@backstage/plugin-scaffolder-backend 1.22.11 → 1.23.0-next.1

package/dist/cjs/{router-BtUx0eIt.cjs.js → router-BpffhBor.cjs.js}

@@ -6,7 +6,7 @@ var config = require('@backstage/config');
 var errors = require('@backstage/errors');
 var integration = require('@backstage/integration');
 var pluginScaffolderCommon = require('@backstage/plugin-scaffolder-common');
-var alpha = require('@backstage/plugin-scaffolder-common/alpha');
+var alpha$1 = require('@backstage/plugin-scaffolder-common/alpha');
 var express = require('express');
 var Router = require('express-promise-router');
 var jsonschema = require('jsonschema');
@@ -30,15 +30,13 @@ var gerrit = require('@backstage/plugin-scaffolder-backend-module-gerrit');
 var gitlab = require('@backstage/plugin-scaffolder-backend-module-gitlab');
 var pluginScaffolderBackendModuleGitea = require('@backstage/plugin-scaffolder-backend-module-gitea');
 var uuid = require('uuid');
-var tar = require('tar');
-var concatStream = require('concat-stream');
-var util = require('util');
-var stream = require('stream');
+var alpha = require('@backstage/plugin-scaffolder-node/alpha');
 var ObservableImpl = require('zen-observable');
 var lodash = require('lodash');
 var PQueue = require('p-queue');
 var winston = require('winston');
 var nunjucks = require('nunjucks');
+var stream = require('stream');
 var pluginPermissionNode = require('@backstage/plugin-permission-node');
 var promClient = require('prom-client');
 var pluginPermissionCommon = require('@backstage/plugin-permission-common');
@@ -74,8 +72,6 @@ var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
 var path__default = /*#__PURE__*/_interopDefaultCompat(path);
 var globby__default = /*#__PURE__*/_interopDefaultCompat(globby);
 var get__default = /*#__PURE__*/_interopDefaultCompat(get);
-var tar__default = /*#__PURE__*/_interopDefaultCompat(tar);
-var concatStream__default = /*#__PURE__*/_interopDefaultCompat(concatStream);
 var ObservableImpl__default = /*#__PURE__*/_interopDefaultCompat(ObservableImpl);
 var PQueue__default = /*#__PURE__*/_interopDefaultCompat(PQueue);
 var winston__namespace = /*#__PURE__*/_interopNamespaceCompat(winston);
@@ -1509,23 +1505,6 @@ const intervalFromNowTill = (timeoutS, knex) => {
   return heartbeatInterval;
 };
 
