atom.io 0.6.9 → 0.8.0

package/internal/src/timeline/add-atom-to-timeline.ts

@@ -0,0 +1,189 @@
+import type { AtomToken, TimelineUpdate } from "atom.io"
+
+import type { Store } from "../store"
+import { IMPLICIT, withdraw } from "../store"
+import { target } from "../transaction"
+import type {
+	Timeline,
+	TimelineAtomUpdate,
+	TimelineTransactionUpdate,
+} from "./timeline-internal"
+
+export const addAtomToTimeline = (
+	atomToken: AtomToken<any>,
+	tl: Timeline,
+	store: Store = IMPLICIT.STORE,
+): void => {
+	const atom = withdraw(atomToken, store)
+	if (atom === null) {
+		throw new Error(
+			`Cannot subscribe to atom "${atomToken.key}" because it has not been initialized in store "${store.config.name}"`,
+		)
+	}
+	atom.subject.subscribe(`timeline`, (update) => {
+		const currentSelectorKey =
+			store.operation.open && store.operation.token.type === `selector`
+				? store.operation.token.key
+				: null
+		const currentSelectorTime =
+			store.operation.open && store.operation.token.type === `selector`
+				? store.operation.time
+				: null
+		const currentTransactionKey =
+			store.transactionStatus.phase === `applying`
+				? store.transactionStatus.key
+				: null
+		const currentTransactionTime =
+			store.transactionStatus.phase === `applying`
+				? store.transactionStatus.time
+				: null
+
+		store.config.logger?.info(
+			`⏳ timeline "${tl.key}" saw atom "${atomToken.key}" go (`,
+			update.oldValue,
+			`->`,
+			update.newValue,
+			currentTransactionKey
+				? `) in transaction "${currentTransactionKey}"`
+				: currentSelectorKey
+				? `) in selector "${currentSelectorKey}"`
+				: `)`,
+		)
+
+		if (tl.timeTraveling === null) {
+			if (tl.selectorTime && tl.selectorTime !== currentSelectorTime) {
+				const mostRecentUpdate: TimelineUpdate | undefined = tl.history.at(-1)
+				if (mostRecentUpdate === undefined) {
+					throw new Error(
+						`Timeline "${tl.key}" has a selectorTime, but no history. This is most likely a bug in AtomIO.`,
+					)
+				}
+			}
+			if (
+				currentTransactionKey &&
+				store.transactionStatus.phase === `applying`
+			) {
+				const currentTransaction = withdraw(
+					{ key: currentTransactionKey, type: `transaction` },
+					store,
+				)
+				if (currentTransaction === null) {
+					throw new Error(
+						`Transaction "${currentTransactionKey}" not found in store "${store.config.name}". This is surprising, because we are in the application phase of "${currentTransactionKey}".`,
+					)
+				}
+				if (tl.transactionKey !== currentTransactionKey) {
+					if (tl.transactionKey) {
+						store.config.logger?.error(
+							`Timeline "${tl.key}" was unable to resolve transaction "${tl.transactionKey}. This is probably a bug.`,
+						)
+					}
+					tl.transactionKey = currentTransactionKey
+					const unsubscribe = currentTransaction.subject.subscribe(
+						`timeline:${tl.key}`,
+						(update) => {
+							unsubscribe()
+							if (tl.timeTraveling === null && currentTransactionTime) {
+								if (tl.at !== tl.history.length) {
+									tl.history.splice(tl.at)
+								}
+
+								const atomUpdates = update.atomUpdates.filter((atomUpdate) => {
+									const core = target(store)
+									const atomOrFamilyKeys = core.timelineAtoms.getRelatedKeys(
+										tl.key,
+									)
+
+									return atomOrFamilyKeys
+										? [...atomOrFamilyKeys].some(
+												(key) =>
+													key === atomUpdate.key ||
+													key === atomUpdate.family?.key,
+										  )
+										: false
+								})
+
+								const timelineTransactionUpdate: TimelineTransactionUpdate = {
+									type: `transaction_update`,
+									timestamp: currentTransactionTime,
+									...update,
+									atomUpdates,
+								}
+								tl.history.push(timelineTransactionUpdate)
+								tl.at = tl.history.length
+								tl.subject.next(timelineTransactionUpdate)
+							}
+							tl.transactionKey = null
+							store.config.logger?.info(
+								`⌛ timeline "${tl.key}" got a transaction_update "${update.key}"`,
+							)
+						},
+					)
+				}
+			} else if (currentSelectorKey && currentSelectorTime) {
+				let latestUpdate: TimelineUpdate | undefined = tl.history.at(-1)
+
+				if (currentSelectorTime !== tl.selectorTime) {
+					latestUpdate = {
+						type: `selector_update`,
+						timestamp: currentSelectorTime,
+						key: currentSelectorKey,
+						atomUpdates: [],
+					}
+					latestUpdate.atomUpdates.push({
+						key: atom.key,
+						type: `atom_update`,
+						...update,
+					})
+					if (tl.at !== tl.history.length) {
+						tl.history.splice(tl.at)
+					}
+					tl.history.push(latestUpdate)
+
+					store.config.logger?.info(
+						`⌛ timeline "${tl.key}" got a selector_update "${currentSelectorKey}" with`,
+						latestUpdate.atomUpdates.map((atomUpdate) => atomUpdate.key),
+					)
+
+					tl.at = tl.history.length
+					tl.selectorTime = currentSelectorTime
+				} else {
+					if (latestUpdate?.type === `selector_update`) {
+						latestUpdate.atomUpdates.push({
+							key: atom.key,
+							type: `atom_update`,
+							...update,
+						})
+						store.config.logger?.info(
+							`   ⌛ timeline "${tl.key}" set selector_update "${currentSelectorKey}" to`,
+							latestUpdate?.atomUpdates.map((atomUpdate) => atomUpdate.key),
+						)
+					}
+				}
+				if (latestUpdate) tl.subject.next(latestUpdate)
+			} else {
+				const timestamp = Date.now()
+				tl.selectorTime = null
+				if (tl.at !== tl.history.length) {
+					tl.history.splice(tl.at)
+				}
+				const atomUpdate: TimelineAtomUpdate = {
+					type: `atom_update`,
+					timestamp,
+					key: atom.key,
+					oldValue: update.oldValue,
+					newValue: update.newValue,
+				}
+				if (atom.family) {
+					atomUpdate.family = atom.family
+				}
+				tl.history.push(atomUpdate)
+				tl.subject.next(atomUpdate)
+				store.config.logger?.info(
+					`⌛ timeline "${tl.key}" got an atom_update to "${atom.key}"`,
+				)
+				tl.at = tl.history.length
+			}
+		}
+	})
+}

