@sovereignbase/sequencer 0.0.0 → 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -26,17 +26,17 @@ lifecycle workload and API throughput bursts. Full results are available for
26
26
  [throughput](benchmark/.results/throughput.md).
27
27
 
28
28
  Latest throughput results, measured on 12 October 2026. Latencies are in µs per
29
- public API call, weighted by call count across three runs.
30
-
31
- | Operation | 100 initial Strips | 1,000 initial Strips | 10,000 initial Strips |
32
- | ----------------------------------- | -----------------: | -------------------: | --------------------: |
33
- | `new Projection(actorID, sequence)` | 21.059 | 200.042 | 2,377.293 |
34
- | `insert`, random position | 1.069 | 1.507 | 1.298 |
35
- | `remove`, middle | 1.271 | 1.591 | 1.867 |
36
- | `replace`, middle | 0.945 | 0.908 | 2.728 |
37
- | `sequence()` | 17.829 | 237.192 | 2,704.320 |
38
- | `value`, random position | 0.192 | 0.238 | 0.731 |
39
- | `values()` | 27.018 | 390.403 | 4,450.865 |
29
+ public API call, weighted by call count across five runs.
30
+
31
+ | Operation | 100 initial insertions | 1,000 initial insertions | 10,000 initial insertions |
32
+ | ----------------------------------- | ---------------------: | -----------------------: | ------------------------: |
33
+ | `new Projection(actorID, sequence)` | 1.732 | 1.725 | 1.648 |
34
+ | `insert`, random position | 1.043 | 1.036 | 1.081 |
35
+ | `remove`, middle | 1.091 | 1.269 | 1.433 |
36
+ | `replace`, middle | 1.145 | 1.369 | 1.430 |
37
+ | `sequence()` | 0.353 | 0.390 | 0.363 |
38
+ | `value`, random position | 0.065 | 0.053 | 0.115 |
39
+ | `values()` | 4.352 | 147.965 | 1156.844 |
40
40
 
41
41
  Environment: Node 24.16.0, V8 13.6.233.17-node.49, Windows x64, Intel Core
42
42
  i5-10210U. Generated Strip lengths are 1–100 Frames. Each case warms up for
@@ -44,25 +44,25 @@ i5-10210U. Generated Strip lengths are 1–100 Frames. Each case warms up for
44
44
 
45
45
  ## Memory efficiency
46
46
 
47
- Additional retained memory for 10,000 insertions containing 500,000 Frames:
47
+ Retained-memory comparison for eight Projections, each containing 6,000
48
+ single-Frame insertions. These are five-run medians from isolated Node processes:
48
49
 
49
- | Construction | JS heap | External memory, including WASM | Total |
50
- | -------------------- | -------: | ------------------------------: | -------: |
51
- | First construction | 5.073 MB | 1.412 MB | 6.485 MB |
52
- | After initialization | 4.604 MB | 1.049 MB | 5.653 MB |
50
+ | Measurement | Before extension coalescing | Current |
51
+ | --------------------------- | --------------------------: | -------: |
52
+ | Additional JS heap after GC | 2.038 MB | 0.520 MB |
53
+ | Shared WASM memory capacity | 7.406 MB | 1.049 MB |
53
54
 
54
- Values are medians of three separate process measurements after garbage
55
- collection, using 50 numeric Frames per insertion. Module import is excluded. The second
56
- row initializes an empty Projection before measuring. These are additional heap
57
- and external allocations, not whole-process RSS. WASM starts with 1 MiB of memory
58
- and grows as needed.
55
+ Module import and a small warm-up are excluded from the heap delta. WASM
56
+ capacity includes the initial 1 MiB allocation. These are not process RSS or
57
+ per-Projection total memory. Measurements and complete before/after results are
58
+ retained in [the optimization report](archives/optimizations/flat_sequence/README.md).
59
59
 
60
60
  ### Moderate bundle size
61
61
 
62
62
  | Format | Raw | Minified | Minified + gzip |
