Applications API v2#72
Merged
Merged
Conversation
deadlycoconuts
approved these changes
Nov 30, 2022
Collaborator
deadlycoconuts
left a comment
There was a problem hiding this comment.
LGTM! 🚀 Thanks for the extensive refactoring; just had a couple of minor questions but no comments besides that!
Collaborator
Author
|
@deadlycoconuts thank you for the review 🙌 |
2 tasks
This file contains hidden or 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
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.
Context:
Until now, the information about enabled CaraML applications in the MLP deployment was persisted in the DB and retrieved from there via an API call. In the hindsight, that wasn't the best design decision, because it was required to add DB migration script for adding/modifying the app configuration, which in turn required releasing the new version of the
mlpapp.Also, the information about the available CaraML applications conceptually belongs to the deployment configuration, because the same version of CaraML can be deployed with a different subset of CaraML applications (e.g. it should be possible to deploy CaraML with Merlin, but without Turing etc.). It's harder to achieve this, because the DB migrations are strictly versioned.
This MR attempts to solve this issue by introducing Applications API v2, which retrieves the information about CaraML applications from the runtime configuration and doesn't persist this data in the database. This refactoring is also done in preparation to embed CaraML microfrontends into the
mlphost UI.Changes:
v1andv2endpoints simultaneously@gojek/mlp-uicomponents library to use/v2/applicationsinstead of/v1/applicationsNext Steps:
Since the frontends of CaraML apps are still using
/v1/applications, it's required to keep this API endpoint until these apps are updated to use the new version of@gojek/mlp-ui. After it's done, Applications API v1 can be completely removed from the codebase.