Merge pull request #1 from replane-dev/replication-logs

Replication logs

Author: tilyupo

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@replanejs/sdk",
-  "version": "0.5.11",
+  "version": "0.6.1",
   "description": "Dynamic configuration SDK for browser and server environments (Node.js, Deno, Bun). Powered by Replane.",
   "type": "module",
   "license": "MIT",

src/index.ts

@@ -332,9 +332,9 @@ class ReplaneRemoteStorage implements ReplaneStorage {
       for await (const sseEvent of rawEvents) {
         resetInactivityTimer();
 
-        if (sseEvent.type === "ping") continue;
+        if (sseEvent.type === "comment") continue;
 
-        const event = JSON.parse(sseEvent.payload);
+        const event = JSON.parse(sseEvent.data);
         if (
           typeof event === "object" &&
           event !== null &&
@@ -364,7 +364,7 @@ class ReplaneRemoteStorage implements ReplaneStorage {
   }
 }
 
-export type ReplaneContext = Record<string, unknown>;
+export type ReplaneContext = Record<string, string | number | boolean | null | undefined>;
 
 export interface ReplaneClientOptions<T extends Configs> {
   /**
@@ -404,7 +404,7 @@ export interface ReplaneClientOptions<T extends Configs> {
   /**
    * Timeout in ms for SSE connection inactivity.
    * If no events (including pings) are received within this time, the connection will be re-established.
-   * @default 60000
+   * @default 30000
    */
   inactivityTimeoutMs?: number;
   /**
@@ -597,7 +597,6 @@ async function _createReplaneClient<T extends Configs = Record<string, unknown>>
           currentConfigs: [...configs.values()].map((config) => ({
             name: config.name,
             overrides: config.overrides,
-            version: config.version,
             value: config.value,
           })),
           requiredConfigs: sdkOptions.requiredConfigs,
@@ -606,14 +605,11 @@ async function _createReplaneClient<T extends Configs = Record<string, unknown>>
 
       for await (const event of replicationStream) {
         const updatedConfigs: ConfigDto[] =
-          event.type === "config_change" ? [event] : event.configs;
+          event.type === "config_change" ? [event.config] : event.configs;
         for (const config of updatedConfigs) {
-          if (config.version <= (configs.get(config.name)?.version ?? -1)) continue; // ignore outdated changes
-
           configs.set(config.name, {
             name: config.name,
             overrides: config.overrides,
-            version: config.version,
             value: config.value,
           });
           for (const callback of clientSubscriptions) {
@@ -759,7 +755,7 @@ function toFinalOptions<T extends Configs>(defaults: ReplaneClientOptions<T>): R
       globalThis.fetch.bind(globalThis),
     requestTimeoutMs: defaults.requestTimeoutMs ?? 2000,
     initializationTimeoutMs: defaults.initializationTimeoutMs ?? 5000,
-    inactivityTimeoutMs: defaults.inactivityTimeoutMs ?? 60_000,
+    inactivityTimeoutMs: defaults.inactivityTimeoutMs ?? 30_000,
     logger: defaults.logger ?? console,
     retryDelayMs: defaults.retryDelayMs ?? 200,
     context: {
@@ -810,7 +806,7 @@ async function fetchWithTimeout(
 
 const SSE_DATA_PREFIX = "data:";
 
-type SseEvent = { type: "ping" } | { type: "data"; payload: string };
+type SseEvent = { type: "comment"; comment: string } | { type: "data"; data: string };
 
 async function* fetchSse(params: {
   fetchFn: typeof fetch;
@@ -878,13 +874,13 @@ async function* fetchSse(params: {
         for (const frame of frames) {
           // Parse lines inside a single SSE event frame
           const dataLines: string[] = [];
-          let isPing = false;
+          let comment: string | null = null;
 
           for (const rawLine of frame.split(/\r?\n/)) {
             if (!rawLine) continue;
             if (rawLine.startsWith(":")) {
-              // comment/keepalive - treat as ping
-              isPing = true;
+              // comment/keepalive
+              comment = rawLine.slice(1);
               continue;
             }
 
@@ -896,10 +892,10 @@ async function* fetchSse(params: {
           }
 
           if (dataLines.length) {
-            const payload = dataLines.join("\n");
-            yield { type: "data", payload };
-          } else if (isPing) {
-            yield { type: "ping" };
+            const data = dataLines.join("\n");
+            yield { type: "data", data };
+          } else if (comment !== null) {
+            yield { type: "comment", comment };
           }
         }
       }

src/types.ts

@@ -6,17 +6,13 @@ export interface StartReplicationStreamBody {
 export interface ConfigDto {
   name: string;
   overrides: RenderedOverride[];
-  version: number;
   value: unknown;
 }
 
 export type ReplicationStreamRecord =
   | {
       type: "config_change";
-      name: string;
-      overrides: RenderedOverride[];
-      version: number;
-      value: unknown;
+      config: ConfigDto;
     }
   | {
       type: "init";