@backstage/plugin-scaffolder-backend 0.15.9 → 0.15.13

package/dist/index.d.ts

@@ -3,13 +3,15 @@ import { ScmIntegrations, ScmIntegrationRegistry } from '@backstage/integration'
 import { CatalogApi } from '@backstage/catalog-client';
 import { Logger } from 'winston';
 import { Writable } from 'stream';
-import * as _backstage_config from '@backstage/config';
-import { Config, JsonValue, JsonObject } from '@backstage/config';
+import * as _backstage_types from '@backstage/types';
+import { JsonValue, JsonObject } from '@backstage/types';
 import { Schema } from 'jsonschema';
 import { UrlReader, ContainerRunner, PluginDatabaseManager } from '@backstage/backend-common';
+import { Config } from '@backstage/config';
 import { createPullRequest } from 'octokit-plugin-create-pull-request';
 import { Octokit } from '@octokit/rest';
 export { createFetchCookiecutterAction } from '@backstage/plugin-scaffolder-backend-module-cookiecutter';
+import { Knex } from 'knex';
 import express from 'express';
 import { TemplateEntityV1beta2, Entity, LocationSpec } from '@backstage/catalog-model';
 import { CatalogProcessor, CatalogProcessorEmit } from '@backstage/plugin-catalog-backend';
@@ -144,6 +146,204 @@ declare type RunCommandOptions = {
 };
 declare const runCommand: ({ command, args, logStream, }: RunCommandOptions) => Promise<void>;
 
