@aws-cdk/toolkit-lib 0.1.5 → 0.1.6

package/lib/api/shared-private.js

@@ -30,10 +30,13 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // lib/api/shared-private.ts
 var shared_private_exports = {};
 __export(shared_private_exports, {
+  FakeIoHost: () => FakeIoHost,
   IO: () => IO,
+  IoDefaultMessages: () => IoDefaultMessages,
   IoHelper: () => IoHelper,
   SPAN: () => SPAN,
   SpanMaker: () => SpanMaker,
+  TestIoHost: () => TestIoHost,
   asIoHelper: () => asIoHelper,
   confirm: () => confirm,
   debug: () => debug,
@@ -130,19 +133,20 @@ var SpanMaker = class {
     this.definition = definition;
     this.ioHelper = ioHelper;
   }
-  async begin(first, second) {
+  async begin(a, b) {
     const spanId = uuid.v4();
     const startTime = (/* @__PURE__ */ new Date()).getTime();
     const notify = (msg) => {
       return this.ioHelper.notify(withSpanId(spanId, msg));
     };
-    const startMsg = second ? first : "Starting %s ...";
-    const startPayload = second ?? first;
+    const startInput = parseArgs(a, b);
+    const startMsg = startInput.message ?? `Starting ${this.definition.name} ...`;
+    const startPayload = startInput.payload;
     await notify(this.definition.start.msg(
-      util.format(startMsg, this.definition.name),
+      startMsg,
       startPayload
     ));
-    const timingMsg = "\n\u2728  %s time: %ds\n";
+    const timingMsgTemplate = "\n\u2728  %s time: %ds\n";
     const time = () => {
       const elapsedTime = (/* @__PURE__ */ new Date()).getTime() - startTime;
       return {
@@ -151,13 +155,7 @@ var SpanMaker = class {
       };
     };
     return {
-      elapsedTime: async (msg) => {
-        if (msg) {
-          await notify({
-            ...msg,
-            data: msg.data
-          });
-        }
+      elapsedTime: async () => {
         return time();
       },
       notify: async (msg) => {
@@ -165,18 +163,19 @@ var SpanMaker = class {
       },
       timing: async (maker, message2) => {
         const duration = time();
-        const endMsg = message2 ? message2 : timingMsg;
-        await notify(maker.msg(util.format(endMsg, this.definition.name, duration.asSec), {
+        const timingMsg = message2 ? message2 : util.format(timingMsgTemplate, this.definition.name, duration.asSec);
+        await notify(maker.msg(timingMsg, {
           duration: duration.asMs
         }));
         return duration;
       },
-      end: async (a, b) => {
+      end: async (x, y) => {
         const duration = time();
-        const endMsg = b ? a : timingMsg;
-        const endPayload = b ?? a;
+        const endInput = parseArgs(x, y);
+        const endMsg = endInput.message ?? util.format(timingMsgTemplate, this.definition.name, duration.asSec);
+        const endPayload = endInput.payload;
         await notify(this.definition.end.msg(
-          util.format(endMsg, this.definition.name, duration.asSec),
+          endMsg,
           {
             duration: duration.asMs,
             ...endPayload
@@ -187,6 +186,15 @@ var SpanMaker = class {
     };
   }
 };
+function parseArgs(first, second) {
+  const firstIsMessage = typeof first === "string";
+  const message2 = firstIsMessage || second ? first : void 0;
+  const payload = firstIsMessage || second ? second : first;
+  return {
+    message: message2,
+    payload
+  };
+}
 function withSpanId(span, message2) {
   return {
     ...message2,
@@ -295,7 +303,7 @@ var confirm = (details) => request("info", {
 
 // ../tmp-toolkit-helpers/src/api/io/private/messages.ts
 var IO = {
-  // Defaults
+  // Defaults (0000)
   DEFAULT_TOOLKIT_INFO: info({
     code: "CDK_TOOLKIT_I0000",
     description: "Default info messages emitted from the Toolkit"
@@ -308,7 +316,15 @@ var IO = {
     code: "CDK_TOOLKIT_W0000",
     description: "Default warning messages emitted from the Toolkit"
   }),
-  // 1: Synth
+  DEFAULT_TOOLKIT_ERROR: error({
+    code: "CDK_TOOLKIT_E0000",
+    description: "Default error messages emitted from the Toolkit"
+  }),
+  DEFAULT_TOOLKIT_TRACE: trace({
+    code: "CDK_TOOLKIT_I0000",
+    description: "Default trace messages emitted from the Toolkit"
+  }),
+  // 1: Synth (1xxx)
   CDK_TOOLKIT_I1000: info({
     code: "CDK_TOOLKIT_I1000",
     description: "Provides synthesis times.",
@@ -329,7 +345,7 @@ var IO = {
     description: "Successfully deployed stacks",
     interface: "AssemblyData"
   }),
-  // 2: List
+  // 2: List (2xxx)
   CDK_TOOLKIT_I2901: result({
     code: "CDK_TOOLKIT_I2901",
     description: "Provides details on the selected stacks and their dependencies",
@@ -340,8 +356,8 @@ var IO = {
     code: "CDK_TOOLKIT_E3900",
     description: "Resource import failed"
   }),
-  // 4: Diff
-  // 5: Deploy & Watch
+  // 4: Diff (4xxx)
+  // 5: Deploy & Watch (5xxx)
   CDK_TOOLKIT_I5000: info({
     code: "CDK_TOOLKIT_I5000",
     description: "Provides deployment times",
@@ -403,7 +419,7 @@ var IO = {
     description: "Stack deploy progress",
     interface: "StackDeployProgress"
   }),
-  // Assets
+  // Assets (52xx)
   CDK_TOOLKIT_I5210: trace({
     code: "CDK_TOOLKIT_I5210",
     description: "Started building a specific asset",
@@ -424,7 +440,7 @@ var IO = {
     description: "Publishing the asset has completed",
     interface: "Duration"
   }),
-  // Watch
+  // Watch (53xx)
   CDK_TOOLKIT_I5310: debug({
     code: "CDK_TOOLKIT_I5310",
     description: "The computed settings used for file watching",
@@ -453,7 +469,18 @@ var IO = {
     code: "CDK_TOOLKIT_I5315",
     description: "Queued watch deployment started"
   }),
-  // Stack Monitor
+  // Hotswap (54xx)
+  CDK_TOOLKIT_I5400: trace({
+    code: "CDK_TOOLKIT_I5400",
+    description: "Starting a hotswap deployment",
+    interface: "HotswapDeployment"
+  }),
+  CDK_TOOLKIT_I5410: info({
+    code: "CDK_TOOLKIT_I5410",
+    description: "Hotswap deployment has ended, a full deployment might still follow if needed",
+    interface: "Duration"
+  }),
+  // Stack Monitor (55xx)
   CDK_TOOLKIT_I5501: info({
     code: "CDK_TOOLKIT_I5501",
     description: "Stack Monitoring: Start monitoring of a single stack",
@@ -469,7 +496,7 @@ var IO = {
     description: "Stack Monitoring: Finished monitoring of a single stack",
     interface: "StackMonitoringControlEvent"
   }),
-  // Success
+  // Success (59xx)
   CDK_TOOLKIT_I5900: result({
     code: "CDK_TOOLKIT_I5900",
     description: "Deployment results on success",
@@ -493,7 +520,7 @@ var IO = {
     description: "Stack Monitoring error",
     interface: "ErrorPayload"
   }),
-  // 6: Rollback
+  // 6: Rollback (6xxx)
   CDK_TOOLKIT_I6000: info({
     code: "CDK_TOOLKIT_I6000",
     description: "Provides rollback times",
@@ -513,7 +540,7 @@ var IO = {
     description: "Rollback failed",
     interface: "ErrorPayload"
   }),
-  // 7: Destroy
+  // 7: Destroy (7xxx)
   CDK_TOOLKIT_I7000: info({
     code: "CDK_TOOLKIT_I7000",
     description: "Provides destroy times",
@@ -553,7 +580,7 @@ var IO = {
     description: "Stack deletion failed",
     interface: "ErrorPayload"
   }),
-  // 9: Bootstrap
+  // 9: Bootstrap (9xxx)
   CDK_TOOLKIT_I9000: info({
     code: "CDK_TOOLKIT_I9000",
     description: "Provides bootstrap times",
@@ -574,6 +601,23 @@ var IO = {
     description: "Bootstrap failed",
     interface: "ErrorPayload"
   }),
+  // Notices
+  CDK_TOOLKIT_I0100: info({
+    code: "CDK_TOOLKIT_I0100",
+    description: "Notices decoration (the header or footer of a list of notices)"
+  }),
+  CDK_TOOLKIT_W0101: warn({
+    code: "CDK_TOOLKIT_W0101",
+    description: "A notice that is marked as a warning"
+  }),
+  CDK_TOOLKIT_E0101: error({
+    code: "CDK_TOOLKIT_E0101",
+    description: "A notice that is marked as an error"
+  }),
+  CDK_TOOLKIT_I0101: info({
+    code: "CDK_TOOLKIT_I0101",
+    description: "A notice that is marked as informational"
+  }),
   // Assembly codes
   CDK_ASSEMBLY_I0010: debug({
     code: "CDK_ASSEMBLY_I0010",
@@ -690,14 +734,129 @@ var SPAN = {
     name: "Publish Asset",
     start: IO.CDK_TOOLKIT_I5220,
     end: IO.CDK_TOOLKIT_I5221
+  },
+  HOTSWAP: {
+    name: "hotswap-deployment",
+    start: IO.CDK_TOOLKIT_I5400,
+    end: IO.CDK_TOOLKIT_I5410
+  }
+};
+
+// ../tmp-toolkit-helpers/src/api/io/private/io-default-messages.ts
+var util2 = __toESM(require("util"));
+var IoDefaultMessages = class {
+  constructor(ioHelper) {
+    this.ioHelper = ioHelper;
+  }
+  notify(msg) {
+    return this.ioHelper.notify(msg);
+  }
+  requestResponse(msg) {
+    return this.ioHelper.requestResponse(msg);
+  }
+  error(input, ...args) {
+    this.emitMessage(IO.DEFAULT_TOOLKIT_ERROR, input, ...args);
+  }
+  warn(input, ...args) {
+    this.emitMessage(IO.DEFAULT_TOOLKIT_WARN, input, ...args);
+  }
+  warning(input, ...args) {
+    this.emitMessage(IO.DEFAULT_TOOLKIT_WARN, input, ...args);
+  }
+  info(input, ...args) {
+    this.emitMessage(IO.DEFAULT_TOOLKIT_INFO, input, ...args);
+  }
+  debug(input, ...args) {
+    this.emitMessage(IO.DEFAULT_TOOLKIT_DEBUG, input, ...args);
+  }
+  trace(input, ...args) {
+    this.emitMessage(IO.DEFAULT_TOOLKIT_TRACE, input, ...args);
+  }
+  result(input, ...args) {
+    const message2 = args.length > 0 ? util2.format(input, ...args) : input;
+    void this.ioHelper.notify({
+      time: /* @__PURE__ */ new Date(),
+      code: IO.DEFAULT_TOOLKIT_INFO.code,
+      level: "result",
+      message: message2,
+      data: void 0
+    });
+  }
+  emitMessage(maker, input, ...args) {
+    const message2 = args.length > 0 ? util2.format(input, ...args) : input;
+    void this.ioHelper.notify(maker.msg(message2));
+  }
+};
+
+// ../tmp-toolkit-helpers/src/api/io/private/testing/test-io-host.ts
+var TestIoHost = class {
+  constructor(level = "info") {
+    this.level = level;
+    this.notifySpy = jest.fn();
+    this.requestSpy = jest.fn();
+  }
+  notifySpy;
+  requestSpy;
+  requireDeployApproval = "never" /* NEVER */;
+  async notify(msg) {
+    if (isMessageRelevantForLevel(msg, this.level)) {
+      this.notifySpy(msg);
+    }
+  }
+  async requestResponse(msg) {
+    if (isMessageRelevantForLevel(msg, this.level) && this.needsApproval(msg)) {
+      this.requestSpy(msg);
+    }
+    return msg.defaultResponse;
+  }
+  needsApproval(msg) {
+    if (!["CDK_TOOLKIT_I5060"].includes(msg.code)) {
+      return true;
+    }
+    switch (this.requireDeployApproval) {
+      case "never" /* NEVER */:
+        return false;
+      case "any-change" /* ANY_CHANGE */:
+        return true;
+      case "broadening" /* BROADENING */:
+        return msg.data?.permissionChangeType === "broadening";
+      default:
+        return true;
+    }
+  }
+};
+
+// ../tmp-toolkit-helpers/src/api/io/private/testing/fake-io-host.ts
+var FakeIoHost = class {
+  messages = [];
+  requestResponse;
+  constructor() {
+    this.clear();
+  }
+  clear() {
+    this.messages.splice(0, this.messages.length);
+    this.requestResponse = jest.fn().mockRejectedValue(new Error("requestResponse not mocked"));
+  }
+  async notify(msg) {
+    this.messages.push(msg);
+  }
+  expectMessage(m) {
+    expect(this.messages).toContainEqual(expect.objectContaining({
+      ...m.level ? { level: m.level } : void 0,
+      // Can be a partial string as well
+      message: expect.stringContaining(m.containing)
+    }));
   }
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  FakeIoHost,
   IO,
+  IoDefaultMessages,
   IoHelper,
   SPAN,
   SpanMaker,
+  TestIoHost,
   asIoHelper,
   confirm,
   debug,