@backstage/plugin-scaffolder-backend-module-sentry 0.2.14-next.1 → 0.2.14

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @backstage/plugin-scaffolder-backend-module-sentry
 
+## 0.2.14
+
+### Patch Changes
+
+- c8aa210: Updating import for the `scaffolderActionsExtensionPoint` to be the main export
+- eea5360: Add sentry:fetch:dsn action to retrieve a Sentry project's DSN
+- Updated dependencies
+  - @backstage/plugin-scaffolder-node@0.12.0
+  - @backstage/config@1.3.5
+  - @backstage/backend-plugin-api@1.4.4
+
 ## 0.2.14-next.1
 
 ### Patch Changes

package/README.md

@@ -4,6 +4,9 @@ Welcome to the Sentry Module for Scaffolder.
 
 Here you can find all Sentry related features to improve your scaffolder:
 
+- Create a Sentry Project
+- Fetch the DSN for an existing Sentry Project
+
 ## Getting started
 
 You need to configure the action in your backend:
@@ -112,6 +115,14 @@ spec:
         teamSlug: TEAM-SLUG
         name: ${{ parameters.name }}
 
+    - id: fetch-sentry-dsn
+      if: ${{ parameters.dryRun !== true }}
+      name: Get the DSN of the newly created Sentry Project
+      action: sentry:fetch:dsn
+      input:
+        organizationSlug: ORG-SLUG
+        projectSlug: ${{ parameters.name }}
+
     - id: publish
       if: ${{ parameters.dryRun !== true }}
       name: Publish

package/dist/actions/fetchDSN.cjs.js

@@ -0,0 +1,69 @@
+'use strict';
+
+var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
+var errors = require('@backstage/errors');
+
+function createSentryFetchDSNAction(options) {
+  const { config } = options;
+  return pluginScaffolderNode.createTemplateAction({
+    id: "sentry:fetch:dsn",
+    supportsDryRun: true,
+    schema: {
+      input: {
+        organizationSlug: (z) => z.string({
+          description: "The slug of the organization the project belongs to"
+        }),
+        projectSlug: (z) => z.string({
+          description: "The slug of the project to fetch the DSN for"
+        }),
+        authToken: (z) => z.string({
+          description: "authenticate via bearer auth token. Requires one of the following scopes: project:admin, project:read, project:write"
+        }).optional()
+      },
+      output: {
+        dsn: (z) => z.string({
+          description: "The public DSN of the Sentry project"
+        }).optional()
+      }
+    },
+    async handler(ctx) {
+      const { organizationSlug, projectSlug, authToken } = ctx.input;
+      const token = authToken ? authToken : config.getOptionalString("scaffolder.sentry.token");
+      if (!token) {
+        throw new errors.InputError(`No valid sentry token given`);
+      }
+      const response = await fetch(
+        `https://sentry.io/api/0/projects/${organizationSlug}/${projectSlug}/keys/`,
+        {
+          method: "GET",
+          headers: {
+            Authorization: `Bearer ${token}`,
+            "Content-Type": "application/json"
+          }
+        }
+      );
+      if (!response.headers.get("content-type")?.includes("application/json")) {
+        throw new errors.InputError(
+          `Unexpected Sentry Response Type: ${await response.text()}`
+        );
+      }
+      const keys = await response.json();
+      if (response.status !== 200) {
+        throw new errors.InputError(
+          `Sentry Response was: ${keys.detail || "Unknown error"}`
+        );
+      }
+      if (!Array.isArray(keys) || keys.length === 0) {
+        throw new errors.InputError("No keys found for the specified project");
+      }
+      const publicDsn = keys[0]?.dsn?.public;
+      if (!publicDsn) {
+        throw new errors.InputError("No public DSN found in project keys");
+      }
+      ctx.output("dsn", publicDsn);
+    }
+  });
+}
+
+exports.createSentryFetchDSNAction = createSentryFetchDSNAction;
+//# sourceMappingURL=fetchDSN.cjs.js.map

