github-issue-tower-defence-management 2.19.1 → 2.19.3

package/src/adapter/entry-points/console/consoleGithubTokenResolver.test.ts

@@ -1,275 +0,0 @@
-import {
-  createConsoleGithubTokenResolver,
-  createConsoleGithubTokenResolverByItemUrl,
-  createConsoleIssueRepositoryResolver,
-  createConsoleProjectRepositoryResolver,
-  extractProjectOwner,
-  extractRepositoryOwner,
-} from './consoleGithubTokenResolver';
-
-describe('extractProjectOwner', () => {
-  it('should return the organization login of an organization project url', () => {
-    expect(
-      extractProjectOwner('https://github.com/orgs/acme/projects/18'),
-    ).toBe('acme');
-  });
-
-  it('should return the user login of a user project url', () => {
-    expect(
-      extractProjectOwner('https://github.com/users/acme-owner/projects/48'),
-    ).toBe('acme-owner');
-  });
-
-  it('should return null for a url that is not a project url', () => {
-    expect(
-      extractProjectOwner('https://github.com/acme/acme-repository/issues/178'),
-    ).toBeNull();
-  });
-});
-
-describe('createConsoleProjectRepositoryResolver', () => {
-  it('builds the project repository from the token of the owner in the project url', () => {
-    const resolve = createConsoleProjectRepositoryResolver<string>(
-      (repositoryOwner) => `token-of-${repositoryOwner}`,
-      (githubToken) => `repository-with-${githubToken}`,
-    );
-
-    expect(resolve('https://github.com/orgs/acme/projects/18')).toBe(
-      'repository-with-token-of-acme',
-    );
-  });
-
-  it('throws when the project owner cannot be read from the project url', () => {
-    const resolve = createConsoleProjectRepositoryResolver<string>(
-      (repositoryOwner) => `token-of-${repositoryOwner}`,
-      (githubToken) => `repository-with-${githubToken}`,
-    );
-
-    expect(() => resolve('https://github.com/orgs/acme')).toThrow(
-      'The project owner cannot be read from the project url: https://github.com/orgs/acme',
-    );
-  });
-});
-
-describe('createConsoleGithubTokenResolverByItemUrl', () => {
-  it('returns the token for the owner of the given item url', () => {
-    const resolve = createConsoleGithubTokenResolverByItemUrl(
-      (repositoryOwner) => `token-of-${repositoryOwner}`,
-    );
-
-    expect(
-      resolve('https://github.com/acme-labs/acme-portal-mock/issues/178'),
-    ).toBe('token-of-acme-labs');
-  });
-
-  it('throws when the repository owner cannot be read from the url', () => {
-    const resolve = createConsoleGithubTokenResolverByItemUrl(
-      (repositoryOwner) => `token-of-${repositoryOwner}`,
-    );
-
-    expect(() =>
-      resolve('https://github.com/acme-labs/acme-portal-mock'),
-    ).toThrow(
-      'The repository owner cannot be read from the url: https://github.com/acme-labs/acme-portal-mock',
-    );
-  });
-});
-
-describe('createConsoleIssueRepositoryResolver', () => {
-  it('builds the issue repository from the token of the owner in the url', () => {
-    const resolve = createConsoleIssueRepositoryResolver<string>(
-      (repositoryOwner) => `token-of-${repositoryOwner}`,
-      (githubToken) => `repository-with-${githubToken}`,
-    );
-
-    expect(
-      resolve('https://github.com/acme-labs/acme-portal-mock/issues/178'),
-    ).toBe('repository-with-token-of-acme-labs');
-  });
-
-  it('throws when the repository owner cannot be read from the url', () => {
-    const resolve = createConsoleIssueRepositoryResolver<string>(
-      (repositoryOwner) => `token-of-${repositoryOwner}`,
-      (githubToken) => `repository-with-${githubToken}`,
-    );
-
-    expect(() =>
-      resolve('https://github.com/acme-labs/acme-portal-mock'),
-    ).toThrow(
-      'The repository owner cannot be read from the operated url: https://github.com/acme-labs/acme-portal-mock',
-    );
-  });
-});
-
-describe('extractRepositoryOwner', () => {
-  it('should return the owner of an issue url', () => {
-    expect(
-      extractRepositoryOwner(
-        'https://github.com/acme-labs/acme-portal-mock/issues/178',
-      ),
-    ).toBe('acme-labs');
-  });
-
-  it('should return the owner of a pull request url', () => {
-    expect(
-      extractRepositoryOwner(
-        'https://github.com/HiromiShikata/npm-cli-github-issue-tower-defence-management/pull/1399',
-      ),
-    ).toBe('HiromiShikata');
-  });
-
-  it('should return null for a url that is not an issue or a pull request', () => {
-    expect(
-      extractRepositoryOwner('https://github.com/acme-labs/acme-portal-mock'),
-    ).toBeNull();
-  });
-});
-
-describe('createConsoleGithubTokenResolver', () => {
-  it('should return the default token when consoleProjectUrls is null', () => {
-    const resolve = createConsoleGithubTokenResolver(
-      'default-token',
-      null,
-      null,
-      () => {
-        throw new Error('must not read any file');
-      },
-    );
-
-    expect(resolve('HiromiShikata')).toBe('default-token');
-  });
-
-  it('should return the default token when githubTokenFileDirPath is null', () => {
-    const resolve = createConsoleGithubTokenResolver(
-      'default-token',
-      { acme: 'https://github.com/orgs/acme-labs/projects/1' },
-      null,
-      () => {
-        throw new Error('must not read any file');
-      },
-    );
-
-    expect(resolve('acme-labs')).toBe('default-token');
-  });
-
-  it('should return the token read from the pjcode-named file for the matching project owner', () => {
-    const resolve = createConsoleGithubTokenResolver(
-      'default-token',
-      { acme: 'https://github.com/orgs/acme-labs/projects/1' },
-      '/creds',
-      (filePath) =>
-        filePath === '/creds/tdpm-github-token-acme.txt'
-          ? 'fine-grained-token\n'
-          : (() => {
-              throw new Error(`unexpected file path: ${filePath}`);
-            })(),
-    );
-
-    expect(resolve('acme-labs')).toBe('fine-grained-token');
-  });
-
-  it('should return the token for example-org when cmg project URL owner is example-org', () => {
-    const resolve = createConsoleGithubTokenResolver(
-      'default-token',
-      { cmg: 'https://github.com/orgs/example-org/projects/18' },
-      '/token-dir',
-      (filePath) =>
-        filePath === '/token-dir/tdpm-github-token-cmg.txt'
-          ? 'cmg-token'
-          : (() => {
-              throw new Error(`unexpected file path: ${filePath}`);
-            })(),
-    );
-
-    expect(resolve('example-org')).toBe('cmg-token');
-  });
-
-  it('should keep using the default token for owners that match no project url', () => {
-    const resolve = createConsoleGithubTokenResolver(
-      'default-token',
-      { acme: 'https://github.com/orgs/acme-labs/projects/1' },
-      '/creds',
-      () => 'fine-grained-token',
-    );
-
-    expect(resolve('globex-inc')).toBe('default-token');
-  });
-
-  it('should read the token file only once per owner', () => {
-    let readCount = 0;
-    const resolve = createConsoleGithubTokenResolver(
-      'default-token',
-      { acme: 'https://github.com/orgs/acme-labs/projects/1' },
-      '/creds',
-      () => {
-        readCount += 1;
-        return 'fine-grained-token';
-      },
-    );
-
-    resolve('acme-labs');
-    resolve('acme-labs');
-
-    expect(readCount).toBe(1);
-  });
-
-  it('should throw when the token file for the matching pjcode contains no token', () => {
-    const resolve = createConsoleGithubTokenResolver(
-      'default-token',
-      { acme: 'https://github.com/orgs/acme-labs/projects/1' },
-      '/creds',
-      () => '  \n',
-    );
-
-    expect(() => resolve('acme-labs')).toThrow(
-      'The GitHub token file for pjcode "acme" contains no token: /creds/tdpm-github-token-acme.txt',
-    );
-  });
-
-  it('should return the default token when the token file for the matching pjcode is absent', () => {
-    const resolve = createConsoleGithubTokenResolver(
-      'default-token',
-      { acme: 'https://github.com/orgs/acme-labs/projects/1' },
-      '/creds',
-      () => {
-        throw Object.assign(
-          new Error(
-            "ENOENT: no such file or directory, open '/creds/tdpm-github-token-acme.txt'",
-          ),
-          { code: 'ENOENT' },
-        );
-      },
-    );
-
-    expect(resolve('acme-labs')).toBe('default-token');
-  });
-
-  it('should rethrow a non-ENOENT error from the token file reader', () => {
-    const resolve = createConsoleGithubTokenResolver(
-      'default-token',
-      { acme: 'https://github.com/orgs/acme-labs/projects/1' },
-      '/creds',
-      () => {
-        throw Object.assign(
-          new Error(
-            "EACCES: permission denied, open '/creds/tdpm-github-token-acme.txt'",
-          ),
-          { code: 'EACCES' },
-        );
-      },
-    );
-
-    expect(() => resolve('acme-labs')).toThrow('EACCES: permission denied');
-  });
-
-  it('should match the project owner case-insensitively', () => {
-    const resolve = createConsoleGithubTokenResolver(
-      'default-token',
-      { acme: 'https://github.com/orgs/Acme-Labs/projects/1' },
-      '/creds',
-      () => 'fine-grained-token',
-    );
-
-    expect(resolve('acme-labs')).toBe('fine-grained-token');
-  });
-});

package/src/adapter/entry-points/console/consoleGithubTokenResolver.ts

@@ -1,113 +0,0 @@
-export type ConsoleGithubTokenResolver = (repositoryOwner: string) => string;
-
-export type GithubTokenFileReader = (filePath: string) => string;
-
-export const extractRepositoryOwner = (
-  issueOrPullRequestUrl: string,
-): string | null => {
-  const match = issueOrPullRequestUrl.match(
-    /^https:\/\/github\.com\/([A-Za-z0-9._-]+)\/[A-Za-z0-9._-]+\/(?:issues|pull)\/\d+/,
-  );
-  return match ? match[1] : null;
-};
-
-export const createConsoleIssueRepositoryResolver = <IssueRepositoryType>(
-  resolveGithubToken: ConsoleGithubTokenResolver,
-  buildIssueRepositoryForToken: (githubToken: string) => IssueRepositoryType,
-): ((issueOrPullRequestUrl: string) => IssueRepositoryType) => {
-  return (issueOrPullRequestUrl: string): IssueRepositoryType => {
-    const repositoryOwner = extractRepositoryOwner(issueOrPullRequestUrl);
-    if (repositoryOwner === null) {
-      throw new Error(
-        `The repository owner cannot be read from the operated url: ${issueOrPullRequestUrl}`,
-      );
-    }
-    return buildIssueRepositoryForToken(resolveGithubToken(repositoryOwner));
-  };
-};
-
-export const extractProjectOwner = (projectUrl: string): string | null => {
-  const match = projectUrl.match(
-    /^https:\/\/github\.com\/(?:orgs|users)\/([A-Za-z0-9._-]+)\/projects\/\d+/,
-  );
-  return match ? match[1] : null;
-};
-
-export const createConsoleProjectRepositoryResolver = <ProjectRepositoryType>(
-  resolveGithubToken: ConsoleGithubTokenResolver,
-  buildProjectRepositoryForToken: (
-    githubToken: string,
-  ) => ProjectRepositoryType,
-): ((projectUrl: string) => ProjectRepositoryType) => {
-  return (projectUrl: string): ProjectRepositoryType => {
-    const projectOwner = extractProjectOwner(projectUrl);
-    if (projectOwner === null) {
-      throw new Error(
-        `The project owner cannot be read from the project url: ${projectUrl}`,
-      );
-    }
-    return buildProjectRepositoryForToken(resolveGithubToken(projectOwner));
-  };
-};
-
-export const createConsoleGithubTokenResolverByItemUrl = (
-  resolveGithubToken: ConsoleGithubTokenResolver,
-): ((itemUrl: string) => string) => {
-  return (itemUrl: string): string => {
-    const owner = extractRepositoryOwner(itemUrl);
-    if (owner === null) {
-      throw new Error(
-        `The repository owner cannot be read from the url: ${itemUrl}`,
-      );
-    }
-    return resolveGithubToken(owner);
-  };
-};
-
-export const createConsoleGithubTokenResolver = (
-  defaultToken: string,
-  consoleProjectUrls: Record<string, string> | null,
-  githubTokenFileDirPath: string | null,
-  readTokenFile: GithubTokenFileReader,
-): ConsoleGithubTokenResolver => {
-  const resolvedTokenByRepositoryOwner = new Map<string, string>();
-  return (repositoryOwner: string): string => {
-    const alreadyResolved = resolvedTokenByRepositoryOwner.get(repositoryOwner);
-    if (alreadyResolved !== undefined) {
-      return alreadyResolved;
-    }
-    if (consoleProjectUrls === null || githubTokenFileDirPath === null) {
-      return defaultToken;
-    }
-    const normalizedOwner = repositoryOwner.toLowerCase();
-    const matchedPjcode = Object.entries(consoleProjectUrls).find(
-      ([, projectUrl]) =>
-        extractProjectOwner(projectUrl)?.toLowerCase() === normalizedOwner,
-    )?.[0];
-    if (matchedPjcode === undefined) {
-      return defaultToken;
-    }
-    const filePath = `${githubTokenFileDirPath}/tdpm-github-token-${matchedPjcode}.txt`;
-    let fileContent: string;
-    try {
-      fileContent = readTokenFile(filePath);
-    } catch (error) {
-      if (
-        error instanceof Error &&
-        'code' in error &&
-        error.code === 'ENOENT'
-      ) {
-        return defaultToken;
-      }
-      throw error;
-    }
-    const token = fileContent.trim();
-    if (token.length === 0) {
-      throw new Error(
-        `The GitHub token file for pjcode "${matchedPjcode}" contains no token: ${filePath}`,
-      );
-    }
-    resolvedTokenByRepositoryOwner.set(repositoryOwner, token);
-    return token;
-  };
-};