package/internal/src/timeline/index.ts

@@ -0,0 +1,3 @@
+export * from "./add-atom-to-timeline"
+export * from "./time-travel-internal"
+export * from "./timeline-internal"

package/internal/src/timeline/time-travel-internal.ts

@@ -0,0 +1,91 @@
+import type { TimelineToken } from "atom.io"
+import { setState } from "atom.io"
+
+import type { Store } from "../store"
+import { IMPLICIT } from "../store"
+
+export const redo__INTERNAL = (
+	token: TimelineToken,
+	store: Store = IMPLICIT.STORE,
+): void => {
+	store.config.logger?.info(`⏩ redo "${token.key}"`)
+	const timelineData = store.timelines.get(token.key)
+	if (!timelineData) {
+		store.config.logger?.error(
+			`Failed to redo on timeline "${token.key}". This timeline has not been initialized.`,
+		)
+		return
+	}
+	if (timelineData.at === timelineData.history.length) {
+		store.config.logger?.warn(
+			`Failed to redo at the end of timeline "${token.key}". There is nothing to redo.`,
+		)
+		return
+	}
+	timelineData.timeTraveling = `into_future`
+	const update = timelineData.history[timelineData.at]
+	switch (update.type) {
+		case `atom_update`: {
+			const { key, newValue } = update
+			setState({ key, type: `atom` }, newValue, store)
+			break
+		}
+		case `selector_update`:
+		case `transaction_update`: {
+			for (const atomUpdate of update.atomUpdates) {
+				const { key, newValue } = atomUpdate
+				setState({ key, type: `atom` }, newValue, store)
+			}
+			break
+		}
+	}
+	++timelineData.at
+	timelineData.subject.next(`redo`)
+	timelineData.timeTraveling = null
+	store.config.logger?.info(
+		`⏹️ "${token.key}" is now at ${timelineData.at} / ${timelineData.history.length}`,
+	)
+}
+
+export const undo__INTERNAL = (
+	token: TimelineToken,
+	store: Store = IMPLICIT.STORE,
+): void => {
+	store.config.logger?.info(`⏪ undo "${token.key}"`)
+	const timelineData = store.timelines.get(token.key)
+	if (!timelineData) {
+		store.config.logger?.error(
+			`Failed to undo on timeline "${token.key}". This timeline has not been initialized.`,
+		)
+		return
+	}
+	if (timelineData.at === 0) {
+		store.config.logger?.warn(
+			`Failed to undo at the beginning of timeline "${token.key}". There is nothing to undo.`,
+		)
+		return
+	}
+	timelineData.timeTraveling = `into_past`
+	--timelineData.at
+	const update = timelineData.history[timelineData.at]
+	switch (update.type) {
+		case `atom_update`: {
+			const { key, oldValue } = update
+			setState({ key, type: `atom` }, oldValue, store)
+			break
+		}
+		case `selector_update`:
+		case `transaction_update`: {
+			for (const atomUpdate of [...update.atomUpdates].reverse()) {
+				const { key, oldValue } = atomUpdate
+				setState({ key, type: `atom` }, oldValue, store)
+			}
+			break
+		}
+	}
+	timelineData.subject.next(`undo`)
+	timelineData.timeTraveling = null
+	store.config.logger?.info(
+		`⏹️ "${token.key}" is now at ${timelineData.at} / ${timelineData.history.length}`,
+	)
+}

