@dcl/sdk 7.28.1-34901226656.commit-44656ea → 7.28.1-34955459026.commit-7db2d46

package/src/server/storage/constants.ts

@@ -0,0 +1,111 @@
+export const MODULE_NAME = 'Storage'
+
+/**
+ * Options for getValues pagination and filtering.
+ */
+export interface GetValuesOptions {
+  prefix?: string
+  limit?: number
+  offset?: number
+}
+
+/**
+ * Result of getValues with pagination metadata.
+ */
+export interface GetValuesResult {
+  /** Key-value entries for the current page. */
+  data: Array<{ key: string; value: unknown }>
+  pagination: {
+    offset: number
+    total: number
+  }
+}
+
+/**
+ * Per-call options for Storage get().
+ */
+export interface GetOptions {
+  /**
+   * When true, bypasses the read cache and forces a network read (the result
+   * still refreshes the cache). Concurrent gets for the same key still share
+   * one in-flight request. Default: false.
+   */
+  fresh?: boolean
+}
+
+/**
+ * Per-call options for Storage set().
+ */
+export interface SetOptions {
+  /**
+   * When true, skips the network write if the serialized value matches the
+   * last value known to be stored for this key (from a previous successful
+   * set() or get()). Overrides the configured default. Default: true.
+   */
+  skipIfUnchanged?: boolean
+}
+
+/**
+ * Module-wide configuration for Storage, applied to both scene-scoped and
+ * player-scoped storage via Storage.configure().
+ */
+export interface StorageOptions {
+  /**
+   * Default for set()'s skipIfUnchanged when not passed per call. A skip only
+   * suppresses a proven no-op: the exact serialized value was confirmed stored
+   * by a previous network round-trip within cacheMaxAgeMs. Default: true.
+   */
+  skipIfUnchanged?: boolean
+  /**
+   * When true, get() serves values from the local cache within cacheMaxAgeMs,
+   * including confirmed "not found" results, without a network request.
+   * Out-of-band writers (e.g. CLI storage commands) may not be visible for up
+   * to cacheMaxAgeMs; pass { fresh: true } per call to force a network read.
+   * Default: true.
+   */
+  cacheReads?: boolean
+  /**
+   * Max cache entries per scope (scene / player) before oldest entries are
+   * evicted. Entries hold the serialized value body, so memory scales with
+   * value size — this bounds entry count, not bytes. Default: 512.
+   */
+  cacheMaxEntries?: number
+  /**
+   * Max age of a cache entry in milliseconds, bounding both read-cache
+   * staleness and write-dedup trust; older entries are treated as unknown.
+   * The default is deliberately short so out-of-band writers (CLI storage
+   * commands, dashboards) become visible within a minute, while still
+   * absorbing hot per-frame reads. Default: 60000 (1 minute).
+   */
+  cacheMaxAgeMs?: number
+}
+
+/**
+ * Fully-resolved storage configuration shared by scene and player storage.
+ * @internal
+ */
+export interface StorageConfigState {
+  skipIfUnchanged: boolean
+  cacheReads: boolean
+  cacheMaxEntries: number
+  cacheMaxAgeMs: number
+}
+
+/**
+ * Default values for the resolved storage configuration.
+ * @internal
+ */
+export const DEFAULT_STORAGE_CONFIG: Readonly<StorageConfigState> = {
+  skipIfUnchanged: true,
+  cacheReads: true,
+  cacheMaxEntries: 512,
+  cacheMaxAgeMs: 60 * 1000
+}
+
+/**
+ * Creates a mutable config object, later mutated by Storage.configure().
+ * @internal
+ */
+export function createStorageConfig(overrides?: StorageOptions): StorageConfigState {
+  return { ...DEFAULT_STORAGE_CONFIG, ...overrides }
+}

package/src/server/storage/index.ts

