@backstage/plugin-scaffolder-backend 1.21.0-next.0 → 1.21.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,41 @@
 # @backstage/plugin-scaffolder-backend
 
+## 1.21.0-next.1
+
+### Minor Changes
+
+- 78c100b: Support providing an overriding token for `fetch:template`, `fetch:plain` and `fetch:file` when interacting with upstream integrations
+
+### Patch Changes
+
+- 09f8b31: Simple typo fix in the fetch:template action example on the word 'skeleton'.
+- f6792c6: Move the `NODE_OPTIONS` messaging for `--no-node-snapshot` to the `SecureTemplater` in order to get better messaging at runtime
+- e1c479d: When using node 20+ the `scaffolder-backend` will now throw an error at startup if the `--no-node-snapshot` option was
+  not provided to node.
+- e0e5afe: Add option to configure nunjucks with the `trimBlocks` and `lstripBlocks` options in the fetch:template action
+- Updated dependencies
+  - @backstage/plugin-scaffolder-backend-module-github@0.2.0-next.1
+  - @backstage/catalog-model@1.4.4-next.0
+  - @backstage/catalog-client@1.6.0-next.1
+  - @backstage/backend-plugin-api@0.6.10-next.1
+  - @backstage/backend-common@0.21.0-next.1
+  - @backstage/integration@1.9.0-next.0
+  - @backstage/plugin-scaffolder-node@0.3.0-next.1
+  - @backstage/backend-tasks@0.5.15-next.1
+  - @backstage/config@1.1.1
+  - @backstage/errors@1.2.3
+  - @backstage/types@1.1.1
+  - @backstage/plugin-auth-node@0.4.4-next.1
+  - @backstage/plugin-catalog-backend-module-scaffolder-entity-model@0.1.7-next.1
+  - @backstage/plugin-catalog-node@1.6.2-next.1
+  - @backstage/plugin-permission-common@0.7.12
+  - @backstage/plugin-permission-node@0.7.21-next.1
+  - @backstage/plugin-scaffolder-backend-module-azure@0.1.2-next.1
+  - @backstage/plugin-scaffolder-backend-module-bitbucket@0.1.2-next.1
+  - @backstage/plugin-scaffolder-backend-module-gerrit@0.1.2-next.1
+  - @backstage/plugin-scaffolder-backend-module-gitlab@0.2.13-next.1
+  - @backstage/plugin-scaffolder-common@1.5.0-next.1
+
 ## 1.21.0-next.0
 
 ### Minor Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-backend",
-  "version": "1.21.0-next.0",
+  "version": "1.21.0-next.1",
   "main": "../dist/alpha.cjs.js",
   "types": "../dist/alpha.d.ts"
 }

package/dist/alpha.cjs.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var alpha = require('@backstage/plugin-scaffolder-common/alpha');
 var pluginPermissionNode = require('@backstage/plugin-permission-node');
-var router = require('./cjs/router-842a762b.cjs.js');
+var router = require('./cjs/router-43c4dd8a.cjs.js');
 var backendPluginApi = require('@backstage/backend-plugin-api');
 var backendCommon = require('@backstage/backend-common');
 var integration = require('@backstage/integration');

package/dist/cjs/{router-842a762b.cjs.js → router-43c4dd8a.cjs.js}

@@ -640,6 +640,11 @@ function createFetchPlainAction(options) {
             title: "Target Path",
             description: "Target path within the working directory to download the contents to.",
             type: "string"
+          },
+          token: {
+            title: "Token",
+            description: "An optional token to use for authentication when reading the resources.",
+            type: "string"
           }
         }
       }
@@ -655,7 +660,8 @@ function createFetchPlainAction(options) {
         integrations,
         baseUrl: (_b = ctx.templateInfo) == null ? void 0 : _b.baseUrl,
         fetchUrl: ctx.input.url,
-        outputPath
+        outputPath,
+        token: ctx.input.token
       });
     }
   });
@@ -700,6 +706,11 @@ function createFetchPlainFileAction(options) {
             title: "Target Path",
             description: "Target path within the working directory to download the file as.",
             type: "string"
+          },
+          token: {
+            title: "Token",
+            description: "An optional token to use for authentication when reading the resources.",
+            type: "string"
           }
         }
       }
@@ -717,12 +728,22 @@ function createFetchPlainFileAction(options) {
         integrations,
         baseUrl: (_a = ctx.templateInfo) == null ? void 0 : _a.baseUrl,
         fetchUrl: ctx.input.url,
-        outputPath
+        outputPath,
+        token: ctx.input.token
       });
     }
   });
 }
 
