-
Notifications
You must be signed in to change notification settings - Fork 253
Decode UTF-16 .env files on variable import #3187
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.
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
levivannoort
wants to merge
2
commits into
main
Choose a base branch
from
fix/env-import-encoding
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+102
−4
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| import { parse, readEnvFile } from '$lib/helpers/envfile'; | ||
| import { expect, test } from 'vitest'; | ||
|
|
||
| function encodeUtf16(text: string, littleEndian: boolean, bom: boolean): ArrayBuffer { | ||
| const codeUnits = bom | ||
| ? [0xfeff, ...text.split('').map((c) => c.charCodeAt(0))] | ||
| : text.split('').map((c) => c.charCodeAt(0)); | ||
| const buffer = new ArrayBuffer(codeUnits.length * 2); | ||
| const view = new DataView(buffer); | ||
| codeUnits.forEach((unit, i) => view.setUint16(i * 2, unit, littleEndian)); | ||
| return buffer; | ||
| } | ||
|
|
||
| const ENV = 'ACME_SERVICE_API_KEY=secret-value\nOTHER_KEY=other'; | ||
| const EXPECTED = { ACME_SERVICE_API_KEY: 'secret-value', OTHER_KEY: 'other' }; | ||
|
|
||
| test('reads UTF-8', async () => { | ||
| const file = new Blob([new TextEncoder().encode(ENV)]); | ||
| expect(parse(await readEnvFile(file))).toEqual(EXPECTED); | ||
| }); | ||
|
|
||
| test('reads UTF-8 with BOM', async () => { | ||
| const bytes = new Uint8Array([0xef, 0xbb, 0xbf, ...new TextEncoder().encode(ENV)]); | ||
| expect(parse(await readEnvFile(new Blob([bytes])))).toEqual(EXPECTED); | ||
| }); | ||
|
|
||
| test('reads UTF-16LE with BOM (PowerShell default)', async () => { | ||
| const file = new Blob([encodeUtf16(ENV, true, true)]); | ||
| expect(parse(await readEnvFile(file))).toEqual(EXPECTED); | ||
| }); | ||
|
|
||
| test('reads UTF-16BE with BOM', async () => { | ||
| const file = new Blob([encodeUtf16(ENV, false, true)]); | ||
| expect(parse(await readEnvFile(file))).toEqual(EXPECTED); | ||
| }); | ||
|
|
||
| test('reads BOM-less UTF-16LE by NUL heuristic', async () => { | ||
| const file = new Blob([encodeUtf16(ENV, true, false)]); | ||
| const parsed = parse(await readEnvFile(file)); | ||
| expect(parsed).toEqual(EXPECTED); | ||
| // The regression this guards: keys must not carry interleaved NUL bytes. | ||
| expect(Object.keys(parsed).some((key) => key.includes('\u0000'))).toBe(false); | ||
| }); | ||
|
|
||
| test('reads BOM-less UTF-16BE by NUL heuristic', async () => { | ||
| const file = new Blob([encodeUtf16(ENV, false, false)]); | ||
| expect(parse(await readEnvFile(file))).toEqual(EXPECTED); | ||
| }); | ||
|
|
||
| test('keeps UTF-8 text containing a stray NUL as UTF-8', async () => { | ||
| const text = 'A=1\nB=has\u0000nul'; | ||
| const file = new Blob([new TextEncoder().encode(text)]); | ||
| expect(await readEnvFile(file)).toBe(text); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When a BOM-less UTF-16 file contains at least 30% non-ASCII code units in its values or comments, the file-wide NUL ratio falls below this threshold and
readEnvFiledecodes it as UTF-8. This leaves interleaved NULs in ASCII keys, causing variable validation to reject the entire import.