fix(toolkit-lib): unnecessary dependency on promptly (#523)

Fixes #396 

This PR refactors the resource import prompts to use the IoHost instead.
With that change, we can remove the promptly library as a toolkit-lib
dependency and only have it in the CLI.

The change itself is not in a code path that is currently publicly
available to toolkit-lib users, it only affects the `cdk import`
command. The user experience for this is virtually unchanged, see
screenshots.

Before:

<img width="691" alt="image"
src="https://github.com/user-attachments/assets/1f13644a-e8bc-4a7b-bfca-bf23fdfb9ceb"
/>
<img width="956" alt="image"
src="https://github.com/user-attachments/assets/57181fa6-4c20-4b81-9ce7-c1451f62e033"
/>
<img width="1224" alt="image"
src="https://github.com/user-attachments/assets/ee2768da-1eca-42b8-8c2e-c00772f07d99"
/>


After:

<img width="681" alt="image"
src="https://github.com/user-attachments/assets/f5185293-d381-44ad-94a5-76b47224b703"
/>
<img width="954" alt="image"
src="https://github.com/user-attachments/assets/1a4e5a6b-ec89-469e-9b8e-8e2e4cbaf950"
/>
<img width="1110" alt="image"
src="https://github.com/user-attachments/assets/e0d43e3b-91d6-4f7b-9c65-fae3387c874c"
/>

---
By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache-2.0 license

Author: mrgrain

.projenrc.ts

@@ -751,7 +751,6 @@ const toolkitLib = configureProject(
       'glob',
       'minimatch',
       'p-limit@^3',
-      'promptly',
       'proxy-agent',
       'semver',
       'split2',
@@ -773,6 +772,8 @@ const toolkitLib = configureProject(
       'aws-sdk-client-mock-jest',
       'fast-check',
       'jest-environment-node',
+      '@types/jest-when',
+      'jest-when',
       'nock@13',
       'typedoc',
       'xml-js',

packages/@aws-cdk-testing/cli-integ/tests/cli-integ-tests/import/cdk-import-interactive.integtest.ts

@@ -25,11 +25,11 @@ integTest('cdk import prompts the user for sns topic arns', withDefaultFixture(a
     await fixture.cdk(['import', fullStackName], {
       interact: [
         {
-          prompt: /Topic1.*\(empty to skip\):/,
+          prompt: /Topic1.*\(empty to skip\)/,
           input: topic1Arn,
         },
         {
-          prompt: /Topic2.*\(empty to skip\):/,
+          prompt: /Topic2.*\(empty to skip\)/,
           input: topic2Arn,
         },
       ],

packages/@aws-cdk/toolkit-lib/.projen/deps.json

@@ -67,6 +67,8 @@ Please let us know by [opening an issue](https://github.com/aws/aws-cdk-cli/issu
 | `CDK_TOOLKIT_I1901` | Provides stack data | `result` | {@link StackAndAssemblyData} |
 | `CDK_TOOLKIT_I1902` | Successfully deployed stacks | `result` | {@link AssemblyData} |
 | `CDK_TOOLKIT_I2901` | Provides details on the selected stacks and their dependencies | `result` | {@link StackDetailsPayload} |
+| `CDK_TOOLKIT_I3100` | Confirm the import of a specific resource | `info` | {@link ResourceImportRequest} |
+| `CDK_TOOLKIT_I3110` | Additional information is needed to identify a resource | `info` | {@link ResourceIdentificationRequest} |
 | `CDK_TOOLKIT_E3900` | Resource import failed | `error` | {@link ErrorPayload} |
 | `CDK_TOOLKIT_I4000` | Diff stacks is starting | `trace` | {@link StackSelectionDetails} |
 | `CDK_TOOLKIT_I4001` | Output of the diff command | `info` | {@link DiffResult} |

packages/@aws-cdk/toolkit-lib/.projen/tasks.json

@@ -8,6 +8,7 @@ import type { BuildAsset, DeployConfirmationRequest, PublishAsset, StackDeployPr
 import type { StackDestroy, StackDestroyProgress } from '../../../payloads/destroy';
 import type { AssetBatchDeletionRequest } from '../../../payloads/gc';
 import type { HotswapDeploymentDetails, HotswapDeploymentAttempt, HotswappableChange, HotswapResult } from '../../../payloads/hotswap';
+import type { ResourceIdentificationRequest, ResourceImportRequest } from '../../../payloads/import';
 import type { StackDetailsPayload } from '../../../payloads/list';
 import type { CloudWatchLogEvent, CloudWatchLogMonitorControlEvent } from '../../../payloads/logs-monitor';
 import type { RefactorResult } from '../../../payloads/refactor';
@@ -61,6 +62,16 @@ export const IO = {
   }),
 
   // 3: Import & Migrate
+  CDK_TOOLKIT_I3100: make.confirm<ResourceImportRequest>({
+    code: 'CDK_TOOLKIT_I3100',
+    description: 'Confirm the import of a specific resource',
+    interface: 'ResourceImportRequest',
+  }),
+  CDK_TOOLKIT_I3110: make.question<ResourceIdentificationRequest>({
+    code: 'CDK_TOOLKIT_I3110',
+    description: 'Additional information is needed to identify a resource',
+    interface: 'ResourceIdentificationRequest',
+  }),
   CDK_TOOLKIT_E3900: make.error<ErrorPayload>({
     code: 'CDK_TOOLKIT_E3900',
     description: 'Resource import failed',

packages/@aws-cdk/toolkit-lib/docs/message-registry.md

@@ -5,7 +5,6 @@ import type * as cxapi from '@aws-cdk/cx-api';
 import type { ResourceIdentifierSummary, ResourceToImport } from '@aws-sdk/client-cloudformation';
 import * as chalk from 'chalk';
 import * as fs from 'fs-extra';
-import * as promptly from 'promptly';
 import type { DeploymentMethod } from '../../actions/deploy';
 import { ToolkitError } from '../../toolkit/toolkit-error';
 import type { Deployments } from '../deployments';
@@ -347,10 +346,14 @@ export class ResourceImporter {
       const candidateProps = Object.fromEntries(satisfiedPropSet.map(p => [p, resourceProps[p]]));
       const displayCandidateProps = fmtdict(candidateProps);
 
-      if (await promptly.confirm(
-        `${chalk.blue(resourceName)} (${resourceType}): import with ${chalk.yellow(displayCandidateProps)} (yes/no) [default: yes]? `,
-        { default: 'yes' },
-      )) {
+      const importTheResource = await this.ioHelper.requestResponse(IO.CDK_TOOLKIT_I3100.req(`${chalk.blue(resourceName)} (${resourceType}): import with ${chalk.yellow(displayCandidateProps)}`, {
+        resource: {
+          type: resourceType,
+          props: candidateProps,
+          stringifiedProps: displayCandidateProps,
+        },
+      }));
+      if (importTheResource) {
         return candidateProps;
       }
     }
@@ -364,35 +367,32 @@ export class ResourceImporter {
     // We cannot auto-import this, ask the user for one of the props
     // The only difference between these cases is what we print: for multiple properties, we print a preamble
     const prefix = `${chalk.blue(resourceName)} (${resourceType})`;
-    let preamble;
-    let promptPattern;
+    const promptPattern = `${prefix}: enter %s`;
     if (idPropSets.length > 1) {
-      preamble = `${prefix}: enter one of ${idPropSets.map(x => chalk.blue(x.join('+'))).join(', ')} to import (all empty to skip)`;
-      promptPattern = `${prefix}: enter %`;
-    } else {
-      promptPattern = `${prefix}: enter %`;
+      const preamble = `${prefix}: enter one of ${idPropSets.map(x => chalk.blue(x.join('+'))).join(', ')} to import (leave all empty to skip)`;
+      await this.ioHelper.defaults.info(preamble);
     }
 
     // Do the input loop here
-    if (preamble) {
-      await this.ioHelper.defaults.info(preamble);
-    }
     for (const idProps of idPropSets) {
       const input: Record<string, string> = {};
       for (const idProp of idProps) {
         // If we have a value from the template, use it as default. This will only be a partial
         // identifier if present, otherwise we would have done the import already above.
         const defaultValue = resourceProps[idProp] ?? '';
 
-        const prompt = [
-          promptPattern.replace(/%/g, chalk.blue(idProp)),
-          defaultValue
-            ? `[${defaultValue}]`
-            : '(empty to skip)',
-        ].join(' ') + ':';
-        const response = await promptly.prompt(prompt,
-          { default: defaultValue, trim: true },
-        );
+        const response = await this.ioHelper.requestResponse(IO.CDK_TOOLKIT_I3110.req(
+          format(promptPattern, chalk.blue(idProp)),
+          {
+            resource: {
+              name: resourceName,
+              type: resourceType,
+              idProp,
+            },
+            responseDescription: defaultValue ? undefined : 'empty to skip',
+          },
+          defaultValue,
+        ));
 
         if (!response) {
           break;

packages/@aws-cdk/toolkit-lib/lib/api/io/private/messages.ts

@@ -0,0 +1,47 @@
+import type { DataRequest } from './types';
+
+/**
+ * A proposed resource import.
+ */
+export interface ResourceImportRequest {
+  /**
+   * The resource to be imported
+   */
+  readonly resource: {
+    /**
+     * The CloudFormation resource type of the resource
+     */
+    readonly type: string;
+    /**
+     * The properties of the imported resource
+     */
+    readonly props: Record<string, any>;
+    /**
+     * A formattated string representation of the props.
+     */
+    readonly stringifiedProps: string;
+  };
+}
+
+/**
+ * A resource that needs to be identified during an import.
+ */
+export interface ResourceIdentificationRequest extends DataRequest {
+  /**
+   * The resource that needs to be identified.
+   */
+  readonly resource: {
+    /**
+     * The construct path or logical id of the resource.
+     */
+    readonly name: string;
+    /**
+     * The type of the resource.
+     */
+    readonly type: string;
+    /**
+     * The property that we try to identify the resource by.
+     */
+    readonly idProp: string;
+  };
+}

packages/@aws-cdk/toolkit-lib/lib/api/resource-import/importer.ts

@@ -16,3 +16,4 @@ export * from './diff';
 export * from './logs-monitor';
 export * from './hotswap';
 export * from './gc';
+export * from './import';

packages/@aws-cdk/toolkit-lib/lib/payloads/import.ts

@@ -1,4 +1,5 @@
-import type { IIoHost, IoMessage, IoMessageLevel, IoRequest } from '../../lib/api/io';
+import { when } from 'jest-when';
+import type { IIoHost, IoMessage, IoMessageCode, IoMessageLevel, IoRequest } from '../../lib/api/io';
 import type { IoHelper } from '../../lib/api/io/private';
 import { asIoHelper, isMessageRelevantForLevel } from '../../lib/api/io/private';
 
@@ -66,4 +67,26 @@ export class TestIoHost implements IIoHost {
       message: expect.stringContaining(m.containing),
     }));
   }
+
+  /**
+   * Mocks the response for a given message code.
+   *
+   * Use `requestSpy.mockReset()` to remove mock.
+   */
+  public mockResponse(code: IoMessageCode, response: any) {
+    when(this.requestSpy)
+      .calledWith(expect.objectContaining({ code }))
+      .mockResolvedValue(response);
+  }
+
+  /**
+   * Mocks the response for a given message code, only once.
+   *
+   * Use `requestSpy.mockReset()` to remove mock.
+   */
+  public mockResponseOnce(code: IoMessageCode, response: any) {
+    when(this.requestSpy)
+      .calledWith(expect.objectContaining({ code }))
+      .mockResolvedValueOnce(response);
+  }
 }