refactor-jasmine-vitest removes done() from asynchronous callbacks, so migrated tests no longer wait for them
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 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時間
- マージ済み PR(30日)
- 225
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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 日以内に返信