Skip to content

Reject empty or whitespace-only configKey values in include_assets builds #7530

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

Open
JoshuaWhite1 wants to merge 1 commit into
base: main
Choose a base branch
from
+47 −0
Open

Reject empty or whitespace-only configKey values in include_assets builds #7530

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
40 changes: 40 additions & 0 deletions packages/app/src/cli/services/build/steps/include-assets/copy-config-key-entry.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,4 +316,44 @@ describe('copyConfigKeyEntry', () => {
await expect(fileExists(joinPath(outDir, 'tools.json'))).resolves.toBe(true)
})
})

describe('value guard', () => {
test('throws when value is an empty string', async () => {
await inTemporaryDirectory(async (tmpDir) => {
const outDir = joinPath(tmpDir, 'out')
await mkdir(outDir)
const context = makeContext({assets: ''})
const promise = copyConfigKeyEntry({key: 'assets', baseDir: tmpDir, outputDir: outDir, context})
await expect(promise).rejects.toThrow(AbortError)
await expect(promise).rejects.toThrow(`'assets' can't be empty.`)
})
})

test('throws when value is whitespace-only', async () => {
await inTemporaryDirectory(async (tmpDir) => {
const outDir = joinPath(tmpDir, 'out')
await mkdir(outDir)
const context = makeContext({assets: ' '})
const promise = copyConfigKeyEntry({key: 'assets', baseDir: tmpDir, outputDir: outDir, context})
await expect(promise).rejects.toThrow(AbortError)
await expect(promise).rejects.toThrow(`'assets' can't be empty.`)
})
})

test('throws with the field name only, not the full configKey, when the key is nested', async () => {
await inTemporaryDirectory(async (tmpDir) => {
const outDir = joinPath(tmpDir, 'out')
await mkdir(outDir)
const context = makeContext({extension_points: [{assets: ''}]})
const promise = copyConfigKeyEntry({
key: 'extension_points[].assets',
baseDir: tmpDir,
outputDir: outDir,
context,
})
await expect(promise).rejects.toThrow(AbortError)
await expect(promise).rejects.toThrow(`'assets' can't be empty.`)
})
})
})
})
7 changes: 7 additions & 0 deletions packages/app/src/cli/services/build/steps/include-assets/copy-config-key-entry.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,13 @@ export async function copyConfigKeyEntry(config: {
// should only be copied once; the pathMap entry is reused for all references.
const uniquePaths = [...new Set(paths)]

const fieldName = key.split('.').pop()?.replace(/\[\]$/, '') ?? key
Copy link
Copy Markdown
Contributor

@melissaluu melissaluu May 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should do the check earlier when we get the value so we don't have to do the extra unnecessary work of setting up the paths etc.

Copy link
Copy Markdown
Contributor

@melissaluu melissaluu May 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To keep things simple, let's just add the check here to scope this validation to the single string value block - this will fulfill our current use case.

In the case where an asset key can have an array, I think we should review what the expected outcome should be for arrays before forcing an error if only one of the paths are empty string - and it's out of scope for us ATM so we can defer

for (const sourcePath of uniquePaths) {
if (sourcePath.trim() === '') {
throw new AbortError(`'${fieldName}' can't be empty.`)
}
}

// Process sequentially to avoid filesystem race conditions on shared output paths.
const pathMap = new Map<string, string | string[]>()
let filesCopied = 0
Expand Down
Loading