Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(clients): safer replaceAllObjects + metis compliant #3164

Merged
merged 11 commits into from
Jun 12, 2024

Conversation

shortcuts
Copy link
Member

@shortcuts shortcuts commented Jun 11, 2024

🧭 What and Why

🎟 JIRA Ticket: https://algolia.atlassian.net/browse/DI-2407

Changes included:

Add metis compliant implementation for replaceAllObjects, also ensure it never hangs if the source index does not exist, detailed explanation in the docs.

suggested implementation from @Jerska

@shortcuts shortcuts self-assigned this Jun 11, 2024
@algolia-bot
Copy link
Collaborator

algolia-bot commented Jun 11, 2024

✗ The generated branch has been deleted.

If the PR has been merged, you can check the generated code on the main branch.
You can still access the code generated on main via this commit.

@shortcuts shortcuts marked this pull request as ready for review June 11, 2024 20:08
@shortcuts shortcuts requested a review from a team as a code owner June 11, 2024 20:08
Copy link

github-actions bot commented Jun 11, 2024

@github-actions github-actions bot temporarily deployed to pull request June 11, 2024 20:51 Inactive
Copy link
Collaborator

@millotp millotp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks really good !

website/docs/contributing/add-new-api-client.md Outdated Show resolved Hide resolved

Always wait on the destination index, because:
- it's the only index that we know for sure will exist (since we create it).
- it is Metis compliant, no need for custom implementation.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this something we want to expose in a public documentation ? this seems like internal details

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's fine, pretty niche documentation, I can ask

website/docs/contributing/add-new-api-client.md Outdated Show resolved Hide resolved
@shortcuts shortcuts requested a review from millotp June 12, 2024 08:28
@shortcuts shortcuts enabled auto-merge (squash) June 12, 2024 08:28
@github-actions github-actions bot temporarily deployed to pull request June 12, 2024 08:46 Inactive
@shortcuts shortcuts merged commit de40907 into main Jun 12, 2024
23 checks passed
@shortcuts shortcuts deleted the fix/replace-all-objects branch June 12, 2024 08:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants