@backstage/backend-defaults 0.5.0-next.0 → 0.5.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,47 @@
 # @backstage/backend-defaults
 
+## 0.5.0-next.1
+
+### Minor Changes
+
+- a4bac3c: **BREAKING**: You can no longer supply a `basePath` option to the host discovery implementation. In the new backend system, the ability to choose this path has been removed anyway at the plugin router level.
+- 055b75b: **BREAKING**: Simplifications and cleanup as part of the Backend System 1.0 work.
+
+  For the `/database` subpath exports:
+
+  - The deprecated `dropDatabase` function has now been removed, without replacement.
+  - The deprecated `LegacyRootDatabaseService` type has now been removed.
+  - The return type from `DatabaseManager.forPlugin` is now directly a `DatabaseService`, as arguably expected.
+  - `DatabaseManager.forPlugin` now requires the `deps` argument, with the logger and lifecycle services.
+
+  For the `/cache` subpath exports:
+
+  - The `PluginCacheManager` type has been removed. You can still import it from `@backstage/backend-common`, but it's deprecated there, and you should move off of that package by migrating fully to the new backend system.
+  - Accordingly, `CacheManager.forPlugin` immediately returns a `CacheService` instead of a `PluginCacheManager`. The outcome of this is that you no longer need to make the extra `.getClient()` call. The old `CacheManager` with the old behavior still exists on `@backstage/backend-common`, but the above recommendations apply.
+
+### Patch Changes
+
+- 622360e: Move down the discovery config to be in the root
+- fe6fd8c: Accept `ConfigService` instead of `Config` in constructors/factories
+- 5705424: Wrap scheduled tasks from the scheduler core service now in OpenTelemetry spans
+- b2a329d: Properly indent the config schema
+- Updated dependencies
+  - @backstage/backend-common@0.25.0-next.1
+  - @backstage/plugin-auth-node@0.5.2-next.1
+  - @backstage/backend-app-api@0.10.0-next.1
+  - @backstage/backend-dev-utils@0.1.5
+  - @backstage/backend-plugin-api@0.9.0-next.1
+  - @backstage/cli-common@0.1.14
+  - @backstage/cli-node@0.2.7
+  - @backstage/config@1.2.0
+  - @backstage/config-loader@1.9.0
+  - @backstage/errors@1.2.4
+  - @backstage/integration@1.14.0
+  - @backstage/integration-aws-node@0.1.12
+  - @backstage/types@1.1.1
+  - @backstage/plugin-events-node@0.4.0-next.1
+  - @backstage/plugin-permission-node@0.8.3-next.1
+
 ## 0.5.0-next.0
 
 ### Minor Changes

package/auth/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/backend-defaults__auth",
-  "version": "0.5.0-next.0",
+  "version": "0.5.0-next.1",
   "main": "../dist/auth.cjs.js",
   "types": "../dist/auth.d.ts"
 }

package/cache/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/backend-defaults__cache",
-  "version": "0.5.0-next.0",
+  "version": "0.5.0-next.1",
   "main": "../dist/cache.cjs.js",
   "types": "../dist/cache.d.ts"
 }

package/config.d.ts

@@ -373,205 +373,205 @@ export interface Config {
           }
       >;
     };
-  };
 