+/**
+ * Status
+ *
+ * @public
+ */
+declare type Status = 'open' | 'processing' | 'failed' | 'cancelled' | 'completed';
+/**
+ * CompletedTaskState
+ *
+ * @public
+ */
+declare type CompletedTaskState = 'failed' | 'completed';
+/**
+ * SerializedTask
+ *
+ * @public
+ */
+declare type SerializedTask = {
+    id: string;
+    spec: TaskSpec;
+    status: Status;
+    createdAt: string;
+    lastHeartbeatAt?: string;
+    secrets?: TaskSecrets;
+};
+/**
+ * TaskEventType
+ *
+ * @public
+ */
+declare type TaskEventType = 'completion' | 'log';
+/**
+ * SerializedTaskEvent
+ *
+ * @public
+ */
+declare type SerializedTaskEvent = {
+    id: number;
+    taskId: string;
+    body: JsonObject;
+    type: TaskEventType;
+    createdAt: string;
+};
+/**
+ * TemplateMetadata
+ *
+ * @public
+ */
+declare type TemplateMetadata = {
+    name: string;
+};
+/**
+ * TaskSpecV1beta2
+ *
+ * @public
+ */
+interface TaskSpecV1beta2 {
+    apiVersion: 'backstage.io/v1beta2';
+    baseUrl?: string;
+    values: JsonObject;
+    steps: Array<{
+        id: string;
+        name: string;
+        action: string;
+        input?: JsonObject;
+        if?: string | boolean;
+    }>;
+    output: {
+        [name: string]: string;
+    };
+    metadata?: TemplateMetadata;
+}
+interface TaskStep {
+    id: string;
+    name: string;
+    action: string;
+    input?: JsonObject;
+    if?: string | boolean;
+}
+/**
+ * TaskSpecV1beta3
+ *
+ * @public
+ */
+interface TaskSpecV1beta3 {
+    apiVersion: 'scaffolder.backstage.io/v1beta3';
+    baseUrl?: string;
+    parameters: JsonObject;
+    steps: TaskStep[];
+    output: {
+        [name: string]: JsonValue;
+    };
+    metadata?: TemplateMetadata;
+}
+/**
+ * TaskSpec
+ *
+ * @public
+ */
+declare type TaskSpec = TaskSpecV1beta2 | TaskSpecV1beta3;
+/**
+ * TaskSecrets
+ *
+ * @public
+ */
+declare type TaskSecrets = {
+    token: string | undefined;
+};
+/**
+ * DispatchResult
+ *
+ * @public
+ */
+declare type DispatchResult = {
+    taskId: string;
+};
+/**
+ * Task
+ *
+ * @public
+ */
+interface TaskContext {
+    spec: TaskSpec;
+    secrets?: TaskSecrets;
+    done: boolean;
+    emitLog(message: string, metadata?: JsonValue): Promise<void>;
+    complete(result: CompletedTaskState, metadata?: JsonValue): Promise<void>;
+    getWorkspaceName(): Promise<string>;
+}
+/**
+ * TaskBroker
+ *
+ * @public
+ */
+interface TaskBroker {
+    claim(): Promise<TaskContext>;
+    dispatch(spec: TaskSpec, secrets?: TaskSecrets): Promise<DispatchResult>;
+    vacuumTasks(timeoutS: {
+        timeoutS: number;
+    }): Promise<void>;
+    observe(options: {
+        taskId: string;
+        after: number | undefined;
+    }, callback: (error: Error | undefined, result: {
+        events: SerializedTaskEvent[];
+    }) => void): {
+        unsubscribe: () => void;
+    };
+    get(taskId: string): Promise<SerializedTask>;
+}
+/**
+ * TaskStoreEmitOptions
+ *
+ * @public
+ */
+declare type TaskStoreEmitOptions = {
+    taskId: string;
+    body: JsonObject;
+};
+/**
+ * TaskStoreListEventsOptions
+ *
+ * @public
+ */
+declare type TaskStoreListEventsOptions = {
+    taskId: string;
+    after?: number | undefined;
+};
+/**
+ * TaskStore
+ *
+ * @public
+ */
+interface TaskStore {
+    createTask(task: TaskSpec, secrets?: TaskSecrets): Promise<{
+        taskId: string;
+    }>;
+    getTask(taskId: string): Promise<SerializedTask>;
+    claimTask(): Promise<SerializedTask | undefined>;
+    completeTask(options: {
+        taskId: string;
+        status: Status;
+        eventBody: JsonObject;
+    }): Promise<void>;
+    heartbeatTask(taskId: string): Promise<void>;
+    listStaleTasks(options: {
+        timeoutS: number;
+    }): Promise<{
+        tasks: {
+            taskId: string;
+        }[];
+    }>;
+    emitLogEvent({ taskId, body }: TaskStoreEmitOptions): Promise<void>;
+    listEvents({ taskId, after, }: TaskStoreListEventsOptions): Promise<{
+        events: SerializedTaskEvent[];
+    }>;
+}
+
 declare type PartialJsonObject = Partial<JsonObject>;
 declare type PartialJsonValue = PartialJsonObject | JsonValue | undefined;
 declare type InputBase = Partial<{
@@ -167,6 +367,7 @@ declare type ActionContext<Input extends InputBase> = {
      * Creates a temporary directory for use by the action, which is then cleaned up automatically.
      */
     createTemporaryDirectory(): Promise<string>;
+    metadata?: TemplateMetadata;
 };
 declare type TemplateAction<Input extends InputBase> = {
     id: string;
@@ -186,9 +387,112 @@ declare class TemplateActionRegistry {
 }
 
 declare const createTemplateAction: <Input extends Partial<{
-    [name: string]: _backstage_config.JsonValue | Partial<_backstage_config.JsonObject> | undefined;
+    [name: string]: _backstage_types.JsonValue | Partial<_backstage_types.JsonObject> | undefined;
 }>>(templateAction: TemplateAction<Input>) => TemplateAction<any>;
 
+/**
+ * DatabaseTaskStore
+ *
+ * @public
+ */
+declare type DatabaseTaskStoreOptions = {
+    database: Knex;
+};
+/**
+ * DatabaseTaskStore
+ *
+ * @public
+ */
+declare class DatabaseTaskStore implements TaskStore {
+    private readonly db;
+    static create(options: DatabaseTaskStoreOptions): Promise<DatabaseTaskStore>;
+    constructor(options: DatabaseTaskStoreOptions);
+    getTask(taskId: string): Promise<SerializedTask>;
+    createTask(spec: TaskSpec, secrets?: TaskSecrets): Promise<{
+        taskId: string;
+    }>;
+    claimTask(): Promise<SerializedTask | undefined>;
+    heartbeatTask(taskId: string): Promise<void>;
+    listStaleTasks({ timeoutS }: {
+        timeoutS: number;
+    }): Promise<{
+        tasks: {
+            taskId: string;
+        }[];
+    }>;
+    completeTask({ taskId, status, eventBody, }: {
+        taskId: string;
+        status: Status;
+        eventBody: JsonObject;
+    }): Promise<void>;
+    emitLogEvent({ taskId, body }: TaskStoreEmitOptions): Promise<void>;
+    listEvents({ taskId, after, }: TaskStoreListEventsOptions): Promise<{
+        events: SerializedTaskEvent[];
+    }>;
+}
+
+/**
+ * TaskManager
+ *
+ * @public
+ */
+declare class TaskManager implements TaskContext {
+    private readonly state;
+    private readonly storage;
+    private readonly logger;
+    private isDone;
+    private heartbeatTimeoutId?;
+    static create(state: TaskState, storage: TaskStore, logger: Logger): TaskManager;
+    private constructor();
+    get spec(): TaskSpec;
+    get secrets(): TaskSecrets | undefined;
+    getWorkspaceName(): Promise<string>;
+    get done(): boolean;
+    emitLog(message: string, metadata?: JsonObject): Promise<void>;
+    complete(result: CompletedTaskState, metadata?: JsonObject): Promise<void>;
+    private startTimeout;
+}
+/**
+ * TaskState
+ *
+ * @public
+ */
+interface TaskState {
+    spec: TaskSpec;
+    taskId: string;
+    secrets?: TaskSecrets;
+}
+
+/**
+ * CreateWorkerOptions
+ *
+ * @public
+ */
+declare type CreateWorkerOptions = {
+    taskBroker: TaskBroker;
+    actionRegistry: TemplateActionRegistry;
+    integrations: ScmIntegrations;
+    workingDirectory: string;
+    logger: Logger;
+};
+/**
+ * TaskWorker
+ *
+ * @public
+ */
+declare class TaskWorker {
+    private readonly options;
+    private constructor();
+    static create(options: CreateWorkerOptions): Promise<TaskWorker>;
+    start(): void;
+    runOneTask(task: TaskContext): Promise<void>;
+}
+
+/**
+ * RouterOptions
+ *
+ * @public
+ */
 interface RouterOptions {
     logger: Logger;
     config: Config;
@@ -198,6 +502,7 @@ interface RouterOptions {
     actions?: TemplateAction<any>[];
     taskWorkers?: number;
     containerRunner: ContainerRunner;
+    taskBroker?: TaskBroker;
 }
 declare function createRouter(options: RouterOptions): Promise<express.Router>;
 
@@ -224,4 +529,4 @@ declare class ScaffolderEntitiesProcessor implements CatalogProcessor {
     postProcessEntity(entity: Entity, _location: LocationSpec, emit: CatalogProcessorEmit): Promise<Entity>;
 }
 
-export { ActionContext, CatalogEntityClient, OctokitProvider, RouterOptions, ScaffolderEntitiesProcessor, TemplateAction, TemplateActionRegistry, createBuiltinActions, createCatalogRegisterAction, createCatalogWriteAction, createDebugLogAction, createFetchPlainAction, createFetchTemplateAction, createFilesystemDeleteAction, createFilesystemRenameAction, createGithubActionsDispatchAction, createGithubWebhookAction, createPublishAzureAction, createPublishBitbucketAction, createPublishFileAction, createPublishGithubAction, createPublishGithubPullRequestAction, createPublishGitlabAction, createRouter, createTemplateAction, fetchContents, runCommand };
+export { ActionContext, CatalogEntityClient, CompletedTaskState, CreateWorkerOptions, DatabaseTaskStore, DispatchResult, OctokitProvider, RouterOptions, ScaffolderEntitiesProcessor, SerializedTask, SerializedTaskEvent, Status, TaskBroker, TaskContext, TaskEventType, TaskManager, TaskSecrets, TaskSpec, TaskSpecV1beta2, TaskSpecV1beta3, TaskState, TaskStore, TaskStoreEmitOptions, TaskStoreListEventsOptions, TaskWorker, TemplateAction, TemplateActionRegistry, TemplateMetadata, createBuiltinActions, createCatalogRegisterAction, createCatalogWriteAction, createDebugLogAction, createFetchPlainAction, createFetchTemplateAction, createFilesystemDeleteAction, createFilesystemRenameAction, createGithubActionsDispatchAction, createGithubWebhookAction, createPublishAzureAction, createPublishBitbucketAction, createPublishFileAction, createPublishGithubAction, createPublishGithubPullRequestAction, createPublishGitlabAction, createRouter, createTemplateAction, fetchContents, runCommand };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-scaffolder-backend",
   "description": "The Backstage backend plugin that helps you create new things",
-  "version": "0.15.9",
+  "version": "0.15.13",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -30,15 +30,16 @@
     "clean": "backstage-cli clean"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.9.6",
-    "@backstage/catalog-client": "^0.5.0",
-    "@backstage/catalog-model": "^0.9.4",
-    "@backstage/config": "^0.1.10",
-    "@backstage/errors": "^0.1.2",
-    "@backstage/integration": "^0.6.8",
-    "@backstage/plugin-catalog-backend": "^0.17.0",
-    "@backstage/plugin-scaffolder-backend-module-cookiecutter": "^0.1.2",
-    "@backstage/plugin-scaffolder-common": "^0.1.0",
+    "@backstage/backend-common": "^0.9.10",
+    "@backstage/catalog-client": "^0.5.2",
+    "@backstage/catalog-model": "^0.9.7",
+    "@backstage/config": "^0.1.11",
+    "@backstage/errors": "^0.1.4",
+    "@backstage/integration": "^0.6.9",
+    "@backstage/plugin-catalog-backend": "^0.17.4",
+    "@backstage/plugin-scaffolder-backend-module-cookiecutter": "^0.1.4",
+    "@backstage/plugin-scaffolder-common": "^0.1.1",
+    "@backstage/types": "^0.1.1",
     "@gitbeaker/core": "^30.2.0",
     "@gitbeaker/node": "^30.2.0",
     "@octokit/rest": "^18.5.3",
@@ -64,14 +65,14 @@
     "luxon": "^2.0.2",
     "morgan": "^1.10.0",
     "nunjucks": "^3.2.3",
-    "octokit-plugin-create-pull-request": "^3.9.3",
+    "octokit-plugin-create-pull-request": "^3.10.0",
     "uuid": "^8.2.0",
     "winston": "^3.2.1",
     "yaml": "^1.10.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.7.16",
-    "@backstage/test-utils": "^0.1.19",
+    "@backstage/cli": "^0.9.0",
+    "@backstage/test-utils": "^0.1.22",
     "@types/command-exists": "^1.2.0",
     "@types/fs-extra": "^9.0.1",
     "@types/git-url-parse": "^9.0.0",
@@ -80,7 +81,7 @@
     "@types/supertest": "^2.0.8",
     "jest-when": "^3.1.0",
     "mock-fs": "^5.1.0",
-    "msw": "^0.29.0",
+    "msw": "^0.35.0",
     "supertest": "^6.1.3",
     "yaml": "^1.10.0"
   },
@@ -90,5 +91,5 @@
     "config.d.ts"
   ],
   "configSchema": "config.d.ts",
-  "gitHead": "0995c9cc5bb68ff8b847a08dd46a20cf39048213"
+  "gitHead": "ddfdcd2b44dc9848cf550cea5346d5f9916a36d9"
 }