package/internal/src/timeline/timeline-internal.ts

@@ -0,0 +1,115 @@
+import type {
+	FamilyMetadata,
+	StateUpdate,
+	TimelineOptions,
+	TimelineToken,
+	TimelineUpdate,
+	TransactionUpdate,
+	ƒn,
+} from "atom.io"
+
+import type { Store } from "../store"
+import { IMPLICIT } from "../store"
+import { Subject } from "../subject"
+import { target } from "../transaction"
+import { addAtomToTimeline } from "./add-atom-to-timeline"
+
+export type TimelineAtomUpdate = StateUpdate<unknown> & {
+	key: string
+	type: `atom_update`
+	timestamp: number
+	family?: FamilyMetadata
+}
+export type TimelineSelectorUpdate = {
+	key: string
+	type: `selector_update`
+	timestamp: number
+	atomUpdates: Omit<TimelineAtomUpdate, `timestamp`>[]
+}
+export type TimelineTransactionUpdate = TransactionUpdate<ƒn> & {
+	key: string
+	type: `transaction_update`
+	timestamp: number
+}
+
+export type Timeline = {
+	type: `timeline`
+	key: string
+	at: number
+	timeTraveling: `into_future` | `into_past` | null
+	history: TimelineUpdate[]
+	selectorTime: number | null
+	transactionKey: string | null
+	install: (store: Store) => void
+	subject: Subject<
+		| TimelineAtomUpdate
+		| TimelineSelectorUpdate
+		| TimelineTransactionUpdate
+		| `redo`
+		| `undo`
+	>
+}
+
+export function timeline__INTERNAL(
+	options: TimelineOptions,
+	store: Store = IMPLICIT.STORE,
+	data: Timeline | null = null,
+): TimelineToken {
+	const tl: Timeline = {
+		type: `timeline`,
+		key: options.key,
+		at: 0,
+		timeTraveling: null,
+		selectorTime: null,
+		transactionKey: null,
+		...data,
+		history: data?.history.map((update) => ({ ...update })) ?? [],
+		install: (store) => timeline__INTERNAL(options, store, tl),
+		subject: new Subject(),
+	}
+
+	const core = target(store)
+	for (const tokenOrFamily of options.atoms) {
+		const timelineKey = core.timelineAtoms.getRelatedKey(tokenOrFamily.key)
+		if (timelineKey) {
+			store.config.logger?.error(
+				`❌ Failed to add atom "${tokenOrFamily.key}" to timeline "${options.key}" because it belongs to timeline "${timelineKey}"`,
+			)
+			continue
+		}
+		if (tokenOrFamily.type === `atom_family`) {
+			const family = tokenOrFamily
+			family.subject.subscribe(`timeline:${options.key}`, (token) => {
+				if (!core.atoms.has(token.key)) {
+					addAtomToTimeline(token, tl, store)
+				}
+			})
+		} else {
+			const token = tokenOrFamily
+			if (`family` in token && token.family) {
+				const familyTimelineKey = core.timelineAtoms.getRelatedKey(
+					token.family.key,
+				)
+				if (familyTimelineKey) {
+					store.config.logger?.error(
+						`❌ Failed to add atom "${token.key}" to timeline "${options.key}" because its family "${token.family.key}" belongs to timeline "${familyTimelineKey}"`,
+					)
+					continue
+				}
+			}
+			addAtomToTimeline(token, tl, store)
+		}
+		core.timelineAtoms = core.timelineAtoms.set({
+			atomKey: tokenOrFamily.key,
+			timelineKey: options.key,
+		})
+	}
+
+	store.timelines.set(options.key, tl)
+	const token: TimelineToken = {
+		key: options.key,
+		type: `timeline`,
+	}
+	store.subject.timelineCreation.next(token)
+	return token
+}

