@backstage/backend-dynamic-feature-service 0.4.2-next.1 → 0.4.2

package/CHANGELOG.md

@@ -1,5 +1,68 @@
 # @backstage/backend-dynamic-feature-service
 
+## 0.4.2
+
+### Patch Changes
+
+- d18d494: Enhance and simplify the activation of the dynamic plugins feature:
+
+  - The dynamic plugins service (which implements the `DynamicPluginsProvider`) is restored, since it is required for plugins to depend on it in order to get the details of loaded dynamic plugins (possibly with loading errors to be surfaced in some UI).
+  - A new all-in-one feature loader (`dynamicPluginsFeatureLoader`) is provided that allows a 1-liner activation of both the dynamic features and additional services or plugins required to have the dynamic plugins work correctly with dynamic plugins config schemas. Previous service factories or feature loaders are deprecated.
+
+- e6c0550: Enhance the API of the `DynamicPluginProvider` (available as a service) to:
+
+  - expose the new `getScannedPackage()` method that returns the `ScannedPluginPackage` from which a given plugin has been loaded,
+  - add an optional `includeFailed` argument in the plugins list retrieval methods, to include the plugins that could be successfully loaded (`false` by default).
+
+- 4c89e47: Allow passing an async module loader in the `DynamicPluginsFeatureLoaderOptions`.
+- 094eaa3: Remove references to in-repo backend-common
+- 2f88f88: Updated backend installation instructions.
+- Updated dependencies
+  - @backstage/backend-defaults@0.5.1
+  - @backstage/cli-node@0.2.9
+  - @backstage/backend-app-api@1.0.1
+  - @backstage/plugin-scaffolder-node@0.5.0
+  - @backstage/plugin-auth-node@0.5.3
+  - @backstage/plugin-search-backend-node@1.3.3
+  - @backstage/plugin-catalog-backend@1.27.0
+  - @backstage/plugin-permission-node@0.8.4
+  - @backstage/plugin-events-backend@0.3.13
+  - @backstage/plugin-events-node@0.4.1
+  - @backstage/backend-plugin-api@1.0.1
+  - @backstage/cli-common@0.1.14
+  - @backstage/config@1.2.0
+  - @backstage/config-loader@1.9.1
+  - @backstage/errors@1.2.4
+  - @backstage/types@1.1.1
+  - @backstage/plugin-app-node@0.1.26
+  - @backstage/plugin-permission-common@0.8.1
+  - @backstage/plugin-search-common@1.2.14
+
+## 0.4.2-next.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/cli-node@0.2.9-next.0
+  - @backstage/backend-app-api@1.0.1-next.1
+  - @backstage/backend-defaults@0.5.1-next.2
+  - @backstage/plugin-auth-node@0.5.3-next.1
+  - @backstage/plugin-catalog-backend@1.26.2-next.2
+  - @backstage/plugin-scaffolder-node@0.5.0-next.2
+  - @backstage/backend-plugin-api@1.0.1-next.1
+  - @backstage/cli-common@0.1.14
+  - @backstage/config@1.2.0
+  - @backstage/config-loader@1.9.1
+  - @backstage/errors@1.2.4
+  - @backstage/types@1.1.1
+  - @backstage/plugin-app-node@0.1.26-next.1
+  - @backstage/plugin-events-backend@0.3.13-next.1
+  - @backstage/plugin-events-node@0.4.1-next.1
+  - @backstage/plugin-permission-common@0.8.1
+  - @backstage/plugin-permission-node@0.8.4-next.1
+  - @backstage/plugin-search-backend-node@1.3.3-next.2
+  - @backstage/plugin-search-common@1.2.14
+
 ## 0.4.2-next.1
 
 ### Patch Changes

package/README.md

@@ -15,8 +15,7 @@ In the `backend` application, it can be enabled by adding the `backend-dynamic-f
 ```ts
 const backend = createBackend();
 +
