@backstage/plugin-catalog-backend 1.26.2-next.1 → 1.26.2-next.2

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.
Files changed (181) hide show
  1. package/CHANGELOG.md +22 -0
  2. package/alpha/package.json +1 -1
  3. package/dist/alpha.cjs.js +9 -250
  4. package/dist/alpha.cjs.js.map +1 -1
  5. package/dist/constants.cjs.js +8 -0
  6. package/dist/constants.cjs.js.map +1 -0
  7. package/dist/database/DefaultCatalogDatabase.cjs.js +68 -0
  8. package/dist/database/DefaultCatalogDatabase.cjs.js.map +1 -0
  9. package/dist/database/DefaultProcessingDatabase.cjs.js +247 -0
  10. package/dist/database/DefaultProcessingDatabase.cjs.js.map +1 -0
  11. package/dist/database/DefaultProviderDatabase.cjs.js +201 -0
  12. package/dist/database/DefaultProviderDatabase.cjs.js.map +1 -0
  13. package/dist/database/conversion.cjs.js +30 -0
  14. package/dist/database/conversion.cjs.js.map +1 -0
  15. package/dist/database/metrics.cjs.js +91 -0
  16. package/dist/database/metrics.cjs.js.map +1 -0
  17. package/dist/database/migrations.cjs.js +16 -0
  18. package/dist/database/migrations.cjs.js.map +1 -0
  19. package/dist/database/operations/provider/deleteWithEagerPruningOfChildren.cjs.js +123 -0
  20. package/dist/database/operations/provider/deleteWithEagerPruningOfChildren.cjs.js.map +1 -0
  21. package/dist/database/operations/provider/refreshByRefreshKeys.cjs.js +13 -0
  22. package/dist/database/operations/provider/refreshByRefreshKeys.cjs.js.map +1 -0
  23. package/dist/database/operations/refreshState/checkLocationKeyConflict.cjs.js +17 -0
  24. package/dist/database/operations/refreshState/checkLocationKeyConflict.cjs.js.map +1 -0
  25. package/dist/database/operations/refreshState/insertUnprocessedEntity.cjs.js +38 -0
  26. package/dist/database/operations/refreshState/insertUnprocessedEntity.cjs.js.map +1 -0
  27. package/dist/database/operations/refreshState/updateUnprocessedEntity.cjs.js +28 -0
  28. package/dist/database/operations/refreshState/updateUnprocessedEntity.cjs.js.map +1 -0
  29. package/dist/database/operations/stitcher/buildEntitySearch.cjs.js +116 -0
  30. package/dist/database/operations/stitcher/buildEntitySearch.cjs.js.map +1 -0
  31. package/dist/database/operations/stitcher/getDeferredStitchableEntities.cjs.js +43 -0
  32. package/dist/database/operations/stitcher/getDeferredStitchableEntities.cjs.js.map +1 -0
  33. package/dist/database/operations/stitcher/markDeferredStitchCompleted.cjs.js +12 -0
  34. package/dist/database/operations/stitcher/markDeferredStitchCompleted.cjs.js.map +1 -0
  35. package/dist/database/operations/stitcher/markForStitching.cjs.js +63 -0
  36. package/dist/database/operations/stitcher/markForStitching.cjs.js.map +1 -0
  37. package/dist/database/operations/stitcher/performStitching.cjs.js +141 -0
  38. package/dist/database/operations/stitcher/performStitching.cjs.js.map +1 -0
  39. package/dist/database/operations/stitcher/util.cjs.js +17 -0
  40. package/dist/database/operations/stitcher/util.cjs.js.map +1 -0
  41. package/dist/database/operations/util/deleteOrphanedEntities.cjs.js +53 -0
  42. package/dist/database/operations/util/deleteOrphanedEntities.cjs.js.map +1 -0
  43. package/dist/database/util.cjs.js +15 -0
  44. package/dist/database/util.cjs.js.map +1 -0
  45. package/dist/deprecated.cjs.js +17 -0
  46. package/dist/deprecated.cjs.js.map +1 -0
  47. package/dist/index.cjs.js +37 -269
  48. package/dist/index.cjs.js.map +1 -1
  49. package/dist/ingestion/CatalogRules.cjs.js +158 -0
  50. package/dist/ingestion/CatalogRules.cjs.js.map +1 -0
  51. package/dist/ingestion/LocationAnalyzer.cjs.js +75 -0
  52. package/dist/ingestion/LocationAnalyzer.cjs.js.map +1 -0
  53. package/dist/permissions/conditionExports.cjs.js +17 -0
  54. package/dist/permissions/conditionExports.cjs.js.map +1 -0
  55. package/dist/permissions/rules/createPropertyRule.cjs.js +36 -0
  56. package/dist/permissions/rules/createPropertyRule.cjs.js.map +1 -0
  57. package/dist/permissions/rules/hasAnnotation.cjs.js +25 -0
  58. package/dist/permissions/rules/hasAnnotation.cjs.js.map +1 -0
  59. package/dist/permissions/rules/hasLabel.cjs.js +21 -0
  60. package/dist/permissions/rules/hasLabel.cjs.js.map +1 -0
  61. package/dist/permissions/rules/hasMetadata.cjs.js +8 -0
  62. package/dist/permissions/rules/hasMetadata.cjs.js.map +1 -0
  63. package/dist/permissions/rules/hasSpec.cjs.js +8 -0
  64. package/dist/permissions/rules/hasSpec.cjs.js.map +1 -0
  65. package/dist/permissions/rules/index.cjs.js +22 -0
  66. package/dist/permissions/rules/index.cjs.js.map +1 -0
  67. package/dist/permissions/rules/isEntityKind.cjs.js +27 -0
  68. package/dist/permissions/rules/isEntityKind.cjs.js.map +1 -0
  69. package/dist/permissions/rules/isEntityOwner.cjs.js +30 -0
  70. package/dist/permissions/rules/isEntityOwner.cjs.js.map +1 -0
  71. package/dist/permissions/rules/util.cjs.js +8 -0
  72. package/dist/permissions/rules/util.cjs.js.map +1 -0
  73. package/dist/processing/DefaultCatalogProcessingEngine.cjs.js +374 -0
  74. package/dist/processing/DefaultCatalogProcessingEngine.cjs.js.map +1 -0
  75. package/dist/processing/DefaultCatalogProcessingOrchestrator.cjs.js +329 -0
  76. package/dist/processing/DefaultCatalogProcessingOrchestrator.cjs.js.map +1 -0
  77. package/dist/processing/ProcessorCacheManager.cjs.js +89 -0
  78. package/dist/processing/ProcessorCacheManager.cjs.js.map +1 -0
  79. package/dist/processing/ProcessorOutputCollector.cjs.js +99 -0
  80. package/dist/processing/ProcessorOutputCollector.cjs.js.map +1 -0
  81. package/dist/processing/TaskPipeline.cjs.js +92 -0
  82. package/dist/processing/TaskPipeline.cjs.js.map +1 -0
  83. package/dist/processing/connectEntityProviders.cjs.js +72 -0
  84. package/dist/processing/connectEntityProviders.cjs.js.map +1 -0
  85. package/dist/processing/refresh.cjs.js +11 -0
  86. package/dist/processing/refresh.cjs.js.map +1 -0
  87. package/dist/processing/util.cjs.js +65 -0
  88. package/dist/processing/util.cjs.js.map +1 -0
  89. package/dist/processors/AnnotateLocationEntityProcessor.cjs.js +57 -0
  90. package/dist/processors/AnnotateLocationEntityProcessor.cjs.js.map +1 -0
  91. package/dist/processors/AnnotateScmSlugEntityProcessor.cjs.js +76 -0
  92. package/dist/processors/AnnotateScmSlugEntityProcessor.cjs.js.map +1 -0
  93. package/dist/processors/BuiltinKindsEntityProcessor.cjs.js +213 -0
  94. package/dist/processors/BuiltinKindsEntityProcessor.cjs.js.map +1 -0
  95. package/dist/processors/CodeOwnersProcessor.cjs.js +56 -0
  96. package/dist/processors/CodeOwnersProcessor.cjs.js.map +1 -0
  97. package/dist/processors/FileReaderProcessor.cjs.js +59 -0
  98. package/dist/processors/FileReaderProcessor.cjs.js.map +1 -0
  99. package/dist/processors/LocationEntityProcessor.cjs.js +64 -0
  100. package/dist/processors/LocationEntityProcessor.cjs.js.map +1 -0
  101. package/dist/processors/PlaceholderProcessor.cjs.js +143 -0
  102. package/dist/processors/PlaceholderProcessor.cjs.js.map +1 -0
  103. package/dist/processors/UrlReaderProcessor.cjs.js +94 -0
  104. package/dist/processors/UrlReaderProcessor.cjs.js.map +1 -0
  105. package/dist/processors/codeowners/read.cjs.js +45 -0
  106. package/dist/processors/codeowners/read.cjs.js.map +1 -0
  107. package/dist/processors/codeowners/resolve.cjs.js +51 -0
  108. package/dist/processors/codeowners/resolve.cjs.js.map +1 -0
  109. package/dist/processors/codeowners/scm.cjs.js +14 -0
  110. package/dist/processors/codeowners/scm.cjs.js.map +1 -0
  111. package/dist/processors/transformLegacyPolicyToProcessor.cjs.js +19 -0
  112. package/dist/processors/transformLegacyPolicyToProcessor.cjs.js.map +1 -0
  113. package/dist/providers/ConfigLocationEntityProvider.cjs.js +57 -0
  114. package/dist/providers/ConfigLocationEntityProvider.cjs.js.map +1 -0
  115. package/dist/providers/DefaultLocationStore.cjs.js +126 -0
  116. package/dist/providers/DefaultLocationStore.cjs.js.map +1 -0
  117. package/dist/schema/openapi.generated.cjs.js +1552 -0
  118. package/dist/schema/openapi.generated.cjs.js.map +1 -0
  119. package/dist/search/DefaultCatalogCollator.cjs.js +79 -0
  120. package/dist/search/DefaultCatalogCollator.cjs.js.map +1 -0
  121. package/dist/service/AuthorizedEntitiesCatalog.cjs.js +228 -0
  122. package/dist/service/AuthorizedEntitiesCatalog.cjs.js.map +1 -0
  123. package/dist/service/AuthorizedLocationAnalyzer.cjs.js +29 -0
  124. package/dist/service/AuthorizedLocationAnalyzer.cjs.js.map +1 -0
  125. package/dist/service/AuthorizedLocationService.cjs.js +65 -0
  126. package/dist/service/AuthorizedLocationService.cjs.js.map +1 -0
  127. package/dist/service/AuthorizedRefreshService.cjs.js +30 -0
  128. package/dist/service/AuthorizedRefreshService.cjs.js.map +1 -0
  129. package/dist/service/AuthorizedValidationService.cjs.js +29 -0
  130. package/dist/service/AuthorizedValidationService.cjs.js.map +1 -0
  131. package/dist/service/CatalogBuilder.cjs.js +631 -0
  132. package/dist/service/CatalogBuilder.cjs.js.map +1 -0
  133. package/dist/service/CatalogPlugin.cjs.js +213 -0
  134. package/dist/service/CatalogPlugin.cjs.js.map +1 -0
  135. package/dist/service/DefaultEntitiesCatalog.cjs.js +505 -0
  136. package/dist/service/DefaultEntitiesCatalog.cjs.js.map +1 -0
  137. package/dist/service/DefaultLocationService.cjs.js +107 -0
  138. package/dist/service/DefaultLocationService.cjs.js.map +1 -0
  139. package/dist/service/DefaultRefreshService.cjs.js +29 -0
  140. package/dist/service/DefaultRefreshService.cjs.js.map +1 -0
  141. package/dist/service/createRouter.cjs.js +284 -0
  142. package/dist/service/createRouter.cjs.js.map +1 -0
  143. package/dist/service/request/basicEntityFilter.cjs.js +14 -0
  144. package/dist/service/request/basicEntityFilter.cjs.js.map +1 -0
  145. package/dist/service/request/common.cjs.js +17 -0
  146. package/dist/service/request/common.cjs.js.map +1 -0
  147. package/dist/service/request/entitiesBatchRequest.cjs.js +21 -0
  148. package/dist/service/request/entitiesBatchRequest.cjs.js.map +1 -0
  149. package/dist/service/request/parseEntityFacetParams.cjs.js +18 -0
  150. package/dist/service/request/parseEntityFacetParams.cjs.js.map +1 -0
  151. package/dist/service/request/parseEntityFilterParams.cjs.js +47 -0
  152. package/dist/service/request/parseEntityFilterParams.cjs.js.map +1 -0
  153. package/dist/service/request/parseEntityOrderFieldParams.cjs.js +25 -0
  154. package/dist/service/request/parseEntityOrderFieldParams.cjs.js.map +1 -0
  155. package/dist/service/request/parseEntityOrderParams.cjs.js +22 -0
  156. package/dist/service/request/parseEntityOrderParams.cjs.js.map +1 -0
  157. package/dist/service/request/parseEntityPaginationParams.cjs.js +30 -0
  158. package/dist/service/request/parseEntityPaginationParams.cjs.js.map +1 -0
  159. package/dist/service/request/parseEntityTransformParams.cjs.js +54 -0
  160. package/dist/service/request/parseEntityTransformParams.cjs.js.map +1 -0
  161. package/dist/service/request/parseQueryEntitiesParams.cjs.js +33 -0
  162. package/dist/service/request/parseQueryEntitiesParams.cjs.js.map +1 -0
  163. package/dist/service/util.cjs.js +105 -0
  164. package/dist/service/util.cjs.js.map +1 -0
  165. package/dist/stitching/DefaultStitcher.cjs.js +131 -0
  166. package/dist/stitching/DefaultStitcher.cjs.js.map +1 -0
  167. package/dist/stitching/progressTracker.cjs.js +75 -0
  168. package/dist/stitching/progressTracker.cjs.js.map +1 -0
  169. package/dist/stitching/types.cjs.js +24 -0
  170. package/dist/stitching/types.cjs.js.map +1 -0
  171. package/dist/util/conversion.cjs.js +63 -0
  172. package/dist/util/conversion.cjs.js.map +1 -0
  173. package/dist/util/metrics.cjs.js +33 -0
  174. package/dist/util/metrics.cjs.js.map +1 -0
  175. package/dist/util/opentelemetry.cjs.js +66 -0
  176. package/dist/util/opentelemetry.cjs.js.map +1 -0
  177. package/dist/util/parse.cjs.js +47 -0
  178. package/dist/util/parse.cjs.js.map +1 -0
  179. package/package.json +14 -14
  180. package/dist/cjs/CatalogBuilder-BBOOqsyi.cjs.js +0 -7379
  181. package/dist/cjs/CatalogBuilder-BBOOqsyi.cjs.js.map +0 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,27 @@
