@backstage/plugin-techdocs-node 1.12.12-next.1 → 1.12.12

package/dist/stages/publish/googleStorage.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"googleStorage.cjs.js","sources":["../../../src/stages/publish/googleStorage.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 */\nimport { Entity, CompoundEntityRef } from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport { assertError } from '@backstage/errors';\nimport {\n  File,\n  FileExistsResponse,\n  Storage,\n  StorageOptions,\n} from '@google-cloud/storage';\nimport express from 'express';\nimport JSON5 from 'json5';\nimport path from 'path';\nimport { Readable } from 'stream';\nimport {\n  getFileTreeRecursively,\n  getHeadersForFileExtension,\n  isValidContentPath,\n  lowerCaseEntityTriplet,\n  lowerCaseEntityTripletInStoragePath,\n  bulkStorageOperation,\n  getCloudPathForLocalPath,\n  getStaleFiles,\n  normalizeExternalStorageRootPath,\n} from './helpers';\nimport { MigrateWriteStream } from './migrations';\nimport {\n  PublisherBase,\n  PublishRequest,\n  PublishResponse,\n  ReadinessResponse,\n  TechDocsMetadata,\n} from './types';\nimport { LoggerService } from '@backstage/backend-plugin-api';\n\nexport class GoogleGCSPublish implements PublisherBase {\n  private readonly storageClient: Storage;\n  private readonly bucketName: string;\n  private readonly legacyPathCasing: boolean;\n  private readonly logger: LoggerService;\n  private readonly bucketRootPath: string;\n\n  constructor(options: {\n    storageClient: Storage;\n    bucketName: string;\n    legacyPathCasing: boolean;\n    logger: LoggerService;\n    bucketRootPath: string;\n  }) {\n    this.storageClient = options.storageClient;\n    this.bucketName = options.bucketName;\n    this.legacyPathCasing = options.legacyPathCasing;\n    this.logger = options.logger;\n    this.bucketRootPath = options.bucketRootPath;\n  }\n\n  static fromConfig(\n    config: Config,\n    logger: LoggerService,\n    options?: StorageOptions,\n  ): PublisherBase {\n    let bucketName = '';\n    try {\n      bucketName = config.getString('techdocs.publisher.googleGcs.bucketName');\n    } catch (error) {\n      throw new Error(\n        \"Since techdocs.publisher.type is set to 'googleGcs' in your app config, \" +\n          'techdocs.publisher.googleGcs.bucketName is required.',\n      );\n    }\n\n    const bucketRootPath = normalizeExternalStorageRootPath(\n      config.getOptionalString('techdocs.publisher.googleGcs.bucketRootPath') ||\n        '',\n    );\n\n    // Credentials is an optional config. If missing, default GCS environment variables will be used.\n    // Read more here https://cloud.google.com/docs/authentication/production\n    const credentials = config.getOptionalString(\n      'techdocs.publisher.googleGcs.credentials',\n    );\n    const projectId = config.getOptionalString(\n      'techdocs.publisher.googleGcs.projectId',\n    );\n    let credentialsJson: any = {};\n    if (credentials) {\n      try {\n        credentialsJson = JSON.parse(credentials);\n      } catch (err) {\n        throw new Error(\n          'Error in parsing techdocs.publisher.googleGcs.credentials config to JSON.',\n        );\n      }\n    }\n\n    const clientOpts: StorageOptions = options ?? {};\n    if (projectId) {\n      clientOpts.projectId = projectId;\n    }\n\n    const storageClient = new Storage({\n      ...(credentials && {\n        projectId: credentialsJson.project_id,\n        credentials: credentialsJson,\n      }),\n      ...clientOpts,\n    });\n\n    const legacyPathCasing =\n      config.getOptionalBoolean(\n        'techdocs.legacyUseCaseSensitiveTripletPaths',\n      ) || false;\n\n    return new GoogleGCSPublish({\n      storageClient,\n      bucketName,\n      legacyPathCasing,\n      logger,\n      bucketRootPath,\n    });\n  }\n\n  /**\n   * Check if the defined bucket exists. Being able to connect means the configuration is good\n   * and the storage client will work.\n   */\n  async getReadiness(): Promise<ReadinessResponse> {\n    try {\n      await this.storageClient.bucket(this.bucketName).getMetadata();\n      this.logger.info(\n        `Successfully connected to the GCS bucket ${this.bucketName}.`,\n      );\n\n      return {\n        isAvailable: true,\n      };\n    } catch (err) {\n      assertError(err);\n      this.logger.error(\n        `Could not retrieve metadata about the GCS bucket ${this.bucketName}. ` +\n          'Make sure the bucket exists. Also make sure that authentication is setup either by explicitly defining ' +\n          'techdocs.publisher.googleGcs.credentials in app config or by using environment variables. ' +\n          'Refer to https://backstage.io/docs/features/techdocs/using-cloud-storage',\n      );\n      this.logger.error(`from GCS client library: ${err.message}`);\n\n      return { isAvailable: false };\n    }\n  }\n\n  /**\n   * Upload all the files from the generated `directory` to the GCS bucket.\n   * Directory structure used in the bucket is - entityNamespace/entityKind/entityName/index.html\n   */\n  async publish({\n    entity,\n    directory,\n  }: PublishRequest): Promise<PublishResponse> {\n    const objects: string[] = [];\n    const useLegacyPathCasing = this.legacyPathCasing;\n    const bucket = this.storageClient.bucket(this.bucketName);\n    const bucketRootPath = this.bucketRootPath;\n\n    // First, try to retrieve a list of all individual files currently existing\n    let existingFiles: string[] = [];\n    try {\n      const remoteFolder = getCloudPathForLocalPath(\n        entity,\n        undefined,\n        useLegacyPathCasing,\n        bucketRootPath,\n      );\n      existingFiles = await this.getFilesForFolder(remoteFolder);\n    } catch (e) {\n      assertError(e);\n      this.logger.error(\n        `Unable to list files for Entity ${entity.metadata.name}: ${e.message}`,\n      );\n    }\n\n    // Then, merge new files into the same folder\n    let absoluteFilesToUpload;\n    try {\n      // Remove the absolute path prefix of the source directory\n      // Path of all files to upload, relative to the root of the source directory\n      // e.g. ['index.html', 'sub-page/index.html', 'assets/images/favicon.png']\n      absoluteFilesToUpload = await getFileTreeRecursively(directory);\n\n      await bulkStorageOperation(\n        async absoluteFilePath => {\n          const relativeFilePath = path.relative(directory, absoluteFilePath);\n          const destination = getCloudPathForLocalPath(\n            entity,\n            relativeFilePath,\n            useLegacyPathCasing,\n            bucketRootPath,\n          );\n          objects.push(destination);\n          return await bucket.upload(absoluteFilePath, { destination });\n        },\n        absoluteFilesToUpload,\n        { concurrencyLimit: 10 },\n      );\n\n      this.logger.info(\n        `Successfully uploaded all the generated files for Entity ${entity.metadata.name}. Total number of files: ${absoluteFilesToUpload.length}`,\n      );\n    } catch (e) {\n      const errorMessage = `Unable to upload file(s) to Google Cloud Storage. ${e}`;\n      this.logger.error(errorMessage);\n      throw new Error(errorMessage);\n    }\n\n    // Last, try to remove the files that were *only* present previously\n    try {\n      const relativeFilesToUpload = absoluteFilesToUpload.map(\n        absoluteFilePath =>\n          getCloudPathForLocalPath(\n            entity,\n            path.relative(directory, absoluteFilePath),\n            useLegacyPathCasing,\n            bucketRootPath,\n          ),\n      );\n      const staleFiles = getStaleFiles(relativeFilesToUpload, existingFiles);\n\n      await bulkStorageOperation(\n        async relativeFilePath => {\n          return await bucket.file(relativeFilePath).delete();\n        },\n        staleFiles,\n        { concurrencyLimit: 10 },\n      );\n\n      this.logger.info(\n        `Successfully deleted stale files for Entity ${entity.metadata.name}. Total number of files: ${staleFiles.length}`,\n      );\n    } catch (error) {\n      const errorMessage = `Unable to delete file(s) from Google Cloud Storage. ${error}`;\n      this.logger.error(errorMessage);\n    }\n\n    return { objects };\n  }\n\n  fetchTechDocsMetadata(\n    entityName: CompoundEntityRef,\n  ): Promise<TechDocsMetadata> {\n    return new Promise((resolve, reject) => {\n      const entityTriplet = `${entityName.namespace}/${entityName.kind}/${entityName.name}`;\n      const entityDir = this.legacyPathCasing\n        ? entityTriplet\n        : lowerCaseEntityTriplet(entityTriplet);\n\n      const entityRootDir = path.posix.join(this.bucketRootPath, entityDir);\n      if (!isValidContentPath(this.bucketRootPath, entityRootDir)) {\n        this.logger.error(\n          `Invalid content path found while fetching TechDocs metadata: ${entityRootDir}`,\n        );\n        reject(new Error(`Metadata Not Found`));\n      }\n\n      const fileStreamChunks: Array<any> = [];\n      this.storageClient\n        .bucket(this.bucketName)\n        .file(`${entityRootDir}/techdocs_metadata.json`)\n        .createReadStream()\n        .on('error', err => {\n          this.logger.error(err.message);\n          reject(err);\n        })\n        .on('data', chunk => {\n          fileStreamChunks.push(chunk);\n        })\n        .on('end', () => {\n          const techdocsMetadataJson =\n            Buffer.concat(fileStreamChunks).toString('utf-8');\n          resolve(JSON5.parse(techdocsMetadataJson));\n        });\n    });\n  }\n\n  /**\n   * Express route middleware to serve static files on a route in techdocs-backend.\n   */\n  docsRouter(): express.Handler {\n    return (req, res) => {\n      const decodedUri = decodeURI(req.path.replace(/^\\//, ''));\n\n      // filePath example - /default/component/documented-component/index.html\n      const filePathNoRoot = this.legacyPathCasing\n        ? decodedUri\n        : lowerCaseEntityTripletInStoragePath(decodedUri);\n\n      // Prepend the root path to the relative file path\n      const filePath = path.posix.join(this.bucketRootPath, filePathNoRoot);\n      if (!isValidContentPath(this.bucketRootPath, filePath)) {\n        this.logger.error(\n          `Attempted to fetch TechDocs content for a file outside of the bucket root: ${filePathNoRoot}`,\n        );\n        res.status(404).send('File Not Found');\n        return;\n      }\n\n      // Files with different extensions (CSS, HTML) need to be served with different headers\n      const fileExtension = path.extname(filePath);\n      const responseHeaders = getHeadersForFileExtension(fileExtension);\n\n      // Pipe file chunks directly from storage to client.\n      this.storageClient\n        .bucket(this.bucketName)\n        .file(filePath)\n        .createReadStream()\n        .on('pipe', () => {\n          res.writeHead(200, responseHeaders);\n        })\n        .on('error', err => {\n          this.logger.warn(\n            `TechDocs Google GCS router failed to serve content from bucket ${this.bucketName} at path ${filePath}: ${err.message}`,\n          );\n          // Send a 404 with a meaningful message if possible.\n          if (!res.headersSent) {\n            res.status(404).send('File Not Found');\n          } else {\n            res.destroy();\n          }\n        })\n        .pipe(res);\n    };\n  }\n\n  /**\n   * A helper function which checks if index.html of an Entity's docs site is available. This\n   * can be used to verify if there are any pre-generated docs available to serve.\n   */\n  async hasDocsBeenGenerated(entity: Entity): Promise<boolean> {\n    return new Promise(resolve => {\n      const entityTriplet = `${entity.metadata.namespace}/${entity.kind}/${entity.metadata.name}`;\n      const entityDir = this.legacyPathCasing\n        ? entityTriplet\n        : lowerCaseEntityTriplet(entityTriplet);\n\n      const entityRootDir = path.posix.join(this.bucketRootPath, entityDir);\n      if (!isValidContentPath(this.bucketRootPath, entityRootDir)) {\n        this.logger.error(\n          `Invalid content path found while checking if docs have been generated: ${entityRootDir}`,\n        );\n        resolve(false);\n      }\n\n      this.storageClient\n        .bucket(this.bucketName)\n        .file(`${entityRootDir}/index.html`)\n        .exists()\n        .then((response: FileExistsResponse) => {\n          resolve(response[0]);\n        })\n        .catch(() => {\n          resolve(false);\n        });\n    });\n  }\n\n  migrateDocsCase({ removeOriginal = false, concurrency = 25 }): Promise<void> {\n    return new Promise((resolve, reject) => {\n      // Iterate through every file in the root of the publisher.\n      const allFileMetadata: Readable = this.storageClient\n        .bucket(this.bucketName)\n        .getFilesStream();\n      const migrateFiles = new MigrateWriteStream(\n        this.logger,\n        removeOriginal,\n        concurrency,\n      );\n      migrateFiles.on('finish', resolve).on('error', reject);\n      allFileMetadata.pipe(migrateFiles).on('error', error => {\n        migrateFiles.destroy();\n        reject(error);\n      });\n    });\n  }\n\n  private getFilesForFolder(folder: string): Promise<string[]> {\n    const fileMetadataStream: Readable = this.storageClient\n      .bucket(this.bucketName)\n      .getFilesStream({ prefix: folder });\n\n    return new Promise((resolve, reject) => {\n      const files: string[] = [];\n\n      fileMetadataStream.on('error', error => {\n        // push file to file array\n        reject(error);\n      });\n\n      fileMetadataStream.on('data', (file: File) => {\n        // push file to file array\n        files.push(file.name);\n      });\n\n      fileMetadataStream.on('end', () => {\n        // resolve promise\n        resolve(files);\n      });\n    });\n  }\n}\n"],"names":["normalizeExternalStorageRootPath","Storage","assertError","getCloudPathForLocalPath","getFileTreeRecursively","bulkStorageOperation","path","getStaleFiles","lowerCaseEntityTriplet","isValidContentPath","JSON5","lowerCaseEntityTripletInStoragePath","getHeadersForFileExtension","MigrateWriteStream"],"mappings":";;;;;;;;;;;;;;AAiDO,MAAM,gBAA0C,CAAA;AAAA,EACpC,aAAA,CAAA;AAAA,EACA,UAAA,CAAA;AAAA,EACA,gBAAA,CAAA;AAAA,EACA,MAAA,CAAA;AAAA,EACA,cAAA,CAAA;AAAA,EAEjB,YAAY,OAMT,EAAA;AACD,IAAA,IAAA,CAAK,gBAAgB,OAAQ,CAAA,aAAA,CAAA;AAC7B,IAAA,IAAA,CAAK,aAAa,OAAQ,CAAA,UAAA,CAAA;AAC1B,IAAA,IAAA,CAAK,mBAAmB,OAAQ,CAAA,gBAAA,CAAA;AAChC,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AACtB,IAAA,IAAA,CAAK,iBAAiB,OAAQ,CAAA,cAAA,CAAA;AAAA,GAChC;AAAA,EAEA,OAAO,UAAA,CACL,MACA,EAAA,MAAA,EACA,OACe,EAAA;AACf,IAAA,IAAI,UAAa,GAAA,EAAA,CAAA;AACjB,IAAI,IAAA;AACF,MAAa,UAAA,GAAA,MAAA,CAAO,UAAU,yCAAyC,CAAA,CAAA;AAAA,aAChE,KAAO,EAAA;AACd,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,8HAAA;AAAA,OAEF,CAAA;AAAA,KACF;AAEA,IAAA,MAAM,cAAiB,GAAAA,wCAAA;AAAA,MACrB,MAAA,CAAO,iBAAkB,CAAA,6CAA6C,CACpE,IAAA,EAAA;AAAA,KACJ,CAAA;AAIA,IAAA,MAAM,cAAc,MAAO,CAAA,iBAAA;AAAA,MACzB,0CAAA;AAAA,KACF,CAAA;AACA,IAAA,MAAM,YAAY,MAAO,CAAA,iBAAA;AAAA,MACvB,wCAAA;AAAA,KACF,CAAA;AACA,IAAA,IAAI,kBAAuB,EAAC,CAAA;AAC5B,IAAA,IAAI,WAAa,EAAA;AACf,MAAI,IAAA;AACF,QAAkB,eAAA,GAAA,IAAA,CAAK,MAAM,WAAW,CAAA,CAAA;AAAA,eACjC,GAAK,EAAA;AACZ,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,2EAAA;AAAA,SACF,CAAA;AAAA,OACF;AAAA,KACF;AAEA,IAAM,MAAA,UAAA,GAA6B,WAAW,EAAC,CAAA;AAC/C,IAAA,IAAI,SAAW,EAAA;AACb,MAAA,UAAA,CAAW,SAAY,GAAA,SAAA,CAAA;AAAA,KACzB;AAEA,IAAM,MAAA,aAAA,GAAgB,IAAIC,eAAQ,CAAA;AAAA,MAChC,GAAI,WAAe,IAAA;AAAA,QACjB,WAAW,eAAgB,CAAA,UAAA;AAAA,QAC3B,WAAa,EAAA,eAAA;AAAA,OACf;AAAA,MACA,GAAG,UAAA;AAAA,KACJ,CAAA,CAAA;AAED,IAAA,MAAM,mBACJ,MAAO,CAAA,kBAAA;AAAA,MACL,6CAAA;AAAA,KACG,IAAA,KAAA,CAAA;AAEP,IAAA,OAAO,IAAI,gBAAiB,CAAA;AAAA,MAC1B,aAAA;AAAA,MACA,UAAA;AAAA,MACA,gBAAA;AAAA,MACA,MAAA;AAAA,MACA,cAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,YAA2C,GAAA;AAC/C,IAAI,IAAA;AACF,MAAA,MAAM,KAAK,aAAc,CAAA,MAAA,CAAO,IAAK,CAAA,UAAU,EAAE,WAAY,EAAA,CAAA;AAC7D,MAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,QACV,CAAA,yCAAA,EAA4C,KAAK,UAAU,CAAA,CAAA,CAAA;AAAA,OAC7D,CAAA;AAEA,MAAO,OAAA;AAAA,QACL,WAAa,EAAA,IAAA;AAAA,OACf,CAAA;AAAA,aACO,GAAK,EAAA;AACZ,MAAAC,kBAAA,CAAY,GAAG,CAAA,CAAA;AACf,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,CAAA,iDAAA,EAAoD,KAAK,UAAU,CAAA,2QAAA,CAAA;AAAA,OAIrE,CAAA;AACA,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAA4B,yBAAA,EAAA,GAAA,CAAI,OAAO,CAAE,CAAA,CAAA,CAAA;AAE3D,MAAO,OAAA,EAAE,aAAa,KAAM,EAAA,CAAA;AAAA,KAC9B;AAAA,GACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,OAAQ,CAAA;AAAA,IACZ,MAAA;AAAA,IACA,SAAA;AAAA,GAC2C,EAAA;AAC3C,IAAA,MAAM,UAAoB,EAAC,CAAA;AAC3B,IAAA,MAAM,sBAAsB,IAAK,CAAA,gBAAA,CAAA;AACjC,IAAA,MAAM,MAAS,GAAA,IAAA,CAAK,aAAc,CAAA,MAAA,CAAO,KAAK,UAAU,CAAA,CAAA;AACxD,IAAA,MAAM,iBAAiB,IAAK,CAAA,cAAA,CAAA;AAG5B,IAAA,IAAI,gBAA0B,EAAC,CAAA;AAC/B,IAAI,IAAA;AACF,MAAA,MAAM,YAAe,GAAAC,gCAAA;AAAA,QACnB,MAAA;AAAA,QACA,KAAA,CAAA;AAAA,QACA,mBAAA;AAAA,QACA,cAAA;AAAA,OACF,CAAA;AACA,MAAgB,aAAA,GAAA,MAAM,IAAK,CAAA,iBAAA,CAAkB,YAAY,CAAA,CAAA;AAAA,aAClD,CAAG,EAAA;AACV,MAAAD,kBAAA,CAAY,CAAC,CAAA,CAAA;AACb,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,mCAAmC,MAAO,CAAA,QAAA,CAAS,IAAI,CAAA,EAAA,EAAK,EAAE,OAAO,CAAA,CAAA;AAAA,OACvE,CAAA;AAAA,KACF;AAGA,IAAI,IAAA,qBAAA,CAAA;AACJ,IAAI,IAAA;AAIF,MAAwB,qBAAA,GAAA,MAAME,+BAAuB,SAAS,CAAA,CAAA;AAE9D,MAAM,MAAAC,4BAAA;AAAA,QACJ,OAAM,gBAAoB,KAAA;AACxB,UAAA,MAAM,gBAAmB,GAAAC,qBAAA,CAAK,QAAS,CAAA,SAAA,EAAW,gBAAgB,CAAA,CAAA;AAClE,UAAA,MAAM,WAAc,GAAAH,gCAAA;AAAA,YAClB,MAAA;AAAA,YACA,gBAAA;AAAA,YACA,mBAAA;AAAA,YACA,cAAA;AAAA,WACF,CAAA;AACA,UAAA,OAAA,CAAQ,KAAK,WAAW,CAAA,CAAA;AACxB,UAAA,OAAO,MAAM,MAAO,CAAA,MAAA,CAAO,gBAAkB,EAAA,EAAE,aAAa,CAAA,CAAA;AAAA,SAC9D;AAAA,QACA,qBAAA;AAAA,QACA,EAAE,kBAAkB,EAAG,EAAA;AAAA,OACzB,CAAA;AAEA,MAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,QACV,4DAA4D,MAAO,CAAA,QAAA,CAAS,IAAI,CAAA,yBAAA,EAA4B,sBAAsB,MAAM,CAAA,CAAA;AAAA,OAC1I,CAAA;AAAA,aACO,CAAG,EAAA;AACV,MAAM,MAAA,YAAA,GAAe,qDAAqD,CAAC,CAAA,CAAA,CAAA;AAC3E,MAAK,IAAA,CAAA,MAAA,CAAO,MAAM,YAAY,CAAA,CAAA;AAC9B,MAAM,MAAA,IAAI,MAAM,YAAY,CAAA,CAAA;AAAA,KAC9B;AAGA,IAAI,IAAA;AACF,MAAA,MAAM,wBAAwB,qBAAsB,CAAA,GAAA;AAAA,QAClD,CACE,gBAAA,KAAAA,gCAAA;AAAA,UACE,MAAA;AAAA,UACAG,qBAAA,CAAK,QAAS,CAAA,SAAA,EAAW,gBAAgB,CAAA;AAAA,UACzC,mBAAA;AAAA,UACA,cAAA;AAAA,SACF;AAAA,OACJ,CAAA;AACA,MAAM,MAAA,UAAA,GAAaC,qBAAc,CAAA,qBAAA,EAAuB,aAAa,CAAA,CAAA;AAErE,MAAM,MAAAF,4BAAA;AAAA,QACJ,OAAM,gBAAoB,KAAA;AACxB,UAAA,OAAO,MAAM,MAAA,CAAO,IAAK,CAAA,gBAAgB,EAAE,MAAO,EAAA,CAAA;AAAA,SACpD;AAAA,QACA,UAAA;AAAA,QACA,EAAE,kBAAkB,EAAG,EAAA;AAAA,OACzB,CAAA;AAEA,MAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,QACV,+CAA+C,MAAO,CAAA,QAAA,CAAS,IAAI,CAAA,yBAAA,EAA4B,WAAW,MAAM,CAAA,CAAA;AAAA,OAClH,CAAA;AAAA,aACO,KAAO,EAAA;AACd,MAAM,MAAA,YAAA,GAAe,uDAAuD,KAAK,CAAA,CAAA,CAAA;AACjF,MAAK,IAAA,CAAA,MAAA,CAAO,MAAM,YAAY,CAAA,CAAA;AAAA,KAChC;AAEA,IAAA,OAAO,EAAE,OAAQ,EAAA,CAAA;AAAA,GACnB;AAAA,EAEA,sBACE,UAC2B,EAAA;AAC3B,IAAA,OAAO,IAAI,OAAA,CAAQ,CAAC,OAAA,EAAS,MAAW,KAAA;AACtC,MAAM,MAAA,aAAA,GAAgB,GAAG,UAAW,CAAA,SAAS,IAAI,UAAW,CAAA,IAAI,CAAI,CAAA,EAAA,UAAA,CAAW,IAAI,CAAA,CAAA,CAAA;AACnF,MAAA,MAAM,SAAY,GAAA,IAAA,CAAK,gBACnB,GAAA,aAAA,GACAG,+BAAuB,aAAa,CAAA,CAAA;AAExC,MAAA,MAAM,gBAAgBF,qBAAK,CAAA,KAAA,CAAM,IAAK,CAAA,IAAA,CAAK,gBAAgB,SAAS,CAAA,CAAA;AACpE,MAAA,IAAI,CAACG,0BAAA,CAAmB,IAAK,CAAA,cAAA,EAAgB,aAAa,CAAG,EAAA;AAC3D,QAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,UACV,gEAAgE,aAAa,CAAA,CAAA;AAAA,SAC/E,CAAA;AACA,QAAO,MAAA,CAAA,IAAI,KAAM,CAAA,CAAA,kBAAA,CAAoB,CAAC,CAAA,CAAA;AAAA,OACxC;AAEA,MAAA,MAAM,mBAA+B,EAAC,CAAA;AACtC,MAAA,IAAA,CAAK,aACF,CAAA,MAAA,CAAO,IAAK,CAAA,UAAU,EACtB,IAAK,CAAA,CAAA,EAAG,aAAa,CAAA,uBAAA,CAAyB,CAC9C,CAAA,gBAAA,EACA,CAAA,EAAA,CAAG,SAAS,CAAO,GAAA,KAAA;AAClB,QAAK,IAAA,CAAA,MAAA,CAAO,KAAM,CAAA,GAAA,CAAI,OAAO,CAAA,CAAA;AAC7B,QAAA,MAAA,CAAO,GAAG,CAAA,CAAA;AAAA,OACX,CAAA,CACA,EAAG,CAAA,MAAA,EAAQ,CAAS,KAAA,KAAA;AACnB,QAAA,gBAAA,CAAiB,KAAK,KAAK,CAAA,CAAA;AAAA,OAC5B,CAAA,CACA,EAAG,CAAA,KAAA,EAAO,MAAM;AACf,QAAA,MAAM,uBACJ,MAAO,CAAA,MAAA,CAAO,gBAAgB,CAAA,CAAE,SAAS,OAAO,CAAA,CAAA;AAClD,QAAQ,OAAA,CAAAC,sBAAA,CAAM,KAAM,CAAA,oBAAoB,CAAC,CAAA,CAAA;AAAA,OAC1C,CAAA,CAAA;AAAA,KACJ,CAAA,CAAA;AAAA,GACH;AAAA;AAAA;AAAA;AAAA,EAKA,UAA8B,GAAA;AAC5B,IAAO,OAAA,CAAC,KAAK,GAAQ,KAAA;AACnB,MAAA,MAAM,aAAa,SAAU,CAAA,GAAA,CAAI,KAAK,OAAQ,CAAA,KAAA,EAAO,EAAE,CAAC,CAAA,CAAA;AAGxD,MAAA,MAAM,cAAiB,GAAA,IAAA,CAAK,gBACxB,GAAA,UAAA,GACAC,4CAAoC,UAAU,CAAA,CAAA;AAGlD,MAAA,MAAM,WAAWL,qBAAK,CAAA,KAAA,CAAM,IAAK,CAAA,IAAA,CAAK,gBAAgB,cAAc,CAAA,CAAA;AACpE,MAAA,IAAI,CAACG,0BAAA,CAAmB,IAAK,CAAA,cAAA,EAAgB,QAAQ,CAAG,EAAA;AACtD,QAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,UACV,8EAA8E,cAAc,CAAA,CAAA;AAAA,SAC9F,CAAA;AACA,QAAA,GAAA,CAAI,MAAO,CAAA,GAAG,CAAE,CAAA,IAAA,CAAK,gBAAgB,CAAA,CAAA;AACrC,QAAA,OAAA;AAAA,OACF;AAGA,MAAM,MAAA,aAAA,GAAgBH,qBAAK,CAAA,OAAA,CAAQ,QAAQ,CAAA,CAAA;AAC3C,MAAM,MAAA,eAAA,GAAkBM,mCAA2B,aAAa,CAAA,CAAA;AAGhE,MAAA,IAAA,CAAK,aACF,CAAA,MAAA,CAAO,IAAK,CAAA,UAAU,CACtB,CAAA,IAAA,CAAK,QAAQ,CAAA,CACb,gBAAiB,EAAA,CACjB,EAAG,CAAA,MAAA,EAAQ,MAAM;AAChB,QAAI,GAAA,CAAA,SAAA,CAAU,KAAK,eAAe,CAAA,CAAA;AAAA,OACnC,CAAA,CACA,EAAG,CAAA,OAAA,EAAS,CAAO,GAAA,KAAA;AAClB,QAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,UACV,kEAAkE,IAAK,CAAA,UAAU,YAAY,QAAQ,CAAA,EAAA,EAAK,IAAI,OAAO,CAAA,CAAA;AAAA,SACvH,CAAA;AAEA,QAAI,IAAA,CAAC,IAAI,WAAa,EAAA;AACpB,UAAA,GAAA,CAAI,MAAO,CAAA,GAAG,CAAE,CAAA,IAAA,CAAK,gBAAgB,CAAA,CAAA;AAAA,SAChC,MAAA;AACL,UAAA,GAAA,CAAI,OAAQ,EAAA,CAAA;AAAA,SACd;AAAA,OACD,CACA,CAAA,IAAA,CAAK,GAAG,CAAA,CAAA;AAAA,KACb,CAAA;AAAA,GACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,qBAAqB,MAAkC,EAAA;AAC3D,IAAO,OAAA,IAAI,QAAQ,CAAW,OAAA,KAAA;AAC5B,MAAM,MAAA,aAAA,GAAgB,CAAG,EAAA,MAAA,CAAO,QAAS,CAAA,SAAS,CAAI,CAAA,EAAA,MAAA,CAAO,IAAI,CAAA,CAAA,EAAI,MAAO,CAAA,QAAA,CAAS,IAAI,CAAA,CAAA,CAAA;AACzF,MAAA,MAAM,SAAY,GAAA,IAAA,CAAK,gBACnB,GAAA,aAAA,GACAJ,+BAAuB,aAAa,CAAA,CAAA;AAExC,MAAA,MAAM,gBAAgBF,qBAAK,CAAA,KAAA,CAAM,IAAK,CAAA,IAAA,CAAK,gBAAgB,SAAS,CAAA,CAAA;AACpE,MAAA,IAAI,CAACG,0BAAA,CAAmB,IAAK,CAAA,cAAA,EAAgB,aAAa,CAAG,EAAA;AAC3D,QAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,UACV,0EAA0E,aAAa,CAAA,CAAA;AAAA,SACzF,CAAA;AACA,QAAA,OAAA,CAAQ,KAAK,CAAA,CAAA;AAAA,OACf;AAEA,MAAA,IAAA,CAAK,aACF,CAAA,MAAA,CAAO,IAAK,CAAA,UAAU,EACtB,IAAK,CAAA,CAAA,EAAG,aAAa,CAAA,WAAA,CAAa,CAClC,CAAA,MAAA,EACA,CAAA,IAAA,CAAK,CAAC,QAAiC,KAAA;AACtC,QAAQ,OAAA,CAAA,QAAA,CAAS,CAAC,CAAC,CAAA,CAAA;AAAA,OACpB,CACA,CAAA,KAAA,CAAM,MAAM;AACX,QAAA,OAAA,CAAQ,KAAK,CAAA,CAAA;AAAA,OACd,CAAA,CAAA;AAAA,KACJ,CAAA,CAAA;AAAA,GACH;AAAA,EAEA,gBAAgB,EAAE,cAAA,GAAiB,KAAO,EAAA,WAAA,GAAc,IAAqB,EAAA;AAC3E,IAAA,OAAO,IAAI,OAAA,CAAQ,CAAC,OAAA,EAAS,MAAW,KAAA;AAEtC,MAAA,MAAM,kBAA4B,IAAK,CAAA,aAAA,CACpC,OAAO,IAAK,CAAA,UAAU,EACtB,cAAe,EAAA,CAAA;AAClB,MAAA,MAAM,eAAe,IAAII,kCAAA;AAAA,QACvB,IAAK,CAAA,MAAA;AAAA,QACL,cAAA;AAAA,QACA,WAAA;AAAA,OACF,CAAA;AACA,MAAA,YAAA,CAAa,GAAG,QAAU,EAAA,OAAO,CAAE,CAAA,EAAA,CAAG,SAAS,MAAM,CAAA,CAAA;AACrD,MAAA,eAAA,CAAgB,IAAK,CAAA,YAAY,CAAE,CAAA,EAAA,CAAG,SAAS,CAAS,KAAA,KAAA;AACtD,QAAA,YAAA,CAAa,OAAQ,EAAA,CAAA;AACrB,QAAA,MAAA,CAAO,KAAK,CAAA,CAAA;AAAA,OACb,CAAA,CAAA;AAAA,KACF,CAAA,CAAA;AAAA,GACH;AAAA,EAEQ,kBAAkB,MAAmC,EAAA;AAC3D,IAAM,MAAA,kBAAA,GAA+B,IAAK,CAAA,aAAA,CACvC,MAAO,CAAA,IAAA,CAAK,UAAU,CAAA,CACtB,cAAe,CAAA,EAAE,MAAQ,EAAA,MAAA,EAAQ,CAAA,CAAA;AAEpC,IAAA,OAAO,IAAI,OAAA,CAAQ,CAAC,OAAA,EAAS,MAAW,KAAA;AACtC,MAAA,MAAM,QAAkB,EAAC,CAAA;AAEzB,MAAmB,kBAAA,CAAA,EAAA,CAAG,SAAS,CAAS,KAAA,KAAA;AAEtC,QAAA,MAAA,CAAO,KAAK,CAAA,CAAA;AAAA,OACb,CAAA,CAAA;AAED,MAAmB,kBAAA,CAAA,EAAA,CAAG,MAAQ,EAAA,CAAC,IAAe,KAAA;AAE5C,QAAM,KAAA,CAAA,IAAA,CAAK,KAAK,IAAI,CAAA,CAAA;AAAA,OACrB,CAAA,CAAA;AAED,MAAmB,kBAAA,CAAA,EAAA,CAAG,OAAO,MAAM;AAEjC,QAAA,OAAA,CAAQ,KAAK,CAAA,CAAA;AAAA,OACd,CAAA,CAAA;AAAA,KACF,CAAA,CAAA;AAAA,GACH;AACF;;;;"}

