pj/sanderling
1
0 Fork 0
mirror of https://github.com/priyanshujain/sanderling.git synced 2026-10-02 19:17:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: remove snapshots from writing-specs

Browse Source
This commit is contained in:
pj committed 2026-04-25 19:20:25 +07:00
1 parent eea760d6ed
commit 74e0744ae3
1 file changed
-27
Download Patch File Download Diff File Expand all files Collapse all files
docs/manual/writing-specs.md
-27
View File
@@ -11,7 +11,6 @@ import { extract, always, now, actions, weighted, Tap, taps, swipes } from "@san
// 1. Extractors pull values from each observed state. // 1. Extractors pull values from each observed state.
const loggedIn = extract((s) => !!s.ax.find("id:home-tab-bar")); const loggedIn = extract((s) => !!s.ax.find("id:home-tab-bar"));
const cartCount = extract<number>((s) => (s.snapshots.cart_count as number) ?? 0);
// 2. Properties are LTL formulas evaluated every step. // 2. Properties are LTL formulas evaluated every step.
export const properties = { export const properties = {
@@ -34,7 +33,6 @@ What extractors see:
```ts ```ts
interface State { interface State {
ax: AccessibilityTree; // view hierarchy ax: AccessibilityTree; // view hierarchy
snapshots: Record<string, unknown>; // values registered by the in-app SDK
screen: { id: string; hash: string }; screen: { id: string; hash: string };
lastAction: Action | null; lastAction: Action | null;
logs: LogEntry[]; // since previous state logs: LogEntry[]; // since previous state
@@ -45,8 +43,6 @@ interface State {
`ax.find("text:Click me")`, `ax.find("id:login-form")`, `ax.findAll("role:todo-row")` are the common accessors. Prefer stable testID-style identifiers over positional selectors, for the same reason you would in Espresso or XCUITest. `ax.find("text:Click me")`, `ax.find("id:login-form")`, `ax.findAll("role:todo-row")` are the common accessors. Prefer stable testID-style identifiers over positional selectors, for the same reason you would in Espresso or XCUITest.
`snapshots` is populated by the in-app SDK via `Sanderling.extract("name") { value }`. Use it when the UI does not expose a value you need, such as business-logic state or hidden fields.
## Pattern: preconditions (login, onboarding) ## Pattern: preconditions (login, onboarding)
sanderling has no setup phase and no fixtures. Preconditions are action generators with two properties: sanderling has no setup phase and no fixtures. Preconditions are action generators with two properties:
@@ -129,29 +125,6 @@ loginSucceedsWithin30s: eventually(() => loggedIn.current).within(30, "seconds")
`within` takes `"milliseconds"`, `"seconds"`, or `"steps"`. Useful for liveness checks: the loading spinner eventually goes away, the deep link eventually lands on `/home`. `within` takes `"milliseconds"`, `"seconds"`, or `"steps"`. Useful for liveness checks: the loading spinner eventually goes away, the deep link eventually lands on `/home`.
## Pattern: snapshot-backed properties
When the UI does not expose a value but the app knows it, use the SDK's extractor registry:
```kotlin
// in the app (Android)
Sanderling.extract("cart_count") { store.cart.size }
```
```ts
// in the spec
const cartCount = extract<number>((s) => (s.snapshots.cart_count as number) ?? 0);
export const properties = {
cartMonotonicAfterAdd: always(() => {
const previous = cartCount.previous;
return previous === undefined || cartCount.current >= previous;
}),
};
```
This pattern lets you write properties against business logic that no UI element exposes.
## Pattern: weighted exploration sub-trees ## Pattern: weighted exploration sub-trees
Nest `weighted` to group related actions and tune their collective rate: Nest `weighted` to group related actions and tune their collective rate: