fix(release): stabilize Wrangler dry-run receipt

Author: ALikesToCode

scripts/create-deployment-receipt.test.ts

@@ -6,6 +6,7 @@ import {
   assertActiveWorkerReleaseBindings,
   assertDeploymentReceiptBindings,
   assertFrozenDryRunProjection,
+  hasExpectedDryRunShape,
   qualifiedContainerImage,
   selectQualifiedContainer,
 } from "./create-deployment-receipt";
@@ -42,6 +43,11 @@ const generationIsolationProbeSha256 =
 
 describe("deployment receipt frozen dry-run projection", () => {
   const workerBundleSha256 = "a".repeat(64);
+  const file = (name: string) => ({
+    name,
+    isFile: () => true,
+    isSymbolicLink: () => false,
+  });
 
   it("accepts exactly one byte-identical Worker bundle", () => {
     expect(() =>
@@ -53,6 +59,32 @@ describe("deployment receipt frozen dry-run projection", () => {
     ).not.toThrow();
   });
 
+  it("accepts the exact Wrangler files independent of directory order", () => {
+    const readme = file("README.md");
+    const worker = file("index.js");
+
+    expect(hasExpectedDryRunShape([readme, worker])).toBe(true);
+    expect(hasExpectedDryRunShape([worker, readme])).toBe(true);
+  });
+
+  it("rejects extra, non-file, and symbolic-link entries", () => {
+    const readme = file("README.md");
+    const worker = file("index.js");
+
+    expect(
+      hasExpectedDryRunShape([readme, worker, file("metadata.json")]),
+    ).toBe(false);
+    expect(
+      hasExpectedDryRunShape([readme, { ...worker, isFile: () => false }]),
+    ).toBe(false);
+    expect(
+      hasExpectedDryRunShape([
+        readme,
+        { ...worker, isSymbolicLink: () => true },
+      ]),
+    ).toBe(false);
+  });
+
   it("rejects changed Worker bytes and every non-singleton projection", () => {
     expect(() =>
       assertFrozenDryRunProjection({

scripts/create-deployment-receipt.ts

@@ -124,19 +124,29 @@ export function assertFrozenDryRunProjection(input: {
   }
 }
 
+type DryRunDirectoryEntry = {
+  name: string;
+  isFile: () => boolean;
+  isSymbolicLink: () => boolean;
+};
+
+export function hasExpectedDryRunShape(
+  entries: readonly DryRunDirectoryEntry[],
+): boolean {
+  const names = entries.map((entry) => entry.name).sort();
+  return (
+    JSON.stringify(names) === JSON.stringify(["README.md", "index.js"]) &&
+    entries.every((entry) => entry.isFile() && !entry.isSymbolicLink())
+  );
+}
+
 function dryRunWorkerHash(
   root: string,
   directory: string,
   expectedWorkerSha256: string,
 ) {
-  const entries = readdirSync(directory, { withFileTypes: true }).sort(
-    (left, right) => left.name.localeCompare(right.name),
-  );
-  if (
-    JSON.stringify(entries.map((entry) => entry.name)) !==
-      JSON.stringify(["README.md", "index.js"]) ||
-    entries.some((entry) => !entry.isFile() || entry.isSymbolicLink())
-  ) {
+  const entries = readdirSync(directory, { withFileTypes: true });
+  if (!hasExpectedDryRunShape(entries)) {
     throw new Error("Wrangler dry-run output has an unexpected shape");
   }
   const workerPath = resolve(directory, "index.js");