containerify 3.2.1 → 3.3.2

package/lib/appLayerCreator.d.ts

@@ -1,5 +1,5 @@
-import { Options } from "./types";
-declare function addLayers(tmpdir: string, fromdir: string, todir: string, options: Options): Promise<void>;
+import { ManifestDescriptor, Options } from "./types";
+declare function addLayers(tmpdir: string, fromdir: string, todir: string, options: Options): Promise<ManifestDescriptor>;
 declare const _default: {
     addLayers: typeof addLayers;
 };

package/lib/appLayerCreator.js

@@ -22,39 +22,25 @@ const utils_1 = require("./utils");
 const version_1 = require("./version");
 const depLayerPossibles = ["package.json", "package-lock.json", "node_modules"];
 const ignore = [".git", ".gitignore", ".npmrc", ".DS_Store", "npm-debug.log", ".svn", ".hg", "CVS"];
-function statCache(layerOwner) {
+function createOnWriteEntry(layerOwner) {
     if (!layerOwner)
-        return null;
-    // We use the stat cache to overwrite uid and gid in image.
-    // A bit hacky
-    const statCacheMap = new Map();
-    const a = layerOwner.split(":");
-    const gid = parseInt(a[0]);
-    const uid = parseInt(a[1]);
-    return {
-        get: function (name) {
-            if (statCacheMap.has(name))
-                return statCacheMap.get(name);
-            const stat = fss.statSync(name);
-            stat.uid = uid;
-            stat.gid = gid;
-            stat.atime = new Date(0);
-            stat.mtime = new Date(0);
-            stat.ctime = new Date(0);
-            stat.birthtime = new Date(0);
-            stat.atimeMs = 0;
-            stat.mtimeMs = 0;
-            stat.ctimeMs = 0;
-            stat.birthtimeMs = 0;
-            statCacheMap.set(name, stat);
-            return stat;
-        },
-        set: function (name, stat) {
-            statCacheMap.set(name, stat);
-        },
-        has: function () {
-            return true;
-        },
+        return undefined;
+    // We use onWriteEntry to overwrite uid and gid in the tar archive
+    // Format is already validated in cli.ts to be "gid:uid"
+    const parts = layerOwner.split(":");
+    const gid = parseInt(parts[0], 10);
+    const uid = parseInt(parts[1], 10);
+    return (entry) => {
+        if (entry.header) {
+            entry.header.uid = uid;
+            entry.header.gid = gid;
+            entry.header.uname = "";
+            entry.header.gname = "";
+            // Set all timestamps to epoch to match original behavior
+            entry.header.atime = new Date(0);
+            entry.header.mtime = new Date(0);
+            entry.header.ctime = new Date(0);
+        }
     };
 }
 const tarDefaultConfig = {
@@ -127,7 +113,7 @@ function addDataLayer(tmpdir, todir, options, config, manifest, files, comment)
                 comment +
                 (comment == "dependencies" ? ". Did you forget to run npm install?" : ""));
         }
-        yield tar.create(Object.assign(Object.assign({}, tarDefaultConfig), Object.assign({ statCache: statCache(options.layerOwner), portable: !options.layerOwner, prefix: "/", cwd: buildDir, file: layerFile, gzip: true, noMtime: !(options.setTimeStamp || options.preserveTimeStamp) }, (options.setTimeStamp ? { mtime: new Date(options.setTimeStamp) } : {}))), filesToTar);
+        yield tar.create(Object.assign(Object.assign({}, tarDefaultConfig), Object.assign({ onWriteEntry: createOnWriteEntry(options.layerOwner), portable: !options.layerOwner, prefix: "/", cwd: buildDir, file: layerFile, gzip: true, noMtime: !(options.setTimeStamp || options.preserveTimeStamp) }, (options.setTimeStamp ? { mtime: new Date(options.setTimeStamp) } : {}))), filesToTar);
         const fhash = yield calculateHash(layerFile);
         const finalName = path.join(todir, fhash + ".tar.gz");
         yield fse.move(layerFile, finalName);
@@ -253,7 +239,14 @@ function addLayers(tmpdir, fromdir, todir, options) {
         yield fs_1.promises.writeFile(configFile, configContent);
         manifest.config.digest = "sha256:" + configHash;
         manifest.config.size = yield fileutil.sizeOf(configFile);
-        yield fs_1.promises.writeFile(path.join(todir, "manifest.json"), JSON.stringify(manifest));
+        const manifestJson = JSON.stringify(manifest);
+        yield fs_1.promises.writeFile(path.join(todir, "manifest.json"), manifestJson);
+        const manifestBuffer = Buffer.from(manifestJson, "utf-8");
+        return {
+            mediaType: manifest.mediaType,
+            digest: calculateHashOfBuffer(manifestBuffer),
+            size: manifestBuffer.byteLength,
+        };
     });
 }
 exports.default = {

package/lib/cli.js

@@ -61,6 +61,7 @@ program
     .option("--layerOwner <gid:uid>", "Optional: Set specific gid and uid on files in the added layers")
     .option("--buildFolder <path>", "Optional: Use a specific build folder when creating the image")
     .option("--layerCacheFolder <path>", "Optional: Folder to cache base layers between builds")
+    .option("--writeDigestTo <path>", "Optional: Write the resulting image digest to the file path provided")
     .version(version_1.VERSION, "--version", "Get containerify version");
 program.parse(process.argv);
 function setKeyValue(target, keyValue, separator = "=", defaultValue) {
@@ -96,7 +97,6 @@ const labels = Object.assign(Object.assign({}, configFromFile.labels), labelsOpt
 const envOpt = {};
 (_b = cliOptions.envs) === null || _b === void 0 ? void 0 : _b.forEach((envs) => envs.split(",").forEach((env) => setKeyValue(envOpt, env)));
 const envs = Object.assign(Object.assign({}, configFromFile.envs), envOpt); //Let cli arguments override file
-console.log(envs);
 const customContent = {};
 (_c = configFromFile.customContent) === null || _c === void 0 ? void 0 : _c.forEach((c) => setKeyValue(customContent, c, ":", c));
 (_d = cliOptions.customContent) === null || _d === void 0 ? void 0 : _d.forEach((contents) => contents.split(",").forEach((content) => setKeyValue(customContent, content, ":", content)));
@@ -118,7 +118,7 @@ const options = Object.assign(Object.assign(Object.assign({}, defaultOptions), s
         user: setOptions.user,
         workdir: setOptions.workdir,
         entrypoint: setOptions.entrypoint,
-    } });
+    }, writeDigestTo: cliOptions.writeDigestTo });
 function exitWithErrorIf(check, error) {
     if (check) {
         logger_1.default.error("ERROR: " + error);
@@ -214,7 +214,7 @@ function run(options) {
         const fromRegistryUrl = (_a = options.fromRegistry) !== null && _a !== void 0 ? _a : registry_1.DEFAULT_DOCKER_REGISTRY;
         const fromRegistry = yield (0, registry_1.createRegistry)(fromRegistryUrl, options.fromImage, allowInsecure, options.fromToken);
         const originalManifest = yield fromRegistry.download(options.fromImage, fromdir, (0, utils_1.getPreferredPlatform)(options.platform), options.layerCacheFolder);
-        yield appLayerCreator_1.default.addLayers(tmpdir, fromdir, todir, options);
+        const manifestDescriptor = yield appLayerCreator_1.default.addLayers(tmpdir, fromdir, todir, options);
         if (options.toDocker) {
             if (!(yield dockerExporter_1.default.isAvailable())) {
                 throw new Error("Docker executable not found on path. Unable to export to local docker registry.");
@@ -233,6 +233,10 @@ function run(options) {
         logger_1.default.debug(`Deleting ${tmpdir} ...`);
         yield fse.remove(tmpdir);
         logger_1.default.debug("Done");
+        if (options.writeDigestTo) {
+            logger_1.default.debug(`Writing digest ${manifestDescriptor.digest} to ${options.writeDigestTo}`);
+            fs.writeFileSync(options.writeDigestTo, manifestDescriptor.digest);
+        }
     });
 }
 logger_1.default.debug("Running with config:", options);

package/lib/httpRequest.js

@@ -20,7 +20,6 @@ exports.dlJson = dlJson;
 exports.followRedirects = followRedirects;
 const https = require("https");
 const http = require("http");
-const URL = require("url");
 const logger_1 = require("./logger");
 const types_1 = require("./types");
 exports.redirectCodes = [308, 307, 303, 302, 301];
@@ -28,9 +27,15 @@ function isOk(httpStatus) {
     return httpStatus >= 200 && httpStatus < 300;
 }
 function createHttpOptions(method, url, headers) {
-    const options = Object.assign({}, URL.parse(url));
-    options.headers = headers;
-    options.method = method;
+    const parsedUrl = new URL(url);
+    const options = {
+        protocol: parsedUrl.protocol,
+        hostname: parsedUrl.hostname,
+        port: parsedUrl.port,
+        path: parsedUrl.pathname + parsedUrl.search,
+        headers: headers,
+        method: method,
+    };
     if (url.includes("X-Amz-Algorithm") && method == "GET") {
         //We are using a pre-signed URL, so we don't need to send the Authorization header
         options.headers["Authorization"] = "";
@@ -101,7 +106,6 @@ function followRedirects(uri, headers, allowInsecure, cb, count = 0) {
             if (count > 10)
                 return cb({ error: "Too many redirects for " + uri });
             const location = res.headers.location;
-            console.log(res.headers);
             if (!location)
                 return cb({ error: "Redirect, but missing location header" });
             return followRedirects(location, headers, allowInsecure, cb, count + 1);

package/lib/registry.js

@@ -12,7 +12,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DEFAULT_DOCKER_REGISTRY = void 0;
 exports.createRegistry = createRegistry;
 exports.parseFullImageUrl = parseFullImageUrl;
-const URL = require("url");
 const fss = require("fs");
 const fs_1 = require("fs");
 const path = require("path");
@@ -130,7 +129,7 @@ function uploadContent(uploadUrl, file, fileConfig, allowInsecure, auth, content
 }
 function processToken(registryBaseUrl, allowInsecure, imagePath, token) {
     return __awaiter(this, void 0, void 0, function* () {
-        const { hostname } = new URL.URL(registryBaseUrl);
+        const { hostname } = new URL(registryBaseUrl);
         const image = (0, utils_1.parseImage)(imagePath);
         if ((hostname === null || hostname === void 0 ? void 0 : hostname.endsWith(".docker.io")) && !token)
             return getDockerToken(image.path, allowInsecure);
@@ -182,8 +181,14 @@ function createRegistry(registryBaseUrl_1, imagePath_1, allowInsecure_1, auth_1)
                 return new Promise((resolve, reject) => {
                     const parameters = new URLSearchParams(mountParameters);
                     const url = `${registryBaseUrl}${image.path}/blobs/uploads/${parameters.size > 0 ? "?" + parameters : ""}`;
-                    const options = URL.parse(url);
-                    options.method = "POST";
+                    const parsedUrl = new URL(url);
+                    const options = {
+                        protocol: parsedUrl.protocol,
+                        hostname: parsedUrl.hostname,
+                        port: parsedUrl.port,
+                        path: parsedUrl.pathname + parsedUrl.search,
+                        method: "POST",
+                    };
                     if (token)
                         options.headers = { authorization: token };
                     (0, httpRequest_1.request)(options, allowInsecure, (res) => {
@@ -195,7 +200,7 @@ function createRegistry(registryBaseUrl_1, imagePath_1, allowInsecure_1, auth_1)
                                     resolve({ uploadUrl: location });
                                 }
                                 else {
-                                    const regURL = URL.parse(registryBaseUrl);
+                                    const regURL = new URL(registryBaseUrl);
                                     resolve({
                                         uploadUrl: `${regURL.protocol}//${regURL.hostname}${regURL.port ? ":" + regURL.port : ""}${location}`,
                                     });

package/lib/types.d.ts

@@ -91,6 +91,7 @@ export type Options = {
         workdir?: string;
         entrypoint?: string;
     };
+    writeDigestTo?: string;
 };
 export declare enum InsecureRegistrySupport {
     NO = 0,
@@ -101,4 +102,5 @@ export type Registry = {
     upload: (imageStr: string, folder: string, doCrossMount: boolean, originalManifest: Manifest, originalRepository: string) => Promise<void>;
     registryBaseUrl: string;
 };
+export type ManifestDescriptor = Descriptor;
 export {};

package/lib/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "3.2.1";
+export declare const VERSION = "3.3.2";

package/lib/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = "3.2.1";
+exports.VERSION = "3.3.2";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "containerify",
-	"version": "3.2.1",
+	"version": "3.3.2",
 	"description": "Build node.js docker images without docker",
 	"main": "./lib/cli.js",
 	"scripts": {
@@ -37,8 +37,8 @@
 	],
 	"dependencies": {
 		"commander": "^13.1.0",
-		"fs-extra": "^11.3.0",
-		"tar": "^6.2.1"
+		"fs-extra": "^11.3.2",
+		"tar": "^7.5.7"
 	},
 	"devDependencies": {
 		"@eslint/eslintrc": "^3.3.1",