Merge branch '343-adjust-configu-store-for-approval-queue' into 0-mer…

…ge-of-tag-and-approval-queue

ts/packages/cli/package.json

@@ -98,8 +98,8 @@
   ],
   "dependencies": {
     "@configu/lib": "^0.7.0",
-    "@configu/node": "^0.20.1",
-    "@configu/ts": "^0.20.1",
+    "@configu/node": "^0.20.2-next.5",
+    "@configu/ts": "^0.20.2-next.5",
     "@oclif/core": "^3.14.1",
     "@oclif/plugin-autocomplete": "^3.0.3",
     "@oclif/plugin-not-found": "^3.0.5",

ts/packages/cli/src/commands/upsert.ts

@@ -1,6 +1,6 @@
 import { Flags } from '@oclif/core';
 import _ from 'lodash';
-import { ConfigSet, UpsertCommand } from '@configu/node';
+import { ConfigSet, ConfiguConfigStore, UpsertCommand } from '@configu/node';
 import { extractConfigs } from '@configu/lib';
 import { BaseCommand } from '../base';
 import { readFile } from '../helpers';
@@ -77,13 +77,24 @@ export default class Upsert extends BaseCommand<typeof Upsert> {
         .value();
     }
 
-    await new UpsertCommand({
-      store,
-      set,
-      schema,
-      configs,
-      pipe,
-    }).run();
-    this.print(`Configs upserted successfully`, { symbol: 'success' });
+    try {
+      await new UpsertCommand({
+        store,
+        set,
+        schema,
+        configs,
+        pipe,
+      }).run();
+      this.print(`Configs upserted successfully`, { symbol: 'success' });
+    } catch (error) {
+      if (error.name === ConfiguConfigStore.approvalQueueErrorName) {
+        const queueUrl = error.queueUrl as string;
+        // * print warning message with queue url highlighted with an underline
+        const warningMessage = error.message.replace(queueUrl, `\u001B[4m${queueUrl}\u001B[0m`);
+        this.print(warningMessage, { symbol: 'warning' });
+      } else {
+        throw error;
+      }
+    }
   }
 }

ts/packages/ts/src/stores/Configu.ts

@@ -10,9 +10,23 @@ export type ConfiguConfigStoreConfiguration = {
   tag?: string;
 };
 
+const ConfiguConfigStoreApprovalQueueErrorName = 'ConfiguConfigStoreApprovalQueueError';
+class ConfiguConfigStoreApprovalQueueError extends Error {
+  readonly queueUrl: string;
+  readonly name: string = ConfiguConfigStoreApprovalQueueErrorName;
+
+  constructor(protectedSet: string, queueUrl: string) {
+    super(
+      `Your recent upsert to the ${protectedSet} ConfigSet is currently pending in its approval queue, as ${protectedSet} is a "protected set". To proceed with these changes, please review and approve them at ${queueUrl}. If you lack the necessary permissions, reach out to an authorized org member.`,
+    );
+    this.queueUrl = queueUrl;
+  }
+}
+
 export class ConfiguConfigStore extends ConfigStore {
   private client: Axios;
   private tag?: string;
+  public static readonly approvalQueueErrorName = ConfiguConfigStoreApprovalQueueErrorName;
   constructor({
     credentials,
     endpoint = `https://api.configu.com`,
@@ -45,6 +59,11 @@ export class ConfiguConfigStore extends ConfigStore {
   }
 
   async set(configs: Config[]): Promise<void> {
-    await this.client.put('/config', { configs });
+    const response = await this.client.put('/config', { configs });
+    if (response.status === 202) {
+      const protectedSet = response.data.diff.pending[0].set;
+      const queueUrl = `${response.data.queueUrl}?set=${protectedSet}`;
+      throw new ConfiguConfigStoreApprovalQueueError(protectedSet, queueUrl);
+    }
   }
 }