Merge pull request #8405 from backstage/freben/nounpack

Do not unpack arguments directly on exported items 🧹
2021-12-08 13:15:13 +01:00
parent 60ad732470 dcd1a0c3f4
commit 986a5d869e
66 changed files with 433 additions and 708 deletions
@@ -188,18 +188,9 @@ export type DatabaseManagerOptions = {

 // @public (undocumented)
 export class DockerContainerRunner implements ContainerRunner {
-  constructor({ dockerClient }: { dockerClient: Docker });
+  constructor(options: { dockerClient: Docker });
  // (undocumented)
-  runContainer({
-    imageName,
-    command,
-    args,
-    logStream,
-    mountDirs,
-    workingDir,
-    envVars,
-    pullImage,
-  }: RunContainerOptions): Promise<void>;
+  runContainer(options: RunContainerOptions): Promise<void>;
 }

 // @public
@@ -235,34 +226,17 @@ export function getVoidLogger(): winston.Logger;
 // @public (undocumented)
 export class Git {
  // (undocumented)
-  add({ dir, filepath }: { dir: string; filepath: string }): Promise<void>;
+  add(options: { dir: string; filepath: string }): Promise<void>;
  // (undocumented)
-  addRemote({
-    dir,
-    url,
-    remote,
-  }: {
+  addRemote(options: {
    dir: string;
    remote: string;
    url: string;
  }): Promise<void>;
  // (undocumented)
-  clone({
-    url,
-    dir,
-    ref,
-  }: {
-    url: string;
-    dir: string;
-    ref?: string;
-  }): Promise<void>;
+  clone(options: { url: string; dir: string; ref?: string }): Promise<void>;
  // (undocumented)
-  commit({
-    dir,
-    message,
-    author,
-    committer,
-  }: {
+  commit(options: {
    dir: string;
    message: string;
    author: {
@@ -275,41 +249,22 @@ export class Git {
    };
  }): Promise<string>;
  // (undocumented)
-  currentBranch({
-    dir,
-    fullName,
-  }: {
+  currentBranch(options: {
    dir: string;
    fullName?: boolean;
  }): Promise<string | undefined>;
  // (undocumented)
-  fetch({ dir, remote }: { dir: string; remote?: string }): Promise<void>;
+  fetch(options: { dir: string; remote?: string }): Promise<void>;
  // (undocumented)
-  static fromAuth: ({
-    username,
-    password,
-    logger,
-  }: {
-    username?: string | undefined;
-    password?: string | undefined;
-    logger?: Logger_2 | undefined;
+  static fromAuth: (options: {
+    username?: string;
+    password?: string;
+    logger?: Logger_2;
  }) => Git;
  // (undocumented)
-  init({
-    dir,
-    defaultBranch,
-  }: {
-    dir: string;
-    defaultBranch?: string;
-  }): Promise<void>;
+  init(options: { dir: string; defaultBranch?: string }): Promise<void>;
  // (undocumented)
-  merge({
-    dir,
-    theirs,
-    ours,
-    author,
-    committer,
-  }: {
+  merge(options: {
    dir: string;
    theirs: string;
    ours?: string;
@@ -323,17 +278,11 @@ export class Git {
    };
  }): Promise<MergeResult>;
  // (undocumented)
-  push({ dir, remote }: { dir: string; remote: string }): Promise<PushResult>;
+  push(options: { dir: string; remote: string }): Promise<PushResult>;
  // (undocumented)
-  readCommit({
-    dir,
-    sha,
-  }: {
-    dir: string;
-    sha: string;
-  }): Promise<ReadCommitResult>;
+  readCommit(options: { dir: string; sha: string }): Promise<ReadCommitResult>;
  // (undocumented)
-  resolveRef({ dir, ref }: { dir: string; ref: string }): Promise<string>;
+  resolveRef(options: { dir: string; ref: string }): Promise<string>;
 }

 // @public
@@ -634,8 +583,8 @@ export type UrlReaderPredicateTuple = {

 // @public
 export class UrlReaders {
-  static create({ logger, config, factories }: UrlReadersOptions): UrlReader;
-  static default({ logger, config, factories }: UrlReadersOptions): UrlReader;
+  static create(options: UrlReadersOptions): UrlReader;
+  static default(options: UrlReadersOptions): UrlReader;
 }

 // @public (undocumented)
@@ -46,7 +46,8 @@ export class UrlReaders {
  /**
   * Creates a UrlReader without any known types.
   */
-  static create({ logger, config, factories }: UrlReadersOptions): UrlReader {
+  static create(options: UrlReadersOptions): UrlReader {
+    const { logger, config, factories } = options;
    const mux = new UrlReaderPredicateMux(logger);
    const treeResponseFactory = DefaultReadTreeResponseFactory.create({
      config,
@@ -68,7 +69,8 @@ export class UrlReaders {
   *
   * Any additional factories passed will be loaded before the default ones.
   */
-  static default({ logger, config, factories = [] }: UrlReadersOptions) {
+  static default(options: UrlReadersOptions) {
+    const { logger, config, factories = [] } = options;
    return UrlReaders.create({
      logger,
      config,
@@ -13,6 +13,7 @@
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
+
 import git, {
  ProgressCallback,
  MergeResult,
@@ -42,44 +43,32 @@ export class Git {
    },
  ) {}

-  async add({
-    dir,
-    filepath,
-  }: {
-    dir: string;
-    filepath: string;
-  }): Promise<void> {
+  async add(options: { dir: string; filepath: string }): Promise<void> {
+    const { dir, filepath } = options;
    this.config.logger?.info(`Adding file {dir=${dir},filepath=${filepath}}`);

    return git.add({ fs, dir, filepath });
  }

-  async addRemote({
-    dir,
-    url,
-    remote,
-  }: {
+  async addRemote(options: {
    dir: string;
    remote: string;
    url: string;
  }): Promise<void> {
+    const { dir, url, remote } = options;
    this.config.logger?.info(
      `Creating new remote {dir=${dir},remote=${remote},url=${url}}`,
    );
    return git.addRemote({ fs, dir, remote, url });
  }

-  async commit({
-    dir,
-    message,
-    author,
-    committer,
-  }: {
+  async commit(options: {
    dir: string;
    message: string;
    author: { name: string; email: string };
    committer: { name: string; email: string };
  }): Promise<string> {
+    const { dir, message, author, committer } = options;
    this.config.logger?.info(
      `Committing file to repo {dir=${dir},message=${message}}`,
    );
@@ -87,15 +76,12 @@ export class Git {
    return git.commit({ fs, dir, message, author, committer });
  }

-  async clone({
-    url,
-    dir,
-    ref,
-  }: {
+  async clone(options: {
    url: string;
    dir: string;
    ref?: string;
  }): Promise<void> {
+    const { url, dir, ref } = options;
    this.config.logger?.info(`Cloning repo {dir=${dir},url=${url}}`);
    return git.clone({
      fs,
@@ -114,51 +100,35 @@ export class Git {
  }

  // https://isomorphic-git.org/docs/en/currentBranch
-  async currentBranch({
-    dir,
-    fullName,
-  }: {
+  async currentBranch(options: {
    dir: string;
    fullName?: boolean;
  }): Promise<string | undefined> {
-    const fullname = fullName ?? false;
-    return git.currentBranch({ fs, dir, fullname }) as Promise<
+    const { dir, fullName = false } = options;
+    return git.currentBranch({ fs, dir, fullname: fullName }) as Promise<
      string | undefined
    >;
  }

  // https://isomorphic-git.org/docs/en/fetch
-  async fetch({
-    dir,
-    remote,
-  }: {
-    dir: string;
-    remote?: string;
-  }): Promise<void> {
-    const remoteValue = remote ?? 'origin';
+  async fetch(options: { dir: string; remote?: string }): Promise<void> {
+    const { dir, remote = 'origin' } = options;
    this.config.logger?.info(
-      `Fetching remote=${remoteValue} for repository {dir=${dir}}`,
+      `Fetching remote=${remote} for repository {dir=${dir}}`,
    );
    await git.fetch({
      fs,
      http,
      dir,
-      remote: remoteValue,
+      remote,
      onProgress: this.onProgressHandler(),
-      headers: {
-        'user-agent': 'git/@isomorphic-git',
-      },
+      headers: { 'user-agent': 'git/@isomorphic-git' },
      onAuth: this.onAuth,
    });
  }

-  async init({
-    dir,
-    defaultBranch = 'master',
-  }: {
-    dir: string;
-    defaultBranch?: string;
-  }): Promise<void> {
+  async init(options: { dir: string; defaultBranch?: string }): Promise<void> {
+    const { dir, defaultBranch = 'master' } = options;
    this.config.logger?.info(`Init git repository {dir=${dir}}`);

    return git.init({
@@ -169,19 +139,14 @@ export class Git {
  }

  // https://isomorphic-git.org/docs/en/merge
-  async merge({
-    dir,
-    theirs,
-    ours,
-    author,
-    committer,
-  }: {
+  async merge(options: {
    dir: string;
    theirs: string;
    ours?: string;
    author: { name: string; email: string };
    committer: { name: string; email: string };
  }): Promise<MergeResult> {
+    const { dir, theirs, ours, author, committer } = options;
    this.config.logger?.info(
      `Merging branch '${theirs}' into '${ours}' for repository {dir=${dir}}`,
    );
@@ -197,7 +162,8 @@ export class Git {
    });
  }

-  async push({ dir, remote }: { dir: string; remote: string }) {
+  async push(options: { dir: string; remote: string }) {
+    const { dir, remote } = options;
    this.config.logger?.info(
      `Pushing directory to remote {dir=${dir},remote=${remote}}`,
    );
@@ -215,24 +181,17 @@ export class Git {
  }

  // https://isomorphic-git.org/docs/en/readCommit
-  async readCommit({
-    dir,
-    sha,
-  }: {
+  async readCommit(options: {
    dir: string;
    sha: string;
  }): Promise<ReadCommitResult> {
+    const { dir, sha } = options;
    return git.readCommit({ fs, dir, oid: sha });
  }

  // https://isomorphic-git.org/docs/en/resolveRef
-  async resolveRef({
-    dir,
-    ref,
-  }: {
-    dir: string;
-    ref: string;
-  }): Promise<string> {
+  async resolveRef(options: { dir: string; ref: string }): Promise<string> {
+    const { dir, ref } = options;
    return git.resolveRef({ fs, dir, ref });
  }

@@ -256,13 +215,12 @@ export class Git {
    };
  };

-  static fromAuth = ({
-    username,
-    password,
-    logger,
-  }: {
+  static fromAuth = (options: {
    username?: string;
    password?: string;
    logger?: Logger;
-  }) => new Git({ username, password, logger });
+  }) => {
+    const { username, password, logger } = options;
+    return new Git({ username, password, logger });
+  };
 }
@@ -28,20 +28,22 @@ export type UserOptions = {
 export class DockerContainerRunner implements ContainerRunner {
  private readonly dockerClient: Docker;

-  constructor({ dockerClient }: { dockerClient: Docker }) {
-    this.dockerClient = dockerClient;
+  constructor(options: { dockerClient: Docker }) {
+    this.dockerClient = options.dockerClient;
  }

-  async runContainer({
-    imageName,
-    command,
-    args,
-    logStream = new PassThrough(),
-    mountDirs = {},
-    workingDir,
-    envVars = {},
-    pullImage = true,
-  }: RunContainerOptions) {
+  async runContainer(options: RunContainerOptions) {
+    const {
+      imageName,
+      command,
+      args,
+      logStream = new PassThrough(),
+      mountDirs = {},
+      workingDir,
+      envVars = {},
+      pullImage = true,
+    } = options;
+
    // Show a better error message when Docker is unavailable.
    try {
      await this.dockerClient.ping();