Open History to see the last commit
1import { isSignal, untracked } from '@angular/core'
2import { SIGNAL, signalSetFn } from '@angular/core/primitives/signals'
3import type { InputSignal, Signal } from '@angular/core'
4import type { ComponentFixture } from '@angular/core/testing'
5β
6let queryKeyCount = 0
7export function queryKey() {
8 queryKeyCount++
9 return [`query_${queryKeyCount}`]
10}
11β
12export function simpleFetcher(): Promise<string> {
13 return new Promise((resolve) => {
14 setTimeout(() => {
15 return resolve('Some data')
16 }, 0)
17 })
18}
19β
20export function delayedFetcher(timeout = 0): () => Promise<string> {
21 return () =>
22 new Promise((resolve) => {
23 setTimeout(() => {
24 return resolve('Some data')
25 }, timeout)
26 })
27}
28β
29export function getSimpleFetcherWithReturnData(returnData: unknown) {
30 return () =>
31 new Promise((resolve) => setTimeout(() => resolve(returnData), 0))
32}
33β
34export function rejectFetcher(): Promise<Error> {
35 return new Promise((_, reject) => {
36 setTimeout(() => {
37 return reject(new Error('Some error'))
38 }, 0)
39 })
40}
41β
42export function infiniteFetcher({
43 pageParam,
44}: {
45 pageParam?: number
46}): Promise<string> {
47 return new Promise((resolve) => {
48 setTimeout(() => {
49 return resolve('data on page ' + pageParam)
50 }, 0)
51 })
52}
53β
54export function successMutator<T>(param: T): Promise<T> {
55 return new Promise((resolve) => {
56 setTimeout(() => {
57 return resolve(param)
58 }, 0)
59 })
60}
61β
62export function errorMutator(_parameter?: unknown): Promise<Error> {
63 return rejectFetcher()
64}
65β
66// Evaluate all signals on an object and return the result
67function evaluateSignals<T extends Record<string, any>>(
68 obj: T,
69): { [K in keyof T]: ReturnType<T[K]> } {
70 const result: Partial<{ [K in keyof T]: ReturnType<T[K]> }> = {}
71β
72 untracked(() => {
73 for (const key in obj) {
74 if (
75 Object.prototype.hasOwnProperty.call(obj, key) &&
76 // Only evaluate signals, not normal functions
77 isSignal(obj[key])
78 ) {
79 const func = obj[key]
80 result[key] = func()
81 }
82 }
83 })
84β
85 return result as { [K in keyof T]: ReturnType<T[K]> }
86}
87β
88export const expectSignals = <T extends Record<string, any>>(
89 obj: T,
90 expected: Partial<{
91 [K in keyof T]: T[K] extends Signal<any> ? ReturnType<T[K]> : never
92 }>,
93): void => {
94 expect(evaluateSignals(obj)).toMatchObject(expected)
95}
96β
97type ToSignalInputUpdatableMap<T> = {
98 [K in keyof T as T[K] extends InputSignal<any>
99 ? K
100 : never]: T[K] extends InputSignal<infer Value> ? Value : never
101}
102β
103function componentHasSignalInputProperty<TProperty extends string>(
104 component: object,
105 property: TProperty,
106): component is { [key in TProperty]: InputSignal<unknown> } {
107 return (
108 component.hasOwnProperty(property) && (component as any)[property][SIGNAL]
109 )
110}
111β
112/**
113 * Set required signal input value to component fixture
114 * @see https://github.com/angular/angular/issues/54013
115 */
116export function setSignalInputs<T extends NonNullable<unknown>>(
117 component: T,
118 inputs: ToSignalInputUpdatableMap<T>,
119) {
120 for (const inputKey in inputs) {
121 if (componentHasSignalInputProperty(component, inputKey)) {
122 signalSetFn(component[inputKey][SIGNAL], inputs[inputKey])
123 }
124 }
125}
126β
127export function setFixtureSignalInputs<T extends NonNullable<unknown>>(
128 componentFixture: ComponentFixture<T>,
129 inputs: ToSignalInputUpdatableMap<T>,
130 options: { detectChanges: boolean } = { detectChanges: true },
131) {
132 setSignalInputs(componentFixture.componentInstance, inputs)
133 if (options.detectChanges) {
134 componentFixture.detectChanges()
135 }
136}