@axis-backstage/plugin-statuspage-backend 0.2.0

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# @axis-backstage/plugin-statuspage-backend
+
+## 0.2.0
+
+### Minor Changes
+
+- b445aaa: Initial Release of the Statuspage Plugin
+
+### Patch Changes
+
+- Updated dependencies [b445aaa]
+  - @axis-backstage/plugin-statuspage-common@0.2.0

package/README.md

@@ -0,0 +1,56 @@
+# Statuspage backend
+
+Welcome to the Statuspage backend plugin!
+
+The plugin retrieves component status information the statuspage.io api.
+
+## Setup
+
+The following sections will help you get the Readme Backend plugin setup and running.
+
+### Installation
+
+Install the plugin by following the example below:
+
+```bash
+# From your Backstage root directory
+yarn --cwd packages/backend add @axis-backstage/plugin-statuspage-backend
+```
+
+### Integrating
+
+Here's how to get the backend plugin up and running:
+
+1. Create a new file named `packages/backend/src/plugins/statuspage.ts`, and add the following to it:
+
+   ```ts
+   import { PluginEnvironment } from '../types';
+   import { createRouter } from '@internal/plugin-statuspage-backend';
+   import { Router } from 'express';
+
+   export default async function createPlugin(
+     env: PluginEnvironment,
+   ): Promise<Router> {
+     return await createRouter({
+       logger: env.logger,
+       config: env.config,
+     });
+   }
+   ```
+
+2. Wire this into the overall backend router by adding the following to `packages/backend/src/index.ts`:
+
+   ```ts
+   import statuspage from './plugins/statuspage';
+   ...
+
+   async function main() {
+     // Add this line under the other lines that follow the useHotMemoize pattern
+    const statuspageEnv = useHotMemoize(module, () => createEnv('statuspage'));
+
+    ....
+
+     // Add this under the lines that add their routers to apiRouter
+    apiRouter.use('/statuspage', authMiddleware, await statuspage(statuspageEnv));
+   }
+   ```

package/config.d.ts

@@ -0,0 +1,30 @@
+export interface Config {
+  /**
+   * Configuration for the StatusPage plugin.
+   * @visibility backend
+   */
+  statuspage: {
+    /**
+     * The name of the instance
+     * @visibility backend
+     */
+    name: string;
+
+    /**
+     * The page id of the your statuspage
+     * @visibility backend
+     */
+    pageid: string;
+
+    /**
+     * Client access token
+     * @visibility secret
+     */
+    token: string;
+
+    /**
+     * Link to the statuspage
+     */
+    link?: string;
+  }[];
+}

package/dist/index.cjs.js