package/dist/stages/publish/helpers.cjs.js

@@ -0,0 +1,138 @@
+'use strict';
+
+var catalogModel = require('@backstage/catalog-model');
+var mime = require('mime-types');
+var path = require('path');
+var createLimiter = require('p-limit');
+var recursiveReadDir = require('recursive-readdir');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var mime__default = /*#__PURE__*/_interopDefaultCompat(mime);
+var path__default = /*#__PURE__*/_interopDefaultCompat(path);
+var createLimiter__default = /*#__PURE__*/_interopDefaultCompat(createLimiter);
+var recursiveReadDir__default = /*#__PURE__*/_interopDefaultCompat(recursiveReadDir);
+
+const getContentTypeForExtension = (ext) => {
+  const defaultContentType = "text/plain; charset=utf-8";
+  const excludedTypes = [
+    "text/html",
+    "text/xml",
+    "image/svg+xml",
+    "text/xsl",
+    "application/vnd.wap.xhtml+xml",
+    "multipart/x-mixed-replace",
+    "text/rdf",
+    "application/mathml+xml",
+    "application/octet-stream",
+    "application/rdf+xml",
+    "application/xhtml+xml",
+    "application/xml",
+    "text/cache-manifest",
+    "text/vtt"
+  ];
+  if (ext.match(
+    /htm|xml|svg|appcache|manifest|mathml|owl|rdf|rng|vtt|xht|xsd|xsl/i
+  )) {
+    return defaultContentType;
+  }
+  const contentType = mime__default.default.lookup(ext);
+  if (contentType && excludedTypes.includes(contentType)) {
+    return defaultContentType;
+  }
+  return mime__default.default.contentType(ext) || defaultContentType;
+};
+const getHeadersForFileExtension = (fileExtension) => {
+  return {
+    "Content-Type": getContentTypeForExtension(fileExtension)
+  };
+};
+const getFileTreeRecursively = async (rootDirPath) => {
+  const fileList = await recursiveReadDir__default.default(rootDirPath).catch((error) => {
+    throw new Error(`Failed to read template directory: ${error.message}`);
+  });
+  return fileList;
+};
+const lowerCaseEntityTriplet = (posixPath) => {
+  const [namespace, kind, name, ...rest] = posixPath.split(path__default.default.posix.sep);
+  const lowerNamespace = namespace.toLowerCase();
+  const lowerKind = kind.toLowerCase();
+  const lowerName = name.toLowerCase();
+  return [lowerNamespace, lowerKind, lowerName, ...rest].join(path__default.default.posix.sep);
+};
+const lowerCaseEntityTripletInStoragePath = (originalPath) => {
+  let posixPath = originalPath;
+  if (originalPath.includes(path__default.default.win32.sep)) {
+    posixPath = originalPath.split(path__default.default.win32.sep).join(path__default.default.posix.sep);
+  }
+  const parts = posixPath.split(path__default.default.posix.sep);
+  if (parts[0] === "") {
+    parts.shift();
+  }
+  if (parts.length <= 3) {
+    throw new Error(
+      `Encountered file unmanaged by TechDocs ${originalPath}. Skipping.`
+    );
+  }
+  return lowerCaseEntityTriplet(parts.join(path__default.default.posix.sep));
+};
+const normalizeExternalStorageRootPath = (posixPath) => {
+  let normalizedPath = posixPath;
+  if (posixPath.startsWith(path__default.default.posix.sep)) {
+    normalizedPath = posixPath.slice(1);
+  }
+  if (normalizedPath.endsWith(path__default.default.posix.sep)) {
+    normalizedPath = normalizedPath.slice(0, normalizedPath.length - 1);
+  }
+  return normalizedPath;
+};
+const getStaleFiles = (newFiles, oldFiles) => {
+  const staleFiles = new Set(oldFiles);
+  const removedParentDirs = /* @__PURE__ */ new Set();
+  newFiles.forEach((newFile) => {
+    staleFiles.delete(newFile);
+    let parentDir = newFile.substring(0, newFile.lastIndexOf("/"));
+    while (!removedParentDirs.has(parentDir) && parentDir.length >= newFile.indexOf("/")) {
+      staleFiles.delete(parentDir);
+      removedParentDirs.add(parentDir);
+      parentDir = parentDir.substring(0, parentDir.lastIndexOf("/"));
+    }
+  });
+  return Array.from(staleFiles);
+};
+const getCloudPathForLocalPath = (entity, localPath = "", useLegacyPathCasing = false, externalStorageRootPath = "") => {
+  const relativeFilePathPosix = localPath.split(path__default.default.sep).join(path__default.default.posix.sep);
+  const entityRootDir = `${entity.metadata?.namespace ?? catalogModel.DEFAULT_NAMESPACE}/${entity.kind}/${entity.metadata.name}`;
+  const relativeFilePathTriplet = `${entityRootDir}/${relativeFilePathPosix}`;
+  const destination = useLegacyPathCasing ? relativeFilePathTriplet : lowerCaseEntityTriplet(relativeFilePathTriplet);
+  const destinationWithRoot = [
+    // The extra filter prevents unintended double slashes and prefixes.
+    ...externalStorageRootPath.split(path__default.default.posix.sep).filter((s) => s !== ""),
+    destination
+  ].join("/");
+  return destinationWithRoot;
+};
+const bulkStorageOperation = async (operation, args, { concurrencyLimit } = { concurrencyLimit: 25 }) => {
+  const limiter = createLimiter__default.default(concurrencyLimit);
+  await Promise.all(args.map((arg) => limiter(operation, arg)));
+};
+const isValidContentPath = (bucketRoot, contentPath) => {
+  const relativePath = path__default.default.posix.relative(bucketRoot, contentPath);
+  if (relativePath === "") {
+    return true;
+  }
+  const outsideBase = relativePath.startsWith("..");
+  const differentDrive = path__default.default.posix.isAbsolute(relativePath);
+  return !outsideBase && !differentDrive;
+};
+
+exports.bulkStorageOperation = bulkStorageOperation;
+exports.getCloudPathForLocalPath = getCloudPathForLocalPath;
+exports.getFileTreeRecursively = getFileTreeRecursively;
+exports.getHeadersForFileExtension = getHeadersForFileExtension;
+exports.getStaleFiles = getStaleFiles;
+exports.isValidContentPath = isValidContentPath;
+exports.lowerCaseEntityTriplet = lowerCaseEntityTriplet;
+exports.lowerCaseEntityTripletInStoragePath = lowerCaseEntityTripletInStoragePath;
+exports.normalizeExternalStorageRootPath = normalizeExternalStorageRootPath;
+//# sourceMappingURL=helpers.cjs.js.map

