@backstage/backend-defaults 0.15.2-next.1 → 0.15.3-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 +47 -0
- package/config.d.ts +34 -0
- package/dist/CreateBackend.cjs.js +1 -0
- package/dist/CreateBackend.cjs.js.map +1 -1
- package/dist/alpha/entrypoints/metrics/DefaultMetricsService.cjs.js +45 -0
- package/dist/alpha/entrypoints/metrics/DefaultMetricsService.cjs.js.map +1 -0
- package/dist/alpha/entrypoints/metrics/metricsServiceFactory.cjs.js +27 -0
- package/dist/alpha/entrypoints/metrics/metricsServiceFactory.cjs.js.map +1 -0
- package/dist/alpha.cjs.js +2 -0
- package/dist/alpha.cjs.js.map +1 -1
- package/dist/alpha.d.ts +8 -1
- package/dist/entrypoints/httpRouter/http/createRateLimitMiddleware.cjs.js.map +1 -1
- package/dist/entrypoints/httpRouter/httpRouterServiceFactory.cjs.js +1 -1
- package/dist/entrypoints/urlReader/lib/GitlabUrlReader.cjs.js +31 -62
- package/dist/entrypoints/urlReader/lib/GitlabUrlReader.cjs.js.map +1 -1
- package/dist/httpRouter.cjs.js +2 -0
- package/dist/httpRouter.cjs.js.map +1 -1
- package/dist/httpRouter.d.ts +10 -1
- package/dist/package.json.cjs.js +1 -1
- package/dist/urlReader.d.ts +0 -1
- package/package.json +15 -15
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,52 @@
|
|
|
1
1
|
# @backstage/backend-defaults
|
|
2
2
|
|
|
3
|
+
## 0.15.3-next.0
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 6738cf0: build(deps): bump `minimatch` from 9.0.5 to 10.2.1
|
|
8
|
+
- d933f62: Add configurable throttling and retry mechanism for GitLab integration.
|
|
9
|
+
- b99158a: Fixed `yarn backstage-cli config:check --strict --config app-config.yaml` config validation error by adding
|
|
10
|
+
an optional `default` type discriminator to PostgreSQL connection configuration,
|
|
11
|
+
allowing `config:check` to properly validate `default` connection configurations.
|
|
12
|
+
- 1ee5b28: Adds an alpha `MetricsService` to provide a unified interface for metrics instrumentation across Backstage plugins.
|
|
13
|
+
- Updated dependencies
|
|
14
|
+
- @backstage/cli-node@0.2.19-next.0
|
|
15
|
+
- @backstage/integration@1.21.0-next.0
|
|
16
|
+
- @backstage/config-loader@1.10.9-next.0
|
|
17
|
+
- @backstage/backend-plugin-api@1.7.1-next.0
|
|
18
|
+
- @backstage/backend-app-api@1.5.1-next.0
|
|
19
|
+
- @backstage/backend-dev-utils@0.1.7
|
|
20
|
+
- @backstage/config@1.3.6
|
|
21
|
+
- @backstage/errors@1.2.7
|
|
22
|
+
- @backstage/integration-aws-node@0.1.20
|
|
23
|
+
- @backstage/types@1.2.2
|
|
24
|
+
- @backstage/plugin-auth-node@0.6.14-next.0
|
|
25
|
+
- @backstage/plugin-events-node@0.4.20-next.0
|
|
26
|
+
- @backstage/plugin-permission-node@0.10.11-next.0
|
|
27
|
+
|
|
28
|
+
## 0.15.2
|
|
29
|
+
|
|
30
|
+
### Patch Changes
|
|
31
|
+
|
|
32
|
+
- 7455dae: Use node prefix on native imports
|
|
33
|
+
- 44f5d04: Minor internal restructure of the postgres config loading code
|
|
34
|
+
- 4fc7bf0: Bump to tar v7
|
|
35
|
+
- 5dd683f: `createRateLimitMiddleware` is now exported from `@backstage/backend-defaults/httpRouter`
|
|
36
|
+
- 8dd518a: Support `connection.type: azure` in database client to use Microsoft Entra authentication with Azure database for PostgreSQL
|
|
37
|
+
- 69d880e: Bump to latest zod to ensure it has the latest features
|
|
38
|
+
- Updated dependencies
|
|
39
|
+
- @backstage/backend-app-api@1.5.0
|
|
40
|
+
- @backstage/integration@1.20.0
|
|
41
|
+
- @backstage/integration-aws-node@0.1.20
|
|
42
|
+
- @backstage/backend-plugin-api@1.7.0
|
|
43
|
+
- @backstage/backend-dev-utils@0.1.7
|
|
44
|
+
- @backstage/config-loader@1.10.8
|
|
45
|
+
- @backstage/cli-node@0.2.18
|
|
46
|
+
- @backstage/plugin-auth-node@0.6.13
|
|
47
|
+
- @backstage/plugin-permission-node@0.10.10
|
|
48
|
+
- @backstage/plugin-events-node@0.4.19
|
|
49
|
+
|
|
3
50
|
## 0.15.2-next.1
|
|
4
51
|
|
|
5
52
|
### Patch Changes
|
package/config.d.ts
CHANGED
|
@@ -633,6 +633,10 @@ export interface Config {
|
|
|
633
633
|
ipAddressType?: 'PUBLIC' | 'PRIVATE' | 'PSC';
|
|
634
634
|
}
|
|
635
635
|
| {
|
|
636
|
+
/**
|
|
637
|
+
* The rest config for default, regular connections
|
|
638
|
+
*/
|
|
639
|
+
type?: 'default';
|
|
636
640
|
/**
|
|
637
641
|
* Password that belongs to the client User
|
|
638
642
|
* @visibility secret
|
|
@@ -1123,6 +1127,36 @@ export interface Config {
|
|
|
1123
1127
|
headers?: { [name: string]: string };
|
|
1124
1128
|
};
|
|
1125
1129
|
|
|
1130
|
+
/**
|
|
1131
|
+
* Options for the metrics service.
|
|
1132
|
+
*/
|
|
1133
|
+
metrics?: {
|
|
1134
|
+
/**
|
|
1135
|
+
* Plugin-specific metrics configuration. Each plugin can override meter metadata.
|
|
1136
|
+
*/
|
|
1137
|
+
plugin?: {
|
|
1138
|
+
[pluginId: string]: {
|
|
1139
|
+
/**
|
|
1140
|
+
* Meter configuration for this plugin.
|
|
1141
|
+
*/
|
|
1142
|
+
meter?: {
|
|
1143
|
+
/**
|
|
1144
|
+
* Custom meter name. If not set, defaults to backstage-plugin-{pluginId}.
|
|
1145
|
+
*/
|
|
1146
|
+
name?: string;
|
|
1147
|
+
/**
|
|
1148
|
+
* Version for the meter.
|
|
1149
|
+
*/
|
|
1150
|
+
version?: string;
|
|
1151
|
+
/**
|
|
1152
|
+
* Schema URL for the meter.
|
|
1153
|
+
*/
|
|
1154
|
+
schemaUrl?: string;
|
|
1155
|
+
};
|
|
1156
|
+
};
|
|
1157
|
+
};
|
|
1158
|
+
};
|
|
1159
|
+
|
|
1126
1160
|
/**
|
|
1127
1161
|
* Options to configure the default RootLoggerService.
|
|
1128
1162
|
*/
|
|
@@ -48,6 +48,7 @@ const defaultServiceFactories = [
|
|
|
48
48
|
// alpha services
|
|
49
49
|
alpha.actionsRegistryServiceFactory,
|
|
50
50
|
alpha.actionsServiceFactory,
|
|
51
|
+
alpha.metricsServiceFactory,
|
|
51
52
|
// Unexported alpha services kept around for compatibility reasons
|
|
52
53
|
instanceMetadataServiceFactory.instanceMetadataServiceFactory
|
|
53
54
|
];
|
|
@@ -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 { 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} from '@backstage/backend-defaults/alpha';\nimport { instanceMetadataServiceFactory } from './alpha/entrypoints/instanceMetadata/instanceMetadataServiceFactory';\n\nexport const defaultServiceFactories = [\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\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","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 { 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} from '@backstage/backend-defaults/alpha';\nimport { instanceMetadataServiceFactory } from './alpha/entrypoints/instanceMetadata/instanceMetadataServiceFactory';\n\nexport const defaultServiceFactories = [\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\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","instanceMetadataServiceFactory","createSpecializedBackend"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AA4CO,MAAM,uBAAA,GAA0B;AAAA,EACrCA,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,iCAAA;AAAA,EACAC,+BAAA;AAAA,EACAC,iCAAA;AAAA,EACAC,qCAAA;AAAA;AAAA,EAGAC,mCAAA;AAAA,EACAC,2BAAA;AAAA,EACAC,2BAAA;AAAA;AAAA,EAGAC;AACF;AAKO,SAAS,aAAA,GAAyB;AACvC,EAAA,OAAOC,sCAAA,CAAyB,EAAE,uBAAA,EAAyB,CAAA;AAC7D;;;;;"}
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var api = require('@opentelemetry/api');
|
|
4
|
+
|
|
5
|
+
class DefaultMetricsService {
|
|
6
|
+
meter;
|
|
7
|
+
constructor(opts) {
|
|
8
|
+
this.meter = api.metrics.getMeter(opts.name, opts.version, {
|
|
9
|
+
schemaUrl: opts.schemaUrl
|
|
10
|
+
});
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* Creates a new {@link MetricsService} instance.
|
|
14
|
+
*
|
|
15
|
+
* @param opts - Options for configuring the meter scope
|
|
16
|
+
* @returns A new MetricsService instance
|
|
17
|
+
*/
|
|
18
|
+
static create(opts) {
|
|
19
|
+
return new DefaultMetricsService(opts);
|
|
20
|
+
}
|
|
21
|
+
createCounter(name, opts) {
|
|
22
|
+
return this.meter.createCounter(name, opts);
|
|
23
|
+
}
|
|
24
|
+
createUpDownCounter(name, opts) {
|
|
25
|
+
return this.meter.createUpDownCounter(name, opts);
|
|
26
|
+
}
|
|
27
|
+
createHistogram(name, opts) {
|
|
28
|
+
return this.meter.createHistogram(name, opts);
|
|
29
|
+
}
|
|
30
|
+
createGauge(name, opts) {
|
|
31
|
+
return this.meter.createGauge(name, opts);
|
|
32
|
+
}
|
|
33
|
+
createObservableCounter(name, opts) {
|
|
34
|
+
return this.meter.createObservableCounter(name, opts);
|
|
35
|
+
}
|
|
36
|
+
createObservableUpDownCounter(name, opts) {
|
|
37
|
+
return this.meter.createObservableUpDownCounter(name, opts);
|
|
38
|
+
}
|
|
39
|
+
createObservableGauge(name, opts) {
|
|
40
|
+
return this.meter.createObservableGauge(name, opts);
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
exports.DefaultMetricsService = DefaultMetricsService;
|
|
45
|
+
//# sourceMappingURL=DefaultMetricsService.cjs.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"DefaultMetricsService.cjs.js","sources":["../../../../src/alpha/entrypoints/metrics/DefaultMetricsService.ts"],"sourcesContent":["/*\n * Copyright 2026 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 { Meter, metrics } from '@opentelemetry/api';\nimport {\n MetricsService,\n MetricAttributes,\n MetricOptions,\n MetricsServiceCounter,\n MetricsServiceUpDownCounter,\n MetricsServiceHistogram,\n MetricsServiceGauge,\n MetricsServiceObservableCounter,\n MetricsServiceObservableGauge,\n MetricsServiceObservableUpDownCounter,\n} from '@backstage/backend-plugin-api/alpha';\n\n/**\n * Options for creating a {@link DefaultMetricsService}.\n *\n * @alpha\n */\nexport interface DefaultMetricsServiceOptions {\n name: string;\n version?: string;\n schemaUrl?: string;\n}\n\n/**\n * Default implementation of the {@link MetricsService} interface.\n *\n * This implementation provides a thin wrapper around the OpenTelemetry Meter API.\n *\n * @alpha\n */\nexport class DefaultMetricsService implements MetricsService {\n private readonly meter: Meter;\n\n private constructor(opts: DefaultMetricsServiceOptions) {\n // The meter name sets the OpenTelemetry Instrumentation Scope which identifies the source of metrics in telemetry backends.\n this.meter = metrics.getMeter(opts.name, opts.version, {\n schemaUrl: opts.schemaUrl,\n });\n }\n\n /**\n * Creates a new {@link MetricsService} instance.\n *\n * @param opts - Options for configuring the meter scope\n * @returns A new MetricsService instance\n */\n static create(opts: DefaultMetricsServiceOptions): MetricsService {\n return new DefaultMetricsService(opts);\n }\n\n createCounter<TAttributes extends MetricAttributes = MetricAttributes>(\n name: string,\n opts?: MetricOptions,\n ): MetricsServiceCounter<TAttributes> {\n return this.meter.createCounter(name, opts);\n }\n\n createUpDownCounter<TAttributes extends MetricAttributes = MetricAttributes>(\n name: string,\n opts?: MetricOptions,\n ): MetricsServiceUpDownCounter<TAttributes> {\n return this.meter.createUpDownCounter(name, opts);\n }\n\n createHistogram<TAttributes extends MetricAttributes = MetricAttributes>(\n name: string,\n opts?: MetricOptions,\n ): MetricsServiceHistogram<TAttributes> {\n return this.meter.createHistogram(name, opts);\n }\n\n createGauge<TAttributes extends MetricAttributes = MetricAttributes>(\n name: string,\n opts?: MetricOptions,\n ): MetricsServiceGauge<TAttributes> {\n return this.meter.createGauge(name, opts);\n }\n\n createObservableCounter<\n TAttributes extends MetricAttributes = MetricAttributes,\n >(\n name: string,\n opts?: MetricOptions,\n ): MetricsServiceObservableCounter<TAttributes> {\n return this.meter.createObservableCounter(name, opts);\n }\n\n createObservableUpDownCounter<\n TAttributes extends MetricAttributes = MetricAttributes,\n >(\n name: string,\n opts?: MetricOptions,\n ): MetricsServiceObservableUpDownCounter<TAttributes> {\n return this.meter.createObservableUpDownCounter(name, opts);\n }\n\n createObservableGauge<\n TAttributes extends MetricAttributes = MetricAttributes,\n >(\n name: string,\n opts?: MetricOptions,\n ): MetricsServiceObservableGauge<TAttributes> {\n return this.meter.createObservableGauge(name, opts);\n }\n}\n"],"names":["metrics"],"mappings":";;;;AAgDO,MAAM,qBAAA,CAAgD;AAAA,EAC1C,KAAA;AAAA,EAET,YAAY,IAAA,EAAoC;AAEtD,IAAA,IAAA,CAAK,QAAQA,WAAA,CAAQ,QAAA,CAAS,IAAA,CAAK,IAAA,EAAM,KAAK,OAAA,EAAS;AAAA,MACrD,WAAW,IAAA,CAAK;AAAA,KACjB,CAAA;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OAAO,OAAO,IAAA,EAAoD;AAChE,IAAA,OAAO,IAAI,sBAAsB,IAAI,CAAA;AAAA,EACvC;AAAA,EAEA,aAAA,CACE,MACA,IAAA,EACoC;AACpC,IAAA,OAAO,IAAA,CAAK,KAAA,CAAM,aAAA,CAAc,IAAA,EAAM,IAAI,CAAA;AAAA,EAC5C;AAAA,EAEA,mBAAA,CACE,MACA,IAAA,EAC0C;AAC1C,IAAA,OAAO,IAAA,CAAK,KAAA,CAAM,mBAAA,CAAoB,IAAA,EAAM,IAAI,CAAA;AAAA,EAClD;AAAA,EAEA,eAAA,CACE,MACA,IAAA,EACsC;AACtC,IAAA,OAAO,IAAA,CAAK,KAAA,CAAM,eAAA,CAAgB,IAAA,EAAM,IAAI,CAAA;AAAA,EAC9C;AAAA,EAEA,WAAA,CACE,MACA,IAAA,EACkC;AAClC,IAAA,OAAO,IAAA,CAAK,KAAA,CAAM,WAAA,CAAY,IAAA,EAAM,IAAI,CAAA;AAAA,EAC1C;AAAA,EAEA,uBAAA,CAGE,MACA,IAAA,EAC8C;AAC9C,IAAA,OAAO,IAAA,CAAK,KAAA,CAAM,uBAAA,CAAwB,IAAA,EAAM,IAAI,CAAA;AAAA,EACtD;AAAA,EAEA,6BAAA,CAGE,MACA,IAAA,EACoD;AACpD,IAAA,OAAO,IAAA,CAAK,KAAA,CAAM,6BAAA,CAA8B,IAAA,EAAM,IAAI,CAAA;AAAA,EAC5D;AAAA,EAEA,qBAAA,CAGE,MACA,IAAA,EAC4C;AAC5C,IAAA,OAAO,IAAA,CAAK,KAAA,CAAM,qBAAA,CAAsB,IAAA,EAAM,IAAI,CAAA;AAAA,EACpD;AACF;;;;"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var alpha = require('@backstage/backend-plugin-api/alpha');
|
|
4
|
+
var backendPluginApi = require('@backstage/backend-plugin-api');
|
|
5
|
+
var DefaultMetricsService = require('./DefaultMetricsService.cjs.js');
|
|
6
|
+
|
|
7
|
+
const metricsServiceFactory = backendPluginApi.createServiceFactory({
|
|
8
|
+
service: alpha.metricsServiceRef,
|
|
9
|
+
deps: {
|
|
10
|
+
config: backendPluginApi.coreServices.rootConfig,
|
|
11
|
+
pluginMetadata: backendPluginApi.coreServices.pluginMetadata
|
|
12
|
+
},
|
|
13
|
+
factory: ({ config, pluginMetadata }) => {
|
|
14
|
+
const pluginId = pluginMetadata.getId();
|
|
15
|
+
const meterConfig = config.getOptionalConfig(
|
|
16
|
+
`backend.metrics.plugin.${pluginId}.meter`
|
|
17
|
+
);
|
|
18
|
+
const scopeName = `backstage-plugin-${pluginId}`;
|
|
19
|
+
const name = meterConfig?.getOptionalString("name") ?? scopeName;
|
|
20
|
+
const version = meterConfig?.getOptionalString("version");
|
|
21
|
+
const schemaUrl = meterConfig?.getOptionalString("schemaUrl");
|
|
22
|
+
return DefaultMetricsService.DefaultMetricsService.create({ name, version, schemaUrl });
|
|
23
|
+
}
|
|
24
|
+
});
|
|
25
|
+
|
|
26
|
+
exports.metricsServiceFactory = metricsServiceFactory;
|
|
27
|
+
//# sourceMappingURL=metricsServiceFactory.cjs.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"metricsServiceFactory.cjs.js","sources":["../../../../src/alpha/entrypoints/metrics/metricsServiceFactory.ts"],"sourcesContent":["/*\n * Copyright 2025 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 { metricsServiceRef } from '@backstage/backend-plugin-api/alpha';\nimport {\n coreServices,\n createServiceFactory,\n} from '@backstage/backend-plugin-api';\nimport { DefaultMetricsService } from './DefaultMetricsService';\n\n/**\n * Service factory for collecting plugin-scoped metrics.\n *\n * @alpha\n */\nexport const metricsServiceFactory = createServiceFactory({\n service: metricsServiceRef,\n deps: {\n config: coreServices.rootConfig,\n pluginMetadata: coreServices.pluginMetadata,\n },\n factory: ({ config, pluginMetadata }) => {\n const pluginId = pluginMetadata.getId();\n\n const meterConfig = config.getOptionalConfig(\n `backend.metrics.plugin.${pluginId}.meter`,\n );\n const scopeName = `backstage-plugin-${pluginId}`;\n const name = meterConfig?.getOptionalString('name') ?? scopeName;\n const version = meterConfig?.getOptionalString('version');\n const schemaUrl = meterConfig?.getOptionalString('schemaUrl');\n\n return DefaultMetricsService.create({ name, version, schemaUrl });\n },\n});\n"],"names":["createServiceFactory","metricsServiceRef","coreServices","DefaultMetricsService"],"mappings":";;;;;;AA4BO,MAAM,wBAAwBA,qCAAA,CAAqB;AAAA,EACxD,OAAA,EAASC,uBAAA;AAAA,EACT,IAAA,EAAM;AAAA,IACJ,QAAQC,6BAAA,CAAa,UAAA;AAAA,IACrB,gBAAgBA,6BAAA,CAAa;AAAA,GAC/B;AAAA,EACA,OAAA,EAAS,CAAC,EAAE,MAAA,EAAQ,gBAAe,KAAM;AACvC,IAAA,MAAM,QAAA,GAAW,eAAe,KAAA,EAAM;AAEtC,IAAA,MAAM,cAAc,MAAA,CAAO,iBAAA;AAAA,MACzB,0BAA0B,QAAQ,CAAA,MAAA;AAAA,KACpC;AACA,IAAA,MAAM,SAAA,GAAY,oBAAoB,QAAQ,CAAA,CAAA;AAC9C,IAAA,MAAM,IAAA,GAAO,WAAA,EAAa,iBAAA,CAAkB,MAAM,CAAA,IAAK,SAAA;AACvD,IAAA,MAAM,OAAA,GAAU,WAAA,EAAa,iBAAA,CAAkB,SAAS,CAAA;AACxD,IAAA,MAAM,SAAA,GAAY,WAAA,EAAa,iBAAA,CAAkB,WAAW,CAAA;AAE5D,IAAA,OAAOC,4CAAsB,MAAA,CAAO,EAAE,IAAA,EAAM,OAAA,EAAS,WAAW,CAAA;AAAA,EAClE;AACF,CAAC;;;;"}
|
package/dist/alpha.cjs.js
CHANGED
|
@@ -2,11 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
var actionsRegistryServiceFactory = require('./alpha/entrypoints/actionsRegistry/actionsRegistryServiceFactory.cjs.js');
|
|
4
4
|
var actionsServiceFactory = require('./alpha/entrypoints/actions/actionsServiceFactory.cjs.js');
|
|
5
|
+
var metricsServiceFactory = require('./alpha/entrypoints/metrics/metricsServiceFactory.cjs.js');
|
|
5
6
|
var rootSystemMetadataServiceFactory = require('./alpha/entrypoints/rootSystemMetadata/rootSystemMetadataServiceFactory.cjs.js');
|
|
6
7
|
|
|
7
8
|
|
|
8
9
|
|
|
9
10
|
exports.actionsRegistryServiceFactory = actionsRegistryServiceFactory.actionsRegistryServiceFactory;
|
|
10
11
|
exports.actionsServiceFactory = actionsServiceFactory.actionsServiceFactory;
|
|
12
|
+
exports.metricsServiceFactory = metricsServiceFactory.metricsServiceFactory;
|
|
11
13
|
exports.rootSystemMetadataServiceFactory = rootSystemMetadataServiceFactory.rootSystemMetadataServiceFactory;
|
|
12
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
|
@@ -11,6 +11,13 @@ declare const actionsRegistryServiceFactory: _backstage_backend_plugin_api.Servi
|
|
|
11
11
|
*/
|
|
12
12
|
declare const actionsServiceFactory: _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api_alpha.ActionsService, "plugin", "singleton">;
|
|
13
13
|
|
|
14
|
+
/**
|
|
15
|
+
* Service factory for collecting plugin-scoped metrics.
|
|
16
|
+
*
|
|
17
|
+
* @alpha
|
|
18
|
+
*/
|
|
19
|
+
declare const metricsServiceFactory: _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api_alpha.MetricsService, "plugin", "singleton">;
|
|
20
|
+
|
|
14
21
|
/**
|
|
15
22
|
* Metadata about an entire Backstage system, a collection of Backstage instances.
|
|
16
23
|
*
|
|
@@ -18,4 +25,4 @@ declare const actionsServiceFactory: _backstage_backend_plugin_api.ServiceFactor
|
|
|
18
25
|
*/
|
|
19
26
|
declare const rootSystemMetadataServiceFactory: _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api_alpha.RootSystemMetadataService, "root", "singleton">;
|
|
20
27
|
|
|
21
|
-
export { actionsRegistryServiceFactory, actionsServiceFactory, rootSystemMetadataServiceFactory };
|
|
28
|
+
export { actionsRegistryServiceFactory, actionsServiceFactory, metricsServiceFactory, rootSystemMetadataServiceFactory };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createRateLimitMiddleware.cjs.js","sources":["../../../../src/entrypoints/httpRouter/http/createRateLimitMiddleware.ts"],"sourcesContent":["/*\n * Copyright 2025 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 */\nimport { NextFunction, Request, Response } from 'express';\nimport { RateLimitStoreFactory } from '../../../lib/RateLimitStoreFactory.ts';\nimport {
|
|
1
|
+
{"version":3,"file":"createRateLimitMiddleware.cjs.js","sources":["../../../../src/entrypoints/httpRouter/http/createRateLimitMiddleware.ts"],"sourcesContent":["/*\n * Copyright 2025 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 */\nimport { NextFunction, Request, Response, RequestHandler } from 'express';\nimport { RateLimitStoreFactory } from '../../../lib/RateLimitStoreFactory.ts';\nimport { RootConfigService } from '@backstage/backend-plugin-api';\n\nimport { rateLimitMiddleware } from '../../../lib/rateLimitMiddleware.ts';\n\n/**\n * @public\n * Creates a middleware that applies rate limiting to requests based on the provided configuration.\n */\nexport const createRateLimitMiddleware = (options: {\n pluginId: string;\n config: RootConfigService;\n}): RequestHandler => {\n const { pluginId, config } = options;\n const configKey = `backend.rateLimit.plugin.${pluginId}`;\n const enabled = config.has(configKey);\n if (!enabled) {\n return (_req: Request, _res: Response, next: NextFunction) => {\n next();\n };\n }\n\n const rateLimitOptions = config.getConfig(configKey);\n\n return rateLimitMiddleware({\n store: RateLimitStoreFactory.create({ config, prefix: pluginId }),\n config: rateLimitOptions,\n });\n};\n"],"names":["rateLimitMiddleware","RateLimitStoreFactory"],"mappings":";;;;;AAyBO,MAAM,yBAAA,GAA4B,CAAC,OAAA,KAGpB;AACpB,EAAA,MAAM,EAAE,QAAA,EAAU,MAAA,EAAO,GAAI,OAAA;AAC7B,EAAA,MAAM,SAAA,GAAY,4BAA4B,QAAQ,CAAA,CAAA;AACtD,EAAA,MAAM,OAAA,GAAU,MAAA,CAAO,GAAA,CAAI,SAAS,CAAA;AACpC,EAAA,IAAI,CAAC,OAAA,EAAS;AACZ,IAAA,OAAO,CAAC,IAAA,EAAe,IAAA,EAAgB,IAAA,KAAuB;AAC5D,MAAA,IAAA,EAAK;AAAA,IACP,CAAA;AAAA,EACF;AAEA,EAAA,MAAM,gBAAA,GAAmB,MAAA,CAAO,SAAA,CAAU,SAAS,CAAA;AAEnD,EAAA,OAAOA,uCAAA,CAAoB;AAAA,IACzB,OAAOC,2CAAA,CAAsB,MAAA,CAAO,EAAE,MAAA,EAAQ,MAAA,EAAQ,UAAU,CAAA;AAAA,IAChE,MAAA,EAAQ;AAAA,GACT,CAAA;AACH;;;;"}
|
|
@@ -6,6 +6,7 @@ var createAuthIntegrationRouter = require('./http/createAuthIntegrationRouter.cj
|
|
|
6
6
|
var createCredentialsBarrier = require('./http/createCredentialsBarrier.cjs.js');
|
|
7
7
|
var createLifecycleMiddleware = require('./http/createLifecycleMiddleware.cjs.js');
|
|
8
8
|
var createCookieAuthRefreshMiddleware = require('./http/createCookieAuthRefreshMiddleware.cjs.js');
|
|
9
|
+
var createRateLimitMiddleware = require('./http/createRateLimitMiddleware.cjs.js');
|
|
9
10
|
require('express');
|
|
10
11
|
require('lodash/trimEnd');
|
|
11
12
|
require('node:http');
|
|
@@ -18,7 +19,6 @@ require('minimatch');
|
|
|
18
19
|
require('helmet');
|
|
19
20
|
require('lodash/kebabCase');
|
|
20
21
|
require('../rootHttpRouter/rootHttpRouterServiceFactory.cjs.js');
|
|
21
|
-
var createRateLimitMiddleware = require('./http/createRateLimitMiddleware.cjs.js');
|
|
22
22
|
|
|
23
23
|
function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
|
|
24
24
|
|
|
@@ -1,18 +1,14 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
var fetch = require('node-fetch');
|
|
4
3
|
var errors = require('@backstage/errors');
|
|
5
4
|
var integration = require('@backstage/integration');
|
|
6
5
|
var parseGitUrl = require('git-url-parse');
|
|
7
6
|
var lodash = require('lodash');
|
|
8
7
|
var minimatch = require('minimatch');
|
|
9
|
-
var node_stream = require('node:stream');
|
|
10
8
|
var ReadUrlResponseFactory = require('./ReadUrlResponseFactory.cjs.js');
|
|
11
|
-
var util = require('./util.cjs.js');
|
|
12
9
|
|
|
13
10
|
function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
|
|
14
11
|
|
|
15
|
-
var fetch__default = /*#__PURE__*/_interopDefaultCompat(fetch);
|
|
16
12
|
var parseGitUrl__default = /*#__PURE__*/_interopDefaultCompat(parseGitUrl);
|
|
17
13
|
|
|
18
14
|
class GitlabUrlReader {
|
|
@@ -42,7 +38,7 @@ class GitlabUrlReader {
|
|
|
42
38
|
const builtUrl = await this.getGitlabFetchUrl(url, token);
|
|
43
39
|
let response;
|
|
44
40
|
try {
|
|
45
|
-
response = await
|
|
41
|
+
response = await this.integration.fetch(builtUrl, {
|
|
46
42
|
headers: {
|
|
47
43
|
...integration.getGitLabRequestOptions(this.integration.config, token).headers,
|
|
48
44
|
...etag && !isArtifact && { "If-None-Match": etag },
|
|
@@ -65,12 +61,7 @@ class GitlabUrlReader {
|
|
|
65
61
|
throw new errors.NotModifiedError();
|
|
66
62
|
}
|
|
67
63
|
if (response.ok) {
|
|
68
|
-
return ReadUrlResponseFactory.ReadUrlResponseFactory.
|
|
69
|
-
etag: response.headers.get("ETag") ?? void 0,
|
|
70
|
-
lastModifiedAt: util.parseLastModified(
|
|
71
|
-
response.headers.get("Last-Modified")
|
|
72
|
-
)
|
|
73
|
-
});
|
|
64
|
+
return ReadUrlResponseFactory.ReadUrlResponseFactory.fromResponse(response);
|
|
74
65
|
}
|
|
75
66
|
const message = `${url} could not be read as ${builtUrl}, ${response.status} ${response.statusText}`;
|
|
76
67
|
if (response.status === 404) {
|
|
@@ -89,7 +80,7 @@ class GitlabUrlReader {
|
|
|
89
80
|
const rectifiedRelativePath = `${lodash.trimStart(relativePath, "/")}/`;
|
|
90
81
|
repoFullName = full_name.replace(rectifiedRelativePath, "");
|
|
91
82
|
}
|
|
92
|
-
const projectGitlabResponse = await
|
|
83
|
+
const projectGitlabResponse = await this.integration.fetch(
|
|
93
84
|
new URL(
|
|
94
85
|
`${this.integration.config.apiBaseUrl}/projects/${encodeURIComponent(
|
|
95
86
|
repoFullName
|
|
@@ -111,7 +102,7 @@ class GitlabUrlReader {
|
|
|
111
102
|
if (!!filepath) {
|
|
112
103
|
commitsReqParams.set("path", filepath);
|
|
113
104
|
}
|
|
114
|
-
const commitsGitlabResponse = await
|
|
105
|
+
const commitsGitlabResponse = await this.integration.fetch(
|
|
115
106
|
new URL(
|
|
116
107
|
`${this.integration.config.apiBaseUrl}/projects/${encodeURIComponent(
|
|
117
108
|
repoFullName
|
|
@@ -144,30 +135,28 @@ class GitlabUrlReader {
|
|
|
144
135
|
if (!!filepath) {
|
|
145
136
|
archiveReqParams.set("path", filepath);
|
|
146
137
|
}
|
|
147
|
-
const
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
}
|
|
161
|
-
);
|
|
138
|
+
const reqUrl = `${this.integration.config.apiBaseUrl}/projects/${encodeURIComponent(
|
|
139
|
+
repoFullName
|
|
140
|
+
)}/repository/archive?${archiveReqParams.toString()}`;
|
|
141
|
+
const archiveGitLabResponse = await this.integration.fetch(reqUrl, {
|
|
142
|
+
...integration.getGitLabRequestOptions(this.integration.config, token),
|
|
143
|
+
// TODO(freben): The signal cast is there because pre-3.x versions of
|
|
144
|
+
// node-fetch have a very slightly deviating AbortSignal type signature.
|
|
145
|
+
// The difference does not affect us in practice however. The cast can
|
|
146
|
+
// be removed after we support ESM for CLI dependencies and migrate to
|
|
147
|
+
// version 3 of node-fetch.
|
|
148
|
+
// https://github.com/backstage/backstage/issues/8242
|
|
149
|
+
...signal && { signal }
|
|
150
|
+
});
|
|
162
151
|
if (!archiveGitLabResponse.ok) {
|
|
163
|
-
const message = `Failed to read tree (archive) from ${url}, ${archiveGitLabResponse.status} ${archiveGitLabResponse.statusText}`;
|
|
152
|
+
const message = `Failed to read tree (archive) from ${url}, ${reqUrl}, ${archiveGitLabResponse.status} ${archiveGitLabResponse.statusText}`;
|
|
164
153
|
if (archiveGitLabResponse.status === 404) {
|
|
165
154
|
throw new errors.NotFoundError(message);
|
|
166
155
|
}
|
|
167
156
|
throw new Error(message);
|
|
168
157
|
}
|
|
169
158
|
return await this.deps.treeResponseFactory.fromTarArchive({
|
|
170
|
-
|
|
159
|
+
response: archiveGitLabResponse,
|
|
171
160
|
subpath: filepath,
|
|
172
161
|
etag: commitSha,
|
|
173
162
|
filter: options?.filter
|
|
@@ -244,7 +233,7 @@ class GitlabUrlReader {
|
|
|
244
233
|
async getGitlabFetchUrl(target, token) {
|
|
245
234
|
const targetUrl = new URL(target);
|
|
246
235
|
if (targetUrl.pathname.includes("/-/jobs/artifacts/")) {
|
|
247
|
-
return this.getGitlabArtifactFetchUrl(targetUrl
|
|
236
|
+
return this.getGitlabArtifactFetchUrl(targetUrl).then(
|
|
248
237
|
(value) => value.toString()
|
|
249
238
|
);
|
|
250
239
|
}
|
|
@@ -253,52 +242,32 @@ class GitlabUrlReader {
|
|
|
253
242
|
// convert urls of the form:
|
|
254
243
|
// https://example.com/<namespace>/<project>/-/jobs/artifacts/<ref>/raw/<path_to_file>?job=<job_name>
|
|
255
244
|
// to urls of the form:
|
|
256
|
-
// https://example.com/api/v4/projects
|
|
257
|
-
|
|
245
|
+
// https://example.com/api/v4/projects/namespace%2Fproject/jobs/artifacts/:ref_name/raw/*artifact_path?job=<job_name>
|
|
246
|
+
getGitlabArtifactFetchUrl(target) {
|
|
258
247
|
if (!target.pathname.includes("/-/jobs/artifacts/")) {
|
|
259
248
|
throw new Error("Unable to process url as an GitLab artifact");
|
|
260
249
|
}
|
|
261
250
|
try {
|
|
262
251
|
const [namespaceAndProject, ref] = target.pathname.split("/-/jobs/artifacts/");
|
|
263
|
-
const projectPath = new URL(target);
|
|
264
|
-
projectPath.pathname = namespaceAndProject;
|
|
265
|
-
const projectId = await this.resolveProjectToId(projectPath, token);
|
|
266
252
|
const relativePath = integration.getGitLabIntegrationRelativePath(
|
|
267
253
|
this.integration.config
|
|
268
254
|
);
|
|
255
|
+
let projectPath = namespaceAndProject;
|
|
256
|
+
if (relativePath) {
|
|
257
|
+
projectPath = lodash.trimStart(projectPath, relativePath);
|
|
258
|
+
}
|
|
259
|
+
projectPath = projectPath.replace(/^\//, "");
|
|
269
260
|
const newUrl = new URL(target);
|
|
270
|
-
newUrl.pathname = `${relativePath}/api/v4/projects/${
|
|
271
|
-
|
|
261
|
+
newUrl.pathname = `${relativePath}/api/v4/projects/${encodeURIComponent(
|
|
262
|
+
projectPath
|
|
263
|
+
)}/jobs/artifacts/${ref}`;
|
|
264
|
+
return Promise.resolve(newUrl);
|
|
272
265
|
} catch (e) {
|
|
273
266
|
throw new Error(
|
|
274
267
|
`Unable to translate GitLab artifact URL: ${target}, ${e}`
|
|
275
268
|
);
|
|
276
269
|
}
|
|
277
270
|
}
|
|
278
|
-
async resolveProjectToId(pathToProject, token) {
|
|
279
|
-
let project = pathToProject.pathname;
|
|
280
|
-
const relativePath = integration.getGitLabIntegrationRelativePath(
|
|
281
|
-
this.integration.config
|
|
282
|
-
);
|
|
283
|
-
if (relativePath) {
|
|
284
|
-
project = project.replace(relativePath, "");
|
|
285
|
-
}
|
|
286
|
-
project = project.replace(/^\//, "");
|
|
287
|
-
const result = await fetch__default.default(
|
|
288
|
-
`${pathToProject.origin}${relativePath}/api/v4/projects/${encodeURIComponent(project)}`,
|
|
289
|
-
integration.getGitLabRequestOptions(this.integration.config, token)
|
|
290
|
-
);
|
|
291
|
-
const data = await result.json();
|
|
292
|
-
if (!result.ok) {
|
|
293
|
-
if (result.status === 401) {
|
|
294
|
-
throw new Error(
|
|
295
|
-
"GitLab Error: 401 - Unauthorized. The access token used is either expired, or does not have permission to read the project"
|
|
296
|
-
);
|
|
297
|
-
}
|
|
298
|
-
throw new Error(`Gitlab error: ${data.error}, ${data.error_description}`);
|
|
299
|
-
}
|
|
300
|
-
return Number(data.id);
|
|
301
|
-
}
|
|
302
271
|
}
|
|
303
272
|
|
|
304
273
|
exports.GitlabUrlReader = GitlabUrlReader;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"GitlabUrlReader.cjs.js","sources":["../../../../src/entrypoints/urlReader/lib/GitlabUrlReader.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\n// NOTE(freben): Intentionally uses node-fetch because of https://github.com/backstage/backstage/issues/28190\nimport fetch, { Response } from 'node-fetch';\n\nimport {\n UrlReaderService,\n UrlReaderServiceReadTreeOptions,\n UrlReaderServiceReadTreeResponse,\n UrlReaderServiceReadUrlOptions,\n UrlReaderServiceReadUrlResponse,\n UrlReaderServiceSearchOptions,\n UrlReaderServiceSearchResponse,\n} from '@backstage/backend-plugin-api';\nimport {\n assertError,\n NotFoundError,\n NotModifiedError,\n} from '@backstage/errors';\nimport {\n getGitLabFileFetchUrl,\n getGitLabIntegrationRelativePath,\n getGitLabRequestOptions,\n GitLabIntegration,\n ScmIntegrations,\n} from '@backstage/integration';\nimport parseGitUrl from 'git-url-parse';\nimport { trimEnd, trimStart } from 'lodash';\nimport { Minimatch } from 'minimatch';\nimport { Readable } from 'node:stream';\nimport { ReadUrlResponseFactory } from './ReadUrlResponseFactory';\nimport { ReaderFactory, ReadTreeResponseFactory } from './types';\nimport { parseLastModified } from './util';\n\n/**\n * Implements a {@link @backstage/backend-plugin-api#UrlReaderService} for files on GitLab.\n *\n * @public\n */\nexport class GitlabUrlReader implements UrlReaderService {\n static factory: ReaderFactory = ({ config, treeResponseFactory }) => {\n const integrations = ScmIntegrations.fromConfig(config);\n return integrations.gitlab.list().map(integration => {\n const reader = new GitlabUrlReader(integration, {\n treeResponseFactory,\n });\n const predicate = (url: URL) => url.host === integration.config.host;\n return { reader, predicate };\n });\n };\n\n private readonly integration: GitLabIntegration;\n private readonly deps: { treeResponseFactory: ReadTreeResponseFactory };\n\n constructor(\n integration: GitLabIntegration,\n deps: { treeResponseFactory: ReadTreeResponseFactory },\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 const { etag, lastModifiedAfter, signal, token } = options ?? {};\n const isArtifact = url.includes('/-/jobs/artifacts/');\n const builtUrl = await this.getGitlabFetchUrl(url, token);\n\n let response: Response;\n try {\n response = await fetch(builtUrl, {\n headers: {\n ...getGitLabRequestOptions(this.integration.config, token).headers,\n ...(etag && !isArtifact && { 'If-None-Match': etag }),\n ...(lastModifiedAfter &&\n !isArtifact && {\n 'If-Modified-Since': lastModifiedAfter.toUTCString(),\n }),\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 } catch (e) {\n throw new Error(`Unable to read ${url}, ${e}`);\n }\n\n if (response.status === 304) {\n throw new NotModifiedError();\n }\n\n if (response.ok) {\n return ReadUrlResponseFactory.fromNodeJSReadable(response.body, {\n etag: response.headers.get('ETag') ?? undefined,\n lastModifiedAt: parseLastModified(\n response.headers.get('Last-Modified'),\n ),\n });\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, signal, token } = options ?? {};\n const { ref, full_name, filepath } = parseGitUrl(url);\n\n let repoFullName = full_name;\n\n const relativePath = getGitLabIntegrationRelativePath(\n this.integration.config,\n );\n\n // Considering self hosted gitlab with relative\n // assuming '/gitlab' is the relative path\n // from: /gitlab/repo/project\n // to: repo/project\n if (relativePath) {\n const rectifiedRelativePath = `${trimStart(relativePath, '/')}/`;\n repoFullName = full_name.replace(rectifiedRelativePath, '');\n }\n\n // Use GitLab API to get the default branch\n // encodeURIComponent is required for GitLab API\n // https://docs.gitlab.com/ee/api/README.html#namespaced-path-encoding\n const projectGitlabResponse = await fetch(\n new URL(\n `${this.integration.config.apiBaseUrl}/projects/${encodeURIComponent(\n repoFullName,\n )}`,\n ).toString(),\n getGitLabRequestOptions(this.integration.config, token),\n );\n if (!projectGitlabResponse.ok) {\n const msg = `Failed to read tree from ${url}, ${projectGitlabResponse.status} ${projectGitlabResponse.statusText}`;\n if (projectGitlabResponse.status === 404) {\n throw new NotFoundError(msg);\n }\n throw new Error(msg);\n }\n const projectGitlabResponseJson = await projectGitlabResponse.json();\n\n // ref is an empty string if no branch is set in provided url to readTree.\n const branch = ref || projectGitlabResponseJson.default_branch;\n\n // Fetch the latest commit that modifies the filepath in the provided or default branch\n // to compare against the provided sha.\n const commitsReqParams = new URLSearchParams();\n commitsReqParams.set('ref_name', branch);\n if (!!filepath) {\n commitsReqParams.set('path', filepath);\n }\n const commitsGitlabResponse = await fetch(\n new URL(\n `${this.integration.config.apiBaseUrl}/projects/${encodeURIComponent(\n repoFullName,\n )}/repository/commits?${commitsReqParams.toString()}`,\n ).toString(),\n {\n ...getGitLabRequestOptions(this.integration.config, token),\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 );\n if (!commitsGitlabResponse.ok) {\n const message = `Failed to read tree (branch) from ${url}, ${commitsGitlabResponse.status} ${commitsGitlabResponse.statusText}`;\n if (commitsGitlabResponse.status === 404) {\n throw new NotFoundError(message);\n }\n throw new Error(message);\n }\n\n const commitSha = (await commitsGitlabResponse.json())[0]?.id ?? '';\n if (etag && etag === commitSha) {\n throw new NotModifiedError();\n }\n\n const archiveReqParams = new URLSearchParams();\n archiveReqParams.set('sha', branch);\n if (!!filepath) {\n archiveReqParams.set('path', filepath);\n }\n // https://docs.gitlab.com/ee/api/repositories.html#get-file-archive\n const archiveGitLabResponse = await fetch(\n `${this.integration.config.apiBaseUrl}/projects/${encodeURIComponent(\n repoFullName,\n )}/repository/archive?${archiveReqParams.toString()}`,\n {\n ...getGitLabRequestOptions(this.integration.config, token),\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 );\n if (!archiveGitLabResponse.ok) {\n const message = `Failed to read tree (archive) from ${url}, ${archiveGitLabResponse.status} ${archiveGitLabResponse.statusText}`;\n if (archiveGitLabResponse.status === 404) {\n throw new NotFoundError(message);\n }\n throw new Error(message);\n }\n\n return await this.deps.treeResponseFactory.fromTarArchive({\n stream: Readable.from(archiveGitLabResponse.body),\n subpath: filepath,\n etag: commitSha,\n filter: options?.filter,\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 (error) {\n assertError(error);\n if (error.name === 'NotFoundError') {\n return {\n files: [],\n etag: '',\n };\n }\n throw error;\n }\n }\n\n const staticPart = this.getStaticPart(filepath);\n const matcher = new Minimatch(filepath);\n const treeUrl = trimEnd(url.replace(filepath, staticPart), `/`);\n const pathPrefix = staticPart ? `${staticPart}/` : '';\n const tree = await this.readTree(treeUrl, {\n etag: options?.etag,\n signal: options?.signal,\n filter: path => matcher.match(`${pathPrefix}${path}`),\n });\n\n const files = await tree.files();\n return {\n etag: tree.etag,\n files: files.map(file => ({\n url: this.integration.resolveUrl({\n url: `/${pathPrefix}${file.path}`,\n base: url,\n }),\n content: file.content,\n lastModifiedAt: file.lastModifiedAt,\n })),\n };\n }\n\n /**\n * This function splits the input globPattern string into segments using the path separator /. It then iterates over\n * the segments from the end of the array towards the beginning, checking if the concatenated string up to that\n * segment matches the original globPattern using the minimatch function. If a match is found, it continues iterating.\n * If no match is found, it returns the concatenated string up to the current segment, which is the static part of the\n * glob pattern.\n *\n * E.g. `catalog/foo/*.yaml` will return `catalog/foo`.\n *\n * @param globPattern - the glob pattern\n */\n private getStaticPart(globPattern: string) {\n const segments = globPattern.split('/');\n const globIndex = segments.findIndex(segment => segment.match(/[*?]/));\n return globIndex === -1\n ? globPattern\n : segments.slice(0, globIndex).join('/');\n }\n\n toString() {\n const { host, token } = this.integration.config;\n return `gitlab{host=${host},authed=${Boolean(token)}}`;\n }\n\n private async getGitlabFetchUrl(\n target: string,\n token?: string,\n ): Promise<string> {\n // If the target is for a job artifact then go down that path\n const targetUrl = new URL(target);\n if (targetUrl.pathname.includes('/-/jobs/artifacts/')) {\n return this.getGitlabArtifactFetchUrl(targetUrl, token).then(value =>\n value.toString(),\n );\n }\n // Default to the old behavior of assuming the url is for a file\n return getGitLabFileFetchUrl(target, this.integration.config, token);\n }\n\n // convert urls of the form:\n // https://example.com/<namespace>/<project>/-/jobs/artifacts/<ref>/raw/<path_to_file>?job=<job_name>\n // to urls of the form:\n // https://example.com/api/v4/projects/:id/jobs/artifacts/:ref_name/raw/*artifact_path?job=<job_name>\n private async getGitlabArtifactFetchUrl(\n target: URL,\n token?: string,\n ): Promise<URL> {\n if (!target.pathname.includes('/-/jobs/artifacts/')) {\n throw new Error('Unable to process url as an GitLab artifact');\n }\n try {\n const [namespaceAndProject, ref] =\n target.pathname.split('/-/jobs/artifacts/');\n const projectPath = new URL(target);\n projectPath.pathname = namespaceAndProject;\n const projectId = await this.resolveProjectToId(projectPath, token);\n const relativePath = getGitLabIntegrationRelativePath(\n this.integration.config,\n );\n const newUrl = new URL(target);\n newUrl.pathname = `${relativePath}/api/v4/projects/${projectId}/jobs/artifacts/${ref}`;\n return newUrl;\n } catch (e) {\n throw new Error(\n `Unable to translate GitLab artifact URL: ${target}, ${e}`,\n );\n }\n }\n\n private async resolveProjectToId(\n pathToProject: URL,\n token?: string,\n ): Promise<number> {\n let project = pathToProject.pathname;\n // Check relative path exist and remove it if so\n const relativePath = getGitLabIntegrationRelativePath(\n this.integration.config,\n );\n if (relativePath) {\n project = project.replace(relativePath, '');\n }\n // Trim an initial / if it exists\n project = project.replace(/^\\//, '');\n const result = await fetch(\n `${\n pathToProject.origin\n }${relativePath}/api/v4/projects/${encodeURIComponent(project)}`,\n getGitLabRequestOptions(this.integration.config, token),\n );\n const data = await result.json();\n if (!result.ok) {\n if (result.status === 401) {\n throw new Error(\n 'GitLab Error: 401 - Unauthorized. The access token used is either expired, or does not have permission to read the project',\n );\n }\n\n throw new Error(`Gitlab error: ${data.error}, ${data.error_description}`);\n }\n return Number(data.id);\n }\n}\n"],"names":["ScmIntegrations","fetch","getGitLabRequestOptions","NotModifiedError","ReadUrlResponseFactory","parseLastModified","NotFoundError","parseGitUrl","getGitLabIntegrationRelativePath","trimStart","Readable","assertError","Minimatch","trimEnd","getGitLabFileFetchUrl"],"mappings":";;;;;;;;;;;;;;;;;AAqDO,MAAM,eAAA,CAA4C;AAAA,EACvD,OAAO,OAAA,GAAyB,CAAC,EAAE,MAAA,EAAQ,qBAAoB,KAAM;AACnE,IAAA,MAAM,YAAA,GAAeA,2BAAA,CAAgB,UAAA,CAAW,MAAM,CAAA;AACtD,IAAA,OAAO,YAAA,CAAa,MAAA,CAAO,IAAA,EAAK,CAAE,IAAI,CAAA,WAAA,KAAe;AACnD,MAAA,MAAM,MAAA,GAAS,IAAI,eAAA,CAAgB,WAAA,EAAa;AAAA,QAC9C;AAAA,OACD,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,EAEjB,WAAA,CACE,aACA,IAAA,EACA;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;AAC1C,IAAA,MAAM,EAAE,IAAA,EAAM,iBAAA,EAAmB,QAAQ,KAAA,EAAM,GAAI,WAAW,EAAC;AAC/D,IAAA,MAAM,UAAA,GAAa,GAAA,CAAI,QAAA,CAAS,oBAAoB,CAAA;AACpD,IAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,iBAAA,CAAkB,KAAK,KAAK,CAAA;AAExD,IAAA,IAAI,QAAA;AACJ,IAAA,IAAI;AACF,MAAA,QAAA,GAAW,MAAMC,uBAAM,QAAA,EAAU;AAAA,QAC/B,OAAA,EAAS;AAAA,UACP,GAAGC,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,MAAA,EAAQ,KAAK,CAAA,CAAE,OAAA;AAAA,UAC3D,GAAI,IAAA,IAAQ,CAAC,UAAA,IAAc,EAAE,iBAAiB,IAAA,EAAK;AAAA,UACnD,GAAI,iBAAA,IACF,CAAC,UAAA,IAAc;AAAA,YACb,mBAAA,EAAqB,kBAAkB,WAAA;AAAY;AACrD,SACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,QAOA,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;AAEA,IAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,MAAA,MAAM,IAAIC,uBAAA,EAAiB;AAAA,IAC7B;AAEA,IAAA,IAAI,SAAS,EAAA,EAAI;AACf,MAAA,OAAOC,6CAAA,CAAuB,kBAAA,CAAmB,QAAA,CAAS,IAAA,EAAM;AAAA,QAC9D,IAAA,EAAM,QAAA,CAAS,OAAA,CAAQ,GAAA,CAAI,MAAM,CAAA,IAAK,MAAA;AAAA,QACtC,cAAA,EAAgBC,sBAAA;AAAA,UACd,QAAA,CAAS,OAAA,CAAQ,GAAA,CAAI,eAAe;AAAA;AACtC,OACD,CAAA;AAAA,IACH;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,KAAA,EAAM,GAAI,WAAW,EAAC;AAC5C,IAAA,MAAM,EAAE,GAAA,EAAK,SAAA,EAAW,QAAA,EAAS,GAAIC,6BAAY,GAAG,CAAA;AAEpD,IAAA,IAAI,YAAA,GAAe,SAAA;AAEnB,IAAA,MAAM,YAAA,GAAeC,4CAAA;AAAA,MACnB,KAAK,WAAA,CAAY;AAAA,KACnB;AAMA,IAAA,IAAI,YAAA,EAAc;AAChB,MAAA,MAAM,qBAAA,GAAwB,CAAA,EAAGC,gBAAA,CAAU,YAAA,EAAc,GAAG,CAAC,CAAA,CAAA,CAAA;AAC7D,MAAA,YAAA,GAAe,SAAA,CAAU,OAAA,CAAQ,qBAAA,EAAuB,EAAE,CAAA;AAAA,IAC5D;AAKA,IAAA,MAAM,wBAAwB,MAAMR,sBAAA;AAAA,MAClC,IAAI,GAAA;AAAA,QACF,CAAA,EAAG,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,UAAU,CAAA,UAAA,EAAa,kBAAA;AAAA,UAChD;AAAA,SACD,CAAA;AAAA,QACD,QAAA,EAAS;AAAA,MACXC,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,MAAA,EAAQ,KAAK;AAAA,KACxD;AACA,IAAA,IAAI,CAAC,sBAAsB,EAAA,EAAI;AAC7B,MAAA,MAAM,GAAA,GAAM,4BAA4B,GAAG,CAAA,EAAA,EAAK,sBAAsB,MAAM,CAAA,CAAA,EAAI,sBAAsB,UAAU,CAAA,CAAA;AAChH,MAAA,IAAI,qBAAA,CAAsB,WAAW,GAAA,EAAK;AACxC,QAAA,MAAM,IAAII,qBAAc,GAAG,CAAA;AAAA,MAC7B;AACA,MAAA,MAAM,IAAI,MAAM,GAAG,CAAA;AAAA,IACrB;AACA,IAAA,MAAM,yBAAA,GAA4B,MAAM,qBAAA,CAAsB,IAAA,EAAK;AAGnE,IAAA,MAAM,MAAA,GAAS,OAAO,yBAAA,CAA0B,cAAA;AAIhD,IAAA,MAAM,gBAAA,GAAmB,IAAI,eAAA,EAAgB;AAC7C,IAAA,gBAAA,CAAiB,GAAA,CAAI,YAAY,MAAM,CAAA;AACvC,IAAA,IAAI,CAAC,CAAC,QAAA,EAAU;AACd,MAAA,gBAAA,CAAiB,GAAA,CAAI,QAAQ,QAAQ,CAAA;AAAA,IACvC;AACA,IAAA,MAAM,wBAAwB,MAAML,sBAAA;AAAA,MAClC,IAAI,GAAA;AAAA,QACF,CAAA,EAAG,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,UAAU,CAAA,UAAA,EAAa,kBAAA;AAAA,UAChD;AAAA,SACD,CAAA,oBAAA,EAAuB,gBAAA,CAAiB,QAAA,EAAU,CAAA;AAAA,QACnD,QAAA,EAAS;AAAA,MACX;AAAA,QACE,GAAGC,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,QAAQ,KAAK,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,QAOzD,GAAI,MAAA,IAAU,EAAE,MAAA;AAAsB;AACxC,KACF;AACA,IAAA,IAAI,CAAC,sBAAsB,EAAA,EAAI;AAC7B,MAAA,MAAM,OAAA,GAAU,qCAAqC,GAAG,CAAA,EAAA,EAAK,sBAAsB,MAAM,CAAA,CAAA,EAAI,sBAAsB,UAAU,CAAA,CAAA;AAC7H,MAAA,IAAI,qBAAA,CAAsB,WAAW,GAAA,EAAK;AACxC,QAAA,MAAM,IAAII,qBAAc,OAAO,CAAA;AAAA,MACjC;AACA,MAAA,MAAM,IAAI,MAAM,OAAO,CAAA;AAAA,IACzB;AAEA,IAAA,MAAM,aAAa,MAAM,qBAAA,CAAsB,MAAK,EAAG,CAAC,GAAG,EAAA,IAAM,EAAA;AACjE,IAAA,IAAI,IAAA,IAAQ,SAAS,SAAA,EAAW;AAC9B,MAAA,MAAM,IAAIH,uBAAA,EAAiB;AAAA,IAC7B;AAEA,IAAA,MAAM,gBAAA,GAAmB,IAAI,eAAA,EAAgB;AAC7C,IAAA,gBAAA,CAAiB,GAAA,CAAI,OAAO,MAAM,CAAA;AAClC,IAAA,IAAI,CAAC,CAAC,QAAA,EAAU;AACd,MAAA,gBAAA,CAAiB,GAAA,CAAI,QAAQ,QAAQ,CAAA;AAAA,IACvC;AAEA,IAAA,MAAM,wBAAwB,MAAMF,sBAAA;AAAA,MAClC,CAAA,EAAG,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,UAAU,CAAA,UAAA,EAAa,kBAAA;AAAA,QAChD;AAAA,OACD,CAAA,oBAAA,EAAuB,gBAAA,CAAiB,QAAA,EAAU,CAAA,CAAA;AAAA,MACnD;AAAA,QACE,GAAGC,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,QAAQ,KAAK,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,QAOzD,GAAI,MAAA,IAAU,EAAE,MAAA;AAAsB;AACxC,KACF;AACA,IAAA,IAAI,CAAC,sBAAsB,EAAA,EAAI;AAC7B,MAAA,MAAM,OAAA,GAAU,sCAAsC,GAAG,CAAA,EAAA,EAAK,sBAAsB,MAAM,CAAA,CAAA,EAAI,sBAAsB,UAAU,CAAA,CAAA;AAC9H,MAAA,IAAI,qBAAA,CAAsB,WAAW,GAAA,EAAK;AACxC,QAAA,MAAM,IAAII,qBAAc,OAAO,CAAA;AAAA,MACjC;AACA,MAAA,MAAM,IAAI,MAAM,OAAO,CAAA;AAAA,IACzB;AAEA,IAAA,OAAO,MAAM,IAAA,CAAK,IAAA,CAAK,mBAAA,CAAoB,cAAA,CAAe;AAAA,MACxD,MAAA,EAAQI,oBAAA,CAAS,IAAA,CAAK,qBAAA,CAAsB,IAAI,CAAA;AAAA,MAChD,OAAA,EAAS,QAAA;AAAA,MACT,IAAA,EAAM,SAAA;AAAA,MACN,QAAQ,OAAA,EAAS;AAAA,KAClB,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,MAAA,CACJ,GAAA,EACA,OAAA,EACyC;AACzC,IAAA,MAAM,EAAE,QAAA,EAAS,GAAIH,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,KAAA,EAAO;AACd,QAAAI,kBAAA,CAAY,KAAK,CAAA;AACjB,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,UAAA,GAAa,IAAA,CAAK,aAAA,CAAc,QAAQ,CAAA;AAC9C,IAAA,MAAM,OAAA,GAAU,IAAIC,mBAAA,CAAU,QAAQ,CAAA;AACtC,IAAA,MAAM,UAAUC,cAAA,CAAQ,GAAA,CAAI,QAAQ,QAAA,EAAU,UAAU,GAAG,CAAA,CAAA,CAAG,CAAA;AAC9D,IAAA,MAAM,UAAA,GAAa,UAAA,GAAa,CAAA,EAAG,UAAU,CAAA,CAAA,CAAA,GAAM,EAAA;AACnD,IAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,QAAA,CAAS,OAAA,EAAS;AAAA,MACxC,MAAM,OAAA,EAAS,IAAA;AAAA,MACf,QAAQ,OAAA,EAAS,MAAA;AAAA,MACjB,MAAA,EAAQ,UAAQ,OAAA,CAAQ,KAAA,CAAM,GAAG,UAAU,CAAA,EAAG,IAAI,CAAA,CAAE;AAAA,KACrD,CAAA;AAED,IAAA,MAAM,KAAA,GAAQ,MAAM,IAAA,CAAK,KAAA,EAAM;AAC/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,UAAU,CAAA,EAAG,KAAK,IAAI,CAAA,CAAA;AAAA,UAC/B,IAAA,EAAM;AAAA,SACP,CAAA;AAAA,QACD,SAAS,IAAA,CAAK,OAAA;AAAA,QACd,gBAAgB,IAAA,CAAK;AAAA,OACvB,CAAE;AAAA,KACJ;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaQ,cAAc,WAAA,EAAqB;AACzC,IAAA,MAAM,QAAA,GAAW,WAAA,CAAY,KAAA,CAAM,GAAG,CAAA;AACtC,IAAA,MAAM,YAAY,QAAA,CAAS,SAAA,CAAU,aAAW,OAAA,CAAQ,KAAA,CAAM,MAAM,CAAC,CAAA;AACrE,IAAA,OAAO,SAAA,KAAc,KACjB,WAAA,GACA,QAAA,CAAS,MAAM,CAAA,EAAG,SAAS,CAAA,CAAE,IAAA,CAAK,GAAG,CAAA;AAAA,EAC3C;AAAA,EAEA,QAAA,GAAW;AACT,IAAA,MAAM,EAAE,IAAA,EAAM,KAAA,EAAM,GAAI,KAAK,WAAA,CAAY,MAAA;AACzC,IAAA,OAAO,CAAA,YAAA,EAAe,IAAI,CAAA,QAAA,EAAW,OAAA,CAAQ,KAAK,CAAC,CAAA,CAAA,CAAA;AAAA,EACrD;AAAA,EAEA,MAAc,iBAAA,CACZ,MAAA,EACA,KAAA,EACiB;AAEjB,IAAA,MAAM,SAAA,GAAY,IAAI,GAAA,CAAI,MAAM,CAAA;AAChC,IAAA,IAAI,SAAA,CAAU,QAAA,CAAS,QAAA,CAAS,oBAAoB,CAAA,EAAG;AACrD,MAAA,OAAO,IAAA,CAAK,yBAAA,CAA0B,SAAA,EAAW,KAAK,CAAA,CAAE,IAAA;AAAA,QAAK,CAAA,KAAA,KAC3D,MAAM,QAAA;AAAS,OACjB;AAAA,IACF;AAEA,IAAA,OAAOC,iCAAA,CAAsB,MAAA,EAAQ,IAAA,CAAK,WAAA,CAAY,QAAQ,KAAK,CAAA;AAAA,EACrE;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAc,yBAAA,CACZ,MAAA,EACA,KAAA,EACc;AACd,IAAA,IAAI,CAAC,MAAA,CAAO,QAAA,CAAS,QAAA,CAAS,oBAAoB,CAAA,EAAG;AACnD,MAAA,MAAM,IAAI,MAAM,6CAA6C,CAAA;AAAA,IAC/D;AACA,IAAA,IAAI;AACF,MAAA,MAAM,CAAC,mBAAA,EAAqB,GAAG,IAC7B,MAAA,CAAO,QAAA,CAAS,MAAM,oBAAoB,CAAA;AAC5C,MAAA,MAAM,WAAA,GAAc,IAAI,GAAA,CAAI,MAAM,CAAA;AAClC,MAAA,WAAA,CAAY,QAAA,GAAW,mBAAA;AACvB,MAAA,MAAM,SAAA,GAAY,MAAM,IAAA,CAAK,kBAAA,CAAmB,aAAa,KAAK,CAAA;AAClE,MAAA,MAAM,YAAA,GAAeN,4CAAA;AAAA,QACnB,KAAK,WAAA,CAAY;AAAA,OACnB;AACA,MAAA,MAAM,MAAA,GAAS,IAAI,GAAA,CAAI,MAAM,CAAA;AAC7B,MAAA,MAAA,CAAO,WAAW,CAAA,EAAG,YAAY,CAAA,iBAAA,EAAoB,SAAS,mBAAmB,GAAG,CAAA,CAAA;AACpF,MAAA,OAAO,MAAA;AAAA,IACT,SAAS,CAAA,EAAG;AACV,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,yCAAA,EAA4C,MAAM,CAAA,EAAA,EAAK,CAAC,CAAA;AAAA,OAC1D;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAc,kBAAA,CACZ,aAAA,EACA,KAAA,EACiB;AACjB,IAAA,IAAI,UAAU,aAAA,CAAc,QAAA;AAE5B,IAAA,MAAM,YAAA,GAAeA,4CAAA;AAAA,MACnB,KAAK,WAAA,CAAY;AAAA,KACnB;AACA,IAAA,IAAI,YAAA,EAAc;AAChB,MAAA,OAAA,GAAU,OAAA,CAAQ,OAAA,CAAQ,YAAA,EAAc,EAAE,CAAA;AAAA,IAC5C;AAEA,IAAA,OAAA,GAAU,OAAA,CAAQ,OAAA,CAAQ,KAAA,EAAO,EAAE,CAAA;AACnC,IAAA,MAAM,SAAS,MAAMP,sBAAA;AAAA,MACnB,CAAA,EACE,cAAc,MAChB,CAAA,EAAG,YAAY,CAAA,iBAAA,EAAoB,kBAAA,CAAmB,OAAO,CAAC,CAAA,CAAA;AAAA,MAC9DC,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,MAAA,EAAQ,KAAK;AAAA,KACxD;AACA,IAAA,MAAM,IAAA,GAAO,MAAM,MAAA,CAAO,IAAA,EAAK;AAC/B,IAAA,IAAI,CAAC,OAAO,EAAA,EAAI;AACd,MAAA,IAAI,MAAA,CAAO,WAAW,GAAA,EAAK;AACzB,QAAA,MAAM,IAAI,KAAA;AAAA,UACR;AAAA,SACF;AAAA,MACF;AAEA,MAAA,MAAM,IAAI,MAAM,CAAA,cAAA,EAAiB,IAAA,CAAK,KAAK,CAAA,EAAA,EAAK,IAAA,CAAK,iBAAiB,CAAA,CAAE,CAAA;AAAA,IAC1E;AACA,IAAA,OAAO,MAAA,CAAO,KAAK,EAAE,CAAA;AAAA,EACvB;AACF;;;;"}
|
|
1
|
+
{"version":3,"file":"GitlabUrlReader.cjs.js","sources":["../../../../src/entrypoints/urlReader/lib/GitlabUrlReader.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 assertError,\n NotFoundError,\n NotModifiedError,\n} from '@backstage/errors';\nimport {\n getGitLabFileFetchUrl,\n getGitLabIntegrationRelativePath,\n getGitLabRequestOptions,\n GitLabIntegration,\n ScmIntegrations,\n} from '@backstage/integration';\nimport parseGitUrl from 'git-url-parse';\nimport { trimEnd, trimStart } from 'lodash';\nimport { Minimatch } from 'minimatch';\nimport { ReadUrlResponseFactory } from './ReadUrlResponseFactory';\nimport { ReaderFactory, ReadTreeResponseFactory } from './types';\n\n/**\n * Implements a {@link @backstage/backend-plugin-api#UrlReaderService} for files on GitLab.\n *\n * @public\n */\nexport class GitlabUrlReader implements UrlReaderService {\n static factory: ReaderFactory = ({ config, treeResponseFactory }) => {\n const integrations = ScmIntegrations.fromConfig(config);\n return integrations.gitlab.list().map(integration => {\n const reader = new GitlabUrlReader(integration, {\n treeResponseFactory,\n });\n const predicate = (url: URL) => url.host === integration.config.host;\n return { reader, predicate };\n });\n };\n\n private readonly integration: GitLabIntegration;\n private readonly deps: { treeResponseFactory: ReadTreeResponseFactory };\n\n constructor(\n integration: GitLabIntegration,\n deps: { treeResponseFactory: ReadTreeResponseFactory },\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 const { etag, lastModifiedAfter, signal, token } = options ?? {};\n const isArtifact = url.includes('/-/jobs/artifacts/');\n const builtUrl = await this.getGitlabFetchUrl(url, token);\n\n let response: Response;\n try {\n response = await this.integration.fetch(builtUrl, {\n headers: {\n ...getGitLabRequestOptions(this.integration.config, token).headers,\n ...(etag && !isArtifact && { 'If-None-Match': etag }),\n ...(lastModifiedAfter &&\n !isArtifact && {\n 'If-Modified-Since': lastModifiedAfter.toUTCString(),\n }),\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 } catch (e) {\n throw new Error(`Unable to read ${url}, ${e}`);\n }\n\n if (response.status === 304) {\n throw new NotModifiedError();\n }\n\n if (response.ok) {\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, signal, token } = options ?? {};\n const { ref, full_name, filepath } = parseGitUrl(url);\n\n let repoFullName = full_name;\n\n const relativePath = getGitLabIntegrationRelativePath(\n this.integration.config,\n );\n\n // Considering self hosted gitlab with relative\n // assuming '/gitlab' is the relative path\n // from: /gitlab/repo/project\n // to: repo/project\n if (relativePath) {\n const rectifiedRelativePath = `${trimStart(relativePath, '/')}/`;\n repoFullName = full_name.replace(rectifiedRelativePath, '');\n }\n\n // Use GitLab API to get the default branch\n // encodeURIComponent is required for GitLab API\n // https://docs.gitlab.com/ee/api/README.html#namespaced-path-encoding\n const projectGitlabResponse = await this.integration.fetch(\n new URL(\n `${this.integration.config.apiBaseUrl}/projects/${encodeURIComponent(\n repoFullName,\n )}`,\n ).toString(),\n getGitLabRequestOptions(this.integration.config, token),\n );\n if (!projectGitlabResponse.ok) {\n const msg = `Failed to read tree from ${url}, ${projectGitlabResponse.status} ${projectGitlabResponse.statusText}`;\n if (projectGitlabResponse.status === 404) {\n throw new NotFoundError(msg);\n }\n throw new Error(msg);\n }\n const projectGitlabResponseJson = await projectGitlabResponse.json();\n\n // ref is an empty string if no branch is set in provided url to readTree.\n const branch = ref || projectGitlabResponseJson.default_branch;\n\n // Fetch the latest commit that modifies the filepath in the provided or default branch\n // to compare against the provided sha.\n const commitsReqParams = new URLSearchParams();\n commitsReqParams.set('ref_name', branch);\n if (!!filepath) {\n commitsReqParams.set('path', filepath);\n }\n const commitsGitlabResponse = await this.integration.fetch(\n new URL(\n `${this.integration.config.apiBaseUrl}/projects/${encodeURIComponent(\n repoFullName,\n )}/repository/commits?${commitsReqParams.toString()}`,\n ).toString(),\n {\n ...getGitLabRequestOptions(this.integration.config, token),\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 );\n if (!commitsGitlabResponse.ok) {\n const message = `Failed to read tree (branch) from ${url}, ${commitsGitlabResponse.status} ${commitsGitlabResponse.statusText}`;\n if (commitsGitlabResponse.status === 404) {\n throw new NotFoundError(message);\n }\n throw new Error(message);\n }\n\n const commitSha = (await commitsGitlabResponse.json())[0]?.id ?? '';\n if (etag && etag === commitSha) {\n throw new NotModifiedError();\n }\n\n const archiveReqParams = new URLSearchParams();\n archiveReqParams.set('sha', branch);\n if (!!filepath) {\n archiveReqParams.set('path', filepath);\n }\n // https://docs.gitlab.com/ee/api/repositories.html#get-file-archive\n const reqUrl = `${\n this.integration.config.apiBaseUrl\n }/projects/${encodeURIComponent(\n repoFullName,\n )}/repository/archive?${archiveReqParams.toString()}`;\n const archiveGitLabResponse = await this.integration.fetch(reqUrl, {\n ...getGitLabRequestOptions(this.integration.config, token),\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 if (!archiveGitLabResponse.ok) {\n const message = `Failed to read tree (archive) from ${url}, ${reqUrl}, ${archiveGitLabResponse.status} ${archiveGitLabResponse.statusText}`;\n if (archiveGitLabResponse.status === 404) {\n throw new NotFoundError(message);\n }\n throw new Error(message);\n }\n\n return await this.deps.treeResponseFactory.fromTarArchive({\n response: archiveGitLabResponse,\n subpath: filepath,\n etag: commitSha,\n filter: options?.filter,\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 (error) {\n assertError(error);\n if (error.name === 'NotFoundError') {\n return {\n files: [],\n etag: '',\n };\n }\n throw error;\n }\n }\n\n const staticPart = this.getStaticPart(filepath);\n const matcher = new Minimatch(filepath);\n const treeUrl = trimEnd(url.replace(filepath, staticPart), `/`);\n const pathPrefix = staticPart ? `${staticPart}/` : '';\n const tree = await this.readTree(treeUrl, {\n etag: options?.etag,\n signal: options?.signal,\n filter: path => matcher.match(`${pathPrefix}${path}`),\n });\n\n const files = await tree.files();\n return {\n etag: tree.etag,\n files: files.map(file => ({\n url: this.integration.resolveUrl({\n url: `/${pathPrefix}${file.path}`,\n base: url,\n }),\n content: file.content,\n lastModifiedAt: file.lastModifiedAt,\n })),\n };\n }\n\n /**\n * This function splits the input globPattern string into segments using the path separator /. It then iterates over\n * the segments from the end of the array towards the beginning, checking if the concatenated string up to that\n * segment matches the original globPattern using the minimatch function. If a match is found, it continues iterating.\n * If no match is found, it returns the concatenated string up to the current segment, which is the static part of the\n * glob pattern.\n *\n * E.g. `catalog/foo/*.yaml` will return `catalog/foo`.\n *\n * @param globPattern - the glob pattern\n */\n private getStaticPart(globPattern: string) {\n const segments = globPattern.split('/');\n const globIndex = segments.findIndex(segment => segment.match(/[*?]/));\n return globIndex === -1\n ? globPattern\n : segments.slice(0, globIndex).join('/');\n }\n\n toString() {\n const { host, token } = this.integration.config;\n return `gitlab{host=${host},authed=${Boolean(token)}}`;\n }\n\n private async getGitlabFetchUrl(\n target: string,\n token?: string,\n ): Promise<string> {\n // If the target is for a job artifact then go down that path\n const targetUrl = new URL(target);\n if (targetUrl.pathname.includes('/-/jobs/artifacts/')) {\n return this.getGitlabArtifactFetchUrl(targetUrl).then(value =>\n value.toString(),\n );\n }\n // Default to the optimized behavior - no API call needed for file URLs\n return getGitLabFileFetchUrl(target, this.integration.config, token);\n }\n\n // convert urls of the form:\n // https://example.com/<namespace>/<project>/-/jobs/artifacts/<ref>/raw/<path_to_file>?job=<job_name>\n // to urls of the form:\n // https://example.com/api/v4/projects/namespace%2Fproject/jobs/artifacts/:ref_name/raw/*artifact_path?job=<job_name>\n private getGitlabArtifactFetchUrl(target: URL): Promise<URL> {\n if (!target.pathname.includes('/-/jobs/artifacts/')) {\n throw new Error('Unable to process url as an GitLab artifact');\n }\n try {\n const [namespaceAndProject, ref] =\n target.pathname.split('/-/jobs/artifacts/');\n\n // Extract project path directly instead of making API call\n const relativePath = getGitLabIntegrationRelativePath(\n this.integration.config,\n );\n\n let projectPath = namespaceAndProject;\n // Check relative path exist and remove it\n if (relativePath) {\n projectPath = trimStart(projectPath, relativePath);\n }\n // Trim an initial / if it exists\n projectPath = projectPath.replace(/^\\//, '');\n\n const newUrl = new URL(target);\n newUrl.pathname = `${relativePath}/api/v4/projects/${encodeURIComponent(\n projectPath,\n )}/jobs/artifacts/${ref}`;\n return Promise.resolve(newUrl);\n } catch (e) {\n throw new Error(\n `Unable to translate GitLab artifact URL: ${target}, ${e}`,\n );\n }\n }\n}\n"],"names":["ScmIntegrations","getGitLabRequestOptions","NotModifiedError","ReadUrlResponseFactory","NotFoundError","parseGitUrl","getGitLabIntegrationRelativePath","trimStart","assertError","Minimatch","trimEnd","getGitLabFileFetchUrl"],"mappings":";;;;;;;;;;;;;AAgDO,MAAM,eAAA,CAA4C;AAAA,EACvD,OAAO,OAAA,GAAyB,CAAC,EAAE,MAAA,EAAQ,qBAAoB,KAAM;AACnE,IAAA,MAAM,YAAA,GAAeA,2BAAA,CAAgB,UAAA,CAAW,MAAM,CAAA;AACtD,IAAA,OAAO,YAAA,CAAa,MAAA,CAAO,IAAA,EAAK,CAAE,IAAI,CAAA,WAAA,KAAe;AACnD,MAAA,MAAM,MAAA,GAAS,IAAI,eAAA,CAAgB,WAAA,EAAa;AAAA,QAC9C;AAAA,OACD,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,EAEjB,WAAA,CACE,aACA,IAAA,EACA;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;AAC1C,IAAA,MAAM,EAAE,IAAA,EAAM,iBAAA,EAAmB,QAAQ,KAAA,EAAM,GAAI,WAAW,EAAC;AAC/D,IAAA,MAAM,UAAA,GAAa,GAAA,CAAI,QAAA,CAAS,oBAAoB,CAAA;AACpD,IAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,iBAAA,CAAkB,KAAK,KAAK,CAAA;AAExD,IAAA,IAAI,QAAA;AACJ,IAAA,IAAI;AACF,MAAA,QAAA,GAAW,MAAM,IAAA,CAAK,WAAA,CAAY,KAAA,CAAM,QAAA,EAAU;AAAA,QAChD,OAAA,EAAS;AAAA,UACP,GAAGC,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,MAAA,EAAQ,KAAK,CAAA,CAAE,OAAA;AAAA,UAC3D,GAAI,IAAA,IAAQ,CAAC,UAAA,IAAc,EAAE,iBAAiB,IAAA,EAAK;AAAA,UACnD,GAAI,iBAAA,IACF,CAAC,UAAA,IAAc;AAAA,YACb,mBAAA,EAAqB,kBAAkB,WAAA;AAAY;AACrD,SACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,QAOA,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;AAEA,IAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,MAAA,MAAM,IAAIC,uBAAA,EAAiB;AAAA,IAC7B;AAEA,IAAA,IAAI,SAAS,EAAA,EAAI;AACf,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,KAAA,EAAM,GAAI,WAAW,EAAC;AAC5C,IAAA,MAAM,EAAE,GAAA,EAAK,SAAA,EAAW,QAAA,EAAS,GAAIC,6BAAY,GAAG,CAAA;AAEpD,IAAA,IAAI,YAAA,GAAe,SAAA;AAEnB,IAAA,MAAM,YAAA,GAAeC,4CAAA;AAAA,MACnB,KAAK,WAAA,CAAY;AAAA,KACnB;AAMA,IAAA,IAAI,YAAA,EAAc;AAChB,MAAA,MAAM,qBAAA,GAAwB,CAAA,EAAGC,gBAAA,CAAU,YAAA,EAAc,GAAG,CAAC,CAAA,CAAA,CAAA;AAC7D,MAAA,YAAA,GAAe,SAAA,CAAU,OAAA,CAAQ,qBAAA,EAAuB,EAAE,CAAA;AAAA,IAC5D;AAKA,IAAA,MAAM,qBAAA,GAAwB,MAAM,IAAA,CAAK,WAAA,CAAY,KAAA;AAAA,MACnD,IAAI,GAAA;AAAA,QACF,CAAA,EAAG,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,UAAU,CAAA,UAAA,EAAa,kBAAA;AAAA,UAChD;AAAA,SACD,CAAA;AAAA,QACD,QAAA,EAAS;AAAA,MACXN,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,MAAA,EAAQ,KAAK;AAAA,KACxD;AACA,IAAA,IAAI,CAAC,sBAAsB,EAAA,EAAI;AAC7B,MAAA,MAAM,GAAA,GAAM,4BAA4B,GAAG,CAAA,EAAA,EAAK,sBAAsB,MAAM,CAAA,CAAA,EAAI,sBAAsB,UAAU,CAAA,CAAA;AAChH,MAAA,IAAI,qBAAA,CAAsB,WAAW,GAAA,EAAK;AACxC,QAAA,MAAM,IAAIG,qBAAc,GAAG,CAAA;AAAA,MAC7B;AACA,MAAA,MAAM,IAAI,MAAM,GAAG,CAAA;AAAA,IACrB;AACA,IAAA,MAAM,yBAAA,GAA4B,MAAM,qBAAA,CAAsB,IAAA,EAAK;AAGnE,IAAA,MAAM,MAAA,GAAS,OAAO,yBAAA,CAA0B,cAAA;AAIhD,IAAA,MAAM,gBAAA,GAAmB,IAAI,eAAA,EAAgB;AAC7C,IAAA,gBAAA,CAAiB,GAAA,CAAI,YAAY,MAAM,CAAA;AACvC,IAAA,IAAI,CAAC,CAAC,QAAA,EAAU;AACd,MAAA,gBAAA,CAAiB,GAAA,CAAI,QAAQ,QAAQ,CAAA;AAAA,IACvC;AACA,IAAA,MAAM,qBAAA,GAAwB,MAAM,IAAA,CAAK,WAAA,CAAY,KAAA;AAAA,MACnD,IAAI,GAAA;AAAA,QACF,CAAA,EAAG,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,UAAU,CAAA,UAAA,EAAa,kBAAA;AAAA,UAChD;AAAA,SACD,CAAA,oBAAA,EAAuB,gBAAA,CAAiB,QAAA,EAAU,CAAA;AAAA,QACnD,QAAA,EAAS;AAAA,MACX;AAAA,QACE,GAAGH,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,QAAQ,KAAK,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,QAOzD,GAAI,MAAA,IAAU,EAAE,MAAA;AAAsB;AACxC,KACF;AACA,IAAA,IAAI,CAAC,sBAAsB,EAAA,EAAI;AAC7B,MAAA,MAAM,OAAA,GAAU,qCAAqC,GAAG,CAAA,EAAA,EAAK,sBAAsB,MAAM,CAAA,CAAA,EAAI,sBAAsB,UAAU,CAAA,CAAA;AAC7H,MAAA,IAAI,qBAAA,CAAsB,WAAW,GAAA,EAAK;AACxC,QAAA,MAAM,IAAIG,qBAAc,OAAO,CAAA;AAAA,MACjC;AACA,MAAA,MAAM,IAAI,MAAM,OAAO,CAAA;AAAA,IACzB;AAEA,IAAA,MAAM,aAAa,MAAM,qBAAA,CAAsB,MAAK,EAAG,CAAC,GAAG,EAAA,IAAM,EAAA;AACjE,IAAA,IAAI,IAAA,IAAQ,SAAS,SAAA,EAAW;AAC9B,MAAA,MAAM,IAAIF,uBAAA,EAAiB;AAAA,IAC7B;AAEA,IAAA,MAAM,gBAAA,GAAmB,IAAI,eAAA,EAAgB;AAC7C,IAAA,gBAAA,CAAiB,GAAA,CAAI,OAAO,MAAM,CAAA;AAClC,IAAA,IAAI,CAAC,CAAC,QAAA,EAAU;AACd,MAAA,gBAAA,CAAiB,GAAA,CAAI,QAAQ,QAAQ,CAAA;AAAA,IACvC;AAEA,IAAA,MAAM,SAAS,CAAA,EACb,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,UAC1B,CAAA,UAAA,EAAa,kBAAA;AAAA,MACX;AAAA,KACD,CAAA,oBAAA,EAAuB,gBAAA,CAAiB,QAAA,EAAU,CAAA,CAAA;AACnD,IAAA,MAAM,qBAAA,GAAwB,MAAM,IAAA,CAAK,WAAA,CAAY,MAAM,MAAA,EAAQ;AAAA,MACjE,GAAGD,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,QAAQ,KAAK,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAOzD,GAAI,MAAA,IAAU,EAAE,MAAA;AAAsB,KACvC,CAAA;AACD,IAAA,IAAI,CAAC,sBAAsB,EAAA,EAAI;AAC7B,MAAA,MAAM,OAAA,GAAU,CAAA,mCAAA,EAAsC,GAAG,CAAA,EAAA,EAAK,MAAM,KAAK,qBAAA,CAAsB,MAAM,CAAA,CAAA,EAAI,qBAAA,CAAsB,UAAU,CAAA,CAAA;AACzI,MAAA,IAAI,qBAAA,CAAsB,WAAW,GAAA,EAAK;AACxC,QAAA,MAAM,IAAIG,qBAAc,OAAO,CAAA;AAAA,MACjC;AACA,MAAA,MAAM,IAAI,MAAM,OAAO,CAAA;AAAA,IACzB;AAEA,IAAA,OAAO,MAAM,IAAA,CAAK,IAAA,CAAK,mBAAA,CAAoB,cAAA,CAAe;AAAA,MACxD,QAAA,EAAU,qBAAA;AAAA,MACV,OAAA,EAAS,QAAA;AAAA,MACT,IAAA,EAAM,SAAA;AAAA,MACN,QAAQ,OAAA,EAAS;AAAA,KAClB,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,MAAA,CACJ,GAAA,EACA,OAAA,EACyC;AACzC,IAAA,MAAM,EAAE,QAAA,EAAS,GAAIC,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,KAAA,EAAO;AACd,QAAAG,kBAAA,CAAY,KAAK,CAAA;AACjB,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,UAAA,GAAa,IAAA,CAAK,aAAA,CAAc,QAAQ,CAAA;AAC9C,IAAA,MAAM,OAAA,GAAU,IAAIC,mBAAA,CAAU,QAAQ,CAAA;AACtC,IAAA,MAAM,UAAUC,cAAA,CAAQ,GAAA,CAAI,QAAQ,QAAA,EAAU,UAAU,GAAG,CAAA,CAAA,CAAG,CAAA;AAC9D,IAAA,MAAM,UAAA,GAAa,UAAA,GAAa,CAAA,EAAG,UAAU,CAAA,CAAA,CAAA,GAAM,EAAA;AACnD,IAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,QAAA,CAAS,OAAA,EAAS;AAAA,MACxC,MAAM,OAAA,EAAS,IAAA;AAAA,MACf,QAAQ,OAAA,EAAS,MAAA;AAAA,MACjB,MAAA,EAAQ,UAAQ,OAAA,CAAQ,KAAA,CAAM,GAAG,UAAU,CAAA,EAAG,IAAI,CAAA,CAAE;AAAA,KACrD,CAAA;AAED,IAAA,MAAM,KAAA,GAAQ,MAAM,IAAA,CAAK,KAAA,EAAM;AAC/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,UAAU,CAAA,EAAG,KAAK,IAAI,CAAA,CAAA;AAAA,UAC/B,IAAA,EAAM;AAAA,SACP,CAAA;AAAA,QACD,SAAS,IAAA,CAAK,OAAA;AAAA,QACd,gBAAgB,IAAA,CAAK;AAAA,OACvB,CAAE;AAAA,KACJ;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaQ,cAAc,WAAA,EAAqB;AACzC,IAAA,MAAM,QAAA,GAAW,WAAA,CAAY,KAAA,CAAM,GAAG,CAAA;AACtC,IAAA,MAAM,YAAY,QAAA,CAAS,SAAA,CAAU,aAAW,OAAA,CAAQ,KAAA,CAAM,MAAM,CAAC,CAAA;AACrE,IAAA,OAAO,SAAA,KAAc,KACjB,WAAA,GACA,QAAA,CAAS,MAAM,CAAA,EAAG,SAAS,CAAA,CAAE,IAAA,CAAK,GAAG,CAAA;AAAA,EAC3C;AAAA,EAEA,QAAA,GAAW;AACT,IAAA,MAAM,EAAE,IAAA,EAAM,KAAA,EAAM,GAAI,KAAK,WAAA,CAAY,MAAA;AACzC,IAAA,OAAO,CAAA,YAAA,EAAe,IAAI,CAAA,QAAA,EAAW,OAAA,CAAQ,KAAK,CAAC,CAAA,CAAA,CAAA;AAAA,EACrD;AAAA,EAEA,MAAc,iBAAA,CACZ,MAAA,EACA,KAAA,EACiB;AAEjB,IAAA,MAAM,SAAA,GAAY,IAAI,GAAA,CAAI,MAAM,CAAA;AAChC,IAAA,IAAI,SAAA,CAAU,QAAA,CAAS,QAAA,CAAS,oBAAoB,CAAA,EAAG;AACrD,MAAA,OAAO,IAAA,CAAK,yBAAA,CAA0B,SAAS,CAAA,CAAE,IAAA;AAAA,QAAK,CAAA,KAAA,KACpD,MAAM,QAAA;AAAS,OACjB;AAAA,IACF;AAEA,IAAA,OAAOC,iCAAA,CAAsB,MAAA,EAAQ,IAAA,CAAK,WAAA,CAAY,QAAQ,KAAK,CAAA;AAAA,EACrE;AAAA;AAAA;AAAA;AAAA;AAAA,EAMQ,0BAA0B,MAAA,EAA2B;AAC3D,IAAA,IAAI,CAAC,MAAA,CAAO,QAAA,CAAS,QAAA,CAAS,oBAAoB,CAAA,EAAG;AACnD,MAAA,MAAM,IAAI,MAAM,6CAA6C,CAAA;AAAA,IAC/D;AACA,IAAA,IAAI;AACF,MAAA,MAAM,CAAC,mBAAA,EAAqB,GAAG,IAC7B,MAAA,CAAO,QAAA,CAAS,MAAM,oBAAoB,CAAA;AAG5C,MAAA,MAAM,YAAA,GAAeL,4CAAA;AAAA,QACnB,KAAK,WAAA,CAAY;AAAA,OACnB;AAEA,MAAA,IAAI,WAAA,GAAc,mBAAA;AAElB,MAAA,IAAI,YAAA,EAAc;AAChB,QAAA,WAAA,GAAcC,gBAAA,CAAU,aAAa,YAAY,CAAA;AAAA,MACnD;AAEA,MAAA,WAAA,GAAc,WAAA,CAAY,OAAA,CAAQ,KAAA,EAAO,EAAE,CAAA;AAE3C,MAAA,MAAM,MAAA,GAAS,IAAI,GAAA,CAAI,MAAM,CAAA;AAC7B,MAAA,MAAA,CAAO,QAAA,GAAW,CAAA,EAAG,YAAY,CAAA,iBAAA,EAAoB,kBAAA;AAAA,QACnD;AAAA,OACD,mBAAmB,GAAG,CAAA,CAAA;AACvB,MAAA,OAAO,OAAA,CAAQ,QAAQ,MAAM,CAAA;AAAA,IAC/B,SAAS,CAAA,EAAG;AACV,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,yCAAA,EAA4C,MAAM,CAAA,EAAA,EAAK,CAAC,CAAA;AAAA,OAC1D;AAAA,IACF;AAAA,EACF;AACF;;;;"}
|
package/dist/httpRouter.cjs.js
CHANGED
|
@@ -5,6 +5,7 @@ var createAuthIntegrationRouter = require('./entrypoints/httpRouter/http/createA
|
|
|
5
5
|
var createCredentialsBarrier = require('./entrypoints/httpRouter/http/createCredentialsBarrier.cjs.js');
|
|
6
6
|
var createLifecycleMiddleware = require('./entrypoints/httpRouter/http/createLifecycleMiddleware.cjs.js');
|
|
7
7
|
var createCookieAuthRefreshMiddleware = require('./entrypoints/httpRouter/http/createCookieAuthRefreshMiddleware.cjs.js');
|
|
8
|
+
var createRateLimitMiddleware = require('./entrypoints/httpRouter/http/createRateLimitMiddleware.cjs.js');
|
|
8
9
|
|
|
9
10
|
|
|
10
11
|
|
|
@@ -13,4 +14,5 @@ exports.createAuthIntegrationRouter = createAuthIntegrationRouter.createAuthInte
|
|
|
13
14
|
exports.createCredentialsBarrier = createCredentialsBarrier.createCredentialsBarrier;
|
|
14
15
|
exports.createLifecycleMiddleware = createLifecycleMiddleware.createLifecycleMiddleware;
|
|
15
16
|
exports.createCookieAuthRefreshMiddleware = createCookieAuthRefreshMiddleware.createCookieAuthRefreshMiddleware;
|
|
17
|
+
exports.createRateLimitMiddleware = createRateLimitMiddleware.createRateLimitMiddleware;
|
|
16
18
|
//# sourceMappingURL=httpRouter.cjs.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"httpRouter.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"httpRouter.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;"}
|
package/dist/httpRouter.d.ts
CHANGED
|
@@ -65,5 +65,14 @@ declare function createCookieAuthRefreshMiddleware(options: {
|
|
|
65
65
|
httpAuth: HttpAuthService;
|
|
66
66
|
}): express.Router;
|
|
67
67
|
|
|
68
|
-
|
|
68
|
+
/**
|
|
69
|
+
* @public
|
|
70
|
+
* Creates a middleware that applies rate limiting to requests based on the provided configuration.
|
|
71
|
+
*/
|
|
72
|
+
declare const createRateLimitMiddleware: (options: {
|
|
73
|
+
pluginId: string;
|
|
74
|
+
config: RootConfigService;
|
|
75
|
+
}) => RequestHandler;
|
|
76
|
+
|
|
77
|
+
export { createAuthIntegrationRouter, createCookieAuthRefreshMiddleware, createCredentialsBarrier, createLifecycleMiddleware, createRateLimitMiddleware, httpRouterServiceFactory };
|
|
69
78
|
export type { LifecycleMiddlewareOptions };
|
package/dist/package.json.cjs.js
CHANGED
package/dist/urlReader.d.ts
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/backend-defaults",
|
|
3
|
-
"version": "0.15.
|
|
3
|
+
"version": "0.15.3-next.0",
|
|
4
4
|
"description": "Backend defaults used by Backstage backend apps",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "node-library"
|
|
@@ -217,18 +217,18 @@
|
|
|
217
217
|
"@aws-sdk/types": "^3.347.0",
|
|
218
218
|
"@azure/identity": "^4.0.0",
|
|
219
219
|
"@azure/storage-blob": "^12.5.0",
|
|
220
|
-
"@backstage/backend-app-api": "1.5.
|
|
221
|
-
"@backstage/backend-dev-utils": "0.1.7
|
|
222
|
-
"@backstage/backend-plugin-api": "1.7.
|
|
223
|
-
"@backstage/cli-node": "0.2.
|
|
220
|
+
"@backstage/backend-app-api": "1.5.1-next.0",
|
|
221
|
+
"@backstage/backend-dev-utils": "0.1.7",
|
|
222
|
+
"@backstage/backend-plugin-api": "1.7.1-next.0",
|
|
223
|
+
"@backstage/cli-node": "0.2.19-next.0",
|
|
224
224
|
"@backstage/config": "1.3.6",
|
|
225
|
-
"@backstage/config-loader": "1.10.
|
|
225
|
+
"@backstage/config-loader": "1.10.9-next.0",
|
|
226
226
|
"@backstage/errors": "1.2.7",
|
|
227
|
-
"@backstage/integration": "1.
|
|
228
|
-
"@backstage/integration-aws-node": "0.1.20
|
|
229
|
-
"@backstage/plugin-auth-node": "0.6.
|
|
230
|
-
"@backstage/plugin-events-node": "0.4.
|
|
231
|
-
"@backstage/plugin-permission-node": "0.10.
|
|
227
|
+
"@backstage/integration": "1.21.0-next.0",
|
|
228
|
+
"@backstage/integration-aws-node": "0.1.20",
|
|
229
|
+
"@backstage/plugin-auth-node": "0.6.14-next.0",
|
|
230
|
+
"@backstage/plugin-events-node": "0.4.20-next.0",
|
|
231
|
+
"@backstage/plugin-permission-node": "0.10.11-next.0",
|
|
232
232
|
"@backstage/types": "1.2.2",
|
|
233
233
|
"@google-cloud/storage": "^7.0.0",
|
|
234
234
|
"@keyv/memcache": "^2.0.1",
|
|
@@ -260,7 +260,7 @@
|
|
|
260
260
|
"lodash": "^4.17.21",
|
|
261
261
|
"logform": "^2.3.2",
|
|
262
262
|
"luxon": "^3.0.0",
|
|
263
|
-
"minimatch": "^
|
|
263
|
+
"minimatch": "^10.2.1",
|
|
264
264
|
"mysql2": "^3.0.0",
|
|
265
265
|
"node-fetch": "^2.7.0",
|
|
266
266
|
"node-forge": "^1.3.2",
|
|
@@ -284,9 +284,9 @@
|
|
|
284
284
|
},
|
|
285
285
|
"devDependencies": {
|
|
286
286
|
"@aws-sdk/util-stream-node": "^3.350.0",
|
|
287
|
-
"@backstage/backend-plugin-api": "1.7.
|
|
288
|
-
"@backstage/backend-test-utils": "1.
|
|
289
|
-
"@backstage/cli": "0.35.
|
|
287
|
+
"@backstage/backend-plugin-api": "1.7.1-next.0",
|
|
288
|
+
"@backstage/backend-test-utils": "1.11.1-next.0",
|
|
289
|
+
"@backstage/cli": "0.35.5-next.0",
|
|
290
290
|
"@google-cloud/cloud-sql-connector": "^1.4.0",
|
|
291
291
|
"@types/archiver": "^7.0.0",
|
|
292
292
|
"@types/base64-stream": "^1.0.2",
|