1
1
  # @backstage/plugin-catalog-backend
2
2
 
3
+ ## 1.26.2-next.2
4
+
5
+ ### Patch Changes
6
+
7
+ - 720a2f9: Updated dependency `git-url-parse` to `^15.0.0`.
8
+ - f1cab41: Update catalog search table in transaction
9
+ - Updated dependencies
10
+ - @backstage/plugin-catalog-node@1.13.1-next.1
11
+ - @backstage/integration@1.15.1-next.1
12
+ - @backstage/backend-openapi-utils@0.2.0-next.1
13
+ - @backstage/catalog-client@1.7.1-next.0
14
+ - @backstage/backend-plugin-api@1.0.1-next.1
15
+ - @backstage/catalog-model@1.7.0
16
+ - @backstage/config@1.2.0
17
+ - @backstage/errors@1.2.4
18
+ - @backstage/types@1.1.1
19
+ - @backstage/plugin-catalog-common@1.1.0
20
+ - @backstage/plugin-events-node@0.4.1-next.1
21
+ - @backstage/plugin-permission-common@0.8.1
22
+ - @backstage/plugin-permission-node@0.8.4-next.1
23
+ - @backstage/plugin-search-backend-module-catalog@0.2.3-next.2
24
+
3
25
  ## 1.26.2-next.1