63
63
  | -------- | -------: | -------: | --------------: |
64
- | ESM | 109.8 kB | 93.9 kB | 34.6 kB |
65
- | CommonJS | 110.0 kB | 94.9 kB | 34.8 kB |
64
+ | ESM | 117.9 kB | 99.7 kB | 36.4 kB |
65
+ | CommonJS | 118.0 kB | 100.6 kB | 36.6 kB |
66
66
 
67
67
  Both bundles include the WASM module. Minified sizes use Terser with three
68
68
  compression passes; source maps and type declarations are excluded. kB and MB
@@ -75,18 +75,35 @@ framing or content. Numeric metadata accepts `Uint32Array` and JSON numeric
75
75
  arrays. Generic content, called Footage, stays in JavaScript; only numeric
76
76
  metadata enters WASM.
77
77
 
78
+ `sequence()` returns `[words, footage]`: one numeric array and one content
79
+ array, with no nested insertion or acknowledgement arrays. `words[0]` locates
80
+ the first six-word insertion record; preceding acknowledgements are length
81
+ prefixed. Positive insertion lengths identify successive spans of `footage`.
82
+ An empty Sequence is `[[], []]`. Construction and `merge()` accept numeric
83
+ arrays or `Uint32Array` metadata; exported numeric arrays can be sent as JSON.
84
+
85
+ ```ts
86
+ const retained = projection.sequence()
87
+ const restored = new Projection<string>(2, retained)
88
+ ```
89
+
90
+ Consecutive local insertions extend an intact insertion from the same Session
91
+ without reserving another zero in its logical clock. Gossip contains only the
92
+ new suffix, still using six structural words. A removal or fragmentation ends
93
+ the local extension chain. Retained snapshots remain unchanged by later edits.
94
+
78
95
  Measured JSON transport sizes for 1,000 one-Frame insertions containing `'x'`,
79
96
  their removal Gossip, and a snapshot captured before removal:
80
97
 
81
98
  | Workload | Average bytes per operation or insertion | JSON | JSON + gzip | gzip reduction |
82
99
  | ---------------------------------------------- | ---------------------------------------: | ------: | ----------: | -------------: |
83
- | 1,000 one-frame insertions | 44.9 B | 45.9 kB | 5.1 kB | 88.8% |
84
- | 1,000 one-frame removals | 65.3 B | 66.3 kB | 7.7 kB | 88.5% |
85
- | Snapshot containing 1,000 one-frame insertions | 43.9 B | 43.9 kB | 5.2 kB | 88.0% |
100
+ | 1,000 one-frame insertions | 44.8 B | 45.8 kB | 5.1 kB | 88.9% |
101
+ | 1,000 one-frame removals | 67.8 B | 68.8 kB | 7.7 kB | 88.9% |
102
+ | Snapshot containing 1,000 one-frame insertions | 4.0 B | 4.0 kB | 0.1 kB | 98.3% |
86
103
 
87
104
  Gossip sizes include acknowledgements and content where present. Delta averages
88
105
  measure individual Gossip packets; batch totals include their enclosing array.
89
- Snapshot averages divide the complete Sequence size by its insertion count.
106
+ Snapshot averages divide the complete Sequence size by the 1,000 authored insertions. Consecutive insertions are retained as one insertion.
90
107
  Sizes vary with Session IDs and content.
91
108
 
92
109
  ## Tests
@@ -97,7 +114,7 @@ Sizes vary with Session IDs and content.
97
114
  typechecks tests, runs unit, convergence, integration and generative stress suites
98
115
  with V8 coverage, then runs runtime and browser compatibility checks.
99
116
 
100
- The latest verification passed 151 Vitest tests and 88 compatibility checks.
117
+ The latest verification passed 167 Vitest tests and 88 compatibility checks.
101
118
  Convergence tests include 1,024 generated editing histories for each compaction
102
119
  mode. See the [test suites](test/README.md) and
103
120
  [automated test report](https://sovereignbase.dev/sequencer/tests/).