@backstage/backend-defaults 0.18.0 → 0.18.1-next.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (126) hide show
  1. package/CHANGELOG.md +18 -0
  2. package/dist/CreateBackend.cjs.js.map +1 -1
  3. package/dist/PackageDiscoveryService.cjs.js.map +1 -1
  4. package/dist/alpha/entrypoints/actions/DefaultActionsService.cjs.js.map +1 -1
  5. package/dist/alpha/entrypoints/actions/actionsServiceFactory.cjs.js.map +1 -1
  6. package/dist/alpha/entrypoints/actionsRegistry/DefaultActionsRegistryService.cjs.js.map +1 -1
  7. package/dist/alpha/entrypoints/actionsRegistry/actionFilters.cjs.js.map +1 -1
  8. package/dist/alpha/entrypoints/actionsRegistry/actionsRegistryServiceFactory.cjs.js.map +1 -1
  9. package/dist/alpha/entrypoints/instanceMetadata/instanceMetadataServiceFactory.cjs.js.map +1 -1
  10. package/dist/alpha/entrypoints/metrics/DefaultMetricsService.cjs.js.map +1 -1
  11. package/dist/alpha/entrypoints/metrics/metricsServiceFactory.cjs.js.map +1 -1
  12. package/dist/alpha/entrypoints/tracing/DefaultTracingService.cjs.js.map +1 -1
  13. package/dist/alpha/entrypoints/tracing/tracingServiceFactory.cjs.js.map +1 -1
  14. package/dist/discoveryFeatureLoader.cjs.js.map +1 -1
  15. package/dist/entrypoints/auditor/DefaultAuditorService.cjs.js.map +1 -1
  16. package/dist/entrypoints/auditor/WinstonRootAuditorService.cjs.js.map +1 -1
  17. package/dist/entrypoints/auditor/auditorServiceFactory.cjs.js.map +1 -1
  18. package/dist/entrypoints/auditor/utils.cjs.js.map +1 -1
  19. package/dist/entrypoints/auth/DefaultAuthService.cjs.js.map +1 -1
  20. package/dist/entrypoints/auth/JwksClient.cjs.js.map +1 -1
  21. package/dist/entrypoints/auth/authServiceFactory.cjs.js.map +1 -1
  22. package/dist/entrypoints/auth/external/ExternalAuthTokenHandler.cjs.js.map +1 -1
  23. package/dist/entrypoints/auth/external/helpers.cjs.js.map +1 -1
  24. package/dist/entrypoints/auth/external/jwks.cjs.js.map +1 -1
  25. package/dist/entrypoints/auth/external/legacy.cjs.js.map +1 -1
  26. package/dist/entrypoints/auth/external/static.cjs.js.map +1 -1
  27. package/dist/entrypoints/auth/helpers.cjs.js.map +1 -1
  28. package/dist/entrypoints/auth/plugin/PluginTokenHandler.cjs.js.map +1 -1
  29. package/dist/entrypoints/auth/plugin/keys/DatabaseKeyStore.cjs.js.map +1 -1
  30. package/dist/entrypoints/auth/plugin/keys/DatabasePluginKeySource.cjs.js.map +1 -1
  31. package/dist/entrypoints/auth/plugin/keys/StaticConfigPluginKeySource.cjs.js.map +1 -1
  32. package/dist/entrypoints/auth/plugin/keys/createPluginKeySource.cjs.js.map +1 -1
  33. package/dist/entrypoints/auth/user/UserTokenHandler.cjs.js.map +1 -1
  34. package/dist/entrypoints/cache/CacheClient.cjs.js.map +1 -1
  35. package/dist/entrypoints/cache/CacheManager.cjs.js.map +1 -1
  36. package/dist/entrypoints/cache/cacheServiceFactory.cjs.js.map +1 -1
  37. package/dist/entrypoints/cache/providers/infinispan/InfinispanKeyvStore.cjs.js.map +1 -1
  38. package/dist/entrypoints/cache/providers/infinispan/InfinispanOptionsMapper.cjs.js.map +1 -1
  39. package/dist/entrypoints/cache/types.cjs.js.map +1 -1
  40. package/dist/entrypoints/database/DatabaseManager.cjs.js.map +1 -1
  41. package/dist/entrypoints/database/connectors/defaultNameOverride.cjs.js.map +1 -1
  42. package/dist/entrypoints/database/connectors/mergeDatabaseConfig.cjs.js.map +1 -1
  43. package/dist/entrypoints/database/connectors/mysql.cjs.js.map +1 -1
  44. package/dist/entrypoints/database/connectors/postgres.cjs.js +2 -0
  45. package/dist/entrypoints/database/connectors/postgres.cjs.js.map +1 -1
  46. package/dist/entrypoints/database/connectors/sqlite3.cjs.js.map +1 -1
  47. package/dist/entrypoints/database/databaseServiceFactory.cjs.js.map +1 -1
  48. package/dist/entrypoints/discovery/HostDiscovery.cjs.js.map +1 -1
  49. package/dist/entrypoints/discovery/SrvResolvers.cjs.js.map +1 -1
  50. package/dist/entrypoints/discovery/discoveryServiceFactory.cjs.js.map +1 -1
  51. package/dist/entrypoints/discovery/parsing.cjs.js.map +1 -1
  52. package/dist/entrypoints/httpAuth/httpAuthServiceFactory.cjs.js.map +1 -1
  53. package/dist/entrypoints/httpRouter/http/createAuthIntegrationRouter.cjs.js.map +1 -1
  54. package/dist/entrypoints/httpRouter/http/createCookieAuthRefreshMiddleware.cjs.js.map +1 -1
  55. package/dist/entrypoints/httpRouter/http/createCredentialsBarrier.cjs.js.map +1 -1
  56. package/dist/entrypoints/httpRouter/http/createLifecycleMiddleware.cjs.js.map +1 -1
  57. package/dist/entrypoints/httpRouter/http/createRateLimitMiddleware.cjs.js.map +1 -1
  58. package/dist/entrypoints/httpRouter/httpRouterServiceFactory.cjs.js.map +1 -1
  59. package/dist/entrypoints/lifecycle/lifecycleServiceFactory.cjs.js.map +1 -1
  60. package/dist/entrypoints/logger/loggerServiceFactory.cjs.js.map +1 -1
  61. package/dist/entrypoints/permissions/permissionsServiceFactory.cjs.js.map +1 -1
  62. package/dist/entrypoints/permissionsRegistry/permissionsRegistryServiceFactory.cjs.js.map +1 -1
  63. package/dist/entrypoints/rootConfig/createConfigSecretEnumerator.cjs.js.map +1 -1
  64. package/dist/entrypoints/rootConfig/rootConfigServiceFactory.cjs.js.map +1 -1
  65. package/dist/entrypoints/rootHealth/rootHealthServiceFactory.cjs.js.map +1 -1
  66. package/dist/entrypoints/rootHttpRouter/DefaultRootHttpRouter.cjs.js.map +1 -1
  67. package/dist/entrypoints/rootHttpRouter/createHealthRouter.cjs.js.map +1 -1
  68. package/dist/entrypoints/rootHttpRouter/http/MiddlewareFactory.cjs.js.map +1 -1
  69. package/dist/entrypoints/rootHttpRouter/http/applyInternalErrorFilter.cjs.js.map +1 -1
  70. package/dist/entrypoints/rootHttpRouter/http/config.cjs.js.map +1 -1
  71. package/dist/entrypoints/rootHttpRouter/http/createHttpServer.cjs.js.map +1 -1
  72. package/dist/entrypoints/rootHttpRouter/http/getGeneratedCertificate.cjs.js.map +1 -1
  73. package/dist/entrypoints/rootHttpRouter/http/readCorsOptions.cjs.js.map +1 -1
  74. package/dist/entrypoints/rootHttpRouter/http/readHelmetOptions.cjs.js.map +1 -1
  75. package/dist/entrypoints/rootHttpRouter/rootHttpRouterServiceFactory.cjs.js.map +1 -1
  76. package/dist/entrypoints/rootLifecycle/rootLifecycleServiceFactory.cjs.js.map +1 -1
  77. package/dist/entrypoints/rootLogger/WinstonLogger.cjs.js.map +1 -1
  78. package/dist/entrypoints/rootLogger/config.cjs.js.map +1 -1
  79. package/dist/entrypoints/rootLogger/rootLoggerServiceFactory.cjs.js.map +1 -1
  80. package/dist/entrypoints/rootLogger/types.cjs.js.map +1 -1
  81. package/dist/entrypoints/rootLogger/utils.cjs.js.map +1 -1
  82. package/dist/entrypoints/rootSystemMetadata/lib/DefaultRootSystemMetadataService.cjs.js.map +1 -1
  83. package/dist/entrypoints/rootSystemMetadata/rootSystemMetadataServiceFactory.cjs.js.map +1 -1
  84. package/dist/entrypoints/scheduler/database/migrateBackendTasks.cjs.js.map +1 -1
  85. package/dist/entrypoints/scheduler/database/tables.cjs.js.map +1 -1
  86. package/dist/entrypoints/scheduler/lib/DefaultSchedulerService.cjs.js.map +1 -1
  87. package/dist/entrypoints/scheduler/lib/LocalTaskWorker.cjs.js.map +1 -1
  88. package/dist/entrypoints/scheduler/lib/PluginTaskSchedulerImpl.cjs.js.map +1 -1
  89. package/dist/entrypoints/scheduler/lib/PluginTaskSchedulerJanitor.cjs.js.map +1 -1
  90. package/dist/entrypoints/scheduler/lib/TaskStatePoller.cjs.js.map +1 -1
  91. package/dist/entrypoints/scheduler/lib/TaskWorker.cjs.js.map +1 -1
  92. package/dist/entrypoints/scheduler/lib/types.cjs.js.map +1 -1
  93. package/dist/entrypoints/scheduler/lib/util.cjs.js.map +1 -1
  94. package/dist/entrypoints/scheduler/schedulerServiceFactory.cjs.js.map +1 -1
  95. package/dist/entrypoints/urlReader/lib/AwsCodeCommitUrlReader.cjs.js.map +1 -1
  96. package/dist/entrypoints/urlReader/lib/AwsS3UrlReader.cjs.js.map +1 -1
  97. package/dist/entrypoints/urlReader/lib/AzureBlobStorageUrlReader.cjs.js.map +1 -1
  98. package/dist/entrypoints/urlReader/lib/AzureUrlReader.cjs.js.map +1 -1
  99. package/dist/entrypoints/urlReader/lib/BitbucketCloudUrlReader.cjs.js.map +1 -1
  100. package/dist/entrypoints/urlReader/lib/BitbucketServerUrlReader.cjs.js.map +1 -1
  101. package/dist/entrypoints/urlReader/lib/FetchUrlReader.cjs.js.map +1 -1
  102. package/dist/entrypoints/urlReader/lib/GerritUrlReader.cjs.js.map +1 -1
  103. package/dist/entrypoints/urlReader/lib/GiteaUrlReader.cjs.js.map +1 -1
  104. package/dist/entrypoints/urlReader/lib/GithubUrlReader.cjs.js.map +1 -1
  105. package/dist/entrypoints/urlReader/lib/GitlabUrlReader.cjs.js.map +1 -1
  106. package/dist/entrypoints/urlReader/lib/GoogleGcsUrlReader.cjs.js.map +1 -1
  107. package/dist/entrypoints/urlReader/lib/HarnessUrlReader.cjs.js.map +1 -1
  108. package/dist/entrypoints/urlReader/lib/ReadUrlResponseFactory.cjs.js.map +1 -1
  109. package/dist/entrypoints/urlReader/lib/UrlReaderPredicateMux.cjs.js.map +1 -1
  110. package/dist/entrypoints/urlReader/lib/UrlReaders.cjs.js.map +1 -1
  111. package/dist/entrypoints/urlReader/lib/tree/ReadTreeResponseFactory.cjs.js.map +1 -1
  112. package/dist/entrypoints/urlReader/lib/tree/ReadableArrayResponse.cjs.js.map +1 -1
  113. package/dist/entrypoints/urlReader/lib/tree/TarArchiveResponse.cjs.js.map +1 -1
  114. package/dist/entrypoints/urlReader/lib/tree/ZipArchiveResponse.cjs.js.map +1 -1
  115. package/dist/entrypoints/urlReader/lib/tree/util.cjs.js.map +1 -1
  116. package/dist/entrypoints/urlReader/lib/util.cjs.js.map +1 -1
  117. package/dist/entrypoints/urlReader/urlReaderServiceFactory.cjs.js.map +1 -1
  118. package/dist/entrypoints/userInfo/CachedUserInfoService.cjs.js.map +1 -1
  119. package/dist/entrypoints/userInfo/DefaultUserInfoService.cjs.js.map +1 -1
  120. package/dist/entrypoints/userInfo/userInfoServiceFactory.cjs.js.map +1 -1
  121. package/dist/lib/RateLimitStoreFactory.cjs.js.map +1 -1
  122. package/dist/lib/escapeRegExp.cjs.js.map +1 -1
  123. package/dist/lib/rateLimitMiddleware.cjs.js.map +1 -1
  124. package/dist/package.json.cjs.js +1 -1
  125. package/dist/package.json.cjs.js.map +1 -1
  126. package/package.json +17 -17
@@ -1 +1 @@
1
- {"version":3,"file":"GerritUrlReader.cjs.js","sources":["../../../../src/entrypoints/urlReader/lib/GerritUrlReader.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 {\n UrlReaderService,\n UrlReaderServiceReadTreeOptions,\n UrlReaderServiceReadTreeResponse,\n UrlReaderServiceReadUrlOptions,\n UrlReaderServiceReadUrlResponse,\n UrlReaderServiceSearchOptions,\n UrlReaderServiceSearchResponse,\n} from '@backstage/backend-plugin-api';\nimport { Base64Decode } from 'base64-stream';\nimport fetch, { Response } from 'node-fetch';\nimport { Readable } from 'node:stream';\nimport {\n GerritIntegration,\n ScmIntegrations,\n buildGerritGitilesArchiveUrlFromLocation,\n getGerritBranchApiUrl,\n getGerritFileContentsApiUrl,\n getGerritRequestOptions,\n parseGerritJsonResponse,\n parseGitilesUrlRef,\n} from '@backstage/integration';\nimport {\n NotFoundError,\n NotModifiedError,\n ResponseError,\n toError,\n} from '@backstage/errors';\nimport { ReadTreeResponseFactory, ReaderFactory } from './types';\nimport { Minimatch } from 'minimatch';\nimport { getGitilesAuthenticationUrl } from '@backstage/integration';\n\n/**\n * Implements a {@link @backstage/backend-plugin-api#UrlReaderService} for files in Gerrit.\n *\n * @remarks\n * To be able to link to Git contents for Gerrit providers in a user friendly\n * way we are depending on that there is a Gitiles installation somewhere\n * that we can link to. It is perfectly possible to integrate Gerrit with\n * Backstage without Gitiles since all API calls goes directly to Gerrit.\n * However if Gitiles is configured, readTree will use it to fetch\n * an archive instead of cloning the repository.\n *\n * The \"host\" variable in the config is the Gerrit host. The address where\n * Gitiles is installed may be on the same host but it could be on a\n * separate host. For example a Gerrit instance could be hosted on\n * \"gerrit-review.company.com\" but the repos could be browsable on a separate\n * host, e.g. \"gerrit.company.com\" and the human readable URL would then\n * not point to the API host.\n *\n * @public\n */\nexport class GerritUrlReader implements UrlReaderService {\n static factory: ReaderFactory = ({ config, treeResponseFactory }) => {\n const integrations = ScmIntegrations.fromConfig(config);\n if (!integrations.gerrit) {\n return [];\n }\n return integrations.gerrit.list().map(integration => {\n const reader = new GerritUrlReader(integration, { treeResponseFactory });\n const predicate = (url: URL) => {\n const gitilesUrl = new URL(integration.config.gitilesBaseUrl!);\n // If gitilesUrl is not specified it will default to\n // \"integration.config.host\".\n return url.host === gitilesUrl.host;\n };\n return { reader, predicate };\n });\n };\n\n private readonly integration: GerritIntegration;\n private readonly deps: { treeResponseFactory: ReadTreeResponseFactory };\n\n constructor(\n integration: GerritIntegration,\n deps: { treeResponseFactory: ReadTreeResponseFactory },\n ) {\n this.integration = integration;\n this.deps = deps;\n }\n\n async read(url: string): Promise<Buffer> {\n const response = await this.readUrl(url);\n return response.buffer();\n }\n\n async readUrl(\n url: string,\n options?: UrlReaderServiceReadUrlOptions,\n ): Promise<UrlReaderServiceReadUrlResponse> {\n const apiUrl = getGerritFileContentsApiUrl(this.integration.config, url);\n let response: Response;\n try {\n response = await fetch(apiUrl, {\n method: 'GET',\n ...getGerritRequestOptions(this.integration.config),\n // TODO(freben): The signal cast is there because pre-3.x versions of\n // node-fetch have a very slightly deviating AbortSignal type signature.\n // The difference does not affect us in practice however. The cast can\n // be removed after we support ESM for CLI dependencies and migrate to\n // version 3 of node-fetch.\n // https://github.com/backstage/backstage/issues/8242\n signal: options?.signal as any,\n });\n } catch (e) {\n throw new Error(`Unable to read gerrit file ${url}, ${e}`);\n }\n\n if (response.ok) {\n let responseBody: string;\n return {\n buffer: async () => {\n if (responseBody === undefined) {\n responseBody = await response.text();\n }\n return Buffer.from(responseBody, 'base64');\n },\n stream: () => {\n const readable = Readable.from(response.body);\n return readable.pipe(new Base64Decode());\n },\n };\n }\n if (response.status === 404) {\n throw new NotFoundError(`File ${url} not found.`);\n }\n throw new Error(\n `${url} could not be read as ${apiUrl}, ${response.status} ${response.statusText}`,\n );\n }\n\n async readTree(\n url: string,\n options?: UrlReaderServiceReadTreeOptions,\n ): Promise<UrlReaderServiceReadTreeResponse> {\n const urlRevision = await this.getRevisionForUrl(url, options);\n\n return this.readTreeFromGitiles(url, urlRevision, options);\n }\n\n async search(\n url: string,\n options?: UrlReaderServiceSearchOptions,\n ): Promise<UrlReaderServiceSearchResponse> {\n const { path } = parseGitilesUrlRef(this.integration.config, url);\n\n if (!path.match(/[*?]/)) {\n try {\n const data = await this.readUrl(url, options);\n\n return {\n files: [\n {\n url: url,\n content: data.buffer,\n lastModifiedAt: data.lastModifiedAt,\n },\n ],\n etag: data.etag ?? '',\n };\n } catch (e) {\n const error = toError(e);\n if (error.name === 'NotFoundError') {\n return {\n files: [],\n etag: '',\n };\n }\n throw error;\n }\n }\n\n const urlRevision = await this.getRevisionForUrl(url, options);\n\n const files = await this.searchFilesFromGitiles(url, options);\n\n return { files, etag: urlRevision };\n }\n\n toString() {\n const { host, password } = this.integration.config;\n return `gerrit{host=${host},authed=${Boolean(password)}}`;\n }\n\n private async readTreeFromGitiles(\n url: string,\n revision: string,\n options?: UrlReaderServiceReadTreeOptions,\n ) {\n const archiveUrl = buildGerritGitilesArchiveUrlFromLocation(\n this.integration.config,\n url,\n );\n const archiveResponse = await fetch(archiveUrl, {\n ...getGerritRequestOptions(this.integration.config),\n // TODO(freben): The signal cast is there because pre-3.x versions of\n // node-fetch have a very slightly deviating AbortSignal type signature.\n // The difference does not affect us in practice however. The cast can\n // be removed after we support ESM for CLI dependencies and migrate to\n // version 3 of node-fetch.\n // https://github.com/backstage/backstage/issues/8242\n signal: options?.signal as any,\n });\n\n if (archiveResponse.status === 404) {\n throw new NotFoundError(`Not found: ${archiveUrl}`);\n }\n\n if (!archiveResponse.ok) {\n throw new Error(\n `${url} could not be read as ${archiveUrl}, ${archiveResponse.status} ${archiveResponse.statusText}`,\n );\n }\n\n return await this.deps.treeResponseFactory.fromTarArchive({\n stream: archiveResponse.body as unknown as Readable,\n etag: revision,\n filter: options?.filter,\n stripFirstDirectory: false,\n });\n }\n\n private async getRevisionForUrl(\n url: string,\n options?: UrlReaderServiceReadTreeOptions,\n ): Promise<string> {\n const { ref, refType } = parseGitilesUrlRef(this.integration.config, url);\n // The url points to a static revision.\n if (refType === 'sha') {\n if (options?.etag === ref) {\n throw new NotModifiedError();\n }\n return ref;\n }\n\n const apiUrl = getGerritBranchApiUrl(this.integration.config, url);\n let response: Response;\n try {\n response = await fetch(apiUrl, {\n method: 'GET',\n ...getGerritRequestOptions(this.integration.config),\n });\n } catch (e) {\n throw new Error(`Unable to read branch state ${url}, ${e}`);\n }\n\n if (!response.ok) {\n throw await ResponseError.fromResponse(response);\n }\n\n const branchInfo = (await parseGerritJsonResponse(response as any)) as {\n revision: string;\n };\n if (options?.etag === branchInfo.revision) {\n throw new NotModifiedError();\n }\n return branchInfo.revision;\n }\n\n private async searchFilesFromGitiles(\n url: string,\n options?: UrlReaderServiceReadTreeOptions,\n ): Promise<UrlReaderServiceSearchResponse['files']> {\n const { path, basePath } = parseGitilesUrlRef(this.integration.config, url);\n\n const treeUrl = `${basePath}/?format=JSON&recursive`.replace(\n this.integration.config.gitilesBaseUrl,\n getGitilesAuthenticationUrl(this.integration.config),\n );\n\n const treeResponse = await fetch(treeUrl, {\n ...getGerritRequestOptions(this.integration.config),\n // TODO(freben): The signal cast is there because pre-3.x versions of\n // node-fetch have a very slightly deviating AbortSignal type signature.\n // The difference does not affect us in practice however. The cast can\n // be removed after we support ESM for CLI dependencies and migrate to\n // version 3 of node-fetch.\n // https://github.com/backstage/backstage/issues/8242\n signal: options?.signal as any,\n });\n if (!treeResponse.ok) {\n throw await ResponseError.fromResponse(treeResponse);\n }\n\n const res = (await parseGerritJsonResponse(treeResponse as any)) as {\n id: string;\n entries: { mode: number; type: string; id: string; name: string }[];\n };\n\n const matcher = new Minimatch(decodeURIComponent(path).replace(/^\\/+/, ''));\n\n const matching = res.entries.filter(\n item => item.type === 'blob' && item.name && matcher.match(item.name),\n );\n\n return matching.map(item => ({\n url: `${basePath}/${item.name}`,\n content: async () => {\n const apiUrl = getGerritFileContentsApiUrl(\n this.integration.config,\n `${basePath}/${item.name}`,\n );\n const response = await fetch(apiUrl, {\n method: 'GET',\n ...getGerritRequestOptions(this.integration.config),\n // TODO(freben): The signal cast is there because pre-3.x versions of\n // node-fetch have a very slightly deviating AbortSignal type signature.\n // The difference does not affect us in practice however. The cast can\n // be removed after we support ESM for CLI dependencies and migrate to\n // version 3 of node-fetch.\n // https://github.com/backstage/backstage/issues/8242\n signal: options?.signal as any,\n });\n\n const responseBody = await response.text();\n return Buffer.from(responseBody, 'base64');\n },\n }));\n }\n}\n"],"names":["ScmIntegrations","getGerritFileContentsApiUrl","fetch","getGerritRequestOptions","Readable","Base64Decode","NotFoundError","parseGitilesUrlRef","toError","buildGerritGitilesArchiveUrlFromLocation","NotModifiedError","getGerritBranchApiUrl","ResponseError","parseGerritJsonResponse","getGitilesAuthenticationUrl","Minimatch"],"mappings":";;;;;;;;;;;;;AAoEO,MAAM,eAAA,CAA4C;AAAA,EACvD,OAAO,OAAA,GAAyB,CAAC,EAAE,MAAA,EAAQ,qBAAoB,KAAM;AACnE,IAAA,MAAM,YAAA,GAAeA,2BAAA,CAAgB,UAAA,CAAW,MAAM,CAAA;AACtD,IAAA,IAAI,CAAC,aAAa,MAAA,EAAQ;AACxB,MAAA,OAAO,EAAC;AAAA,IACV;AACA,IAAA,OAAO,YAAA,CAAa,MAAA,CAAO,IAAA,EAAK,CAAE,IAAI,CAAA,WAAA,KAAe;AACnD,MAAA,MAAM,SAAS,IAAI,eAAA,CAAgB,WAAA,EAAa,EAAE,qBAAqB,CAAA;AACvE,MAAA,MAAM,SAAA,GAAY,CAAC,GAAA,KAAa;AAC9B,QAAA,MAAM,UAAA,GAAa,IAAI,GAAA,CAAI,WAAA,CAAY,OAAO,cAAe,CAAA;AAG7D,QAAA,OAAO,GAAA,CAAI,SAAS,UAAA,CAAW,IAAA;AAAA,MACjC,CAAA;AACA,MAAA,OAAO,EAAE,QAAQ,SAAA,EAAU;AAAA,IAC7B,CAAC,CAAA;AAAA,EACH,CAAA;AAAA,EAEiB,WAAA;AAAA,EACA,IAAA;AAAA,EAEjB,WAAA,CACE,aACA,IAAA,EACA;AACA,IAAA,IAAA,CAAK,WAAA,GAAc,WAAA;AACnB,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;AAAA,EACd;AAAA,EAEA,MAAM,KAAK,GAAA,EAA8B;AACvC,IAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,OAAA,CAAQ,GAAG,CAAA;AACvC,IAAA,OAAO,SAAS,MAAA,EAAO;AAAA,EACzB;AAAA,EAEA,MAAM,OAAA,CACJ,GAAA,EACA,OAAA,EAC0C;AAC1C,IAAA,MAAM,MAAA,GAASC,uCAAA,CAA4B,IAAA,CAAK,WAAA,CAAY,QAAQ,GAAG,CAAA;AACvE,IAAA,IAAI,QAAA;AACJ,IAAA,IAAI;AACF,MAAA,QAAA,GAAW,MAAMC,uBAAM,MAAA,EAAQ;AAAA,QAC7B,MAAA,EAAQ,KAAA;AAAA,QACR,GAAGC,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,MAAM,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,QAOlD,QAAQ,OAAA,EAAS;AAAA,OAClB,CAAA;AAAA,IACH,SAAS,CAAA,EAAG;AACV,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,2BAAA,EAA8B,GAAG,CAAA,EAAA,EAAK,CAAC,CAAA,CAAE,CAAA;AAAA,IAC3D;AAEA,IAAA,IAAI,SAAS,EAAA,EAAI;AACf,MAAA,IAAI,YAAA;AACJ,MAAA,OAAO;AAAA,QACL,QAAQ,YAAY;AAClB,UAAA,IAAI,iBAAiB,MAAA,EAAW;AAC9B,YAAA,YAAA,GAAe,MAAM,SAAS,IAAA,EAAK;AAAA,UACrC;AACA,UAAA,OAAO,MAAA,CAAO,IAAA,CAAK,YAAA,EAAc,QAAQ,CAAA;AAAA,QAC3C,CAAA;AAAA,QACA,QAAQ,MAAM;AACZ,UAAA,MAAM,QAAA,GAAWC,oBAAA,CAAS,IAAA,CAAK,QAAA,CAAS,IAAI,CAAA;AAC5C,UAAA,OAAO,QAAA,CAAS,IAAA,CAAK,IAAIC,yBAAA,EAAc,CAAA;AAAA,QACzC;AAAA,OACF;AAAA,IACF;AACA,IAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,MAAA,MAAM,IAAIC,oBAAA,CAAc,CAAA,KAAA,EAAQ,GAAG,CAAA,WAAA,CAAa,CAAA;AAAA,IAClD;AACA,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,EAAG,GAAG,CAAA,sBAAA,EAAyB,MAAM,KAAK,QAAA,CAAS,MAAM,CAAA,CAAA,EAAI,QAAA,CAAS,UAAU,CAAA;AAAA,KAClF;AAAA,EACF;AAAA,EAEA,MAAM,QAAA,CACJ,GAAA,EACA,OAAA,EAC2C;AAC3C,IAAA,MAAM,WAAA,GAAc,MAAM,IAAA,CAAK,iBAAA,CAAkB,KAAK,OAAO,CAAA;AAE7D,IAAA,OAAO,IAAA,CAAK,mBAAA,CAAoB,GAAA,EAAK,WAAA,EAAa,OAAO,CAAA;AAAA,EAC3D;AAAA,EAEA,MAAM,MAAA,CACJ,GAAA,EACA,OAAA,EACyC;AACzC,IAAA,MAAM,EAAE,IAAA,EAAK,GAAIC,+BAAmB,IAAA,CAAK,WAAA,CAAY,QAAQ,GAAG,CAAA;AAEhE,IAAA,IAAI,CAAC,IAAA,CAAK,KAAA,CAAM,MAAM,CAAA,EAAG;AACvB,MAAA,IAAI;AACF,QAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,OAAA,CAAQ,KAAK,OAAO,CAAA;AAE5C,QAAA,OAAO;AAAA,UACL,KAAA,EAAO;AAAA,YACL;AAAA,cACE,GAAA;AAAA,cACA,SAAS,IAAA,CAAK,MAAA;AAAA,cACd,gBAAgB,IAAA,CAAK;AAAA;AACvB,WACF;AAAA,UACA,IAAA,EAAM,KAAK,IAAA,IAAQ;AAAA,SACrB;AAAA,MACF,SAAS,CAAA,EAAG;AACV,QAAA,MAAM,KAAA,GAAQC,eAAQ,CAAC,CAAA;AACvB,QAAA,IAAI,KAAA,CAAM,SAAS,eAAA,EAAiB;AAClC,UAAA,OAAO;AAAA,YACL,OAAO,EAAC;AAAA,YACR,IAAA,EAAM;AAAA,WACR;AAAA,QACF;AACA,QAAA,MAAM,KAAA;AAAA,MACR;AAAA,IACF;AAEA,IAAA,MAAM,WAAA,GAAc,MAAM,IAAA,CAAK,iBAAA,CAAkB,KAAK,OAAO,CAAA;AAE7D,IAAA,MAAM,KAAA,GAAQ,MAAM,IAAA,CAAK,sBAAA,CAAuB,KAAK,OAAO,CAAA;AAE5D,IAAA,OAAO,EAAE,KAAA,EAAO,IAAA,EAAM,WAAA,EAAY;AAAA,EACpC;AAAA,EAEA,QAAA,GAAW;AACT,IAAA,MAAM,EAAE,IAAA,EAAM,QAAA,EAAS,GAAI,KAAK,WAAA,CAAY,MAAA;AAC5C,IAAA,OAAO,CAAA,YAAA,EAAe,IAAI,CAAA,QAAA,EAAW,OAAA,CAAQ,QAAQ,CAAC,CAAA,CAAA,CAAA;AAAA,EACxD;AAAA,EAEA,MAAc,mBAAA,CACZ,GAAA,EACA,QAAA,EACA,OAAA,EACA;AACA,IAAA,MAAM,UAAA,GAAaC,oDAAA;AAAA,MACjB,KAAK,WAAA,CAAY,MAAA;AAAA,MACjB;AAAA,KACF;AACA,IAAA,MAAM,eAAA,GAAkB,MAAMP,sBAAA,CAAM,UAAA,EAAY;AAAA,MAC9C,GAAGC,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,MAAM,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAOlD,QAAQ,OAAA,EAAS;AAAA,KAClB,CAAA;AAED,IAAA,IAAI,eAAA,CAAgB,WAAW,GAAA,EAAK;AAClC,MAAA,MAAM,IAAIG,oBAAA,CAAc,CAAA,WAAA,EAAc,UAAU,CAAA,CAAE,CAAA;AAAA,IACpD;AAEA,IAAA,IAAI,CAAC,gBAAgB,EAAA,EAAI;AACvB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,EAAG,GAAG,CAAA,sBAAA,EAAyB,UAAU,KAAK,eAAA,CAAgB,MAAM,CAAA,CAAA,EAAI,eAAA,CAAgB,UAAU,CAAA;AAAA,OACpG;AAAA,IACF;AAEA,IAAA,OAAO,MAAM,IAAA,CAAK,IAAA,CAAK,mBAAA,CAAoB,cAAA,CAAe;AAAA,MACxD,QAAQ,eAAA,CAAgB,IAAA;AAAA,MACxB,IAAA,EAAM,QAAA;AAAA,MACN,QAAQ,OAAA,EAAS,MAAA;AAAA,MACjB,mBAAA,EAAqB;AAAA,KACtB,CAAA;AAAA,EACH;AAAA,EAEA,MAAc,iBAAA,CACZ,GAAA,EACA,OAAA,EACiB;AACjB,IAAA,MAAM,EAAE,KAAK,OAAA,EAAQ,GAAIC,+BAAmB,IAAA,CAAK,WAAA,CAAY,QAAQ,GAAG,CAAA;AAExE,IAAA,IAAI,YAAY,KAAA,EAAO;AACrB,MAAA,IAAI,OAAA,EAAS,SAAS,GAAA,EAAK;AACzB,QAAA,MAAM,IAAIG,uBAAA,EAAiB;AAAA,MAC7B;AACA,MAAA,OAAO,GAAA;AAAA,IACT;AAEA,IAAA,MAAM,MAAA,GAASC,iCAAA,CAAsB,IAAA,CAAK,WAAA,CAAY,QAAQ,GAAG,CAAA;AACjE,IAAA,IAAI,QAAA;AACJ,IAAA,IAAI;AACF,MAAA,QAAA,GAAW,MAAMT,uBAAM,MAAA,EAAQ;AAAA,QAC7B,MAAA,EAAQ,KAAA;AAAA,QACR,GAAGC,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,MAAM;AAAA,OACnD,CAAA;AAAA,IACH,SAAS,CAAA,EAAG;AACV,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,4BAAA,EAA+B,GAAG,CAAA,EAAA,EAAK,CAAC,CAAA,CAAE,CAAA;AAAA,IAC5D;AAEA,IAAA,IAAI,CAAC,SAAS,EAAA,EAAI;AAChB,MAAA,MAAM,MAAMS,oBAAA,CAAc,YAAA,CAAa,QAAQ,CAAA;AAAA,IACjD;AAEA,IAAA,MAAM,UAAA,GAAc,MAAMC,mCAAA,CAAwB,QAAe,CAAA;AAGjE,IAAA,IAAI,OAAA,EAAS,IAAA,KAAS,UAAA,CAAW,QAAA,EAAU;AACzC,MAAA,MAAM,IAAIH,uBAAA,EAAiB;AAAA,IAC7B;AACA,IAAA,OAAO,UAAA,CAAW,QAAA;AAAA,EACpB;AAAA,EAEA,MAAc,sBAAA,CACZ,GAAA,EACA,OAAA,EACkD;AAClD,IAAA,MAAM,EAAE,MAAM,QAAA,EAAS,GAAIH,+BAAmB,IAAA,CAAK,WAAA,CAAY,QAAQ,GAAG,CAAA;AAE1E,IAAA,MAAM,OAAA,GAAU,CAAA,EAAG,QAAQ,CAAA,uBAAA,CAAA,CAA0B,OAAA;AAAA,MACnD,IAAA,CAAK,YAAY,MAAA,CAAO,cAAA;AAAA,MACxBO,uCAAA,CAA4B,IAAA,CAAK,WAAA,CAAY,MAAM;AAAA,KACrD;AAEA,IAAA,MAAM,YAAA,GAAe,MAAMZ,sBAAA,CAAM,OAAA,EAAS;AAAA,MACxC,GAAGC,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,MAAM,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAOlD,QAAQ,OAAA,EAAS;AAAA,KAClB,CAAA;AACD,IAAA,IAAI,CAAC,aAAa,EAAA,EAAI;AACpB,MAAA,MAAM,MAAMS,oBAAA,CAAc,YAAA,CAAa,YAAY,CAAA;AAAA,IACrD;AAEA,IAAA,MAAM,GAAA,GAAO,MAAMC,mCAAA,CAAwB,YAAmB,CAAA;AAK9D,IAAA,MAAM,OAAA,GAAU,IAAIE,mBAAA,CAAU,kBAAA,CAAmB,IAAI,CAAA,CAAE,OAAA,CAAQ,MAAA,EAAQ,EAAE,CAAC,CAAA;AAE1E,IAAA,MAAM,QAAA,GAAW,IAAI,OAAA,CAAQ,MAAA;AAAA,MAC3B,CAAA,IAAA,KAAQ,KAAK,IAAA,KAAS,MAAA,IAAU,KAAK,IAAA,IAAQ,OAAA,CAAQ,KAAA,CAAM,IAAA,CAAK,IAAI;AAAA,KACtE;AAEA,IAAA,OAAO,QAAA,CAAS,IAAI,CAAA,IAAA,MAAS;AAAA,MAC3B,GAAA,EAAK,CAAA,EAAG,QAAQ,CAAA,CAAA,EAAI,KAAK,IAAI,CAAA,CAAA;AAAA,MAC7B,SAAS,YAAY;AACnB,QAAA,MAAM,MAAA,GAASd,uCAAA;AAAA,UACb,KAAK,WAAA,CAAY,MAAA;AAAA,UACjB,CAAA,EAAG,QAAQ,CAAA,CAAA,EAAI,IAAA,CAAK,IAAI,CAAA;AAAA,SAC1B;AACA,QAAA,MAAM,QAAA,GAAW,MAAMC,sBAAA,CAAM,MAAA,EAAQ;AAAA,UACnC,MAAA,EAAQ,KAAA;AAAA,UACR,GAAGC,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,MAAM,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,UAOlD,QAAQ,OAAA,EAAS;AAAA,SAClB,CAAA;AAED,QAAA,MAAM,YAAA,GAAe,MAAM,QAAA,CAAS,IAAA,EAAK;AACzC,QAAA,OAAO,MAAA,CAAO,IAAA,CAAK,YAAA,EAAc,QAAQ,CAAA;AAAA,MAC3C;AAAA,KACF,CAAE,CAAA;AAAA,EACJ;AACF;;;;"}
1
+ {"version":3,"file":"GerritUrlReader.cjs.js","sources":["../../../../src/entrypoints/urlReader/lib/GerritUrlReader.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 {\n UrlReaderService,\n UrlReaderServiceReadTreeOptions,\n UrlReaderServiceReadTreeResponse,\n UrlReaderServiceReadUrlOptions,\n UrlReaderServiceReadUrlResponse,\n UrlReaderServiceSearchOptions,\n UrlReaderServiceSearchResponse,\n} from '@backstage/backend-plugin-api';\nimport { Base64Decode } from 'base64-stream';\nimport fetch, { Response } from 'node-fetch';\nimport { Readable } from 'node:stream';\nimport {\n GerritIntegration,\n ScmIntegrations,\n buildGerritGitilesArchiveUrlFromLocation,\n getGerritBranchApiUrl,\n getGerritFileContentsApiUrl,\n getGerritRequestOptions,\n parseGerritJsonResponse,\n parseGitilesUrlRef,\n} from '@backstage/integration';\nimport {\n NotFoundError,\n NotModifiedError,\n ResponseError,\n toError,\n} from '@backstage/errors';\nimport { ReadTreeResponseFactory, ReaderFactory } from './types';\nimport { Minimatch } from 'minimatch';\nimport { getGitilesAuthenticationUrl } from '@backstage/integration';\n\n/**\n * Implements a {@link @backstage/backend-plugin-api#UrlReaderService} for files in Gerrit.\n *\n * @remarks\n * To be able to link to Git contents for Gerrit providers in a user friendly\n * way we are depending on that there is a Gitiles installation somewhere\n * that we can link to. It is perfectly possible to integrate Gerrit with\n * Backstage without Gitiles since all API calls goes directly to Gerrit.\n * However if Gitiles is configured, readTree will use it to fetch\n * an archive instead of cloning the repository.\n *\n * The \"host\" variable in the config is the Gerrit host. The address where\n * Gitiles is installed may be on the same host but it could be on a\n * separate host. For example a Gerrit instance could be hosted on\n * \"gerrit-review.company.com\" but the repos could be browsable on a separate\n * host, e.g. \"gerrit.company.com\" and the human readable URL would then\n * not point to the API host.\n *\n * @public\n */\nexport class GerritUrlReader implements UrlReaderService {\n static factory: ReaderFactory = ({ config, treeResponseFactory }) => {\n const integrations = ScmIntegrations.fromConfig(config);\n if (!integrations.gerrit) {\n return [];\n }\n return integrations.gerrit.list().map(integration => {\n const reader = new GerritUrlReader(integration, { treeResponseFactory });\n const predicate = (url: URL) => {\n const gitilesUrl = new URL(integration.config.gitilesBaseUrl!);\n // If gitilesUrl is not specified it will default to\n // \"integration.config.host\".\n return url.host === gitilesUrl.host;\n };\n return { reader, predicate };\n });\n };\n\n private readonly integration: GerritIntegration;\n private readonly deps: { treeResponseFactory: ReadTreeResponseFactory };\n\n constructor(\n integration: GerritIntegration,\n deps: { treeResponseFactory: ReadTreeResponseFactory },\n ) {\n this.integration = integration;\n this.deps = deps;\n }\n\n async read(url: string): Promise<Buffer> {\n const response = await this.readUrl(url);\n return response.buffer();\n }\n\n async readUrl(\n url: string,\n options?: UrlReaderServiceReadUrlOptions,\n ): Promise<UrlReaderServiceReadUrlResponse> {\n const apiUrl = getGerritFileContentsApiUrl(this.integration.config, url);\n let response: Response;\n try {\n response = await fetch(apiUrl, {\n method: 'GET',\n ...getGerritRequestOptions(this.integration.config),\n // TODO(freben): The signal cast is there because pre-3.x versions of\n // node-fetch have a very slightly deviating AbortSignal type signature.\n // The difference does not affect us in practice however. The cast can\n // be removed after we support ESM for CLI dependencies and migrate to\n // version 3 of node-fetch.\n // https://github.com/backstage/backstage/issues/8242\n signal: options?.signal as any,\n });\n } catch (e) {\n throw new Error(`Unable to read gerrit file ${url}, ${e}`);\n }\n\n if (response.ok) {\n let responseBody: string;\n return {\n buffer: async () => {\n if (responseBody === undefined) {\n responseBody = await response.text();\n }\n return Buffer.from(responseBody, 'base64');\n },\n stream: () => {\n const readable = Readable.from(response.body);\n return readable.pipe(new Base64Decode());\n },\n };\n }\n if (response.status === 404) {\n throw new NotFoundError(`File ${url} not found.`);\n }\n throw new Error(\n `${url} could not be read as ${apiUrl}, ${response.status} ${response.statusText}`,\n );\n }\n\n async readTree(\n url: string,\n options?: UrlReaderServiceReadTreeOptions,\n ): Promise<UrlReaderServiceReadTreeResponse> {\n const urlRevision = await this.getRevisionForUrl(url, options);\n\n return this.readTreeFromGitiles(url, urlRevision, options);\n }\n\n async search(\n url: string,\n options?: UrlReaderServiceSearchOptions,\n ): Promise<UrlReaderServiceSearchResponse> {\n const { path } = parseGitilesUrlRef(this.integration.config, url);\n\n if (!path.match(/[*?]/)) {\n try {\n const data = await this.readUrl(url, options);\n\n return {\n files: [\n {\n url: url,\n content: data.buffer,\n lastModifiedAt: data.lastModifiedAt,\n },\n ],\n etag: data.etag ?? '',\n };\n } catch (e) {\n const error = toError(e);\n if (error.name === 'NotFoundError') {\n return {\n files: [],\n etag: '',\n };\n }\n throw error;\n }\n }\n\n const urlRevision = await this.getRevisionForUrl(url, options);\n\n const files = await this.searchFilesFromGitiles(url, options);\n\n return { files, etag: urlRevision };\n }\n\n toString() {\n const { host, password } = this.integration.config;\n return `gerrit{host=${host},authed=${Boolean(password)}}`;\n }\n\n private async readTreeFromGitiles(\n url: string,\n revision: string,\n options?: UrlReaderServiceReadTreeOptions,\n ) {\n const archiveUrl = buildGerritGitilesArchiveUrlFromLocation(\n this.integration.config,\n url,\n );\n const archiveResponse = await fetch(archiveUrl, {\n ...getGerritRequestOptions(this.integration.config),\n // TODO(freben): The signal cast is there because pre-3.x versions of\n // node-fetch have a very slightly deviating AbortSignal type signature.\n // The difference does not affect us in practice however. The cast can\n // be removed after we support ESM for CLI dependencies and migrate to\n // version 3 of node-fetch.\n // https://github.com/backstage/backstage/issues/8242\n signal: options?.signal as any,\n });\n\n if (archiveResponse.status === 404) {\n throw new NotFoundError(`Not found: ${archiveUrl}`);\n }\n\n if (!archiveResponse.ok) {\n throw new Error(\n `${url} could not be read as ${archiveUrl}, ${archiveResponse.status} ${archiveResponse.statusText}`,\n );\n }\n\n return await this.deps.treeResponseFactory.fromTarArchive({\n stream: archiveResponse.body as unknown as Readable,\n etag: revision,\n filter: options?.filter,\n stripFirstDirectory: false,\n });\n }\n\n private async getRevisionForUrl(\n url: string,\n options?: UrlReaderServiceReadTreeOptions,\n ): Promise<string> {\n const { ref, refType } = parseGitilesUrlRef(this.integration.config, url);\n // The url points to a static revision.\n if (refType === 'sha') {\n if (options?.etag === ref) {\n throw new NotModifiedError();\n }\n return ref;\n }\n\n const apiUrl = getGerritBranchApiUrl(this.integration.config, url);\n let response: Response;\n try {\n response = await fetch(apiUrl, {\n method: 'GET',\n ...getGerritRequestOptions(this.integration.config),\n });\n } catch (e) {\n throw new Error(`Unable to read branch state ${url}, ${e}`);\n }\n\n if (!response.ok) {\n throw await ResponseError.fromResponse(response);\n }\n\n const branchInfo = (await parseGerritJsonResponse(response as any)) as {\n revision: string;\n };\n if (options?.etag === branchInfo.revision) {\n throw new NotModifiedError();\n }\n return branchInfo.revision;\n }\n\n private async searchFilesFromGitiles(\n url: string,\n options?: UrlReaderServiceReadTreeOptions,\n ): Promise<UrlReaderServiceSearchResponse['files']> {\n const { path, basePath } = parseGitilesUrlRef(this.integration.config, url);\n\n const treeUrl = `${basePath}/?format=JSON&recursive`.replace(\n this.integration.config.gitilesBaseUrl,\n getGitilesAuthenticationUrl(this.integration.config),\n );\n\n const treeResponse = await fetch(treeUrl, {\n ...getGerritRequestOptions(this.integration.config),\n // TODO(freben): The signal cast is there because pre-3.x versions of\n // node-fetch have a very slightly deviating AbortSignal type signature.\n // The difference does not affect us in practice however. The cast can\n // be removed after we support ESM for CLI dependencies and migrate to\n // version 3 of node-fetch.\n // https://github.com/backstage/backstage/issues/8242\n signal: options?.signal as any,\n });\n if (!treeResponse.ok) {\n throw await ResponseError.fromResponse(treeResponse);\n }\n\n const res = (await parseGerritJsonResponse(treeResponse as any)) as {\n id: string;\n entries: { mode: number; type: string; id: string; name: string }[];\n };\n\n const matcher = new Minimatch(decodeURIComponent(path).replace(/^\\/+/, ''));\n\n const matching = res.entries.filter(\n item => item.type === 'blob' && item.name && matcher.match(item.name),\n );\n\n return matching.map(item => ({\n url: `${basePath}/${item.name}`,\n content: async () => {\n const apiUrl = getGerritFileContentsApiUrl(\n this.integration.config,\n `${basePath}/${item.name}`,\n );\n const response = await fetch(apiUrl, {\n method: 'GET',\n ...getGerritRequestOptions(this.integration.config),\n // TODO(freben): The signal cast is there because pre-3.x versions of\n // node-fetch have a very slightly deviating AbortSignal type signature.\n // The difference does not affect us in practice however. The cast can\n // be removed after we support ESM for CLI dependencies and migrate to\n // version 3 of node-fetch.\n // https://github.com/backstage/backstage/issues/8242\n signal: options?.signal as any,\n });\n\n const responseBody = await response.text();\n return Buffer.from(responseBody, 'base64');\n },\n }));\n }\n}\n"],"names":["ScmIntegrations","getGerritFileContentsApiUrl","fetch","getGerritRequestOptions","Readable","Base64Decode","NotFoundError","parseGitilesUrlRef","toError","buildGerritGitilesArchiveUrlFromLocation","NotModifiedError","getGerritBranchApiUrl","ResponseError","parseGerritJsonResponse","getGitilesAuthenticationUrl","Minimatch"],"mappings":";;;;;;;;;;;;;AAoEO,MAAM,eAAA,CAA4C;AAAA,EACvD,OAAO,OAAA,GAAyB,CAAC,EAAE,MAAA,EAAQ,qBAAoB,KAAM;AACnE,IAAA,MAAM,YAAA,GAAeA,2BAAA,CAAgB,UAAA,CAAW,MAAM,CAAA;AACtD,IAAA,IAAI,CAAC,aAAa,MAAA,EAAQ;AACxB,MAAA,OAAO,EAAC;AAAA,IACV;AACA,IAAA,OAAO,YAAA,CAAa,MAAA,CAAO,IAAA,EAAK,CAAE,IAAI,CAAA,WAAA,KAAe;AACnD,MAAA,MAAM,SAAS,IAAI,eAAA,CAAgB,WAAA,EAAa,EAAE,qBAAqB,CAAA;AACvE,MAAA,MAAM,SAAA,GAAY,CAAC,GAAA,KAAa;AAC9B,QAAA,MAAM,UAAA,GAAa,IAAI,GAAA,CAAI,WAAA,CAAY,OAAO,cAAe,CAAA;AAG7D,QAAA,OAAO,GAAA,CAAI,SAAS,UAAA,CAAW,IAAA;AAAA,MACjC,CAAA;AACA,MAAA,OAAO,EAAE,QAAQ,SAAA,EAAU;AAAA,IAC7B,CAAC,CAAA;AAAA,EACH,CAAA;AAAA,EAEiB,WAAA;AAAA,EACA,IAAA;AAAA,EAEjB,WAAA,CACE,aACA,IAAA,EACA;AACA,IAAA,IAAA,CAAK,WAAA,GAAc,WAAA;AACnB,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;AAAA,EACd;AAAA,EAEA,MAAM,KAAK,GAAA,EAA8B;AACvC,IAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,OAAA,CAAQ,GAAG,CAAA;AACvC,IAAA,OAAO,SAAS,MAAA,EAAO;AAAA,EACzB;AAAA,EAEA,MAAM,OAAA,CACJ,GAAA,EACA,OAAA,EAC0C;AAC1C,IAAA,MAAM,MAAA,GAASC,uCAAA,CAA4B,IAAA,CAAK,WAAA,CAAY,QAAQ,GAAG,CAAA;AACvE,IAAA,IAAI,QAAA;AACJ,IAAA,IAAI;AACF,MAAA,QAAA,GAAW,MAAMC,uBAAM,MAAA,EAAQ;AAAA,QAC7B,MAAA,EAAQ,KAAA;AAAA,QACR,GAAGC,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,MAAM,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,QAOlD,QAAQ,OAAA,EAAS;AAAA,OAClB,CAAA;AAAA,IACH,SAAS,CAAA,EAAG;AACV,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,2BAAA,EAA8B,GAAG,CAAA,EAAA,EAAK,CAAC,CAAA,CAAE,CAAA;AAAA,IAC3D;AAEA,IAAA,IAAI,SAAS,EAAA,EAAI;AACf,MAAA,IAAI,YAAA;AACJ,MAAA,OAAO;AAAA,QACL,QAAQ,YAAY;AAClB,UAAA,IAAI,iBAAiB,MAAA,EAAW;AAC9B,YAAA,YAAA,GAAe,MAAM,SAAS,IAAA,EAAK;AAAA,UACrC;AACA,UAAA,OAAO,MAAA,CAAO,IAAA,CAAK,YAAA,EAAc,QAAQ,CAAA;AAAA,QAC3C,CAAA;AAAA,QACA,QAAQ,MAAM;AACZ,UAAA,MAAM,QAAA,GAAWC,oBAAA,CAAS,IAAA,CAAK,QAAA,CAAS,IAAI,CAAA;AAC5C,UAAA,OAAO,QAAA,CAAS,IAAA,CAAK,IAAIC,yBAAA,EAAc,CAAA;AAAA,QACzC;AAAA,OACF;AAAA,IACF;AACA,IAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,MAAA,MAAM,IAAIC,oBAAA,CAAc,CAAA,KAAA,EAAQ,GAAG,CAAA,WAAA,CAAa,CAAA;AAAA,IAClD;AACA,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,EAAG,GAAG,CAAA,sBAAA,EAAyB,MAAM,KAAK,QAAA,CAAS,MAAM,CAAA,CAAA,EAAI,QAAA,CAAS,UAAU,CAAA;AAAA,KAClF;AAAA,EACF;AAAA,EAEA,MAAM,QAAA,CACJ,GAAA,EACA,OAAA,EAC2C;AAC3C,IAAA,MAAM,WAAA,GAAc,MAAM,IAAA,CAAK,iBAAA,CAAkB,KAAK,OAAO,CAAA;AAE7D,IAAA,OAAO,IAAA,CAAK,mBAAA,CAAoB,GAAA,EAAK,WAAA,EAAa,OAAO,CAAA;AAAA,EAC3D;AAAA,EAEA,MAAM,MAAA,CACJ,GAAA,EACA,OAAA,EACyC;AACzC,IAAA,MAAM,EAAE,IAAA,EAAK,GAAIC,+BAAmB,IAAA,CAAK,WAAA,CAAY,QAAQ,GAAG,CAAA;AAEhE,IAAA,IAAI,CAAC,IAAA,CAAK,KAAA,CAAM,MAAM,CAAA,EAAG;AACvB,MAAA,IAAI;AACF,QAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,OAAA,CAAQ,KAAK,OAAO,CAAA;AAE5C,QAAA,OAAO;AAAA,UACL,KAAA,EAAO;AAAA,YACL;AAAA,cACE,GAAA;AAAA,cACA,SAAS,IAAA,CAAK,MAAA;AAAA,cACd,gBAAgB,IAAA,CAAK;AAAA;AACvB,WACF;AAAA,UACA,IAAA,EAAM,KAAK,IAAA,IAAQ;AAAA,SACrB;AAAA,MACF,SAAS,CAAA,EAAG;AACV,QAAA,MAAM,KAAA,GAAQC,eAAQ,CAAC,CAAA;AACvB,QAAA,IAAI,KAAA,CAAM,SAAS,eAAA,EAAiB;AAClC,UAAA,OAAO;AAAA,YACL,OAAO,EAAC;AAAA,YACR,IAAA,EAAM;AAAA,WACR;AAAA,QACF;AACA,QAAA,MAAM,KAAA;AAAA,MACR;AAAA,IACF;AAEA,IAAA,MAAM,WAAA,GAAc,MAAM,IAAA,CAAK,iBAAA,CAAkB,KAAK,OAAO,CAAA;AAE7D,IAAA,MAAM,KAAA,GAAQ,MAAM,IAAA,CAAK,sBAAA,CAAuB,KAAK,OAAO,CAAA;AAE5D,IAAA,OAAO,EAAE,KAAA,EAAO,IAAA,EAAM,WAAA,EAAY;AAAA,EACpC;AAAA,EAEA,QAAA,GAAW;AACT,IAAA,MAAM,EAAE,IAAA,EAAM,QAAA,EAAS,GAAI,KAAK,WAAA,CAAY,MAAA;AAC5C,IAAA,OAAO,CAAA,YAAA,EAAe,IAAI,CAAA,QAAA,EAAW,OAAA,CAAQ,QAAQ,CAAC,CAAA,CAAA,CAAA;AAAA,EACxD;AAAA,EAEA,MAAc,mBAAA,CACZ,GAAA,EACA,QAAA,EACA,OAAA,EACA;AACA,IAAA,MAAM,UAAA,GAAaC,oDAAA;AAAA,MACjB,KAAK,WAAA,CAAY,MAAA;AAAA,MACjB;AAAA,KACF;AACA,IAAA,MAAM,eAAA,GAAkB,MAAMP,sBAAA,CAAM,UAAA,EAAY;AAAA,MAC9C,GAAGC,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,MAAM,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAOlD,QAAQ,OAAA,EAAS;AAAA,KAClB,CAAA;AAED,IAAA,IAAI,eAAA,CAAgB,WAAW,GAAA,EAAK;AAClC,MAAA,MAAM,IAAIG,oBAAA,CAAc,CAAA,WAAA,EAAc,UAAU,CAAA,CAAE,CAAA;AAAA,IACpD;AAEA,IAAA,IAAI,CAAC,gBAAgB,EAAA,EAAI;AACvB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,EAAG,GAAG,CAAA,sBAAA,EAAyB,UAAU,KAAK,eAAA,CAAgB,MAAM,CAAA,CAAA,EAAI,eAAA,CAAgB,UAAU,CAAA;AAAA,OACpG;AAAA,IACF;AAEA,IAAA,OAAO,MAAM,IAAA,CAAK,IAAA,CAAK,mBAAA,CAAoB,cAAA,CAAe;AAAA,MACxD,QAAQ,eAAA,CAAgB,IAAA;AAAA,MACxB,IAAA,EAAM,QAAA;AAAA,MACN,QAAQ,OAAA,EAAS,MAAA;AAAA,MACjB,mBAAA,EAAqB;AAAA,KACtB,CAAA;AAAA,EACH;AAAA,EAEA,MAAc,iBAAA,CACZ,GAAA,EACA,OAAA,EACiB;AACjB,IAAA,MAAM,EAAE,KAAK,OAAA,EAAQ,GAAIC,+BAAmB,IAAA,CAAK,WAAA,CAAY,QAAQ,GAAG,CAAA;AAExE,IAAA,IAAI,YAAY,KAAA,EAAO;AACrB,MAAA,IAAI,OAAA,EAAS,SAAS,GAAA,EAAK;AACzB,QAAA,MAAM,IAAIG,uBAAA,EAAiB;AAAA,MAC7B;AACA,MAAA,OAAO,GAAA;AAAA,IACT;AAEA,IAAA,MAAM,MAAA,GAASC,iCAAA,CAAsB,IAAA,CAAK,WAAA,CAAY,QAAQ,GAAG,CAAA;AACjE,IAAA,IAAI,QAAA;AACJ,IAAA,IAAI;AACF,MAAA,QAAA,GAAW,MAAMT,uBAAM,MAAA,EAAQ;AAAA,QAC7B,MAAA,EAAQ,KAAA;AAAA,QACR,GAAGC,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,MAAM;AAAA,OACnD,CAAA;AAAA,IACH,SAAS,CAAA,EAAG;AACV,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,4BAAA,EAA+B,GAAG,CAAA,EAAA,EAAK,CAAC,CAAA,CAAE,CAAA;AAAA,IAC5D;AAEA,IAAA,IAAI,CAAC,SAAS,EAAA,EAAI;AAChB,MAAA,MAAM,MAAMS,oBAAA,CAAc,YAAA,CAAa,QAAQ,CAAA;AAAA,IACjD;AAEA,IAAA,MAAM,UAAA,GAAc,MAAMC,mCAAA,CAAwB,QAAe,CAAA;AAGjE,IAAA,IAAI,OAAA,EAAS,IAAA,KAAS,UAAA,CAAW,QAAA,EAAU;AACzC,MAAA,MAAM,IAAIH,uBAAA,EAAiB;AAAA,IAC7B;AACA,IAAA,OAAO,UAAA,CAAW,QAAA;AAAA,EACpB;AAAA,EAEA,MAAc,sBAAA,CACZ,GAAA,EACA,OAAA,EACkD;AAClD,IAAA,MAAM,EAAE,MAAM,QAAA,EAAS,GAAIH,+BAAmB,IAAA,CAAK,WAAA,CAAY,QAAQ,GAAG,CAAA;AAE1E,IAAA,MAAM,OAAA,GAAU,CAAA,EAAG,QAAQ,CAAA,uBAAA,CAAA,CAA0B,OAAA;AAAA,MACnD,IAAA,CAAK,YAAY,MAAA,CAAO,cAAA;AAAA,MACxBO,uCAAA,CAA4B,IAAA,CAAK,WAAA,CAAY,MAAM;AAAA,KACrD;AAEA,IAAA,MAAM,YAAA,GAAe,MAAMZ,sBAAA,CAAM,OAAA,EAAS;AAAA,MACxC,GAAGC,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,MAAM,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAOlD,QAAQ,OAAA,EAAS;AAAA,KAClB,CAAA;AACD,IAAA,IAAI,CAAC,aAAa,EAAA,EAAI;AACpB,MAAA,MAAM,MAAMS,oBAAA,CAAc,YAAA,CAAa,YAAY,CAAA;AAAA,IACrD;AAEA,IAAA,MAAM,GAAA,GAAO,MAAMC,mCAAA,CAAwB,YAAmB,CAAA;AAK9D,IAAA,MAAM,OAAA,GAAU,IAAIE,mBAAA,CAAU,kBAAA,CAAmB,IAAI,CAAA,CAAE,OAAA,CAAQ,MAAA,EAAQ,EAAE,CAAC,CAAA;AAE1E,IAAA,MAAM,QAAA,GAAW,IAAI,OAAA,CAAQ,MAAA;AAAA,MAC3B,CAAA,IAAA,KAAQ,KAAK,IAAA,KAAS,MAAA,IAAU,KAAK,IAAA,IAAQ,OAAA,CAAQ,KAAA,CAAM,IAAA,CAAK,IAAI;AAAA,KACtE;AAEA,IAAA,OAAO,QAAA,CAAS,IAAI,CAAA,IAAA,MAAS;AAAA,MAC3B,GAAA,EAAK,CAAA,EAAG,QAAQ,CAAA,CAAA,EAAI,KAAK,IAAI,CAAA,CAAA;AAAA,MAC7B,SAAS,YAAY;AACnB,QAAA,MAAM,MAAA,GAASd,uCAAA;AAAA,UACb,KAAK,WAAA,CAAY,MAAA;AAAA,UACjB,CAAA,EAAG,QAAQ,CAAA,CAAA,EAAI,IAAA,CAAK,IAAI,CAAA;AAAA,SAC1B;AACA,QAAA,MAAM,QAAA,GAAW,MAAMC,sBAAA,CAAM,MAAA,EAAQ;AAAA,UACnC,MAAA,EAAQ,KAAA;AAAA,UACR,GAAGC,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,MAAM,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,UAOlD,QAAQ,OAAA,EAAS;AAAA,SAClB,CAAA;AAED,QAAA,MAAM,YAAA,GAAe,MAAM,QAAA,CAAS,IAAA,EAAK;AACzC,QAAA,OAAO,MAAA,CAAO,IAAA,CAAK,YAAA,EAAc,QAAQ,CAAA;AAAA,MAC3C;AAAA,KACF,CAAE,CAAA;AAAA,EACJ;AACF;;"}
@@ -1 +1 @@
1
- {"version":3,"file":"GiteaUrlReader.cjs.js","sources":["../../../../src/entrypoints/urlReader/lib/GiteaUrlReader.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 {\n UrlReaderService,\n UrlReaderServiceReadTreeOptions,\n UrlReaderServiceReadTreeResponse,\n UrlReaderServiceReadUrlOptions,\n UrlReaderServiceReadUrlResponse,\n UrlReaderServiceSearchOptions,\n UrlReaderServiceSearchResponse,\n} from '@backstage/backend-plugin-api';\nimport {\n getGiteaFileContentsUrl,\n getGiteaArchiveUrl,\n getGiteaLatestCommitUrl,\n parseGiteaUrl,\n getGiteaRequestOptions,\n GiteaIntegration,\n ScmIntegrations,\n} from '@backstage/integration';\nimport { ReaderFactory, ReadTreeResponseFactory } from './types';\nimport { ReadUrlResponseFactory } from './ReadUrlResponseFactory';\nimport {\n toError,\n AuthenticationError,\n NotFoundError,\n NotModifiedError,\n} from '@backstage/errors';\nimport { Readable } from 'node:stream';\nimport { parseLastModified } from './util';\nimport parseGitUrl from 'git-url-parse';\n\n/**\n * Implements a {@link @backstage/backend-plugin-api#UrlReaderService} for the Gitea v1 api.\n *\n * @public\n */\nexport class GiteaUrlReader implements UrlReaderService {\n static factory: ReaderFactory = ({ config, treeResponseFactory }) => {\n return ScmIntegrations.fromConfig(config)\n .gitea.list()\n .map(integration => {\n const reader = new GiteaUrlReader(integration, { treeResponseFactory });\n const predicate = (url: URL) => {\n return url.host === integration.config.host;\n };\n return { reader, predicate };\n });\n };\n\n private readonly integration: GiteaIntegration;\n private readonly deps: {\n treeResponseFactory: ReadTreeResponseFactory;\n };\n\n constructor(\n integration: GiteaIntegration,\n deps: {\n treeResponseFactory: ReadTreeResponseFactory;\n },\n ) {\n this.integration = integration;\n this.deps = deps;\n }\n\n async read(url: string): Promise<Buffer> {\n const response = await this.readUrl(url);\n return response.buffer();\n }\n\n async readUrl(\n url: string,\n options?: UrlReaderServiceReadUrlOptions,\n ): Promise<UrlReaderServiceReadUrlResponse> {\n let response: Response;\n const blobUrl = getGiteaFileContentsUrl(this.integration.config, url);\n\n try {\n response = await fetch(blobUrl, {\n method: 'GET',\n ...getGiteaRequestOptions(this.integration.config),\n signal: options?.signal as any,\n });\n } catch (e) {\n throw new Error(`Unable to read ${blobUrl}, ${e}`);\n }\n\n if (response.ok) {\n // Gitea returns an object with the file contents encoded, not the file itself\n const { encoding, content } = await response.json();\n\n if (encoding === 'base64') {\n return ReadUrlResponseFactory.fromReadable(\n Readable.from(Buffer.from(content, 'base64')),\n {\n etag: response.headers.get('ETag') ?? undefined,\n lastModifiedAt: parseLastModified(\n response.headers.get('Last-Modified'),\n ),\n },\n );\n }\n\n throw new Error(`Unknown encoding: ${encoding}`);\n }\n\n const message = `${url} could not be read as ${blobUrl}, ${response.status} ${response.statusText}`;\n if (response.status === 404) {\n throw new NotFoundError(message);\n }\n\n if (response.status === 304) {\n throw new NotModifiedError();\n }\n\n if (response.status === 403) {\n throw new AuthenticationError();\n }\n\n throw new Error(message);\n }\n\n async readTree(\n url: string,\n options?: UrlReaderServiceReadTreeOptions,\n ): Promise<UrlReaderServiceReadTreeResponse> {\n const lastCommitHash = await this.getLastCommitHash(url);\n if (options?.etag && options.etag === lastCommitHash) {\n throw new NotModifiedError();\n }\n\n const archiveUri = getGiteaArchiveUrl(this.integration.config, url);\n\n let response: Response;\n try {\n response = await fetch(archiveUri, {\n method: 'GET',\n ...getGiteaRequestOptions(this.integration.config),\n signal: options?.signal as any,\n });\n } catch (e) {\n throw new Error(`Unable to read ${archiveUri}, ${e}`);\n }\n\n const parsedUri = parseGiteaUrl(this.integration.config, url);\n\n return this.deps.treeResponseFactory.fromTarArchive({\n response: response,\n subpath: parsedUri.path,\n etag: lastCommitHash,\n filter: options?.filter,\n });\n }\n\n async search(\n url: string,\n options?: UrlReaderServiceSearchOptions,\n ): Promise<UrlReaderServiceSearchResponse> {\n const { filepath } = parseGitUrl(url);\n\n if (filepath.match(/[*?]/)) {\n throw new Error('Unsupported search pattern URL');\n }\n\n try {\n const data = await this.readUrl(url, options);\n\n return {\n files: [\n {\n url: url,\n content: data.buffer,\n lastModifiedAt: data.lastModifiedAt,\n },\n ],\n etag: data.etag ?? '',\n };\n } catch (e) {\n const error = toError(e);\n if (error.name === 'NotFoundError') {\n return {\n files: [],\n etag: '',\n };\n }\n throw error;\n }\n }\n\n toString() {\n const { host } = this.integration.config;\n return `gitea{host=${host},authed=${Boolean(\n this.integration.config.password,\n )}}`;\n }\n\n private async getLastCommitHash(url: string): Promise<string> {\n const commitUri = getGiteaLatestCommitUrl(this.integration.config, url);\n\n const response = await fetch(\n commitUri,\n getGiteaRequestOptions(this.integration.config),\n );\n if (!response.ok) {\n const message = `Failed to retrieve latest commit information from ${commitUri}, ${response.status} ${response.statusText}`;\n if (response.status === 404) {\n throw new NotFoundError(message);\n }\n throw new Error(message);\n }\n\n return (await response.json()).sha;\n }\n}\n"],"names":["ScmIntegrations","getGiteaFileContentsUrl","getGiteaRequestOptions","ReadUrlResponseFactory","Readable","parseLastModified","NotFoundError","NotModifiedError","AuthenticationError","getGiteaArchiveUrl","parseGiteaUrl","parseGitUrl","toError","getGiteaLatestCommitUrl"],"mappings":";;;;;;;;;;;;;AAmDO,MAAM,cAAA,CAA2C;AAAA,EACtD,OAAO,OAAA,GAAyB,CAAC,EAAE,MAAA,EAAQ,qBAAoB,KAAM;AACnE,IAAA,OAAOA,2BAAA,CAAgB,WAAW,MAAM,CAAA,CACrC,MAAM,IAAA,EAAK,CACX,IAAI,CAAA,WAAA,KAAe;AAClB,MAAA,MAAM,SAAS,IAAI,cAAA,CAAe,WAAA,EAAa,EAAE,qBAAqB,CAAA;AACtE,MAAA,MAAM,SAAA,GAAY,CAAC,GAAA,KAAa;AAC9B,QAAA,OAAO,GAAA,CAAI,IAAA,KAAS,WAAA,CAAY,MAAA,CAAO,IAAA;AAAA,MACzC,CAAA;AACA,MAAA,OAAO,EAAE,QAAQ,SAAA,EAAU;AAAA,IAC7B,CAAC,CAAA;AAAA,EACL,CAAA;AAAA,EAEiB,WAAA;AAAA,EACA,IAAA;AAAA,EAIjB,WAAA,CACE,aACA,IAAA,EAGA;AACA,IAAA,IAAA,CAAK,WAAA,GAAc,WAAA;AACnB,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;AAAA,EACd;AAAA,EAEA,MAAM,KAAK,GAAA,EAA8B;AACvC,IAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,OAAA,CAAQ,GAAG,CAAA;AACvC,IAAA,OAAO,SAAS,MAAA,EAAO;AAAA,EACzB;AAAA,EAEA,MAAM,OAAA,CACJ,GAAA,EACA,OAAA,EAC0C;AAC1C,IAAA,IAAI,QAAA;AACJ,IAAA,MAAM,OAAA,GAAUC,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,QAAQ,GAAG,CAAA;AAEpE,IAAA,IAAI;AACF,MAAA,QAAA,GAAW,MAAM,MAAM,OAAA,EAAS;AAAA,QAC9B,MAAA,EAAQ,KAAA;AAAA,QACR,GAAGC,kCAAA,CAAuB,IAAA,CAAK,WAAA,CAAY,MAAM,CAAA;AAAA,QACjD,QAAQ,OAAA,EAAS;AAAA,OAClB,CAAA;AAAA,IACH,SAAS,CAAA,EAAG;AACV,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,eAAA,EAAkB,OAAO,CAAA,EAAA,EAAK,CAAC,CAAA,CAAE,CAAA;AAAA,IACnD;AAEA,IAAA,IAAI,SAAS,EAAA,EAAI;AAEf,MAAA,MAAM,EAAE,QAAA,EAAU,OAAA,EAAQ,GAAI,MAAM,SAAS,IAAA,EAAK;AAElD,MAAA,IAAI,aAAa,QAAA,EAAU;AACzB,QAAA,OAAOC,6CAAA,CAAuB,YAAA;AAAA,UAC5BC,qBAAS,IAAA,CAAK,MAAA,CAAO,IAAA,CAAK,OAAA,EAAS,QAAQ,CAAC,CAAA;AAAA,UAC5C;AAAA,YACE,IAAA,EAAM,QAAA,CAAS,OAAA,CAAQ,GAAA,CAAI,MAAM,CAAA,IAAK,MAAA;AAAA,YACtC,cAAA,EAAgBC,sBAAA;AAAA,cACd,QAAA,CAAS,OAAA,CAAQ,GAAA,CAAI,eAAe;AAAA;AACtC;AACF,SACF;AAAA,MACF;AAEA,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,kBAAA,EAAqB,QAAQ,CAAA,CAAE,CAAA;AAAA,IACjD;AAEA,IAAA,MAAM,OAAA,GAAU,CAAA,EAAG,GAAG,CAAA,sBAAA,EAAyB,OAAO,KAAK,QAAA,CAAS,MAAM,CAAA,CAAA,EAAI,QAAA,CAAS,UAAU,CAAA,CAAA;AACjG,IAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,MAAA,MAAM,IAAIC,qBAAc,OAAO,CAAA;AAAA,IACjC;AAEA,IAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,MAAA,MAAM,IAAIC,uBAAA,EAAiB;AAAA,IAC7B;AAEA,IAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,MAAA,MAAM,IAAIC,0BAAA,EAAoB;AAAA,IAChC;AAEA,IAAA,MAAM,IAAI,MAAM,OAAO,CAAA;AAAA,EACzB;AAAA,EAEA,MAAM,QAAA,CACJ,GAAA,EACA,OAAA,EAC2C;AAC3C,IAAA,MAAM,cAAA,GAAiB,MAAM,IAAA,CAAK,iBAAA,CAAkB,GAAG,CAAA;AACvD,IAAA,IAAI,OAAA,EAAS,IAAA,IAAQ,OAAA,CAAQ,IAAA,KAAS,cAAA,EAAgB;AACpD,MAAA,MAAM,IAAID,uBAAA,EAAiB;AAAA,IAC7B;AAEA,IAAA,MAAM,UAAA,GAAaE,8BAAA,CAAmB,IAAA,CAAK,WAAA,CAAY,QAAQ,GAAG,CAAA;AAElE,IAAA,IAAI,QAAA;AACJ,IAAA,IAAI;AACF,MAAA,QAAA,GAAW,MAAM,MAAM,UAAA,EAAY;AAAA,QACjC,MAAA,EAAQ,KAAA;AAAA,QACR,GAAGP,kCAAA,CAAuB,IAAA,CAAK,WAAA,CAAY,MAAM,CAAA;AAAA,QACjD,QAAQ,OAAA,EAAS;AAAA,OAClB,CAAA;AAAA,IACH,SAAS,CAAA,EAAG;AACV,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,eAAA,EAAkB,UAAU,CAAA,EAAA,EAAK,CAAC,CAAA,CAAE,CAAA;AAAA,IACtD;AAEA,IAAA,MAAM,SAAA,GAAYQ,yBAAA,CAAc,IAAA,CAAK,WAAA,CAAY,QAAQ,GAAG,CAAA;AAE5D,IAAA,OAAO,IAAA,CAAK,IAAA,CAAK,mBAAA,CAAoB,cAAA,CAAe;AAAA,MAClD,QAAA;AAAA,MACA,SAAS,SAAA,CAAU,IAAA;AAAA,MACnB,IAAA,EAAM,cAAA;AAAA,MACN,QAAQ,OAAA,EAAS;AAAA,KAClB,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,MAAA,CACJ,GAAA,EACA,OAAA,EACyC;AACzC,IAAA,MAAM,EAAE,QAAA,EAAS,GAAIC,4BAAA,CAAY,GAAG,CAAA;AAEpC,IAAA,IAAI,QAAA,CAAS,KAAA,CAAM,MAAM,CAAA,EAAG;AAC1B,MAAA,MAAM,IAAI,MAAM,gCAAgC,CAAA;AAAA,IAClD;AAEA,IAAA,IAAI;AACF,MAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,OAAA,CAAQ,KAAK,OAAO,CAAA;AAE5C,MAAA,OAAO;AAAA,QACL,KAAA,EAAO;AAAA,UACL;AAAA,YACE,GAAA;AAAA,YACA,SAAS,IAAA,CAAK,MAAA;AAAA,YACd,gBAAgB,IAAA,CAAK;AAAA;AACvB,SACF;AAAA,QACA,IAAA,EAAM,KAAK,IAAA,IAAQ;AAAA,OACrB;AAAA,IACF,SAAS,CAAA,EAAG;AACV,MAAA,MAAM,KAAA,GAAQC,eAAQ,CAAC,CAAA;AACvB,MAAA,IAAI,KAAA,CAAM,SAAS,eAAA,EAAiB;AAClC,QAAA,OAAO;AAAA,UACL,OAAO,EAAC;AAAA,UACR,IAAA,EAAM;AAAA,SACR;AAAA,MACF;AACA,MAAA,MAAM,KAAA;AAAA,IACR;AAAA,EACF;AAAA,EAEA,QAAA,GAAW;AACT,IAAA,MAAM,EAAE,IAAA,EAAK,GAAI,IAAA,CAAK,WAAA,CAAY,MAAA;AAClC,IAAA,OAAO,CAAA,WAAA,EAAc,IAAI,CAAA,QAAA,EAAW,OAAA;AAAA,MAClC,IAAA,CAAK,YAAY,MAAA,CAAO;AAAA,KACzB,CAAA,CAAA,CAAA;AAAA,EACH;AAAA,EAEA,MAAc,kBAAkB,GAAA,EAA8B;AAC5D,IAAA,MAAM,SAAA,GAAYC,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,QAAQ,GAAG,CAAA;AAEtE,IAAA,MAAM,WAAW,MAAM,KAAA;AAAA,MACrB,SAAA;AAAA,MACAX,kCAAA,CAAuB,IAAA,CAAK,WAAA,CAAY,MAAM;AAAA,KAChD;AACA,IAAA,IAAI,CAAC,SAAS,EAAA,EAAI;AAChB,MAAA,MAAM,OAAA,GAAU,qDAAqD,SAAS,CAAA,EAAA,EAAK,SAAS,MAAM,CAAA,CAAA,EAAI,SAAS,UAAU,CAAA,CAAA;AACzH,MAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,QAAA,MAAM,IAAII,qBAAc,OAAO,CAAA;AAAA,MACjC;AACA,MAAA,MAAM,IAAI,MAAM,OAAO,CAAA;AAAA,IACzB;AAEA,IAAA,OAAA,CAAQ,MAAM,QAAA,CAAS,IAAA,EAAK,EAAG,GAAA;AAAA,EACjC;AACF;;;;"}
1
+ {"version":3,"file":"GiteaUrlReader.cjs.js","sources":["../../../../src/entrypoints/urlReader/lib/GiteaUrlReader.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 {\n UrlReaderService,\n UrlReaderServiceReadTreeOptions,\n UrlReaderServiceReadTreeResponse,\n UrlReaderServiceReadUrlOptions,\n UrlReaderServiceReadUrlResponse,\n UrlReaderServiceSearchOptions,\n UrlReaderServiceSearchResponse,\n} from '@backstage/backend-plugin-api';\nimport {\n getGiteaFileContentsUrl,\n getGiteaArchiveUrl,\n getGiteaLatestCommitUrl,\n parseGiteaUrl,\n getGiteaRequestOptions,\n GiteaIntegration,\n ScmIntegrations,\n} from '@backstage/integration';\nimport { ReaderFactory, ReadTreeResponseFactory } from './types';\nimport { ReadUrlResponseFactory } from './ReadUrlResponseFactory';\nimport {\n toError,\n AuthenticationError,\n NotFoundError,\n NotModifiedError,\n} from '@backstage/errors';\nimport { Readable } from 'node:stream';\nimport { parseLastModified } from './util';\nimport parseGitUrl from 'git-url-parse';\n\n/**\n * Implements a {@link @backstage/backend-plugin-api#UrlReaderService} for the Gitea v1 api.\n *\n * @public\n */\nexport class GiteaUrlReader implements UrlReaderService {\n static factory: ReaderFactory = ({ config, treeResponseFactory }) => {\n return ScmIntegrations.fromConfig(config)\n .gitea.list()\n .map(integration => {\n const reader = new GiteaUrlReader(integration, { treeResponseFactory });\n const predicate = (url: URL) => {\n return url.host === integration.config.host;\n };\n return { reader, predicate };\n });\n };\n\n private readonly integration: GiteaIntegration;\n private readonly deps: {\n treeResponseFactory: ReadTreeResponseFactory;\n };\n\n constructor(\n integration: GiteaIntegration,\n deps: {\n treeResponseFactory: ReadTreeResponseFactory;\n },\n ) {\n this.integration = integration;\n this.deps = deps;\n }\n\n async read(url: string): Promise<Buffer> {\n const response = await this.readUrl(url);\n return response.buffer();\n }\n\n async readUrl(\n url: string,\n options?: UrlReaderServiceReadUrlOptions,\n ): Promise<UrlReaderServiceReadUrlResponse> {\n let response: Response;\n const blobUrl = getGiteaFileContentsUrl(this.integration.config, url);\n\n try {\n response = await fetch(blobUrl, {\n method: 'GET',\n ...getGiteaRequestOptions(this.integration.config),\n signal: options?.signal as any,\n });\n } catch (e) {\n throw new Error(`Unable to read ${blobUrl}, ${e}`);\n }\n\n if (response.ok) {\n // Gitea returns an object with the file contents encoded, not the file itself\n const { encoding, content } = await response.json();\n\n if (encoding === 'base64') {\n return ReadUrlResponseFactory.fromReadable(\n Readable.from(Buffer.from(content, 'base64')),\n {\n etag: response.headers.get('ETag') ?? undefined,\n lastModifiedAt: parseLastModified(\n response.headers.get('Last-Modified'),\n ),\n },\n );\n }\n\n throw new Error(`Unknown encoding: ${encoding}`);\n }\n\n const message = `${url} could not be read as ${blobUrl}, ${response.status} ${response.statusText}`;\n if (response.status === 404) {\n throw new NotFoundError(message);\n }\n\n if (response.status === 304) {\n throw new NotModifiedError();\n }\n\n if (response.status === 403) {\n throw new AuthenticationError();\n }\n\n throw new Error(message);\n }\n\n async readTree(\n url: string,\n options?: UrlReaderServiceReadTreeOptions,\n ): Promise<UrlReaderServiceReadTreeResponse> {\n const lastCommitHash = await this.getLastCommitHash(url);\n if (options?.etag && options.etag === lastCommitHash) {\n throw new NotModifiedError();\n }\n\n const archiveUri = getGiteaArchiveUrl(this.integration.config, url);\n\n let response: Response;\n try {\n response = await fetch(archiveUri, {\n method: 'GET',\n ...getGiteaRequestOptions(this.integration.config),\n signal: options?.signal as any,\n });\n } catch (e) {\n throw new Error(`Unable to read ${archiveUri}, ${e}`);\n }\n\n const parsedUri = parseGiteaUrl(this.integration.config, url);\n\n return this.deps.treeResponseFactory.fromTarArchive({\n response: response,\n subpath: parsedUri.path,\n etag: lastCommitHash,\n filter: options?.filter,\n });\n }\n\n async search(\n url: string,\n options?: UrlReaderServiceSearchOptions,\n ): Promise<UrlReaderServiceSearchResponse> {\n const { filepath } = parseGitUrl(url);\n\n if (filepath.match(/[*?]/)) {\n throw new Error('Unsupported search pattern URL');\n }\n\n try {\n const data = await this.readUrl(url, options);\n\n return {\n files: [\n {\n url: url,\n content: data.buffer,\n lastModifiedAt: data.lastModifiedAt,\n },\n ],\n etag: data.etag ?? '',\n };\n } catch (e) {\n const error = toError(e);\n if (error.name === 'NotFoundError') {\n return {\n files: [],\n etag: '',\n };\n }\n throw error;\n }\n }\n\n toString() {\n const { host } = this.integration.config;\n return `gitea{host=${host},authed=${Boolean(\n this.integration.config.password,\n )}}`;\n }\n\n private async getLastCommitHash(url: string): Promise<string> {\n const commitUri = getGiteaLatestCommitUrl(this.integration.config, url);\n\n const response = await fetch(\n commitUri,\n getGiteaRequestOptions(this.integration.config),\n );\n if (!response.ok) {\n const message = `Failed to retrieve latest commit information from ${commitUri}, ${response.status} ${response.statusText}`;\n if (response.status === 404) {\n throw new NotFoundError(message);\n }\n throw new Error(message);\n }\n\n return (await response.json()).sha;\n }\n}\n"],"names":["ScmIntegrations","getGiteaFileContentsUrl","getGiteaRequestOptions","ReadUrlResponseFactory","Readable","parseLastModified","NotFoundError","NotModifiedError","AuthenticationError","getGiteaArchiveUrl","parseGiteaUrl","parseGitUrl","toError","getGiteaLatestCommitUrl"],"mappings":";;;;;;;;;;;;;AAmDO,MAAM,cAAA,CAA2C;AAAA,EACtD,OAAO,OAAA,GAAyB,CAAC,EAAE,MAAA,EAAQ,qBAAoB,KAAM;AACnE,IAAA,OAAOA,2BAAA,CAAgB,WAAW,MAAM,CAAA,CACrC,MAAM,IAAA,EAAK,CACX,IAAI,CAAA,WAAA,KAAe;AAClB,MAAA,MAAM,SAAS,IAAI,cAAA,CAAe,WAAA,EAAa,EAAE,qBAAqB,CAAA;AACtE,MAAA,MAAM,SAAA,GAAY,CAAC,GAAA,KAAa;AAC9B,QAAA,OAAO,GAAA,CAAI,IAAA,KAAS,WAAA,CAAY,MAAA,CAAO,IAAA;AAAA,MACzC,CAAA;AACA,MAAA,OAAO,EAAE,QAAQ,SAAA,EAAU;AAAA,IAC7B,CAAC,CAAA;AAAA,EACL,CAAA;AAAA,EAEiB,WAAA;AAAA,EACA,IAAA;AAAA,EAIjB,WAAA,CACE,aACA,IAAA,EAGA;AACA,IAAA,IAAA,CAAK,WAAA,GAAc,WAAA;AACnB,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;AAAA,EACd;AAAA,EAEA,MAAM,KAAK,GAAA,EAA8B;AACvC,IAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,OAAA,CAAQ,GAAG,CAAA;AACvC,IAAA,OAAO,SAAS,MAAA,EAAO;AAAA,EACzB;AAAA,EAEA,MAAM,OAAA,CACJ,GAAA,EACA,OAAA,EAC0C;AAC1C,IAAA,IAAI,QAAA;AACJ,IAAA,MAAM,OAAA,GAAUC,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,QAAQ,GAAG,CAAA;AAEpE,IAAA,IAAI;AACF,MAAA,QAAA,GAAW,MAAM,MAAM,OAAA,EAAS;AAAA,QAC9B,MAAA,EAAQ,KAAA;AAAA,QACR,GAAGC,kCAAA,CAAuB,IAAA,CAAK,WAAA,CAAY,MAAM,CAAA;AAAA,QACjD,QAAQ,OAAA,EAAS;AAAA,OAClB,CAAA;AAAA,IACH,SAAS,CAAA,EAAG;AACV,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,eAAA,EAAkB,OAAO,CAAA,EAAA,EAAK,CAAC,CAAA,CAAE,CAAA;AAAA,IACnD;AAEA,IAAA,IAAI,SAAS,EAAA,EAAI;AAEf,MAAA,MAAM,EAAE,QAAA,EAAU,OAAA,EAAQ,GAAI,MAAM,SAAS,IAAA,EAAK;AAElD,MAAA,IAAI,aAAa,QAAA,EAAU;AACzB,QAAA,OAAOC,6CAAA,CAAuB,YAAA;AAAA,UAC5BC,qBAAS,IAAA,CAAK,MAAA,CAAO,IAAA,CAAK,OAAA,EAAS,QAAQ,CAAC,CAAA;AAAA,UAC5C;AAAA,YACE,IAAA,EAAM,QAAA,CAAS,OAAA,CAAQ,GAAA,CAAI,MAAM,CAAA,IAAK,MAAA;AAAA,YACtC,cAAA,EAAgBC,sBAAA;AAAA,cACd,QAAA,CAAS,OAAA,CAAQ,GAAA,CAAI,eAAe;AAAA;AACtC;AACF,SACF;AAAA,MACF;AAEA,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,kBAAA,EAAqB,QAAQ,CAAA,CAAE,CAAA;AAAA,IACjD;AAEA,IAAA,MAAM,OAAA,GAAU,CAAA,EAAG,GAAG,CAAA,sBAAA,EAAyB,OAAO,KAAK,QAAA,CAAS,MAAM,CAAA,CAAA,EAAI,QAAA,CAAS,UAAU,CAAA,CAAA;AACjG,IAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,MAAA,MAAM,IAAIC,qBAAc,OAAO,CAAA;AAAA,IACjC;AAEA,IAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,MAAA,MAAM,IAAIC,uBAAA,EAAiB;AAAA,IAC7B;AAEA,IAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,MAAA,MAAM,IAAIC,0BAAA,EAAoB;AAAA,IAChC;AAEA,IAAA,MAAM,IAAI,MAAM,OAAO,CAAA;AAAA,EACzB;AAAA,EAEA,MAAM,QAAA,CACJ,GAAA,EACA,OAAA,EAC2C;AAC3C,IAAA,MAAM,cAAA,GAAiB,MAAM,IAAA,CAAK,iBAAA,CAAkB,GAAG,CAAA;AACvD,IAAA,IAAI,OAAA,EAAS,IAAA,IAAQ,OAAA,CAAQ,IAAA,KAAS,cAAA,EAAgB;AACpD,MAAA,MAAM,IAAID,uBAAA,EAAiB;AAAA,IAC7B;AAEA,IAAA,MAAM,UAAA,GAAaE,8BAAA,CAAmB,IAAA,CAAK,WAAA,CAAY,QAAQ,GAAG,CAAA;AAElE,IAAA,IAAI,QAAA;AACJ,IAAA,IAAI;AACF,MAAA,QAAA,GAAW,MAAM,MAAM,UAAA,EAAY;AAAA,QACjC,MAAA,EAAQ,KAAA;AAAA,QACR,GAAGP,kCAAA,CAAuB,IAAA,CAAK,WAAA,CAAY,MAAM,CAAA;AAAA,QACjD,QAAQ,OAAA,EAAS;AAAA,OAClB,CAAA;AAAA,IACH,SAAS,CAAA,EAAG;AACV,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,eAAA,EAAkB,UAAU,CAAA,EAAA,EAAK,CAAC,CAAA,CAAE,CAAA;AAAA,IACtD;AAEA,IAAA,MAAM,SAAA,GAAYQ,yBAAA,CAAc,IAAA,CAAK,WAAA,CAAY,QAAQ,GAAG,CAAA;AAE5D,IAAA,OAAO,IAAA,CAAK,IAAA,CAAK,mBAAA,CAAoB,cAAA,CAAe;AAAA,MAClD,QAAA;AAAA,MACA,SAAS,SAAA,CAAU,IAAA;AAAA,MACnB,IAAA,EAAM,cAAA;AAAA,MACN,QAAQ,OAAA,EAAS;AAAA,KAClB,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,MAAA,CACJ,GAAA,EACA,OAAA,EACyC;AACzC,IAAA,MAAM,EAAE,QAAA,EAAS,GAAIC,4BAAA,CAAY,GAAG,CAAA;AAEpC,IAAA,IAAI,QAAA,CAAS,KAAA,CAAM,MAAM,CAAA,EAAG;AAC1B,MAAA,MAAM,IAAI,MAAM,gCAAgC,CAAA;AAAA,IAClD;AAEA,IAAA,IAAI;AACF,MAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,OAAA,CAAQ,KAAK,OAAO,CAAA;AAE5C,MAAA,OAAO;AAAA,QACL,KAAA,EAAO;AAAA,UACL;AAAA,YACE,GAAA;AAAA,YACA,SAAS,IAAA,CAAK,MAAA;AAAA,YACd,gBAAgB,IAAA,CAAK;AAAA;AACvB,SACF;AAAA,QACA,IAAA,EAAM,KAAK,IAAA,IAAQ;AAAA,OACrB;AAAA,IACF,SAAS,CAAA,EAAG;AACV,MAAA,MAAM,KAAA,GAAQC,eAAQ,CAAC,CAAA;AACvB,MAAA,IAAI,KAAA,CAAM,SAAS,eAAA,EAAiB;AAClC,QAAA,OAAO;AAAA,UACL,OAAO,EAAC;AAAA,UACR,IAAA,EAAM;AAAA,SACR;AAAA,MACF;AACA,MAAA,MAAM,KAAA;AAAA,IACR;AAAA,EACF;AAAA,EAEA,QAAA,GAAW;AACT,IAAA,MAAM,EAAE,IAAA,EAAK,GAAI,IAAA,CAAK,WAAA,CAAY,MAAA;AAClC,IAAA,OAAO,CAAA,WAAA,EAAc,IAAI,CAAA,QAAA,EAAW,OAAA;AAAA,MAClC,IAAA,CAAK,YAAY,MAAA,CAAO;AAAA,KACzB,CAAA,CAAA,CAAA;AAAA,EACH;AAAA,EAEA,MAAc,kBAAkB,GAAA,EAA8B;AAC5D,IAAA,MAAM,SAAA,GAAYC,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,QAAQ,GAAG,CAAA;AAEtE,IAAA,MAAM,WAAW,MAAM,KAAA;AAAA,MACrB,SAAA;AAAA,MACAX,kCAAA,CAAuB,IAAA,CAAK,WAAA,CAAY,MAAM;AAAA,KAChD;AACA,IAAA,IAAI,CAAC,SAAS,EAAA,EAAI;AAChB,MAAA,MAAM,OAAA,GAAU,qDAAqD,SAAS,CAAA,EAAA,EAAK,SAAS,MAAM,CAAA,CAAA,EAAI,SAAS,UAAU,CAAA,CAAA;AACzH,MAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,QAAA,MAAM,IAAII,qBAAc,OAAO,CAAA;AAAA,MACjC;AACA,MAAA,MAAM,IAAI,MAAM,OAAO,CAAA;AAAA,IACzB;AAEA,IAAA,OAAA,CAAQ,MAAM,QAAA,CAAS,IAAA,EAAK,EAAG,GAAA;AAAA,EACjC;AACF;;"}
@@ -1 +1 @@
1
- {"version":3,"file":"GithubUrlReader.cjs.js","sources":["../../../../src/entrypoints/urlReader/lib/GithubUrlReader.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n UrlReaderService,\n UrlReaderServiceReadTreeOptions,\n UrlReaderServiceReadTreeResponse,\n UrlReaderServiceReadUrlOptions,\n UrlReaderServiceReadUrlResponse,\n UrlReaderServiceSearchOptions,\n UrlReaderServiceSearchResponse,\n UrlReaderServiceSearchResponseFile,\n} from '@backstage/backend-plugin-api';\nimport {\n getGithubFileFetchUrl,\n DefaultGithubCredentialsProvider,\n GithubCredentialsProvider,\n GithubIntegration,\n ScmIntegrations,\n GithubCredentials,\n} from '@backstage/integration';\nimport { RestEndpointMethodTypes } from '@octokit/rest';\nimport fetch, { RequestInit, Response } from 'node-fetch';\nimport parseGitUrl from 'git-url-parse';\nimport { Minimatch } from 'minimatch';\nimport { Readable } from 'node:stream';\nimport { toError, NotFoundError, NotModifiedError } from '@backstage/errors';\nimport { ReadTreeResponseFactory, ReaderFactory } from './types';\nimport { ReadUrlResponseFactory } from './ReadUrlResponseFactory';\nimport { parseLastModified } from './util';\nimport isGlob from 'is-glob';\n\nexport type GhRepoResponse =\n RestEndpointMethodTypes['repos']['get']['response']['data'];\nexport type GhCombinedCommitStatusResponse =\n RestEndpointMethodTypes['repos']['getCombinedStatusForRef']['response']['data'];\nexport type GhTreeResponse =\n RestEndpointMethodTypes['git']['getTree']['response']['data'];\nexport type GhBlobResponse =\n RestEndpointMethodTypes['git']['getBlob']['response']['data'];\n\n/**\n * Implements a {@link @backstage/backend-plugin-api#UrlReaderService} for files through the GitHub v3 APIs, such as\n * the one exposed by GitHub itself.\n *\n * @public\n */\nexport class GithubUrlReader implements UrlReaderService {\n static factory: ReaderFactory = ({ config, treeResponseFactory }) => {\n const integrations = ScmIntegrations.fromConfig(config);\n const credentialsProvider =\n DefaultGithubCredentialsProvider.fromIntegrations(integrations);\n return integrations.github.list().map(integration => {\n const reader = new GithubUrlReader(integration, {\n treeResponseFactory,\n credentialsProvider,\n });\n const predicate = (url: URL) => url.host === integration.config.host;\n return { reader, predicate };\n });\n };\n\n private readonly integration: GithubIntegration;\n private readonly deps: {\n treeResponseFactory: ReadTreeResponseFactory;\n credentialsProvider: GithubCredentialsProvider;\n };\n\n constructor(\n integration: GithubIntegration,\n deps: {\n treeResponseFactory: ReadTreeResponseFactory;\n credentialsProvider: GithubCredentialsProvider;\n },\n ) {\n this.integration = integration;\n this.deps = deps;\n if (!integration.config.apiBaseUrl && !integration.config.rawBaseUrl) {\n throw new Error(\n `GitHub integration '${integration.title}' must configure an explicit apiBaseUrl or rawBaseUrl`,\n );\n }\n }\n\n async read(url: string): Promise<Buffer> {\n const response = await this.readUrl(url);\n return response.buffer();\n }\n\n private getCredentials = async (\n url: string,\n options?: { token?: string },\n ): Promise<GithubCredentials> => {\n if (options?.token) {\n return {\n headers: {\n Authorization: `Bearer ${options.token}`,\n },\n type: 'token',\n token: options.token,\n };\n }\n\n return await this.deps.credentialsProvider.getCredentials({\n url,\n });\n };\n\n async readUrl(\n url: string,\n options?: UrlReaderServiceReadUrlOptions,\n ): Promise<UrlReaderServiceReadUrlResponse> {\n const credentials = await this.getCredentials(url, options);\n\n const ghUrl = getGithubFileFetchUrl(\n url,\n this.integration.config,\n credentials,\n );\n\n const response = await this.fetchResponse(ghUrl, {\n headers: {\n ...credentials?.headers,\n ...(options?.etag && { 'If-None-Match': options.etag }),\n ...(options?.lastModifiedAfter && {\n 'If-Modified-Since': options.lastModifiedAfter.toUTCString(),\n }),\n Accept: 'application/vnd.github.v3.raw',\n },\n // TODO(freben): The signal cast is there because pre-3.x versions of\n // node-fetch have a very slightly deviating AbortSignal type signature.\n // The difference does not affect us in practice however. The cast can\n // be removed after we support ESM for CLI dependencies and migrate to\n // version 3 of node-fetch.\n // https://github.com/backstage/backstage/issues/8242\n signal: options?.signal as any,\n });\n\n return ReadUrlResponseFactory.fromNodeJSReadable(response.body, {\n etag: response.headers.get('ETag') ?? undefined,\n lastModifiedAt: parseLastModified(response.headers.get('Last-Modified')),\n });\n }\n\n async readTree(\n url: string,\n options?: UrlReaderServiceReadTreeOptions,\n ): Promise<UrlReaderServiceReadTreeResponse> {\n const repoDetails = await this.getRepoDetails(url, options);\n const commitSha = repoDetails.commitSha;\n\n if (options?.etag && options.etag === commitSha) {\n throw new NotModifiedError();\n }\n\n const { filepath } = parseGitUrl(url);\n const { headers } = await this.getCredentials(url, options);\n\n return this.doReadTree(\n repoDetails.repo.archive_url,\n commitSha,\n filepath,\n // TODO(freben): The signal cast is there because pre-3.x versions of\n // node-fetch have a very slightly deviating AbortSignal type signature.\n // The difference does not affect us in practice however. The cast can be\n // removed after we support ESM for CLI dependencies and migrate to\n // version 3 of node-fetch.\n // https://github.com/backstage/backstage/issues/8242\n { headers, signal: options?.signal as any },\n options,\n );\n }\n\n async search(\n url: string,\n options?: UrlReaderServiceSearchOptions,\n ): Promise<UrlReaderServiceSearchResponse> {\n const { filepath } = parseGitUrl(url);\n\n // If it's a direct URL we use readUrl instead\n if (!isGlob(filepath)) {\n try {\n const data = await this.readUrl(url, options);\n\n return {\n files: [\n {\n url: url,\n content: data.buffer,\n lastModifiedAt: data.lastModifiedAt,\n },\n ],\n etag: data.etag ?? '',\n };\n } catch (e) {\n const error = toError(e);\n if (error.name === 'NotFoundError') {\n return {\n files: [],\n etag: '',\n };\n }\n throw error;\n }\n }\n\n const repoDetails = await this.getRepoDetails(url, options);\n const commitSha = repoDetails.commitSha;\n\n if (options?.etag && options.etag === commitSha) {\n throw new NotModifiedError();\n }\n\n const { headers } = await this.getCredentials(url, options);\n\n const files = await this.doSearch(\n url,\n repoDetails.repo.trees_url,\n repoDetails.repo.archive_url,\n commitSha,\n filepath,\n { headers, signal: options?.signal as any },\n );\n\n return { files, etag: commitSha };\n }\n\n toString() {\n const { host, token } = this.integration.config;\n return `github{host=${host},authed=${Boolean(token)}}`;\n }\n\n private async doReadTree(\n archiveUrl: string,\n sha: string,\n subpath: string,\n init: RequestInit,\n options?: UrlReaderServiceReadTreeOptions,\n ): Promise<UrlReaderServiceReadTreeResponse> {\n // archive_url looks like \"https://api.github.com/repos/owner/repo/{archive_format}{/ref}\"\n const archive = await this.fetchResponse(\n archiveUrl\n .replace('{archive_format}', 'tarball')\n .replace('{/ref}', `/${sha}`),\n init,\n );\n\n return await this.deps.treeResponseFactory.fromTarArchive({\n // TODO(Rugvip): Underlying implementation of fetch will be node-fetch, we probably want\n // to stick to using that in exclusively backend code.\n stream: Readable.from(archive.body),\n subpath,\n etag: sha,\n filter: options?.filter,\n });\n }\n\n private async doSearch(\n url: string,\n treesUrl: string,\n archiveUrl: string,\n sha: string,\n query: string,\n init: RequestInit,\n ): Promise<UrlReaderServiceSearchResponseFile[]> {\n function pathToUrl(path: string): string {\n // TODO(freben): Use the integration package facility for this instead\n // pathname starts as /backstage/backstage/blob/master/<path>\n const updated = new URL(url);\n const base = updated.pathname.split('/').slice(1, 5).join('/');\n updated.pathname = `${base}/${path}`;\n return updated.toString();\n }\n\n const matcher = new Minimatch(query.replace(/^\\/+/, ''));\n\n // trees_url looks like \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"\n const recursiveTree: GhTreeResponse = await this.fetchJson(\n treesUrl.replace('{/sha}', `/${sha}?recursive=true`),\n init,\n );\n\n // The simple case is that we got the entire tree in a single operation.\n if (!recursiveTree.truncated) {\n const matching = recursiveTree.tree.filter(\n item =>\n item.type === 'blob' &&\n item.path &&\n item.url &&\n matcher.match(item.path),\n );\n\n return matching.map(item => ({\n url: pathToUrl(item.path!),\n content: async () => {\n const blob: GhBlobResponse = await this.fetchJson(item.url!, init);\n return Buffer.from(blob.content, 'base64');\n },\n }));\n }\n\n // For larger repos, we leverage readTree and filter through that instead\n const tree = await this.doReadTree(archiveUrl, sha, '', init, {\n filter: path => matcher.match(path),\n });\n const files = await tree.files();\n\n return files.map(file => ({\n url: pathToUrl(file.path),\n content: file.content,\n lastModifiedAt: file.lastModifiedAt,\n }));\n }\n\n private async getRepoDetails(\n url: string,\n options?: { token?: string },\n ): Promise<{\n commitSha: string;\n repo: {\n archive_url: string;\n trees_url: string;\n };\n }> {\n const parsed = parseGitUrl(url);\n const { ref, full_name } = parsed;\n\n const credentials = await this.getCredentials(url, options);\n const { headers } = credentials;\n\n const commitStatus: GhCombinedCommitStatusResponse = await this.fetchJson(\n `${this.integration.config.apiBaseUrl}/repos/${full_name}/commits/${\n ref || (await this.getDefaultBranch(full_name, credentials))\n }/status?per_page=0`,\n { headers },\n );\n\n return {\n commitSha: commitStatus.sha,\n repo: commitStatus.repository,\n };\n }\n\n private async getDefaultBranch(\n repoFullName: string,\n credentials: GithubCredentials,\n ): Promise<string> {\n const repo: GhRepoResponse = await this.fetchJson(\n `${this.integration.config.apiBaseUrl}/repos/${repoFullName}`,\n { headers: credentials.headers },\n );\n\n return repo.default_branch;\n }\n\n private async fetchResponse(\n url: string | URL,\n init: RequestInit,\n ): Promise<Response> {\n const urlAsString = url.toString();\n const response = await fetch(urlAsString, init);\n\n if (!response.ok) {\n let message = `Request failed for ${urlAsString}, ${response.status} ${response.statusText}`;\n\n if (response.status === 304) {\n throw new NotModifiedError();\n }\n\n if (response.status === 404) {\n throw new NotFoundError(message);\n }\n\n // GitHub returns a 403 response with a couple of headers indicating rate\n // limit status. See more in the GitHub docs:\n // https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting\n if (this.integration.parseRateLimitInfo(response).isRateLimited) {\n message += ' (rate limit exceeded)';\n }\n\n throw new Error(message);\n }\n\n return response;\n }\n\n private async fetchJson(url: string | URL, init: RequestInit): Promise<any> {\n const response = await this.fetchResponse(url, init);\n return await response.json();\n }\n}\n"],"names":["ScmIntegrations","DefaultGithubCredentialsProvider","getGithubFileFetchUrl","ReadUrlResponseFactory","parseLastModified","NotModifiedError","parseGitUrl","isGlob","toError","Readable","Minimatch","fetch","NotFoundError"],"mappings":";;;;;;;;;;;;;;;;;;AA4DO,MAAM,eAAA,CAA4C;AAAA,EACvD,OAAO,OAAA,GAAyB,CAAC,EAAE,MAAA,EAAQ,qBAAoB,KAAM;AACnE,IAAA,MAAM,YAAA,GAAeA,2BAAA,CAAgB,UAAA,CAAW,MAAM,CAAA;AACtD,IAAA,MAAM,mBAAA,GACJC,4CAAA,CAAiC,gBAAA,CAAiB,YAAY,CAAA;AAChE,IAAA,OAAO,YAAA,CAAa,MAAA,CAAO,IAAA,EAAK,CAAE,IAAI,CAAA,WAAA,KAAe;AACnD,MAAA,MAAM,MAAA,GAAS,IAAI,eAAA,CAAgB,WAAA,EAAa;AAAA,QAC9C,mBAAA;AAAA,QACA;AAAA,OACD,CAAA;AACD,MAAA,MAAM,YAAY,CAAC,GAAA,KAAa,GAAA,CAAI,IAAA,KAAS,YAAY,MAAA,CAAO,IAAA;AAChE,MAAA,OAAO,EAAE,QAAQ,SAAA,EAAU;AAAA,IAC7B,CAAC,CAAA;AAAA,EACH,CAAA;AAAA,EAEiB,WAAA;AAAA,EACA,IAAA;AAAA,EAKjB,WAAA,CACE,aACA,IAAA,EAIA;AACA,IAAA,IAAA,CAAK,WAAA,GAAc,WAAA;AACnB,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;AACZ,IAAA,IAAI,CAAC,WAAA,CAAY,MAAA,CAAO,cAAc,CAAC,WAAA,CAAY,OAAO,UAAA,EAAY;AACpE,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,oBAAA,EAAuB,YAAY,KAAK,CAAA,qDAAA;AAAA,OAC1C;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAM,KAAK,GAAA,EAA8B;AACvC,IAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,OAAA,CAAQ,GAAG,CAAA;AACvC,IAAA,OAAO,SAAS,MAAA,EAAO;AAAA,EACzB;AAAA,EAEQ,cAAA,GAAiB,OACvB,GAAA,EACA,OAAA,KAC+B;AAC/B,IAAA,IAAI,SAAS,KAAA,EAAO;AAClB,MAAA,OAAO;AAAA,QACL,OAAA,EAAS;AAAA,UACP,aAAA,EAAe,CAAA,OAAA,EAAU,OAAA,CAAQ,KAAK,CAAA;AAAA,SACxC;AAAA,QACA,IAAA,EAAM,OAAA;AAAA,QACN,OAAO,OAAA,CAAQ;AAAA,OACjB;AAAA,IACF;AAEA,IAAA,OAAO,MAAM,IAAA,CAAK,IAAA,CAAK,mBAAA,CAAoB,cAAA,CAAe;AAAA,MACxD;AAAA,KACD,CAAA;AAAA,EACH,CAAA;AAAA,EAEA,MAAM,OAAA,CACJ,GAAA,EACA,OAAA,EAC0C;AAC1C,IAAA,MAAM,WAAA,GAAc,MAAM,IAAA,CAAK,cAAA,CAAe,KAAK,OAAO,CAAA;AAE1D,IAAA,MAAM,KAAA,GAAQC,iCAAA;AAAA,MACZ,GAAA;AAAA,MACA,KAAK,WAAA,CAAY,MAAA;AAAA,MACjB;AAAA,KACF;AAEA,IAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,aAAA,CAAc,KAAA,EAAO;AAAA,MAC/C,OAAA,EAAS;AAAA,QACP,GAAG,WAAA,EAAa,OAAA;AAAA,QAChB,GAAI,OAAA,EAAS,IAAA,IAAQ,EAAE,eAAA,EAAiB,QAAQ,IAAA,EAAK;AAAA,QACrD,GAAI,SAAS,iBAAA,IAAqB;AAAA,UAChC,mBAAA,EAAqB,OAAA,CAAQ,iBAAA,CAAkB,WAAA;AAAY,SAC7D;AAAA,QACA,MAAA,EAAQ;AAAA,OACV;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAOA,QAAQ,OAAA,EAAS;AAAA,KAClB,CAAA;AAED,IAAA,OAAOC,6CAAA,CAAuB,kBAAA,CAAmB,QAAA,CAAS,IAAA,EAAM;AAAA,MAC9D,IAAA,EAAM,QAAA,CAAS,OAAA,CAAQ,GAAA,CAAI,MAAM,CAAA,IAAK,MAAA;AAAA,MACtC,gBAAgBC,sBAAA,CAAkB,QAAA,CAAS,OAAA,CAAQ,GAAA,CAAI,eAAe,CAAC;AAAA,KACxE,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,QAAA,CACJ,GAAA,EACA,OAAA,EAC2C;AAC3C,IAAA,MAAM,WAAA,GAAc,MAAM,IAAA,CAAK,cAAA,CAAe,KAAK,OAAO,CAAA;AAC1D,IAAA,MAAM,YAAY,WAAA,CAAY,SAAA;AAE9B,IAAA,IAAI,OAAA,EAAS,IAAA,IAAQ,OAAA,CAAQ,IAAA,KAAS,SAAA,EAAW;AAC/C,MAAA,MAAM,IAAIC,uBAAA,EAAiB;AAAA,IAC7B;AAEA,IAAA,MAAM,EAAE,QAAA,EAAS,GAAIC,4BAAA,CAAY,GAAG,CAAA;AACpC,IAAA,MAAM,EAAE,OAAA,EAAQ,GAAI,MAAM,IAAA,CAAK,cAAA,CAAe,KAAK,OAAO,CAAA;AAE1D,IAAA,OAAO,IAAA,CAAK,UAAA;AAAA,MACV,YAAY,IAAA,CAAK,WAAA;AAAA,MACjB,SAAA;AAAA,MACA,QAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAOA,EAAE,OAAA,EAAS,MAAA,EAAQ,OAAA,EAAS,MAAA,EAAc;AAAA,MAC1C;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,MAAA,CACJ,GAAA,EACA,OAAA,EACyC;AACzC,IAAA,MAAM,EAAE,QAAA,EAAS,GAAIA,4BAAA,CAAY,GAAG,CAAA;AAGpC,IAAA,IAAI,CAACC,uBAAA,CAAO,QAAQ,CAAA,EAAG;AACrB,MAAA,IAAI;AACF,QAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,OAAA,CAAQ,KAAK,OAAO,CAAA;AAE5C,QAAA,OAAO;AAAA,UACL,KAAA,EAAO;AAAA,YACL;AAAA,cACE,GAAA;AAAA,cACA,SAAS,IAAA,CAAK,MAAA;AAAA,cACd,gBAAgB,IAAA,CAAK;AAAA;AACvB,WACF;AAAA,UACA,IAAA,EAAM,KAAK,IAAA,IAAQ;AAAA,SACrB;AAAA,MACF,SAAS,CAAA,EAAG;AACV,QAAA,MAAM,KAAA,GAAQC,eAAQ,CAAC,CAAA;AACvB,QAAA,IAAI,KAAA,CAAM,SAAS,eAAA,EAAiB;AAClC,UAAA,OAAO;AAAA,YACL,OAAO,EAAC;AAAA,YACR,IAAA,EAAM;AAAA,WACR;AAAA,QACF;AACA,QAAA,MAAM,KAAA;AAAA,MACR;AAAA,IACF;AAEA,IAAA,MAAM,WAAA,GAAc,MAAM,IAAA,CAAK,cAAA,CAAe,KAAK,OAAO,CAAA;AAC1D,IAAA,MAAM,YAAY,WAAA,CAAY,SAAA;AAE9B,IAAA,IAAI,OAAA,EAAS,IAAA,IAAQ,OAAA,CAAQ,IAAA,KAAS,SAAA,EAAW;AAC/C,MAAA,MAAM,IAAIH,uBAAA,EAAiB;AAAA,IAC7B;AAEA,IAAA,MAAM,EAAE,OAAA,EAAQ,GAAI,MAAM,IAAA,CAAK,cAAA,CAAe,KAAK,OAAO,CAAA;AAE1D,IAAA,MAAM,KAAA,GAAQ,MAAM,IAAA,CAAK,QAAA;AAAA,MACvB,GAAA;AAAA,MACA,YAAY,IAAA,CAAK,SAAA;AAAA,MACjB,YAAY,IAAA,CAAK,WAAA;AAAA,MACjB,SAAA;AAAA,MACA,QAAA;AAAA,MACA,EAAE,OAAA,EAAS,MAAA,EAAQ,OAAA,EAAS,MAAA;AAAc,KAC5C;AAEA,IAAA,OAAO,EAAE,KAAA,EAAO,IAAA,EAAM,SAAA,EAAU;AAAA,EAClC;AAAA,EAEA,QAAA,GAAW;AACT,IAAA,MAAM,EAAE,IAAA,EAAM,KAAA,EAAM,GAAI,KAAK,WAAA,CAAY,MAAA;AACzC,IAAA,OAAO,CAAA,YAAA,EAAe,IAAI,CAAA,QAAA,EAAW,OAAA,CAAQ,KAAK,CAAC,CAAA,CAAA,CAAA;AAAA,EACrD;AAAA,EAEA,MAAc,UAAA,CACZ,UAAA,EACA,GAAA,EACA,OAAA,EACA,MACA,OAAA,EAC2C;AAE3C,IAAA,MAAM,OAAA,GAAU,MAAM,IAAA,CAAK,aAAA;AAAA,MACzB,UAAA,CACG,QAAQ,kBAAA,EAAoB,SAAS,EACrC,OAAA,CAAQ,QAAA,EAAU,CAAA,CAAA,EAAI,GAAG,CAAA,CAAE,CAAA;AAAA,MAC9B;AAAA,KACF;AAEA,IAAA,OAAO,MAAM,IAAA,CAAK,IAAA,CAAK,mBAAA,CAAoB,cAAA,CAAe;AAAA;AAAA;AAAA,MAGxD,MAAA,EAAQI,oBAAA,CAAS,IAAA,CAAK,OAAA,CAAQ,IAAI,CAAA;AAAA,MAClC,OAAA;AAAA,MACA,IAAA,EAAM,GAAA;AAAA,MACN,QAAQ,OAAA,EAAS;AAAA,KAClB,CAAA;AAAA,EACH;AAAA,EAEA,MAAc,QAAA,CACZ,GAAA,EACA,UACA,UAAA,EACA,GAAA,EACA,OACA,IAAA,EAC+C;AAC/C,IAAA,SAAS,UAAU,IAAA,EAAsB;AAGvC,MAAA,MAAM,OAAA,GAAU,IAAI,GAAA,CAAI,GAAG,CAAA;AAC3B,MAAA,MAAM,IAAA,GAAO,OAAA,CAAQ,QAAA,CAAS,KAAA,CAAM,GAAG,CAAA,CAAE,KAAA,CAAM,CAAA,EAAG,CAAC,CAAA,CAAE,IAAA,CAAK,GAAG,CAAA;AAC7D,MAAA,OAAA,CAAQ,QAAA,GAAW,CAAA,EAAG,IAAI,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA;AAClC,MAAA,OAAO,QAAQ,QAAA,EAAS;AAAA,IAC1B;AAEA,IAAA,MAAM,UAAU,IAAIC,mBAAA,CAAU,MAAM,OAAA,CAAQ,MAAA,EAAQ,EAAE,CAAC,CAAA;AAGvD,IAAA,MAAM,aAAA,GAAgC,MAAM,IAAA,CAAK,SAAA;AAAA,MAC/C,QAAA,CAAS,OAAA,CAAQ,QAAA,EAAU,CAAA,CAAA,EAAI,GAAG,CAAA,eAAA,CAAiB,CAAA;AAAA,MACnD;AAAA,KACF;AAGA,IAAA,IAAI,CAAC,cAAc,SAAA,EAAW;AAC5B,MAAA,MAAM,QAAA,GAAW,cAAc,IAAA,CAAK,MAAA;AAAA,QAClC,CAAA,IAAA,KACE,IAAA,CAAK,IAAA,KAAS,MAAA,IACd,IAAA,CAAK,IAAA,IACL,IAAA,CAAK,GAAA,IACL,OAAA,CAAQ,KAAA,CAAM,IAAA,CAAK,IAAI;AAAA,OAC3B;AAEA,MAAA,OAAO,QAAA,CAAS,IAAI,CAAA,IAAA,MAAS;AAAA,QAC3B,GAAA,EAAK,SAAA,CAAU,IAAA,CAAK,IAAK,CAAA;AAAA,QACzB,SAAS,YAAY;AACnB,UAAA,MAAM,OAAuB,MAAM,IAAA,CAAK,SAAA,CAAU,IAAA,CAAK,KAAM,IAAI,CAAA;AACjE,UAAA,OAAO,MAAA,CAAO,IAAA,CAAK,IAAA,CAAK,OAAA,EAAS,QAAQ,CAAA;AAAA,QAC3C;AAAA,OACF,CAAE,CAAA;AAAA,IACJ;AAGA,IAAA,MAAM,OAAO,MAAM,IAAA,CAAK,WAAW,UAAA,EAAY,GAAA,EAAK,IAAI,IAAA,EAAM;AAAA,MAC5D,MAAA,EAAQ,CAAA,IAAA,KAAQ,OAAA,CAAQ,KAAA,CAAM,IAAI;AAAA,KACnC,CAAA;AACD,IAAA,MAAM,KAAA,GAAQ,MAAM,IAAA,CAAK,KAAA,EAAM;AAE/B,IAAA,OAAO,KAAA,CAAM,IAAI,CAAA,IAAA,MAAS;AAAA,MACxB,GAAA,EAAK,SAAA,CAAU,IAAA,CAAK,IAAI,CAAA;AAAA,MACxB,SAAS,IAAA,CAAK,OAAA;AAAA,MACd,gBAAgB,IAAA,CAAK;AAAA,KACvB,CAAE,CAAA;AAAA,EACJ;AAAA,EAEA,MAAc,cAAA,CACZ,GAAA,EACA,OAAA,EAOC;AACD,IAAA,MAAM,MAAA,GAASJ,6BAAY,GAAG,CAAA;AAC9B,IAAA,MAAM,EAAE,GAAA,EAAK,SAAA,EAAU,GAAI,MAAA;AAE3B,IAAA,MAAM,WAAA,GAAc,MAAM,IAAA,CAAK,cAAA,CAAe,KAAK,OAAO,CAAA;AAC1D,IAAA,MAAM,EAAE,SAAQ,GAAI,WAAA;AAEpB,IAAA,MAAM,YAAA,GAA+C,MAAM,IAAA,CAAK,SAAA;AAAA,MAC9D,CAAA,EAAG,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,UAAU,CAAA,OAAA,EAAU,SAAS,CAAA,SAAA,EACtD,GAAA,IAAQ,MAAM,IAAA,CAAK,gBAAA,CAAiB,SAAA,EAAW,WAAW,CAC5D,CAAA,kBAAA,CAAA;AAAA,MACA,EAAE,OAAA;AAAQ,KACZ;AAEA,IAAA,OAAO;AAAA,MACL,WAAW,YAAA,CAAa,GAAA;AAAA,MACxB,MAAM,YAAA,CAAa;AAAA,KACrB;AAAA,EACF;AAAA,EAEA,MAAc,gBAAA,CACZ,YAAA,EACA,WAAA,EACiB;AACjB,IAAA,MAAM,IAAA,GAAuB,MAAM,IAAA,CAAK,SAAA;AAAA,MACtC,GAAG,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,UAAU,UAAU,YAAY,CAAA,CAAA;AAAA,MAC3D,EAAE,OAAA,EAAS,WAAA,CAAY,OAAA;AAAQ,KACjC;AAEA,IAAA,OAAO,IAAA,CAAK,cAAA;AAAA,EACd;AAAA,EAEA,MAAc,aAAA,CACZ,GAAA,EACA,IAAA,EACmB;AACnB,IAAA,MAAM,WAAA,GAAc,IAAI,QAAA,EAAS;AACjC,IAAA,MAAM,QAAA,GAAW,MAAMK,sBAAA,CAAM,WAAA,EAAa,IAAI,CAAA;AAE9C,IAAA,IAAI,CAAC,SAAS,EAAA,EAAI;AAChB,MAAA,IAAI,OAAA,GAAU,sBAAsB,WAAW,CAAA,EAAA,EAAK,SAAS,MAAM,CAAA,CAAA,EAAI,SAAS,UAAU,CAAA,CAAA;AAE1F,MAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,QAAA,MAAM,IAAIN,uBAAA,EAAiB;AAAA,MAC7B;AAEA,MAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,QAAA,MAAM,IAAIO,qBAAc,OAAO,CAAA;AAAA,MACjC;AAKA,MAAA,IAAI,IAAA,CAAK,WAAA,CAAY,kBAAA,CAAmB,QAAQ,EAAE,aAAA,EAAe;AAC/D,QAAA,OAAA,IAAW,wBAAA;AAAA,MACb;AAEA,MAAA,MAAM,IAAI,MAAM,OAAO,CAAA;AAAA,IACzB;AAEA,IAAA,OAAO,QAAA;AAAA,EACT;AAAA,EAEA,MAAc,SAAA,CAAU,GAAA,EAAmB,IAAA,EAAiC;AAC1E,IAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,aAAA,CAAc,KAAK,IAAI,CAAA;AACnD,IAAA,OAAO,MAAM,SAAS,IAAA,EAAK;AAAA,EAC7B;AACF;;;;"}
1
+ {"version":3,"file":"GithubUrlReader.cjs.js","sources":["../../../../src/entrypoints/urlReader/lib/GithubUrlReader.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n UrlReaderService,\n UrlReaderServiceReadTreeOptions,\n UrlReaderServiceReadTreeResponse,\n UrlReaderServiceReadUrlOptions,\n UrlReaderServiceReadUrlResponse,\n UrlReaderServiceSearchOptions,\n UrlReaderServiceSearchResponse,\n UrlReaderServiceSearchResponseFile,\n} from '@backstage/backend-plugin-api';\nimport {\n getGithubFileFetchUrl,\n DefaultGithubCredentialsProvider,\n GithubCredentialsProvider,\n GithubIntegration,\n ScmIntegrations,\n GithubCredentials,\n} from '@backstage/integration';\nimport { RestEndpointMethodTypes } from '@octokit/rest';\nimport fetch, { RequestInit, Response } from 'node-fetch';\nimport parseGitUrl from 'git-url-parse';\nimport { Minimatch } from 'minimatch';\nimport { Readable } from 'node:stream';\nimport { toError, NotFoundError, NotModifiedError } from '@backstage/errors';\nimport { ReadTreeResponseFactory, ReaderFactory } from './types';\nimport { ReadUrlResponseFactory } from './ReadUrlResponseFactory';\nimport { parseLastModified } from './util';\nimport isGlob from 'is-glob';\n\nexport type GhRepoResponse =\n RestEndpointMethodTypes['repos']['get']['response']['data'];\nexport type GhCombinedCommitStatusResponse =\n RestEndpointMethodTypes['repos']['getCombinedStatusForRef']['response']['data'];\nexport type GhTreeResponse =\n RestEndpointMethodTypes['git']['getTree']['response']['data'];\nexport type GhBlobResponse =\n RestEndpointMethodTypes['git']['getBlob']['response']['data'];\n\n/**\n * Implements a {@link @backstage/backend-plugin-api#UrlReaderService} for files through the GitHub v3 APIs, such as\n * the one exposed by GitHub itself.\n *\n * @public\n */\nexport class GithubUrlReader implements UrlReaderService {\n static factory: ReaderFactory = ({ config, treeResponseFactory }) => {\n const integrations = ScmIntegrations.fromConfig(config);\n const credentialsProvider =\n DefaultGithubCredentialsProvider.fromIntegrations(integrations);\n return integrations.github.list().map(integration => {\n const reader = new GithubUrlReader(integration, {\n treeResponseFactory,\n credentialsProvider,\n });\n const predicate = (url: URL) => url.host === integration.config.host;\n return { reader, predicate };\n });\n };\n\n private readonly integration: GithubIntegration;\n private readonly deps: {\n treeResponseFactory: ReadTreeResponseFactory;\n credentialsProvider: GithubCredentialsProvider;\n };\n\n constructor(\n integration: GithubIntegration,\n deps: {\n treeResponseFactory: ReadTreeResponseFactory;\n credentialsProvider: GithubCredentialsProvider;\n },\n ) {\n this.integration = integration;\n this.deps = deps;\n if (!integration.config.apiBaseUrl && !integration.config.rawBaseUrl) {\n throw new Error(\n `GitHub integration '${integration.title}' must configure an explicit apiBaseUrl or rawBaseUrl`,\n );\n }\n }\n\n async read(url: string): Promise<Buffer> {\n const response = await this.readUrl(url);\n return response.buffer();\n }\n\n private getCredentials = async (\n url: string,\n options?: { token?: string },\n ): Promise<GithubCredentials> => {\n if (options?.token) {\n return {\n headers: {\n Authorization: `Bearer ${options.token}`,\n },\n type: 'token',\n token: options.token,\n };\n }\n\n return await this.deps.credentialsProvider.getCredentials({\n url,\n });\n };\n\n async readUrl(\n url: string,\n options?: UrlReaderServiceReadUrlOptions,\n ): Promise<UrlReaderServiceReadUrlResponse> {\n const credentials = await this.getCredentials(url, options);\n\n const ghUrl = getGithubFileFetchUrl(\n url,\n this.integration.config,\n credentials,\n );\n\n const response = await this.fetchResponse(ghUrl, {\n headers: {\n ...credentials?.headers,\n ...(options?.etag && { 'If-None-Match': options.etag }),\n ...(options?.lastModifiedAfter && {\n 'If-Modified-Since': options.lastModifiedAfter.toUTCString(),\n }),\n Accept: 'application/vnd.github.v3.raw',\n },\n // TODO(freben): The signal cast is there because pre-3.x versions of\n // node-fetch have a very slightly deviating AbortSignal type signature.\n // The difference does not affect us in practice however. The cast can\n // be removed after we support ESM for CLI dependencies and migrate to\n // version 3 of node-fetch.\n // https://github.com/backstage/backstage/issues/8242\n signal: options?.signal as any,\n });\n\n return ReadUrlResponseFactory.fromNodeJSReadable(response.body, {\n etag: response.headers.get('ETag') ?? undefined,\n lastModifiedAt: parseLastModified(response.headers.get('Last-Modified')),\n });\n }\n\n async readTree(\n url: string,\n options?: UrlReaderServiceReadTreeOptions,\n ): Promise<UrlReaderServiceReadTreeResponse> {\n const repoDetails = await this.getRepoDetails(url, options);\n const commitSha = repoDetails.commitSha;\n\n if (options?.etag && options.etag === commitSha) {\n throw new NotModifiedError();\n }\n\n const { filepath } = parseGitUrl(url);\n const { headers } = await this.getCredentials(url, options);\n\n return this.doReadTree(\n repoDetails.repo.archive_url,\n commitSha,\n filepath,\n // TODO(freben): The signal cast is there because pre-3.x versions of\n // node-fetch have a very slightly deviating AbortSignal type signature.\n // The difference does not affect us in practice however. The cast can be\n // removed after we support ESM for CLI dependencies and migrate to\n // version 3 of node-fetch.\n // https://github.com/backstage/backstage/issues/8242\n { headers, signal: options?.signal as any },\n options,\n );\n }\n\n async search(\n url: string,\n options?: UrlReaderServiceSearchOptions,\n ): Promise<UrlReaderServiceSearchResponse> {\n const { filepath } = parseGitUrl(url);\n\n // If it's a direct URL we use readUrl instead\n if (!isGlob(filepath)) {\n try {\n const data = await this.readUrl(url, options);\n\n return {\n files: [\n {\n url: url,\n content: data.buffer,\n lastModifiedAt: data.lastModifiedAt,\n },\n ],\n etag: data.etag ?? '',\n };\n } catch (e) {\n const error = toError(e);\n if (error.name === 'NotFoundError') {\n return {\n files: [],\n etag: '',\n };\n }\n throw error;\n }\n }\n\n const repoDetails = await this.getRepoDetails(url, options);\n const commitSha = repoDetails.commitSha;\n\n if (options?.etag && options.etag === commitSha) {\n throw new NotModifiedError();\n }\n\n const { headers } = await this.getCredentials(url, options);\n\n const files = await this.doSearch(\n url,\n repoDetails.repo.trees_url,\n repoDetails.repo.archive_url,\n commitSha,\n filepath,\n { headers, signal: options?.signal as any },\n );\n\n return { files, etag: commitSha };\n }\n\n toString() {\n const { host, token } = this.integration.config;\n return `github{host=${host},authed=${Boolean(token)}}`;\n }\n\n private async doReadTree(\n archiveUrl: string,\n sha: string,\n subpath: string,\n init: RequestInit,\n options?: UrlReaderServiceReadTreeOptions,\n ): Promise<UrlReaderServiceReadTreeResponse> {\n // archive_url looks like \"https://api.github.com/repos/owner/repo/{archive_format}{/ref}\"\n const archive = await this.fetchResponse(\n archiveUrl\n .replace('{archive_format}', 'tarball')\n .replace('{/ref}', `/${sha}`),\n init,\n );\n\n return await this.deps.treeResponseFactory.fromTarArchive({\n // TODO(Rugvip): Underlying implementation of fetch will be node-fetch, we probably want\n // to stick to using that in exclusively backend code.\n stream: Readable.from(archive.body),\n subpath,\n etag: sha,\n filter: options?.filter,\n });\n }\n\n private async doSearch(\n url: string,\n treesUrl: string,\n archiveUrl: string,\n sha: string,\n query: string,\n init: RequestInit,\n ): Promise<UrlReaderServiceSearchResponseFile[]> {\n function pathToUrl(path: string): string {\n // TODO(freben): Use the integration package facility for this instead\n // pathname starts as /backstage/backstage/blob/master/<path>\n const updated = new URL(url);\n const base = updated.pathname.split('/').slice(1, 5).join('/');\n updated.pathname = `${base}/${path}`;\n return updated.toString();\n }\n\n const matcher = new Minimatch(query.replace(/^\\/+/, ''));\n\n // trees_url looks like \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"\n const recursiveTree: GhTreeResponse = await this.fetchJson(\n treesUrl.replace('{/sha}', `/${sha}?recursive=true`),\n init,\n );\n\n // The simple case is that we got the entire tree in a single operation.\n if (!recursiveTree.truncated) {\n const matching = recursiveTree.tree.filter(\n item =>\n item.type === 'blob' &&\n item.path &&\n item.url &&\n matcher.match(item.path),\n );\n\n return matching.map(item => ({\n url: pathToUrl(item.path!),\n content: async () => {\n const blob: GhBlobResponse = await this.fetchJson(item.url!, init);\n return Buffer.from(blob.content, 'base64');\n },\n }));\n }\n\n // For larger repos, we leverage readTree and filter through that instead\n const tree = await this.doReadTree(archiveUrl, sha, '', init, {\n filter: path => matcher.match(path),\n });\n const files = await tree.files();\n\n return files.map(file => ({\n url: pathToUrl(file.path),\n content: file.content,\n lastModifiedAt: file.lastModifiedAt,\n }));\n }\n\n private async getRepoDetails(\n url: string,\n options?: { token?: string },\n ): Promise<{\n commitSha: string;\n repo: {\n archive_url: string;\n trees_url: string;\n };\n }> {\n const parsed = parseGitUrl(url);\n const { ref, full_name } = parsed;\n\n const credentials = await this.getCredentials(url, options);\n const { headers } = credentials;\n\n const commitStatus: GhCombinedCommitStatusResponse = await this.fetchJson(\n `${this.integration.config.apiBaseUrl}/repos/${full_name}/commits/${\n ref || (await this.getDefaultBranch(full_name, credentials))\n }/status?per_page=0`,\n { headers },\n );\n\n return {\n commitSha: commitStatus.sha,\n repo: commitStatus.repository,\n };\n }\n\n private async getDefaultBranch(\n repoFullName: string,\n credentials: GithubCredentials,\n ): Promise<string> {\n const repo: GhRepoResponse = await this.fetchJson(\n `${this.integration.config.apiBaseUrl}/repos/${repoFullName}`,\n { headers: credentials.headers },\n );\n\n return repo.default_branch;\n }\n\n private async fetchResponse(\n url: string | URL,\n init: RequestInit,\n ): Promise<Response> {\n const urlAsString = url.toString();\n const response = await fetch(urlAsString, init);\n\n if (!response.ok) {\n let message = `Request failed for ${urlAsString}, ${response.status} ${response.statusText}`;\n\n if (response.status === 304) {\n throw new NotModifiedError();\n }\n\n if (response.status === 404) {\n throw new NotFoundError(message);\n }\n\n // GitHub returns a 403 response with a couple of headers indicating rate\n // limit status. See more in the GitHub docs:\n // https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting\n if (this.integration.parseRateLimitInfo(response).isRateLimited) {\n message += ' (rate limit exceeded)';\n }\n\n throw new Error(message);\n }\n\n return response;\n }\n\n private async fetchJson(url: string | URL, init: RequestInit): Promise<any> {\n const response = await this.fetchResponse(url, init);\n return await response.json();\n }\n}\n"],"names":["ScmIntegrations","DefaultGithubCredentialsProvider","getGithubFileFetchUrl","ReadUrlResponseFactory","parseLastModified","NotModifiedError","parseGitUrl","isGlob","toError","Readable","Minimatch","fetch","NotFoundError"],"mappings":";;;;;;;;;;;;;;;;;;AA4DO,MAAM,eAAA,CAA4C;AAAA,EACvD,OAAO,OAAA,GAAyB,CAAC,EAAE,MAAA,EAAQ,qBAAoB,KAAM;AACnE,IAAA,MAAM,YAAA,GAAeA,2BAAA,CAAgB,UAAA,CAAW,MAAM,CAAA;AACtD,IAAA,MAAM,mBAAA,GACJC,4CAAA,CAAiC,gBAAA,CAAiB,YAAY,CAAA;AAChE,IAAA,OAAO,YAAA,CAAa,MAAA,CAAO,IAAA,EAAK,CAAE,IAAI,CAAA,WAAA,KAAe;AACnD,MAAA,MAAM,MAAA,GAAS,IAAI,eAAA,CAAgB,WAAA,EAAa;AAAA,QAC9C,mBAAA;AAAA,QACA;AAAA,OACD,CAAA;AACD,MAAA,MAAM,YAAY,CAAC,GAAA,KAAa,GAAA,CAAI,IAAA,KAAS,YAAY,MAAA,CAAO,IAAA;AAChE,MAAA,OAAO,EAAE,QAAQ,SAAA,EAAU;AAAA,IAC7B,CAAC,CAAA;AAAA,EACH,CAAA;AAAA,EAEiB,WAAA;AAAA,EACA,IAAA;AAAA,EAKjB,WAAA,CACE,aACA,IAAA,EAIA;AACA,IAAA,IAAA,CAAK,WAAA,GAAc,WAAA;AACnB,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;AACZ,IAAA,IAAI,CAAC,WAAA,CAAY,MAAA,CAAO,cAAc,CAAC,WAAA,CAAY,OAAO,UAAA,EAAY;AACpE,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,oBAAA,EAAuB,YAAY,KAAK,CAAA,qDAAA;AAAA,OAC1C;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAM,KAAK,GAAA,EAA8B;AACvC,IAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,OAAA,CAAQ,GAAG,CAAA;AACvC,IAAA,OAAO,SAAS,MAAA,EAAO;AAAA,EACzB;AAAA,EAEQ,cAAA,GAAiB,OACvB,GAAA,EACA,OAAA,KAC+B;AAC/B,IAAA,IAAI,SAAS,KAAA,EAAO;AAClB,MAAA,OAAO;AAAA,QACL,OAAA,EAAS;AAAA,UACP,aAAA,EAAe,CAAA,OAAA,EAAU,OAAA,CAAQ,KAAK,CAAA;AAAA,SACxC;AAAA,QACA,IAAA,EAAM,OAAA;AAAA,QACN,OAAO,OAAA,CAAQ;AAAA,OACjB;AAAA,IACF;AAEA,IAAA,OAAO,MAAM,IAAA,CAAK,IAAA,CAAK,mBAAA,CAAoB,cAAA,CAAe;AAAA,MACxD;AAAA,KACD,CAAA;AAAA,EACH,CAAA;AAAA,EAEA,MAAM,OAAA,CACJ,GAAA,EACA,OAAA,EAC0C;AAC1C,IAAA,MAAM,WAAA,GAAc,MAAM,IAAA,CAAK,cAAA,CAAe,KAAK,OAAO,CAAA;AAE1D,IAAA,MAAM,KAAA,GAAQC,iCAAA;AAAA,MACZ,GAAA;AAAA,MACA,KAAK,WAAA,CAAY,MAAA;AAAA,MACjB;AAAA,KACF;AAEA,IAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,aAAA,CAAc,KAAA,EAAO;AAAA,MAC/C,OAAA,EAAS;AAAA,QACP,GAAG,WAAA,EAAa,OAAA;AAAA,QAChB,GAAI,OAAA,EAAS,IAAA,IAAQ,EAAE,eAAA,EAAiB,QAAQ,IAAA,EAAK;AAAA,QACrD,GAAI,SAAS,iBAAA,IAAqB;AAAA,UAChC,mBAAA,EAAqB,OAAA,CAAQ,iBAAA,CAAkB,WAAA;AAAY,SAC7D;AAAA,QACA,MAAA,EAAQ;AAAA,OACV;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAOA,QAAQ,OAAA,EAAS;AAAA,KAClB,CAAA;AAED,IAAA,OAAOC,6CAAA,CAAuB,kBAAA,CAAmB,QAAA,CAAS,IAAA,EAAM;AAAA,MAC9D,IAAA,EAAM,QAAA,CAAS,OAAA,CAAQ,GAAA,CAAI,MAAM,CAAA,IAAK,MAAA;AAAA,MACtC,gBAAgBC,sBAAA,CAAkB,QAAA,CAAS,OAAA,CAAQ,GAAA,CAAI,eAAe,CAAC;AAAA,KACxE,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,QAAA,CACJ,GAAA,EACA,OAAA,EAC2C;AAC3C,IAAA,MAAM,WAAA,GAAc,MAAM,IAAA,CAAK,cAAA,CAAe,KAAK,OAAO,CAAA;AAC1D,IAAA,MAAM,YAAY,WAAA,CAAY,SAAA;AAE9B,IAAA,IAAI,OAAA,EAAS,IAAA,IAAQ,OAAA,CAAQ,IAAA,KAAS,SAAA,EAAW;AAC/C,MAAA,MAAM,IAAIC,uBAAA,EAAiB;AAAA,IAC7B;AAEA,IAAA,MAAM,EAAE,QAAA,EAAS,GAAIC,4BAAA,CAAY,GAAG,CAAA;AACpC,IAAA,MAAM,EAAE,OAAA,EAAQ,GAAI,MAAM,IAAA,CAAK,cAAA,CAAe,KAAK,OAAO,CAAA;AAE1D,IAAA,OAAO,IAAA,CAAK,UAAA;AAAA,MACV,YAAY,IAAA,CAAK,WAAA;AAAA,MACjB,SAAA;AAAA,MACA,QAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAOA,EAAE,OAAA,EAAS,MAAA,EAAQ,OAAA,EAAS,MAAA,EAAc;AAAA,MAC1C;AAAA,KACF;AAAA,EACF;AAAA,EAEA,MAAM,MAAA,CACJ,GAAA,EACA,OAAA,EACyC;AACzC,IAAA,MAAM,EAAE,QAAA,EAAS,GAAIA,4BAAA,CAAY,GAAG,CAAA;AAGpC,IAAA,IAAI,CAACC,uBAAA,CAAO,QAAQ,CAAA,EAAG;AACrB,MAAA,IAAI;AACF,QAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,OAAA,CAAQ,KAAK,OAAO,CAAA;AAE5C,QAAA,OAAO;AAAA,UACL,KAAA,EAAO;AAAA,YACL;AAAA,cACE,GAAA;AAAA,cACA,SAAS,IAAA,CAAK,MAAA;AAAA,cACd,gBAAgB,IAAA,CAAK;AAAA;AACvB,WACF;AAAA,UACA,IAAA,EAAM,KAAK,IAAA,IAAQ;AAAA,SACrB;AAAA,MACF,SAAS,CAAA,EAAG;AACV,QAAA,MAAM,KAAA,GAAQC,eAAQ,CAAC,CAAA;AACvB,QAAA,IAAI,KAAA,CAAM,SAAS,eAAA,EAAiB;AAClC,UAAA,OAAO;AAAA,YACL,OAAO,EAAC;AAAA,YACR,IAAA,EAAM;AAAA,WACR;AAAA,QACF;AACA,QAAA,MAAM,KAAA;AAAA,MACR;AAAA,IACF;AAEA,IAAA,MAAM,WAAA,GAAc,MAAM,IAAA,CAAK,cAAA,CAAe,KAAK,OAAO,CAAA;AAC1D,IAAA,MAAM,YAAY,WAAA,CAAY,SAAA;AAE9B,IAAA,IAAI,OAAA,EAAS,IAAA,IAAQ,OAAA,CAAQ,IAAA,KAAS,SAAA,EAAW;AAC/C,MAAA,MAAM,IAAIH,uBAAA,EAAiB;AAAA,IAC7B;AAEA,IAAA,MAAM,EAAE,OAAA,EAAQ,GAAI,MAAM,IAAA,CAAK,cAAA,CAAe,KAAK,OAAO,CAAA;AAE1D,IAAA,MAAM,KAAA,GAAQ,MAAM,IAAA,CAAK,QAAA;AAAA,MACvB,GAAA;AAAA,MACA,YAAY,IAAA,CAAK,SAAA;AAAA,MACjB,YAAY,IAAA,CAAK,WAAA;AAAA,MACjB,SAAA;AAAA,MACA,QAAA;AAAA,MACA,EAAE,OAAA,EAAS,MAAA,EAAQ,OAAA,EAAS,MAAA;AAAc,KAC5C;AAEA,IAAA,OAAO,EAAE,KAAA,EAAO,IAAA,EAAM,SAAA,EAAU;AAAA,EAClC;AAAA,EAEA,QAAA,GAAW;AACT,IAAA,MAAM,EAAE,IAAA,EAAM,KAAA,EAAM,GAAI,KAAK,WAAA,CAAY,MAAA;AACzC,IAAA,OAAO,CAAA,YAAA,EAAe,IAAI,CAAA,QAAA,EAAW,OAAA,CAAQ,KAAK,CAAC,CAAA,CAAA,CAAA;AAAA,EACrD;AAAA,EAEA,MAAc,UAAA,CACZ,UAAA,EACA,GAAA,EACA,OAAA,EACA,MACA,OAAA,EAC2C;AAE3C,IAAA,MAAM,OAAA,GAAU,MAAM,IAAA,CAAK,aAAA;AAAA,MACzB,UAAA,CACG,QAAQ,kBAAA,EAAoB,SAAS,EACrC,OAAA,CAAQ,QAAA,EAAU,CAAA,CAAA,EAAI,GAAG,CAAA,CAAE,CAAA;AAAA,MAC9B;AAAA,KACF;AAEA,IAAA,OAAO,MAAM,IAAA,CAAK,IAAA,CAAK,mBAAA,CAAoB,cAAA,CAAe;AAAA;AAAA;AAAA,MAGxD,MAAA,EAAQI,oBAAA,CAAS,IAAA,CAAK,OAAA,CAAQ,IAAI,CAAA;AAAA,MAClC,OAAA;AAAA,MACA,IAAA,EAAM,GAAA;AAAA,MACN,QAAQ,OAAA,EAAS;AAAA,KAClB,CAAA;AAAA,EACH;AAAA,EAEA,MAAc,QAAA,CACZ,GAAA,EACA,UACA,UAAA,EACA,GAAA,EACA,OACA,IAAA,EAC+C;AAC/C,IAAA,SAAS,UAAU,IAAA,EAAsB;AAGvC,MAAA,MAAM,OAAA,GAAU,IAAI,GAAA,CAAI,GAAG,CAAA;AAC3B,MAAA,MAAM,IAAA,GAAO,OAAA,CAAQ,QAAA,CAAS,KAAA,CAAM,GAAG,CAAA,CAAE,KAAA,CAAM,CAAA,EAAG,CAAC,CAAA,CAAE,IAAA,CAAK,GAAG,CAAA;AAC7D,MAAA,OAAA,CAAQ,QAAA,GAAW,CAAA,EAAG,IAAI,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA;AAClC,MAAA,OAAO,QAAQ,QAAA,EAAS;AAAA,IAC1B;AAEA,IAAA,MAAM,UAAU,IAAIC,mBAAA,CAAU,MAAM,OAAA,CAAQ,MAAA,EAAQ,EAAE,CAAC,CAAA;AAGvD,IAAA,MAAM,aAAA,GAAgC,MAAM,IAAA,CAAK,SAAA;AAAA,MAC/C,QAAA,CAAS,OAAA,CAAQ,QAAA,EAAU,CAAA,CAAA,EAAI,GAAG,CAAA,eAAA,CAAiB,CAAA;AAAA,MACnD;AAAA,KACF;AAGA,IAAA,IAAI,CAAC,cAAc,SAAA,EAAW;AAC5B,MAAA,MAAM,QAAA,GAAW,cAAc,IAAA,CAAK,MAAA;AAAA,QAClC,CAAA,IAAA,KACE,IAAA,CAAK,IAAA,KAAS,MAAA,IACd,IAAA,CAAK,IAAA,IACL,IAAA,CAAK,GAAA,IACL,OAAA,CAAQ,KAAA,CAAM,IAAA,CAAK,IAAI;AAAA,OAC3B;AAEA,MAAA,OAAO,QAAA,CAAS,IAAI,CAAA,IAAA,MAAS;AAAA,QAC3B,GAAA,EAAK,SAAA,CAAU,IAAA,CAAK,IAAK,CAAA;AAAA,QACzB,SAAS,YAAY;AACnB,UAAA,MAAM,OAAuB,MAAM,IAAA,CAAK,SAAA,CAAU,IAAA,CAAK,KAAM,IAAI,CAAA;AACjE,UAAA,OAAO,MAAA,CAAO,IAAA,CAAK,IAAA,CAAK,OAAA,EAAS,QAAQ,CAAA;AAAA,QAC3C;AAAA,OACF,CAAE,CAAA;AAAA,IACJ;AAGA,IAAA,MAAM,OAAO,MAAM,IAAA,CAAK,WAAW,UAAA,EAAY,GAAA,EAAK,IAAI,IAAA,EAAM;AAAA,MAC5D,MAAA,EAAQ,CAAA,IAAA,KAAQ,OAAA,CAAQ,KAAA,CAAM,IAAI;AAAA,KACnC,CAAA;AACD,IAAA,MAAM,KAAA,GAAQ,MAAM,IAAA,CAAK,KAAA,EAAM;AAE/B,IAAA,OAAO,KAAA,CAAM,IAAI,CAAA,IAAA,MAAS;AAAA,MACxB,GAAA,EAAK,SAAA,CAAU,IAAA,CAAK,IAAI,CAAA;AAAA,MACxB,SAAS,IAAA,CAAK,OAAA;AAAA,MACd,gBAAgB,IAAA,CAAK;AAAA,KACvB,CAAE,CAAA;AAAA,EACJ;AAAA,EAEA,MAAc,cAAA,CACZ,GAAA,EACA,OAAA,EAOC;AACD,IAAA,MAAM,MAAA,GAASJ,6BAAY,GAAG,CAAA;AAC9B,IAAA,MAAM,EAAE,GAAA,EAAK,SAAA,EAAU,GAAI,MAAA;AAE3B,IAAA,MAAM,WAAA,GAAc,MAAM,IAAA,CAAK,cAAA,CAAe,KAAK,OAAO,CAAA;AAC1D,IAAA,MAAM,EAAE,SAAQ,GAAI,WAAA;AAEpB,IAAA,MAAM,YAAA,GAA+C,MAAM,IAAA,CAAK,SAAA;AAAA,MAC9D,CAAA,EAAG,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,UAAU,CAAA,OAAA,EAAU,SAAS,CAAA,SAAA,EACtD,GAAA,IAAQ,MAAM,IAAA,CAAK,gBAAA,CAAiB,SAAA,EAAW,WAAW,CAC5D,CAAA,kBAAA,CAAA;AAAA,MACA,EAAE,OAAA;AAAQ,KACZ;AAEA,IAAA,OAAO;AAAA,MACL,WAAW,YAAA,CAAa,GAAA;AAAA,MACxB,MAAM,YAAA,CAAa;AAAA,KACrB;AAAA,EACF;AAAA,EAEA,MAAc,gBAAA,CACZ,YAAA,EACA,WAAA,EACiB;AACjB,IAAA,MAAM,IAAA,GAAuB,MAAM,IAAA,CAAK,SAAA;AAAA,MACtC,GAAG,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,UAAU,UAAU,YAAY,CAAA,CAAA;AAAA,MAC3D,EAAE,OAAA,EAAS,WAAA,CAAY,OAAA;AAAQ,KACjC;AAEA,IAAA,OAAO,IAAA,CAAK,cAAA;AAAA,EACd;AAAA,EAEA,MAAc,aAAA,CACZ,GAAA,EACA,IAAA,EACmB;AACnB,IAAA,MAAM,WAAA,GAAc,IAAI,QAAA,EAAS;AACjC,IAAA,MAAM,QAAA,GAAW,MAAMK,sBAAA,CAAM,WAAA,EAAa,IAAI,CAAA;AAE9C,IAAA,IAAI,CAAC,SAAS,EAAA,EAAI;AAChB,MAAA,IAAI,OAAA,GAAU,sBAAsB,WAAW,CAAA,EAAA,EAAK,SAAS,MAAM,CAAA,CAAA,EAAI,SAAS,UAAU,CAAA,CAAA;AAE1F,MAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,QAAA,MAAM,IAAIN,uBAAA,EAAiB;AAAA,MAC7B;AAEA,MAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,QAAA,MAAM,IAAIO,qBAAc,OAAO,CAAA;AAAA,MACjC;AAKA,MAAA,IAAI,IAAA,CAAK,WAAA,CAAY,kBAAA,CAAmB,QAAQ,EAAE,aAAA,EAAe;AAC/D,QAAA,OAAA,IAAW,wBAAA;AAAA,MACb;AAEA,MAAA,MAAM,IAAI,MAAM,OAAO,CAAA;AAAA,IACzB;AAEA,IAAA,OAAO,QAAA;AAAA,EACT;AAAA,EAEA,MAAc,SAAA,CAAU,GAAA,EAAmB,IAAA,EAAiC;AAC1E,IAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,aAAA,CAAc,KAAK,IAAI,CAAA;AACnD,IAAA,OAAO,MAAM,SAAS,IAAA,EAAK;AAAA,EAC7B;AACF;;"}
@@ -1 +1 @@
1
- {"version":3,"file":"GitlabUrlReader.cjs.js","sources":["../../../../src/entrypoints/urlReader/lib/GitlabUrlReader.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n UrlReaderService,\n UrlReaderServiceReadTreeOptions,\n UrlReaderServiceReadTreeResponse,\n UrlReaderServiceReadUrlOptions,\n UrlReaderServiceReadUrlResponse,\n UrlReaderServiceSearchOptions,\n UrlReaderServiceSearchResponse,\n} from '@backstage/backend-plugin-api';\nimport { toError, NotFoundError, NotModifiedError } from '@backstage/errors';\nimport {\n getGitLabFileFetchUrl,\n getGitLabIntegrationRelativePath,\n getGitLabRequestOptions,\n GitLabIntegration,\n ScmIntegrations,\n} from '@backstage/integration';\nimport parseGitUrl from 'git-url-parse';\nimport { trimEnd } from 'lodash';\nimport { Minimatch } from 'minimatch';\nimport { ReadUrlResponseFactory } from './ReadUrlResponseFactory';\nimport { ReaderFactory, ReadTreeResponseFactory } from './types';\n\n/**\n * Implements a {@link @backstage/backend-plugin-api#UrlReaderService} for files on GitLab.\n *\n * @public\n */\nexport class GitlabUrlReader implements UrlReaderService {\n static factory: ReaderFactory = ({ config, treeResponseFactory }) => {\n const integrations = ScmIntegrations.fromConfig(config);\n return integrations.gitlab.list().map(integration => {\n const reader = new GitlabUrlReader(integration, {\n treeResponseFactory,\n });\n const predicate = (url: URL) => url.host === integration.config.host;\n return { reader, predicate };\n });\n };\n\n private readonly integration: GitLabIntegration;\n private readonly deps: { treeResponseFactory: ReadTreeResponseFactory };\n\n constructor(\n integration: GitLabIntegration,\n deps: { treeResponseFactory: ReadTreeResponseFactory },\n ) {\n this.integration = integration;\n this.deps = deps;\n }\n\n async read(url: string): Promise<Buffer> {\n const response = await this.readUrl(url);\n return response.buffer();\n }\n\n async readUrl(\n url: string,\n options?: UrlReaderServiceReadUrlOptions,\n ): Promise<UrlReaderServiceReadUrlResponse> {\n const { etag, lastModifiedAfter, signal, token } = options ?? {};\n const isArtifact = url.includes('/-/jobs/artifacts/');\n const builtUrl = await this.getGitlabFetchUrl(url, token);\n\n let response: Response;\n try {\n response = await this.integration.fetch(builtUrl, {\n headers: {\n ...getGitLabRequestOptions(this.integration.config, token).headers,\n ...(etag && !isArtifact && { 'If-None-Match': etag }),\n ...(lastModifiedAfter &&\n !isArtifact && {\n 'If-Modified-Since': lastModifiedAfter.toUTCString(),\n }),\n },\n // TODO(freben): The signal cast is there because pre-3.x versions of\n // node-fetch have a very slightly deviating AbortSignal type signature.\n // The difference does not affect us in practice however. The cast can be\n // removed after we support ESM for CLI dependencies and migrate to\n // version 3 of node-fetch.\n // https://github.com/backstage/backstage/issues/8242\n ...(signal && { signal: signal as any }),\n });\n } catch (e) {\n throw new Error(`Unable to read ${url}, ${e}`);\n }\n\n if (response.status === 304) {\n throw new NotModifiedError();\n }\n\n if (response.ok) {\n return ReadUrlResponseFactory.fromResponse(response);\n }\n\n const message = `${url} could not be read as ${builtUrl}, ${response.status} ${response.statusText}`;\n if (response.status === 404) {\n throw new NotFoundError(message);\n }\n throw new Error(message);\n }\n\n async readTree(\n url: string,\n options?: UrlReaderServiceReadTreeOptions,\n ): Promise<UrlReaderServiceReadTreeResponse> {\n const { etag, signal, token } = options ?? {};\n const { ref, full_name, filepath } = parseGitUrl(url);\n\n const repoFullName = this.validateAndStripGitLabRelativePath(\n `/${full_name}`,\n );\n\n // Use GitLab API to get the default branch\n // encodeURIComponent is required for GitLab API\n // https://docs.gitlab.com/ee/api/README.html#namespaced-path-encoding\n const projectGitlabResponse = await this.integration.fetch(\n new URL(\n `${this.integration.config.apiBaseUrl}/projects/${encodeURIComponent(\n repoFullName,\n )}`,\n ).toString(),\n getGitLabRequestOptions(this.integration.config, token),\n );\n if (!projectGitlabResponse.ok) {\n const msg = `Failed to read tree from ${url}, ${projectGitlabResponse.status} ${projectGitlabResponse.statusText}`;\n if (projectGitlabResponse.status === 404) {\n throw new NotFoundError(msg);\n }\n throw new Error(msg);\n }\n const projectGitlabResponseJson = await projectGitlabResponse.json();\n\n // ref is an empty string if no branch is set in provided url to readTree.\n const branch = ref || projectGitlabResponseJson.default_branch;\n\n // Fetch the latest commit that modifies the filepath in the provided or default branch\n // to compare against the provided sha.\n const commitsReqParams = new URLSearchParams();\n commitsReqParams.set('ref_name', branch);\n if (!!filepath) {\n commitsReqParams.set('path', filepath);\n }\n const commitsGitlabResponse = await this.integration.fetch(\n new URL(\n `${this.integration.config.apiBaseUrl}/projects/${encodeURIComponent(\n repoFullName,\n )}/repository/commits?${commitsReqParams.toString()}`,\n ).toString(),\n {\n ...getGitLabRequestOptions(this.integration.config, token),\n // TODO(freben): The signal cast is there because pre-3.x versions of\n // node-fetch have a very slightly deviating AbortSignal type signature.\n // The difference does not affect us in practice however. The cast can\n // be removed after we support ESM for CLI dependencies and migrate to\n // version 3 of node-fetch.\n // https://github.com/backstage/backstage/issues/8242\n ...(signal && { signal: signal as any }),\n },\n );\n if (!commitsGitlabResponse.ok) {\n const message = `Failed to read tree (branch) from ${url}, ${commitsGitlabResponse.status} ${commitsGitlabResponse.statusText}`;\n if (commitsGitlabResponse.status === 404) {\n throw new NotFoundError(message);\n }\n throw new Error(message);\n }\n\n const commitSha = (await commitsGitlabResponse.json())[0]?.id ?? '';\n if (etag && etag === commitSha) {\n throw new NotModifiedError();\n }\n\n const archiveReqParams = new URLSearchParams();\n archiveReqParams.set('sha', branch);\n if (!!filepath) {\n archiveReqParams.set('path', filepath);\n }\n // https://docs.gitlab.com/ee/api/repositories.html#get-file-archive\n const reqUrl = `${\n this.integration.config.apiBaseUrl\n }/projects/${encodeURIComponent(\n repoFullName,\n )}/repository/archive?${archiveReqParams.toString()}`;\n const archiveGitLabResponse = await this.integration.fetch(reqUrl, {\n ...getGitLabRequestOptions(this.integration.config, token),\n // The mode is set to 'same-origin' to overwrite the default 'cors' value.\n // The repository/archive endpoint marks mode='cors' as a \"hotlink\" which will return 406 - Not Acceptable as a response\n // More info on this issue can be found @ https://github.com/backstage/backstage/issues/34395\n mode: 'same-origin',\n // TODO(freben): The signal cast is there because pre-3.x versions of\n // node-fetch have a very slightly deviating AbortSignal type signature.\n // The difference does not affect us in practice however. The cast can\n // be removed after we support ESM for CLI dependencies and migrate to\n // version 3 of node-fetch.\n // https://github.com/backstage/backstage/issues/8242\n ...(signal && { signal: signal as any }),\n });\n if (!archiveGitLabResponse.ok) {\n const message = `Failed to read tree (archive) from ${url}, ${reqUrl}, ${archiveGitLabResponse.status} ${archiveGitLabResponse.statusText}`;\n if (archiveGitLabResponse.status === 404) {\n throw new NotFoundError(message);\n }\n throw new Error(message);\n }\n\n return await this.deps.treeResponseFactory.fromTarArchive({\n response: archiveGitLabResponse,\n subpath: filepath,\n etag: commitSha,\n filter: options?.filter,\n });\n }\n\n async search(\n url: string,\n options?: UrlReaderServiceSearchOptions,\n ): Promise<UrlReaderServiceSearchResponse> {\n const { filepath } = parseGitUrl(url);\n\n // If it's a direct URL we use readUrl instead\n if (!filepath?.match(/[*?]/)) {\n try {\n const data = await this.readUrl(url, options);\n\n return {\n files: [\n {\n url: url,\n content: data.buffer,\n lastModifiedAt: data.lastModifiedAt,\n },\n ],\n etag: data.etag ?? '',\n };\n } catch (e) {\n const error = toError(e);\n if (error.name === 'NotFoundError') {\n return {\n files: [],\n etag: '',\n };\n }\n throw error;\n }\n }\n\n const staticPart = this.getStaticPart(filepath);\n const matcher = new Minimatch(filepath);\n const treeUrl = trimEnd(url.replace(filepath, staticPart), `/`);\n const pathPrefix = staticPart ? `${staticPart}/` : '';\n const tree = await this.readTree(treeUrl, {\n etag: options?.etag,\n signal: options?.signal,\n filter: path => matcher.match(`${pathPrefix}${path}`),\n });\n\n const files = await tree.files();\n return {\n etag: tree.etag,\n files: files.map(file => ({\n url: this.integration.resolveUrl({\n url: `/${pathPrefix}${file.path}`,\n base: url,\n }),\n content: file.content,\n lastModifiedAt: file.lastModifiedAt,\n })),\n };\n }\n\n /**\n * This function splits the input globPattern string into segments using the path separator /. It then iterates over\n * the segments from the end of the array towards the beginning, checking if the concatenated string up to that\n * segment matches the original globPattern using the minimatch function. If a match is found, it continues iterating.\n * If no match is found, it returns the concatenated string up to the current segment, which is the static part of the\n * glob pattern.\n *\n * E.g. `catalog/foo/*.yaml` will return `catalog/foo`.\n *\n * @param globPattern - the glob pattern\n */\n private getStaticPart(globPattern: string) {\n const segments = globPattern.split('/');\n const globIndex = segments.findIndex(segment => segment.match(/[*?]/));\n return globIndex === -1\n ? globPattern\n : segments.slice(0, globIndex).join('/');\n }\n\n toString() {\n const { host, token } = this.integration.config;\n return `gitlab{host=${host},authed=${Boolean(token)}}`;\n }\n\n private async getGitlabFetchUrl(\n target: string,\n token?: string,\n ): Promise<string> {\n // If the target is for a job artifact then go down that path\n const targetUrl = new URL(target);\n this.validateAndStripGitLabRelativePath(targetUrl.pathname);\n if (targetUrl.pathname.includes('/-/jobs/artifacts/')) {\n return this.getGitlabArtifactFetchUrl(targetUrl).then(value =>\n value.toString(),\n );\n }\n // Default to the optimized behavior - no API call needed for file URLs\n return getGitLabFileFetchUrl(target, this.integration.config, token);\n }\n\n // convert urls of the form:\n // https://example.com/<namespace>/<project>/-/jobs/artifacts/<ref>/raw/<path_to_file>?job=<job_name>\n // to urls of the form:\n // https://example.com/api/v4/projects/namespace%2Fproject/jobs/artifacts/:ref_name/raw/*artifact_path?job=<job_name>\n private getGitlabArtifactFetchUrl(target: URL): Promise<URL> {\n if (!target.pathname.includes('/-/jobs/artifacts/')) {\n throw new Error('Unable to process url as an GitLab artifact');\n }\n try {\n const [namespaceAndProject, ref] =\n target.pathname.split('/-/jobs/artifacts/');\n\n const relativePath = getGitLabIntegrationRelativePath(\n this.integration.config,\n );\n const projectPath =\n this.validateAndStripGitLabRelativePath(namespaceAndProject);\n\n const newUrl = new URL(target);\n newUrl.pathname = `${relativePath}/api/v4/projects/${encodeURIComponent(\n projectPath,\n )}/jobs/artifacts/${ref}`;\n return Promise.resolve(newUrl);\n } catch (e) {\n throw new Error(\n `Unable to translate GitLab artifact URL: ${target}, ${e}`,\n );\n }\n }\n\n private validateAndStripGitLabRelativePath(pathname: string): string {\n const relativePath = getGitLabIntegrationRelativePath(\n this.integration.config,\n );\n if (!relativePath) {\n return pathname.replace(/^\\//, '');\n }\n\n const relativePathPrefix = `${relativePath}/`;\n if (!pathname.startsWith(relativePathPrefix)) {\n throw new Error(\n `Failed to read GitLab URL from ${pathname}. Url path must start with ${relativePathPrefix}.`,\n );\n }\n\n return pathname.slice(relativePathPrefix.length);\n }\n}\n"],"names":["ScmIntegrations","getGitLabRequestOptions","NotModifiedError","ReadUrlResponseFactory","NotFoundError","parseGitUrl","toError","Minimatch","trimEnd","getGitLabFileFetchUrl","getGitLabIntegrationRelativePath"],"mappings":";;;;;;;;;;;;;AA4CO,MAAM,eAAA,CAA4C;AAAA,EACvD,OAAO,OAAA,GAAyB,CAAC,EAAE,MAAA,EAAQ,qBAAoB,KAAM;AACnE,IAAA,MAAM,YAAA,GAAeA,2BAAA,CAAgB,UAAA,CAAW,MAAM,CAAA;AACtD,IAAA,OAAO,YAAA,CAAa,MAAA,CAAO,IAAA,EAAK,CAAE,IAAI,CAAA,WAAA,KAAe;AACnD,MAAA,MAAM,MAAA,GAAS,IAAI,eAAA,CAAgB,WAAA,EAAa;AAAA,QAC9C;AAAA,OACD,CAAA;AACD,MAAA,MAAM,YAAY,CAAC,GAAA,KAAa,GAAA,CAAI,IAAA,KAAS,YAAY,MAAA,CAAO,IAAA;AAChE,MAAA,OAAO,EAAE,QAAQ,SAAA,EAAU;AAAA,IAC7B,CAAC,CAAA;AAAA,EACH,CAAA;AAAA,EAEiB,WAAA;AAAA,EACA,IAAA;AAAA,EAEjB,WAAA,CACE,aACA,IAAA,EACA;AACA,IAAA,IAAA,CAAK,WAAA,GAAc,WAAA;AACnB,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;AAAA,EACd;AAAA,EAEA,MAAM,KAAK,GAAA,EAA8B;AACvC,IAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,OAAA,CAAQ,GAAG,CAAA;AACvC,IAAA,OAAO,SAAS,MAAA,EAAO;AAAA,EACzB;AAAA,EAEA,MAAM,OAAA,CACJ,GAAA,EACA,OAAA,EAC0C;AAC1C,IAAA,MAAM,EAAE,IAAA,EAAM,iBAAA,EAAmB,QAAQ,KAAA,EAAM,GAAI,WAAW,EAAC;AAC/D,IAAA,MAAM,UAAA,GAAa,GAAA,CAAI,QAAA,CAAS,oBAAoB,CAAA;AACpD,IAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,iBAAA,CAAkB,KAAK,KAAK,CAAA;AAExD,IAAA,IAAI,QAAA;AACJ,IAAA,IAAI;AACF,MAAA,QAAA,GAAW,MAAM,IAAA,CAAK,WAAA,CAAY,KAAA,CAAM,QAAA,EAAU;AAAA,QAChD,OAAA,EAAS;AAAA,UACP,GAAGC,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,MAAA,EAAQ,KAAK,CAAA,CAAE,OAAA;AAAA,UAC3D,GAAI,IAAA,IAAQ,CAAC,UAAA,IAAc,EAAE,iBAAiB,IAAA,EAAK;AAAA,UACnD,GAAI,iBAAA,IACF,CAAC,UAAA,IAAc;AAAA,YACb,mBAAA,EAAqB,kBAAkB,WAAA;AAAY;AACrD,SACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,QAOA,GAAI,MAAA,IAAU,EAAE,MAAA;AAAsB,OACvC,CAAA;AAAA,IACH,SAAS,CAAA,EAAG;AACV,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,eAAA,EAAkB,GAAG,CAAA,EAAA,EAAK,CAAC,CAAA,CAAE,CAAA;AAAA,IAC/C;AAEA,IAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,MAAA,MAAM,IAAIC,uBAAA,EAAiB;AAAA,IAC7B;AAEA,IAAA,IAAI,SAAS,EAAA,EAAI;AACf,MAAA,OAAOC,6CAAA,CAAuB,aAAa,QAAQ,CAAA;AAAA,IACrD;AAEA,IAAA,MAAM,OAAA,GAAU,CAAA,EAAG,GAAG,CAAA,sBAAA,EAAyB,QAAQ,KAAK,QAAA,CAAS,MAAM,CAAA,CAAA,EAAI,QAAA,CAAS,UAAU,CAAA,CAAA;AAClG,IAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,MAAA,MAAM,IAAIC,qBAAc,OAAO,CAAA;AAAA,IACjC;AACA,IAAA,MAAM,IAAI,MAAM,OAAO,CAAA;AAAA,EACzB;AAAA,EAEA,MAAM,QAAA,CACJ,GAAA,EACA,OAAA,EAC2C;AAC3C,IAAA,MAAM,EAAE,IAAA,EAAM,MAAA,EAAQ,KAAA,EAAM,GAAI,WAAW,EAAC;AAC5C,IAAA,MAAM,EAAE,GAAA,EAAK,SAAA,EAAW,QAAA,EAAS,GAAIC,6BAAY,GAAG,CAAA;AAEpD,IAAA,MAAM,eAAe,IAAA,CAAK,kCAAA;AAAA,MACxB,IAAI,SAAS,CAAA;AAAA,KACf;AAKA,IAAA,MAAM,qBAAA,GAAwB,MAAM,IAAA,CAAK,WAAA,CAAY,KAAA;AAAA,MACnD,IAAI,GAAA;AAAA,QACF,CAAA,EAAG,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,UAAU,CAAA,UAAA,EAAa,kBAAA;AAAA,UAChD;AAAA,SACD,CAAA;AAAA,QACD,QAAA,EAAS;AAAA,MACXJ,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,MAAA,EAAQ,KAAK;AAAA,KACxD;AACA,IAAA,IAAI,CAAC,sBAAsB,EAAA,EAAI;AAC7B,MAAA,MAAM,GAAA,GAAM,4BAA4B,GAAG,CAAA,EAAA,EAAK,sBAAsB,MAAM,CAAA,CAAA,EAAI,sBAAsB,UAAU,CAAA,CAAA;AAChH,MAAA,IAAI,qBAAA,CAAsB,WAAW,GAAA,EAAK;AACxC,QAAA,MAAM,IAAIG,qBAAc,GAAG,CAAA;AAAA,MAC7B;AACA,MAAA,MAAM,IAAI,MAAM,GAAG,CAAA;AAAA,IACrB;AACA,IAAA,MAAM,yBAAA,GAA4B,MAAM,qBAAA,CAAsB,IAAA,EAAK;AAGnE,IAAA,MAAM,MAAA,GAAS,OAAO,yBAAA,CAA0B,cAAA;AAIhD,IAAA,MAAM,gBAAA,GAAmB,IAAI,eAAA,EAAgB;AAC7C,IAAA,gBAAA,CAAiB,GAAA,CAAI,YAAY,MAAM,CAAA;AACvC,IAAA,IAAI,CAAC,CAAC,QAAA,EAAU;AACd,MAAA,gBAAA,CAAiB,GAAA,CAAI,QAAQ,QAAQ,CAAA;AAAA,IACvC;AACA,IAAA,MAAM,qBAAA,GAAwB,MAAM,IAAA,CAAK,WAAA,CAAY,KAAA;AAAA,MACnD,IAAI,GAAA;AAAA,QACF,CAAA,EAAG,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,UAAU,CAAA,UAAA,EAAa,kBAAA;AAAA,UAChD;AAAA,SACD,CAAA,oBAAA,EAAuB,gBAAA,CAAiB,QAAA,EAAU,CAAA;AAAA,QACnD,QAAA,EAAS;AAAA,MACX;AAAA,QACE,GAAGH,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,QAAQ,KAAK,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,QAOzD,GAAI,MAAA,IAAU,EAAE,MAAA;AAAsB;AACxC,KACF;AACA,IAAA,IAAI,CAAC,sBAAsB,EAAA,EAAI;AAC7B,MAAA,MAAM,OAAA,GAAU,qCAAqC,GAAG,CAAA,EAAA,EAAK,sBAAsB,MAAM,CAAA,CAAA,EAAI,sBAAsB,UAAU,CAAA,CAAA;AAC7H,MAAA,IAAI,qBAAA,CAAsB,WAAW,GAAA,EAAK;AACxC,QAAA,MAAM,IAAIG,qBAAc,OAAO,CAAA;AAAA,MACjC;AACA,MAAA,MAAM,IAAI,MAAM,OAAO,CAAA;AAAA,IACzB;AAEA,IAAA,MAAM,aAAa,MAAM,qBAAA,CAAsB,MAAK,EAAG,CAAC,GAAG,EAAA,IAAM,EAAA;AACjE,IAAA,IAAI,IAAA,IAAQ,SAAS,SAAA,EAAW;AAC9B,MAAA,MAAM,IAAIF,uBAAA,EAAiB;AAAA,IAC7B;AAEA,IAAA,MAAM,gBAAA,GAAmB,IAAI,eAAA,EAAgB;AAC7C,IAAA,gBAAA,CAAiB,GAAA,CAAI,OAAO,MAAM,CAAA;AAClC,IAAA,IAAI,CAAC,CAAC,QAAA,EAAU;AACd,MAAA,gBAAA,CAAiB,GAAA,CAAI,QAAQ,QAAQ,CAAA;AAAA,IACvC;AAEA,IAAA,MAAM,SAAS,CAAA,EACb,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,UAC1B,CAAA,UAAA,EAAa,kBAAA;AAAA,MACX;AAAA,KACD,CAAA,oBAAA,EAAuB,gBAAA,CAAiB,QAAA,EAAU,CAAA,CAAA;AACnD,IAAA,MAAM,qBAAA,GAAwB,MAAM,IAAA,CAAK,WAAA,CAAY,MAAM,MAAA,EAAQ;AAAA,MACjE,GAAGD,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,QAAQ,KAAK,CAAA;AAAA;AAAA;AAAA;AAAA,MAIzD,IAAA,EAAM,aAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAON,GAAI,MAAA,IAAU,EAAE,MAAA;AAAsB,KACvC,CAAA;AACD,IAAA,IAAI,CAAC,sBAAsB,EAAA,EAAI;AAC7B,MAAA,MAAM,OAAA,GAAU,CAAA,mCAAA,EAAsC,GAAG,CAAA,EAAA,EAAK,MAAM,KAAK,qBAAA,CAAsB,MAAM,CAAA,CAAA,EAAI,qBAAA,CAAsB,UAAU,CAAA,CAAA;AACzI,MAAA,IAAI,qBAAA,CAAsB,WAAW,GAAA,EAAK;AACxC,QAAA,MAAM,IAAIG,qBAAc,OAAO,CAAA;AAAA,MACjC;AACA,MAAA,MAAM,IAAI,MAAM,OAAO,CAAA;AAAA,IACzB;AAEA,IAAA,OAAO,MAAM,IAAA,CAAK,IAAA,CAAK,mBAAA,CAAoB,cAAA,CAAe;AAAA,MACxD,QAAA,EAAU,qBAAA;AAAA,MACV,OAAA,EAAS,QAAA;AAAA,MACT,IAAA,EAAM,SAAA;AAAA,MACN,QAAQ,OAAA,EAAS;AAAA,KAClB,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,MAAA,CACJ,GAAA,EACA,OAAA,EACyC;AACzC,IAAA,MAAM,EAAE,QAAA,EAAS,GAAIC,4BAAA,CAAY,GAAG,CAAA;AAGpC,IAAA,IAAI,CAAC,QAAA,EAAU,KAAA,CAAM,MAAM,CAAA,EAAG;AAC5B,MAAA,IAAI;AACF,QAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,OAAA,CAAQ,KAAK,OAAO,CAAA;AAE5C,QAAA,OAAO;AAAA,UACL,KAAA,EAAO;AAAA,YACL;AAAA,cACE,GAAA;AAAA,cACA,SAAS,IAAA,CAAK,MAAA;AAAA,cACd,gBAAgB,IAAA,CAAK;AAAA;AACvB,WACF;AAAA,UACA,IAAA,EAAM,KAAK,IAAA,IAAQ;AAAA,SACrB;AAAA,MACF,SAAS,CAAA,EAAG;AACV,QAAA,MAAM,KAAA,GAAQC,eAAQ,CAAC,CAAA;AACvB,QAAA,IAAI,KAAA,CAAM,SAAS,eAAA,EAAiB;AAClC,UAAA,OAAO;AAAA,YACL,OAAO,EAAC;AAAA,YACR,IAAA,EAAM;AAAA,WACR;AAAA,QACF;AACA,QAAA,MAAM,KAAA;AAAA,MACR;AAAA,IACF;AAEA,IAAA,MAAM,UAAA,GAAa,IAAA,CAAK,aAAA,CAAc,QAAQ,CAAA;AAC9C,IAAA,MAAM,OAAA,GAAU,IAAIC,mBAAA,CAAU,QAAQ,CAAA;AACtC,IAAA,MAAM,UAAUC,cAAA,CAAQ,GAAA,CAAI,QAAQ,QAAA,EAAU,UAAU,GAAG,CAAA,CAAA,CAAG,CAAA;AAC9D,IAAA,MAAM,UAAA,GAAa,UAAA,GAAa,CAAA,EAAG,UAAU,CAAA,CAAA,CAAA,GAAM,EAAA;AACnD,IAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,QAAA,CAAS,OAAA,EAAS;AAAA,MACxC,MAAM,OAAA,EAAS,IAAA;AAAA,MACf,QAAQ,OAAA,EAAS,MAAA;AAAA,MACjB,MAAA,EAAQ,UAAQ,OAAA,CAAQ,KAAA,CAAM,GAAG,UAAU,CAAA,EAAG,IAAI,CAAA,CAAE;AAAA,KACrD,CAAA;AAED,IAAA,MAAM,KAAA,GAAQ,MAAM,IAAA,CAAK,KAAA,EAAM;AAC/B,IAAA,OAAO;AAAA,MACL,MAAM,IAAA,CAAK,IAAA;AAAA,MACX,KAAA,EAAO,KAAA,CAAM,GAAA,CAAI,CAAA,IAAA,MAAS;AAAA,QACxB,GAAA,EAAK,IAAA,CAAK,WAAA,CAAY,UAAA,CAAW;AAAA,UAC/B,GAAA,EAAK,CAAA,CAAA,EAAI,UAAU,CAAA,EAAG,KAAK,IAAI,CAAA,CAAA;AAAA,UAC/B,IAAA,EAAM;AAAA,SACP,CAAA;AAAA,QACD,SAAS,IAAA,CAAK,OAAA;AAAA,QACd,gBAAgB,IAAA,CAAK;AAAA,OACvB,CAAE;AAAA,KACJ;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaQ,cAAc,WAAA,EAAqB;AACzC,IAAA,MAAM,QAAA,GAAW,WAAA,CAAY,KAAA,CAAM,GAAG,CAAA;AACtC,IAAA,MAAM,YAAY,QAAA,CAAS,SAAA,CAAU,aAAW,OAAA,CAAQ,KAAA,CAAM,MAAM,CAAC,CAAA;AACrE,IAAA,OAAO,SAAA,KAAc,KACjB,WAAA,GACA,QAAA,CAAS,MAAM,CAAA,EAAG,SAAS,CAAA,CAAE,IAAA,CAAK,GAAG,CAAA;AAAA,EAC3C;AAAA,EAEA,QAAA,GAAW;AACT,IAAA,MAAM,EAAE,IAAA,EAAM,KAAA,EAAM,GAAI,KAAK,WAAA,CAAY,MAAA;AACzC,IAAA,OAAO,CAAA,YAAA,EAAe,IAAI,CAAA,QAAA,EAAW,OAAA,CAAQ,KAAK,CAAC,CAAA,CAAA,CAAA;AAAA,EACrD;AAAA,EAEA,MAAc,iBAAA,CACZ,MAAA,EACA,KAAA,EACiB;AAEjB,IAAA,MAAM,SAAA,GAAY,IAAI,GAAA,CAAI,MAAM,CAAA;AAChC,IAAA,IAAA,CAAK,kCAAA,CAAmC,UAAU,QAAQ,CAAA;AAC1D,IAAA,IAAI,SAAA,CAAU,QAAA,CAAS,QAAA,CAAS,oBAAoB,CAAA,EAAG;AACrD,MAAA,OAAO,IAAA,CAAK,yBAAA,CAA0B,SAAS,CAAA,CAAE,IAAA;AAAA,QAAK,CAAA,KAAA,KACpD,MAAM,QAAA;AAAS,OACjB;AAAA,IACF;AAEA,IAAA,OAAOC,iCAAA,CAAsB,MAAA,EAAQ,IAAA,CAAK,WAAA,CAAY,QAAQ,KAAK,CAAA;AAAA,EACrE;AAAA;AAAA;AAAA;AAAA;AAAA,EAMQ,0BAA0B,MAAA,EAA2B;AAC3D,IAAA,IAAI,CAAC,MAAA,CAAO,QAAA,CAAS,QAAA,CAAS,oBAAoB,CAAA,EAAG;AACnD,MAAA,MAAM,IAAI,MAAM,6CAA6C,CAAA;AAAA,IAC/D;AACA,IAAA,IAAI;AACF,MAAA,MAAM,CAAC,mBAAA,EAAqB,GAAG,IAC7B,MAAA,CAAO,QAAA,CAAS,MAAM,oBAAoB,CAAA;AAE5C,MAAA,MAAM,YAAA,GAAeC,4CAAA;AAAA,QACnB,KAAK,WAAA,CAAY;AAAA,OACnB;AACA,MAAA,MAAM,WAAA,GACJ,IAAA,CAAK,kCAAA,CAAmC,mBAAmB,CAAA;AAE7D,MAAA,MAAM,MAAA,GAAS,IAAI,GAAA,CAAI,MAAM,CAAA;AAC7B,MAAA,MAAA,CAAO,QAAA,GAAW,CAAA,EAAG,YAAY,CAAA,iBAAA,EAAoB,kBAAA;AAAA,QACnD;AAAA,OACD,mBAAmB,GAAG,CAAA,CAAA;AACvB,MAAA,OAAO,OAAA,CAAQ,QAAQ,MAAM,CAAA;AAAA,IAC/B,SAAS,CAAA,EAAG;AACV,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,yCAAA,EAA4C,MAAM,CAAA,EAAA,EAAK,CAAC,CAAA;AAAA,OAC1D;AAAA,IACF;AAAA,EACF;AAAA,EAEQ,mCAAmC,QAAA,EAA0B;AACnE,IAAA,MAAM,YAAA,GAAeA,4CAAA;AAAA,MACnB,KAAK,WAAA,CAAY;AAAA,KACnB;AACA,IAAA,IAAI,CAAC,YAAA,EAAc;AACjB,MAAA,OAAO,QAAA,CAAS,OAAA,CAAQ,KAAA,EAAO,EAAE,CAAA;AAAA,IACnC;AAEA,IAAA,MAAM,kBAAA,GAAqB,GAAG,YAAY,CAAA,CAAA,CAAA;AAC1C,IAAA,IAAI,CAAC,QAAA,CAAS,UAAA,CAAW,kBAAkB,CAAA,EAAG;AAC5C,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,+BAAA,EAAkC,QAAQ,CAAA,2BAAA,EAA8B,kBAAkB,CAAA,CAAA;AAAA,OAC5F;AAAA,IACF;AAEA,IAAA,OAAO,QAAA,CAAS,KAAA,CAAM,kBAAA,CAAmB,MAAM,CAAA;AAAA,EACjD;AACF;;;;"}
1
+ {"version":3,"file":"GitlabUrlReader.cjs.js","sources":["../../../../src/entrypoints/urlReader/lib/GitlabUrlReader.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n UrlReaderService,\n UrlReaderServiceReadTreeOptions,\n UrlReaderServiceReadTreeResponse,\n UrlReaderServiceReadUrlOptions,\n UrlReaderServiceReadUrlResponse,\n UrlReaderServiceSearchOptions,\n UrlReaderServiceSearchResponse,\n} from '@backstage/backend-plugin-api';\nimport { toError, NotFoundError, NotModifiedError } from '@backstage/errors';\nimport {\n getGitLabFileFetchUrl,\n getGitLabIntegrationRelativePath,\n getGitLabRequestOptions,\n GitLabIntegration,\n ScmIntegrations,\n} from '@backstage/integration';\nimport parseGitUrl from 'git-url-parse';\nimport { trimEnd } from 'lodash';\nimport { Minimatch } from 'minimatch';\nimport { ReadUrlResponseFactory } from './ReadUrlResponseFactory';\nimport { ReaderFactory, ReadTreeResponseFactory } from './types';\n\n/**\n * Implements a {@link @backstage/backend-plugin-api#UrlReaderService} for files on GitLab.\n *\n * @public\n */\nexport class GitlabUrlReader implements UrlReaderService {\n static factory: ReaderFactory = ({ config, treeResponseFactory }) => {\n const integrations = ScmIntegrations.fromConfig(config);\n return integrations.gitlab.list().map(integration => {\n const reader = new GitlabUrlReader(integration, {\n treeResponseFactory,\n });\n const predicate = (url: URL) => url.host === integration.config.host;\n return { reader, predicate };\n });\n };\n\n private readonly integration: GitLabIntegration;\n private readonly deps: { treeResponseFactory: ReadTreeResponseFactory };\n\n constructor(\n integration: GitLabIntegration,\n deps: { treeResponseFactory: ReadTreeResponseFactory },\n ) {\n this.integration = integration;\n this.deps = deps;\n }\n\n async read(url: string): Promise<Buffer> {\n const response = await this.readUrl(url);\n return response.buffer();\n }\n\n async readUrl(\n url: string,\n options?: UrlReaderServiceReadUrlOptions,\n ): Promise<UrlReaderServiceReadUrlResponse> {\n const { etag, lastModifiedAfter, signal, token } = options ?? {};\n const isArtifact = url.includes('/-/jobs/artifacts/');\n const builtUrl = await this.getGitlabFetchUrl(url, token);\n\n let response: Response;\n try {\n response = await this.integration.fetch(builtUrl, {\n headers: {\n ...getGitLabRequestOptions(this.integration.config, token).headers,\n ...(etag && !isArtifact && { 'If-None-Match': etag }),\n ...(lastModifiedAfter &&\n !isArtifact && {\n 'If-Modified-Since': lastModifiedAfter.toUTCString(),\n }),\n },\n // TODO(freben): The signal cast is there because pre-3.x versions of\n // node-fetch have a very slightly deviating AbortSignal type signature.\n // The difference does not affect us in practice however. The cast can be\n // removed after we support ESM for CLI dependencies and migrate to\n // version 3 of node-fetch.\n // https://github.com/backstage/backstage/issues/8242\n ...(signal && { signal: signal as any }),\n });\n } catch (e) {\n throw new Error(`Unable to read ${url}, ${e}`);\n }\n\n if (response.status === 304) {\n throw new NotModifiedError();\n }\n\n if (response.ok) {\n return ReadUrlResponseFactory.fromResponse(response);\n }\n\n const message = `${url} could not be read as ${builtUrl}, ${response.status} ${response.statusText}`;\n if (response.status === 404) {\n throw new NotFoundError(message);\n }\n throw new Error(message);\n }\n\n async readTree(\n url: string,\n options?: UrlReaderServiceReadTreeOptions,\n ): Promise<UrlReaderServiceReadTreeResponse> {\n const { etag, signal, token } = options ?? {};\n const { ref, full_name, filepath } = parseGitUrl(url);\n\n const repoFullName = this.validateAndStripGitLabRelativePath(\n `/${full_name}`,\n );\n\n // Use GitLab API to get the default branch\n // encodeURIComponent is required for GitLab API\n // https://docs.gitlab.com/ee/api/README.html#namespaced-path-encoding\n const projectGitlabResponse = await this.integration.fetch(\n new URL(\n `${this.integration.config.apiBaseUrl}/projects/${encodeURIComponent(\n repoFullName,\n )}`,\n ).toString(),\n getGitLabRequestOptions(this.integration.config, token),\n );\n if (!projectGitlabResponse.ok) {\n const msg = `Failed to read tree from ${url}, ${projectGitlabResponse.status} ${projectGitlabResponse.statusText}`;\n if (projectGitlabResponse.status === 404) {\n throw new NotFoundError(msg);\n }\n throw new Error(msg);\n }\n const projectGitlabResponseJson = await projectGitlabResponse.json();\n\n // ref is an empty string if no branch is set in provided url to readTree.\n const branch = ref || projectGitlabResponseJson.default_branch;\n\n // Fetch the latest commit that modifies the filepath in the provided or default branch\n // to compare against the provided sha.\n const commitsReqParams = new URLSearchParams();\n commitsReqParams.set('ref_name', branch);\n if (!!filepath) {\n commitsReqParams.set('path', filepath);\n }\n const commitsGitlabResponse = await this.integration.fetch(\n new URL(\n `${this.integration.config.apiBaseUrl}/projects/${encodeURIComponent(\n repoFullName,\n )}/repository/commits?${commitsReqParams.toString()}`,\n ).toString(),\n {\n ...getGitLabRequestOptions(this.integration.config, token),\n // TODO(freben): The signal cast is there because pre-3.x versions of\n // node-fetch have a very slightly deviating AbortSignal type signature.\n // The difference does not affect us in practice however. The cast can\n // be removed after we support ESM for CLI dependencies and migrate to\n // version 3 of node-fetch.\n // https://github.com/backstage/backstage/issues/8242\n ...(signal && { signal: signal as any }),\n },\n );\n if (!commitsGitlabResponse.ok) {\n const message = `Failed to read tree (branch) from ${url}, ${commitsGitlabResponse.status} ${commitsGitlabResponse.statusText}`;\n if (commitsGitlabResponse.status === 404) {\n throw new NotFoundError(message);\n }\n throw new Error(message);\n }\n\n const commitSha = (await commitsGitlabResponse.json())[0]?.id ?? '';\n if (etag && etag === commitSha) {\n throw new NotModifiedError();\n }\n\n const archiveReqParams = new URLSearchParams();\n archiveReqParams.set('sha', branch);\n if (!!filepath) {\n archiveReqParams.set('path', filepath);\n }\n // https://docs.gitlab.com/ee/api/repositories.html#get-file-archive\n const reqUrl = `${\n this.integration.config.apiBaseUrl\n }/projects/${encodeURIComponent(\n repoFullName,\n )}/repository/archive?${archiveReqParams.toString()}`;\n const archiveGitLabResponse = await this.integration.fetch(reqUrl, {\n ...getGitLabRequestOptions(this.integration.config, token),\n // The mode is set to 'same-origin' to overwrite the default 'cors' value.\n // The repository/archive endpoint marks mode='cors' as a \"hotlink\" which will return 406 - Not Acceptable as a response\n // More info on this issue can be found @ https://github.com/backstage/backstage/issues/34395\n mode: 'same-origin',\n // TODO(freben): The signal cast is there because pre-3.x versions of\n // node-fetch have a very slightly deviating AbortSignal type signature.\n // The difference does not affect us in practice however. The cast can\n // be removed after we support ESM for CLI dependencies and migrate to\n // version 3 of node-fetch.\n // https://github.com/backstage/backstage/issues/8242\n ...(signal && { signal: signal as any }),\n });\n if (!archiveGitLabResponse.ok) {\n const message = `Failed to read tree (archive) from ${url}, ${reqUrl}, ${archiveGitLabResponse.status} ${archiveGitLabResponse.statusText}`;\n if (archiveGitLabResponse.status === 404) {\n throw new NotFoundError(message);\n }\n throw new Error(message);\n }\n\n return await this.deps.treeResponseFactory.fromTarArchive({\n response: archiveGitLabResponse,\n subpath: filepath,\n etag: commitSha,\n filter: options?.filter,\n });\n }\n\n async search(\n url: string,\n options?: UrlReaderServiceSearchOptions,\n ): Promise<UrlReaderServiceSearchResponse> {\n const { filepath } = parseGitUrl(url);\n\n // If it's a direct URL we use readUrl instead\n if (!filepath?.match(/[*?]/)) {\n try {\n const data = await this.readUrl(url, options);\n\n return {\n files: [\n {\n url: url,\n content: data.buffer,\n lastModifiedAt: data.lastModifiedAt,\n },\n ],\n etag: data.etag ?? '',\n };\n } catch (e) {\n const error = toError(e);\n if (error.name === 'NotFoundError') {\n return {\n files: [],\n etag: '',\n };\n }\n throw error;\n }\n }\n\n const staticPart = this.getStaticPart(filepath);\n const matcher = new Minimatch(filepath);\n const treeUrl = trimEnd(url.replace(filepath, staticPart), `/`);\n const pathPrefix = staticPart ? `${staticPart}/` : '';\n const tree = await this.readTree(treeUrl, {\n etag: options?.etag,\n signal: options?.signal,\n filter: path => matcher.match(`${pathPrefix}${path}`),\n });\n\n const files = await tree.files();\n return {\n etag: tree.etag,\n files: files.map(file => ({\n url: this.integration.resolveUrl({\n url: `/${pathPrefix}${file.path}`,\n base: url,\n }),\n content: file.content,\n lastModifiedAt: file.lastModifiedAt,\n })),\n };\n }\n\n /**\n * This function splits the input globPattern string into segments using the path separator /. It then iterates over\n * the segments from the end of the array towards the beginning, checking if the concatenated string up to that\n * segment matches the original globPattern using the minimatch function. If a match is found, it continues iterating.\n * If no match is found, it returns the concatenated string up to the current segment, which is the static part of the\n * glob pattern.\n *\n * E.g. `catalog/foo/*.yaml` will return `catalog/foo`.\n *\n * @param globPattern - the glob pattern\n */\n private getStaticPart(globPattern: string) {\n const segments = globPattern.split('/');\n const globIndex = segments.findIndex(segment => segment.match(/[*?]/));\n return globIndex === -1\n ? globPattern\n : segments.slice(0, globIndex).join('/');\n }\n\n toString() {\n const { host, token } = this.integration.config;\n return `gitlab{host=${host},authed=${Boolean(token)}}`;\n }\n\n private async getGitlabFetchUrl(\n target: string,\n token?: string,\n ): Promise<string> {\n // If the target is for a job artifact then go down that path\n const targetUrl = new URL(target);\n this.validateAndStripGitLabRelativePath(targetUrl.pathname);\n if (targetUrl.pathname.includes('/-/jobs/artifacts/')) {\n return this.getGitlabArtifactFetchUrl(targetUrl).then(value =>\n value.toString(),\n );\n }\n // Default to the optimized behavior - no API call needed for file URLs\n return getGitLabFileFetchUrl(target, this.integration.config, token);\n }\n\n // convert urls of the form:\n // https://example.com/<namespace>/<project>/-/jobs/artifacts/<ref>/raw/<path_to_file>?job=<job_name>\n // to urls of the form:\n // https://example.com/api/v4/projects/namespace%2Fproject/jobs/artifacts/:ref_name/raw/*artifact_path?job=<job_name>\n private getGitlabArtifactFetchUrl(target: URL): Promise<URL> {\n if (!target.pathname.includes('/-/jobs/artifacts/')) {\n throw new Error('Unable to process url as an GitLab artifact');\n }\n try {\n const [namespaceAndProject, ref] =\n target.pathname.split('/-/jobs/artifacts/');\n\n const relativePath = getGitLabIntegrationRelativePath(\n this.integration.config,\n );\n const projectPath =\n this.validateAndStripGitLabRelativePath(namespaceAndProject);\n\n const newUrl = new URL(target);\n newUrl.pathname = `${relativePath}/api/v4/projects/${encodeURIComponent(\n projectPath,\n )}/jobs/artifacts/${ref}`;\n return Promise.resolve(newUrl);\n } catch (e) {\n throw new Error(\n `Unable to translate GitLab artifact URL: ${target}, ${e}`,\n );\n }\n }\n\n private validateAndStripGitLabRelativePath(pathname: string): string {\n const relativePath = getGitLabIntegrationRelativePath(\n this.integration.config,\n );\n if (!relativePath) {\n return pathname.replace(/^\\//, '');\n }\n\n const relativePathPrefix = `${relativePath}/`;\n if (!pathname.startsWith(relativePathPrefix)) {\n throw new Error(\n `Failed to read GitLab URL from ${pathname}. Url path must start with ${relativePathPrefix}.`,\n );\n }\n\n return pathname.slice(relativePathPrefix.length);\n }\n}\n"],"names":["ScmIntegrations","getGitLabRequestOptions","NotModifiedError","ReadUrlResponseFactory","NotFoundError","parseGitUrl","toError","Minimatch","trimEnd","getGitLabFileFetchUrl","getGitLabIntegrationRelativePath"],"mappings":";;;;;;;;;;;;;AA4CO,MAAM,eAAA,CAA4C;AAAA,EACvD,OAAO,OAAA,GAAyB,CAAC,EAAE,MAAA,EAAQ,qBAAoB,KAAM;AACnE,IAAA,MAAM,YAAA,GAAeA,2BAAA,CAAgB,UAAA,CAAW,MAAM,CAAA;AACtD,IAAA,OAAO,YAAA,CAAa,MAAA,CAAO,IAAA,EAAK,CAAE,IAAI,CAAA,WAAA,KAAe;AACnD,MAAA,MAAM,MAAA,GAAS,IAAI,eAAA,CAAgB,WAAA,EAAa;AAAA,QAC9C;AAAA,OACD,CAAA;AACD,MAAA,MAAM,YAAY,CAAC,GAAA,KAAa,GAAA,CAAI,IAAA,KAAS,YAAY,MAAA,CAAO,IAAA;AAChE,MAAA,OAAO,EAAE,QAAQ,SAAA,EAAU;AAAA,IAC7B,CAAC,CAAA;AAAA,EACH,CAAA;AAAA,EAEiB,WAAA;AAAA,EACA,IAAA;AAAA,EAEjB,WAAA,CACE,aACA,IAAA,EACA;AACA,IAAA,IAAA,CAAK,WAAA,GAAc,WAAA;AACnB,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;AAAA,EACd;AAAA,EAEA,MAAM,KAAK,GAAA,EAA8B;AACvC,IAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,OAAA,CAAQ,GAAG,CAAA;AACvC,IAAA,OAAO,SAAS,MAAA,EAAO;AAAA,EACzB;AAAA,EAEA,MAAM,OAAA,CACJ,GAAA,EACA,OAAA,EAC0C;AAC1C,IAAA,MAAM,EAAE,IAAA,EAAM,iBAAA,EAAmB,QAAQ,KAAA,EAAM,GAAI,WAAW,EAAC;AAC/D,IAAA,MAAM,UAAA,GAAa,GAAA,CAAI,QAAA,CAAS,oBAAoB,CAAA;AACpD,IAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,iBAAA,CAAkB,KAAK,KAAK,CAAA;AAExD,IAAA,IAAI,QAAA;AACJ,IAAA,IAAI;AACF,MAAA,QAAA,GAAW,MAAM,IAAA,CAAK,WAAA,CAAY,KAAA,CAAM,QAAA,EAAU;AAAA,QAChD,OAAA,EAAS;AAAA,UACP,GAAGC,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,MAAA,EAAQ,KAAK,CAAA,CAAE,OAAA;AAAA,UAC3D,GAAI,IAAA,IAAQ,CAAC,UAAA,IAAc,EAAE,iBAAiB,IAAA,EAAK;AAAA,UACnD,GAAI,iBAAA,IACF,CAAC,UAAA,IAAc;AAAA,YACb,mBAAA,EAAqB,kBAAkB,WAAA;AAAY;AACrD,SACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,QAOA,GAAI,MAAA,IAAU,EAAE,MAAA;AAAsB,OACvC,CAAA;AAAA,IACH,SAAS,CAAA,EAAG;AACV,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,eAAA,EAAkB,GAAG,CAAA,EAAA,EAAK,CAAC,CAAA,CAAE,CAAA;AAAA,IAC/C;AAEA,IAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,MAAA,MAAM,IAAIC,uBAAA,EAAiB;AAAA,IAC7B;AAEA,IAAA,IAAI,SAAS,EAAA,EAAI;AACf,MAAA,OAAOC,6CAAA,CAAuB,aAAa,QAAQ,CAAA;AAAA,IACrD;AAEA,IAAA,MAAM,OAAA,GAAU,CAAA,EAAG,GAAG,CAAA,sBAAA,EAAyB,QAAQ,KAAK,QAAA,CAAS,MAAM,CAAA,CAAA,EAAI,QAAA,CAAS,UAAU,CAAA,CAAA;AAClG,IAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,MAAA,MAAM,IAAIC,qBAAc,OAAO,CAAA;AAAA,IACjC;AACA,IAAA,MAAM,IAAI,MAAM,OAAO,CAAA;AAAA,EACzB;AAAA,EAEA,MAAM,QAAA,CACJ,GAAA,EACA,OAAA,EAC2C;AAC3C,IAAA,MAAM,EAAE,IAAA,EAAM,MAAA,EAAQ,KAAA,EAAM,GAAI,WAAW,EAAC;AAC5C,IAAA,MAAM,EAAE,GAAA,EAAK,SAAA,EAAW,QAAA,EAAS,GAAIC,6BAAY,GAAG,CAAA;AAEpD,IAAA,MAAM,eAAe,IAAA,CAAK,kCAAA;AAAA,MACxB,IAAI,SAAS,CAAA;AAAA,KACf;AAKA,IAAA,MAAM,qBAAA,GAAwB,MAAM,IAAA,CAAK,WAAA,CAAY,KAAA;AAAA,MACnD,IAAI,GAAA;AAAA,QACF,CAAA,EAAG,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,UAAU,CAAA,UAAA,EAAa,kBAAA;AAAA,UAChD;AAAA,SACD,CAAA;AAAA,QACD,QAAA,EAAS;AAAA,MACXJ,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,MAAA,EAAQ,KAAK;AAAA,KACxD;AACA,IAAA,IAAI,CAAC,sBAAsB,EAAA,EAAI;AAC7B,MAAA,MAAM,GAAA,GAAM,4BAA4B,GAAG,CAAA,EAAA,EAAK,sBAAsB,MAAM,CAAA,CAAA,EAAI,sBAAsB,UAAU,CAAA,CAAA;AAChH,MAAA,IAAI,qBAAA,CAAsB,WAAW,GAAA,EAAK;AACxC,QAAA,MAAM,IAAIG,qBAAc,GAAG,CAAA;AAAA,MAC7B;AACA,MAAA,MAAM,IAAI,MAAM,GAAG,CAAA;AAAA,IACrB;AACA,IAAA,MAAM,yBAAA,GAA4B,MAAM,qBAAA,CAAsB,IAAA,EAAK;AAGnE,IAAA,MAAM,MAAA,GAAS,OAAO,yBAAA,CAA0B,cAAA;AAIhD,IAAA,MAAM,gBAAA,GAAmB,IAAI,eAAA,EAAgB;AAC7C,IAAA,gBAAA,CAAiB,GAAA,CAAI,YAAY,MAAM,CAAA;AACvC,IAAA,IAAI,CAAC,CAAC,QAAA,EAAU;AACd,MAAA,gBAAA,CAAiB,GAAA,CAAI,QAAQ,QAAQ,CAAA;AAAA,IACvC;AACA,IAAA,MAAM,qBAAA,GAAwB,MAAM,IAAA,CAAK,WAAA,CAAY,KAAA;AAAA,MACnD,IAAI,GAAA;AAAA,QACF,CAAA,EAAG,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,UAAU,CAAA,UAAA,EAAa,kBAAA;AAAA,UAChD;AAAA,SACD,CAAA,oBAAA,EAAuB,gBAAA,CAAiB,QAAA,EAAU,CAAA;AAAA,QACnD,QAAA,EAAS;AAAA,MACX;AAAA,QACE,GAAGH,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,QAAQ,KAAK,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,QAOzD,GAAI,MAAA,IAAU,EAAE,MAAA;AAAsB;AACxC,KACF;AACA,IAAA,IAAI,CAAC,sBAAsB,EAAA,EAAI;AAC7B,MAAA,MAAM,OAAA,GAAU,qCAAqC,GAAG,CAAA,EAAA,EAAK,sBAAsB,MAAM,CAAA,CAAA,EAAI,sBAAsB,UAAU,CAAA,CAAA;AAC7H,MAAA,IAAI,qBAAA,CAAsB,WAAW,GAAA,EAAK;AACxC,QAAA,MAAM,IAAIG,qBAAc,OAAO,CAAA;AAAA,MACjC;AACA,MAAA,MAAM,IAAI,MAAM,OAAO,CAAA;AAAA,IACzB;AAEA,IAAA,MAAM,aAAa,MAAM,qBAAA,CAAsB,MAAK,EAAG,CAAC,GAAG,EAAA,IAAM,EAAA;AACjE,IAAA,IAAI,IAAA,IAAQ,SAAS,SAAA,EAAW;AAC9B,MAAA,MAAM,IAAIF,uBAAA,EAAiB;AAAA,IAC7B;AAEA,IAAA,MAAM,gBAAA,GAAmB,IAAI,eAAA,EAAgB;AAC7C,IAAA,gBAAA,CAAiB,GAAA,CAAI,OAAO,MAAM,CAAA;AAClC,IAAA,IAAI,CAAC,CAAC,QAAA,EAAU;AACd,MAAA,gBAAA,CAAiB,GAAA,CAAI,QAAQ,QAAQ,CAAA;AAAA,IACvC;AAEA,IAAA,MAAM,SAAS,CAAA,EACb,IAAA,CAAK,WAAA,CAAY,MAAA,CAAO,UAC1B,CAAA,UAAA,EAAa,kBAAA;AAAA,MACX;AAAA,KACD,CAAA,oBAAA,EAAuB,gBAAA,CAAiB,QAAA,EAAU,CAAA,CAAA;AACnD,IAAA,MAAM,qBAAA,GAAwB,MAAM,IAAA,CAAK,WAAA,CAAY,MAAM,MAAA,EAAQ;AAAA,MACjE,GAAGD,mCAAA,CAAwB,IAAA,CAAK,WAAA,CAAY,QAAQ,KAAK,CAAA;AAAA;AAAA;AAAA;AAAA,MAIzD,IAAA,EAAM,aAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAON,GAAI,MAAA,IAAU,EAAE,MAAA;AAAsB,KACvC,CAAA;AACD,IAAA,IAAI,CAAC,sBAAsB,EAAA,EAAI;AAC7B,MAAA,MAAM,OAAA,GAAU,CAAA,mCAAA,EAAsC,GAAG,CAAA,EAAA,EAAK,MAAM,KAAK,qBAAA,CAAsB,MAAM,CAAA,CAAA,EAAI,qBAAA,CAAsB,UAAU,CAAA,CAAA;AACzI,MAAA,IAAI,qBAAA,CAAsB,WAAW,GAAA,EAAK;AACxC,QAAA,MAAM,IAAIG,qBAAc,OAAO,CAAA;AAAA,MACjC;AACA,MAAA,MAAM,IAAI,MAAM,OAAO,CAAA;AAAA,IACzB;AAEA,IAAA,OAAO,MAAM,IAAA,CAAK,IAAA,CAAK,mBAAA,CAAoB,cAAA,CAAe;AAAA,MACxD,QAAA,EAAU,qBAAA;AAAA,MACV,OAAA,EAAS,QAAA;AAAA,MACT,IAAA,EAAM,SAAA;AAAA,MACN,QAAQ,OAAA,EAAS;AAAA,KAClB,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,MAAA,CACJ,GAAA,EACA,OAAA,EACyC;AACzC,IAAA,MAAM,EAAE,QAAA,EAAS,GAAIC,4BAAA,CAAY,GAAG,CAAA;AAGpC,IAAA,IAAI,CAAC,QAAA,EAAU,KAAA,CAAM,MAAM,CAAA,EAAG;AAC5B,MAAA,IAAI;AACF,QAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,OAAA,CAAQ,KAAK,OAAO,CAAA;AAE5C,QAAA,OAAO;AAAA,UACL,KAAA,EAAO;AAAA,YACL;AAAA,cACE,GAAA;AAAA,cACA,SAAS,IAAA,CAAK,MAAA;AAAA,cACd,gBAAgB,IAAA,CAAK;AAAA;AACvB,WACF;AAAA,UACA,IAAA,EAAM,KAAK,IAAA,IAAQ;AAAA,SACrB;AAAA,MACF,SAAS,CAAA,EAAG;AACV,QAAA,MAAM,KAAA,GAAQC,eAAQ,CAAC,CAAA;AACvB,QAAA,IAAI,KAAA,CAAM,SAAS,eAAA,EAAiB;AAClC,UAAA,OAAO;AAAA,YACL,OAAO,EAAC;AAAA,YACR,IAAA,EAAM;AAAA,WACR;AAAA,QACF;AACA,QAAA,MAAM,KAAA;AAAA,MACR;AAAA,IACF;AAEA,IAAA,MAAM,UAAA,GAAa,IAAA,CAAK,aAAA,CAAc,QAAQ,CAAA;AAC9C,IAAA,MAAM,OAAA,GAAU,IAAIC,mBAAA,CAAU,QAAQ,CAAA;AACtC,IAAA,MAAM,UAAUC,cAAA,CAAQ,GAAA,CAAI,QAAQ,QAAA,EAAU,UAAU,GAAG,CAAA,CAAA,CAAG,CAAA;AAC9D,IAAA,MAAM,UAAA,GAAa,UAAA,GAAa,CAAA,EAAG,UAAU,CAAA,CAAA,CAAA,GAAM,EAAA;AACnD,IAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,QAAA,CAAS,OAAA,EAAS;AAAA,MACxC,MAAM,OAAA,EAAS,IAAA;AAAA,MACf,QAAQ,OAAA,EAAS,MAAA;AAAA,MACjB,MAAA,EAAQ,UAAQ,OAAA,CAAQ,KAAA,CAAM,GAAG,UAAU,CAAA,EAAG,IAAI,CAAA,CAAE;AAAA,KACrD,CAAA;AAED,IAAA,MAAM,KAAA,GAAQ,MAAM,IAAA,CAAK,KAAA,EAAM;AAC/B,IAAA,OAAO;AAAA,MACL,MAAM,IAAA,CAAK,IAAA;AAAA,MACX,KAAA,EAAO,KAAA,CAAM,GAAA,CAAI,CAAA,IAAA,MAAS;AAAA,QACxB,GAAA,EAAK,IAAA,CAAK,WAAA,CAAY,UAAA,CAAW;AAAA,UAC/B,GAAA,EAAK,CAAA,CAAA,EAAI,UAAU,CAAA,EAAG,KAAK,IAAI,CAAA,CAAA;AAAA,UAC/B,IAAA,EAAM;AAAA,SACP,CAAA;AAAA,QACD,SAAS,IAAA,CAAK,OAAA;AAAA,QACd,gBAAgB,IAAA,CAAK;AAAA,OACvB,CAAE;AAAA,KACJ;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaQ,cAAc,WAAA,EAAqB;AACzC,IAAA,MAAM,QAAA,GAAW,WAAA,CAAY,KAAA,CAAM,GAAG,CAAA;AACtC,IAAA,MAAM,YAAY,QAAA,CAAS,SAAA,CAAU,aAAW,OAAA,CAAQ,KAAA,CAAM,MAAM,CAAC,CAAA;AACrE,IAAA,OAAO,SAAA,KAAc,KACjB,WAAA,GACA,QAAA,CAAS,MAAM,CAAA,EAAG,SAAS,CAAA,CAAE,IAAA,CAAK,GAAG,CAAA;AAAA,EAC3C;AAAA,EAEA,QAAA,GAAW;AACT,IAAA,MAAM,EAAE,IAAA,EAAM,KAAA,EAAM,GAAI,KAAK,WAAA,CAAY,MAAA;AACzC,IAAA,OAAO,CAAA,YAAA,EAAe,IAAI,CAAA,QAAA,EAAW,OAAA,CAAQ,KAAK,CAAC,CAAA,CAAA,CAAA;AAAA,EACrD;AAAA,EAEA,MAAc,iBAAA,CACZ,MAAA,EACA,KAAA,EACiB;AAEjB,IAAA,MAAM,SAAA,GAAY,IAAI,GAAA,CAAI,MAAM,CAAA;AAChC,IAAA,IAAA,CAAK,kCAAA,CAAmC,UAAU,QAAQ,CAAA;AAC1D,IAAA,IAAI,SAAA,CAAU,QAAA,CAAS,QAAA,CAAS,oBAAoB,CAAA,EAAG;AACrD,MAAA,OAAO,IAAA,CAAK,yBAAA,CAA0B,SAAS,CAAA,CAAE,IAAA;AAAA,QAAK,CAAA,KAAA,KACpD,MAAM,QAAA;AAAS,OACjB;AAAA,IACF;AAEA,IAAA,OAAOC,iCAAA,CAAsB,MAAA,EAAQ,IAAA,CAAK,WAAA,CAAY,QAAQ,KAAK,CAAA;AAAA,EACrE;AAAA;AAAA;AAAA;AAAA;AAAA,EAMQ,0BAA0B,MAAA,EAA2B;AAC3D,IAAA,IAAI,CAAC,MAAA,CAAO,QAAA,CAAS,QAAA,CAAS,oBAAoB,CAAA,EAAG;AACnD,MAAA,MAAM,IAAI,MAAM,6CAA6C,CAAA;AAAA,IAC/D;AACA,IAAA,IAAI;AACF,MAAA,MAAM,CAAC,mBAAA,EAAqB,GAAG,IAC7B,MAAA,CAAO,QAAA,CAAS,MAAM,oBAAoB,CAAA;AAE5C,MAAA,MAAM,YAAA,GAAeC,4CAAA;AAAA,QACnB,KAAK,WAAA,CAAY;AAAA,OACnB;AACA,MAAA,MAAM,WAAA,GACJ,IAAA,CAAK,kCAAA,CAAmC,mBAAmB,CAAA;AAE7D,MAAA,MAAM,MAAA,GAAS,IAAI,GAAA,CAAI,MAAM,CAAA;AAC7B,MAAA,MAAA,CAAO,QAAA,GAAW,CAAA,EAAG,YAAY,CAAA,iBAAA,EAAoB,kBAAA;AAAA,QACnD;AAAA,OACD,mBAAmB,GAAG,CAAA,CAAA;AACvB,MAAA,OAAO,OAAA,CAAQ,QAAQ,MAAM,CAAA;AAAA,IAC/B,SAAS,CAAA,EAAG;AACV,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,yCAAA,EAA4C,MAAM,CAAA,EAAA,EAAK,CAAC,CAAA;AAAA,OAC1D;AAAA,IACF;AAAA,EACF;AAAA,EAEQ,mCAAmC,QAAA,EAA0B;AACnE,IAAA,MAAM,YAAA,GAAeA,4CAAA;AAAA,MACnB,KAAK,WAAA,CAAY;AAAA,KACnB;AACA,IAAA,IAAI,CAAC,YAAA,EAAc;AACjB,MAAA,OAAO,QAAA,CAAS,OAAA,CAAQ,KAAA,EAAO,EAAE,CAAA;AAAA,IACnC;AAEA,IAAA,MAAM,kBAAA,GAAqB,GAAG,YAAY,CAAA,CAAA,CAAA;AAC1C,IAAA,IAAI,CAAC,QAAA,CAAS,UAAA,CAAW,kBAAkB,CAAA,EAAG;AAC5C,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,+BAAA,EAAkC,QAAQ,CAAA,2BAAA,EAA8B,kBAAkB,CAAA,CAAA;AAAA,OAC5F;AAAA,IACF;AAEA,IAAA,OAAO,QAAA,CAAS,KAAA,CAAM,kBAAA,CAAmB,MAAM,CAAA;AAAA,EACjD;AACF;;"}
@@ -1 +1 @@
1
- {"version":3,"file":"GoogleGcsUrlReader.cjs.js","sources":["../../../../src/entrypoints/urlReader/lib/GoogleGcsUrlReader.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 * as GoogleCloud from '@google-cloud/storage';\nimport {\n UrlReaderService,\n UrlReaderServiceReadTreeOptions,\n UrlReaderServiceReadTreeResponse,\n UrlReaderServiceReadUrlOptions,\n UrlReaderServiceReadUrlResponse,\n UrlReaderServiceSearchOptions,\n UrlReaderServiceSearchResponse,\n} from '@backstage/backend-plugin-api';\nimport { ReaderFactory, ReadTreeResponseFactory } from './types';\nimport getRawBody from 'raw-body';\nimport {\n GoogleGcsIntegrationConfig,\n readGoogleGcsIntegrationConfig,\n} from '@backstage/integration';\n\nimport { Readable } from 'node:stream';\nimport { ReadUrlResponseFactory } from './ReadUrlResponseFactory';\nimport packageinfo from '../../../../package.json';\nimport { toError } from '@backstage/errors';\nimport { relative } from 'node:path/posix';\nimport { hasDotPathSegments } from './util';\n\nconst GOOGLE_GCS_HOST = 'storage.cloud.google.com';\n\nconst parseURL = (\n url: string,\n): { host: string; bucket: string; key: string } => {\n const { host, pathname } = new URL(url);\n\n if (host !== GOOGLE_GCS_HOST) {\n throw new Error(`not a valid GCS URL: ${url}`);\n }\n\n const [, bucket, ...key] = pathname.split('/');\n return {\n host: host,\n bucket,\n key: key.join('/'),\n };\n};\n\n/**\n * Implements a {@link @backstage/backend-plugin-api#UrlReaderService} for files on Google GCS.\n *\n * @public\n */\nexport class GoogleGcsUrlReader implements UrlReaderService {\n static factory: ReaderFactory = ({ config, logger, treeResponseFactory }) => {\n if (!config.has('integrations.googleGcs')) {\n return [];\n }\n const gcsConfig = readGoogleGcsIntegrationConfig(\n config.getConfig('integrations.googleGcs'),\n );\n let storage: GoogleCloud.Storage;\n if (!gcsConfig.clientEmail || !gcsConfig.privateKey) {\n logger.info(\n 'googleGcs credentials not found in config. Using default credentials provider.',\n );\n storage = new GoogleCloud.Storage({\n userAgent: `backstage/backend-defaults.GoogleGcsUrlReader/${packageinfo.version}`,\n });\n } else {\n storage = new GoogleCloud.Storage({\n credentials: {\n client_email: gcsConfig.clientEmail || undefined,\n private_key: gcsConfig.privateKey || undefined,\n },\n userAgent: `backstage/backend-defaults.GoogleGcsUrlReader/${packageinfo.version}`,\n });\n }\n const reader = new GoogleGcsUrlReader(gcsConfig, storage, {\n treeResponseFactory,\n });\n const predicate = (url: URL) => url.host === GOOGLE_GCS_HOST;\n return [{ reader, predicate }];\n };\n\n private readonly integration: GoogleGcsIntegrationConfig;\n private readonly storage: GoogleCloud.Storage;\n private readonly deps: {\n treeResponseFactory: ReadTreeResponseFactory;\n };\n\n constructor(\n integration: GoogleGcsIntegrationConfig,\n storage: GoogleCloud.Storage,\n deps: {\n treeResponseFactory: ReadTreeResponseFactory;\n },\n ) {\n this.integration = integration;\n this.storage = storage;\n this.deps = deps;\n }\n\n private readStreamFromUrl(url: string): Readable {\n const { bucket, key } = parseURL(url);\n return this.storage.bucket(bucket).file(key).createReadStream();\n }\n\n async read(url: string): Promise<Buffer> {\n try {\n return await getRawBody(this.readStreamFromUrl(url));\n } catch (error) {\n throw new Error(`unable to read gcs file from ${url}, ${error}`);\n }\n }\n\n async readUrl(\n url: string,\n _options?: UrlReaderServiceReadUrlOptions,\n ): Promise<UrlReaderServiceReadUrlResponse> {\n // TODO etag is not implemented yet.\n const stream = this.readStreamFromUrl(url);\n return ReadUrlResponseFactory.fromReadable(stream);\n }\n\n async readTree(\n url: string,\n _options?: UrlReaderServiceReadTreeOptions,\n ): Promise<UrlReaderServiceReadTreeResponse> {\n const { bucket, key } = parseURL(url);\n\n if (key.match(/[*?]/)) {\n throw new Error(\n 'GcsUrlReader readTree does not support glob patterns, use search instead',\n );\n }\n\n const [files] = await this.storage.bucket(bucket).getFiles({\n autoPaginate: true,\n prefix: key,\n });\n\n const responses = files\n .filter(file => !hasDotPathSegments(file.name))\n .map(file => ({\n data: file.createReadStream(),\n path: relative(key, file.name),\n lastModifiedAt: file.metadata.updated\n ? new Date(file.metadata.updated as string)\n : undefined,\n }));\n\n return this.deps.treeResponseFactory.fromReadableArray(responses);\n }\n\n async search(\n url: string,\n options?: UrlReaderServiceSearchOptions,\n ): Promise<UrlReaderServiceSearchResponse> {\n const { bucket, key: pattern } = parseURL(url);\n\n // If it's a direct URL we use readUrl instead\n if (!pattern?.match(/[*?]/)) {\n try {\n const data = await this.readUrl(url, options);\n\n return {\n files: [\n {\n url: url,\n content: data.buffer,\n lastModifiedAt: data.lastModifiedAt,\n },\n ],\n etag: data.etag ?? '',\n };\n } catch (e) {\n const error = toError(e);\n if (error.name === 'NotFoundError') {\n return {\n files: [],\n etag: '',\n };\n }\n throw error;\n }\n }\n\n if (!pattern.endsWith('*') || pattern.indexOf('*') !== pattern.length - 1) {\n throw new Error('GcsUrlReader only supports prefix-based searches');\n }\n\n const [files] = await this.storage.bucket(bucket).getFiles({\n autoPaginate: true,\n prefix: pattern.split('*').join(''),\n });\n\n return {\n files: files.map(file => {\n const fullUrl = ['https:/', GOOGLE_GCS_HOST, bucket, file.name].join(\n '/',\n );\n return {\n url: fullUrl,\n content: async () => {\n const readResponse = await this.readUrl(fullUrl);\n return readResponse.buffer();\n },\n };\n }),\n // TODO etag is not implemented yet.\n etag: 'NOT/IMPLEMENTED',\n };\n }\n\n toString() {\n const key = this.integration.privateKey;\n return `googleGcs{host=${GOOGLE_GCS_HOST},authed=${Boolean(key)}}`;\n }\n}\n"],"names":["readGoogleGcsIntegrationConfig","GoogleCloud","packageinfo","getRawBody","ReadUrlResponseFactory","hasDotPathSegments","relative","toError"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCA,MAAM,eAAA,GAAkB,0BAAA;AAExB,MAAM,QAAA,GAAW,CACf,GAAA,KACkD;AAClD,EAAA,MAAM,EAAE,IAAA,EAAM,QAAA,EAAS,GAAI,IAAI,IAAI,GAAG,CAAA;AAEtC,EAAA,IAAI,SAAS,eAAA,EAAiB;AAC5B,IAAA,MAAM,IAAI,KAAA,CAAM,CAAA,qBAAA,EAAwB,GAAG,CAAA,CAAE,CAAA;AAAA,EAC/C;AAEA,EAAA,MAAM,GAAG,MAAA,EAAQ,GAAG,GAAG,CAAA,GAAI,QAAA,CAAS,MAAM,GAAG,CAAA;AAC7C,EAAA,OAAO;AAAA,IACL,IAAA;AAAA,IACA,MAAA;AAAA,IACA,GAAA,EAAK,GAAA,CAAI,IAAA,CAAK,GAAG;AAAA,GACnB;AACF,CAAA;AAOO,MAAM,kBAAA,CAA+C;AAAA,EAC1D,OAAO,OAAA,GAAyB,CAAC,EAAE,MAAA,EAAQ,MAAA,EAAQ,qBAAoB,KAAM;AAC3E,IAAA,IAAI,CAAC,MAAA,CAAO,GAAA,CAAI,wBAAwB,CAAA,EAAG;AACzC,MAAA,OAAO,EAAC;AAAA,IACV;AACA,IAAA,MAAM,SAAA,GAAYA,0CAAA;AAAA,MAChB,MAAA,CAAO,UAAU,wBAAwB;AAAA,KAC3C;AACA,IAAA,IAAI,OAAA;AACJ,IAAA,IAAI,CAAC,SAAA,CAAU,WAAA,IAAe,CAAC,UAAU,UAAA,EAAY;AACnD,MAAA,MAAA,CAAO,IAAA;AAAA,QACL;AAAA,OACF;AACA,MAAA,OAAA,GAAU,IAAIC,uBAAY,OAAA,CAAQ;AAAA,QAChC,SAAA,EAAW,CAAA,8CAAA,EAAiDC,gBAAA,CAAY,OAAO,CAAA;AAAA,OAChF,CAAA;AAAA,IACH,CAAA,MAAO;AACL,MAAA,OAAA,GAAU,IAAID,uBAAY,OAAA,CAAQ;AAAA,QAChC,WAAA,EAAa;AAAA,UACX,YAAA,EAAc,UAAU,WAAA,IAAe,MAAA;AAAA,UACvC,WAAA,EAAa,UAAU,UAAA,IAAc;AAAA,SACvC;AAAA,QACA,SAAA,EAAW,CAAA,8CAAA,EAAiDC,gBAAA,CAAY,OAAO,CAAA;AAAA,OAChF,CAAA;AAAA,IACH;AACA,IAAA,MAAM,MAAA,GAAS,IAAI,kBAAA,CAAmB,SAAA,EAAW,OAAA,EAAS;AAAA,MACxD;AAAA,KACD,CAAA;AACD,IAAA,MAAM,SAAA,GAAY,CAAC,GAAA,KAAa,GAAA,CAAI,IAAA,KAAS,eAAA;AAC7C,IAAA,OAAO,CAAC,EAAE,MAAA,EAAQ,SAAA,EAAW,CAAA;AAAA,EAC/B,CAAA;AAAA,EAEiB,WAAA;AAAA,EACA,OAAA;AAAA,EACA,IAAA;AAAA,EAIjB,WAAA,CACE,WAAA,EACA,OAAA,EACA,IAAA,EAGA;AACA,IAAA,IAAA,CAAK,WAAA,GAAc,WAAA;AACnB,IAAA,IAAA,CAAK,OAAA,GAAU,OAAA;AACf,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;AAAA,EACd;AAAA,EAEQ,kBAAkB,GAAA,EAAuB;AAC/C,IAAA,MAAM,EAAE,MAAA,EAAQ,GAAA,EAAI,GAAI,SAAS,GAAG,CAAA;AACpC,IAAA,OAAO,IAAA,CAAK,QAAQ,MAAA,CAAO,MAAM,EAAE,IAAA,CAAK,GAAG,EAAE,gBAAA,EAAiB;AAAA,EAChE;AAAA,EAEA,MAAM,KAAK,GAAA,EAA8B;AACvC,IAAA,IAAI;AACF,MAAA,OAAO,MAAMC,2BAAA,CAAW,IAAA,CAAK,iBAAA,CAAkB,GAAG,CAAC,CAAA;AAAA,IACrD,SAAS,KAAA,EAAO;AACd,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,6BAAA,EAAgC,GAAG,CAAA,EAAA,EAAK,KAAK,CAAA,CAAE,CAAA;AAAA,IACjE;AAAA,EACF;AAAA,EAEA,MAAM,OAAA,CACJ,GAAA,EACA,QAAA,EAC0C;AAE1C,IAAA,MAAM,MAAA,GAAS,IAAA,CAAK,iBAAA,CAAkB,GAAG,CAAA;AACzC,IAAA,OAAOC,6CAAA,CAAuB,aAAa,MAAM,CAAA;AAAA,EACnD;AAAA,EAEA,MAAM,QAAA,CACJ,GAAA,EACA,QAAA,EAC2C;AAC3C,IAAA,MAAM,EAAE,MAAA,EAAQ,GAAA,EAAI,GAAI,SAAS,GAAG,CAAA;AAEpC,IAAA,IAAI,GAAA,CAAI,KAAA,CAAM,MAAM,CAAA,EAAG;AACrB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR;AAAA,OACF;AAAA,IACF;AAEA,IAAA,MAAM,CAAC,KAAK,CAAA,GAAI,MAAM,KAAK,OAAA,CAAQ,MAAA,CAAO,MAAM,CAAA,CAAE,QAAA,CAAS;AAAA,MACzD,YAAA,EAAc,IAAA;AAAA,MACd,MAAA,EAAQ;AAAA,KACT,CAAA;AAED,IAAA,MAAM,SAAA,GAAY,KAAA,CACf,MAAA,CAAO,CAAA,IAAA,KAAQ,CAACC,uBAAA,CAAmB,IAAA,CAAK,IAAI,CAAC,CAAA,CAC7C,GAAA,CAAI,CAAA,IAAA,MAAS;AAAA,MACZ,IAAA,EAAM,KAAK,gBAAA,EAAiB;AAAA,MAC5B,IAAA,EAAMC,cAAA,CAAS,GAAA,EAAK,IAAA,CAAK,IAAI,CAAA;AAAA,MAC7B,cAAA,EAAgB,KAAK,QAAA,CAAS,OAAA,GAC1B,IAAI,IAAA,CAAK,IAAA,CAAK,QAAA,CAAS,OAAiB,CAAA,GACxC;AAAA,KACN,CAAE,CAAA;AAEJ,IAAA,OAAO,IAAA,CAAK,IAAA,CAAK,mBAAA,CAAoB,iBAAA,CAAkB,SAAS,CAAA;AAAA,EAClE;AAAA,EAEA,MAAM,MAAA,CACJ,GAAA,EACA,OAAA,EACyC;AACzC,IAAA,MAAM,EAAE,MAAA,EAAQ,GAAA,EAAK,OAAA,EAAQ,GAAI,SAAS,GAAG,CAAA;AAG7C,IAAA,IAAI,CAAC,OAAA,EAAS,KAAA,CAAM,MAAM,CAAA,EAAG;AAC3B,MAAA,IAAI;AACF,QAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,OAAA,CAAQ,KAAK,OAAO,CAAA;AAE5C,QAAA,OAAO;AAAA,UACL,KAAA,EAAO;AAAA,YACL;AAAA,cACE,GAAA;AAAA,cACA,SAAS,IAAA,CAAK,MAAA;AAAA,cACd,gBAAgB,IAAA,CAAK;AAAA;AACvB,WACF;AAAA,UACA,IAAA,EAAM,KAAK,IAAA,IAAQ;AAAA,SACrB;AAAA,MACF,SAAS,CAAA,EAAG;AACV,QAAA,MAAM,KAAA,GAAQC,eAAQ,CAAC,CAAA;AACvB,QAAA,IAAI,KAAA,CAAM,SAAS,eAAA,EAAiB;AAClC,UAAA,OAAO;AAAA,YACL,OAAO,EAAC;AAAA,YACR,IAAA,EAAM;AAAA,WACR;AAAA,QACF;AACA,QAAA,MAAM,KAAA;AAAA,MACR;AAAA,IACF;AAEA,IAAA,IAAI,CAAC,OAAA,CAAQ,QAAA,CAAS,GAAG,CAAA,IAAK,OAAA,CAAQ,OAAA,CAAQ,GAAG,CAAA,KAAM,OAAA,CAAQ,MAAA,GAAS,CAAA,EAAG;AACzE,MAAA,MAAM,IAAI,MAAM,kDAAkD,CAAA;AAAA,IACpE;AAEA,IAAA,MAAM,CAAC,KAAK,CAAA,GAAI,MAAM,KAAK,OAAA,CAAQ,MAAA,CAAO,MAAM,CAAA,CAAE,QAAA,CAAS;AAAA,MACzD,YAAA,EAAc,IAAA;AAAA,MACd,QAAQ,OAAA,CAAQ,KAAA,CAAM,GAAG,CAAA,CAAE,KAAK,EAAE;AAAA,KACnC,CAAA;AAED,IAAA,OAAO;AAAA,MACL,KAAA,EAAO,KAAA,CAAM,GAAA,CAAI,CAAA,IAAA,KAAQ;AACvB,QAAA,MAAM,UAAU,CAAC,SAAA,EAAW,iBAAiB,MAAA,EAAQ,IAAA,CAAK,IAAI,CAAA,CAAE,IAAA;AAAA,UAC9D;AAAA,SACF;AACA,QAAA,OAAO;AAAA,UACL,GAAA,EAAK,OAAA;AAAA,UACL,SAAS,YAAY;AACnB,YAAA,MAAM,YAAA,GAAe,MAAM,IAAA,CAAK,OAAA,CAAQ,OAAO,CAAA;AAC/C,YAAA,OAAO,aAAa,MAAA,EAAO;AAAA,UAC7B;AAAA,SACF;AAAA,MACF,CAAC,CAAA;AAAA;AAAA,MAED,IAAA,EAAM;AAAA,KACR;AAAA,EACF;AAAA,EAEA,QAAA,GAAW;AACT,IAAA,MAAM,GAAA,GAAM,KAAK,WAAA,CAAY,UAAA;AAC7B,IAAA,OAAO,CAAA,eAAA,EAAkB,eAAe,CAAA,QAAA,EAAW,OAAA,CAAQ,GAAG,CAAC,CAAA,CAAA,CAAA;AAAA,EACjE;AACF;;;;"}
1
+ {"version":3,"file":"GoogleGcsUrlReader.cjs.js","sources":["../../../../src/entrypoints/urlReader/lib/GoogleGcsUrlReader.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 * as GoogleCloud from '@google-cloud/storage';\nimport {\n UrlReaderService,\n UrlReaderServiceReadTreeOptions,\n UrlReaderServiceReadTreeResponse,\n UrlReaderServiceReadUrlOptions,\n UrlReaderServiceReadUrlResponse,\n UrlReaderServiceSearchOptions,\n UrlReaderServiceSearchResponse,\n} from '@backstage/backend-plugin-api';\nimport { ReaderFactory, ReadTreeResponseFactory } from './types';\nimport getRawBody from 'raw-body';\nimport {\n GoogleGcsIntegrationConfig,\n readGoogleGcsIntegrationConfig,\n} from '@backstage/integration';\n\nimport { Readable } from 'node:stream';\nimport { ReadUrlResponseFactory } from './ReadUrlResponseFactory';\nimport packageinfo from '../../../../package.json';\nimport { toError } from '@backstage/errors';\nimport { relative } from 'node:path/posix';\nimport { hasDotPathSegments } from './util';\n\nconst GOOGLE_GCS_HOST = 'storage.cloud.google.com';\n\nconst parseURL = (\n url: string,\n): { host: string; bucket: string; key: string } => {\n const { host, pathname } = new URL(url);\n\n if (host !== GOOGLE_GCS_HOST) {\n throw new Error(`not a valid GCS URL: ${url}`);\n }\n\n const [, bucket, ...key] = pathname.split('/');\n return {\n host: host,\n bucket,\n key: key.join('/'),\n };\n};\n\n/**\n * Implements a {@link @backstage/backend-plugin-api#UrlReaderService} for files on Google GCS.\n *\n * @public\n */\nexport class GoogleGcsUrlReader implements UrlReaderService {\n static factory: ReaderFactory = ({ config, logger, treeResponseFactory }) => {\n if (!config.has('integrations.googleGcs')) {\n return [];\n }\n const gcsConfig = readGoogleGcsIntegrationConfig(\n config.getConfig('integrations.googleGcs'),\n );\n let storage: GoogleCloud.Storage;\n if (!gcsConfig.clientEmail || !gcsConfig.privateKey) {\n logger.info(\n 'googleGcs credentials not found in config. Using default credentials provider.',\n );\n storage = new GoogleCloud.Storage({\n userAgent: `backstage/backend-defaults.GoogleGcsUrlReader/${packageinfo.version}`,\n });\n } else {\n storage = new GoogleCloud.Storage({\n credentials: {\n client_email: gcsConfig.clientEmail || undefined,\n private_key: gcsConfig.privateKey || undefined,\n },\n userAgent: `backstage/backend-defaults.GoogleGcsUrlReader/${packageinfo.version}`,\n });\n }\n const reader = new GoogleGcsUrlReader(gcsConfig, storage, {\n treeResponseFactory,\n });\n const predicate = (url: URL) => url.host === GOOGLE_GCS_HOST;\n return [{ reader, predicate }];\n };\n\n private readonly integration: GoogleGcsIntegrationConfig;\n private readonly storage: GoogleCloud.Storage;\n private readonly deps: {\n treeResponseFactory: ReadTreeResponseFactory;\n };\n\n constructor(\n integration: GoogleGcsIntegrationConfig,\n storage: GoogleCloud.Storage,\n deps: {\n treeResponseFactory: ReadTreeResponseFactory;\n },\n ) {\n this.integration = integration;\n this.storage = storage;\n this.deps = deps;\n }\n\n private readStreamFromUrl(url: string): Readable {\n const { bucket, key } = parseURL(url);\n return this.storage.bucket(bucket).file(key).createReadStream();\n }\n\n async read(url: string): Promise<Buffer> {\n try {\n return await getRawBody(this.readStreamFromUrl(url));\n } catch (error) {\n throw new Error(`unable to read gcs file from ${url}, ${error}`);\n }\n }\n\n async readUrl(\n url: string,\n _options?: UrlReaderServiceReadUrlOptions,\n ): Promise<UrlReaderServiceReadUrlResponse> {\n // TODO etag is not implemented yet.\n const stream = this.readStreamFromUrl(url);\n return ReadUrlResponseFactory.fromReadable(stream);\n }\n\n async readTree(\n url: string,\n _options?: UrlReaderServiceReadTreeOptions,\n ): Promise<UrlReaderServiceReadTreeResponse> {\n const { bucket, key } = parseURL(url);\n\n if (key.match(/[*?]/)) {\n throw new Error(\n 'GcsUrlReader readTree does not support glob patterns, use search instead',\n );\n }\n\n const [files] = await this.storage.bucket(bucket).getFiles({\n autoPaginate: true,\n prefix: key,\n });\n\n const responses = files\n .filter(file => !hasDotPathSegments(file.name))\n .map(file => ({\n data: file.createReadStream(),\n path: relative(key, file.name),\n lastModifiedAt: file.metadata.updated\n ? new Date(file.metadata.updated as string)\n : undefined,\n }));\n\n return this.deps.treeResponseFactory.fromReadableArray(responses);\n }\n\n async search(\n url: string,\n options?: UrlReaderServiceSearchOptions,\n ): Promise<UrlReaderServiceSearchResponse> {\n const { bucket, key: pattern } = parseURL(url);\n\n // If it's a direct URL we use readUrl instead\n if (!pattern?.match(/[*?]/)) {\n try {\n const data = await this.readUrl(url, options);\n\n return {\n files: [\n {\n url: url,\n content: data.buffer,\n lastModifiedAt: data.lastModifiedAt,\n },\n ],\n etag: data.etag ?? '',\n };\n } catch (e) {\n const error = toError(e);\n if (error.name === 'NotFoundError') {\n return {\n files: [],\n etag: '',\n };\n }\n throw error;\n }\n }\n\n if (!pattern.endsWith('*') || pattern.indexOf('*') !== pattern.length - 1) {\n throw new Error('GcsUrlReader only supports prefix-based searches');\n }\n\n const [files] = await this.storage.bucket(bucket).getFiles({\n autoPaginate: true,\n prefix: pattern.split('*').join(''),\n });\n\n return {\n files: files.map(file => {\n const fullUrl = ['https:/', GOOGLE_GCS_HOST, bucket, file.name].join(\n '/',\n );\n return {\n url: fullUrl,\n content: async () => {\n const readResponse = await this.readUrl(fullUrl);\n return readResponse.buffer();\n },\n };\n }),\n // TODO etag is not implemented yet.\n etag: 'NOT/IMPLEMENTED',\n };\n }\n\n toString() {\n const key = this.integration.privateKey;\n return `googleGcs{host=${GOOGLE_GCS_HOST},authed=${Boolean(key)}}`;\n }\n}\n"],"names":["readGoogleGcsIntegrationConfig","GoogleCloud","packageinfo","getRawBody","ReadUrlResponseFactory","hasDotPathSegments","relative","toError"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCA,MAAM,eAAA,GAAkB,0BAAA;AAExB,MAAM,QAAA,GAAW,CACf,GAAA,KACkD;AAClD,EAAA,MAAM,EAAE,IAAA,EAAM,QAAA,EAAS,GAAI,IAAI,IAAI,GAAG,CAAA;AAEtC,EAAA,IAAI,SAAS,eAAA,EAAiB;AAC5B,IAAA,MAAM,IAAI,KAAA,CAAM,CAAA,qBAAA,EAAwB,GAAG,CAAA,CAAE,CAAA;AAAA,EAC/C;AAEA,EAAA,MAAM,GAAG,MAAA,EAAQ,GAAG,GAAG,CAAA,GAAI,QAAA,CAAS,MAAM,GAAG,CAAA;AAC7C,EAAA,OAAO;AAAA,IACL,IAAA;AAAA,IACA,MAAA;AAAA,IACA,GAAA,EAAK,GAAA,CAAI,IAAA,CAAK,GAAG;AAAA,GACnB;AACF,CAAA;AAOO,MAAM,kBAAA,CAA+C;AAAA,EAC1D,OAAO,OAAA,GAAyB,CAAC,EAAE,MAAA,EAAQ,MAAA,EAAQ,qBAAoB,KAAM;AAC3E,IAAA,IAAI,CAAC,MAAA,CAAO,GAAA,CAAI,wBAAwB,CAAA,EAAG;AACzC,MAAA,OAAO,EAAC;AAAA,IACV;AACA,IAAA,MAAM,SAAA,GAAYA,0CAAA;AAAA,MAChB,MAAA,CAAO,UAAU,wBAAwB;AAAA,KAC3C;AACA,IAAA,IAAI,OAAA;AACJ,IAAA,IAAI,CAAC,SAAA,CAAU,WAAA,IAAe,CAAC,UAAU,UAAA,EAAY;AACnD,MAAA,MAAA,CAAO,IAAA;AAAA,QACL;AAAA,OACF;AACA,MAAA,OAAA,GAAU,IAAIC,uBAAY,OAAA,CAAQ;AAAA,QAChC,SAAA,EAAW,CAAA,8CAAA,EAAiDC,gBAAA,CAAY,OAAO,CAAA;AAAA,OAChF,CAAA;AAAA,IACH,CAAA,MAAO;AACL,MAAA,OAAA,GAAU,IAAID,uBAAY,OAAA,CAAQ;AAAA,QAChC,WAAA,EAAa;AAAA,UACX,YAAA,EAAc,UAAU,WAAA,IAAe,MAAA;AAAA,UACvC,WAAA,EAAa,UAAU,UAAA,IAAc;AAAA,SACvC;AAAA,QACA,SAAA,EAAW,CAAA,8CAAA,EAAiDC,gBAAA,CAAY,OAAO,CAAA;AAAA,OAChF,CAAA;AAAA,IACH;AACA,IAAA,MAAM,MAAA,GAAS,IAAI,kBAAA,CAAmB,SAAA,EAAW,OAAA,EAAS;AAAA,MACxD;AAAA,KACD,CAAA;AACD,IAAA,MAAM,SAAA,GAAY,CAAC,GAAA,KAAa,GAAA,CAAI,IAAA,KAAS,eAAA;AAC7C,IAAA,OAAO,CAAC,EAAE,MAAA,EAAQ,SAAA,EAAW,CAAA;AAAA,EAC/B,CAAA;AAAA,EAEiB,WAAA;AAAA,EACA,OAAA;AAAA,EACA,IAAA;AAAA,EAIjB,WAAA,CACE,WAAA,EACA,OAAA,EACA,IAAA,EAGA;AACA,IAAA,IAAA,CAAK,WAAA,GAAc,WAAA;AACnB,IAAA,IAAA,CAAK,OAAA,GAAU,OAAA;AACf,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;AAAA,EACd;AAAA,EAEQ,kBAAkB,GAAA,EAAuB;AAC/C,IAAA,MAAM,EAAE,MAAA,EAAQ,GAAA,EAAI,GAAI,SAAS,GAAG,CAAA;AACpC,IAAA,OAAO,IAAA,CAAK,QAAQ,MAAA,CAAO,MAAM,EAAE,IAAA,CAAK,GAAG,EAAE,gBAAA,EAAiB;AAAA,EAChE;AAAA,EAEA,MAAM,KAAK,GAAA,EAA8B;AACvC,IAAA,IAAI;AACF,MAAA,OAAO,MAAMC,2BAAA,CAAW,IAAA,CAAK,iBAAA,CAAkB,GAAG,CAAC,CAAA;AAAA,IACrD,SAAS,KAAA,EAAO;AACd,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,6BAAA,EAAgC,GAAG,CAAA,EAAA,EAAK,KAAK,CAAA,CAAE,CAAA;AAAA,IACjE;AAAA,EACF;AAAA,EAEA,MAAM,OAAA,CACJ,GAAA,EACA,QAAA,EAC0C;AAE1C,IAAA,MAAM,MAAA,GAAS,IAAA,CAAK,iBAAA,CAAkB,GAAG,CAAA;AACzC,IAAA,OAAOC,6CAAA,CAAuB,aAAa,MAAM,CAAA;AAAA,EACnD;AAAA,EAEA,MAAM,QAAA,CACJ,GAAA,EACA,QAAA,EAC2C;AAC3C,IAAA,MAAM,EAAE,MAAA,EAAQ,GAAA,EAAI,GAAI,SAAS,GAAG,CAAA;AAEpC,IAAA,IAAI,GAAA,CAAI,KAAA,CAAM,MAAM,CAAA,EAAG;AACrB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR;AAAA,OACF;AAAA,IACF;AAEA,IAAA,MAAM,CAAC,KAAK,CAAA,GAAI,MAAM,KAAK,OAAA,CAAQ,MAAA,CAAO,MAAM,CAAA,CAAE,QAAA,CAAS;AAAA,MACzD,YAAA,EAAc,IAAA;AAAA,MACd,MAAA,EAAQ;AAAA,KACT,CAAA;AAED,IAAA,MAAM,SAAA,GAAY,KAAA,CACf,MAAA,CAAO,CAAA,IAAA,KAAQ,CAACC,uBAAA,CAAmB,IAAA,CAAK,IAAI,CAAC,CAAA,CAC7C,GAAA,CAAI,CAAA,IAAA,MAAS;AAAA,MACZ,IAAA,EAAM,KAAK,gBAAA,EAAiB;AAAA,MAC5B,IAAA,EAAMC,cAAA,CAAS,GAAA,EAAK,IAAA,CAAK,IAAI,CAAA;AAAA,MAC7B,cAAA,EAAgB,KAAK,QAAA,CAAS,OAAA,GAC1B,IAAI,IAAA,CAAK,IAAA,CAAK,QAAA,CAAS,OAAiB,CAAA,GACxC;AAAA,KACN,CAAE,CAAA;AAEJ,IAAA,OAAO,IAAA,CAAK,IAAA,CAAK,mBAAA,CAAoB,iBAAA,CAAkB,SAAS,CAAA;AAAA,EAClE;AAAA,EAEA,MAAM,MAAA,CACJ,GAAA,EACA,OAAA,EACyC;AACzC,IAAA,MAAM,EAAE,MAAA,EAAQ,GAAA,EAAK,OAAA,EAAQ,GAAI,SAAS,GAAG,CAAA;AAG7C,IAAA,IAAI,CAAC,OAAA,EAAS,KAAA,CAAM,MAAM,CAAA,EAAG;AAC3B,MAAA,IAAI;AACF,QAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,OAAA,CAAQ,KAAK,OAAO,CAAA;AAE5C,QAAA,OAAO;AAAA,UACL,KAAA,EAAO;AAAA,YACL;AAAA,cACE,GAAA;AAAA,cACA,SAAS,IAAA,CAAK,MAAA;AAAA,cACd,gBAAgB,IAAA,CAAK;AAAA;AACvB,WACF;AAAA,UACA,IAAA,EAAM,KAAK,IAAA,IAAQ;AAAA,SACrB;AAAA,MACF,SAAS,CAAA,EAAG;AACV,QAAA,MAAM,KAAA,GAAQC,eAAQ,CAAC,CAAA;AACvB,QAAA,IAAI,KAAA,CAAM,SAAS,eAAA,EAAiB;AAClC,UAAA,OAAO;AAAA,YACL,OAAO,EAAC;AAAA,YACR,IAAA,EAAM;AAAA,WACR;AAAA,QACF;AACA,QAAA,MAAM,KAAA;AAAA,MACR;AAAA,IACF;AAEA,IAAA,IAAI,CAAC,OAAA,CAAQ,QAAA,CAAS,GAAG,CAAA,IAAK,OAAA,CAAQ,OAAA,CAAQ,GAAG,CAAA,KAAM,OAAA,CAAQ,MAAA,GAAS,CAAA,EAAG;AACzE,MAAA,MAAM,IAAI,MAAM,kDAAkD,CAAA;AAAA,IACpE;AAEA,IAAA,MAAM,CAAC,KAAK,CAAA,GAAI,MAAM,KAAK,OAAA,CAAQ,MAAA,CAAO,MAAM,CAAA,CAAE,QAAA,CAAS;AAAA,MACzD,YAAA,EAAc,IAAA;AAAA,MACd,QAAQ,OAAA,CAAQ,KAAA,CAAM,GAAG,CAAA,CAAE,KAAK,EAAE;AAAA,KACnC,CAAA;AAED,IAAA,OAAO;AAAA,MACL,KAAA,EAAO,KAAA,CAAM,GAAA,CAAI,CAAA,IAAA,KAAQ;AACvB,QAAA,MAAM,UAAU,CAAC,SAAA,EAAW,iBAAiB,MAAA,EAAQ,IAAA,CAAK,IAAI,CAAA,CAAE,IAAA;AAAA,UAC9D;AAAA,SACF;AACA,QAAA,OAAO;AAAA,UACL,GAAA,EAAK,OAAA;AAAA,UACL,SAAS,YAAY;AACnB,YAAA,MAAM,YAAA,GAAe,MAAM,IAAA,CAAK,OAAA,CAAQ,OAAO,CAAA;AAC/C,YAAA,OAAO,aAAa,MAAA,EAAO;AAAA,UAC7B;AAAA,SACF;AAAA,MACF,CAAC,CAAA;AAAA;AAAA,MAED,IAAA,EAAM;AAAA,KACR;AAAA,EACF;AAAA,EAEA,QAAA,GAAW;AACT,IAAA,MAAM,GAAA,GAAM,KAAK,WAAA,CAAY,UAAA;AAC7B,IAAA,OAAO,CAAA,eAAA,EAAkB,eAAe,CAAA,QAAA,EAAW,OAAA,CAAQ,GAAG,CAAC,CAAA,CAAA,CAAA;AAAA,EACjE;AACF;;"}
@@ -1 +1 @@
1
- {"version":3,"file":"HarnessUrlReader.cjs.js","sources":["../../../../src/entrypoints/urlReader/lib/HarnessUrlReader.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n UrlReaderService,\n UrlReaderServiceReadTreeResponse,\n UrlReaderServiceReadUrlOptions,\n UrlReaderServiceReadUrlResponse,\n UrlReaderServiceSearchResponse,\n UrlReaderServiceReadTreeOptions,\n UrlReaderServiceSearchOptions,\n} from '@backstage/backend-plugin-api';\nimport {\n getHarnessRequestOptions,\n getHarnessFileContentsUrl,\n HarnessIntegration,\n ScmIntegrations,\n getHarnessLatestCommitUrl,\n getHarnessArchiveUrl,\n parseHarnessUrl,\n} from '@backstage/integration';\nimport { ReadTreeResponseFactory, ReaderFactory } from './types';\nimport fetch, { Response } from 'node-fetch';\nimport { ReadUrlResponseFactory } from './ReadUrlResponseFactory';\nimport {\n toError,\n AuthenticationError,\n NotFoundError,\n NotModifiedError,\n} from '@backstage/errors';\nimport { Readable } from 'node:stream';\nimport { predicateFromConfig } from './FetchUrlReader';\n\nconst REDIRECT_STATUS_CODES = [301, 302, 303, 307, 308];\nconst MAX_REDIRECTS = 5;\n\n/**\n * Implements a {@link @backstage/backend-plugin-api#UrlReaderService} for the Harness code v1 api.\n *\n *\n * @public\n */\nexport class HarnessUrlReader implements UrlReaderService {\n static factory: ReaderFactory = ({ config, treeResponseFactory }) => {\n const allowedRedirectPredicate = predicateFromConfig(config);\n return ScmIntegrations.fromConfig(config)\n .harness.list()\n .map(integration => {\n const reader = new HarnessUrlReader(integration, {\n treeResponseFactory,\n allowedRedirectPredicate,\n });\n const predicate = (url: URL) => {\n return url.host === integration.config.host;\n };\n return { reader, predicate };\n });\n };\n\n private readonly integration: HarnessIntegration;\n private readonly deps: {\n treeResponseFactory: ReadTreeResponseFactory;\n allowedRedirectPredicate?: (url: URL) => boolean;\n };\n private readonly allowedRedirectPredicate: (url: URL) => boolean;\n\n constructor(\n integration: HarnessIntegration,\n deps: {\n treeResponseFactory: ReadTreeResponseFactory;\n allowedRedirectPredicate?: (url: URL) => boolean;\n },\n ) {\n this.integration = integration;\n this.deps = deps;\n this.allowedRedirectPredicate =\n deps.allowedRedirectPredicate ?? (() => false);\n }\n async read(url: string): Promise<Buffer> {\n const response = await this.readUrl(url);\n return response.buffer();\n }\n\n async readUrl(\n url: string,\n options?: UrlReaderServiceReadUrlOptions,\n ): Promise<UrlReaderServiceReadUrlResponse> {\n const blobUrl = getHarnessFileContentsUrl(this.integration.config, url);\n const response = await this.fetchUrl(blobUrl, options?.signal);\n\n if (response.ok) {\n // Harness Code returns the raw content object\n const jsonResponse = { data: response.body };\n if (jsonResponse) {\n return ReadUrlResponseFactory.fromReadable(\n Readable.from(jsonResponse.data),\n {\n etag: response.headers.get('ETag') ?? undefined,\n },\n );\n }\n\n throw new Error(`Unknown json: ${jsonResponse}`);\n }\n\n const message = `${url} x ${blobUrl}, ${response.status} ${response.statusText}`;\n if (response.status === 404) {\n throw new NotFoundError(message);\n }\n\n if (response.status === 304) {\n throw new NotModifiedError();\n }\n\n if (response.status === 403) {\n throw new AuthenticationError();\n }\n\n throw new Error(message);\n }\n\n async readTree(\n url: string,\n options?: UrlReaderServiceReadTreeOptions,\n ): Promise<UrlReaderServiceReadTreeResponse> {\n const lastCommitHash = await this.getLastCommitHash(url);\n\n if (options?.etag && options.etag === lastCommitHash) {\n throw new NotModifiedError();\n }\n\n const archiveUri = getHarnessArchiveUrl(this.integration.config, url);\n\n const response = await this.fetchUrl(archiveUri, options?.signal);\n\n const parsedUri = parseHarnessUrl(this.integration.config, url);\n\n return this.deps.treeResponseFactory.fromZipArchive({\n stream: Readable.from(response.body),\n subpath: parsedUri.path,\n etag: lastCommitHash,\n filter: options?.filter,\n });\n }\n\n async search(\n url: string,\n options?: UrlReaderServiceSearchOptions,\n ): Promise<UrlReaderServiceSearchResponse> {\n const { path } = parseHarnessUrl(this.integration.config, url);\n\n if (path.match(/[*?]/)) {\n throw new Error('Unsupported search pattern URL');\n }\n\n try {\n const data = await this.readUrl(url, options);\n\n return {\n files: [\n {\n url: url,\n content: data.buffer,\n lastModifiedAt: data.lastModifiedAt,\n },\n ],\n etag: data.etag ?? '',\n };\n } catch (e) {\n const error = toError(e);\n if (error.name === 'NotFoundError') {\n return {\n files: [],\n etag: '',\n };\n }\n throw error;\n }\n }\n\n toString() {\n const { host } = this.integration.config;\n return `harness{host=${host},authed=${Boolean(\n this.integration.config.token || this.integration.config.apiKey,\n )}}`;\n }\n\n private async fetchUrl(url: string, signal?: AbortSignal): Promise<Response> {\n const configuredOrigin = new URL(`https://${this.integration.config.host}`)\n .origin;\n let currentUrl = url;\n let includeCredentials = true;\n\n for (let redirectCount = 0; ; redirectCount += 1) {\n const currentUrlObject = new URL(currentUrl);\n const requestOptions =\n includeCredentials && currentUrlObject.origin === configuredOrigin\n ? getHarnessRequestOptions(this.integration.config)\n : {};\n let response: Response;\n try {\n response = await fetch(currentUrl, {\n method: 'GET',\n ...requestOptions,\n redirect: 'manual',\n signal: signal as any,\n });\n } catch (e) {\n throw new Error(`Unable to read ${currentUrl}, ${e}`);\n }\n\n const location = response.headers.get('location');\n if (!REDIRECT_STATUS_CODES.includes(response.status) || !location) {\n return response;\n }\n\n response.body.resume();\n\n let redirectUrl: URL;\n try {\n redirectUrl = new URL(location, currentUrl);\n } catch (e) {\n throw new Error(\n `Unable to read ${currentUrl}, invalid redirect URL ${location}, ${e}`,\n );\n }\n\n if (\n redirectUrl.origin !== configuredOrigin &&\n !this.allowedRedirectPredicate(redirectUrl)\n ) {\n throw new Error(\n `Refusing to follow cross-origin Harness redirect to ${redirectUrl.origin}`,\n );\n }\n\n if (redirectUrl.origin !== configuredOrigin) {\n includeCredentials = false;\n }\n\n if (redirectCount === MAX_REDIRECTS) {\n throw new Error(\n `Too many redirects (max ${MAX_REDIRECTS}) when reading ${url}`,\n );\n }\n\n currentUrl = redirectUrl.toString();\n }\n }\n\n private async getLastCommitHash(url: string): Promise<string> {\n const commitUri = getHarnessLatestCommitUrl(this.integration.config, url);\n\n const response = await this.fetchUrl(commitUri);\n if (!response.ok) {\n const message = `Failed to retrieve latest commit information from ${commitUri}, ${response.status} ${response.statusText}`;\n if (response.status === 404) {\n throw new NotFoundError(message);\n }\n throw new Error(message);\n }\n\n return (await response.json()).latest_commit.sha;\n }\n}\n"],"names":["predicateFromConfig","ScmIntegrations","getHarnessFileContentsUrl","ReadUrlResponseFactory","Readable","NotFoundError","NotModifiedError","AuthenticationError","getHarnessArchiveUrl","parseHarnessUrl","toError","getHarnessRequestOptions","fetch","getHarnessLatestCommitUrl"],"mappings":";;;;;;;;;;;;;AA8CA,MAAM,wBAAwB,CAAC,GAAA,EAAK,GAAA,EAAK,GAAA,EAAK,KAAK,GAAG,CAAA;AACtD,MAAM,aAAA,GAAgB,CAAA;AAQf,MAAM,gBAAA,CAA6C;AAAA,EACxD,OAAO,OAAA,GAAyB,CAAC,EAAE,MAAA,EAAQ,qBAAoB,KAAM;AACnE,IAAA,MAAM,wBAAA,GAA2BA,mCAAoB,MAAM,CAAA;AAC3D,IAAA,OAAOC,2BAAA,CAAgB,WAAW,MAAM,CAAA,CACrC,QAAQ,IAAA,EAAK,CACb,IAAI,CAAA,WAAA,KAAe;AAClB,MAAA,MAAM,MAAA,GAAS,IAAI,gBAAA,CAAiB,WAAA,EAAa;AAAA,QAC/C,mBAAA;AAAA,QACA;AAAA,OACD,CAAA;AACD,MAAA,MAAM,SAAA,GAAY,CAAC,GAAA,KAAa;AAC9B,QAAA,OAAO,GAAA,CAAI,IAAA,KAAS,WAAA,CAAY,MAAA,CAAO,IAAA;AAAA,MACzC,CAAA;AACA,MAAA,OAAO,EAAE,QAAQ,SAAA,EAAU;AAAA,IAC7B,CAAC,CAAA;AAAA,EACL,CAAA;AAAA,EAEiB,WAAA;AAAA,EACA,IAAA;AAAA,EAIA,wBAAA;AAAA,EAEjB,WAAA,CACE,aACA,IAAA,EAIA;AACA,IAAA,IAAA,CAAK,WAAA,GAAc,WAAA;AACnB,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;AACZ,IAAA,IAAA,CAAK,wBAAA,GACH,IAAA,CAAK,wBAAA,KAA6B,MAAM,KAAA,CAAA;AAAA,EAC5C;AAAA,EACA,MAAM,KAAK,GAAA,EAA8B;AACvC,IAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,OAAA,CAAQ,GAAG,CAAA;AACvC,IAAA,OAAO,SAAS,MAAA,EAAO;AAAA,EACzB;AAAA,EAEA,MAAM,OAAA,CACJ,GAAA,EACA,OAAA,EAC0C;AAC1C,IAAA,MAAM,OAAA,GAAUC,qCAAA,CAA0B,IAAA,CAAK,WAAA,CAAY,QAAQ,GAAG,CAAA;AACtE,IAAA,MAAM,WAAW,MAAM,IAAA,CAAK,QAAA,CAAS,OAAA,EAAS,SAAS,MAAM,CAAA;AAE7D,IAAA,IAAI,SAAS,EAAA,EAAI;AAEf,MAAA,MAAM,YAAA,GAAe,EAAE,IAAA,EAAM,QAAA,CAAS,IAAA,EAAK;AAC3C,MAAA,IAAI,YAAA,EAAc;AAChB,QAAA,OAAOC,6CAAA,CAAuB,YAAA;AAAA,UAC5BC,oBAAA,CAAS,IAAA,CAAK,YAAA,CAAa,IAAI,CAAA;AAAA,UAC/B;AAAA,YACE,IAAA,EAAM,QAAA,CAAS,OAAA,CAAQ,GAAA,CAAI,MAAM,CAAA,IAAK;AAAA;AACxC,SACF;AAAA,MACF;AAEA,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,cAAA,EAAiB,YAAY,CAAA,CAAE,CAAA;AAAA,IACjD;AAEA,IAAA,MAAM,OAAA,GAAU,CAAA,EAAG,GAAG,CAAA,GAAA,EAAM,OAAO,KAAK,QAAA,CAAS,MAAM,CAAA,CAAA,EAAI,QAAA,CAAS,UAAU,CAAA,CAAA;AAC9E,IAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,MAAA,MAAM,IAAIC,qBAAc,OAAO,CAAA;AAAA,IACjC;AAEA,IAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,MAAA,MAAM,IAAIC,uBAAA,EAAiB;AAAA,IAC7B;AAEA,IAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,MAAA,MAAM,IAAIC,0BAAA,EAAoB;AAAA,IAChC;AAEA,IAAA,MAAM,IAAI,MAAM,OAAO,CAAA;AAAA,EACzB;AAAA,EAEA,MAAM,QAAA,CACJ,GAAA,EACA,OAAA,EAC2C;AAC3C,IAAA,MAAM,cAAA,GAAiB,MAAM,IAAA,CAAK,iBAAA,CAAkB,GAAG,CAAA;AAEvD,IAAA,IAAI,OAAA,EAAS,IAAA,IAAQ,OAAA,CAAQ,IAAA,KAAS,cAAA,EAAgB;AACpD,MAAA,MAAM,IAAID,uBAAA,EAAiB;AAAA,IAC7B;AAEA,IAAA,MAAM,UAAA,GAAaE,gCAAA,CAAqB,IAAA,CAAK,WAAA,CAAY,QAAQ,GAAG,CAAA;AAEpE,IAAA,MAAM,WAAW,MAAM,IAAA,CAAK,QAAA,CAAS,UAAA,EAAY,SAAS,MAAM,CAAA;AAEhE,IAAA,MAAM,SAAA,GAAYC,2BAAA,CAAgB,IAAA,CAAK,WAAA,CAAY,QAAQ,GAAG,CAAA;AAE9D,IAAA,OAAO,IAAA,CAAK,IAAA,CAAK,mBAAA,CAAoB,cAAA,CAAe;AAAA,MAClD,MAAA,EAAQL,oBAAA,CAAS,IAAA,CAAK,QAAA,CAAS,IAAI,CAAA;AAAA,MACnC,SAAS,SAAA,CAAU,IAAA;AAAA,MACnB,IAAA,EAAM,cAAA;AAAA,MACN,QAAQ,OAAA,EAAS;AAAA,KAClB,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,MAAA,CACJ,GAAA,EACA,OAAA,EACyC;AACzC,IAAA,MAAM,EAAE,IAAA,EAAK,GAAIK,4BAAgB,IAAA,CAAK,WAAA,CAAY,QAAQ,GAAG,CAAA;AAE7D,IAAA,IAAI,IAAA,CAAK,KAAA,CAAM,MAAM,CAAA,EAAG;AACtB,MAAA,MAAM,IAAI,MAAM,gCAAgC,CAAA;AAAA,IAClD;AAEA,IAAA,IAAI;AACF,MAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,OAAA,CAAQ,KAAK,OAAO,CAAA;AAE5C,MAAA,OAAO;AAAA,QACL,KAAA,EAAO;AAAA,UACL;AAAA,YACE,GAAA;AAAA,YACA,SAAS,IAAA,CAAK,MAAA;AAAA,YACd,gBAAgB,IAAA,CAAK;AAAA;AACvB,SACF;AAAA,QACA,IAAA,EAAM,KAAK,IAAA,IAAQ;AAAA,OACrB;AAAA,IACF,SAAS,CAAA,EAAG;AACV,MAAA,MAAM,KAAA,GAAQC,eAAQ,CAAC,CAAA;AACvB,MAAA,IAAI,KAAA,CAAM,SAAS,eAAA,EAAiB;AAClC,QAAA,OAAO;AAAA,UACL,OAAO,EAAC;AAAA,UACR,IAAA,EAAM;AAAA,SACR;AAAA,MACF;AACA,MAAA,MAAM,KAAA;AAAA,IACR;AAAA,EACF;AAAA,EAEA,QAAA,GAAW;AACT,IAAA,MAAM,EAAE,IAAA,EAAK,GAAI,IAAA,CAAK,WAAA,CAAY,MAAA;AAClC,IAAA,OAAO,CAAA,aAAA,EAAgB,IAAI,CAAA,QAAA,EAAW,OAAA;AAAA,MACpC,KAAK,WAAA,CAAY,MAAA,CAAO,KAAA,IAAS,IAAA,CAAK,YAAY,MAAA,CAAO;AAAA,KAC1D,CAAA,CAAA,CAAA;AAAA,EACH;AAAA,EAEA,MAAc,QAAA,CAAS,GAAA,EAAa,MAAA,EAAyC;AAC3E,IAAA,MAAM,gBAAA,GAAmB,IAAI,GAAA,CAAI,CAAA,QAAA,EAAW,KAAK,WAAA,CAAY,MAAA,CAAO,IAAI,CAAA,CAAE,CAAA,CACvE,MAAA;AACH,IAAA,IAAI,UAAA,GAAa,GAAA;AACjB,IAAA,IAAI,kBAAA,GAAqB,IAAA;AAEzB,IAAA,KAAA,IAAS,aAAA,GAAgB,CAAA,IAAK,aAAA,IAAiB,CAAA,EAAG;AAChD,MAAA,MAAM,gBAAA,GAAmB,IAAI,GAAA,CAAI,UAAU,CAAA;AAC3C,MAAA,MAAM,cAAA,GACJ,kBAAA,IAAsB,gBAAA,CAAiB,MAAA,KAAW,gBAAA,GAC9CC,qCAAyB,IAAA,CAAK,WAAA,CAAY,MAAM,CAAA,GAChD,EAAC;AACP,MAAA,IAAI,QAAA;AACJ,MAAA,IAAI;AACF,QAAA,QAAA,GAAW,MAAMC,uBAAM,UAAA,EAAY;AAAA,UACjC,MAAA,EAAQ,KAAA;AAAA,UACR,GAAG,cAAA;AAAA,UACH,QAAA,EAAU,QAAA;AAAA,UACV;AAAA,SACD,CAAA;AAAA,MACH,SAAS,CAAA,EAAG;AACV,QAAA,MAAM,IAAI,KAAA,CAAM,CAAA,eAAA,EAAkB,UAAU,CAAA,EAAA,EAAK,CAAC,CAAA,CAAE,CAAA;AAAA,MACtD;AAEA,MAAA,MAAM,QAAA,GAAW,QAAA,CAAS,OAAA,CAAQ,GAAA,CAAI,UAAU,CAAA;AAChD,MAAA,IAAI,CAAC,qBAAA,CAAsB,QAAA,CAAS,SAAS,MAAM,CAAA,IAAK,CAAC,QAAA,EAAU;AACjE,QAAA,OAAO,QAAA;AAAA,MACT;AAEA,MAAA,QAAA,CAAS,KAAK,MAAA,EAAO;AAErB,MAAA,IAAI,WAAA;AACJ,MAAA,IAAI;AACF,QAAA,WAAA,GAAc,IAAI,GAAA,CAAI,QAAA,EAAU,UAAU,CAAA;AAAA,MAC5C,SAAS,CAAA,EAAG;AACV,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,eAAA,EAAkB,UAAU,CAAA,uBAAA,EAA0B,QAAQ,KAAK,CAAC,CAAA;AAAA,SACtE;AAAA,MACF;AAEA,MAAA,IACE,YAAY,MAAA,KAAW,gBAAA,IACvB,CAAC,IAAA,CAAK,wBAAA,CAAyB,WAAW,CAAA,EAC1C;AACA,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,oDAAA,EAAuD,YAAY,MAAM,CAAA;AAAA,SAC3E;AAAA,MACF;AAEA,MAAA,IAAI,WAAA,CAAY,WAAW,gBAAA,EAAkB;AAC3C,QAAA,kBAAA,GAAqB,KAAA;AAAA,MACvB;AAEA,MAAA,IAAI,kBAAkB,aAAA,EAAe;AACnC,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,wBAAA,EAA2B,aAAa,CAAA,eAAA,EAAkB,GAAG,CAAA;AAAA,SAC/D;AAAA,MACF;AAEA,MAAA,UAAA,GAAa,YAAY,QAAA,EAAS;AAAA,IACpC;AAAA,EACF;AAAA,EAEA,MAAc,kBAAkB,GAAA,EAA8B;AAC5D,IAAA,MAAM,SAAA,GAAYC,qCAAA,CAA0B,IAAA,CAAK,WAAA,CAAY,QAAQ,GAAG,CAAA;AAExE,IAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,QAAA,CAAS,SAAS,CAAA;AAC9C,IAAA,IAAI,CAAC,SAAS,EAAA,EAAI;AAChB,MAAA,MAAM,OAAA,GAAU,qDAAqD,SAAS,CAAA,EAAA,EAAK,SAAS,MAAM,CAAA,CAAA,EAAI,SAAS,UAAU,CAAA,CAAA;AACzH,MAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,QAAA,MAAM,IAAIR,qBAAc,OAAO,CAAA;AAAA,MACjC;AACA,MAAA,MAAM,IAAI,MAAM,OAAO,CAAA;AAAA,IACzB;AAEA,IAAA,OAAA,CAAQ,MAAM,QAAA,CAAS,IAAA,EAAK,EAAG,aAAA,CAAc,GAAA;AAAA,EAC/C;AACF;;;;"}
1
+ {"version":3,"file":"HarnessUrlReader.cjs.js","sources":["../../../../src/entrypoints/urlReader/lib/HarnessUrlReader.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n UrlReaderService,\n UrlReaderServiceReadTreeResponse,\n UrlReaderServiceReadUrlOptions,\n UrlReaderServiceReadUrlResponse,\n UrlReaderServiceSearchResponse,\n UrlReaderServiceReadTreeOptions,\n UrlReaderServiceSearchOptions,\n} from '@backstage/backend-plugin-api';\nimport {\n getHarnessRequestOptions,\n getHarnessFileContentsUrl,\n HarnessIntegration,\n ScmIntegrations,\n getHarnessLatestCommitUrl,\n getHarnessArchiveUrl,\n parseHarnessUrl,\n} from '@backstage/integration';\nimport { ReadTreeResponseFactory, ReaderFactory } from './types';\nimport fetch, { Response } from 'node-fetch';\nimport { ReadUrlResponseFactory } from './ReadUrlResponseFactory';\nimport {\n toError,\n AuthenticationError,\n NotFoundError,\n NotModifiedError,\n} from '@backstage/errors';\nimport { Readable } from 'node:stream';\nimport { predicateFromConfig } from './FetchUrlReader';\n\nconst REDIRECT_STATUS_CODES = [301, 302, 303, 307, 308];\nconst MAX_REDIRECTS = 5;\n\n/**\n * Implements a {@link @backstage/backend-plugin-api#UrlReaderService} for the Harness code v1 api.\n *\n *\n * @public\n */\nexport class HarnessUrlReader implements UrlReaderService {\n static factory: ReaderFactory = ({ config, treeResponseFactory }) => {\n const allowedRedirectPredicate = predicateFromConfig(config);\n return ScmIntegrations.fromConfig(config)\n .harness.list()\n .map(integration => {\n const reader = new HarnessUrlReader(integration, {\n treeResponseFactory,\n allowedRedirectPredicate,\n });\n const predicate = (url: URL) => {\n return url.host === integration.config.host;\n };\n return { reader, predicate };\n });\n };\n\n private readonly integration: HarnessIntegration;\n private readonly deps: {\n treeResponseFactory: ReadTreeResponseFactory;\n allowedRedirectPredicate?: (url: URL) => boolean;\n };\n private readonly allowedRedirectPredicate: (url: URL) => boolean;\n\n constructor(\n integration: HarnessIntegration,\n deps: {\n treeResponseFactory: ReadTreeResponseFactory;\n allowedRedirectPredicate?: (url: URL) => boolean;\n },\n ) {\n this.integration = integration;\n this.deps = deps;\n this.allowedRedirectPredicate =\n deps.allowedRedirectPredicate ?? (() => false);\n }\n async read(url: string): Promise<Buffer> {\n const response = await this.readUrl(url);\n return response.buffer();\n }\n\n async readUrl(\n url: string,\n options?: UrlReaderServiceReadUrlOptions,\n ): Promise<UrlReaderServiceReadUrlResponse> {\n const blobUrl = getHarnessFileContentsUrl(this.integration.config, url);\n const response = await this.fetchUrl(blobUrl, options?.signal);\n\n if (response.ok) {\n // Harness Code returns the raw content object\n const jsonResponse = { data: response.body };\n if (jsonResponse) {\n return ReadUrlResponseFactory.fromReadable(\n Readable.from(jsonResponse.data),\n {\n etag: response.headers.get('ETag') ?? undefined,\n },\n );\n }\n\n throw new Error(`Unknown json: ${jsonResponse}`);\n }\n\n const message = `${url} x ${blobUrl}, ${response.status} ${response.statusText}`;\n if (response.status === 404) {\n throw new NotFoundError(message);\n }\n\n if (response.status === 304) {\n throw new NotModifiedError();\n }\n\n if (response.status === 403) {\n throw new AuthenticationError();\n }\n\n throw new Error(message);\n }\n\n async readTree(\n url: string,\n options?: UrlReaderServiceReadTreeOptions,\n ): Promise<UrlReaderServiceReadTreeResponse> {\n const lastCommitHash = await this.getLastCommitHash(url);\n\n if (options?.etag && options.etag === lastCommitHash) {\n throw new NotModifiedError();\n }\n\n const archiveUri = getHarnessArchiveUrl(this.integration.config, url);\n\n const response = await this.fetchUrl(archiveUri, options?.signal);\n\n const parsedUri = parseHarnessUrl(this.integration.config, url);\n\n return this.deps.treeResponseFactory.fromZipArchive({\n stream: Readable.from(response.body),\n subpath: parsedUri.path,\n etag: lastCommitHash,\n filter: options?.filter,\n });\n }\n\n async search(\n url: string,\n options?: UrlReaderServiceSearchOptions,\n ): Promise<UrlReaderServiceSearchResponse> {\n const { path } = parseHarnessUrl(this.integration.config, url);\n\n if (path.match(/[*?]/)) {\n throw new Error('Unsupported search pattern URL');\n }\n\n try {\n const data = await this.readUrl(url, options);\n\n return {\n files: [\n {\n url: url,\n content: data.buffer,\n lastModifiedAt: data.lastModifiedAt,\n },\n ],\n etag: data.etag ?? '',\n };\n } catch (e) {\n const error = toError(e);\n if (error.name === 'NotFoundError') {\n return {\n files: [],\n etag: '',\n };\n }\n throw error;\n }\n }\n\n toString() {\n const { host } = this.integration.config;\n return `harness{host=${host},authed=${Boolean(\n this.integration.config.token || this.integration.config.apiKey,\n )}}`;\n }\n\n private async fetchUrl(url: string, signal?: AbortSignal): Promise<Response> {\n const configuredOrigin = new URL(`https://${this.integration.config.host}`)\n .origin;\n let currentUrl = url;\n let includeCredentials = true;\n\n for (let redirectCount = 0; ; redirectCount += 1) {\n const currentUrlObject = new URL(currentUrl);\n const requestOptions =\n includeCredentials && currentUrlObject.origin === configuredOrigin\n ? getHarnessRequestOptions(this.integration.config)\n : {};\n let response: Response;\n try {\n response = await fetch(currentUrl, {\n method: 'GET',\n ...requestOptions,\n redirect: 'manual',\n signal: signal as any,\n });\n } catch (e) {\n throw new Error(`Unable to read ${currentUrl}, ${e}`);\n }\n\n const location = response.headers.get('location');\n if (!REDIRECT_STATUS_CODES.includes(response.status) || !location) {\n return response;\n }\n\n response.body.resume();\n\n let redirectUrl: URL;\n try {\n redirectUrl = new URL(location, currentUrl);\n } catch (e) {\n throw new Error(\n `Unable to read ${currentUrl}, invalid redirect URL ${location}, ${e}`,\n );\n }\n\n if (\n redirectUrl.origin !== configuredOrigin &&\n !this.allowedRedirectPredicate(redirectUrl)\n ) {\n throw new Error(\n `Refusing to follow cross-origin Harness redirect to ${redirectUrl.origin}`,\n );\n }\n\n if (redirectUrl.origin !== configuredOrigin) {\n includeCredentials = false;\n }\n\n if (redirectCount === MAX_REDIRECTS) {\n throw new Error(\n `Too many redirects (max ${MAX_REDIRECTS}) when reading ${url}`,\n );\n }\n\n currentUrl = redirectUrl.toString();\n }\n }\n\n private async getLastCommitHash(url: string): Promise<string> {\n const commitUri = getHarnessLatestCommitUrl(this.integration.config, url);\n\n const response = await this.fetchUrl(commitUri);\n if (!response.ok) {\n const message = `Failed to retrieve latest commit information from ${commitUri}, ${response.status} ${response.statusText}`;\n if (response.status === 404) {\n throw new NotFoundError(message);\n }\n throw new Error(message);\n }\n\n return (await response.json()).latest_commit.sha;\n }\n}\n"],"names":["predicateFromConfig","ScmIntegrations","getHarnessFileContentsUrl","ReadUrlResponseFactory","Readable","NotFoundError","NotModifiedError","AuthenticationError","getHarnessArchiveUrl","parseHarnessUrl","toError","getHarnessRequestOptions","fetch","getHarnessLatestCommitUrl"],"mappings":";;;;;;;;;;;;;AA8CA,MAAM,wBAAwB,CAAC,GAAA,EAAK,GAAA,EAAK,GAAA,EAAK,KAAK,GAAG,CAAA;AACtD,MAAM,aAAA,GAAgB,CAAA;AAQf,MAAM,gBAAA,CAA6C;AAAA,EACxD,OAAO,OAAA,GAAyB,CAAC,EAAE,MAAA,EAAQ,qBAAoB,KAAM;AACnE,IAAA,MAAM,wBAAA,GAA2BA,mCAAoB,MAAM,CAAA;AAC3D,IAAA,OAAOC,2BAAA,CAAgB,WAAW,MAAM,CAAA,CACrC,QAAQ,IAAA,EAAK,CACb,IAAI,CAAA,WAAA,KAAe;AAClB,MAAA,MAAM,MAAA,GAAS,IAAI,gBAAA,CAAiB,WAAA,EAAa;AAAA,QAC/C,mBAAA;AAAA,QACA;AAAA,OACD,CAAA;AACD,MAAA,MAAM,SAAA,GAAY,CAAC,GAAA,KAAa;AAC9B,QAAA,OAAO,GAAA,CAAI,IAAA,KAAS,WAAA,CAAY,MAAA,CAAO,IAAA;AAAA,MACzC,CAAA;AACA,MAAA,OAAO,EAAE,QAAQ,SAAA,EAAU;AAAA,IAC7B,CAAC,CAAA;AAAA,EACL,CAAA;AAAA,EAEiB,WAAA;AAAA,EACA,IAAA;AAAA,EAIA,wBAAA;AAAA,EAEjB,WAAA,CACE,aACA,IAAA,EAIA;AACA,IAAA,IAAA,CAAK,WAAA,GAAc,WAAA;AACnB,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;AACZ,IAAA,IAAA,CAAK,wBAAA,GACH,IAAA,CAAK,wBAAA,KAA6B,MAAM,KAAA,CAAA;AAAA,EAC5C;AAAA,EACA,MAAM,KAAK,GAAA,EAA8B;AACvC,IAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,OAAA,CAAQ,GAAG,CAAA;AACvC,IAAA,OAAO,SAAS,MAAA,EAAO;AAAA,EACzB;AAAA,EAEA,MAAM,OAAA,CACJ,GAAA,EACA,OAAA,EAC0C;AAC1C,IAAA,MAAM,OAAA,GAAUC,qCAAA,CAA0B,IAAA,CAAK,WAAA,CAAY,QAAQ,GAAG,CAAA;AACtE,IAAA,MAAM,WAAW,MAAM,IAAA,CAAK,QAAA,CAAS,OAAA,EAAS,SAAS,MAAM,CAAA;AAE7D,IAAA,IAAI,SAAS,EAAA,EAAI;AAEf,MAAA,MAAM,YAAA,GAAe,EAAE,IAAA,EAAM,QAAA,CAAS,IAAA,EAAK;AAC3C,MAAA,IAAI,YAAA,EAAc;AAChB,QAAA,OAAOC,6CAAA,CAAuB,YAAA;AAAA,UAC5BC,oBAAA,CAAS,IAAA,CAAK,YAAA,CAAa,IAAI,CAAA;AAAA,UAC/B;AAAA,YACE,IAAA,EAAM,QAAA,CAAS,OAAA,CAAQ,GAAA,CAAI,MAAM,CAAA,IAAK;AAAA;AACxC,SACF;AAAA,MACF;AAEA,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,cAAA,EAAiB,YAAY,CAAA,CAAE,CAAA;AAAA,IACjD;AAEA,IAAA,MAAM,OAAA,GAAU,CAAA,EAAG,GAAG,CAAA,GAAA,EAAM,OAAO,KAAK,QAAA,CAAS,MAAM,CAAA,CAAA,EAAI,QAAA,CAAS,UAAU,CAAA,CAAA;AAC9E,IAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,MAAA,MAAM,IAAIC,qBAAc,OAAO,CAAA;AAAA,IACjC;AAEA,IAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,MAAA,MAAM,IAAIC,uBAAA,EAAiB;AAAA,IAC7B;AAEA,IAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,MAAA,MAAM,IAAIC,0BAAA,EAAoB;AAAA,IAChC;AAEA,IAAA,MAAM,IAAI,MAAM,OAAO,CAAA;AAAA,EACzB;AAAA,EAEA,MAAM,QAAA,CACJ,GAAA,EACA,OAAA,EAC2C;AAC3C,IAAA,MAAM,cAAA,GAAiB,MAAM,IAAA,CAAK,iBAAA,CAAkB,GAAG,CAAA;AAEvD,IAAA,IAAI,OAAA,EAAS,IAAA,IAAQ,OAAA,CAAQ,IAAA,KAAS,cAAA,EAAgB;AACpD,MAAA,MAAM,IAAID,uBAAA,EAAiB;AAAA,IAC7B;AAEA,IAAA,MAAM,UAAA,GAAaE,gCAAA,CAAqB,IAAA,CAAK,WAAA,CAAY,QAAQ,GAAG,CAAA;AAEpE,IAAA,MAAM,WAAW,MAAM,IAAA,CAAK,QAAA,CAAS,UAAA,EAAY,SAAS,MAAM,CAAA;AAEhE,IAAA,MAAM,SAAA,GAAYC,2BAAA,CAAgB,IAAA,CAAK,WAAA,CAAY,QAAQ,GAAG,CAAA;AAE9D,IAAA,OAAO,IAAA,CAAK,IAAA,CAAK,mBAAA,CAAoB,cAAA,CAAe;AAAA,MAClD,MAAA,EAAQL,oBAAA,CAAS,IAAA,CAAK,QAAA,CAAS,IAAI,CAAA;AAAA,MACnC,SAAS,SAAA,CAAU,IAAA;AAAA,MACnB,IAAA,EAAM,cAAA;AAAA,MACN,QAAQ,OAAA,EAAS;AAAA,KAClB,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,MAAA,CACJ,GAAA,EACA,OAAA,EACyC;AACzC,IAAA,MAAM,EAAE,IAAA,EAAK,GAAIK,4BAAgB,IAAA,CAAK,WAAA,CAAY,QAAQ,GAAG,CAAA;AAE7D,IAAA,IAAI,IAAA,CAAK,KAAA,CAAM,MAAM,CAAA,EAAG;AACtB,MAAA,MAAM,IAAI,MAAM,gCAAgC,CAAA;AAAA,IAClD;AAEA,IAAA,IAAI;AACF,MAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,OAAA,CAAQ,KAAK,OAAO,CAAA;AAE5C,MAAA,OAAO;AAAA,QACL,KAAA,EAAO;AAAA,UACL;AAAA,YACE,GAAA;AAAA,YACA,SAAS,IAAA,CAAK,MAAA;AAAA,YACd,gBAAgB,IAAA,CAAK;AAAA;AACvB,SACF;AAAA,QACA,IAAA,EAAM,KAAK,IAAA,IAAQ;AAAA,OACrB;AAAA,IACF,SAAS,CAAA,EAAG;AACV,MAAA,MAAM,KAAA,GAAQC,eAAQ,CAAC,CAAA;AACvB,MAAA,IAAI,KAAA,CAAM,SAAS,eAAA,EAAiB;AAClC,QAAA,OAAO;AAAA,UACL,OAAO,EAAC;AAAA,UACR,IAAA,EAAM;AAAA,SACR;AAAA,MACF;AACA,MAAA,MAAM,KAAA;AAAA,IACR;AAAA,EACF;AAAA,EAEA,QAAA,GAAW;AACT,IAAA,MAAM,EAAE,IAAA,EAAK,GAAI,IAAA,CAAK,WAAA,CAAY,MAAA;AAClC,IAAA,OAAO,CAAA,aAAA,EAAgB,IAAI,CAAA,QAAA,EAAW,OAAA;AAAA,MACpC,KAAK,WAAA,CAAY,MAAA,CAAO,KAAA,IAAS,IAAA,CAAK,YAAY,MAAA,CAAO;AAAA,KAC1D,CAAA,CAAA,CAAA;AAAA,EACH;AAAA,EAEA,MAAc,QAAA,CAAS,GAAA,EAAa,MAAA,EAAyC;AAC3E,IAAA,MAAM,gBAAA,GAAmB,IAAI,GAAA,CAAI,CAAA,QAAA,EAAW,KAAK,WAAA,CAAY,MAAA,CAAO,IAAI,CAAA,CAAE,CAAA,CACvE,MAAA;AACH,IAAA,IAAI,UAAA,GAAa,GAAA;AACjB,IAAA,IAAI,kBAAA,GAAqB,IAAA;AAEzB,IAAA,KAAA,IAAS,aAAA,GAAgB,CAAA,IAAK,aAAA,IAAiB,CAAA,EAAG;AAChD,MAAA,MAAM,gBAAA,GAAmB,IAAI,GAAA,CAAI,UAAU,CAAA;AAC3C,MAAA,MAAM,cAAA,GACJ,kBAAA,IAAsB,gBAAA,CAAiB,MAAA,KAAW,gBAAA,GAC9CC,qCAAyB,IAAA,CAAK,WAAA,CAAY,MAAM,CAAA,GAChD,EAAC;AACP,MAAA,IAAI,QAAA;AACJ,MAAA,IAAI;AACF,QAAA,QAAA,GAAW,MAAMC,uBAAM,UAAA,EAAY;AAAA,UACjC,MAAA,EAAQ,KAAA;AAAA,UACR,GAAG,cAAA;AAAA,UACH,QAAA,EAAU,QAAA;AAAA,UACV;AAAA,SACD,CAAA;AAAA,MACH,SAAS,CAAA,EAAG;AACV,QAAA,MAAM,IAAI,KAAA,CAAM,CAAA,eAAA,EAAkB,UAAU,CAAA,EAAA,EAAK,CAAC,CAAA,CAAE,CAAA;AAAA,MACtD;AAEA,MAAA,MAAM,QAAA,GAAW,QAAA,CAAS,OAAA,CAAQ,GAAA,CAAI,UAAU,CAAA;AAChD,MAAA,IAAI,CAAC,qBAAA,CAAsB,QAAA,CAAS,SAAS,MAAM,CAAA,IAAK,CAAC,QAAA,EAAU;AACjE,QAAA,OAAO,QAAA;AAAA,MACT;AAEA,MAAA,QAAA,CAAS,KAAK,MAAA,EAAO;AAErB,MAAA,IAAI,WAAA;AACJ,MAAA,IAAI;AACF,QAAA,WAAA,GAAc,IAAI,GAAA,CAAI,QAAA,EAAU,UAAU,CAAA;AAAA,MAC5C,SAAS,CAAA,EAAG;AACV,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,eAAA,EAAkB,UAAU,CAAA,uBAAA,EAA0B,QAAQ,KAAK,CAAC,CAAA;AAAA,SACtE;AAAA,MACF;AAEA,MAAA,IACE,YAAY,MAAA,KAAW,gBAAA,IACvB,CAAC,IAAA,CAAK,wBAAA,CAAyB,WAAW,CAAA,EAC1C;AACA,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,oDAAA,EAAuD,YAAY,MAAM,CAAA;AAAA,SAC3E;AAAA,MACF;AAEA,MAAA,IAAI,WAAA,CAAY,WAAW,gBAAA,EAAkB;AAC3C,QAAA,kBAAA,GAAqB,KAAA;AAAA,MACvB;AAEA,MAAA,IAAI,kBAAkB,aAAA,EAAe;AACnC,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,wBAAA,EAA2B,aAAa,CAAA,eAAA,EAAkB,GAAG,CAAA;AAAA,SAC/D;AAAA,MACF;AAEA,MAAA,UAAA,GAAa,YAAY,QAAA,EAAS;AAAA,IACpC;AAAA,EACF;AAAA,EAEA,MAAc,kBAAkB,GAAA,EAA8B;AAC5D,IAAA,MAAM,SAAA,GAAYC,qCAAA,CAA0B,IAAA,CAAK,WAAA,CAAY,QAAQ,GAAG,CAAA;AAExE,IAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,QAAA,CAAS,SAAS,CAAA;AAC9C,IAAA,IAAI,CAAC,SAAS,EAAA,EAAI;AAChB,MAAA,MAAM,OAAA,GAAU,qDAAqD,SAAS,CAAA,EAAA,EAAK,SAAS,MAAM,CAAA,CAAA,EAAI,SAAS,UAAU,CAAA,CAAA;AACzH,MAAA,IAAI,QAAA,CAAS,WAAW,GAAA,EAAK;AAC3B,QAAA,MAAM,IAAIR,qBAAc,OAAO,CAAA;AAAA,MACjC;AACA,MAAA,MAAM,IAAI,MAAM,OAAO,CAAA;AAAA,IACzB;AAEA,IAAA,OAAA,CAAQ,MAAM,QAAA,CAAS,IAAA,EAAK,EAAG,aAAA,CAAc,GAAA;AAAA,EAC/C;AACF;;"}
@@ -1 +1 @@
1
- {"version":3,"file":"ReadUrlResponseFactory.cjs.js","sources":["../../../../src/entrypoints/urlReader/lib/ReadUrlResponseFactory.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 { ConflictError } from '@backstage/errors';\nimport { UrlReaderServiceReadUrlResponse } from '@backstage/backend-plugin-api';\nimport getRawBody from 'raw-body';\nimport { Readable } from 'node:stream';\nimport { ReadUrlResponseFactoryFromStreamOptions } from './types';\nimport { parseLastModified, responseToReadable } from './util';\n\n/**\n * Utility class for UrlReader implementations to create valid ReadUrlResponse\n * instances from common response primitives.\n *\n * @public\n */\nexport class ReadUrlResponseFactory {\n /**\n * Resolves a UrlReaderServiceReadUrlResponse from a Readable stream.\n */\n static async fromReadable(\n stream: Readable,\n options?: ReadUrlResponseFactoryFromStreamOptions,\n ): Promise<UrlReaderServiceReadUrlResponse> {\n // Reference to eventual buffer enables callers to call buffer() multiple\n // times without consequence.\n let buffer: Promise<Buffer>;\n\n // Prevent \"stream is not readable\" errors from bubbling up.\n const conflictError = new ConflictError(\n 'Cannot use buffer() and stream() from the same ReadUrlResponse',\n );\n let hasCalledStream = false;\n let hasCalledBuffer = false;\n\n return {\n buffer: () => {\n hasCalledBuffer = true;\n if (hasCalledStream) throw conflictError;\n if (buffer) return buffer;\n buffer = getRawBody(stream);\n return buffer;\n },\n stream: () => {\n hasCalledStream = true;\n if (hasCalledBuffer) throw conflictError;\n return stream;\n },\n etag: options?.etag,\n lastModifiedAt: options?.lastModifiedAt,\n };\n }\n\n /**\n * Resolves a UrlReaderServiceReadUrlResponse from an old-style NodeJS.ReadableStream.\n */\n static async fromNodeJSReadable(\n oldStyleStream: NodeJS.ReadableStream,\n options?: ReadUrlResponseFactoryFromStreamOptions,\n ): Promise<UrlReaderServiceReadUrlResponse> {\n const readable = Readable.from(oldStyleStream);\n return ReadUrlResponseFactory.fromReadable(readable, options);\n }\n\n /**\n * Resolves a UrlReaderServiceReadUrlResponse from a native fetch response body.\n */\n static async fromResponse(\n response: Response,\n ): Promise<UrlReaderServiceReadUrlResponse> {\n const etag = response.headers.get('etag') || undefined;\n const lastModifiedAt = parseLastModified(\n response.headers.get('last-modified'),\n );\n\n return ReadUrlResponseFactory.fromReadable(responseToReadable(response), {\n etag,\n lastModifiedAt,\n });\n }\n}\n"],"names":["ConflictError","getRawBody","Readable","parseLastModified","responseToReadable"],"mappings":";;;;;;;;;;;AA6BO,MAAM,sBAAA,CAAuB;AAAA;AAAA;AAAA;AAAA,EAIlC,aAAa,YAAA,CACX,MAAA,EACA,OAAA,EAC0C;AAG1C,IAAA,IAAI,MAAA;AAGJ,IAAA,MAAM,gBAAgB,IAAIA,oBAAA;AAAA,MACxB;AAAA,KACF;AACA,IAAA,IAAI,eAAA,GAAkB,KAAA;AACtB,IAAA,IAAI,eAAA,GAAkB,KAAA;AAEtB,IAAA,OAAO;AAAA,MACL,QAAQ,MAAM;AACZ,QAAA,eAAA,GAAkB,IAAA;AAClB,QAAA,IAAI,iBAAiB,MAAM,aAAA;AAC3B,QAAA,IAAI,QAAQ,OAAO,MAAA;AACnB,QAAA,MAAA,GAASC,4BAAW,MAAM,CAAA;AAC1B,QAAA,OAAO,MAAA;AAAA,MACT,CAAA;AAAA,MACA,QAAQ,MAAM;AACZ,QAAA,eAAA,GAAkB,IAAA;AAClB,QAAA,IAAI,iBAAiB,MAAM,aAAA;AAC3B,QAAA,OAAO,MAAA;AAAA,MACT,CAAA;AAAA,MACA,MAAM,OAAA,EAAS,IAAA;AAAA,MACf,gBAAgB,OAAA,EAAS;AAAA,KAC3B;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,aAAa,kBAAA,CACX,cAAA,EACA,OAAA,EAC0C;AAC1C,IAAA,MAAM,QAAA,GAAWC,oBAAA,CAAS,IAAA,CAAK,cAAc,CAAA;AAC7C,IAAA,OAAO,sBAAA,CAAuB,YAAA,CAAa,QAAA,EAAU,OAAO,CAAA;AAAA,EAC9D;AAAA;AAAA;AAAA;AAAA,EAKA,aAAa,aACX,QAAA,EAC0C;AAC1C,IAAA,MAAM,IAAA,GAAO,QAAA,CAAS,OAAA,CAAQ,GAAA,CAAI,MAAM,CAAA,IAAK,MAAA;AAC7C,IAAA,MAAM,cAAA,GAAiBC,sBAAA;AAAA,MACrB,QAAA,CAAS,OAAA,CAAQ,GAAA,CAAI,eAAe;AAAA,KACtC;AAEA,IAAA,OAAO,sBAAA,CAAuB,YAAA,CAAaC,uBAAA,CAAmB,QAAQ,CAAA,EAAG;AAAA,MACvE,IAAA;AAAA,MACA;AAAA,KACD,CAAA;AAAA,EACH;AACF;;;;"}
1
+ {"version":3,"file":"ReadUrlResponseFactory.cjs.js","sources":["../../../../src/entrypoints/urlReader/lib/ReadUrlResponseFactory.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 { ConflictError } from '@backstage/errors';\nimport { UrlReaderServiceReadUrlResponse } from '@backstage/backend-plugin-api';\nimport getRawBody from 'raw-body';\nimport { Readable } from 'node:stream';\nimport { ReadUrlResponseFactoryFromStreamOptions } from './types';\nimport { parseLastModified, responseToReadable } from './util';\n\n/**\n * Utility class for UrlReader implementations to create valid ReadUrlResponse\n * instances from common response primitives.\n *\n * @public\n */\nexport class ReadUrlResponseFactory {\n /**\n * Resolves a UrlReaderServiceReadUrlResponse from a Readable stream.\n */\n static async fromReadable(\n stream: Readable,\n options?: ReadUrlResponseFactoryFromStreamOptions,\n ): Promise<UrlReaderServiceReadUrlResponse> {\n // Reference to eventual buffer enables callers to call buffer() multiple\n // times without consequence.\n let buffer: Promise<Buffer>;\n\n // Prevent \"stream is not readable\" errors from bubbling up.\n const conflictError = new ConflictError(\n 'Cannot use buffer() and stream() from the same ReadUrlResponse',\n );\n let hasCalledStream = false;\n let hasCalledBuffer = false;\n\n return {\n buffer: () => {\n hasCalledBuffer = true;\n if (hasCalledStream) throw conflictError;\n if (buffer) return buffer;\n buffer = getRawBody(stream);\n return buffer;\n },\n stream: () => {\n hasCalledStream = true;\n if (hasCalledBuffer) throw conflictError;\n return stream;\n },\n etag: options?.etag,\n lastModifiedAt: options?.lastModifiedAt,\n };\n }\n\n /**\n * Resolves a UrlReaderServiceReadUrlResponse from an old-style NodeJS.ReadableStream.\n */\n static async fromNodeJSReadable(\n oldStyleStream: NodeJS.ReadableStream,\n options?: ReadUrlResponseFactoryFromStreamOptions,\n ): Promise<UrlReaderServiceReadUrlResponse> {\n const readable = Readable.from(oldStyleStream);\n return ReadUrlResponseFactory.fromReadable(readable, options);\n }\n\n /**\n * Resolves a UrlReaderServiceReadUrlResponse from a native fetch response body.\n */\n static async fromResponse(\n response: Response,\n ): Promise<UrlReaderServiceReadUrlResponse> {\n const etag = response.headers.get('etag') || undefined;\n const lastModifiedAt = parseLastModified(\n response.headers.get('last-modified'),\n );\n\n return ReadUrlResponseFactory.fromReadable(responseToReadable(response), {\n etag,\n lastModifiedAt,\n });\n }\n}\n"],"names":["ConflictError","getRawBody","Readable","parseLastModified","responseToReadable"],"mappings":";;;;;;;;;;;AA6BO,MAAM,sBAAA,CAAuB;AAAA;AAAA;AAAA;AAAA,EAIlC,aAAa,YAAA,CACX,MAAA,EACA,OAAA,EAC0C;AAG1C,IAAA,IAAI,MAAA;AAGJ,IAAA,MAAM,gBAAgB,IAAIA,oBAAA;AAAA,MACxB;AAAA,KACF;AACA,IAAA,IAAI,eAAA,GAAkB,KAAA;AACtB,IAAA,IAAI,eAAA,GAAkB,KAAA;AAEtB,IAAA,OAAO;AAAA,MACL,QAAQ,MAAM;AACZ,QAAA,eAAA,GAAkB,IAAA;AAClB,QAAA,IAAI,iBAAiB,MAAM,aAAA;AAC3B,QAAA,IAAI,QAAQ,OAAO,MAAA;AACnB,QAAA,MAAA,GAASC,4BAAW,MAAM,CAAA;AAC1B,QAAA,OAAO,MAAA;AAAA,MACT,CAAA;AAAA,MACA,QAAQ,MAAM;AACZ,QAAA,eAAA,GAAkB,IAAA;AAClB,QAAA,IAAI,iBAAiB,MAAM,aAAA;AAC3B,QAAA,OAAO,MAAA;AAAA,MACT,CAAA;AAAA,MACA,MAAM,OAAA,EAAS,IAAA;AAAA,MACf,gBAAgB,OAAA,EAAS;AAAA,KAC3B;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,aAAa,kBAAA,CACX,cAAA,EACA,OAAA,EAC0C;AAC1C,IAAA,MAAM,QAAA,GAAWC,oBAAA,CAAS,IAAA,CAAK,cAAc,CAAA;AAC7C,IAAA,OAAO,sBAAA,CAAuB,YAAA,CAAa,QAAA,EAAU,OAAO,CAAA;AAAA,EAC9D;AAAA;AAAA;AAAA;AAAA,EAKA,aAAa,aACX,QAAA,EAC0C;AAC1C,IAAA,MAAM,IAAA,GAAO,QAAA,CAAS,OAAA,CAAQ,GAAA,CAAI,MAAM,CAAA,IAAK,MAAA;AAC7C,IAAA,MAAM,cAAA,GAAiBC,sBAAA;AAAA,MACrB,QAAA,CAAS,OAAA,CAAQ,GAAA,CAAI,eAAe;AAAA,KACtC;AAEA,IAAA,OAAO,sBAAA,CAAuB,YAAA,CAAaC,uBAAA,CAAmB,QAAQ,CAAA,EAAG;AAAA,MACvE,IAAA;AAAA,MACA;AAAA,KACD,CAAA;AAAA,EACH;AACF;;"}
@@ -1 +1 @@
1
- {"version":3,"file":"UrlReaderPredicateMux.cjs.js","sources":["../../../../src/entrypoints/urlReader/lib/UrlReaderPredicateMux.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n UrlReaderServiceReadTreeOptions,\n UrlReaderServiceReadTreeResponse,\n UrlReaderServiceReadUrlOptions,\n UrlReaderServiceReadUrlResponse,\n UrlReaderServiceSearchOptions,\n UrlReaderServiceSearchResponse,\n UrlReaderService,\n} from '@backstage/backend-plugin-api';\nimport { NotAllowedError } from '@backstage/errors';\nimport { UrlReaderPredicateTuple } from './types';\n\nfunction notAllowedMessage(url: string) {\n return (\n `Reading from '${url}' is not allowed. ` +\n `You may need to configure an integration for the target host, or add it ` +\n `to the configured list of allowed hosts at 'backend.reading.allow'`\n );\n}\n\n/**\n * A UrlReaderService implementation that selects from a set of readers\n * based on a predicate tied to each reader.\n */\nexport class UrlReaderPredicateMux implements UrlReaderService {\n private readonly readers: UrlReaderPredicateTuple[] = [];\n\n register(tuple: UrlReaderPredicateTuple): void {\n this.readers.push(tuple);\n }\n\n async readUrl(\n url: string,\n options?: UrlReaderServiceReadUrlOptions,\n ): Promise<UrlReaderServiceReadUrlResponse> {\n const parsed = new URL(url);\n\n for (const { predicate, reader } of this.readers) {\n if (predicate(parsed)) {\n return reader.readUrl(url, options);\n }\n }\n\n throw new NotAllowedError(notAllowedMessage(url));\n }\n\n async readTree(\n url: string,\n options?: UrlReaderServiceReadTreeOptions,\n ): Promise<UrlReaderServiceReadTreeResponse> {\n const parsed = new URL(url);\n\n for (const { predicate, reader } of this.readers) {\n if (predicate(parsed)) {\n return await reader.readTree(url, options);\n }\n }\n\n throw new NotAllowedError(notAllowedMessage(url));\n }\n\n async search(\n url: string,\n options?: UrlReaderServiceSearchOptions,\n ): Promise<UrlReaderServiceSearchResponse> {\n const parsed = new URL(url);\n\n for (const { predicate, reader } of this.readers) {\n if (predicate(parsed)) {\n return await reader.search(url, options);\n }\n }\n\n throw new NotAllowedError(notAllowedMessage(url));\n }\n\n toString() {\n return `predicateMux{readers=${this.readers.map(t => t.reader).join(',')}`;\n }\n}\n"],"names":["NotAllowedError"],"mappings":";;;;AA4BA,SAAS,kBAAkB,GAAA,EAAa;AACtC,EAAA,OACE,iBAAiB,GAAG,CAAA,4JAAA,CAAA;AAIxB;AAMO,MAAM,qBAAA,CAAkD;AAAA,EAC5C,UAAqC,EAAC;AAAA,EAEvD,SAAS,KAAA,EAAsC;AAC7C,IAAA,IAAA,CAAK,OAAA,CAAQ,KAAK,KAAK,CAAA;AAAA,EACzB;AAAA,EAEA,MAAM,OAAA,CACJ,GAAA,EACA,OAAA,EAC0C;AAC1C,IAAA,MAAM,MAAA,GAAS,IAAI,GAAA,CAAI,GAAG,CAAA;AAE1B,IAAA,KAAA,MAAW,EAAE,SAAA,EAAW,MAAA,EAAO,IAAK,KAAK,OAAA,EAAS;AAChD,MAAA,IAAI,SAAA,CAAU,MAAM,CAAA,EAAG;AACrB,QAAA,OAAO,MAAA,CAAO,OAAA,CAAQ,GAAA,EAAK,OAAO,CAAA;AAAA,MACpC;AAAA,IACF;AAEA,IAAA,MAAM,IAAIA,sBAAA,CAAgB,iBAAA,CAAkB,GAAG,CAAC,CAAA;AAAA,EAClD;AAAA,EAEA,MAAM,QAAA,CACJ,GAAA,EACA,OAAA,EAC2C;AAC3C,IAAA,MAAM,MAAA,GAAS,IAAI,GAAA,CAAI,GAAG,CAAA;AAE1B,IAAA,KAAA,MAAW,EAAE,SAAA,EAAW,MAAA,EAAO,IAAK,KAAK,OAAA,EAAS;AAChD,MAAA,IAAI,SAAA,CAAU,MAAM,CAAA,EAAG;AACrB,QAAA,OAAO,MAAM,MAAA,CAAO,QAAA,CAAS,GAAA,EAAK,OAAO,CAAA;AAAA,MAC3C;AAAA,IACF;AAEA,IAAA,MAAM,IAAIA,sBAAA,CAAgB,iBAAA,CAAkB,GAAG,CAAC,CAAA;AAAA,EAClD;AAAA,EAEA,MAAM,MAAA,CACJ,GAAA,EACA,OAAA,EACyC;AACzC,IAAA,MAAM,MAAA,GAAS,IAAI,GAAA,CAAI,GAAG,CAAA;AAE1B,IAAA,KAAA,MAAW,EAAE,SAAA,EAAW,MAAA,EAAO,IAAK,KAAK,OAAA,EAAS;AAChD,MAAA,IAAI,SAAA,CAAU,MAAM,CAAA,EAAG;AACrB,QAAA,OAAO,MAAM,MAAA,CAAO,MAAA,CAAO,GAAA,EAAK,OAAO,CAAA;AAAA,MACzC;AAAA,IACF;AAEA,IAAA,MAAM,IAAIA,sBAAA,CAAgB,iBAAA,CAAkB,GAAG,CAAC,CAAA;AAAA,EAClD;AAAA,EAEA,QAAA,GAAW;AACT,IAAA,OAAO,CAAA,qBAAA,EAAwB,IAAA,CAAK,OAAA,CAAQ,GAAA,CAAI,CAAA,CAAA,KAAK,EAAE,MAAM,CAAA,CAAE,IAAA,CAAK,GAAG,CAAC,CAAA,CAAA;AAAA,EAC1E;AACF;;;;"}
1
+ {"version":3,"file":"UrlReaderPredicateMux.cjs.js","sources":["../../../../src/entrypoints/urlReader/lib/UrlReaderPredicateMux.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n UrlReaderServiceReadTreeOptions,\n UrlReaderServiceReadTreeResponse,\n UrlReaderServiceReadUrlOptions,\n UrlReaderServiceReadUrlResponse,\n UrlReaderServiceSearchOptions,\n UrlReaderServiceSearchResponse,\n UrlReaderService,\n} from '@backstage/backend-plugin-api';\nimport { NotAllowedError } from '@backstage/errors';\nimport { UrlReaderPredicateTuple } from './types';\n\nfunction notAllowedMessage(url: string) {\n return (\n `Reading from '${url}' is not allowed. ` +\n `You may need to configure an integration for the target host, or add it ` +\n `to the configured list of allowed hosts at 'backend.reading.allow'`\n );\n}\n\n/**\n * A UrlReaderService implementation that selects from a set of readers\n * based on a predicate tied to each reader.\n */\nexport class UrlReaderPredicateMux implements UrlReaderService {\n private readonly readers: UrlReaderPredicateTuple[] = [];\n\n register(tuple: UrlReaderPredicateTuple): void {\n this.readers.push(tuple);\n }\n\n async readUrl(\n url: string,\n options?: UrlReaderServiceReadUrlOptions,\n ): Promise<UrlReaderServiceReadUrlResponse> {\n const parsed = new URL(url);\n\n for (const { predicate, reader } of this.readers) {\n if (predicate(parsed)) {\n return reader.readUrl(url, options);\n }\n }\n\n throw new NotAllowedError(notAllowedMessage(url));\n }\n\n async readTree(\n url: string,\n options?: UrlReaderServiceReadTreeOptions,\n ): Promise<UrlReaderServiceReadTreeResponse> {\n const parsed = new URL(url);\n\n for (const { predicate, reader } of this.readers) {\n if (predicate(parsed)) {\n return await reader.readTree(url, options);\n }\n }\n\n throw new NotAllowedError(notAllowedMessage(url));\n }\n\n async search(\n url: string,\n options?: UrlReaderServiceSearchOptions,\n ): Promise<UrlReaderServiceSearchResponse> {\n const parsed = new URL(url);\n\n for (const { predicate, reader } of this.readers) {\n if (predicate(parsed)) {\n return await reader.search(url, options);\n }\n }\n\n throw new NotAllowedError(notAllowedMessage(url));\n }\n\n toString() {\n return `predicateMux{readers=${this.readers.map(t => t.reader).join(',')}`;\n }\n}\n"],"names":["NotAllowedError"],"mappings":";;;;AA4BA,SAAS,kBAAkB,GAAA,EAAa;AACtC,EAAA,OACE,iBAAiB,GAAG,CAAA,4JAAA,CAAA;AAIxB;AAMO,MAAM,qBAAA,CAAkD;AAAA,EAC5C,UAAqC,EAAC;AAAA,EAEvD,SAAS,KAAA,EAAsC;AAC7C,IAAA,IAAA,CAAK,OAAA,CAAQ,KAAK,KAAK,CAAA;AAAA,EACzB;AAAA,EAEA,MAAM,OAAA,CACJ,GAAA,EACA,OAAA,EAC0C;AAC1C,IAAA,MAAM,MAAA,GAAS,IAAI,GAAA,CAAI,GAAG,CAAA;AAE1B,IAAA,KAAA,MAAW,EAAE,SAAA,EAAW,MAAA,EAAO,IAAK,KAAK,OAAA,EAAS;AAChD,MAAA,IAAI,SAAA,CAAU,MAAM,CAAA,EAAG;AACrB,QAAA,OAAO,MAAA,CAAO,OAAA,CAAQ,GAAA,EAAK,OAAO,CAAA;AAAA,MACpC;AAAA,IACF;AAEA,IAAA,MAAM,IAAIA,sBAAA,CAAgB,iBAAA,CAAkB,GAAG,CAAC,CAAA;AAAA,EAClD;AAAA,EAEA,MAAM,QAAA,CACJ,GAAA,EACA,OAAA,EAC2C;AAC3C,IAAA,MAAM,MAAA,GAAS,IAAI,GAAA,CAAI,GAAG,CAAA;AAE1B,IAAA,KAAA,MAAW,EAAE,SAAA,EAAW,MAAA,EAAO,IAAK,KAAK,OAAA,EAAS;AAChD,MAAA,IAAI,SAAA,CAAU,MAAM,CAAA,EAAG;AACrB,QAAA,OAAO,MAAM,MAAA,CAAO,QAAA,CAAS,GAAA,EAAK,OAAO,CAAA;AAAA,MAC3C;AAAA,IACF;AAEA,IAAA,MAAM,IAAIA,sBAAA,CAAgB,iBAAA,CAAkB,GAAG,CAAC,CAAA;AAAA,EAClD;AAAA,EAEA,MAAM,MAAA,CACJ,GAAA,EACA,OAAA,EACyC;AACzC,IAAA,MAAM,MAAA,GAAS,IAAI,GAAA,CAAI,GAAG,CAAA;AAE1B,IAAA,KAAA,MAAW,EAAE,SAAA,EAAW,MAAA,EAAO,IAAK,KAAK,OAAA,EAAS;AAChD,MAAA,IAAI,SAAA,CAAU,MAAM,CAAA,EAAG;AACrB,QAAA,OAAO,MAAM,MAAA,CAAO,MAAA,CAAO,GAAA,EAAK,OAAO,CAAA;AAAA,MACzC;AAAA,IACF;AAEA,IAAA,MAAM,IAAIA,sBAAA,CAAgB,iBAAA,CAAkB,GAAG,CAAC,CAAA;AAAA,EAClD;AAAA,EAEA,QAAA,GAAW;AACT,IAAA,OAAO,CAAA,qBAAA,EAAwB,IAAA,CAAK,OAAA,CAAQ,GAAA,CAAI,CAAA,CAAA,KAAK,EAAE,MAAM,CAAA,CAAE,IAAA,CAAK,GAAG,CAAC,CAAA,CAAA;AAAA,EAC1E;AACF;;"}