-  /**
-   * Options used by the default discovery service.
-   */
-  discovery?: {
-    /**
-     * A list of target baseUrls and the associated plugins.
-     */
-    endpoints: Array<{
+    /** Database connection configuration, select base database type using the `client` field */
+    database: {
+      /** Default database client to use */
+      client: 'better-sqlite3' | 'sqlite3' | 'pg';
       /**
-       * The target base URL to use for the plugin.
+       * Base database connection string, or object with individual connection properties
+       * @visibility secret
+       */
+      connection:
+        | string
+        | {
+            /**
+             * Password that belongs to the client User
+             * @visibility secret
+             */
+            password?: string;
+            /**
+             * Other connection settings
+             */
+            [key: string]: unknown;
+          };
+      /** Database name prefix override */
+      prefix?: string;
+      /**
+       * Whether to ensure the given database exists by creating it if it does not.
+       * Defaults to true if unspecified.
+       */
+      ensureExists?: boolean;
+      /**
+       * Whether to ensure the given database schema exists by creating it if it does not.
+       * Defaults to false if unspecified.
        *
-       * 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 plugin ID.
+       * NOTE: Currently only supported by the `pg` client when pluginDivisionMode: schema
        */
-      target: string | { internal: string; external: string };
+      ensureSchemaExists?: boolean;
       /**
-       * Array of plugins which use the target base URL.
+       * How plugins databases are managed/divided in the provided database instance.
+       *
+       * `database` -> Plugins are each given their own database to manage their schemas/tables.
+       *
+       * `schema` -> Plugins will be given their own schema (in the specified/default database)
+       *             to manage their tables.
+       *
+       * NOTE: Currently only supported by the `pg` client.
+       *
+       * @default database
        */
-      plugins: string[];
-    }>;
-  };
+      pluginDivisionMode?: 'database' | 'schema';
+      /** Configures the ownership of newly created schemas in pg databases. */
+      role?: string;
+      /**
+       * Arbitrary config object to pass to knex when initializing
+       * (https://knexjs.org/#Installation-client). Most notable is the debug
+       * and asyncStackTraces booleans
+       */
+      knexConfig?: object;
+      /** Skip running database migrations. */
+      skipMigrations?: boolean;
+      /** Plugin specific database configuration and client override */
+      plugin?: {
+        [pluginId: string]: {
+          /** Database client override */
+          client?: 'better-sqlite3' | 'sqlite3' | 'pg';
+          /**
+           * Database connection string or Knex object override
+           * @visibility secret
+           */
+          connection?: string | object;
+          /**
+           * Whether to ensure the given database exists by creating it if it does not.
+           * Defaults to base config if unspecified.
+           */
+          ensureExists?: boolean;
+          /**
+           * Whether to ensure the given database schema exists by creating it if it does not.
+           * Defaults to false if unspecified.
+           *
+           * NOTE: Currently only supported by the `pg` client when pluginDivisionMode: schema
+           */
+          ensureSchemaExists?: boolean;
+          /**
+           * Arbitrary config object to pass to knex when initializing
+           * (https://knexjs.org/#Installation-client). Most notable is the
+           * debug and asyncStackTraces booleans.
+           *
+           * This is merged recursively into the base knexConfig
+           */
+          knexConfig?: object;
+          /** Configures the ownership of newly created schemas in pg databases. */
+          role?: string;
+          /** Skip running database migrations. */
+          skipMigrations?: boolean;
+        };
+      };
+    };
 
