@backstage/backend-defaults 0.5.1-next.1 → 0.5.1-next.2

package/dist/entrypoints/urlReader/lib/ReadUrlResponseFactory.cjs.js

@@ -0,0 +1,49 @@
+'use strict';
+
+var errors = require('@backstage/errors');
+var getRawBody = require('raw-body');
+var stream = require('stream');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var getRawBody__default = /*#__PURE__*/_interopDefaultCompat(getRawBody);
+
+class ReadUrlResponseFactory {
+  /**
+   * Resolves a ReadUrlResponse from a Readable stream.
+   */
+  static async fromReadable(stream, options) {
+    let buffer;
+    const conflictError = new errors.ConflictError(
+      "Cannot use buffer() and stream() from the same ReadUrlResponse"
+    );
+    let hasCalledStream = false;
+    let hasCalledBuffer = false;
+    return {
+      buffer: () => {
+        hasCalledBuffer = true;
+        if (hasCalledStream) throw conflictError;
+        if (buffer) return buffer;
+        buffer = getRawBody__default.default(stream);
+        return buffer;
+      },
+      stream: () => {
+        hasCalledStream = true;
+        if (hasCalledBuffer) throw conflictError;
+        return stream;
+      },
+      etag: options?.etag,
+      lastModifiedAt: options?.lastModifiedAt
+    };
+  }
+  /**
+   * Resolves a ReadUrlResponse from an old-style NodeJS.ReadableStream.
+   */
+  static async fromNodeJSReadable(oldStyleStream, options) {
+    const readable = stream.Readable.from(oldStyleStream);
+    return ReadUrlResponseFactory.fromReadable(readable, options);
+  }
+}
+
+exports.ReadUrlResponseFactory = ReadUrlResponseFactory;
+//# sourceMappingURL=ReadUrlResponseFactory.cjs.js.map

package/dist/entrypoints/urlReader/lib/ReadUrlResponseFactory.cjs.js.map

@@ -0,0 +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 'stream';\nimport { ReadUrlResponseFactoryFromStreamOptions } from './types';\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 ReadUrlResponse 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 ReadUrlResponse 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"],"names":["ConflictError","getRawBody","Readable"],"mappings":";;;;;;;;;;AA4BO,MAAM,sBAAuB,CAAA;AAAA;AAAA;AAAA;AAAA,EAIlC,aAAa,YACX,CAAA,MAAA,EACA,OAC0C,EAAA;AAG1C,IAAI,IAAA,MAAA,CAAA;AAGJ,IAAA,MAAM,gBAAgB,IAAIA,oBAAA;AAAA,MACxB,gEAAA;AAAA,KACF,CAAA;AACA,IAAA,IAAI,eAAkB,GAAA,KAAA,CAAA;AACtB,IAAA,IAAI,eAAkB,GAAA,KAAA,CAAA;AAEtB,IAAO,OAAA;AAAA,MACL,QAAQ,MAAM;AACZ,QAAkB,eAAA,GAAA,IAAA,CAAA;AAClB,QAAA,IAAI,iBAAuB,MAAA,aAAA,CAAA;AAC3B,QAAA,IAAI,QAAe,OAAA,MAAA,CAAA;AACnB,QAAA,MAAA,GAASC,4BAAW,MAAM,CAAA,CAAA;AAC1B,QAAO,OAAA,MAAA,CAAA;AAAA,OACT;AAAA,MACA,QAAQ,MAAM;AACZ,QAAkB,eAAA,GAAA,IAAA,CAAA;AAClB,QAAA,IAAI,iBAAuB,MAAA,aAAA,CAAA;AAC3B,QAAO,OAAA,MAAA,CAAA;AAAA,OACT;AAAA,MACA,MAAM,OAAS,EAAA,IAAA;AAAA,MACf,gBAAgB,OAAS,EAAA,cAAA;AAAA,KAC3B,CAAA;AAAA,GACF;AAAA;AAAA;AAAA;AAAA,EAKA,aAAa,kBACX,CAAA,cAAA,EACA,OAC0C,EAAA;AAC1C,IAAM,MAAA,QAAA,GAAWC,eAAS,CAAA,IAAA,CAAK,cAAc,CAAA,CAAA;AAC7C,IAAO,OAAA,sBAAA,CAAuB,YAAa,CAAA,QAAA,EAAU,OAAO,CAAA,CAAA;AAAA,GAC9D;AACF;;;;"}

package/dist/entrypoints/urlReader/lib/UrlReaderPredicateMux.cjs.js

@@ -0,0 +1,46 @@
+'use strict';
+
+var errors = require('@backstage/errors');
+
+function notAllowedMessage(url) {
+  return `Reading from '${url}' is not allowed. You may need to configure an integration for the target host, or add it to the configured list of allowed hosts at 'backend.reading.allow'`;
+}
+class UrlReaderPredicateMux {
+  readers = [];
+  register(tuple) {
+    this.readers.push(tuple);
+  }
+  async readUrl(url, options) {
+    const parsed = new URL(url);
+    for (const { predicate, reader } of this.readers) {
+      if (predicate(parsed)) {
+        return reader.readUrl(url, options);
+      }
+    }
+    throw new errors.NotAllowedError(notAllowedMessage(url));
+  }
+  async readTree(url, options) {
+    const parsed = new URL(url);
+    for (const { predicate, reader } of this.readers) {
+      if (predicate(parsed)) {
+        return await reader.readTree(url, options);
+      }
+    }
+    throw new errors.NotAllowedError(notAllowedMessage(url));
+  }
+  async search(url, options) {
+    const parsed = new URL(url);
+    for (const { predicate, reader } of this.readers) {
+      if (predicate(parsed)) {
+        return await reader.search(url, options);
+      }
+    }
+    throw new errors.NotAllowedError(notAllowedMessage(url));
+  }
+  toString() {
+    return `predicateMux{readers=${this.readers.map((t) => t.reader).join(",")}`;
+  }
+}
+
+exports.UrlReaderPredicateMux = UrlReaderPredicateMux;
+//# sourceMappingURL=UrlReaderPredicateMux.cjs.js.map

package/dist/entrypoints/urlReader/lib/UrlReaderPredicateMux.cjs.js.map