package/src/adapter/entry-points/console/consoleImageProxy.test.ts

@@ -1,140 +0,0 @@
-import {
-  type ImageFetcher,
-  fetchProxiedImage,
-  isAllowedImageUrl,
-} from './consoleImageProxy';
-
-describe('isAllowedImageUrl', () => {
-  it('allows github user-attachments URLs', () => {
-    expect(
-      isAllowedImageUrl(
-        'https://github.com/user-attachments/assets/0a1b2c3d-4e5f',
-      ),
-    ).toBe(true);
-  });
-
-  it('allows githubusercontent subdomain URLs', () => {
-    expect(
-      isAllowedImageUrl(
-        'https://private-user-images.githubusercontent.com/1/2.png',
-      ),
-    ).toBe(true);
-  });
-
-  it('rejects arbitrary external hosts', () => {
-    expect(isAllowedImageUrl('https://example.com/avatar.png')).toBe(false);
-  });
-
-  it('rejects non-https github paths outside user-attachments', () => {
-    expect(isAllowedImageUrl('https://github.com/HiromiShikata/repo')).toBe(
-      false,
-    );
-  });
-
-  it('rejects a host that merely contains githubusercontent.com as a suffix trick', () => {
-    expect(isAllowedImageUrl('https://evil-githubusercontent.com/x.png')).toBe(
-      false,
-    );
-  });
-});
-
-describe('fetchProxiedImage', () => {
-  const successFetcher: ImageFetcher = async (_url, headers) => {
-    expect(headers.Authorization).toBe('token gh-token-value');
-    return {
-      status: 200,
-      contentType: 'image/png',
-      body: Buffer.from([0x89, 0x50, 0x4e, 0x47]),
-    };
-  };
-
-  it('returns image bytes for an allow-listed url with a valid token', async () => {
-    const result = await fetchProxiedImage(
-      'https://github.com/user-attachments/assets/abc',
-      'gh-token-value',
-      successFetcher,
-    );
-    expect(result.ok).toBe(true);
-    if (result.ok) {
-      expect(result.contentType).toBe('image/png');
-      expect(Array.from(result.body)).toEqual([0x89, 0x50, 0x4e, 0x47]);
-    }
-  });
-
-  it('rejects a missing url with status 400', async () => {
-    const result = await fetchProxiedImage(
-      '',
-      'gh-token-value',
-      successFetcher,
-    );
-    expect(result).toEqual({
-      ok: false,
-      statusCode: 400,
-      error: 'missing url parameter',
-    });
-  });
-
-  it('rejects a non-allow-listed url with status 400', async () => {
-    const result = await fetchProxiedImage(
-      'https://example.com/avatar.png',
-      'gh-token-value',
-      successFetcher,
-    );
-    expect(result).toEqual({
-      ok: false,
-      statusCode: 400,
-      error: 'url not in allowed domain',
-    });
-  });
-
-  it('returns 502 when the upstream responds with a non-2xx status', async () => {
-    const failingFetcher: ImageFetcher = async () => ({
-      status: 404,
-      contentType: null,
-      body: Buffer.alloc(0),
-    });
-    const result = await fetchProxiedImage(
-      'https://github.com/user-attachments/assets/abc',
-      'gh-token-value',
-      failingFetcher,
-    );
-    expect(result).toEqual({
-      ok: false,
-      statusCode: 502,
-      error: 'upstream 404',
-    });
-  });
-
-  it('returns 502 when the fetcher throws', async () => {
-    const throwingFetcher: ImageFetcher = async () => {
-      throw new Error('network down');
-    };
-    const result = await fetchProxiedImage(
-      'https://github.com/user-attachments/assets/abc',
-      'gh-token-value',
-      throwingFetcher,
-    );
-    expect(result).toEqual({
-      ok: false,
-      statusCode: 502,
-      error: 'proxy error: network down',
-    });
-  });
-
-  it('falls back to octet-stream content type when upstream omits it', async () => {
-    const noContentTypeFetcher: ImageFetcher = async () => ({
-      status: 200,
-      contentType: null,
-      body: Buffer.from([0x01]),
-    });
-    const result = await fetchProxiedImage(
-      'https://private-user-images.githubusercontent.com/1/2',
-      'gh-token-value',
-      noContentTypeFetcher,
-    );
-    expect(result.ok).toBe(true);
-    if (result.ok) {
-      expect(result.contentType).toBe('application/octet-stream');
-    }
-  });
-});

