mirror of
https://github.com/vrtmrz/obsidian-livesync.git
synced 2026-09-22 02:27:07 +00:00
Tighten provider adapter boundaries
This commit is contained in:
@@ -19,6 +19,7 @@ import {
|
||||
type CentralRemoteAdministrationReplicator,
|
||||
type CentralRemoteAdministrationResult,
|
||||
type CentralRemoteAdministrationRunner,
|
||||
type ReplicatorInstance,
|
||||
type SupportedCapability,
|
||||
} from "@vrtmrz/livesync-commonlib/replication";
|
||||
|
||||
@@ -40,6 +41,19 @@ type CouchDBAdministrationReplicator = CentralRemoteAdministrationReplicator &
|
||||
|
||||
type JournalAdministrationClient = Pick<LiveSyncJournalReplicator["client"], "downloadJson">;
|
||||
|
||||
function isCentralRemoteAdministrationReplicator(
|
||||
replicator: ReplicatorInstance
|
||||
): replicator is CentralRemoteAdministrationReplicator {
|
||||
return (
|
||||
"nodeid" in replicator &&
|
||||
typeof replicator.nodeid === "string" &&
|
||||
"markRemoteResolved" in replicator &&
|
||||
typeof replicator.markRemoteResolved === "function" &&
|
||||
"markRemoteLocked" in replicator &&
|
||||
typeof replicator.markRemoteLocked === "function"
|
||||
);
|
||||
}
|
||||
|
||||
async function ensureLocalNodeIdentity(
|
||||
replicator: CentralRemoteAdministrationReplicator
|
||||
): Promise<CentralRemoteAdministrationResult | undefined> {
|
||||
@@ -116,8 +130,12 @@ async function runCentralRemoteAdministration(
|
||||
function requireCouchDBAdministrationOperations(
|
||||
replicator: CentralRemoteAdministrationReplicator
|
||||
): asserts replicator is CouchDBAdministrationReplicator {
|
||||
const candidate = replicator as Partial<CouchDBAdministrationReplicator>;
|
||||
if (typeof candidate.connectRemoteCouchDBWithSetting !== "function" || typeof candidate.isMobile !== "function") {
|
||||
if (
|
||||
!("connectRemoteCouchDBWithSetting" in replicator) ||
|
||||
typeof replicator.connectRemoteCouchDBWithSetting !== "function" ||
|
||||
!("isMobile" in replicator) ||
|
||||
typeof replicator.isMobile !== "function"
|
||||
) {
|
||||
throw new Error("The configured CouchDB administration adapter does not provide milestone access.");
|
||||
}
|
||||
}
|
||||
@@ -164,14 +182,22 @@ function prepareCouchDBMilestoneReader(
|
||||
};
|
||||
}
|
||||
|
||||
function isJournalAdministrationClient(client: unknown): client is JournalAdministrationClient {
|
||||
return (
|
||||
typeof client === "object" &&
|
||||
client !== null &&
|
||||
"downloadJson" in client &&
|
||||
typeof client.downloadJson === "function"
|
||||
);
|
||||
}
|
||||
|
||||
function requireJournalAdministrationClient(
|
||||
replicator: CentralRemoteAdministrationReplicator
|
||||
): JournalAdministrationClient {
|
||||
const client = (replicator as { readonly client?: JournalAdministrationClient }).client;
|
||||
if (typeof client?.downloadJson !== "function") {
|
||||
if (!("client" in replicator) || !isJournalAdministrationClient(replicator.client)) {
|
||||
throw new Error("The configured Object Storage administration adapter does not provide milestone access.");
|
||||
}
|
||||
return client;
|
||||
return replicator.client;
|
||||
}
|
||||
|
||||
function prepareObjectStorageMilestoneReader(
|
||||
@@ -191,14 +217,31 @@ function prepareObjectStorageMilestoneReader(
|
||||
};
|
||||
}
|
||||
|
||||
const runCouchDBCentralRemoteAdministration: CentralRemoteAdministrationRunner = async (replicator, setting, request) =>
|
||||
await runCentralRemoteAdministration(replicator, setting, request, prepareCouchDBMilestoneReader);
|
||||
const runCouchDBCentralRemoteAdministration: CentralRemoteAdministrationRunner = async (
|
||||
replicator,
|
||||
setting,
|
||||
request
|
||||
) => {
|
||||
if (!isCentralRemoteAdministrationReplicator(replicator)) {
|
||||
return centralRemoteAdministrationVerificationFailed(
|
||||
CENTRAL_REMOTE_ADMINISTRATION_FAILURE_REASONS.CAPABILITY_NOT_APPLICABLE
|
||||
);
|
||||
}
|
||||
return await runCentralRemoteAdministration(replicator, setting, request, prepareCouchDBMilestoneReader);
|
||||
};
|
||||
|
||||
const runObjectStorageCentralRemoteAdministration: CentralRemoteAdministrationRunner = async (
|
||||
replicator,
|
||||
setting,
|
||||
request
|
||||
) => await runCentralRemoteAdministration(replicator, setting, request, prepareObjectStorageMilestoneReader);
|
||||
) => {
|
||||
if (!isCentralRemoteAdministrationReplicator(replicator)) {
|
||||
return centralRemoteAdministrationVerificationFailed(
|
||||
CENTRAL_REMOTE_ADMINISTRATION_FAILURE_REASONS.CAPABILITY_NOT_APPLICABLE
|
||||
);
|
||||
}
|
||||
return await runCentralRemoteAdministration(replicator, setting, request, prepareObjectStorageMilestoneReader);
|
||||
};
|
||||
|
||||
/** CouchDB mutation and milestone postcondition verification capability. */
|
||||
export const COUCHDB_CENTRAL_REMOTE_ADMINISTRATION_CAPABILITY: SupportedCapability<CentralRemoteAdministrationRunner> =
|
||||
|
||||
@@ -21,7 +21,6 @@ import {
|
||||
type LiveSyncCouchDBReplicatorEnv,
|
||||
} from "@vrtmrz/livesync-commonlib/compat/replication/couchdb/LiveSyncReplicator";
|
||||
import { LiveSyncJournalReplicator } from "@vrtmrz/livesync-commonlib/compat/replication/journal/LiveSyncJournalReplicator";
|
||||
import type { LiveSyncJournalReplicatorEnv } from "@vrtmrz/livesync-commonlib/compat/replication/journal/LiveSyncJournalReplicatorEnv";
|
||||
import {
|
||||
getCouchDBReplicatorConfigurationIdentity,
|
||||
getObjectStorageReplicatorConfigurationIdentity,
|
||||
@@ -40,18 +39,19 @@ import {
|
||||
OBJECT_STORAGE_CENTRAL_REMOTE_ADMINISTRATION_CAPABILITY,
|
||||
} from "./centralRemoteAdministration";
|
||||
|
||||
export type CentralReplicatorProviderHost = LiveSyncCouchDBReplicatorEnv & LiveSyncJournalReplicatorEnv;
|
||||
/** Host environment sufficient to construct every current central provider. */
|
||||
export type CentralReplicatorProviderHost = LiveSyncCouchDBReplicatorEnv;
|
||||
|
||||
/** Minimal operation required by both central one-shot adapters. */
|
||||
interface OneShotOutcomeReplicator extends ReplicatorInstance {
|
||||
openOneShotReplicationWithOutcome(setting: RemoteDBSettings, showResult: boolean): Promise<ReplicationOutcome>;
|
||||
}
|
||||
|
||||
function asOneShotOutcomeReplicator(instance: ReplicatorInstance): OneShotOutcomeReplicator | undefined {
|
||||
const candidate = instance as Partial<OneShotOutcomeReplicator>;
|
||||
return typeof candidate.openOneShotReplicationWithOutcome === "function"
|
||||
? (instance as OneShotOutcomeReplicator)
|
||||
: undefined;
|
||||
function isOneShotOutcomeReplicator(instance: ReplicatorInstance): instance is OneShotOutcomeReplicator {
|
||||
return (
|
||||
"openOneShotReplicationWithOutcome" in instance &&
|
||||
typeof instance.openOneShotReplicationWithOutcome === "function"
|
||||
);
|
||||
}
|
||||
|
||||
async function runOneShotWithOutcome(
|
||||
@@ -59,11 +59,10 @@ async function runOneShotWithOutcome(
|
||||
setting: RemoteDBSettings,
|
||||
showResult: boolean
|
||||
): Promise<ReplicationOutcome> {
|
||||
const replicator = asOneShotOutcomeReplicator(instance);
|
||||
if (!replicator) {
|
||||
if (!isOneShotOutcomeReplicator(instance)) {
|
||||
return replicationFailed(new Error("The configured provider does not implement one-shot replication."));
|
||||
}
|
||||
return await replicator.openOneShotReplicationWithOutcome(setting, showResult);
|
||||
return await instance.openOneShotReplicationWithOutcome(setting, showResult);
|
||||
}
|
||||
|
||||
const couchDBUserInitiatedOneShot: UserInitiatedOneShotRunner = async (instance, setting, request) => {
|
||||
|
||||
@@ -9,10 +9,10 @@ import {
|
||||
type LiveSyncCouchDBReplicatorEnv,
|
||||
} from "@vrtmrz/livesync-commonlib/compat/replication/couchdb/LiveSyncReplicator";
|
||||
import { LiveSyncJournalReplicator } from "@vrtmrz/livesync-commonlib/compat/replication/journal/LiveSyncJournalReplicator";
|
||||
import type { LiveSyncJournalReplicatorEnv } from "@vrtmrz/livesync-commonlib/compat/replication/journal/LiveSyncJournalReplicatorEnv";
|
||||
import { createReplicatorDisposer, snapshotRemoteSettings } from "./shared";
|
||||
|
||||
export type ConnectionResourceHost = LiveSyncCouchDBReplicatorEnv & LiveSyncJournalReplicatorEnv;
|
||||
/** Host environment sufficient to construct either central connection probe. */
|
||||
export type ConnectionResourceHost = LiveSyncCouchDBReplicatorEnv;
|
||||
|
||||
function createCouchDBConnectionProbe(
|
||||
replicator: LiveSyncCouchDBReplicator,
|
||||
@@ -60,7 +60,12 @@ function createObjectStorageConnectionProbe(
|
||||
};
|
||||
}
|
||||
|
||||
/** Build an unpublished CouchDB connection resource for one host. */
|
||||
/**
|
||||
* Build an unpublished CouchDB connection probe for one host.
|
||||
*
|
||||
* The probe owns both its concrete Replicator and each connection it opens. It
|
||||
* never publishes that Replicator as the active provider instance.
|
||||
*/
|
||||
export function createCouchDBConnectionProbeFactory(host: ConnectionResourceHost): ConnectionProbeFactory {
|
||||
return (setting) => {
|
||||
const snapshot = snapshotRemoteSettings(setting);
|
||||
@@ -68,7 +73,12 @@ export function createCouchDBConnectionProbeFactory(host: ConnectionResourceHost
|
||||
};
|
||||
}
|
||||
|
||||
/** Build an unpublished Object Storage connection resource for one host. */
|
||||
/**
|
||||
* Build an unpublished Object Storage connection probe for one host.
|
||||
*
|
||||
* The probe owns its concrete Replicator and never publishes or replaces the
|
||||
* active provider instance.
|
||||
*/
|
||||
export function createObjectStorageConnectionProbeFactory(host: ConnectionResourceHost): ConnectionProbeFactory {
|
||||
return (setting) => {
|
||||
const snapshot = snapshotRemoteSettings(setting);
|
||||
|
||||
@@ -5,10 +5,10 @@ import {
|
||||
type LiveSyncCouchDBReplicatorEnv,
|
||||
} from "@vrtmrz/livesync-commonlib/compat/replication/couchdb/LiveSyncReplicator";
|
||||
import { LiveSyncJournalReplicator } from "@vrtmrz/livesync-commonlib/compat/replication/journal/LiveSyncJournalReplicator";
|
||||
import type { LiveSyncJournalReplicatorEnv } from "@vrtmrz/livesync-commonlib/compat/replication/journal/LiveSyncJournalReplicatorEnv";
|
||||
import { createReplicatorDisposer, snapshotRemoteSettings, type ResourceReplicator } from "./shared";
|
||||
|
||||
export type PreferredTweakResourceHost = LiveSyncCouchDBReplicatorEnv & LiveSyncJournalReplicatorEnv;
|
||||
/** Host environment sufficient to construct either preferred-tweak probe. */
|
||||
export type PreferredTweakResourceHost = LiveSyncCouchDBReplicatorEnv;
|
||||
|
||||
interface PreferredTweakReplicator extends ResourceReplicator {
|
||||
getRemotePreferredTweakValues(setting: RemoteDBSettings): Promise<RemotePreferredTweakResult>;
|
||||
@@ -24,7 +24,7 @@ function createPreferredTweakProbe(
|
||||
};
|
||||
}
|
||||
|
||||
/** Build an unpublished CouchDB preferred-tweak resource for one host. */
|
||||
/** Build an unpublished, independently disposed CouchDB preferred-tweak probe. */
|
||||
export function createCouchDBPreferredTweakProbeFactory(host: PreferredTweakResourceHost): PreferredTweakProbeFactory {
|
||||
return (setting) => {
|
||||
const snapshot = snapshotRemoteSettings(setting);
|
||||
@@ -32,7 +32,7 @@ export function createCouchDBPreferredTweakProbeFactory(host: PreferredTweakReso
|
||||
};
|
||||
}
|
||||
|
||||
/** Build an unpublished Object Storage preferred-tweak resource for one host. */
|
||||
/** Build an unpublished, independently disposed Object Storage preferred-tweak probe. */
|
||||
export function createObjectStoragePreferredTweakProbeFactory(
|
||||
host: PreferredTweakResourceHost
|
||||
): PreferredTweakProbeFactory {
|
||||
|
||||
@@ -5,10 +5,10 @@ import {
|
||||
type LiveSyncCouchDBReplicatorEnv,
|
||||
} from "@vrtmrz/livesync-commonlib/compat/replication/couchdb/LiveSyncReplicator";
|
||||
import { LiveSyncJournalReplicator } from "@vrtmrz/livesync-commonlib/compat/replication/journal/LiveSyncJournalReplicator";
|
||||
import type { LiveSyncJournalReplicatorEnv } from "@vrtmrz/livesync-commonlib/compat/replication/journal/LiveSyncJournalReplicatorEnv";
|
||||
import { createReplicatorDisposer, snapshotRemoteSettings, type ResourceReplicator } from "./shared";
|
||||
|
||||
export type SecuritySeedResourceHost = LiveSyncCouchDBReplicatorEnv & LiveSyncJournalReplicatorEnv;
|
||||
/** Host environment sufficient to construct either Security Seed resource. */
|
||||
export type SecuritySeedResourceHost = LiveSyncCouchDBReplicatorEnv;
|
||||
|
||||
/** Minimal private Replicator surface required by a Security Seed resource. */
|
||||
interface SecuritySeedReplicator extends ResourceReplicator {
|
||||
@@ -28,12 +28,12 @@ function createSecuritySeedResourceFactory(
|
||||
};
|
||||
}
|
||||
|
||||
/** Build an unpublished CouchDB Security Seed resource for one host. */
|
||||
/** Build an unpublished, independently disposed CouchDB Security Seed resource. */
|
||||
export function createCouchDBSecuritySeedResourceFactory(host: SecuritySeedResourceHost): SecuritySeedResourceFactory {
|
||||
return createSecuritySeedResourceFactory(() => new LiveSyncCouchDBReplicator(host));
|
||||
}
|
||||
|
||||
/** Build an unpublished Object Storage Security Seed resource for one host. */
|
||||
/** Build an unpublished, independently disposed Object Storage Security Seed resource. */
|
||||
export function createObjectStorageSecuritySeedResourceFactory(
|
||||
host: SecuritySeedResourceHost
|
||||
): SecuritySeedResourceFactory {
|
||||
|
||||
@@ -1,5 +1,12 @@
|
||||
import type { RemoteDBSettings } from "@vrtmrz/livesync-commonlib/compat/common/types";
|
||||
|
||||
/**
|
||||
* Closeable surface of a concrete Replicator owned by one private resource.
|
||||
*
|
||||
* It deliberately exposes no active-provider controls: the resource may use
|
||||
* the helper for one bounded operation, then must dispose it without
|
||||
* publishing or replacing the active Replicator.
|
||||
*/
|
||||
export interface ResourceReplicator {
|
||||
closeReplication(): void | Promise<void>;
|
||||
}
|
||||
|
||||
@@ -6,7 +6,12 @@ import {
|
||||
import { checkSyncInfo } from "@vrtmrz/livesync-commonlib/compat/pouchdb/negotiation";
|
||||
import { createReplicatorDisposer, snapshotRemoteSettings } from "./shared";
|
||||
|
||||
/** Build an owned CouchDB synchronisation-information verifier for one host. */
|
||||
/**
|
||||
* Build an unpublished CouchDB synchronisation-information verifier.
|
||||
*
|
||||
* The resource owns its concrete Replicator and connection, and cannot replace
|
||||
* the active provider instance.
|
||||
*/
|
||||
export function createCouchDBSynchronisationInformationResourceFactory(
|
||||
host: LiveSyncCouchDBReplicatorEnv
|
||||
): SynchronisationInformationResourceFactory {
|
||||
|
||||
Reference in New Issue
Block a user