@@ -0,0 +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,CAAA;AAIxB,CAAA;AAMO,MAAM,qBAAkD,CAAA;AAAA,EAC5C,UAAqC,EAAC,CAAA;AAAA,EAEvD,SAAS,KAAsC,EAAA;AAC7C,IAAK,IAAA,CAAA,OAAA,CAAQ,KAAK,KAAK,CAAA,CAAA;AAAA,GACzB;AAAA,EAEA,MAAM,OACJ,CAAA,GAAA,EACA,OAC0C,EAAA;AAC1C,IAAM,MAAA,MAAA,GAAS,IAAI,GAAA,CAAI,GAAG,CAAA,CAAA;AAE1B,IAAA,KAAA,MAAW,EAAE,SAAA,EAAW,MAAO,EAAA,IAAK,KAAK,OAAS,EAAA;AAChD,MAAI,IAAA,SAAA,CAAU,MAAM,CAAG,EAAA;AACrB,QAAO,OAAA,MAAA,CAAO,OAAQ,CAAA,GAAA,EAAK,OAAO,CAAA,CAAA;AAAA,OACpC;AAAA,KACF;AAEA,IAAA,MAAM,IAAIA,sBAAA,CAAgB,iBAAkB,CAAA,GAAG,CAAC,CAAA,CAAA;AAAA,GAClD;AAAA,EAEA,MAAM,QACJ,CAAA,GAAA,EACA,OAC2C,EAAA;AAC3C,IAAM,MAAA,MAAA,GAAS,IAAI,GAAA,CAAI,GAAG,CAAA,CAAA;AAE1B,IAAA,KAAA,MAAW,EAAE,SAAA,EAAW,MAAO,EAAA,IAAK,KAAK,OAAS,EAAA;AAChD,MAAI,IAAA,SAAA,CAAU,MAAM,CAAG,EAAA;AACrB,QAAA,OAAO,MAAM,MAAA,CAAO,QAAS,CAAA,GAAA,EAAK,OAAO,CAAA,CAAA;AAAA,OAC3C;AAAA,KACF;AAEA,IAAA,MAAM,IAAIA,sBAAA,CAAgB,iBAAkB,CAAA,GAAG,CAAC,CAAA,CAAA;AAAA,GAClD;AAAA,EAEA,MAAM,MACJ,CAAA,GAAA,EACA,OACyC,EAAA;AACzC,IAAM,MAAA,MAAA,GAAS,IAAI,GAAA,CAAI,GAAG,CAAA,CAAA;AAE1B,IAAA,KAAA,MAAW,EAAE,SAAA,EAAW,MAAO,EAAA,IAAK,KAAK,OAAS,EAAA;AAChD,MAAI,IAAA,SAAA,CAAU,MAAM,CAAG,EAAA;AACrB,QAAA,OAAO,MAAM,MAAA,CAAO,MAAO,CAAA,GAAA,EAAK,OAAO,CAAA,CAAA;AAAA,OACzC;AAAA,KACF;AAEA,IAAA,MAAM,IAAIA,sBAAA,CAAgB,iBAAkB,CAAA,GAAG,CAAC,CAAA,CAAA;AAAA,GAClD;AAAA,EAEA,QAAW,GAAA;AACT,IAAO,OAAA,CAAA,qBAAA,EAAwB,IAAK,CAAA,OAAA,CAAQ,GAAI,CAAA,CAAA,CAAA,KAAK,EAAE,MAAM,CAAA,CAAE,IAAK,CAAA,GAAG,CAAC,CAAA,CAAA,CAAA;AAAA,GAC1E;AACF;;;;"}

package/dist/entrypoints/urlReader/lib/UrlReaders.cjs.js

@@ -0,0 +1,68 @@
+'use strict';
+
+var UrlReaderPredicateMux = require('./UrlReaderPredicateMux.cjs.js');
+var AzureUrlReader = require('./AzureUrlReader.cjs.js');
+var BitbucketCloudUrlReader = require('./BitbucketCloudUrlReader.cjs.js');
+var BitbucketServerUrlReader = require('./BitbucketServerUrlReader.cjs.js');
+var BitbucketUrlReader = require('./BitbucketUrlReader.cjs.js');
+var GerritUrlReader = require('./GerritUrlReader.cjs.js');
+var GithubUrlReader = require('./GithubUrlReader.cjs.js');
+var GitlabUrlReader = require('./GitlabUrlReader.cjs.js');
+var ReadTreeResponseFactory = require('./tree/ReadTreeResponseFactory.cjs.js');
+var FetchUrlReader = require('./FetchUrlReader.cjs.js');
+var GoogleGcsUrlReader = require('./GoogleGcsUrlReader.cjs.js');
+var AwsS3UrlReader = require('./AwsS3UrlReader.cjs.js');
+var GiteaUrlReader = require('./GiteaUrlReader.cjs.js');
+var AwsCodeCommitUrlReader = require('./AwsCodeCommitUrlReader.cjs.js');
+var HarnessUrlReader = require('./HarnessUrlReader.cjs.js');
+
+class UrlReaders {
+  /**
+   * Creates a custom {@link @backstage/backend-plugin-api#UrlReaderService} wrapper for your own set of factories.
+   */
+  static create(options) {
+    const { logger, config, factories } = options;
+    const mux = new UrlReaderPredicateMux.UrlReaderPredicateMux();
+    const treeResponseFactory = ReadTreeResponseFactory.DefaultReadTreeResponseFactory.create({
+      config
+    });
+    for (const factory of factories ?? []) {
+      const tuples = factory({ config, logger, treeResponseFactory });
+      for (const tuple of tuples) {
+        mux.register(tuple);
+      }
+    }
+    return mux;
+  }
+  /**
+   * Creates a {@link @backstage/backend-plugin-api#UrlReaderService} wrapper that includes all the default factories
+   * from this package.
+   *
+   * Any additional factories passed will be loaded before the default ones.
+   */
+  static default(options) {
+    const { logger, config, factories = [] } = options;
+    return UrlReaders.create({
+      logger,
+      config,
+      factories: factories.concat([
+        AzureUrlReader.AzureUrlReader.factory,
+        BitbucketCloudUrlReader.BitbucketCloudUrlReader.factory,
+        BitbucketServerUrlReader.BitbucketServerUrlReader.factory,
+        BitbucketUrlReader.BitbucketUrlReader.factory,
+        GerritUrlReader.GerritUrlReader.factory,
+        GithubUrlReader.GithubUrlReader.factory,
+        GiteaUrlReader.GiteaUrlReader.factory,
+        GitlabUrlReader.GitlabUrlReader.factory,
+        GoogleGcsUrlReader.GoogleGcsUrlReader.factory,
+        HarnessUrlReader.HarnessUrlReader.factory,
+        AwsS3UrlReader.AwsS3UrlReader.factory,
+        AwsCodeCommitUrlReader.AwsCodeCommitUrlReader.factory,
+        FetchUrlReader.FetchUrlReader.factory
+      ])
+    });
+  }
+}
+
+exports.UrlReaders = UrlReaders;
+//# sourceMappingURL=UrlReaders.cjs.js.map

