feat: add headless react util defineSearchEngine #3107

mrrajamanickam-coveo · 2023-08-14T22:28:48Z

Adds React util to define search engine that provides context provider, hooks to hydrate engine and controllers.

TODO

Add more unit tests
- Fix issues testing with error boundary
Add e2e tests
Fix error useSyncExternalStore can only be used in client components
Fix build error after latest merge with master

https://coveord.atlassian.net/browse/KIT-2606
https://coveord.atlassian.net/browse/KIT-2692

https://coveord.atlassian.net/browse/KIT-2606

github-actions · 2023-08-14T22:32:41Z

Dependency Review

The following issues were found:

✅ 0 vulnerable package(s)
✅ 0 package(s) with incompatible licenses
✅ 0 package(s) with invalid SPDX license definitions
⚠️ 2 package(s) with unknown licenses.

See the Details below.

License Issues

package-lock.json

Package	Version	License	Issue Type
packages/headless-react	0.0.0	Null	Unknown License

packages/samples/headless-ssr/package.json

Package	Version	License	Issue Type
@coveo/headless-react	0.0.0	Null	Unknown License

Allowed Licenses: 0BSD, Apache-2.0, Apache-2.0 AND MIT, Apache-2.0 AND BSD-3-Clause AND Python-2.0, Beerware, BlueOak-1.0.0, BSD-1-Clause, BSD-2-Clause, BSD-2-Clause-Patent, BSD-2-Clause-Views, BSD-2-Clause AND MIT, BSD-3-Clause, BSD-3-Clause-Attribution, BSD-3-Clause-Clear, BSL-1.0, CC-BY-3.0, CC-BY-4.0, CC0-1.0, CNRI-Python, curl, HPND, IBM-pibs, ImageMagick, ISC, JSON, MIT, MIT-0, MIT AND ISC, MIT AND Python-2.0, MIT-advertising, mpi-permissive, NCSA, ODC-By-1.0, PDDL-1.0, Plexus, PostgreSQL, PSF-2.0, Python-2.0, Python-2.0.1, SAX-PD, Unlicense, UPL-1.0, W3C, Wsuipa, WTFPL, X11, X11-distribute-modifications-variant, Xerox, Zlib, ZPL-2.1

Scanned Manifest Files

package-lock.json

packages/headless-react/package.json

packages/samples/headless-react/package.json

packages/samples/headless-ssr/package.json

github-actions · 2023-08-14T22:56:18Z

Pull Request Report

PR Title

✅ Title follows the conventional commit spec.

Bundle Size

File	Old (kb)	New (kb)
case-assist	182.1	182.1
commerce	262.6	262.6
search	345.4	345.4
insight	299	299
product-listing	287.7	287.7
product-recommendation	156.3	156.3
recommendation	192.9	192.9
ssr	207.5	207.5

https://coveord.atlassian.net/browse/KIT-2606

mrrajamanickam-coveo · 2023-08-28T17:13:24Z

Working on fixing test failures in CI (that passed locally) ...

 FAIL  src/search-engine.test.tsx
  ● Test suite failed to run

    src/search-engine.test.tsx:93:23 - error TS2339: Property 'toHaveLength' does not exist on type 'ArrayLikeMatchers<HTMLElement>'.

    93       expect(results).toHaveLength(numResults);
                             ~~~~~~~~~~~~

 11 passing (31s)
  1 failing

  1) react Headless SSR utils
       should pass the web-vitals audits:
     Error: cy.vitals() - A threshold has been crossed.