@@ -0,0 +1,74 @@
+import { createStorageConfig, StorageOptions } from './constants'
+import { createSceneStorage, ISceneStorage } from './scene'
+import { createPlayerStorage, IPlayerStorage } from './player'
+
+// Re-export interfaces and types
+export { GetOptions, GetValuesOptions, GetValuesResult, SetOptions, StorageOptions } from './constants'
+export { ISceneStorage } from './scene'
+export { IPlayerStorage } from './player'
+
+/**
+ * Storage interface with methods for scene-scoped and player-scoped storage.
+ */
+export interface IStorage extends ISceneStorage {
+  /** Player-scoped storage for key-value pairs */
+  player: IPlayerStorage
+
+  /**
+   * Sets module-wide defaults for both scene-scoped and player-scoped storage.
+   * Merges the given partial options into the current configuration.
+   * Note: cacheMaxEntries applies per scope (scene and player each keep their
+   * own cache) and bounds entry count, not bytes (entries hold serialized
+   * value bodies).
+   */
+  configure(options: StorageOptions): void
+}
+
+/**
+ * Creates the Storage module with scene-scoped and player-scoped storage.
+ */
+const createStorage = (): IStorage => {
+  const config = createStorageConfig()
+  const sceneStorage = createSceneStorage(config)
+  const playerStorage = createPlayerStorage(config)
+
+  return {
+    // Spread scene storage methods at top level
+    get: sceneStorage.get,
+    set: sceneStorage.set,
+    delete: sceneStorage.delete,
+    getValues: sceneStorage.getValues,
+    // Keep player as nested property
+    player: playerStorage,
+    configure(options: StorageOptions): void {
+      for (const [key, value] of Object.entries(options)) {
+        if (value !== undefined) (config as unknown as Record<string, unknown>)[key] = value
+      }
+    }
+  }
+}
+
+/**
+ * Storage provides methods to store and retrieve key-value data from the
+ * Server Side Storage service.
+ *
+ * - Use Storage.get/set/delete/getValues for scene-scoped storage
+ * - Use Storage.player.get/set/delete/getValues for player-scoped storage
+ * - Use Storage.configure to change module-wide defaults (e.g. skipIfUnchanged, cacheReads)
+ *
+ * Reads are cached by default: get() serves values known from a network
+ * round-trip within the last cacheMaxAgeMs (including confirmed "not found"
+ * results) without hitting the service, and concurrent gets for the same key
+ * share one request. Overlapping writes to the same key are serialized so the
+ * service commits them in issue order, and rapid writes coalesce to the
+ * latest value; every set()/delete() resolves once its value (or the newer
+ * value that superseded it) is durably applied. By default (skipIfUnchanged)
+ * an unchanged set is skipped, but only when a previous confirmed round-trip
+ * proved the exact value is already stored. Out-of-band writers (e.g. CLI storage commands)
+ * may not be visible for up to cacheMaxAgeMs; use get(key, { fresh: true })
+ * for an authoritative read or Storage.configure({ cacheReads: false }) to
+ * disable read caching.
+ *
+ * This module only works when running on server-side scenes.
+ */
+export const Storage: IStorage = createStorage()

package/src/server/storage/player.ts