package/src/adapter/entry-points/console/consoleImageProxy.ts

@@ -1,111 +0,0 @@
-const GITHUBUSERCONTENT_HOST_SUFFIX = '.githubusercontent.com';
-
-const isAllowedHost = (hostname: string): boolean => {
-  if (hostname === 'github.com') {
-    return true;
-  }
-  if (!hostname.endsWith(GITHUBUSERCONTENT_HOST_SUFFIX)) {
-    return false;
-  }
-  const subdomain = hostname.slice(
-    0,
-    hostname.length - GITHUBUSERCONTENT_HOST_SUFFIX.length,
-  );
-  return subdomain.length > 0 && /^[a-z0-9][a-z0-9.-]*$/.test(subdomain);
-};
-
-const parseAllowedImageUrl = (url: string): URL | null => {
-  let parsed: URL;
-  try {
-    parsed = new URL(url);
-  } catch {
-    return null;
-  }
-  if (parsed.protocol !== 'https:') {
-    return null;
-  }
-  if (parsed.hostname === 'github.com') {
-    return parsed.pathname.startsWith('/user-attachments/') ? parsed : null;
-  }
-  return isAllowedHost(parsed.hostname) ? parsed : null;
-};
-
-export const isAllowedImageUrl = (url: string): boolean =>
-  parseAllowedImageUrl(url) !== null;
-
-export type ProxiedImageSuccess = {
-  ok: true;
-  contentType: string;
-  body: Buffer;
-};
-
-export type ProxiedImageFailure = {
-  ok: false;
-  statusCode: number;
-  error: string;
-};
-
-export type ProxiedImageResult = ProxiedImageSuccess | ProxiedImageFailure;
-
-export type ImageFetcher = (
-  url: string,
-  headers: Record<string, string>,
-) => Promise<{
-  status: number;
-  contentType: string | null;
-  body: Buffer;
-}>;
-
-const defaultImageFetcher: ImageFetcher = async (url, headers) => {
-  const validated = parseAllowedImageUrl(url);
-  if (validated === null) {
-    throw new Error('url not in allowed domain');
-  }
-  const safeUrl = `https://${validated.host}${validated.pathname}${validated.search}`;
-  const response = await fetch(safeUrl, { headers, redirect: 'follow' });
-  const arrayBuffer = await response.arrayBuffer();
-  return {
-    status: response.status,
-    contentType: response.headers.get('content-type'),
-    body: Buffer.from(arrayBuffer),
-  };
-};
-
-export const fetchProxiedImage = async (
-  url: string,
-  githubToken: string,
-  fetcher: ImageFetcher = defaultImageFetcher,
-): Promise<ProxiedImageResult> => {
-  if (url.length === 0) {
-    return { ok: false, statusCode: 400, error: 'missing url parameter' };
-  }
-  const allowedUrl = parseAllowedImageUrl(url);
-  if (allowedUrl === null) {
-    return { ok: false, statusCode: 400, error: 'url not in allowed domain' };
-  }
-  let result: {
-    status: number;
-    contentType: string | null;
-    body: Buffer;
-  };
-  try {
-    result = await fetcher(allowedUrl.toString(), {
-      Authorization: `token ${githubToken}`,
-    });
-  } catch (error) {
-    const detail = error instanceof Error ? error.message : String(error);
-    return { ok: false, statusCode: 502, error: `proxy error: ${detail}` };
-  }
-  if (result.status < 200 || result.status >= 300) {
-    return {
-      ok: false,
-      statusCode: 502,
-      error: `upstream ${result.status}`,
-    };
-  }
-  return {
-    ok: true,
-    contentType: result.contentType ?? 'application/octet-stream',
-    body: result.body,
-  };
-};

