Skip to content

escape shell metacharacters #640

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 6, 2025
Merged

escape shell metacharacters #640

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0f1e87b
escape shell metacharacters
vicb May 6, 2025
e35d679
fixup!
vicb May 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/deep-nails-behave.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@opennextjs/cloudflare": patch
---

fix: escape shell arguments when populating the cache
33 changes: 26 additions & 7 deletions packages/cloudflare/src/cli/commands/populate-cache.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ async function populateR2IncrementalCache(

runWrangler(
options,
["r2 object put", JSON.stringify(path.join(bucket, cacheKey)), `--file ${JSON.stringify(fullPath)}`],
["r2 object put", quoteShellMeta(path.join(bucket, cacheKey)), `--file ${quoteShellMeta(fullPath)}`],
// NOTE: R2 does not support the environment flag and results in the following error:
// Incorrect type for the 'cacheExpiry' field on 'HttpMetadata': the provided value is not of type 'date'.
{ target: populateCacheOptions.target, excludeRemoteFlag: true, logging: "error" }
Expand Down Expand Up @@ -168,11 +168,10 @@ async function populateKVIncrementalCache(

writeFileSync(chunkPath, JSON.stringify(kvMapping));

runWrangler(
options,
["kv bulk put", JSON.stringify(chunkPath), `--binding ${JSON.stringify(KV_CACHE_BINDING_NAME)}`],
{ ...populateCacheOptions, logging: "error" }
);
runWrangler(options, ["kv bulk put", quoteShellMeta(chunkPath), `--binding ${KV_CACHE_BINDING_NAME}`], {
...populateCacheOptions,
logging: "error",
});

rmSync(chunkPath);
}
Expand All @@ -197,7 +196,7 @@ function populateD1TagCache(
options,
[
"d1 execute",
JSON.stringify(D1_TAG_BINDING_NAME),
D1_TAG_BINDING_NAME,
`--command "CREATE TABLE IF NOT EXISTS revalidations (tag TEXT NOT NULL, revalidatedAt INTEGER NOT NULL, UNIQUE(tag) ON CONFLICT REPLACE);"`,
],
{ ...populateCacheOptions, logging: "error" }
Expand Down Expand Up @@ -258,3 +257,23 @@ export async function populateCache(
}
}
}

/**
* Escape shell metacharacters.
*
* When `spawnSync` is invoked with `shell: true`, metacharacters need to be escaped.
*
* Based on https://github.com/ljharb/shell-quote/blob/main/quote.js
*
* @param arg
* @returns escaped arg
*/
function quoteShellMeta(arg: string) {
if (/["\s]/.test(arg) && !/'/.test(arg)) {
return `'${arg.replace(/(['\\])/g, "\\$1")}'`;
}
if (/["'\s]/.test(arg)) {
return `"${arg.replace(/(["\\$`!])/g, "\\$1")}"`;
}
return arg.replace(/([A-Za-z]:)?([#!"$&'()*,:;<=>?@[\\\]^`{|}])/g, "$1\\$2");
}