-  /** Database connection configuration, select base database type using the `client` field */
-  database: {
-    /** Default database client to use */
-    client: 'better-sqlite3' | 'sqlite3' | 'pg';
-    /**
-     * Base database connection string, or object with individual connection properties
-     * @visibility secret
-     */
-    connection:
-      | string
+    /** Cache connection configuration, select cache type using the `store` field */
+    cache?:
+      | {
+          store: 'memory';
+          /** An optional default TTL (in milliseconds). */
+          defaultTtl?: number | HumanDuration;
+        }
       | {
+          store: 'redis';
           /**
-           * Password that belongs to the client User
+           * A redis connection string in the form `redis://user:pass@host:port`.
            * @visibility secret
            */
-          password?: string;
+          connection: string;
+          /** An optional default TTL (in milliseconds). */
+          defaultTtl?: number | HumanDuration;
           /**
-           * Other connection settings
+           * Whether or not [useRedisSets](https://github.com/jaredwray/keyv/tree/main/packages/redis#useredissets) should be configured to this redis cache.
+           * Defaults to true if unspecified.
            */
-          [key: string]: unknown;
+          useRedisSets?: boolean;
+        }
+      | {
+          store: 'memcache';
+          /**
+           * A memcache connection string in the form `user:pass@host:port`.
+           * @visibility secret
+           */
+          connection: string;
+          /** An optional default TTL (in milliseconds). */
+          defaultTtl?: number | HumanDuration;
         };
-    /** Database name prefix override */
-    prefix?: string;
-    /**
-     * Whether to ensure the given database exists by creating it if it does not.
-     * Defaults to true if unspecified.
-     */
-    ensureExists?: boolean;
+
+    cors?: {
+      origin?: string | string[];
+      methods?: string | string[];
+      allowedHeaders?: string | string[];
+      exposedHeaders?: string | string[];
+      credentials?: boolean;
+      maxAge?: number;
+      preflightContinue?: boolean;
+      optionsSuccessStatus?: number;
+    };
+
     /**
-     * Whether to ensure the given database schema exists by creating it if it does not.
-     * Defaults to false if unspecified.
+     * Content Security Policy options.
      *
-     * NOTE: Currently only supported by the `pg` client when pluginDivisionMode: schema
+     * The keys are the plain policy ID, e.g. "upgrade-insecure-requests". The
+     * values are on the format that the helmet library expects them, as an
+     * array of strings. There is also the special value false, which means to
+     * remove the default value that Backstage puts in place for that policy.
      */
-    ensureSchemaExists?: boolean;
-    /**
-     * How plugins databases are managed/divided in the provided database instance.
-     *
-     * `database` -> Plugins are each given their own database to manage their schemas/tables.
-     *
-     * `schema` -> Plugins will be given their own schema (in the specified/default database)
-     *             to manage their tables.
-     *
-     * NOTE: Currently only supported by the `pg` client.
-     *
-     * @default database
-     */
-    pluginDivisionMode?: 'database' | 'schema';
-    /** Configures the ownership of newly created schemas in pg databases. */
-    role?: string;
+    csp?: { [policyId: string]: string[] | false };
+
     /**
-     * Arbitrary config object to pass to knex when initializing
-     * (https://knexjs.org/#Installation-client). Most notable is the debug
-     * and asyncStackTraces booleans
+     * Configuration related to URL reading, used for example for reading catalog info
+     * files, scaffolder templates, and techdocs content.
      */
-    knexConfig?: object;
-    /** Skip running database migrations. */
-    skipMigrations?: boolean;
-    /** Plugin specific database configuration and client override */
-    plugin?: {
-      [pluginId: string]: {
-        /** Database client override */
-        client?: 'better-sqlite3' | 'sqlite3' | 'pg';
-        /**
-         * Database connection string or Knex object override
-         * @visibility secret
-         */
-        connection?: string | object;
-        /**
-         * Whether to ensure the given database exists by creating it if it does not.
-         * Defaults to base config if unspecified.
-         */
-        ensureExists?: boolean;
-        /**
-         * Whether to ensure the given database schema exists by creating it if it does not.
-         * Defaults to false if unspecified.
-         *
-         * NOTE: Currently only supported by the `pg` client when pluginDivisionMode: schema
-         */
-        ensureSchemaExists?: boolean;
+    reading?: {
+      /**
+       * A list of targets to allow outgoing requests to. Users will be able to make
+       * requests on behalf of the backend to the targets that are allowed by this list.
+       */
+      allow?: Array<{
         /**
-         * Arbitrary config object to pass to knex when initializing
-         * (https://knexjs.org/#Installation-client). Most notable is the
-         * debug and asyncStackTraces booleans.
-         *
-         * This is merged recursively into the base knexConfig
+         * A host to allow outgoing requests to, being either a full host or
+         * a subdomain wildcard pattern with a leading `*`. For example `example.com`
+         * and `*.example.com` are valid values, `prod.*.example.com` is not.
+         * The host may also contain a port, for example `example.com:8080`.
          */
-        knexConfig?: object;
-        /** Configures the ownership of newly created schemas in pg databases. */
-        role?: string;
-        /** Skip running database migrations. */
-        skipMigrations?: boolean;
-      };
-    };
-  };
+        host: string;
 
-  /** Cache connection configuration, select cache type using the `store` field */
-  cache?:
-    | {
-        store: 'memory';
-        /** An optional default TTL (in milliseconds). */
-        defaultTtl?: number | HumanDuration;
-      }
-    | {
-        store: 'redis';
-        /**
-         * A redis connection string in the form `redis://user:pass@host:port`.
-         * @visibility secret
-         */
-        connection: string;
-        /** An optional default TTL (in milliseconds). */
-        defaultTtl?: number | HumanDuration;
-        /**
-         * Whether or not [useRedisSets](https://github.com/jaredwray/keyv/tree/main/packages/redis#useredissets) should be configured to this redis cache.
-         * Defaults to true if unspecified.
-         */
-        useRedisSets?: boolean;
-      }
-    | {
-        store: 'memcache';
         /**
-         * A memcache connection string in the form `user:pass@host:port`.
-         * @visibility secret
+         * An optional list of paths. In case they are present only targets matching
+         * any of them will are allowed. You can use trailing slashes to make sure only
+         * subdirectories are allowed, for example `/mydir/` will allow targets with
+         * paths like `/mydir/a` but will block paths like `/mydir2`.
          */
-        connection: string;
-        /** An optional default TTL (in milliseconds). */
-        defaultTtl?: number | HumanDuration;
-      };
-
-  cors?: {
-    origin?: string | string[];
-    methods?: string | string[];
-    allowedHeaders?: string | string[];
-    exposedHeaders?: string | string[];
-    credentials?: boolean;
-    maxAge?: number;
-    preflightContinue?: boolean;
-    optionsSuccessStatus?: number;
+        paths?: string[];
+      }>;
+    };
   };
 
   /**
-   * Content Security Policy options.
-   *
-   * The keys are the plain policy ID, e.g. "upgrade-insecure-requests". The
-   * values are on the format that the helmet library expects them, as an
-   * array of strings. There is also the special value false, which means to
-   * remove the default value that Backstage puts in place for that policy.
-   */
-  csp?: { [policyId: string]: string[] | false };
-
-  /**
-   * Configuration related to URL reading, used for example for reading catalog info
-   * files, scaffolder templates, and techdocs content.
+   * Options used by the default discovery service.
    */
