@livestore/sync-s2 0.0.0-snapshot-4b42ef6ef0c52dda5b8633a10addf45134e4cafe → 0.0.0-snapshot-4d1cde4c26a9d8ff6ba4b77935eaa816334db6d4

package/dist/limits.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"limits.test.js","sourceRoot":"","sources":["../src/limits.test.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAA;AAC7C,OAAO,EACL,gBAAgB,EAChB,yBAAyB,EACzB,uBAAuB,EACvB,wBAAwB,EACxB,oBAAoB,GACrB,MAAM,aAAa,CAAA;AAEpB,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAA;AAEjC,MAAM,SAAS,GAAG,CAAC,aAAqB,EAAE,KAAK,GAAG,CAAC,EAAmC,EAAE,CAAC,CAAC;IACxF,IAAI,EAAE,SAAS,KAAK,EAAE;IACtB,IAAI,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE;IAC5C,MAAM,EAAE,KAAsD;IAC9D,YAAY,EAAE,KAAsD;IACpE,QAAQ,EAAE,QAAQ;IAClB,SAAS,EAAE,SAAS;CACrB,CAAC,CAAA;AAEF,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACjC,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,MAAM,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,EAAE,CAAA;QAC3D,MAAM,QAAQ,GAAG,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,UAAU,CAAA;QACjE,MAAM,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IAC1D,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;QACnE,MAAM,MAAM,GAAG,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAA;QACpF,MAAM,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAA;QAEvC,MAAM,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;QAC9B,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;QACxE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,IAAI,uBAAuB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC3F,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,0DAA0D,EAAE,GAAG,EAAE;QAClE,MAAM,QAAQ,GAAG,SAAS,CAAC,wBAAwB,EAAE,CAAC,CAAC,CAAA;QACvD,MAAM,CAAC,GAAG,EAAE,CAAC,gBAAgB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAC1E,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/src/limits.test.ts

@@ -1,42 +0,0 @@
-import type { EventSequenceNumber, LiveStoreEvent } from '@livestore/common/schema'
-import { describe, expect, it } from 'vitest'
-import {
-  chunkEventsForS2,
-  computeRecordMeteredBytes,
-  MAX_BATCH_METERED_BYTES,
-  MAX_RECORD_METERED_BYTES,
-  S2LimitExceededError,
-} from './limits.ts'
-
-const encoder = new TextEncoder()
-
-const makeEvent = (payloadLength: number, index = 0): LiveStoreEvent.AnyEncodedGlobal => ({
-  name: `event-${index}`,
-  args: { payload: 'x'.repeat(payloadLength) },
-  seqNum: index as EventSequenceNumber.GlobalEventSequenceNumber,
-  parentSeqNum: index as EventSequenceNumber.GlobalEventSequenceNumber,
-  clientId: 'client',
-  sessionId: 'session',
-})
-
-describe('S2 limits helpers', () => {
-  it('computes metered bytes for record bodies', () => {
-    const record = { body: JSON.stringify({ hello: 'world' }) }
-    const expected = 8 + encoder.encode(record.body ?? '').byteLength
-    expect(computeRecordMeteredBytes(record)).toBe(expected)
-  })
-
-  it('splits large batches while respecting metered byte limits', () => {
-    const events = [makeEvent(400_000, 1), makeEvent(400_000, 2), makeEvent(400_000, 3)]
-    const chunks = chunkEventsForS2(events)
-
-    expect(chunks).toHaveLength(2)
-    expect(chunks.map((chunk) => chunk.events.length)).toStrictEqual([2, 1])
-    expect(chunks.every((chunk) => chunk.meteredBytes <= MAX_BATCH_METERED_BYTES)).toBe(true)
-  })
-
-  it('throws when a single record exceeds the metered byte cap', () => {
-    const oversize = makeEvent(MAX_RECORD_METERED_BYTES, 1)
-    expect(() => chunkEventsForS2([oversize])).toThrow(S2LimitExceededError)
-  })
-})

package/src/limits.ts

@@ -1,135 +0,0 @@
-import type { LiveStoreEvent } from '@livestore/common/schema'
-import { splitChunkBySize } from '@livestore/common/sync'
-import { Chunk, Effect, Schema } from '@livestore/utils/effect'
-
-const textEncoder = new TextEncoder()
-
-/**
- * Maximum metered size of a single record (docs: https://s2.dev/docs/limits#records).
- */
-export const MAX_RECORD_METERED_BYTES = 1_048_576 // 1 MiB
-
-/**
- * Maximum combined metered size of a batch append (docs: https://s2.dev/docs/limits#records).
- */
-export const MAX_BATCH_METERED_BYTES = 1_048_576 // 1 MiB
-
-/**
- * Maximum number of records per append (docs: https://s2.dev/docs/limits#records).
- */
-export const MAX_RECORDS_PER_BATCH = 1_000
-
-const LimitType = Schema.Literal('record-metered-bytes', 'batch-metered-bytes', 'batch-count')
-
-export class S2LimitExceededError extends Schema.TaggedError<S2LimitExceededError>()('S2LimitExceededError', {
-  limitType: LimitType,
-  max: Schema.Number,
-  actual: Schema.Number,
-  recordIndex: Schema.optional(Schema.Number),
-}) {}
-
-export interface AppendRecordBody {
-  readonly body?: string
-  readonly headers?: ReadonlyArray<{ readonly name: string; readonly value: string }>
-}
-
-// S2 measures bodies/headers in UTF‑8 bytes; centralising this helper keeps the
-// formula readable and consistent with the docs.
-const utf8ByteLength = (value: string): number => textEncoder.encode(value).byteLength
-
-export const computeRecordMeteredBytes = (record: AppendRecordBody): number => {
-  const headers = record.headers ?? []
-  const headerCount = headers.length
-  const headerBytes = headers.reduce(
-    (acc, header) => acc + utf8ByteLength(header.name) + utf8ByteLength(header.value),
-    0,
-  )
-  const bodyBytes = record.body === undefined ? 0 : utf8ByteLength(record.body)
-  return 8 + 2 * headerCount + headerBytes + bodyBytes
-}
-
-export const computeBatchMeteredBytes = (records: ReadonlyArray<AppendRecordBody>): number =>
-  records.reduce((acc, record) => acc + computeRecordMeteredBytes(record), 0)
-
-interface PreparedEvent {
-  readonly event: LiveStoreEvent.AnyEncodedGlobal
-  readonly record: AppendRecordBody
-  readonly meteredBytes: number
-  readonly index: number
-}
-
-export interface S2Chunk {
-  readonly events: ReadonlyArray<LiveStoreEvent.AnyEncodedGlobal>
-  readonly records: ReadonlyArray<AppendRecordBody>
-  readonly meteredBytes: number
-}
-
-// Pre-stringify events and pre-compute per-record metered bytes so we only pay
-// the JSON cost once when chunking large batches.
-const convertEventsToPrepared = (events: ReadonlyArray<LiveStoreEvent.AnyEncodedGlobal>): PreparedEvent[] =>
-  events.map((event, index) => {
-    const body = JSON.stringify(event)
-    const record: AppendRecordBody = { body }
-    const meteredBytes = computeRecordMeteredBytes(record)
-
-    if (meteredBytes > MAX_RECORD_METERED_BYTES) {
-      throw new S2LimitExceededError({
-        limitType: 'record-metered-bytes',
-        max: MAX_RECORD_METERED_BYTES,
-        actual: meteredBytes,
-        recordIndex: index,
-      })
-    }
-
-    return { event, record, meteredBytes, index }
-  })
-
-// Summarises a chunk’s metered bytes. Passed to splitChunkBySize so we enforce
-// S2 limits directly instead of relying on JSON size heuristics.
-const makeChunkMeasure = (items: ReadonlyArray<PreparedEvent>): number =>
-  items.reduce((acc, item) => acc + item.meteredBytes, 0)
-
-const mapPreparedChunks = (chunks: Chunk.Chunk<Chunk.Chunk<PreparedEvent>>): ReadonlyArray<S2Chunk> =>
-  Chunk.toReadonlyArray(chunks).map((chunk) => {
-    const chunkItems = Chunk.toReadonlyArray(chunk)
-    const events = chunkItems.map((item) => item.event)
-    const records = chunkItems.map((item) => item.record)
-    return {
-      events,
-      records,
-      meteredBytes: makeChunkMeasure(chunkItems),
-    }
-  })
-
-export const chunkEventsForS2 = (events: ReadonlyArray<LiveStoreEvent.AnyEncodedGlobal>): ReadonlyArray<S2Chunk> => {
-  if (events.length === 0) {
-    return []
-  }
-
-  const prepared = convertEventsToPrepared(events)
-
-  try {
-    const chunks = Chunk.fromIterable(prepared).pipe(
-      splitChunkBySize({
-        maxItems: MAX_RECORDS_PER_BATCH,
-        maxBytes: MAX_BATCH_METERED_BYTES,
-        encode: (items) => ({ records: items.map((item) => item.record) }),
-        measure: makeChunkMeasure,
-      }),
-      Effect.runSync,
-    )
-
-    return mapPreparedChunks(chunks)
-  } catch (error) {
-    if (error && typeof error === 'object' && (error as any)._tag === 'OversizeChunkItemError') {
-      const oversize = error as { size: number; maxBytes: number; _tag: string }
-      throw new S2LimitExceededError({
-        limitType: 'record-metered-bytes',
-        max: oversize.maxBytes,
-        actual: oversize.size,
-      })
-    }
-
-    throw error
-  }
-}