package/internal/src/transaction/abort-transaction.ts

@@ -0,0 +1,12 @@
+import type { Store } from "../store"
+
+export const abortTransaction = (store: Store): void => {
+	if (store.transactionStatus.phase === `idle`) {
+		store.config.logger?.warn(
+			`abortTransaction called outside of a transaction. This is probably a bug.`,
+		)
+		return
+	}
+	store.transactionStatus = { phase: `idle` }
+	store.config.logger?.info(`🪂`, `transaction fail`)
+}

package/internal/src/transaction/apply-transaction.ts

@@ -0,0 +1,64 @@
+import type { AtomToken, ƒn } from "atom.io"
+import { setState, transaction } from "atom.io"
+
+import { withdraw } from "../store"
+import type { Store } from "../store"
+
+export const applyTransaction = <ƒ extends ƒn>(
+	output: ReturnType<ƒ>,
+	store: Store,
+): void => {
+	if (store.transactionStatus.phase !== `building`) {
+		store.config.logger?.warn(
+			`abortTransaction called outside of a transaction. This is probably a bug.`,
+		)
+		return
+	}
+	store.transactionStatus.phase = `applying`
+	store.transactionStatus.output = output
+	const { atomUpdates } = store.transactionStatus
+	store.config.logger?.info(
+		`🛃 applying transaction "${store.transactionStatus.key}" with ${atomUpdates.length} updates.`,
+	)
+	store.config.logger?.info(`🛃 the updates are:`, atomUpdates)
+	for (const { key, newValue } of atomUpdates) {
+		const token: AtomToken<unknown> = { key, type: `atom` }
+		if (!store.valueMap.has(token.key)) {
+			if (token.family) {
+				const family = store.families.get(token.family.key)
+				if (family) {
+					family(token.family.subKey)
+				}
+			} else {
+				const newAtom = store.transactionStatus.core.atoms.get(token.key)
+				if (!newAtom) {
+					throw new Error(
+						`Absurd Error: Atom "${token.key}" not found while copying updates from transaction "${store.transactionStatus.key}" to store "${store.config.name}"`,
+					)
+				}
+				store.atoms.set(newAtom.key, newAtom)
+				store.valueMap.set(newAtom.key, newAtom.default)
+				store.config.logger?.info(`🔧`, `add atom "${newAtom.key}"`)
+			}
+		}
+		// if (store.transactionStatus.key === `dealCards`) debugger
+		setState(token, newValue, store)
+	}
+	const myTransaction = withdraw<ƒ>(
+		{ key: store.transactionStatus.key, type: `transaction` },
+		store,
+	)
+	if (myTransaction === null) {
+		throw new Error(
+			`Transaction "${store.transactionStatus.key}" not found. Absurd. How is this running?`,
+		)
+	}
+	myTransaction.subject.next({
+		key: store.transactionStatus.key,
+		atomUpdates,
+		output,
+		params: store.transactionStatus.params as Parameters<ƒ>,
+	})
+	store.transactionStatus = { phase: `idle` }
+	store.config.logger?.info(`🛬`, `transaction "${myTransaction.key}" applied`)
+}

