@backstage/backend-defaults 0.17.5 → 0.17.6-next.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +13 -0
- package/dist/CreateBackend.cjs.js +2 -0
- package/dist/CreateBackend.cjs.js.map +1 -1
- package/dist/alpha.cjs.js +0 -2
- package/dist/alpha.cjs.js.map +1 -1
- package/dist/alpha.d.ts +1 -8
- package/dist/{alpha/entrypoints → entrypoints}/rootSystemMetadata/lib/DefaultRootSystemMetadataService.cjs.js +1 -1
- package/dist/entrypoints/rootSystemMetadata/lib/DefaultRootSystemMetadataService.cjs.js.map +1 -0
- package/dist/{alpha/entrypoints → entrypoints}/rootSystemMetadata/rootSystemMetadataServiceFactory.cjs.js +1 -2
- package/dist/entrypoints/rootSystemMetadata/rootSystemMetadataServiceFactory.cjs.js.map +1 -0
- package/dist/entrypoints/urlReader/lib/AzureUrlReader.cjs.js +8 -1
- package/dist/entrypoints/urlReader/lib/AzureUrlReader.cjs.js.map +1 -1
- package/dist/package.json.cjs.js +1 -1
- package/dist/rootSystemMetadata.cjs.js +10 -0
- package/dist/rootSystemMetadata.cjs.js.map +1 -0
- package/dist/rootSystemMetadata.d.ts +29 -0
- package/package.json +25 -17
- package/dist/alpha/entrypoints/rootSystemMetadata/lib/DefaultRootSystemMetadataService.cjs.js.map +0 -1
- package/dist/alpha/entrypoints/rootSystemMetadata/rootSystemMetadataServiceFactory.cjs.js.map +0 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,18 @@
|
|
|
1
1
|
# @backstage/backend-defaults
|
|
2
2
|
|
|
3
|
+
## 0.17.6-next.0
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 79c1d58: Fixed a bug in the Azure DevOps URL reader where the abort signal was not forwarded to the commits API fetch, causing the fetch to hang indefinitely when a build timeout or cancellation was triggered.
|
|
8
|
+
- 74d8cbf: Added a new public `@backstage/backend-defaults/rootSystemMetadata` entrypoint, exporting `rootSystemMetadataServiceFactory` and `DefaultRootSystemMetadataService`. The system metadata service is now registered automatically as a default service, so backends no longer need to add it manually.
|
|
9
|
+
- Updated dependencies
|
|
10
|
+
- @backstage/backend-app-api@1.7.3-next.0
|
|
11
|
+
- @backstage/plugin-auth-node@0.7.4-next.0
|
|
12
|
+
- @backstage/backend-plugin-api@1.10.0-next.0
|
|
13
|
+
- @backstage/plugin-permission-node@0.11.3-next.0
|
|
14
|
+
- @backstage/plugin-events-node@0.4.25-next.0
|
|
15
|
+
|
|
3
16
|
## 0.17.5
|
|
4
17
|
|
|
5
18
|
### Patch Changes
|
|
@@ -17,6 +17,7 @@ var rootHealth = require('@backstage/backend-defaults/rootHealth');
|
|
|
17
17
|
var rootHttpRouter = require('@backstage/backend-defaults/rootHttpRouter');
|
|
18
18
|
var rootLifecycle = require('@backstage/backend-defaults/rootLifecycle');
|
|
19
19
|
var rootLogger = require('@backstage/backend-defaults/rootLogger');
|
|
20
|
+
var rootSystemMetadata = require('@backstage/backend-defaults/rootSystemMetadata');
|
|
20
21
|
var scheduler = require('@backstage/backend-defaults/scheduler');
|
|
21
22
|
var urlReader = require('@backstage/backend-defaults/urlReader');
|
|
22
23
|
var userInfo = require('@backstage/backend-defaults/userInfo');
|
|
@@ -41,6 +42,7 @@ const defaultServiceFactories = [
|
|
|
41
42
|
rootHttpRouter.rootHttpRouterServiceFactory,
|
|
42
43
|
rootLifecycle.rootLifecycleServiceFactory,
|
|
43
44
|
rootLogger.rootLoggerServiceFactory,
|
|
45
|
+
rootSystemMetadata.rootSystemMetadataServiceFactory,
|
|
44
46
|
scheduler.schedulerServiceFactory,
|
|
45
47
|
userInfo.userInfoServiceFactory,
|
|
46
48
|
urlReader.urlReaderServiceFactory,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CreateBackend.cjs.js","sources":["../src/CreateBackend.ts"],"sourcesContent":["/*\n * Copyright 2022 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 { Backend, createSpecializedBackend } from '@backstage/backend-app-api';\nimport { ServiceFactory } from '@backstage/backend-plugin-api';\nimport { auditorServiceFactory } from '@backstage/backend-defaults/auditor';\nimport { authServiceFactory } from '@backstage/backend-defaults/auth';\nimport { cacheServiceFactory } from '@backstage/backend-defaults/cache';\nimport { databaseServiceFactory } from '@backstage/backend-defaults/database';\nimport { discoveryServiceFactory } from '@backstage/backend-defaults/discovery';\nimport { httpAuthServiceFactory } from '@backstage/backend-defaults/httpAuth';\nimport { httpRouterServiceFactory } from '@backstage/backend-defaults/httpRouter';\nimport { lifecycleServiceFactory } from '@backstage/backend-defaults/lifecycle';\nimport { loggerServiceFactory } from '@backstage/backend-defaults/logger';\nimport { permissionsServiceFactory } from '@backstage/backend-defaults/permissions';\nimport { permissionsRegistryServiceFactory } from '@backstage/backend-defaults/permissionsRegistry';\nimport { rootConfigServiceFactory } from '@backstage/backend-defaults/rootConfig';\nimport { rootHealthServiceFactory } from '@backstage/backend-defaults/rootHealth';\nimport { rootHttpRouterServiceFactory } from '@backstage/backend-defaults/rootHttpRouter';\nimport { rootLifecycleServiceFactory } from '@backstage/backend-defaults/rootLifecycle';\nimport { rootLoggerServiceFactory } from '@backstage/backend-defaults/rootLogger';\nimport { schedulerServiceFactory } from '@backstage/backend-defaults/scheduler';\nimport { urlReaderServiceFactory } from '@backstage/backend-defaults/urlReader';\nimport { userInfoServiceFactory } from '@backstage/backend-defaults/userInfo';\nimport { eventsServiceFactory } from '@backstage/plugin-events-node';\nimport {\n actionsRegistryServiceFactory,\n actionsServiceFactory,\n metricsServiceFactory,\n tracingServiceFactory,\n} from '@backstage/backend-defaults/alpha';\nimport { instanceMetadataServiceFactory } from './alpha/entrypoints/instanceMetadata/instanceMetadataServiceFactory';\n\n/** @public */\nexport const defaultServiceFactories: ServiceFactory[] = [\n auditorServiceFactory,\n authServiceFactory,\n cacheServiceFactory,\n rootConfigServiceFactory,\n databaseServiceFactory,\n discoveryServiceFactory,\n httpAuthServiceFactory,\n httpRouterServiceFactory,\n lifecycleServiceFactory,\n loggerServiceFactory,\n permissionsServiceFactory,\n permissionsRegistryServiceFactory,\n rootHealthServiceFactory,\n rootHttpRouterServiceFactory,\n rootLifecycleServiceFactory,\n rootLoggerServiceFactory,\n schedulerServiceFactory,\n userInfoServiceFactory,\n urlReaderServiceFactory,\n eventsServiceFactory,\n\n // alpha services\n actionsRegistryServiceFactory,\n actionsServiceFactory,\n metricsServiceFactory,\n tracingServiceFactory,\n\n // Unexported alpha services kept around for compatibility reasons\n instanceMetadataServiceFactory,\n];\n\n/**\n * @public\n */\nexport function createBackend(): Backend {\n return createSpecializedBackend({ defaultServiceFactories });\n}\n"],"names":["auditorServiceFactory","authServiceFactory","cacheServiceFactory","rootConfigServiceFactory","databaseServiceFactory","discoveryServiceFactory","httpAuthServiceFactory","httpRouterServiceFactory","lifecycleServiceFactory","loggerServiceFactory","permissionsServiceFactory","permissionsRegistryServiceFactory","rootHealthServiceFactory","rootHttpRouterServiceFactory","rootLifecycleServiceFactory","rootLoggerServiceFactory","schedulerServiceFactory","userInfoServiceFactory","urlReaderServiceFactory","eventsServiceFactory","actionsRegistryServiceFactory","actionsServiceFactory","metricsServiceFactory","tracingServiceFactory","instanceMetadataServiceFactory","createSpecializedBackend"],"mappings":"
|
|
1
|
+
{"version":3,"file":"CreateBackend.cjs.js","sources":["../src/CreateBackend.ts"],"sourcesContent":["/*\n * Copyright 2022 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 { Backend, createSpecializedBackend } from '@backstage/backend-app-api';\nimport { ServiceFactory } from '@backstage/backend-plugin-api';\nimport { auditorServiceFactory } from '@backstage/backend-defaults/auditor';\nimport { authServiceFactory } from '@backstage/backend-defaults/auth';\nimport { cacheServiceFactory } from '@backstage/backend-defaults/cache';\nimport { databaseServiceFactory } from '@backstage/backend-defaults/database';\nimport { discoveryServiceFactory } from '@backstage/backend-defaults/discovery';\nimport { httpAuthServiceFactory } from '@backstage/backend-defaults/httpAuth';\nimport { httpRouterServiceFactory } from '@backstage/backend-defaults/httpRouter';\nimport { lifecycleServiceFactory } from '@backstage/backend-defaults/lifecycle';\nimport { loggerServiceFactory } from '@backstage/backend-defaults/logger';\nimport { permissionsServiceFactory } from '@backstage/backend-defaults/permissions';\nimport { permissionsRegistryServiceFactory } from '@backstage/backend-defaults/permissionsRegistry';\nimport { rootConfigServiceFactory } from '@backstage/backend-defaults/rootConfig';\nimport { rootHealthServiceFactory } from '@backstage/backend-defaults/rootHealth';\nimport { rootHttpRouterServiceFactory } from '@backstage/backend-defaults/rootHttpRouter';\nimport { rootLifecycleServiceFactory } from '@backstage/backend-defaults/rootLifecycle';\nimport { rootLoggerServiceFactory } from '@backstage/backend-defaults/rootLogger';\nimport { rootSystemMetadataServiceFactory } from '@backstage/backend-defaults/rootSystemMetadata';\nimport { schedulerServiceFactory } from '@backstage/backend-defaults/scheduler';\nimport { urlReaderServiceFactory } from '@backstage/backend-defaults/urlReader';\nimport { userInfoServiceFactory } from '@backstage/backend-defaults/userInfo';\nimport { eventsServiceFactory } from '@backstage/plugin-events-node';\nimport {\n actionsRegistryServiceFactory,\n actionsServiceFactory,\n metricsServiceFactory,\n tracingServiceFactory,\n} from '@backstage/backend-defaults/alpha';\nimport { instanceMetadataServiceFactory } from './alpha/entrypoints/instanceMetadata/instanceMetadataServiceFactory';\n\n/** @public */\nexport const defaultServiceFactories: ServiceFactory[] = [\n auditorServiceFactory,\n authServiceFactory,\n cacheServiceFactory,\n rootConfigServiceFactory,\n databaseServiceFactory,\n discoveryServiceFactory,\n httpAuthServiceFactory,\n httpRouterServiceFactory,\n lifecycleServiceFactory,\n loggerServiceFactory,\n permissionsServiceFactory,\n permissionsRegistryServiceFactory,\n rootHealthServiceFactory,\n rootHttpRouterServiceFactory,\n rootLifecycleServiceFactory,\n rootLoggerServiceFactory,\n rootSystemMetadataServiceFactory,\n schedulerServiceFactory,\n userInfoServiceFactory,\n urlReaderServiceFactory,\n eventsServiceFactory,\n\n // alpha services\n actionsRegistryServiceFactory,\n actionsServiceFactory,\n metricsServiceFactory,\n tracingServiceFactory,\n\n // Unexported alpha services kept around for compatibility reasons\n instanceMetadataServiceFactory,\n];\n\n/**\n * @public\n */\nexport function createBackend(): Backend {\n return createSpecializedBackend({ defaultServiceFactories });\n}\n"],"names":["auditorServiceFactory","authServiceFactory","cacheServiceFactory","rootConfigServiceFactory","databaseServiceFactory","discoveryServiceFactory","httpAuthServiceFactory","httpRouterServiceFactory","lifecycleServiceFactory","loggerServiceFactory","permissionsServiceFactory","permissionsRegistryServiceFactory","rootHealthServiceFactory","rootHttpRouterServiceFactory","rootLifecycleServiceFactory","rootLoggerServiceFactory","rootSystemMetadataServiceFactory","schedulerServiceFactory","userInfoServiceFactory","urlReaderServiceFactory","eventsServiceFactory","actionsRegistryServiceFactory","actionsServiceFactory","metricsServiceFactory","tracingServiceFactory","instanceMetadataServiceFactory","createSpecializedBackend"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAgDO,MAAM,uBAAA,GAA4C;AAAA,EACvDA,6BAAA;AAAA,EACAC,uBAAA;AAAA,EACAC,yBAAA;AAAA,EACAC,mCAAA;AAAA,EACAC,+BAAA;AAAA,EACAC,iCAAA;AAAA,EACAC,+BAAA;AAAA,EACAC,mCAAA;AAAA,EACAC,iCAAA;AAAA,EACAC,2BAAA;AAAA,EACAC,qCAAA;AAAA,EACAC,qDAAA;AAAA,EACAC,mCAAA;AAAA,EACAC,2CAAA;AAAA,EACAC,yCAAA;AAAA,EACAC,mCAAA;AAAA,EACAC,mDAAA;AAAA,EACAC,iCAAA;AAAA,EACAC,+BAAA;AAAA,EACAC,iCAAA;AAAA,EACAC,qCAAA;AAAA;AAAA,EAGAC,mCAAA;AAAA,EACAC,2BAAA;AAAA,EACAC,2BAAA;AAAA,EACAC,2BAAA;AAAA;AAAA,EAGAC;AACF;AAKO,SAAS,aAAA,GAAyB;AACvC,EAAA,OAAOC,sCAAA,CAAyB,EAAE,uBAAA,EAAyB,CAAA;AAC7D;;;;;"}
|
package/dist/alpha.cjs.js
CHANGED
|
@@ -3,7 +3,6 @@
|
|
|
3
3
|
var actionsRegistryServiceFactory = require('./alpha/entrypoints/actionsRegistry/actionsRegistryServiceFactory.cjs.js');
|
|
4
4
|
var actionsServiceFactory = require('./alpha/entrypoints/actions/actionsServiceFactory.cjs.js');
|
|
5
5
|
var metricsServiceFactory = require('./alpha/entrypoints/metrics/metricsServiceFactory.cjs.js');
|
|
6
|
-
var rootSystemMetadataServiceFactory = require('./alpha/entrypoints/rootSystemMetadata/rootSystemMetadataServiceFactory.cjs.js');
|
|
7
6
|
var tracingServiceFactory = require('./alpha/entrypoints/tracing/tracingServiceFactory.cjs.js');
|
|
8
7
|
|
|
9
8
|
|
|
@@ -11,6 +10,5 @@ var tracingServiceFactory = require('./alpha/entrypoints/tracing/tracingServiceF
|
|
|
11
10
|
exports.actionsRegistryServiceFactory = actionsRegistryServiceFactory.actionsRegistryServiceFactory;
|
|
12
11
|
exports.actionsServiceFactory = actionsServiceFactory.actionsServiceFactory;
|
|
13
12
|
exports.metricsServiceFactory = metricsServiceFactory.metricsServiceFactory;
|
|
14
|
-
exports.rootSystemMetadataServiceFactory = rootSystemMetadataServiceFactory.rootSystemMetadataServiceFactory;
|
|
15
13
|
exports.tracingServiceFactory = tracingServiceFactory.tracingServiceFactory;
|
|
16
14
|
//# sourceMappingURL=alpha.cjs.js.map
|
package/dist/alpha.cjs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"alpha.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"alpha.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;"}
|
package/dist/alpha.d.ts
CHANGED
|
@@ -18,13 +18,6 @@ declare const actionsServiceFactory: _backstage_backend_plugin_api.ServiceFactor
|
|
|
18
18
|
*/
|
|
19
19
|
declare const metricsServiceFactory: _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api_alpha.MetricsService, "plugin", "singleton">;
|
|
20
20
|
|
|
21
|
-
/**
|
|
22
|
-
* Metadata about an entire Backstage system, a collection of Backstage instances.
|
|
23
|
-
*
|
|
24
|
-
* @alpha
|
|
25
|
-
*/
|
|
26
|
-
declare const rootSystemMetadataServiceFactory: _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api_alpha.RootSystemMetadataService, "root", "singleton">;
|
|
27
|
-
|
|
28
21
|
/**
|
|
29
22
|
* Service factory for emitting plugin-scoped trace spans.
|
|
30
23
|
*
|
|
@@ -32,4 +25,4 @@ declare const rootSystemMetadataServiceFactory: _backstage_backend_plugin_api.Se
|
|
|
32
25
|
*/
|
|
33
26
|
declare const tracingServiceFactory: _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api_alpha.TracingService, "plugin", "singleton">;
|
|
34
27
|
|
|
35
|
-
export { actionsRegistryServiceFactory, actionsServiceFactory, metricsServiceFactory,
|
|
28
|
+
export { actionsRegistryServiceFactory, actionsServiceFactory, metricsServiceFactory, tracingServiceFactory };
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"DefaultRootSystemMetadataService.cjs.js","sources":["../../../../src/entrypoints/rootSystemMetadata/lib/DefaultRootSystemMetadataService.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 LoggerService,\n RootConfigService,\n RootInstanceMetadataService,\n RootSystemMetadataService,\n RootSystemMetadataServicePluginInfo,\n} from '@backstage/backend-plugin-api';\nimport { getEndpoints } from '../../discovery/parsing';\nimport { Config } from '@backstage/config';\n\nfunction getPlugins(config: Config): string[] {\n const endpoints = getEndpoints(config);\n return Array.from(new Set(endpoints.flatMap(endpoint => endpoint.plugins)));\n}\n\n/**\n * @public\n */\nexport class DefaultRootSystemMetadataService\n implements RootSystemMetadataService\n{\n #plugins: string[];\n #instanceMetadata: RootInstanceMetadataService;\n constructor(options: {\n logger: LoggerService;\n config: RootConfigService;\n instanceMetadata: RootInstanceMetadataService;\n }) {\n const { config } = options;\n this.#plugins = getPlugins(config);\n config.subscribe?.(() => {\n this.#plugins = getPlugins(config);\n });\n this.#instanceMetadata = options.instanceMetadata;\n }\n\n public static create(pluginEnv: {\n logger: LoggerService;\n config: RootConfigService;\n instanceMetadata: RootInstanceMetadataService;\n }) {\n return new DefaultRootSystemMetadataService(pluginEnv);\n }\n\n public async getInstalledPlugins(): Promise<\n RootSystemMetadataServicePluginInfo[]\n > {\n const plugins = this.#plugins.map(pluginId => ({ pluginId }));\n\n for (const plugin of await this.#instanceMetadata.getInstalledPlugins()) {\n plugins.push({ pluginId: plugin.pluginId });\n }\n\n return plugins;\n }\n}\n"],"names":["getEndpoints"],"mappings":";;;;AA0BA,SAAS,WAAW,MAAA,EAA0B;AAC5C,EAAA,MAAM,SAAA,GAAYA,qBAAa,MAAM,CAAA;AACrC,EAAA,OAAO,KAAA,CAAM,IAAA,CAAK,IAAI,GAAA,CAAI,SAAA,CAAU,QAAQ,CAAA,QAAA,KAAY,QAAA,CAAS,OAAO,CAAC,CAAC,CAAA;AAC5E;AAKO,MAAM,gCAAA,CAEb;AAAA,EACE,QAAA;AAAA,EACA,iBAAA;AAAA,EACA,YAAY,OAAA,EAIT;AACD,IAAA,MAAM,EAAE,QAAO,GAAI,OAAA;AACnB,IAAA,IAAA,CAAK,QAAA,GAAW,WAAW,MAAM,CAAA;AACjC,IAAA,MAAA,CAAO,YAAY,MAAM;AACvB,MAAA,IAAA,CAAK,QAAA,GAAW,WAAW,MAAM,CAAA;AAAA,IACnC,CAAC,CAAA;AACD,IAAA,IAAA,CAAK,oBAAoB,OAAA,CAAQ,gBAAA;AAAA,EACnC;AAAA,EAEA,OAAc,OAAO,SAAA,EAIlB;AACD,IAAA,OAAO,IAAI,iCAAiC,SAAS,CAAA;AAAA,EACvD;AAAA,EAEA,MAAa,mBAAA,GAEX;AACA,IAAA,MAAM,UAAU,IAAA,CAAK,QAAA,CAAS,IAAI,CAAA,QAAA,MAAa,EAAE,UAAS,CAAE,CAAA;AAE5D,IAAA,KAAA,MAAW,MAAA,IAAU,MAAM,IAAA,CAAK,iBAAA,CAAkB,qBAAoB,EAAG;AACvE,MAAA,OAAA,CAAQ,IAAA,CAAK,EAAE,QAAA,EAAU,MAAA,CAAO,UAAU,CAAA;AAAA,IAC5C;AAEA,IAAA,OAAO,OAAA;AAAA,EACT;AACF;;;;"}
|
|
@@ -2,10 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
var backendPluginApi = require('@backstage/backend-plugin-api');
|
|
4
4
|
var DefaultRootSystemMetadataService = require('./lib/DefaultRootSystemMetadataService.cjs.js');
|
|
5
|
-
var alpha = require('@backstage/backend-plugin-api/alpha');
|
|
6
5
|
|
|
7
6
|
const rootSystemMetadataServiceFactory = backendPluginApi.createServiceFactory({
|
|
8
|
-
service:
|
|
7
|
+
service: backendPluginApi.coreServices.rootSystemMetadata,
|
|
9
8
|
deps: {
|
|
10
9
|
logger: backendPluginApi.coreServices.rootLogger,
|
|
11
10
|
config: backendPluginApi.coreServices.rootConfig,
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"rootSystemMetadataServiceFactory.cjs.js","sources":["../../../src/entrypoints/rootSystemMetadata/rootSystemMetadataServiceFactory.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 createServiceFactory,\n} from '@backstage/backend-plugin-api';\nimport { DefaultRootSystemMetadataService } from './lib/DefaultRootSystemMetadataService';\n\n/**\n * Metadata about an entire Backstage system, a collection of Backstage instances.\n *\n * @public\n */\nexport const rootSystemMetadataServiceFactory = createServiceFactory({\n service: coreServices.rootSystemMetadata,\n deps: {\n logger: coreServices.rootLogger,\n config: coreServices.rootConfig,\n instanceMetadata: coreServices.rootInstanceMetadata,\n },\n async factory({ logger, config, instanceMetadata }) {\n return DefaultRootSystemMetadataService.create({\n logger,\n config,\n instanceMetadata,\n });\n },\n});\n"],"names":["createServiceFactory","coreServices","DefaultRootSystemMetadataService"],"mappings":";;;;;AA2BO,MAAM,mCAAmCA,qCAAA,CAAqB;AAAA,EACnE,SAASC,6BAAA,CAAa,kBAAA;AAAA,EACtB,IAAA,EAAM;AAAA,IACJ,QAAQA,6BAAA,CAAa,UAAA;AAAA,IACrB,QAAQA,6BAAA,CAAa,UAAA;AAAA,IACrB,kBAAkBA,6BAAA,CAAa;AAAA,GACjC;AAAA,EACA,MAAM,OAAA,CAAQ,EAAE,MAAA,EAAQ,MAAA,EAAQ,kBAAiB,EAAG;AAClD,IAAA,OAAOC,kEAAiC,MAAA,CAAO;AAAA,MAC7C,MAAA;AAAA,MACA,MAAA;AAAA,MACA;AAAA,KACD,CAAA;AAAA,EACH;AACF,CAAC;;;;"}
|
|
@@ -69,7 +69,14 @@ class AzureUrlReader {
|
|
|
69
69
|
url
|
|
70
70
|
});
|
|
71
71
|
const commitsAzureResponse = await fetch(integration.getAzureCommitsUrl(url), {
|
|
72
|
-
headers: credentials?.headers
|
|
72
|
+
headers: credentials?.headers,
|
|
73
|
+
// TODO(freben): The signal cast is there because pre-3.x versions of
|
|
74
|
+
// node-fetch have a very slightly deviating AbortSignal type signature.
|
|
75
|
+
// The difference does not affect us in practice however. The cast can be
|
|
76
|
+
// removed after we support ESM for CLI dependencies and migrate to
|
|
77
|
+
// version 3 of node-fetch.
|
|
78
|
+
// https://github.com/backstage/backstage/issues/8242
|
|
79
|
+
...signal && { signal }
|
|
73
80
|
});
|
|
74
81
|
if (!commitsAzureResponse.ok) {
|
|
75
82
|
const message = `Failed to read tree from ${url}, ${commitsAzureResponse.status} ${commitsAzureResponse.statusText}`;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AzureUrlReader.cjs.js","sources":["../../../../src/entrypoints/urlReader/lib/AzureUrlReader.ts"],"sourcesContent":["/*\n * Copyright 2020 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 UrlReaderService,\n UrlReaderServiceReadTreeOptions,\n UrlReaderServiceReadTreeResponse,\n UrlReaderServiceReadUrlOptions,\n UrlReaderServiceReadUrlResponse,\n UrlReaderServiceSearchOptions,\n UrlReaderServiceSearchResponse,\n} from '@backstage/backend-plugin-api';\nimport {\n getAzureCommitsUrl,\n getAzureDownloadUrl,\n getAzureFileFetchUrl,\n AzureDevOpsCredentialsProvider,\n DefaultAzureDevOpsCredentialsProvider,\n ScmIntegrations,\n AzureIntegration,\n} from '@backstage/integration';\nimport parseGitUrl from 'git-url-parse';\nimport { Minimatch } from 'minimatch';\nimport { toError, NotFoundError, NotModifiedError } from '@backstage/errors';\nimport { ReadTreeResponseFactory, ReaderFactory } from './types';\nimport { ReadUrlResponseFactory } from './ReadUrlResponseFactory';\n\n/**\n * Implements a {@link @backstage/backend-plugin-api#UrlReaderService} for Azure repos.\n *\n * @public\n */\nexport class AzureUrlReader implements UrlReaderService {\n static factory: ReaderFactory = ({ config, treeResponseFactory }) => {\n const integrations = ScmIntegrations.fromConfig(config);\n const credentialProvider =\n DefaultAzureDevOpsCredentialsProvider.fromIntegrations(integrations);\n return integrations.azure.list().map(integration => {\n const reader = new AzureUrlReader(integration, {\n treeResponseFactory,\n credentialsProvider: credentialProvider,\n });\n const predicate = (url: URL) => url.host === integration.config.host;\n return { reader, predicate };\n });\n };\n\n private readonly integration: AzureIntegration;\n private readonly deps: {\n treeResponseFactory: ReadTreeResponseFactory;\n credentialsProvider: AzureDevOpsCredentialsProvider;\n };\n\n constructor(\n integration: AzureIntegration,\n deps: {\n treeResponseFactory: ReadTreeResponseFactory;\n credentialsProvider: AzureDevOpsCredentialsProvider;\n },\n ) {\n this.integration = integration;\n this.deps = deps;\n }\n\n async read(url: string): Promise<Buffer> {\n const response = await this.readUrl(url);\n return response.buffer();\n }\n\n async readUrl(\n url: string,\n options?: UrlReaderServiceReadUrlOptions,\n ): Promise<UrlReaderServiceReadUrlResponse> {\n // TODO: etag is not implemented yet.\n const { signal } = options ?? {};\n\n const builtUrl = getAzureFileFetchUrl(url);\n let response: Response;\n try {\n const credentials = await this.deps.credentialsProvider.getCredentials({\n url: builtUrl,\n });\n response = await fetch(builtUrl, {\n headers: credentials?.headers,\n // TODO(freben): The signal cast is there because pre-3.x versions of\n // node-fetch have a very slightly deviating AbortSignal type signature.\n // The difference does not affect us in practice however. The cast can\n // be removed after we support ESM for CLI dependencies and migrate to\n // version 3 of node-fetch.\n // https://github.com/backstage/backstage/issues/8242\n ...(signal && { signal: signal as any }),\n });\n } catch (e) {\n throw new Error(`Unable to read ${url}, ${e}`);\n }\n\n // for private repos when PAT is not valid, Azure API returns a http status code 203 with sign in page html\n if (response.ok && response.status !== 203) {\n return ReadUrlResponseFactory.fromResponse(response);\n }\n\n const message = `${url} could not be read as ${builtUrl}, ${response.status} ${response.statusText}`;\n if (response.status === 404) {\n throw new NotFoundError(message);\n }\n throw new Error(message);\n }\n\n async readTree(\n url: string,\n options?: UrlReaderServiceReadTreeOptions,\n ): Promise<UrlReaderServiceReadTreeResponse> {\n const { etag, filter, signal } = options ?? {};\n\n // TODO: Support filepath based reading tree feature like other providers\n\n // Get latest commit SHA\n\n const credentials = await this.deps.credentialsProvider.getCredentials({\n url: url,\n });\n\n const commitsAzureResponse = await fetch(getAzureCommitsUrl(url), {\n headers: credentials?.headers,\n });\n if (!commitsAzureResponse.ok) {\n const message = `Failed to read tree from ${url}, ${commitsAzureResponse.status} ${commitsAzureResponse.statusText}`;\n if (commitsAzureResponse.status === 404) {\n throw new NotFoundError(message);\n }\n throw new Error(message);\n }\n\n const commitSha = (await commitsAzureResponse.json()).value[0].commitId;\n if (etag && etag === commitSha) {\n throw new NotModifiedError();\n }\n\n const archiveAzureResponse = await fetch(getAzureDownloadUrl(url), {\n headers: {\n ...credentials?.headers,\n Accept: 'application/zip',\n },\n // TODO(freben): The signal cast is there because pre-3.x versions of\n // node-fetch have a very slightly deviating AbortSignal type signature.\n // The difference does not affect us in practice however. The cast can be\n // removed after we support ESM for CLI dependencies and migrate to\n // version 3 of node-fetch.\n // https://github.com/backstage/backstage/issues/8242\n ...(signal && { signal: signal as any }),\n });\n if (!archiveAzureResponse.ok) {\n const message = `Failed to read tree from ${url}, ${archiveAzureResponse.status} ${archiveAzureResponse.statusText}`;\n if (archiveAzureResponse.status === 404) {\n throw new NotFoundError(message);\n }\n throw new Error(message);\n }\n\n // When downloading a zip archive from azure on a subpath we get an extra directory\n // layer added at the top. With for example the file /a/b/c.txt and a download of\n // /a/b, we'll see /b/c.txt in the zip archive. This picks out /b so that we can remove it.\n let subpath;\n const path = new URL(url).searchParams.get('path');\n if (path) {\n subpath = path.split('/').filter(Boolean).slice(-1)[0];\n }\n\n return await this.deps.treeResponseFactory.fromZipArchive({\n response: archiveAzureResponse,\n etag: commitSha,\n filter,\n subpath,\n });\n }\n\n async search(\n url: string,\n options?: UrlReaderServiceSearchOptions,\n ): Promise<UrlReaderServiceSearchResponse> {\n const { filepath } = parseGitUrl(url);\n\n // If it's a direct URL we use readUrl instead\n if (!filepath?.match(/[*?]/)) {\n try {\n const data = await this.readUrl(url, options);\n\n return {\n files: [\n {\n url: url,\n content: data.buffer,\n lastModifiedAt: data.lastModifiedAt,\n },\n ],\n etag: data.etag ?? '',\n };\n } catch (e) {\n const error = toError(e);\n if (error.name === 'NotFoundError') {\n return {\n files: [],\n etag: '',\n };\n }\n throw error;\n }\n }\n\n const treeUrl = new URL(url);\n\n const path = treeUrl.searchParams.get('path');\n const matcher = path && new Minimatch(path.replace(/^\\/+/, ''));\n\n // TODO(freben): For now, read the entire repo and filter through that. In\n // a future improvement, we could be smart and try to deduce that non-glob\n // prefixes (like for filepaths such as some-prefix/**/a.yaml) can be used\n // to get just that part of the repo.\n treeUrl.searchParams.delete('path');\n\n const tree = await this.readTree(treeUrl.toString(), {\n etag: options?.etag,\n signal: options?.signal,\n filter: p => (matcher ? matcher.match(p) : true),\n });\n const files = await tree.files();\n\n return {\n etag: tree.etag,\n files: files.map(file => ({\n url: this.integration.resolveUrl({\n url: `/${file.path}`,\n base: url,\n }),\n content: file.content,\n lastModifiedAt: file.lastModifiedAt,\n })),\n };\n }\n\n toString() {\n const { host, credentials } = this.integration.config;\n return `azure{host=${host},authed=${Boolean(\n credentials !== undefined && credentials.length > 0,\n )}}`;\n }\n}\n"],"names":["ScmIntegrations","DefaultAzureDevOpsCredentialsProvider","getAzureFileFetchUrl","ReadUrlResponseFactory","NotFoundError","getAzureCommitsUrl","NotModifiedError","getAzureDownloadUrl","parseGitUrl","toError","Minimatch"],"mappings":";;;;;;;;;;;;AA6CO,MAAM,cAAA,CAA2C;AAAA,EACtD,OAAO,OAAA,GAAyB,CAAC,EAAE,MAAA,EAAQ,qBAAoB,KAAM;AACnE,IAAA,MAAM,YAAA,GAAeA,2BAAA,CAAgB,UAAA,CAAW,MAAM,CAAA;AACtD,IAAA,MAAM,kBAAA,GACJC,iDAAA,CAAsC,gBAAA,CAAiB,YAAY,CAAA;AACrE,IAAA,OAAO,YAAA,CAAa,KAAA,CAAM,IAAA,EAAK,CAAE,IAAI,CAAA,WAAA,KAAe;AAClD,MAAA,MAAM,MAAA,GAAS,IAAI,cAAA,CAAe,WAAA,EAAa;AAAA,QAC7C,mBAAA;AAAA,QACA,mBAAA,EAAqB;AAAA,OACtB,CAAA;AACD,MAAA,MAAM,YAAY,CAAC,GAAA,KAAa,GAAA,CAAI,IAAA,KAAS,YAAY,MAAA,CAAO,IAAA;AAChE,MAAA,OAAO,EAAE,QAAQ,SAAA,EAAU;AAAA,IAC7B,CAAC,CAAA;AAAA,EACH,CAAA;AAAA,EAEiB,WAAA;AAAA,EACA,IAAA;AAAA,EAKjB,WAAA,CACE,aACA,IAAA,EAIA;AACA,IAAA,IAAA,CAAK,WAAA,GAAc,WAAA;AACnB,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;AAAA,EACd;AAAA,EAEA,MAAM,KAAK,GAAA,EAA8B;AACvC,IAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,OAAA,CAAQ,GAAG,CAAA;AACvC,IAAA,OAAO,SAAS,MAAA,EAAO;AAAA,EACzB;AAAA,EAEA,MAAM,OAAA,CACJ,GAAA,EACA,OAAA,EAC0C;AAE1C,IAAA,MAAM,EAAE,MAAA,EAAO,GAAI,OAAA,IAAW,EAAC;AAE/B,IAAA,MAAM,QAAA,GAAWC,iCAAqB,GAAG,CAAA;AACzC,IAAA,IAAI,QAAA;AACJ,IAAA,IAAI;AACF,MAAA,MAAM,WAAA,GAAc,MAAM,IAAA,CAAK,IAAA,CAAK,oBAAoB,cAAA,CAAe;AAAA,QACrE,GAAA,EAAK;AAAA,OACN,CAAA;AACD,MAAA,QAAA,GAAW,MAAM,MAAM,QAAA,EAAU;AAAA,QAC/B,SAAS,WAAA,EAAa,OAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,QAOtB,GAAI,MAAA,IAAU,EAAE,MAAA;AAAsB,OACvC,CAAA;AAAA,IACH,SAAS,CAAA,EAAG;AACV,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,eAAA,EAAkB,GAAG,CAAA,EAAA,EAAK,CAAC,CAAA,CAAE,CAAA;AAAA,IAC/C;AAGA,IAAA,IAAI,QAAA,CAAS,EAAA,IAAM,QAAA,CAAS,MAAA,KAAW,GAAA,EAAK;AAC1C,MAAA,OAAOC,6CAAA,CAAuB,aAAa,QAAQ,CAAA;AAAA,IACrD;AAEA,IAAA,MAAM,OAAA,GAAU,CAAA,EAAG,GAAG,CAAA,sBAAA,EAAyB,QAAQ,KAAK,QAAA,CAAS,MAAM,CAAA,CAAA,EAAI,QAAA,CAAS,UAAU,CAAA,CAAA;AAClG,IAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,MAAA,MAAM,IAAIC,qBAAc,OAAO,CAAA;AAAA,IACjC;AACA,IAAA,MAAM,IAAI,MAAM,OAAO,CAAA;AAAA,EACzB;AAAA,EAEA,MAAM,QAAA,CACJ,GAAA,EACA,OAAA,EAC2C;AAC3C,IAAA,MAAM,EAAE,IAAA,EAAM,MAAA,EAAQ,MAAA,EAAO,GAAI,WAAW,EAAC;AAM7C,IAAA,MAAM,WAAA,GAAc,MAAM,IAAA,CAAK,IAAA,CAAK,oBAAoB,cAAA,CAAe;AAAA,MACrE;AAAA,KACD,CAAA;AAED,IAAA,MAAM,oBAAA,GAAuB,MAAM,KAAA,CAAMC,8BAAA,CAAmB,GAAG,CAAA,EAAG;AAAA,MAChE,SAAS,WAAA,EAAa;AAAA,KACvB,CAAA;AACD,IAAA,IAAI,CAAC,qBAAqB,EAAA,EAAI;AAC5B,MAAA,MAAM,OAAA,GAAU,4BAA4B,GAAG,CAAA,EAAA,EAAK,qBAAqB,MAAM,CAAA,CAAA,EAAI,qBAAqB,UAAU,CAAA,CAAA;AAClH,MAAA,IAAI,oBAAA,CAAqB,WAAW,GAAA,EAAK;AACvC,QAAA,MAAM,IAAID,qBAAc,OAAO,CAAA;AAAA,MACjC;AACA,MAAA,MAAM,IAAI,MAAM,OAAO,CAAA;AAAA,IACzB;AAEA,IAAA,MAAM,aAAa,MAAM,oBAAA,CAAqB,MAAK,EAAG,KAAA,CAAM,CAAC,CAAA,CAAE,QAAA;AAC/D,IAAA,IAAI,IAAA,IAAQ,SAAS,SAAA,EAAW;AAC9B,MAAA,MAAM,IAAIE,uBAAA,EAAiB;AAAA,IAC7B;AAEA,IAAA,MAAM,oBAAA,GAAuB,MAAM,KAAA,CAAMC,+BAAA,CAAoB,GAAG,CAAA,EAAG;AAAA,MACjE,OAAA,EAAS;AAAA,QACP,GAAG,WAAA,EAAa,OAAA;AAAA,QAChB,MAAA,EAAQ;AAAA,OACV;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAOA,GAAI,MAAA,IAAU,EAAE,MAAA;AAAsB,KACvC,CAAA;AACD,IAAA,IAAI,CAAC,qBAAqB,EAAA,EAAI;AAC5B,MAAA,MAAM,OAAA,GAAU,4BAA4B,GAAG,CAAA,EAAA,EAAK,qBAAqB,MAAM,CAAA,CAAA,EAAI,qBAAqB,UAAU,CAAA,CAAA;AAClH,MAAA,IAAI,oBAAA,CAAqB,WAAW,GAAA,EAAK;AACvC,QAAA,MAAM,IAAIH,qBAAc,OAAO,CAAA;AAAA,MACjC;AACA,MAAA,MAAM,IAAI,MAAM,OAAO,CAAA;AAAA,IACzB;AAKA,IAAA,IAAI,OAAA;AACJ,IAAA,MAAM,OAAO,IAAI,GAAA,CAAI,GAAG,CAAA,CAAE,YAAA,CAAa,IAAI,MAAM,CAAA;AACjD,IAAA,IAAI,IAAA,EAAM;AACR,MAAA,OAAA,GAAU,IAAA,CAAK,KAAA,CAAM,GAAG,CAAA,CAAE,MAAA,CAAO,OAAO,CAAA,CAAE,KAAA,CAAM,EAAE,CAAA,CAAE,CAAC,CAAA;AAAA,IACvD;AAEA,IAAA,OAAO,MAAM,IAAA,CAAK,IAAA,CAAK,mBAAA,CAAoB,cAAA,CAAe;AAAA,MACxD,QAAA,EAAU,oBAAA;AAAA,MACV,IAAA,EAAM,SAAA;AAAA,MACN,MAAA;AAAA,MACA;AAAA,KACD,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,MAAA,CACJ,GAAA,EACA,OAAA,EACyC;AACzC,IAAA,MAAM,EAAE,QAAA,EAAS,GAAII,4BAAA,CAAY,GAAG,CAAA;AAGpC,IAAA,IAAI,CAAC,QAAA,EAAU,KAAA,CAAM,MAAM,CAAA,EAAG;AAC5B,MAAA,IAAI;AACF,QAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,OAAA,CAAQ,KAAK,OAAO,CAAA;AAE5C,QAAA,OAAO;AAAA,UACL,KAAA,EAAO;AAAA,YACL;AAAA,cACE,GAAA;AAAA,cACA,SAAS,IAAA,CAAK,MAAA;AAAA,cACd,gBAAgB,IAAA,CAAK;AAAA;AACvB,WACF;AAAA,UACA,IAAA,EAAM,KAAK,IAAA,IAAQ;AAAA,SACrB;AAAA,MACF,SAAS,CAAA,EAAG;AACV,QAAA,MAAM,KAAA,GAAQC,eAAQ,CAAC,CAAA;AACvB,QAAA,IAAI,KAAA,CAAM,SAAS,eAAA,EAAiB;AAClC,UAAA,OAAO;AAAA,YACL,OAAO,EAAC;AAAA,YACR,IAAA,EAAM;AAAA,WACR;AAAA,QACF;AACA,QAAA,MAAM,KAAA;AAAA,MACR;AAAA,IACF;AAEA,IAAA,MAAM,OAAA,GAAU,IAAI,GAAA,CAAI,GAAG,CAAA;AAE3B,IAAA,MAAM,IAAA,GAAO,OAAA,CAAQ,YAAA,CAAa,GAAA,CAAI,MAAM,CAAA;AAC5C,IAAA,MAAM,OAAA,GAAU,QAAQ,IAAIC,mBAAA,CAAU,KAAK,OAAA,CAAQ,MAAA,EAAQ,EAAE,CAAC,CAAA;AAM9D,IAAA,OAAA,CAAQ,YAAA,CAAa,OAAO,MAAM,CAAA;AAElC,IAAA,MAAM,OAAO,MAAM,IAAA,CAAK,QAAA,CAAS,OAAA,CAAQ,UAAS,EAAG;AAAA,MACnD,MAAM,OAAA,EAAS,IAAA;AAAA,MACf,QAAQ,OAAA,EAAS,MAAA;AAAA,MACjB,QAAQ,CAAA,CAAA,KAAM,OAAA,GAAU,OAAA,CAAQ,KAAA,CAAM,CAAC,CAAA,GAAI;AAAA,KAC5C,CAAA;AACD,IAAA,MAAM,KAAA,GAAQ,MAAM,IAAA,CAAK,KAAA,EAAM;AAE/B,IAAA,OAAO;AAAA,MACL,MAAM,IAAA,CAAK,IAAA;AAAA,MACX,KAAA,EAAO,KAAA,CAAM,GAAA,CAAI,CAAA,IAAA,MAAS;AAAA,QACxB,GAAA,EAAK,IAAA,CAAK,WAAA,CAAY,UAAA,CAAW;AAAA,UAC/B,GAAA,EAAK,CAAA,CAAA,EAAI,IAAA,CAAK,IAAI,CAAA,CAAA;AAAA,UAClB,IAAA,EAAM;AAAA,SACP,CAAA;AAAA,QACD,SAAS,IAAA,CAAK,OAAA;AAAA,QACd,gBAAgB,IAAA,CAAK;AAAA,OACvB,CAAE;AAAA,KACJ;AAAA,EACF;AAAA,EAEA,QAAA,GAAW;AACT,IAAA,MAAM,EAAE,IAAA,EAAM,WAAA,EAAY,GAAI,KAAK,WAAA,CAAY,MAAA;AAC/C,IAAA,OAAO,CAAA,WAAA,EAAc,IAAI,CAAA,QAAA,EAAW,OAAA;AAAA,MAClC,WAAA,KAAgB,MAAA,IAAa,WAAA,CAAY,MAAA,GAAS;AAAA,KACnD,CAAA,CAAA,CAAA;AAAA,EACH;AACF;;;;"}
|
|
1
|
+
{"version":3,"file":"AzureUrlReader.cjs.js","sources":["../../../../src/entrypoints/urlReader/lib/AzureUrlReader.ts"],"sourcesContent":["/*\n * Copyright 2020 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 UrlReaderService,\n UrlReaderServiceReadTreeOptions,\n UrlReaderServiceReadTreeResponse,\n UrlReaderServiceReadUrlOptions,\n UrlReaderServiceReadUrlResponse,\n UrlReaderServiceSearchOptions,\n UrlReaderServiceSearchResponse,\n} from '@backstage/backend-plugin-api';\nimport {\n getAzureCommitsUrl,\n getAzureDownloadUrl,\n getAzureFileFetchUrl,\n AzureDevOpsCredentialsProvider,\n DefaultAzureDevOpsCredentialsProvider,\n ScmIntegrations,\n AzureIntegration,\n} from '@backstage/integration';\nimport parseGitUrl from 'git-url-parse';\nimport { Minimatch } from 'minimatch';\nimport { toError, NotFoundError, NotModifiedError } from '@backstage/errors';\nimport { ReadTreeResponseFactory, ReaderFactory } from './types';\nimport { ReadUrlResponseFactory } from './ReadUrlResponseFactory';\n\n/**\n * Implements a {@link @backstage/backend-plugin-api#UrlReaderService} for Azure repos.\n *\n * @public\n */\nexport class AzureUrlReader implements UrlReaderService {\n static factory: ReaderFactory = ({ config, treeResponseFactory }) => {\n const integrations = ScmIntegrations.fromConfig(config);\n const credentialProvider =\n DefaultAzureDevOpsCredentialsProvider.fromIntegrations(integrations);\n return integrations.azure.list().map(integration => {\n const reader = new AzureUrlReader(integration, {\n treeResponseFactory,\n credentialsProvider: credentialProvider,\n });\n const predicate = (url: URL) => url.host === integration.config.host;\n return { reader, predicate };\n });\n };\n\n private readonly integration: AzureIntegration;\n private readonly deps: {\n treeResponseFactory: ReadTreeResponseFactory;\n credentialsProvider: AzureDevOpsCredentialsProvider;\n };\n\n constructor(\n integration: AzureIntegration,\n deps: {\n treeResponseFactory: ReadTreeResponseFactory;\n credentialsProvider: AzureDevOpsCredentialsProvider;\n },\n ) {\n this.integration = integration;\n this.deps = deps;\n }\n\n async read(url: string): Promise<Buffer> {\n const response = await this.readUrl(url);\n return response.buffer();\n }\n\n async readUrl(\n url: string,\n options?: UrlReaderServiceReadUrlOptions,\n ): Promise<UrlReaderServiceReadUrlResponse> {\n // TODO: etag is not implemented yet.\n const { signal } = options ?? {};\n\n const builtUrl = getAzureFileFetchUrl(url);\n let response: Response;\n try {\n const credentials = await this.deps.credentialsProvider.getCredentials({\n url: builtUrl,\n });\n response = await fetch(builtUrl, {\n headers: credentials?.headers,\n // TODO(freben): The signal cast is there because pre-3.x versions of\n // node-fetch have a very slightly deviating AbortSignal type signature.\n // The difference does not affect us in practice however. The cast can\n // be removed after we support ESM for CLI dependencies and migrate to\n // version 3 of node-fetch.\n // https://github.com/backstage/backstage/issues/8242\n ...(signal && { signal: signal as any }),\n });\n } catch (e) {\n throw new Error(`Unable to read ${url}, ${e}`);\n }\n\n // for private repos when PAT is not valid, Azure API returns a http status code 203 with sign in page html\n if (response.ok && response.status !== 203) {\n return ReadUrlResponseFactory.fromResponse(response);\n }\n\n const message = `${url} could not be read as ${builtUrl}, ${response.status} ${response.statusText}`;\n if (response.status === 404) {\n throw new NotFoundError(message);\n }\n throw new Error(message);\n }\n\n async readTree(\n url: string,\n options?: UrlReaderServiceReadTreeOptions,\n ): Promise<UrlReaderServiceReadTreeResponse> {\n const { etag, filter, signal } = options ?? {};\n\n // TODO: Support filepath based reading tree feature like other providers\n\n // Get latest commit SHA\n\n const credentials = await this.deps.credentialsProvider.getCredentials({\n url: url,\n });\n\n const commitsAzureResponse = await fetch(getAzureCommitsUrl(url), {\n headers: credentials?.headers,\n // TODO(freben): The signal cast is there because pre-3.x versions of\n // node-fetch have a very slightly deviating AbortSignal type signature.\n // The difference does not affect us in practice however. The cast can be\n // removed after we support ESM for CLI dependencies and migrate to\n // version 3 of node-fetch.\n // https://github.com/backstage/backstage/issues/8242\n ...(signal && { signal: signal as any }),\n });\n if (!commitsAzureResponse.ok) {\n const message = `Failed to read tree from ${url}, ${commitsAzureResponse.status} ${commitsAzureResponse.statusText}`;\n if (commitsAzureResponse.status === 404) {\n throw new NotFoundError(message);\n }\n throw new Error(message);\n }\n\n const commitSha = (await commitsAzureResponse.json()).value[0].commitId;\n if (etag && etag === commitSha) {\n throw new NotModifiedError();\n }\n\n const archiveAzureResponse = await fetch(getAzureDownloadUrl(url), {\n headers: {\n ...credentials?.headers,\n Accept: 'application/zip',\n },\n // TODO(freben): The signal cast is there because pre-3.x versions of\n // node-fetch have a very slightly deviating AbortSignal type signature.\n // The difference does not affect us in practice however. The cast can be\n // removed after we support ESM for CLI dependencies and migrate to\n // version 3 of node-fetch.\n // https://github.com/backstage/backstage/issues/8242\n ...(signal && { signal: signal as any }),\n });\n if (!archiveAzureResponse.ok) {\n const message = `Failed to read tree from ${url}, ${archiveAzureResponse.status} ${archiveAzureResponse.statusText}`;\n if (archiveAzureResponse.status === 404) {\n throw new NotFoundError(message);\n }\n throw new Error(message);\n }\n\n // When downloading a zip archive from azure on a subpath we get an extra directory\n // layer added at the top. With for example the file /a/b/c.txt and a download of\n // /a/b, we'll see /b/c.txt in the zip archive. This picks out /b so that we can remove it.\n let subpath;\n const path = new URL(url).searchParams.get('path');\n if (path) {\n subpath = path.split('/').filter(Boolean).slice(-1)[0];\n }\n\n return await this.deps.treeResponseFactory.fromZipArchive({\n response: archiveAzureResponse,\n etag: commitSha,\n filter,\n subpath,\n });\n }\n\n async search(\n url: string,\n options?: UrlReaderServiceSearchOptions,\n ): Promise<UrlReaderServiceSearchResponse> {\n const { filepath } = parseGitUrl(url);\n\n // If it's a direct URL we use readUrl instead\n if (!filepath?.match(/[*?]/)) {\n try {\n const data = await this.readUrl(url, options);\n\n return {\n files: [\n {\n url: url,\n content: data.buffer,\n lastModifiedAt: data.lastModifiedAt,\n },\n ],\n etag: data.etag ?? '',\n };\n } catch (e) {\n const error = toError(e);\n if (error.name === 'NotFoundError') {\n return {\n files: [],\n etag: '',\n };\n }\n throw error;\n }\n }\n\n const treeUrl = new URL(url);\n\n const path = treeUrl.searchParams.get('path');\n const matcher = path && new Minimatch(path.replace(/^\\/+/, ''));\n\n // TODO(freben): For now, read the entire repo and filter through that. In\n // a future improvement, we could be smart and try to deduce that non-glob\n // prefixes (like for filepaths such as some-prefix/**/a.yaml) can be used\n // to get just that part of the repo.\n treeUrl.searchParams.delete('path');\n\n const tree = await this.readTree(treeUrl.toString(), {\n etag: options?.etag,\n signal: options?.signal,\n filter: p => (matcher ? matcher.match(p) : true),\n });\n const files = await tree.files();\n\n return {\n etag: tree.etag,\n files: files.map(file => ({\n url: this.integration.resolveUrl({\n url: `/${file.path}`,\n base: url,\n }),\n content: file.content,\n lastModifiedAt: file.lastModifiedAt,\n })),\n };\n }\n\n toString() {\n const { host, credentials } = this.integration.config;\n return `azure{host=${host},authed=${Boolean(\n credentials !== undefined && credentials.length > 0,\n )}}`;\n }\n}\n"],"names":["ScmIntegrations","DefaultAzureDevOpsCredentialsProvider","getAzureFileFetchUrl","ReadUrlResponseFactory","NotFoundError","getAzureCommitsUrl","NotModifiedError","getAzureDownloadUrl","parseGitUrl","toError","Minimatch"],"mappings":";;;;;;;;;;;;AA6CO,MAAM,cAAA,CAA2C;AAAA,EACtD,OAAO,OAAA,GAAyB,CAAC,EAAE,MAAA,EAAQ,qBAAoB,KAAM;AACnE,IAAA,MAAM,YAAA,GAAeA,2BAAA,CAAgB,UAAA,CAAW,MAAM,CAAA;AACtD,IAAA,MAAM,kBAAA,GACJC,iDAAA,CAAsC,gBAAA,CAAiB,YAAY,CAAA;AACrE,IAAA,OAAO,YAAA,CAAa,KAAA,CAAM,IAAA,EAAK,CAAE,IAAI,CAAA,WAAA,KAAe;AAClD,MAAA,MAAM,MAAA,GAAS,IAAI,cAAA,CAAe,WAAA,EAAa;AAAA,QAC7C,mBAAA;AAAA,QACA,mBAAA,EAAqB;AAAA,OACtB,CAAA;AACD,MAAA,MAAM,YAAY,CAAC,GAAA,KAAa,GAAA,CAAI,IAAA,KAAS,YAAY,MAAA,CAAO,IAAA;AAChE,MAAA,OAAO,EAAE,QAAQ,SAAA,EAAU;AAAA,IAC7B,CAAC,CAAA;AAAA,EACH,CAAA;AAAA,EAEiB,WAAA;AAAA,EACA,IAAA;AAAA,EAKjB,WAAA,CACE,aACA,IAAA,EAIA;AACA,IAAA,IAAA,CAAK,WAAA,GAAc,WAAA;AACnB,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;AAAA,EACd;AAAA,EAEA,MAAM,KAAK,GAAA,EAA8B;AACvC,IAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,OAAA,CAAQ,GAAG,CAAA;AACvC,IAAA,OAAO,SAAS,MAAA,EAAO;AAAA,EACzB;AAAA,EAEA,MAAM,OAAA,CACJ,GAAA,EACA,OAAA,EAC0C;AAE1C,IAAA,MAAM,EAAE,MAAA,EAAO,GAAI,OAAA,IAAW,EAAC;AAE/B,IAAA,MAAM,QAAA,GAAWC,iCAAqB,GAAG,CAAA;AACzC,IAAA,IAAI,QAAA;AACJ,IAAA,IAAI;AACF,MAAA,MAAM,WAAA,GAAc,MAAM,IAAA,CAAK,IAAA,CAAK,oBAAoB,cAAA,CAAe;AAAA,QACrE,GAAA,EAAK;AAAA,OACN,CAAA;AACD,MAAA,QAAA,GAAW,MAAM,MAAM,QAAA,EAAU;AAAA,QAC/B,SAAS,WAAA,EAAa,OAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,QAOtB,GAAI,MAAA,IAAU,EAAE,MAAA;AAAsB,OACvC,CAAA;AAAA,IACH,SAAS,CAAA,EAAG;AACV,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,eAAA,EAAkB,GAAG,CAAA,EAAA,EAAK,CAAC,CAAA,CAAE,CAAA;AAAA,IAC/C;AAGA,IAAA,IAAI,QAAA,CAAS,EAAA,IAAM,QAAA,CAAS,MAAA,KAAW,GAAA,EAAK;AAC1C,MAAA,OAAOC,6CAAA,CAAuB,aAAa,QAAQ,CAAA;AAAA,IACrD;AAEA,IAAA,MAAM,OAAA,GAAU,CAAA,EAAG,GAAG,CAAA,sBAAA,EAAyB,QAAQ,KAAK,QAAA,CAAS,MAAM,CAAA,CAAA,EAAI,QAAA,CAAS,UAAU,CAAA,CAAA;AAClG,IAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,MAAA,MAAM,IAAIC,qBAAc,OAAO,CAAA;AAAA,IACjC;AACA,IAAA,MAAM,IAAI,MAAM,OAAO,CAAA;AAAA,EACzB;AAAA,EAEA,MAAM,QAAA,CACJ,GAAA,EACA,OAAA,EAC2C;AAC3C,IAAA,MAAM,EAAE,IAAA,EAAM,MAAA,EAAQ,MAAA,EAAO,GAAI,WAAW,EAAC;AAM7C,IAAA,MAAM,WAAA,GAAc,MAAM,IAAA,CAAK,IAAA,CAAK,oBAAoB,cAAA,CAAe;AAAA,MACrE;AAAA,KACD,CAAA;AAED,IAAA,MAAM,oBAAA,GAAuB,MAAM,KAAA,CAAMC,8BAAA,CAAmB,GAAG,CAAA,EAAG;AAAA,MAChE,SAAS,WAAA,EAAa,OAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAOtB,GAAI,MAAA,IAAU,EAAE,MAAA;AAAsB,KACvC,CAAA;AACD,IAAA,IAAI,CAAC,qBAAqB,EAAA,EAAI;AAC5B,MAAA,MAAM,OAAA,GAAU,4BAA4B,GAAG,CAAA,EAAA,EAAK,qBAAqB,MAAM,CAAA,CAAA,EAAI,qBAAqB,UAAU,CAAA,CAAA;AAClH,MAAA,IAAI,oBAAA,CAAqB,WAAW,GAAA,EAAK;AACvC,QAAA,MAAM,IAAID,qBAAc,OAAO,CAAA;AAAA,MACjC;AACA,MAAA,MAAM,IAAI,MAAM,OAAO,CAAA;AAAA,IACzB;AAEA,IAAA,MAAM,aAAa,MAAM,oBAAA,CAAqB,MAAK,EAAG,KAAA,CAAM,CAAC,CAAA,CAAE,QAAA;AAC/D,IAAA,IAAI,IAAA,IAAQ,SAAS,SAAA,EAAW;AAC9B,MAAA,MAAM,IAAIE,uBAAA,EAAiB;AAAA,IAC7B;AAEA,IAAA,MAAM,oBAAA,GAAuB,MAAM,KAAA,CAAMC,+BAAA,CAAoB,GAAG,CAAA,EAAG;AAAA,MACjE,OAAA,EAAS;AAAA,QACP,GAAG,WAAA,EAAa,OAAA;AAAA,QAChB,MAAA,EAAQ;AAAA,OACV;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAOA,GAAI,MAAA,IAAU,EAAE,MAAA;AAAsB,KACvC,CAAA;AACD,IAAA,IAAI,CAAC,qBAAqB,EAAA,EAAI;AAC5B,MAAA,MAAM,OAAA,GAAU,4BAA4B,GAAG,CAAA,EAAA,EAAK,qBAAqB,MAAM,CAAA,CAAA,EAAI,qBAAqB,UAAU,CAAA,CAAA;AAClH,MAAA,IAAI,oBAAA,CAAqB,WAAW,GAAA,EAAK;AACvC,QAAA,MAAM,IAAIH,qBAAc,OAAO,CAAA;AAAA,MACjC;AACA,MAAA,MAAM,IAAI,MAAM,OAAO,CAAA;AAAA,IACzB;AAKA,IAAA,IAAI,OAAA;AACJ,IAAA,MAAM,OAAO,IAAI,GAAA,CAAI,GAAG,CAAA,CAAE,YAAA,CAAa,IAAI,MAAM,CAAA;AACjD,IAAA,IAAI,IAAA,EAAM;AACR,MAAA,OAAA,GAAU,IAAA,CAAK,KAAA,CAAM,GAAG,CAAA,CAAE,MAAA,CAAO,OAAO,CAAA,CAAE,KAAA,CAAM,EAAE,CAAA,CAAE,CAAC,CAAA;AAAA,IACvD;AAEA,IAAA,OAAO,MAAM,IAAA,CAAK,IAAA,CAAK,mBAAA,CAAoB,cAAA,CAAe;AAAA,MACxD,QAAA,EAAU,oBAAA;AAAA,MACV,IAAA,EAAM,SAAA;AAAA,MACN,MAAA;AAAA,MACA;AAAA,KACD,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,MAAA,CACJ,GAAA,EACA,OAAA,EACyC;AACzC,IAAA,MAAM,EAAE,QAAA,EAAS,GAAII,4BAAA,CAAY,GAAG,CAAA;AAGpC,IAAA,IAAI,CAAC,QAAA,EAAU,KAAA,CAAM,MAAM,CAAA,EAAG;AAC5B,MAAA,IAAI;AACF,QAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,OAAA,CAAQ,KAAK,OAAO,CAAA;AAE5C,QAAA,OAAO;AAAA,UACL,KAAA,EAAO;AAAA,YACL;AAAA,cACE,GAAA;AAAA,cACA,SAAS,IAAA,CAAK,MAAA;AAAA,cACd,gBAAgB,IAAA,CAAK;AAAA;AACvB,WACF;AAAA,UACA,IAAA,EAAM,KAAK,IAAA,IAAQ;AAAA,SACrB;AAAA,MACF,SAAS,CAAA,EAAG;AACV,QAAA,MAAM,KAAA,GAAQC,eAAQ,CAAC,CAAA;AACvB,QAAA,IAAI,KAAA,CAAM,SAAS,eAAA,EAAiB;AAClC,UAAA,OAAO;AAAA,YACL,OAAO,EAAC;AAAA,YACR,IAAA,EAAM;AAAA,WACR;AAAA,QACF;AACA,QAAA,MAAM,KAAA;AAAA,MACR;AAAA,IACF;AAEA,IAAA,MAAM,OAAA,GAAU,IAAI,GAAA,CAAI,GAAG,CAAA;AAE3B,IAAA,MAAM,IAAA,GAAO,OAAA,CAAQ,YAAA,CAAa,GAAA,CAAI,MAAM,CAAA;AAC5C,IAAA,MAAM,OAAA,GAAU,QAAQ,IAAIC,mBAAA,CAAU,KAAK,OAAA,CAAQ,MAAA,EAAQ,EAAE,CAAC,CAAA;AAM9D,IAAA,OAAA,CAAQ,YAAA,CAAa,OAAO,MAAM,CAAA;AAElC,IAAA,MAAM,OAAO,MAAM,IAAA,CAAK,QAAA,CAAS,OAAA,CAAQ,UAAS,EAAG;AAAA,MACnD,MAAM,OAAA,EAAS,IAAA;AAAA,MACf,QAAQ,OAAA,EAAS,MAAA;AAAA,MACjB,QAAQ,CAAA,CAAA,KAAM,OAAA,GAAU,OAAA,CAAQ,KAAA,CAAM,CAAC,CAAA,GAAI;AAAA,KAC5C,CAAA;AACD,IAAA,MAAM,KAAA,GAAQ,MAAM,IAAA,CAAK,KAAA,EAAM;AAE/B,IAAA,OAAO;AAAA,MACL,MAAM,IAAA,CAAK,IAAA;AAAA,MACX,KAAA,EAAO,KAAA,CAAM,GAAA,CAAI,CAAA,IAAA,MAAS;AAAA,QACxB,GAAA,EAAK,IAAA,CAAK,WAAA,CAAY,UAAA,CAAW;AAAA,UAC/B,GAAA,EAAK,CAAA,CAAA,EAAI,IAAA,CAAK,IAAI,CAAA,CAAA;AAAA,UAClB,IAAA,EAAM;AAAA,SACP,CAAA;AAAA,QACD,SAAS,IAAA,CAAK,OAAA;AAAA,QACd,gBAAgB,IAAA,CAAK;AAAA,OACvB,CAAE;AAAA,KACJ;AAAA,EACF;AAAA,EAEA,QAAA,GAAW;AACT,IAAA,MAAM,EAAE,IAAA,EAAM,WAAA,EAAY,GAAI,KAAK,WAAA,CAAY,MAAA;AAC/C,IAAA,OAAO,CAAA,WAAA,EAAc,IAAI,CAAA,QAAA,EAAW,OAAA;AAAA,MAClC,WAAA,KAAgB,MAAA,IAAa,WAAA,CAAY,MAAA,GAAS;AAAA,KACnD,CAAA,CAAA,CAAA;AAAA,EACH;AACF;;;;"}
|
package/dist/package.json.cjs.js
CHANGED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var rootSystemMetadataServiceFactory = require('./entrypoints/rootSystemMetadata/rootSystemMetadataServiceFactory.cjs.js');
|
|
4
|
+
var DefaultRootSystemMetadataService = require('./entrypoints/rootSystemMetadata/lib/DefaultRootSystemMetadataService.cjs.js');
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
exports.rootSystemMetadataServiceFactory = rootSystemMetadataServiceFactory.rootSystemMetadataServiceFactory;
|
|
9
|
+
exports.DefaultRootSystemMetadataService = DefaultRootSystemMetadataService.DefaultRootSystemMetadataService;
|
|
10
|
+
//# sourceMappingURL=rootSystemMetadata.cjs.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"rootSystemMetadata.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;"}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
|
|
2
|
+
import { RootSystemMetadataService, LoggerService, RootConfigService, RootInstanceMetadataService, RootSystemMetadataServicePluginInfo } from '@backstage/backend-plugin-api';
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Metadata about an entire Backstage system, a collection of Backstage instances.
|
|
6
|
+
*
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
declare const rootSystemMetadataServiceFactory: _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.RootSystemMetadataService, "root", "singleton">;
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* @public
|
|
13
|
+
*/
|
|
14
|
+
declare class DefaultRootSystemMetadataService implements RootSystemMetadataService {
|
|
15
|
+
#private;
|
|
16
|
+
constructor(options: {
|
|
17
|
+
logger: LoggerService;
|
|
18
|
+
config: RootConfigService;
|
|
19
|
+
instanceMetadata: RootInstanceMetadataService;
|
|
20
|
+
});
|
|
21
|
+
static create(pluginEnv: {
|
|
22
|
+
logger: LoggerService;
|
|
23
|
+
config: RootConfigService;
|
|
24
|
+
instanceMetadata: RootInstanceMetadataService;
|
|
25
|
+
}): DefaultRootSystemMetadataService;
|
|
26
|
+
getInstalledPlugins(): Promise<RootSystemMetadataServicePluginInfo[]>;
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
export { DefaultRootSystemMetadataService, rootSystemMetadataServiceFactory };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/backend-defaults",
|
|
3
|
-
"version": "0.17.
|
|
3
|
+
"version": "0.17.6-next.0",
|
|
4
4
|
"description": "Backend defaults used by Backstage backend apps",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "node-library"
|
|
@@ -104,6 +104,11 @@
|
|
|
104
104
|
"types": "./dist/rootLogger.d.ts",
|
|
105
105
|
"default": "./dist/rootLogger.cjs.js"
|
|
106
106
|
},
|
|
107
|
+
"./rootSystemMetadata": {
|
|
108
|
+
"require": "./dist/rootSystemMetadata.cjs.js",
|
|
109
|
+
"types": "./dist/rootSystemMetadata.d.ts",
|
|
110
|
+
"default": "./dist/rootSystemMetadata.cjs.js"
|
|
111
|
+
},
|
|
107
112
|
"./scheduler": {
|
|
108
113
|
"require": "./dist/scheduler.cjs.js",
|
|
109
114
|
"types": "./dist/scheduler.d.ts",
|
|
@@ -178,6 +183,9 @@
|
|
|
178
183
|
"rootLogger": [
|
|
179
184
|
"dist/rootLogger.d.ts"
|
|
180
185
|
],
|
|
186
|
+
"rootSystemMetadata": [
|
|
187
|
+
"dist/rootSystemMetadata.d.ts"
|
|
188
|
+
],
|
|
181
189
|
"scheduler": [
|
|
182
190
|
"dist/scheduler.d.ts"
|
|
183
191
|
],
|
|
@@ -218,20 +226,20 @@
|
|
|
218
226
|
"@aws-sdk/types": "^3.347.0",
|
|
219
227
|
"@azure/identity": "^4.0.0",
|
|
220
228
|
"@azure/storage-blob": "^12.5.0",
|
|
221
|
-
"@backstage/backend-app-api": "
|
|
222
|
-
"@backstage/backend-dev-utils": "
|
|
223
|
-
"@backstage/backend-plugin-api": "
|
|
224
|
-
"@backstage/cli-node": "
|
|
225
|
-
"@backstage/config": "
|
|
226
|
-
"@backstage/config-loader": "
|
|
227
|
-
"@backstage/errors": "
|
|
228
|
-
"@backstage/integration": "
|
|
229
|
-
"@backstage/integration-aws-node": "
|
|
230
|
-
"@backstage/plugin-auth-node": "
|
|
231
|
-
"@backstage/plugin-events-node": "
|
|
232
|
-
"@backstage/plugin-permission-common": "
|
|
233
|
-
"@backstage/plugin-permission-node": "
|
|
234
|
-
"@backstage/types": "
|
|
229
|
+
"@backstage/backend-app-api": "1.7.3-next.0",
|
|
230
|
+
"@backstage/backend-dev-utils": "0.1.7",
|
|
231
|
+
"@backstage/backend-plugin-api": "1.10.0-next.0",
|
|
232
|
+
"@backstage/cli-node": "0.3.4",
|
|
233
|
+
"@backstage/config": "1.3.8",
|
|
234
|
+
"@backstage/config-loader": "1.11.0",
|
|
235
|
+
"@backstage/errors": "1.3.1",
|
|
236
|
+
"@backstage/integration": "2.0.3",
|
|
237
|
+
"@backstage/integration-aws-node": "0.2.0",
|
|
238
|
+
"@backstage/plugin-auth-node": "0.7.4-next.0",
|
|
239
|
+
"@backstage/plugin-events-node": "0.4.25-next.0",
|
|
240
|
+
"@backstage/plugin-permission-common": "0.9.9",
|
|
241
|
+
"@backstage/plugin-permission-node": "0.11.3-next.0",
|
|
242
|
+
"@backstage/types": "1.2.2",
|
|
235
243
|
"@google-cloud/storage": "^7.0.0",
|
|
236
244
|
"@keyv/memcache": "^2.0.1",
|
|
237
245
|
"@keyv/redis": "^4.0.1",
|
|
@@ -286,8 +294,8 @@
|
|
|
286
294
|
},
|
|
287
295
|
"devDependencies": {
|
|
288
296
|
"@aws-sdk/util-stream-node": "^3.350.0",
|
|
289
|
-
"@backstage/backend-test-utils": "
|
|
290
|
-
"@backstage/cli": "
|
|
297
|
+
"@backstage/backend-test-utils": "1.11.6-next.0",
|
|
298
|
+
"@backstage/cli": "0.36.4",
|
|
291
299
|
"@google-cloud/cloud-sql-connector": "^1.4.0",
|
|
292
300
|
"@types/archiver": "^7.0.0",
|
|
293
301
|
"@types/base64-stream": "^1.0.2",
|
package/dist/alpha/entrypoints/rootSystemMetadata/lib/DefaultRootSystemMetadataService.cjs.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"DefaultRootSystemMetadataService.cjs.js","sources":["../../../../../src/alpha/entrypoints/rootSystemMetadata/lib/DefaultRootSystemMetadataService.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 LoggerService,\n RootConfigService,\n RootInstanceMetadataService,\n} from '@backstage/backend-plugin-api';\nimport {\n RootSystemMetadataService,\n RootSystemMetadataServicePluginInfo,\n} from '@backstage/backend-plugin-api/alpha';\nimport { getEndpoints } from '../../../../entrypoints/discovery/parsing';\nimport { Config } from '@backstage/config';\n\nfunction getPlugins(config: Config): string[] {\n const endpoints = getEndpoints(config);\n return Array.from(new Set(endpoints.flatMap(endpoint => endpoint.plugins)));\n}\n\n/**\n * @alpha\n */\nexport class DefaultRootSystemMetadataService\n implements RootSystemMetadataService\n{\n #plugins: string[];\n #instanceMetadata: RootInstanceMetadataService;\n constructor(options: {\n logger: LoggerService;\n config: RootConfigService;\n instanceMetadata: RootInstanceMetadataService;\n }) {\n const { config } = options;\n this.#plugins = getPlugins(config);\n config.subscribe?.(() => {\n this.#plugins = getPlugins(config);\n });\n this.#instanceMetadata = options.instanceMetadata;\n }\n\n public static create(pluginEnv: {\n logger: LoggerService;\n config: RootConfigService;\n instanceMetadata: RootInstanceMetadataService;\n }) {\n return new DefaultRootSystemMetadataService(pluginEnv);\n }\n\n public async getInstalledPlugins(): Promise<\n RootSystemMetadataServicePluginInfo[]\n > {\n const plugins = this.#plugins.map(pluginId => ({ pluginId }));\n\n for (const plugin of await this.#instanceMetadata.getInstalledPlugins()) {\n plugins.push({ pluginId: plugin.pluginId });\n }\n\n return plugins;\n }\n}\n"],"names":["getEndpoints"],"mappings":";;;;AA4BA,SAAS,WAAW,MAAA,EAA0B;AAC5C,EAAA,MAAM,SAAA,GAAYA,qBAAa,MAAM,CAAA;AACrC,EAAA,OAAO,KAAA,CAAM,IAAA,CAAK,IAAI,GAAA,CAAI,SAAA,CAAU,QAAQ,CAAA,QAAA,KAAY,QAAA,CAAS,OAAO,CAAC,CAAC,CAAA;AAC5E;AAKO,MAAM,gCAAA,CAEb;AAAA,EACE,QAAA;AAAA,EACA,iBAAA;AAAA,EACA,YAAY,OAAA,EAIT;AACD,IAAA,MAAM,EAAE,QAAO,GAAI,OAAA;AACnB,IAAA,IAAA,CAAK,QAAA,GAAW,WAAW,MAAM,CAAA;AACjC,IAAA,MAAA,CAAO,YAAY,MAAM;AACvB,MAAA,IAAA,CAAK,QAAA,GAAW,WAAW,MAAM,CAAA;AAAA,IACnC,CAAC,CAAA;AACD,IAAA,IAAA,CAAK,oBAAoB,OAAA,CAAQ,gBAAA;AAAA,EACnC;AAAA,EAEA,OAAc,OAAO,SAAA,EAIlB;AACD,IAAA,OAAO,IAAI,iCAAiC,SAAS,CAAA;AAAA,EACvD;AAAA,EAEA,MAAa,mBAAA,GAEX;AACA,IAAA,MAAM,UAAU,IAAA,CAAK,QAAA,CAAS,IAAI,CAAA,QAAA,MAAa,EAAE,UAAS,CAAE,CAAA;AAE5D,IAAA,KAAA,MAAW,MAAA,IAAU,MAAM,IAAA,CAAK,iBAAA,CAAkB,qBAAoB,EAAG;AACvE,MAAA,OAAA,CAAQ,IAAA,CAAK,EAAE,QAAA,EAAU,MAAA,CAAO,UAAU,CAAA;AAAA,IAC5C;AAEA,IAAA,OAAO,OAAA;AAAA,EACT;AACF;;;;"}
|
package/dist/alpha/entrypoints/rootSystemMetadata/rootSystemMetadataServiceFactory.cjs.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"rootSystemMetadataServiceFactory.cjs.js","sources":["../../../../src/alpha/entrypoints/rootSystemMetadata/rootSystemMetadataServiceFactory.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 createServiceFactory,\n} from '@backstage/backend-plugin-api';\nimport { DefaultRootSystemMetadataService } from './lib/DefaultRootSystemMetadataService';\nimport { rootSystemMetadataServiceRef } from '@backstage/backend-plugin-api/alpha';\n\n/**\n * Metadata about an entire Backstage system, a collection of Backstage instances.\n *\n * @alpha\n */\nexport const rootSystemMetadataServiceFactory = createServiceFactory({\n service: rootSystemMetadataServiceRef,\n deps: {\n logger: coreServices.rootLogger,\n config: coreServices.rootConfig,\n instanceMetadata: coreServices.rootInstanceMetadata,\n },\n async factory({ logger, config, instanceMetadata }) {\n return DefaultRootSystemMetadataService.create({\n logger,\n config,\n instanceMetadata,\n });\n },\n});\n"],"names":["createServiceFactory","rootSystemMetadataServiceRef","coreServices","DefaultRootSystemMetadataService"],"mappings":";;;;;;AA4BO,MAAM,mCAAmCA,qCAAA,CAAqB;AAAA,EACnE,OAAA,EAASC,kCAAA;AAAA,EACT,IAAA,EAAM;AAAA,IACJ,QAAQC,6BAAA,CAAa,UAAA;AAAA,IACrB,QAAQA,6BAAA,CAAa,UAAA;AAAA,IACrB,kBAAkBA,6BAAA,CAAa;AAAA,GACjC;AAAA,EACA,MAAM,OAAA,CAAQ,EAAE,MAAA,EAAQ,MAAA,EAAQ,kBAAiB,EAAG;AAClD,IAAA,OAAOC,kEAAiC,MAAA,CAAO;AAAA,MAC7C,MAAA;AAAA,MACA,MAAA;AAAA,MACA;AAAA,KACD,CAAA;AAAA,EACH;AACF,CAAC;;;;"}
|