package/dist/actions/fetchDSN.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchDSN.cjs.js","sources":["../../src/actions/fetchDSN.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createTemplateAction } from '@backstage/plugin-scaffolder-node';\nimport { InputError } from '@backstage/errors';\nimport { Config } from '@backstage/config';\n\n/**\n * Creates the `sentry:fetch:dsn` Scaffolder action.\n *\n * @remarks\n *\n * See {@link https://backstage.io/docs/features/software-templates/writing-custom-actions}.\n *\n * @param options - Configuration of the Sentry API.\n * @public\n */\nexport function createSentryFetchDSNAction(options: { config: Config }) {\n  const { config } = options;\n\n  return createTemplateAction({\n    id: 'sentry:fetch:dsn',\n    supportsDryRun: true,\n    schema: {\n      input: {\n        organizationSlug: z =>\n          z.string({\n            description: 'The slug of the organization the project belongs to',\n          }),\n        projectSlug: z =>\n          z.string({\n            description: 'The slug of the project to fetch the DSN for',\n          }),\n        authToken: z =>\n          z\n            .string({\n              description:\n                'authenticate via bearer auth token. Requires one of the following scopes: project:admin, project:read, project:write',\n            })\n            .optional(),\n      },\n      output: {\n        dsn: z =>\n          z\n            .string({\n              description: 'The public DSN of the Sentry project',\n            })\n            .optional(),\n      },\n    },\n    async handler(ctx) {\n      const { organizationSlug, projectSlug, authToken } = ctx.input;\n\n      const token = authToken\n        ? authToken\n        : config.getOptionalString('scaffolder.sentry.token');\n\n      if (!token) {\n        throw new InputError(`No valid sentry token given`);\n      }\n\n      const response = await fetch(\n        `https://sentry.io/api/0/projects/${organizationSlug}/${projectSlug}/keys/`,\n        {\n          method: 'GET',\n          headers: {\n            Authorization: `Bearer ${token}`,\n            'Content-Type': 'application/json',\n          },\n        },\n      );\n\n      if (!response.headers.get('content-type')?.includes('application/json')) {\n        throw new InputError(\n          `Unexpected Sentry Response Type: ${await response.text()}`,\n        );\n      }\n\n      const keys = await response.json();\n\n      if (response.status !== 200) {\n        throw new InputError(\n          `Sentry Response was: ${keys.detail || 'Unknown error'}`,\n        );\n      }\n\n      if (!Array.isArray(keys) || keys.length === 0) {\n        throw new InputError('No keys found for the specified project');\n      }\n\n      const publicDsn = keys[0]?.dsn?.public;\n      if (!publicDsn) {\n        throw new InputError('No public DSN found in project keys');\n      }\n\n      ctx.output('dsn', publicDsn);\n    },\n  });\n}\n"],"names":["createTemplateAction","InputError"],"mappings":";;;;;AA8BO,SAAS,2BAA2B,OAAA,EAA6B;AACtE,EAAA,MAAM,EAAE,QAAO,GAAI,OAAA;AAEnB,EAAA,OAAOA,yCAAA,CAAqB;AAAA,IAC1B,EAAA,EAAI,kBAAA;AAAA,IACJ,cAAA,EAAgB,IAAA;AAAA,IAChB,MAAA,EAAQ;AAAA,MACN,KAAA,EAAO;AAAA,QACL,gBAAA,EAAkB,CAAA,CAAA,KAChB,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd,CAAA;AAAA,QACH,WAAA,EAAa,CAAA,CAAA,KACX,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd,CAAA;AAAA,QACH,SAAA,EAAW,CAAA,CAAA,KACT,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EACE;AAAA,SACH,EACA,QAAA;AAAS,OAChB;AAAA,MACA,MAAA,EAAQ;AAAA,QACN,GAAA,EAAK,CAAA,CAAA,KACH,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EAAa;AAAA,SACd,EACA,QAAA;AAAS;AAChB,KACF;AAAA,IACA,MAAM,QAAQ,GAAA,EAAK;AACjB,MAAA,MAAM,EAAE,gBAAA,EAAkB,WAAA,EAAa,SAAA,KAAc,GAAA,CAAI,KAAA;AAEzD,MAAA,MAAM,KAAA,GAAQ,SAAA,GACV,SAAA,GACA,MAAA,CAAO,kBAAkB,yBAAyB,CAAA;AAEtD,MAAA,IAAI,CAAC,KAAA,EAAO;AACV,QAAA,MAAM,IAAIC,kBAAW,CAAA,2BAAA,CAA6B,CAAA;AAAA,MACpD;AAEA,MAAA,MAAM,WAAW,MAAM,KAAA;AAAA,QACrB,CAAA,iCAAA,EAAoC,gBAAgB,CAAA,CAAA,EAAI,WAAW,CAAA,MAAA,CAAA;AAAA,QACnE;AAAA,UACE,MAAA,EAAQ,KAAA;AAAA,UACR,OAAA,EAAS;AAAA,YACP,aAAA,EAAe,UAAU,KAAK,CAAA,CAAA;AAAA,YAC9B,cAAA,EAAgB;AAAA;AAClB;AACF,OACF;AAEA,MAAA,IAAI,CAAC,SAAS,OAAA,CAAQ,GAAA,CAAI,cAAc,CAAA,EAAG,QAAA,CAAS,kBAAkB,CAAA,EAAG;AACvE,QAAA,MAAM,IAAIA,iBAAA;AAAA,UACR,CAAA,iCAAA,EAAoC,MAAM,QAAA,CAAS,IAAA,EAAM,CAAA;AAAA,SAC3D;AAAA,MACF;AAEA,MAAA,MAAM,IAAA,GAAO,MAAM,QAAA,CAAS,IAAA,EAAK;AAEjC,MAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,QAAA,MAAM,IAAIA,iBAAA;AAAA,UACR,CAAA,qBAAA,EAAwB,IAAA,CAAK,MAAA,IAAU,eAAe,CAAA;AAAA,SACxD;AAAA,MACF;AAEA,MAAA,IAAI,CAAC,KAAA,CAAM,OAAA,CAAQ,IAAI,CAAA,IAAK,IAAA,CAAK,WAAW,CAAA,EAAG;AAC7C,QAAA,MAAM,IAAIA,kBAAW,yCAAyC,CAAA;AAAA,MAChE;AAEA,MAAA,MAAM,SAAA,GAAY,IAAA,CAAK,CAAC,CAAA,EAAG,GAAA,EAAK,MAAA;AAChC,MAAA,IAAI,CAAC,SAAA,EAAW;AACd,QAAA,MAAM,IAAIA,kBAAW,qCAAqC,CAAA;AAAA,MAC5D;AAEA,MAAA,GAAA,CAAI,MAAA,CAAO,OAAO,SAAS,CAAA;AAAA,IAC7B;AAAA,GACD,CAAA;AACH;;;;"}