@@ -0,0 +1,289 @@
+import { getStorageServerUrl } from '../storage-url'
+import { assertIsServer, wrapSignedFetch } from '../utils'
+import {
+  createStorageConfig,
+  GetOptions,
+  GetValuesOptions,
+  GetValuesResult,
+  MODULE_NAME,
+  SetOptions,
+  StorageConfigState
+} from './constants'
+import { createValueCache } from './value-cache'
+import { createWriteQueue } from './write-queue'
+
+/**
+ * Player-scoped storage interface for key-value pairs from the Server Side Storage service.
+ * This is NOT filesystem storage - data is stored in the remote storage service.
+ */
+export interface IPlayerStorage {
+  /**
+   * Retrieves a value from a player's storage by key from the Server Side Storage service.
+   *
+   * By default (cacheReads), values read or written during the last cacheMaxAgeMs
+   * are served from a local cache without a network request, including confirmed
+   * "not found" results. Concurrent gets for the same player and key share one
+   * request. Out-of-band writers (e.g. CLI storage commands) may not be visible
+   * for up to cacheMaxAgeMs — pass { fresh: true } to force a network read.
+   * @param address - The player's wallet address
+   * @param key - The key to retrieve
+   * @param options - Optional { fresh } to bypass the read cache
+   * @returns A promise that resolves to the parsed JSON value, or null if not found
+   */
+  get<T = unknown>(address: string, key: string, options?: GetOptions): Promise<T | null>
+
+  /**
+   * Stores a value in a player's storage in the Server Side Storage service.
+   * @param address - The player's wallet address
+   * @param key - The key to store the value under
+   * @param value - The value to store (will be JSON serialized)
+   * @param options - Optional { skipIfUnchanged } to skip the network write when the value is already stored
+   * @returns A promise that resolves to true if successful, false otherwise
+   */
+  set<T = unknown>(address: string, key: string, value: T, options?: SetOptions): Promise<boolean>
+
+  /**
+   * Deletes a value from a player's storage in the Server Side Storage service.
+   * @param address - The player's wallet address
+   * @param key - The key to delete
+   * @returns A promise that resolves to true if deleted, false if not found
+   */
+  delete(address: string, key: string): Promise<boolean>
+
+  /**
+   * Returns key-value entries from a player's storage, optionally filtered by prefix.
+   * Supports pagination via limit and offset.
+   * @param address - The player's wallet address
+   * @param options - Optional { prefix, limit, offset } for filtering and pagination.
+   * @returns A promise that resolves to { data, pagination: { offset, total } } for pagination UI
+   */
+  getValues(address: string, options?: GetValuesOptions): Promise<GetValuesResult>
+}
+
+/**
+ * Creates player-scoped storage that provides methods to interact with
+ * player-specific key-value pairs from the Server Side Storage service.
+ * This module only works when running on server-side scenes.
+ * @internal
+ */
+export const createPlayerStorage = (config: StorageConfigState = createStorageConfig()): IPlayerStorage => {
+  const cache = createValueCache(config)
+  // Each in-flight GET is tracked by a wrapper object whose identity marks
+  // ownership: set()/delete() drop the wrapper, detaching the pending GET so
+  // its stale response cannot overwrite the newer cache entry.
+  const inflightGets = new Map<string, { promise: Promise<unknown> }>()
+
+  // Ethereum addresses are case-insensitive (checksum casing only), so
+  // mixed-case callers must share the same cache entry. The NUL separator
+  // cannot appear in an address, making the pair unambiguous.
+  const cacheKey = (address: string, key: string) => `${address.toLowerCase()}\u0000${key}`
+
+  // Writes to the same player key are serialized (and rapid ones coalesced to
+  // the latest value) so the service commits them in issue order — overlapping
+  // PUTs would otherwise leave both the kept value and the cached value to
+  // response-order chance. Keyed by the same case-insensitive cache key.
+  const writes = createWriteQueue()
+
+  async function executeSet(address: string, key: string, ck: string, body: string): Promise<boolean> {
+    const baseUrl = await getStorageServerUrl()
+    const url = `${baseUrl}/players/${encodeURIComponent(address)}/values/${encodeURIComponent(key)}`
+
+    const [error] = await wrapSignedFetch({
+      url,
+      init: {
+        method: 'PUT',
+        headers: {
+          'content-type': 'application/json'
+        },
+        body
+      }
+    })
+
+    // Either way the entry changed server-side (or may have): detach any
+    // overlapping in-flight GET so its stale response is not cached.
+    inflightGets.delete(ck)
+
+    if (error) {
+      // The PUT may have reached the server, so the cached body is no
+      // longer reliable.
+      cache.delete(ck)
+      console.error(`Failed to set player storage value '${key}' for '${address}': ${error}`)
+      return false
+    }
+
+    cache.set(ck, { body })
+    return true
+  }
+
+  async function executeDelete(address: string, key: string, ck: string): Promise<boolean> {
+    const baseUrl = await getStorageServerUrl()
+    const url = `${baseUrl}/players/${encodeURIComponent(address)}/values/${encodeURIComponent(key)}`
+
+    const [error, , status] = await wrapSignedFetch({
+      url,
+      init: {
+        method: 'DELETE',
+        headers: {}
+      }
+    })
+
+    // Detach again: a GET may have started while the DELETE was in flight.
+    inflightGets.delete(ck)
+
+    if (error) {
+      // A 404 still confirms the key is absent server-side.
+      if (status === 404) cache.setAbsent(ck)
+      console.error(`Failed to delete player storage value '${key}' for '${address}': ${error}`)
+      return false
+    }
+
+    cache.setAbsent(ck)
+    return true
+  }
+
+  return {
+    async get<T = unknown>(address: string, key: string, options?: GetOptions): Promise<T | null> {
+      assertIsServer(MODULE_NAME)
+
+      const ck = cacheKey(address, key)
+
+      if (config.cacheReads && !options?.fresh) {
+        const entry = cache.get(ck)
+        if (entry?.absent) return null
+        // Parse per hit so each caller gets a fresh object (no shared mutation).
+        if (entry?.body !== undefined) return JSON.parse(entry.body).value as T
+      }
+
+      // Coalesce concurrent gets (even fresh ones: an in-flight response is
+      // milliseconds old, not TTL-stale) into a single network request.
+      const joined = inflightGets.get(ck)
+      if (joined) return joined.promise as Promise<T | null>
+
+      const inflight = {} as { promise: Promise<T | null> }
+      inflight.promise = (async () => {
+        try {
+          const baseUrl = await getStorageServerUrl()
+          const url = `${baseUrl}/players/${encodeURIComponent(address)}/values/${encodeURIComponent(key)}`
+
+          const [error, data, status] = await wrapSignedFetch<{ value: T }>({ url })
+
+          const isOwner = inflightGets.get(ck) === inflight
+
+          if (error) {
+            // A confirmed 404 is a first-class "absent" outcome, not a failure.
+            if (status === 404) {
+              if (isOwner) cache.setAbsent(ck)
+              return null
+            }
+            console.error(`Failed to get player storage value '${key}' for '${address}': ${error}`)
+            return null
+          }
+
+          if (data && data.value !== undefined) {
+            // Same serialization shape as set()'s PUT body, so a read followed by
+            // an unchanged write can be skipped.
+            const body = JSON.stringify({ value: data.value })
+            if (isOwner) cache.set(ck, { body })
+            return data.value
+          }
+
+          // 200 with a missing value is ambiguous: neither a confirmed value
+          // nor a confirmed absence, so cache nothing.
+          return null
+        } finally {
+          if (inflightGets.get(ck) === inflight) inflightGets.delete(ck)
+        }
+      })()
+
+      inflightGets.set(ck, inflight)
+      return inflight.promise
+    },
+
+    async set<T = unknown>(address: string, key: string, value: T, options?: SetOptions): Promise<boolean> {
+      assertIsServer(MODULE_NAME)
+
+      const ck = cacheKey(address, key)
+      const body = JSON.stringify({ value })
+      const skipIfUnchanged = options?.skipIfUnchanged ?? config.skipIfUnchanged
+
+      // Dedup against confirmed state only while no write is pending — a
+      // pending write makes the cache momentarily stale; enqueue() coalesces
+      // against pending writes instead.
+      if (skipIfUnchanged && writes.pending(ck) === undefined && cache.get(ck)?.body === body) {
+        return true
+      }
+
+      return writes.enqueue(ck, body, (b) => executeSet(address, key, ck, b as string), skipIfUnchanged)
+    },
+
+    async delete(address: string, key: string): Promise<boolean> {
+      assertIsServer(MODULE_NAME)
+
+      const ck = cacheKey(address, key)
+
+      // Invalidate immediately — even while the DELETE waits behind other
+      // writes, reads must not serve the doomed value, and a stale
+      // "unchanged" skip would lose a future write.
+      cache.delete(ck)
+      inflightGets.delete(ck)
+
+      return writes.enqueue(ck, null, () => executeDelete(address, key, ck), true)
+    },
+
+    async getValues(address: string, options?: GetValuesOptions): Promise<GetValuesResult> {
+      assertIsServer(MODULE_NAME)
+
+      const { prefix, limit, offset } = options ?? {}
+      const baseUrl = await getStorageServerUrl()
+      const parts: string[] = []
+
+      if (!!prefix) {
+        parts.push(`prefix=${encodeURIComponent(prefix)}`)
+      }
+
+      if (!!limit) {
+        parts.push(`limit=${limit}`)
+      }
+
+      if (!!offset) {
+        parts.push(`offset=${offset}`)
+      }
+
+      const query = parts.join('&')
+      const url = query
+        ? `${baseUrl}/players/${encodeURIComponent(address)}/values?${query}`
+        : `${baseUrl}/players/${encodeURIComponent(address)}/values`
+
+      const [error, response] = await wrapSignedFetch<GetValuesResult>({ url })
+
+      if (error) {
+        console.error(`Failed to get player storage values for '${address}': ${error}`)
+        return { data: [], pagination: { offset: 0, total: 0 } }
+      }
+
+      const data = response?.data ?? []
+
+      // Seed the per-key cache so subsequent get()/set() on returned keys can
+      // skip the network. Only keys with no live entry and no pending write
+      // are seeded: existing per-key state comes from a confirmed operation
+      // that this page snapshot — whose request started earlier — must not
+      // clobber with stale data. Absence is never seeded (prefix/pagination
+      // make it non-authoritative). A page larger than cacheMaxEntries churns
+      // the cache; entries repopulate lazily.
+      for (const entry of data) {
+        const ck = cacheKey(address, entry.key)
+        if (entry.value !== undefined && !writes.isPending(ck) && cache.get(ck) === undefined) {
+          cache.set(ck, { body: JSON.stringify({ value: entry.value }) })
+        }
+      }
+
+      const requestedOffset = offset ?? 0
+      const pagination = {
+        offset: response?.pagination?.offset ?? requestedOffset,
+        total: response?.pagination?.total ?? data.length
+      }
+
+      return { data, pagination }
+    }
+  }
+}