@verdant-web/common 2.3.4 → 2.4.0-next.1

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,