@verdant-web/store 3.12.1 → 4.0.0-next.0

package/src/entities/EntityMetadata.ts

@@ -10,7 +10,7 @@ import {
 	compareTimestampSchemaVersions,
 	getWallClockTime,
 } from '@verdant-web/common';
-import { Context } from '../context.js';
+import { Context } from '../context/context.js';
 import { EntityChange } from './types.js';
 
 export type EntityMetadataView = {
@@ -118,7 +118,7 @@ export class EntityMetadata {
 			!!confirmedResult.latestTimestamp &&
 			compareTimestampSchemaVersions(
 				confirmedResult.latestTimestamp,
-				this.ctx.getNow(),
+				this.ctx.time.now,
 			) < 0;
 
 		const empty =
@@ -142,7 +142,6 @@ export class EntityMetadata {
 				'warn',
 				`Entity ${this.oid} has no view, no deleted flag, and not empty`,
 			);
-			debugger;
 		}
 
 		return {
@@ -227,7 +226,7 @@ export class EntityMetadata {
 		let futureSeen: string | undefined = undefined;
 		let authz: string | undefined = undefined;
 
-		const now = this.ctx.getNow();
+		const now = this.ctx.time.now;
 		for (const op of operations) {
 			// ignore ops before our after cutoff
 			if (after && op.timestamp <= after) {
@@ -323,6 +322,7 @@ export class EntityFamilyMetadata {
 				);
 			}
 			this.get(baseline.oid).addBaseline(baseline);
+			changes[baseline.oid] ??= { oid: baseline.oid, isLocal };
 		}
 		for (const [oid, ops] of Object.entries(operations)) {
 			if (!areOidsRelated(this.rootOid, oid)) {

package/src/entities/EntityStore.ts

@@ -2,7 +2,6 @@ import {
 	DocumentBaseline,
 	ObjectIdentifier,
 	Operation,
-	StorageFieldsSchema,
 	StorageObjectFieldSchema,
 	assert,
 	assignOid,
@@ -15,14 +14,12 @@ import {
 	removeOidsFromAllSubObjects,
 	AuthorizationKey,
 } from '@verdant-web/common';
-import { Context } from '../context.js';
-import { Metadata } from '../metadata/Metadata.js';
+import { Context } from '../context/context.js';
 import { Entity } from './Entity.js';
 import { Disposable } from '../utils/Disposable.js';
 import { EntityFamilyMetadata } from './EntityMetadata.js';
 import { FileManager } from '../files/FileManager.js';
 import { OperationBatcher } from './OperationBatcher.js';
-import { QueryableStorage } from '../queries/QueryableStorage.js';
 import { WeakEvent } from 'weak-event';
 import { processValueFiles } from '../files/utils.js';
 
@@ -57,10 +54,8 @@ export interface EntityCreateOptions {
 
 export class EntityStore extends Disposable {
 	private ctx;
-	private meta;
 	private files;
 	private batcher;
-	private queryableStorage;
 	private events: EntityStoreEvents = {
 		add: new WeakEvent(),
 		replace: new WeakEvent(),
@@ -80,26 +75,18 @@ export class EntityStore extends Disposable {
 		},
 	);
 
-	constructor({
-		ctx,
-		meta,
-		files,
-	}: {
-		ctx: Context;
-		meta: Metadata;
-		files: FileManager;
-	}) {
+	constructor({ ctx, files }: { ctx: Context; files: FileManager }) {
 		super();
 
 		this.ctx = ctx;
-		this.meta = meta;
 		this.files = files;
-		this.queryableStorage = new QueryableStorage({ ctx });
 		this.batcher = new OperationBatcher({
 			ctx,
-			meta,
 			entities: this,
 		});
+		this.addDispose(
+			this.ctx.internalEvents.subscribe('persistenceReset', this.clearCache),
+		);
 	}
 
 	// expose batch APIs
@@ -145,7 +132,7 @@ export class EntityStore extends Disposable {
 	};
 
 	empty = async () => {
-		await this.queryableStorage.reset();
+		await this.ctx.queries.reset();
 		this.events.resetAll.invoke(this);
 		this.cache.clear();
 	};
@@ -155,8 +142,8 @@ export class EntityStore extends Disposable {
 			this.ctx.log('warn', 'EntityStore is disposed, not resetting local data');
 			return;
 		}
-		await this.meta.reset();
-		await this.queryableStorage.reset();
+		await this.ctx.meta.reset();
+		await this.ctx.queries.reset();
 		this.events.resetAll.invoke(this);
 	};
 
@@ -172,6 +159,11 @@ export class EntityStore extends Disposable {
 		const baselines = data?.baselines ?? [];
 		const operations = data?.operations ?? [];
 
+		if (baselines.length === 0 && operations.length === 0) {
+			this.ctx.log('debug', 'No data to process');
+			return;
+		}
+
 		this.ctx.log('debug', 'Processing incoming data', {
 			operations: operations.length,
 			baselines: baselines.length,
@@ -200,6 +192,7 @@ export class EntityStore extends Disposable {
 			const event = data.reset ? this.events.replace : this.events.add;
 			const hydrationPromise = this.pendingEntityPromises.get(oid);
 			if (hydrationPromise) {
+				this.ctx.log('debug', 'Waiting for ongoing entity hydration', oid);
 				hydrationPromise.then(() => {
 					event.invoke(this, {
 						oid,
@@ -209,6 +202,7 @@ export class EntityStore extends Disposable {
 					});
 				});
 			} else {
+				this.ctx.log('debug', 'Applying data to entity', oid);
 				event.invoke(this, {
 					oid,
 					baselines,
@@ -227,7 +221,7 @@ export class EntityStore extends Disposable {
 		// TODO: could messages be sent to sync before storage,
 		// so that realtime is lower latency? What would happen
 		// if the storage failed?
-		await this.meta.insertData(data, abortOptions);
+		await this.ctx.meta.insertData(data, abortOptions);
 
 		// recompute all affected documents for querying
 		const entities = await Promise.all(
@@ -246,7 +240,7 @@ export class EntityStore extends Disposable {
 			}),
 		);
 		try {
-			await this.queryableStorage.saveEntities(entities, abortOptions);
+			await this.ctx.queries.saveEntities(entities, abortOptions);
 		} catch (err) {
 			if (this.disposed) {
 				this.ctx.log(
@@ -275,14 +269,16 @@ export class EntityStore extends Disposable {
 		}
 
 		if (this.cache.has(oid)) {
-			this.ctx.log('debug', 'Hydrating entity from cache', oid);
 			const cached = this.cache.get(oid);
 			if (cached) {
 				const entity = cached.deref();
 				if (entity) {
 					if (entity.deleted) {
+						this.ctx.log('debug', 'Hydrated entity is deleted', oid);
+						// debugger;
 						return null;
 					}
+					this.ctx.log('debug', 'Hydrating entity from cache', oid);
 					return entity;
 				} else {
 					this.ctx.log('debug', "Removing GC'd entity from cache", oid);
@@ -299,6 +295,7 @@ export class EntityStore extends Disposable {
 			this.ctx.log('debug', 'Hydrating entity from storage', oid);
 			const entity = this.constructEntity(oid);
 			if (!entity) {
+				this.ctx.log('warn', 'Entity schema not found, cannot construct', oid);
 				return null;
 			}
 			const pendingPromise = this.loadEntity(entity, opts);
@@ -308,7 +305,7 @@ export class EntityStore extends Disposable {
 			this.pendingEntityPromises.set(oid, pendingPromise);
 			return pendingPromise;
 		} else {
-			this.ctx.log('debug', 'Waiting for entity hydration', oid);
+			this.ctx.log('debug', 'Waiting for ongoing entity hydration', oid);
 			return pendingPromise;
 		}
 	};
@@ -345,7 +342,7 @@ export class EntityStore extends Disposable {
 			);
 		}
 
-		const operations = this.meta.patchCreator.createInitialize(processed, oid);
+		const operations = this.ctx.patchCreator.createInitialize(processed, oid);
 		if (access) {
 			operations.forEach((op) => {
 				op.authz = access;
@@ -396,7 +393,7 @@ export class EntityStore extends Disposable {
 		for (const entity of entities) {
 			if (entity) {
 				const oids = entity.__getFamilyOids__();
-				const deletes = this.meta.patchCreator.createDeleteAll(oids);
+				const deletes = this.ctx.patchCreator.createDeleteAll(oids);
 				for (const op of deletes) {
 					op.authz = entity.access;
 				}
@@ -468,7 +465,6 @@ export class EntityStore extends Disposable {
 			readonlyKeys,
 			files: this.files,
 			metadataFamily: metadataFamily,
-			patchCreator: this.meta.patchCreator,
 			storeEvents: this.events,
 			deleteSelf: this.delete.bind(this, oid),
 		});
@@ -504,7 +500,7 @@ export class EntityStore extends Disposable {
 		entity: Entity,
 		opts?: { abort: AbortSignal },
 	) => {
-		const { operations, baselines } = await this.meta.getDocumentData(
+		const { operations, baselines } = await this.ctx.meta.getDocumentData(
 			entity.oid,
 			opts,
 		);
@@ -531,6 +527,7 @@ export class EntityStore extends Disposable {
 	 * referenced will go 'dead'...
 	 */
 	clearCache = () => {
+		this.ctx.log('debug', 'Emptying entity cache');
 		this.cache.clear();
 	};
 }

package/src/entities/OperationBatcher.ts

@@ -10,8 +10,7 @@ import {
 	isSuperseded,
 	operationSupersedes,
 } from '@verdant-web/common';
-import { Metadata } from '../metadata/Metadata.js';
-import { Context } from '../context.js';
+import { Context } from '../context/context.js';
 import type { EntityStore } from './EntityStore.js';
 import { Entity } from './Entity.js';
 
@@ -29,22 +28,18 @@ export class OperationBatcher {
 	private batcher;
 	private currentBatchKey = DEFAULT_BATCH_KEY;
 	private defaultBatchTimeout: number;
-	private meta;
 	private ctx;
 	private entities;
 
 	constructor({
 		batchTimeout = 200,
-		meta,
 		ctx,
 		entities,
 	}: {
 		batchTimeout?: number;
-		meta: Metadata;
 		ctx: Context;
 		entities: EntityStore;
 	}) {
-		this.meta = meta;
 		this.ctx = ctx;
 		this.entities = entities;
 		this.defaultBatchTimeout = batchTimeout;
@@ -69,6 +64,7 @@ export class OperationBatcher {
 		batchKey: string,
 		meta: { undoable?: boolean },
 	) => {
+		if (!operations.length) return;
 		this.ctx.log(
 			'debug',
 			'Flushing',
@@ -77,7 +73,6 @@ export class OperationBatcher {
 			batchKey,
 			'to storage / sync',
 		);
-		if (!operations.length) return;
 
 		// next block of logic computes superseding rules to eliminate
 		// operations which are 'overshadowed' by later ones on the same
@@ -129,7 +124,7 @@ export class OperationBatcher {
 		// cannot be done in reversed loop above or timestamps would be
 		// in reverse order.
 		for (const op of committed) {
-			op.timestamp = this.meta.now;
+			op.timestamp = this.ctx.time.now;
 		}
 		await this.commitOperations(committed, meta);
 	};
@@ -257,7 +252,10 @@ export class OperationBatcher {
 		return externalApi;
 	};
 
-	flushAll = () => Promise.all(this.batcher.flushAll());
+	flushAll = () => {
+		this.ctx.log('debug', 'Flushing all operations');
+		return Promise.all(this.batcher.flushAll());
+	};
 
 	private createUndo = async (data: { ops: Operation[]; source?: Entity }) => {
 		// this can't be done on-demand because we rely on the current
@@ -273,7 +271,7 @@ export class OperationBatcher {
 			});
 			// set time to now for all undo operations, they're happening now.
 			for (const op of inverseOps) {
-				op.timestamp = this.meta.now;
+				op.timestamp = this.ctx.time.now;
 			}
 			await this.commitOperations(
 				inverseOps,
@@ -293,7 +291,7 @@ export class OperationBatcher {
 	}) => {
 		const grouped = groupPatchesByOid(ops);
 		const inverseOps: Operation[] = [];
-		const getNow = () => this.meta.now;
+		const getNow = () => this.ctx.time.now;
 		await Promise.all(
 			Object.entries(grouped).map(async ([oid, patches]): Promise<void> => {
 				const entity = source ?? (await this.entities.hydrate(getOidRoot(oid)));

package/src/errors.ts

@@ -0,0 +1,13 @@
+export enum VerdantErrorCode {
+	MigrationPathNotFound = 50001,
+}
+
+export class VerdantError extends Error {
+	static Code = VerdantErrorCode;
+	constructor(
+		public code: VerdantErrorCode,
+		message: string,
+	) {
+		super(message);
+	}
+}

package/src/files/EntityFile.ts

@@ -1,4 +1,5 @@
 import { EventSubscriber, FileData } from '@verdant-web/common';
+import { Context } from '../context/context.js';
 
 export type EntityFileEvents = {
 	change: () => void;
@@ -6,7 +7,6 @@ export type EntityFileEvents = {
 
 export const UPDATE = Symbol('entity-file-update');
 export const MARK_FAILED = Symbol('entity-file-mark-failed');
-export const MARK_UPLOADED = Symbol('entity-file-mark-uploaded');
 
 export type EntityFileSnapshot = {
 	id: string;
@@ -24,17 +24,26 @@ export class EntityFile extends EventSubscriber<EntityFileEvents> {
 	private _loading = true;
 	private _failed = false;
 	private _downloadRemote = false;
+	private ctx: Context;
+	private unsubscribes: (() => void)[] = [];
 
 	constructor(
 		public readonly id: string,
 		{
 			downloadRemote = false,
+			ctx,
 		}: {
 			downloadRemote?: boolean;
-		} = {},
+			ctx: Context;
+		},
 	) {
 		super();
+		this.ctx = ctx;
 		this._downloadRemote = downloadRemote;
+
+		this.unsubscribes.push(
+			this.ctx.internalEvents.subscribe(`fileUploaded:${id}`, this.onUploaded),
+		);
 	}
 
 	get downloadRemote() {
@@ -48,6 +57,7 @@ export class EntityFile extends EventSubscriber<EntityFileEvents> {
 	}
 
 	[UPDATE] = (fileData: FileData) => {
+		this.ctx.log('debug', 'EntityFile updated', this.id, fileData);
 		this._loading = false;
 		this._failed = false;
 		this._fileData = fileData;
@@ -55,6 +65,7 @@ export class EntityFile extends EventSubscriber<EntityFileEvents> {
 			if (this._objectUrl) {
 				URL.revokeObjectURL(this._objectUrl);
 			}
+			this.ctx.log('debug', 'Creating object URL for file', this.id);
 			this._objectUrl = URL.createObjectURL(fileData.file);
 		}
 		this.emit('change');
@@ -66,7 +77,7 @@ export class EntityFile extends EventSubscriber<EntityFileEvents> {
 		this.emit('change');
 	};
 
-	[MARK_UPLOADED] = () => {
+	private onUploaded = () => {
 		if (!this._fileData) return;
 		this._fileData!.remote = true;
 		this.emit('change');
@@ -102,13 +113,13 @@ export class EntityFile extends EventSubscriber<EntityFileEvents> {
 	};
 
 	getSnapshot(): FileData {
-		if (this._fileData) return this._fileData;
 		return {
 			id: this.id,
-			url: this._objectUrl ?? undefined,
+			url: this._objectUrl ?? this._fileData?.url ?? undefined,
 			name: this.name ?? 'unknown-file',
 			remote: false,
 			type: this.type ?? '',
+			file: this._fileData?.file,
 		};
 	}
 }