@vrtmrz/livesync-commonlib 0.1.23 → 0.1.24

package/dist/replication/trystero/TrysteroReplicator.js

@@ -1,4 +1,5 @@
 import { TweakValuesShouldMatchedTemplate } from "../../common/types.js";
+import { assessTweakCompatibility } from "../../common/models/tweak.compatibility.js";
 import {
   LOG_LEVEL_INFO,
   LOG_LEVEL_NOTICE,
@@ -17,7 +18,6 @@ import {
 } from "./TrysteroReplicatorP2PServer.js";
 import { encryptWithEphemeralSalt, decryptWithEphemeralSalt } from "octagonal-wheels/encryption/hkdf";
 import { sha1 } from "octagonal-wheels/hash/purejs";
-import { isObjectDifferent } from "octagonal-wheels/object";
 import { getRelaySockets, pauseRelayReconnection, resumeRelayReconnection } from "@trystero-p2p/nostr";
 import { P2PAutomationCoordinator } from "./P2PAutomationCoordinator.js";
 import { compatGlobal } from "../../common/coreEnvFunctions.js";
@@ -728,9 +728,6 @@ ${info.lastSeq} / ${info.maxSeqInBatch})`,
     const tweakValues = await connection.invokeRemoteObjectFunction("getTweakSettings", [this.server.serverPeerId], 5e3, signal);
     if (signal?.aborted) return false;
     const thisTweakValues = await this.getTweakSettings("");
-    if (!isObjectDifferent(thisTweakValues, tweakValues)) {
-      return true;
-    }
     if (thisTweakValues.passphrase !== tweakValues.passphrase) {
       Logger(
         "Replication cancelled: Passphrase is not matched\nCannot replicate to a remote database until the problem is resolved.",
@@ -738,6 +735,8 @@ ${info.lastSeq} / ${info.maxSeqInBatch})`,
       );
       return false;
     }
