atom.io 0.46.4 → 0.46.6

package/src/realtime-server/realtime-family-provider.ts

@@ -14,7 +14,7 @@ import type { ServerConfig } from "."
 export type FamilyProvider = ReturnType<typeof realtimeAtomFamilyProvider>
 export function realtimeAtomFamilyProvider({
 	socket,
-	userKey,
+	consumer,
 	store = IMPLICIT.STORE,
 }: ServerConfig) {
 	return function familyProvider<
@@ -22,8 +22,17 @@ export function realtimeAtomFamilyProvider({
 		K extends Canonical,
 	>(
 		family: AtomIO.RegularAtomFamilyToken<J, K>,
-		index: AtomIO.ReadableToken<Iterable<NoInfer<K>>>,
+		index: AtomIO.ReadableToken<Iterable<NoInfer<K>>> | Iterable<NoInfer<K>>,
 	): () => void {
+		const [dynamicIndex, staticIndex]:
+			| [AtomIO.ReadableToken<Iterable<NoInfer<K>>>, undefined]
+			| [undefined, Iterable<NoInfer<K>>] = (() => {
+			if (typeof index === `object` && `key` in index && `type` in index) {
+				return [index, undefined] as const
+			}
+			return [undefined, index] as const
+		})()
+
 		const coreSubscriptions = new Set<() => void>()
 		const clearCoreSubscriptions = () => {
 			for (const unsub of coreSubscriptions) unsub()
@@ -70,7 +79,7 @@ export function realtimeAtomFamilyProvider({
 					store.logger.info(
 						`🙈`,
 						`user`,
-						userKey,
+						consumer,
 						`unsubscribed from state "${token.key}"`,
 					)
 					fillUnsubRequest(token.key)
@@ -91,18 +100,23 @@ export function realtimeAtomFamilyProvider({
 			store.logger.info(
 				`👀`,
 				`user`,
-				userKey,
+				consumer,
 				`can subscribe to family "${family.key}"`,
 			)
 			coreSubscriptions.add(
 				employSocket(socket, `sub:${family.key}`, (subKey: K) => {
-					const exposedSubKeys = getFromStore(store, index)
+					let exposedSubKeys: Iterable<K>
+					if (dynamicIndex) {
+						exposedSubKeys = getFromStore(store, dynamicIndex)
+					} else {
+						exposedSubKeys = staticIndex
+					}
 					const shouldExpose = isAvailable(exposedSubKeys, subKey)
 					if (shouldExpose) {
 						store.logger.info(
 							`👀`,
 							`user`,
-							userKey,
+							consumer,
 							`is approved for a subscription to`,
 							subKey,
 							`in family "${family.key}"`,
@@ -112,7 +126,7 @@ export function realtimeAtomFamilyProvider({
 						store.logger.info(
 							`❌`,
 							`user`,
-							userKey,
+							consumer,
 							`is denied for a subscription to`,
 							subKey,
 							`in family "${family.key}"`,
@@ -122,35 +136,37 @@ export function realtimeAtomFamilyProvider({
 					}
 				}),
 			)
-			coreSubscriptions.add(
-				subscribeToState(
-					store,
-					index,
-					`expose-family:${family.key}:${socket.id}`,
-					({ newValue: newExposedSubKeys }) => {
-						store.logger.info(
-							`👀`,
-							`user`,
-							userKey,
-							`has the following keys available for family "${family.key}"`,
-							newExposedSubKeys,
-						)
-						for (const subKey of newExposedSubKeys) {
-							if (familyMemberSubscriptionsWanted.has(stringifyJson(subKey))) {
-								store.logger.info(
-									`👀`,
-									`user`,
-									userKey,
-									`is retroactively approved for a subscription to`,
-									subKey,
-									`in family "${family.key}"`,
-								)
-								exposeFamilyMembers(subKey)
+			if (dynamicIndex) {
+				coreSubscriptions.add(
+					subscribeToState(
+						store,
+						dynamicIndex,
+						`expose-family:${family.key}:${socket.id}`,
+						({ newValue: newExposedSubKeys }) => {
+							store.logger.info(
+								`👀`,
+								`user`,
+								consumer,
+								`has the following keys available for family "${family.key}"`,
+								newExposedSubKeys,
+							)
+							for (const subKey of newExposedSubKeys) {
+								if (familyMemberSubscriptionsWanted.has(stringifyJson(subKey))) {
+									store.logger.info(
+										`👀`,
+										`user`,
+										consumer,
+										`is retroactively approved for a subscription to`,
+										subKey,
+										`in family "${family.key}"`,
+									)
+									exposeFamilyMembers(subKey)
+								}
 							}
-						}
-					},
-				),
-			)
+						},
+					),
+				)
+			}
 		}
 
 		start()

package/src/realtime-server/realtime-mutable-family-provider.ts

@@ -31,7 +31,7 @@ export type MutableFamilyProvider = ReturnType<
 >
 export function realtimeMutableFamilyProvider({
 	socket,
-	userKey,
+	consumer,
 	store = IMPLICIT.STORE,
 }: ServerConfig) {
 	return function mutableFamilyProvider<
@@ -39,8 +39,17 @@ export function realtimeMutableFamilyProvider({
 		K extends Canonical,
 	>(
 		family: AtomIO.MutableAtomFamilyToken<T, K>,
-		index: AtomIO.ReadableToken<Iterable<NoInfer<K>>>,
+		index: AtomIO.ReadableToken<Iterable<NoInfer<K>>> | Iterable<NoInfer<K>>,
 	): () => void {
+		const [dynamicIndex, staticIndex]:
+			| [AtomIO.ReadableToken<Iterable<NoInfer<K>>>, undefined]
+			| [undefined, Iterable<NoInfer<K>>] = (() => {
+			if (typeof index === `object` && `key` in index && `type` in index) {
+				return [index, undefined] as const
+			}
+			return [undefined, index] as const
+		})()
+
 		const coreSubscriptions = new Set<() => void>()
 		const clearCoreSubscriptions = () => {
 			for (const unsub of coreSubscriptions) unsub()
@@ -95,18 +104,23 @@ export function realtimeMutableFamilyProvider({
 			store.logger.info(
 				`👀`,
 				`user`,
-				userKey,
+				consumer,
 				`can subscribe to family "${family.key}"`,
 			)
 			coreSubscriptions.add(
 				employSocket(socket, `sub:${family.key}`, (subKey: K) => {
-					const exposedSubKeys = getFromStore(store, index)
+					let exposedSubKeys: Iterable<K>
+					if (dynamicIndex) {
+						exposedSubKeys = getFromStore(store, dynamicIndex)
+					} else {
+						exposedSubKeys = staticIndex
+					}
 					const shouldExpose = isAvailable(exposedSubKeys, subKey)
 					if (shouldExpose) {
 						store.logger.info(
 							`👀`,
 							`user`,
-							userKey,
+							consumer,
 							`is approved for a subscription to`,
 							subKey,
 							`in family "${family.key}"`,
@@ -116,7 +130,7 @@ export function realtimeMutableFamilyProvider({
 						store.logger.info(
 							`❌`,
 							`user`,
-							userKey,
+							consumer,
 							`is denied for a subscription to`,
 							subKey,
 							`in family "${family.key}"`,
@@ -126,35 +140,37 @@ export function realtimeMutableFamilyProvider({
 					}
 				}),
 			)
-			coreSubscriptions.add(
-				subscribeToState(
-					store,
-					index,
-					`expose-family:${family.key}:${socket.id}`,
-					({ newValue: newExposedSubKeys }) => {
-						store.logger.info(
-							`👀`,
-							`user`,
-							userKey,
-							`has the following keys available for family "${family.key}"`,
-							newExposedSubKeys,
-						)
-						for (const subKey of newExposedSubKeys) {
-							if (familyMemberSubscriptionsWanted.has(stringifyJson(subKey))) {
-								store.logger.info(
-									`👀`,
-									`user`,
-									userKey,
-									`is retroactively approved for a subscription to`,
-									subKey,
-									`in family "${family.key}"`,
-								)
-								exposeFamilyMembers(subKey)
+			if (dynamicIndex) {
+				coreSubscriptions.add(
+					subscribeToState(
+						store,
+						dynamicIndex,
+						`expose-family:${family.key}:${socket.id}`,
+						({ newValue: newExposedSubKeys }) => {
+							store.logger.info(
+								`👀`,
+								`user`,
+								consumer,
+								`has the following keys available for family "${family.key}"`,
+								newExposedSubKeys,
+							)
+							for (const subKey of newExposedSubKeys) {
+								if (familyMemberSubscriptionsWanted.has(stringifyJson(subKey))) {
+									store.logger.info(
+										`👀`,
+										`user`,
+										consumer,
+										`is retroactively approved for a subscription to`,
+										subKey,
+										`in family "${family.key}"`,
+									)
+									exposeFamilyMembers(subKey)
+								}
 							}
-						}
-					},
-				),
-			)
+						},
+					),
+				)
+			}
 		}
 
 		start()

package/src/realtime-server/realtime-mutable-provider.ts

@@ -15,7 +15,7 @@ import type { ServerConfig } from "."
 export type MutableProvider = ReturnType<typeof realtimeMutableProvider>
 export function realtimeMutableProvider({
 	socket,
-	userKey,
+	consumer,
 	store = IMPLICIT.STORE,
 }: ServerConfig) {
 	return function mutableProvider<
@@ -34,7 +34,7 @@ export function realtimeMutableProvider({
 			store.logger.info(
 				`👀`,
 				`user`,
-				userKey,
+				consumer,
 				`can subscribe to state "${token.key}"`,
 			)
 			subscriptions.add(
@@ -42,7 +42,7 @@ export function realtimeMutableProvider({
 					store.logger.info(
 						`👀`,
 						`user`,
-						userKey,
+						consumer,
 						`subscribes to state "${token.key}"`,
 					)
 					clearSubscriptions()
@@ -62,7 +62,7 @@ export function realtimeMutableProvider({
 							store.logger.info(
 								`🙈`,
 								`user`,
-								userKey,
+								consumer,
 								`unsubscribes from state "${token.key}"`,
 							)
 							clearSubscriptions()

package/src/realtime-server/realtime-state-provider.ts

@@ -17,10 +17,10 @@ function isReadableToken(input: unknown): input is AtomIO.ReadableToken<any> {
 export type StateProvider = ReturnType<typeof realtimeStateProvider>
 export function realtimeStateProvider({
 	socket,
-	userKey,
+	consumer,
 	store = IMPLICIT.STORE,
 }: ServerConfig) {
-	store.logger.info(`🔌`, `user`, userKey, `initialized state provider`)
+	store.logger.info(`🔌`, `user`, consumer, `initialized state provider`)
 	return function stateProvider<C extends Json.Serializable, S extends C>(
 		clientToken: AtomIO.WritableToken<C>,
 		serverData:
@@ -40,7 +40,7 @@ export function realtimeStateProvider({
 				store.logger.info(
 					`👀`,
 					`user`,
-					userKey,
+					consumer,
 					`will be served`,
 					serverData,
 					`as "${clientToken.key}"`,
@@ -49,7 +49,7 @@ export function realtimeStateProvider({
 				store.logger.info(
 					`👀`,
 					`user`,
-					userKey,
+					consumer,
 					`can subscribe to state "${serverData.key}" as "${clientToken.key}"`,
 				)
 			}
@@ -59,7 +59,7 @@ export function realtimeStateProvider({
 						store.logger.info(
 							`👀`,
 							`user`,
-							userKey,
+							consumer,
 							`requests`,
 							`"${clientToken.key}"`,
 						)
@@ -68,7 +68,7 @@ export function realtimeStateProvider({
 						store.logger.info(
 							`👀`,
 							`user`,
-							userKey,
+							consumer,
 							`subscribes to state "${serverData.key}"`,
 							clientToken === serverData
 								? `directly`
@@ -94,7 +94,7 @@ export function realtimeStateProvider({
 								store.logger.info(
 									`🙈`,
 									`user`,
-									userKey,
+									consumer,
 									`unsubscribes from state "${serverData.key}", served`,
 									clientToken === serverData
 										? `directly`

package/src/realtime-server/realtime-state-receiver.ts

@@ -17,7 +17,7 @@ import type { ServerConfig } from "."
 export type StateReceiver = ReturnType<typeof realtimeStateReceiver>
 export function realtimeStateReceiver({
 	socket,
-	userKey,
+	consumer,
 	store = IMPLICIT.STORE,
 }: ServerConfig) {
 	return function stateReceiver<S extends Json.Serializable, C extends S>(
@@ -43,7 +43,7 @@ export function realtimeStateReceiver({
 						store.logger.error(
 							`❌`,
 							`user`,
-							userKey,
+							consumer,
 							`attempted to publish invalid value`,
 							newValue,
 							`to state "${serverToken.key}"`,

package/src/realtime-server/server-config.ts

@@ -12,21 +12,27 @@ import {
 	IMPLICIT,
 	setIntoStore,
 } from "atom.io/internal"
-import type { Socket, SocketKey, UserKey } from "atom.io/realtime"
+import type { RoomKey, Socket, SocketKey, UserKey } from "atom.io/realtime"
+import { myUserKeyAtom } from "atom.io/realtime-client"
 import type { Server } from "socket.io"
 
 import { realtimeStateProvider } from "./realtime-state-provider"
 import type { SocketSystemHierarchy } from "./server-socket-state"
 import {
+	onlineUsersAtom,
 	socketAtoms,
 	socketKeysAtom,
-	userKeysAtom,
 	usersOfSockets,
 } from "./server-socket-state"
 
 export type ServerConfig = {
 	socket: Socket
-	userKey: UserKey
+	consumer: RoomKey | UserKey
+	store?: RootStore
+}
+export type UserServerConfig = {
+	socket: Socket
+	consumer: UserKey
 	store?: RootStore
 }
 
@@ -57,7 +63,7 @@ export type Handshake = {
 export function realtime(
 	server: Server,
 	auth: (handshake: Handshake) => Loadable<Error | UserKey>,
-	onConnect: (config: ServerConfig) => Loadable<() => Loadable<void>>,
+	onConnect: (config: UserServerConfig) => Loadable<() => Loadable<void>>,
 	store: RootStore = IMPLICIT.STORE,
 ): () => Promise<void> {
 	const socketRealm = new Realm<SocketSystemHierarchy>(store)
@@ -76,24 +82,21 @@ export function realtime(
 			editRelationsInStore(store, usersOfSockets, (relations) => {
 				relations.set(userClaim, socketClaim)
 			})
-			setIntoStore(store, userKeysAtom, (index) => index.add(userClaim))
+			setIntoStore(store, onlineUsersAtom, (index) => index.add(userClaim))
 			setIntoStore(store, socketKeysAtom, (index) => index.add(socketClaim))
 			next()
 		})
 		.on(`connection`, async (socket) => {
 			const socketKey = `socket::${socket.id}` satisfies SocketKey
-			const userKeyState = findRelationsInStore(
+			const userKeySelector = findRelationsInStore(
 				store,
 				usersOfSockets,
 				socketKey,
 			).userKeyOfSocket
-			const userKey = getFromStore(store, userKeyState)!
-			const serverConfig: ServerConfig = { store, socket, userKey }
+			const userKey = getFromStore(store, userKeySelector)!
+			const serverConfig: UserServerConfig = { store, socket, consumer: userKey }
 			const provideState = realtimeStateProvider(serverConfig)
-			const unsubFromMyUserKey = provideState(
-				{ key: `myUserKey`, type: `atom` },
-				userKey,
-			)
+			const unsubFromMyUserKey = provideState(myUserKeyAtom, userKey)
 
 			const disposeServices = await onConnect(serverConfig)
 
@@ -104,7 +107,11 @@ export function realtime(
 				editRelationsInStore(store, usersOfSockets, (rel) =>
 					rel.delete(socketKey),
 				)
-				setIntoStore(store, userKeysAtom, (keys) => (keys.delete(userKey), keys))
+				setIntoStore(
+					store,
+					onlineUsersAtom,
+					(keys) => (keys.delete(userKey), keys),
+				)
 				setIntoStore(
 					store,
 					socketKeysAtom,

package/src/realtime-server/server-socket-state.ts

@@ -25,11 +25,11 @@ export const socketAtoms: RegularAtomFamilyToken<Socket | null, SocketKey> =
 	})
 
 export const socketKeysAtom: MutableAtomToken<UList<SocketKey>> = mutableAtom({
-	key: `socketsIndex`,
+	key: `socketKeys`,
 	class: UList,
 })
-export const userKeysAtom: MutableAtomToken<UList<UserKey>> = mutableAtom({
-	key: `usersIndex`,
+export const onlineUsersAtom: MutableAtomToken<UList<UserKey>> = mutableAtom({
+	key: `onlineUsers`,
 	class: UList,
 })
 export const usersOfSockets: JoinToken<

package/src/realtime-testing/setup-realtime-test.tsx

@@ -133,7 +133,7 @@ export const setupRealtimeTestServer = (
 			return new Error(`Authentication error`)
 		},
 		(config) => {
-			const { socket, userKey } = config
+			const { socket, consumer: userKey } = config
 			function enableLogging() {
 				prefixLogger(silo.store, `server`)
 				socket.onAny((event, ...args) => {
@@ -148,7 +148,7 @@ export const setupRealtimeTestServer = (
 			}
 			const disposeServices = options.server({
 				socket: config.socket,
-				userKey: config.userKey,
+				userKey: config.consumer,
 				enableLogging,
 				silo,
 			})