Skip to content

fix(cdk/testing): account for new DirectiveFixture API #33771

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.

Sign up for GitHub

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

Merged
crisbeto merged 1 commit into from
Sep 5, 2026
Merged

fix(cdk/testing): account for new DirectiveFixture API #33771

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions goldens/cdk/testing/testbed/index.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,23 @@
```ts

import { ComponentFixture } from '@angular/core/testing';
import { DirectiveFixture } from '@angular/core/testing';

// @public
export type Fixture<T = unknown> = ComponentFixture<T> | DirectiveFixture<T>;

// @public
export class TestbedHarnessEnvironment extends HarnessEnvironment<Element> {
protected constructor(rawRootElement: Element, _fixture: ComponentFixture<unknown>, options?: TestbedHarnessEnvironmentOptions);
protected constructor(rawRootElement: Element, _fixture: Fixture, options?: TestbedHarnessEnvironmentOptions);
protected createEnvironment(element: Element): HarnessEnvironment<Element>;
protected createTestElement(element: Element): TestElement;
static documentRootLoader(fixture: ComponentFixture<unknown>, options?: TestbedHarnessEnvironmentOptions): HarnessLoader;
static documentRootLoader(fixture: Fixture, options?: TestbedHarnessEnvironmentOptions): HarnessLoader;
forceStabilize(): Promise<void>;
protected getAllRawElements(selector: string): Promise<Element[]>;
protected getDocumentRoot(): Element;
static getNativeElement(el: TestElement): Element;
static harnessForFixture<T extends ComponentHarness>(fixture: ComponentFixture<unknown>, harnessType: ComponentHarnessConstructor<T>, options?: TestbedHarnessEnvironmentOptions): Promise<T>;
static loader(fixture: ComponentFixture<unknown>, options?: TestbedHarnessEnvironmentOptions): HarnessLoader;
static harnessForFixture<T extends ComponentHarness>(fixture: Fixture, harnessType: ComponentHarnessConstructor<T>, options?: TestbedHarnessEnvironmentOptions): Promise<T>;
static loader(fixture: Fixture, options?: TestbedHarnessEnvironmentOptions): HarnessLoader;
waitForTasksOutsideAngular(): Promise<void>;
}

Expand Down
37 changes: 23 additions & 14 deletions src/cdk/testing/testbed/testbed-harness-environment.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,12 @@ import {
stopHandlingAutoChangeDetectionStatus,
TestElement,
} from '../../testing';
import {ComponentFixture, flush} from '@angular/core/testing';
import {ComponentFixture, DirectiveFixture, flush, TestBed} from '@angular/core/testing';
import {Observable} from 'rxjs';
import {takeWhile} from 'rxjs/operators';
import {TaskState, TaskStateZoneInterceptor} from './task-state-zone-interceptor';
import {UnitTestElement} from './unit-test-element';
import {DestroyRef} from '@angular/core';

/** Options to configure the environment. */
export interface TestbedHarnessEnvironmentOptions {
Expand All @@ -32,19 +33,22 @@ const defaultEnvironmentOptions: TestbedHarnessEnvironmentOptions = {
queryFn: (selector: string, root: Element) => root.querySelectorAll(selector),
};

/** Covers all fixtures supported by `TestBed`. */
export type Fixture<T = unknown> = ComponentFixture<T> | DirectiveFixture<T>;

/** Whether auto change detection is currently disabled. */
let disableAutoChangeDetection = false;

/**
* The set of non-destroyed fixtures currently being used by `TestbedHarnessEnvironment` instances.
*/
const activeFixtures = new Set<ComponentFixture<unknown>>();
const activeFixtures = new Set<Fixture>();

/**
* Installs a handler for change detection batching status changes for a specific fixture.
* @param fixture The fixture to handle change detection batching for.
*/
function installAutoChangeDetectionStatusHandler(fixture: ComponentFixture<unknown>) {
function installAutoChangeDetectionStatusHandler(fixture: Fixture) {
if (!activeFixtures.size) {
handleAutoChangeDetectionStatus(({isDisabled, onDetectChangesNow}) => {
disableAutoChangeDetection = isDisabled;
Expand All @@ -60,7 +64,7 @@ function installAutoChangeDetectionStatusHandler(fixture: ComponentFixture<unkno
* Uninstalls a handler for change detection batching status changes for a specific fixture.
* @param fixture The fixture to stop handling change detection batching for.
*/
function uninstallAutoChangeDetectionStatusHandler(fixture: ComponentFixture<unknown>) {
function uninstallAutoChangeDetectionStatusHandler(fixture: Fixture) {
activeFixtures.delete(fixture);
if (!activeFixtures.size) {
stopHandlingAutoChangeDetectionStatus();
Expand All @@ -76,7 +80,7 @@ function isInFakeAsyncZone() {
* Triggers change detection for a specific fixture.
* @param fixture The fixture to trigger change detection for.
*/
async function detectChanges(fixture: ComponentFixture<unknown>) {
async function detectChanges(fixture: Fixture) {
fixture.detectChanges();
if (isInFakeAsyncZone()) {
flush();
Expand All @@ -101,7 +105,7 @@ export class TestbedHarnessEnvironment extends HarnessEnvironment<Element> {

protected constructor(
rawRootElement: Element,
private _fixture: ComponentFixture<unknown>,
private _fixture: Fixture,
options?: TestbedHarnessEnvironmentOptions,
) {
super(rawRootElement);
Expand All @@ -111,17 +115,22 @@ export class TestbedHarnessEnvironment extends HarnessEnvironment<Element> {
}
this._stabilizeCallback = () => this.forceStabilize();
installAutoChangeDetectionStatusHandler(_fixture);
_fixture.componentRef.onDestroy(() => {

const onDestroy = () => {
uninstallAutoChangeDetectionStatusHandler(_fixture);
this._destroyed = true;
});
};

if (_fixture instanceof ComponentFixture) {
_fixture.componentRef.onDestroy(onDestroy);
} else {
// TODO(crisbeto): use host ref in directive fixture once it's available.
TestBed.inject(DestroyRef).onDestroy(onDestroy);
}
}

/** Creates a `HarnessLoader` rooted at the given fixture's root element. */
static loader(
fixture: ComponentFixture<unknown>,
options?: TestbedHarnessEnvironmentOptions,
): HarnessLoader {
static loader(fixture: Fixture, options?: TestbedHarnessEnvironmentOptions): HarnessLoader {
return new TestbedHarnessEnvironment(fixture.nativeElement, fixture, options);
}

Expand All @@ -130,7 +139,7 @@ export class TestbedHarnessEnvironment extends HarnessEnvironment<Element> {
* located outside of a fixture (e.g. overlays appended to the document body).
*/
static documentRootLoader(
fixture: ComponentFixture<unknown>,
fixture: Fixture,
options?: TestbedHarnessEnvironmentOptions,
): HarnessLoader {
return new TestbedHarnessEnvironment(document.body, fixture, options);
Expand All @@ -151,7 +160,7 @@ export class TestbedHarnessEnvironment extends HarnessEnvironment<Element> {
* of the fixture.
*/
static async harnessForFixture<T extends ComponentHarness>(
fixture: ComponentFixture<unknown>,
fixture: Fixture,
harnessType: ComponentHarnessConstructor<T>,
options?: TestbedHarnessEnvironmentOptions,
): Promise<T> {
Expand Down
Loading
Loading