package/src/adapter/entry-points/console/consoleItemUrlLookup.test.ts

@@ -1,63 +0,0 @@
-import * as fs from 'fs';
-import * as os from 'os';
-import * as path from 'path';
-import { findConsoleItemUrl } from './consoleItemUrlLookup';
-
-describe('findConsoleItemUrl', () => {
-  let baseDir: string;
-
-  beforeEach(() => {
-    baseDir = fs.mkdtempSync(path.join(os.tmpdir(), 'console-lookup-'));
-  });
-
-  afterEach(() => {
-    fs.rmSync(baseDir, { recursive: true, force: true });
-  });
-
-  const writeList = (tab: string, items: unknown): void => {
-    const dir = path.join(baseDir, 'acme', tab);
-    fs.mkdirSync(dir, { recursive: true });
-    fs.writeFileSync(path.join(dir, 'list.json'), JSON.stringify({ items }));
-  };
-
-  it('returns the stored url when the requested url is listed in a tab', () => {
-    writeList('prs', [{ url: 'https://github.com/o/r/issues/1' }]);
-    expect(
-      findConsoleItemUrl(baseDir, 'acme', 'https://github.com/o/r/issues/1'),
-    ).toBe('https://github.com/o/r/issues/1');
-  });
-
-  it('returns null when no tab lists the requested url', () => {
-    writeList('prs', [{ url: 'https://github.com/o/r/issues/1' }]);
-    expect(
-      findConsoleItemUrl(baseDir, 'acme', 'https://github.com/o/r/issues/2'),
-    ).toBeNull();
-  });
-
-  it('returns null when the project directory does not exist', () => {
-    expect(
-      findConsoleItemUrl(baseDir, 'unknown', 'https://github.com/o/r/issues/1'),
-    ).toBeNull();
-  });
-
-  it('ignores a tab file that is not valid json', () => {
-    const dir = path.join(baseDir, 'acme', 'failed-preparation');
-    fs.mkdirSync(dir, { recursive: true });
-    fs.writeFileSync(path.join(dir, 'list.json'), 'not json');
-    writeList('prs', [{ url: 'https://github.com/o/r/issues/1' }]);
-    expect(
-      findConsoleItemUrl(baseDir, 'acme', 'https://github.com/o/r/issues/1'),
-    ).toBe('https://github.com/o/r/issues/1');
-  });
-
-  it('ignores entries without a url string', () => {
-    writeList('prs', [
-      { url: 1 },
-      null,
-      { url: 'https://github.com/o/r/pull/9' },
-    ]);
-    expect(
-      findConsoleItemUrl(baseDir, 'acme', 'https://github.com/o/r/pull/9'),
-    ).toBe('https://github.com/o/r/pull/9');
-  });
-});