package/dist/entrypoints/urlReader/lib/UrlReaders.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UrlReaders.cjs.js","sources":["../../../../src/entrypoints/urlReader/lib/UrlReaders.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  LoggerService,\n  RootConfigService,\n  UrlReaderService,\n} from '@backstage/backend-plugin-api';\nimport { ReaderFactory } from './types';\nimport { UrlReaderPredicateMux } from './UrlReaderPredicateMux';\nimport { AzureUrlReader } from './AzureUrlReader';\nimport { BitbucketCloudUrlReader } from './BitbucketCloudUrlReader';\nimport { BitbucketServerUrlReader } from './BitbucketServerUrlReader';\nimport { BitbucketUrlReader } from './BitbucketUrlReader';\nimport { GerritUrlReader } from './GerritUrlReader';\nimport { GithubUrlReader } from './GithubUrlReader';\nimport { GitlabUrlReader } from './GitlabUrlReader';\nimport { DefaultReadTreeResponseFactory } from './tree';\nimport { FetchUrlReader } from './FetchUrlReader';\nimport { GoogleGcsUrlReader } from './GoogleGcsUrlReader';\nimport { AwsS3UrlReader } from './AwsS3UrlReader';\nimport { GiteaUrlReader } from './GiteaUrlReader';\nimport { AwsCodeCommitUrlReader } from './AwsCodeCommitUrlReader';\nimport { HarnessUrlReader } from './HarnessUrlReader';\n\n/**\n * Creation options for {@link @backstage/backend-plugin-api#UrlReaderService}.\n *\n * @public\n */\nexport type UrlReadersOptions = {\n  /** Root config object */\n  config: RootConfigService;\n  /** Logger used by all the readers */\n  logger: LoggerService;\n  /** A list of factories used to construct individual readers that match on URLs */\n  factories?: ReaderFactory[];\n};\n\n/**\n * Helps construct {@link @backstage/backend-plugin-api#UrlReaderService}s.\n *\n * @public\n */\nexport class UrlReaders {\n  /**\n   * Creates a custom {@link @backstage/backend-plugin-api#UrlReaderService} wrapper for your own set of factories.\n   */\n  static create(options: UrlReadersOptions): UrlReaderService {\n    const { logger, config, factories } = options;\n    const mux = new UrlReaderPredicateMux();\n    const treeResponseFactory = DefaultReadTreeResponseFactory.create({\n      config,\n    });\n    for (const factory of factories ?? []) {\n      const tuples = factory({ config, logger: logger, treeResponseFactory });\n\n      for (const tuple of tuples) {\n        mux.register(tuple);\n      }\n    }\n\n    return mux;\n  }\n\n  /**\n   * Creates a {@link @backstage/backend-plugin-api#UrlReaderService} wrapper that includes all the default factories\n   * from this package.\n   *\n   * Any additional factories passed will be loaded before the default ones.\n   */\n  static default(options: UrlReadersOptions) {\n    const { logger, config, factories = [] } = options;\n    return UrlReaders.create({\n      logger,\n      config,\n      factories: factories.concat([\n        AzureUrlReader.factory,\n        BitbucketCloudUrlReader.factory,\n        BitbucketServerUrlReader.factory,\n        BitbucketUrlReader.factory,\n        GerritUrlReader.factory,\n        GithubUrlReader.factory,\n        GiteaUrlReader.factory,\n        GitlabUrlReader.factory,\n        GoogleGcsUrlReader.factory,\n        HarnessUrlReader.factory,\n        AwsS3UrlReader.factory,\n        AwsCodeCommitUrlReader.factory,\n        FetchUrlReader.factory,\n      ]),\n    });\n  }\n}\n"],"names":["UrlReaderPredicateMux","DefaultReadTreeResponseFactory","AzureUrlReader","BitbucketCloudUrlReader","BitbucketServerUrlReader","BitbucketUrlReader","GerritUrlReader","GithubUrlReader","GiteaUrlReader","GitlabUrlReader","GoogleGcsUrlReader","HarnessUrlReader","AwsS3UrlReader","AwsCodeCommitUrlReader","FetchUrlReader"],"mappings":";;;;;;;;;;;;;;;;;;AAyDO,MAAM,UAAW,CAAA;AAAA;AAAA;AAAA;AAAA,EAItB,OAAO,OAAO,OAA8C,EAAA;AAC1D,IAAA,MAAM,EAAE,MAAA,EAAQ,MAAQ,EAAA,SAAA,EAAc,GAAA,OAAA,CAAA;AACtC,IAAM,MAAA,GAAA,GAAM,IAAIA,2CAAsB,EAAA,CAAA;AACtC,IAAM,MAAA,mBAAA,GAAsBC,uDAA+B,MAAO,CAAA;AAAA,MAChE,MAAA;AAAA,KACD,CAAA,CAAA;AACD,IAAW,KAAA,MAAA,OAAA,IAAW,SAAa,IAAA,EAAI,EAAA;AACrC,MAAA,MAAM,SAAS,OAAQ,CAAA,EAAE,MAAQ,EAAA,MAAA,EAAgB,qBAAqB,CAAA,CAAA;AAEtE,MAAA,KAAA,MAAW,SAAS,MAAQ,EAAA;AAC1B,QAAA,GAAA,CAAI,SAAS,KAAK,CAAA,CAAA;AAAA,OACpB;AAAA,KACF;AAEA,IAAO,OAAA,GAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OAAO,QAAQ,OAA4B,EAAA;AACzC,IAAA,MAAM,EAAE,MAAQ,EAAA,MAAA,EAAQ,SAAY,GAAA,IAAO,GAAA,OAAA,CAAA;AAC3C,IAAA,OAAO,WAAW,MAAO,CAAA;AAAA,MACvB,MAAA;AAAA,MACA,MAAA;AAAA,MACA,SAAA,EAAW,UAAU,MAAO,CAAA;AAAA,QAC1BC,6BAAe,CAAA,OAAA;AAAA,QACfC,+CAAwB,CAAA,OAAA;AAAA,QACxBC,iDAAyB,CAAA,OAAA;AAAA,QACzBC,qCAAmB,CAAA,OAAA;AAAA,QACnBC,+BAAgB,CAAA,OAAA;AAAA,QAChBC,+BAAgB,CAAA,OAAA;AAAA,QAChBC,6BAAe,CAAA,OAAA;AAAA,QACfC,+BAAgB,CAAA,OAAA;AAAA,QAChBC,qCAAmB,CAAA,OAAA;AAAA,QACnBC,iCAAiB,CAAA,OAAA;AAAA,QACjBC,6BAAe,CAAA,OAAA;AAAA,QACfC,6CAAuB,CAAA,OAAA;AAAA,QACvBC,6BAAe,CAAA,OAAA;AAAA,OAChB,CAAA;AAAA,KACF,CAAA,CAAA;AAAA,GACH;AACF;;;;"}

package/dist/entrypoints/urlReader/lib/tree/ReadTreeResponseFactory.cjs.js

@@ -0,0 +1,46 @@
+'use strict';
+
+var os = require('os');
+var TarArchiveResponse = require('./TarArchiveResponse.cjs.js');
+var ZipArchiveResponse = require('./ZipArchiveResponse.cjs.js');
+var ReadableArrayResponse = require('./ReadableArrayResponse.cjs.js');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var os__default = /*#__PURE__*/_interopDefaultCompat(os);
+
+class DefaultReadTreeResponseFactory {
+  constructor(workDir) {
+    this.workDir = workDir;
+  }
+  static create(options) {
+    return new DefaultReadTreeResponseFactory(
+      options.config.getOptionalString("backend.workingDirectory") ?? os__default.default.tmpdir()
+    );
+  }
+  async fromTarArchive(options) {
+    return new TarArchiveResponse.TarArchiveResponse(
+      options.stream,
+      options.subpath ?? "",
+      this.workDir,
+      options.etag,
+      options.filter,
+      options.stripFirstDirectory ?? true
+    );
+  }
+  async fromZipArchive(options) {
+    return new ZipArchiveResponse.ZipArchiveResponse(
+      options.stream,
+      options.subpath ?? "",
+      this.workDir,
+      options.etag,
+      options.filter
+    );
+  }
+  async fromReadableArray(options) {
+    return new ReadableArrayResponse.ReadableArrayResponse(options, this.workDir, "");
+  }
+}
+
+exports.DefaultReadTreeResponseFactory = DefaultReadTreeResponseFactory;
+//# sourceMappingURL=ReadTreeResponseFactory.cjs.js.map

