feat(setup-checks): let ExApps surface setup checks in the admin overview#908
Draft
oleksandr-nc wants to merge 1 commit into
Draft
feat(setup-checks): let ExApps surface setup checks in the admin overview#908oleksandr-nc wants to merge 1 commit into
oleksandr-nc wants to merge 1 commit into
Conversation
ca6a6b9 to
68efcb0
Compare
…view Signed-off-by: Oleksander Piskun <oleksandr2088@icloud.com>
68efcb0 to
1942754
Compare
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.
Implements #888.
ExApps can now surface admin-facing setup checks in Settings > Administration > Overview, next to the
core ones (e.g. an ExApp warning that it isn't configured correctly). An ExApp opts in with
POST /api/v1/setup_check(andDELETEto opt out); app_api registers a single aggregate "ExternalApps"
ISetupCheck, and the results come from each opted-in ExApp's/setup_checksendpoint. A downor slow ExApp shows "not responding".
The SetupCheck page itself does no HTTP. The fan-out to ExApps runs entirely in the background (a
10-min TimedJob plus a one-off job that an admin's page visit enqueues, stale-while-revalidate) and
stores the results in
IAppConfig; the page just reads those, filtered to the currently opted-in andenabled ExApps. So a slow, down, or errored ExApp can never slow down the admin page.
Notes:
IAppConfig.Draft: the
nc_py_apihelper (a@setup_checkdecorator) and docs are a follow-up; this is theserver/app_api side. NC35-only, not backported.