@dcl/sdk 7.26.0 → 7.26.1-31714079767.commit-96e9a29

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 }
+    }
+  }
+}

package/src/server/storage/scene.ts

@@ -0,0 +1,270 @@
+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'
+
+/**
+ * Scene-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 ISceneStorage {
+  /**
+   * Retrieves a value from scene 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 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 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>(key: string, options?: GetOptions): Promise<T | null>
+
+  /**
+   * Stores a value in scene storage in the Server Side Storage service.
+   * @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
+   */
+  set<T = unknown>(key: string, value: T, options?: SetOptions): Promise<boolean>
+
+  /**
+   * Deletes a value from scene storage in the Server Side Storage service.
+   * @param key - The key to delete
+   * @returns A promise that resolves to true if deleted, false if not found
+   */
+  delete(key: string): Promise<boolean>
+
+  /**
+   * Returns key-value entries from scene storage, optionally filtered by prefix.
+   * Supports pagination via limit and offset.
+   * @param options - Optional { prefix, limit, offset } for filtering and pagination.
+   * @returns A promise that resolves to { data, pagination: { offset, total } } for pagination UI
+   */
+  getValues(options?: GetValuesOptions): Promise<GetValuesResult>
+}
+
+/**
+ * Creates scene-scoped storage that provides methods to interact with
+ * scene-specific key-value pairs from the Server Side Storage service.
+ * This module only works when running on server-side scenes.
+ * @internal
+ */
+export const createSceneStorage = (config: StorageConfigState = createStorageConfig()): ISceneStorage => {
+  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> }>()
+  // Writes to the same 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.
+  const writes = createWriteQueue()
+
+  async function executeSet(key: string, body: string): Promise<boolean> {
+    const baseUrl = await getStorageServerUrl()
+    const url = `${baseUrl}/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(key)
+
+    if (error) {
+      // The PUT may have reached the server, so the cached body is no
+      // longer reliable.
+      cache.delete(key)
+      console.error(`Failed to set storage value '${key}': ${error}`)
+      return false
+    }
+
+    cache.set(key, { body })
+    return true
+  }
+
+  async function executeDelete(key: string): Promise<boolean> {
+    const baseUrl = await getStorageServerUrl()
+    const url = `${baseUrl}/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(key)
+
+    if (error) {
+      // A 404 still confirms the key is absent server-side.
+      if (status === 404) cache.setAbsent(key)
+      console.error(`Failed to delete storage value '${key}': ${error}`)
+      return false
+    }
+
+    cache.setAbsent(key)
+    return true
+  }
+
+  return {
+    async get<T = unknown>(key: string, options?: GetOptions): Promise<T | null> {
+      assertIsServer(MODULE_NAME)
+
+      if (config.cacheReads && !options?.fresh) {
+        const entry = cache.get(key)
+        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(key)
+      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}/values/${encodeURIComponent(key)}`
+
+          const [error, data, status] = await wrapSignedFetch<{ value: T }>({ url })
+
+          const isOwner = inflightGets.get(key) === inflight
+
+          if (error) {
+            // A confirmed 404 is a first-class "absent" outcome, not a failure.
+            if (status === 404) {
+              if (isOwner) cache.setAbsent(key)
+              return null
+            }
+            console.error(`Failed to get storage value '${key}': ${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(key, { 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(key) === inflight) inflightGets.delete(key)
+        }
+      })()
+
+      inflightGets.set(key, inflight)
+      return inflight.promise
+    },
+
+    async set<T = unknown>(key: string, value: T, options?: SetOptions): Promise<boolean> {
+      assertIsServer(MODULE_NAME)
+
+      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(key) === undefined && cache.get(key)?.body === body) {
+        return true
+      }
+
+      return writes.enqueue(key, body, (b) => executeSet(key, b as string), skipIfUnchanged)
+    },
+
+    async delete(key: string): Promise<boolean> {
+      assertIsServer(MODULE_NAME)
+
+      // 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(key)
+      inflightGets.delete(key)
+
+      return writes.enqueue(key, null, () => executeDelete(key), true)
+    },
+
+    async getValues(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}/values?${query}` : `${baseUrl}/values`
+
+      const [error, response] = await wrapSignedFetch<GetValuesResult>({ url })
+
+      if (error) {
+        console.error(`Failed to get storage values: ${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) {
+        if (entry.value !== undefined && !writes.isPending(entry.key) && cache.get(entry.key) === undefined) {
+          cache.set(entry.key, { 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 }
+    }
+  }
+}

