@backstage-community/plugin-3scale-backend 3.0.3 → 3.0.4
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
CHANGED
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
## @janus-idp/backstage-plugin-3scale-backend [1.8.0](https://github.com/janus-idp/backstage-plugins/compare/@janus-idp/backstage-plugin-3scale-backend@1.7.1...@janus-idp/backstage-plugin-3scale-backend@1.8.0) (2024-07-25)
|
|
2
2
|
|
|
3
|
+
## 3.0.4
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- cf44ca3: Clean up api report warnings and remove unnecessary files
|
|
8
|
+
|
|
3
9
|
## 3.0.3
|
|
4
10
|
|
|
5
11
|
### Patch Changes
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ThreeScaleAPIConnector.cjs.js","sources":["../../src/clients/ThreeScaleAPIConnector.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 */\nimport type { APIDocs, Proxy, Services } from './types';\n\nexport function listServices(\n baseUrl: string,\n access_token: string,\n page: number,\n size: number,\n): Promise<Services> {\n return fetch(\n `${baseUrl}/admin/api/services.json?access_token=${access_token}&page=${page}&size=${size}`,\n ).then(response => {\n if (!response.ok) {\n throw new Error(response.statusText);\n }\n return response.json() as Promise<Services>;\n });\n}\n\nexport function listApiDocs(\n baseUrl: string,\n access_token: string,\n): Promise<APIDocs> {\n return fetch(\n `${baseUrl}/admin/api/active_docs.json?access_token=${access_token}`,\n ).then(response => {\n if (!response.ok) {\n throw new Error(response.statusText);\n }\n return response.json() as Promise<APIDocs>;\n });\n}\n\nexport function getProxyConfig(\n baseUrl: string,\n access_token: string,\n service_id: number,\n): Promise<Proxy> {\n return fetch(\n `${baseUrl}/admin/api/services/${service_id}/proxy.json?access_token=${access_token}`,\n ).then(response => {\n if (!response.ok) {\n throw new Error(response.statusText);\n }\n return response.json() as Promise<Proxy>;\n });\n}\n"],"names":[],"mappings":";;
|
|
1
|
+
{"version":3,"file":"ThreeScaleAPIConnector.cjs.js","sources":["../../src/clients/ThreeScaleAPIConnector.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 */\nimport type { APIDocs, Proxy, Services } from './types';\n\n/**\n * @internal\n */\nexport function listServices(\n baseUrl: string,\n access_token: string,\n page: number,\n size: number,\n): Promise<Services> {\n return fetch(\n `${baseUrl}/admin/api/services.json?access_token=${access_token}&page=${page}&size=${size}`,\n ).then(response => {\n if (!response.ok) {\n throw new Error(response.statusText);\n }\n return response.json() as Promise<Services>;\n });\n}\n\n/**\n * @internal\n */\nexport function listApiDocs(\n baseUrl: string,\n access_token: string,\n): Promise<APIDocs> {\n return fetch(\n `${baseUrl}/admin/api/active_docs.json?access_token=${access_token}`,\n ).then(response => {\n if (!response.ok) {\n throw new Error(response.statusText);\n }\n return response.json() as Promise<APIDocs>;\n });\n}\n\n/**\n * @internal\n */\nexport function getProxyConfig(\n baseUrl: string,\n access_token: string,\n service_id: number,\n): Promise<Proxy> {\n return fetch(\n `${baseUrl}/admin/api/services/${service_id}/proxy.json?access_token=${access_token}`,\n ).then(response => {\n if (!response.ok) {\n throw new Error(response.statusText);\n }\n return response.json() as Promise<Proxy>;\n });\n}\n"],"names":[],"mappings":";;AAoBO,SAAS,YACd,CAAA,OAAA,EACA,YACA,EAAA,IAAA,EACA,IACmB,EAAA;AACnB,EAAO,OAAA,KAAA;AAAA,IACL,GAAG,OAAO,CAAA,sCAAA,EAAyC,YAAY,CAAS,MAAA,EAAA,IAAI,SAAS,IAAI,CAAA,CAAA;AAAA,GAC3F,CAAE,KAAK,CAAY,QAAA,KAAA;AACjB,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAM,MAAA,IAAI,KAAM,CAAA,QAAA,CAAS,UAAU,CAAA,CAAA;AAAA,KACrC;AACA,IAAA,OAAO,SAAS,IAAK,EAAA,CAAA;AAAA,GACtB,CAAA,CAAA;AACH,CAAA;AAKgB,SAAA,WAAA,CACd,SACA,YACkB,EAAA;AAClB,EAAO,OAAA,KAAA;AAAA,IACL,CAAA,EAAG,OAAO,CAAA,yCAAA,EAA4C,YAAY,CAAA,CAAA;AAAA,GACpE,CAAE,KAAK,CAAY,QAAA,KAAA;AACjB,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAM,MAAA,IAAI,KAAM,CAAA,QAAA,CAAS,UAAU,CAAA,CAAA;AAAA,KACrC;AACA,IAAA,OAAO,SAAS,IAAK,EAAA,CAAA;AAAA,GACtB,CAAA,CAAA;AACH,CAAA;AAKgB,SAAA,cAAA,CACd,OACA,EAAA,YAAA,EACA,UACgB,EAAA;AAChB,EAAO,OAAA,KAAA;AAAA,IACL,CAAG,EAAA,OAAO,CAAuB,oBAAA,EAAA,UAAU,4BAA4B,YAAY,CAAA,CAAA;AAAA,GACrF,CAAE,KAAK,CAAY,QAAA,KAAA;AACjB,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAM,MAAA,IAAI,KAAM,CAAA,QAAA,CAAS,UAAU,CAAA,CAAA;AAAA,KACrC;AACA,IAAA,OAAO,SAAS,IAAK,EAAA,CAAA;AAAA,GACtB,CAAA,CAAA;AACH;;;;;;"}
|
package/dist/index.d.ts
CHANGED
|
@@ -3,110 +3,14 @@ import { LoggerService, SchedulerServiceTaskRunner, SchedulerService } from '@ba
|
|
|
3
3
|
import { Config } from '@backstage/config';
|
|
4
4
|
import { EntityProvider, EntityProviderConnection } from '@backstage/plugin-catalog-node';
|
|
5
5
|
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
interface ServiceElement {
|
|
10
|
-
service: ServiceService;
|
|
11
|
-
}
|
|
12
|
-
interface ServiceService {
|
|
13
|
-
id: number;
|
|
14
|
-
name: string;
|
|
15
|
-
state: string;
|
|
16
|
-
system_name: string;
|
|
17
|
-
backend_version: string;
|
|
18
|
-
deployment_option: string;
|
|
19
|
-
support_email: string;
|
|
20
|
-
description: string;
|
|
21
|
-
intentions_required: boolean;
|
|
22
|
-
buyers_manage_apps: boolean;
|
|
23
|
-
buyers_manage_keys: boolean;
|
|
24
|
-
referrer_filters_required: boolean;
|
|
25
|
-
custom_keys_enabled: boolean;
|
|
26
|
-
buyer_key_regenerate_enabled: boolean;
|
|
27
|
-
mandatory_app_key: boolean;
|
|
28
|
-
buyer_can_select_plan: boolean;
|
|
29
|
-
buyer_plan_change_permission: string;
|
|
30
|
-
created_at: Date;
|
|
31
|
-
updated_at: Date;
|
|
32
|
-
links: Link[];
|
|
33
|
-
}
|
|
34
|
-
interface Link {
|
|
35
|
-
rel: string;
|
|
36
|
-
href: string;
|
|
37
|
-
}
|
|
38
|
-
interface APIDocs {
|
|
39
|
-
api_docs: APIDocElement[];
|
|
40
|
-
}
|
|
41
|
-
interface APIDocElement {
|
|
42
|
-
api_doc: APIDoc;
|
|
43
|
-
}
|
|
44
|
-
interface APIDoc {
|
|
45
|
-
id: number;
|
|
46
|
-
system_name: string;
|
|
47
|
-
name: string;
|
|
48
|
-
published: boolean;
|
|
49
|
-
skip_swagger_validations: boolean;
|
|
50
|
-
body: string;
|
|
51
|
-
created_at: Date;
|
|
52
|
-
updated_at: Date;
|
|
53
|
-
description?: string;
|
|
54
|
-
service_id?: number;
|
|
55
|
-
}
|
|
56
|
-
interface Proxy {
|
|
57
|
-
proxy: ProxyElement;
|
|
58
|
-
}
|
|
59
|
-
interface ProxyElement {
|
|
60
|
-
service_id: number;
|
|
61
|
-
endpoint: string;
|
|
62
|
-
api_backend: string;
|
|
63
|
-
credentials_location: string;
|
|
64
|
-
auth_app_key: string;
|
|
65
|
-
auth_app_id: string;
|
|
66
|
-
auth_user_key: string;
|
|
67
|
-
error_auth_failed: string;
|
|
68
|
-
error_auth_missing: string;
|
|
69
|
-
error_status_auth_failed: number;
|
|
70
|
-
error_headers_auth_failed: string;
|
|
71
|
-
error_status_auth_missing: number;
|
|
72
|
-
error_headers_auth_missing: string;
|
|
73
|
-
error_no_match: string;
|
|
74
|
-
error_status_no_match: number;
|
|
75
|
-
error_headers_no_match: string;
|
|
76
|
-
error_limits_exceeded: string;
|
|
77
|
-
error_status_limits_exceeded: number;
|
|
78
|
-
error_headers_limits_exceeded: string;
|
|
79
|
-
secret_token: string;
|
|
80
|
-
sandbox_endpoint: string;
|
|
81
|
-
api_test_path: string;
|
|
82
|
-
policies_config: PoliciesConfig[];
|
|
83
|
-
created_at: Date;
|
|
84
|
-
updated_at: Date;
|
|
85
|
-
deployment_option: string;
|
|
86
|
-
lock_version: number;
|
|
87
|
-
links: Link[];
|
|
88
|
-
}
|
|
89
|
-
interface PoliciesConfig {
|
|
90
|
-
name: string;
|
|
91
|
-
version: string;
|
|
92
|
-
configuration: Configuration;
|
|
93
|
-
enabled: boolean;
|
|
94
|
-
}
|
|
95
|
-
interface Configuration {
|
|
96
|
-
commands?: Command[];
|
|
97
|
-
}
|
|
98
|
-
interface Command {
|
|
99
|
-
op: string;
|
|
100
|
-
regex: string;
|
|
101
|
-
replace: string;
|
|
102
|
-
}
|
|
103
|
-
|
|
104
|
-
declare function listServices(baseUrl: string, access_token: string, page: number, size: number): Promise<Services>;
|
|
105
|
-
declare function listApiDocs(baseUrl: string, access_token: string): Promise<APIDocs>;
|
|
106
|
-
declare function getProxyConfig(baseUrl: string, access_token: string, service_id: number): Promise<Proxy>;
|
|
107
|
-
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
108
9
|
declare const catalogModule3ScaleEntityProvider: _backstage_backend_plugin_api.BackendFeature;
|
|
109
10
|
|
|
11
|
+
/**
|
|
12
|
+
* @public
|
|
13
|
+
*/
|
|
110
14
|
declare class ThreeScaleApiEntityProvider implements EntityProvider {
|
|
111
15
|
private static SERVICES_FETCH_SIZE;
|
|
112
16
|
private readonly env;
|
|
@@ -131,4 +35,4 @@ declare class ThreeScaleApiEntityProvider implements EntityProvider {
|
|
|
131
35
|
private buildApiEntityFromService;
|
|
132
36
|
}
|
|
133
37
|
|
|
134
|
-
export { ThreeScaleApiEntityProvider, catalogModule3ScaleEntityProvider as default
|
|
38
|
+
export { ThreeScaleApiEntityProvider, catalogModule3ScaleEntityProvider as default };
|
package/dist/module.cjs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"module.cjs.js","sources":["../src/module.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 createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';\n\nimport { ThreeScaleApiEntityProvider } from './providers';\n\nexport const catalogModule3ScaleEntityProvider = createBackendModule({\n moduleId: 'catalog-backend-module-3scale',\n pluginId: 'catalog',\n register(env) {\n env.registerInit({\n deps: {\n catalog: catalogProcessingExtensionPoint,\n config: coreServices.rootConfig,\n logger: coreServices.logger,\n scheduler: coreServices.scheduler,\n },\n async init({ catalog, config, logger, scheduler }) {\n catalog.addEntityProvider(\n ThreeScaleApiEntityProvider.fromConfig(\n { config, logger },\n {\n scheduler: scheduler,\n schedule: scheduler.createScheduledTaskRunner({\n frequency: { minutes: 30 },\n timeout: { minutes: 3 },\n }),\n },\n ),\n );\n },\n });\n },\n});\n"],"names":["createBackendModule","catalogProcessingExtensionPoint","coreServices","ThreeScaleApiEntityProvider"],"mappings":";;;;;;
|
|
1
|
+
{"version":3,"file":"module.cjs.js","sources":["../src/module.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 createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';\n\nimport { ThreeScaleApiEntityProvider } from './providers';\n\n/**\n * @public\n */\nexport const catalogModule3ScaleEntityProvider = createBackendModule({\n moduleId: 'catalog-backend-module-3scale',\n pluginId: 'catalog',\n register(env) {\n env.registerInit({\n deps: {\n catalog: catalogProcessingExtensionPoint,\n config: coreServices.rootConfig,\n logger: coreServices.logger,\n scheduler: coreServices.scheduler,\n },\n async init({ catalog, config, logger, scheduler }) {\n catalog.addEntityProvider(\n ThreeScaleApiEntityProvider.fromConfig(\n { config, logger },\n {\n scheduler: scheduler,\n schedule: scheduler.createScheduledTaskRunner({\n frequency: { minutes: 30 },\n timeout: { minutes: 3 },\n }),\n },\n ),\n );\n },\n });\n },\n});\n"],"names":["createBackendModule","catalogProcessingExtensionPoint","coreServices","ThreeScaleApiEntityProvider"],"mappings":";;;;;;AA2BO,MAAM,oCAAoCA,oCAAoB,CAAA;AAAA,EACnE,QAAU,EAAA,+BAAA;AAAA,EACV,QAAU,EAAA,SAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,OAAS,EAAAC,qCAAA;AAAA,QACT,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,OAC1B;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,SAAS,MAAQ,EAAA,MAAA,EAAQ,WAAa,EAAA;AACjD,QAAQ,OAAA,CAAA,iBAAA;AAAA,UACNC,uDAA4B,CAAA,UAAA;AAAA,YAC1B,EAAE,QAAQ,MAAO,EAAA;AAAA,YACjB;AAAA,cACE,SAAA;AAAA,cACA,QAAA,EAAU,UAAU,yBAA0B,CAAA;AAAA,gBAC5C,SAAA,EAAW,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,gBACzB,OAAA,EAAS,EAAE,OAAA,EAAS,CAAE,EAAA;AAAA,eACvB,CAAA;AAAA,aACH;AAAA,WACF;AAAA,SACF,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ThreeScaleApiEntityProvider.cjs.js","sources":["../../src/providers/ThreeScaleApiEntityProvider.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 type {\n SchedulerServiceTaskRunner,\n SchedulerService,\n LoggerService,\n} from '@backstage/backend-plugin-api';\nimport {\n ANNOTATION_LOCATION,\n ANNOTATION_ORIGIN_LOCATION,\n ApiEntity,\n Entity,\n} from '@backstage/catalog-model';\n\nimport type { Config } from '@backstage/config';\nimport { InputError, isError, NotFoundError } from '@backstage/errors';\n\nimport {\n EntityProvider,\n EntityProviderConnection,\n} from '@backstage/plugin-catalog-node';\n\nimport {\n getProxyConfig,\n listApiDocs,\n listServices,\n} from '../clients/ThreeScaleAPIConnector';\nimport type {\n APIDocElement,\n APIDocs,\n Proxy,\n ServiceElement,\n Services,\n} from '../clients/types';\nimport { readThreeScaleApiEntityConfigs } from './config';\nimport { isNonEmptyArray, NonEmptyArray, ThreeScaleConfig } from './types';\nimport {\n isOpenAPI3_0,\n isSwagger1_2,\n isSwagger2_0,\n OpenAPIMergerAndConverter,\n} from './open-api-merger-converter';\nimport { Swagger } from 'atlassian-openapi';\n\nexport class ThreeScaleApiEntityProvider implements EntityProvider {\n private static SERVICES_FETCH_SIZE: number = 500;\n private readonly env: string;\n private readonly baseUrl: string;\n private readonly accessToken: string;\n private readonly logger: LoggerService;\n private readonly scheduleFn: () => Promise<void>;\n private readonly openApiMerger: OpenAPIMergerAndConverter;\n private connection?: EntityProviderConnection;\n\n static fromConfig(\n deps: {\n config: Config;\n logger: LoggerService;\n },\n\n options: {\n schedule: SchedulerServiceTaskRunner;\n scheduler: SchedulerService;\n },\n ): ThreeScaleApiEntityProvider[] {\n const providerConfigs = readThreeScaleApiEntityConfigs(deps.config);\n\n if (!options.schedule && !options.scheduler) {\n throw new Error('Either schedule or scheduler must be provided.');\n }\n\n return providerConfigs.map(providerConfig => {\n if (!options.schedule && !providerConfig.schedule) {\n throw new InputError(\n `No schedule provided via config for ThreeScaleApiEntityProvider:${providerConfig.id}.`,\n );\n }\n\n let taskRunner;\n\n if (options.scheduler && providerConfig.schedule) {\n // Create a scheduled task runner using the provided scheduler and schedule configuration\n taskRunner = options.scheduler.createScheduledTaskRunner(\n providerConfig.schedule,\n );\n } else if (options.schedule) {\n // Use the provided schedule directly\n taskRunner = options.schedule;\n } else {\n // Handle the case where both options.schedule and options.scheduler are missing\n throw new Error('Neither schedule nor scheduler is provided.');\n }\n\n return new ThreeScaleApiEntityProvider(\n providerConfig,\n deps.logger,\n taskRunner,\n );\n });\n }\n\n private constructor(\n config: ThreeScaleConfig,\n logger: LoggerService,\n taskRunner: SchedulerServiceTaskRunner,\n ) {\n this.env = config.id;\n this.baseUrl = config.baseUrl;\n this.accessToken = config.accessToken;\n this.logger = logger.child({\n target: this.getProviderName(),\n });\n\n this.scheduleFn = this.createScheduleFn(taskRunner);\n this.openApiMerger = new OpenAPIMergerAndConverter();\n }\n\n private createScheduleFn(\n taskRunner: SchedulerServiceTaskRunner,\n ): () => Promise<void> {\n return async () => {\n const taskId = `${this.getProviderName()}:run`;\n return taskRunner.run({\n id: taskId,\n fn: async () => {\n try {\n await this.run();\n } catch (error: any) {\n if (isError(error)) {\n // Ensure that we don't log any sensitive internal data:\n this.logger.error(\n `Error while syncing 3scale API from ${this.baseUrl}`,\n {\n // Default Error properties:\n name: error.name,\n message: error.message,\n stack: error.stack,\n // Additional status code if available:\n status: (error.response as { status?: string })?.status,\n },\n );\n }\n }\n },\n });\n };\n }\n\n getProviderName(): string {\n return `ThreeScaleApiEntityProvider:${this.env}`;\n }\n\n async connect(connection: EntityProviderConnection): Promise<void> {\n this.connection = connection;\n await this.scheduleFn();\n }\n\n async run(): Promise<void> {\n if (!this.connection) {\n throw new NotFoundError('Not initialized');\n }\n\n this.logger.info(`Discovering ApiEntities from 3scale ${this.baseUrl}`);\n\n const entities: Entity[] = [];\n\n let page: number = 0;\n let services: Services;\n let apiDocs: APIDocs;\n let fetchServices: boolean = true;\n while (fetchServices) {\n services = await listServices(\n this.baseUrl,\n this.accessToken,\n page,\n ThreeScaleApiEntityProvider.SERVICES_FETCH_SIZE,\n );\n apiDocs = await listApiDocs(this.baseUrl, this.accessToken);\n for (const element of services.services) {\n const service = element;\n this.logger.debug(`Find service ${service.service.name}`);\n\n const docs = apiDocs.api_docs.filter(\n obj => obj.api_doc.service_id === service.service.id,\n );\n const proxy = await getProxyConfig(\n this.baseUrl,\n this.accessToken,\n service.service.id,\n );\n if (isNonEmptyArray(docs)) {\n this.logger.info(JSON.stringify(docs));\n const apiEntity: ApiEntity = await this.buildApiEntityFromService(\n service,\n docs,\n proxy,\n );\n entities.push(apiEntity);\n this.logger.debug(`Discovered ApiEntity ${service.service.name}`);\n }\n }\n\n if (\n services.services.length <\n ThreeScaleApiEntityProvider.SERVICES_FETCH_SIZE\n ) {\n fetchServices = false;\n }\n page++;\n }\n\n this.logger.info(`Applying the mutation with ${entities.length} entities`);\n\n await this.connection.applyMutation({\n type: 'full',\n entities: entities.map(entity => ({\n entity,\n locationKey: this.getProviderName(),\n })),\n });\n }\n\n private async buildApiEntityFromService(\n service: ServiceElement,\n apiDocs: NonEmptyArray<APIDocElement>,\n proxy: Proxy,\n ): Promise<ApiEntity> {\n const location = `url:${this.baseUrl}/apiconfig/services/${service.service.id}`;\n const serviceDescription = service.service.description || '';\n let entityDescription: string | undefined;\n\n const docs = apiDocs.map(doc => JSON.parse(doc.api_doc.body));\n\n let swaggerDocJSON;\n if (docs.length > 1) {\n // convert all docs to openapi 3.0 and merge them\n let mergedDescription = `[Merged ${docs.length} API docs]`;\n let mergedTitle = mergedDescription;\n const convertedDocs: Swagger.SwaggerV3[] = [];\n for (const doc of docs) {\n const convertedDoc = await this.openApiMerger.convertAPIDocToOpenAPI3(\n doc,\n );\n convertedDocs.push(convertedDoc);\n mergedDescription = getDocInfo(convertedDoc)?.description\n ? `${mergedDescription} ${getDocInfo(convertedDoc)?.description}`\n : mergedDescription;\n mergedTitle = getDocInfo(convertedDoc)?.title\n ? `${mergedTitle} ${getDocInfo(convertedDoc)?.title}`\n : mergedTitle;\n }\n if (isNonEmptyArray(convertedDocs)) {\n swaggerDocJSON = await this.openApiMerger.mergeOpenAPI3Docs(\n convertedDocs,\n );\n swaggerDocJSON.info.description = mergedDescription;\n swaggerDocJSON.info.title = mergedTitle;\n entityDescription = mergedDescription;\n }\n }\n\n if (docs.length === 1) {\n swaggerDocJSON = docs[0];\n\n const spec = JSON.parse(apiDocs[0].api_doc.body);\n if (isSwagger1_2(spec)) {\n // Backstage UI can render only openapi 3.0 or swagger 2.0. That's why we need to convert swagger 1.2 to swagger 2.0.\n swaggerDocJSON = await this.openApiMerger.convertSwagger1_2To2_0(spec);\n }\n entityDescription = getDocInfo(spec)?.description;\n }\n\n return {\n kind: 'API',\n apiVersion: 'backstage.io/v1alpha1',\n metadata: {\n annotations: {\n [ANNOTATION_LOCATION]: location,\n [ANNOTATION_ORIGIN_LOCATION]: location,\n },\n // TODO: add tenant name\n name: `${service.service.system_name}`,\n description: entityDescription || serviceDescription,\n // TODO: add labels\n // labels: this.getApiEntityLabels(service),\n links: [\n {\n url: `${this.baseUrl}/apiconfig/services/${service.service.id}`,\n title: '3scale Overview',\n },\n {\n url: `${proxy.proxy.sandbox_endpoint}`,\n title: 'Staging Apicast Endpoint',\n },\n {\n url: `${proxy.proxy.endpoint}`,\n title: 'Production Apicast Endpoint',\n },\n ],\n },\n spec: {\n type: 'openapi',\n lifecycle: this.env,\n system: '3scale',\n owner: '3scale',\n definition: JSON.stringify(swaggerDocJSON, null, 2),\n },\n };\n }\n}\n\nfunction getDocInfo(\n spec: any,\n): { description: string; title: string } | undefined {\n if (isSwagger2_0(spec) || isOpenAPI3_0(spec)) {\n return spec.info;\n }\n\n // swagger 1.2 spec doc defined by single file doesn't have description field\n return undefined;\n}\n"],"names":["readThreeScaleApiEntityConfigs","InputError","OpenAPIMergerAndConverter","isError","NotFoundError","listServices","listApiDocs","getProxyConfig","isNonEmptyArray","isSwagger1_2","ANNOTATION_LOCATION","ANNOTATION_ORIGIN_LOCATION","isSwagger2_0","isOpenAPI3_0"],"mappings":";;;;;;;;;AA0DO,MAAM,2BAAsD,CAAA;AAAA,EACjE,OAAe,mBAA8B,GAAA,GAAA,CAAA;AAAA,EAC5B,GAAA,CAAA;AAAA,EACA,OAAA,CAAA;AAAA,EACA,WAAA,CAAA;AAAA,EACA,MAAA,CAAA;AAAA,EACA,UAAA,CAAA;AAAA,EACA,aAAA,CAAA;AAAA,EACT,UAAA,CAAA;AAAA,EAER,OAAO,UACL,CAAA,IAAA,EAKA,OAI+B,EAAA;AAC/B,IAAM,MAAA,eAAA,GAAkBA,qCAA+B,CAAA,IAAA,CAAK,MAAM,CAAA,CAAA;AAElE,IAAA,IAAI,CAAC,OAAA,CAAQ,QAAY,IAAA,CAAC,QAAQ,SAAW,EAAA;AAC3C,MAAM,MAAA,IAAI,MAAM,gDAAgD,CAAA,CAAA;AAAA,KAClE;AAEA,IAAO,OAAA,eAAA,CAAgB,IAAI,CAAkB,cAAA,KAAA;AAC3C,MAAA,IAAI,CAAC,OAAA,CAAQ,QAAY,IAAA,CAAC,eAAe,QAAU,EAAA;AACjD,QAAA,MAAM,IAAIC,iBAAA;AAAA,UACR,CAAA,gEAAA,EAAmE,eAAe,EAAE,CAAA,CAAA,CAAA;AAAA,SACtF,CAAA;AAAA,OACF;AAEA,MAAI,IAAA,UAAA,CAAA;AAEJ,MAAI,IAAA,OAAA,CAAQ,SAAa,IAAA,cAAA,CAAe,QAAU,EAAA;AAEhD,QAAA,UAAA,GAAa,QAAQ,SAAU,CAAA,yBAAA;AAAA,UAC7B,cAAe,CAAA,QAAA;AAAA,SACjB,CAAA;AAAA,OACF,MAAA,IAAW,QAAQ,QAAU,EAAA;AAE3B,QAAA,UAAA,GAAa,OAAQ,CAAA,QAAA,CAAA;AAAA,OAChB,MAAA;AAEL,QAAM,MAAA,IAAI,MAAM,6CAA6C,CAAA,CAAA;AAAA,OAC/D;AAEA,MAAA,OAAO,IAAI,2BAAA;AAAA,QACT,cAAA;AAAA,QACA,IAAK,CAAA,MAAA;AAAA,QACL,UAAA;AAAA,OACF,CAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA,EAEQ,WAAA,CACN,MACA,EAAA,MAAA,EACA,UACA,EAAA;AACA,IAAA,IAAA,CAAK,MAAM,MAAO,CAAA,EAAA,CAAA;AAClB,IAAA,IAAA,CAAK,UAAU,MAAO,CAAA,OAAA,CAAA;AACtB,IAAA,IAAA,CAAK,cAAc,MAAO,CAAA,WAAA,CAAA;AAC1B,IAAK,IAAA,CAAA,MAAA,GAAS,OAAO,KAAM,CAAA;AAAA,MACzB,MAAA,EAAQ,KAAK,eAAgB,EAAA;AAAA,KAC9B,CAAA,CAAA;AAED,IAAK,IAAA,CAAA,UAAA,GAAa,IAAK,CAAA,gBAAA,CAAiB,UAAU,CAAA,CAAA;AAClD,IAAK,IAAA,CAAA,aAAA,GAAgB,IAAIC,gDAA0B,EAAA,CAAA;AAAA,GACrD;AAAA,EAEQ,iBACN,UACqB,EAAA;AACrB,IAAA,OAAO,YAAY;AACjB,MAAA,MAAM,MAAS,GAAA,CAAA,EAAG,IAAK,CAAA,eAAA,EAAiB,CAAA,IAAA,CAAA,CAAA;AACxC,MAAA,OAAO,WAAW,GAAI,CAAA;AAAA,QACpB,EAAI,EAAA,MAAA;AAAA,QACJ,IAAI,YAAY;AACd,UAAI,IAAA;AACF,YAAA,MAAM,KAAK,GAAI,EAAA,CAAA;AAAA,mBACR,KAAY,EAAA;AACnB,YAAI,IAAAC,cAAA,CAAQ,KAAK,CAAG,EAAA;AAElB,cAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,gBACV,CAAA,oCAAA,EAAuC,KAAK,OAAO,CAAA,CAAA;AAAA,gBACnD;AAAA;AAAA,kBAEE,MAAM,KAAM,CAAA,IAAA;AAAA,kBACZ,SAAS,KAAM,CAAA,OAAA;AAAA,kBACf,OAAO,KAAM,CAAA,KAAA;AAAA;AAAA,kBAEb,MAAA,EAAS,MAAM,QAAkC,EAAA,MAAA;AAAA,iBACnD;AAAA,eACF,CAAA;AAAA,aACF;AAAA,WACF;AAAA,SACF;AAAA,OACD,CAAA,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA,EAEA,eAA0B,GAAA;AACxB,IAAO,OAAA,CAAA,4BAAA,EAA+B,KAAK,GAAG,CAAA,CAAA,CAAA;AAAA,GAChD;AAAA,EAEA,MAAM,QAAQ,UAAqD,EAAA;AACjE,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA,CAAA;AAClB,IAAA,MAAM,KAAK,UAAW,EAAA,CAAA;AAAA,GACxB;AAAA,EAEA,MAAM,GAAqB,GAAA;AACzB,IAAI,IAAA,CAAC,KAAK,UAAY,EAAA;AACpB,MAAM,MAAA,IAAIC,qBAAc,iBAAiB,CAAA,CAAA;AAAA,KAC3C;AAEA,IAAA,IAAA,CAAK,MAAO,CAAA,IAAA,CAAK,CAAuC,oCAAA,EAAA,IAAA,CAAK,OAAO,CAAE,CAAA,CAAA,CAAA;AAEtE,IAAA,MAAM,WAAqB,EAAC,CAAA;AAE5B,IAAA,IAAI,IAAe,GAAA,CAAA,CAAA;AACnB,IAAI,IAAA,QAAA,CAAA;AACJ,IAAI,IAAA,OAAA,CAAA;AACJ,IAAA,IAAI,aAAyB,GAAA,IAAA,CAAA;AAC7B,IAAA,OAAO,aAAe,EAAA;AACpB,MAAA,QAAA,GAAW,MAAMC,mCAAA;AAAA,QACf,IAAK,CAAA,OAAA;AAAA,QACL,IAAK,CAAA,WAAA;AAAA,QACL,IAAA;AAAA,QACA,2BAA4B,CAAA,mBAAA;AAAA,OAC9B,CAAA;AACA,MAAA,OAAA,GAAU,MAAMC,kCAAA,CAAY,IAAK,CAAA,OAAA,EAAS,KAAK,WAAW,CAAA,CAAA;AAC1D,MAAW,KAAA,MAAA,OAAA,IAAW,SAAS,QAAU,EAAA;AACvC,QAAA,MAAM,OAAU,GAAA,OAAA,CAAA;AAChB,QAAA,IAAA,CAAK,OAAO,KAAM,CAAA,CAAA,aAAA,EAAgB,OAAQ,CAAA,OAAA,CAAQ,IAAI,CAAE,CAAA,CAAA,CAAA;AAExD,QAAM,MAAA,IAAA,GAAO,QAAQ,QAAS,CAAA,MAAA;AAAA,UAC5B,CAAO,GAAA,KAAA,GAAA,CAAI,OAAQ,CAAA,UAAA,KAAe,QAAQ,OAAQ,CAAA,EAAA;AAAA,SACpD,CAAA;AACA,QAAA,MAAM,QAAQ,MAAMC,qCAAA;AAAA,UAClB,IAAK,CAAA,OAAA;AAAA,UACL,IAAK,CAAA,WAAA;AAAA,UACL,QAAQ,OAAQ,CAAA,EAAA;AAAA,SAClB,CAAA;AACA,QAAI,IAAAC,qBAAA,CAAgB,IAAI,CAAG,EAAA;AACzB,UAAA,IAAA,CAAK,MAAO,CAAA,IAAA,CAAK,IAAK,CAAA,SAAA,CAAU,IAAI,CAAC,CAAA,CAAA;AACrC,UAAM,MAAA,SAAA,GAAuB,MAAM,IAAK,CAAA,yBAAA;AAAA,YACtC,OAAA;AAAA,YACA,IAAA;AAAA,YACA,KAAA;AAAA,WACF,CAAA;AACA,UAAA,QAAA,CAAS,KAAK,SAAS,CAAA,CAAA;AACvB,UAAA,IAAA,CAAK,OAAO,KAAM,CAAA,CAAA,qBAAA,EAAwB,OAAQ,CAAA,OAAA,CAAQ,IAAI,CAAE,CAAA,CAAA,CAAA;AAAA,SAClE;AAAA,OACF;AAEA,MAAA,IACE,QAAS,CAAA,QAAA,CAAS,MAClB,GAAA,2BAAA,CAA4B,mBAC5B,EAAA;AACA,QAAgB,aAAA,GAAA,KAAA,CAAA;AAAA,OAClB;AACA,MAAA,IAAA,EAAA,CAAA;AAAA,KACF;AAEA,IAAA,IAAA,CAAK,MAAO,CAAA,IAAA,CAAK,CAA8B,2BAAA,EAAA,QAAA,CAAS,MAAM,CAAW,SAAA,CAAA,CAAA,CAAA;AAEzE,IAAM,MAAA,IAAA,CAAK,WAAW,aAAc,CAAA;AAAA,MAClC,IAAM,EAAA,MAAA;AAAA,MACN,QAAA,EAAU,QAAS,CAAA,GAAA,CAAI,CAAW,MAAA,MAAA;AAAA,QAChC,MAAA;AAAA,QACA,WAAA,EAAa,KAAK,eAAgB,EAAA;AAAA,OAClC,CAAA,CAAA;AAAA,KACH,CAAA,CAAA;AAAA,GACH;AAAA,EAEA,MAAc,yBAAA,CACZ,OACA,EAAA,OAAA,EACA,KACoB,EAAA;AACpB,IAAA,MAAM,WAAW,CAAO,IAAA,EAAA,IAAA,CAAK,OAAO,CAAuB,oBAAA,EAAA,OAAA,CAAQ,QAAQ,EAAE,CAAA,CAAA,CAAA;AAC7E,IAAM,MAAA,kBAAA,GAAqB,OAAQ,CAAA,OAAA,CAAQ,WAAe,IAAA,EAAA,CAAA;AAC1D,IAAI,IAAA,iBAAA,CAAA;AAEJ,IAAM,MAAA,IAAA,GAAO,QAAQ,GAAI,CAAA,CAAA,GAAA,KAAO,KAAK,KAAM,CAAA,GAAA,CAAI,OAAQ,CAAA,IAAI,CAAC,CAAA,CAAA;AAE5D,IAAI,IAAA,cAAA,CAAA;AACJ,IAAI,IAAA,IAAA,CAAK,SAAS,CAAG,EAAA;AAEnB,MAAI,IAAA,iBAAA,GAAoB,CAAW,QAAA,EAAA,IAAA,CAAK,MAAM,CAAA,UAAA,CAAA,CAAA;AAC9C,MAAA,IAAI,WAAc,GAAA,iBAAA,CAAA;AAClB,MAAA,MAAM,gBAAqC,EAAC,CAAA;AAC5C,MAAA,KAAA,MAAW,OAAO,IAAM,EAAA;AACtB,QAAM,MAAA,YAAA,GAAe,MAAM,IAAA,CAAK,aAAc,CAAA,uBAAA;AAAA,UAC5C,GAAA;AAAA,SACF,CAAA;AACA,QAAA,aAAA,CAAc,KAAK,YAAY,CAAA,CAAA;AAC/B,QAAoB,iBAAA,GAAA,UAAA,CAAW,YAAY,CAAA,EAAG,WAC1C,GAAA,CAAA,EAAG,iBAAiB,CAAA,CAAA,EAAI,UAAW,CAAA,YAAY,CAAG,EAAA,WAAW,CAC7D,CAAA,GAAA,iBAAA,CAAA;AACJ,QAAc,WAAA,GAAA,UAAA,CAAW,YAAY,CAAA,EAAG,KACpC,GAAA,CAAA,EAAG,WAAW,CAAA,CAAA,EAAI,UAAW,CAAA,YAAY,CAAG,EAAA,KAAK,CACjD,CAAA,GAAA,WAAA,CAAA;AAAA,OACN;AACA,MAAI,IAAAA,qBAAA,CAAgB,aAAa,CAAG,EAAA;AAClC,QAAiB,cAAA,GAAA,MAAM,KAAK,aAAc,CAAA,iBAAA;AAAA,UACxC,aAAA;AAAA,SACF,CAAA;AACA,QAAA,cAAA,CAAe,KAAK,WAAc,GAAA,iBAAA,CAAA;AAClC,QAAA,cAAA,CAAe,KAAK,KAAQ,GAAA,WAAA,CAAA;AAC5B,QAAoB,iBAAA,GAAA,iBAAA,CAAA;AAAA,OACtB;AAAA,KACF;AAEA,IAAI,IAAA,IAAA,CAAK,WAAW,CAAG,EAAA;AACrB,MAAA,cAAA,GAAiB,KAAK,CAAC,CAAA,CAAA;AAEvB,MAAA,MAAM,OAAO,IAAK,CAAA,KAAA,CAAM,QAAQ,CAAC,CAAA,CAAE,QAAQ,IAAI,CAAA,CAAA;AAC/C,MAAI,IAAAC,mCAAA,CAAa,IAAI,CAAG,EAAA;AAEtB,QAAA,cAAA,GAAiB,MAAM,IAAA,CAAK,aAAc,CAAA,sBAAA,CAAuB,IAAI,CAAA,CAAA;AAAA,OACvE;AACA,MAAoB,iBAAA,GAAA,UAAA,CAAW,IAAI,CAAG,EAAA,WAAA,CAAA;AAAA,KACxC;AAEA,IAAO,OAAA;AAAA,MACL,IAAM,EAAA,KAAA;AAAA,MACN,UAAY,EAAA,uBAAA;AAAA,MACZ,QAAU,EAAA;AAAA,QACR,WAAa,EAAA;AAAA,UACX,CAACC,gCAAmB,GAAG,QAAA;AAAA,UACvB,CAACC,uCAA0B,GAAG,QAAA;AAAA,SAChC;AAAA;AAAA,QAEA,IAAM,EAAA,CAAA,EAAG,OAAQ,CAAA,OAAA,CAAQ,WAAW,CAAA,CAAA;AAAA,QACpC,aAAa,iBAAqB,IAAA,kBAAA;AAAA;AAAA;AAAA,QAGlC,KAAO,EAAA;AAAA,UACL;AAAA,YACE,KAAK,CAAG,EAAA,IAAA,CAAK,OAAO,CAAuB,oBAAA,EAAA,OAAA,CAAQ,QAAQ,EAAE,CAAA,CAAA;AAAA,YAC7D,KAAO,EAAA,iBAAA;AAAA,WACT;AAAA,UACA;AAAA,YACE,GAAK,EAAA,CAAA,EAAG,KAAM,CAAA,KAAA,CAAM,gBAAgB,CAAA,CAAA;AAAA,YACpC,KAAO,EAAA,0BAAA;AAAA,WACT;AAAA,UACA;AAAA,YACE,GAAK,EAAA,CAAA,EAAG,KAAM,CAAA,KAAA,CAAM,QAAQ,CAAA,CAAA;AAAA,YAC5B,KAAO,EAAA,6BAAA;AAAA,WACT;AAAA,SACF;AAAA,OACF;AAAA,MACA,IAAM,EAAA;AAAA,QACJ,IAAM,EAAA,SAAA;AAAA,QACN,WAAW,IAAK,CAAA,GAAA;AAAA,QAChB,MAAQ,EAAA,QAAA;AAAA,QACR,KAAO,EAAA,QAAA;AAAA,QACP,UAAY,EAAA,IAAA,CAAK,SAAU,CAAA,cAAA,EAAgB,MAAM,CAAC,CAAA;AAAA,OACpD;AAAA,KACF,CAAA;AAAA,GACF;AACF,CAAA;AAEA,SAAS,WACP,IACoD,EAAA;AACpD,EAAA,IAAIC,mCAAa,CAAA,IAAI,CAAK,IAAAC,mCAAA,CAAa,IAAI,CAAG,EAAA;AAC5C,IAAA,OAAO,IAAK,CAAA,IAAA,CAAA;AAAA,GACd;AAGA,EAAO,OAAA,KAAA,CAAA,CAAA;AACT;;;;"}
|
|
1
|
+
{"version":3,"file":"ThreeScaleApiEntityProvider.cjs.js","sources":["../../src/providers/ThreeScaleApiEntityProvider.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 type {\n SchedulerServiceTaskRunner,\n SchedulerService,\n LoggerService,\n} from '@backstage/backend-plugin-api';\nimport {\n ANNOTATION_LOCATION,\n ANNOTATION_ORIGIN_LOCATION,\n ApiEntity,\n Entity,\n} from '@backstage/catalog-model';\n\nimport type { Config } from '@backstage/config';\nimport { InputError, isError, NotFoundError } from '@backstage/errors';\n\nimport {\n EntityProvider,\n EntityProviderConnection,\n} from '@backstage/plugin-catalog-node';\n\nimport {\n getProxyConfig,\n listApiDocs,\n listServices,\n} from '../clients/ThreeScaleAPIConnector';\nimport type {\n APIDocElement,\n APIDocs,\n Proxy,\n ServiceElement,\n Services,\n} from '../clients/types';\nimport { readThreeScaleApiEntityConfigs } from './config';\nimport { isNonEmptyArray, NonEmptyArray, ThreeScaleConfig } from './types';\nimport {\n isOpenAPI3_0,\n isSwagger1_2,\n isSwagger2_0,\n OpenAPIMergerAndConverter,\n} from './open-api-merger-converter';\nimport { Swagger } from 'atlassian-openapi';\n\n/**\n * @public\n */\nexport class ThreeScaleApiEntityProvider implements EntityProvider {\n private static SERVICES_FETCH_SIZE: number = 500;\n private readonly env: string;\n private readonly baseUrl: string;\n private readonly accessToken: string;\n private readonly logger: LoggerService;\n private readonly scheduleFn: () => Promise<void>;\n private readonly openApiMerger: OpenAPIMergerAndConverter;\n private connection?: EntityProviderConnection;\n\n static fromConfig(\n deps: {\n config: Config;\n logger: LoggerService;\n },\n\n options: {\n schedule: SchedulerServiceTaskRunner;\n scheduler: SchedulerService;\n },\n ): ThreeScaleApiEntityProvider[] {\n const providerConfigs = readThreeScaleApiEntityConfigs(deps.config);\n\n if (!options.schedule && !options.scheduler) {\n throw new Error('Either schedule or scheduler must be provided.');\n }\n\n return providerConfigs.map(providerConfig => {\n if (!options.schedule && !providerConfig.schedule) {\n throw new InputError(\n `No schedule provided via config for ThreeScaleApiEntityProvider:${providerConfig.id}.`,\n );\n }\n\n let taskRunner;\n\n if (options.scheduler && providerConfig.schedule) {\n // Create a scheduled task runner using the provided scheduler and schedule configuration\n taskRunner = options.scheduler.createScheduledTaskRunner(\n providerConfig.schedule,\n );\n } else if (options.schedule) {\n // Use the provided schedule directly\n taskRunner = options.schedule;\n } else {\n // Handle the case where both options.schedule and options.scheduler are missing\n throw new Error('Neither schedule nor scheduler is provided.');\n }\n\n return new ThreeScaleApiEntityProvider(\n providerConfig,\n deps.logger,\n taskRunner,\n );\n });\n }\n\n private constructor(\n config: ThreeScaleConfig,\n logger: LoggerService,\n taskRunner: SchedulerServiceTaskRunner,\n ) {\n this.env = config.id;\n this.baseUrl = config.baseUrl;\n this.accessToken = config.accessToken;\n this.logger = logger.child({\n target: this.getProviderName(),\n });\n\n this.scheduleFn = this.createScheduleFn(taskRunner);\n this.openApiMerger = new OpenAPIMergerAndConverter();\n }\n\n private createScheduleFn(\n taskRunner: SchedulerServiceTaskRunner,\n ): () => Promise<void> {\n return async () => {\n const taskId = `${this.getProviderName()}:run`;\n return taskRunner.run({\n id: taskId,\n fn: async () => {\n try {\n await this.run();\n } catch (error: any) {\n if (isError(error)) {\n // Ensure that we don't log any sensitive internal data:\n this.logger.error(\n `Error while syncing 3scale API from ${this.baseUrl}`,\n {\n // Default Error properties:\n name: error.name,\n message: error.message,\n stack: error.stack,\n // Additional status code if available:\n status: (error.response as { status?: string })?.status,\n },\n );\n }\n }\n },\n });\n };\n }\n\n getProviderName(): string {\n return `ThreeScaleApiEntityProvider:${this.env}`;\n }\n\n async connect(connection: EntityProviderConnection): Promise<void> {\n this.connection = connection;\n await this.scheduleFn();\n }\n\n async run(): Promise<void> {\n if (!this.connection) {\n throw new NotFoundError('Not initialized');\n }\n\n this.logger.info(`Discovering ApiEntities from 3scale ${this.baseUrl}`);\n\n const entities: Entity[] = [];\n\n let page: number = 0;\n let services: Services;\n let apiDocs: APIDocs;\n let fetchServices: boolean = true;\n while (fetchServices) {\n services = await listServices(\n this.baseUrl,\n this.accessToken,\n page,\n ThreeScaleApiEntityProvider.SERVICES_FETCH_SIZE,\n );\n apiDocs = await listApiDocs(this.baseUrl, this.accessToken);\n for (const element of services.services) {\n const service = element;\n this.logger.debug(`Find service ${service.service.name}`);\n\n const docs = apiDocs.api_docs.filter(\n obj => obj.api_doc.service_id === service.service.id,\n );\n const proxy = await getProxyConfig(\n this.baseUrl,\n this.accessToken,\n service.service.id,\n );\n if (isNonEmptyArray(docs)) {\n this.logger.info(JSON.stringify(docs));\n const apiEntity: ApiEntity = await this.buildApiEntityFromService(\n service,\n docs,\n proxy,\n );\n entities.push(apiEntity);\n this.logger.debug(`Discovered ApiEntity ${service.service.name}`);\n }\n }\n\n if (\n services.services.length <\n ThreeScaleApiEntityProvider.SERVICES_FETCH_SIZE\n ) {\n fetchServices = false;\n }\n page++;\n }\n\n this.logger.info(`Applying the mutation with ${entities.length} entities`);\n\n await this.connection.applyMutation({\n type: 'full',\n entities: entities.map(entity => ({\n entity,\n locationKey: this.getProviderName(),\n })),\n });\n }\n\n private async buildApiEntityFromService(\n service: ServiceElement,\n apiDocs: NonEmptyArray<APIDocElement>,\n proxy: Proxy,\n ): Promise<ApiEntity> {\n const location = `url:${this.baseUrl}/apiconfig/services/${service.service.id}`;\n const serviceDescription = service.service.description || '';\n let entityDescription: string | undefined;\n\n const docs = apiDocs.map(doc => JSON.parse(doc.api_doc.body));\n\n let swaggerDocJSON;\n if (docs.length > 1) {\n // convert all docs to openapi 3.0 and merge them\n let mergedDescription = `[Merged ${docs.length} API docs]`;\n let mergedTitle = mergedDescription;\n const convertedDocs: Swagger.SwaggerV3[] = [];\n for (const doc of docs) {\n const convertedDoc = await this.openApiMerger.convertAPIDocToOpenAPI3(\n doc,\n );\n convertedDocs.push(convertedDoc);\n mergedDescription = getDocInfo(convertedDoc)?.description\n ? `${mergedDescription} ${getDocInfo(convertedDoc)?.description}`\n : mergedDescription;\n mergedTitle = getDocInfo(convertedDoc)?.title\n ? `${mergedTitle} ${getDocInfo(convertedDoc)?.title}`\n : mergedTitle;\n }\n if (isNonEmptyArray(convertedDocs)) {\n swaggerDocJSON = await this.openApiMerger.mergeOpenAPI3Docs(\n convertedDocs,\n );\n swaggerDocJSON.info.description = mergedDescription;\n swaggerDocJSON.info.title = mergedTitle;\n entityDescription = mergedDescription;\n }\n }\n\n if (docs.length === 1) {\n swaggerDocJSON = docs[0];\n\n const spec = JSON.parse(apiDocs[0].api_doc.body);\n if (isSwagger1_2(spec)) {\n // Backstage UI can render only openapi 3.0 or swagger 2.0. That's why we need to convert swagger 1.2 to swagger 2.0.\n swaggerDocJSON = await this.openApiMerger.convertSwagger1_2To2_0(spec);\n }\n entityDescription = getDocInfo(spec)?.description;\n }\n\n return {\n kind: 'API',\n apiVersion: 'backstage.io/v1alpha1',\n metadata: {\n annotations: {\n [ANNOTATION_LOCATION]: location,\n [ANNOTATION_ORIGIN_LOCATION]: location,\n },\n // TODO: add tenant name\n name: `${service.service.system_name}`,\n description: entityDescription || serviceDescription,\n // TODO: add labels\n // labels: this.getApiEntityLabels(service),\n links: [\n {\n url: `${this.baseUrl}/apiconfig/services/${service.service.id}`,\n title: '3scale Overview',\n },\n {\n url: `${proxy.proxy.sandbox_endpoint}`,\n title: 'Staging Apicast Endpoint',\n },\n {\n url: `${proxy.proxy.endpoint}`,\n title: 'Production Apicast Endpoint',\n },\n ],\n },\n spec: {\n type: 'openapi',\n lifecycle: this.env,\n system: '3scale',\n owner: '3scale',\n definition: JSON.stringify(swaggerDocJSON, null, 2),\n },\n };\n }\n}\n\nfunction getDocInfo(\n spec: any,\n): { description: string; title: string } | undefined {\n if (isSwagger2_0(spec) || isOpenAPI3_0(spec)) {\n return spec.info;\n }\n\n // swagger 1.2 spec doc defined by single file doesn't have description field\n return undefined;\n}\n"],"names":["readThreeScaleApiEntityConfigs","InputError","OpenAPIMergerAndConverter","isError","NotFoundError","listServices","listApiDocs","getProxyConfig","isNonEmptyArray","isSwagger1_2","ANNOTATION_LOCATION","ANNOTATION_ORIGIN_LOCATION","isSwagger2_0","isOpenAPI3_0"],"mappings":";;;;;;;;;AA6DO,MAAM,2BAAsD,CAAA;AAAA,EACjE,OAAe,mBAA8B,GAAA,GAAA,CAAA;AAAA,EAC5B,GAAA,CAAA;AAAA,EACA,OAAA,CAAA;AAAA,EACA,WAAA,CAAA;AAAA,EACA,MAAA,CAAA;AAAA,EACA,UAAA,CAAA;AAAA,EACA,aAAA,CAAA;AAAA,EACT,UAAA,CAAA;AAAA,EAER,OAAO,UACL,CAAA,IAAA,EAKA,OAI+B,EAAA;AAC/B,IAAM,MAAA,eAAA,GAAkBA,qCAA+B,CAAA,IAAA,CAAK,MAAM,CAAA,CAAA;AAElE,IAAA,IAAI,CAAC,OAAA,CAAQ,QAAY,IAAA,CAAC,QAAQ,SAAW,EAAA;AAC3C,MAAM,MAAA,IAAI,MAAM,gDAAgD,CAAA,CAAA;AAAA,KAClE;AAEA,IAAO,OAAA,eAAA,CAAgB,IAAI,CAAkB,cAAA,KAAA;AAC3C,MAAA,IAAI,CAAC,OAAA,CAAQ,QAAY,IAAA,CAAC,eAAe,QAAU,EAAA;AACjD,QAAA,MAAM,IAAIC,iBAAA;AAAA,UACR,CAAA,gEAAA,EAAmE,eAAe,EAAE,CAAA,CAAA,CAAA;AAAA,SACtF,CAAA;AAAA,OACF;AAEA,MAAI,IAAA,UAAA,CAAA;AAEJ,MAAI,IAAA,OAAA,CAAQ,SAAa,IAAA,cAAA,CAAe,QAAU,EAAA;AAEhD,QAAA,UAAA,GAAa,QAAQ,SAAU,CAAA,yBAAA;AAAA,UAC7B,cAAe,CAAA,QAAA;AAAA,SACjB,CAAA;AAAA,OACF,MAAA,IAAW,QAAQ,QAAU,EAAA;AAE3B,QAAA,UAAA,GAAa,OAAQ,CAAA,QAAA,CAAA;AAAA,OAChB,MAAA;AAEL,QAAM,MAAA,IAAI,MAAM,6CAA6C,CAAA,CAAA;AAAA,OAC/D;AAEA,MAAA,OAAO,IAAI,2BAAA;AAAA,QACT,cAAA;AAAA,QACA,IAAK,CAAA,MAAA;AAAA,QACL,UAAA;AAAA,OACF,CAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA,EAEQ,WAAA,CACN,MACA,EAAA,MAAA,EACA,UACA,EAAA;AACA,IAAA,IAAA,CAAK,MAAM,MAAO,CAAA,EAAA,CAAA;AAClB,IAAA,IAAA,CAAK,UAAU,MAAO,CAAA,OAAA,CAAA;AACtB,IAAA,IAAA,CAAK,cAAc,MAAO,CAAA,WAAA,CAAA;AAC1B,IAAK,IAAA,CAAA,MAAA,GAAS,OAAO,KAAM,CAAA;AAAA,MACzB,MAAA,EAAQ,KAAK,eAAgB,EAAA;AAAA,KAC9B,CAAA,CAAA;AAED,IAAK,IAAA,CAAA,UAAA,GAAa,IAAK,CAAA,gBAAA,CAAiB,UAAU,CAAA,CAAA;AAClD,IAAK,IAAA,CAAA,aAAA,GAAgB,IAAIC,gDAA0B,EAAA,CAAA;AAAA,GACrD;AAAA,EAEQ,iBACN,UACqB,EAAA;AACrB,IAAA,OAAO,YAAY;AACjB,MAAA,MAAM,MAAS,GAAA,CAAA,EAAG,IAAK,CAAA,eAAA,EAAiB,CAAA,IAAA,CAAA,CAAA;AACxC,MAAA,OAAO,WAAW,GAAI,CAAA;AAAA,QACpB,EAAI,EAAA,MAAA;AAAA,QACJ,IAAI,YAAY;AACd,UAAI,IAAA;AACF,YAAA,MAAM,KAAK,GAAI,EAAA,CAAA;AAAA,mBACR,KAAY,EAAA;AACnB,YAAI,IAAAC,cAAA,CAAQ,KAAK,CAAG,EAAA;AAElB,cAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,gBACV,CAAA,oCAAA,EAAuC,KAAK,OAAO,CAAA,CAAA;AAAA,gBACnD;AAAA;AAAA,kBAEE,MAAM,KAAM,CAAA,IAAA;AAAA,kBACZ,SAAS,KAAM,CAAA,OAAA;AAAA,kBACf,OAAO,KAAM,CAAA,KAAA;AAAA;AAAA,kBAEb,MAAA,EAAS,MAAM,QAAkC,EAAA,MAAA;AAAA,iBACnD;AAAA,eACF,CAAA;AAAA,aACF;AAAA,WACF;AAAA,SACF;AAAA,OACD,CAAA,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA,EAEA,eAA0B,GAAA;AACxB,IAAO,OAAA,CAAA,4BAAA,EAA+B,KAAK,GAAG,CAAA,CAAA,CAAA;AAAA,GAChD;AAAA,EAEA,MAAM,QAAQ,UAAqD,EAAA;AACjE,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA,CAAA;AAClB,IAAA,MAAM,KAAK,UAAW,EAAA,CAAA;AAAA,GACxB;AAAA,EAEA,MAAM,GAAqB,GAAA;AACzB,IAAI,IAAA,CAAC,KAAK,UAAY,EAAA;AACpB,MAAM,MAAA,IAAIC,qBAAc,iBAAiB,CAAA,CAAA;AAAA,KAC3C;AAEA,IAAA,IAAA,CAAK,MAAO,CAAA,IAAA,CAAK,CAAuC,oCAAA,EAAA,IAAA,CAAK,OAAO,CAAE,CAAA,CAAA,CAAA;AAEtE,IAAA,MAAM,WAAqB,EAAC,CAAA;AAE5B,IAAA,IAAI,IAAe,GAAA,CAAA,CAAA;AACnB,IAAI,IAAA,QAAA,CAAA;AACJ,IAAI,IAAA,OAAA,CAAA;AACJ,IAAA,IAAI,aAAyB,GAAA,IAAA,CAAA;AAC7B,IAAA,OAAO,aAAe,EAAA;AACpB,MAAA,QAAA,GAAW,MAAMC,mCAAA;AAAA,QACf,IAAK,CAAA,OAAA;AAAA,QACL,IAAK,CAAA,WAAA;AAAA,QACL,IAAA;AAAA,QACA,2BAA4B,CAAA,mBAAA;AAAA,OAC9B,CAAA;AACA,MAAA,OAAA,GAAU,MAAMC,kCAAA,CAAY,IAAK,CAAA,OAAA,EAAS,KAAK,WAAW,CAAA,CAAA;AAC1D,MAAW,KAAA,MAAA,OAAA,IAAW,SAAS,QAAU,EAAA;AACvC,QAAA,MAAM,OAAU,GAAA,OAAA,CAAA;AAChB,QAAA,IAAA,CAAK,OAAO,KAAM,CAAA,CAAA,aAAA,EAAgB,OAAQ,CAAA,OAAA,CAAQ,IAAI,CAAE,CAAA,CAAA,CAAA;AAExD,QAAM,MAAA,IAAA,GAAO,QAAQ,QAAS,CAAA,MAAA;AAAA,UAC5B,CAAO,GAAA,KAAA,GAAA,CAAI,OAAQ,CAAA,UAAA,KAAe,QAAQ,OAAQ,CAAA,EAAA;AAAA,SACpD,CAAA;AACA,QAAA,MAAM,QAAQ,MAAMC,qCAAA;AAAA,UAClB,IAAK,CAAA,OAAA;AAAA,UACL,IAAK,CAAA,WAAA;AAAA,UACL,QAAQ,OAAQ,CAAA,EAAA;AAAA,SAClB,CAAA;AACA,QAAI,IAAAC,qBAAA,CAAgB,IAAI,CAAG,EAAA;AACzB,UAAA,IAAA,CAAK,MAAO,CAAA,IAAA,CAAK,IAAK,CAAA,SAAA,CAAU,IAAI,CAAC,CAAA,CAAA;AACrC,UAAM,MAAA,SAAA,GAAuB,MAAM,IAAK,CAAA,yBAAA;AAAA,YACtC,OAAA;AAAA,YACA,IAAA;AAAA,YACA,KAAA;AAAA,WACF,CAAA;AACA,UAAA,QAAA,CAAS,KAAK,SAAS,CAAA,CAAA;AACvB,UAAA,IAAA,CAAK,OAAO,KAAM,CAAA,CAAA,qBAAA,EAAwB,OAAQ,CAAA,OAAA,CAAQ,IAAI,CAAE,CAAA,CAAA,CAAA;AAAA,SAClE;AAAA,OACF;AAEA,MAAA,IACE,QAAS,CAAA,QAAA,CAAS,MAClB,GAAA,2BAAA,CAA4B,mBAC5B,EAAA;AACA,QAAgB,aAAA,GAAA,KAAA,CAAA;AAAA,OAClB;AACA,MAAA,IAAA,EAAA,CAAA;AAAA,KACF;AAEA,IAAA,IAAA,CAAK,MAAO,CAAA,IAAA,CAAK,CAA8B,2BAAA,EAAA,QAAA,CAAS,MAAM,CAAW,SAAA,CAAA,CAAA,CAAA;AAEzE,IAAM,MAAA,IAAA,CAAK,WAAW,aAAc,CAAA;AAAA,MAClC,IAAM,EAAA,MAAA;AAAA,MACN,QAAA,EAAU,QAAS,CAAA,GAAA,CAAI,CAAW,MAAA,MAAA;AAAA,QAChC,MAAA;AAAA,QACA,WAAA,EAAa,KAAK,eAAgB,EAAA;AAAA,OAClC,CAAA,CAAA;AAAA,KACH,CAAA,CAAA;AAAA,GACH;AAAA,EAEA,MAAc,yBAAA,CACZ,OACA,EAAA,OAAA,EACA,KACoB,EAAA;AACpB,IAAA,MAAM,WAAW,CAAO,IAAA,EAAA,IAAA,CAAK,OAAO,CAAuB,oBAAA,EAAA,OAAA,CAAQ,QAAQ,EAAE,CAAA,CAAA,CAAA;AAC7E,IAAM,MAAA,kBAAA,GAAqB,OAAQ,CAAA,OAAA,CAAQ,WAAe,IAAA,EAAA,CAAA;AAC1D,IAAI,IAAA,iBAAA,CAAA;AAEJ,IAAM,MAAA,IAAA,GAAO,QAAQ,GAAI,CAAA,CAAA,GAAA,KAAO,KAAK,KAAM,CAAA,GAAA,CAAI,OAAQ,CAAA,IAAI,CAAC,CAAA,CAAA;AAE5D,IAAI,IAAA,cAAA,CAAA;AACJ,IAAI,IAAA,IAAA,CAAK,SAAS,CAAG,EAAA;AAEnB,MAAI,IAAA,iBAAA,GAAoB,CAAW,QAAA,EAAA,IAAA,CAAK,MAAM,CAAA,UAAA,CAAA,CAAA;AAC9C,MAAA,IAAI,WAAc,GAAA,iBAAA,CAAA;AAClB,MAAA,MAAM,gBAAqC,EAAC,CAAA;AAC5C,MAAA,KAAA,MAAW,OAAO,IAAM,EAAA;AACtB,QAAM,MAAA,YAAA,GAAe,MAAM,IAAA,CAAK,aAAc,CAAA,uBAAA;AAAA,UAC5C,GAAA;AAAA,SACF,CAAA;AACA,QAAA,aAAA,CAAc,KAAK,YAAY,CAAA,CAAA;AAC/B,QAAoB,iBAAA,GAAA,UAAA,CAAW,YAAY,CAAA,EAAG,WAC1C,GAAA,CAAA,EAAG,iBAAiB,CAAA,CAAA,EAAI,UAAW,CAAA,YAAY,CAAG,EAAA,WAAW,CAC7D,CAAA,GAAA,iBAAA,CAAA;AACJ,QAAc,WAAA,GAAA,UAAA,CAAW,YAAY,CAAA,EAAG,KACpC,GAAA,CAAA,EAAG,WAAW,CAAA,CAAA,EAAI,UAAW,CAAA,YAAY,CAAG,EAAA,KAAK,CACjD,CAAA,GAAA,WAAA,CAAA;AAAA,OACN;AACA,MAAI,IAAAA,qBAAA,CAAgB,aAAa,CAAG,EAAA;AAClC,QAAiB,cAAA,GAAA,MAAM,KAAK,aAAc,CAAA,iBAAA;AAAA,UACxC,aAAA;AAAA,SACF,CAAA;AACA,QAAA,cAAA,CAAe,KAAK,WAAc,GAAA,iBAAA,CAAA;AAClC,QAAA,cAAA,CAAe,KAAK,KAAQ,GAAA,WAAA,CAAA;AAC5B,QAAoB,iBAAA,GAAA,iBAAA,CAAA;AAAA,OACtB;AAAA,KACF;AAEA,IAAI,IAAA,IAAA,CAAK,WAAW,CAAG,EAAA;AACrB,MAAA,cAAA,GAAiB,KAAK,CAAC,CAAA,CAAA;AAEvB,MAAA,MAAM,OAAO,IAAK,CAAA,KAAA,CAAM,QAAQ,CAAC,CAAA,CAAE,QAAQ,IAAI,CAAA,CAAA;AAC/C,MAAI,IAAAC,mCAAA,CAAa,IAAI,CAAG,EAAA;AAEtB,QAAA,cAAA,GAAiB,MAAM,IAAA,CAAK,aAAc,CAAA,sBAAA,CAAuB,IAAI,CAAA,CAAA;AAAA,OACvE;AACA,MAAoB,iBAAA,GAAA,UAAA,CAAW,IAAI,CAAG,EAAA,WAAA,CAAA;AAAA,KACxC;AAEA,IAAO,OAAA;AAAA,MACL,IAAM,EAAA,KAAA;AAAA,MACN,UAAY,EAAA,uBAAA;AAAA,MACZ,QAAU,EAAA;AAAA,QACR,WAAa,EAAA;AAAA,UACX,CAACC,gCAAmB,GAAG,QAAA;AAAA,UACvB,CAACC,uCAA0B,GAAG,QAAA;AAAA,SAChC;AAAA;AAAA,QAEA,IAAM,EAAA,CAAA,EAAG,OAAQ,CAAA,OAAA,CAAQ,WAAW,CAAA,CAAA;AAAA,QACpC,aAAa,iBAAqB,IAAA,kBAAA;AAAA;AAAA;AAAA,QAGlC,KAAO,EAAA;AAAA,UACL;AAAA,YACE,KAAK,CAAG,EAAA,IAAA,CAAK,OAAO,CAAuB,oBAAA,EAAA,OAAA,CAAQ,QAAQ,EAAE,CAAA,CAAA;AAAA,YAC7D,KAAO,EAAA,iBAAA;AAAA,WACT;AAAA,UACA;AAAA,YACE,GAAK,EAAA,CAAA,EAAG,KAAM,CAAA,KAAA,CAAM,gBAAgB,CAAA,CAAA;AAAA,YACpC,KAAO,EAAA,0BAAA;AAAA,WACT;AAAA,UACA;AAAA,YACE,GAAK,EAAA,CAAA,EAAG,KAAM,CAAA,KAAA,CAAM,QAAQ,CAAA,CAAA;AAAA,YAC5B,KAAO,EAAA,6BAAA;AAAA,WACT;AAAA,SACF;AAAA,OACF;AAAA,MACA,IAAM,EAAA;AAAA,QACJ,IAAM,EAAA,SAAA;AAAA,QACN,WAAW,IAAK,CAAA,GAAA;AAAA,QAChB,MAAQ,EAAA,QAAA;AAAA,QACR,KAAO,EAAA,QAAA;AAAA,QACP,UAAY,EAAA,IAAA,CAAK,SAAU,CAAA,cAAA,EAAgB,MAAM,CAAC,CAAA;AAAA,OACpD;AAAA,KACF,CAAA;AAAA,GACF;AACF,CAAA;AAEA,SAAS,WACP,IACoD,EAAA;AACpD,EAAA,IAAIC,mCAAa,CAAA,IAAI,CAAK,IAAAC,mCAAA,CAAa,IAAI,CAAG,EAAA;AAC5C,IAAA,OAAO,IAAK,CAAA,IAAA,CAAA;AAAA,GACd;AAGA,EAAO,OAAA,KAAA,CAAA,CAAA;AACT;;;;"}
|