update types

Signed-off-by: Tianle Huang <tianleh@amazon.com>
opensearch-project · Apr 10, 2024 · c00bb41 · c00bb41
1 parent 667e834
commit c00bb41
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 19 deletions.
diff --git a/src/plugins/application_config/server/opensearch_config_client.ts b/src/plugins/application_config/server/opensearch_config_client.ts
@@ -12,13 +12,13 @@ export class OpenSearchConfigurationClient implements ConfigurationClient {
   private client: IScopedClusterClient;
   private configurationIndexName: string;
   private readonly logger: Logger;
-  private cache: LRUCache<string, string>;
+  private cache: LRUCache<string, string | undefined>;
 
   constructor(
     scopedClusterClient: IScopedClusterClient,
     configurationIndexName: string,
     logger: Logger,
-    cache: LRUCache<string, string>
+    cache: LRUCache<string, string | undefined>
   ) {
     this.client = scopedClusterClient;
     this.configurationIndexName = configurationIndexName;
@@ -29,21 +29,17 @@ export class OpenSearchConfigurationClient implements ConfigurationClient {
   async getEntityConfig(entity: string) {
     const entityValidated = validate(entity, this.logger);
 
-    const cachedValue = this.cache.get(entityValidated);
-
     if (this.cache.has(entityValidated)) {
-      this.logger.info(`found value ${cachedValue} from cache`);
-      return cachedValue;
+      this.logger.info(`Key ${entityValidated} is found from cache.`);
+      return this.cache.get(entityValidated);
     }
 
-    this.logger.info('No value found in cache');
-
     try {
       const data = await this.client.asInternalUser.get({
         index: this.configurationIndexName,
         id: entityValidated,
       });
-      const value = data?.body?._source?.value || '';
+      const value = data?.body?._source?.value;
 
       this.cache.set(entityValidated, value);
 
@@ -53,7 +49,7 @@ export class OpenSearchConfigurationClient implements ConfigurationClient {
 
       this.logger.error(errorMessage);
 
-      this.cache.set(entityValidated, '');
+      this.cache.set(entityValidated, undefined);
       throw e;
     }
   }
@@ -98,11 +94,13 @@ export class OpenSearchConfigurationClient implements ConfigurationClient {
     } catch (e) {
       if (e?.body?.error?.type === 'index_not_found_exception') {
         this.logger.info('Attemp to delete a not found index.');
+        this.cache.del(entityValidated);
         return entityValidated;
       }
 
       if (e?.body?.result === 'not_found') {
         this.logger.info('Attemp to delete a not found document.');
+        this.cache.del(entityValidated);
         return entityValidated;
       }
 

diff --git a/src/plugins/application_config/server/plugin.ts b/src/plugins/application_config/server/plugin.ts
@@ -13,7 +13,6 @@ import {
   CoreStart,
   Plugin,
   Logger,
-  IScopedClusterClient,
   SharedGlobalConfig,
   OpenSearchDashboardsRequest,
   IClusterClient,
@@ -36,7 +35,7 @@ export class ApplicationConfigPlugin
   private configurationIndexName: string;
   private clusterClient: IClusterClient;
 
-  private cache: LRUCache<string, string>;
+  private cache: LRUCache<string, string | undefined>;
 
   constructor(initializerContext: PluginInitializerContext) {
     this.logger = initializerContext.logger.get();
@@ -45,8 +44,8 @@ export class ApplicationConfigPlugin
     this.clusterClient = null;
 
     this.cache = new LRUCache({
-      max: 30,
-      maxAge: 100 * 1000,
+      max: 100, // at most 100 entries
+      maxAge: 10 * 60 * 1000, // 10 mins
     });
   }
 

diff --git a/src/plugins/application_config/server/types.ts b/src/plugins/application_config/server/types.ts
@@ -3,10 +3,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { IScopedClusterClient, Headers } from 'src/core/server';
+import { Headers, OpenSearchDashboardsRequest } from 'src/core/server';
 
 export interface ApplicationConfigPluginSetup {
-  getConfigurationClient: (inputOpenSearchClient: IScopedClusterClient) => ConfigurationClient;
+  getConfigurationClient: (request: OpenSearchDashboardsRequest) => ConfigurationClient;
   registerConfigurationClient: (inputConfigurationClient: ConfigurationClient) => void;
 }
 // eslint-disable-next-line @typescript-eslint/no-empty-interface

diff --git a/src/plugins/csp_handler/server/csp_handlers.ts b/src/plugins/csp_handler/server/csp_handlers.ts
@@ -30,7 +30,7 @@ const CSP_RULES_CONFIG_KEY = 'csp.rules';
 export function createCspRulesPreResponseHandler(
   core: CoreSetup,
   cspHeader: string,
-  getConfigurationClient: (scopedClusterClient: IScopedClusterClient) => ConfigurationClient,
+  getConfigurationClient: (request: OpenSearchDashboardsRequest) => ConfigurationClient,
   logger: Logger
 ): OnPreResponseHandler {
   return async (
@@ -47,8 +47,6 @@ export function createCspRulesPreResponseHandler(
         return toolkit.next({});
       }
 
-      const [coreStart] = await core.getStartServices();
-
       const client = getConfigurationClient(request);
 
       const cspRules = await client.getEntityConfig(CSP_RULES_CONFIG_KEY, {