@vrtmrz/livesync-commonlib 0.1.7 → 0.1.9

package/dist/pouchdb/StreamingFetch.d.ts

@@ -46,8 +46,10 @@ export type FetchChangesForInitialSyncProgress = {
  * Fetches initial data from CouchDB as a stream and writes it into PouchDB.
  * @param downloadToDB PouchDB instance.
  * @param remoteDbUrl CouchDB database URL (for example: 'https://xxx.com/mydb').
+ * @param authHeader Value of the `Authorization` header for CouchDB.
  * @param decryptFunction Function to decrypt each document.
  * @param since Sequence ID to start fetching changes from (default is '0').
+ * @param customHeaders Additional request headers required by the CouchDB endpoint or its reverse proxy.
  */
-export declare function fetchChangesForInitialSync(downloadToDB: PouchDB.Database, remoteDbUrl: string, authHeader: string, decryptFunction: (doc: EntryDoc) => Promise<AnyEntry | EntryLeaf>, since?: number | string, onProgress?: (progress: FetchChangesForInitialSyncProgress) => void, onCheckpoint?: (sequence: DBSequence) => void | Promise<void>): Promise<void>;
+export declare function fetchChangesForInitialSync(downloadToDB: PouchDB.Database, remoteDbUrl: string, authHeader: string, decryptFunction: (doc: EntryDoc) => Promise<AnyEntry | EntryLeaf>, since?: number | string, onProgress?: (progress: FetchChangesForInitialSyncProgress) => void, onCheckpoint?: (sequence: DBSequence) => void | Promise<void>, customHeaders?: Record<string, string>): Promise<void>;
 export {};

package/dist/pouchdb/StreamingFetch.js

@@ -1,6 +1,7 @@
 import { _fetch } from "../common/coreEnvFunctions.js";
 import { LOG_LEVEL_VERBOSE, Logger } from "octagonal-wheels/common/logger";
 const FAST_FETCH_CHANGES_PAGE_LIMIT = 1e4;
+const FAST_FETCH_CHANGES_PAGE_TIMEOUT_MS = 1e3;
 class StreamingFetchFailure extends Error {
   constructor(stage, message, retryable, options) {
     super(message, options?.cause === void 0 ? void 0 : { cause: options.cause });
@@ -226,7 +227,7 @@ function parseChangesFeedLine(line) {
   }
   return { type: "change", change };
 }
-async function fetchChangesForInitialSync(downloadToDB, remoteDbUrl, authHeader, decryptFunction, since = "0", onProgress, onCheckpoint) {
+async function fetchChangesForInitialSync(downloadToDB, remoteDbUrl, authHeader, decryptFunction, since = "0", onProgress, onCheckpoint, customHeaders) {
   let totalFetched = 0;
   let totalValidFetched = 0;
   let totalBytes = 0;
@@ -236,13 +237,11 @@ async function fetchChangesForInitialSync(downloadToDB, remoteDbUrl, authHeader,
     style: "all_docs",
     conflicts: "true",
     revs: "true",
-    since: since.toString(),
-    heartbeat: "30000"
-  };
-  const fetchHeaders = {
-    Accept: "application/json",
-    Authorization: authHeader
+    since: since.toString()
   };
+  const fetchHeaders = new Headers(customHeaders);
+  fetchHeaders.set("Accept", "application/json");
+  fetchHeaders.set("Authorization", authHeader);
   const targetURL = setParamsToURL(new URL(`${remoteDbUrl}/_changes`), {
     ...changesBaseParams,
     feed: "normal",
@@ -362,7 +361,8 @@ async function fetchChangesForInitialSync(downloadToDB, remoteDbUrl, authHeader,
       const changesURL = setParamsToURL(new URL(`${remoteDbUrl}/_changes`), {
         ...changesBaseParams,
         since: pageSince.toString(),
-        limit: pageLimit.toString()
+        limit: pageLimit.toString(),
+        timeout: FAST_FETCH_CHANGES_PAGE_TIMEOUT_MS.toString()
       });
       const response = await fetchResponse(
         changesURL.toString(),

package/dist/serviceModules/Rebuilder.js

@@ -8,6 +8,7 @@ import { ServiceModuleBase } from "./ServiceModuleBase.js";
 import { fetchChangesForInitialSync, isRetryableStreamingFetchFailure } from "../pouchdb/StreamingFetch.js";
 import { getConfiguredFunctionsForEncryption } from "../pouchdb/encryption.js";
 import { AuthorizationHeaderGenerator, generateCredentialObject } from "../replication/httplib.js";
+import { parseHeaderValues } from "../common/utils.js";
 import { sizeToHumanReadable } from "octagonal-wheels/number";
 const FAST_FETCH_CHECKPOINT_KEY = "fast-fetch-checkpoint";
 const FAST_FETCH_RETRY_DELAYS = [2e3, 5e3, 1e4, 2e4];
@@ -356,6 +357,7 @@ Are you sure you wish to proceed?`;
     const authHeader = await new AuthorizationHeaderGenerator().getAuthorizationHeader(
       generateCredentialObject(settings)
     );
+    const customHeaders = parseHeaderValues(settings.couchDB_CustomHeaders);
     for (let attempt = 0; ; attempt++) {
       try {
         await fetchChangesForInitialSync(
@@ -372,7 +374,8 @@ Total bytes fetched: ${sizeToHumanReadable(progress.totalBytes)}`,
               "fetch-init-progress"
             );
           },
-          (sequence) => this.saveFastFetchCheckpoint(remote, sequence)
+          (sequence) => this.saveFastFetchCheckpoint(remote, sequence),
+          customHeaders
         );
         break;
       } catch (ex) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vrtmrz/livesync-commonlib",
-  "version": "0.1.7",
+  "version": "0.1.9",
   "description": "Shared data, storage, and replication primitives for Self-hosted LiveSync clients.",
   "type": "module",
   "license": "MIT",