Change ContextContainer to lazily initialize providers (#129896)

* Change ContextContainer to lazily initialize providers * Introduce CustomRequestHandlerContext, start adapting usages * adapt IContextProvider's return type * start fixing violations * fixing violations - 2 * adapt home routes * fix remaining core violation * fix violations on core tests * fixing more violations * fixing more violations * update generated doc... * fix more violations * adapt remaining RequestHandlerContext * fix more violations * fix non-async method * more fixes * fix another await in non async method * add yet another missing async * [CI] Auto-commit changed files from 'node scripts/eslint --no-cache --fix' * add yet yet another missing async * update fleet's endpoints * fix telemetry endpoints * fix event_log endpoints * fix some security unit tests * adapt canvas routes * adapt alerting routes * adapt more so_tagging routes * fix data_enhanced routes * fix license_management routes * fix file_upload routes * fix index_management routes * fix lists routes * fix snapshot_restore routes * fix rule_registry routes * fix ingest_pipelines routes * fix remote_clusters routes * fix index_lifecycle_management routes * improve and fix the lazy implementation * fix triggers_actions_ui endpoints * start fixing unit tests * fix cases routes * fix transform routes * fix upgrade_assistant routes * fix uptime route wrapper * fix uptime route wrapper bis * update osquery routes * update cross_cluster_replication routes * fix some ML routes / wrappers * adapt maps routes * adapt rollup routes * fix some canvas unit tests * fix more canvas unit tests * fix observability wrapper * fix (?) infra type hell * start fixing monitoring * fix a few test plugins * woups * fix yet more violations * fixing UA tests * fix logstash handlers * fix fleet unit tests * lint? * one more batch * update security_solution endpoints * start fixing security_solution mocks * start fixing security_solution tests * fix more security_solution tests * fix more security_solution tests * just one more * fix last (?) security_solution tests * fix timelion javascript file * fix more test plugins * fix transforms context type * fix ml context type * fix context tests * fix securitySolution withEndpointAuthz tests * fix features unit tests * fix actions unit tests * fix imports * fix duplicate import * fix some merge problems * fix new usage * fix new test * introduces context.resolve * down the rabbit hole again * start fixing test type failures * more test type failures fixes * move import comment back to correct place * more test type failures fixes, bis * use context.resolve for security solution rules routes * fix new violations due to master merge * remove comment Co-authored-by: kibanamachine <[email protected]>
elastic · Apr 22, 2022 · a02c00b · a02c00b
1 parent 706d926
commit a02c00b
Show file tree

Hide file tree

Showing 699 changed files with 4,511 additions and 3,173 deletions.
diff --git a/...core/server/kibana-plugin-core-server.corerequesthandlercontext.deprecations.md b/...core/server/kibana-plugin-core-server.corerequesthandlercontext.deprecations.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [CoreRequestHandlerContext](./kibana-plugin-core-server.corerequesthandlercontext.md) &gt; [deprecations](./kibana-plugin-core-server.corerequesthandlercontext.deprecations.md)
+
+## CoreRequestHandlerContext.deprecations property
+
+<b>Signature:</b>
+
+```typescript
+deprecations: {
+        client: DeprecationsClient;
+    };
+```
diff --git a/...ore/server/kibana-plugin-core-server.corerequesthandlercontext.elasticsearch.md b/...ore/server/kibana-plugin-core-server.corerequesthandlercontext.elasticsearch.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [CoreRequestHandlerContext](./kibana-plugin-core-server.corerequesthandlercontext.md) &gt; [elasticsearch](./kibana-plugin-core-server.corerequesthandlercontext.elasticsearch.md)
+
+## CoreRequestHandlerContext.elasticsearch property
+
+<b>Signature:</b>
+
+```typescript
+elasticsearch: {
+        client: IScopedClusterClient;
+    };
+```
diff --git a/.../development/core/server/kibana-plugin-core-server.corerequesthandlercontext.md b/.../development/core/server/kibana-plugin-core-server.corerequesthandlercontext.md
@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [CoreRequestHandlerContext](./kibana-plugin-core-server.corerequesthandlercontext.md)
+
+## CoreRequestHandlerContext interface
+
+The `core` context provided to route handler.
+
+Provides the following clients and services: - [savedObjects.client](./kibana-plugin-core-server.savedobjectsclient.md) - Saved Objects client which uses the credentials of the incoming request - [savedObjects.typeRegistry](./kibana-plugin-core-server.isavedobjecttyperegistry.md) - Type registry containing all the registered types. - [elasticsearch.client](./kibana-plugin-core-server.iscopedclusterclient.md) - Elasticsearch data client which uses the credentials of the incoming request - [uiSettings.client](./kibana-plugin-core-server.iuisettingsclient.md) - uiSettings client which uses the credentials of the incoming request
+
+<b>Signature:</b>
+
+```typescript
+export interface CoreRequestHandlerContext 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [deprecations](./kibana-plugin-core-server.corerequesthandlercontext.deprecations.md) | { client: DeprecationsClient; } |  |
+|  [elasticsearch](./kibana-plugin-core-server.corerequesthandlercontext.elasticsearch.md) | { client: IScopedClusterClient; } |  |
+|  [savedObjects](./kibana-plugin-core-server.corerequesthandlercontext.savedobjects.md) | { client: SavedObjectsClientContract; typeRegistry: ISavedObjectTypeRegistry; getClient: (options?: SavedObjectsClientProviderOptions) =&gt; SavedObjectsClientContract; getExporter: (client: SavedObjectsClientContract) =&gt; ISavedObjectsExporter; getImporter: (client: SavedObjectsClientContract) =&gt; ISavedObjectsImporter; } |  |
+|  [uiSettings](./kibana-plugin-core-server.corerequesthandlercontext.uisettings.md) | { client: IUiSettingsClient; } |  |
+
diff --git a/...core/server/kibana-plugin-core-server.corerequesthandlercontext.savedobjects.md b/...core/server/kibana-plugin-core-server.corerequesthandlercontext.savedobjects.md
@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [CoreRequestHandlerContext](./kibana-plugin-core-server.corerequesthandlercontext.md) &gt; [savedObjects](./kibana-plugin-core-server.corerequesthandlercontext.savedobjects.md)
+
+## CoreRequestHandlerContext.savedObjects property
+
+<b>Signature:</b>
+
+```typescript
+savedObjects: {
+        client: SavedObjectsClientContract;
+        typeRegistry: ISavedObjectTypeRegistry;
+        getClient: (options?: SavedObjectsClientProviderOptions) => SavedObjectsClientContract;
+        getExporter: (client: SavedObjectsClientContract) => ISavedObjectsExporter;
+        getImporter: (client: SavedObjectsClientContract) => ISavedObjectsImporter;
+    };
+```
diff --git a/...t/core/server/kibana-plugin-core-server.corerequesthandlercontext.uisettings.md b/...t/core/server/kibana-plugin-core-server.corerequesthandlercontext.uisettings.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [CoreRequestHandlerContext](./kibana-plugin-core-server.corerequesthandlercontext.md) &gt; [uiSettings](./kibana-plugin-core-server.corerequesthandlercontext.uisettings.md)
+
+## CoreRequestHandlerContext.uiSettings property
+
+<b>Signature:</b>
+
+```typescript
+uiSettings: {
+        client: IUiSettingsClient;
+    };
+```
diff --git a/...evelopment/core/server/kibana-plugin-core-server.customrequesthandlercontext.md b/...evelopment/core/server/kibana-plugin-core-server.customrequesthandlercontext.md
@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [CustomRequestHandlerContext](./kibana-plugin-core-server.customrequesthandlercontext.md)
+
+## CustomRequestHandlerContext type
+
+
+<b>Signature:</b>
+
+```typescript
+export declare type CustomRequestHandlerContext<T> = RequestHandlerContext & {
+    [Key in keyof T]: T[Key] extends Promise<unknown> ? T[Key] : Promise<T[Key]>;
+};
+```
diff --git a/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.md b/docs/development/core/server/kibana-plugin-core-server.httpservicesetup.md
@@ -87,5 +87,5 @@ async (context, request, response) => {
 |  [registerOnPreAuth](./kibana-plugin-core-server.httpservicesetup.registeronpreauth.md) | (handler: OnPreAuthHandler) =&gt; void | To define custom logic to perform for incoming requests before the Auth interceptor performs a check that user has access to requested resources. |
 |  [registerOnPreResponse](./kibana-plugin-core-server.httpservicesetup.registeronpreresponse.md) | (handler: OnPreResponseHandler) =&gt; void | To define custom logic to perform for the server response. |
 |  [registerOnPreRouting](./kibana-plugin-core-server.httpservicesetup.registeronprerouting.md) | (handler: OnPreRoutingHandler) =&gt; void | To define custom logic to perform for incoming requests before server performs a route lookup. |
-|  [registerRouteHandlerContext](./kibana-plugin-core-server.httpservicesetup.registerroutehandlercontext.md) | &lt;Context extends RequestHandlerContext, ContextName extends keyof Context&gt;(contextName: ContextName, provider: RequestHandlerContextProvider&lt;Context, ContextName&gt;) =&gt; RequestHandlerContextContainer | Register a context provider for a route handler. |
+|  [registerRouteHandlerContext](./kibana-plugin-core-server.httpservicesetup.registerroutehandlercontext.md) | &lt;Context extends RequestHandlerContext, ContextName extends keyof Omit&lt;Context, 'resolve'&gt;&gt;(contextName: ContextName, provider: RequestHandlerContextProvider&lt;Context, ContextName&gt;) =&gt; RequestHandlerContextContainer | Register a context provider for a route handler. |
 
diff --git a/...erver/kibana-plugin-core-server.httpservicesetup.registerroutehandlercontext.md b/...erver/kibana-plugin-core-server.httpservicesetup.registerroutehandlercontext.md
@@ -9,7 +9,7 @@ Register a context provider for a route handler.
 <b>Signature:</b>
 
 ```typescript
-registerRouteHandlerContext: <Context extends RequestHandlerContext, ContextName extends keyof Context>(contextName: ContextName, provider: RequestHandlerContextProvider<Context, ContextName>) => RequestHandlerContextContainer;
+registerRouteHandlerContext: <Context extends RequestHandlerContext, ContextName extends keyof Omit<Context, 'resolve'>>(contextName: ContextName, provider: RequestHandlerContextProvider<Context, ContextName>) => RequestHandlerContextContainer;
 ```
 
 ## Example

diff --git a/docs/development/core/server/kibana-plugin-core-server.icontextprovider.md b/docs/development/core/server/kibana-plugin-core-server.icontextprovider.md
@@ -9,7 +9,7 @@ A function that returns a context value for a specific key of given context type
 <b>Signature:</b>
 
 ```typescript
-export declare type IContextProvider<Context extends RequestHandlerContext, ContextName extends keyof Context> = (context: Omit<Context, ContextName>, ...rest: HandlerParameters<RequestHandler>) => Promise<Context[ContextName]> | Context[ContextName];
+export declare type IContextProvider<Context extends RequestHandlerContext, ContextName extends keyof Context> = (context: Omit<Context, ContextName>, ...rest: HandlerParameters<RequestHandler>) => MaybePromise<Awaited<Context[ContextName]>>;
 ```
 
 ## Remarks

diff --git a/docs/development/core/server/kibana-plugin-core-server.md b/docs/development/core/server/kibana-plugin-core-server.md
@@ -60,6 +60,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 |  [ConfigDeprecationDetails](./kibana-plugin-core-server.configdeprecationdetails.md) |  |
 |  [ContextSetup](./kibana-plugin-core-server.contextsetup.md) | An object that handles registration of context providers and configuring handlers with context. |
 |  [CorePreboot](./kibana-plugin-core-server.corepreboot.md) | Context passed to the <code>setup</code> method of <code>preboot</code> plugins. |
+|  [CoreRequestHandlerContext](./kibana-plugin-core-server.corerequesthandlercontext.md) | The <code>core</code> context provided to route handler.<!-- -->Provides the following clients and services: - [savedObjects.client](./kibana-plugin-core-server.savedobjectsclient.md) - Saved Objects client which uses the credentials of the incoming request - [savedObjects.typeRegistry](./kibana-plugin-core-server.isavedobjecttyperegistry.md) - Type registry containing all the registered types. - [elasticsearch.client](./kibana-plugin-core-server.iscopedclusterclient.md) - Elasticsearch data client which uses the credentials of the incoming request - [uiSettings.client](./kibana-plugin-core-server.iuisettingsclient.md) - uiSettings client which uses the credentials of the incoming request |
 |  [CoreSetup](./kibana-plugin-core-server.coresetup.md) | Context passed to the <code>setup</code> method of <code>standard</code> plugins. |
 |  [CoreStart](./kibana-plugin-core-server.corestart.md) | Context passed to the plugins <code>start</code> method. |
 |  [CoreStatus](./kibana-plugin-core-server.corestatus.md) | Status of core services. |
@@ -133,7 +134,8 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 |  [PrebootPlugin](./kibana-plugin-core-server.prebootplugin.md) | The interface that should be returned by a <code>PluginInitializer</code> for a <code>preboot</code> plugin. |
 |  [PrebootServicePreboot](./kibana-plugin-core-server.prebootservicepreboot.md) | Kibana Preboot Service allows to control the boot flow of Kibana. Preboot plugins can use it to hold the boot until certain condition is met. |
 |  [RegisterDeprecationsConfig](./kibana-plugin-core-server.registerdeprecationsconfig.md) |  |
-|  [RequestHandlerContext](./kibana-plugin-core-server.requesthandlercontext.md) | Plugin specific context passed to a route handler.<!-- -->Provides the following clients and services: - [savedObjects.client](./kibana-plugin-core-server.savedobjectsclient.md) - Saved Objects client which uses the credentials of the incoming request - [savedObjects.typeRegistry](./kibana-plugin-core-server.isavedobjecttyperegistry.md) - Type registry containing all the registered types. - [elasticsearch.client](./kibana-plugin-core-server.iscopedclusterclient.md) - Elasticsearch data client which uses the credentials of the incoming request - [uiSettings.client](./kibana-plugin-core-server.iuisettingsclient.md) - uiSettings client which uses the credentials of the incoming request |
+|  [RequestHandlerContext](./kibana-plugin-core-server.requesthandlercontext.md) | Base context passed to a route handler. |
+|  [RequestHandlerContextBase](./kibana-plugin-core-server.requesthandlercontextbase.md) | \* |
 |  [ResolveCapabilitiesOptions](./kibana-plugin-core-server.resolvecapabilitiesoptions.md) | Defines a set of additional options for the <code>resolveCapabilities</code> method of [CapabilitiesStart](./kibana-plugin-core-server.capabilitiesstart.md)<!-- -->. |
 |  [RouteConfig](./kibana-plugin-core-server.routeconfig.md) | Route specific configuration. |
 |  [RouteConfigOptions](./kibana-plugin-core-server.routeconfigoptions.md) | Additional route options. |
@@ -262,6 +264,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 |  [AuthResult](./kibana-plugin-core-server.authresult.md) |  |
 |  [CapabilitiesProvider](./kibana-plugin-core-server.capabilitiesprovider.md) | See [CapabilitiesSetup](./kibana-plugin-core-server.capabilitiessetup.md) |
 |  [CapabilitiesSwitcher](./kibana-plugin-core-server.capabilitiesswitcher.md) | See [CapabilitiesSetup](./kibana-plugin-core-server.capabilitiessetup.md) |
+|  [CustomRequestHandlerContext](./kibana-plugin-core-server.customrequesthandlercontext.md) |  |
 |  [DeprecationsDetails](./kibana-plugin-core-server.deprecationsdetails.md) |  |
 |  [DestructiveRouteMethod](./kibana-plugin-core-server.destructiveroutemethod.md) | Set of HTTP methods changing the state of the server. |
 |  [DocLinksServiceStart](./kibana-plugin-core-server.doclinksservicestart.md) |  |

diff --git a/...development/core/server/kibana-plugin-core-server.requesthandlercontext.core.md b/...development/core/server/kibana-plugin-core-server.requesthandlercontext.core.md
@@ -7,22 +7,5 @@
 <b>Signature:</b>
 
 ```typescript
-core: {
-        savedObjects: {
-            client: SavedObjectsClientContract;
-            typeRegistry: ISavedObjectTypeRegistry;
-            getClient: (options?: SavedObjectsClientProviderOptions) => SavedObjectsClientContract;
-            getExporter: (client: SavedObjectsClientContract) => ISavedObjectsExporter;
-            getImporter: (client: SavedObjectsClientContract) => ISavedObjectsImporter;
-        };
-        elasticsearch: {
-            client: IScopedClusterClient;
-        };
-        uiSettings: {
-            client: IUiSettingsClient;
-        };
-        deprecations: {
-            client: DeprecationsClient;
-        };
-    };
+core: Promise<CoreRequestHandlerContext>;
 ```
diff --git a/docs/development/core/server/kibana-plugin-core-server.requesthandlercontext.md b/docs/development/core/server/kibana-plugin-core-server.requesthandlercontext.md
@@ -4,19 +4,18 @@
 
 ## RequestHandlerContext interface
 
-Plugin specific context passed to a route handler.
-
-Provides the following clients and services: - [savedObjects.client](./kibana-plugin-core-server.savedobjectsclient.md) - Saved Objects client which uses the credentials of the incoming request - [savedObjects.typeRegistry](./kibana-plugin-core-server.isavedobjecttyperegistry.md) - Type registry containing all the registered types. - [elasticsearch.client](./kibana-plugin-core-server.iscopedclusterclient.md) - Elasticsearch data client which uses the credentials of the incoming request - [uiSettings.client](./kibana-plugin-core-server.iuisettingsclient.md) - uiSettings client which uses the credentials of the incoming request
+Base context passed to a route handler.
 
 <b>Signature:</b>
 
 ```typescript
-export interface RequestHandlerContext 
+export interface RequestHandlerContext extends RequestHandlerContextBase 
 ```
+<b>Extends:</b> RequestHandlerContextBase
 
 ## Properties
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [core](./kibana-plugin-core-server.requesthandlercontext.core.md) | { savedObjects: { client: SavedObjectsClientContract; typeRegistry: ISavedObjectTypeRegistry; getClient: (options?: SavedObjectsClientProviderOptions) =&gt; SavedObjectsClientContract; getExporter: (client: SavedObjectsClientContract) =&gt; ISavedObjectsExporter; getImporter: (client: SavedObjectsClientContract) =&gt; ISavedObjectsImporter; }; elasticsearch: { client: IScopedClusterClient; }; uiSettings: { client: IUiSettingsClient; }; deprecations: { client: DeprecationsClient; }; } |  |
+|  [core](./kibana-plugin-core-server.requesthandlercontext.core.md) | Promise&lt;CoreRequestHandlerContext&gt; |  |
 
diff --git a/.../development/core/server/kibana-plugin-core-server.requesthandlercontextbase.md b/.../development/core/server/kibana-plugin-core-server.requesthandlercontextbase.md
@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [RequestHandlerContextBase](./kibana-plugin-core-server.requesthandlercontextbase.md)
+
+## RequestHandlerContextBase interface
+
+\*
+
+<b>Signature:</b>
+
+```typescript
+export interface RequestHandlerContextBase 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [resolve](./kibana-plugin-core-server.requesthandlercontextbase.resolve.md) | &lt;T extends keyof Omit&lt;this, 'resolve'&gt;&gt;(parts: T\[\]) =&gt; Promise&lt;AwaitedProperties&lt;Pick&lt;this, T&gt;&gt;&gt; | Await all the specified context parts and return them. |
+
diff --git a/...ment/core/server/kibana-plugin-core-server.requesthandlercontextbase.resolve.md b/...ment/core/server/kibana-plugin-core-server.requesthandlercontextbase.resolve.md
@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [RequestHandlerContextBase](./kibana-plugin-core-server.requesthandlercontextbase.md) &gt; [resolve](./kibana-plugin-core-server.requesthandlercontextbase.resolve.md)
+
+## RequestHandlerContextBase.resolve property
+
+Await all the specified context parts and return them.
+
+<b>Signature:</b>
+
+```typescript
+resolve: <T extends keyof Omit<this, 'resolve'>>(parts: T[]) => Promise<AwaitedProperties<Pick<this, T>>>;
+```
+
+## Example
+
+
+```ts
+const resolved = await context.resolve(['core', 'pluginA']);
+const esClient = resolved.core.elasticsearch.client;
+const pluginAService = resolved.pluginA.someService;
+```
+
diff --git a/examples/screenshot_mode_example/server/routes.ts b/examples/screenshot_mode_example/server/routes.ts
@@ -14,7 +14,7 @@ export const registerRoutes = ({ router, log, screenshotMode }: RouteDependencie
     { path: `${BASE_API_ROUTE}/check_is_screenshot`, validate: false },
     async (ctx, req, res) => {
       log.info(`Reading screenshot mode from a request: ${screenshotMode.isScreenshotMode(req)}`);
-      log.info(`Reading is screenshot mode from ctx: ${ctx.screenshotMode.isScreenshot}`);
+      log.info(`Reading is screenshot mode from ctx: ${(await ctx.screenshotMode).isScreenshot}`);
       return res.ok();
     }
   );

diff --git a/examples/search_examples/server/routes/server_search_route.ts b/examples/search_examples/server/routes/server_search_route.ts
@@ -33,8 +33,9 @@ export function registerServerSearchRoute(router: IRouter<DataRequestHandlerCont
       const abortSignal = getRequestAbortedSignal(request.events.aborted$);
 
       try {
-        const res = await context
-          .search!.search(
+        const search = await context.search;
+        const res = await search
+          .search(
             {
               params: {
                 index,

diff --git a/packages/kbn-utility-types/src/index.ts b/packages/kbn-utility-types/src/index.ts
@@ -26,6 +26,13 @@ export type MaybePromise<T> = T | Promise<T>;
  */
 export type ShallowPromise<T> = T extends Promise<infer U> ? Promise<U> : Promise<T>;
 
+/**
+ * Unwrap all promise attributes of the given type
+ */
+export type AwaitedProperties<T> = {
+  [K in keyof T]: Awaited<T[K]>;
+};
+
 /**
  * Minimal interface for an object resembling an `Observable`.
  */