4
26
 
5
27
  ### Patch Changes
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-catalog-backend__alpha",
3
- "version": "1.26.2-next.1",
3
+ "version": "1.26.2-next.2",
4
4
  "main": "../dist/alpha.cjs.js",
5
5
  "types": "../dist/alpha.d.ts"
6
6
  }
package/dist/alpha.cjs.js CHANGED
@@ -2,257 +2,16 @@
2
2
 
3
3
  Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
- var alpha = require('@backstage/plugin-catalog-common/alpha');
6
- var pluginPermissionNode = require('@backstage/plugin-permission-node');
7
- var CatalogBuilder = require('./cjs/CatalogBuilder-BBOOqsyi.cjs.js');
8
- var backendPluginApi = require('@backstage/backend-plugin-api');
9
- var pluginEventsNode = require('@backstage/plugin-events-node');
10
- var alpha$1 = require('@backstage/plugin-catalog-node/alpha');
11
- var lodash = require('lodash');
12
- var errors = require('@backstage/errors');
13
- require('@backstage/backend-common');
14
- require('@backstage/catalog-model');
15
- require('@backstage/integration');
16
- require('crypto');
17
- require('git-url-parse');
18
- require('@backstage/plugin-catalog-node');
19
- require('core-js/features/promise');
20
- require('codeowners-utils');
21
- require('fs-extra');
22
- require('glob');
23
- require('path');
24
- require('util');
25
- require('yaml');
26
- require('p-limit');
27
- require('uuid');
28
- require('@backstage/plugin-permission-common');
29
- require('luxon');
30
- require('prom-client');
31
- require('@opentelemetry/api');
32
- require('fast-json-stable-stringify');
33
- require('lodash/uniq');
34
- require('lodash/chunk');
35
- require('zod');
36
- require('@backstage/types');
37
- require('@backstage/catalog-client');
38
- require('yn');
39
- require('@backstage/backend-openapi-utils');
40
- require('minimatch');
41
- require('@backstage/config');
5
+ var conditionExports = require('./permissions/conditionExports.cjs.js');
6
+ var index = require('./permissions/rules/index.cjs.js');
7
+ var CatalogPlugin = require('./service/CatalogPlugin.cjs.js');
8
+ var util = require('./permissions/rules/util.cjs.js');
42
9
 
43
- const { conditions, createConditionalDecision } = pluginPermissionNode.createConditionExports({
44
- pluginId: "catalog",
45
- resourceType: alpha.RESOURCE_TYPE_CATALOG_ENTITY,
46
- rules: CatalogBuilder.permissionRules
47
- });
48
- const catalogConditions = conditions;
49
- const createCatalogConditionalDecision = createConditionalDecision;
50
10
 
