@backstage/plugin-scaffolder-backend 0.0.0-nightly-20220217022146 → 0.0.0-nightly-20220221022454

package/CHANGELOG.md

@@ -1,6 +1,64 @@
 # @backstage/plugin-scaffolder-backend
 
-## 0.0.0-nightly-20220217022146
+## 0.0.0-nightly-20220221022454
+
+### Minor Changes
+
+- 7f193ff019: - **BREAKING** - `DatabaseTaskStore()` constructor is now removed. Please use the `DatabaseTaskStore.create()` method instead.
+
+  - **BREAKING** - `TaskStore.createTask()` method now only takes one argument of type `TaskStoreCreateTaskOptions` which encapsulates the `spec` and `secrets`
+
+  ```diff
+  - TaskStore.createTask(spec, secrets)
+  + TaskStore.createTask({ spec, secrets})
+  ```
+
+  - **BREAKING** - `TaskBroker.dispatch()` method now only takes one argument of type `TaskBrokerDispatchOptions` which encapsulates the `spec` and `secrets`
+
+  ```diff
+  - TaskBroker.dispatch(spec, secrets)
+  + TaskBroker.dispatch({ spec, secrets})
+  ```
+
+### Patch Changes
+
+- 6981ac4ad2: - **DEPRECATED** - The `containerRunner` option passed to `createBuiltinActions` has now been deprecated.
+
+  - **DEPRECATED** - The `createFetchCookiecutterAction` export has also been deprecated and will soon disappear from this plugin.
+
+  The `fetch:cookiecutter` action will soon be removed from the default list of actions that are provided out of the box from the scaffolder plugin. It will still be supported, and maintained by the community, so you can install the package (`@backstage/plugin-scaffolder-backend-module-cookiecutter`) and pass it in as a custom action. Or you can migrate your templates to use [`fetch:template`](https://backstage.io/docs/features/software-templates/builtin-actions#migrating-from-fetchcookiecutter-to-fetchtemplate) with the `cookiecutterCompat` option.
+
+- 0f37cdef19: Migrated over from the deprecated `spec.metadata` to `spec.templateInfo` for the `name` and the `baseUrl` of the template.
+- 7f193ff019: - **DEPRECATED** - `Status` has been deprecated in favour of `TaskStatus`
+  - **DEPRECATED** - `CompletedTaskState` has been deprecated in favour of `TaskCompletionState`
+  - **DEPRECATED** - `DispatchResult` has been deprecated in favour of `TaskBrokerDispatchResult`
+- df61ca71dd: Implemented required `getProcessorName` method for catalog processor.
+- Updated dependencies
+  - @backstage/plugin-catalog-backend@0.0.0-nightly-20220221022454
+  - @backstage/plugin-scaffolder-common@0.0.0-nightly-20220221022454
+  - @backstage/catalog-model@0.0.0-nightly-20220221022454
+  - @backstage/plugin-scaffolder-backend-module-cookiecutter@0.0.0-nightly-20220221022454
+  - @backstage/integration@0.0.0-nightly-20220221022454
+  - @backstage/catalog-client@0.0.0-nightly-20220221022454
+
+## 0.16.1
+
+### Patch Changes
+
+- Fix for the previous release with missing type declarations.
+- Updated dependencies
+  - @backstage/backend-common@0.10.9
+  - @backstage/catalog-client@0.7.1
+  - @backstage/catalog-model@0.10.1
+  - @backstage/config@0.1.15
+  - @backstage/errors@0.2.2
+  - @backstage/integration@0.7.4
+  - @backstage/types@0.1.3
+  - @backstage/plugin-catalog-backend@0.21.5
+  - @backstage/plugin-scaffolder-backend-module-cookiecutter@0.2.1
+  - @backstage/plugin-scaffolder-common@0.2.1
+
+## 0.16.0
 
 ### Minor Changes
 
@@ -23,16 +81,16 @@
 - 1433045c08: Removed unused `helmet` dependency.
 - 27eccab216: Replaces use of deprecated catalog-model constants.
 - Updated dependencies
-  - @backstage/plugin-scaffolder-common@0.0.0-nightly-20220217022146
-  - @backstage/plugin-catalog-backend@0.0.0-nightly-20220217022146
-  - @backstage/backend-common@0.0.0-nightly-20220217022146
-  - @backstage/catalog-client@0.0.0-nightly-20220217022146
-  - @backstage/errors@0.0.0-nightly-20220217022146
-  - @backstage/integration@0.0.0-nightly-20220217022146
-  - @backstage/catalog-model@0.0.0-nightly-20220217022146
-  - @backstage/config@0.0.0-nightly-20220217022146
-  - @backstage/types@0.0.0-nightly-20220217022146
-  - @backstage/plugin-scaffolder-backend-module-cookiecutter@0.0.0-nightly-20220217022146
+  - @backstage/plugin-scaffolder-common@0.2.0
+  - @backstage/plugin-catalog-backend@0.21.4
+  - @backstage/backend-common@0.10.8
+  - @backstage/catalog-client@0.7.0
+  - @backstage/errors@0.2.1
+  - @backstage/integration@0.7.3
+  - @backstage/catalog-model@0.10.0
+  - @backstage/config@0.1.14
+  - @backstage/types@0.1.2
+  - @backstage/plugin-scaffolder-backend-module-cookiecutter@0.2.0
 
 ## 0.15.24
 

package/dist/index.cjs.js

@@ -250,9 +250,6 @@ async function fetchContents({
   fetchUrl = ".",
   outputPath
 }) {
-  if (typeof fetchUrl !== "string") {
-    throw new errors.InputError(`Invalid url parameter, expected string, got ${typeof fetchUrl}`);
-  }
   let fetchUrlIsAbsolute = false;
   try {
     new URL(fetchUrl);
@@ -309,14 +306,14 @@ function createFetchPlainAction(options) {
       }
     },
     async handler(ctx) {
-      var _a;
+      var _a, _b;
       ctx.logger.info("Fetching plain content from remote URL");
       const targetPath = (_a = ctx.input.targetPath) != null ? _a : "./";
       const outputPath = backendCommon.resolveSafeChildPath(ctx.workspacePath, targetPath);
       await fetchContents({
         reader,
         integrations,
-        baseUrl: ctx.baseUrl,
+        baseUrl: (_b = ctx.templateInfo) == null ? void 0 : _b.baseUrl,
         fetchUrl: ctx.input.url,
         outputPath
       });
@@ -475,7 +472,7 @@ function createFetchTemplateAction(options) {
       }
     },
     async handler(ctx) {
-      var _a;
+      var _a, _b;
       ctx.logger.info("Fetching template content from remote URL");
       const workDir = await ctx.createTemporaryDirectory();
       const templateDir = backendCommon.resolveSafeChildPath(workDir, "template");
@@ -497,7 +494,7 @@ function createFetchTemplateAction(options) {
       await fetchContents({
         reader,
         integrations,
-        baseUrl: ctx.baseUrl,
+        baseUrl: (_b = ctx.templateInfo) == null ? void 0 : _b.baseUrl,
         fetchUrl: ctx.input.url,
         outputPath: templateDir
       });
@@ -2054,6 +2051,9 @@ const createBuiltinActions = (options) => {
     })
   ];
   if (containerRunner) {
+    backendCommon.getRootLogger().warn(`[DEPRECATED] The fetch:cookiecutter action will be removed part of the default scaffolder actions in later versions. 
+You can install the package seperately and remove the containerRunner from the createBuiltInActions to remove this warning,
+or you can migrate to using fetch:template https://backstage.io/docs/features/software-templates/builtin-actions#migrating-from-fetchcookiecutter-to-fetchtemplate`);
     actions.push(pluginScaffolderBackendModuleCookiecutter.createFetchCookiecutterAction({
       reader,
       integrations,
@@ -2116,12 +2116,12 @@ class DatabaseTaskStore {
       throw new Error(`Failed to parse spec of task '${taskId}', ${error}`);
     }
   }
-  async createTask(spec, secrets) {
+  async createTask(options) {
     const taskId = uuid.v4();
     await this.db("tasks").insert({
       id: taskId,
-      spec: JSON.stringify(spec),
-      secrets: secrets ? JSON.stringify(secrets) : void 0,
+      spec: JSON.stringify(options.spec),
+      secrets: options.secrets ? JSON.stringify(options.secrets) : void 0,
       status: "open"
     });
     return { taskId };
@@ -2333,8 +2333,8 @@ class StorageTaskBroker {
       await this.waitForDispatch();
     }
   }
-  async dispatch(spec, secrets) {
-    const taskRow = await this.storage.createTask(spec, secrets);
+  async dispatch(options) {
+    const taskRow = await this.storage.createTask(options);
     this.signalDispatch();
     return {
       taskId: taskRow.taskId
@@ -2368,8 +2368,8 @@ class StorageTaskBroker {
     })();
     return { unsubscribe };
   }
-  async vacuumTasks(timeoutS) {
-    const { tasks } = await this.storage.listStaleTasks(timeoutS);
+  async vacuumTasks(options) {
+    const { tasks } = await this.storage.listStaleTasks(options);
     await Promise.all(tasks.map(async (task) => {
       try {
         await this.storage.completeTask({
@@ -2509,9 +2509,6 @@ class HandlebarsWorkflowRunner {
           this.options.logger.debug(`Running ${action.id} with input`, {
             input: JSON.stringify(input, null, 2)
           });
-          if (!task.spec.metadata) {
-            console.warn("DEPRECATION NOTICE: metadata is undefined. metadata will be required in the future.");
-          }
           await action.handler({
             baseUrl: task.spec.baseUrl,
             logger: taskLogger,
@@ -2527,7 +2524,8 @@ class HandlebarsWorkflowRunner {
             output(name, value) {
               stepOutputs[name] = value;
             },
-            metadata: task.spec.metadata
+            metadata: task.spec.metadata,
+            templateInfo: task.spec.templateInfo
           });
           for (const tmpDir of tmpDirs) {
             await fs__default["default"].remove(tmpDir);
@@ -2702,7 +2700,8 @@ class NunjucksWorkflowRunner {
             output(name, value) {
               stepOutput[name] = value;
             },
-            metadata: task.spec.metadata
+            metadata: task.spec.metadata,
+            templateInfo: task.spec.templateInfo
           });
           for (const tmpDir of tmpDirs) {
             await fs__default["default"].remove(tmpDir);
@@ -2934,14 +2933,17 @@ async function createRouter(options) {
     });
     res.json(actionsList);
   }).post("/v2/tasks", async (req, res) => {
-    var _a, _b, _c, _d, _e;
+    var _a, _b, _c, _d;
     const templateName = req.body.templateName;
+    const { kind, namespace } = { kind: "template", namespace: "default" };
     const values = req.body.values;
     const token = getBearerToken(req.headers.authorization);
     const template = await findTemplate({
       catalogApi: catalogClient,
       entityRef: {
-        name: templateName
+        name: templateName,
+        kind,
+        namespace
       },
       token: getBearerToken(req.headers.authorization)
     });
@@ -2958,10 +2960,8 @@ async function createRouter(options) {
         }
       }
       const baseUrl = getEntityBaseUrl(template);
-      taskSpec = template.apiVersion === "backstage.io/v1beta2" ? {
-        apiVersion: template.apiVersion,
+      const baseTaskSpec = {
         baseUrl,
-        values,
         steps: template.spec.steps.map((step, index) => {
           var _a2, _b2;
           return {
@@ -2971,29 +2971,34 @@ async function createRouter(options) {
           };
         }),
         output: (_b = template.spec.output) != null ? _b : {},
-        metadata: { name: (_c = template.metadata) == null ? void 0 : _c.name }
+        metadata: { name: (_c = template.metadata) == null ? void 0 : _c.name },
+        templateInfo: {
+          entityRef: catalogModel.stringifyEntityRef({
+            kind,
+            namespace,
+            name: (_d = template.metadata) == null ? void 0 : _d.name
+          }),
+          baseUrl
+        }
+      };
+      taskSpec = template.apiVersion === "backstage.io/v1beta2" ? {
+        ...baseTaskSpec,
+        apiVersion: template.apiVersion,
+        values
       } : {
+        ...baseTaskSpec,
         apiVersion: template.apiVersion,
-        baseUrl,
-        parameters: values,
-        steps: template.spec.steps.map((step, index) => {
-          var _a2, _b2;
-          return {
-            ...step,
-            id: (_a2 = step.id) != null ? _a2 : `step-${index + 1}`,
-            name: (_b2 = step.name) != null ? _b2 : step.action
-          };
-        }),
-        output: (_d = template.spec.output) != null ? _d : {},
-        metadata: { name: (_e = template.metadata) == null ? void 0 : _e.name }
+        parameters: values
       };
     } else {
       throw new errors.InputError(`Unsupported apiVersion field in schema entity, ${template.apiVersion}`);
     }
-    const result = await taskBroker.dispatch(taskSpec, {
-      ...req.body.secrets,
-      backstageToken: token,
-      token
+    const result = await taskBroker.dispatch({
+      spec: taskSpec,
+      secrets: {
+        ...req.body.secrets,
+        backstageToken: token
+      }
     });
     res.status(201).json({ id: result.taskId });
   }).get("/v2/tasks/:taskId", async (req, res) => {
@@ -3072,6 +3077,9 @@ class ScaffolderEntitiesProcessor {
   constructor() {
     this.validators = [pluginScaffolderCommon.templateEntityV1beta3Validator];
   }
+  getProcessorName() {
+    return "ScaffolderEntitiesProcessor";
+  }
   async validateEntityKind(entity) {
     for (const validator of this.validators) {
       if (await validator.check(entity)) {