package/dist/stages/publish/helpers.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.cjs.js","sources":["../../../src/stages/publish/helpers.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 */\nimport { Entity, DEFAULT_NAMESPACE } from '@backstage/catalog-model';\nimport mime from 'mime-types';\nimport path from 'path';\nimport createLimiter from 'p-limit';\nimport recursiveReadDir from 'recursive-readdir';\n\n/**\n * Helper to get the expected content-type for a given file extension. Also\n * takes XSS mitigation into account.\n */\nconst getContentTypeForExtension = (ext: string): string => {\n  const defaultContentType = 'text/plain; charset=utf-8';\n  const excludedTypes = [\n    'text/html',\n    'text/xml',\n    'image/svg+xml',\n    'text/xsl',\n    'application/vnd.wap.xhtml+xml',\n    'multipart/x-mixed-replace',\n    'text/rdf',\n    'application/mathml+xml',\n    'application/octet-stream',\n    'application/rdf+xml',\n    'application/xhtml+xml',\n    'application/xml',\n    'text/cache-manifest',\n    'text/vtt',\n  ];\n\n  // Prevent sanitization bypass by preventing browsers from directly rendering\n  // the contents of untrusted files.\n  if (\n    ext.match(\n      /htm|xml|svg|appcache|manifest|mathml|owl|rdf|rng|vtt|xht|xsd|xsl/i,\n    )\n  ) {\n    return defaultContentType;\n  }\n\n  // Check again to make sure that the content type is not in the excluded mime-type list\n  // We use .lookup here to avoid the \"; charset=...\" addition\n  const contentType = mime.lookup(ext);\n  if (contentType && excludedTypes.includes(contentType)) {\n    return defaultContentType;\n  }\n\n  return mime.contentType(ext) || defaultContentType;\n};\n\nexport type responseHeadersType = {\n  'Content-Type': string;\n};\n\n/**\n * Some files need special headers to be used correctly by the frontend. This function\n * generates headers in the response to those file requests.\n * @param fileExtension - .html, .css, .js, .png etc.\n */\nexport const getHeadersForFileExtension = (\n  fileExtension: string,\n): responseHeadersType => {\n  return {\n    'Content-Type': getContentTypeForExtension(fileExtension),\n  };\n};\n\n/**\n * Recursively traverse all the sub-directories of a path and return\n * a list of absolute paths of all the files. e.g. tree command in Unix\n *\n * @example\n *\n * /User/username/my_dir\n *     dirA\n *     |   subDirA\n *     |   |   file1\n *     EmptyDir\n *     dirB\n *     |   file2\n *     file3\n *\n * getFileListRecursively('/Users/username/myDir')\n * // returns\n * [\n *   '/User/username/my_dir/dirA/subDirA/file1',\n *   '/User/username/my_dir/dirB/file2',\n *   '/User/username/my_dir/file3'\n * ]\n * @param rootDirPath - Absolute path to the root directory.\n */\nexport const getFileTreeRecursively = async (\n  rootDirPath: string,\n): Promise<string[]> => {\n  // Iterate on all the files in the directory and its sub-directories\n  const fileList = await recursiveReadDir(rootDirPath).catch(error => {\n    throw new Error(`Failed to read template directory: ${error.message}`);\n  });\n  return fileList;\n};\n\n/**\n * Takes a posix path and returns a lower-cased version of entity's triplet\n * with the remaining path in posix.\n *\n * Path must not include a starting slash.\n *\n * @example\n * lowerCaseEntityTriplet('default/Component/backstage')\n * // return default/component/backstage\n */\nexport const lowerCaseEntityTriplet = (posixPath: string): string => {\n  const [namespace, kind, name, ...rest] = posixPath.split(path.posix.sep);\n  const lowerNamespace = namespace.toLowerCase();\n  const lowerKind = kind.toLowerCase();\n  const lowerName = name.toLowerCase();\n  return [lowerNamespace, lowerKind, lowerName, ...rest].join(path.posix.sep);\n};\n\n/**\n * Takes either a win32 or posix path and returns a lower-cased version of entity's triplet\n * with the remaining path in posix.\n *\n * Starting slashes will be trimmed.\n *\n * Throws an error if the path does not appear to be an entity triplet.\n *\n * @example\n * lowerCaseEntityTripletInStoragePath('/default/Component/backstage/file.txt')\n * // return default/component/backstage/file.txt\n */\nexport const lowerCaseEntityTripletInStoragePath = (\n  originalPath: string,\n): string => {\n  let posixPath = originalPath;\n  if (originalPath.includes(path.win32.sep)) {\n    posixPath = originalPath.split(path.win32.sep).join(path.posix.sep);\n  }\n\n  // remove leading slash\n  const parts = posixPath.split(path.posix.sep);\n  if (parts[0] === '') {\n    parts.shift();\n  }\n\n  // check if all parts of the entity exist (name, namespace, kind) plus filename\n  if (parts.length <= 3) {\n    throw new Error(\n      `Encountered file unmanaged by TechDocs ${originalPath}. Skipping.`,\n    );\n  }\n\n  return lowerCaseEntityTriplet(parts.join(path.posix.sep));\n};\n\n/**\n * Take a posix path and return a path without leading and trailing\n * separators\n *\n * @example\n * normalizeExternalStorageRootPath('/backstage-data/techdocs/')\n * // return backstage-data/techdocs\n */\nexport const normalizeExternalStorageRootPath = (posixPath: string): string => {\n  // remove leading slash\n  let normalizedPath = posixPath;\n  if (posixPath.startsWith(path.posix.sep)) {\n    normalizedPath = posixPath.slice(1);\n  }\n\n  // remove trailing slash\n  if (normalizedPath.endsWith(path.posix.sep)) {\n    normalizedPath = normalizedPath.slice(0, normalizedPath.length - 1);\n  }\n\n  return normalizedPath;\n};\n\n// Only returns the files that existed previously and are not present anymore.\nexport const getStaleFiles = (\n  newFiles: string[],\n  oldFiles: string[],\n): string[] => {\n  const staleFiles = new Set(oldFiles);\n  const removedParentDirs = new Set();\n  newFiles.forEach(newFile => {\n    staleFiles.delete(newFile);\n\n    // We have to traverse through the directory hierarchy of a new file and\n    // ensure that we won't try to delete one of the parent directories.\n    let parentDir = newFile.substring(0, newFile.lastIndexOf('/'));\n    while (\n      !removedParentDirs.has(parentDir) &&\n      parentDir.length >= newFile.indexOf('/')\n    ) {\n      staleFiles.delete(parentDir);\n      removedParentDirs.add(parentDir);\n      parentDir = parentDir.substring(0, parentDir.lastIndexOf('/'));\n    }\n  });\n  return Array.from(staleFiles);\n};\n\n// Compose actual filename on remote bucket including entity information\nexport const getCloudPathForLocalPath = (\n  entity: Entity,\n  localPath = '',\n  useLegacyPathCasing = false,\n  externalStorageRootPath = '',\n): string => {\n  // Convert destination file path to a POSIX path for uploading.\n  // GCS expects / as path separator and relativeFilePath will contain \\\\ on Windows.\n  // https://cloud.google.com/storage/docs/gsutil/addlhelp/HowSubdirectoriesWork\n  const relativeFilePathPosix = localPath.split(path.sep).join(path.posix.sep);\n\n  // The / delimiter is intentional since it represents the cloud storage and not the local file system.\n  const entityRootDir = `${entity.metadata?.namespace ?? DEFAULT_NAMESPACE}/${\n    entity.kind\n  }/${entity.metadata.name}`;\n\n  const relativeFilePathTriplet = `${entityRootDir}/${relativeFilePathPosix}`;\n\n  const destination = useLegacyPathCasing\n    ? relativeFilePathTriplet\n    : lowerCaseEntityTriplet(relativeFilePathTriplet);\n\n  // Again, the / delimiter is intentional, as it represents remote storage.\n  const destinationWithRoot = [\n    // The extra filter prevents unintended double slashes and prefixes.\n    ...externalStorageRootPath.split(path.posix.sep).filter(s => s !== ''),\n    destination,\n  ].join('/');\n\n  return destinationWithRoot; // Remote storage file relative path\n};\n\n// Perform rate limited generic operations by passing a function and a list of arguments\nexport const bulkStorageOperation = async <T>(\n  operation: (arg: T) => Promise<unknown>,\n  args: T[],\n  { concurrencyLimit } = { concurrencyLimit: 25 },\n) => {\n  const limiter = createLimiter(concurrencyLimit);\n  await Promise.all(args.map(arg => limiter(operation, arg)));\n};\n\n// Checks content path is the same as or a child path of bucketRoot, specifically for posix paths.\nexport const isValidContentPath = (\n  bucketRoot: string,\n  contentPath: string,\n): boolean => {\n  const relativePath = path.posix.relative(bucketRoot, contentPath);\n  if (relativePath === '') {\n    // The same directory\n    return true;\n  }\n\n  const outsideBase = relativePath.startsWith('..'); // not outside base\n  const differentDrive = path.posix.isAbsolute(relativePath); // on Windows, this means dir is on a different drive from base.\n\n  return !outsideBase && !differentDrive;\n};\n"],"names":["mime","recursiveReadDir","path","DEFAULT_NAMESPACE","createLimiter"],"mappings":";;;;;;;;;;;;;;;AAyBA,MAAM,0BAAA,GAA6B,CAAC,GAAwB,KAAA;AAC1D,EAAA,MAAM,kBAAqB,GAAA,2BAAA,CAAA;AAC3B,EAAA,MAAM,aAAgB,GAAA;AAAA,IACpB,WAAA;AAAA,IACA,UAAA;AAAA,IACA,eAAA;AAAA,IACA,UAAA;AAAA,IACA,+BAAA;AAAA,IACA,2BAAA;AAAA,IACA,UAAA;AAAA,IACA,wBAAA;AAAA,IACA,0BAAA;AAAA,IACA,qBAAA;AAAA,IACA,uBAAA;AAAA,IACA,iBAAA;AAAA,IACA,qBAAA;AAAA,IACA,UAAA;AAAA,GACF,CAAA;AAIA,EAAA,IACE,GAAI,CAAA,KAAA;AAAA,IACF,mEAAA;AAAA,GAEF,EAAA;AACA,IAAO,OAAA,kBAAA,CAAA;AAAA,GACT;AAIA,EAAM,MAAA,WAAA,GAAcA,qBAAK,CAAA,MAAA,CAAO,GAAG,CAAA,CAAA;AACnC,EAAA,IAAI,WAAe,IAAA,aAAA,CAAc,QAAS,CAAA,WAAW,CAAG,EAAA;AACtD,IAAO,OAAA,kBAAA,CAAA;AAAA,GACT;AAEA,EAAO,OAAAA,qBAAA,CAAK,WAAY,CAAA,GAAG,CAAK,IAAA,kBAAA,CAAA;AAClC,CAAA,CAAA;AAWa,MAAA,0BAAA,GAA6B,CACxC,aACwB,KAAA;AACxB,EAAO,OAAA;AAAA,IACL,cAAA,EAAgB,2BAA2B,aAAa,CAAA;AAAA,GAC1D,CAAA;AACF,EAAA;AA0Ba,MAAA,sBAAA,GAAyB,OACpC,WACsB,KAAA;AAEtB,EAAA,MAAM,WAAW,MAAMC,iCAAA,CAAiB,WAAW,CAAA,CAAE,MAAM,CAAS,KAAA,KAAA;AAClE,IAAA,MAAM,IAAI,KAAA,CAAM,CAAsC,mCAAA,EAAA,KAAA,CAAM,OAAO,CAAE,CAAA,CAAA,CAAA;AAAA,GACtE,CAAA,CAAA;AACD,EAAO,OAAA,QAAA,CAAA;AACT,EAAA;AAYa,MAAA,sBAAA,GAAyB,CAAC,SAA8B,KAAA;AACnE,EAAM,MAAA,CAAC,SAAW,EAAA,IAAA,EAAM,IAAM,EAAA,GAAG,IAAI,CAAA,GAAI,SAAU,CAAA,KAAA,CAAMC,qBAAK,CAAA,KAAA,CAAM,GAAG,CAAA,CAAA;AACvE,EAAM,MAAA,cAAA,GAAiB,UAAU,WAAY,EAAA,CAAA;AAC7C,EAAM,MAAA,SAAA,GAAY,KAAK,WAAY,EAAA,CAAA;AACnC,EAAM,MAAA,SAAA,GAAY,KAAK,WAAY,EAAA,CAAA;AACnC,EAAO,OAAA,CAAC,cAAgB,EAAA,SAAA,EAAW,SAAW,EAAA,GAAG,IAAI,CAAE,CAAA,IAAA,CAAKA,qBAAK,CAAA,KAAA,CAAM,GAAG,CAAA,CAAA;AAC5E,EAAA;AAca,MAAA,mCAAA,GAAsC,CACjD,YACW,KAAA;AACX,EAAA,IAAI,SAAY,GAAA,YAAA,CAAA;AAChB,EAAA,IAAI,YAAa,CAAA,QAAA,CAASA,qBAAK,CAAA,KAAA,CAAM,GAAG,CAAG,EAAA;AACzC,IAAY,SAAA,GAAA,YAAA,CAAa,MAAMA,qBAAK,CAAA,KAAA,CAAM,GAAG,CAAE,CAAA,IAAA,CAAKA,qBAAK,CAAA,KAAA,CAAM,GAAG,CAAA,CAAA;AAAA,GACpE;AAGA,EAAA,MAAM,KAAQ,GAAA,SAAA,CAAU,KAAM,CAAAA,qBAAA,CAAK,MAAM,GAAG,CAAA,CAAA;AAC5C,EAAI,IAAA,KAAA,CAAM,CAAC,CAAA,KAAM,EAAI,EAAA;AACnB,IAAA,KAAA,CAAM,KAAM,EAAA,CAAA;AAAA,GACd;AAGA,EAAI,IAAA,KAAA,CAAM,UAAU,CAAG,EAAA;AACrB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,0CAA0C,YAAY,CAAA,WAAA,CAAA;AAAA,KACxD,CAAA;AAAA,GACF;AAEA,EAAA,OAAO,uBAAuB,KAAM,CAAA,IAAA,CAAKA,qBAAK,CAAA,KAAA,CAAM,GAAG,CAAC,CAAA,CAAA;AAC1D,EAAA;AAUa,MAAA,gCAAA,GAAmC,CAAC,SAA8B,KAAA;AAE7E,EAAA,IAAI,cAAiB,GAAA,SAAA,CAAA;AACrB,EAAA,IAAI,SAAU,CAAA,UAAA,CAAWA,qBAAK,CAAA,KAAA,CAAM,GAAG,CAAG,EAAA;AACxC,IAAiB,cAAA,GAAA,SAAA,CAAU,MAAM,CAAC,CAAA,CAAA;AAAA,GACpC;AAGA,EAAA,IAAI,cAAe,CAAA,QAAA,CAASA,qBAAK,CAAA,KAAA,CAAM,GAAG,CAAG,EAAA;AAC3C,IAAA,cAAA,GAAiB,cAAe,CAAA,KAAA,CAAM,CAAG,EAAA,cAAA,CAAe,SAAS,CAAC,CAAA,CAAA;AAAA,GACpE;AAEA,EAAO,OAAA,cAAA,CAAA;AACT,EAAA;AAGa,MAAA,aAAA,GAAgB,CAC3B,QAAA,EACA,QACa,KAAA;AACb,EAAM,MAAA,UAAA,GAAa,IAAI,GAAA,CAAI,QAAQ,CAAA,CAAA;AACnC,EAAM,MAAA,iBAAA,uBAAwB,GAAI,EAAA,CAAA;AAClC,EAAA,QAAA,CAAS,QAAQ,CAAW,OAAA,KAAA;AAC1B,IAAA,UAAA,CAAW,OAAO,OAAO,CAAA,CAAA;AAIzB,IAAA,IAAI,YAAY,OAAQ,CAAA,SAAA,CAAU,GAAG,OAAQ,CAAA,WAAA,CAAY,GAAG,CAAC,CAAA,CAAA;AAC7D,IACE,OAAA,CAAC,iBAAkB,CAAA,GAAA,CAAI,SAAS,CAAA,IAChC,UAAU,MAAU,IAAA,OAAA,CAAQ,OAAQ,CAAA,GAAG,CACvC,EAAA;AACA,MAAA,UAAA,CAAW,OAAO,SAAS,CAAA,CAAA;AAC3B,MAAA,iBAAA,CAAkB,IAAI,SAAS,CAAA,CAAA;AAC/B,MAAA,SAAA,GAAY,UAAU,SAAU,CAAA,CAAA,EAAG,SAAU,CAAA,WAAA,CAAY,GAAG,CAAC,CAAA,CAAA;AAAA,KAC/D;AAAA,GACD,CAAA,CAAA;AACD,EAAO,OAAA,KAAA,CAAM,KAAK,UAAU,CAAA,CAAA;AAC9B,EAAA;AAGa,MAAA,wBAAA,GAA2B,CACtC,MACA,EAAA,SAAA,GAAY,IACZ,mBAAsB,GAAA,KAAA,EACtB,0BAA0B,EACf,KAAA;AAIX,EAAM,MAAA,qBAAA,GAAwB,UAAU,KAAM,CAAAA,qBAAA,CAAK,GAAG,CAAE,CAAA,IAAA,CAAKA,qBAAK,CAAA,KAAA,CAAM,GAAG,CAAA,CAAA;AAG3E,EAAA,MAAM,aAAgB,GAAA,CAAA,EAAG,MAAO,CAAA,QAAA,EAAU,SAAa,IAAAC,8BAAiB,CACtE,CAAA,EAAA,MAAA,CAAO,IACT,CAAA,CAAA,EAAI,MAAO,CAAA,QAAA,CAAS,IAAI,CAAA,CAAA,CAAA;AAExB,EAAA,MAAM,uBAA0B,GAAA,CAAA,EAAG,aAAa,CAAA,CAAA,EAAI,qBAAqB,CAAA,CAAA,CAAA;AAEzE,EAAA,MAAM,WAAc,GAAA,mBAAA,GAChB,uBACA,GAAA,sBAAA,CAAuB,uBAAuB,CAAA,CAAA;AAGlD,EAAA,MAAM,mBAAsB,GAAA;AAAA;AAAA,IAE1B,GAAG,uBAAwB,CAAA,KAAA,CAAMD,qBAAK,CAAA,KAAA,CAAM,GAAG,CAAE,CAAA,MAAA,CAAO,CAAK,CAAA,KAAA,CAAA,KAAM,EAAE,CAAA;AAAA,IACrE,WAAA;AAAA,GACF,CAAE,KAAK,GAAG,CAAA,CAAA;AAEV,EAAO,OAAA,mBAAA,CAAA;AACT,EAAA;AAGa,MAAA,oBAAA,GAAuB,OAClC,SAAA,EACA,IACA,EAAA,EAAE,kBAAqB,GAAA,EAAE,gBAAkB,EAAA,EAAA,EACxC,KAAA;AACH,EAAM,MAAA,OAAA,GAAUE,+BAAc,gBAAgB,CAAA,CAAA;AAC9C,EAAM,MAAA,OAAA,CAAQ,IAAI,IAAK,CAAA,GAAA,CAAI,SAAO,OAAQ,CAAA,SAAA,EAAW,GAAG,CAAC,CAAC,CAAA,CAAA;AAC5D,EAAA;AAGa,MAAA,kBAAA,GAAqB,CAChC,UAAA,EACA,WACY,KAAA;AACZ,EAAA,MAAM,YAAe,GAAAF,qBAAA,CAAK,KAAM,CAAA,QAAA,CAAS,YAAY,WAAW,CAAA,CAAA;AAChE,EAAA,IAAI,iBAAiB,EAAI,EAAA;AAEvB,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAEA,EAAM,MAAA,WAAA,GAAc,YAAa,CAAA,UAAA,CAAW,IAAI,CAAA,CAAA;AAChD,EAAA,MAAM,cAAiB,GAAAA,qBAAA,CAAK,KAAM,CAAA,UAAA,CAAW,YAAY,CAAA,CAAA;AAEzD,EAAO,OAAA,CAAC,eAAe,CAAC,cAAA,CAAA;AAC1B;;;;;;;;;;;;"}

package/dist/stages/publish/local.cjs.js

@@ -0,0 +1,248 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var catalogModel = require('@backstage/catalog-model');
+var express = require('express');
+var fs = require('fs-extra');
+var os = require('os');
+var createLimiter = require('p-limit');
+var path = require('path');
+var helpers = require('./helpers.cjs.js');
+var errors = require('@backstage/errors');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var express__default = /*#__PURE__*/_interopDefaultCompat(express);
+var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+var os__default = /*#__PURE__*/_interopDefaultCompat(os);
+var createLimiter__default = /*#__PURE__*/_interopDefaultCompat(createLimiter);
+var path__default = /*#__PURE__*/_interopDefaultCompat(path);
+
+class LocalPublish {
+  legacyPathCasing;
+  logger;
+  discovery;
+  staticDocsDir;
+  constructor(options) {
+    this.logger = options.logger;
+    this.discovery = options.discovery;
+    this.legacyPathCasing = options.legacyPathCasing;
+    this.staticDocsDir = options.staticDocsDir;
+  }
+  static fromConfig(config, logger, discovery) {
+    const legacyPathCasing = config.getOptionalBoolean(
+      "techdocs.legacyUseCaseSensitiveTripletPaths"
+    ) || false;
+    let staticDocsDir = config.getOptionalString(
+      "techdocs.publisher.local.publishDirectory"
+    );
+    if (!staticDocsDir) {
+      try {
+        staticDocsDir = backendPluginApi.resolvePackagePath(
+          "@backstage/plugin-techdocs-backend",
+          "static/docs"
+        );
+      } catch (err) {
+        staticDocsDir = os__default.default.tmpdir();
+      }
+    }
+    return new LocalPublish({
+      logger,
+      discovery,
+      legacyPathCasing,
+      staticDocsDir
+    });
+  }
+  async getReadiness() {
+    return {
+      isAvailable: true
+    };
+  }
+  async publish({
+    entity,
+    directory
+  }) {
+    const entityNamespace = entity.metadata.namespace ?? "default";
+    let publishDir;
+    try {
+      publishDir = this.staticEntityPathJoin(
+        entityNamespace,
+        entity.kind,
+        entity.metadata.name
+      );
+    } catch (error) {
+      throw new errors.ForwardedError(
+        `Unable to publish TechDocs site for entity: ${catalogModel.stringifyEntityRef(
+          entity
+        )}`,
+        error
+      );
+    }
+    if (!fs__default.default.existsSync(publishDir)) {
+      this.logger.info(`Could not find ${publishDir}, creating the directory.`);
+      fs__default.default.mkdirSync(publishDir, { recursive: true });
+    }
+    try {
+      await fs__default.default.copy(directory, publishDir);
+      this.logger.info(`Published site stored at ${publishDir}`);
+    } catch (error) {
+      this.logger.debug(
+        `Failed to copy docs from ${directory} to ${publishDir}`
+      );
+      throw error;
+    }
+    const techdocsApiUrl = await this.discovery.getBaseUrl("techdocs");
+    const publishedFilePaths = (await helpers.getFileTreeRecursively(publishDir)).map(
+      (abs) => {
+        return abs.split(`${this.staticDocsDir}/`)[1];
+      }
+    );
+    return {
+      remoteUrl: `${techdocsApiUrl}/static/docs/${encodeURIComponent(
+        entity.metadata.name
+      )}`,
+      objects: publishedFilePaths
+    };
+  }
+  async fetchTechDocsMetadata(entityName) {
+    let metadataPath;
+    try {
+      metadataPath = this.staticEntityPathJoin(
+        entityName.namespace,
+        entityName.kind,
+        entityName.name,
+        "techdocs_metadata.json"
+      );
+    } catch (err) {
+      throw new errors.ForwardedError(
+        `Unexpected entity when fetching metadata: ${catalogModel.stringifyEntityRef(
+          entityName
+        )}`,
+        err
+      );
+    }
+    try {
+      return await fs__default.default.readJson(metadataPath);
+    } catch (err) {
+      throw new errors.ForwardedError(
+        `Unable to read techdocs_metadata.json at ${metadataPath}. Error: ${err}`,
+        err
+      );
+    }
+  }
+  docsRouter() {
+    const router = express__default.default.Router();
+    router.use((req, res, next) => {
+      if (this.legacyPathCasing) {
+        return next();
+      }
+      const [_, namespace, kind, name, ...rest] = req.path.split("/");
+      if (!namespace || !kind || !name) {
+        return next();
+      }
+      const newPath = [
+        _,
+        namespace.toLowerCase(),
+        kind.toLowerCase(),
+        name.toLowerCase(),
+        ...rest
+      ].join("/");
+      if (newPath === req.path) {
+        return next();
+      }
+      return res.redirect(301, req.baseUrl + newPath);
+    });
+    router.use(
+      express__default.default.static(this.staticDocsDir, {
+        // Handle content-type header the same as all other publishers.
+        setHeaders: (res, filePath) => {
+          const fileExtension = path__default.default.extname(filePath);
+          const headers = helpers.getHeadersForFileExtension(fileExtension);
+          for (const [header, value] of Object.entries(headers)) {
+            res.setHeader(header, value);
+          }
+        }
+      })
+    );
+    return router;
+  }
+  async hasDocsBeenGenerated(entity) {
+    const namespace = entity.metadata.namespace ?? "default";
+    try {
+      const indexHtmlPath = this.staticEntityPathJoin(
+        namespace,
+        entity.kind,
+        entity.metadata.name,
+        "index.html"
+      );
+      await fs__default.default.access(indexHtmlPath, fs__default.default.constants.F_OK);
+      return true;
+    } catch (err) {
+      if (err.name === "NotAllowedError") {
+        this.logger.error(
+          `Unexpected entity when checking if generated: ${catalogModel.stringifyEntityRef(
+            entity
+          )}`
+        );
+      }
+      return false;
+    }
+  }
+  /**
+   * This code will never run in practice. It is merely here to illustrate how
+   * to implement this method for other storage providers.
+   */
+  async migrateDocsCase({
+    removeOriginal = false,
+    concurrency = 25
+  }) {
+    const files = await helpers.getFileTreeRecursively(this.staticDocsDir);
+    const limit = createLimiter__default.default(concurrency);
+    await Promise.all(
+      files.map(
+        (f) => limit(async (file) => {
+          const relativeFile = file.replace(
+            `${this.staticDocsDir}${path__default.default.sep}`,
+            ""
+          );
+          const newFile = helpers.lowerCaseEntityTripletInStoragePath(relativeFile);
+          if (relativeFile === newFile) {
+            return;
+          }
+          await new Promise((resolve) => {
+            const migrate = removeOriginal ? fs__default.default.move : fs__default.default.copyFile;
+            this.logger.debug(`Migrating ${relativeFile}`);
+            migrate(file, newFile, (err) => {
+              if (err) {
+                this.logger.warn(
+                  `Unable to migrate ${relativeFile}: ${err.message}`
+                );
+              }
+              resolve();
+            });
+          });
+        }, f)
+      )
+    );
+  }
+  /**
+   * Utility wrapper around path.join(), used to control legacy case logic.
+   */
+  staticEntityPathJoin(...allParts) {
+    let staticEntityPath = this.staticDocsDir;
+    allParts.map((part) => part.split(path__default.default.sep)).flat().forEach((part, index) => {
+      if (index < 3) {
+        staticEntityPath = backendPluginApi.resolveSafeChildPath(
+          staticEntityPath,
+          this.legacyPathCasing ? part : part.toLowerCase()
+        );
+        return;
+      }
+      staticEntityPath = backendPluginApi.resolveSafeChildPath(staticEntityPath, part);
+    });
+    return staticEntityPath;
+  }
+}
+
+exports.LocalPublish = LocalPublish;
+//# sourceMappingURL=local.cjs.js.map

package/dist/stages/publish/local.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"local.cjs.js","sources":["../../../src/stages/publish/local.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  DiscoveryService,\n  LoggerService,\n  resolvePackagePath,\n  resolveSafeChildPath,\n} from '@backstage/backend-plugin-api';\nimport {\n  Entity,\n  CompoundEntityRef,\n  stringifyEntityRef,\n} from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport express from 'express';\nimport fs from 'fs-extra';\nimport os from 'os';\nimport createLimiter from 'p-limit';\nimport path from 'path';\nimport {\n  PublisherBase,\n  PublishRequest,\n  PublishResponse,\n  ReadinessResponse,\n  TechDocsMetadata,\n} from './types';\nimport {\n  getFileTreeRecursively,\n  getHeadersForFileExtension,\n  lowerCaseEntityTripletInStoragePath,\n} from './helpers';\nimport { ForwardedError } from '@backstage/errors';\n\n/**\n * Local publisher which uses the local filesystem to store the generated static files. It uses by default a\n * directory called \"static\" at the root of techdocs-backend plugin unless a directory has been configured by\n * \"techdocs.publisher.local.publishDirectory\".\n */\nexport class LocalPublish implements PublisherBase {\n  private readonly legacyPathCasing: boolean;\n  private readonly logger: LoggerService;\n  private readonly discovery: DiscoveryService;\n  private readonly staticDocsDir: string;\n\n  constructor(options: {\n    logger: LoggerService;\n    discovery: DiscoveryService;\n    legacyPathCasing: boolean;\n    staticDocsDir: string;\n  }) {\n    this.logger = options.logger;\n    this.discovery = options.discovery;\n    this.legacyPathCasing = options.legacyPathCasing;\n    this.staticDocsDir = options.staticDocsDir;\n  }\n\n  static fromConfig(\n    config: Config,\n    logger: LoggerService,\n    discovery: DiscoveryService,\n  ): PublisherBase {\n    const legacyPathCasing =\n      config.getOptionalBoolean(\n        'techdocs.legacyUseCaseSensitiveTripletPaths',\n      ) || false;\n\n    let staticDocsDir = config.getOptionalString(\n      'techdocs.publisher.local.publishDirectory',\n    );\n    if (!staticDocsDir) {\n      try {\n        staticDocsDir = resolvePackagePath(\n          '@backstage/plugin-techdocs-backend',\n          'static/docs',\n        );\n      } catch (err) {\n        // This will most probably never be used.\n        // The try/catch is introduced so that techdocs-cli can import @backstage/plugin-techdocs-node\n        // on CI/CD without installing techdocs backend plugin.\n        staticDocsDir = os.tmpdir();\n      }\n    }\n\n    return new LocalPublish({\n      logger,\n      discovery,\n      legacyPathCasing,\n      staticDocsDir,\n    });\n  }\n\n  async getReadiness(): Promise<ReadinessResponse> {\n    return {\n      isAvailable: true,\n    };\n  }\n\n  async publish({\n    entity,\n    directory,\n  }: PublishRequest): Promise<PublishResponse> {\n    const entityNamespace = entity.metadata.namespace ?? 'default';\n    let publishDir: string;\n\n    try {\n      publishDir = this.staticEntityPathJoin(\n        entityNamespace,\n        entity.kind,\n        entity.metadata.name,\n      );\n    } catch (error) {\n      throw new ForwardedError(\n        `Unable to publish TechDocs site for entity: ${stringifyEntityRef(\n          entity,\n        )}`,\n        error,\n      );\n    }\n\n    if (!fs.existsSync(publishDir)) {\n      this.logger.info(`Could not find ${publishDir}, creating the directory.`);\n      fs.mkdirSync(publishDir, { recursive: true });\n    }\n\n    try {\n      await fs.copy(directory, publishDir);\n      this.logger.info(`Published site stored at ${publishDir}`);\n    } catch (error) {\n      this.logger.debug(\n        `Failed to copy docs from ${directory} to ${publishDir}`,\n      );\n      throw error;\n    }\n\n    // Generate publish response.\n    const techdocsApiUrl = await this.discovery.getBaseUrl('techdocs');\n    const publishedFilePaths = (await getFileTreeRecursively(publishDir)).map(\n      abs => {\n        return abs.split(`${this.staticDocsDir}/`)[1];\n      },\n    );\n\n    return {\n      remoteUrl: `${techdocsApiUrl}/static/docs/${encodeURIComponent(\n        entity.metadata.name,\n      )}`,\n      objects: publishedFilePaths,\n    };\n  }\n\n  async fetchTechDocsMetadata(\n    entityName: CompoundEntityRef,\n  ): Promise<TechDocsMetadata> {\n    let metadataPath: string;\n\n    try {\n      metadataPath = this.staticEntityPathJoin(\n        entityName.namespace,\n        entityName.kind,\n        entityName.name,\n        'techdocs_metadata.json',\n      );\n    } catch (err) {\n      throw new ForwardedError(\n        `Unexpected entity when fetching metadata: ${stringifyEntityRef(\n          entityName,\n        )}`,\n        err,\n      );\n    }\n\n    try {\n      return await fs.readJson(metadataPath);\n    } catch (err) {\n      throw new ForwardedError(\n        `Unable to read techdocs_metadata.json at ${metadataPath}. Error: ${err}`,\n        err,\n      );\n    }\n  }\n\n  docsRouter(): express.Handler {\n    const router = express.Router();\n\n    // Redirect middleware ensuring that requests to case-sensitive entity\n    // triplet paths are always sent to lower-case versions.\n    router.use((req, res, next) => {\n      // If legacy path casing is on, let the request immediately continue.\n      if (this.legacyPathCasing) {\n        return next();\n      }\n\n      // Generate a lower-case entity triplet path.\n      const [_, namespace, kind, name, ...rest] = req.path.split('/');\n\n      // Ignore non-triplet objects.\n      if (!namespace || !kind || !name) {\n        return next();\n      }\n\n      const newPath = [\n        _,\n        namespace.toLowerCase(),\n        kind.toLowerCase(),\n        name.toLowerCase(),\n        ...rest,\n      ].join('/');\n\n      // If there was no change, then let express.static() handle the request.\n      if (newPath === req.path) {\n        return next();\n      }\n\n      // Otherwise, redirect to the new path.\n      return res.redirect(301, req.baseUrl + newPath);\n    });\n    router.use(\n      express.static(this.staticDocsDir, {\n        // Handle content-type header the same as all other publishers.\n        setHeaders: (res, filePath) => {\n          const fileExtension = path.extname(filePath);\n          const headers = getHeadersForFileExtension(fileExtension);\n          for (const [header, value] of Object.entries(headers)) {\n            res.setHeader(header, value);\n          }\n        },\n      }),\n    );\n\n    return router;\n  }\n\n  async hasDocsBeenGenerated(entity: Entity): Promise<boolean> {\n    const namespace = entity.metadata.namespace ?? 'default';\n\n    // Check if the file exists\n    try {\n      const indexHtmlPath = this.staticEntityPathJoin(\n        namespace,\n        entity.kind,\n        entity.metadata.name,\n        'index.html',\n      );\n\n      await fs.access(indexHtmlPath, fs.constants.F_OK);\n\n      return true;\n    } catch (err) {\n      if (err.name === 'NotAllowedError') {\n        this.logger.error(\n          `Unexpected entity when checking if generated: ${stringifyEntityRef(\n            entity,\n          )}`,\n        );\n      }\n      return false;\n    }\n  }\n\n  /**\n   * This code will never run in practice. It is merely here to illustrate how\n   * to implement this method for other storage providers.\n   */\n  async migrateDocsCase({\n    removeOriginal = false,\n    concurrency = 25,\n  }): Promise<void> {\n    // Iterate through every file in the root of the publisher.\n    const files = await getFileTreeRecursively(this.staticDocsDir);\n    const limit = createLimiter(concurrency);\n\n    await Promise.all(\n      files.map(f =>\n        limit(async file => {\n          const relativeFile = file.replace(\n            `${this.staticDocsDir}${path.sep}`,\n            '',\n          );\n          const newFile = lowerCaseEntityTripletInStoragePath(relativeFile);\n\n          // If all parts are already lowercase, ignore.\n          if (relativeFile === newFile) {\n            return;\n          }\n\n          // Otherwise, copy or move the file.\n          await new Promise<void>(resolve => {\n            const migrate = removeOriginal ? fs.move : fs.copyFile;\n            this.logger.debug(`Migrating ${relativeFile}`);\n            migrate(file, newFile, err => {\n              if (err) {\n                this.logger.warn(\n                  `Unable to migrate ${relativeFile}: ${err.message}`,\n                );\n              }\n              resolve();\n            });\n          });\n        }, f),\n      ),\n    );\n  }\n\n  /**\n   * Utility wrapper around path.join(), used to control legacy case logic.\n   */\n  protected staticEntityPathJoin(...allParts: string[]): string {\n    let staticEntityPath = this.staticDocsDir;\n\n    allParts\n      .map(part => part.split(path.sep))\n      .flat()\n      .forEach((part, index) => {\n        // Respect legacy path casing when operating on namespace, kind, or name.\n        if (index < 3) {\n          staticEntityPath = resolveSafeChildPath(\n            staticEntityPath,\n            this.legacyPathCasing ? part : part.toLowerCase(),\n          );\n          return;\n        }\n\n        // Otherwise, respect the provided case.\n        staticEntityPath = resolveSafeChildPath(staticEntityPath, part);\n      });\n\n    return staticEntityPath;\n  }\n}\n"],"names":["resolvePackagePath","os","ForwardedError","stringifyEntityRef","fs","getFileTreeRecursively","express","path","getHeadersForFileExtension","createLimiter","lowerCaseEntityTripletInStoragePath","resolveSafeChildPath"],"mappings":";;;;;;;;;;;;;;;;;;;;AAoDO,MAAM,YAAsC,CAAA;AAAA,EAChC,gBAAA,CAAA;AAAA,EACA,MAAA,CAAA;AAAA,EACA,SAAA,CAAA;AAAA,EACA,aAAA,CAAA;AAAA,EAEjB,YAAY,OAKT,EAAA;AACD,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AACtB,IAAA,IAAA,CAAK,YAAY,OAAQ,CAAA,SAAA,CAAA;AACzB,IAAA,IAAA,CAAK,mBAAmB,OAAQ,CAAA,gBAAA,CAAA;AAChC,IAAA,IAAA,CAAK,gBAAgB,OAAQ,CAAA,aAAA,CAAA;AAAA,GAC/B;AAAA,EAEA,OAAO,UAAA,CACL,MACA,EAAA,MAAA,EACA,SACe,EAAA;AACf,IAAA,MAAM,mBACJ,MAAO,CAAA,kBAAA;AAAA,MACL,6CAAA;AAAA,KACG,IAAA,KAAA,CAAA;AAEP,IAAA,IAAI,gBAAgB,MAAO,CAAA,iBAAA;AAAA,MACzB,2CAAA;AAAA,KACF,CAAA;AACA,IAAA,IAAI,CAAC,aAAe,EAAA;AAClB,MAAI,IAAA;AACF,QAAgB,aAAA,GAAAA,mCAAA;AAAA,UACd,oCAAA;AAAA,UACA,aAAA;AAAA,SACF,CAAA;AAAA,eACO,GAAK,EAAA;AAIZ,QAAA,aAAA,GAAgBC,oBAAG,MAAO,EAAA,CAAA;AAAA,OAC5B;AAAA,KACF;AAEA,IAAA,OAAO,IAAI,YAAa,CAAA;AAAA,MACtB,MAAA;AAAA,MACA,SAAA;AAAA,MACA,gBAAA;AAAA,MACA,aAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA,EAEA,MAAM,YAA2C,GAAA;AAC/C,IAAO,OAAA;AAAA,MACL,WAAa,EAAA,IAAA;AAAA,KACf,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,OAAQ,CAAA;AAAA,IACZ,MAAA;AAAA,IACA,SAAA;AAAA,GAC2C,EAAA;AAC3C,IAAM,MAAA,eAAA,GAAkB,MAAO,CAAA,QAAA,CAAS,SAAa,IAAA,SAAA,CAAA;AACrD,IAAI,IAAA,UAAA,CAAA;AAEJ,IAAI,IAAA;AACF,MAAA,UAAA,GAAa,IAAK,CAAA,oBAAA;AAAA,QAChB,eAAA;AAAA,QACA,MAAO,CAAA,IAAA;AAAA,QACP,OAAO,QAAS,CAAA,IAAA;AAAA,OAClB,CAAA;AAAA,aACO,KAAO,EAAA;AACd,MAAA,MAAM,IAAIC,qBAAA;AAAA,QACR,CAA+C,4CAAA,EAAAC,+BAAA;AAAA,UAC7C,MAAA;AAAA,SACD,CAAA,CAAA;AAAA,QACD,KAAA;AAAA,OACF,CAAA;AAAA,KACF;AAEA,IAAA,IAAI,CAACC,mBAAA,CAAG,UAAW,CAAA,UAAU,CAAG,EAAA;AAC9B,MAAA,IAAA,CAAK,MAAO,CAAA,IAAA,CAAK,CAAkB,eAAA,EAAA,UAAU,CAA2B,yBAAA,CAAA,CAAA,CAAA;AACxE,MAAAA,mBAAA,CAAG,SAAU,CAAA,UAAA,EAAY,EAAE,SAAA,EAAW,MAAM,CAAA,CAAA;AAAA,KAC9C;AAEA,IAAI,IAAA;AACF,MAAM,MAAAA,mBAAA,CAAG,IAAK,CAAA,SAAA,EAAW,UAAU,CAAA,CAAA;AACnC,MAAA,IAAA,CAAK,MAAO,CAAA,IAAA,CAAK,CAA4B,yBAAA,EAAA,UAAU,CAAE,CAAA,CAAA,CAAA;AAAA,aAClD,KAAO,EAAA;AACd,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,CAAA,yBAAA,EAA4B,SAAS,CAAA,IAAA,EAAO,UAAU,CAAA,CAAA;AAAA,OACxD,CAAA;AACA,MAAM,MAAA,KAAA,CAAA;AAAA,KACR;AAGA,IAAA,MAAM,cAAiB,GAAA,MAAM,IAAK,CAAA,SAAA,CAAU,WAAW,UAAU,CAAA,CAAA;AACjE,IAAA,MAAM,kBAAsB,GAAA,CAAA,MAAMC,8BAAuB,CAAA,UAAU,CAAG,EAAA,GAAA;AAAA,MACpE,CAAO,GAAA,KAAA;AACL,QAAA,OAAO,IAAI,KAAM,CAAA,CAAA,EAAG,KAAK,aAAa,CAAA,CAAA,CAAG,EAAE,CAAC,CAAA,CAAA;AAAA,OAC9C;AAAA,KACF,CAAA;AAEA,IAAO,OAAA;AAAA,MACL,SAAA,EAAW,CAAG,EAAA,cAAc,CAAgB,aAAA,EAAA,kBAAA;AAAA,QAC1C,OAAO,QAAS,CAAA,IAAA;AAAA,OACjB,CAAA,CAAA;AAAA,MACD,OAAS,EAAA,kBAAA;AAAA,KACX,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,sBACJ,UAC2B,EAAA;AAC3B,IAAI,IAAA,YAAA,CAAA;AAEJ,IAAI,IAAA;AACF,MAAA,YAAA,GAAe,IAAK,CAAA,oBAAA;AAAA,QAClB,UAAW,CAAA,SAAA;AAAA,QACX,UAAW,CAAA,IAAA;AAAA,QACX,UAAW,CAAA,IAAA;AAAA,QACX,wBAAA;AAAA,OACF,CAAA;AAAA,aACO,GAAK,EAAA;AACZ,MAAA,MAAM,IAAIH,qBAAA;AAAA,QACR,CAA6C,0CAAA,EAAAC,+BAAA;AAAA,UAC3C,UAAA;AAAA,SACD,CAAA,CAAA;AAAA,QACD,GAAA;AAAA,OACF,CAAA;AAAA,KACF;AAEA,IAAI,IAAA;AACF,MAAO,OAAA,MAAMC,mBAAG,CAAA,QAAA,CAAS,YAAY,CAAA,CAAA;AAAA,aAC9B,GAAK,EAAA;AACZ,MAAA,MAAM,IAAIF,qBAAA;AAAA,QACR,CAAA,yCAAA,EAA4C,YAAY,CAAA,SAAA,EAAY,GAAG,CAAA,CAAA;AAAA,QACvE,GAAA;AAAA,OACF,CAAA;AAAA,KACF;AAAA,GACF;AAAA,EAEA,UAA8B,GAAA;AAC5B,IAAM,MAAA,MAAA,GAASI,yBAAQ,MAAO,EAAA,CAAA;AAI9B,IAAA,MAAA,CAAO,GAAI,CAAA,CAAC,GAAK,EAAA,GAAA,EAAK,IAAS,KAAA;AAE7B,MAAA,IAAI,KAAK,gBAAkB,EAAA;AACzB,QAAA,OAAO,IAAK,EAAA,CAAA;AAAA,OACd;AAGA,MAAM,MAAA,CAAC,CAAG,EAAA,SAAA,EAAW,IAAM,EAAA,IAAA,EAAM,GAAG,IAAI,CAAI,GAAA,GAAA,CAAI,IAAK,CAAA,KAAA,CAAM,GAAG,CAAA,CAAA;AAG9D,MAAA,IAAI,CAAC,SAAA,IAAa,CAAC,IAAA,IAAQ,CAAC,IAAM,EAAA;AAChC,QAAA,OAAO,IAAK,EAAA,CAAA;AAAA,OACd;AAEA,MAAA,MAAM,OAAU,GAAA;AAAA,QACd,CAAA;AAAA,QACA,UAAU,WAAY,EAAA;AAAA,QACtB,KAAK,WAAY,EAAA;AAAA,QACjB,KAAK,WAAY,EAAA;AAAA,QACjB,GAAG,IAAA;AAAA,OACL,CAAE,KAAK,GAAG,CAAA,CAAA;AAGV,MAAI,IAAA,OAAA,KAAY,IAAI,IAAM,EAAA;AACxB,QAAA,OAAO,IAAK,EAAA,CAAA;AAAA,OACd;AAGA,MAAA,OAAO,GAAI,CAAA,QAAA,CAAS,GAAK,EAAA,GAAA,CAAI,UAAU,OAAO,CAAA,CAAA;AAAA,KAC/C,CAAA,CAAA;AACD,IAAO,MAAA,CAAA,GAAA;AAAA,MACLA,wBAAA,CAAQ,MAAO,CAAA,IAAA,CAAK,aAAe,EAAA;AAAA;AAAA,QAEjC,UAAA,EAAY,CAAC,GAAA,EAAK,QAAa,KAAA;AAC7B,UAAM,MAAA,aAAA,GAAgBC,qBAAK,CAAA,OAAA,CAAQ,QAAQ,CAAA,CAAA;AAC3C,UAAM,MAAA,OAAA,GAAUC,mCAA2B,aAAa,CAAA,CAAA;AACxD,UAAA,KAAA,MAAW,CAAC,MAAQ,EAAA,KAAK,KAAK,MAAO,CAAA,OAAA,CAAQ,OAAO,CAAG,EAAA;AACrD,YAAI,GAAA,CAAA,SAAA,CAAU,QAAQ,KAAK,CAAA,CAAA;AAAA,WAC7B;AAAA,SACF;AAAA,OACD,CAAA;AAAA,KACH,CAAA;AAEA,IAAO,OAAA,MAAA,CAAA;AAAA,GACT;AAAA,EAEA,MAAM,qBAAqB,MAAkC,EAAA;AAC3D,IAAM,MAAA,SAAA,GAAY,MAAO,CAAA,QAAA,CAAS,SAAa,IAAA,SAAA,CAAA;AAG/C,IAAI,IAAA;AACF,MAAA,MAAM,gBAAgB,IAAK,CAAA,oBAAA;AAAA,QACzB,SAAA;AAAA,QACA,MAAO,CAAA,IAAA;AAAA,QACP,OAAO,QAAS,CAAA,IAAA;AAAA,QAChB,YAAA;AAAA,OACF,CAAA;AAEA,MAAA,MAAMJ,mBAAG,CAAA,MAAA,CAAO,aAAe,EAAAA,mBAAA,CAAG,UAAU,IAAI,CAAA,CAAA;AAEhD,MAAO,OAAA,IAAA,CAAA;AAAA,aACA,GAAK,EAAA;AACZ,MAAI,IAAA,GAAA,CAAI,SAAS,iBAAmB,EAAA;AAClC,QAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,UACV,CAAiD,8CAAA,EAAAD,+BAAA;AAAA,YAC/C,MAAA;AAAA,WACD,CAAA,CAAA;AAAA,SACH,CAAA;AAAA,OACF;AACA,MAAO,OAAA,KAAA,CAAA;AAAA,KACT;AAAA,GACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,eAAgB,CAAA;AAAA,IACpB,cAAiB,GAAA,KAAA;AAAA,IACjB,WAAc,GAAA,EAAA;AAAA,GACE,EAAA;AAEhB,IAAA,MAAM,KAAQ,GAAA,MAAME,8BAAuB,CAAA,IAAA,CAAK,aAAa,CAAA,CAAA;AAC7D,IAAM,MAAA,KAAA,GAAQI,+BAAc,WAAW,CAAA,CAAA;AAEvC,IAAA,MAAM,OAAQ,CAAA,GAAA;AAAA,MACZ,KAAM,CAAA,GAAA;AAAA,QAAI,CAAA,CAAA,KACR,KAAM,CAAA,OAAM,IAAQ,KAAA;AAClB,UAAA,MAAM,eAAe,IAAK,CAAA,OAAA;AAAA,YACxB,CAAG,EAAA,IAAA,CAAK,aAAa,CAAA,EAAGF,sBAAK,GAAG,CAAA,CAAA;AAAA,YAChC,EAAA;AAAA,WACF,CAAA;AACA,UAAM,MAAA,OAAA,GAAUG,4CAAoC,YAAY,CAAA,CAAA;AAGhE,UAAA,IAAI,iBAAiB,OAAS,EAAA;AAC5B,YAAA,OAAA;AAAA,WACF;AAGA,UAAM,MAAA,IAAI,QAAc,CAAW,OAAA,KAAA;AACjC,YAAA,MAAM,OAAU,GAAA,cAAA,GAAiBN,mBAAG,CAAA,IAAA,GAAOA,mBAAG,CAAA,QAAA,CAAA;AAC9C,YAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAAa,UAAA,EAAA,YAAY,CAAE,CAAA,CAAA,CAAA;AAC7C,YAAQ,OAAA,CAAA,IAAA,EAAM,SAAS,CAAO,GAAA,KAAA;AAC5B,cAAA,IAAI,GAAK,EAAA;AACP,gBAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,kBACV,CAAqB,kBAAA,EAAA,YAAY,CAAK,EAAA,EAAA,GAAA,CAAI,OAAO,CAAA,CAAA;AAAA,iBACnD,CAAA;AAAA,eACF;AACA,cAAQ,OAAA,EAAA,CAAA;AAAA,aACT,CAAA,CAAA;AAAA,WACF,CAAA,CAAA;AAAA,WACA,CAAC,CAAA;AAAA,OACN;AAAA,KACF,CAAA;AAAA,GACF;AAAA;AAAA;AAAA;AAAA,EAKU,wBAAwB,QAA4B,EAAA;AAC5D,IAAA,IAAI,mBAAmB,IAAK,CAAA,aAAA,CAAA;AAE5B,IAAA,QAAA,CACG,GAAI,CAAA,CAAA,IAAA,KAAQ,IAAK,CAAA,KAAA,CAAMG,qBAAK,CAAA,GAAG,CAAC,CAAA,CAChC,IAAK,EAAA,CACL,OAAQ,CAAA,CAAC,MAAM,KAAU,KAAA;AAExB,MAAA,IAAI,QAAQ,CAAG,EAAA;AACb,QAAmB,gBAAA,GAAAI,qCAAA;AAAA,UACjB,gBAAA;AAAA,UACA,IAAK,CAAA,gBAAA,GAAmB,IAAO,GAAA,IAAA,CAAK,WAAY,EAAA;AAAA,SAClD,CAAA;AACA,QAAA,OAAA;AAAA,OACF;AAGA,MAAmB,gBAAA,GAAAA,qCAAA,CAAqB,kBAAkB,IAAI,CAAA,CAAA;AAAA,KAC/D,CAAA,CAAA;AAEH,IAAO,OAAA,gBAAA,CAAA;AAAA,GACT;AACF;;;;"}

