Refactor Discovery Engine resource handling #384
Merged
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
This adds a new Rails app configuration option for the default collection, the root ancestor of all Discovery Engine resources. This will allow us to construct fully qualified names (paths) for all resources without having to configure several separate environment variables for the datastore, the engine, the serving config, etc.
In the vein of "a little duplication is better than the wrong abstraction", we probably want to avoid having a shared library for the handful of relatively trivial shared data models between this app and Search Admin. - Copy `DataStore` and `Engine` models (and `DiscoveryEngineNameable` concern) from Search Admin into this app
This changes the usage of Rails configuration/environment variables for getting the default data store to use `DataStore.default` instead.
This adds a `Branch` model and a representation of a data store's default branch, allowing us to remove the more specific environment variable/app configuration. Branches are annoying because they are undocumented and don't formally form part of the Discovery Engine API. Every data store has exactly one branch (the default one), and you don't interact with it in any way _other than_ when you add/update/remove documents on the datastore.
This adds a `ServingConfig` model and a representation of the existing default serving configuration, allowing us to remove the more specific environment variable/app configuration.
leenagupte
approved these changes
Feb 7, 2025
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.
We currently have separate environment variables (mirrored in app configuration) for the Discovery Engine data store, data store branch, engine, and serving config.
These all share a common ancestor (the default collection), so we don't need to set them all up separately.
This PR adopts the new data model from Search Admin in this application too, with first class models for each of the above Discovery Engine resources, and removes the previous configuration.
see alphagov/search-admin#1360