refactor: add system config background rotation

Author: lsndr

src/Config/CliBuilder.ts

@@ -1,6 +1,6 @@
 import { CliConfig, ConfigReader } from './ConfigReader';
 import { ClusterArgs, Helpers, logger, LogLevel, Sentry } from '../Utils';
-import { SystemConfigReader } from './SystemConfigReader';
+import { SystemConfigManager } from './SystemConfigManager';
 import { CliInfo } from './CliInfo';
 import { Arguments, Argv, CommandModule } from 'yargs';
 
@@ -105,33 +105,40 @@ export class CliBuilder {
     const handler = command.handler.bind(command);
 
     command.handler = async (args: Arguments) => {
-      const systemConfigReader = new SystemConfigReader(args.api as string);
-      const systemConfig = await systemConfigReader.read();
-
-      Sentry.init({
-        attachStacktrace: true,
-        dsn: systemConfig.sentryDsn,
-        release: process.env.VERSION,
-        beforeSend(event) {
-          if (event.contexts.args) {
-            event.contexts.args = {
-              ...event.contexts.args,
-              t: event.contexts.args.t && '[Filtered]',
-              token: event.contexts.args.token && '[Filtered]'
-            };
-          }
-
-          return event;
-        }
-      });
+      const systemConfigManager = new SystemConfigManager(args.api as string);
+      const systemConfig = await systemConfigManager.read();
 
       return Sentry.runWithAsyncContext(() => {
+        this.initSentry(systemConfig.sentryDsn);
         Sentry.setContext('args', args);
 
+        systemConfigManager.enableBackgroundRotation((rotatedSystemConfig) => {
+          this.initSentry(rotatedSystemConfig.sentryDsn);
+        });
+
         return handler(args);
       });
     };
 
     return command;
   }
+
+  private initSentry(dsn: string) {
+    Sentry.init({
+      attachStacktrace: true,
+      dsn,
+      release: process.env.VERSION,
+      beforeSend(event) {
+        if (event.contexts.args) {
+          event.contexts.args = {
+            ...event.contexts.args,
+            t: event.contexts.args.t && '[Filtered]',
+            token: event.contexts.args.token && '[Filtered]'
+          };
+        }
+
+        return event;
+      }
+    });
+  }
 }

src/Config/SystemConfigReader.ts renamed to src/Config/SystemConfigManager.ts

@@ -14,10 +14,11 @@ interface SystemConfigFile {
   updatedAt: Date;
 }
 
-export class SystemConfigReader {
+export class SystemConfigManager {
   private readonly rotationInterval = 3600000;
   private readonly path = join(homedir(), '.brightclirc');
   private readonly client: RequestPromiseAPI;
+  private isBackgroundRotationEnabled = false;
 
   constructor(baseUrl: string) {
     this.client = request.defaults({
@@ -37,6 +38,41 @@ export class SystemConfigReader {
     };
   }
 
+  public enableBackgroundRotation(onRotation: (config: SystemConfig) => void) {
+    this.isBackgroundRotationEnabled = true;
+
+    (async () => {
+      while (this.isBackgroundRotationEnabled) {
+        logger.debug('Performing background rotation of system config file');
+
+        const isRotated = await this.rotateIfNecessary();
+
+        if (isRotated) {
+          const configFile = await this.getConfigFile();
+
+          onRotation(configFile.data);
+        }
+
+        logger.debug(
+          'Background rotation is done, sleeping for %s ms',
+          this.rotationInterval
+        );
+
+        await this.sleep(this.rotationInterval);
+      }
+    })().catch((e) => {
+      logger.debug('An error occurred during background rotation', e);
+    });
+  }
+
+  public disableBackgroundRotation() {
+    this.isBackgroundRotationEnabled = false;
+  }
+
+  private sleep(ms: number) {
+    return new Promise((resolve) => setTimeout(resolve, ms).unref());
+  }
+
   private needsRotation(configFile: SystemConfigFile) {
     if (process.env.NODE_ENV !== 'production') {
       return;
@@ -58,7 +94,7 @@ export class SystemConfigReader {
         configFile.updatedAt
       );
 
-      return;
+      return false;
     }
 
     logger.debug(
@@ -73,13 +109,17 @@ export class SystemConfigReader {
         data: newConfig,
         updatedAt: new Date()
       });
+
+      return true;
     } else {
       logger.debug('Rotation failed');
 
       await this.updateConfigFile({
         ...configFile,
         updatedAt: new Date()
       });
+
+      return false;
     }
   }