@chipmobilesdk/rn-local-db 0.1.2 → 0.2.1

package/src/testing/conformance/index.ts

@@ -1,161 +1,161 @@
-/**
- * The conformance suite: the executable definition of what the package
- * guarantees (FR-092).
- *
- * Exported rather than kept internal so a consuming team can run it against
- * their own adapter if one ever exists, and so both of ours are held to
- * exactly the same standard rather than to two similar-looking test files.
- */
-
-import type { StorageAdapter } from '../../contract/adapter';
-import type { DatabaseConfig, ScopeTargetConfig } from '../../contract/config';
-import type { EncryptionConfig } from '../../contract/encryption';
-import type { ScopeDescriptor } from '../../contract/scope';
-import { registerRecordConformance } from './records';
-import { registerScopeConformance } from './scopes';
-import { registerQueryConformance } from './queries';
-import { registerTransactionConformance } from './transactions';
-import { registerMigrationConformance } from './migrations';
-import { registerLifecycleConformance } from './lifecycle';
-import { registerAttachmentConformance } from './attachments';
-import { registerEncryptionConformance } from './encryption';
-
-export type ConformanceContext = {
-	adapter: StorageAdapter;
-	/** A fresh config for the given scope, using the standard test schema. */
-	configFor(scope: ScopeDescriptor, overrides?: Partial<DatabaseConfig>): DatabaseConfig;
-	/**
-	 * How an app names a scope for deletion.
-	 *
-	 * Carries the encryption config when the run is encrypted, because that is
-	 * how a real consumer calls it: `ScopeTargetConfig.encryption` exists so
-	 * deletion can report what it removed rather than guessing at it.
-	 */
-	scopeTargetFor(scope: ScopeDescriptor): ScopeTargetConfig;
-	reset(): Promise<void>;
-	/**
-	 * Reach past the package and delete an artifact the way the operating
-	 * system does when it reclaims storage. Each adapter supplies its own,
-	 * because the suite cannot simulate this through the public API without
-	 * asking the package to break its own guarantee.
-	 */
-	removeArtifactBehindTheScenes(scopeKey: string, attachmentId: string): Promise<void>;
-	/** The other direction: a reference whose artifact survives. */
-	removeReferenceBehindTheScenes(scopeKey: string, attachmentId: string): Promise<void>;
-};
-
-export type ConformanceHooks = Pick<
-	ConformanceContext,
-	'removeArtifactBehindTheScenes' | 'removeReferenceBehindTheScenes'
->;
-
-export type ConformanceOptions = {
-	/** Sections the adapter knowingly cannot satisfy, with a documented reason. */
-	skip?: ConformanceSection[];
-	/**
-	 * Run every section against an encrypted database (FR-105).
-	 *
-	 * The suite is the contract, so the contract has to hold in both postures
-	 * — an encrypted database that quietly behaved differently would be a
-	 * second implementation nobody tested.
-	 */
-	encryption?: EncryptionConfig;
-};
-
-export type ConformanceSection =
-	| 'records'
-	| 'scopes'
-	| 'queries'
-	| 'transactions'
-	| 'migrations'
-	| 'lifecycle'
-	| 'attachments'
-	| 'encryption';
-
-export const TEST_COLLECTIONS: DatabaseConfig['collections'] = [
-	{
-		name: 'notes',
-		fields: [
-			{ name: 'title', type: 'string' },
-			{ name: 'score', type: 'number' },
-			{ name: 'done', type: 'boolean' },
-			{ name: 'updated', type: 'timestamp' },
-		],
-		indexes: [{ name: 'notes_by_score', fields: ['score'] }],
-		softDelete: true,
-		timestamps: true,
-	},
-	{
-		name: 'plain',
-		fields: [{ name: 'label', type: 'string' }],
-	},
-];
-
-export function makeConformanceContext(
-	adapter: StorageAdapter,
-	reset: () => Promise<void>,
-	hooks: ConformanceHooks,
-	defaults: Partial<DatabaseConfig> = {},
-): ConformanceContext {
-	return {
-		adapter,
-		reset,
-		...hooks,
-		configFor(scope, overrides = {}) {
-			return {
-				name: 'conformance',
-				scope,
-				schemaVersion: 1,
-				collections: TEST_COLLECTIONS,
-				migrations: [{ version: 1, migrate: async () => {} }],
-				...defaults,
-				...overrides,
-			};
-		},
-		scopeTargetFor(scope) {
-			return {
-				name: 'conformance',
-				scope,
-				...(defaults.encryption ? { encryption: defaults.encryption } : {}),
-			};
-		},
-	};
-}
-
-/**
- * Registers the whole suite against one adapter. Both adapters call this with
- * the same arguments; any difference in outcome is a divergence that must be
- * documented under FR-096 or fixed.
- */
-export function runConformanceSuite(
-	factory: () => StorageAdapter,
-	reset: () => Promise<void>,
-	hooks: ConformanceHooks,
-	options: ConformanceOptions = {},
-): void {
-	const skip = new Set(options.skip ?? []);
-	const context = makeConformanceContext(
-		factory(),
-		reset,
-		hooks,
-		options.encryption ? { encryption: options.encryption } : {},
-	);
-
-	const sections: [ConformanceSection, (c: ConformanceContext) => void][] = [
-		['records', registerRecordConformance],
-		['scopes', registerScopeConformance],
-		['queries', registerQueryConformance],
-		['transactions', registerTransactionConformance],
-		['migrations', registerMigrationConformance],
-		['lifecycle', registerLifecycleConformance],
-		['attachments', registerAttachmentConformance],
-		['encryption', registerEncryptionConformance],
-	];
-
-	for (const [name, register] of sections) {
-		if (skip.has(name)) {
-			continue;
-		}
-		register(context);
-	}
-}
+/**
+ * The conformance suite: the executable definition of what the package
+ * guarantees (FR-092).
+ *
+ * Exported rather than kept internal so a consuming team can run it against
+ * their own adapter if one ever exists, and so both of ours are held to
+ * exactly the same standard rather than to two similar-looking test files.
+ */
+
+import type { StorageAdapter } from '../../contract/adapter';
+import type { DatabaseConfig, ScopeTargetConfig } from '../../contract/config';
+import type { EncryptionConfig } from '../../contract/encryption';
+import type { ScopeDescriptor } from '../../contract/scope';
+import { registerRecordConformance } from './records';
+import { registerScopeConformance } from './scopes';
+import { registerQueryConformance } from './queries';
+import { registerTransactionConformance } from './transactions';
+import { registerMigrationConformance } from './migrations';
+import { registerLifecycleConformance } from './lifecycle';
+import { registerAttachmentConformance } from './attachments';
+import { registerEncryptionConformance } from './encryption';
+
+export type ConformanceContext = {
+	adapter: StorageAdapter;
+	/** A fresh config for the given scope, using the standard test schema. */
+	configFor(scope: ScopeDescriptor, overrides?: Partial<DatabaseConfig>): DatabaseConfig;
+	/**
+	 * How an app names a scope for deletion.
+	 *
+	 * Carries the encryption config when the run is encrypted, because that is
+	 * how a real consumer calls it: `ScopeTargetConfig.encryption` exists so
+	 * deletion can report what it removed rather than guessing at it.
+	 */
+	scopeTargetFor(scope: ScopeDescriptor): ScopeTargetConfig;
+	reset(): Promise<void>;
+	/**
+	 * Reach past the package and delete an artifact the way the operating
+	 * system does when it reclaims storage. Each adapter supplies its own,
+	 * because the suite cannot simulate this through the public API without
+	 * asking the package to break its own guarantee.
+	 */
+	removeArtifactBehindTheScenes(scopeKey: string, attachmentId: string): Promise<void>;
+	/** The other direction: a reference whose artifact survives. */
+	removeReferenceBehindTheScenes(scopeKey: string, attachmentId: string): Promise<void>;
+};
+
+export type ConformanceHooks = Pick<
+	ConformanceContext,
+	'removeArtifactBehindTheScenes' | 'removeReferenceBehindTheScenes'
+>;
+
+export type ConformanceOptions = {
+	/** Sections the adapter knowingly cannot satisfy, with a documented reason. */
+	skip?: ConformanceSection[];
+	/**
+	 * Run every section against an encrypted database (FR-105).
+	 *
+	 * The suite is the contract, so the contract has to hold in both postures
+	 * — an encrypted database that quietly behaved differently would be a
+	 * second implementation nobody tested.
+	 */
+	encryption?: EncryptionConfig;
+};
+
+export type ConformanceSection =
+	| 'records'
+	| 'scopes'
+	| 'queries'
+	| 'transactions'
+	| 'migrations'
+	| 'lifecycle'
+	| 'attachments'
+	| 'encryption';
+
+export const TEST_COLLECTIONS: DatabaseConfig['collections'] = [
+	{
+		name: 'notes',
+		fields: [
+			{ name: 'title', type: 'string' },
+			{ name: 'score', type: 'number' },
+			{ name: 'done', type: 'boolean' },
+			{ name: 'updated', type: 'timestamp' },
+		],
+		indexes: [{ name: 'notes_by_score', fields: ['score'] }],
+		softDelete: true,
+		timestamps: true,
+	},
+	{
+		name: 'plain',
+		fields: [{ name: 'label', type: 'string' }],
+	},
+];
+
+export function makeConformanceContext(
+	adapter: StorageAdapter,
+	reset: () => Promise<void>,
+	hooks: ConformanceHooks,
+	defaults: Partial<DatabaseConfig> = {},
+): ConformanceContext {
+	return {
+		adapter,
+		reset,
+		...hooks,
+		configFor(scope, overrides = {}) {
+			return {
+				name: 'conformance',
+				scope,
+				schemaVersion: 1,
+				collections: TEST_COLLECTIONS,
+				migrations: [{ version: 1, migrate: async () => {} }],
+				...defaults,
+				...overrides,
+			};
+		},
+		scopeTargetFor(scope) {
+			return {
+				name: 'conformance',
+				scope,
+				...(defaults.encryption ? { encryption: defaults.encryption } : {}),
+			};
+		},
+	};
+}
+
+/**
+ * Registers the whole suite against one adapter. Both adapters call this with
+ * the same arguments; any difference in outcome is a divergence that must be
+ * documented under FR-096 or fixed.
+ */
+export function runConformanceSuite(
+	factory: () => StorageAdapter,
+	reset: () => Promise<void>,
+	hooks: ConformanceHooks,
+	options: ConformanceOptions = {},
+): void {
+	const skip = new Set(options.skip ?? []);
+	const context = makeConformanceContext(
+		factory(),
+		reset,
+		hooks,
+		options.encryption ? { encryption: options.encryption } : {},
+	);
+
+	const sections: [ConformanceSection, (c: ConformanceContext) => void][] = [
+		['records', registerRecordConformance],
+		['scopes', registerScopeConformance],
+		['queries', registerQueryConformance],
+		['transactions', registerTransactionConformance],
+		['migrations', registerMigrationConformance],
+		['lifecycle', registerLifecycleConformance],
+		['attachments', registerAttachmentConformance],
+		['encryption', registerEncryptionConformance],
+	];
+
+	for (const [name, register] of sections) {
+		if (skip.has(name)) {
+			continue;
+		}
+		register(context);
+	}
+}

