From 6ea23c9c6d99f0b04216329198575cae20311b73 Mon Sep 17 00:00:00 2001 From: benjdlambert Date: Tue, 23 Sep 2025 15:49:58 +0200 Subject: [PATCH] chore: remove deprecated types and making breaking changes Signed-off-by: benjdlambert --- plugins/scaffolder-backend/report.api.md | 373 ------------------ plugins/scaffolder-backend/src/index.ts | 4 +- .../actions/TemplateActionRegistry.ts | 3 +- .../src/scaffolder/tasks/DatabaseTaskStore.ts | 6 +- .../tasks/NunjucksWorkflowRunner.ts | 2 +- .../src/scaffolder/tasks/StorageTaskBroker.ts | 4 +- .../src/scaffolder/tasks/TaskWorker.ts | 8 +- .../src/scaffolder/tasks/types.ts | 50 +-- plugins/scaffolder-node/report.api.md | 13 +- plugins/scaffolder-node/src/tasks/types.ts | 16 +- 10 files changed, 24 insertions(+), 455 deletions(-) diff --git a/plugins/scaffolder-backend/report.api.md b/plugins/scaffolder-backend/report.api.md index 918718e495..8f9249cc5e 100644 --- a/plugins/scaffolder-backend/report.api.md +++ b/plugins/scaffolder-backend/report.api.md @@ -3,45 +3,21 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { AuditorService } from '@backstage/backend-plugin-api'; -import { AuthService } from '@backstage/backend-plugin-api'; import { BackendFeature } from '@backstage/backend-plugin-api'; -import { BackstageCredentials } from '@backstage/backend-plugin-api'; import { CatalogService } from '@backstage/plugin-catalog-node'; -import { Config } from '@backstage/config'; -import { DatabaseService } from '@backstage/backend-plugin-api'; import { Duration } from 'luxon'; -import { EventsService } from '@backstage/plugin-events-node'; import { HumanDuration } from '@backstage/types'; -import { JsonObject } from '@backstage/types'; -import { Knex } from 'knex'; -import { LoggerService } from '@backstage/backend-plugin-api'; -import { PermissionCriteria } from '@backstage/plugin-permission-common'; -import { PermissionEvaluator } from '@backstage/plugin-permission-common'; import { PermissionRule } from '@backstage/plugin-permission-node'; import { PermissionRuleParams } from '@backstage/plugin-permission-common'; import { RESOURCE_TYPE_SCAFFOLDER_ACTION } from '@backstage/plugin-scaffolder-common/alpha'; import { RESOURCE_TYPE_SCAFFOLDER_TEMPLATE } from '@backstage/plugin-scaffolder-common/alpha'; import { ScmIntegrations } from '@backstage/integration'; -import { SerializedTask } from '@backstage/plugin-scaffolder-node'; -import { SerializedTaskEvent } from '@backstage/plugin-scaffolder-node'; -import { TaskBroker } from '@backstage/plugin-scaffolder-node'; -import { TaskCompletionState } from '@backstage/plugin-scaffolder-node'; -import { TaskContext } from '@backstage/plugin-scaffolder-node'; -import { TaskFilters } from '@backstage/plugin-scaffolder-node'; -import { TaskRecovery } from '@backstage/plugin-scaffolder-common'; -import { TaskSecrets } from '@backstage/plugin-scaffolder-node'; -import { TaskSpec } from '@backstage/plugin-scaffolder-common'; -import { TaskSpecV1beta3 } from '@backstage/plugin-scaffolder-common'; -import { TaskStatus } from '@backstage/plugin-scaffolder-node'; import { TemplateAction } from '@backstage/plugin-scaffolder-node'; import { TemplateEntityStepV1beta3 } from '@backstage/plugin-scaffolder-common'; import { TemplateFilter } from '@backstage/plugin-scaffolder-node'; import { TemplateGlobal } from '@backstage/plugin-scaffolder-node'; import { TemplateParametersV1beta3 } from '@backstage/plugin-scaffolder-common'; -import { UpdateTaskCheckpointOptions } from '@backstage/plugin-scaffolder-node/alpha'; import { UrlReaderService } from '@backstage/backend-plugin-api'; -import { WorkspaceProvider } from '@backstage/plugin-scaffolder-node/alpha'; // @public (undocumented) export type ActionPermissionRuleInput< @@ -267,359 +243,10 @@ export function createWaitAction(options?: { 'v2' >; -// @public @deprecated -export type CreateWorkerOptions = { - taskBroker: TaskBroker; - actionRegistry: TemplateActionRegistry; - integrations: ScmIntegrations; - workingDirectory: string; - logger: LoggerService; - auditor?: AuditorService; - config?: Config; - additionalTemplateFilters?: Record; - concurrentTasksLimit?: number; - additionalTemplateGlobals?: Record; - permissions?: PermissionEvaluator; - gracefulShutdown?: boolean; -}; - -// @public -export interface CurrentClaimedTask { - createdBy?: string; - secrets?: TaskSecrets; - spec: TaskSpec; - state?: JsonObject; - taskId: string; - workspace?: Promise; -} - -// @public @deprecated -export class DatabaseTaskStore implements TaskStore { - // (undocumented) - cancelTask( - options: TaskStoreEmitOptions< - { - message: string; - } & JsonObject - >, - ): Promise; - // (undocumented) - claimTask(): Promise; - // (undocumented) - cleanWorkspace({ taskId }: { taskId: string }): Promise; - // (undocumented) - completeTask(options: { - taskId: string; - status: TaskStatus; - eventBody: JsonObject; - }): Promise; - // (undocumented) - static create(options: DatabaseTaskStoreOptions): Promise; - // (undocumented) - createTask( - options: TaskStoreCreateTaskOptions, - ): Promise; - // (undocumented) - emitLogEvent( - options: TaskStoreEmitOptions< - { - message: string; - } & JsonObject - >, - ): Promise; - // (undocumented) - getTask(taskId: string): Promise; - // (undocumented) - getTaskState({ taskId }: { taskId: string }): Promise< - | { - state: JsonObject; - } - | undefined - >; - // (undocumented) - heartbeatTask(taskId: string): Promise; - // (undocumented) - list(options: { - createdBy?: string; - status?: TaskStatus; - filters?: { - createdBy?: string | string[]; - status?: TaskStatus | TaskStatus[]; - }; - pagination?: { - limit?: number; - offset?: number; - }; - order?: { - order: 'asc' | 'desc'; - field: string; - }[]; - permissionFilters?: PermissionCriteria; - }): Promise<{ - tasks: SerializedTask[]; - totalTasks?: number; - }>; - // (undocumented) - listEvents(options: TaskStoreListEventsOptions): Promise<{ - events: SerializedTaskEvent[]; - }>; - // (undocumented) - listStaleTasks(options: { timeoutS: number }): Promise<{ - tasks: { - taskId: string; - recovery?: TaskRecovery; - }[]; - }>; - // (undocumented) - recoverTasks(options: TaskStoreRecoverTaskOptions): Promise<{ - ids: string[]; - }>; - // (undocumented) - rehydrateWorkspace(options: { - taskId: string; - targetPath: string; - }): Promise; - // (undocumented) - retryTask?(options: { secrets?: TaskSecrets; taskId: string }): Promise; - // (undocumented) - saveTaskState(options: { taskId: string; state?: JsonObject }): Promise; - // (undocumented) - serializeWorkspace(options: { path: string; taskId: string }): Promise; - // (undocumented) - shutdownTask(options: TaskStoreShutDownTaskOptions): Promise; -} - -// @public @deprecated -export type DatabaseTaskStoreOptions = { - database: DatabaseService | Knex; - events?: EventsService; -}; - // @public const scaffolderPlugin: BackendFeature; export default scaffolderPlugin; -// @public @deprecated -export class TaskManager implements TaskContext { - // (undocumented) - get cancelSignal(): AbortSignal; - // (undocumented) - cleanWorkspace?(): Promise; - // (undocumented) - complete(result: TaskCompletionState, metadata?: JsonObject): Promise; - // (undocumented) - static create( - task: CurrentClaimedTask, - storage: TaskStore, - abortSignal: AbortSignal, - logger: LoggerService, - auth?: AuthService, - config?: Config, - additionalWorkspaceProviders?: Record, - ): TaskManager; - // (undocumented) - get createdBy(): string | undefined; - // (undocumented) - get done(): boolean; - // (undocumented) - emitLog(message: string, logMetadata?: JsonObject): Promise; - // (undocumented) - getInitiatorCredentials(): Promise; - // (undocumented) - getTaskState?(): Promise< - | { - state?: JsonObject; - } - | undefined - >; - // (undocumented) - getWorkspaceName(): Promise; - // (undocumented) - rehydrateWorkspace?(options: { - taskId: string; - targetPath: string; - }): Promise; - // (undocumented) - get secrets(): TaskSecrets | undefined; - // (undocumented) - serializeWorkspace?(options: { path: string }): Promise; - // (undocumented) - get spec(): TaskSpecV1beta3; - // (undocumented) - get taskId(): string; - // (undocumented) - updateCheckpoint?(options: UpdateTaskCheckpointOptions): Promise; -} - -// @public @deprecated -export interface TaskStore { - // (undocumented) - cancelTask?(options: TaskStoreEmitOptions): Promise; - // (undocumented) - claimTask(): Promise; - // (undocumented) - cleanWorkspace?({ taskId }: { taskId: string }): Promise; - // (undocumented) - completeTask(options: { - taskId: string; - status: TaskStatus; - eventBody: JsonObject; - }): Promise; - // (undocumented) - createTask( - options: TaskStoreCreateTaskOptions, - ): Promise; - // (undocumented) - emitLogEvent(options: TaskStoreEmitOptions): Promise; - // (undocumented) - getTask(taskId: string): Promise; - // (undocumented) - getTaskState?({ taskId }: { taskId: string }): Promise< - | { - state: JsonObject; - } - | undefined - >; - // (undocumented) - heartbeatTask(taskId: string): Promise; - // (undocumented) - list?(options: { - filters?: { - createdBy?: string | string[]; - status?: TaskStatus | TaskStatus[]; - }; - pagination?: { - limit?: number; - offset?: number; - }; - permissionFilters?: PermissionCriteria; - order?: { - order: 'asc' | 'desc'; - field: string; - }[]; - }): Promise<{ - tasks: SerializedTask[]; - totalTasks?: number; - }>; - // @deprecated (undocumented) - list?(options: { - createdBy?: string; - status?: TaskStatus; - filters?: { - createdBy?: string | string[]; - status?: TaskStatus | TaskStatus[]; - }; - pagination?: { - limit?: number; - offset?: number; - }; - order?: { - order: 'asc' | 'desc'; - field: string; - }[]; - }): Promise<{ - tasks: SerializedTask[]; - totalTasks?: number; - }>; - // (undocumented) - listEvents(options: TaskStoreListEventsOptions): Promise<{ - events: SerializedTaskEvent[]; - }>; - // (undocumented) - listStaleTasks(options: { timeoutS: number }): Promise<{ - tasks: { - taskId: string; - }[]; - }>; - // (undocumented) - recoverTasks?(options: TaskStoreRecoverTaskOptions): Promise<{ - ids: string[]; - }>; - // (undocumented) - rehydrateWorkspace?(options: { - taskId: string; - targetPath: string; - }): Promise; - // (undocumented) - retryTask?(options: { secrets?: TaskSecrets; taskId: string }): Promise; - // (undocumented) - saveTaskState?(options: { - taskId: string; - state?: JsonObject; - }): Promise; - // (undocumented) - serializeWorkspace?({ - path, - taskId, - }: { - path: string; - taskId: string; - }): Promise; - // (undocumented) - shutdownTask?(options: TaskStoreShutDownTaskOptions): Promise; -} - -// @public @deprecated -export type TaskStoreCreateTaskOptions = { - spec: TaskSpec; - createdBy?: string; - secrets?: TaskSecrets; -}; - -// @public @deprecated -export type TaskStoreCreateTaskResult = { - taskId: string; -}; - -// @public @deprecated -export type TaskStoreEmitOptions = { - taskId: string; - body: TBody; -}; - -// @public @deprecated -export type TaskStoreListEventsOptions = { - isTaskRecoverable?: boolean; - taskId: string; - after?: number | undefined; -}; - -// @public @deprecated -export type TaskStoreRecoverTaskOptions = { - timeout: HumanDuration; -}; - -// @public @deprecated -export type TaskStoreShutDownTaskOptions = { - taskId: string; -}; - -// @public @deprecated -export class TaskWorker { - // (undocumented) - static create(options: CreateWorkerOptions): Promise; - // (undocumented) - protected onReadyToClaimTask(): Promise; - // (undocumented) - recoverTasks(): Promise; - // (undocumented) - runOneTask(task: TaskContext): Promise; - // (undocumented) - start(): void; - // (undocumented) - stop(): Promise; -} - -// @public @deprecated -export class TemplateActionRegistry { - // (undocumented) - get(actionId: string): TemplateAction; - // (undocumented) - list(): TemplateAction[]; - // (undocumented) - register(action: TemplateAction): void; -} - // @public (undocumented) export type TemplatePermissionRuleInput< TParams extends PermissionRuleParams = PermissionRuleParams, diff --git a/plugins/scaffolder-backend/src/index.ts b/plugins/scaffolder-backend/src/index.ts index 4273ed8197..d911d51536 100644 --- a/plugins/scaffolder-backend/src/index.ts +++ b/plugins/scaffolder-backend/src/index.ts @@ -21,7 +21,9 @@ */ export { scaffolderPlugin as default } from './ScaffolderPlugin'; -export * from './scaffolder'; + +export * from './scaffolder/actions/builtin'; + export { type TemplatePermissionRuleInput, type ActionPermissionRuleInput, diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/TemplateActionRegistry.ts b/plugins/scaffolder-backend/src/scaffolder/actions/TemplateActionRegistry.ts index c819d4c21f..d6d7685a21 100644 --- a/plugins/scaffolder-backend/src/scaffolder/actions/TemplateActionRegistry.ts +++ b/plugins/scaffolder-backend/src/scaffolder/actions/TemplateActionRegistry.ts @@ -16,10 +16,9 @@ import { ConflictError, NotFoundError } from '@backstage/errors'; import { TemplateAction } from '@backstage/plugin-scaffolder-node'; + /** * Registry of all registered template actions. - * @public - * @deprecated this type is deprecated, and there will be a new way to create Workers in the next major version. */ export class TemplateActionRegistry { private readonly actions = new Map(); diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.ts index fdcaa8613e..22ce3e83b7 100644 --- a/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.ts +++ b/plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.ts @@ -85,8 +85,6 @@ export type RawDbTaskEventRow = { /** * DatabaseTaskStore - * @deprecated this type is deprecated, and there will be a new way to create Workers in the next major version. - * @public */ export type DatabaseTaskStoreOptions = { database: DatabaseService | Knex; @@ -118,8 +116,6 @@ const parseSqlDateToIsoString = (input: T): T | string => { /** * DatabaseTaskStore - * @deprecated this type is deprecated, and there will be a new way to create Workers in the next major version. - * @public */ export class DatabaseTaskStore implements TaskStore { private readonly db: Knex; @@ -723,7 +719,7 @@ export class DatabaseTaskStore implements TaskStore { }); } - async retryTask?(options: { + async retryTask(options: { secrets?: TaskSecrets; taskId: string; }): Promise { diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.ts index d069a6bc1c..bcae93fb4d 100644 --- a/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.ts +++ b/plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.ts @@ -33,7 +33,7 @@ import { SecureTemplater, SecureTemplateRenderer, } from '../../lib/templating/SecureTemplater'; -import { TemplateActionRegistry } from '../actions'; +import { TemplateActionRegistry } from '../actions/TemplateActionRegistry'; import { generateExampleOutput, isTruthy } from './helper'; import { TaskTrackType, WorkflowResponse, WorkflowRunner } from './types'; diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/StorageTaskBroker.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/StorageTaskBroker.ts index 5b4d568144..2c2c176770 100644 --- a/plugins/scaffolder-backend/src/scaffolder/tasks/StorageTaskBroker.ts +++ b/plugins/scaffolder-backend/src/scaffolder/tasks/StorageTaskBroker.ts @@ -50,8 +50,6 @@ type TaskState = { }; /** * TaskManager - * @deprecated this type is deprecated, and there will be a new way to create Workers in the next major version. - * @public */ export class TaskManager implements TaskContext { private isDone = false; @@ -488,7 +486,7 @@ export class StorageTaskBroker implements TaskBroker { }); } - async retry?(options: { + async retry(options: { secrets?: TaskSecrets; taskId: string; }): Promise { diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/TaskWorker.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/TaskWorker.ts index 9abe5f3ba6..adfdf0b553 100644 --- a/plugins/scaffolder-backend/src/scaffolder/tasks/TaskWorker.ts +++ b/plugins/scaffolder-backend/src/scaffolder/tasks/TaskWorker.ts @@ -25,7 +25,7 @@ import { TemplateGlobal, } from '@backstage/plugin-scaffolder-node'; import PQueue from 'p-queue'; -import { TemplateActionRegistry } from '../actions'; +import { TemplateActionRegistry } from '../actions/TemplateActionRegistry'; import { NunjucksWorkflowRunner } from './NunjucksWorkflowRunner'; import { WorkflowRunner } from './types'; import { setTimeout } from 'timers/promises'; @@ -36,8 +36,6 @@ const DEFAULT_TASK_PARAMETER_MAX_LENGTH = 256; /** * TaskWorkerOptions - * @deprecated this type is deprecated, and there will be a new way to create Workers in the next major version. - * @public */ export type TaskWorkerOptions = { taskBroker: TaskBroker; @@ -54,8 +52,6 @@ export type TaskWorkerOptions = { /** * CreateWorkerOptions - * @deprecated this type is deprecated, and there will be a new way to create Workers in the next major version. - * @public */ export type CreateWorkerOptions = { taskBroker: TaskBroker; @@ -86,8 +82,6 @@ export type CreateWorkerOptions = { /** * TaskWorker - * @deprecated this type is deprecated, and there will be a new way to create Workers in the next major version. - * @public */ export class TaskWorker { private taskQueue: PQueue; diff --git a/plugins/scaffolder-backend/src/scaffolder/tasks/types.ts b/plugins/scaffolder-backend/src/scaffolder/tasks/types.ts index 62ffb171ff..874e32b838 100644 --- a/plugins/scaffolder-backend/src/scaffolder/tasks/types.ts +++ b/plugins/scaffolder-backend/src/scaffolder/tasks/types.ts @@ -30,8 +30,6 @@ import { PermissionCriteria } from '@backstage/plugin-permission-common'; /** * TaskStoreEmitOptions * - * @public - * @deprecated this type is deprecated, and there will be a new way to create Workers in the next major version. */ export type TaskStoreEmitOptions = { taskId: string; @@ -41,8 +39,6 @@ export type TaskStoreEmitOptions = { /** * TaskStoreListEventsOptions * - * @public - * @deprecated this type is deprecated, and there will be a new way to create Workers in the next major version. */ export type TaskStoreListEventsOptions = { isTaskRecoverable?: boolean; @@ -53,8 +49,6 @@ export type TaskStoreListEventsOptions = { /** * TaskStoreShutDownTaskOptions * - * @public - * @deprecated this type is deprecated, and there will be a new way to create Workers in the next major version. */ export type TaskStoreShutDownTaskOptions = { taskId: string; @@ -62,8 +56,6 @@ export type TaskStoreShutDownTaskOptions = { /** * The options passed to {@link TaskStore.createTask} - * @public - * @deprecated this type is deprecated, and there will be a new way to create Workers in the next major version. */ export type TaskStoreCreateTaskOptions = { spec: TaskSpec; @@ -73,8 +65,6 @@ export type TaskStoreCreateTaskOptions = { /** * The options passed to {@link TaskStore.recoverTasks} - * @public - * @deprecated this type is deprecated, and there will be a new way to create Workers in the next major version. */ export type TaskStoreRecoverTaskOptions = { timeout: HumanDuration; @@ -82,8 +72,6 @@ export type TaskStoreRecoverTaskOptions = { /** * The response from {@link TaskStore.createTask} - * @public - * @deprecated this type is deprecated, and there will be a new way to create Workers in the next major version. */ export type TaskStoreCreateTaskResult = { taskId: string; @@ -92,19 +80,17 @@ export type TaskStoreCreateTaskResult = { /** * TaskStore * - * @public - * @deprecated this type is deprecated, and there will be a new way to create Workers in the next major version. */ export interface TaskStore { - cancelTask?(options: TaskStoreEmitOptions): Promise; + cancelTask(options: TaskStoreEmitOptions): Promise; createTask( options: TaskStoreCreateTaskOptions, ): Promise; - retryTask?(options: { secrets?: TaskSecrets; taskId: string }): Promise; + retryTask(options: { secrets?: TaskSecrets; taskId: string }): Promise; - recoverTasks?( + recoverTasks( options: TaskStoreRecoverTaskOptions, ): Promise<{ ids: string[] }>; @@ -137,51 +123,31 @@ export interface TaskStore { order?: { order: 'asc' | 'desc'; field: string }[]; }): Promise<{ tasks: SerializedTask[]; totalTasks?: number }>; - /** - * @deprecated Make sure to pass `createdBy` and `status` in the `filters` parameter instead - */ - list?(options: { - createdBy?: string; - status?: TaskStatus; - filters?: { - createdBy?: string | string[]; - status?: TaskStatus | TaskStatus[]; - }; - pagination?: { - limit?: number; - offset?: number; - }; - order?: { order: 'asc' | 'desc'; field: string }[]; - }): Promise<{ tasks: SerializedTask[]; totalTasks?: number }>; - emitLogEvent(options: TaskStoreEmitOptions): Promise; - getTaskState?({ taskId }: { taskId: string }): Promise< + getTaskState({ taskId }: { taskId: string }): Promise< | { state: JsonObject; } | undefined >; - saveTaskState?(options: { - taskId: string; - state?: JsonObject; - }): Promise; + saveTaskState(options: { taskId: string; state?: JsonObject }): Promise; listEvents( options: TaskStoreListEventsOptions, ): Promise<{ events: SerializedTaskEvent[] }>; - shutdownTask?(options: TaskStoreShutDownTaskOptions): Promise; + shutdownTask(options: TaskStoreShutDownTaskOptions): Promise; rehydrateWorkspace?(options: { taskId: string; targetPath: string; }): Promise; - cleanWorkspace?({ taskId }: { taskId: string }): Promise; + cleanWorkspace({ taskId }: { taskId: string }): Promise; - serializeWorkspace?({ + serializeWorkspace({ path, taskId, }: { diff --git a/plugins/scaffolder-node/report.api.md b/plugins/scaffolder-node/report.api.md index c97344867a..fa0163b245 100644 --- a/plugins/scaffolder-node/report.api.md +++ b/plugins/scaffolder-node/report.api.md @@ -356,7 +356,7 @@ export type SerializedTaskEvent = { // @public export interface TaskBroker { // (undocumented) - cancel?(taskId: string): Promise; + cancel(taskId: string): Promise; // (undocumented) claim(): Promise; // (undocumented) @@ -370,7 +370,7 @@ export interface TaskBroker { // (undocumented) get(taskId: string): Promise; // (undocumented) - list?(options?: { + list(options?: { filters?: { createdBy?: string | string[]; status?: TaskStatus | TaskStatus[]; @@ -388,15 +388,10 @@ export interface TaskBroker { tasks: SerializedTask[]; totalTasks?: number; }>; - // @deprecated (undocumented) - list?(options: { createdBy?: string; status?: TaskStatus }): Promise<{ - tasks: SerializedTask[]; - totalTasks?: number; - }>; // (undocumented) - recoverTasks?(): Promise; + recoverTasks(): Promise; // (undocumented) - retry?(options: { secrets?: TaskSecrets; taskId: string }): Promise; + retry(options: { secrets?: TaskSecrets; taskId: string }): Promise; // (undocumented) vacuumTasks(options: { timeoutS: number }): Promise; } diff --git a/plugins/scaffolder-node/src/tasks/types.ts b/plugins/scaffolder-node/src/tasks/types.ts index aaac468fce..fd80d547c1 100644 --- a/plugins/scaffolder-node/src/tasks/types.ts +++ b/plugins/scaffolder-node/src/tasks/types.ts @@ -177,13 +177,13 @@ export interface TaskContext { * @public */ export interface TaskBroker { - cancel?(taskId: string): Promise; + cancel(taskId: string): Promise; - retry?(options: { secrets?: TaskSecrets; taskId: string }): Promise; + retry(options: { secrets?: TaskSecrets; taskId: string }): Promise; claim(): Promise; - recoverTasks?(): Promise; + recoverTasks(): Promise; dispatch( options: TaskBrokerDispatchOptions, @@ -198,7 +198,7 @@ export interface TaskBroker { get(taskId: string): Promise; - list?(options?: { + list(options?: { filters?: { createdBy?: string | string[]; status?: TaskStatus | TaskStatus[]; @@ -210,12 +210,4 @@ export interface TaskBroker { order?: { order: 'asc' | 'desc'; field: string }[]; permissionFilters?: PermissionCriteria; }): Promise<{ tasks: SerializedTask[]; totalTasks?: number }>; - - /** - * @deprecated Make sure to pass `createdBy` and `status` in the `filters` parameter instead - */ - list?(options: { - createdBy?: string; - status?: TaskStatus; - }): Promise<{ tasks: SerializedTask[]; totalTasks?: number }>; }