@verdant-web/common 2.3.3 → 2.4.0-next.0

package/src/oids.ts

@@ -29,10 +29,7 @@ import { isObject, assert } from './utils.js';
 
 export type ObjectIdentifier = string;
 
-export const LEGACY_OID_KEY = '__@@oid_do_not_use';
-export const OID_KEY = '@@id';
-
-const COLLECTION_SEPARATOR = '/';
+const SEGMENT_SEPARATOR = '/';
 const RANDOM_SEPARATOR = ':';
 
 /**
@@ -54,7 +51,7 @@ export function maybeGetOid(obj: any): ObjectIdentifier | undefined {
 	if (!isObject(obj)) {
 		return undefined;
 	}
-	return oidMap.get(obj) ?? obj[OID_KEY] ?? obj[LEGACY_OID_KEY];
+	return oidMap.get(obj);
 }
 
 export function assignOid(obj: any, oid: ObjectIdentifier) {
@@ -78,10 +75,6 @@ export function removeOid(obj: any) {
 	return obj;
 }
 
-export function isOidKey(key: string) {
-	return key === OID_KEY || key === LEGACY_OID_KEY;
-}
-
 /**
  * For sub-objects, assign a random sub-OID if no OID
  * is already assigned.
@@ -141,6 +134,11 @@ function unsanitizeFragment(id: string) {
 		.replace(/˙/g, '.');
 }
 
+/**
+ * Creates an OID for the document with a particular ID.
+ * To create a sub-object OID, use createSubOid and pass
+ * the root OID.
+ */
 export function createOid(
 	collection: string,
 	documentId: string,
@@ -148,7 +146,7 @@ export function createOid(
 ) {
 	let oid =
 		sanitizeFragment(collection) +
-		COLLECTION_SEPARATOR +
+		SEGMENT_SEPARATOR +
 		sanitizeFragment(documentId);
 	if (subId) {
 		oid += RANDOM_SEPARATOR + subId;
@@ -169,18 +167,26 @@ export function decomposeOid(oid: ObjectIdentifier): {
 	id: string;
 	subId?: string;
 } {
-	const [core, random] = oid.split(RANDOM_SEPARATOR);
-	let [collection, idOrLegacyPathId, ...others] = core.split('/');
-	// if there's more than one slash... something went wrong, but we can just bolt the rest on.
+	let [collection, coreId, ...others] = oid.split('/');
+	// if 'others' exists, something's off, but maybe we can recover...
+	// by assuming the last segment is the authz and bolting the rest onto coreId
 	if (others.length) {
-		idOrLegacyPathId += '/' + others.join('/');
+		console.error(
+			`OID ${oid} has more than 3 segments. Attempting to parse it anyway.`,
+		);
+		coreId += '/' + others.join('/');
 	}
+
+	const [idOrLegacyPathId, random] = coreId.split(RANDOM_SEPARATOR);
+
 	let id;
+	// legacy path handling. shouldn't be necessary anymore.
 	if (idOrLegacyPathId.includes('.')) {
 		id = idOrLegacyPathId.slice(0, idOrLegacyPathId.indexOf('.'));
 	} else {
 		id = idOrLegacyPathId;
 	}
+
 	return {
 		collection: unsanitizeFragment(collection),
 		id: unsanitizeFragment(id),
@@ -230,84 +236,6 @@ export function assignOidsToAllSubObjects(
 	}
 }
 
-export function assignOidProperty(obj: any, oid: ObjectIdentifier) {
-	assert(
-		isObject(obj),
-		`Only objects can be assigned OIDs, received ${JSON.stringify(obj)}`,
-	);
-	obj[OID_KEY] = oid;
-	return obj;
-}
-
-export function maybeGetOidProperty(obj: any) {
-	if (!isObject(obj)) {
-		return undefined;
-	}
-	return obj[OID_KEY] || obj[LEGACY_OID_KEY];
-}
-
-function removeOidProperty(obj: any) {
-	if (!isObject(obj)) {
-		return obj;
-	}
-	delete obj[LEGACY_OID_KEY];
-	delete obj[OID_KEY];
-	return obj;
-}
-
-function transferOidFromSystemToProperty(obj: any) {
-	const oid = maybeGetOid(obj);
-	if (oid) {
-		assignOidProperty(obj, oid);
-	}
-}
-
-/**
- * Assigns a special property to all objects in the given object
- * which have an OID
- */
-export function assignOidPropertiesToAllSubObjects(obj: any) {
-	transferOidFromSystemToProperty(obj);
-
-	if (Array.isArray(obj)) {
-		for (let i = 0; i < obj.length; i++) {
-			assignOidPropertiesToAllSubObjects(obj[i]);
-		}
-	} else if (isObject(obj)) {
-		for (const key of Object.keys(obj)) {
-			assignOidPropertiesToAllSubObjects(obj[key]);
-		}
-	}
-}
-
-function copyOidFromPropertyToSystem(obj: any) {
-	const oid = maybeGetOidProperty(obj);
-	if (oid) {
-		assignOid(obj, oid);
-	}
-}
-
-/**
- *
- * Removes the special property from all objects in the given object
- * which have an OID, transferring the OID from the property to the OID
- * system in-memory.
- */
-export function removeOidPropertiesFromAllSubObjects(obj: any) {
-	copyOidFromPropertyToSystem(obj);
-	removeOidProperty(obj);
-
-	if (Array.isArray(obj)) {
-		for (let i = 0; i < obj.length; i++) {
-			removeOidPropertiesFromAllSubObjects(obj[i]);
-		}
-	} else if (isObject(obj)) {
-		for (const key of Object.keys(obj)) {
-			removeOidPropertiesFromAllSubObjects(obj[key]);
-		}
-	}
-}
-
 export function removeOidsFromAllSubObjects(obj: any) {
 	removeOid(obj);
 
@@ -442,10 +370,6 @@ export function getOidSubIdRange(oid: ObjectIdentifier) {
 	const lastSubId = createSubOid(root, () => '\uffff');
 	return [`${root}${RANDOM_SEPARATOR}`, lastSubId];
 }
-export function getLegacyDotOidSubIdRange(oid: ObjectIdentifier) {
-	const root = getOidRoot(oid);
-	return [`${root}.`, `${root}.\uffff`];
-}
 
 export function getRoots(oids: ObjectIdentifier[]) {
 	const set = new Set<ObjectIdentifier>();
@@ -459,6 +383,10 @@ export function areOidsRelated(oidA: ObjectIdentifier, oidB: ObjectIdentifier) {
 	return getOidRoot(oidA) === getOidRoot(oidB);
 }
 
+export function isRootOid(oid: ObjectIdentifier) {
+	return !oid.includes(RANDOM_SEPARATOR);
+}
+
 /**
  * Recursively rewrites any OIDs in an object which are 'foreign' -
  * i.e. relate to some other object/entity - to be local to the
@@ -493,29 +421,3 @@ function migrateForeignOid(parentOid: ObjectIdentifier, child: any) {
 		);
 	}
 }
-
-export function isLegacyDotOid(oid: ObjectIdentifier) {
-	const partBeforeRandomSep = oid.split(RANDOM_SEPARATOR)[0];
-	return partBeforeRandomSep.includes('.');
-}
-
-export function convertLegacyOid(oid: ObjectIdentifier) {
-	const { collection, id, subId } = decomposeOid(oid);
-	return createOid(collection, id, subId);
-}
-
-export const MATCH_LEGACY_OID_JSON_STRING = /"\w+\/[^"]+?(\.[^"]+)+\:[\S]+?"/g;
-export function replaceLegacyOidsInJsonString(string: string) {
-	// replace every match of a legacy OID, converting to a new OID
-	return string.replaceAll(MATCH_LEGACY_OID_JSON_STRING, (match) => {
-		const legacyOid = match.slice(1, match.length - 1);
-		return `"${convertLegacyOid(legacyOid)}"`;
-	});
-}
-export function replaceLegacyOidsInObject(obj: any) {
-	return JSON.parse(replaceLegacyOidsInJsonString(JSON.stringify(obj)));
-}
-
-export function isRootOid(oid: ObjectIdentifier) {
-	return !oid.includes(RANDOM_SEPARATOR);
-}

package/src/oidsLegacy.test.ts

@@ -0,0 +1,147 @@
+import { describe, expect, it } from 'vitest';
+import {
+	getLegacyDotOidSubIdRange,
+	MATCH_LEGACY_OID_JSON_STRING,
+	replaceLegacyOidsInObject,
+} from './oidsLegacy.js';
+import {
+	areOidsRelated,
+	createSubOid,
+	getOidRoot,
+	ObjectIdentifier,
+} from './oids.js';
+
+describe('handling legacy OIDs', () => {
+	it('should get the root OID for a legacy OID', () => {
+		expect(getOidRoot('items/clabgyjfh00003968qycsq3ld.inputs.#')).toEqual(
+			'items/clabgyjfh00003968qycsq3ld',
+		);
+	});
+	it('should create sub-ids for legacy OIDs in new format', () => {
+		expect(
+			createSubOid(
+				'items/clabgyjfh00003968qycsq3ld.inputs.#',
+				() => 'pseudorandom',
+			),
+		).toEqual('items/clabgyjfh00003968qycsq3ld:pseudorandom');
+	});
+	it('should identify new sub-OIDs as related to the legacy root OID', () => {
+		expect(
+			areOidsRelated(
+				'items/clabgyjfh00003968qycsq3ld.inputs.#',
+				'items/clabgyjfh00003968qycsq3ld:pseudorandom',
+			),
+		).toBe(true);
+	});
+	it.each([
+		['items/clabgyjfh00003968qycsq3ld.inputs.#:baz', true],
+		// include more unicode chars
+		['items/clabgyjfh00003968qycsq3ld\ufea3.inputs\u39fc.#:baz!!!', true],
+		// not matching new oids
+		['items/clabgyjfh00003968qycsq3ld', false],
+		['items/clabgyjfh00003968qycsq3ld:baz', false],
+		['items/clabgyjfh00003968qycsq3ld:baz1111', false],
+		// not matching anything else
+		[
+			'PREPARE SOUS VIDE BATH: Fill container or pot with water. Set the temperature to 130F/54.4C – 132F/55.5C (for very moist and tender) and allow water to heat to that temperature.Tip: start with hot tap water instead of cold water to reduce heating time. Note 4 for other temperatures.',
+			false,
+		],
+	])('matches legacy oids', (oid, match) => {
+		expect(MATCH_LEGACY_OID_JSON_STRING.test('"' + oid + '"'), oid).toBe(match);
+		// regex are stateful 🙄
+		MATCH_LEGACY_OID_JSON_STRING.lastIndex = 0;
+	});
+	it.each([
+		[
+			{ op: 'delete', oid: 'items/clabgyjfh00003968qycsq3ld.inputs.#:baz' },
+			{ op: 'delete', oid: 'items/clabgyjfh00003968qycsq3ld:baz' },
+		],
+		[
+			{
+				op: 'list-push',
+				oid: 'items/clabgyjfh00003968qycsq3ld.inputs.#:baz',
+				value: {
+					'@@type': 'ref',
+					id: 'items/clabgyjfh00003968qycsq3ld.inputs.#:qux',
+				},
+			},
+			{
+				op: 'list-push',
+				oid: 'items/clabgyjfh00003968qycsq3ld:baz',
+				value: { '@@type': 'ref', id: 'items/clabgyjfh00003968qycsq3ld:qux' },
+			},
+		],
+		[
+			{
+				op: 'list-remove',
+				oid: 'items/clabgyjfh00003968qycsq3ld.inputs.#:baz',
+				value: {
+					'@@type': 'ref',
+					id: 'items/clabgyjfh00003968qycsq3ld.inputs.#:qux',
+				},
+			},
+			{
+				op: 'list-remove',
+				oid: 'items/clabgyjfh00003968qycsq3ld:baz',
+				value: { '@@type': 'ref', id: 'items/clabgyjfh00003968qycsq3ld:qux' },
+			},
+		],
+		[
+			{
+				oid: 'items/clabgyjfh00003968qycsq3ld.inputs.#:baz',
+				timestamp: '2021-03-04T21:00:00.000Z',
+				snapshot: {
+					foo: 1,
+					bar: {
+						'@@type': 'ref',
+						id: 'items/clabgyjfh00003968qycsq3ld.inputs.#:qux',
+					},
+				},
+			},
+			{
+				oid: 'items/clabgyjfh00003968qycsq3ld:baz',
+				timestamp: '2021-03-04T21:00:00.000Z',
+				snapshot: {
+					foo: 1,
+					bar: { '@@type': 'ref', id: 'items/clabgyjfh00003968qycsq3ld:qux' },
+				},
+			},
+		],
+		[
+			{ oid: 'test/what if.boo.blah so what:fajsdfj' },
+			{ oid: 'test/what if:fajsdfj' },
+		],
+	])(
+		'should replace legacy OIDs in a JSON string with new OIDs',
+		(from, to) => {
+			expect(replaceLegacyOidsInObject(from), JSON.stringify(from)).toEqual(to);
+		},
+	);
+
+	it('should accommodate legacy dot style oids when computing ranges', () => {
+		function isWithin(
+			oid: ObjectIdentifier,
+			start: ObjectIdentifier,
+			end: ObjectIdentifier,
+		) {
+			return oid >= start && oid <= end;
+		}
+
+		const [start, end] = getLegacyDotOidSubIdRange('test/a.foo:barrrr');
+		expect(start).toEqual('test/a.');
+		expect(end).toEqual('test/a.\uffff');
+		expect(start < end).toBe(true);
+		expect(isWithin('test/a.foo:0', start, end)).toBe(true);
+		expect(isWithin('test/a.foo:1', start, end)).toBe(true);
+		expect(isWithin('test/a.bar:zzzzzzzzzzzzzzzzzzzzzzz', start, end)).toBe(
+			true,
+		);
+		expect(isWithin('test/a.aff:\uffff', start, end)).toBe(true);
+		expect(isWithin('test1/a', start, end)).toBe(false);
+		expect(isWithin('test/b', start, end)).toBe(false);
+		expect(isWithin('test/ ', start, end)).toBe(false);
+		expect(isWithin('test/a1', start, end)).toBe(false);
+		expect(isWithin('test/a1:3', start, end)).toBe(false);
+		expect(isWithin('test/a.foo:barrrr', start, end)).toBe(true);
+	});
+});

package/src/oidsLegacy.ts

@@ -0,0 +1,87 @@
+import {
+	assignOid,
+	createOid,
+	decomposeOid,
+	getOidRoot,
+	ObjectIdentifier,
+} from './oids.js';
+import { isObject } from './utils.js';
+
+export const LEGACY_OID_KEY = '__@@oid_do_not_use';
+export const OID_KEY = '@@id';
+
+export function maybeGetOidProperty(obj: any) {
+	if (!isObject(obj)) {
+		return undefined;
+	}
+	return obj[OID_KEY] || obj[LEGACY_OID_KEY];
+}
+
+function removeOidProperty(obj: any) {
+	if (!isObject(obj)) {
+		return obj;
+	}
+	delete obj[LEGACY_OID_KEY];
+	delete obj[OID_KEY];
+	return obj;
+}
+
+function copyOidFromPropertyToSystem(obj: any) {
+	const oid = maybeGetOidProperty(obj);
+	if (oid) {
+		assignOid(obj, oid);
+	}
+}
+
+/**
+ *
+ * Removes the special property from all objects in the given object
+ * which have an OID, transferring the OID from the property to the OID
+ * system in-memory.
+ */
+export function removeOidPropertiesFromAllSubObjects(obj: any) {
+	copyOidFromPropertyToSystem(obj);
+	removeOidProperty(obj);
+
+	if (Array.isArray(obj)) {
+		for (let i = 0; i < obj.length; i++) {
+			removeOidPropertiesFromAllSubObjects(obj[i]);
+		}
+	} else if (isObject(obj)) {
+		for (const key of Object.keys(obj)) {
+			removeOidPropertiesFromAllSubObjects(obj[key]);
+		}
+	}
+}
+
+export function isLegacyDotOid(oid: ObjectIdentifier) {
+	const partBeforeRandomSep = oid.split(':')[0];
+	return partBeforeRandomSep.includes('.');
+}
+
+export function convertLegacyOid(oid: ObjectIdentifier) {
+	const { collection, id, subId } = decomposeOid(oid);
+	return createOid(collection, id, subId);
+}
+
+// NOTE: all legacy OIDs should now be gone.
+export const MATCH_LEGACY_OID_JSON_STRING = /"\w+\/[^"]+?(\.[^"]+)+\:[\S]+?"/g;
+export function replaceLegacyOidsInJsonString(string: string) {
+	// replace every match of a legacy OID, converting to a new OID
+	return string.replaceAll(MATCH_LEGACY_OID_JSON_STRING, (match) => {
+		const legacyOid = match.slice(1, match.length - 1);
+		return `"${convertLegacyOid(legacyOid)}"`;
+	});
+}
+export function replaceLegacyOidsInObject(obj: any) {
+	return JSON.parse(replaceLegacyOidsInJsonString(JSON.stringify(obj)));
+}
+
+export function getLegacyDotOidSubIdRange(oid: ObjectIdentifier) {
+	const root = getOidRoot(oid);
+	return [`${root}.`, `${root}.\uffff`];
+}
+
+export function isOidKey(key: string) {
+	return key === OID_KEY || key === LEGACY_OID_KEY;
+}

package/src/operation.test.ts

@@ -5,7 +5,6 @@ import {
 	assignOidsToAllSubObjects,
 	createRef,
 	getOid,
-	OID_KEY,
 } from './oids.js';
 import {
 	applyPatch,