+    const tweakAssessment = assessTweakCompatibility(thisTweakValues, tweakValues);
+    if (!tweakAssessment.representationDiffers) return true;
     Logger(
       "Some mismatched configuration have been detected... Please check settings for efficient replication.",
       logLevel

package/dist/services/base/IService.d.ts

@@ -1,6 +1,6 @@
 import type { FetchHttpHandler } from "@smithy/fetch-http-handler";
 import { type LOG_LEVEL } from "octagonal-wheels/common/logger";
-import type { AnyEntry, AUTO_MERGED, CouchDBCredentials, diff_result, DocumentID, EntryDoc, EntryHasPath, FileEventItem, FilePath, FilePathWithPrefix, LoadedEntry, MetaEntry, MISSING_OR_ERROR, ObsidianLiveSyncSettings, RemoteDBSettings, RemotePreferredTweakResult, SettingsMigrationState, TweakValues, UXFileInfo, UXFileInfoStub } from "../../common/types.js";
+import type { AnyEntry, AUTO_MERGED, CouchDBCredentials, diff_result, DocumentID, EntryDoc, EntryHasPath, FileEventItem, FilePath, FilePathWithPrefix, LoadedEntry, MetaEntry, MISSING_OR_ERROR, ObsidianLiveSyncSettings, RemoteDBSettings, RemotePreferredTweakResult, SettingsMigrationState, TweakAssessment, TweakValues, UXFileInfo, UXFileInfoStub } from "../../common/types.js";
 import type { LiveSyncLocalDB } from "../../pouchdb/LiveSyncLocalDB.js";
 import type { ReplicatorInstance } from "../../replication/ReplicatorInstance.js";
 import type { SimpleStore } from "octagonal-wheels/databases/SimpleStoreBase";
@@ -335,8 +335,8 @@ export interface ISettingService {
 }
 export interface ITweakValueService {
     fetchRemotePreferred(trialSetting: RemoteDBSettings): Promise<RemotePreferredTweakResult>;
-    checkAndAskResolvingMismatched(preferred: Partial<TweakValues>): Promise<[TweakValues | boolean, boolean]>;
-    askResolvingMismatched(preferredSource: TweakValues, updatePreferredRemote?: (setting: ObsidianLiveSyncSettings) => Promise<boolean>): Promise<"OK" | "CHECKAGAIN" | "IGNORE">;
+    checkAndAskResolvingMismatched(preferred: Partial<TweakValues>, assessment?: TweakAssessment): Promise<[TweakValues | boolean, boolean]>;
+    askResolvingMismatched(preferredSource: TweakValues, updatePreferredRemote?: (setting: ObsidianLiveSyncSettings) => Promise<boolean>, assessment?: TweakAssessment): Promise<"OK" | "CHECKAGAIN" | "IGNORE">;
     checkAndAskUseRemoteConfiguration(settings: RemoteDBSettings): Promise<{
         result: false | TweakValues;
         requireFetch: boolean;

package/dist/services/base/ReplicationService.d.ts

@@ -117,8 +117,8 @@ export declare abstract class ReplicationService<T extends ServiceContext = Serv
      *
      * Each attempt owns a separate reservation. Compatibility recovery runs
      * between those reservations, and a retry is admitted only when the exact
-     * first-attempt context remains active. Both attempts use one detached
-     * settings snapshot.
+     * first-attempt context remains active. Each attempt uses a detached settings
+     * snapshot, and a compatibility retry captures its snapshot after recovery.
      */
     private performDirectionalReplication;
     replicateAllToRemote(showingNotice?: boolean): Promise<boolean>;

package/dist/services/base/ReplicationService.js

@@ -329,40 +329,43 @@ class ReplicationService extends ServiceBase {
    *
    * Each attempt owns a separate reservation. Compatibility recovery runs
    * between those reservations, and a retry is admitted only when the exact
-   * first-attempt context remains active. Both attempts use one detached
-   * settings snapshot.
+   * first-attempt context remains active. Each attempt uses a detached settings
+   * snapshot, and a compatibility retry captures its snapshot after recovery.
    */
   async performDirectionalReplication(direction, showingNotice, admission = DIRECTIONAL_REPLICATION_ADMISSION.ORDINARY) {
     if (direction === DIRECTIONAL_REPLICATION.UPLOAD && !await this.onBeforeReplicate(showingNotice)) {
       this._log(this.context.translate("Replicator.Message.SomeModuleFailed"), LOG_LEVEL_NOTICE);
       return false;
     }
-    const detachedSetting = asCopy(this.settingService.currentSettings());
-    if (admission === DIRECTIONAL_REPLICATION_ADMISSION.EXPLICIT_REBUILD) {
-      detachedSetting.versionUpFlash = "";
-    }
-    const setting = Object.freeze(detachedSetting);
+    const captureSetting = () => {
+      const detachedSetting = asCopy(this.settingService.currentSettings());
+      if (admission === DIRECTIONAL_REPLICATION_ADMISSION.EXPLICIT_REBUILD) {
+        detachedSetting.versionUpFlash = "";
+      }
+      return Object.freeze(detachedSetting);
+    };
+    const setting = captureSetting();
     let expectedContext;
-    const run = async () => {
+    const run = async (attemptSetting) => {
       const admitted = await this.replicatorService.runWithActiveReplicatorContext((context) => {
         if (expectedContext && context !== expectedContext) {
           return replicationBlocked("not-ready");
         }
         expectedContext ??= context;
-        return runDirectionalReplication(context, setting, direction, showingNotice);
+        return runDirectionalReplication(context, attemptSetting, direction, showingNotice);
       });
       if (admitted) return admitted;
       this._log(`Active replicator not found during directional ${direction}`, LOG_LEVEL_NOTICE);
       return replicationBlocked("no-active-replicator");
     };
-    const outcome = await run();
+    const outcome = await run(setting);
     if (isReplicationCompleted(outcome)) return true;
     if (outcome.status !== "failed") return false;
     const failedContext = expectedContext;
     if (!failedContext) return false;
     const failure = Object.freeze({ context: failedContext, setting, outcome });
     const checkResult = await this.checkConnectionFailure(failure);
-    return checkResult === "CHECKAGAIN" && isReplicationCompleted(await run());
+    return checkResult === "CHECKAGAIN" && isReplicationCompleted(await run(captureSetting()));
   }
   async replicateAllToRemote(showingNotice = false) {
     if (!this.appLifecycleService.isReady()) return false;

package/dist/services/base/TweakValueService.d.ts

@@ -1,4 +1,4 @@
-import type { ObsidianLiveSyncSettings, RemoteDBSettings, RemotePreferredTweakResult, TweakValues } from "../../common/types.js";
+import type { ObsidianLiveSyncSettings, RemoteDBSettings, RemotePreferredTweakResult, TweakAssessment, TweakValues } from "../../common/types.js";
 import type { ITweakValueService } from "./IService.js";
 import { ServiceBase, type ServiceContext } from "./ServiceBase.js";
 /**
@@ -13,14 +13,16 @@ export declare abstract class TweakValueService<T extends ServiceContext = Servi
     /**
      * Check and ask the user to resolve any mismatched tweak values.
      * @param preferred The preferred tweak values to check against.
+     * @param assessment The exact compatibility assessment from the calling operation, when available.
      */
-    abstract checkAndAskResolvingMismatched(preferred: Partial<TweakValues>): Promise<[TweakValues | boolean, boolean]>;
+    abstract checkAndAskResolvingMismatched(preferred: Partial<TweakValues>, assessment?: TweakAssessment): Promise<[TweakValues | boolean, boolean]>;
     /**
      * Ask the user to resolve any mismatched tweak values.
      * @param preferredSource The preferred tweak values to resolve against.
      * @param updatePreferredRemote Optional exact-context writer supplied by the failed operation.
+     * @param assessment The exact compatibility assessment from the failed operation, when available.
      */
-    abstract askResolvingMismatched(preferredSource: TweakValues, updatePreferredRemote?: (setting: ObsidianLiveSyncSettings) => Promise<boolean>): Promise<"OK" | "CHECKAGAIN" | "IGNORE">;
+    abstract askResolvingMismatched(preferredSource: TweakValues, updatePreferredRemote?: (setting: ObsidianLiveSyncSettings) => Promise<boolean>, assessment?: TweakAssessment): Promise<"OK" | "CHECKAGAIN" | "IGNORE">;
     /**
      * Check and ask the user to use the remote configuration.
      * @param settings The remote database settings to connect.

package/dist/services/implements/injectable/InjectableTweakValueService.d.ts

@@ -2,14 +2,14 @@ import type { ServiceContext } from "../../base/ServiceBase.js";
 import { TweakValueService } from "../../base/TweakValueService.js";
 export declare class InjectableTweakValueService<T extends ServiceContext> extends TweakValueService<T> {
     fetchRemotePreferred: import("../../lib/HandlerUtils.js").HandlerFunction<(trialSetting: import("../../../settings.js").RemoteDBSettings) => Promise<import("../../../common/types.js").RemotePreferredTweakResult>, unknown>;
-    checkAndAskResolvingMismatched: import("../../lib/HandlerUtils.js").HandlerFunction<(preferred: Partial<import("../../../common/types.js").TweakValues>) => Promise<[import("../../../common/types.js").TweakValues | boolean, boolean]>, unknown>;
-    askResolvingMismatched: import("../../lib/HandlerUtils.js").HandlerFunction<(preferredSource: import("../../../common/types.js").TweakValues, updatePreferredRemote?: (setting: import("../../../settings.js").ObsidianLiveSyncSettings) => Promise<boolean>) => Promise<"OK" | "CHECKAGAIN" | "IGNORE">, unknown>;
+    checkAndAskResolvingMismatched: import("../../lib/HandlerUtils.js").HandlerFunction<(preferred: Partial<import("../../../settings.js").TweakValues>, assessment?: import("../../../settings.js").TweakAssessment) => Promise<[import("../../../settings.js").TweakValues | boolean, boolean]>, unknown>;
+    askResolvingMismatched: import("../../lib/HandlerUtils.js").HandlerFunction<(preferredSource: import("../../../settings.js").TweakValues, updatePreferredRemote?: (setting: import("../../../settings.js").ObsidianLiveSyncSettings) => Promise<boolean>, assessment?: import("../../../settings.js").TweakAssessment) => Promise<"OK" | "CHECKAGAIN" | "IGNORE">, unknown>;
     checkAndAskUseRemoteConfiguration: import("../../lib/HandlerUtils.js").HandlerFunction<(settings: import("../../../settings.js").RemoteDBSettings) => Promise<{
-        result: false | import("../../../common/types.js").TweakValues;
+        result: false | import("../../../settings.js").TweakValues;
         requireFetch: boolean;
     }>, unknown>;
-    askUseRemoteConfiguration: import("../../lib/HandlerUtils.js").HandlerFunction<(trialSetting: import("../../../settings.js").RemoteDBSettings, preferred: import("../../../common/types.js").TweakValues) => Promise<{
-        result: false | import("../../../common/types.js").TweakValues;
+    askUseRemoteConfiguration: import("../../lib/HandlerUtils.js").HandlerFunction<(trialSetting: import("../../../settings.js").RemoteDBSettings, preferred: import("../../../settings.js").TweakValues) => Promise<{
+        result: false | import("../../../settings.js").TweakValues;
         requireFetch: boolean;
     }>, unknown>;
 }

package/dist/settings.d.ts

@@ -7,4 +7,7 @@ export { DEFAULT_SETTINGS, NEW_VAULT_SETTINGS, P2P_DEFAULT_SETTINGS, SETTINGS_SC
 export { PREFERRED_BASE, PREFERRED_JOURNAL_SYNC, PREFERRED_SETTING_CLOUDANT, PREFERRED_SETTING_SELF_HOSTED, } from "./common/models/setting.const.preferred.js";
 export { CURRENT_SETTING_VERSION } from "./common/models/setting.const.js";
 export { prepareSettingsForLoad, SettingsMigrationReviewCodes, type PreparedSettings, type SettingsMigrationReviewCode, type SettingsMigrationReviewReason, type SettingsMigrationState, } from "./common/models/setting.lifecycle.js";
+export { assessTweakCompatibility } from "./common/models/tweak.compatibility.js";
+export type { TweakAssessment, TweakAssessmentEntry, TweakAssessmentRelation, TweakAssessmentValue, TweakTransition, TweakTransitionReason, } from "./common/models/tweak.compatibility.js";
+export type { TweakReconstruction, TweakValues } from "./common/models/tweak.definition.js";
 export type { ObsidianLiveSyncSettings, RemoteDBSettings, RemoteTypeSettings, } from "./common/models/setting.type.js";

package/dist/settings.js

@@ -16,6 +16,7 @@ import {
   prepareSettingsForLoad,
   SettingsMigrationReviewCodes
 } from "./common/models/setting.lifecycle.js";
+import { assessTweakCompatibility } from "./common/models/tweak.compatibility.js";
 export {
   CURRENT_SETTING_VERSION,
   DEFAULT_SETTINGS,
@@ -27,6 +28,7 @@ export {
   PREFERRED_SETTING_SELF_HOSTED,
   SETTINGS_SCHEMA_DEFAULTS,
   SettingsMigrationReviewCodes,
+  assessTweakCompatibility,
   createNewVaultSettings,
   prepareSettingsForLoad
 };