Split search backend plugin initialization into init and start phases #24796
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes backstage#24794. The build process takes place synchronously to the plugin initialization rather than at startup so that the HTTP router has the relevant types available to validate incoming requests. Signed-off-by: Brian Phillips <28457+brianphillips@users.noreply.github.com>
Signed-off-by: Brian Phillips <28457+brianphillips@users.noreply.github.com>
github-actions
bot
added
search
Changed Packages
|
Signed-off-by: Brian Phillips <28457+brianphillips@users.noreply.github.com>
freben
requested review from
a team,
freben and
Rugvip
and removed request for
a team
Rugvip
requested changes
May 16, 2024
Signed-off-by: Brian Phillips <28457+brianphillips@users.noreply.github.com>
brianphillips
changed the title
emmaindal
reviewed
May 16, 2024
Co-authored-by: Emma Indal <emma.indahl@gmail.com> Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
awanlin
approved these changes
May 16, 2024
There was a problem hiding this comment.
Thanks for this @brianphillips, left one small nit but it's not blocking
Co-authored-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com> Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
|
Thank you for contributing to Backstage! The changes in this pull request will be part of the |
|
Uffizzi Cluster |
benjdlambert
added a commit
that referenced
this pull request
May 16, 2024
Signed-off-by: blam <ben@blam.sh>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hey, I just made a Pull Request!
As discussed over in #24794, the backend search plugin needs to have two phases during initialization: build and start.
The build phase is synchronous and ensures that the
searchIndexServicestate is initialized before creating the HTTP router. This "build" phase is necessary to ensure the collators are all added to thesearchIndexServiceobject before trying to use that list of document types within the zod request schema that is used to validate incoming requests. Prior to this change, the set of types would be empty at initialization time and incoming requests would be rejected due to validation errors.✔️ Checklist
Signed-off-byline in the message. (more info)