Merge pull request #6247 from Shopify/package-fix

Fix theme package folder structure

Author: EvilGenius13

packages/cli-kit/src/public/node/archiver.integration.test.ts

@@ -26,7 +26,8 @@ describe('zip', () => {
 
       // Then
       const archiveEntries = await readArchiveFiles(zipPath)
-      expect(structure.sort()).toEqual(archiveEntries.sort())
+      const expectedEntries = ['extensions/', 'extensions/first/', 'extensions/first/main.js', 'test.json']
+      expect(expectedEntries.sort()).toEqual(archiveEntries.sort())
     })
   })
 
@@ -49,7 +50,11 @@ describe('zip', () => {
 
       // Then
       const archiveEntries = await readArchiveFiles(zipPath)
-      expect([`extensions/first/main.js`]).toEqual(archiveEntries)
+
+      expect(archiveEntries).toContain('extensions/')
+      expect(archiveEntries).toContain('extensions/first/')
+      const expectedEntries = ['extensions/', 'extensions/first/', 'extensions/first/main.js']
+      expect(expectedEntries.sort()).toEqual(archiveEntries.sort())
     })
   })
 })

packages/cli-kit/src/public/node/archiver.ts

@@ -1,4 +1,4 @@
-import {relativePath, joinPath} from './path.js'
+import {relativePath, joinPath, dirname} from './path.js'
 import {glob, removeFile} from './fs.js'
 import {outputDebug, outputContent, outputToken} from '../../public/node/output.js'
 import archiver from 'archiver'
@@ -52,16 +52,38 @@ export async function zip(options: ZipOptions): Promise<void> {
     })
     archive.pipe(output)
 
+    const directoriesToAdd = new Set<string>()
     for (const filePath of pathsToZip) {
       const fileRelativePath = relativePath(inputDirectory, filePath)
-      archive.file(filePath, {name: fileRelativePath})
+      collectParentDirectories(fileRelativePath, directoriesToAdd)
+    }
+
+    const sortedDirs = Array.from(directoriesToAdd).sort((left, right) => left.localeCompare(right))
+    for (const dir of sortedDirs) {
+      const dirName = dir.endsWith('/') ? dir : `${dir}/`
+      archive.append(Buffer.alloc(0), {name: dirName})
+    }
+
+    for (const filePath of pathsToZip) {
+      const fileRelativePath = relativePath(inputDirectory, filePath)
+      if (filePath && fileRelativePath) archive.file(filePath, {name: fileRelativePath})
     }
 
     // eslint-disable-next-line @typescript-eslint/no-floating-promises
     archive.finalize()
   })
 }
 
+function collectParentDirectories(fileRelativePath: string, accumulator: Set<string>): void {
+  let currentDir = dirname(fileRelativePath)
+  while (currentDir && currentDir !== '.' && currentDir !== '/') {
+    accumulator.add(currentDir)
+    const parent = dirname(currentDir)
+    if (parent === currentDir) break
+    currentDir = parent
+  }
+}
+
 export interface BrotliOptions {
   /**
    * The directory to compress.
@@ -133,7 +155,7 @@ export async function brotliCompress(options: BrotliOptions): Promise<void> {
           // eslint-disable-next-line @typescript-eslint/no-floating-promises
           archive.finalize()
         })
-        .catch((error) => reject(error))
+        .catch((error) => reject(error instanceof Error ? error : new Error(String(error))))
     })
 
     const tarContent = readFileSync(tempTarPath)

packages/theme/src/cli/services/package.test.ts

@@ -191,7 +191,10 @@ async function readArchiveFiles(zipPath: string) {
   await expect(fileExists(zipPath)).resolves.toBeTruthy()
   // eslint-disable-next-line @babel/new-cap
   const archive = new StreamZip.async({file: zipPath})
-  const archiveEntries = Object.keys(await archive.entries())
+  const entries = await archive.entries()
+  const archiveEntries = Object.values(entries)
+    .filter((entry: any) => !entry.isDirectory)
+    .map((entry: any) => entry.name)
   await archive.close()
 
   return archiveEntries