refactor: add sentry dsn rotation logic (#466)

relates-to: #458

src/Config/CliBuilder.ts

@@ -1,8 +1,8 @@
 import { CliConfig, ConfigReader } from './ConfigReader';
-import { ClusterArgs, Helpers, logger, LogLevel } from '../Utils';
+import { ClusterArgs, Helpers, logger, LogLevel, Sentry } from '../Utils';
+import { SystemConfigReader } from './SystemConfigReader';
 import { CliInfo } from './CliInfo';
 import { Arguments, Argv, CommandModule } from 'yargs';
-import { runWithAsyncContext, setContext } from '@sentry/node';
 
 export interface CliBuilderOptions {
   info: CliInfo;
@@ -86,20 +86,11 @@ export class CliBuilder {
       );
 
     return commands
-      .reduce((acc: Argv, item: CommandModule) => {
-        const handler = item.handler.bind(item);
-
-        item.handler = (args) =>
-          runWithAsyncContext(() => {
-            setContext('args', args);
-
-            handler(args);
-          });
-
-        acc.command(item);
-
-        return acc;
-      }, cli)
+      .reduce(
+        (acc: Argv, item: CommandModule) =>
+          acc.command(this.wrapWithSentry(item)),
+        cli
+      )
       .recommendCommands()
       .demandCommand(1)
       .strict(true)
@@ -109,4 +100,38 @@ export class CliBuilder {
       .alias('h', 'help')
       .wrap(null);
   }
+
+  private wrapWithSentry(command: CommandModule) {
+    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;
+        }
+      });
+
+      return Sentry.runWithAsyncContext(() => {
+        Sentry.setContext('args', args);
+
+        return handler(args);
+      });
+    };
+
+    return command;
+  }
 }

src/Config/SystemConfigReader.ts

@@ -0,0 +1,135 @@
+import { logger } from '../Utils';
+import request, { RequestPromiseAPI } from 'request-promise';
+import { readFile, writeFile } from 'fs';
+import { join } from 'path';
+import { homedir } from 'os';
+import { promisify } from 'util';
+
+export interface SystemConfig {
+  sentryDsn?: string;
+}
+
+interface SystemConfigFile {
+  data: SystemConfig;
+  updatedAt: Date;
+}
+
+export class SystemConfigReader {
+  private readonly rotationInterval = 3600000;
+  private readonly path = join(homedir(), '.brightclirc');
+  private readonly client: RequestPromiseAPI;
+
+  constructor(baseUrl: string) {
+    this.client = request.defaults({
+      baseUrl,
+      timeout: 1500,
+      json: true
+    });
+  }
+
+  public async read(): Promise<SystemConfig> {
+    await this.rotateIfNecessary();
+    const configFile = await this.getConfigFile();
+
+    return {
+      sentryDsn: process.env['SENTRY_DSN'],
+      ...configFile.data
+    };
+  }
+
+  private needsRotation(configFile: SystemConfigFile) {
+    if (process.env.NODE_ENV !== 'production') {
+      return;
+    }
+
+    const lifeTime = Date.now() - configFile.updatedAt.getTime();
+
+    return lifeTime >= this.rotationInterval;
+  }
+
+  private async rotateIfNecessary() {
+    logger.debug('Trying to rotate system config');
+
+    const configFile = await this.getConfigFile();
+
+    if (!this.needsRotation(configFile)) {
+      logger.debug(
+        'Rotation is not needed, last updated on: %s ms',
+        configFile.updatedAt
+      );
+
+      return;
+    }
+
+    logger.debug(
+      'Rotating system config last updated on: %s ms',
+      configFile.updatedAt
+    );
+
+    const newConfig = await this.fetchNewConfig();
+
+    if (newConfig) {
+      await this.updateConfigFile({
+        data: newConfig,
+        updatedAt: new Date()
+      });
+    } else {
+      logger.debug('Rotation failed');
+
+      await this.updateConfigFile({
+        ...configFile,
+        updatedAt: new Date()
+      });
+    }
+  }
+
+  private defaultConfigFile(): SystemConfigFile {
+    return {
+      data: {},
+      updatedAt: new Date()
+    };
+  }
+
+  private async getConfigFile() {
+    const defaultConfigFile = this.defaultConfigFile();
+
+    try {
+      logger.debug('Loading system config file');
+
+      const file = await promisify(readFile)(this.path);
+      const fileConfig = JSON.parse(file.toString()) as SystemConfigFile;
+
+      return {
+        ...fileConfig,
+        updatedAt: new Date(fileConfig.updatedAt)
+      };
+    } catch (e) {
+      logger.debug('Error during loading system config file', e);
+      logger.debug('Using default system config file');
+
+      return defaultConfigFile;
+    }
+  }
+
+  private async updateConfigFile(configFile: SystemConfigFile) {
+    logger.debug('Updating system config file');
+
+    try {
+      await promisify(writeFile)(this.path, JSON.stringify(configFile));
+    } catch (e) {
+      logger.debug('Error during updating system config file', e);
+    }
+  }
+
+  private async fetchNewConfig(): Promise<SystemConfig | undefined> {
+    logger.debug('Fetching new system config');
+
+    try {
+      return await this.client.get({
+        uri: '/api/v1/cli/config'
+      });
+    } catch (e) {
+      logger.debug('Error during fetching new system config: ', e);
+    }
+  }
+}

src/Utils/Sentry.ts

@@ -1,20 +1,3 @@
-import { init } from '@sentry/node';
+import { init, setContext, runWithAsyncContext } from '@sentry/node';
 
-export function sentry() {
-  init({
-    attachStacktrace: true,
-    dsn: process.env.SENTRY_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;
-    }
-  });
-}
+export default { init, setContext, runWithAsyncContext };

src/Utils/index.ts

@@ -3,4 +3,4 @@ export * from './Helpers';
 export * from './Logger';
 export * from './Backoff';
 export * from './Traceroute';
-export * from './Sentry';
+export { default as Sentry } from './Sentry';

src/index.ts

@@ -16,9 +16,6 @@ import {
   Integration
 } from './Commands';
 import { CliBuilder, container } from './Config';
-import { sentry } from './Utils';
-
-sentry();
 
 container.resolve(CliBuilder).build({
   commands: [