+function isNoNodeSnapshotOptionProvided() {
+  var _a;
+  return ((_a = process.env.NODE_OPTIONS) == null ? void 0 : _a.includes("--no-node-snapshot")) || process.argv.includes("--no-node-snapshot");
+}
+function getMajorNodeVersion() {
+  const version = process.versions.node;
+  return parseInt(version.split(".")[0], 10);
+}
+
 const mkScript = (nunjucksSource) => `
 const { render, renderCompat } = (() => {
   const module = {};
@@ -733,6 +754,7 @@ const { render, renderCompat } = (() => {
 
   const env = module.exports.configure({
     autoescape: false,
+    ...JSON.parse(nunjucksConfigs),
     tags: {
       variableStart: '\${{',
       variableEnd: '}}',
@@ -741,6 +763,7 @@ const { render, renderCompat } = (() => {
 
   const compatEnv = module.exports.configure({
     autoescape: false,
+    ...JSON.parse(nunjucksConfigs),
     tags: {
       variableStart: '{{',
       variableEnd: '}}',
@@ -793,8 +816,16 @@ class SecureTemplater {
     const {
       cookiecutterCompat,
       templateFilters = {},
-      templateGlobals = {}
+      templateGlobals = {},
+      nunjucksConfigs = {}
     } = options;
+    const nodeVersion = getMajorNodeVersion();
+    if (nodeVersion >= 20 && !isNoNodeSnapshotOptionProvided()) {
+      throw new Error(
+        `When using Node.js version 20 or newer, the scaffolder backend plugin requires that it be started with the --no-node-snapshot option. 
+        Please make sure that you have NODE_OPTIONS=--no-node-snapshot in your environment.`
+      );
+    }
     const isolate = new isolatedVm.Isolate({ memoryLimit: 128 });
     const context = await isolate.createContext();
     const contextGlobal = context.global;
@@ -808,6 +839,7 @@ class SecureTemplater {
     const nunjucksScript = await isolate.compileScript(
       mkScript(nunjucksSource)
     );
+    await contextGlobal.set("nunjucksConfigs", JSON.stringify(nunjucksConfigs));
     const availableFilters = Object.keys(templateFilters);
     await contextGlobal.set(
       "availableTemplateFilters",
@@ -884,7 +916,7 @@ const createDefaultFilters = ({
 
 const examples$2 = [
   {
-    description: "Downloads a skelaton directory that lives alongside the template file and fill it out with values.",
+    description: "Downloads a skeleton directory that lives alongside the template file and fill it out with values.",
     example: yaml__default["default"].stringify({
       steps: [
         {
@@ -969,6 +1001,11 @@ function createFetchTemplateAction(options) {
             title: "Replace files",
             description: "If set, replace files in targetPath instead of skipping existing ones.",
             type: "boolean"
+          },
+          token: {
+            title: "Token",
+            description: "An optional token to use for authentication when reading the resources.",
+            type: "string"
           }
         }
       }
@@ -1020,7 +1057,8 @@ function createFetchTemplateAction(options) {
         integrations,
         baseUrl: (_b = ctx.templateInfo) == null ? void 0 : _b.baseUrl,
         fetchUrl: ctx.input.url,
-        outputPath: templateDir
+        outputPath: templateDir,
+        token: ctx.input.token
       });
       ctx.logger.info("Listing files and directories in template");
       const allEntriesInTemplate = await globby__default["default"](`**/*`, {
@@ -1053,7 +1091,11 @@ function createFetchTemplateAction(options) {
           ...defaultTemplateFilters,
           ...additionalTemplateFilters
         },
-        templateGlobals: additionalTemplateGlobals
+        templateGlobals: additionalTemplateGlobals,
+        nunjucksConfigs: {
+          trimBlocks: ctx.input.trimBlocks,
+          lstripBlocks: ctx.input.lstripBlocks
+        }
       });
       for (const location of allEntriesInTemplate) {
         let renderContents;
@@ -3340,4 +3382,4 @@ exports.createRouter = createRouter;
 exports.createWaitAction = createWaitAction;
 exports.scaffolderActionRules = scaffolderActionRules;
 exports.scaffolderTemplateRules = scaffolderTemplateRules;
-//# sourceMappingURL=router-842a762b.cjs.js.map
+//# sourceMappingURL=router-43c4dd8a.cjs.js.map