@shivaedev/test-story 0.29.0 → 0.30.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +23 -0
- package/README.md +62 -34
- package/dist/server/adapters/outcomeMatchers.d.ts +12 -0
- package/dist/server/adapters/outcomeMatchers.d.ts.map +1 -0
- package/dist/server/adapters/outcomeMatchers.js +22 -0
- package/dist/server/adapters/outcomeMatchers.js.map +1 -0
- package/dist/server/{internal → adapters}/screenElements.d.ts +5 -2
- package/dist/server/adapters/screenElements.d.ts.map +1 -0
- package/dist/server/{internal → adapters}/screenElements.js +22 -5
- package/dist/server/adapters/screenElements.js.map +1 -0
- package/dist/server/adapters/screenMutations.d.ts +3 -0
- package/dist/server/adapters/screenMutations.d.ts.map +1 -0
- package/dist/server/adapters/screenMutations.js +11 -0
- package/dist/server/adapters/screenMutations.js.map +1 -0
- package/dist/server/adapters/screenNavigation.d.ts +3 -0
- package/dist/server/adapters/screenNavigation.d.ts.map +1 -0
- package/dist/server/adapters/screenNavigation.js +34 -0
- package/dist/server/adapters/screenNavigation.js.map +1 -0
- package/dist/server/adapters/screenQueries.d.ts +8 -0
- package/dist/server/adapters/screenQueries.d.ts.map +1 -0
- package/dist/server/adapters/screenQueries.js +62 -0
- package/dist/server/adapters/screenQueries.js.map +1 -0
- package/dist/server/internal/nextClientHint.d.ts +4 -0
- package/dist/server/internal/nextClientHint.d.ts.map +1 -0
- package/dist/server/internal/{screenActivity.js → nextClientHint.js} +1 -5
- package/dist/server/internal/nextClientHint.js.map +1 -0
- package/dist/server/internal/screenAccessibility.d.ts +0 -1
- package/dist/server/internal/screenAccessibility.d.ts.map +1 -1
- package/dist/server/internal/screenAccessibility.js +1 -22
- package/dist/server/internal/screenAccessibility.js.map +1 -1
- package/dist/server/internal/screenReadouts.d.ts +1 -1
- package/dist/server/internal/screenReadouts.d.ts.map +1 -1
- package/dist/server/internal/screenReadouts.js +3 -3
- package/dist/server/internal/screenReadouts.js.map +1 -1
- package/dist/server/internal/screenWaits.d.ts +28 -0
- package/dist/server/internal/screenWaits.d.ts.map +1 -0
- package/dist/server/internal/screenWaits.js +47 -0
- package/dist/server/internal/screenWaits.js.map +1 -0
- package/dist/server/internal/waitForScreen.d.ts +9 -0
- package/dist/server/internal/waitForScreen.d.ts.map +1 -0
- package/dist/server/internal/waitForScreen.js +36 -0
- package/dist/server/internal/waitForScreen.js.map +1 -0
- package/dist/server/outcomes.d.ts +8 -1
- package/dist/server/outcomes.d.ts.map +1 -1
- package/dist/server/outcomes.js +6 -6
- package/dist/server/outcomes.js.map +1 -1
- package/dist/server/screenDriver.d.ts +19 -9
- package/dist/server/screenDriver.d.ts.map +1 -1
- package/dist/server/screenDriver.js +18 -58
- package/dist/server/screenDriver.js.map +1 -1
- package/package.json +3 -3
- package/src/server/adapters/outcomeMatchers.ts +33 -0
- package/src/server/{internal → adapters}/screenElements.ts +22 -5
- package/src/server/adapters/screenMutations.ts +14 -0
- package/src/server/adapters/screenNavigation.ts +37 -0
- package/src/server/adapters/screenQueries.ts +75 -0
- package/src/server/internal/{screenActivity.ts → nextClientHint.ts} +1 -5
- package/src/server/internal/screenAccessibility.ts +1 -25
- package/src/server/internal/screenReadouts.ts +3 -3
- package/src/server/internal/screenWaits.ts +105 -0
- package/src/server/internal/waitForScreen.ts +48 -0
- package/src/server/outcomes.ts +19 -10
- package/src/server/screenDriver.ts +25 -73
- package/dist/server/internal/screenActivity.d.ts +0 -5
- package/dist/server/internal/screenActivity.d.ts.map +0 -1
- package/dist/server/internal/screenActivity.js.map +0 -1
- package/dist/server/internal/screenElements.d.ts.map +0 -1
- package/dist/server/internal/screenElements.js.map +0 -1
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
import { isInaccessible } from "dom-accessibility-api";
|
|
2
|
+
import { accessibility, isRendered, targetName } from "#internal/screenAccessibility.ts";
|
|
3
|
+
import { screenText } from "#internal/screenText.ts";
|
|
4
|
+
import type { ScreenTarget } from "#screenDriver.ts";
|
|
5
|
+
|
|
6
|
+
function matchesText(value: string, expected: string | RegExp) {
|
|
7
|
+
return typeof expected === "string" ? value === expected : new RegExp(expected.source, expected.flags).test(value);
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
export function screenQueries(root: () => HTMLElement, dialogs: boolean) {
|
|
11
|
+
function query(selector: string) {
|
|
12
|
+
const current = root();
|
|
13
|
+
const found = new Set(current.querySelectorAll<HTMLElement>(selector));
|
|
14
|
+
const portals = dialogs
|
|
15
|
+
? [...current.ownerDocument.querySelectorAll<HTMLElement>('dialog,[role="dialog"],[role="alertdialog"]')].filter(
|
|
16
|
+
(dialog) => !current.contains(dialog),
|
|
17
|
+
)
|
|
18
|
+
: [];
|
|
19
|
+
for (const dialog of portals) {
|
|
20
|
+
if (dialog.matches(selector)) {
|
|
21
|
+
found.add(dialog);
|
|
22
|
+
}
|
|
23
|
+
for (const child of dialog.querySelectorAll<HTMLElement>(selector)) {
|
|
24
|
+
found.add(child);
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
return [...found];
|
|
28
|
+
}
|
|
29
|
+
function candidates() {
|
|
30
|
+
return query("*")
|
|
31
|
+
.filter((element) => isRendered(element) && !isInaccessible(element))
|
|
32
|
+
.map((element) => {
|
|
33
|
+
const { role, name } = accessibility(element);
|
|
34
|
+
return { element, name: role === "alert" && name === "" ? screenText(element).replace(/\s+/gu, " ").trim() : name, role };
|
|
35
|
+
})
|
|
36
|
+
.filter(({ role }) => role !== null);
|
|
37
|
+
}
|
|
38
|
+
function roles(target: Exclude<ScreenTarget, string>) {
|
|
39
|
+
return candidates().filter(({ role, name }) => role === target.role && matchesText(name, target.name));
|
|
40
|
+
}
|
|
41
|
+
return {
|
|
42
|
+
matches: (target: ScreenTarget) =>
|
|
43
|
+
(typeof target === "string" ? query(target).filter(isRendered) : roles(target).map(({ element }) => element)).filter(
|
|
44
|
+
(element) => element.isConnected,
|
|
45
|
+
),
|
|
46
|
+
query,
|
|
47
|
+
roleElement: (target: Exclude<ScreenTarget, string>) => {
|
|
48
|
+
const matches = roles(target);
|
|
49
|
+
const found = matches[0];
|
|
50
|
+
if (matches.length === 1 && found) {
|
|
51
|
+
return found.element;
|
|
52
|
+
}
|
|
53
|
+
const listing = candidates()
|
|
54
|
+
.map(({ role, name }) => ` - ${role} named ${JSON.stringify(name)}`)
|
|
55
|
+
.join("\n");
|
|
56
|
+
throw new Error(
|
|
57
|
+
`The screen has ${matches.length} matches for ${targetName(target)}.\nhelp: Use a role and name for exactly one visible target.\nCandidates on screen:\n${listing || " (none)"}`,
|
|
58
|
+
);
|
|
59
|
+
},
|
|
60
|
+
textElement: (text: string | RegExp) => {
|
|
61
|
+
const current = root();
|
|
62
|
+
const matches = [current, ...query("*")].filter(
|
|
63
|
+
(element) => isRendered(element) && matchesText(screenText(element).replace(/\s+/gu, " ").trim(), text),
|
|
64
|
+
);
|
|
65
|
+
const deepest = matches.filter((element) => !matches.some((other) => element !== other && element.contains(other)));
|
|
66
|
+
const found = deepest[0];
|
|
67
|
+
if (deepest.length !== 1 || found === undefined) {
|
|
68
|
+
throw new Error(
|
|
69
|
+
`The screen has ${deepest.length} matches for text ${String(text instanceof RegExp ? text : JSON.stringify(text))}.\nhelp: Use text that identifies exactly one visible element.`,
|
|
70
|
+
);
|
|
71
|
+
}
|
|
72
|
+
return found;
|
|
73
|
+
},
|
|
74
|
+
};
|
|
75
|
+
}
|
|
@@ -1,9 +1,5 @@
|
|
|
1
1
|
import { Effect, Stream } from "effect";
|
|
2
|
-
import {
|
|
3
|
-
|
|
4
|
-
export function waitForClient(activity: ClientActivity) {
|
|
5
|
-
return activity.pipe(Stream.filter(isClientIdle), Stream.take(1), Stream.runDrain);
|
|
6
|
-
}
|
|
2
|
+
import type { ClientActivity } from "@shivaedev/contract/clientActivity.ts";
|
|
7
3
|
|
|
8
4
|
export const nextClientHint = Effect.fnUntraced(function* (activity: ClientActivity) {
|
|
9
5
|
const before = (yield* activity.current).liveHints;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { computeAccessibleName, getRole
|
|
1
|
+
import { computeAccessibleName, getRole } from "dom-accessibility-api";
|
|
2
2
|
import type { ScreenTarget } from "#screenDriver.ts";
|
|
3
3
|
|
|
4
4
|
export function accessibility(element: Element) {
|
|
@@ -24,27 +24,3 @@ export function isRendered(found: HTMLElement) {
|
|
|
24
24
|
}
|
|
25
25
|
return true;
|
|
26
26
|
}
|
|
27
|
-
|
|
28
|
-
export function roleElement(root: HTMLElement, target: Exclude<ScreenTarget, string>) {
|
|
29
|
-
const candidates = Array.from(root.querySelectorAll<HTMLElement>("*"))
|
|
30
|
-
.filter((element) => isRendered(element) && !isInaccessible(element))
|
|
31
|
-
.map((element) => ({ ...accessibility(element), element }))
|
|
32
|
-
.filter(({ role }) => role !== null);
|
|
33
|
-
const matches = candidates.filter(({ role, name }) => {
|
|
34
|
-
if (role !== target.role) {
|
|
35
|
-
return false;
|
|
36
|
-
}
|
|
37
|
-
if (typeof target.name === "string") {
|
|
38
|
-
return name === target.name;
|
|
39
|
-
}
|
|
40
|
-
return new RegExp(target.name.source, target.name.flags).test(name);
|
|
41
|
-
});
|
|
42
|
-
const found = matches[0];
|
|
43
|
-
if (matches.length === 1 && found) {
|
|
44
|
-
return found.element;
|
|
45
|
-
}
|
|
46
|
-
const listing = candidates.map(({ role, name }) => ` - ${role} named ${JSON.stringify(name)}`).join("\n");
|
|
47
|
-
throw new Error(
|
|
48
|
-
`The screen has ${matches.length} matches for ${targetName(target)}.\nhelp: Use a role and name for exactly one visible target.\nCandidates on screen:\n${listing || " (none)"}`,
|
|
49
|
-
);
|
|
50
|
-
}
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
+
import { screenElements } from "#adapters/screenElements.ts";
|
|
1
2
|
import type { ScreenTarget } from "#screenDriver.ts";
|
|
2
3
|
import { accessibility, targetName } from "./screenAccessibility.ts";
|
|
3
|
-
import { screenElements } from "./screenElements.ts";
|
|
4
4
|
|
|
5
|
-
export function screenReadouts(currentRoot: () => HTMLElement, tell: (line: string) => void) {
|
|
6
|
-
const elements = screenElements(currentRoot);
|
|
5
|
+
export function screenReadouts(currentRoot: () => HTMLElement, tell: (line: string) => void, dialogs = true) {
|
|
6
|
+
const elements = screenElements(currentRoot, dialogs);
|
|
7
7
|
return {
|
|
8
8
|
accessible: (selector: string | Element) => {
|
|
9
9
|
if (typeof selector !== "string") {
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
import { Effect } from "effect";
|
|
2
|
+
import { withLive } from "@shivaedev/test/withLive.ts";
|
|
3
|
+
import type { screenElements } from "#adapters/screenElements.ts";
|
|
4
|
+
import { screenNavigation } from "#adapters/screenNavigation.ts";
|
|
5
|
+
import type { ScreenDriverOptions, ScreenTarget } from "#screenDriver.ts";
|
|
6
|
+
import { targetName } from "./screenAccessibility.ts";
|
|
7
|
+
import { waitForScreen } from "./waitForScreen.ts";
|
|
8
|
+
|
|
9
|
+
type Options = Omit<ScreenDriverOptions, "act" | "root" | "timeoutMs" | "pending"> & {
|
|
10
|
+
readonly act: NonNullable<ScreenDriverOptions["act"]>;
|
|
11
|
+
readonly pending: ScreenDriverOptions["pending"];
|
|
12
|
+
readonly root: () => HTMLElement;
|
|
13
|
+
readonly timeoutMs: number;
|
|
14
|
+
};
|
|
15
|
+
|
|
16
|
+
export function screenWaits(options: Options, elements: ReturnType<typeof screenElements>) {
|
|
17
|
+
const { act, pending, root, tell, timeoutMs } = options;
|
|
18
|
+
function unsettled(limit: number) {
|
|
19
|
+
return new Error(
|
|
20
|
+
`The screen did not settle within ${limit}ms.\nhelp: Release held requests and check the app's pending signal and renderer act adapter.\nScreen: ${root().textContent}`,
|
|
21
|
+
);
|
|
22
|
+
}
|
|
23
|
+
function wait<A>(line: string, read: () => A, timeout: number, expired: () => Effect.Effect<A>) {
|
|
24
|
+
return withLive(
|
|
25
|
+
Effect.sync(() => tell(line)).pipe(
|
|
26
|
+
Effect.andThen(waitForScreen({ act, pending, root }, Effect.try(read))),
|
|
27
|
+
Effect.timeoutOrElse({ duration: timeout, orElse: expired }),
|
|
28
|
+
),
|
|
29
|
+
);
|
|
30
|
+
}
|
|
31
|
+
return {
|
|
32
|
+
find: (target: ScreenTarget, settings: { readonly timeout?: number } = {}) => {
|
|
33
|
+
const limit = settings.timeout ?? timeoutMs;
|
|
34
|
+
return wait(
|
|
35
|
+
`find ${targetName(target)}`,
|
|
36
|
+
() => elements.element(target),
|
|
37
|
+
limit,
|
|
38
|
+
() => {
|
|
39
|
+
const lookup = Effect.sync(() => elements.element(target));
|
|
40
|
+
return pending === undefined ? lookup : lookup.pipe(Effect.andThen(Effect.die(unsettled(limit))));
|
|
41
|
+
},
|
|
42
|
+
);
|
|
43
|
+
},
|
|
44
|
+
findText: (text: string | RegExp, settings: { readonly timeout?: number } = {}) => {
|
|
45
|
+
const name = typeof text === "string" ? JSON.stringify(text) : String(text);
|
|
46
|
+
const limit = settings.timeout ?? timeoutMs;
|
|
47
|
+
return wait(
|
|
48
|
+
`find text ${name}`,
|
|
49
|
+
() => elements.textElement(text),
|
|
50
|
+
limit,
|
|
51
|
+
() =>
|
|
52
|
+
Effect.sync(() => elements.textElement(text)).pipe(
|
|
53
|
+
Effect.andThen(
|
|
54
|
+
Effect.die(new Error(`The screen did not finish waiting for text ${name} within ${limit}ms.\nhelp: Check the app's pending signal.`)),
|
|
55
|
+
),
|
|
56
|
+
),
|
|
57
|
+
);
|
|
58
|
+
},
|
|
59
|
+
gone: (target: ScreenTarget, settings: { readonly timeout?: number } = {}) => {
|
|
60
|
+
const limit = settings.timeout ?? timeoutMs;
|
|
61
|
+
function stillHere() {
|
|
62
|
+
return new Error(
|
|
63
|
+
`The screen did not lose ${targetName(target)} within ${limit}ms.\nhelp: Remove or hide every matching target and complete pending work.`,
|
|
64
|
+
);
|
|
65
|
+
}
|
|
66
|
+
return withLive(
|
|
67
|
+
Effect.sync(() => tell(`wait for ${targetName(target)} to disappear`)).pipe(
|
|
68
|
+
Effect.andThen(
|
|
69
|
+
waitForScreen(
|
|
70
|
+
{ act, pending, root },
|
|
71
|
+
Effect.suspend(() => (elements.matches(target).length === 0 ? Effect.void : Effect.fail(stillHere()))),
|
|
72
|
+
),
|
|
73
|
+
),
|
|
74
|
+
Effect.timeoutOrElse({ duration: limit, orElse: () => Effect.die(stillHere()) }),
|
|
75
|
+
),
|
|
76
|
+
);
|
|
77
|
+
},
|
|
78
|
+
navigatedAway: (prefix: string, settings: { readonly timeout?: number } = {}) => {
|
|
79
|
+
const limit = settings.timeout ?? timeoutMs;
|
|
80
|
+
function timedOut() {
|
|
81
|
+
return Effect.die(
|
|
82
|
+
new Error(
|
|
83
|
+
`The screen did not navigate to ${JSON.stringify(prefix)} within ${limit}ms.\nhelp: Trigger the redirect and check its destination.\nLocation: ${root().ownerDocument.location.href}`,
|
|
84
|
+
),
|
|
85
|
+
);
|
|
86
|
+
}
|
|
87
|
+
return withLive(
|
|
88
|
+
Effect.sync(() => tell(`wait for navigation to ${JSON.stringify(prefix)}`)).pipe(
|
|
89
|
+
Effect.andThen(screenNavigation(root, prefix)),
|
|
90
|
+
Effect.timeoutOrElse({ duration: limit, orElse: timedOut }),
|
|
91
|
+
),
|
|
92
|
+
);
|
|
93
|
+
},
|
|
94
|
+
settle: (settings: { readonly timeoutMs?: number } = {}) => {
|
|
95
|
+
const limit = settings.timeoutMs ?? timeoutMs;
|
|
96
|
+
return withLive(
|
|
97
|
+
Effect.sync(() => tell("wait for the screen's pending work")).pipe(
|
|
98
|
+
Effect.andThen(waitForScreen({ act, pending, root }, Effect.void)),
|
|
99
|
+
Effect.tap(() => Effect.sync(() => tell("the screen has no pending work"))),
|
|
100
|
+
Effect.timeoutOrElse({ duration: limit, orElse: () => Effect.die(unsettled(limit)) }),
|
|
101
|
+
),
|
|
102
|
+
);
|
|
103
|
+
},
|
|
104
|
+
};
|
|
105
|
+
}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import { Effect, Queue, Result, Stream } from "effect";
|
|
2
|
+
import { isClientIdle } from "@shivaedev/contract/clientActivity.ts";
|
|
3
|
+
import { screenMutations } from "#adapters/screenMutations.ts";
|
|
4
|
+
import type { ScreenDriverOptions } from "#screenDriver.ts";
|
|
5
|
+
|
|
6
|
+
type WaitOptions = Required<Pick<ScreenDriverOptions, "act">> & {
|
|
7
|
+
readonly pending: ScreenDriverOptions["pending"];
|
|
8
|
+
readonly root: () => HTMLElement;
|
|
9
|
+
};
|
|
10
|
+
|
|
11
|
+
const observePending = Effect.fnUntraced(function* (pending: ScreenDriverOptions["pending"], changes: Queue.Queue<void>) {
|
|
12
|
+
if (pending === undefined) {
|
|
13
|
+
return Effect.succeed(false);
|
|
14
|
+
}
|
|
15
|
+
if (typeof pending === "function") {
|
|
16
|
+
return Effect.sync(pending);
|
|
17
|
+
}
|
|
18
|
+
let busy = true;
|
|
19
|
+
const states = "current" in pending ? Stream.map(pending, (state) => !isClientIdle(state)) : pending;
|
|
20
|
+
yield* states.pipe(
|
|
21
|
+
Stream.runForEach((value) =>
|
|
22
|
+
Effect.sync(() => {
|
|
23
|
+
busy = value;
|
|
24
|
+
Queue.offerUnsafe(changes, undefined);
|
|
25
|
+
}),
|
|
26
|
+
),
|
|
27
|
+
Effect.forkScoped,
|
|
28
|
+
);
|
|
29
|
+
return "current" in pending ? Effect.map(pending.current, (state) => !isClientIdle(state)) : Effect.sync(() => busy);
|
|
30
|
+
});
|
|
31
|
+
|
|
32
|
+
export const waitForScreen = Effect.fnUntraced(function* <A, E>({ act, pending, root }: WaitOptions, read: Effect.Effect<A, E>) {
|
|
33
|
+
const changes = yield* Queue.sliding<void>(1);
|
|
34
|
+
yield* screenMutations(root(), () => Queue.offerUnsafe(changes, undefined));
|
|
35
|
+
const isBusy = yield* observePending(pending, changes);
|
|
36
|
+
do {
|
|
37
|
+
if (pending !== undefined) {
|
|
38
|
+
yield* Effect.promise(() => act(() => Promise.resolve()));
|
|
39
|
+
}
|
|
40
|
+
if (!(yield* isBusy)) {
|
|
41
|
+
const result = yield* Effect.result(read);
|
|
42
|
+
if (Result.isSuccess(result)) {
|
|
43
|
+
return result.success;
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
yield* pending === undefined ? Queue.take(changes) : Effect.promise((signal) => act(() => Effect.runPromise(Queue.take(changes), { signal })));
|
|
47
|
+
} while (true);
|
|
48
|
+
}, Effect.scoped);
|
package/src/server/outcomes.ts
CHANGED
|
@@ -1,21 +1,30 @@
|
|
|
1
1
|
import { Effect } from "effect";
|
|
2
2
|
import { type DeeplyAllowMatchers, expect } from "vitest";
|
|
3
|
+
import type { NumericBound } from "#adapters/outcomeMatchers.ts";
|
|
3
4
|
|
|
4
5
|
type AnyReadout = Effect.Effect<unknown, unknown, unknown>;
|
|
6
|
+
type NativeMatcher = Exclude<DeeplyAllowMatchers<number>, number>;
|
|
7
|
+
type Expected<T> =
|
|
8
|
+
| NativeMatcher
|
|
9
|
+
| (T extends readonly unknown[]
|
|
10
|
+
? { readonly [TKey in keyof T]: Expected<T[TKey]> }
|
|
11
|
+
: T extends object
|
|
12
|
+
? { readonly [TKey in keyof T]?: Expected<T[TKey]> }
|
|
13
|
+
: T | (T extends number ? NumericBound : never));
|
|
5
14
|
|
|
6
15
|
export const outcomes = Effect.fn("Story.outcomes")(check);
|
|
7
16
|
|
|
8
|
-
function check<TReadouts extends
|
|
17
|
+
function check<TReadouts extends readonly AnyReadout[]>(
|
|
9
18
|
rows: {
|
|
10
|
-
readonly [TKey in keyof TReadouts]: readonly [TReadouts[TKey],
|
|
19
|
+
readonly [TKey in keyof TReadouts]: readonly [string, () => TReadouts[TKey], Expected<Effect.Success<NoInfer<TReadouts[TKey]>>>];
|
|
11
20
|
},
|
|
12
|
-
): Effect.fn.Return<void, Effect.Error<TReadouts[
|
|
13
|
-
function* check(rows:
|
|
14
|
-
const actual: Record<string, unknown> =
|
|
15
|
-
const expected: Record<string, unknown> =
|
|
16
|
-
for (const [label,
|
|
17
|
-
actual[label]
|
|
18
|
-
expected[label]
|
|
21
|
+
): Effect.fn.Return<void, Effect.Error<TReadouts[number]>, Effect.Services<TReadouts[number]>>;
|
|
22
|
+
function* check(rows: readonly (readonly [string, () => AnyReadout, unknown])[]) {
|
|
23
|
+
const actual: Record<string, unknown>[] = [];
|
|
24
|
+
const expected: Record<string, unknown>[] = [];
|
|
25
|
+
for (const [label, readout, value] of rows) {
|
|
26
|
+
actual.push({ [label]: yield* Effect.suspend(readout) });
|
|
27
|
+
expected.push({ [label]: value });
|
|
19
28
|
}
|
|
20
|
-
expect(actual).
|
|
29
|
+
expect(actual).toMatchObject(expected);
|
|
21
30
|
}
|
|
@@ -1,16 +1,17 @@
|
|
|
1
|
-
import { Data, Effect,
|
|
2
|
-
import {
|
|
1
|
+
import { Data, Effect, type Stream } from "effect";
|
|
2
|
+
import type { ClientActivity } from "@shivaedev/contract/clientActivity.ts";
|
|
3
3
|
import { withLive } from "@shivaedev/test/withLive.ts";
|
|
4
|
+
import { screenElements } from "#adapters/screenElements.ts";
|
|
5
|
+
import { nextClientHint } from "#internal/nextClientHint.ts";
|
|
4
6
|
import { targetName } from "#internal/screenAccessibility.ts";
|
|
5
|
-
import { nextClientHint, waitForClient } from "#internal/screenActivity.ts";
|
|
6
|
-
import { screenElements } from "#internal/screenElements.ts";
|
|
7
7
|
import { screenReadouts } from "#internal/screenReadouts.ts";
|
|
8
|
+
import { screenWaits } from "#internal/screenWaits.ts";
|
|
8
9
|
|
|
9
10
|
export type ScreenTarget = string | { readonly role: string; readonly name: string | RegExp };
|
|
10
11
|
|
|
11
12
|
export interface ScreenDriverOptions {
|
|
12
13
|
readonly act?: (action: () => Promise<void>) => PromiseLike<void>;
|
|
13
|
-
readonly pending?: (() => boolean) | ClientActivity;
|
|
14
|
+
readonly pending?: (() => boolean) | Stream.Stream<boolean> | ClientActivity;
|
|
14
15
|
readonly root: HTMLElement | (() => HTMLElement);
|
|
15
16
|
readonly tell: (line: string) => void;
|
|
16
17
|
readonly timeoutMs?: number;
|
|
@@ -33,93 +34,42 @@ export type ScreenDriver<E = never, THintError = MissingClientActivity> = Omit<R
|
|
|
33
34
|
};
|
|
34
35
|
|
|
35
36
|
export function screenDriver(options: ScreenDriverOptions & { readonly pending: ClientActivity }): ScreenDriver<never, never>;
|
|
36
|
-
export function screenDriver(options: ScreenDriverOptions & { readonly pending: () => boolean }): ScreenDriver;
|
|
37
|
+
export function screenDriver(options: ScreenDriverOptions & { readonly pending: (() => boolean) | Stream.Stream<boolean> }): ScreenDriver;
|
|
37
38
|
export function screenDriver(options: ScreenDriverOptions): ScreenDriver<MissingScreenPending>;
|
|
38
39
|
export function screenDriver(options: ScreenDriverOptions): ScreenDriver<MissingScreenPending> {
|
|
40
|
+
return makeDriver(options, true);
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
function makeDriver(options: ScreenDriverOptions, dialogs: boolean): ScreenDriver<MissingScreenPending> {
|
|
39
44
|
const suppliedRoot = options.root;
|
|
40
45
|
const root = typeof suppliedRoot === "function" ? suppliedRoot : () => suppliedRoot;
|
|
41
|
-
const elements = screenElements(root);
|
|
46
|
+
const elements = screenElements(root, dialogs);
|
|
42
47
|
return {
|
|
43
|
-
...makeScreenActions(options),
|
|
48
|
+
...makeScreenActions(options, dialogs),
|
|
44
49
|
within: (container) => {
|
|
45
50
|
function scopedRoot() {
|
|
46
51
|
return container instanceof HTMLElement ? elements.rendered(container, container.tagName.toLowerCase()) : elements.element(container);
|
|
47
52
|
}
|
|
48
53
|
scopedRoot();
|
|
49
|
-
return
|
|
54
|
+
return makeDriver({ ...options, root: scopedRoot }, false);
|
|
50
55
|
},
|
|
51
56
|
};
|
|
52
57
|
}
|
|
53
58
|
|
|
54
|
-
function makeScreenActions({ root, pending, tell, act = (action) => action(), timeoutMs = 3000 }: ScreenDriverOptions) {
|
|
59
|
+
function makeScreenActions({ root, pending, tell, act = (action) => action(), timeoutMs = 3000 }: ScreenDriverOptions, dialogs: boolean) {
|
|
55
60
|
const currentRoot = typeof root === "function" ? root : () => root;
|
|
56
|
-
const elements = screenElements(currentRoot);
|
|
61
|
+
const elements = screenElements(currentRoot, dialogs);
|
|
62
|
+
const waits = screenWaits({ act, pending, root: currentRoot, tell, timeoutMs }, elements);
|
|
57
63
|
function perform(line: string, action: () => void) {
|
|
58
64
|
return Effect.promise(async () => {
|
|
59
65
|
tell(line);
|
|
60
66
|
await act(async () => action());
|
|
61
67
|
});
|
|
62
68
|
}
|
|
63
|
-
|
|
64
|
-
if (pending === undefined) {
|
|
65
|
-
return Effect.fail(new MissingScreenPending());
|
|
66
|
-
}
|
|
67
|
-
return settleWork(pending, options);
|
|
68
|
-
}
|
|
69
|
-
function settleWork(work: NonNullable<ScreenDriverOptions["pending"]>, options: { readonly timeoutMs?: number }) {
|
|
70
|
-
const limit = options.timeoutMs ?? timeoutMs;
|
|
71
|
-
const isIdle = typeof work === "function" ? Effect.sync(() => !work()) : Effect.map(work.current, isClientIdle);
|
|
72
|
-
const wait = Effect.gen(function* () {
|
|
73
|
-
tell("wait for the screen's pending work");
|
|
74
|
-
do {
|
|
75
|
-
yield* Effect.promise(() => act(async () => undefined));
|
|
76
|
-
if (yield* isIdle) {
|
|
77
|
-
tell("the screen has no pending work");
|
|
78
|
-
return;
|
|
79
|
-
}
|
|
80
|
-
yield* typeof work === "function"
|
|
81
|
-
? Effect.promise(() => act(() => new Promise<void>((resolve) => setTimeout(resolve, 10))))
|
|
82
|
-
: Effect.promise((signal) => act(() => Effect.runPromise(waitForClient(work), { signal })));
|
|
83
|
-
} while (true);
|
|
84
|
-
});
|
|
85
|
-
function timedOut() {
|
|
86
|
-
return Effect.die(
|
|
87
|
-
new Error(
|
|
88
|
-
`The screen did not settle within ${limit}ms.\nhelp: Release held requests and check the app's pending signal and renderer act adapter.\nScreen: ${currentRoot().textContent}`,
|
|
89
|
-
),
|
|
90
|
-
);
|
|
91
|
-
}
|
|
92
|
-
return withLive(wait.pipe(Effect.timeoutOrElse({ duration: limit, orElse: timedOut })));
|
|
93
|
-
}
|
|
94
|
-
function find(target: ScreenTarget, options: { readonly timeout?: number } = {}) {
|
|
95
|
-
if (pending !== undefined && typeof pending !== "function") {
|
|
96
|
-
return settleWork(pending, { timeoutMs: options.timeout ?? timeoutMs }).pipe(
|
|
97
|
-
Effect.andThen(
|
|
98
|
-
Effect.sync(() => {
|
|
99
|
-
tell(`find ${targetName(target)}`);
|
|
100
|
-
return elements.element(target);
|
|
101
|
-
}),
|
|
102
|
-
),
|
|
103
|
-
);
|
|
104
|
-
}
|
|
105
|
-
return withLive(
|
|
106
|
-
Effect.gen(function* () {
|
|
107
|
-
tell(`find ${targetName(target)}`);
|
|
108
|
-
return yield* Effect.tryPromise(async () => {
|
|
109
|
-
await act(async () => undefined);
|
|
110
|
-
return elements.element(target);
|
|
111
|
-
}).pipe(
|
|
112
|
-
Effect.retry(Schedule.spaced(10)),
|
|
113
|
-
Effect.timeoutOrElse({
|
|
114
|
-
duration: options.timeout ?? timeoutMs,
|
|
115
|
-
orElse: () => Effect.sync(() => elements.element(target)),
|
|
116
|
-
}),
|
|
117
|
-
);
|
|
118
|
-
}),
|
|
119
|
-
);
|
|
120
|
-
}
|
|
69
|
+
|
|
121
70
|
return {
|
|
122
|
-
...screenReadouts(currentRoot, tell),
|
|
71
|
+
...screenReadouts(currentRoot, tell, dialogs),
|
|
72
|
+
...waits,
|
|
123
73
|
click: (selector: ScreenTarget) =>
|
|
124
74
|
perform(`click ${targetName(selector)}`, () => {
|
|
125
75
|
const element = elements.element(selector);
|
|
@@ -128,9 +78,8 @@ function makeScreenActions({ root, pending, tell, act = (action) => action(), ti
|
|
|
128
78
|
element.click();
|
|
129
79
|
}),
|
|
130
80
|
enter: (selector: ScreenTarget, value: string) => perform(`enter a value in ${targetName(selector)}`, () => elements.enter(selector, value)),
|
|
131
|
-
find,
|
|
132
81
|
nextLiveHint: () => {
|
|
133
|
-
if (pending === undefined || typeof pending === "function") {
|
|
82
|
+
if (pending === undefined || typeof pending === "function" || !("current" in pending)) {
|
|
134
83
|
return Effect.fail(new MissingClientActivity());
|
|
135
84
|
}
|
|
136
85
|
return withLive(
|
|
@@ -139,7 +88,10 @@ function makeScreenActions({ root, pending, tell, act = (action) => action(), ti
|
|
|
139
88
|
),
|
|
140
89
|
);
|
|
141
90
|
},
|
|
142
|
-
|
|
91
|
+
select: (selector: ScreenTarget, value: string) =>
|
|
92
|
+
perform(`select ${JSON.stringify(value)} in ${targetName(selector)}`, () => elements.select(selector, value)),
|
|
93
|
+
settle: (settings?: { readonly timeoutMs?: number }) =>
|
|
94
|
+
pending === undefined ? Effect.fail(new MissingScreenPending()) : waits.settle(settings),
|
|
143
95
|
submit: (selector: ScreenTarget = "form") => perform(`submit ${targetName(selector)}`, () => elements.form(selector).requestSubmit()),
|
|
144
96
|
};
|
|
145
97
|
}
|
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
import { Effect } from "effect";
|
|
2
|
-
import { type ClientActivity } from "@shivaedev/contract/clientActivity.ts";
|
|
3
|
-
export declare function waitForClient(activity: ClientActivity): Effect.Effect<void, never, never>;
|
|
4
|
-
export declare const nextClientHint: (activity: ClientActivity) => Effect.Effect<void, never, never>;
|
|
5
|
-
//# sourceMappingURL=screenActivity.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"screenActivity.d.ts","sourceRoot":"","sources":["../../../src/server/internal/screenActivity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAU,MAAM,QAAQ,CAAC;AACxC,OAAO,EAAE,KAAK,cAAc,EAAgB,MAAM,uCAAuC,CAAC;AAE1F,wBAAgB,aAAa,CAAC,QAAQ,EAAE,cAAc,qCAErD;AAED,eAAO,MAAM,cAAc,iEAOzB,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"screenActivity.js","sourceRoot":"","sources":["../../../src/server/internal/screenActivity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AACxC,OAAO,EAAuB,YAAY,EAAE,MAAM,uCAAuC,CAAC;AAE1F,MAAM,UAAU,aAAa,CAAC,QAAwB;IACrD,OAAO,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;AACpF,CAAC;AAED,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,QAAwB;IAClF,MAAM,MAAM,GAAG,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC;IACnD,OAAO,KAAK,CAAC,CAAC,QAAQ,CAAC,IAAI,CAC1B,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,GAAG,MAAM,CAAC,EAClD,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EACd,MAAM,CAAC,QAAQ,CACf,CAAC;AACH,CAAC,CAAC,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"screenElements.d.ts","sourceRoot":"","sources":["../../../src/server/internal/screenElements.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,WAAW;wBAO1B,YAAY;qBAsBf,WAAW,YAAY,YAAY;sBAQxC,YAAY,SAAS,MAAM;qBAY5B,YAAY;sBA7BL,YAAY;sBAnBZ,WAAW,YAAY,MAAM;;EA4DtD"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"screenElements.js","sourceRoot":"","sources":["../../../src/server/internal/screenElements.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AAEvF,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,MAAM,UAAU,cAAc,CAAC,IAAuB;IACrD,SAAS,QAAQ,CAAC,KAAkB,EAAE,QAAgB;QACrD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,gBAAgB,QAAQ,8FAA8F,CAAC,CAAC;QACzI,CAAC;QACD,OAAO,KAAK,CAAC;IACd,CAAC;IACD,SAAS,OAAO,CAAC,QAAsB;QACtC,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAClC,OAAO,WAAW,CAAC,IAAI,EAAE,EAAE,QAAQ,CAAC,CAAC;QACtC,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,EAAE,CAAC,gBAAgB,CAAc,QAAQ,CAAC,CAAC;QAC/D,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QACzB,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACjD,MAAM,IAAI,KAAK,CACd,kBAAkB,OAAO,CAAC,MAAM,gBAAgB,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,sEAAsE,CAC9I,CAAC;QACH,CAAC;QACD,OAAO,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAClC,CAAC;IACD,SAAS,KAAK,CAAC,QAAsB;QACpC,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;QAChC,IAAI,CAAC,CAAC,KAAK,YAAY,gBAAgB,IAAI,KAAK,YAAY,mBAAmB,CAAC,EAAE,CAAC;YAClF,MAAM,IAAI,KAAK,CACd,gBAAgB,UAAU,CAAC,QAAQ,CAAC,4FAA4F,CAChI,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACd,CAAC;IACD,SAAS,OAAO,CAAC,KAAkB,EAAE,QAAsB;QAC1D,IAAI,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;YAC5D,MAAM,IAAI,KAAK,CAAC,gBAAgB,UAAU,CAAC,QAAQ,CAAC,kFAAkF,CAAC,CAAC;QACzI,CAAC;IACF,CAAC;IACD,OAAO;QACN,OAAO;QACP,OAAO;QACP,KAAK,EAAE,CAAC,QAAsB,EAAE,KAAa,EAAE,EAAE;YAChD,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;YAC9B,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YACzB,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;gBACpB,MAAM,IAAI,KAAK,CAAC,gBAAgB,UAAU,CAAC,QAAQ,CAAC,6DAA6D,CAAC,CAAC;YACpH,CAAC;YACD,KAAK,CAAC,KAAK,EAAE,CAAC;YACd,MAAM,SAAS,GAAG,KAAK,YAAY,gBAAgB,CAAC,CAAC,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC,mBAAmB,CAAC,SAAS,CAAC;YACjH,MAAM,CAAC,wBAAwB,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YAC7E,KAAK,CAAC,aAAa,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YAC3D,KAAK,CAAC,aAAa,CAAC,IAAI,KAAK,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAC7D,CAAC;QACD,IAAI,EAAE,CAAC,QAAsB,EAAE,EAAE;YAChC,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;YAChC,IAAI,CAAC,CAAC,KAAK,YAAY,eAAe,CAAC,EAAE,CAAC;gBACzC,MAAM,IAAI,KAAK,CAAC,gBAAgB,UAAU,CAAC,QAAQ,CAAC,0DAA0D,CAAC,CAAC;YACjH,CAAC;YACD,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YACzB,OAAO,KAAK,CAAC;QACd,CAAC;QACD,KAAK;QACL,QAAQ;QACR,IAAI,EAAE,UAAU;KAChB,CAAC;AACH,CAAC"}
|