package/src/testing/conformance/lifecycle.ts

@@ -1,99 +1,99 @@
-import type { ScopeDescriptor } from '../../contract/scope';
-import type { ConformanceContext } from './index';
-
-/** US6: sign-out retains; deletion happens only when asked, and only where asked. */
-export function registerLifecycleConformance(context: ConformanceContext): void {
-	describe('conformance: lifecycle', () => {
-		beforeEach(() => context.reset());
-
-		const alice: ScopeDescriptor = { kind: 'identity', id: 'alice' };
-		const bob: ScopeDescriptor = { kind: 'identity', id: 'bob' };
-
-		it('retains data when a handle is closed without a delete request', async () => {
-			const first = await context.adapter.open(context.configFor(alice));
-			await first.collection('notes').insert({ id: 'a', data: { title: 'kept' } });
-			// Closing the handle is what a sign-out looks like to this package.
-			await first.close();
-
-			const second = await context.adapter.open(context.configFor(alice));
-			expect((await second.collection('notes').get('a')).data.title).toBe('kept');
-			await second.close();
-		});
-
-		it('removes every record in the target scope and nothing else', async () => {
-			const a = await context.adapter.open(context.configFor(alice));
-			await a.collection('notes').insert({ id: 'x', data: { title: 'alice' } });
-			await a.collection('plain').insert({ id: 'y', data: { label: 'alice' } });
-			await a.close();
-
-			const b = await context.adapter.open(context.configFor(bob));
-			await b.collection('notes').insert({ id: 'x', data: { title: 'bob' } });
-			await b.close();
-
-			const outcome = await context.adapter.deleteScopeData(context.scopeTargetFor(alice));
-			expect(outcome.removedRecords).toBe(2);
-
-			const reopenedAlice = await context.adapter.open(context.configFor(alice));
-			expect(await reopenedAlice.collection('notes').count()).toBe(0);
-			expect(await reopenedAlice.collection('plain').count()).toBe(0);
-			await reopenedAlice.close();
-
-			const reopenedBob = await context.adapter.open(context.configFor(bob));
-			expect((await reopenedBob.collection('notes').get('x')).data.title).toBe('bob');
-			await reopenedBob.close();
-		});
-
-		it('reports success for a scope holding no data', async () => {
-			const outcome = await context.adapter.deleteScopeData(
-				context.scopeTargetFor({ kind: 'identity', id: 'never-used' }),
-			);
-			expect(outcome.removedRecords).toBe(0);
-			expect(outcome.failedRemovals).toEqual([]);
-		});
-
-		it('reports what it removed rather than a bare success', async () => {
-			const handle = await context.adapter.open(context.configFor(alice));
-			await handle.collection('notes').insert({ id: 'a', data: { title: 'x' } });
-			await handle.close();
-
-			const outcome = await context.adapter.deleteScopeData(context.scopeTargetFor(alice));
-			expect(outcome).toMatchObject({
-				removedRecords: 1,
-				removedArtifacts: [],
-				orphanedReferences: [],
-				failedRemovals: [],
-			});
-		});
-
-		it('makes the whole database behave as a first install after deleteDatabase', async () => {
-			const handle = await context.adapter.open(context.configFor(alice));
-			await handle.collection('notes').insert({ id: 'a', data: { title: 'x' } });
-			await handle.close();
-
-			await context.adapter.deleteDatabase({ name: 'conformance' });
-
-			const reopened = await context.adapter.open(context.configFor(alice));
-			expect(await reopened.collection('notes').count()).toBe(0);
-			await reopened.close();
-		});
-
-		it('recovers exactly one scope with resetScope', async () => {
-			const a = await context.adapter.open(context.configFor(alice));
-			await a.collection('notes').insert({ id: 'x', data: { title: 'alice' } });
-			await a.close();
-			const b = await context.adapter.open(context.configFor(bob));
-			await b.collection('notes').insert({ id: 'x', data: { title: 'bob' } });
-			await b.close();
-
-			await context.adapter.resetScope(context.scopeTargetFor(alice));
-
-			const reopenedAlice = await context.adapter.open(context.configFor(alice));
-			expect(await reopenedAlice.collection('notes').count()).toBe(0);
-			await reopenedAlice.close();
-
-			const reopenedBob = await context.adapter.open(context.configFor(bob));
-			expect(await reopenedBob.collection('notes').count()).toBe(1);
-			await reopenedBob.close();
-		});
-	});
-}
+import type { ScopeDescriptor } from '../../contract/scope';
+import type { ConformanceContext } from './index';
+
+/** US6: sign-out retains; deletion happens only when asked, and only where asked. */
+export function registerLifecycleConformance(context: ConformanceContext): void {
+	describe('conformance: lifecycle', () => {
+		beforeEach(() => context.reset());
+
+		const alice: ScopeDescriptor = { kind: 'identity', id: 'alice' };
+		const bob: ScopeDescriptor = { kind: 'identity', id: 'bob' };
+
+		it('retains data when a handle is closed without a delete request', async () => {
+			const first = await context.adapter.open(context.configFor(alice));
+			await first.collection('notes').insert({ id: 'a', data: { title: 'kept' } });
+			// Closing the handle is what a sign-out looks like to this package.
+			await first.close();
+
+			const second = await context.adapter.open(context.configFor(alice));
+			expect((await second.collection('notes').get('a')).data.title).toBe('kept');
+			await second.close();
+		});
+
+		it('removes every record in the target scope and nothing else', async () => {
+			const a = await context.adapter.open(context.configFor(alice));
+			await a.collection('notes').insert({ id: 'x', data: { title: 'alice' } });
+			await a.collection('plain').insert({ id: 'y', data: { label: 'alice' } });
+			await a.close();
+
+			const b = await context.adapter.open(context.configFor(bob));
+			await b.collection('notes').insert({ id: 'x', data: { title: 'bob' } });
+			await b.close();
+
+			const outcome = await context.adapter.deleteScopeData(context.scopeTargetFor(alice));
+			expect(outcome.removedRecords).toBe(2);
+
+			const reopenedAlice = await context.adapter.open(context.configFor(alice));
+			expect(await reopenedAlice.collection('notes').count()).toBe(0);
+			expect(await reopenedAlice.collection('plain').count()).toBe(0);
+			await reopenedAlice.close();
+
+			const reopenedBob = await context.adapter.open(context.configFor(bob));
+			expect((await reopenedBob.collection('notes').get('x')).data.title).toBe('bob');
+			await reopenedBob.close();
+		});
+
+		it('reports success for a scope holding no data', async () => {
+			const outcome = await context.adapter.deleteScopeData(
+				context.scopeTargetFor({ kind: 'identity', id: 'never-used' }),
+			);
+			expect(outcome.removedRecords).toBe(0);
+			expect(outcome.failedRemovals).toEqual([]);
+		});
+
+		it('reports what it removed rather than a bare success', async () => {
+			const handle = await context.adapter.open(context.configFor(alice));
+			await handle.collection('notes').insert({ id: 'a', data: { title: 'x' } });
+			await handle.close();
+
+			const outcome = await context.adapter.deleteScopeData(context.scopeTargetFor(alice));
+			expect(outcome).toMatchObject({
+				removedRecords: 1,
+				removedArtifacts: [],
+				orphanedReferences: [],
+				failedRemovals: [],
+			});
+		});
+
+		it('makes the whole database behave as a first install after deleteDatabase', async () => {
+			const handle = await context.adapter.open(context.configFor(alice));
+			await handle.collection('notes').insert({ id: 'a', data: { title: 'x' } });
+			await handle.close();
+
+			await context.adapter.deleteDatabase({ name: 'conformance' });
+
+			const reopened = await context.adapter.open(context.configFor(alice));
+			expect(await reopened.collection('notes').count()).toBe(0);
+			await reopened.close();
+		});
+
+		it('recovers exactly one scope with resetScope', async () => {
+			const a = await context.adapter.open(context.configFor(alice));
+			await a.collection('notes').insert({ id: 'x', data: { title: 'alice' } });
+			await a.close();
+			const b = await context.adapter.open(context.configFor(bob));
+			await b.collection('notes').insert({ id: 'x', data: { title: 'bob' } });
+			await b.close();
+
+			await context.adapter.resetScope(context.scopeTargetFor(alice));
+
+			const reopenedAlice = await context.adapter.open(context.configFor(alice));
+			expect(await reopenedAlice.collection('notes').count()).toBe(0);
+			await reopenedAlice.close();
+
+			const reopenedBob = await context.adapter.open(context.configFor(bob));
+			expect(await reopenedBob.collection('notes').count()).toBe(1);
+			await reopenedBob.close();
+		});
+	});
+}