|
| 1 | +import algoliasearchHelper, { |
| 2 | + SearchParameters, |
| 3 | + SearchResults, |
| 4 | +} from 'algoliasearch-helper'; |
| 5 | +import connectSmartSort from '../connectSmartSort'; |
| 6 | +import { |
| 7 | + createInitOptions, |
| 8 | + createRenderOptions, |
| 9 | + createDisposeOptions, |
| 10 | +} from '../../../../test/mock/createWidget'; |
| 11 | +import { noop } from '../../../lib/utils'; |
| 12 | +import { createSearchClient } from '../../../../test/mock/createSearchClient'; |
| 13 | +import { createSingleSearchResponse } from '../../../../test/mock/createAPIResponse'; |
| 14 | + |
| 15 | +const createHelper = () => { |
| 16 | + return algoliasearchHelper(createSearchClient(), '', {}); |
| 17 | +}; |
| 18 | + |
| 19 | +describe('connectSmartSort', () => { |
| 20 | + it('is a widget', () => { |
| 21 | + const render = jest.fn(); |
| 22 | + const unmount = jest.fn(); |
| 23 | + |
| 24 | + const customSmartSort = connectSmartSort(render, unmount); |
| 25 | + const widget = customSmartSort({}); |
| 26 | + |
| 27 | + expect(widget).toEqual( |
| 28 | + expect.objectContaining({ |
| 29 | + $$type: 'ais.smartSort', |
| 30 | + init: expect.any(Function), |
| 31 | + render: expect.any(Function), |
| 32 | + dispose: expect.any(Function), |
| 33 | + }) |
| 34 | + ); |
| 35 | + }); |
| 36 | + |
| 37 | + it('dispose relevancyStrictness set by the widget', () => { |
| 38 | + const helper = createHelper(); |
| 39 | + const makeWidget = connectSmartSort(noop); |
| 40 | + const widget = makeWidget({}); |
| 41 | + widget.init!(createInitOptions({ helper })); |
| 42 | + const { refine } = widget.getWidgetRenderState( |
| 43 | + createRenderOptions({ |
| 44 | + helper, |
| 45 | + }) |
| 46 | + ); |
| 47 | + refine(10); |
| 48 | + expect( |
| 49 | + widget.getWidgetSearchParameters!(helper.state, { |
| 50 | + uiState: {}, |
| 51 | + }).relevancyStrictness |
| 52 | + ).toEqual(10); |
| 53 | + |
| 54 | + const nextState = widget.dispose!( |
| 55 | + createDisposeOptions({ state: helper.state }) |
| 56 | + ) as SearchParameters; |
| 57 | + expect(nextState.relevancyStrictness).toBeUndefined(); |
| 58 | + }); |
| 59 | + |
| 60 | + it('apply relevancyStrictness to helper on refine()', () => { |
| 61 | + const helper = createHelper(); |
| 62 | + const makeWidget = connectSmartSort(noop); |
| 63 | + const widget = makeWidget({}); |
| 64 | + |
| 65 | + widget.init!(createInitOptions({ helper })); |
| 66 | + const { refine } = widget.getWidgetRenderState( |
| 67 | + createRenderOptions({ helper }) |
| 68 | + ); |
| 69 | + |
| 70 | + expect(helper.state.relevancyStrictness).toBeUndefined(); |
| 71 | + |
| 72 | + refine(0); |
| 73 | + expect(helper.state.relevancyStrictness).toEqual(0); |
| 74 | + |
| 75 | + refine(11); |
| 76 | + expect(helper.state.relevancyStrictness).toEqual(11); |
| 77 | + }); |
| 78 | + |
| 79 | + it('decide isSmartSorted based on appliedRelevancyStrictness', () => { |
| 80 | + const helper = createHelper(); |
| 81 | + const makeWidget = connectSmartSort(noop); |
| 82 | + const widget = makeWidget({}); |
| 83 | + |
| 84 | + widget.init!(createInitOptions({ helper })); |
| 85 | + |
| 86 | + let renderState = widget.getWidgetRenderState( |
| 87 | + createRenderOptions({ |
| 88 | + helper, |
| 89 | + results: new SearchResults(helper.state, [ |
| 90 | + createSingleSearchResponse({ |
| 91 | + hits: [], |
| 92 | + appliedRelevancyStrictness: 60, |
| 93 | + }), |
| 94 | + ]), |
| 95 | + }) |
| 96 | + ); |
| 97 | + expect(renderState.isSmartSorted).toBe(true); |
| 98 | + |
| 99 | + renderState = widget.getWidgetRenderState( |
| 100 | + createRenderOptions({ |
| 101 | + helper, |
| 102 | + results: new SearchResults(helper.state, [ |
| 103 | + createSingleSearchResponse({ |
| 104 | + hits: [], |
| 105 | + appliedRelevancyStrictness: 0, |
| 106 | + }), |
| 107 | + ]), |
| 108 | + }) |
| 109 | + ); |
| 110 | + expect(renderState.isSmartSorted).toBe(false); |
| 111 | + }); |
| 112 | + |
| 113 | + it('decide isVirtualReplica based on appliedRelevancyStrictness', () => { |
| 114 | + const helper = createHelper(); |
| 115 | + const makeWidget = connectSmartSort(noop); |
| 116 | + const widget = makeWidget({}); |
| 117 | + |
| 118 | + widget.init!(createInitOptions({ helper })); |
| 119 | + |
| 120 | + let renderState = widget.getWidgetRenderState( |
| 121 | + createRenderOptions({ |
| 122 | + helper, |
| 123 | + results: new SearchResults(helper.state, [ |
| 124 | + createSingleSearchResponse({ |
| 125 | + hits: [], |
| 126 | + appliedRelevancyStrictness: 60, |
| 127 | + }), |
| 128 | + ]), |
| 129 | + }) |
| 130 | + ); |
| 131 | + expect(renderState.isVirtualReplica).toBe(true); |
| 132 | + |
| 133 | + renderState = widget.getWidgetRenderState( |
| 134 | + createRenderOptions({ |
| 135 | + helper, |
| 136 | + results: new SearchResults(helper.state, [ |
| 137 | + createSingleSearchResponse({ |
| 138 | + hits: [], |
| 139 | + appliedRelevancyStrictness: 0, |
| 140 | + }), |
| 141 | + ]), |
| 142 | + }) |
| 143 | + ); |
| 144 | + expect(renderState.isVirtualReplica).toBe(true); |
| 145 | + |
| 146 | + renderState = widget.getWidgetRenderState( |
| 147 | + createRenderOptions({ |
| 148 | + helper, |
| 149 | + results: new SearchResults(helper.state, [ |
| 150 | + createSingleSearchResponse({ |
| 151 | + hits: [], |
| 152 | + appliedRelevancyStrictness: undefined, |
| 153 | + }), |
| 154 | + ]), |
| 155 | + }) |
| 156 | + ); |
| 157 | + expect(renderState.isVirtualReplica).toBe(false); |
| 158 | + }); |
| 159 | + |
| 160 | + describe('getRenderState', () => { |
| 161 | + it('return the render state', () => { |
| 162 | + const helper = createHelper(); |
| 163 | + const renderFn = jest.fn(); |
| 164 | + const unmountFn = jest.fn(); |
| 165 | + const makeWidget = connectSmartSort(renderFn, unmountFn); |
| 166 | + const widget = makeWidget({}); |
| 167 | + |
| 168 | + const renderState1 = widget.getRenderState( |
| 169 | + {}, |
| 170 | + createInitOptions({ helper }) |
| 171 | + ); |
| 172 | + expect(renderState1.smartSort).toEqual({ |
| 173 | + isSmartSorted: false, |
| 174 | + isVirtualReplica: false, |
| 175 | + refine: expect.any(Function), |
| 176 | + widgetParams: {}, |
| 177 | + }); |
| 178 | + |
| 179 | + widget.init!(createInitOptions()); |
| 180 | + const renderState2 = widget.getRenderState( |
| 181 | + {}, |
| 182 | + createRenderOptions({ |
| 183 | + helper, |
| 184 | + results: new SearchResults(helper.state, [ |
| 185 | + createSingleSearchResponse({ |
| 186 | + hits: [], |
| 187 | + appliedRelevancyStrictness: 15, |
| 188 | + }), |
| 189 | + ]), |
| 190 | + }) |
| 191 | + ); |
| 192 | + expect(renderState2.smartSort).toEqual({ |
| 193 | + isSmartSorted: true, |
| 194 | + isVirtualReplica: true, |
| 195 | + refine: expect.any(Function), |
| 196 | + widgetParams: {}, |
| 197 | + }); |
| 198 | + }); |
| 199 | + }); |
| 200 | + |
| 201 | + describe('getWidgetRenderState', () => { |
| 202 | + it('return the widget render state', () => { |
| 203 | + const helper = createHelper(); |
| 204 | + const makeWidget = connectSmartSort(noop); |
| 205 | + const widget = makeWidget({}); |
| 206 | + |
| 207 | + const widgetRenderState1 = widget.getWidgetRenderState( |
| 208 | + createInitOptions({ helper }) |
| 209 | + ); |
| 210 | + expect(widgetRenderState1).toEqual({ |
| 211 | + isSmartSorted: false, |
| 212 | + isVirtualReplica: false, |
| 213 | + refine: expect.any(Function), |
| 214 | + widgetParams: {}, |
| 215 | + }); |
| 216 | + |
| 217 | + widget.init!(createInitOptions()); |
| 218 | + const widgetRenderState2 = widget.getWidgetRenderState( |
| 219 | + createRenderOptions({ |
| 220 | + helper, |
| 221 | + results: new SearchResults(helper.state, [ |
| 222 | + createSingleSearchResponse({ |
| 223 | + hits: [], |
| 224 | + appliedRelevancyStrictness: 20, |
| 225 | + }), |
| 226 | + ]), |
| 227 | + }) |
| 228 | + ); |
| 229 | + expect(widgetRenderState2).toEqual({ |
| 230 | + isSmartSorted: true, |
| 231 | + isVirtualReplica: true, |
| 232 | + refine: expect.any(Function), |
| 233 | + widgetParams: {}, |
| 234 | + }); |
| 235 | + }); |
| 236 | + }); |
| 237 | + |
| 238 | + describe('getWidgetUiState', () => { |
| 239 | + it('does not have relevancyStrictness by default', () => { |
| 240 | + const helper = createHelper(); |
| 241 | + const makeWidget = connectSmartSort(noop); |
| 242 | + const widget = makeWidget({}); |
| 243 | + |
| 244 | + const widgetUiState = widget.getWidgetUiState!( |
| 245 | + {}, |
| 246 | + { helper, searchParameters: helper.state } |
| 247 | + ); |
| 248 | + expect(widgetUiState.smartSort?.relevancyStrictness).toBeUndefined(); |
| 249 | + }); |
| 250 | + |
| 251 | + it('add refined parameters', () => { |
| 252 | + const helper = createHelper(); |
| 253 | + const makeWidget = connectSmartSort(noop); |
| 254 | + const widget = makeWidget({}); |
| 255 | + |
| 256 | + widget.init!(createInitOptions({ helper })); |
| 257 | + const { refine } = widget.getWidgetRenderState( |
| 258 | + createRenderOptions({ helper }) |
| 259 | + ); |
| 260 | + refine(25); |
| 261 | + |
| 262 | + expect( |
| 263 | + widget.getWidgetUiState!({}, { helper, searchParameters: helper.state }) |
| 264 | + ).toEqual({ |
| 265 | + smartSort: { relevancyStrictness: 25 }, |
| 266 | + }); |
| 267 | + }); |
| 268 | + |
| 269 | + it('overwrite existing uiState with searchParameters', () => { |
| 270 | + const helper = createHelper(); |
| 271 | + const makeWidget = connectSmartSort(noop); |
| 272 | + const widget = makeWidget({}); |
| 273 | + |
| 274 | + expect( |
| 275 | + widget.getWidgetUiState!( |
| 276 | + { smartSort: { relevancyStrictness: 25 } }, |
| 277 | + { helper, searchParameters: helper.state } |
| 278 | + ) |
| 279 | + ).toEqual({ |
| 280 | + smartSort: { relevancyStrictness: undefined }, |
| 281 | + }); |
| 282 | + |
| 283 | + const { refine } = widget.getWidgetRenderState( |
| 284 | + createRenderOptions({ helper }) |
| 285 | + ); |
| 286 | + refine(30); |
| 287 | + |
| 288 | + // applies 30 from searchParameters |
| 289 | + expect( |
| 290 | + widget.getWidgetUiState!( |
| 291 | + { smartSort: { relevancyStrictness: 25 } }, |
| 292 | + { helper, searchParameters: helper.state } |
| 293 | + ) |
| 294 | + ).toEqual({ |
| 295 | + smartSort: { relevancyStrictness: 30 }, |
| 296 | + }); |
| 297 | + }); |
| 298 | + }); |
| 299 | + |
| 300 | + describe('getWidgetSearchParameters', () => { |
| 301 | + it('does not include relevancyStrictness by default', () => { |
| 302 | + const makeWidget = connectSmartSort(noop); |
| 303 | + const widget = makeWidget({}); |
| 304 | + |
| 305 | + const searchParameters = widget.getWidgetSearchParameters!( |
| 306 | + new SearchParameters(), |
| 307 | + { |
| 308 | + uiState: {}, |
| 309 | + } |
| 310 | + ); |
| 311 | + expect(searchParameters.relevancyStrictness).toBeUndefined(); |
| 312 | + }); |
| 313 | + |
| 314 | + it('return parameters set by uiState', () => { |
| 315 | + const makeWidget = connectSmartSort(noop); |
| 316 | + const widget = makeWidget({}); |
| 317 | + |
| 318 | + const searchParameters = widget.getWidgetSearchParameters!( |
| 319 | + new SearchParameters(), |
| 320 | + { |
| 321 | + uiState: { |
| 322 | + smartSort: { |
| 323 | + relevancyStrictness: 15, |
| 324 | + }, |
| 325 | + }, |
| 326 | + } |
| 327 | + ); |
| 328 | + expect(searchParameters).toEqual( |
| 329 | + new SearchParameters({ relevancyStrictness: 15 }) |
| 330 | + ); |
| 331 | + }); |
| 332 | + |
| 333 | + it('store refined state', () => { |
| 334 | + const helper = createHelper(); |
| 335 | + const makeWidget = connectSmartSort(noop); |
| 336 | + const widget = makeWidget({}); |
| 337 | + |
| 338 | + const { refine } = widget.getWidgetRenderState( |
| 339 | + createRenderOptions({ helper }) |
| 340 | + ); |
| 341 | + refine(25); |
| 342 | + |
| 343 | + const searchParameters = widget.getWidgetSearchParameters!(helper.state, { |
| 344 | + uiState: {}, |
| 345 | + }); |
| 346 | + expect(searchParameters.relevancyStrictness).toEqual(25); |
| 347 | + }); |
| 348 | + |
| 349 | + it('override parameters with the value from uiState', () => { |
| 350 | + const helper = createHelper(); |
| 351 | + const makeWidget = connectSmartSort(noop); |
| 352 | + const widget = makeWidget({}); |
| 353 | + |
| 354 | + const { refine } = widget.getWidgetRenderState( |
| 355 | + createRenderOptions({ helper }) |
| 356 | + ); |
| 357 | + refine(25); |
| 358 | + |
| 359 | + const searchParameters = widget.getWidgetSearchParameters!( |
| 360 | + new SearchParameters(), |
| 361 | + { |
| 362 | + uiState: { |
| 363 | + smartSort: { |
| 364 | + relevancyStrictness: 15, |
| 365 | + }, |
| 366 | + }, |
| 367 | + } |
| 368 | + ); |
| 369 | + expect(searchParameters.relevancyStrictness).toEqual(15); |
| 370 | + }); |
| 371 | + }); |
| 372 | +}); |
0 commit comments