Cancelling the running task (executing of a scaffolder template)

Signed-off-by: Bogdan Nechyporenko <bnechyporenko@bol.com>

plugins/scaffolder-react/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @backstage/plugin-scaffolder-react
 
+## 1.2.0-next.2
+
+### Patch Changes
+
+- 65454876fb2: Minor API report tweaks
+- 3c96e77b513: Make scaffolder adhere to page themes by using page `fontColor` consistently. If your theme overwrites template list or card headers, review those styles.
+- d9893263ba9: scaffolder/next: Fix for steps without properties
+- Updated dependencies
+  - @backstage/core-components@0.12.5-next.2
+  - @backstage/plugin-catalog-react@1.4.0-next.2
+  - @backstage/core-plugin-api@1.5.0-next.2
+
 ## 1.2.0-next.1
 
 ### Minor Changes

plugins/scaffolder-react/api-report.md

@@ -113,7 +113,7 @@ export type ListActionsResponse = Array<Action>;
 
 // @public
 export type LogEvent = {
-  type: 'log' | 'completion';
+  type: 'log' | 'completion' | 'cancelled';
   body: {
     message: string;
     stepId?: string;
@@ -126,6 +126,7 @@ export type LogEvent = {
 
 // @public
 export interface ScaffolderApi {
+  cancelTask(taskId: string): Promise<void>;
   // (undocumented)
   dryRun?(options: ScaffolderDryRunOptions): Promise<ScaffolderDryRunResponse>;
   // (undocumented)
@@ -266,10 +267,11 @@ export type ScaffolderTaskOutput = {
 
 // @public
 export type ScaffolderTaskStatus =
+  | 'cancelled'
+  | 'completed'
+  | 'failed'
   | 'open'
   | 'processing'
-  | 'failed'
-  | 'completed'
   | 'skipped';
 
 // @public
@@ -287,6 +289,7 @@ export const SecretsContextProvider: (
 
 // @public
 export type TaskStream = {
+  cancelled: boolean;
   loading: boolean;
   error?: Error;
   stepLogs: {

plugins/scaffolder-react/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-scaffolder-react",
   "description": "A frontend library that helps other Backstage plugins interact with the Scaffolder",
-  "version": "1.2.0-next.1",
+  "version": "1.2.0-next.2",
   "main": "src/index.ts",
   "types": "src/index.ts",
   "license": "Apache-2.0",

plugins/scaffolder-react/src/api/types.ts

@@ -24,10 +24,11 @@ import { TemplateParameterSchema } from '../types';
  * @public
  */
 export type ScaffolderTaskStatus =
+  | 'cancelled'
+  | 'completed'
+  | 'failed'
   | 'open'
   | 'processing'
-  | 'failed'
-  | 'completed'
   | 'skipped';
 
 /**
@@ -96,7 +97,7 @@ export type ScaffolderTaskOutput = {
  * @public
  */
 export type LogEvent = {
-  type: 'log' | 'completion';
+  type: 'log' | 'completion' | 'cancelled';
   body: {
     message: string;
     stepId?: string;
@@ -196,6 +197,13 @@ export interface ScaffolderApi {
 
   getTask(taskId: string): Promise<ScaffolderTask>;
 
+  /**
+   * Sends a signal to a task broker to cancel the running task by taskId.
+   *
+   * @param taskId - the id of the task
+   */
+  cancelTask(taskId: string): Promise<void>;
+
   listTasks?(options: {
     filterByOwnership: 'owned' | 'all';
   }): Promise<{ tasks: ScaffolderTask[] }>;

plugins/scaffolder-react/src/hooks/useEventStream.ts

@@ -44,6 +44,7 @@ export type ScaffolderStep = {
  * @public
  */
 export type TaskStream = {
+  cancelled: boolean;
   loading: boolean;
   error?: Error;
   stepLogs: { [stepId in string]: string[] };
@@ -66,6 +67,7 @@ type ReducerLogEntry = {
 
 type ReducerAction =
   | { type: 'INIT'; data: ScaffolderTask }
+  | { type: 'CANCELLED' }
   | { type: 'LOGS'; data: ReducerLogEntry[] }
   | { type: 'COMPLETED'; data: ReducerLogEntry }
   | { type: 'ERROR'; data: Error };
@@ -111,7 +113,7 @@ function reducer(draft: TaskStream, action: ReducerAction) {
           }
 
           if (
-            ['cancelled', 'failed', 'completed'].includes(currentStep.status)
+            ['cancelled', 'completed', 'failed'].includes(currentStep.status)
           ) {
             currentStep.endedAt = entry.createdAt;
           }
@@ -131,6 +133,11 @@ function reducer(draft: TaskStream, action: ReducerAction) {
       return;
     }
 
+    case 'CANCELLED': {
+      draft.cancelled = true;
+      return;
+    }
+
     case 'ERROR': {
       draft.error = action.data;
       draft.loading = false;
@@ -151,6 +158,7 @@ function reducer(draft: TaskStream, action: ReducerAction) {
 export const useTaskEventStream = (taskId: string): TaskStream => {
   const scaffolderApi = useApi(scaffolderApiRef);
   const [state, dispatch] = useImmerReducer(reducer, {
+    cancelled: false,
     loading: true,
     completed: false,
     stepLogs: {} as { [stepId in string]: string[] },
@@ -196,6 +204,9 @@ export const useTaskEventStream = (taskId: string): TaskStream => {
             switch (event.type) {
               case 'log':
                 return collectedLogEvents.push(event);
+              case 'cancelled':
+                dispatch({ type: 'CANCELLED' });
+                return undefined;
               case 'completion':
                 emitLogs();
                 dispatch({ type: 'COMPLETED', data: event });

plugins/scaffolder-react/src/next/components/Workflow/Workflow.test.tsx

@@ -24,10 +24,10 @@ import { act, fireEvent } from '@testing-library/react';
 import React from 'react';
 import { Workflow } from './Workflow';
 import { analyticsApiRef } from '@backstage/core-plugin-api';
-import { ScaffolderApi } from '../../../api/types';
-import { scaffolderApiRef } from '../../../api/ref';
+import { ScaffolderApi, scaffolderApiRef } from '../../../api';
 
 const scaffolderApiMock: jest.Mocked<ScaffolderApi> = {
+  cancelTask: jest.fn(),
   scaffold: jest.fn(),
   getTemplateParameterSchema: jest.fn(),
   getIntegrationsList: jest.fn(),