package/src/server/storage/value-cache.ts

@@ -0,0 +1,92 @@
+import { DEFAULT_STORAGE_CONFIG, StorageConfigState } from './constants'
+
+/**
+ * A cached fact about a key's server-side state.
+ * @internal
+ */
+export interface CacheEntry {
+  /**
+   * Serialized `{ value }` body; absent for negative entries. Parsed per read
+   * hit so callers never share object references, and compared verbatim for
+   * write dedup (exact equality — no hash-collision risk).
+   */
+  body?: string
+  /** True when the server confirmed the key does not exist (GET 404 or successful DELETE). */
+  absent?: boolean
+}
+
+/**
+ * Bounded, lazily-expiring cache of key states, backing both write dedup
+ * (skip storage writes whose value is already known to be stored) and read
+ * caching (serve get() without a network request within the TTL).
+ * @internal
+ */
+export interface ValueCache {
+  /** Returns the entry if present and fresh; lazily evicts expired entries. */
+  get(key: string): CacheEntry | undefined
+  /** Stores or refreshes a known value (serialized body); overwrites negative entries. */
+  set(key: string, entry: { body: string }): void
+  /** Stores a confirmed-absent (negative) entry, replacing any value entry. */
+  setAbsent(key: string): void
+  delete(key: string): void
+}
+
+/**
+ * Creates the bounded value cache shared by a storage scope.
+ * @internal
+ */
+export function createValueCache(config: StorageConfigState): ValueCache {
+  const entries = new Map<string, CacheEntry & { storedAt: number }>()
+
+  function insert(key: string, entry: CacheEntry): void {
+    // Delete + re-insert moves refreshed keys to the end of the Map's
+    // insertion order, so eviction below drops the least-recently-written.
+    entries.delete(key)
+    entries.set(key, { ...entry, storedAt: Date.now() })
+
+    // Guard against misconfiguration: a negative bound would loop forever on
+    // an empty map, and a NaN bound would silently disable eviction.
+    const maxEntries = Number.isFinite(config.cacheMaxEntries)
+      ? Math.max(0, config.cacheMaxEntries)
+      : DEFAULT_STORAGE_CONFIG.cacheMaxEntries
+
+    while (entries.size > maxEntries) {
+      entries.delete(entries.keys().next().value!)
+    }
+  }
+
+  return {
+    get(key: string): CacheEntry | undefined {
+      const entry = entries.get(key)
+      if (!entry) return undefined
+
+      // Guard against misconfiguration, mirroring cacheMaxEntries: a NaN
+      // bound would silently disable expiry (NaN comparisons are false).
+      // Negative values need no guard — they just expire everything.
+      const maxAgeMs = Number.isFinite(config.cacheMaxAgeMs)
+        ? config.cacheMaxAgeMs
+        : DEFAULT_STORAGE_CONFIG.cacheMaxAgeMs
+
+      // Lazy max-age expiry: storedAt is never refreshed on hits, so the age
+      // bounds the time since the last actual network confirmation.
+      if (Date.now() - entry.storedAt > maxAgeMs) {
+        entries.delete(key)
+        return undefined
+      }
+
+      return entry
+    },
+
+    set(key: string, entry: { body: string }): void {
+      insert(key, entry)
+    },
+
+    setAbsent(key: string): void {
+      insert(key, { absent: true })
+    },
+
+    delete(key: string): void {
+      entries.delete(key)
+    }
+  }
+}