package/dist/stages/publish/migrations/GoogleMigration.cjs.js

@@ -0,0 +1,52 @@
+'use strict';
+
+var errors = require('@backstage/errors');
+var stream = require('stream');
+var helpers = require('../helpers.cjs.js');
+
+class MigrateWriteStream extends stream.Writable {
+  logger;
+  removeOriginal;
+  maxConcurrency;
+  inFlight = 0;
+  constructor(logger, removeOriginal, concurrency) {
+    super({ objectMode: true });
+    this.logger = logger;
+    this.removeOriginal = removeOriginal;
+    this.maxConcurrency = concurrency;
+  }
+  _write(file, _encoding, next) {
+    let shouldCallNext = true;
+    let newFile;
+    try {
+      newFile = helpers.lowerCaseEntityTripletInStoragePath(file.name);
+    } catch (e) {
+      errors.assertError(e);
+      this.logger.warn(e.message);
+      next();
+      return;
+    }
+    if (newFile === file.name) {
+      next();
+      return;
+    }
+    this.inFlight++;
+    if (this.inFlight < this.maxConcurrency) {
+      next();
+      shouldCallNext = false;
+    }
+    const migrate = this.removeOriginal ? file.move.bind(file) : file.copy.bind(file);
+    this.logger.debug(`Migrating ${file.name}`);
+    migrate(newFile).catch(
+      (e) => this.logger.warn(`Unable to migrate ${file.name}: ${e.message}`)
+    ).finally(() => {
+      this.inFlight--;
+      if (shouldCallNext) {
+        next();
+      }
+    });
+  }
+}
+
+exports.MigrateWriteStream = MigrateWriteStream;
+//# sourceMappingURL=GoogleMigration.cjs.js.map

package/dist/stages/publish/migrations/GoogleMigration.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GoogleMigration.cjs.js","sources":["../../../../src/stages/publish/migrations/GoogleMigration.ts"],"sourcesContent":["/*\n * Copyright 2021 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 { assertError } from '@backstage/errors';\nimport { File } from '@google-cloud/storage';\nimport { Writable } from 'stream';\nimport { lowerCaseEntityTripletInStoragePath } from '../helpers';\nimport { LoggerService } from '@backstage/backend-plugin-api';\n\n/**\n * Writable stream to handle object copy/move operations. This implementation\n * ensures we don't read in files from GCS faster than GCS can copy/move them.\n */\nexport class MigrateWriteStream extends Writable {\n  protected logger: LoggerService;\n  protected removeOriginal: boolean;\n  protected maxConcurrency: number;\n  protected inFlight = 0;\n\n  constructor(\n    logger: LoggerService,\n    removeOriginal: boolean,\n    concurrency: number,\n  ) {\n    super({ objectMode: true });\n    this.logger = logger;\n    this.removeOriginal = removeOriginal;\n    this.maxConcurrency = concurrency;\n  }\n\n  _write(file: File, _encoding: BufferEncoding, next: Function) {\n    let shouldCallNext = true;\n    let newFile;\n    try {\n      newFile = lowerCaseEntityTripletInStoragePath(file.name);\n    } catch (e) {\n      assertError(e);\n      this.logger.warn(e.message);\n      next();\n      return;\n    }\n\n    // If all parts are already lowercase, ignore.\n    if (newFile === file.name) {\n      next();\n      return;\n    }\n\n    // Allow up to n-many files to be migrated at a time.\n    this.inFlight++;\n    if (this.inFlight < this.maxConcurrency) {\n      next();\n      shouldCallNext = false;\n    }\n\n    // Otherwise, copy or move the file.\n    const migrate = this.removeOriginal\n      ? file.move.bind(file)\n      : file.copy.bind(file);\n    this.logger.debug(`Migrating ${file.name}`);\n    migrate(newFile)\n      .catch(e =>\n        this.logger.warn(`Unable to migrate ${file.name}: ${e.message}`),\n      )\n      .finally(() => {\n        this.inFlight--;\n        if (shouldCallNext) {\n          next();\n        }\n      });\n  }\n}\n"],"names":["Writable","lowerCaseEntityTripletInStoragePath","assertError"],"mappings":";;;;;;AA0BO,MAAM,2BAA2BA,eAAS,CAAA;AAAA,EACrC,MAAA,CAAA;AAAA,EACA,cAAA,CAAA;AAAA,EACA,cAAA,CAAA;AAAA,EACA,QAAW,GAAA,CAAA,CAAA;AAAA,EAErB,WAAA,CACE,MACA,EAAA,cAAA,EACA,WACA,EAAA;AACA,IAAM,KAAA,CAAA,EAAE,UAAY,EAAA,IAAA,EAAM,CAAA,CAAA;AAC1B,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AACd,IAAA,IAAA,CAAK,cAAiB,GAAA,cAAA,CAAA;AACtB,IAAA,IAAA,CAAK,cAAiB,GAAA,WAAA,CAAA;AAAA,GACxB;AAAA,EAEA,MAAA,CAAO,IAAY,EAAA,SAAA,EAA2B,IAAgB,EAAA;AAC5D,IAAA,IAAI,cAAiB,GAAA,IAAA,CAAA;AACrB,IAAI,IAAA,OAAA,CAAA;AACJ,IAAI,IAAA;AACF,MAAU,OAAA,GAAAC,2CAAA,CAAoC,KAAK,IAAI,CAAA,CAAA;AAAA,aAChD,CAAG,EAAA;AACV,MAAAC,kBAAA,CAAY,CAAC,CAAA,CAAA;AACb,MAAK,IAAA,CAAA,MAAA,CAAO,IAAK,CAAA,CAAA,CAAE,OAAO,CAAA,CAAA;AAC1B,MAAK,IAAA,EAAA,CAAA;AACL,MAAA,OAAA;AAAA,KACF;AAGA,IAAI,IAAA,OAAA,KAAY,KAAK,IAAM,EAAA;AACzB,MAAK,IAAA,EAAA,CAAA;AACL,MAAA,OAAA;AAAA,KACF;AAGA,IAAK,IAAA,CAAA,QAAA,EAAA,CAAA;AACL,IAAI,IAAA,IAAA,CAAK,QAAW,GAAA,IAAA,CAAK,cAAgB,EAAA;AACvC,MAAK,IAAA,EAAA,CAAA;AACL,MAAiB,cAAA,GAAA,KAAA,CAAA;AAAA,KACnB;AAGA,IAAM,MAAA,OAAA,GAAU,IAAK,CAAA,cAAA,GACjB,IAAK,CAAA,IAAA,CAAK,IAAK,CAAA,IAAI,CACnB,GAAA,IAAA,CAAK,IAAK,CAAA,IAAA,CAAK,IAAI,CAAA,CAAA;AACvB,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAAa,UAAA,EAAA,IAAA,CAAK,IAAI,CAAE,CAAA,CAAA,CAAA;AAC1C,IAAA,OAAA,CAAQ,OAAO,CACZ,CAAA,KAAA;AAAA,MAAM,CAAA,CAAA,KACL,IAAK,CAAA,MAAA,CAAO,IAAK,CAAA,CAAA,kBAAA,EAAqB,KAAK,IAAI,CAAA,EAAA,EAAK,CAAE,CAAA,OAAO,CAAE,CAAA,CAAA;AAAA,KACjE,CACC,QAAQ,MAAM;AACb,MAAK,IAAA,CAAA,QAAA,EAAA,CAAA;AACL,MAAA,IAAI,cAAgB,EAAA;AAClB,QAAK,IAAA,EAAA,CAAA;AAAA,OACP;AAAA,KACD,CAAA,CAAA;AAAA,GACL;AACF;;;;"}