-  reading?: {
+  discovery?: {
     /**
-     * A list of targets to allow outgoing requests to. Users will be able to make
-     * requests on behalf of the backend to the targets that are allowed by this list.
+     * A list of target baseUrls and the associated plugins.
      */
-    allow?: Array<{
+    endpoints: Array<{
       /**
-       * A host to allow outgoing requests to, being either a full host or
-       * a subdomain wildcard pattern with a leading `*`. For example `example.com`
-       * and `*.example.com` are valid values, `prod.*.example.com` is not.
-       * The host may also contain a port, for example `example.com:8080`.
+       * The target base URL 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 plugin ID.
        */
-      host: string;
-
+      target: string | { internal: string; external: string };
       /**
-       * An optional list of paths. In case they are present only targets matching
-       * any of them will are allowed. You can use trailing slashes to make sure only
-       * subdirectories are allowed, for example `/mydir/` will allow targets with
-       * paths like `/mydir/a` but will block paths like `/mydir2`.
+       * Array of plugins which use the target base URL.
        */
-      paths?: string[];
+      plugins: string[];
     }>;
   };
 }

package/database/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/backend-defaults__database",
-  "version": "0.5.0-next.0",
+  "version": "0.5.0-next.1",
   "main": "../dist/database.cjs.js",
   "types": "../dist/database.d.ts"
 }

package/discovery/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/backend-defaults__discovery",
-  "version": "0.5.0-next.0",
+  "version": "0.5.0-next.1",
   "main": "../dist/discovery.cjs.js",
   "types": "../dist/discovery.d.ts"
 }

package/dist/auth.cjs.js

@@ -84,6 +84,7 @@ class DefaultAuthService {
       return { token: "" };
     }
     switch (type) {
+      // TODO: Check whether the principal is ourselves
       case "service":
         return this.pluginTokenHandler.issueToken({
           pluginId: this.pluginId,