package/internal/src/transaction/build-transaction.ts

@@ -0,0 +1,39 @@
+import { Junction } from "~/packages/rel8/junction/src"
+
+import type { Store } from "../store"
+
+export const buildTransaction = (
+	key: string,
+	params: any[],
+	store: Store,
+): void => {
+	store.transactionStatus = {
+		key,
+		phase: `building`,
+		time: Date.now(),
+		core: {
+			atoms: new Map(store.atoms),
+			atomsThatAreDefault: new Set(store.atomsThatAreDefault),
+			families: new Map(store.families),
+			operation: { open: false },
+			readonlySelectors: new Map(store.readonlySelectors),
+			timelines: new Map(store.timelines),
+			timelineAtoms: new Junction(store.timelineAtoms.toJSON()),
+			trackers: new Map(),
+			transactions: new Map(store.transactions),
+			selectorAtoms: new Junction(store.selectorAtoms.toJSON()),
+			selectorGraph: new Junction(store.selectorGraph.toJSON(), {
+				makeContentKey: (...keys) => keys.sort().join(`:`),
+			}),
+			selectors: new Map(store.selectors),
+			valueMap: new Map(store.valueMap),
+		},
+		atomUpdates: [],
+		params,
+		output: undefined,
+	}
+	store.config.logger?.info(
+		`🛫`,
+		`transaction "${key}" building in store "${store.config.name}"`,
+	)
+}

package/internal/src/transaction/index.ts

@@ -0,0 +1,26 @@
+import type { TransactionUpdate, ƒn } from "atom.io"
+
+import type { StoreCore } from ".."
+
+export * from "./transaction-internal"
+
+export * from "./abort-transaction"
+export * from "./apply-transaction"
+export * from "./build-transaction"
+export * from "./redo-transaction"
+export * from "./undo-transaction"
+
+export const TRANSACTION_PHASES = [`idle`, `building`, `applying`] as const
+export type TransactionPhase = typeof TRANSACTION_PHASES[number]
+
+export type TransactionUpdateInProgress<ƒ extends ƒn> = TransactionUpdate<ƒ> & {
+	phase: `applying` | `building`
+	time: number
+	core: StoreCore
+}
+export type TransactionIdle = {
+	phase: `idle`
+}
+export type TransactionStatus<ƒ extends ƒn> =
+	| TransactionIdle
+	| TransactionUpdateInProgress<ƒ>

package/internal/src/transaction/redo-transaction.ts

