Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions renderers/lit/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 20 additions & 2 deletions renderers/web_core/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions renderers/web_core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@
"types": "./dist/src/v0_8/index.d.ts",
"default": "./dist/src/v0_8/index.js"
},
"./v0_9": {
"types": "./dist/src/v0_9/index.d.ts",
"default": "./dist/src/v0_9/index.js"
},
"./types/*": {
"types": "./dist/src/v0_8/types/*.d.ts",
"default": "./dist/src/v0_8/types/*.js"
Expand Down Expand Up @@ -69,6 +73,7 @@
"author": "Google",
"license": "Apache-2.0",
"devDependencies": {
"@types/node": "^24.10.1",
"typescript": "^5.8.3",
"wireit": "^0.15.0-pre.2"
}
Expand Down
203 changes: 203 additions & 0 deletions renderers/web_core/src/v0_9/state/data-model.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,203 @@

import assert from 'node:assert';
import { test, describe, it, beforeEach } from 'node:test';
import { DataModel } from './data-model.js';

describe('DataModel', () => {
let model: DataModel;

beforeEach(() => {
model = new DataModel({
user: {
name: 'Alice',
settings: {
theme: 'dark'
}
},
items: ['a', 'b', 'c']
});
});

// --- Basic Retrieval ---

it('retrieves root data', () => {
assert.deepStrictEqual(model.get('/'), { user: { name: 'Alice', settings: { theme: 'dark' } }, items: ['a', 'b', 'c'] });
});

it('retrieves nested path', () => {
assert.strictEqual(model.get('/user/name'), 'Alice');
assert.strictEqual(model.get('/user/settings/theme'), 'dark');
});

it('retrieves array items', () => {
assert.strictEqual(model.get('/items/0'), 'a');
assert.strictEqual(model.get('/items/1'), 'b');
});

it('returns undefined for non-existent paths', () => {
assert.strictEqual(model.get('/user/age'), undefined);
assert.strictEqual(model.get('/unknown/path'), undefined);
});

// --- Updates ---

it('sets value at existing path', () => {
model.set('/user/name', 'Bob');
assert.strictEqual(model.get('/user/name'), 'Bob');
});

it('sets value at new path', () => {
model.set('/user/age', 30);
assert.strictEqual(model.get('/user/age'), 30);
});

it('creates intermediate objects', () => {
model.set('/a/b/c', 'foo');
assert.strictEqual(model.get('/a/b/c'), 'foo');
assert.notStrictEqual(model.get('/a/b'), undefined);
});

it('removes keys when value is undefined', () => {
model.set('/user/name', undefined);
assert.strictEqual(model.get('/user/name'), undefined);
assert.strictEqual(Object.keys(model.get('/user')).includes('name'), false);
});

it('replaces root object on root update', () => {
model.set('/', { newRoot: true });
assert.deepStrictEqual(model.get('/'), { newRoot: true });
});

// --- Array / List Handling (Flutter Parity) ---

it('List: set and get', () => {
model.set('/list/0', 'hello');
assert.strictEqual(model.get('/list/0'), 'hello');
assert.ok(Array.isArray(model.get('/list')));
});

it('List: append and get', () => {
model.set('/list/0', 'hello');
model.set('/list/1', 'world');
assert.strictEqual(model.get('/list/0'), 'hello');
assert.strictEqual(model.get('/list/1'), 'world');
assert.strictEqual(model.get('/list').length, 2);
});

it('List: update existing index', () => {
model.set('/items/1', 'updated');
assert.strictEqual(model.get('/items/1'), 'updated');
});

it('Nested structures are created automatically', () => {
// Should create nested map and list: { a: { b: [ { c: 123 } ] } }
model.set('/a/b/0/c', 123);
assert.strictEqual(model.get('/a/b/0/c'), 123);
assert.ok(Array.isArray(model.get('/a/b')));
assert.ok(!Array.isArray(model.get('/a/b/0')));

// Should create nested maps
model.set('/x/y/z', 'hello');
assert.strictEqual(model.get('/x/y/z'), 'hello');

// Should create nested lists
model.set('/nestedList/0/0', 'inner');
assert.strictEqual(model.get('/nestedList/0/0'), 'inner');
assert.ok(Array.isArray(model.get('/nestedList')));
assert.ok(Array.isArray(model.get('/nestedList/0')));
});

// --- Subscriptions ---

it('returns a subscription object', () => {
model.set('/a', 1);
const sub = model.subscribe<number>('/a');
assert.strictEqual(sub.value, 1);

let updatedValue: number | undefined;
sub.onChange = (val) => updatedValue = val;

model.set('/a', 2);
assert.strictEqual(sub.value, 2);
assert.strictEqual(updatedValue, 2);

sub.unsubscribe();
// Verify listener removed
model.set('/a', 3);
assert.strictEqual(updatedValue, 2);
});

it('notifies subscribers on exact match', (_: any, done: (result?: any) => void) => {
const sub = model.subscribe('/user/name');
sub.onChange = (val) => {
assert.strictEqual(val, 'Charlie');
done();
};
model.set('/user/name', 'Charlie');
});

it('notifies ancestor subscribers (Container Semantics)', (_: any, done: (result?: any) => void) => {
const sub = model.subscribe('/user');
sub.onChange = (val: any) => {
assert.strictEqual(val.name, 'Dave');
done();
};
model.set('/user/name', 'Dave');
});

it('notifies descendant subscribers', (_: any, done: (result?: any) => void) => {
const sub = model.subscribe('/user/settings/theme');
sub.onChange = (val) => {
assert.strictEqual(val, 'light');
done();
};

// We update the parent object
model.set('/user/settings', { theme: 'light' });
});

it('notifies root subscriber', (_: any, done: (result?: any) => void) => {
const sub = model.subscribe('/');
sub.onChange = (val: any) => {
assert.strictEqual(val.newProp, 'test');
done();
};
model.set('/newProp', 'test');
});

it('notifies parent when child updates', () => {
model.set('/parent', { child: 'initial' });

const sub = model.subscribe('/parent');
let parentValue: any;
sub.onChange = (val) => parentValue = val;

model.set('/parent/child', 'updated');
assert.deepStrictEqual(parentValue, { child: 'updated' });
});

it('stops notifying after dispose', () => {
let count = 0;
const sub = model.subscribe('/');
sub.onChange = () => count++;

model.dispose();
model.set('/foo', 'bar');
assert.strictEqual(count, 0);
});

it('throws when trying to set nested property through a primitive', () => {
model.set('/user/name', 'not an object');
assert.strictEqual(model.get('/user/name'), 'not an object');

assert.throws(() => {
model.set('/user/name/first', 'Alice');
}, /Cannot set path/);
});

it('throws when using non-numeric segment on an array', () => {
assert.throws(() => {
model.set('/items/foo', 'bar');
}, /Cannot use non-numeric segment/);
});
});
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This is a great set of tests! To make it even more robust, I recommend adding a test case to verify the behavior of set when a path segment contains a primitive value. This will ensure the fix for the issue I mentioned in data-model.ts is covered and prevent regressions.

Here's a suggested test case:

Suggested change
});
it('overwrites primitive values in path when setting nested properties', () => {
model.set('/user/name', 'not an object');
assert.strictEqual(model.get('/user/name'), 'not an object');
// Now, try to set a nested property. This should overwrite the primitive.
model.set('/user/name/first', 'Alice');
assert.deepStrictEqual(model.get('/user/name'), { first: 'Alice' });
assert.strictEqual(model.get('/user/name/first'), 'Alice');
});
});
References
  1. The style guide requires that code changes should have tests. While tests are present, this comment suggests adding a test for a critical edge case that was missed, improving test coverage and robustness. (link)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a test case for this, but verify failure as explained above.

Loading
Loading