-
Notifications
You must be signed in to change notification settings - Fork 119
fix(varlock): record missing dataType as a ResolutionError #1069
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
Closed
hassaans
wants to merge
1
commit into
dmno-dev:main
from
hassaans:fix/unprocessed-item-datatype-assertion
+71
−1
Closed
Changes from all commits
Commits
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
58 changes: 58 additions & 0 deletions
58
packages/varlock/src/env-graph/test/unprocessed-item-resolve.test.ts
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,58 @@ | ||
| import { describe, it, expect } from 'vitest'; | ||
| import { EnvGraph } from '../index'; | ||
| import { DotEnvFileDataSource, MultiplePathsContainerDataSource } from '../lib/data-source'; | ||
| import { ResolutionError } from '../lib/errors'; | ||
|
|
||
| /** | ||
| * finishLoad() returns early when a sibling source fails to parse, leaving | ||
| * schema items unprocessed (dataType unset). If that key is also in | ||
| * process.env / overrideValues, ConfigItem.resolve used to throw | ||
| * `expected dataType to be set` from an un-awaited resolveItem — an | ||
| * unhandledRejection while resolveEnvValues() hung forever. | ||
| */ | ||
| describe('unprocessed item resolve', () => { | ||
| it('records a ResolutionError instead of throwing expected dataType to be set', async () => { | ||
| const g = new EnvGraph(); | ||
| g.overrideValues = { REPRO_VAR: 'fixture-token-not-a-real-secret' }; | ||
| // Virtual files must be registered before setRootDataSource so the | ||
| // container can feed overrideContents into each DotEnvFileDataSource. | ||
| g.setVirtualImports('/virtual', { | ||
| '.env.schema': 'REPRO_VAR=\n', | ||
| '.env.local': 'VALID=ok\n@#$%^& this is not valid env syntax !!!\n', | ||
| }); | ||
| await g.setRootDataSource(new MultiplePathsContainerDataSource([ | ||
| '/virtual/.env.schema', | ||
| '/virtual/.env.local', | ||
| ])); | ||
| await g.finishLoad(); | ||
|
|
||
| const item = g.configSchema.REPRO_VAR; | ||
| expect(item).toBeDefined(); | ||
| expect(item.dataType).toBeUndefined(); | ||
|
|
||
| const forwarded: Array<unknown> = []; | ||
| const onRejection = (reason: unknown) => { | ||
| forwarded.push(reason); | ||
| }; | ||
| process.on('unhandledRejection', onRejection); | ||
| try { | ||
| const settled = g.resolveEnvValues().then( | ||
| () => 'RESOLVED' as const, | ||
| (e: unknown) => e, | ||
| ); | ||
| const result = await Promise.race([ | ||
| settled, | ||
| new Promise<'STILL_PENDING'>((r) => setTimeout(() => r('STILL_PENDING'), 200)), | ||
| ]); | ||
| expect(result).toBe('RESOLVED'); | ||
| expect( | ||
| forwarded.some((r) => String((r as Error)?.message ?? r).includes('expected dataType to be set')), | ||
| ).toBe(false); | ||
| expect(item.resolutionError).toBeInstanceOf(ResolutionError); | ||
| expect(item.resolutionError?.message).toMatch(/expected dataType to be set/); | ||
| expect(item.errors.length).toBeGreaterThan(0); | ||
| } finally { | ||
| process.removeListener('unhandledRejection', onRejection); | ||
| } | ||
| }); | ||
| }); | ||
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.
Changed-file ESLint fails here because this expression-bodied Promise executor returns the
TimeoutfromsetTimeout, violatingno-promise-executor-return; this will make lint CI fail. Wrap the executor body in braces and callsetTimeoutwithout returning it.