Add rolling upgrade interstitials to UA

[cjcenizal]

Fixes #111808

Changes:

• Added isClusterUpgrading and isClusterUpgraded flags to context and appropriate UI logic to handle these states.

Wrapped API routes:

• cloud_backup_status.ts Retrieve backup status on Cloud.
• deprecation_logging.ts Set and retrieve deprecation logging status and retrieve log count.
• es_deprecations.ts Retrieve ES deprecations and their reindexing status.
• ml_snapshots.ts Upgrade and delete ML snapshots, and retrieve their upgrading status.
• status.ts Provide status to Cloud to determine whether the cluster is ready to be upgraded.
• update_index_settings.ts Fix a deprecation by deleting an index's settings.
• reindex.indices.ts Reindex individual indices.
• batch_reindex.indices.ts Reindex batches of indices.

We can safely ignore these API routes:

• app.ts This retrieves privileges to prevent unauthorized users from accessing UA. As an aside, this file could probably be named more clearly to reflect this role.

How to test

The interstitial is triggered whenever the above APIs respond with a 426 error. You can force this error by updating es_version_precheck.ts on line 104:

export const versionCheckHandlerWrapper =
  <P, Q, B>(handler: RequestHandler<P, Q, B>, isFailure) =>
  async (
    ctx: RequestHandlerContext,
    request: KibanaRequest<P, Q, B>,
    response: KibanaResponseFactory
  ) => {
    if (isFailure) {
      return response.customError({
        // 426 means "Upgrade Required" and is used when semver compatibility is not met.
        statusCode: 426,
        body: {
          message: 'There are some nodes running a different version of Elasticsearch',
          attributes: {
            allNodesUpgraded: false,
          },
        },
      });
    }
    const errorResponse = await esVersionCheck(ctx, response);
    if (errorResponse) {
      return errorResponse;
    }
    return handler(ctx, request, response);
  };

Then just pass true as the second argument to any API route handler that wraps its logic in versionCheckHandlerWrapper(). You can switch between the different interstitial states by changing allNodesUpgraded to true.

Screenshots

When the cluster is upgrading:

When the upgrade is complete:

[cjcenizal]

By passing through the entire set of properties on the object returned by useDeprecationLogging we create a tight coupling between that hook's return value and DeprecationLoggingToggle props. This is brittle in that changing either one results in a TS error.

[cjcenizal]

Unfortunately, with polling implemented, this causes an infinite loop of re-renders when app.tsx calls useClusterUpgradeStatus. What happens is that this line calls a function which calls a useState setter function, which triggers a re-render of app.tsx. On re-render useClusterUpgradeStatus is called again, and so on.

If we could detect that nothing in response has changed since the last call of _useRequest, then we could avoid calling this.handleClusterUpgradeError on this line. Implementing the original solution of adding support for responseHandlers to the request module would also solve this problem.

[cjcenizal]

Thanks for the reviews @yuliacech and @sabarasaba! I've addressed your comments and asked a couple questions for clarification. Could you please take another look?

@yuliacech I named one of the components in app.tsx to AppHandlingClusterUpgradeState and added more detailed comments to explain the split. I left the other component named App because I think changing its name will leak an implementation detail to the tests, which consume it. Can you take a look and let me know if this is enough to clarify things?

[cjcenizal]

@yuliacech And thanks for the tip about tweak!

[kibanamachine]

💚 Build Succeeded

• continuous-integration/kibana-ci/pull-request
• Commit: 3902332
• Storybooks Preview
• Documentation Changes

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
upgradeAssistant	134.6KB	136.4KB	+1.8KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
upgradeAssistant	16.6KB	17.1KB	+589.0B

History

• 💔 Build #160147 failed dbc7a8e
• 💚 Build #159299 succeeded db265e1
• 💔 Build #159190 failed abbb559
• 💔 Build #157788 failed c9da569
• 💔 Build #157731 failed 01e3ede

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

[sabarasaba]

Latest changes LGTM, thanks for patching it up @cjcenizal !

[yuliacech]

Thanks @cjcenizal, latest changes LGTM! 👍