refactor-jasmine-vitest removes done() from asynchronous callbacks, so migrated tests no longer wait for them
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 74/100
- Issue 类型
- 缺陷
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- angular, typescript
调研方向
Read packages/schematics/angular/refactor/jasmine-vitest/transformers/jasmine-lifecycle.ts and the first relevant case in transformers/jasmine-lifecycle_spec.ts. Trace how transformDoneCallback handles done() inside nested functions, then run the focused transformer spec. Done means migrated tests still await nested asynchronous callbacks or the schematic leaves those cases unchanged with a TODO.
由索引模型根据 Issue 内容生成。
描述
Command
e2e, generate
Is this a regression?
- Yes, this behavior used to work in the previous version
The previous version in which this bug was not present was
No response
Description
When a spec uses Jasmine's done callback inside an asynchronous callback — subscribe(...),
setTimeout(...), an event listener — the refactor-jasmine-vitest schematic deletes the done()
call and converts the test to a plain async function. The migrated test then resolves immediately,
before the callback ever runs, so it no longer waits for — or asserts anything about — the
asynchronous work:
// before (fails under Jasmine if the observable never emits: done timeout;
// fails if the assertion inside the callback throws)
it('emits the loaded data', (done) => {
service.getData().subscribe((data) => {
expect(data).toEqual(expected);
done();
});
});
// after migration (passes unconditionally if the emission is not synchronous)
it('emits the loaded data', async () => {
service.getData().subscribe((data) => {
expect(data).toEqual(expected);
});
});
Two guarantees are lost at once:
- The completion guarantee. In Jasmine, a test whose
doneis never called fails with a
timeout. The migrated test passes instantly, so "the event/emission never happened" bugs are no
longer caught. - Failure attribution. If the callback does fire later, an assertion failure inside it throws
outside any test. Depending on timing it surfaces as an unattributed unhandled error or not at
all (when the run ends first) — instead of failing this test.
The transformation is correct for done() at the top level of the test body and for the explicitly
handled promise forms (.then(done), .then(() => done()), .catch(done.fail)), which are
rewritten to await. The problem is only done() inside a nested function that the transformer
cannot await. The existing safety check (unhandled-done-usage) does not catch this, because
removing the nested done() counts as a handled usage.
Since Vitest has no done callback, a faithful migration for the nested case would wrap the body in
an awaited promise whose resolver takes done's place:
it('emits the loaded data', () =>
new Promise<void>((done) => {
service.getData().subscribe((data) => {
expect(data).toEqual(expected);
done();
});
}));
Alternatively, the schematic could leave the test unchanged with a TODO (like
unhandled-done-usage) whenever done is referenced inside a nested function. Happy to send a PR
for whichever direction you prefer.
Minimal Reproduction
-
ng new repro --defaults && cd repro -
Replace the body of
src/app/app.spec.ts(or any spec) with a test whose callback never fires:import { Subject } from 'rxjs'; describe('done in async callback', () => { it('fails when the data never arrives', (done) => { const data$ = new Subject<number>(); data$.subscribe(() => done()); // nothing ever emits — under Jasmine this test fails with a done timeout }); }); -
Run it with Karma/Jasmine (
ng testwith the Karma builder): the test fails after the timeout —
Async function did not complete within 5000ms. -
ng generate @schematics/angular:refactor-jasmine-vitest -
The spec becomes
it('fails when the data never arrives', async () => { data$.subscribe(() => {}); });
andng test(Vitest runner) reports it as passing.
Exception or Error
Your Environment
_ _ ____ _ ___
/ \ _ __ __ _ _ _| | __ _ _ __ / ___| | |_ _|
/ △ \ | '_ \ / _` | | | | |/ _` | '__| | | | | | |
/ ___ \| | | | (_| | |_| | | (_| | | | |___| |___ | |
/_/ \_\_| |_|\__, |\__,_|_|\__,_|_| \____|_____|___|
|___/
Angular CLI : 22.3.0-next.5
Node.js : 24.15.0
Package Manager : yarn 1.22.22
Operating System : darwin arm64
┌──────────────┬───────────────────┬───────────────────┐
│ Package │ Installed Version │ Requested Version │
├──────────────┼───────────────────┼───────────────────┤
│ @angular/cli │ 22.3.0-next.5 │ ^22.3.0-next.5 │
Anything else relevant?
packages/schematics/angular/refactor/jasmine-vitest/transformers/jasmine-lifecycle.ts—
transformDoneCallback: the body visitor recurses into nested functions and replaces any
done()statement with an empty statement, then marks the testasync.- The current output is asserted by the first case in
transformers/jasmine-lifecycle_spec.ts(setTimeoutwithdone()→asyncwithdone()
removed), so I wanted to raise this before proposing a behavior change. - Not OS- or browser-specific.
- 主要语言
- TypeScript
- 星标
- 27k
- 派生
- 11.8k
- 平均合并
- 1 天 2 小时
- 30 天内合并 PR
- 225
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
angular/angular-cli 的其他 Issue
-
`@angular/[email protected]` depends on vulnerable Vite 7.3.7 - GHSA-p4f5-76q4-ffq7 (Critical RCE)未关闭area: @angular/build
难度 2/5 1-3 小时 新手友好度 65/100
angular/angular-cli#34764 ·
维护者通常 1 天内回复
-
ng add @angular/ssr fails with TypeError when an NgModule in the app module file has no bootstrap array可能已有人在做 @0z5a 今天认领。 未关闭area: @schematics/angular
难度 2/5 1-3 小时 新手友好度 90/100
angular/angular-cli#34761 ·
维护者通常 1 天内回复
-
难度 3/5 1-2 天 新手友好度 72/100
angular/angular-cli#34760 ·
维护者通常 1 天内回复
-
Angular SSR can crash `AngularAppEngine` servers with a single aborted request (22.2.6 regression)可能已有人在做 @SkyZeroZx 于 1 天前认领。 未关闭area: @angular/ssr
难度 4/5 3-5 天 新手友好度 20/100
angular/angular-cli#34754 ·
维护者通常 1 天内回复
-
area: @angular/build
难度 4/5 3-5 天 新手友好度 48/100
angular/angular-cli#34728 · 2 条评论 ·
维护者通常 1 天内回复
查看 angular/angular-cli 的全部 Issue
相似的 Issue
-
status/need-triage
难度 2/5 1-3 小时 新手友好度 76/100
google-gemini/gemini-cli#30384 · 1 条评论 ·
维护者通常 1 天内回复
-
P2
难度 1/5 1 小时以内 新手友好度 84/100
维护者通常 1 天内回复
-
bug ready-for-human
难度 2/5 1-3 小时 新手友好度 60/100
LucasSantana-Dev/Lucky#3150 ·
维护者通常 1 天内回复
-
enhancement good first issue priority: low size: XS
难度 2/5 1-3 小时 新手友好度 88/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
vercel-labs/scriptc#3979 ·
维护者通常 1 天内回复