import { dirname as pathDirname, basename as pathBasename, join as pathJoin, join } from "path"; import { createReadStream, createWriteStream } from "fs"; import { stat, mkdir, unlink, writeFile } from "fs/promises"; import { transformCodebase } from "./transformCodebase"; import { createHash } from "crypto"; import fetch from "make-fetch-happen"; import { createInflateRaw } from "zlib"; import type { Readable } from "stream"; import { homedir } from "os"; import { FetchOptions } from "make-fetch-happen"; import { exec as execCallback } from "child_process"; import { promisify } from "util"; const exec = promisify(execCallback); function hash(s: string) { return createHash("sha256").update(s).digest("hex"); } async function maybeStat(path: string) { try { return await stat(path); } catch (error) { if ((error as Error & { code: string }).code === "ENOENT") return undefined; throw error; } } /** * Get an npm configuration value as string, undefined if not set. * * @param key * @returns string or undefined */ async function getNmpConfig(key: string): Promise { const { stdout } = await exec(`npm config get ${key}`); const value = stdout.trim(); return value && value !== "null" ? value : undefined; } /** * Get proxy configuration from npm config files. Note that we don't care about * proxy config in env vars, because make-fetch-happen will do that for us. * * @returns proxy configuration */ async function getNpmProxyConfig(): Promise> { const proxy = (await getNmpConfig("https-proxy")) ?? (await getNmpConfig("proxy")); const noProxy = (await getNmpConfig("noproxy")) ?? (await getNmpConfig("no-proxy")); return { proxy, noProxy }; } /** * Download a file from `url` to `dir`. Will try to avoid downloading existing * files by using the cache directory ~/.keycloakify/cache * * If the target directory does not exist, it will be created. * * If the target file exists, it will be overwritten. * * We use make-fetch-happen's internal file cache here, so we don't need to * worry about redownloading the same file over and over. Unfortunately, that * cache does not have a single file per entry, but bundles and indexes them, * so we still need to write the contents to the target directory (possibly * over and over), cause the current unzip implementation wants random access. * * @param url download url * @param dir target directory * @param filename target filename * @returns promise for the full path of the downloaded file */ async function download(url: string, dir: string, filename: string): Promise { const proxyOpts = await getNpmProxyConfig(); const cacheRoot = process.env.XDG_CACHE_HOME ?? homedir(); const cachePath = join(cacheRoot, ".keycloakify/cache"); const opts: FetchOptions = { cachePath, cache: 'force-cache', ...proxyOpts }; const response = await fetch(url, opts); const filepath = pathJoin(dir, filename); await mkdir(dir, { recursive: true }); await writeFile(filepath, response.body); return filepath; } /** * @typedef * @type MultiError = Error & { cause: Error[] } */ /** * Extract the archive `zipFile` into the directory `dir`. If `archiveDir` is given, * only that directory will be extracted, stripping the given path components. * * If dir does not exist, it will be created. * * If any archive file exists, it will be overwritten. * * Will unzip using all available nodejs worker threads. * * Will try to clean up extracted files on failure. * * If unpacking fails, will either throw an regular error, or * possibly an `MultiError`, which contains a `cause` field with * a number of root cause errors. * * Warning this method is not optimized for continuous reading of the zip * archive, but is a trade-off between simplicity and allowing extraction * of a single directory from the archive. * * @param zipFile the file to unzip * @param dir the target directory * @param archiveDir if given, unpack only files from this archive directory * @throws {MultiError} error * @returns Promise for a list of full file paths pointing to actually extracted files */ async function unzip(zipFile: string, dir: string, archiveDir?: string): Promise { await mkdir(dir, { recursive: true }); const promises: Promise[] = []; // Iterate over all files in the zip, skip files which are not in archiveDir, // if given. for await (const record of iterateZipArchive(zipFile)) { const { path: recordPath, createReadStream: createRecordReadStream } = record; const filePath = pathJoin(dir, recordPath); const parent = pathDirname(filePath); if (archiveDir && !recordPath.startsWith(archiveDir)) continue; promises.push( new Promise(async (resolve, reject) => { await mkdir(parent, { recursive: true }); // Pull the file out of the archive, write it to the target directory const input = createRecordReadStream(); const output = createWriteStream(filePath); output.setMaxListeners(Infinity); output.on("error", e => reject(Object.assign(e, { filePath }))); output.on("finish", () => resolve(filePath)); input.pipe(output); }) ); } // Wait until _all_ files are either extracted or failed const results = await Promise.allSettled(promises); const success = results.filter(r => r.status === "fulfilled").map(r => (r as PromiseFulfilledResult).value); const failure = results.filter(r => r.status === "rejected").map(r => (r as PromiseRejectedResult).reason); // If any extraction failed, try to clean up, then throw a MultiError, // which has a `cause` field, containing a list of root cause errors. if (failure.length) { await Promise.all(success.map(path => unlink(path))); await Promise.all(failure.map(e => e && e.path && unlink(e.path as string))); const e = new Error("Failed to extract: " + failure.map(e => e.message).join(";")); (e as any).cause = failure; throw e; } return success; } /** * * @param file file to read * @param start first byte to read * @param end last byte to read * @returns Promise of a buffer of read bytes */ async function readFileChunk(file: string, start: number, end: number): Promise { const chunks: Buffer[] = []; return new Promise((resolve, reject) => { const stream = createReadStream(file, { start, end }); stream.setMaxListeners(Infinity); stream.on("error", e => reject(e)); stream.on("end", () => resolve(Buffer.concat(chunks))); stream.on("data", chunk => chunks.push(chunk as Buffer)); }); } type ZipRecord = { path: string; createReadStream: () => Readable; compressionMethod: "deflate" | undefined; }; type ZipRecordGenerator = AsyncGenerator; /** * Iterate over all records of a zipfile, and yield a ZipRecord. * Use `record.createReadStream()` to actually read the file. * * Warning this method will only work with single-disk zip files. * Warning this method may fail if the zip archive has an crazy amount * of files and the central directory is not fully contained within the * last 65k bytes of the zip file. * * @param zipFile * @returns AsyncGenerator which will yield ZipRecords */ async function* iterateZipArchive(zipFile: string): ZipRecordGenerator { // Need to know zip file size before we can do anything else const { size } = await stat(zipFile); const chunkSize = 65_535 + 22 + 1; // max comment size + end header size + wiggle // Read last ~65k bytes. Zip files have an comment up to 65_535 bytes at the very end, // before that comes the zip central directory end header. let chunk = await readFileChunk(zipFile, size - chunkSize, size); const unread = size - chunk.length; let i = chunk.length - 4; let found = false; // Find central directory end header, reading backwards from the end while (!found && i-- > 0) if (chunk[i] === 0x50 && chunk.readUInt32LE(i) === 0x06054b50) found = true; if (!found) throw new Error("Not a zip file"); // This method will fail on a multi-disk zip, so bail early. if (chunk.readUInt16LE(i + 4) !== 0) throw new Error("Multi-disk zip not supported"); let nFiles = chunk.readUint16LE(i + 10); // Get the position of the central directory const directorySize = chunk.readUint32LE(i + 12); const directoryOffset = chunk.readUint32LE(i + 16); if (directoryOffset === 0xffff_ffff) throw new Error("zip64 not supported"); if (directoryOffset > size) throw new Error(`Central directory offset ${directoryOffset} is outside file`); i = directoryOffset - unread; // If i < 0, it means that the central directory is not contained within `chunk` if (i < 0) { chunk = await readFileChunk(zipFile, directoryOffset, directoryOffset + directorySize); i = 0; } // Now iterate the central directory records, yield an `ZipRecord` for every entry while (nFiles-- > 0) { // Check for marker bytes if (chunk.readUInt32LE(i) !== 0x02014b50) throw new Error("No central directory record at position " + (unread + i)); const compressionMethod = ({ 8: "deflate" } as const)[chunk.readUint16LE(i + 10)]; const compressedFileSize = chunk.readUint32LE(i + 20); const filenameLength = chunk.readUint16LE(i + 28); const extraLength = chunk.readUint16LE(i + 30); const commentLength = chunk.readUint16LE(i + 32); // Start of the actual content byte stream is after the 'local' record header, // which is 30 bytes long plus filename and extra field const start = chunk.readUint32LE(i + 42) + 30 + filenameLength + extraLength; const end = start + compressedFileSize; const filename = chunk.slice(i + 46, i + 46 + filenameLength).toString("utf-8"); const createRecordReadStream = () => { const input = createReadStream(zipFile, { start, end }); if (compressionMethod === "deflate") { const inflate = createInflateRaw(); input.pipe(inflate); return inflate; } return input; }; if (end > start) yield { path: filename, createReadStream: createRecordReadStream, compressionMethod }; // advance pointer to next central directory entry i += 46 + filenameLength + extraLength + commentLength; } } export async function downloadAndUnzip({ url, destDirPath, pathOfDirToExtractInArchive, cacheDirPath }: { isSilent: boolean; url: string; destDirPath: string; pathOfDirToExtractInArchive?: string; cacheDirPath: string; }) { const downloadHash = hash(JSON.stringify({ url, pathOfDirToExtractInArchive })).substring(0, 15); const extractDirPath = pathJoin(cacheDirPath, `_${downloadHash}`); const filename = pathBasename(url); const zipFilepath = await download(url, cacheDirPath, filename); const zipMtime = (await stat(zipFilepath)).mtimeMs; const unzipMtime = (await maybeStat(extractDirPath))?.mtimeMs; if (!unzipMtime || zipMtime > unzipMtime) await unzip(zipFilepath, extractDirPath, pathOfDirToExtractInArchive); const srcDirPath = pathOfDirToExtractInArchive === undefined ? extractDirPath : pathJoin(extractDirPath, pathOfDirToExtractInArchive); transformCodebase({ srcDirPath, destDirPath }); }