package/dist/entrypoints/urlReader/lib/tree/ReadTreeResponseFactory.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReadTreeResponseFactory.cjs.js","sources":["../../../../../src/entrypoints/urlReader/lib/tree/ReadTreeResponseFactory.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 os from 'os';\nimport { Config } from '@backstage/config';\nimport {\n  ReadTreeResponseFactoryOptions,\n  ReadTreeResponseFactory,\n  FromReadableArrayOptions,\n} from '../types';\nimport { TarArchiveResponse } from './TarArchiveResponse';\nimport { ZipArchiveResponse } from './ZipArchiveResponse';\nimport { ReadableArrayResponse } from './ReadableArrayResponse';\nimport { UrlReaderServiceReadTreeResponse } from '@backstage/backend-plugin-api';\n\nexport class DefaultReadTreeResponseFactory implements ReadTreeResponseFactory {\n  static create(options: { config: Config }): DefaultReadTreeResponseFactory {\n    return new DefaultReadTreeResponseFactory(\n      options.config.getOptionalString('backend.workingDirectory') ??\n        os.tmpdir(),\n    );\n  }\n\n  constructor(private readonly workDir: string) {}\n\n  async fromTarArchive(\n    options: ReadTreeResponseFactoryOptions & {\n      stripFirstDirectory?: boolean;\n    },\n  ): Promise<UrlReaderServiceReadTreeResponse> {\n    return new TarArchiveResponse(\n      options.stream,\n      options.subpath ?? '',\n      this.workDir,\n      options.etag,\n      options.filter,\n      options.stripFirstDirectory ?? true,\n    );\n  }\n\n  async fromZipArchive(\n    options: ReadTreeResponseFactoryOptions,\n  ): Promise<UrlReaderServiceReadTreeResponse> {\n    return new ZipArchiveResponse(\n      options.stream,\n      options.subpath ?? '',\n      this.workDir,\n      options.etag,\n      options.filter,\n    );\n  }\n\n  async fromReadableArray(\n    options: FromReadableArrayOptions,\n  ): Promise<UrlReaderServiceReadTreeResponse> {\n    return new ReadableArrayResponse(options, this.workDir, '');\n  }\n}\n"],"names":["os","TarArchiveResponse","ZipArchiveResponse","ReadableArrayResponse"],"mappings":";;;;;;;;;;;AA4BO,MAAM,8BAAkE,CAAA;AAAA,EAQ7E,YAA6B,OAAiB,EAAA;AAAjB,IAAA,IAAA,CAAA,OAAA,GAAA,OAAA,CAAA;AAAA,GAAkB;AAAA,EAP/C,OAAO,OAAO,OAA6D,EAAA;AACzE,IAAA,OAAO,IAAI,8BAAA;AAAA,MACT,QAAQ,MAAO,CAAA,iBAAA,CAAkB,0BAA0B,CAAA,IACzDA,oBAAG,MAAO,EAAA;AAAA,KACd,CAAA;AAAA,GACF;AAAA,EAIA,MAAM,eACJ,OAG2C,EAAA;AAC3C,IAAA,OAAO,IAAIC,qCAAA;AAAA,MACT,OAAQ,CAAA,MAAA;AAAA,MACR,QAAQ,OAAW,IAAA,EAAA;AAAA,MACnB,IAAK,CAAA,OAAA;AAAA,MACL,OAAQ,CAAA,IAAA;AAAA,MACR,OAAQ,CAAA,MAAA;AAAA,MACR,QAAQ,mBAAuB,IAAA,IAAA;AAAA,KACjC,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,eACJ,OAC2C,EAAA;AAC3C,IAAA,OAAO,IAAIC,qCAAA;AAAA,MACT,OAAQ,CAAA,MAAA;AAAA,MACR,QAAQ,OAAW,IAAA,EAAA;AAAA,MACnB,IAAK,CAAA,OAAA;AAAA,MACL,OAAQ,CAAA,IAAA;AAAA,MACR,OAAQ,CAAA,MAAA;AAAA,KACV,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,kBACJ,OAC2C,EAAA;AAC3C,IAAA,OAAO,IAAIC,2CAAA,CAAsB,OAAS,EAAA,IAAA,CAAK,SAAS,EAAE,CAAA,CAAA;AAAA,GAC5D;AACF;;;;"}

package/dist/entrypoints/urlReader/lib/tree/ReadableArrayResponse.cjs.js

@@ -0,0 +1,78 @@
+'use strict';
+
+var concatStream = require('concat-stream');
+var platformPath = require('path');
+var getRawBody = require('raw-body');
+var fs = require('fs-extra');
+var util = require('util');
+var tar = require('tar');
+var stream = require('stream');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var concatStream__default = /*#__PURE__*/_interopDefaultCompat(concatStream);
+var platformPath__default = /*#__PURE__*/_interopDefaultCompat(platformPath);
+var getRawBody__default = /*#__PURE__*/_interopDefaultCompat(getRawBody);
+var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+var tar__default = /*#__PURE__*/_interopDefaultCompat(tar);
+
+const pipeline = util.promisify(stream.pipeline);
+class ReadableArrayResponse {
+  constructor(stream, workDir, etag) {
+    this.stream = stream;
+    this.workDir = workDir;
+    this.etag = etag;
+    this.etag = etag;
+  }
+  read = false;
+  // Make sure the input stream is only read once
+  onlyOnce() {
+    if (this.read) {
+      throw new Error("Response has already been read");
+    }
+    this.read = true;
+  }
+  async files() {
+    this.onlyOnce();
+    const files = Array();
+    for (let i = 0; i < this.stream.length; i++) {
+      if (!this.stream[i].path.endsWith("/")) {
+        files.push({
+          path: this.stream[i].path,
+          content: () => getRawBody__default.default(this.stream[i].data),
+          lastModifiedAt: this.stream[i]?.lastModifiedAt
+        });
+      }
+    }
+    return files;
+  }
+  async archive() {
+    const tmpDir = await this.dir();
+    try {
+      const data = await new Promise(async (resolve) => {
+        await pipeline(
+          tar__default.default.create({ cwd: tmpDir }, [""]),
+          concatStream__default.default(resolve)
+        );
+      });
+      return stream.Readable.from(data);
+    } finally {
+      await fs__default.default.remove(tmpDir);
+    }
+  }
+  async dir(options) {
+    this.onlyOnce();
+    const dir = options?.targetDir ?? await fs__default.default.mkdtemp(platformPath__default.default.join(this.workDir, "backstage-"));
+    for (let i = 0; i < this.stream.length; i++) {
+      if (!this.stream[i].path.endsWith("/")) {
+        const filePath = platformPath__default.default.join(dir, this.stream[i].path);
+        await fs__default.default.mkdir(platformPath.dirname(filePath), { recursive: true });
+        await pipeline(this.stream[i].data, fs__default.default.createWriteStream(filePath));
+      }
+    }
+    return dir;
+  }
+}
+
+exports.ReadableArrayResponse = ReadableArrayResponse;
+//# sourceMappingURL=ReadableArrayResponse.cjs.js.map

