@backstage/backend-app-api 0.5.5 → 0.5.6

package/CHANGELOG.md

@@ -1,28 +1,76 @@
 # @backstage/backend-app-api
 
-## 0.5.5
+## 0.5.6
 
 ### Patch Changes
 
+- 74491c9602: Moved `HostDiscovery` from `@backstage/backend-common`.
+- a4617c422a: Added `watch` option to configuration loaders that can be used to disable file watching by setting it to `false`.
 - Updated dependencies
-  - @backstage/plugin-auth-node@0.3.2
-  - @backstage/backend-plugin-api@0.6.5
-  - @backstage/plugin-permission-node@0.7.16
-  - @backstage/backend-common@0.19.7
-  - @backstage/backend-tasks@0.5.10
-  - @backstage/config-loader@1.5.0
+  - @backstage/backend-tasks@0.5.11
+  - @backstage/backend-common@0.19.8
+  - @backstage/plugin-auth-node@0.4.0
+  - @backstage/config-loader@1.5.1
+  - @backstage/errors@1.2.3
+  - @backstage/cli-common@0.1.13
+  - @backstage/backend-plugin-api@0.6.6
+  - @backstage/plugin-permission-node@0.7.17
+  - @backstage/cli-node@0.1.5
+  - @backstage/config@1.1.1
+  - @backstage/types@1.1.1
 
-## 0.5.4
+## 0.5.6-next.2
 
 ### Patch Changes
 
+- 74491c9602: Moved `HostDiscovery` from `@backstage/backend-common`.
+- a4617c422a: Added `watch` option to configuration loaders that can be used to disable file watching by setting it to `false`.
 - Updated dependencies
-  - @backstage/plugin-auth-node@0.3.1
-  - @backstage/backend-plugin-api@0.6.4
-  - @backstage/plugin-permission-node@0.7.15
-  - @backstage/backend-common@0.19.6
-  - @backstage/backend-tasks@0.5.9
-  - @backstage/config-loader@1.5.0
+  - @backstage/backend-common@0.19.8-next.2
+  - @backstage/plugin-auth-node@0.4.0-next.2
+  - @backstage/config-loader@1.5.1-next.1
+  - @backstage/errors@1.2.3-next.0
+  - @backstage/backend-tasks@0.5.11-next.2
+  - @backstage/plugin-permission-node@0.7.17-next.2
+  - @backstage/backend-plugin-api@0.6.6-next.2
+  - @backstage/cli-common@0.1.13-next.0
+  - @backstage/cli-node@0.1.5-next.1
+  - @backstage/config@1.1.1-next.0
+  - @backstage/types@1.1.1
+
+## 0.5.5-next.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-tasks@0.5.10-next.1
+  - @backstage/backend-common@0.19.7-next.1
+  - @backstage/backend-plugin-api@0.6.5-next.1
+  - @backstage/plugin-auth-node@0.3.2-next.1
+  - @backstage/plugin-permission-node@0.7.16-next.1
+  - @backstage/config@1.1.0
+  - @backstage/cli-common@0.1.13-next.0
+  - @backstage/cli-node@0.1.5-next.0
+  - @backstage/config-loader@1.5.1-next.0
+  - @backstage/errors@1.2.2
+  - @backstage/types@1.1.1
+
+## 0.5.5-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-auth-node@0.3.2-next.0
+  - @backstage/config-loader@1.5.1-next.0
+  - @backstage/cli-common@0.1.13-next.0
+  - @backstage/backend-common@0.19.7-next.0
+  - @backstage/config@1.1.0
+  - @backstage/backend-plugin-api@0.6.5-next.0
+  - @backstage/backend-tasks@0.5.10-next.0
+  - @backstage/cli-node@0.1.5-next.0
+  - @backstage/errors@1.2.2
+  - @backstage/types@1.1.1
+  - @backstage/plugin-permission-node@0.7.16-next.0
 
 ## 0.5.3
 

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/backend-app-api",
-  "version": "0.5.5",
+  "version": "0.5.6",
   "main": "../dist/alpha.cjs.js",
   "types": "../dist/alpha.d.ts"
 }

package/config.d.ts

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2020 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export interface Config {
+  /** Discovery options. */
+  discovery?: {
+    /**
+     * Endpoints
+     *
+     * A list of target baseUrls and the associated plugins.
+     */
+    endpoints: {
+      /**
+       * The target baseUrl to use for the plugin
+       *
+       * Can be either a string or an object with internal and external keys.
+       * Targets with `{{pluginId}}` or `{{ pluginId }} in the url will be replaced with the pluginId.
+       */
+      target: string | { internal: string; external: string };
+      /** Array of plugins which use the target baseUrl. */
+      plugins: string[];
+    }[];
+  };
+}

package/dist/index.cjs.js

@@ -23,6 +23,7 @@ var winston = require('winston');
 var backendPluginApi = require('@backstage/backend-plugin-api');
 var alpha = require('@backstage/backend-plugin-api/alpha');
 var backendCommon = require('@backstage/backend-common');
+var backendAppApi = require('@backstage/backend-app-api');
 var PromiseRouter = require('express-promise-router');
 var types = require('@backstage/types');
 var pluginAuthNode = require('@backstage/plugin-auth-node');
