utils: Add onProgress state to show activity log creating in real-t…

…ime (#1767)

* Add onProgress state to show activity log creating in real-time

* Export icon

* Add progressState to index

* Also add it to the executeActivity

* Seems like I missed a few places...oops

* Export in the index also...

* Only filter out progress output if it actually exists

utils/.vscode/settings.json

@@ -10,6 +10,6 @@
         "**/node_modules": true
     },
     "editor.codeActionsOnSave": {
-        "source.fixAll.eslint": true
+        "source.fixAll.eslint": "explicit"
     }
 }

utils/index.d.ts

@@ -1161,9 +1161,11 @@ export interface IWizardOptions<T extends IActionContext> {
 
 export const activitySuccessContext: string;
 export const activityFailContext: string;
+export const activityProgressContext: string;
 
 export const activityInfoIcon: ThemeIcon;
 export const activitySuccessIcon: ThemeIcon;
+export const activityProgressIcon: ThemeIcon;
 export const activityFailIcon: ThemeIcon;
 
 export type ActivityTask<R> = (progress: Progress<{ message?: string, increment?: number }>, cancellationToken: CancellationToken) => Promise<R>;
@@ -1180,6 +1182,7 @@ export declare abstract class ActivityBase<R> implements Activity {
 
     abstract initialState(): ActivityTreeItemOptions;
     abstract successState(): ActivityTreeItemOptions;
+    abstract progressState(): ActivityTreeItemOptions;
     abstract errorState(error: IParsedError): ActivityTreeItemOptions;
 
     public constructor(task: ActivityTask<R>);
@@ -1206,6 +1209,7 @@ export class ExecuteActivity<C extends ExecuteActivityContext = ExecuteActivityC
     public constructor(context: C, task: ActivityTask<void>);
     public initialState(): ActivityTreeItemOptions;
     public successState(): ActivityTreeItemOptions;
+    public progressState(): ActivityTreeItemOptions;
     public errorState(error: IParsedError): ActivityTreeItemOptions;
     protected get label(): string;
 }
@@ -1302,6 +1306,11 @@ export declare abstract class AzureWizardExecuteStep<T extends IActionContext &
      */
     public createSuccessOutput?(context: T): ExecuteActivityOutput;
 
+    /**
+     * Defines the output for display during execution of the step
+     */
+    public createProgressOutput?(context: T): ExecuteActivityOutput;
+
     /**
      * Defines the output for display after unsuccessful execution of the step
      */

utils/src/activityLog/Activity.ts

@@ -37,6 +37,7 @@ export abstract class ActivityBase<R> implements hTypes.Activity {
 
     abstract initialState(): hTypes.ActivityTreeItemOptions;
     abstract successState(): hTypes.ActivityTreeItemOptions;
+    abstract progressState(): hTypes.ActivityTreeItemOptions;
     abstract errorState(error?: types.IParsedError): hTypes.ActivityTreeItemOptions;
 
     public constructor(task: types.ActivityTask<R>) {
@@ -51,6 +52,7 @@ export abstract class ActivityBase<R> implements hTypes.Activity {
 
     private report(progress: { message?: string; increment?: number }): void {
         this._onProgressEmitter.fire({ ...this.getState(), message: progress.message });
+        this.status = ActivityStatus.Running;
     }
 
     public async run(): Promise<R> {
@@ -74,6 +76,8 @@ export abstract class ActivityBase<R> implements hTypes.Activity {
                 return this.errorState(this.error);
             case ActivityStatus.Succeeded:
                 return this.successState();
+            case ActivityStatus.Running:
+                return this.progressState();
             default:
                 return this.initialState();
         }

utils/src/activityLog/activities/ExecuteActivity.ts

@@ -71,6 +71,16 @@ export class ExecuteActivity<TContext extends types.ExecuteActivityContext = typ
         }
     }
 
+    public progressState(): hTypes.ActivityTreeItemOptions {
+        return {
+            label: this.label,
+            getChildren: this.context.activityChildren ? ((parent: AzExtParentTreeItem) => {
+                parent.compareChildrenImpl = () => 0;  // Don't sort
+                return this.context.activityChildren || [];
+            }) : undefined
+        }
+    }
+
     private appendErrorItemToActivityChildren(errorItem: AzExtTreeItem): void {
         // Honor any error suppression flag
         if ((this.context as unknown as types.IActionContext).errorHandling?.suppressDisplay) {

utils/src/constants.ts

@@ -16,7 +16,9 @@ export namespace AzExtQuickInputButtons {
 
 export const activitySuccessContext: string = 'activity:success';
 export const activityFailContext: string = 'activity:fail';
+export const activityProgressContext: string = 'activity:progress';
 
 export const activityInfoIcon: ThemeIcon = new ThemeIcon('info', new ThemeColor('charts.blue'));
 export const activitySuccessIcon: ThemeIcon = new ThemeIcon('pass', new ThemeColor('testing.iconPassed'));
 export const activityFailIcon: ThemeIcon = new ThemeIcon('error', new ThemeColor('testing.iconFailed'));
+export const activityProgressIcon: ThemeIcon = new ThemeIcon('loading~spin');

utils/src/index.ts

@@ -8,7 +8,7 @@ export * from './activityLog/Activity';
 export { createAzExtLogOutputChannel, createAzExtOutputChannel } from './AzExtOutputChannel';
 export * from './AzExtTreeFileSystem';
 export * from './callWithTelemetryAndErrorHandling';
-export { activityFailContext, activityFailIcon, activityInfoIcon, activitySuccessContext, activitySuccessIcon } from './constants';
+export { activityFailContext, activityFailIcon, activityInfoIcon, activityProgressContext, activityProgressIcon, activitySuccessContext, activitySuccessIcon } from './constants';
 export * from './createApiProvider';
 export { createExperimentationService } from './createExperimentationService';
 export * from './DialogResponses';

utils/src/wizard/AzureWizard.ts

@@ -193,6 +193,11 @@ export class AzureWizard<T extends (IInternalActionContext & Partial<types.Execu
                 }
 
                 let output: types.ExecuteActivityOutput | undefined;
+                const progressOutput: types.ExecuteActivityOutput | undefined = step.createProgressOutput?.(this._context);
+                if (progressOutput) {
+                    this.displayActivityOutput(progressOutput, step.options);
+                }
+
                 try {
                     this._context.telemetry.properties.lastStep = `execute-${getEffectiveStepId(step)}`;
                     await step.execute(this._context, internalProgress);
@@ -204,6 +209,12 @@ export class AzureWizard<T extends (IInternalActionContext & Partial<types.Execu
                     }
                 } finally {
                     output ??= {};
+
+                    // always remove the progress item from the activity log
+                    if (progressOutput?.item) {
+                        this._context.activityChildren = this._context.activityChildren?.filter(t => t !== progressOutput.item);
+                    }
+
                     this.displayActivityOutput(output, step.options);
 
                     currentStep += 1;

utils/src/wizard/AzureWizardExecuteStep.ts

@@ -16,4 +16,6 @@ export abstract class AzureWizardExecuteStep<T extends types.IActionContext & Pa
 
     public createSuccessOutput?(context: T): types.ExecuteActivityOutput;
     public createFailOutput?(context: T): types.ExecuteActivityOutput;
+    public createProgressOutput?(context: T): types.ExecuteActivityOutput;
+
 }