fix: update snapshot for error test

chore: bump dependencies

.changeset/weak-lobsters-march.md

@@ -0,0 +1,9 @@
+---
+"wrangler-action": patch
+---
+
+Fixes issues with semver comparison, where version parts were treated lexicographically instead of numerically.
+
+Bulk secret uploading was introduced in wrangler `3.4.0`, and this action tries to check if the version used is greater than `3.4.0`, and then if so, using the new bulk secret API which is faster. Due to a bug in the semver comparison, `3.19.0` was being considered less than `3.4.0`, and then using an older and slower method for uploading secrets.
+
+Now the semver comparison is fixed, the faster bulk method is used for uploading secrets when available.

.github/workflows/release.yml

@@ -20,6 +20,9 @@ jobs:
     steps:
       - name: Checkout Repo
         uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          fetch-tags: true
 
       - name: Setup Node.js
         uses: actions/setup-node@v3

README.md

@@ -31,14 +31,14 @@ jobs:
       - name: Deploy
         uses: cloudflare/wrangler-action@v3
         with:
-          apiToken: ${{ secrets.CF_API_TOKEN }}
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
 ```
 
 ## Authentication
 
 You'll need to configure Wrangler using GitHub's Secrets feature - go to "Settings -> Secrets" and add your Cloudflare API token (for help finding this, see the [Workers documentation](https://developers.cloudflare.com/workers/quickstart/#api-token)). Your API token is encrypted by GitHub, and the action won't print it into logs, so it should be safe!
 
-With your API token set as a secret for your repository, pass it to the action in the `with` block of your workflow. Below, I've set the secret name to `CF_API_TOKEN`:
+With your API token set as a secret for your repository, pass it to the action in the `with` block of your workflow. Below, I've set the secret name to `CLOUDFLARE_API_TOKEN`:
 
 ```yaml
 jobs:
@@ -47,7 +47,7 @@ jobs:
     steps:
       uses: cloudflare/wrangler-action@v3
       with:
-        apiToken: ${{ secrets.CF_API_TOKEN }}
+        apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
 ```
 
 ## Configuration
@@ -60,7 +60,7 @@ jobs:
     steps:
       uses: cloudflare/wrangler-action@v3
       with:
-        apiToken: ${{ secrets.CF_API_TOKEN }}
+        apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
         wranglerVersion: "2.20.0"
 ```
 
@@ -72,7 +72,7 @@ jobs:
     steps:
       uses: cloudflare/wrangler-action@v3
       with:
-        apiToken: ${{ secrets.CF_API_TOKEN }}
+        apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
         workingDirectory: "subfoldername"
 ```
 
@@ -84,7 +84,7 @@ jobs:
     steps:
       uses: cloudflare/wrangler-action@v3
       with:
-        apiToken: ${{ secrets.CF_API_TOKEN }}
+        apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
         secrets: |
           SECRET1
           SECRET2
@@ -101,7 +101,7 @@ jobs:
     steps:
       uses: cloudflare/wrangler-action@v3
       with:
-        apiToken: ${{ secrets.CF_API_TOKEN }}
+        apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
         preCommands: echo "*** pre command ***"
         postCommands: |
           echo "*** post commands ***"
@@ -117,7 +117,7 @@ jobs:
     steps:
       uses: cloudflare/wrangler-action@v3
       with:
-        apiToken: ${{ secrets.CF_API_TOKEN }}
+        apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
         command: whoami
 ```
 
@@ -142,7 +142,7 @@ jobs:
       - name: Deploy
         uses: cloudflare/wrangler-action@v3
         with:
-          apiToken: ${{ secrets.CF_API_TOKEN }}
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
 ```
 
 Note that there are a number of possible events, like `push`, that can be used to trigger a workflow. For more details on the events available, refer to the [GitHub Actions documentation](https://help.github.com/en/articles/workflow-syntax-for-github-actions#on).
@@ -163,8 +163,8 @@ jobs:
       - name: Deploy
         uses: cloudflare/wrangler-action@v3
         with:
-          apiToken: ${{ secrets.CF_API_TOKEN }}
-          accountId: ${{ secrets.CF_ACCOUNT_ID }}
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
           command: pages deploy --project-name=example
 ```
 
