Function getRemoteSource

src/deploy/functions/remoteSource.ts:23–82

(
  repository: string,
  ref: string,
  destDir: string,
  subDir?: string,
)

 * @return Absolute path to the checked‑out source directory
 */
export async function getRemoteSource(
  repository: string,
  ref: string,
  destDir: string,
  subDir?: string,
): Promise<string> {
  logger.debug(
    `Downloading remote source: ${repository}@${ref} (destDir: ${destDir}, subDir: ${subDir || "."})`,
  );

  const gitHubInfo = parseGitHubUrl(repository);
  if (!gitHubInfo) {
    throw new FirebaseError(
      `Could not parse GitHub repository URL: ${repository}. ` +
        `Only GitHub repositories are supported.`,
    );
  }

  let rootDir = destDir;
  try {
    logger.debug(`Attempting to download via GitHub Archive API for ${repository}@${ref}...`);
    const archiveUrl = `https://github.com/${gitHubInfo.owner}/${gitHubInfo.repo}/archive/${ref}.zip`;
    const archivePath = await downloadUtils.downloadToTmp(archiveUrl);
    logger.debug(`Downloaded archive to ${archivePath}, unzipping...`);

    await unzipModule.unzip(archivePath, destDir);

    // GitHub archives usually wrap content in a top-level directory (e.g. repo-ref).
    // We need to find it and use it as the root.
    const files = fs.readdirSync(destDir);

    if (files.length === 1 && fs.statSync(path.join(destDir, files[0])).isDirectory()) {
      rootDir = path.join(destDir, files[0]);
      logger.debug(`Found top-level directory in archive: ${files[0]}`);
    }
  } catch (err: unknown) {
    throw new FirebaseError(
      `Failed to download GitHub archive for ${repository}@${ref}. ` +
        `Make sure the repository is public and the ref exists. ` +
        `Private repositories are not supported via this method.`,
      { original: err as Error },
    );
  }

  const sourceDir = subDir
    ? resolveWithin(
        rootDir,
        subDir,
        `Subdirectory '${subDir}' in remote source must not escape the repository root.`,
      )
    : rootDir;

  if (subDir && !dirExistsSync(sourceDir)) {
    throw new FirebaseError(`Directory '${subDir}' not found in repository ${repository}@${ref}`);
  }

  const origin = `${repository}@${ref}${subDir ? `/${subDir}` : ""}`;
  logLabeledBullet("functions", `downloaded remote source (${origin})`);