Downgrade archiver to restore Jest CJS compatibility (#1366)

Author: cristianrgreco

.github/workflows/checks.yml

@@ -141,6 +141,10 @@ jobs:
         run: node packages/testcontainers/smoke-test.mjs
         env:
           DEBUG: "testcontainers*"
+      - name: Run Jest CommonJS runtime smoke test
+        run: npm exec --yes --package jest@30.4.2 -- jest --testMatch "**/smoke-test.jest.js" --runInBand --no-cache
+        env:
+          DEBUG: "testcontainers*"
 
   test:
     if: ${{ needs.detect-modules.outputs.modules_count != '0' }}

package-lock.json

@@ -32,7 +32,7 @@
   "dependencies": {
     "@balena/dockerignore": "^1.0.2",
     "@types/dockerode": "^4.0.1",
-    "archiver": "^8.0.0",
+    "archiver": "^7.0.1",
     "async-lock": "^1.4.1",
     "byline": "^5.0.0",
     "debug": "^4.4.3",
@@ -47,7 +47,7 @@
     "undici": "^8.3.0"
   },
   "devDependencies": {
-    "@types/archiver": "^8.0.0",
+    "@types/archiver": "^7.0.0",
     "@types/async-lock": "^1.4.2",
     "@types/byline": "^4.2.36",
     "@types/debug": "^4.1.13",

packages/testcontainers/package.json

@@ -0,0 +1,14 @@
+const { GenericContainer } = require("./build/index");
+
+jest.setTimeout(120_000);
+
+test("starts a container under Jest CommonJS runtime", async () => {
+  let container;
+  try {
+    container = await new GenericContainer("alpine:3.12")
+      .withCommand(["sleep", "infinity"])
+      .start();
+  } finally {
+    await container?.stop();
+  }
+});

packages/testcontainers/smoke-test.jest.js

@@ -1,4 +1,4 @@
-import { TarArchive, type EntryData } from "archiver";
+import archiver from "archiver";
 import getPort from "get-port";
 import path from "path";
 import { RandomUuid } from "../common";
@@ -521,8 +521,8 @@ describe("GenericContainer", { timeout: 180_000 }, () => {
         .withExposedPorts(8080)
         .start();
 
-      const tar = new TarArchive();
-      tar.append("hello world", { name: targetWithCopyOwnership.slice(1), uid, gid } as EntryData);
+      const tar = archiver("tar");
+      tar.append("hello world", { name: targetWithCopyOwnership.slice(1), uid, gid } as archiver.EntryData);
       tar.finalize();
 
       await container.copyArchiveToContainer(tar, "/", { copyUIDGID: true });
@@ -536,8 +536,8 @@ describe("GenericContainer", { timeout: 180_000 }, () => {
       const uid = 4242;
       const gid = 4343;
       const targetWithCopyOwnership = "/tmp/with-copy-archives-copyuidgid.txt";
-      const tar = new TarArchive();
-      tar.append("hello world", { name: targetWithCopyOwnership.slice(1), uid, gid } as EntryData);
+      const tar = archiver("tar");
+      tar.append("hello world", { name: targetWithCopyOwnership.slice(1), uid, gid } as archiver.EntryData);
       tar.finalize();
 
       await using containerWithCopyOwnership = await new GenericContainer("cristianrgreco/testcontainer:1.1.14")

packages/testcontainers/src/generic-container/generic-container.test.ts

@@ -1,4 +1,4 @@
-import { TarArchive, type Archiver } from "archiver";
+import archiver from "archiver";
 import AsyncLock from "async-lock";
 import { Container, ContainerCreateOptions, ContainerInspectInfo, HostConfig } from "dockerode";
 import { promises as fs } from "fs";
@@ -275,8 +275,8 @@ export class GenericContainer implements TestContainer {
     }
   }
 
-  private async createArchiveToCopyToContainer(): Promise<Archiver> {
-    const tar = new TarArchive();
+  private async createArchiveToCopyToContainer(): Promise<archiver.Archiver> {
+    const tar = archiver("tar");
     const filesToCopyWithStats = await Promise.all(
       this.filesToCopy.map(async (fileToCopy) => ({
         ...fileToCopy,

packages/testcontainers/src/generic-container/generic-container.ts

@@ -1,4 +1,4 @@
-import { TarArchive } from "archiver";
+import archiver from "archiver";
 import AsyncLock from "async-lock";
 import Dockerode, { ContainerInspectInfo } from "dockerode";
 import { promises as fs } from "fs";
@@ -192,7 +192,7 @@ export class StartedGenericContainer implements StartedTestContainer {
   public async copyFilesToContainer(filesToCopy: FileToCopy[]): Promise<void> {
     log.debug(`Copying files to container...`, { containerId: this.container.id });
     const client = await getContainerRuntimeClient();
-    const tar = new TarArchive();
+    const tar = archiver("tar");
     const filesToCopyWithStats = await Promise.all(
       filesToCopy.map(async (fileToCopy) => ({
         ...fileToCopy,
@@ -208,7 +208,7 @@ export class StartedGenericContainer implements StartedTestContainer {
   public async copyDirectoriesToContainer(directoriesToCopy: DirectoryToCopy[]): Promise<void> {
     log.debug(`Copying directories to container...`, { containerId: this.container.id });
     const client = await getContainerRuntimeClient();
-    const tar = new TarArchive();
+    const tar = archiver("tar");
     directoriesToCopy.forEach(({ source, target }) => tar.directory(source, target));
     tar.finalize();
     await client.container.putArchive(this.container, tar, "/");
@@ -218,7 +218,7 @@ export class StartedGenericContainer implements StartedTestContainer {
   public async copyContentToContainer(contentsToCopy: ContentToCopy[]): Promise<void> {
     log.debug(`Copying content to container...`, { containerId: this.container.id });
     const client = await getContainerRuntimeClient();
-    const tar = new TarArchive();
+    const tar = archiver("tar");
     contentsToCopy.forEach(({ content, target, mode }) => tar.append(content, { name: target, mode: mode }));
     tar.finalize();
     await client.container.putArchive(this.container, tar, "/");