@@ -186,7 +186,7 @@ jobs:
       - name: Deploy app
         uses: cloudflare/wrangler-action@v3
         with:
-          apiToken: ${{ secrets.CF_API_TOKEN }}
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
 ```
 
 If you need help defining the correct cron syntax, check out [crontab.guru](https://crontab.guru/), which provides a friendly user interface for validating your cron schedule.
@@ -212,7 +212,7 @@ jobs:
       - name: Deploy app
         uses: cloudflare/wrangler-action@v3
         with:
-          apiToken: ${{ secrets.CF_API_TOKEN }}
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
           command: deploy --env ${{ github.event.inputs.environment }}
 ```
 
@@ -240,6 +240,6 @@ jobs:
       - name: Deploy app
         uses: cloudflare/wrangler-action@v3
         with:
-          apiToken: ${{ secrets.CF_API_TOKEN }}
-          accountId: ${{ secrets.CF_ACCOUNT_ID }}
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
 ```

package.json

@@ -29,17 +29,18 @@
 		"check": "prettier --check ."
 	},
 	"dependencies": {
-		"@actions/core": "^1.10.0",
+		"@actions/core": "^1.10.1",
 		"@actions/exec": "^1.1.1"
 	},
 	"devDependencies": {
 		"@changesets/changelog-github": "^0.4.8",
 		"@changesets/cli": "^2.26.2",
-		"@cloudflare/workers-types": "^4.20230814.0",
-		"@types/node": "^20.5.0",
-		"@vercel/ncc": "^0.36.1",
-		"prettier": "^3.0.1",
-		"typescript": "^5.1.6",
-		"vitest": "^0.34.1"
+		"@cloudflare/workers-types": "^4.20231121.0",
+		"@types/node": "^20.10.4",
+		"@vercel/ncc": "^0.38.1",
+		"prettier": "^3.1.0",
+		"semver": "^7.5.4",
+		"typescript": "^5.3.3",
+		"vitest": "^1.0.3"
 	}
 }

src/utils.test.ts

@@ -26,7 +26,30 @@ describe("checkWorkingDirectory", () => {
 		expect(() =>
 			checkWorkingDirectory("/does/not/exist"),
 		).toThrowErrorMatchingInlineSnapshot(
-			'"Directory /does/not/exist does not exist."',
+			`[Error: Directory /does/not/exist does not exist.]`,
 		);
 	});
 });
+
+describe("semverCompare", () => {
+	test.each([
+		["1.2.3", "1.2.3", false],
+		["1.2.2", "1.2.3", true],
+		["2.0.0", "3.0.0", true],
+		["3.1.0", "3.1.1", true],
+		["3.1.0", "3.5.0", true],
+		["3.1.0", "3.10.0", true],
+		["3.1.0", "3.15.0", true],
+		["3.10.0", "3.1.0", false],
+		["3.20.0", "3.2.0", false],
+		["3.1.0", "latest", true],
+		["4.0.0", "latest", true],
+	])(
+		"should semver compare %s vs %s correctly, expecting %s",
+		(version1, version2, expected) => {
+			const isVersion1LessThanVersion2 = semverCompare(version1, version2);
+
+			expect(isVersion1LessThanVersion2).toBe(expected);
+		},
+	);
+});

src/utils.ts

@@ -1,5 +1,6 @@
 import { existsSync } from "node:fs";
 import * as path from "node:path";
+import semverGt from "semver/functions/gt";
 
 /**
  * A helper function to compare two semver versions. If the second arg is greater than the first arg, it returns true.
@@ -7,18 +8,7 @@ import * as path from "node:path";
 export function semverCompare(version1: string, version2: string) {
 	if (version2 === "latest") return true;
 
-	const version1Parts = version1.split(".");
-	const version2Parts = version2.split(".");
-
-	for (const version1Part of version1Parts) {
-		const version2Part = version2Parts.shift();
-
-		if (version1Part !== version2Part && version2Part) {
-			return version1Part < version2Part ? true : false;
-		}
-	}
-
-	return false;
+	return semverGt(version2, version1);
 }
 
 export function checkWorkingDirectory(workingDirectory = ".") {