Files
odysseus/static/js/features/notes/application/state.js
T
Alexandre TeixeiraandLéo f1a47f3812 refactor(notes): decompose Notes into feature-owned modules (#6713)
* refactor(notes): decompose Notes into feature-owned modules

* fix(notes): avoid HTML interpolation in reminder picker

* docs(notes): drop checkpoint archives, session logs and publication drafts

The N0-N6 tarballs and raw pytest/node logs are not read by any script or
test, and the logs carry absolute home-directory paths. Once squashed into
dev they would stay in history for good. notes-pr.md and notes-issue.md
were the drafts used to open #6712 and #6713, not documentation.

notes-validation.md keeps the counts, the checkpoint hashes and
implementation.sha256 as the record; local interpreter paths and the local
Docker image name are replaced with portable placeholders.

* fix(notes): keep the state store raw and stop masonry re-observing after close

- state: writes built from views (filter, spread, splice) stored nested
  read-only views in the store, so structuredClone on a stored note threw
  DataCloneError. Store writes now unwrap nested views.
- layout: a save that resolves after closePanel re-renders the leaving pane
  and re-created the masonry ResizeObserver that teardown had disposed.
  Skip creating it once Notes is closed.
- index.js: drop 30 imported or declared names that were never used and
  group the imports at the top. Import order is unchanged.
- Revert unrelated punctuation edits in .gitattributes and keep the header
  comment and docstring first in compare/vote.js and
  test_notes_dom_xss_helpers.py.

Both fixes have a node test that fails on the previous head.

* test(notes): make script rejection assertion case-insensitive

Address CodeQL js/bad-tag-filter alert #1150 in test-only assertion and refresh Notes evidence manifest checksum.

---------

Co-authored-by: Léo <leograndcontact@gmail.com>
2026-10-15 09:29:41 +01:00

84 lines
5.1 KiB
JavaScript

/** The sole Notes state owner. Views have live read-only access; writes use operations. */
export function createNotesState(initial = {}) {
const values = {
open: false, notes: [], editingId: null, selectedIds: new Set(),
activeLabel: null, activeFilter: null, reminderChipNext: 'reminders', searchQuery: '',
viewMode: initial.viewMode || 'list', showingArchived: false, selectMode: false,
suppressNextNoteTapId: null, labelsCollapsed: !!initial.labelsCollapsed,
loading: false, firedDotDismissedAt: initial.firedDotDismissedAt || 0,
};
// Preserve captured note identity across asynchronous completions without
// giving a view a writable reference to the application store.
const views = new WeakMap(), targets = new WeakMap();
const unwrap = value => targets.get(value) || value;
// Copies built from views (spread, filter, map) still hold nested views;
// store only raw data so the owner never keeps its own read-only views.
function unwrapDeep(value, seen = new WeakSet()) {
if (!value || typeof value !== 'object') return value;
if (targets.has(value)) return targets.get(value);
if (seen.has(value)) return value;
seen.add(value);
if (Array.isArray(value)) value.forEach((item, index) => { value[index] = unwrapDeep(item, seen); });
else if (Object.getPrototypeOf(value) === Object.prototype) for (const key of Object.keys(value)) value[key] = unwrapDeep(value[key], seen);
return value;
}
function readonly(value) {
if (!value || typeof value !== 'object') return value;
if (targets.has(value)) return value;
if (views.has(value)) return views.get(value);
const view = new Proxy(value, {
get(target, key) {
if (target instanceof Set) {
if (['add', 'delete', 'clear'].includes(key)) return () => { throw new TypeError('Use Notes selection operations'); };
if (key === 'valueOf') return () => views.get(target);
if (key === 'forEach') return (callback, thisArg) => target.forEach(value => callback.call(thisArg, value, value, views.get(target)));
const member = Reflect.get(target, key, target);
return typeof member === 'function' ? member.bind(target) : member;
}
return readonly(Reflect.get(target, key));
},
set() { throw new TypeError('Use Notes state operations'); },
deleteProperty() { throw new TypeError('Use Notes state operations'); },
defineProperty() { throw new TypeError('Use Notes state operations'); },
setPrototypeOf() { throw new TypeError('Use Notes state operations'); },
preventExtensions() { throw new TypeError('Use Notes state operations'); },
getOwnPropertyDescriptor(target, key) {
const descriptor = Reflect.getOwnPropertyDescriptor(target, key);
if (descriptor && 'value' in descriptor) return { ...descriptor, value: readonly(descriptor.value) };
return descriptor;
},
});
views.set(value, view); targets.set(view, value);
return view;
}
const state = Object.freeze(Object.fromEntries(Object.keys(values).map(key => [key, () => readonly(values[key])])));
const view = Object.freeze(Object.defineProperties({}, Object.fromEntries(Object.entries(state).map(([key, get]) => [key, { get, enumerable: true }]))));
return {
state: view,
setOpen: value => { values.open = value; },
setEditingId: value => { values.editingId = value; },
setActiveLabel: value => { values.activeLabel = value; },
setActiveFilter: value => { values.activeFilter = value; },
setReminderChipNext: value => { values.reminderChipNext = value; },
setSearchQuery: value => { values.searchQuery = value; },
setViewMode: value => { values.viewMode = value; },
setShowingArchived: value => { values.showingArchived = value; },
setSelectMode: value => { values.selectMode = value; },
setSuppressNextNoteTapId: value => { values.suppressNextNoteTapId = value; },
setLabelsCollapsed: value => { values.labelsCollapsed = value; },
setLoading: value => { values.loading = value; },
setFiredDotDismissedAt: value => { values.firedDotDismissedAt = value; },
replaceNotes: notes => { values.notes = notes; },
removeNoteAt: index => readonly(values.notes.splice(index, 1)[0]),
insertNoteAt: (index, note) => { values.notes.splice(index, 0, unwrapDeep(note)); },
prependNote: note => { values.notes.unshift(unwrapDeep(note)); },
replaceNoteAt: (index, note) => { values.notes[index] = unwrapDeep(note); },
mergeNote: (note, patch) => { for (const [key, value] of Object.entries(patch)) unwrap(note)[key] = unwrapDeep(value); },
updateItem: (note, index, patch) => { Object.assign(unwrap(unwrap(note).items[index]), unwrapDeep({ ...patch })); },
spliceItems: (note, ...args) => unwrap(unwrap(note).items).splice(...args.map(arg => unwrapDeep(arg))),
selectId: id => { values.selectedIds.add(id); },
deselectId: id => values.selectedIds.delete(id),
clearSelection: () => values.selectedIds.clear(),
};
}