package/dist/entrypoints/urlReader/lib/tree/ReadableArrayResponse.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReadableArrayResponse.cjs.js","sources":["../../../../../src/entrypoints/urlReader/lib/tree/ReadableArrayResponse.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  UrlReaderServiceReadTreeResponse,\n  UrlReaderServiceReadTreeResponseDirOptions,\n  UrlReaderServiceReadTreeResponseFile,\n} from '@backstage/backend-plugin-api';\nimport concatStream from 'concat-stream';\nimport platformPath, { dirname } from 'path';\nimport getRawBody from 'raw-body';\nimport fs from 'fs-extra';\nimport { promisify } from 'util';\nimport tar from 'tar';\nimport { pipeline as pipelineCb, Readable } from 'stream';\nimport { FromReadableArrayOptions } from '../types';\n\nconst pipeline = promisify(pipelineCb);\n\n/**\n * Wraps a array of Readable objects into a tree response reader.\n */\nexport class ReadableArrayResponse implements UrlReaderServiceReadTreeResponse {\n  private read = false;\n\n  constructor(\n    private readonly stream: FromReadableArrayOptions,\n    private readonly workDir: string,\n    public readonly etag: string,\n  ) {\n    this.etag = etag;\n  }\n\n  // Make sure the input stream is only read once\n  private onlyOnce() {\n    if (this.read) {\n      throw new Error('Response has already been read');\n    }\n    this.read = true;\n  }\n\n  async files(): Promise<UrlReaderServiceReadTreeResponseFile[]> {\n    this.onlyOnce();\n\n    const files = Array<UrlReaderServiceReadTreeResponseFile>();\n\n    for (let i = 0; i < this.stream.length; i++) {\n      if (!this.stream[i].path.endsWith('/')) {\n        files.push({\n          path: this.stream[i].path,\n          content: () => getRawBody(this.stream[i].data),\n          lastModifiedAt: this.stream[i]?.lastModifiedAt,\n        });\n      }\n    }\n\n    return files;\n  }\n\n  async archive(): Promise<NodeJS.ReadableStream> {\n    const tmpDir = await this.dir();\n\n    try {\n      const data = await new Promise<Buffer>(async resolve => {\n        await pipeline(\n          tar.create({ cwd: tmpDir }, ['']),\n          concatStream(resolve),\n        );\n      });\n      return Readable.from(data);\n    } finally {\n      await fs.remove(tmpDir);\n    }\n  }\n\n  async dir(\n    options?: UrlReaderServiceReadTreeResponseDirOptions,\n  ): Promise<string> {\n    this.onlyOnce();\n\n    const dir =\n      options?.targetDir ??\n      (await fs.mkdtemp(platformPath.join(this.workDir, 'backstage-')));\n\n    for (let i = 0; i < this.stream.length; i++) {\n      if (!this.stream[i].path.endsWith('/')) {\n        const filePath = platformPath.join(dir, this.stream[i].path);\n        await fs.mkdir(dirname(filePath), { recursive: true });\n        await pipeline(this.stream[i].data, fs.createWriteStream(filePath));\n      }\n    }\n\n    return dir;\n  }\n}\n"],"names":["promisify","pipelineCb","getRawBody","tar","concatStream","Readable","fs","platformPath","dirname"],"mappings":";;;;;;;;;;;;;;;;;;AA8BA,MAAM,QAAA,GAAWA,eAAUC,eAAU,CAAA,CAAA;AAK9B,MAAM,qBAAkE,CAAA;AAAA,EAG7E,WAAA,CACmB,MACA,EAAA,OAAA,EACD,IAChB,EAAA;AAHiB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,OAAA,GAAA,OAAA,CAAA;AACD,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA,CAAA;AAEhB,IAAA,IAAA,CAAK,IAAO,GAAA,IAAA,CAAA;AAAA,GACd;AAAA,EARQ,IAAO,GAAA,KAAA,CAAA;AAAA;AAAA,EAWP,QAAW,GAAA;AACjB,IAAA,IAAI,KAAK,IAAM,EAAA;AACb,MAAM,MAAA,IAAI,MAAM,gCAAgC,CAAA,CAAA;AAAA,KAClD;AACA,IAAA,IAAA,CAAK,IAAO,GAAA,IAAA,CAAA;AAAA,GACd;AAAA,EAEA,MAAM,KAAyD,GAAA;AAC7D,IAAA,IAAA,CAAK,QAAS,EAAA,CAAA;AAEd,IAAA,MAAM,QAAQ,KAA4C,EAAA,CAAA;AAE1D,IAAA,KAAA,IAAS,IAAI,CAAG,EAAA,CAAA,GAAI,IAAK,CAAA,MAAA,CAAO,QAAQ,CAAK,EAAA,EAAA;AAC3C,MAAI,IAAA,CAAC,KAAK,MAAO,CAAA,CAAC,EAAE,IAAK,CAAA,QAAA,CAAS,GAAG,CAAG,EAAA;AACtC,QAAA,KAAA,CAAM,IAAK,CAAA;AAAA,UACT,IAAM,EAAA,IAAA,CAAK,MAAO,CAAA,CAAC,CAAE,CAAA,IAAA;AAAA,UACrB,SAAS,MAAMC,2BAAA,CAAW,KAAK,MAAO,CAAA,CAAC,EAAE,IAAI,CAAA;AAAA,UAC7C,cAAgB,EAAA,IAAA,CAAK,MAAO,CAAA,CAAC,CAAG,EAAA,cAAA;AAAA,SACjC,CAAA,CAAA;AAAA,OACH;AAAA,KACF;AAEA,IAAO,OAAA,KAAA,CAAA;AAAA,GACT;AAAA,EAEA,MAAM,OAA0C,GAAA;AAC9C,IAAM,MAAA,MAAA,GAAS,MAAM,IAAA,CAAK,GAAI,EAAA,CAAA;AAE9B,IAAI,IAAA;AACF,MAAA,MAAM,IAAO,GAAA,MAAM,IAAI,OAAA,CAAgB,OAAM,OAAW,KAAA;AACtD,QAAM,MAAA,QAAA;AAAA,UACJC,oBAAA,CAAI,OAAO,EAAE,GAAA,EAAK,QAAU,EAAA,CAAC,EAAE,CAAC,CAAA;AAAA,UAChCC,8BAAa,OAAO,CAAA;AAAA,SACtB,CAAA;AAAA,OACD,CAAA,CAAA;AACD,MAAO,OAAAC,eAAA,CAAS,KAAK,IAAI,CAAA,CAAA;AAAA,KACzB,SAAA;AACA,MAAM,MAAAC,mBAAA,CAAG,OAAO,MAAM,CAAA,CAAA;AAAA,KACxB;AAAA,GACF;AAAA,EAEA,MAAM,IACJ,OACiB,EAAA;AACjB,IAAA,IAAA,CAAK,QAAS,EAAA,CAAA;AAEd,IAAM,MAAA,GAAA,GACJ,OAAS,EAAA,SAAA,IACR,MAAMA,mBAAA,CAAG,OAAQ,CAAAC,6BAAA,CAAa,IAAK,CAAA,IAAA,CAAK,OAAS,EAAA,YAAY,CAAC,CAAA,CAAA;AAEjE,IAAA,KAAA,IAAS,IAAI,CAAG,EAAA,CAAA,GAAI,IAAK,CAAA,MAAA,CAAO,QAAQ,CAAK,EAAA,EAAA;AAC3C,MAAI,IAAA,CAAC,KAAK,MAAO,CAAA,CAAC,EAAE,IAAK,CAAA,QAAA,CAAS,GAAG,CAAG,EAAA;AACtC,QAAM,MAAA,QAAA,GAAWA,8BAAa,IAAK,CAAA,GAAA,EAAK,KAAK,MAAO,CAAA,CAAC,EAAE,IAAI,CAAA,CAAA;AAC3D,QAAM,MAAAD,mBAAA,CAAG,MAAME,oBAAQ,CAAA,QAAQ,GAAG,EAAE,SAAA,EAAW,MAAM,CAAA,CAAA;AACrD,QAAM,MAAA,QAAA,CAAS,KAAK,MAAO,CAAA,CAAC,EAAE,IAAM,EAAAF,mBAAA,CAAG,iBAAkB,CAAA,QAAQ,CAAC,CAAA,CAAA;AAAA,OACpE;AAAA,KACF;AAEA,IAAO,OAAA,GAAA,CAAA;AAAA,GACT;AACF;;;;"}

package/dist/entrypoints/urlReader/lib/tree/TarArchiveResponse.cjs.js

@@ -0,0 +1,147 @@
+'use strict';
+
+var concatStream = require('concat-stream');
+var fs = require('fs-extra');
+var platformPath = require('path');
+var stream = require('stream');
+var tar = require('tar');
+var util = require('util');
+var util$1 = require('./util.cjs.js');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var concatStream__default = /*#__PURE__*/_interopDefaultCompat(concatStream);
+var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+var platformPath__default = /*#__PURE__*/_interopDefaultCompat(platformPath);
+var tar__default = /*#__PURE__*/_interopDefaultCompat(tar);
+
+const TarParseStream = tar.Parse;
+const pipeline = util.promisify(stream.pipeline);
+class TarArchiveResponse {
+  constructor(stream, subPath, workDir, etag, filter, stripFirstDirectory = true) {
+    this.stream = stream;
+    this.subPath = subPath;
+    this.workDir = workDir;
+    this.etag = etag;
+    this.filter = filter;
+    this.stripFirstDirectory = stripFirstDirectory;
+    if (subPath) {
+      if (!subPath.endsWith("/")) {
+        this.subPath += "/";
+      }
+      if (subPath.startsWith("/")) {
+        throw new TypeError(
+          `TarArchiveResponse subPath must not start with a /, got '${subPath}'`
+        );
+      }
+    }
+    this.etag = etag;
+  }
+  read = false;
+  // Make sure the input stream is only read once
+  onlyOnce() {
+    if (this.read) {
+      throw new Error("Response has already been read");
+    }
+    this.read = true;
+  }
+  async files() {
+    this.onlyOnce();
+    const files = Array();
+    const parser = new TarParseStream();
+    parser.on("entry", (entry) => {
+      if (entry.type === "Directory") {
+        entry.resume();
+        return;
+      }
+      const relativePath = this.stripFirstDirectory ? util$1.stripFirstDirectoryFromPath(entry.path) : entry.path;
+      if (this.subPath) {
+        if (!relativePath.startsWith(this.subPath)) {
+          entry.resume();
+          return;
+        }
+      }
+      const path = relativePath.slice(this.subPath.length);
+      if (this.filter) {
+        if (!this.filter(path, { size: entry.remain })) {
+          entry.resume();
+          return;
+        }
+      }
+      const content = new Promise(async (resolve) => {
+        await pipeline(entry, concatStream__default.default(resolve));
+      });
+      files.push({
+        path,
+        content: () => content
+      });
+      entry.resume();
+    });
+    await pipeline(this.stream, parser);
+    return files;
+  }
+  async archive() {
+    if (!this.subPath) {
+      this.onlyOnce();
+      return this.stream;
+    }
+    const tmpDir = await this.dir();
+    try {
+      const data = await new Promise(async (resolve) => {
+        await pipeline(
+          tar__default.default.create({ cwd: tmpDir }, [""]),
+          concatStream__default.default(resolve)
+        );
+      });
+      return stream.Readable.from(data);
+    } finally {
+      await fs__default.default.remove(tmpDir);
+    }
+  }
+  async dir(options) {
+    this.onlyOnce();
+    const dir = options?.targetDir ?? await fs__default.default.mkdtemp(platformPath__default.default.join(this.workDir, "backstage-"));
+    let strip = this.subPath ? this.subPath.split("/").length : 1;
+    if (!this.stripFirstDirectory) {
+      strip--;
+    }
+    let filterError = void 0;
+    await pipeline(
+      this.stream,
+      tar__default.default.extract({
+        strip,
+        cwd: dir,
+        filter: (path, stat) => {
+          if (filterError) {
+            return false;
+          }
+          const relativePath = this.stripFirstDirectory ? util$1.stripFirstDirectoryFromPath(path) : path;
+          if (this.subPath && !relativePath.startsWith(this.subPath)) {
+            return false;
+          }
+          if (this.filter) {
+            const innerPath = path.split("/").slice(strip).join("/");
+            try {
+              return this.filter(innerPath, { size: stat.size });
+            } catch (error) {
+              filterError = error;
+              return false;
+            }
+          }
+          return true;
+        }
+      })
+    );
+    if (filterError) {
+      if (!options?.targetDir) {
+        await fs__default.default.remove(dir).catch(() => {
+        });
+      }
+      throw filterError;
+    }
+    return dir;
+  }
+}
+
+exports.TarArchiveResponse = TarArchiveResponse;
+//# sourceMappingURL=TarArchiveResponse.cjs.js.map

package/dist/entrypoints/urlReader/lib/tree/TarArchiveResponse.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TarArchiveResponse.cjs.js","sources":["../../../../../src/entrypoints/urlReader/lib/tree/TarArchiveResponse.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  UrlReaderServiceReadTreeResponse,\n  UrlReaderServiceReadTreeResponseDirOptions,\n  UrlReaderServiceReadTreeResponseFile,\n} from '@backstage/backend-plugin-api';\nimport concatStream from 'concat-stream';\nimport fs from 'fs-extra';\nimport platformPath from 'path';\nimport { pipeline as pipelineCb, Readable } from 'stream';\nimport tar, { Parse, ParseStream, ReadEntry } from 'tar';\nimport { promisify } from 'util';\nimport { stripFirstDirectoryFromPath } from './util';\n\n// Tar types for `Parse` is not a proper constructor, but it should be\nconst TarParseStream = Parse as unknown as { new (): ParseStream };\n\nconst pipeline = promisify(pipelineCb);\n\n/**\n * Wraps a tar archive stream into a tree response reader.\n */\nexport class TarArchiveResponse implements UrlReaderServiceReadTreeResponse {\n  private read = false;\n\n  constructor(\n    private readonly stream: Readable,\n    private readonly subPath: string,\n    private readonly workDir: string,\n    public readonly etag: string,\n    private readonly filter?: (path: string, info: { size: number }) => boolean,\n    private readonly stripFirstDirectory: boolean = true,\n  ) {\n    if (subPath) {\n      if (!subPath.endsWith('/')) {\n        this.subPath += '/';\n      }\n      if (subPath.startsWith('/')) {\n        throw new TypeError(\n          `TarArchiveResponse subPath must not start with a /, got '${subPath}'`,\n        );\n      }\n    }\n\n    this.etag = etag;\n  }\n\n  // Make sure the input stream is only read once\n  private onlyOnce() {\n    if (this.read) {\n      throw new Error('Response has already been read');\n    }\n    this.read = true;\n  }\n\n  async files(): Promise<UrlReaderServiceReadTreeResponseFile[]> {\n    this.onlyOnce();\n\n    const files = Array<UrlReaderServiceReadTreeResponseFile>();\n    const parser = new TarParseStream();\n\n    parser.on('entry', (entry: ReadEntry & Readable) => {\n      if (entry.type === 'Directory') {\n        entry.resume();\n        return;\n      }\n\n      // File path relative to the root extracted directory. Will remove the\n      // top level dir name from the path since its name is hard to predetermine.\n      const relativePath = this.stripFirstDirectory\n        ? stripFirstDirectoryFromPath(entry.path)\n        : entry.path;\n\n      if (this.subPath) {\n        if (!relativePath.startsWith(this.subPath)) {\n          entry.resume();\n          return;\n        }\n      }\n\n      const path = relativePath.slice(this.subPath.length);\n      if (this.filter) {\n        if (!this.filter(path, { size: entry.remain })) {\n          entry.resume();\n          return;\n        }\n      }\n\n      const content = new Promise<Buffer>(async resolve => {\n        await pipeline(entry, concatStream(resolve));\n      });\n\n      files.push({\n        path,\n        content: () => content,\n      });\n\n      entry.resume();\n    });\n\n    await pipeline(this.stream, parser);\n\n    return files;\n  }\n\n  async archive(): Promise<Readable> {\n    if (!this.subPath) {\n      this.onlyOnce();\n\n      return this.stream;\n    }\n\n    // TODO(Rugvip): method for repacking a tar with a subpath is to simply extract into a\n    //               tmp dir and recreate the archive. Would be nicer to stream things instead.\n    const tmpDir = await this.dir();\n\n    try {\n      const data = await new Promise<Buffer>(async resolve => {\n        await pipeline(\n          tar.create({ cwd: tmpDir }, ['']),\n          concatStream(resolve),\n        );\n      });\n      return Readable.from(data);\n    } finally {\n      await fs.remove(tmpDir);\n    }\n  }\n\n  async dir(\n    options?: UrlReaderServiceReadTreeResponseDirOptions,\n  ): Promise<string> {\n    this.onlyOnce();\n\n    const dir =\n      options?.targetDir ??\n      (await fs.mkdtemp(platformPath.join(this.workDir, 'backstage-')));\n\n    // Equivalent of tar --strip-components=N\n    // When no subPath is given, remove just 1 top level directory\n    let strip = this.subPath ? this.subPath.split('/').length : 1;\n    if (!this.stripFirstDirectory) {\n      strip--;\n    }\n\n    let filterError: Error | undefined = undefined;\n    await pipeline(\n      this.stream,\n      tar.extract({\n        strip,\n        cwd: dir,\n        filter: (path, stat) => {\n          // Filter errors will short-circuit the rest of the filtering and then throw\n          if (filterError) {\n            return false;\n          }\n\n          // File path relative to the root extracted directory. Will remove the\n          // top level dir name from the path since its name is hard to predetermine.\n          const relativePath = this.stripFirstDirectory\n            ? stripFirstDirectoryFromPath(path)\n            : path;\n          if (this.subPath && !relativePath.startsWith(this.subPath)) {\n            return false;\n          }\n          if (this.filter) {\n            const innerPath = path.split('/').slice(strip).join('/');\n            try {\n              return this.filter(innerPath, { size: stat.size });\n            } catch (error) {\n              filterError = error;\n              return false;\n            }\n          }\n          return true;\n        },\n      }),\n    );\n\n    if (filterError) {\n      // If the dir was provided we don't want to remove it, but if it wasn't it means\n      // we created a temporary directory and we should remove it.\n      if (!options?.targetDir) {\n        await fs.remove(dir).catch(() => {});\n      }\n      throw filterError;\n    }\n\n    return dir;\n  }\n}\n"],"names":["Parse","promisify","pipelineCb","stripFirstDirectoryFromPath","concatStream","tar","Readable","fs","platformPath"],"mappings":";;;;;;;;;;;;;;;;;AA8BA,MAAM,cAAiB,GAAAA,SAAA,CAAA;AAEvB,MAAM,QAAA,GAAWC,eAAUC,eAAU,CAAA,CAAA;AAK9B,MAAM,kBAA+D,CAAA;AAAA,EAG1E,YACmB,MACA,EAAA,OAAA,EACA,SACD,IACC,EAAA,MAAA,EACA,sBAA+B,IAChD,EAAA;AANiB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,OAAA,GAAA,OAAA,CAAA;AACA,IAAA,IAAA,CAAA,OAAA,GAAA,OAAA,CAAA;AACD,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA,CAAA;AACC,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,mBAAA,GAAA,mBAAA,CAAA;AAEjB,IAAA,IAAI,OAAS,EAAA;AACX,MAAA,IAAI,CAAC,OAAA,CAAQ,QAAS,CAAA,GAAG,CAAG,EAAA;AAC1B,QAAA,IAAA,CAAK,OAAW,IAAA,GAAA,CAAA;AAAA,OAClB;AACA,MAAI,IAAA,OAAA,CAAQ,UAAW,CAAA,GAAG,CAAG,EAAA;AAC3B,QAAA,MAAM,IAAI,SAAA;AAAA,UACR,4DAA4D,OAAO,CAAA,CAAA,CAAA;AAAA,SACrE,CAAA;AAAA,OACF;AAAA,KACF;AAEA,IAAA,IAAA,CAAK,IAAO,GAAA,IAAA,CAAA;AAAA,GACd;AAAA,EAtBQ,IAAO,GAAA,KAAA,CAAA;AAAA;AAAA,EAyBP,QAAW,GAAA;AACjB,IAAA,IAAI,KAAK,IAAM,EAAA;AACb,MAAM,MAAA,IAAI,MAAM,gCAAgC,CAAA,CAAA;AAAA,KAClD;AACA,IAAA,IAAA,CAAK,IAAO,GAAA,IAAA,CAAA;AAAA,GACd;AAAA,EAEA,MAAM,KAAyD,GAAA;AAC7D,IAAA,IAAA,CAAK,QAAS,EAAA,CAAA;AAEd,IAAA,MAAM,QAAQ,KAA4C,EAAA,CAAA;AAC1D,IAAM,MAAA,MAAA,GAAS,IAAI,cAAe,EAAA,CAAA;AAElC,IAAO,MAAA,CAAA,EAAA,CAAG,OAAS,EAAA,CAAC,KAAgC,KAAA;AAClD,MAAI,IAAA,KAAA,CAAM,SAAS,WAAa,EAAA;AAC9B,QAAA,KAAA,CAAM,MAAO,EAAA,CAAA;AACb,QAAA,OAAA;AAAA,OACF;AAIA,MAAA,MAAM,eAAe,IAAK,CAAA,mBAAA,GACtBC,mCAA4B,KAAM,CAAA,IAAI,IACtC,KAAM,CAAA,IAAA,CAAA;AAEV,MAAA,IAAI,KAAK,OAAS,EAAA;AAChB,QAAA,IAAI,CAAC,YAAA,CAAa,UAAW,CAAA,IAAA,CAAK,OAAO,CAAG,EAAA;AAC1C,UAAA,KAAA,CAAM,MAAO,EAAA,CAAA;AACb,UAAA,OAAA;AAAA,SACF;AAAA,OACF;AAEA,MAAA,MAAM,IAAO,GAAA,YAAA,CAAa,KAAM,CAAA,IAAA,CAAK,QAAQ,MAAM,CAAA,CAAA;AACnD,MAAA,IAAI,KAAK,MAAQ,EAAA;AACf,QAAI,IAAA,CAAC,KAAK,MAAO,CAAA,IAAA,EAAM,EAAE,IAAM,EAAA,KAAA,CAAM,MAAO,EAAC,CAAG,EAAA;AAC9C,UAAA,KAAA,CAAM,MAAO,EAAA,CAAA;AACb,UAAA,OAAA;AAAA,SACF;AAAA,OACF;AAEA,MAAA,MAAM,OAAU,GAAA,IAAI,OAAgB,CAAA,OAAM,OAAW,KAAA;AACnD,QAAA,MAAM,QAAS,CAAA,KAAA,EAAOC,6BAAa,CAAA,OAAO,CAAC,CAAA,CAAA;AAAA,OAC5C,CAAA,CAAA;AAED,MAAA,KAAA,CAAM,IAAK,CAAA;AAAA,QACT,IAAA;AAAA,QACA,SAAS,MAAM,OAAA;AAAA,OAChB,CAAA,CAAA;AAED,MAAA,KAAA,CAAM,MAAO,EAAA,CAAA;AAAA,KACd,CAAA,CAAA;AAED,IAAM,MAAA,QAAA,CAAS,IAAK,CAAA,MAAA,EAAQ,MAAM,CAAA,CAAA;AAElC,IAAO,OAAA,KAAA,CAAA;AAAA,GACT;AAAA,EAEA,MAAM,OAA6B,GAAA;AACjC,IAAI,IAAA,CAAC,KAAK,OAAS,EAAA;AACjB,MAAA,IAAA,CAAK,QAAS,EAAA,CAAA;AAEd,MAAA,OAAO,IAAK,CAAA,MAAA,CAAA;AAAA,KACd;AAIA,IAAM,MAAA,MAAA,GAAS,MAAM,IAAA,CAAK,GAAI,EAAA,CAAA;AAE9B,IAAI,IAAA;AACF,MAAA,MAAM,IAAO,GAAA,MAAM,IAAI,OAAA,CAAgB,OAAM,OAAW,KAAA;AACtD,QAAM,MAAA,QAAA;AAAA,UACJC,oBAAA,CAAI,OAAO,EAAE,GAAA,EAAK,QAAU,EAAA,CAAC,EAAE,CAAC,CAAA;AAAA,UAChCD,8BAAa,OAAO,CAAA;AAAA,SACtB,CAAA;AAAA,OACD,CAAA,CAAA;AACD,MAAO,OAAAE,eAAA,CAAS,KAAK,IAAI,CAAA,CAAA;AAAA,KACzB,SAAA;AACA,MAAM,MAAAC,mBAAA,CAAG,OAAO,MAAM,CAAA,CAAA;AAAA,KACxB;AAAA,GACF;AAAA,EAEA,MAAM,IACJ,OACiB,EAAA;AACjB,IAAA,IAAA,CAAK,QAAS,EAAA,CAAA;AAEd,IAAM,MAAA,GAAA,GACJ,OAAS,EAAA,SAAA,IACR,MAAMA,mBAAA,CAAG,OAAQ,CAAAC,6BAAA,CAAa,IAAK,CAAA,IAAA,CAAK,OAAS,EAAA,YAAY,CAAC,CAAA,CAAA;AAIjE,IAAI,IAAA,KAAA,GAAQ,KAAK,OAAU,GAAA,IAAA,CAAK,QAAQ,KAAM,CAAA,GAAG,EAAE,MAAS,GAAA,CAAA,CAAA;AAC5D,IAAI,IAAA,CAAC,KAAK,mBAAqB,EAAA;AAC7B,MAAA,KAAA,EAAA,CAAA;AAAA,KACF;AAEA,IAAA,IAAI,WAAiC,GAAA,KAAA,CAAA,CAAA;AACrC,IAAM,MAAA,QAAA;AAAA,MACJ,IAAK,CAAA,MAAA;AAAA,MACLH,qBAAI,OAAQ,CAAA;AAAA,QACV,KAAA;AAAA,QACA,GAAK,EAAA,GAAA;AAAA,QACL,MAAA,EAAQ,CAAC,IAAA,EAAM,IAAS,KAAA;AAEtB,UAAA,IAAI,WAAa,EAAA;AACf,YAAO,OAAA,KAAA,CAAA;AAAA,WACT;AAIA,UAAA,MAAM,YAAe,GAAA,IAAA,CAAK,mBACtB,GAAAF,kCAAA,CAA4B,IAAI,CAChC,GAAA,IAAA,CAAA;AACJ,UAAA,IAAI,KAAK,OAAW,IAAA,CAAC,aAAa,UAAW,CAAA,IAAA,CAAK,OAAO,CAAG,EAAA;AAC1D,YAAO,OAAA,KAAA,CAAA;AAAA,WACT;AACA,UAAA,IAAI,KAAK,MAAQ,EAAA;AACf,YAAM,MAAA,SAAA,GAAY,KAAK,KAAM,CAAA,GAAG,EAAE,KAAM,CAAA,KAAK,CAAE,CAAA,IAAA,CAAK,GAAG,CAAA,CAAA;AACvD,YAAI,IAAA;AACF,cAAA,OAAO,KAAK,MAAO,CAAA,SAAA,EAAW,EAAE,IAAM,EAAA,IAAA,CAAK,MAAM,CAAA,CAAA;AAAA,qBAC1C,KAAO,EAAA;AACd,cAAc,WAAA,GAAA,KAAA,CAAA;AACd,cAAO,OAAA,KAAA,CAAA;AAAA,aACT;AAAA,WACF;AACA,UAAO,OAAA,IAAA,CAAA;AAAA,SACT;AAAA,OACD,CAAA;AAAA,KACH,CAAA;AAEA,IAAA,IAAI,WAAa,EAAA;AAGf,MAAI,IAAA,CAAC,SAAS,SAAW,EAAA;AACvB,QAAA,MAAMI,mBAAG,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,MAAM,MAAM;AAAA,SAAE,CAAA,CAAA;AAAA,OACrC;AACA,MAAM,MAAA,WAAA,CAAA;AAAA,KACR;AAEA,IAAO,OAAA,GAAA,CAAA;AAAA,GACT;AACF;;;;"}