@@ -0,0 +1,22 @@
+import type { AtomToken, TransactionUpdate, ƒn } from "atom.io"
+import { setState } from "atom.io"
+
+import { withdraw } from "../store"
+import type { Store } from "../store"
+
+export const redoTransactionUpdate = <ƒ extends ƒn>(
+	update: TransactionUpdate<ƒ>,
+	store: Store,
+): void => {
+	store.config.logger?.info(` ⏭ redo transaction "${update.key}" (redo)`)
+	for (const { key, newValue } of update.atomUpdates) {
+		const token: AtomToken<unknown> = { key, type: `atom` }
+		const state = withdraw(token, store)
+		if (state === null) {
+			throw new Error(
+				`State "${token.key}" not found in this store. This is surprising, because we are navigating the history of the store.`,
+			)
+		}
+		setState(state, newValue, store)
+	}
+}

package/internal/src/transaction/transaction-internal.ts

@@ -0,0 +1,64 @@
+import type {
+	TransactionOptions,
+	TransactionToken,
+	TransactionUpdate,
+	ƒn,
+} from "atom.io"
+import { getState, setState } from "atom.io"
+
+import { IMPLICIT, type Store, type StoreCore, deposit } from "../store"
+import { Subject } from "../subject"
+import { abortTransaction } from "./abort-transaction"
+import { applyTransaction } from "./apply-transaction"
+import { buildTransaction } from "./build-transaction"
+
+export type Transaction<ƒ extends ƒn> = {
+	key: string
+	type: `transaction`
+	install: (store: Store) => void
+	subject: Subject<TransactionUpdate<ƒ>>
+	run: (...parameters: Parameters<ƒ>) => ReturnType<ƒ>
+}
+
+export function transaction__INTERNAL<ƒ extends ƒn>(
+	options: TransactionOptions<ƒ>,
+	store: Store = IMPLICIT.STORE,
+): TransactionToken<ƒ> {
+	const newTransaction: Transaction<ƒ> = {
+		key: options.key,
+		type: `transaction`,
+		run: (...params: Parameters<ƒ>) => {
+			buildTransaction(options.key, params, store)
+			try {
+				const output = options.do(
+					{
+						get: (token) => getState(token, store),
+						set: (token, value) => setState(token, value, store),
+					},
+					...params,
+				)
+				applyTransaction(output, store)
+				return output
+			} catch (thrown) {
+				abortTransaction(store)
+				store.config.logger?.error(
+					`Transaction "${options.key}" failed in store "${store.config.name}":`,
+					thrown,
+				)
+				throw thrown
+			}
+		},
+		install: (store) => transaction__INTERNAL(options, store),
+		subject: new Subject(),
+	}
+	const core = target(store)
+	core.transactions.set(newTransaction.key, newTransaction)
+	const token = deposit(newTransaction)
+	store.subject.transactionCreation.next(token)
+	return token
+}
+
+export const target = (store: Store = IMPLICIT.STORE): StoreCore =>
+	store.transactionStatus.phase === `building`
+		? store.transactionStatus.core
+		: store

package/internal/src/transaction/undo-transaction.ts

@@ -0,0 +1,22 @@
+import type { AtomToken, TransactionUpdate, ƒn } from "atom.io"
+import { setState } from "atom.io"
+
+import { withdraw } from "../store"
+import type { Store } from "../store"
+
+export const undoTransactionUpdate = <ƒ extends ƒn>(
+	update: TransactionUpdate<ƒ>,
+	store: Store,
+): void => {
+	store.config.logger?.info(` ⏮ undo transaction "${update.key}" (undo)`)
+	for (const { key, oldValue } of update.atomUpdates) {
+		const token: AtomToken<unknown> = { key, type: `atom` }
+		const state = withdraw(token, store)
+		if (state === null) {
+			throw new Error(
+				`State "${token.key}" not found in this store. This is surprising, because we are navigating the history of the store.`,
+			)
+		}
+		setState(state, oldValue, store)
+	}
+}