-+ backend.add(dynamicPluginsFeatureDiscoveryServiceFactory) // overridden version of the FeatureDiscoveryService which provides features loaded by dynamic plugins
-+ backend.add(dynamicPluginsServiceFactory)
++ backend.add(dynamicPluginsFeatureLoader) // provides features loaded by dynamic plugins
 +
 ```
 

package/dist/features/features.cjs.js

@@ -0,0 +1,35 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var schemas = require('../schemas/schemas.cjs.js');
+var frontend = require('../schemas/frontend.cjs.js');
+var rootLogger = require('../schemas/rootLogger.cjs.js');
+var pluginManager = require('../manager/plugin-manager.cjs.js');
+var pluginScanner = require('../scanner/plugin-scanner.cjs.js');
+
+const dynamicPluginsFeatureLoaderWithOptions = (options) => backendPluginApi.createBackendFeatureLoader({
+  deps: {
+    config: backendPluginApi.coreServices.rootConfig
+  },
+  *loader({ config }) {
+    const dynamicPluginsEnabled = config.has(pluginScanner.configKey);
+    yield* [
+      schemas.dynamicPluginsSchemasServiceFactory(options),
+      pluginManager.dynamicPluginsServiceFactory(options)
+    ];
+    if (dynamicPluginsEnabled) {
+      yield* [
+        rootLogger.dynamicPluginsRootLoggerServiceFactory(options),
+        frontend.dynamicPluginsFrontendSchemas,
+        pluginManager.dynamicPluginsFeatureDiscoveryLoader
+      ];
+    }
+  }
+});
+const dynamicPluginsFeatureLoader = Object.assign(
+  dynamicPluginsFeatureLoaderWithOptions,
+  dynamicPluginsFeatureLoaderWithOptions()
+);
+
+exports.dynamicPluginsFeatureLoader = dynamicPluginsFeatureLoader;
+//# sourceMappingURL=features.cjs.js.map

package/dist/features/features.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"features.cjs.js","sources":["../../src/features/features.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 */\n\nimport {\n  coreServices,\n  createBackendFeatureLoader,\n} from '@backstage/backend-plugin-api';\nimport {\n  DynamicPluginsSchemasOptions,\n  dynamicPluginsFrontendSchemas,\n  dynamicPluginsRootLoggerServiceFactory,\n  dynamicPluginsSchemasServiceFactory,\n} from '../schemas';\nimport {\n  DynamicPluginsFactoryOptions,\n  dynamicPluginsFeatureDiscoveryLoader,\n  dynamicPluginsServiceFactory,\n} from '../manager';\nimport { DynamicPluginsRootLoggerFactoryOptions } from '../schemas';\nimport { configKey } from '../scanner/plugin-scanner';\n\n/**\n * @public\n */\nexport type DynamicPluginsFeatureLoaderOptions = DynamicPluginsFactoryOptions &\n  DynamicPluginsSchemasOptions &\n  DynamicPluginsRootLoggerFactoryOptions;\n\nconst dynamicPluginsFeatureLoaderWithOptions = (\n  options?: DynamicPluginsFeatureLoaderOptions,\n) =>\n  createBackendFeatureLoader({\n    deps: {\n      config: coreServices.rootConfig,\n    },\n    *loader({ config }) {\n      const dynamicPluginsEnabled = config.has(configKey);\n\n      yield* [\n        dynamicPluginsSchemasServiceFactory(options),\n        dynamicPluginsServiceFactory(options),\n      ];\n      if (dynamicPluginsEnabled) {\n        yield* [\n          dynamicPluginsRootLoggerServiceFactory(options),\n          dynamicPluginsFrontendSchemas,\n          dynamicPluginsFeatureDiscoveryLoader,\n        ];\n      }\n    },\n  });\n\n/**\n * A backend feature loader that fully enable backend dynamic plugins.\n * More precisely it:\n * - adds the dynamic plugins root service (typically depended upon by plugins),\n * - adds additional required features to allow supporting dynamic plugins config schemas\n *   in the frontend application and the backend root logger,\n * - uses the dynamic plugins service to discover and expose dynamic plugins as features.\n *\n * @public\n *\n * @example\n * Using the `dynamicPluginsFeatureLoader` loader in a backend instance:\n * ```ts\n * //...\n * import { createBackend } from '@backstage/backend-defaults';\n * import { dynamicPluginsFeatureLoader } from '@backstage/backend-dynamic-feature-service';\n *\n * const backend = createBackend();\n * backend.add(dynamicPluginsFeatureLoader);\n * //...\n * backend.start();\n * ```\n *\n * @example\n * Passing options to the `dynamicPluginsFeatureLoader` loader in a backend instance:\n * ```ts\n * //...\n * import { createBackend } from '@backstage/backend-defaults';\n * import { dynamicPluginsFeatureLoader } from '@backstage/backend-dynamic-feature-service';\n * import { myCustomModuleLoader } from './myCustomModuleLoader';\n * import { myCustomSchemaLocator } from './myCustomSchemaLocator';\n *\n * const backend = createBackend();\n * backend.add(dynamicPluginsFeatureLoader({\n *   moduleLoader: myCustomModuleLoader,\n *   schemaLocator: myCustomSchemaLocator,\n *\n * }));\n * //...\n * backend.start();\n * ```\n */\nexport const dynamicPluginsFeatureLoader = Object.assign(\n  dynamicPluginsFeatureLoaderWithOptions,\n  dynamicPluginsFeatureLoaderWithOptions(),\n);\n"],"names":["createBackendFeatureLoader","coreServices","configKey","dynamicPluginsSchemasServiceFactory","dynamicPluginsServiceFactory","dynamicPluginsRootLoggerServiceFactory","dynamicPluginsFrontendSchemas","dynamicPluginsFeatureDiscoveryLoader"],"mappings":";;;;;;;;;AAyCA,MAAM,sCAAA,GAAyC,CAC7C,OAAA,KAEAA,2CAA2B,CAAA;AAAA,EACzB,IAAM,EAAA;AAAA,IACJ,QAAQC,6BAAa,CAAA,UAAA;AAAA,GACvB;AAAA,EACA,CAAC,MAAA,CAAO,EAAE,MAAA,EAAU,EAAA;AAClB,IAAM,MAAA,qBAAA,GAAwB,MAAO,CAAA,GAAA,CAAIC,uBAAS,CAAA,CAAA;AAElD,IAAO,OAAA;AAAA,MACLC,4CAAoC,OAAO,CAAA;AAAA,MAC3CC,2CAA6B,OAAO,CAAA;AAAA,KACtC,CAAA;AACA,IAAA,IAAI,qBAAuB,EAAA;AACzB,MAAO,OAAA;AAAA,QACLC,kDAAuC,OAAO,CAAA;AAAA,QAC9CC,sCAAA;AAAA,QACAC,kDAAA;AAAA,OACF,CAAA;AAAA,KACF;AAAA,GACF;AACF,CAAC,CAAA,CAAA;AA4CI,MAAM,8BAA8B,MAAO,CAAA,MAAA;AAAA,EAChD,sCAAA;AAAA,EACA,sCAAuC,EAAA;AACzC;;;;"}