-
Notifications
You must be signed in to change notification settings - Fork 11.9k
fix(@angular/build): respect tsconfig customConditions in unit-test builder #33246
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
RobbyRabbitman
wants to merge
1
commit into
angular:main
Choose a base branch
from
RobbyRabbitman:fix/unit-test-custom-conditions
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.
+164
−1
Open
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
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
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
99 changes: 99 additions & 0 deletions
99
packages/angular/build/src/builders/unit-test/tests/options/conditions_spec.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,99 @@ | ||
| /** | ||
| * @license | ||
| * Copyright Google LLC All Rights Reserved. | ||
| * | ||
| * Use of this source code is governed by an MIT-style license that can be | ||
| * found in the LICENSE file at https://angular.dev/license | ||
| */ | ||
|
|
||
| import { | ||
| setTargetMapping, | ||
| setupConditionImport, | ||
| } from '../../../../../../../../modules/testing/builder/src/dev_prod_mode'; | ||
| import { execute } from '../../builder'; | ||
| import { | ||
| BASE_OPTIONS, | ||
| describeBuilder, | ||
| UNIT_TEST_BUILDER_INFO, | ||
| setupApplicationTarget, | ||
| } from '../setup'; | ||
|
|
||
| describeBuilder(execute, UNIT_TEST_BUILDER_INFO, (harness) => { | ||
| describe('Behavior: "customConditions"', () => { | ||
| const GOOD_TARGET = './src/good.js'; | ||
| const BAD_TARGET = './src/bad.js'; | ||
|
|
||
| beforeEach(async () => { | ||
| setupApplicationTarget(harness); | ||
| await setupConditionImport(harness); | ||
|
|
||
| // The spec file imports the conditionally-resolved module and only passes | ||
| // when it resolves to `good.ts`. If `compilerOptions.customConditions` | ||
| // from the test tsconfig is not honored, resolution falls through to | ||
| // `bad.ts` and the assertion fails. | ||
| await harness.writeFile( | ||
| 'src/app/conditions.spec.ts', | ||
| ` | ||
| import { VALUE } from '#target'; | ||
| describe('custom conditions', () => { | ||
| it('should resolve through the test tsconfig customConditions', () => { | ||
| expect(VALUE).toBe('good-value'); | ||
| }); | ||
| }); | ||
| `, | ||
| ); | ||
|
|
||
| // Ensure good/bad sources are reachable by the spec compilation and that | ||
| // bundler-mode resolution is enabled so `#target` is resolved via the | ||
| // package.json imports map. | ||
| await harness.modifyFile('src/tsconfig.spec.json', (content) => { | ||
| const tsConfig = JSON.parse(content); | ||
| tsConfig.compilerOptions ??= {}; | ||
| tsConfig.compilerOptions.moduleResolution = 'bundler'; | ||
| tsConfig.files ??= []; | ||
| tsConfig.files.push('good.ts', 'bad.ts', 'wrong.ts'); | ||
|
|
||
| return JSON.stringify(tsConfig); | ||
| }); | ||
| }); | ||
|
|
||
| it('uses tsconfig customConditions when buildTarget has none', async () => { | ||
| // Map `#target` so only the `staging` condition resolves to the good | ||
| // target. The unit-test builder must read `customConditions` from the | ||
| // test tsconfig and forward them to the application build, otherwise | ||
| // resolution falls back to the `default` entry. | ||
| await setTargetMapping(harness, { | ||
| staging: GOOD_TARGET, | ||
| default: BAD_TARGET, | ||
| }); | ||
|
|
||
| await harness.modifyFile('src/tsconfig.spec.json', (content) => { | ||
| const tsConfig = JSON.parse(content); | ||
| tsConfig.compilerOptions ??= {}; | ||
| tsConfig.compilerOptions.customConditions = ['staging']; | ||
|
|
||
| return JSON.stringify(tsConfig); | ||
| }); | ||
|
|
||
| harness.useTarget('test', { ...BASE_OPTIONS }); | ||
|
|
||
| const { result } = await harness.executeOnce(); | ||
| expect(result?.success).toBeTrue(); | ||
| }); | ||
|
|
||
| it('does not apply unrelated conditions when tsconfig declares none', async () => { | ||
| // Same mapping but no `customConditions` declared in the tsconfig: the | ||
| // `staging` entry must NOT be selected, resolution must land on the | ||
| // `default` (bad) target, and the spec assertion must fail. | ||
| await setTargetMapping(harness, { | ||
| staging: GOOD_TARGET, | ||
| default: BAD_TARGET, | ||
| }); | ||
|
|
||
| harness.useTarget('test', { ...BASE_OPTIONS }); | ||
|
|
||
| const { result } = await harness.executeOnce(); | ||
| expect(result?.success).toBeFalse(); | ||
| }); | ||
| }); | ||
| }); |
Oops, something went wrong.
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.
The logic for reading and parsing the TypeScript configuration can be simplified by using
ts.getParsedCommandLineOfConfigFile. This high-level API handles reading the file and resolving theextendschain in a single call, making the code more concise. Additionally, while ignoring parsing errors (available inparsed.errors) is acceptable for this optional feature, logging them could help users debug issues with theirtsconfigconfiguration.References