@@ -216,7 +217,7 @@ async function createConfigSecretEnumerator(options) {
   };
 }
 async function loadBackendConfig(options) {
-  var _a;
+  var _a, _b;
   const args = parseArgs__default["default"](options.argv);
   const configTargets = [(_a = args.config) != null ? _a : []].flat().map((arg) => isValidUrl(arg) ? { url: arg } : { path: path.resolve(arg) });
   const paths = cliCommon.findPaths(__dirname);
@@ -226,7 +227,7 @@ async function loadBackendConfig(options) {
     configRoot: paths.targetRoot,
     configTargets,
     remote: options.remote,
-    watch: {
+    watch: ((_b = options.watch) != null ? _b : true) ? {
       onChange(newConfigs) {
         console.info(
           `Reloaded config from ${newConfigs.map((c) => c.context).join(", ")}`
@@ -246,7 +247,7 @@ async function loadBackendConfig(options) {
           module.hot.addDisposeHandler(resolve);
         }
       })
-    }
+    } : void 0
   });
   console.info(
     `Loaded config from ${appConfigs.map((c) => c.context).join(", ")}`
@@ -1941,13 +1942,94 @@ const databaseServiceFactory = backendPluginApi.createServiceFactory({
   }
 });
 
+class HostDiscovery {
+  constructor(internalBaseUrl, externalBaseUrl, discoveryConfig) {
+    this.internalBaseUrl = internalBaseUrl;
+    this.externalBaseUrl = externalBaseUrl;
+    this.discoveryConfig = discoveryConfig;
+  }
+  /**
+   * Creates a new HostDiscovery discovery instance by reading
+   * from the `backend` config section, specifically the `.baseUrl` for
+   * discovering the external URL, and the `.listen` and `.https` config
+   * for the internal one.
+   *
+   * Can be overridden in config by providing a target and corresponding plugins in `discovery.endpoints`.
+   * eg.
+   * ```yaml
+   * discovery:
+   *  endpoints:
+   *    - target: https://internal.example.com/internal-catalog
+   *      plugins: [catalog]
+   *    - target: https://internal.example.com/secure/api/{{pluginId}}
+   *      plugins: [auth, permission]
+   *    - target:
+   *        internal: https://internal.example.com/search
+   *        external: https://example.com/search
+   *      plugins: [search]
+   * ```
+   *
+   * The basePath defaults to `/api`, meaning the default full internal
+   * path for the `catalog` plugin will be `http://localhost:7007/api/catalog`.
+   */
+  static fromConfig(config, options) {
+    var _a;
+    const basePath = (_a = options == null ? void 0 : options.basePath) != null ? _a : "/api";
+    const externalBaseUrl = config.getString("backend.baseUrl").replace(/\/+$/, "");
+    const {
+      listen: { host: listenHost = "::", port: listenPort }
+    } = backendAppApi.readHttpServerOptions(config.getConfig("backend"));
+    const protocol = config.has("backend.https") ? "https" : "http";
+    let host = listenHost;
+    if (host === "::" || host === "") {
+      host = "localhost";
+    } else if (host === "0.0.0.0") {
+      host = "127.0.0.1";
+    }
+    if (host.includes(":")) {
+      host = `[${host}]`;
+    }
+    const internalBaseUrl = `${protocol}://${host}:${listenPort}`;
+    return new HostDiscovery(
+      internalBaseUrl + basePath,
+      externalBaseUrl + basePath,
+      config.getOptionalConfig("discovery")
+    );
+  }
+  getTargetFromConfig(pluginId, type) {
+    var _a, _b;
+    const endpoints = (_a = this.discoveryConfig) == null ? void 0 : _a.getOptionalConfigArray("endpoints");
+    const target = (_b = endpoints == null ? void 0 : endpoints.find((endpoint) => endpoint.getStringArray("plugins").includes(pluginId))) == null ? void 0 : _b.get("target");
+    if (!target) {
+      const baseUrl = type === "external" ? this.externalBaseUrl : this.internalBaseUrl;
+      return `${baseUrl}/${encodeURIComponent(pluginId)}`;
+    }
+    if (typeof target === "string") {
+      return target.replace(
+        /\{\{\s*pluginId\s*\}\}/g,
+        encodeURIComponent(pluginId)
+      );
+    }
+    return target[type].replace(
+      /\{\{\s*pluginId\s*\}\}/g,
+      encodeURIComponent(pluginId)
+    );
+  }
+  async getBaseUrl(pluginId) {
+    return this.getTargetFromConfig(pluginId, "internal");
+  }
+  async getExternalBaseUrl(pluginId) {
+    return this.getTargetFromConfig(pluginId, "external");
+  }
+}
+
 const discoveryServiceFactory = backendPluginApi.createServiceFactory({
   service: backendPluginApi.coreServices.discovery,
   deps: {
     config: backendPluginApi.coreServices.rootConfig
   },
   async factory({ config }) {
-    return backendCommon.HostDiscovery.fromConfig(config);
+    return HostDiscovery.fromConfig(config);
   }
 });
 
@@ -2264,6 +2346,7 @@ const urlReaderServiceFactory = backendPluginApi.createServiceFactory({
 });
 
 exports.DefaultRootHttpRouter = DefaultRootHttpRouter;
+exports.HostDiscovery = HostDiscovery;
 exports.MiddlewareFactory = MiddlewareFactory;
 exports.WinstonLogger = WinstonLogger;
 exports.cacheServiceFactory = cacheServiceFactory;