package/dist/index.cjs.js

@@ -3,10 +3,12 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var createProject = require('./actions/createProject.cjs.js');
+var fetchDSN = require('./actions/fetchDSN.cjs.js');
 var module$1 = require('./module.cjs.js');
 
 
 
 exports.createSentryCreateProjectAction = createProject.createSentryCreateProjectAction;
+exports.createSentryFetchDSNAction = fetchDSN.createSentryFetchDSNAction;
 exports.default = module$1.sentryModule;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -25,10 +25,30 @@ declare function createSentryCreateProjectAction(options: {
     [x: string]: any;
 }, "v2">;
 
+/**
+ * Creates the `sentry:fetch:dsn` Scaffolder action.
+ *
+ * @remarks
+ *
+ * See {@link https://backstage.io/docs/features/software-templates/writing-custom-actions}.
+ *
+ * @param options - Configuration of the Sentry API.
+ * @public
+ */
+declare function createSentryFetchDSNAction(options: {
+    config: Config;
+}): _backstage_plugin_scaffolder_node.TemplateAction<{
+    organizationSlug: string;
+    projectSlug: string;
+    authToken?: string | undefined;
+}, {
+    dsn?: string | undefined;
+}, "v2">;
+
 /**
  * @public
  * The Sentry Module for the Scaffolder Backend
  */
 declare const sentryModule: _backstage_backend_plugin_api.BackendFeature;
 
-export { createSentryCreateProjectAction, sentryModule as default };
+export { createSentryCreateProjectAction, createSentryFetchDSNAction, sentryModule as default };

package/dist/module.cjs.js

@@ -3,6 +3,7 @@
 var backendPluginApi = require('@backstage/backend-plugin-api');
 var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
 var createProject = require('./actions/createProject.cjs.js');
+var fetchDSN = require('./actions/fetchDSN.cjs.js');
 
 const sentryModule = backendPluginApi.createBackendModule({
   pluginId: "scaffolder",
@@ -15,7 +16,10 @@ const sentryModule = backendPluginApi.createBackendModule({
         reade: backendPluginApi.coreServices.urlReader
       },
       async init({ scaffolder, config }) {
-        scaffolder.addActions(createProject.createSentryCreateProjectAction({ config }));
+        scaffolder.addActions(
+          createProject.createSentryCreateProjectAction({ config }),
+          fetchDSN.createSentryFetchDSNAction({ config })
+        );
       }
     });
   }

package/dist/module.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"module.cjs.js","sources":["../src/module.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n  coreServices,\n  createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { scaffolderActionsExtensionPoint } from '@backstage/plugin-scaffolder-node';\nimport { createSentryCreateProjectAction } from './actions/createProject';\n\n/**\n * @public\n * The Sentry Module for the Scaffolder Backend\n */\nexport const sentryModule = createBackendModule({\n  pluginId: 'scaffolder',\n  moduleId: 'sentry',\n  register({ registerInit }) {\n    registerInit({\n      deps: {\n        scaffolder: scaffolderActionsExtensionPoint,\n        config: coreServices.rootConfig,\n        reade: coreServices.urlReader,\n      },\n      async init({ scaffolder, config }) {\n        scaffolder.addActions(createSentryCreateProjectAction({ config }));\n      },\n    });\n  },\n});\n"],"names":["createBackendModule","scaffolderActionsExtensionPoint","coreServices","createSentryCreateProjectAction"],"mappings":";;;;;;AA0BO,MAAM,eAAeA,oCAAA,CAAoB;AAAA,EAC9C,QAAA,EAAU,YAAA;AAAA,EACV,QAAA,EAAU,QAAA;AAAA,EACV,QAAA,CAAS,EAAE,YAAA,EAAa,EAAG;AACzB,IAAA,YAAA,CAAa;AAAA,MACX,IAAA,EAAM;AAAA,QACJ,UAAA,EAAYC,oDAAA;AAAA,QACZ,QAAQC,6BAAA,CAAa,UAAA;AAAA,QACrB,OAAOA,6BAAA,CAAa;AAAA,OACtB;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,UAAA,EAAY,QAAO,EAAG;AACjC,QAAA,UAAA,CAAW,UAAA,CAAWC,6CAAA,CAAgC,EAAE,MAAA,EAAQ,CAAC,CAAA;AAAA,MACnE;AAAA,KACD,CAAA;AAAA,EACH;AACF,CAAC;;;;"}
+{"version":3,"file":"module.cjs.js","sources":["../src/module.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n  coreServices,\n  createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { scaffolderActionsExtensionPoint } from '@backstage/plugin-scaffolder-node';\nimport { createSentryCreateProjectAction } from './actions/createProject';\nimport { createSentryFetchDSNAction } from './actions/fetchDSN';\n\n/**\n * @public\n * The Sentry Module for the Scaffolder Backend\n */\nexport const sentryModule = createBackendModule({\n  pluginId: 'scaffolder',\n  moduleId: 'sentry',\n  register({ registerInit }) {\n    registerInit({\n      deps: {\n        scaffolder: scaffolderActionsExtensionPoint,\n        config: coreServices.rootConfig,\n        reade: coreServices.urlReader,\n      },\n      async init({ scaffolder, config }) {\n        scaffolder.addActions(\n          createSentryCreateProjectAction({ config }),\n          createSentryFetchDSNAction({ config }),\n        );\n      },\n    });\n  },\n});\n"],"names":["createBackendModule","scaffolderActionsExtensionPoint","coreServices","createSentryCreateProjectAction","createSentryFetchDSNAction"],"mappings":";;;;;;;AA2BO,MAAM,eAAeA,oCAAA,CAAoB;AAAA,EAC9C,QAAA,EAAU,YAAA;AAAA,EACV,QAAA,EAAU,QAAA;AAAA,EACV,QAAA,CAAS,EAAE,YAAA,EAAa,EAAG;AACzB,IAAA,YAAA,CAAa;AAAA,MACX,IAAA,EAAM;AAAA,QACJ,UAAA,EAAYC,oDAAA;AAAA,QACZ,QAAQC,6BAAA,CAAa,UAAA;AAAA,QACrB,OAAOA,6BAAA,CAAa;AAAA,OACtB;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,UAAA,EAAY,QAAO,EAAG;AACjC,QAAA,UAAA,CAAW,UAAA;AAAA,UACTC,6CAAA,CAAgC,EAAE,MAAA,EAAQ,CAAA;AAAA,UAC1CC,mCAAA,CAA2B,EAAE,MAAA,EAAQ;AAAA,SACvC;AAAA,MACF;AAAA,KACD,CAAA;AAAA,EACH;AACF,CAAC;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-backend-module-sentry",
-  "version": "0.2.14-next.1",
+  "version": "0.2.14",
   "backstage": {
     "role": "backend-plugin-module",
     "pluginId": "scaffolder",
@@ -50,17 +50,17 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "1.4.4-next.0",
-    "@backstage/config": "1.3.4-next.0",
-    "@backstage/errors": "1.2.7",
-    "@backstage/plugin-scaffolder-node": "0.12.0-next.1",
+    "@backstage/backend-plugin-api": "^1.4.4",
+    "@backstage/config": "^1.3.5",
+    "@backstage/errors": "^1.2.7",
+    "@backstage/plugin-scaffolder-node": "^0.12.0",
     "yaml": "^2.3.3"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.9.1-next.1",
-    "@backstage/cli": "0.34.4-next.1",
-    "@backstage/plugin-scaffolder-node-test-utils": "0.3.4-next.1",
-    "@backstage/types": "1.2.2",
+    "@backstage/backend-test-utils": "^1.9.1",
+    "@backstage/cli": "^0.34.4",
+    "@backstage/plugin-scaffolder-node-test-utils": "^0.3.4",
+    "@backstage/types": "^1.2.2",
     "msw": "^2.0.0"
   }
 }