ttfb web-vital is 21.70000000001164, and is over the 20 threshold. Fail.
      at Context.eval (webpack://@coveo/headless-ssr-samples/../../../node_modules/cypress-web-vitals/src/reportResults.js:83:0)

https://coveord.atlassian.net/browse/KIT-2606

packages/headless/src/ssr.index.ts

packages/samples/headless-ssr/src/app/react/components/search-page.tsx

https://coveord.atlassian.net/browse/KIT-2606

…eact_utils https://coveord.atlassian.net/browse/KIT-2606

https://coveord.atlassian.net/browse/KIT-2606

…eact_utils

mrrajamanickam-coveo added 23 commits August 8, 2023 17:26

init new headless-react pkg

0ae24f6

https://coveord.atlassian.net/browse/KIT-2606

add new pkg to vscode workspace, sort workspace listing by usage

d42177e

https://coveord.atlassian.net/browse/KIT-2606

add headless as a dep

3f8260d

https://coveord.atlassian.net/browse/KIT-2606

add react as peer dep

2fd9310

https://coveord.atlassian.net/browse/KIT-2606

init bunch of req files

b568448

https://coveord.atlassian.net/browse/KIT-2606

wip: add define search engine func and types

ed8822d

https://coveord.atlassian.net/browse/KIT-2606

copy config from atomic-react

0bea70b

https://coveord.atlassian.net/browse/KIT-2606

rename main file to index

b5746f1

https://coveord.atlassian.net/browse/KIT-2606

add dev deps, eslint config

878d8c8

https://coveord.atlassian.net/browse/KIT-2606

add build controller hook

79f9b50

https://coveord.atlassian.net/browse/KIT-2606

add provider methods, move function from index

77c0a84

https://coveord.atlassian.net/browse/KIT-2606

use new jsx tsconfig option, add build cmd script

bc82425

https://coveord.atlassian.net/browse/KIT-2606

rename Initial/Live with SSR/CSR

6e50b61

https://coveord.atlassian.net/browse/KIT-2606

add react testing lib dep

cfc314f

https://coveord.atlassian.net/browse/KIT-2606

add initial test

b6b69aa

https://coveord.atlassian.net/browse/KIT-2606

move jest jsdom dep to root as it needs to match jest version

1e6494d

https://coveord.atlassian.net/browse/KIT-2606

add jsdom, lint setup

08cf2ff

add wip jsdom test

7b52694

add wip lint staged config to filter ignored files

ccccce1

https://coveord.atlassian.net/browse/KIT-2606

test: add err check

603558c

https://coveord.atlassian.net/browse/KIT-2606

add tsconfig to exclude tests

b5a226d

https://coveord.atlassian.net/browse/KIT-2606

remove redundant react import with new tsconfig

6d303eb

https://coveord.atlassian.net/browse/KIT-2606

move test file next to src file

b4c5533

https://coveord.atlassian.net/browse/KIT-2606

mrrajamanickam-coveo requested a review from a team as a code owner August 14, 2023 22:28

mrrajamanickam-coveo requested review from olamothe, y-lakhdar and dmbrooke August 14, 2023 22:28

Merge branch 'master' into KIT-2606_headless_react_utils

30a319e

https://coveord.atlassian.net/browse/KIT-2606

mrrajamanickam-coveo requested a review from btaillon-coveo August 25, 2023 21:49

mrrajamanickam-coveo added 8 commits August 25, 2023 15:24

move jest config to ts

d6ea7b2

reuse err msg in test

336ad59

https://coveord.atlassian.net/browse/KIT-2606

fix csr/ssr tests to check for rendered results

25fd2a9

https://coveord.atlassian.net/browse/KIT-2606

fix known errors from showing up in console

4a43cb3

https://coveord.atlassian.net/browse/KIT-2606

add tests for use engine hook

5f9a528

https://coveord.atlassian.net/browse/KIT-2606

enable codecov config, remove unused jsdom test lib

5ed62fe

Merge branch 'master' into KIT-2606_headless_react_utils

086efa1

rename client wrapper to client utils

17ebed8

https://coveord.atlassian.net/browse/KIT-2606

mrrajamanickam-coveo added 3 commits August 28, 2023 12:12

Merge branch 'master' into KIT-2606_headless_react_utils

2983934

add @types/jest dep

83223f4

https://coveord.atlassian.net/browse/KIT-2606

add web vitals thresholds due to CI failure

432ce88

https://coveord.atlassian.net/browse/KIT-2606

btaillon-coveo reviewed Aug 30, 2023

View reviewed changes

packages/headless/src/ssr.index.ts Outdated Show resolved Hide resolved

btaillon-coveo reviewed Aug 30, 2023

View reviewed changes

packages/samples/headless-ssr/src/app/react/components/search-page.tsx Outdated Show resolved Hide resolved

btaillon-coveo approved these changes Aug 30, 2023

View reviewed changes

mrrajamanickam-coveo added 4 commits August 30, 2023 13:50

Merge branch 'master' into KIT-2606_headless_react_utils

39af750

https://coveord.atlassian.net/browse/KIT-2606

remove textencoder/decoder workaround

9e00681

duplicate map object util from headless

939cb74

https://coveord.atlassian.net/browse/KIT-2606

Merge branch 'master' into KIT-2606_headless_react_utils

f29e417

https://coveord.atlassian.net/browse/KIT-2606

mrrajamanickam-coveo mentioned this pull request Sep 1, 2023

style(headless): moved ssr files next to their csr counterparts #3150

Merged

btaillon-coveo added 2 commits September 7, 2023 14:45

Merge remote-tracking branch 'origin/master' into KIT-2606_headless_r…

9a32e1a

…eact_utils https://coveord.atlassian.net/browse/KIT-2606

hoisted components

c7c8847

https://coveord.atlassian.net/browse/KIT-2606

btaillon-coveo enabled auto-merge (squash) September 7, 2023 20:09

btaillon-coveo and others added 3 commits September 8, 2023 09:22

made thresholds much larger and separated them

472ef0c

https://coveord.atlassian.net/browse/KIT-2606

Merge remote-tracking branch 'origin/master' into KIT-2606_headless_r…

d737333

…eact_utils

Add generated files

7b98486

btaillon-coveo disabled auto-merge September 8, 2023 15:15

btaillon-coveo merged commit 1d63e43 into master Sep 8, 2023
2 checks passed

btaillon-coveo deleted the KIT-2606_headless_react_utils branch September 8, 2023 15:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add headless react util defineSearchEngine #3107

feat: add headless react util defineSearchEngine #3107

mrrajamanickam-coveo commented Aug 14, 2023 •

edited

Loading

github-actions bot commented Aug 14, 2023 •

edited

Loading

github-actions bot commented Aug 14, 2023 •

edited

Loading

mrrajamanickam-coveo commented Aug 28, 2023 •

edited

Loading

feat: add headless react util defineSearchEngine #3107

feat: add headless react util defineSearchEngine #3107

Conversation

mrrajamanickam-coveo commented Aug 14, 2023 • edited Loading

TODO

github-actions bot commented Aug 14, 2023 • edited Loading

Dependency Review

License Issues

package-lock.json

packages/samples/headless-ssr/package.json

Scanned Manifest Files

github-actions bot commented Aug 14, 2023 • edited Loading

mrrajamanickam-coveo commented Aug 28, 2023 • edited Loading

mrrajamanickam-coveo commented Aug 14, 2023 •

edited

Loading

github-actions bot commented Aug 14, 2023 •

edited

Loading

github-actions bot commented Aug 14, 2023 •

edited

Loading

mrrajamanickam-coveo commented Aug 28, 2023 •

edited

Loading