feat: add flag (and env) for specifying the monitor interval (#84)

Author: mbystedt

README.md

@@ -199,17 +199,18 @@ Monitor for changes to sync to vault
 
 ```
 USAGE
-  $ vstool monitor [-h] [--broker-api-url <value>] [--broker-token <value>] [--vault-token <value>]
-    [--vault-addr <value>] [--root <value>...]
+  $ vstool monitor [-h] [--broker-api-url <value>] [--broker-token <value>] [--monitor-interval <value>]
+    [--vault-token <value>] [--vault-addr <value>] [--root <value>...]
 
 FLAGS
-  -h, --help                    Show CLI help.
-      --broker-api-url=<value>  [default: https://broker.io.nrs.gov.bc.ca/] The broker api base url
-      --broker-token=<value>    The broker JWT
-      --root=<value>...         [default: ] The root to constrict the policy sync to. Some roots can be further
-                                constricted such as -root=apps -root=cool-app-war
-      --vault-addr=<value>      [default: http://127.0.0.1:8200] The vault address
-      --vault-token=<value>     [default: myroot] The vault token
+  -h, --help                      Show CLI help.
+      --broker-api-url=<value>    [default: https://broker.io.nrs.gov.bc.ca/] The broker api base url
+      --broker-token=<value>      The broker JWT
+      --monitor-interval=<value>  [default: 60000] The duration between each monitor check in milliseconds
+      --root=<value>...           [default: ] The root to constrict the policy sync to. Some roots can be further
+                                  constricted such as -root=apps -root=cool-app-war
+      --vault-addr=<value>        [default: http://127.0.0.1:8200] The vault address
+      --vault-token=<value>       [default: myroot] The vault token
 
 DESCRIPTION
   Monitor for changes to sync to vault

src/broker/broker-monitor.controller.ts

@@ -1,7 +1,7 @@
 import { inject, injectable } from 'inversify';
 import winston from 'winston';
-import { TYPES } from '../inversify.types';
 import { exhaustMap, timer } from 'rxjs';
+import { TYPES } from '../inversify.types';
 import VaultPolicyController from '../vault/vault-policy.controller';
 import VaultGroupController from '../vault/vault-group.controller';
 import VaultApproleController from '../vault/vault-approle.controller';
@@ -24,8 +24,16 @@ export default class BrokerMonitorController {
     private vaultPolicyController: VaultPolicyController,
   ) {}
 
-  public async monitor(root: string[]) {
-    const source$ = timer(0, 60000);
+  /**
+   * Monitor vault and sync changes
+   * @param root The policy roots to monitor
+   * @param monitorIntervalDuration The duration between each monitor check in milliseconds
+   */
+  public async monitor(
+    root: string[],
+    monitorIntervalDuration: number,
+  ): Promise<void> {
+    const source$ = timer(0, monitorIntervalDuration);
 
     source$
       .pipe(

src/commands/monitor.ts

@@ -5,6 +5,7 @@ import {
   brokerApiUrl,
   brokerToken,
   help,
+  monitorIntervalDuration,
   root,
   vaultAddr,
   vaultToken,
@@ -23,6 +24,7 @@ export default class Monitor extends Command {
     ...help,
     ...brokerApiUrl,
     ...brokerToken,
+    ...monitorIntervalDuration,
     ...vaultToken,
     ...vaultAddr,
     ...root,
@@ -42,6 +44,6 @@ export default class Monitor extends Command {
 
     await vsContainer
       .get<BrokerMonitorController>(TYPES.BrokerMonitorController)
-      .monitor(flags.root);
+      .monitor(flags.root, flags['monitor-interval']);
   }
 }

src/flags.ts

@@ -20,6 +20,14 @@ export const brokerToken = {
   }),
 };
 
+export const monitorIntervalDuration = {
+  'monitor-interval': Flags.integer({
+    description: 'The duration between each monitor check in milliseconds',
+    default: 60 * 1000,
+    env: 'MONITOR_INTERVAL_DURATION',
+  }),
+};
+
 export const secretShares = {
   'secret-shares': Flags.integer({
     description: 'The number of shares to split the master key into',
@@ -33,7 +41,6 @@ export const secretThreshold = {
     default: 1,
   }),
 };
-
 export const vaultAddr = {
   'vault-addr': Flags.string({
     default: 'http://127.0.0.1:8200',

src/inversify.config.ts

@@ -1,12 +1,12 @@
 import { Container } from 'inversify';
+import nv from 'node-vault';
+import winston from 'winston';
 import { logger } from './logger';
 import { TYPES } from './inversify.types';
 import { AppService } from './services/app.service';
 import VaultPolicyController from './vault/vault-policy.controller';
 import { vaultFactory } from './vault/vault.factory';
-import nv from 'node-vault';
 import { ConfigService } from './services/config.service';
-import winston from 'winston';
 import VaultGroupController from './vault/vault-group.controller';
 import EnvironmentUtil from './util/environment.util';
 import HclUtil from './util/hcl.util';