@backstage/plugin-catalog-backend-module-azure 0.0.0-nightly-20220308022132

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# @backstage/plugin-catalog-backend-module-azure
+
+## 0.0.0-nightly-20220308022132
+
+### Minor Changes
+
+- 66ba5d9023: Added package, moving out azure specific functionality from the catalog-backend
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-catalog-backend@0.0.0-nightly-20220308022132
+  - @backstage/backend-common@0.0.0-nightly-20220308022132
+  - @backstage/catalog-model@0.0.0-nightly-20220308022132

package/README.md

@@ -0,0 +1,8 @@
+# Catalog Backend Module for Azure
+
+This is an extension module to the plugin-catalog-backend plugin, providing extensions targeted at Azure cloud offerings.
+
+## Getting started
+
+See [Backstage documentation](https://backstage.io/docs/integrations/azure/org) for details on how to install
+and configure the plugin.

package/dist/index.cjs.js

@@ -0,0 +1,105 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var integration = require('@backstage/integration');
+var pluginCatalogBackend = require('@backstage/plugin-catalog-backend');
+var fetch = require('node-fetch');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var fetch__default = /*#__PURE__*/_interopDefaultLegacy(fetch);
+
+const isCloud = (host) => host === "dev.azure.com";
+const PAGE_SIZE = 1e3;
+async function codeSearch(azureConfig, org, project, repo, path) {
+  const searchBaseUrl = isCloud(azureConfig.host) ? "https://almsearch.dev.azure.com" : `https://${azureConfig.host}`;
+  const searchUrl = `${searchBaseUrl}/${org}/${project}/_apis/search/codesearchresults?api-version=6.0-preview.1`;
+  let items = [];
+  let hasMorePages = true;
+  do {
+    const response = await fetch__default["default"](searchUrl, {
+      ...integration.getAzureRequestOptions(azureConfig, {
+        "Content-Type": "application/json"
+      }),
+      method: "POST",
+      body: JSON.stringify({
+        searchText: `path:${path} repo:${repo || "*"}`,
+        $skip: items.length,
+        $top: PAGE_SIZE
+      })
+    });
+    if (response.status !== 200) {
+      throw new Error(`Azure DevOps search failed with response status ${response.status}`);
+    }
+    const body = await response.json();
+    items = [...items, ...body.results];
+    hasMorePages = body.count > items.length;
+  } while (hasMorePages);
+  return items;
+}
+
+class AzureDevOpsDiscoveryProcessor {
+  static fromConfig(config, options) {
+    const integrations = integration.ScmIntegrations.fromConfig(config);
+    return new AzureDevOpsDiscoveryProcessor({
+      ...options,
+      integrations
+    });
+  }
+  constructor(options) {
+    this.integrations = options.integrations;
+    this.logger = options.logger;
+  }
+  getProcessorName() {
+    return "AzureDevOpsDiscoveryProcessor";
+  }
+  async readLocation(location, _optional, emit) {
+    var _a;
+    if (location.type !== "azure-discovery") {
+      return false;
+    }
+    const azureConfig = (_a = this.integrations.azure.byUrl(location.target)) == null ? void 0 : _a.config;
+    if (!azureConfig) {
+      throw new Error(`There is no Azure integration that matches ${location.target}. Please add a configuration entry for it under integrations.azure`);
+    }
+    const { baseUrl, org, project, repo, catalogPath } = parseUrl(location.target);
+    this.logger.info(`Reading Azure DevOps repositories from ${location.target}`);
+    const files = await codeSearch(azureConfig, org, project, repo, catalogPath);
+    this.logger.debug(`Found ${files.length} files in Azure DevOps from ${location.target}.`);
+    for (const file of files) {
+      emit(pluginCatalogBackend.processingResult.location({
+        type: "url",
+        target: `${baseUrl}/${org}/${project}/_git/${file.repository.name}?path=${file.path}`,
+        presence: "optional"
+      }));
+    }
+    return true;
+  }
+}
+function parseUrl(urlString) {
+  const url = new URL(urlString);
+  const path = url.pathname.substr(1).split("/");
+  const catalogPath = url.searchParams.get("path") || "/catalog-info.yaml";
+  if (path.length === 2 && path[0].length && path[1].length) {
+    return {
+      baseUrl: url.origin,
+      org: decodeURIComponent(path[0]),
+      project: decodeURIComponent(path[1]),
+      repo: "",
+      catalogPath
+    };
+  } else if (path.length === 4 && path[0].length && path[1].length && path[2].length && path[3].length) {
+    return {
+      baseUrl: url.origin,
+      org: decodeURIComponent(path[0]),
+      project: decodeURIComponent(path[1]),
+      repo: decodeURIComponent(path[3]),
+      catalogPath
+    };
+  }
+  throw new Error(`Failed to parse ${urlString}`);
+}
+
+exports.AzureDevOpsDiscoveryProcessor = AzureDevOpsDiscoveryProcessor;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/lib/azure.ts","../src/AzureDevOpsDiscoveryProcessor.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 fetch from 'node-fetch';\nimport {\n  AzureIntegrationConfig,\n  getAzureRequestOptions,\n} from '@backstage/integration';\n\nexport interface CodeSearchResponse {\n  count: number;\n  results: CodeSearchResultItem[];\n}\n\nexport interface CodeSearchResultItem {\n  fileName: string;\n  path: string;\n  repository: {\n    name: string;\n  };\n}\n\nconst isCloud = (host: string) => host === 'dev.azure.com';\nconst PAGE_SIZE = 1000;\n\n// codeSearch returns all files that matches the given search path.\nexport async function codeSearch(\n  azureConfig: AzureIntegrationConfig,\n  org: string,\n  project: string,\n  repo: string,\n  path: string,\n): Promise<CodeSearchResultItem[]> {\n  const searchBaseUrl = isCloud(azureConfig.host)\n    ? 'https://almsearch.dev.azure.com'\n    : `https://${azureConfig.host}`;\n  const searchUrl = `${searchBaseUrl}/${org}/${project}/_apis/search/codesearchresults?api-version=6.0-preview.1`;\n\n  let items: CodeSearchResultItem[] = [];\n  let hasMorePages = true;\n\n  do {\n    const response = await fetch(searchUrl, {\n      ...getAzureRequestOptions(azureConfig, {\n        'Content-Type': 'application/json',\n      }),\n      method: 'POST',\n      body: JSON.stringify({\n        searchText: `path:${path} repo:${repo || '*'}`,\n        $skip: items.length,\n        $top: PAGE_SIZE,\n      }),\n    });\n\n    if (response.status !== 200) {\n      throw new Error(\n        `Azure DevOps search failed with response status ${response.status}`,\n      );\n    }\n\n    const body: CodeSearchResponse = await response.json();\n    items = [...items, ...body.results];\n    hasMorePages = body.count > items.length;\n  } while (hasMorePages);\n\n  return items;\n}\n","/*\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 { Config } from '@backstage/config';\nimport {\n  ScmIntegrationRegistry,\n  ScmIntegrations,\n} from '@backstage/integration';\nimport {\n  CatalogProcessor,\n  CatalogProcessorEmit,\n  LocationSpec,\n  processingResult,\n} from '@backstage/plugin-catalog-backend';\nimport { Logger } from 'winston';\nimport { codeSearch } from './lib';\n\n/**\n * Extracts repositories out of an Azure DevOps org.\n *\n * The following will create locations for all projects which have a catalog-info.yaml\n * on the default branch. The first is shorthand for the second.\n *\n *    target: \"https://dev.azure.com/org/project\"\n *    or\n *    target: https://dev.azure.com/org/project?path=/catalog-info.yaml\n *\n * You may also explicitly specify a single repo:\n *\n *    target: https://dev.azure.com/org/project/_git/repo\n *\n * @public\n **/\nexport class AzureDevOpsDiscoveryProcessor implements CatalogProcessor {\n  private readonly integrations: ScmIntegrationRegistry;\n  private readonly logger: Logger;\n\n  static fromConfig(config: Config, options: { logger: Logger }) {\n    const integrations = ScmIntegrations.fromConfig(config);\n\n    return new AzureDevOpsDiscoveryProcessor({\n      ...options,\n      integrations,\n    });\n  }\n\n  constructor(options: {\n    integrations: ScmIntegrationRegistry;\n    logger: Logger;\n  }) {\n    this.integrations = options.integrations;\n    this.logger = options.logger;\n  }\n\n  getProcessorName(): string {\n    return 'AzureDevOpsDiscoveryProcessor';\n  }\n\n  async readLocation(\n    location: LocationSpec,\n    _optional: boolean,\n    emit: CatalogProcessorEmit,\n  ): Promise<boolean> {\n    if (location.type !== 'azure-discovery') {\n      return false;\n    }\n\n    const azureConfig = this.integrations.azure.byUrl(location.target)?.config;\n    if (!azureConfig) {\n      throw new Error(\n        `There is no Azure integration that matches ${location.target}. Please add a configuration entry for it under integrations.azure`,\n      );\n    }\n\n    const { baseUrl, org, project, repo, catalogPath } = parseUrl(\n      location.target,\n    );\n    this.logger.info(\n      `Reading Azure DevOps repositories from ${location.target}`,\n    );\n\n    const files = await codeSearch(\n      azureConfig,\n      org,\n      project,\n      repo,\n      catalogPath,\n    );\n\n    this.logger.debug(\n      `Found ${files.length} files in Azure DevOps from ${location.target}.`,\n    );\n\n    for (const file of files) {\n      emit(\n        processingResult.location({\n          type: 'url',\n          target: `${baseUrl}/${org}/${project}/_git/${file.repository.name}?path=${file.path}`,\n          // Not all locations may actually exist, since the user defined them as a wildcard pattern.\n          // Thus, we emit them as optional and let the downstream processor find them while not outputting\n          // an error if it couldn't.\n          presence: 'optional',\n        }),\n      );\n    }\n\n    return true;\n  }\n}\n\n/**\n * parseUrl extracts segments from the Azure DevOps URL.\n **/\nexport function parseUrl(urlString: string): {\n  baseUrl: string;\n  org: string;\n  project: string;\n  repo: string;\n  catalogPath: string;\n} {\n  const url = new URL(urlString);\n  const path = url.pathname.substr(1).split('/');\n\n  const catalogPath = url.searchParams.get('path') || '/catalog-info.yaml';\n\n  if (path.length === 2 && path[0].length && path[1].length) {\n    return {\n      baseUrl: url.origin,\n      org: decodeURIComponent(path[0]),\n      project: decodeURIComponent(path[1]),\n      repo: '',\n      catalogPath,\n    };\n  } else if (\n    path.length === 4 &&\n    path[0].length &&\n    path[1].length &&\n    path[2].length &&\n    path[3].length\n  ) {\n    return {\n      baseUrl: url.origin,\n      org: decodeURIComponent(path[0]),\n      project: decodeURIComponent(path[1]),\n      repo: decodeURIComponent(path[3]),\n      catalogPath,\n    };\n  }\n\n  throw new Error(`Failed to parse ${urlString}`);\n}\n"],"names":["fetch","getAzureRequestOptions","ScmIntegrations","processingResult"],"mappings":";;;;;;;;;;;;AAmCA,MAAM,UAAU,CAAC,SAAiB,SAAS;AAC3C,MAAM,YAAY;0BAIhB,aACA,KACA,SACA,MACA,MACiC;AACjC,QAAM,gBAAgB,QAAQ,YAAY,QACtC,oCACA,WAAW,YAAY;AAC3B,QAAM,YAAY,GAAG,iBAAiB,OAAO;AAE7C,MAAI,QAAgC;AACpC,MAAI,eAAe;AAEnB,KAAG;AACD,UAAM,WAAW,MAAMA,0BAAM,WAAW;AAAA,SACnCC,mCAAuB,aAAa;AAAA,QACrC,gBAAgB;AAAA;AAAA,MAElB,QAAQ;AAAA,MACR,MAAM,KAAK,UAAU;AAAA,QACnB,YAAY,QAAQ,aAAa,QAAQ;AAAA,QACzC,OAAO,MAAM;AAAA,QACb,MAAM;AAAA;AAAA;AAIV,QAAI,SAAS,WAAW,KAAK;AAC3B,YAAM,IAAI,MACR,mDAAmD,SAAS;AAAA;AAIhE,UAAM,OAA2B,MAAM,SAAS;AAChD,YAAQ,CAAC,GAAG,OAAO,GAAG,KAAK;AAC3B,mBAAe,KAAK,QAAQ,MAAM;AAAA,WAC3B;AAET,SAAO;AAAA;;oCChC8D;AAAA,SAI9D,WAAW,QAAgB,SAA6B;AAC7D,UAAM,eAAeC,4BAAgB,WAAW;AAEhD,WAAO,IAAI,8BAA8B;AAAA,SACpC;AAAA,MACH;AAAA;AAAA;AAAA,EAIJ,YAAY,SAGT;AACD,SAAK,eAAe,QAAQ;AAC5B,SAAK,SAAS,QAAQ;AAAA;AAAA,EAGxB,mBAA2B;AACzB,WAAO;AAAA;AAAA,QAGH,aACJ,UACA,WACA,MACkB;AA3EtB;AA4EI,QAAI,SAAS,SAAS,mBAAmB;AACvC,aAAO;AAAA;AAGT,UAAM,cAAc,WAAK,aAAa,MAAM,MAAM,SAAS,YAAvC,mBAAgD;AACpE,QAAI,CAAC,aAAa;AAChB,YAAM,IAAI,MACR,8CAA8C,SAAS;AAAA;AAI3D,UAAM,EAAE,SAAS,KAAK,SAAS,MAAM,gBAAgB,SACnD,SAAS;AAEX,SAAK,OAAO,KACV,0CAA0C,SAAS;AAGrD,UAAM,QAAQ,MAAM,WAClB,aACA,KACA,SACA,MACA;AAGF,SAAK,OAAO,MACV,SAAS,MAAM,qCAAqC,SAAS;AAG/D,eAAW,QAAQ,OAAO;AACxB,WACEC,sCAAiB,SAAS;AAAA,QACxB,MAAM;AAAA,QACN,QAAQ,GAAG,WAAW,OAAO,gBAAgB,KAAK,WAAW,aAAa,KAAK;AAAA,QAI/E,UAAU;AAAA;AAAA;AAKhB,WAAO;AAAA;AAAA;kBAOc,WAMvB;AACA,QAAM,MAAM,IAAI,IAAI;AACpB,QAAM,OAAO,IAAI,SAAS,OAAO,GAAG,MAAM;AAE1C,QAAM,cAAc,IAAI,aAAa,IAAI,WAAW;AAEpD,MAAI,KAAK,WAAW,KAAK,KAAK,GAAG,UAAU,KAAK,GAAG,QAAQ;AACzD,WAAO;AAAA,MACL,SAAS,IAAI;AAAA,MACb,KAAK,mBAAmB,KAAK;AAAA,MAC7B,SAAS,mBAAmB,KAAK;AAAA,MACjC,MAAM;AAAA,MACN;AAAA;AAAA,aAGF,KAAK,WAAW,KAChB,KAAK,GAAG,UACR,KAAK,GAAG,UACR,KAAK,GAAG,UACR,KAAK,GAAG,QACR;AACA,WAAO;AAAA,MACL,SAAS,IAAI;AAAA,MACb,KAAK,mBAAmB,KAAK;AAAA,MAC7B,SAAS,mBAAmB,KAAK;AAAA,MACjC,MAAM,mBAAmB,KAAK;AAAA,MAC9B;AAAA;AAAA;AAIJ,QAAM,IAAI,MAAM,mBAAmB;AAAA;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,36 @@
+import { Config } from '@backstage/config';
+import { ScmIntegrationRegistry } from '@backstage/integration';
+import { CatalogProcessor, LocationSpec, CatalogProcessorEmit } from '@backstage/plugin-catalog-backend';
+import { Logger } from 'winston';
+
+/**
+ * Extracts repositories out of an Azure DevOps org.
+ *
+ * The following will create locations for all projects which have a catalog-info.yaml
+ * on the default branch. The first is shorthand for the second.
+ *
+ *    target: "https://dev.azure.com/org/project"
+ *    or
+ *    target: https://dev.azure.com/org/project?path=/catalog-info.yaml
+ *
+ * You may also explicitly specify a single repo:
+ *
+ *    target: https://dev.azure.com/org/project/_git/repo
+ *
+ * @public
+ **/
+declare class AzureDevOpsDiscoveryProcessor implements CatalogProcessor {
+    private readonly integrations;
+    private readonly logger;
+    static fromConfig(config: Config, options: {
+        logger: Logger;
+    }): AzureDevOpsDiscoveryProcessor;
+    constructor(options: {
+        integrations: ScmIntegrationRegistry;
+        logger: Logger;
+    });
+    getProcessorName(): string;
+    readLocation(location: LocationSpec, _optional: boolean, emit: CatalogProcessorEmit): Promise<boolean>;
+}
+
+export { AzureDevOpsDiscoveryProcessor };

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@backstage/plugin-catalog-backend-module-azure",
+  "description": "A Backstage catalog backend module that helps integrate towards Azure",
+  "version": "0.0.0-nightly-20220308022132",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "license": "Apache-2.0",
+  "private": false,
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "backstage": {
+    "role": "backend-plugin-module"
+  },
+  "homepage": "https://backstage.io",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/backstage/backstage",
+    "directory": "plugins/catalog-backend-module-azure"
+  },
+  "keywords": [
+    "backstage"
+  ],
+  "scripts": {
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack",
+    "clean": "backstage-cli package clean",
+    "start": "backstage-cli package start"
+  },
+  "dependencies": {
+    "@backstage/backend-common": "^0.0.0-nightly-20220308022132",
+    "@backstage/catalog-model": "^0.0.0-nightly-20220308022132",
+    "@backstage/config": "^0.1.15",
+    "@backstage/errors": "^0.2.2",
+    "@backstage/integration": "^0.8.0",
+    "@backstage/plugin-catalog-backend": "^0.0.0-nightly-20220308022132",
+    "@backstage/types": "^0.1.3",
+    "lodash": "^4.17.21",
+    "msw": "^0.35.0",
+    "node-fetch": "^2.6.7",
+    "winston": "^3.2.1"
+  },
+  "devDependencies": {
+    "@backstage/backend-test-utils": "^0.0.0-nightly-20220308022132",
+    "@backstage/cli": "^0.0.0-nightly-20220308022132",
+    "@types/lodash": "^4.14.151"
+  },
+  "files": [
+    "dist"
+  ]
+}