@@ -0,0 +1,123 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var backendCommon = require('@backstage/backend-common');
+var express = require('express');
+var Router = require('express-promise-router');
+var fetch = require('cross-fetch');
+var backendPluginApi = require('@backstage/backend-plugin-api');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var express__default = /*#__PURE__*/_interopDefaultLegacy(express);
+var Router__default = /*#__PURE__*/_interopDefaultLegacy(Router);
+var fetch__default = /*#__PURE__*/_interopDefaultLegacy(fetch);
+
+const BASE_URL = "https://api.statuspage.io/v1/pages/";
+const getInstance = (config, name) => {
+  const instance = config.find((i) => i.name === name);
+  if (!instance) {
+    throw new Error(
+      `Config for instance '${name}' not found in statuspage.instances`
+    );
+  }
+  return instance;
+};
+const fetchData = async (url, token) => {
+  const response = await fetch__default["default"](url, {
+    headers: {
+      Authorization: `OAuth ${token}`,
+      Accept: "application/json"
+    }
+  });
+  if (!response.ok) {
+    throw new Error(`Failed to fetch status page data from ${url}`);
+  }
+  return response.json();
+};
+const fetchComponents = async (name, config) => {
+  const instance = getInstance(config, name);
+  const url = `${BASE_URL}${instance.pageid}/components`;
+  return fetchData(url, instance.token);
+};
+const fetchComponentGroups = async (name, config) => {
+  const instance = getInstance(config, name);
+  const url = `${BASE_URL}${instance.pageid}/component-groups`;
+  return fetchData(url, instance.token);
+};
+const getLink = (name, config) => {
+  const instance = getInstance(config, name);
+  return instance.link;
+};
+
+function getStatuspageConfig(config) {
+  const statuspageConfig = config.getOptional("statuspage");
+  if (!statuspageConfig) {
+    return [];
+  }
+  return statuspageConfig;
+}
+
+const COMPONENT_GROUPS_KEY = "component-groups";
+const COMPONENTS_KEY = "components";
+async function createRouter(options) {
+  const { logger, config } = options;
+  logger.info("Setting up router for statuspage-backend");
+  const pluginCache = backendCommon.CacheManager.fromConfig(config).forPlugin("statuspage");
+  const statuspageConfig = getStatuspageConfig(config);
+  const cache = pluginCache.getClient({ defaultTtl: 1e3 * 60 * 2 });
+  const router = Router__default["default"]();
+  router.use(express__default["default"].json());
+  router.get("/fetch-components/:name", async (request, response) => {
+    const name = request.params.name;
+    let components = await cache.get(`${COMPONENTS_KEY}-${name}`);
+    if (!components) {
+      components = await fetchComponents(name, statuspageConfig);
+      await cache.set(`${COMPONENTS_KEY}-${name}`, components);
+    }
+    response.json(components);
+  });
+  router.get("/fetch-component-groups/:name", async (request, response) => {
+    const name = request.params.name;
+    let componentGroups = await cache.get(
+      `${COMPONENT_GROUPS_KEY}-${name}`
+    );
+    if (!componentGroups) {
+      componentGroups = await fetchComponentGroups(name, statuspageConfig);
+      await cache.set(`${COMPONENT_GROUPS_KEY}-${name}`, componentGroups);
+    }
+    response.json(componentGroups);
+  });
+  router.get("/fetch-link/:name", (request, response) => {
+    const name = request.params.name;
+    response.json({ url: getLink(name, statuspageConfig) || "" });
+  });
+  router.use(backendCommon.errorHandler());
+  return router;
+}
+
+const statuspagePlugin = backendPluginApi.createBackendPlugin({
+  pluginId: "statuspage",
+  register(env) {
+    env.registerInit({
+      deps: {
+        config: backendPluginApi.coreServices.rootConfig,
+        logger: backendPluginApi.coreServices.logger,
+        httpRouter: backendPluginApi.coreServices.httpRouter
+      },
+      async init({ config, logger, httpRouter }) {
+        httpRouter.use(
+          await createRouter({
+            config,
+            logger: backendCommon.loggerToWinstonLogger(logger)
+          })
+        );
+      }
+    });
+  }
+});
+
+exports.createRouter = createRouter;
+exports["default"] = statuspagePlugin;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/service/api.ts","../src/config.ts","../src/service/router.ts","../src/plugin.ts"],"sourcesContent":["import fetch from 'cross-fetch';\nimport type {\n  Component,\n  ComponentGroup,\n} from '@axis-backstage/plugin-statuspage-common';\nimport { StatuspageConfig } from '../types';\n\nconst BASE_URL = 'https://api.statuspage.io/v1/pages/';\n\nconst getInstance = (config: StatuspageConfig, name: string) => {\n  const instance = config.find(i => i.name === name);\n\n  if (!instance) {\n    throw new Error(\n      `Config for instance '${name}' not found in statuspage.instances`,\n    );\n  }\n\n  return instance;\n};\n\nconst fetchData = async <T>(url: string, token: string): Promise<T> => {\n  const response = await fetch(url, {\n    headers: {\n      Authorization: `OAuth ${token}`,\n      Accept: 'application/json',\n    },\n  });\n\n  if (!response.ok) {\n    throw new Error(`Failed to fetch status page data from ${url}`);\n  }\n\n  return response.json() as T;\n};\n\nexport const fetchComponents = async (\n  name: string,\n  config: StatuspageConfig,\n): Promise<Component[]> => {\n  const instance = getInstance(config, name);\n  const url = `${BASE_URL}${instance.pageid}/components`;\n  return fetchData<Component[]>(url, instance.token);\n};\n\nexport const fetchComponentGroups = async (\n  name: string,\n  config: StatuspageConfig,\n): Promise<ComponentGroup[]> => {\n  const instance = getInstance(config, name);\n  const url = `${BASE_URL}${instance.pageid}/component-groups`;\n  return fetchData(url, instance.token);\n};\n\nexport const getLink = (\n  name: string,\n  config: StatuspageConfig,\n): string | undefined => {\n  const instance = getInstance(config, name);\n  return instance.link;\n};\n","import { Config } from '@backstage/config';\nimport type { StatuspageConfig } from './types';\n\nexport function getStatuspageConfig(config: Config): StatuspageConfig {\n  const statuspageConfig = config.getOptional('statuspage');\n  if (!statuspageConfig) {\n    return [];\n  }\n  return statuspageConfig as unknown as StatuspageConfig;\n}\n","import { CacheManager, errorHandler } from '@backstage/backend-common';\nimport express from 'express';\nimport Router from 'express-promise-router';\nimport { Logger } from 'winston';\nimport { fetchComponentGroups, fetchComponents, getLink } from './api';\nimport { Config } from '@backstage/config';\nimport { getStatuspageConfig } from '../config';\n\n/**\n * Router options.\n *\n * @public\n */\nexport interface RouterOptions {\n  /** The logger instance */\n  logger: Logger;\n  /** Backstage config object */\n  config: Config;\n}\n\nconst COMPONENT_GROUPS_KEY = 'component-groups';\nconst COMPONENTS_KEY = 'components';\n\n/**\n * Create the router.\n *\n * @public\n */\nexport async function createRouter(\n  options: RouterOptions,\n): Promise<express.Router> {\n  const { logger, config } = options;\n  logger.info('Setting up router for statuspage-backend');\n  const pluginCache = CacheManager.fromConfig(config).forPlugin('statuspage');\n  const statuspageConfig = getStatuspageConfig(config);\n  const cache = pluginCache.getClient({ defaultTtl: 1000 * 60 * 2 });\n\n  const router = Router();\n  router.use(express.json());\n\n  router.get('/fetch-components/:name', async (request, response) => {\n    const name = request.params.name;\n    let components = (await cache.get(`${COMPONENTS_KEY}-${name}`)) as any;\n    if (!components) {\n      components = await fetchComponents(name, statuspageConfig);\n      await cache.set(`${COMPONENTS_KEY}-${name}`, components);\n    }\n    response.json(components);\n  });\n\n  router.get('/fetch-component-groups/:name', async (request, response) => {\n    const name = request.params.name;\n    let componentGroups = (await cache.get(\n      `${COMPONENT_GROUPS_KEY}-${name}`,\n    )) as any;\n    if (!componentGroups) {\n      componentGroups = await fetchComponentGroups(name, statuspageConfig);\n      await cache.set(`${COMPONENT_GROUPS_KEY}-${name}`, componentGroups);\n    }\n    response.json(componentGroups);\n  });\n\n  router.get('/fetch-link/:name', (request, response) => {\n    const name = request.params.name;\n    response.json({ url: getLink(name, statuspageConfig) || '' });\n  });\n\n  router.use(errorHandler());\n  return router;\n}\n","import { loggerToWinstonLogger } from '@backstage/backend-common';\nimport {\n  coreServices,\n  createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { createRouter } from './service/router';\n\n/**\n * Entrypoint for our plugin.\n *\n * @public\n */\nexport const statuspagePlugin = createBackendPlugin({\n  pluginId: 'statuspage',\n  register(env) {\n    env.registerInit({\n      deps: {\n        config: coreServices.rootConfig,\n        logger: coreServices.logger,\n        httpRouter: coreServices.httpRouter,\n      },\n      async init({ config, logger, httpRouter }) {\n        httpRouter.use(\n          await createRouter({\n            config,\n            logger: loggerToWinstonLogger(logger),\n          }),\n        );\n      },\n    });\n  },\n});\n"],"names":["fetch","CacheManager","Router","express","errorHandler","createBackendPlugin","coreServices","loggerToWinstonLogger"],"mappings":";;;;;;;;;;;;;;;;AAOA,MAAM,QAAW,GAAA,qCAAA,CAAA;AAEjB,MAAM,WAAA,GAAc,CAAC,MAAA,EAA0B,IAAiB,KAAA;AAC9D,EAAA,MAAM,WAAW,MAAO,CAAA,IAAA,CAAK,CAAK,CAAA,KAAA,CAAA,CAAE,SAAS,IAAI,CAAA,CAAA;AAEjD,EAAA,IAAI,CAAC,QAAU,EAAA;AACb,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,wBAAwB,IAAI,CAAA,mCAAA,CAAA;AAAA,KAC9B,CAAA;AAAA,GACF;AAEA,EAAO,OAAA,QAAA,CAAA;AACT,CAAA,CAAA;AAEA,MAAM,SAAA,GAAY,OAAU,GAAA,EAAa,KAA8B,KAAA;AACrE,EAAM,MAAA,QAAA,GAAW,MAAMA,yBAAA,CAAM,GAAK,EAAA;AAAA,IAChC,OAAS,EAAA;AAAA,MACP,aAAA,EAAe,SAAS,KAAK,CAAA,CAAA;AAAA,MAC7B,MAAQ,EAAA,kBAAA;AAAA,KACV;AAAA,GACD,CAAA,CAAA;AAED,EAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,IAAA,MAAM,IAAI,KAAA,CAAM,CAAyC,sCAAA,EAAA,GAAG,CAAE,CAAA,CAAA,CAAA;AAAA,GAChE;AAEA,EAAA,OAAO,SAAS,IAAK,EAAA,CAAA;AACvB,CAAA,CAAA;AAEa,MAAA,eAAA,GAAkB,OAC7B,IAAA,EACA,MACyB,KAAA;AACzB,EAAM,MAAA,QAAA,GAAW,WAAY,CAAA,MAAA,EAAQ,IAAI,CAAA,CAAA;AACzC,EAAA,MAAM,GAAM,GAAA,CAAA,EAAG,QAAQ,CAAA,EAAG,SAAS,MAAM,CAAA,WAAA,CAAA,CAAA;AACzC,EAAO,OAAA,SAAA,CAAuB,GAAK,EAAA,QAAA,CAAS,KAAK,CAAA,CAAA;AACnD,CAAA,CAAA;AAEa,MAAA,oBAAA,GAAuB,OAClC,IAAA,EACA,MAC8B,KAAA;AAC9B,EAAM,MAAA,QAAA,GAAW,WAAY,CAAA,MAAA,EAAQ,IAAI,CAAA,CAAA;AACzC,EAAA,MAAM,GAAM,GAAA,CAAA,EAAG,QAAQ,CAAA,EAAG,SAAS,MAAM,CAAA,iBAAA,CAAA,CAAA;AACzC,EAAO,OAAA,SAAA,CAAU,GAAK,EAAA,QAAA,CAAS,KAAK,CAAA,CAAA;AACtC,CAAA,CAAA;AAEa,MAAA,OAAA,GAAU,CACrB,IAAA,EACA,MACuB,KAAA;AACvB,EAAM,MAAA,QAAA,GAAW,WAAY,CAAA,MAAA,EAAQ,IAAI,CAAA,CAAA;AACzC,EAAA,OAAO,QAAS,CAAA,IAAA,CAAA;AAClB,CAAA;;ACzDO,SAAS,oBAAoB,MAAkC,EAAA;AACpE,EAAM,MAAA,gBAAA,GAAmB,MAAO,CAAA,WAAA,CAAY,YAAY,CAAA,CAAA;AACxD,EAAA,IAAI,CAAC,gBAAkB,EAAA;AACrB,IAAA,OAAO,EAAC,CAAA;AAAA,GACV;AACA,EAAO,OAAA,gBAAA,CAAA;AACT;;ACWA,MAAM,oBAAuB,GAAA,kBAAA,CAAA;AAC7B,MAAM,cAAiB,GAAA,YAAA,CAAA;AAOvB,eAAsB,aACpB,OACyB,EAAA;AACzB,EAAM,MAAA,EAAE,MAAQ,EAAA,MAAA,EAAW,GAAA,OAAA,CAAA;AAC3B,EAAA,MAAA,CAAO,KAAK,0CAA0C,CAAA,CAAA;AACtD,EAAA,MAAM,cAAcC,0BAAa,CAAA,UAAA,CAAW,MAAM,CAAA,CAAE,UAAU,YAAY,CAAA,CAAA;AAC1E,EAAM,MAAA,gBAAA,GAAmB,oBAAoB,MAAM,CAAA,CAAA;AACnD,EAAM,MAAA,KAAA,GAAQ,YAAY,SAAU,CAAA,EAAE,YAAY,GAAO,GAAA,EAAA,GAAK,GAAG,CAAA,CAAA;AAEjE,EAAA,MAAM,SAASC,0BAAO,EAAA,CAAA;AACtB,EAAO,MAAA,CAAA,GAAA,CAAIC,2BAAQ,CAAA,IAAA,EAAM,CAAA,CAAA;AAEzB,EAAA,MAAA,CAAO,GAAI,CAAA,yBAAA,EAA2B,OAAO,OAAA,EAAS,QAAa,KAAA;AACjE,IAAM,MAAA,IAAA,GAAO,QAAQ,MAAO,CAAA,IAAA,CAAA;AAC5B,IAAI,IAAA,UAAA,GAAc,MAAM,KAAM,CAAA,GAAA,CAAI,GAAG,cAAc,CAAA,CAAA,EAAI,IAAI,CAAE,CAAA,CAAA,CAAA;AAC7D,IAAA,IAAI,CAAC,UAAY,EAAA;AACf,MAAa,UAAA,GAAA,MAAM,eAAgB,CAAA,IAAA,EAAM,gBAAgB,CAAA,CAAA;AACzD,MAAA,MAAM,MAAM,GAAI,CAAA,CAAA,EAAG,cAAc,CAAI,CAAA,EAAA,IAAI,IAAI,UAAU,CAAA,CAAA;AAAA,KACzD;AACA,IAAA,QAAA,CAAS,KAAK,UAAU,CAAA,CAAA;AAAA,GACzB,CAAA,CAAA;AAED,EAAA,MAAA,CAAO,GAAI,CAAA,+BAAA,EAAiC,OAAO,OAAA,EAAS,QAAa,KAAA;AACvE,IAAM,MAAA,IAAA,GAAO,QAAQ,MAAO,CAAA,IAAA,CAAA;AAC5B,IAAI,IAAA,eAAA,GAAmB,MAAM,KAAM,CAAA,GAAA;AAAA,MACjC,CAAA,EAAG,oBAAoB,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA;AAAA,KACjC,CAAA;AACA,IAAA,IAAI,CAAC,eAAiB,EAAA;AACpB,MAAkB,eAAA,GAAA,MAAM,oBAAqB,CAAA,IAAA,EAAM,gBAAgB,CAAA,CAAA;AACnE,MAAA,MAAM,MAAM,GAAI,CAAA,CAAA,EAAG,oBAAoB,CAAI,CAAA,EAAA,IAAI,IAAI,eAAe,CAAA,CAAA;AAAA,KACpE;AACA,IAAA,QAAA,CAAS,KAAK,eAAe,CAAA,CAAA;AAAA,GAC9B,CAAA,CAAA;AAED,EAAA,MAAA,CAAO,GAAI,CAAA,mBAAA,EAAqB,CAAC,OAAA,EAAS,QAAa,KAAA;AACrD,IAAM,MAAA,IAAA,GAAO,QAAQ,MAAO,CAAA,IAAA,CAAA;AAC5B,IAAS,QAAA,CAAA,IAAA,CAAK,EAAE,GAAK,EAAA,OAAA,CAAQ,MAAM,gBAAgB,CAAA,IAAK,IAAI,CAAA,CAAA;AAAA,GAC7D,CAAA,CAAA;AAED,EAAO,MAAA,CAAA,GAAA,CAAIC,4BAAc,CAAA,CAAA;AACzB,EAAO,OAAA,MAAA,CAAA;AACT;;ACzDO,MAAM,mBAAmBC,oCAAoB,CAAA;AAAA,EAClD,QAAU,EAAA,YAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,YAAYA,6BAAa,CAAA,UAAA;AAAA,OAC3B;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,MAAQ,EAAA,MAAA,EAAQ,YAAc,EAAA;AACzC,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAM,YAAa,CAAA;AAAA,YACjB,MAAA;AAAA,YACA,MAAA,EAAQC,oCAAsB,MAAM,CAAA;AAAA,WACrC,CAAA;AAAA,SACH,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,31 @@
+import express from 'express';
+import { Logger } from 'winston';
+import { Config } from '@backstage/config';
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+
+/**
+ * Router options.
+ *
+ * @public
+ */
+interface RouterOptions {
+    /** The logger instance */
+    logger: Logger;
+    /** Backstage config object */
+    config: Config;
+}
+/**
+ * Create the router.
+ *
+ * @public
+ */
+declare function createRouter(options: RouterOptions): Promise<express.Router>;
+
+/**
+ * Entrypoint for our plugin.
+ *
+ * @public
+ */
+declare const statuspagePlugin: () => _backstage_backend_plugin_api.BackendFeature;
+
+export { RouterOptions, createRouter, statuspagePlugin as default };

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@axis-backstage/plugin-statuspage-backend",
+  "version": "0.2.0",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "backstage": {
+    "role": "backend-plugin"
+  },
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack"
+  },
+  "dependencies": {
+    "@axis-backstage/plugin-statuspage-common": "^0.2.0",
+    "@backstage/backend-common": "^0.20.1",
+    "@backstage/backend-plugin-api": "^0.6.9",
+    "@backstage/config": "^1.1.1",
+    "@types/express": "*",
+    "cross-fetch": "^4.0.0",
+    "express": "^4.17.1",
+    "express-promise-router": "^4.1.0",
+    "winston": "^3.2.1"
+  },
+  "devDependencies": {
+    "@backstage/cli": "^0.25.1"
+  },
+  "files": [
+    "dist",
+    "config.d.ts"
+  ],
+  "configSchema": "config.d.ts"
+}