aws-cdk 2.1000.3 → 2.1002.0

package/lib/api/stack-events/stack-activity-monitor.d.ts

@@ -1,62 +1,88 @@
 import { type MetadataEntry } from '@aws-cdk/cloud-assembly-schema';
 import type { CloudFormationStackArtifact } from '@aws-cdk/cx-api';
-import { ResourceEvent, StackEventPoller } from './stack-event-poller';
-import { IoMessageLevel } from '../../toolkit/cli-io-host';
+import { StackEvent } from '@aws-sdk/client-cloudformation';
+import { IoMessaging } from '../../toolkit/cli-io-host';
 import type { ICloudFormationClient } from '../aws-auth';
-export interface StackActivity extends ResourceEvent {
+import { StackProgress } from './stack-progress-monitor';
+/**
+ * Payload when stack monitoring is starting or stopping for a given stack deployment.
+ */
+export interface StackMonitoringControlEvent {
+    /**
+     * A unique identifier for a specific stack deployment.
+     *
+     * Use this value to attribute stack activities received for concurrent deployments.
+     */
+    readonly deployment: string;
+    /**
+     * The stack artifact that is getting deployed
+     */
+    readonly stack: CloudFormationStackArtifact;
+    /**
+     * The name of the Stack that is getting deployed
+     */
+    readonly stackName: string;
+    /**
+     * Total number of resources taking part in this deployment
+     *
+     * The number might not always be known or accurate.
+     * Only use for informational purposes and handle the case when it's unavailable.
+     */
+    readonly resourcesTotal?: number;
+}
+export interface StackActivity {
+    /**
+     * A unique identifier for a specific stack deployment.
+     *
+     * Use this value to attribute stack activities received for concurrent deployments.
+     */
+    readonly deployment: string;
+    /**
+     * The Stack Event as received from CloudFormation
+     */
+    readonly event: StackEvent;
+    /**
+     * Additional resource metadata
+     */
     readonly metadata?: ResourceMetadata;
+    /**
+     * The stack progress
+     */
+    readonly progress: StackProgress;
 }
 export interface ResourceMetadata {
     entry: MetadataEntry;
     constructPath: string;
 }
-/**
- * Supported display modes for stack deployment activity
- */
-export declare enum StackActivityProgress {
+export interface StackActivityMonitorProps {
     /**
-     * Displays a progress bar with only the events for the resource currently being deployed
+     * The CloudFormation client
      */
-    BAR = "bar",
+    readonly cfn: ICloudFormationClient;
     /**
-     * Displays complete history with all CloudFormation stack events
+     * The IoHost used for messaging
      */
-    EVENTS = "events"
-}
-export interface WithDefaultPrinterProps {
+    readonly ioHost: IoMessaging['ioHost'];
     /**
-     * Total number of resources to update
-     *
-     * Used to calculate a progress bar.
-     *
-     * @default - No progress reporting.
+     * The current ToolkitAction
      */
-    readonly resourcesTotal?: number;
+    readonly action: IoMessaging['action'];
     /**
-     * The log level that was requested in the CLI
-     *
-     * If verbose or trace is requested, we'll always use the full history printer.
-     *
-     * @default - Use value from logging.logLevel
+     * The stack artifact that is getting deployed
      */
-    readonly logLevel?: IoMessageLevel;
+    readonly stack: CloudFormationStackArtifact;
     /**
-     * Whether to display all stack events or to display only the events for the
-     * resource currently being deployed
-     *
-     * If not set, the stack history with all stack events will be displayed
-     *
-     * @default false
+     * The name of the Stack that is getting deployed
      */
-    progress?: StackActivityProgress;
+    readonly stackName: string;
     /**
-     * Whether we are on a CI system
+     * Total number of resources to update
      *
-     * If so, disable the "optimized" stack monitor.
+     * Used to calculate a progress bar.
      *
-     * @default false
+     * @default - No progress reporting.
      */
-    readonly ci?: boolean;
+    readonly resourcesTotal?: number;
     /**
      * Creation time of the change set
      *
@@ -69,21 +95,28 @@ export interface WithDefaultPrinterProps {
      * @default - local machine's current time
      */
     readonly changeSetCreationTime?: Date;
+    /**
+     * Time to wait between fetching new activities.
+     *
+     * Must wait a reasonable amount of time between polls, since we need to consider CloudFormation API limits
+     *
+     * @default 2_000
+     */
+    readonly pollingInterval?: number;
 }
 export declare class StackActivityMonitor {
-    private readonly stackName;
-    private readonly printer;
-    private readonly stack?;
     /**
-     * Create a Stack Activity Monitor using a default printer, based on context clues
+     * The poller used to read stack events
      */
-    static withDefaultPrinter(cfn: ICloudFormationClient, stackName: string, stackArtifact: CloudFormationStackArtifact, options?: WithDefaultPrinterProps): StackActivityMonitor;
+    private readonly poller;
     /**
-     * The poller used to read stack events
+     * Fetch new activity every 1 second
+     * Printers can decide to update a view less frequently if desired
      */
-    readonly poller: StackEventPoller;
+    private readonly pollingInterval;
     readonly errors: string[];
-    private active;
+    private monitorId?;
+    private readonly progressMonitor;
     /**
      * Current tick timer
      */
@@ -92,8 +125,12 @@ export declare class StackActivityMonitor {
      * Set to the activity of reading the current events
      */
     private readPromise?;
-    constructor(cfn: ICloudFormationClient, stackName: string, printer: IActivityPrinter, stack?: CloudFormationStackArtifact | undefined, changeSetCreationTime?: Date);
-    start(): this;
+    private readonly ioHost;
+    private readonly action;
+    private readonly stackName;
+    private readonly stack;
+    constructor({ cfn, ioHost, action, stack, stackName, resourcesTotal, changeSetCreationTime, pollingInterval, }: StackActivityMonitorProps);
+    start(): Promise<this>;
     stop(): Promise<void>;
     private scheduleNextTick;
     private tick;
@@ -113,125 +150,10 @@ export declare class StackActivityMonitor {
      * reached the last page.
      */
     private finalPollToEnd;
-    private checkForErrors;
-    private simplifyConstructPath;
-}
-interface PrinterProps {
-    /**
-     * Total resources to deploy
-     */
-    readonly resourcesTotal?: number;
     /**
-     * The with of the "resource type" column.
-     */
-    readonly resourceTypeColumnWidth: number;
-    /**
-     * Stream to write to
-     */
-    readonly stream: NodeJS.WriteStream;
-}
-export interface IActivityPrinter {
-    readonly updateSleep: number;
-    addActivity(activity: StackActivity): void;
-    print(): void;
-    start(): void;
-    stop(): void;
-}
-declare abstract class ActivityPrinterBase implements IActivityPrinter {
-    protected readonly props: PrinterProps;
-    /**
-     * Fetch new activity every 5 seconds
-     */
-    readonly updateSleep: number;
-    /**
-     * A list of resource IDs which are currently being processed
-     */
-    protected resourcesInProgress: Record<string, StackActivity>;
-    /**
-     * Previous completion state observed by logical ID
-     *
-     * We use this to detect that if we see a DELETE_COMPLETE after a
-     * CREATE_COMPLETE, it's actually a rollback and we should DECREASE
-     * resourcesDone instead of increase it
+     * Formats a stack activity into a basic string
      */
-    protected resourcesPrevCompleteState: Record<string, string>;
-    /**
-     * Count of resources that have reported a _COMPLETE status
-     */
-    protected resourcesDone: number;
-    /**
-     * How many digits we need to represent the total count (for lining up the status reporting)
-     */
-    protected readonly resourceDigits: number;
-    protected readonly resourcesTotal?: number;
-    protected rollingBack: boolean;
-    protected readonly failures: StackActivity[];
-    protected hookFailureMap: Map<string, Map<string, string>>;
-    constructor(props: PrinterProps);
-    failureReason(activity: StackActivity): string;
-    addActivity(activity: StackActivity): void;
-    abstract print(): void;
-    start(): void;
-    stop(): void;
-}
-/**
- * Activity Printer which shows a full log of all CloudFormation events
- *
- * When there hasn't been activity for a while, it will print the resources
- * that are currently in progress, to show what's holding up the deployment.
- */
-export declare class HistoryActivityPrinter extends ActivityPrinterBase {
-    /**
-     * Last time we printed something to the console.
-     *
-     * Used to measure timeout for progress reporting.
-     */
-    private lastPrintTime;
-    /**
-     * Number of ms of change absence before we tell the user about the resources that are currently in progress.
-     */
-    private readonly inProgressDelay;
-    private readonly printable;
-    constructor(props: PrinterProps);
-    addActivity(activity: StackActivity): void;
-    print(): void;
-    stop(): void;
-    private printOne;
-    /**
-     * Report the current progress as a [34/42] string, or just [34] if the total is unknown
-     */
-    private progress;
-    /**
-     * If some resources are taking a while to create, notify the user about what's currently in progress
-     */
-    private printInProgress;
-}
-/**
- * Activity Printer which shows the resources currently being updated
- *
- * It will continuously reupdate the terminal and show only the resources
- * that are currently being updated, in addition to a progress bar which
- * shows how far along the deployment is.
- *
- * Resources that have failed will always be shown, and will be recapitulated
- * along with their stack trace when the monitoring ends.
- *
- * Resources that failed deployment because they have been cancelled are
- * not included.
- */
-export declare class CurrentActivityPrinter extends ActivityPrinterBase {
-    /**
-     * This looks very disorienting sleeping for 5 seconds. Update quicker.
-     */
-    readonly updateSleep: number;
-    private oldLogThreshold;
-    private readonly stream;
-    private block;
-    constructor(props: PrinterProps);
-    print(): void;
-    start(): void;
-    stop(): void;
-    private progressBar;
-    private failureReasonOnNextLine;
+    private formatActivity;
+    private checkForErrors;
+    private simplifyConstructPath;
 }
-export {};