feat(clients): support recommend methods in algoliasearch
#2834
Conversation
🔨 The codegen job will run at the end of the CI.Make sure your last commit does not contain generated code, it will be automatically pushed by our CI. |
aymeric-giraudet
changed the title
algoliasearch
| const parsed = yaml.load(await fsp.readFile(toAbsolutePath(bundledPath), 'utf8')) as Spec; | ||
| const base = yaml.load(await fsp.readFile(toAbsolutePath(bundledPath), 'utf8')) as Spec; | ||
|
|
||
| await run(`yarn specs:fix recommend`); |
There was a problem hiding this comment.
I'm aware this could be handled better by parallelizing with Promise.all and whatnot, but I feel it's not worth complexifying the code for
| const recommendTmpPath = toAbsolutePath('specs/bundled/algoliasearch-recommend.tmp.yml'); | ||
| await run(`yarn openapi bundle specs/recommend/spec.yml -o ${recommendTmpPath} --ext yml`); | ||
| const recommend = yaml.load(await fsp.readFile(recommendTmpPath, 'utf8')) as Spec; | ||
| fsp.rm(recommendTmpPath); |
There was a problem hiding this comment.
There might be a way to use the openapi package to load/bundle a YML spec without having to write a temp file or use shell
| @@ -26,6 +26,7 @@ | |||
| {{> algoliasearch/builds/initClients}} | |||
|
|
|||
| return { | |||
| ...createRecommendClient(commonOptions), | |||
There was a problem hiding this comment.
we have to use the init solution like for analytics etc. otherwise both base clients will be merged, I think we can leave search as the base client it would make things clearer for users
had trouble merging our changes, so I've applied some of yours on my PR, which should make the test pass #2860, let me know wdyt |
🧭 What and Why
As we're trying to unify FX libraries, we want to avoid requiring users to import a bunch of different packages.
We've made those changes to v4 : algolia/algoliasearch-client-javascript#1509
🎟 JIRA Ticket: FX-2774
Changes included:
I'm publishing this as a draft as I'm overall not too sure about the best way to implement this :
searchandrecommendspecs foralgoliasearch/lite, and it works well however this will have repercussions for the Dart client (cc @aallam)algoliasearchpart (not lite), I'm a bit torn as methods are not exported so we can't have the same treeshaking we have with v4,createRecommendhas to be called and the bundle will have redundant code. Running into problems with similar models being exported too.Also didn't update it for Dart but it might be fine for now.
🧪 Test
Didn't bother with tests yet as this is subject to change :D