51
- class CatalogLocationsExtensionPointImpl {
52
- #locationTypes;
53
- setAllowedLocationTypes(locationTypes) {
54
- this.#locationTypes = locationTypes;
55
- }
56
- get allowedLocationTypes() {
57
- return this.#locationTypes;
58
- }
59
- }
60
- class CatalogProcessingExtensionPointImpl {
61
- #processors = new Array();
62
- #entityProviders = new Array();
63
- #placeholderResolvers = {};
64
- #onProcessingErrorHandler;
65
- addProcessor(...processors) {
66
- this.#processors.push(...processors.flat());
67
- }
68
- addEntityProvider(...providers) {
69
- this.#entityProviders.push(...providers.flat());
70
- }
71
- addPlaceholderResolver(key, resolver) {
72
- if (key in this.#placeholderResolvers)
73
- throw new Error(
74
- `A placeholder resolver for '${key}' has already been set up, please check your config.`
75
- );
76
- this.#placeholderResolvers[key] = resolver;
77
- }
78
- setOnProcessingErrorHandler(handler) {
79
- this.#onProcessingErrorHandler = handler;
80
- }
81
- get processors() {
82
- return this.#processors;
83
- }
84
- get entityProviders() {
85
- return this.#entityProviders;
86
- }
87
- get placeholderResolvers() {
88
- return this.#placeholderResolvers;
89
- }
90
- get onProcessingErrorHandler() {
91
- return this.#onProcessingErrorHandler;
92
- }
93
- }
94
- class CatalogPermissionExtensionPointImpl {
95
- #permissions = new Array();
96
- #permissionRules = new Array();
97
- addPermissions(...permission) {
98
- this.#permissions.push(...permission.flat());
99
- }
100
- addPermissionRules(...rules) {
101
- this.#permissionRules.push(...rules.flat());
102
- }
103
- get permissions() {
104
- return this.#permissions;
105
- }
106
- get permissionRules() {
107
- return this.#permissionRules;
108
- }
109
- }
110
- class CatalogModelExtensionPointImpl {
111
- #fieldValidators = {};
112
- setFieldValidators(validators) {
113
- lodash.merge(this.#fieldValidators, validators);
114
- }
115
- get fieldValidators() {
116
- return this.#fieldValidators;
117
- }
118
- #entityDataParser;
119
- setEntityDataParser(parser) {
120
- if (this.#entityDataParser) {
121
- throw new Error(
122
- "Attempted to install second EntityDataParser. Only one can be set."
123
- );
124
- }
125
- this.#entityDataParser = parser;
126
- }
127
- get entityDataParser() {
128
- return this.#entityDataParser;
129
- }
130
- }
131
- const catalogPlugin = backendPluginApi.createBackendPlugin({
132
- pluginId: "catalog",
133
- register(env) {
134
- const processingExtensions = new CatalogProcessingExtensionPointImpl();
135
- env.registerExtensionPoint(
136
- alpha$1.catalogProcessingExtensionPoint,
137
- processingExtensions
138
- );
139
- let locationAnalyzerFactory = void 0;
140
- const scmLocationAnalyzers = new Array();
141
- env.registerExtensionPoint(alpha$1.catalogAnalysisExtensionPoint, {
142
- setLocationAnalyzer(analyzerOrFactory) {
143
- if (locationAnalyzerFactory) {
144
- throw new Error("LocationAnalyzer has already been set");
145
- }
146
- if (typeof analyzerOrFactory === "function") {
147
- locationAnalyzerFactory = analyzerOrFactory;
148
- } else {
149
- locationAnalyzerFactory = async () => ({
150
- locationAnalyzer: analyzerOrFactory
151
- });
152
- }
153
- },
154
- addScmLocationAnalyzer(analyzer) {
155
- scmLocationAnalyzers.push(analyzer);
156
- }
157
- });
158
- const permissionExtensions = new CatalogPermissionExtensionPointImpl();
159
- env.registerExtensionPoint(
160
- alpha$1.catalogPermissionExtensionPoint,
161
- permissionExtensions
162
- );
163
- const modelExtensions = new CatalogModelExtensionPointImpl();
164
- env.registerExtensionPoint(alpha$1.catalogModelExtensionPoint, modelExtensions);
165
- const locationTypeExtensions = new CatalogLocationsExtensionPointImpl();
166
- env.registerExtensionPoint(
167
- alpha$1.catalogLocationsExtensionPoint,
168
- locationTypeExtensions
169
- );
170
- env.registerInit({
171
- deps: {
172
- logger: backendPluginApi.coreServices.logger,
173
- config: backendPluginApi.coreServices.rootConfig,
174
- reader: backendPluginApi.coreServices.urlReader,
175
- permissions: backendPluginApi.coreServices.permissions,
176
- database: backendPluginApi.coreServices.database,
177
- httpRouter: backendPluginApi.coreServices.httpRouter,
178
- lifecycle: backendPluginApi.coreServices.rootLifecycle,
179
- scheduler: backendPluginApi.coreServices.scheduler,
180
- discovery: backendPluginApi.coreServices.discovery,
181
- auth: backendPluginApi.coreServices.auth,
182
- httpAuth: backendPluginApi.coreServices.httpAuth,
183
- events: pluginEventsNode.eventsServiceRef
184
- },
185
- async init({
186
- logger,
187
- config,
188
- reader,
189
- database,
190
- permissions,
191
- httpRouter,
192
- lifecycle,
193
- scheduler,
194
- discovery,
195
- auth,
196
- httpAuth,
197
- events
198
- }) {
199
- const builder = await CatalogBuilder.CatalogBuilder.create({
200
- config,
201
- reader,
202
- permissions,
203
- database,
204
- scheduler,
205
- logger,
206
- discovery,
207
- auth,
208
- httpAuth
209
- });
210
- builder.setEventBroker(events);
211
- if (processingExtensions.onProcessingErrorHandler) {
212
- builder.subscribe({
213
- onProcessingError: processingExtensions.onProcessingErrorHandler
214
- });
215
- }
216
- builder.addProcessor(...processingExtensions.processors);
217
- builder.addEntityProvider(...processingExtensions.entityProviders);
218
- if (modelExtensions.entityDataParser) {
219
- builder.setEntityDataParser(modelExtensions.entityDataParser);
220
- }
221
- Object.entries(processingExtensions.placeholderResolvers).forEach(
222
- ([key, resolver]) => builder.setPlaceholderResolver(key, resolver)
223
- );
224
- if (locationAnalyzerFactory) {
225
- const { locationAnalyzer } = await locationAnalyzerFactory({
226
- scmLocationAnalyzers
227
- }).catch((e) => {
228
- throw new errors.ForwardedError("Failed to create LocationAnalyzer", e);
229
- });
230
- builder.setLocationAnalyzer(locationAnalyzer);
231
- } else {
232
- builder.addLocationAnalyzers(...scmLocationAnalyzers);
233
- }
234
- builder.addPermissions(...permissionExtensions.permissions);
235
- builder.addPermissionRules(...permissionExtensions.permissionRules);
236
- builder.setFieldFormatValidators(modelExtensions.fieldValidators);
237
- if (locationTypeExtensions.allowedLocationTypes) {
238
- builder.setAllowedLocationTypes(
239
- locationTypeExtensions.allowedLocationTypes
240
- );
241
- }
242
- const { processingEngine, router } = await builder.build();
243
- lifecycle.addStartupHook(async () => {
244
- await processingEngine.start();
245
- });
246
- lifecycle.addShutdownHook(() => processingEngine.stop());
247
- httpRouter.use(router);
248
- }
249
- });
250
- }
251
- });
252
11
 
253
- exports.createCatalogPermissionRule = CatalogBuilder.createCatalogPermissionRule;
254
- exports.permissionRules = CatalogBuilder.permissionRules;
255
- exports.catalogConditions = catalogConditions;
256
- exports.createCatalogConditionalDecision = createCatalogConditionalDecision;
257
- exports.default = catalogPlugin;
12
+ exports.catalogConditions = conditionExports.catalogConditions;
13
+ exports.createCatalogConditionalDecision = conditionExports.createCatalogConditionalDecision;
14
+ exports.permissionRules = index.permissionRules;
15
+ exports.default = CatalogPlugin.catalogPlugin;
16
+ exports.createCatalogPermissionRule = util.createCatalogPermissionRule;
258
17
  //# sourceMappingURL=alpha.cjs.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"alpha.cjs.js","sources":["../src/permissions/conditionExports.ts","../src/service/CatalogPlugin.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 { RESOURCE_TYPE_CATALOG_ENTITY } from '@backstage/plugin-catalog-common/alpha';\nimport { createConditionExports } from '@backstage/plugin-permission-node';\nimport { permissionRules } from './rules';\n\nconst { conditions, createConditionalDecision } = createConditionExports({\n pluginId: 'catalog',\n resourceType: RESOURCE_TYPE_CATALOG_ENTITY,\n rules: permissionRules,\n});\n\n/**\n * These conditions are used when creating conditional decisions for catalog\n * entities that are returned by authorization policies.\n *\n * @alpha\n */\nexport const catalogConditions = conditions;\n\n/**\n * `createCatalogConditionalDecision` can be used when authoring policies to\n * create conditional decisions. It requires a permission of type\n * `ResourcePermission<'catalog-entity'>` to be passed as the first parameter.\n * It's recommended that you use the provided `isResourcePermission` and\n * `isPermission` helper methods to narrow the type of the permission passed to\n * the handle method as shown below.\n *\n * ```\n * // MyAuthorizationPolicy.ts\n * ...\n * import { createCatalogPolicyDecision } from '@backstage/plugin-catalog-backend';\n * import { RESOURCE_TYPE_CATALOG_ENTITY } from '@backstage/plugin-catalog-common';\n *\n * class MyAuthorizationPolicy implements PermissionPolicy {\n * async handle(request, user) {\n * ...\n *\n * if (isResourcePermission(request.permission, RESOURCE_TYPE_CATALOG_ENTITY)) {\n * return createCatalogConditionalDecision(\n * request.permission,\n * { anyOf: [...insert conditions here...] }\n * );\n * }\n *\n * ...\n * }\n * ```\n *\n * @alpha\n */\nexport const createCatalogConditionalDecision = createConditionalDecision;\n","/*\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 */\nimport {\n coreServices,\n createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { eventsServiceRef } from '@backstage/plugin-events-node';\nimport { Entity, Validators } from '@backstage/catalog-model';\nimport { CatalogBuilder, CatalogPermissionRuleInput } from './CatalogBuilder';\nimport {\n catalogAnalysisExtensionPoint,\n CatalogModelExtensionPoint,\n catalogModelExtensionPoint,\n CatalogPermissionExtensionPoint,\n catalogPermissionExtensionPoint,\n CatalogProcessingExtensionPoint,\n catalogProcessingExtensionPoint,\n CatalogLocationsExtensionPoint,\n catalogLocationsExtensionPoint,\n} from '@backstage/plugin-catalog-node/alpha';\nimport {\n CatalogProcessor,\n CatalogProcessorParser,\n EntityProvider,\n LocationAnalyzer,\n PlaceholderResolver,\n ScmLocationAnalyzer,\n} from '@backstage/plugin-catalog-node';\nimport { merge } from 'lodash';\nimport { Permission } from '@backstage/plugin-permission-common';\nimport { ForwardedError } from '@backstage/errors';\n\nclass CatalogLocationsExtensionPointImpl\n implements CatalogLocationsExtensionPoint\n{\n #locationTypes: string[] | undefined;\n\n setAllowedLocationTypes(locationTypes: Array<string>) {\n this.#locationTypes = locationTypes;\n }\n\n get allowedLocationTypes() {\n return this.#locationTypes;\n }\n}\n\nclass CatalogProcessingExtensionPointImpl\n implements CatalogProcessingExtensionPoint\n{\n #processors = new Array<CatalogProcessor>();\n #entityProviders = new Array<EntityProvider>();\n #placeholderResolvers: Record<string, PlaceholderResolver> = {};\n #onProcessingErrorHandler?: (event: {\n unprocessedEntity: Entity;\n errors: Error[];\n }) => Promise<void> | void;\n\n addProcessor(\n ...processors: Array<CatalogProcessor | Array<CatalogProcessor>>\n ): void {\n this.#processors.push(...processors.flat());\n }\n\n addEntityProvider(\n ...providers: Array<EntityProvider | Array<EntityProvider>>\n ): void {\n this.#entityProviders.push(...providers.flat());\n }\n\n addPlaceholderResolver(key: string, resolver: PlaceholderResolver) {\n if (key in this.#placeholderResolvers)\n throw new Error(\n `A placeholder resolver for '${key}' has already been set up, please check your config.`,\n );\n this.#placeholderResolvers[key] = resolver;\n }\n\n setOnProcessingErrorHandler(\n handler: (event: {\n unprocessedEntity: Entity;\n errors: Error[];\n }) => Promise<void> | void,\n ) {\n this.#onProcessingErrorHandler = handler;\n }\n\n get processors() {\n return this.#processors;\n }\n\n get entityProviders() {\n return this.#entityProviders;\n }\n\n get placeholderResolvers() {\n return this.#placeholderResolvers;\n }\n\n get onProcessingErrorHandler() {\n return this.#onProcessingErrorHandler;\n }\n}\n\nclass CatalogPermissionExtensionPointImpl\n implements CatalogPermissionExtensionPoint\n{\n #permissions = new Array<Permission>();\n #permissionRules = new Array<CatalogPermissionRuleInput>();\n\n addPermissions(...permission: Array<Permission | Array<Permission>>): void {\n this.#permissions.push(...permission.flat());\n }\n\n addPermissionRules(\n ...rules: Array<\n CatalogPermissionRuleInput | Array<CatalogPermissionRuleInput>\n >\n ): void {\n this.#permissionRules.push(...rules.flat());\n }\n\n get permissions() {\n return this.#permissions;\n }\n\n get permissionRules() {\n return this.#permissionRules;\n }\n}\n\nclass CatalogModelExtensionPointImpl implements CatalogModelExtensionPoint {\n #fieldValidators: Partial<Validators> = {};\n\n setFieldValidators(validators: Partial<Validators>): void {\n merge(this.#fieldValidators, validators);\n }\n\n get fieldValidators() {\n return this.#fieldValidators;\n }\n\n #entityDataParser?: CatalogProcessorParser;\n\n setEntityDataParser(parser: CatalogProcessorParser): void {\n if (this.#entityDataParser) {\n throw new Error(\n 'Attempted to install second EntityDataParser. Only one can be set.',\n );\n }\n this.#entityDataParser = parser;\n }\n\n get entityDataParser() {\n return this.#entityDataParser;\n }\n}\n\n/**\n * Catalog plugin\n * @alpha\n */\nexport const catalogPlugin = createBackendPlugin({\n pluginId: 'catalog',\n register(env) {\n const processingExtensions = new CatalogProcessingExtensionPointImpl();\n // plugins depending on this API will be initialized before this plugins init method is executed.\n env.registerExtensionPoint(\n catalogProcessingExtensionPoint,\n processingExtensions,\n );\n\n let locationAnalyzerFactory:\n | ((options: {\n scmLocationAnalyzers: ScmLocationAnalyzer[];\n }) => Promise<{ locationAnalyzer: LocationAnalyzer }>)\n | undefined = undefined;\n const scmLocationAnalyzers = new Array<ScmLocationAnalyzer>();\n env.registerExtensionPoint(catalogAnalysisExtensionPoint, {\n setLocationAnalyzer(analyzerOrFactory) {\n if (locationAnalyzerFactory) {\n throw new Error('LocationAnalyzer has already been set');\n }\n if (typeof analyzerOrFactory === 'function') {\n locationAnalyzerFactory = analyzerOrFactory;\n } else {\n locationAnalyzerFactory = async () => ({\n locationAnalyzer: analyzerOrFactory,\n });\n }\n },\n addScmLocationAnalyzer(analyzer: ScmLocationAnalyzer) {\n scmLocationAnalyzers.push(analyzer);\n },\n });\n\n const permissionExtensions = new CatalogPermissionExtensionPointImpl();\n env.registerExtensionPoint(\n catalogPermissionExtensionPoint,\n permissionExtensions,\n );\n\n const modelExtensions = new CatalogModelExtensionPointImpl();\n env.registerExtensionPoint(catalogModelExtensionPoint, modelExtensions);\n\n const locationTypeExtensions = new CatalogLocationsExtensionPointImpl();\n env.registerExtensionPoint(\n catalogLocationsExtensionPoint,\n locationTypeExtensions,\n );\n\n env.registerInit({\n deps: {\n logger: coreServices.logger,\n config: coreServices.rootConfig,\n reader: coreServices.urlReader,\n permissions: coreServices.permissions,\n database: coreServices.database,\n httpRouter: coreServices.httpRouter,\n lifecycle: coreServices.rootLifecycle,\n scheduler: coreServices.scheduler,\n discovery: coreServices.discovery,\n auth: coreServices.auth,\n httpAuth: coreServices.httpAuth,\n events: eventsServiceRef,\n },\n async init({\n logger,\n config,\n reader,\n database,\n permissions,\n httpRouter,\n lifecycle,\n scheduler,\n discovery,\n auth,\n httpAuth,\n events,\n }) {\n const builder = await CatalogBuilder.create({\n config,\n reader,\n permissions,\n database,\n scheduler,\n logger,\n discovery,\n auth,\n httpAuth,\n });\n\n builder.setEventBroker(events);\n\n if (processingExtensions.onProcessingErrorHandler) {\n builder.subscribe({\n onProcessingError: processingExtensions.onProcessingErrorHandler,\n });\n }\n builder.addProcessor(...processingExtensions.processors);\n builder.addEntityProvider(...processingExtensions.entityProviders);\n\n if (modelExtensions.entityDataParser) {\n builder.setEntityDataParser(modelExtensions.entityDataParser);\n }\n\n Object.entries(processingExtensions.placeholderResolvers).forEach(\n ([key, resolver]) => builder.setPlaceholderResolver(key, resolver),\n );\n if (locationAnalyzerFactory) {\n const { locationAnalyzer } = await locationAnalyzerFactory({\n scmLocationAnalyzers,\n }).catch(e => {\n throw new ForwardedError('Failed to create LocationAnalyzer', e);\n });\n builder.setLocationAnalyzer(locationAnalyzer);\n } else {\n builder.addLocationAnalyzers(...scmLocationAnalyzers);\n }\n builder.addPermissions(...permissionExtensions.permissions);\n builder.addPermissionRules(...permissionExtensions.permissionRules);\n builder.setFieldFormatValidators(modelExtensions.fieldValidators);\n\n if (locationTypeExtensions.allowedLocationTypes) {\n builder.setAllowedLocationTypes(\n locationTypeExtensions.allowedLocationTypes,\n );\n }\n\n const { processingEngine, router } = await builder.build();\n\n lifecycle.addStartupHook(async () => {\n await processingEngine.start();\n });\n lifecycle.addShutdownHook(() => processingEngine.stop());\n httpRouter.use(router);\n },\n });\n },\n});\n"],"names":["createConditionExports","RESOURCE_TYPE_CATALOG_ENTITY","permissionRules","merge","createBackendPlugin","catalogProcessingExtensionPoint","catalogAnalysisExtensionPoint","catalogPermissionExtensionPoint","catalogModelExtensionPoint","catalogLocationsExtensionPoint","coreServices","eventsServiceRef","CatalogBuilder","ForwardedError"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoBA,MAAM,EAAE,UAAA,EAAY,yBAA0B,EAAA,GAAIA,2CAAuB,CAAA;AAAA,EACvE,QAAU,EAAA,SAAA;AAAA,EACV,YAAc,EAAAC,kCAAA;AAAA,EACd,KAAO,EAAAC,8BAAA;AACT,CAAC,CAAA,CAAA;AAQM,MAAM,iBAAoB,GAAA,WAAA;AAiC1B,MAAM,gCAAmC,GAAA;;ACpBhD,MAAM,kCAEN,CAAA;AAAA,EACE,cAAA,CAAA;AAAA,EAEA,wBAAwB,aAA8B,EAAA;AACpD,IAAA,IAAA,CAAK,cAAiB,GAAA,aAAA,CAAA;AAAA,GACxB;AAAA,EAEA,IAAI,oBAAuB,GAAA;AACzB,IAAA,OAAO,IAAK,CAAA,cAAA,CAAA;AAAA,GACd;AACF,CAAA;AAEA,MAAM,mCAEN,CAAA;AAAA,EACE,WAAA,GAAc,IAAI,KAAwB,EAAA,CAAA;AAAA,EAC1C,gBAAA,GAAmB,IAAI,KAAsB,EAAA,CAAA;AAAA,EAC7C,wBAA6D,EAAC,CAAA;AAAA,EAC9D,yBAAA,CAAA;AAAA,EAKA,gBACK,UACG,EAAA;AACN,IAAA,IAAA,CAAK,WAAY,CAAA,IAAA,CAAK,GAAG,UAAA,CAAW,MAAM,CAAA,CAAA;AAAA,GAC5C;AAAA,EAEA,qBACK,SACG,EAAA;AACN,IAAA,IAAA,CAAK,gBAAiB,CAAA,IAAA,CAAK,GAAG,SAAA,CAAU,MAAM,CAAA,CAAA;AAAA,GAChD;AAAA,EAEA,sBAAA,CAAuB,KAAa,QAA+B,EAAA;AACjE,IAAA,IAAI,OAAO,IAAK,CAAA,qBAAA;AACd,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,+BAA+B,GAAG,CAAA,oDAAA,CAAA;AAAA,OACpC,CAAA;AACF,IAAK,IAAA,CAAA,qBAAA,CAAsB,GAAG,CAAI,GAAA,QAAA,CAAA;AAAA,GACpC;AAAA,EAEA,4BACE,OAIA,EAAA;AACA,IAAA,IAAA,CAAK,yBAA4B,GAAA,OAAA,CAAA;AAAA,GACnC;AAAA,EAEA,IAAI,UAAa,GAAA;AACf,IAAA,OAAO,IAAK,CAAA,WAAA,CAAA;AAAA,GACd;AAAA,EAEA,IAAI,eAAkB,GAAA;AACpB,IAAA,OAAO,IAAK,CAAA,gBAAA,CAAA;AAAA,GACd;AAAA,EAEA,IAAI,oBAAuB,GAAA;AACzB,IAAA,OAAO,IAAK,CAAA,qBAAA,CAAA;AAAA,GACd;AAAA,EAEA,IAAI,wBAA2B,GAAA;AAC7B,IAAA,OAAO,IAAK,CAAA,yBAAA,CAAA;AAAA,GACd;AACF,CAAA;AAEA,MAAM,mCAEN,CAAA;AAAA,EACE,YAAA,GAAe,IAAI,KAAkB,EAAA,CAAA;AAAA,EACrC,gBAAA,GAAmB,IAAI,KAAkC,EAAA,CAAA;AAAA,EAEzD,kBAAkB,UAAyD,EAAA;AACzE,IAAA,IAAA,CAAK,YAAa,CAAA,IAAA,CAAK,GAAG,UAAA,CAAW,MAAM,CAAA,CAAA;AAAA,GAC7C;AAAA,EAEA,sBACK,KAGG,EAAA;AACN,IAAA,IAAA,CAAK,gBAAiB,CAAA,IAAA,CAAK,GAAG,KAAA,CAAM,MAAM,CAAA,CAAA;AAAA,GAC5C;AAAA,EAEA,IAAI,WAAc,GAAA;AAChB,IAAA,OAAO,IAAK,CAAA,YAAA,CAAA;AAAA,GACd;AAAA,EAEA,IAAI,eAAkB,GAAA;AACpB,IAAA,OAAO,IAAK,CAAA,gBAAA,CAAA;AAAA,GACd;AACF,CAAA;AAEA,MAAM,8BAAqE,CAAA;AAAA,EACzE,mBAAwC,EAAC,CAAA;AAAA,EAEzC,mBAAmB,UAAuC,EAAA;AACxD,IAAMC,YAAA,CAAA,IAAA,CAAK,kBAAkB,UAAU,CAAA,CAAA;AAAA,GACzC;AAAA,EAEA,IAAI,eAAkB,GAAA;AACpB,IAAA,OAAO,IAAK,CAAA,gBAAA,CAAA;AAAA,GACd;AAAA,EAEA,iBAAA,CAAA;AAAA,EAEA,oBAAoB,MAAsC,EAAA;AACxD,IAAA,IAAI,KAAK,iBAAmB,EAAA;AAC1B,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,oEAAA;AAAA,OACF,CAAA;AAAA,KACF;AACA,IAAA,IAAA,CAAK,iBAAoB,GAAA,MAAA,CAAA;AAAA,GAC3B;AAAA,EAEA,IAAI,gBAAmB,GAAA;AACrB,IAAA,OAAO,IAAK,CAAA,iBAAA,CAAA;AAAA,GACd;AACF,CAAA;AAMO,MAAM,gBAAgBC,oCAAoB,CAAA;AAAA,EAC/C,QAAU,EAAA,SAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAM,MAAA,oBAAA,GAAuB,IAAI,mCAAoC,EAAA,CAAA;AAErE,IAAI,GAAA,CAAA,sBAAA;AAAA,MACFC,uCAAA;AAAA,MACA,oBAAA;AAAA,KACF,CAAA;AAEA,IAAA,IAAI,uBAIY,GAAA,KAAA,CAAA,CAAA;AAChB,IAAM,MAAA,oBAAA,GAAuB,IAAI,KAA2B,EAAA,CAAA;AAC5D,IAAA,GAAA,CAAI,uBAAuBC,qCAA+B,EAAA;AAAA,MACxD,oBAAoB,iBAAmB,EAAA;AACrC,QAAA,IAAI,uBAAyB,EAAA;AAC3B,UAAM,MAAA,IAAI,MAAM,uCAAuC,CAAA,CAAA;AAAA,SACzD;AACA,QAAI,IAAA,OAAO,sBAAsB,UAAY,EAAA;AAC3C,UAA0B,uBAAA,GAAA,iBAAA,CAAA;AAAA,SACrB,MAAA;AACL,UAAA,uBAAA,GAA0B,aAAa;AAAA,YACrC,gBAAkB,EAAA,iBAAA;AAAA,WACpB,CAAA,CAAA;AAAA,SACF;AAAA,OACF;AAAA,MACA,uBAAuB,QAA+B,EAAA;AACpD,QAAA,oBAAA,CAAqB,KAAK,QAAQ,CAAA,CAAA;AAAA,OACpC;AAAA,KACD,CAAA,CAAA;AAED,IAAM,MAAA,oBAAA,GAAuB,IAAI,mCAAoC,EAAA,CAAA;AACrE,IAAI,GAAA,CAAA,sBAAA;AAAA,MACFC,uCAAA;AAAA,MACA,oBAAA;AAAA,KACF,CAAA;AAEA,IAAM,MAAA,eAAA,GAAkB,IAAI,8BAA+B,EAAA,CAAA;AAC3D,IAAI,GAAA,CAAA,sBAAA,CAAuBC,oCAA4B,eAAe,CAAA,CAAA;AAEtE,IAAM,MAAA,sBAAA,GAAyB,IAAI,kCAAmC,EAAA,CAAA;AACtE,IAAI,GAAA,CAAA,sBAAA;AAAA,MACFC,sCAAA;AAAA,MACA,sBAAA;AAAA,KACF,CAAA;AAEA,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,MAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,UAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,SAAA;AAAA,QACrB,aAAaA,6BAAa,CAAA,WAAA;AAAA,QAC1B,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,YAAYA,6BAAa,CAAA,UAAA;AAAA,QACzB,WAAWA,6BAAa,CAAA,aAAA;AAAA,QACxB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,MAAMA,6BAAa,CAAA,IAAA;AAAA,QACnB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,MAAQ,EAAAC,iCAAA;AAAA,OACV;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,MAAA;AAAA,QACA,MAAA;AAAA,QACA,MAAA;AAAA,QACA,QAAA;AAAA,QACA,WAAA;AAAA,QACA,UAAA;AAAA,QACA,SAAA;AAAA,QACA,SAAA;AAAA,QACA,SAAA;AAAA,QACA,IAAA;AAAA,QACA,QAAA;AAAA,QACA,MAAA;AAAA,OACC,EAAA;AACD,QAAM,MAAA,OAAA,GAAU,MAAMC,6BAAA,CAAe,MAAO,CAAA;AAAA,UAC1C,MAAA;AAAA,UACA,MAAA;AAAA,UACA,WAAA;AAAA,UACA,QAAA;AAAA,UACA,SAAA;AAAA,UACA,MAAA;AAAA,UACA,SAAA;AAAA,UACA,IAAA;AAAA,UACA,QAAA;AAAA,SACD,CAAA,CAAA;AAED,QAAA,OAAA,CAAQ,eAAe,MAAM,CAAA,CAAA;AAE7B,QAAA,IAAI,qBAAqB,wBAA0B,EAAA;AACjD,UAAA,OAAA,CAAQ,SAAU,CAAA;AAAA,YAChB,mBAAmB,oBAAqB,CAAA,wBAAA;AAAA,WACzC,CAAA,CAAA;AAAA,SACH;AACA,QAAQ,OAAA,CAAA,YAAA,CAAa,GAAG,oBAAA,CAAqB,UAAU,CAAA,CAAA;AACvD,QAAQ,OAAA,CAAA,iBAAA,CAAkB,GAAG,oBAAA,CAAqB,eAAe,CAAA,CAAA;AAEjE,QAAA,IAAI,gBAAgB,gBAAkB,EAAA;AACpC,UAAQ,OAAA,CAAA,mBAAA,CAAoB,gBAAgB,gBAAgB,CAAA,CAAA;AAAA,SAC9D;AAEA,QAAO,MAAA,CAAA,OAAA,CAAQ,oBAAqB,CAAA,oBAAoB,CAAE,CAAA,OAAA;AAAA,UACxD,CAAC,CAAC,GAAK,EAAA,QAAQ,MAAM,OAAQ,CAAA,sBAAA,CAAuB,KAAK,QAAQ,CAAA;AAAA,SACnE,CAAA;AACA,QAAA,IAAI,uBAAyB,EAAA;AAC3B,UAAA,MAAM,EAAE,gBAAA,EAAqB,GAAA,MAAM,uBAAwB,CAAA;AAAA,YACzD,oBAAA;AAAA,WACD,CAAE,CAAA,KAAA,CAAM,CAAK,CAAA,KAAA;AACZ,YAAM,MAAA,IAAIC,qBAAe,CAAA,mCAAA,EAAqC,CAAC,CAAA,CAAA;AAAA,WAChE,CAAA,CAAA;AACD,UAAA,OAAA,CAAQ,oBAAoB,gBAAgB,CAAA,CAAA;AAAA,SACvC,MAAA;AACL,UAAQ,OAAA,CAAA,oBAAA,CAAqB,GAAG,oBAAoB,CAAA,CAAA;AAAA,SACtD;AACA,QAAQ,OAAA,CAAA,cAAA,CAAe,GAAG,oBAAA,CAAqB,WAAW,CAAA,CAAA;AAC1D,QAAQ,OAAA,CAAA,kBAAA,CAAmB,GAAG,oBAAA,CAAqB,eAAe,CAAA,CAAA;AAClE,QAAQ,OAAA,CAAA,wBAAA,CAAyB,gBAAgB,eAAe,CAAA,CAAA;AAEhE,QAAA,IAAI,uBAAuB,oBAAsB,EAAA;AAC/C,UAAQ,OAAA,CAAA,uBAAA;AAAA,YACN,sBAAuB,CAAA,oBAAA;AAAA,WACzB,CAAA;AAAA,SACF;AAEA,QAAA,MAAM,EAAE,gBAAkB,EAAA,MAAA,EAAW,GAAA,MAAM,QAAQ,KAAM,EAAA,CAAA;AAEzD,QAAA,SAAA,CAAU,eAAe,YAAY;AACnC,UAAA,MAAM,iBAAiB,KAAM,EAAA,CAAA;AAAA,SAC9B,CAAA,CAAA;AACD,QAAA,SAAA,CAAU,eAAgB,CAAA,MAAM,gBAAiB,CAAA,IAAA,EAAM,CAAA,CAAA;AACvD,QAAA,UAAA,CAAW,IAAI,MAAM,CAAA,CAAA;AAAA,OACvB;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;;;;"}
1
+ {"version":3,"file":"alpha.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;"}
@@ -0,0 +1,8 @@
1
+ 'use strict';
2
+
3
+ const CATALOG_CONFLICTS_TOPIC = "experimental.catalog.conflict";
4
+ const CATALOG_ERRORS_TOPIC = "experimental.catalog.errors";
5
+
6
+ exports.CATALOG_CONFLICTS_TOPIC = CATALOG_CONFLICTS_TOPIC;
7
+ exports.CATALOG_ERRORS_TOPIC = CATALOG_ERRORS_TOPIC;
8
+ //# sourceMappingURL=constants.cjs.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"constants.cjs.js","sources":["../src/constants.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/** @public */\nexport const CATALOG_CONFLICTS_TOPIC = 'experimental.catalog.conflict';\n/** @public */\nexport const CATALOG_ERRORS_TOPIC = 'experimental.catalog.errors';\n"],"names":[],"mappings":";;AAiBO,MAAM,uBAA0B,GAAA,gCAAA;AAEhC,MAAM,oBAAuB,GAAA;;;;;"}
@@ -0,0 +1,68 @@
1
+ 'use strict';
2
+
3
+ var errors = require('@backstage/errors');
4
+ var conversion = require('./conversion.cjs.js');
5
+
6
+ const MAX_ANCESTOR_DEPTH = 32;
7
+ class DefaultCatalogDatabase {
8
+ constructor(options) {
9
+ this.options = options;
10
+ }
11
+ async transaction(fn) {
12
+ try {
13
+ let result = void 0;
14
+ await this.options.database.transaction(
15
+ async (tx) => {
16
+ result = await fn(tx);
17
+ },
18
+ {
19
+ // If we explicitly trigger a rollback, don't fail.
20
+ doNotRejectOnRollback: true
21
+ }
22
+ );
23
+ return result;
24
+ } catch (e) {
25
+ this.options.logger.debug(`Error during transaction, ${e}`);
26
+ throw conversion.rethrowError(e);
27
+ }
28
+ }
29
+ async listAncestors(txOpaque, options) {
30
+ const tx = txOpaque;
31
+ const { entityRef } = options;
32
+ const entityRefs = new Array();
33
+ let currentRef = entityRef.toLocaleLowerCase("en-US");
34
+ for (let depth = 1; depth <= MAX_ANCESTOR_DEPTH; depth += 1) {
35
+ const rows = await tx(
36
+ "refresh_state_references"
37
+ ).where({ target_entity_ref: currentRef }).select();
38
+ if (rows.length === 0) {
39
+ if (depth === 1) {
40
+ throw new errors.NotFoundError(`Entity ${currentRef} not found`);
41
+ }
42
+ throw new errors.NotFoundError(
43
+ `Entity ${entityRef} has a broken parent reference chain at ${currentRef}`
44
+ );
45
+ }
46
+ const parentRef = rows.find((r) => r.source_entity_ref)?.source_entity_ref;
47
+ if (!parentRef) {
48
+ return { entityRefs };
49
+ }
50
+ entityRefs.push(parentRef);
51
+ currentRef = parentRef;
52
+ }
53
+ throw new Error(
54
+ `Unable receive ancestors for ${entityRef}, reached maximum depth of ${MAX_ANCESTOR_DEPTH}`
55
+ );
56
+ }
57
+ async refresh(txOpaque, options) {
58
+ const tx = txOpaque;
59
+ const { entityRef } = options;
60
+ const updateResult = await tx("refresh_state").where({ entity_ref: entityRef.toLocaleLowerCase("en-US") }).update({ next_update_at: tx.fn.now() });
61
+ if (updateResult === 0) {
62
+ throw new errors.NotFoundError(`Failed to schedule ${entityRef} for refresh`);
63
+ }
64
+ }
65
+ }
66
+
67
+ exports.DefaultCatalogDatabase = DefaultCatalogDatabase;
68
+ //# sourceMappingURL=DefaultCatalogDatabase.cjs.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"DefaultCatalogDatabase.cjs.js","sources":["../../src/database/DefaultCatalogDatabase.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 { NotFoundError } from '@backstage/errors';\nimport { Knex } from 'knex';\nimport {\n CatalogDatabase,\n ListAncestorsOptions,\n ListAncestorsResult,\n RefreshOptions,\n Transaction,\n} from './types';\nimport { DbRefreshStateReferencesRow, DbRefreshStateRow } from './tables';\nimport { rethrowError } from './conversion';\nimport { LoggerService } from '@backstage/backend-plugin-api';\n\nconst MAX_ANCESTOR_DEPTH = 32;\n\nexport class DefaultCatalogDatabase implements CatalogDatabase {\n constructor(\n private readonly options: {\n database: Knex;\n logger: LoggerService;\n },\n ) {}\n\n async transaction<T>(fn: (tx: Transaction) => Promise<T>): Promise<T> {\n try {\n let result: T | undefined = undefined;\n\n await this.options.database.transaction(\n async tx => {\n // We can't return here, as knex swallows the return type in case the transaction is rolled back:\n // https://github.com/knex/knex/blob/e37aeaa31c8ef9c1b07d2e4d3ec6607e557d800d/lib/transaction.js#L136\n result = await fn(tx);\n },\n {\n // If we explicitly trigger a rollback, don't fail.\n doNotRejectOnRollback: true,\n },\n );\n\n return result!;\n } catch (e) {\n this.options.logger.debug(`Error during transaction, ${e}`);\n throw rethrowError(e);\n }\n }\n\n async listAncestors(\n txOpaque: Transaction,\n options: ListAncestorsOptions,\n ): Promise<ListAncestorsResult> {\n const tx = txOpaque as Knex.Transaction;\n const { entityRef } = options;\n const entityRefs = new Array<string>();\n\n let currentRef = entityRef.toLocaleLowerCase('en-US');\n for (let depth = 1; depth <= MAX_ANCESTOR_DEPTH; depth += 1) {\n const rows = await tx<DbRefreshStateReferencesRow>(\n 'refresh_state_references',\n )\n .where({ target_entity_ref: currentRef })\n .select();\n\n if (rows.length === 0) {\n if (depth === 1) {\n throw new NotFoundError(`Entity ${currentRef} not found`);\n }\n throw new NotFoundError(\n `Entity ${entityRef} has a broken parent reference chain at ${currentRef}`,\n );\n }\n\n const parentRef = rows.find(r => r.source_entity_ref)?.source_entity_ref;\n if (!parentRef) {\n // We've reached the top of the tree which is the entityProvider.\n // In this case we refresh the entity itself.\n return { entityRefs };\n }\n entityRefs.push(parentRef);\n currentRef = parentRef;\n }\n throw new Error(\n `Unable receive ancestors for ${entityRef}, reached maximum depth of ${MAX_ANCESTOR_DEPTH}`,\n );\n }\n\n async refresh(txOpaque: Transaction, options: RefreshOptions): Promise<void> {\n const tx = txOpaque as Knex.Transaction;\n const { entityRef } = options;\n\n const updateResult = await tx<DbRefreshStateRow>('refresh_state')\n .where({ entity_ref: entityRef.toLocaleLowerCase('en-US') })\n .update({ next_update_at: tx.fn.now() });\n if (updateResult === 0) {\n throw new NotFoundError(`Failed to schedule ${entityRef} for refresh`);\n }\n }\n}\n"],"names":["rethrowError","NotFoundError"],"mappings":";;;;;AA6BA,MAAM,kBAAqB,GAAA,EAAA,CAAA;AAEpB,MAAM,sBAAkD,CAAA;AAAA,EAC7D,YACmB,OAIjB,EAAA;AAJiB,IAAA,IAAA,CAAA,OAAA,GAAA,OAAA,CAAA;AAAA,GAIhB;AAAA,EAEH,MAAM,YAAe,EAAiD,EAAA;AACpE,IAAI,IAAA;AACF,MAAA,IAAI,MAAwB,GAAA,KAAA,CAAA,CAAA;AAE5B,MAAM,MAAA,IAAA,CAAK,QAAQ,QAAS,CAAA,WAAA;AAAA,QAC1B,OAAM,EAAM,KAAA;AAGV,UAAS,MAAA,GAAA,MAAM,GAAG,EAAE,CAAA,CAAA;AAAA,SACtB;AAAA,QACA;AAAA;AAAA,UAEE,qBAAuB,EAAA,IAAA;AAAA,SACzB;AAAA,OACF,CAAA;AAEA,MAAO,OAAA,MAAA,CAAA;AAAA,aACA,CAAG,EAAA;AACV,MAAA,IAAA,CAAK,OAAQ,CAAA,MAAA,CAAO,KAAM,CAAA,CAAA,0BAAA,EAA6B,CAAC,CAAE,CAAA,CAAA,CAAA;AAC1D,MAAA,MAAMA,wBAAa,CAAC,CAAA,CAAA;AAAA,KACtB;AAAA,GACF;AAAA,EAEA,MAAM,aACJ,CAAA,QAAA,EACA,OAC8B,EAAA;AAC9B,IAAA,MAAM,EAAK,GAAA,QAAA,CAAA;AACX,IAAM,MAAA,EAAE,WAAc,GAAA,OAAA,CAAA;AACtB,IAAM,MAAA,UAAA,GAAa,IAAI,KAAc,EAAA,CAAA;AAErC,IAAI,IAAA,UAAA,GAAa,SAAU,CAAA,iBAAA,CAAkB,OAAO,CAAA,CAAA;AACpD,IAAA,KAAA,IAAS,KAAQ,GAAA,CAAA,EAAG,KAAS,IAAA,kBAAA,EAAoB,SAAS,CAAG,EAAA;AAC3D,MAAA,MAAM,OAAO,MAAM,EAAA;AAAA,QACjB,0BAAA;AAAA,QAEC,KAAM,CAAA,EAAE,mBAAmB,UAAW,EAAC,EACvC,MAAO,EAAA,CAAA;AAEV,MAAI,IAAA,IAAA,CAAK,WAAW,CAAG,EAAA;AACrB,QAAA,IAAI,UAAU,CAAG,EAAA;AACf,UAAA,MAAM,IAAIC,oBAAA,CAAc,CAAU,OAAA,EAAA,UAAU,CAAY,UAAA,CAAA,CAAA,CAAA;AAAA,SAC1D;AACA,QAAA,MAAM,IAAIA,oBAAA;AAAA,UACR,CAAA,OAAA,EAAU,SAAS,CAAA,wCAAA,EAA2C,UAAU,CAAA,CAAA;AAAA,SAC1E,CAAA;AAAA,OACF;AAEA,MAAA,MAAM,YAAY,IAAK,CAAA,IAAA,CAAK,CAAK,CAAA,KAAA,CAAA,CAAE,iBAAiB,CAAG,EAAA,iBAAA,CAAA;AACvD,MAAA,IAAI,CAAC,SAAW,EAAA;AAGd,QAAA,OAAO,EAAE,UAAW,EAAA,CAAA;AAAA,OACtB;AACA,MAAA,UAAA,CAAW,KAAK,SAAS,CAAA,CAAA;AACzB,MAAa,UAAA,GAAA,SAAA,CAAA;AAAA,KACf;AACA,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,6BAAA,EAAgC,SAAS,CAAA,2BAAA,EAA8B,kBAAkB,CAAA,CAAA;AAAA,KAC3F,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,OAAQ,CAAA,QAAA,EAAuB,OAAwC,EAAA;AAC3E,IAAA,MAAM,EAAK,GAAA,QAAA,CAAA;AACX,IAAM,MAAA,EAAE,WAAc,GAAA,OAAA,CAAA;AAEtB,IAAM,MAAA,YAAA,GAAe,MAAM,EAAsB,CAAA,eAAe,EAC7D,KAAM,CAAA,EAAE,YAAY,SAAU,CAAA,iBAAA,CAAkB,OAAO,CAAE,EAAC,EAC1D,MAAO,CAAA,EAAE,gBAAgB,EAAG,CAAA,EAAA,CAAG,GAAI,EAAA,EAAG,CAAA,CAAA;AACzC,IAAA,IAAI,iBAAiB,CAAG,EAAA;AACtB,MAAA,MAAM,IAAIA,oBAAA,CAAc,CAAsB,mBAAA,EAAA,SAAS,CAAc,YAAA,CAAA,CAAA,CAAA;AAAA,KACvE;AAAA,GACF;AACF;;;;"}