-const pipeline = util.promisify(stream.pipeline);
-const serializeWorkspace = async (path) => {
-  return await new Promise(async (resolve) => {
-    await pipeline(tar__default.default.create({ cwd: path }, [""]), concatStream__default.default(resolve));
-  });
-};
-const restoreWorkspace = async (path, buffer) => {
-  if (buffer) {
-    await pipeline(
-      stream.Readable.from(buffer),
-      tar__default.default.extract({
-        C: path
-      })
-    );
-  }
-};
-
 const migrationsDir = backendPluginApi.resolvePackagePath(
   "@backstage/plugin-scaffolder-backend",
   "migrations"
@@ -1837,7 +1816,10 @@ class DatabaseTaskStore {
   }
   async rehydrateWorkspace(options) {
     const [result] = await this.db("tasks").where({ id: options.taskId }).select("workspace");
-    await restoreWorkspace(options.targetPath, result.workspace);
+    await alpha.restoreWorkspace({
+      path: options.targetPath,
+      buffer: result.workspace
+    });
   }
   async cleanWorkspace({ taskId }) {
     await this.db("tasks").where({ id: taskId }).update({
@@ -1847,7 +1829,7 @@ class DatabaseTaskStore {
   async serializeWorkspace(options) {
     if (options.path) {
       await this.db("tasks").where({ id: options.taskId }).update({
-        workspace: await serializeWorkspace(options.path)
+        workspace: (await alpha.serializeWorkspace(options)).contents
       });
     }
   }
@@ -1925,26 +1907,88 @@ const readDuration$1 = (config$1, key, defaultValue) => {
   return defaultValue;
 };
 
+class DatabaseWorkspaceProvider {
+  constructor(storage) {
+    this.storage = storage;
+  }
+  static create(storage) {
+    return new DatabaseWorkspaceProvider(storage);
+  }
+  async serializeWorkspace(options) {
+    this.storage.serializeWorkspace?.(options);
+  }
+  async rehydrateWorkspace(options) {
+    return this.storage.rehydrateWorkspace?.(options);
+  }
+  async cleanWorkspace(options) {
+    return this.storage.cleanWorkspace?.(options);
+  }
+}
+
+class DefaultWorkspaceService {
+  constructor(task, workspaceProvider, config) {
+    this.task = task;
+    this.workspaceProvider = workspaceProvider;
+    this.config = config;
+  }
+  static create(task, storage, additionalWorkspaceProviders, config) {
+    const workspaceProviderName = config?.getOptionalString(
+      "scaffolder.EXPERIMENTAL_workspaceSerializationProvider"
+    ) ?? "database";
+    const workspaceProvider = additionalWorkspaceProviders?.[workspaceProviderName] ?? DatabaseWorkspaceProvider.create(storage);
+    return new DefaultWorkspaceService(task, workspaceProvider, config);
+  }
+  async serializeWorkspace(options) {
+    if (this.isWorkspaceSerializationEnabled()) {
+      await this.workspaceProvider.serializeWorkspace({
+        path: options.path,
+        taskId: this.task.taskId
+      });
+    }
+  }
+  async cleanWorkspace() {
+    if (this.isWorkspaceSerializationEnabled()) {
+      await this.workspaceProvider.cleanWorkspace({ taskId: this.task.taskId });
+    }
+  }
+  async rehydrateWorkspace(options) {
+    if (this.isWorkspaceSerializationEnabled()) {
+      await this.workspaceProvider.rehydrateWorkspace(options);
+    }
+  }
+  isWorkspaceSerializationEnabled() {
+    return this.config?.getOptionalBoolean(
+      "scaffolder.EXPERIMENTAL_workspaceSerialization"
+    ) ?? false;
+  }
+}
+
 class TaskManager {
   // Runs heartbeat internally
-  constructor(task, storage, signal, logger, auth, config) {
+  constructor(task, storage, signal, logger, workspaceService, auth) {
     this.task = task;
     this.storage = storage;
     this.signal = signal;
     this.logger = logger;
+    this.workspaceService = workspaceService;
     this.auth = auth;
-    this.config = config;
   }
   isDone = false;
   heartbeatTimeoutId;
-  static create(task, storage, abortSignal, logger, auth, config) {
+  static create(task, storage, abortSignal, logger, auth, config, additionalWorkspaceProviders) {
+    const workspaceService = DefaultWorkspaceService.create(
+      task,
+      storage,
+      additionalWorkspaceProviders,
+      config
+    );
     const agent = new TaskManager(
       task,
       storage,
       abortSignal,
       logger,
-      auth,
-      config
+      workspaceService,
+      auth
     );
     agent.startTimeout();
     return agent;
@@ -1965,9 +2009,7 @@ class TaskManager {
     return this.task.taskId;
   }
   async rehydrateWorkspace(options) {
-    if (this.isWorkspaceSerializationEnabled()) {
-      this.storage.rehydrateWorkspace?.(options);
-    }
+    await this.workspaceService.rehydrateWorkspace(options);
   }
   get done() {
     return this.isDone;
@@ -1994,17 +2036,10 @@ class TaskManager {
     });
   }
   async serializeWorkspace(options) {
-    if (this.isWorkspaceSerializationEnabled()) {
-      await this.storage.serializeWorkspace?.({
-        path: options.path,
-        taskId: this.task.taskId
-      });
-    }
+    await this.workspaceService.serializeWorkspace(options);
   }
   async cleanWorkspace() {
-    if (this.isWorkspaceSerializationEnabled()) {
-      await this.storage.cleanWorkspace?.({ taskId: this.task.taskId });
-    }
+    await this.workspaceService.cleanWorkspace();
   }
   async complete(result, metadata) {
     await this.storage.completeTask({
@@ -2034,11 +2069,6 @@ class TaskManager {
       }
     }, 1e3);
   }
-  isWorkspaceSerializationEnabled() {
-    return this.config?.getOptionalBoolean(
-      "scaffolder.EXPERIMENTAL_workspaceSerialization"
-    ) ?? false;
-  }
   async getInitiatorCredentials() {
     const secrets = this.task.secrets;
     if (secrets && secrets.__initiatorCredentials) {
@@ -2061,11 +2091,12 @@ function defer() {
   return { promise, resolve };
 }
 class StorageTaskBroker {
-  constructor(storage, logger, config, auth) {
+  constructor(storage, logger, config, auth, additionalWorkspaceProviders) {
     this.storage = storage;
     this.logger = logger;
     this.config = config;
     this.auth = auth;
+    this.additionalWorkspaceProviders = additionalWorkspaceProviders;
   }
   async list(options) {
     if (!this.storage.list) {
@@ -2138,7 +2169,8 @@ class StorageTaskBroker {
           abortController.signal,
           this.logger,
           this.auth,
-          this.config
+          this.config,
+          this.additionalWorkspaceProviders
         );
       }
       await this.waitForDispatch();
@@ -2246,7 +2278,7 @@ function createHistogramMetric(config) {
 const createTemplatePermissionRule = pluginPermissionNode.makeCreatePermissionRule();
 const hasTag = createTemplatePermissionRule({
   name: "HAS_TAG",
-  resourceType: alpha.RESOURCE_TYPE_SCAFFOLDER_TEMPLATE,
+  resourceType: alpha$1.RESOURCE_TYPE_SCAFFOLDER_TEMPLATE,
   description: `Match parameters or steps with the given tag`,
   paramsSchema: zod.z.object({
     tag: zod.z.string().describe("Name of the tag to match on")
@@ -2259,7 +2291,7 @@ const hasTag = createTemplatePermissionRule({
 const createActionPermissionRule = pluginPermissionNode.makeCreatePermissionRule();
 const hasActionId = createActionPermissionRule({
   name: "HAS_ACTION_ID",
-  resourceType: alpha.RESOURCE_TYPE_SCAFFOLDER_ACTION,
+  resourceType: alpha$1.RESOURCE_TYPE_SCAFFOLDER_ACTION,
   description: `Match actions with the given actionId`,
   paramsSchema: zod.z.object({
     actionId: zod.z.string().describe("Name of the actionId to match on")
@@ -2294,7 +2326,7 @@ function buildHasProperty({
   return createActionPermissionRule({
     name,
     description: `Allow actions with the specified property`,
-    resourceType: alpha.RESOURCE_TYPE_SCAFFOLDER_ACTION,
+    resourceType: alpha$1.RESOURCE_TYPE_SCAFFOLDER_ACTION,
     paramsSchema: zod.z.object({
       key: zod.z.string().describe(`Property within the action parameters to match on`),
       value: valueSchema.optional().describe(`Value of the given property to match on`)
@@ -2722,7 +2754,6 @@ class NunjucksWorkflowRunner {
       if (task.cancelSignal.aborted) {
         throw new Error(`Step ${step.name} has been cancelled.`);
       }
-      await task.cleanWorkspace?.();
       await stepTrack.markSuccessful();
     } catch (err) {
       await taskTrack.markFailed(step, err);
@@ -2758,7 +2789,7 @@ class NunjucksWorkflowRunner {
         user: task.spec.user
       };
       const [decision] = this.options.permissions && task.spec.steps.length ? await this.options.permissions.authorizeConditional(
-        [{ permission: alpha.actionExecutePermission }],
+        [{ permission: alpha$1.actionExecutePermission }],
         { credentials: await task.getInitiatorCredentials() }
       ) : [{ result: pluginPermissionCommon.AuthorizeResult.ALLOW }];
       for (const step of task.spec.steps) {
@@ -2777,6 +2808,7 @@ class NunjucksWorkflowRunner {
       return { output };
     } finally {
       if (workspacePath) {
+        await task.cleanWorkspace?.();
         await fs__default.default.remove(workspacePath);
       }
     }
@@ -3175,10 +3207,10 @@ async function checkPermission(options) {
 }
 
 function isTemplatePermissionRuleInput(permissionRule) {
-  return permissionRule.resourceType === alpha.RESOURCE_TYPE_SCAFFOLDER_TEMPLATE;
+  return permissionRule.resourceType === alpha$1.RESOURCE_TYPE_SCAFFOLDER_TEMPLATE;
 }
 function isActionPermissionRuleInput(permissionRule) {
-  return permissionRule.resourceType === alpha.RESOURCE_TYPE_SCAFFOLDER_ACTION;
+  return permissionRule.resourceType === alpha$1.RESOURCE_TYPE_SCAFFOLDER_ACTION;
 }
 function isSupportedTemplate(entity) {
   return entity.apiVersion === "scaffolder.backstage.io/v1beta3";
@@ -3246,10 +3278,12 @@ async function createRouter(options) {
     scheduler,
     additionalTemplateFilters,
     additionalTemplateGlobals,
+    additionalWorkspaceProviders,
     permissions,
     permissionRules,
     discovery = backendCommon.HostDiscovery.fromConfig(config),
-    identity = buildDefaultIdentityClient(options)
+    identity = buildDefaultIdentityClient(options),
+    autocompleteHandlers = {}
   } = options;
   const { auth, httpAuth } = backendCommon.createLegacyAuthAdapters({
     ...options,
@@ -3263,7 +3297,13 @@ async function createRouter(options) {
   let taskBroker;
   if (!options.taskBroker) {
     const databaseTaskStore = await DatabaseTaskStore.create({ database });
-    taskBroker = new StorageTaskBroker(databaseTaskStore, logger, config, auth);
+    taskBroker = new StorageTaskBroker(
+      databaseTaskStore,
+      logger,
+      config,
+      auth,
+      additionalWorkspaceProviders
+    );
     if (scheduler && databaseTaskStore.listStaleTasks) {
       await scheduler.scheduleTask({
         id: "close_stale_tasks",
@@ -3356,17 +3396,17 @@ async function createRouter(options) {
   const permissionIntegrationRouter = pluginPermissionNode.createPermissionIntegrationRouter({
     resources: [
       {
-        resourceType: alpha.RESOURCE_TYPE_SCAFFOLDER_TEMPLATE,
-        permissions: alpha.scaffolderTemplatePermissions,
+        resourceType: alpha$1.RESOURCE_TYPE_SCAFFOLDER_TEMPLATE,
+        permissions: alpha$1.scaffolderTemplatePermissions,
         rules: templateRules
       },
       {
-        resourceType: alpha.RESOURCE_TYPE_SCAFFOLDER_ACTION,
-        permissions: alpha.scaffolderActionPermissions,
+        resourceType: alpha$1.RESOURCE_TYPE_SCAFFOLDER_ACTION,
+        permissions: alpha$1.scaffolderActionPermissions,
         rules: actionRules
       }
     ],
-    permissions: alpha.scaffolderTaskPermissions
+    permissions: alpha$1.scaffolderTaskPermissions
   });
   router.use(permissionIntegrationRouter);
   router.get(
@@ -3414,7 +3454,7 @@ async function createRouter(options) {
     const credentials = await httpAuth.credentials(req);
     await checkPermission({
       credentials,
-      permissions: [alpha.taskCreatePermission],
+      permissions: [alpha$1.taskCreatePermission],
       permissionService: permissions
     });
     const { token } = await auth.getPluginRequestToken({
@@ -3479,7 +3519,7 @@ async function createRouter(options) {
     const credentials = await httpAuth.credentials(req);
     await checkPermission({
       credentials,
-      permissions: [alpha.taskReadPermission],
+      permissions: [alpha$1.taskReadPermission],
       permissionService: permissions
     });
     const [userEntityRef] = [req.query.createdBy].flat();
@@ -3499,7 +3539,7 @@ async function createRouter(options) {
     const credentials = await httpAuth.credentials(req);
     await checkPermission({
       credentials,
-      permissions: [alpha.taskReadPermission],
+      permissions: [alpha$1.taskReadPermission],
       permissionService: permissions
     });
     const { taskId } = req.params;
@@ -3513,7 +3553,7 @@ async function createRouter(options) {
     const credentials = await httpAuth.credentials(req);
     await checkPermission({
       credentials,
-      permissions: [alpha.taskCancelPermission, alpha.taskReadPermission],
+      permissions: [alpha$1.taskCancelPermission, alpha$1.taskReadPermission],
       permissionService: permissions
     });
     const { taskId } = req.params;
@@ -3523,7 +3563,7 @@ async function createRouter(options) {
     const credentials = await httpAuth.credentials(req);
     await checkPermission({
       credentials,
-      permissions: [alpha.taskReadPermission],
+      permissions: [alpha$1.taskReadPermission],
       permissionService: permissions
     });
     const { taskId } = req.params;
@@ -3569,7 +3609,7 @@ data: ${JSON.stringify(event)}
     const credentials = await httpAuth.credentials(req);
     await checkPermission({
       credentials,
-      permissions: [alpha.taskReadPermission],
+      permissions: [alpha$1.taskReadPermission],
       permissionService: permissions
     });
     const { taskId } = req.params;
@@ -3597,7 +3637,7 @@ data: ${JSON.stringify(event)}
     const credentials = await httpAuth.credentials(req);
     await checkPermission({
       credentials,
-      permissions: [alpha.taskCreatePermission],
+      permissions: [alpha$1.taskCreatePermission],
       permissionService: permissions
     });
     const bodySchema = zod.z.object({
@@ -3619,6 +3659,8 @@ data: ${JSON.stringify(event)}
       onBehalfOf: credentials,
       targetPluginId: "catalog"
     });
+    const userEntityRef = auth.isPrincipal(credentials, "user") ? credentials.principal.userEntityRef : void 0;
+    const userEntity = userEntityRef ? await catalogClient.getEntityByRef(userEntityRef, { token }) : void 0;
     for (const parameters of [template.spec.parameters ?? []].flat()) {
       const result2 = jsonschema.validate(body.values, parameters);
       if (!result2.valid) {
@@ -3636,7 +3678,11 @@ data: ${JSON.stringify(event)}
         apiVersion: template.apiVersion,
         steps,
         output: template.spec.output ?? {},
-        parameters: body.values
+        parameters: body.values,
+        user: {
+          entity: userEntity,
+          ref: userEntityRef
+        }
       },
       directoryContents: (body.directoryContents ?? []).map((file) => ({
         path: file.path,
@@ -3657,6 +3703,19 @@ data: ${JSON.stringify(event)}
         base64Content: file.content.toString("base64")
       }))
     });
+  }).post("/v2/autocomplete/:provider/:resource", async (req, res) => {
+    const { token, context } = req.body;
+    const { provider, resource } = req.params;
+    if (!token) throw new errors.InputError("Missing token query parameter");
+    if (!autocompleteHandlers[provider]) {
+      throw new errors.InputError(`Unsupported provider: ${provider}`);
+    }
+    const { results } = await autocompleteHandlers[provider]({
+      resource,
+      token,
+      context
+    });
+    res.status(200).json({ results });
   });
   const app = express__default.default();
   app.set("logger", logger);
@@ -3677,8 +3736,8 @@ data: ${JSON.stringify(event)}
     }
     const [parameterDecision, stepDecision] = await permissions.authorizeConditional(
       [
-        { permission: alpha.templateParameterReadPermission },
-        { permission: alpha.templateStepReadPermission }
+        { permission: alpha$1.templateParameterReadPermission },
+        { permission: alpha$1.templateStepReadPermission }
       ],
       { credentials }
     );
@@ -3715,4 +3774,4 @@ exports.createRouter = createRouter;
 exports.createWaitAction = createWaitAction;
 exports.scaffolderActionRules = scaffolderActionRules;
 exports.scaffolderTemplateRules = scaffolderTemplateRules;
-//# sourceMappingURL=router-BtUx0eIt.cjs.js.map
+//# sourceMappingURL=router-BpffhBor.cjs.js.map