Merge CouchDB cache compatibility changes into Journal recovery

This commit is contained in:
vorotamoroz committed 2026-11-05 09:54:55 +00:00
commit 0ded0bcea5
16 files changed
+735 -85

No files matched your search

+11 -1
View File
@@ -1111,6 +1111,16 @@ the separate P2P or Object Storage transfer units.
Setting key: useTimeouts Setting key: useTimeouts
If this option is enabled, PouchDB will hold the connection open for 60 seconds, and if no change arrives in that time, close and reopen the socket, instead of holding it open indefinitely. Useful when a proxy limits request duration but can increase resource usage. If this option is enabled, PouchDB will hold the connection open for 60 seconds, and if no change arrives in that time, close and reopen the socket, instead of holding it open indefinitely. Useful when a proxy limits request duration but can increase resource usage.
#### Use headers only for HTTP cache control (compatibility)
Setting key: useCouchDBCacheControlHeadersOnly
Remove the query parameter used to invalidate cached responses (the same URL behaviour as in 1.0.44 and earlier).
Disabled by default. Encrypted CouchDB reads normally use a cache query parameter derived from the plug-in startup time and current Security Seed, and revalidate cached responses. This separates responses from before a remote Rebuild even when document revisions remain unchanged.
Enable this only if your server or proxy rejects that additional query parameter. Requests then retain their original URLs and use `no-store` with revalidation headers. Some native caches can still reuse older encrypted responses in this mode, so decryption failures after a remote Rebuild may recur. Seed refresh before replication remains active in both modes. Changing this setting does not require a database rebuild.
### 3. Configuration Encryption ### 3. Configuration Encryption
#### Encrypting sensitive configuration items #### Encrypting sensitive configuration items
@@ -1228,7 +1238,7 @@ Enable this setting to process files with size mismatches, which can sometimes b
#### Do not split chunks in the background #### Do not split chunks in the background
Setting key: disableWorkerForGeneratingChunks Setting key: disableWorkerForGeneratingChunks
If disabled(toggled), chunks will be split on the UI thread (Previous behaviour). If enabled, chunks will be split on the UI thread (previous behaviour).
#### Process small files in the foreground #### Process small files in the foreground
+16
View File
@@ -4131,6 +4131,22 @@
"@trystero-p2p/core": "0.25.3" "@trystero-p2p/core": "0.25.3"
} }
}, },
"node_modules/@vrtmrz/livesync-commonlib/node_modules/minimatch": {
"version": "11.0.4",
"resolved": "https://registry.npmjs.org/minimatch/-/minimatch-11.0.4.tgz",
"integrity": "sha512-/UJ1dEoVQTjPNDh6SGlUo+ueLMmoHTas4q+8yaAR/5t6nLAIiBDJtoYUh20IYleix7ehiQkgczb84PE3uzHkxg==",
"license": "BlueOak-1.0.0",
"dependencies": {
"@isaacs/nonrecursive-glob-match": "^1.0.3",
"brace-expansion": "^5.0.12"
},
"engines": {
"node": "20 || >=22"
},
"funding": {
"url": "https://github.com/sponsors/isaacs"
}
},
"node_modules/@vrtmrz/obsidian-plugin-kit": { "node_modules/@vrtmrz/obsidian-plugin-kit": {
"version": "0.1.7", "version": "0.1.7",
"resolved": "https://registry.npmjs.org/@vrtmrz/obsidian-plugin-kit/-/obsidian-plugin-kit-0.1.7.tgz", "resolved": "https://registry.npmjs.org/@vrtmrz/obsidian-plugin-kit/-/obsidian-plugin-kit-0.1.7.tgz",
+1 -1
View File
@@ -3167,7 +3167,7 @@ export const allMessages: Readonly<Record<string, Readonly<Record<string, string
"zh-tw": "若啟用「自動啟動 P2P 連線」,外掛啟動時會自動建立 P2P 連線。", "zh-tw": "若啟用「自動啟動 P2P 連線」,外掛啟動時會自動建立 P2P 連線。",
}, },
"If disabled(toggled), chunks will be split on the UI thread (Previous behaviour).": { "If disabled(toggled), chunks will be split on the UI thread (Previous behaviour).": {
def: "If disabled(toggled), chunks will be split on the UI thread (Previous behaviour).", def: "When enabled, chunks are split on the UI thread (the previous behaviour).",
es: "Si se desactiva, los chunks se dividen en el hilo de UI (comportamiento anterior)", es: "Si se desactiva, los chunks se dividen en el hilo de UI (comportamiento anterior)",
fr: "Si désactivé, les fragments seront découpés sur le thread UI (comportement précédent).", fr: "Si désactivé, les fragments seront découpés sur le thread UI (comportement précédent).",
he: "אם מכובה, נתחים יפוצלו בשרשור ממשק המשתמש (התנהגות קודמת).", he: "אם מכובה, נתחים יפוצלו בשרשור ממשק המשתמש (התנהגות קודמת).",
+1 -1
View File
@@ -368,7 +368,7 @@
"I understand the risks and will proceed without a backup.": "I understand the risks and will proceed without a backup.", "I understand the risks and will proceed without a backup.": "I understand the risks and will proceed without a backup.",
"I Understand, Overwrite Server": "I Understand, Overwrite Server", "I Understand, Overwrite Server": "I Understand, Overwrite Server",
"If \"Auto Start P2P Connection\" is enabled, the P2P connection will be started automatically when the plug-in launches.": "If \"Auto Start P2P Connection\" is enabled, the P2P connection will be started automatically when the plug-in launches.", "If \"Auto Start P2P Connection\" is enabled, the P2P connection will be started automatically when the plug-in launches.": "If \"Auto Start P2P Connection\" is enabled, the P2P connection will be started automatically when the plug-in launches.",
"If disabled(toggled), chunks will be split on the UI thread (Previous behaviour).": "If disabled(toggled), chunks will be split on the UI thread (Previous behaviour).", "If disabled(toggled), chunks will be split on the UI thread (Previous behaviour).": "When enabled, chunks are split on the UI thread (the previous behaviour).",
"If enabled per-filed efficient customization sync will be used. We need a small migration when enabling this. And all devices should be updated to v0.23.18. Once we enabled this, we lost a compatibility with old versions.": "If enabled per-filed efficient customization sync will be used. We need a small migration when enabling this. And all devices should be updated to v0.23.18. Once we enabled this, we lost a compatibility with old versions.", "If enabled per-filed efficient customization sync will be used. We need a small migration when enabling this. And all devices should be updated to v0.23.18. Once we enabled this, we lost a compatibility with old versions.": "If enabled per-filed efficient customization sync will be used. We need a small migration when enabling this. And all devices should be updated to v0.23.18. Once we enabled this, we lost a compatibility with old versions.",
"If enabled, changes will be automatically broadcasted to all connected peers. Notified peers will start fetching the changes.": "If enabled, changes will be automatically broadcasted to all connected peers. Notified peers will start fetching the changes.", "If enabled, changes will be automatically broadcasted to all connected peers. Notified peers will start fetching the changes.": "If enabled, changes will be automatically broadcasted to all connected peers. Notified peers will start fetching the changes.",
"If enabled, chunks will be split into no more than 100 items. However, dedupe is slightly weaker.": "If enabled, chunks will be split into no more than 100 items. However, dedupe is slightly weaker.", "If enabled, chunks will be split into no more than 100 items. However, dedupe is slightly weaker.": "If enabled, chunks will be split into no more than 100 items. However, dedupe is slightly weaker.",
+1 -2
View File
@@ -437,8 +437,7 @@ If "Auto Start P2P Connection" is enabled, the P2P connection will be started au
If "Auto Start P2P Connection" is enabled, the P2P connection will be If "Auto Start P2P Connection" is enabled, the P2P connection will be
started automatically when the plug-in launches. started automatically when the plug-in launches.
If disabled(toggled), chunks will be split on the UI thread (Previous behaviour).: If disabled(toggled), chunks will be split on the UI thread (Previous behaviour).:
If disabled(toggled), chunks will be split on the UI thread (Previous When enabled, chunks are split on the UI thread (the previous behaviour).
behaviour).
If enabled per-filed efficient customization sync will be used. We need a small migration when enabling this. And all devices should be updated to v0.23.18. Once we enabled this, we lost a compatibility with old versions.: If enabled per-filed efficient customization sync will be used. We need a small migration when enabling this. And all devices should be updated to v0.23.18. Once we enabled this, we lost a compatibility with old versions.:
If enabled per-filed efficient customization sync will be used. We need a If enabled per-filed efficient customization sync will be used. We need a
small migration when enabling this. And all devices should be updated to small migration when enabling this. And all devices should be updated to
@@ -82,6 +82,7 @@ export function getCouchDBReplicatorConfigurationIdentity(settings: RemoteDBSett
authentication, authentication,
projectHeaders(settings.couchDB_CustomHeaders), projectHeaders(settings.couchDB_CustomHeaders),
settings.useRequestAPI, settings.useRequestAPI,
settings.useCouchDBCacheControlHeadersOnly === true,
settings.disableRequestURI, settings.disableRequestURI,
projectRemoteSecurity(settings), projectRemoteSecurity(settings),
usesEncryptedInternalMetadata(settings), usesEncryptedInternalMetadata(settings),
@@ -7,6 +7,17 @@ import {
} from "./replicatorConfigurationIdentity"; } from "./replicatorConfigurationIdentity";
describe("active Replicator configuration identity", () => { describe("active Replicator configuration identity", () => {
it("treats an absent headers-only CouchDB cache switch as off and leaves Object Storage unaffected", () => {
const absent = configuredSettings();
Reflect.deleteProperty(absent, "useCouchDBCacheControlHeadersOnly");
expect(getCouchDBReplicatorConfigurationIdentity({ ...absent, useCouchDBCacheControlHeadersOnly: false })).toBe(
getCouchDBReplicatorConfigurationIdentity(absent)
);
expect(getObjectStorageReplicatorConfigurationIdentity({ ...absent, useCouchDBCacheControlHeadersOnly: true })).toBe(
getObjectStorageReplicatorConfigurationIdentity(absent)
);
});
it("replaces a connection when the path identity mode changes", () => { it("replaces a connection when the path identity mode changes", () => {
const previous = configuredSettings({ pathNormalizationVersion: 0 }); const previous = configuredSettings({ pathNormalizationVersion: 0 });
const next = { ...previous, pathNormalizationVersion: 1 as const }; const next = { ...previous, pathNormalizationVersion: 1 as const };
@@ -73,6 +84,7 @@ describe("active Replicator configuration identity", () => {
["couchDB_PASSWORD", "secret-b"], ["couchDB_PASSWORD", "secret-b"],
["couchDB_CustomHeaders", "X-First: changed"], ["couchDB_CustomHeaders", "X-First: changed"],
["useRequestAPI", true], ["useRequestAPI", true],
["useCouchDBCacheControlHeadersOnly", true],
["disableRequestURI", true], ["disableRequestURI", true],
["encrypt", false], ["encrypt", false],
["passphrase", "encryption-b"], ["passphrase", "encryption-b"],
@@ -28,6 +28,7 @@ export function panePowerUsers(
onUpdate: this.onlyOnCouchDB, onUpdate: this.onlyOnCouchDB,
}); });
new Setting(paneEl).autoWireToggle("useTimeouts", { onUpdate: this.onlyOnCouchDB }); new Setting(paneEl).autoWireToggle("useTimeouts", { onUpdate: this.onlyOnCouchDB });
new Setting(paneEl).autoWireToggle("useCouchDBCacheControlHeadersOnly", { onUpdate: this.onlyOnCouchDB });
}); });
void addPanel(paneEl, $msg("Configuration Encryption")).then((paneEl) => { void addPanel(paneEl, $msg("Configuration Encryption")).then((paneEl) => {
const passphrase_options: Record<ConfigPassphraseStore, string> = { const passphrase_options: Record<ConfigPassphraseStore, string> = {
+2 -67
View File
@@ -6,6 +6,7 @@ import { ObsidianConfirm } from "./ObsidianConfirm";
import type { Confirm } from "@vrtmrz/livesync-commonlib/compat/interfaces/Confirm"; import type { Confirm } from "@vrtmrz/livesync-commonlib/compat/interfaces/Confirm";
import { requestUrl, type RequestUrlParam } from "@/deps"; import { requestUrl, type RequestUrlParam } from "@/deps";
import { compatGlobal } from "@vrtmrz/livesync-commonlib/compat/common/coreEnvFunctions"; import { compatGlobal } from "@vrtmrz/livesync-commonlib/compat/common/coreEnvFunctions";
import { createNativeRequestHeaders } from "./nativeRequestHeaders";
// All Services will be migrated to be based on Plain Services, not Injectable Services. // All Services will be migrated to be based on Plain Services, not Injectable Services.
// This is a migration step. // This is a migration step.
@@ -16,43 +17,6 @@ declare module "obsidian" {
} }
} }
const cacheReuseDirectives = new Set(["max-age", "max-stale", "min-fresh", "only-if-cached"]);
function splitHeaderDirectives(value: string): string[] {
const directives: string[] = [];
let start = 0;
let inQuotes = false;
let escaped = false;
for (let index = 0; index < value.length; index++) {
const character = value[index];
if (inQuotes && escaped) {
escaped = false;
continue;
}
if (inQuotes && character === "\\") {
escaped = true;
continue;
}
if (character === '"') {
inQuotes = !inQuotes;
} else if (character === "," && !inQuotes) {
const directive = value.slice(start, index).trim();
if (directive) directives.push(directive);
start = index + 1;
}
}
const lastDirective = value.slice(start).trim();
if (lastDirective) directives.push(lastDirective);
return directives;
}
function getDirectiveName(directive: string): string {
const equalsIndex = directive.indexOf("=");
return (equalsIndex === -1 ? directive : directive.slice(0, equalsIndex)).trim().toLowerCase();
}
export class ObsidianAPIService extends InjectableAPIService<ObsidianServiceContext> { export class ObsidianAPIService extends InjectableAPIService<ObsidianServiceContext> {
_customHandler: ObsHttpHandler | undefined; _customHandler: ObsHttpHandler | undefined;
_confirmInstance: Confirm; _confirmInstance: Confirm;
@@ -212,37 +176,8 @@ export class ObsidianAPIService extends InjectableAPIService<ObsidianServiceCont
} }
} }
} }
const transformedHeaders = { ...optHeaders };
// Delete headers that should not be sent by native fetch,
// they are controlled by the browser and may cause CORS preflight failure if sent manually.
delete transformedHeaders["host"];
delete transformedHeaders["Host"];
delete transformedHeaders["content-length"];
delete transformedHeaders["Content-Length"];
const cacheMode = opts?.cache ?? (req instanceof Request ? req.cache : undefined); const cacheMode = opts?.cache ?? (req instanceof Request ? req.cache : undefined);
if (cacheMode === "no-store" && ["GET", "HEAD"].includes(method.toUpperCase())) { const transformedHeaders = createNativeRequestHeaders(optHeaders, method, cacheMode);
// requestUrl has no cache option; no-store alone can reuse an existing cached response.
const cacheControlKeys = Object.keys(transformedHeaders).filter(
(key) => key.toLowerCase() === "cache-control"
);
const cacheControlDirectives = cacheControlKeys
.flatMap((key) => splitHeaderDirectives(transformedHeaders[key]))
.filter((directive) => {
const name = getDirectiveName(directive);
return !cacheReuseDirectives.has(name) && name !== "no-cache" && name !== "no-store";
});
const cacheControlKey = cacheControlKeys[0] ?? "cache-control";
for (const key of cacheControlKeys) delete transformedHeaders[key];
transformedHeaders[cacheControlKey] = [...cacheControlDirectives, "no-cache", "no-store"].join(", ");
const pragmaKeys = Object.keys(transformedHeaders).filter((key) => key.toLowerCase() === "pragma");
const pragmaDirectives = pragmaKeys
.flatMap((key) => splitHeaderDirectives(transformedHeaders[key]))
.filter((directive) => getDirectiveName(directive) !== "no-cache");
const pragmaKey = pragmaKeys[0] ?? "pragma";
for (const key of pragmaKeys) delete transformedHeaders[key];
transformedHeaders[pragmaKey] = [...pragmaDirectives, "no-cache"].join(", ");
}
const contentType = const contentType =
transformedHeaders["content-type"] ?? transformedHeaders["Content-Type"] ?? "application/json"; transformedHeaders["content-type"] ?? transformedHeaders["Content-Type"] ?? "application/json";
const requestParam: RequestUrlParam = { const requestParam: RequestUrlParam = {
@@ -101,6 +101,35 @@ describe("ObsidianAPIService.nativeFetch cache control", () => {
expect(mocks.requestUrl.mock.calls[0][0]).toMatchObject({ url, method }); expect(mocks.requestUrl.mock.calls[0][0]).toMatchObject({ url, method });
}); });
it.each(["GET", "HEAD", "get", "head"])("revalidates an explicit no-cache %s request", async (method) => {
const headers = {
"Cache-Control": 'public, max-age=3600, no-transform, custom="a,b"',
"cAcHe-CoNtRoL": 'max-stale=30, min-fresh=5, only-if-cached, custom-two="max-age=1, only-if-cached"',
Pragma: "cache",
};
const originalHeaders = { ...headers };
await createService({}).nativeFetch(url, { method, cache: "no-cache", headers });
expect(sentHeaders().get("cache-control")).toBe(
'public, no-transform, custom="a,b", custom-two="max-age=1, only-if-cached", no-cache'
);
expect(sentHeaders().get("pragma")).toBe("cache, no-cache");
expect(headers).toEqual(originalHeaders);
expect(mocks.requestUrl.mock.calls[0][0]).toMatchObject({ url, method });
});
it("preserves an explicit no-store directive when enforcing no-cache", async () => {
const headers = { "Cache-Control": "no-store, max-age=3600", Pragma: "legacy" };
const originalHeaders = { ...headers };
await createService({}).nativeFetch(url, { cache: "no-cache", headers });
expect(sentHeaders().get("cache-control")).toBe("no-store, no-cache");
expect(sentHeaders().get("pragma")).toBe("legacy, no-cache");
expect(headers).toEqual(originalHeaders);
});
it("preserves non-conflicting cache directives when enforcing no-store", async () => { it("preserves non-conflicting cache directives when enforcing no-store", async () => {
const headers = { const headers = {
"Cache-Control": 'max-age=3600, no-transform, custom="a,b"', "Cache-Control": 'max-age=3600, no-transform, custom="a,b"',
@@ -140,6 +169,30 @@ describe("ObsidianAPIService.nativeFetch cache control", () => {
expect(request.headers.has("cache-control")).toBe(false); expect(request.headers.has("cache-control")).toBe(false);
}); });
it("uses a Request no-cache mode when the options do not override it", async () => {
const request = new Request(url, {
method: "HEAD",
cache: "no-cache",
headers: { "Cache-Control": "max-age=60", "X-Fixture": "request" },
});
const headers = new Headers({ "X-Other": "options" });
await createService({}).nativeFetch(request, { headers });
expect(sentHeaders().get("cache-control")).toBe("no-cache");
expect(sentHeaders().get("x-fixture")).toBe("request");
expect(sentHeaders().get("x-other")).toBe("options");
expect(request.headers.get("cache-control")).toBe("max-age=60");
expect(headers.has("cache-control")).toBe(false);
});
it("lets an explicit default cache mode override a no-cache Request", async () => {
await createService({}).nativeFetch(new Request(url, { cache: "no-cache" }), { cache: "default" });
expect(sentHeaders().has("cache-control")).toBe(false);
expect(sentHeaders().has("pragma")).toBe(false);
});
it("lets the options request no-store for an otherwise cacheable Request", async () => { it("lets the options request no-store for an otherwise cacheable Request", async () => {
await createService({}).nativeFetch(new Request(url, { cache: "force-cache" }), { cache: "no-store" }); await createService({}).nativeFetch(new Request(url, { cache: "force-cache" }), { cache: "no-store" });
@@ -153,7 +206,7 @@ describe("ObsidianAPIService.nativeFetch cache control", () => {
expect(sentHeaders().has("pragma")).toBe(false); expect(sentHeaders().has("pragma")).toBe(false);
}); });
it.each([undefined, "default", "no-cache", "reload", "force-cache"] as const)( it.each([undefined, "default", "reload", "force-cache"] as const)(
"preserves caller headers for cache mode %s", "preserves caller headers for cache mode %s",
async (cache) => { async (cache) => {
const headers = { "Cache-Control": "max-age=60", Pragma: "fixture" }; const headers = { "Cache-Control": "max-age=60", Pragma: "fixture" };
@@ -171,6 +224,14 @@ describe("ObsidianAPIService.nativeFetch cache control", () => {
expect(sentHeaders().has("pragma")).toBe(false); expect(sentHeaders().has("pragma")).toBe(false);
}); });
it.each(["POST", "PUT", "DELETE"])("preserves a no-cache %s request", async (method) => {
const headers = { "Cache-Control": "max-age=60, no-transform", Pragma: "fixture" };
await createService({}).nativeFetch(url, { method, cache: "no-cache", headers });
expect(mocks.requestUrl.mock.calls[0][0]).toMatchObject({ url, method, headers });
});
it.each(["POST", "PUT", "DELETE"])("preserves a no-store %s request", async (method) => { it.each(["POST", "PUT", "DELETE"])("preserves a no-store %s request", async (method) => {
const headers = { "Cache-Control": "no-transform" }; const headers = { "Cache-Control": "no-transform" };
@@ -0,0 +1,100 @@
const cacheReuseDirectives = new Set(["max-age", "max-stale", "min-fresh", "only-if-cached"]);
function splitHeaderDirectives(value: string): string[] {
const directives: string[] = [];
let start = 0;
let inQuotes = false;
let escaped = false;
for (let index = 0; index < value.length; index++) {
const character = value[index];
if (inQuotes && escaped) {
escaped = false;
continue;
}
if (inQuotes && character === "\\") {
escaped = true;
continue;
}
if (character === '"') {
inQuotes = !inQuotes;
} else if (character === "," && !inQuotes) {
const directive = value.slice(start, index).trim();
if (directive) directives.push(directive);
start = index + 1;
}
}
const lastDirective = value.slice(start).trim();
if (lastDirective) directives.push(lastDirective);
return directives;
}
function getDirectiveName(directive: string): string {
const equalsIndex = directive.indexOf("=");
return (equalsIndex === -1 ? directive : directive.slice(0, equalsIndex)).trim().toLowerCase();
}
/**
* Whether native GET or HEAD requests must revalidate an explicitly bypassed cache.
*
* @param method - HTTP method, compared without regard to letter case.
* @param cacheMode - Effective Request or options cache mode.
* @returns True only for GET/HEAD with `no-cache` or `no-store`.
*/
export function shouldRevalidateNativeRequest(method: string, cacheMode: RequestCache | undefined): boolean {
return (cacheMode === "no-cache" || cacheMode === "no-store") && ["GET", "HEAD"].includes(method.toUpperCase());
}
function shouldRetainCacheControlDirective(directive: string, enforceNoStore: boolean): boolean {
const name = getDirectiveName(directive);
return !cacheReuseDirectives.has(name) && name !== "no-cache" && (!enforceNoStore || name !== "no-store");
}
/**
* Copy request headers and apply the native fetch adapter's header/cache policy.
*
* @param headers - Merged input headers; this function does not mutate them.
* @param method - HTTP method used to decide whether cache revalidation applies.
* @param cacheMode - Effective Request or options cache mode.
* @returns Fresh headers with the adapter's native-controlled headers removed.
* Revalidated GET/HEAD requests retain non-conflicting directives and receive
* `no-cache`; `no-store` also adds that directive. Existing header spelling is retained.
*/
export function createNativeRequestHeaders(
headers: Readonly<Record<string, string>>,
method: string,
cacheMode: RequestCache | undefined
): Record<string, string> {
const transformedHeaders = { ...headers };
// Delete headers that should not be sent by native fetch,
// they are controlled by the browser and may cause CORS preflight failure if sent manually.
delete transformedHeaders["host"];
delete transformedHeaders["Host"];
delete transformedHeaders["content-length"];
delete transformedHeaders["Content-Length"];
if (shouldRevalidateNativeRequest(method, cacheMode)) {
// requestUrl has no cache option; no-store alone can reuse an existing cached response.
const enforceNoStore = cacheMode === "no-store";
const cacheControlKeys = Object.keys(transformedHeaders).filter((key) => key.toLowerCase() === "cache-control");
const cacheControlDirectives = cacheControlKeys
.flatMap((key) => splitHeaderDirectives(transformedHeaders[key]))
.filter((directive) => shouldRetainCacheControlDirective(directive, enforceNoStore));
const cacheControlKey = cacheControlKeys[0] ?? "cache-control";
for (const key of cacheControlKeys) delete transformedHeaders[key];
transformedHeaders[cacheControlKey] = [
...cacheControlDirectives,
"no-cache",
...(enforceNoStore ? ["no-store"] : []),
].join(", ");
const pragmaKeys = Object.keys(transformedHeaders).filter((key) => key.toLowerCase() === "pragma");
const pragmaDirectives = pragmaKeys
.flatMap((key) => splitHeaderDirectives(transformedHeaders[key]))
.filter((directive) => getDirectiveName(directive) !== "no-cache");
const pragmaKey = pragmaKeys[0] ?? "pragma";
for (const key of pragmaKeys) delete transformedHeaders[key];
transformedHeaders[pragmaKey] = [...pragmaDirectives, "no-cache"].join(", ");
}
return transformedHeaders;
}
@@ -0,0 +1,98 @@
import { describe, expect, it } from "vitest";
import { createNativeRequestHeaders, shouldRevalidateNativeRequest } from "./nativeRequestHeaders";
describe("native cache revalidation decision", () => {
it.each(["GET", "HEAD", "get", "head"])("revalidates explicit no-cache/no-store for %s", (method) => {
expect(shouldRevalidateNativeRequest(method, "no-cache")).toBe(true);
expect(shouldRevalidateNativeRequest(method, "no-store")).toBe(true);
});
it.each([undefined, "default", "reload", "force-cache", "only-if-cached"] as const)(
"does not strengthen cache mode %s",
(mode) => {
expect(shouldRevalidateNativeRequest("GET", mode)).toBe(false);
expect(shouldRevalidateNativeRequest("HEAD", mode)).toBe(false);
}
);
it.each(["POST", "PUT", "PATCH", "DELETE", "OPTIONS"])("does not revalidate %s", (method) => {
expect(shouldRevalidateNativeRequest(method, "no-cache")).toBe(false);
expect(shouldRevalidateNativeRequest(method, "no-store")).toBe(false);
});
});
describe("native request header creation", () => {
it("copies input headers and removes the existing native-controlled header forms", () => {
const input = Object.freeze({
host: "first.test",
Host: "second.test",
"content-length": "1",
"Content-Length": "2",
Authorization: "Bearer fixture",
"Cache-Control": "max-age=60",
});
const result = createNativeRequestHeaders(input, "GET", "default");
expect(result).toEqual({ Authorization: "Bearer fixture", "Cache-Control": "max-age=60" });
expect(result).not.toBe(input);
expect(input.host).toBe("first.test");
expect(input["Content-Length"]).toBe("2");
});
it.each(["GET", "HEAD"])("creates no-store revalidation headers for %s", (method) => {
expect(createNativeRequestHeaders({}, method, "no-store")).toEqual({
"cache-control": "no-cache, no-store",
pragma: "no-cache",
});
});
it("preserves an existing no-store directive when enforcing no-cache", () => {
expect(
createNativeRequestHeaders(
{ "Cache-Control": "no-store, max-age=3600", Pragma: "legacy" },
"GET",
"no-cache"
)
).toEqual({ "Cache-Control": "no-store, no-cache", Pragma: "legacy, no-cache" });
});
it("combines differently cased header fields and retains non-conflicting directives", () => {
const input = Object.freeze({
"Cache-Control": 'Max-Age=99, no-transform, custom="a,b", No-Cache',
"cache-control": "max-stale=5, min-fresh=6, only-if-cached, NO-STORE, private",
Pragma: 'legacy="a,b", No-Cache',
pragma: "extension, no-cache",
});
expect(createNativeRequestHeaders(input, "get", "no-store")).toEqual({
"Cache-Control": 'no-transform, custom="a,b", private, no-cache, no-store',
Pragma: 'legacy="a,b", extension, no-cache',
});
expect(input["cache-control"]).toContain("max-stale=5");
});
it("does not split directive commas inside escaped quoted strings", () => {
const custom = String.raw`custom="a\"b,c"`;
expect(createNativeRequestHeaders({ "cache-control": `${custom}, max-age=1` }, "HEAD", "no-cache")).toEqual({
"cache-control": `${custom}, no-cache`,
pragma: "no-cache",
});
});
it.each([
["", "no-cache"],
[", , ,", "no-cache"],
[" , no-transform , , ", "no-transform, no-cache"],
])("ignores empty header-list members in %j", (value, expected) => {
const headers = Object.freeze({ "Cache-Control": value, Pragma: " , , " });
expect(createNativeRequestHeaders(headers, "GET", "no-cache")).toEqual({
"Cache-Control": expected,
Pragma: "no-cache",
});
expect(headers["Cache-Control"]).toBe(value);
});
it("retains cache headers on a non-revalidated method", () => {
const headers = { "cache-control": "max-age=99", Pragma: "legacy" };
expect(createNativeRequestHeaders(headers, "POST", "no-store")).toEqual(headers);
});
});
+29 -5
View File
@@ -3,7 +3,7 @@ import assert from "node:assert/strict";
import { mkdir, readFile, rename, writeFile } from "node:fs/promises"; import { mkdir, readFile, rename, writeFile } from "node:fs/promises";
import { dirname, join } from "node:path"; import { dirname, join } from "node:path";
import { TempDir } from "./helpers/temp.ts"; import { TempDir } from "./helpers/temp.ts";
import { assertFilesEqual, runCliOrFail, sanitiseCatStdout } from "./helpers/cli.ts"; import { assertFilesEqual, runCli, runCliOrFail, sanitiseCatStdout, type CliResult } from "./helpers/cli.ts";
import { applyRemoteSyncSettings, initSettingsFile } from "./helpers/settings.ts"; import { applyRemoteSyncSettings, initSettingsFile } from "./helpers/settings.ts";
import { startMinio, stopMinio } from "./helpers/docker.ts"; import { startMinio, stopMinio } from "./helpers/docker.ts";
@@ -34,6 +34,20 @@ function createJournalFixture(): string {
].join(""); ].join("");
} }
async function assertFetchedVaultMatches(
sourceFile: string,
receiverFile: string,
result: CliResult,
message: string
): Promise<void> {
assert.equal(result.code, 0, `${message}\nCLI exit code: ${result.code}\n${result.combined}`);
try {
await assertFilesEqual(sourceFile, receiverFile, message);
} catch (error) {
throw new Error(`${message}\nCLI output:\n${result.combined}`, { cause: error });
}
}
async function runScenario(encrypt: boolean): Promise<void> { async function runScenario(encrypt: boolean): Promise<void> {
const suffix = `${encrypt ? "enc1" : "enc0"}-${Date.now()}-${Math.floor(Math.random() * 100000)}`; const suffix = `${encrypt ? "enc1" : "enc0"}-${Date.now()}-${Math.floor(Math.random() * 100000)}`;
const minioEndpoint = requireEnv("MINIO_ENDPOINT", "minioEndpoint").replace(/\/$/, ""); const minioEndpoint = requireEnv("MINIO_ENDPOINT", "minioEndpoint").replace(/\/$/, "");
@@ -99,7 +113,7 @@ async function runScenario(encrypt: boolean): Promise<void> {
"--force", "--force",
"--write-settings" "--write-settings"
); );
await runCliOrFail( const initialFetch = await runCli(
receiverDatabase, receiverDatabase,
"--settings", "--settings",
receiverSettings, receiverSettings,
@@ -110,7 +124,12 @@ async function runScenario(encrypt: boolean): Promise<void> {
"--write-settings" "--write-settings"
); );
await assertFilesEqual(sourceFile, receiverFile, "Fetched Vault file does not match the rebuild source"); await assertFetchedVaultMatches(
sourceFile,
receiverFile,
initialFetch,
"Initial fetch did not reproduce the rebuild source in the receiver Vault"
);
const fetchedContent = sanitiseCatStdout( const fetchedContent = sanitiseCatStdout(
await runCliOrFail(receiverDatabase, "--settings", receiverSettings, "cat", targetPath) await runCliOrFail(receiverDatabase, "--settings", receiverSettings, "cat", targetPath)
); );
@@ -163,7 +182,7 @@ async function runScenario(encrypt: boolean): Promise<void> {
"Fetch should retain both the intact remote and differing local contents without inferring their ancestry" "Fetch should retain both the intact remote and differing local contents without inferring their ancestry"
); );
await rename(receiverFile, workDir.join("damaged-vault-backup.md")); await rename(receiverFile, workDir.join("damaged-vault-backup.md"));
await runCliOrFail( const restoreFetch = await runCli(
receiverDatabase, receiverDatabase,
"--settings", "--settings",
receiverSettings, receiverSettings,
@@ -173,7 +192,12 @@ async function runScenario(encrypt: boolean): Promise<void> {
"--force", "--force",
"--write-settings" "--write-settings"
); );
await assertFilesEqual(sourceFile, receiverFile, "Fetching into an empty Vault should restore the remote file"); await assertFetchedVaultMatches(
sourceFile,
receiverFile,
restoreFetch,
"Fetch did not restore the remote file after the damaged Vault copy was moved"
);
assert.equal(await readFile(workDir.join("damaged-vault-backup.md"), "utf8"), damagedContent); assert.equal(await readFile(workDir.join("damaged-vault-backup.md"), "utf8"), damagedContent);
const restoredContent = sanitiseCatStdout( const restoredContent = sanitiseCatStdout(
await runCliOrFail(receiverDatabase, "--settings", receiverSettings, "cat", targetPath) await runCliOrFail(receiverDatabase, "--settings", receiverSettings, "cat", targetPath)
+2 -2
View File
@@ -172,9 +172,9 @@ The Harness also measures ID generation with fixed in-memory data on desktop and
The same workflow checks the two remote-activity status boundaries. It first holds a real CouchDB request at the selected fetch implementation and confirms that `🌐N` is visible while `📲` is absent. It then holds the real one-shot replication immediately before its replicator call, confirms that `📲` is visible while no physical request is active, releases it, and requires the finite and bounded activity counts to return to zero, the request and response counts to balance, and both indicators to disappear. Finally, it creates a remote-only chunk, holds the real on-demand fetch immediately before its remote call, makes the same logical active and idle assertions, and verifies that the fetched chunk is written into the local database. These gates make the active states deterministic without replacing the remote request or operation. The same workflow checks the two remote-activity status boundaries. It first holds a real CouchDB request at the selected fetch implementation and confirms that `🌐N` is visible while `📲` is absent. It then holds the real one-shot replication immediately before its replicator call, confirms that `📲` is visible while no physical request is active, releases it, and requires the finite and bounded activity counts to return to zero, the request and response counts to balance, and both indicators to disappear. Finally, it creates a remote-only chunk, holds the real on-demand fetch immediately before its remote call, makes the same logical active and idle assertions, and verifies that the fetched chunk is written into the local database. These gates make the active states deterministic without replacing the remote request or operation.
`test:e2e:obsidian:couchdb-http-cache` checks replication after rebuilding an encrypted CouchDB remote while an earlier HTTP response remains cached. It enables internal Metadata encryption with Hidden File Sync and Customisation Sync, verifies that the Rebuild replaces the Security Seed and ciphertext while retaining the document revision, and requires the replication pre-check and subsequent sends to succeed without clearing the browser cache. It uses the CouchDB fixture variables, an isolated Vault and profile, and a unique remote database. The raw command uses the current built plug-in by default; `E2E_OBSIDIAN_ARTIFACT_ROOT` can select an exact earlier build for regression comparison. `test:e2e:obsidian:couchdb-http-cache` checks replication after rebuilding an encrypted CouchDB remote while an earlier HTTP response remains cached. It enables internal Metadata encryption with Hidden File Sync and Customisation Sync, verifies that the Rebuild replaces the Security Seed and ciphertext while retaining the document revision, and requires the replication pre-check and subsequent sends to succeed without clearing the browser cache. It uses the CouchDB fixture variables, an isolated Vault and profile, and a unique remote database. The raw command uses the current built plug-in by default; `E2E_OBSIDIAN_ARTIFACT_ROOT` can select an exact earlier build for regression comparison. It also verifies the combined startup-time/Seed hash, the default-off headers-only compatibility switch through the visible settings UI, its saved value after reopening, and the resulting request URLs and cache modes in both switch positions.
Run `npm run test:e2e:obsidian:focused -- couchdb-http-cache --request-api` to warm Obsidian's Internal API cache and perform the same workflow with **Use Internal API** enabled. Both modes require an explicit `no-store` read to return the rebuilt ciphertext. The default mode also retains the stale browser-cache assertion; the Internal API mode permits reads during Rebuild to refresh that cache. Run `npm run test:e2e:obsidian:focused -- couchdb-http-cache --request-api` to warm Obsidian's Internal API cache and perform the same workflow with **Use Internal API** enabled. Both modes read decoded Metadata through owned Commonlib connections and observe the actual request URLs. They require the cache URL to change after Security Seed replacement and remain stable across new connections with an unchanged Seed, including after Standard Fetch. The ordinary Vault file must retain its expected contents. The final Standard Fetch phase includes Chunk bodies rather than leaving them for on-demand retrieval, so strict local reconciliation can read the file after database replacement. The default mode also retains the stale browser-cache assertion; the Internal API mode permits reads during Rebuild to refresh that cache. Native adapters may return a full body rather than 304 during revalidation.
`npm run test:e2e:obsidian:focused -- chunk-fetch-retry` checks delayed Chunk availability through a real CouchDB service and Obsidian. It creates a Metadata-only remote fixture, starts ordinary one-shot replication with `readChunksOnline`, and inserts the missing Chunk only after a real fetch has returned an empty result. A pass-through observer records the replicator's call times and results without substituting responses or adding waits. The fixture sets the existing minimum request interval to 500 ms to keep the real retry status observable even if finite completion expedites the final probe. The actual status bar must show zero initial requests (`🛄`) and one retry (`🔁`), and both counts must return to zero after delivery ends. On-demand replication excludes Chunk documents from the ordinary pull, so the delayed Chunk must arrive through the observed fetch and produce the exact Vault content. `npm run test:e2e:obsidian:focused -- chunk-fetch-retry` checks delayed Chunk availability through a real CouchDB service and Obsidian. It creates a Metadata-only remote fixture, starts ordinary one-shot replication with `readChunksOnline`, and inserts the missing Chunk only after a real fetch has returned an empty result. A pass-through observer records the replicator's call times and results without substituting responses or adding waits. The fixture sets the existing minimum request interval to 500 ms to keep the real retry status observable even if finite completion expedites the final probe. The actual status bar must show zero initial requests (`🛄`) and one retry (`🔁`), and both counts must return to zero after delivery ends. On-demand replication excludes Chunk documents from the ordinary pull, so the delayed Chunk must arrive through the observed fetch and produce the exact Vault content.
+392 -5
View File
@@ -1,5 +1,5 @@
import assert from "node:assert/strict"; import assert from "node:assert/strict";
import { mkdir, writeFile } from "node:fs/promises"; import { mkdir, readFile, writeFile } from "node:fs/promises";
import { dirname, join, resolve } from "node:path"; import { dirname, join, resolve } from "node:path";
import { DoctorRegulation } from "@vrtmrz/livesync-commonlib/compat/common/configForDoc"; import { DoctorRegulation } from "@vrtmrz/livesync-commonlib/compat/common/configForDoc";
import { DOCID_SYNC_PARAMETERS } from "@vrtmrz/livesync-commonlib/compat/common/types"; import { DOCID_SYNC_PARAMETERS } from "@vrtmrz/livesync-commonlib/compat/common/types";
@@ -22,16 +22,47 @@ import {
prepareRemote, prepareRemote,
pushLocalChanges, pushLocalChanges,
waitForLiveSyncCoreReady, waitForLiveSyncCoreReady,
waitForLocalDatabaseEntry,
} from "../runner/liveSyncWorkflow.ts"; } from "../runner/liveSyncWorkflow.ts";
import { startObsidianLiveSyncSession, type ObsidianLiveSyncSession } from "../runner/session.ts"; import { startObsidianLiveSyncSession, type ObsidianLiveSyncSession } from "../runner/session.ts";
import { createTemporaryVault } from "../runner/vault.ts"; import { createTemporaryVault } from "../runner/vault.ts";
import { obsidianRemoteDebuggingPort, openLiveSyncSettings, withObsidianPage } from "../runner/ui.ts";
process.env.E2E_OBSIDIAN_CLI_TIMEOUT_MS ??= "60000"; process.env.E2E_OBSIDIAN_CLI_TIMEOUT_MS ??= "60000";
const useRequestAPI = process.argv.includes("--request-api"); const useRequestAPI = process.argv.includes("--request-api");
type ObservedRequest = { transport: string; method: string; url: string; cache?: RequestCache };
type RestartState = {
settings: {
useCouchDBCacheControlHeadersOnly: boolean;
couchDB_DBNAME: string;
deviceAndVaultName: string;
encrypt: boolean;
encryptInternalMetadata: boolean;
usePathObfuscation: boolean;
};
localDatabaseName: string;
localMetadata: null | { id: string; revision: string; path: string; children: string[] };
nodeId: string;
};
async function waitForNextUnixSecond(previousUnixSecond: number): Promise<void> {
const timeoutMs = Number(process.env.E2E_OBSIDIAN_CORE_READY_TIMEOUT_MS ?? 20000);
const deadline = Date.now() + timeoutMs;
while (Math.floor(Date.now() / 1000) <= previousUnixSecond) {
if (Date.now() >= deadline) {
throw new Error("Timed out waiting for the next Unix second before restarting Obsidian.");
}
await new Promise((resolve) => setTimeout(resolve, 20));
}
}
const customPath = ".obsidian/snippets/http-cache.css"; const customPath = ".obsidian/snippets/http-cache.css";
const nextCustomPath = ".obsidian/snippets/http-cache-new.css"; const nextCustomPath = ".obsidian/snippets/http-cache-new.css";
const ordinaryPath = "example.md";
const ordinaryContents = "/* HTTP cache fixture */\n";
const restartNotePath = "restart-after-http-cache.md";
const restartNoteContents = "Synchronised after restarting Obsidian.\n";
const settings = { const settings = {
encrypt: true, encrypt: true,
passphrase: "couchdb-http-cache-fixture-secret", passphrase: "couchdb-http-cache-fixture-secret",
@@ -48,6 +79,7 @@ const settings = {
syncInternalFilesTargetPatterns: "^\\.http-cache(?:/|$)", syncInternalFilesTargetPatterns: "^\\.http-cache(?:/|$)",
watchInternalFileChanges: false, watchInternalFileChanges: false,
useRequestAPI, useRequestAPI,
usePowerUserMode: true,
autoAcceptCompatibleTweak: false, autoAcceptCompatibleTweak: false,
doctorProcessedVersion: DoctorRegulation.version, doctorProcessedVersion: DoctorRegulation.version,
deviceAndVaultName: "http-cache-source", deviceAndVaultName: "http-cache-source",
@@ -62,6 +94,7 @@ async function main(): Promise<void> {
const connection = { ...couchDb, dbName }; const connection = { ...couchDb, dbName };
const vault = await createTemporaryVault(); const vault = await createTemporaryVault();
let session: ObsidianLiveSyncSession | undefined; let session: ObsidianLiveSyncSession | undefined;
let observingRequests = false;
const evaluate = async <T>(body: string): Promise<T> => { const evaluate = async <T>(body: string): Promise<T> => {
if (!session) throw new Error("No active Obsidian session."); if (!session) throw new Error("No active Obsidian session.");
return await evalObsidianJson<T>( return await evalObsidianJson<T>(
@@ -85,12 +118,118 @@ async function main(): Promise<void> {
if(!response.ok)throw new Error('Fixture read failed: '+response.status); if(!response.ok)throw new Error('Fixture read failed: '+response.status);
return JSON.stringify(await response.json());`); return JSON.stringify(await response.json());`);
}; };
const observeCommonlibRequests = async (): Promise<void> => {
await evaluate(`return (() => {
const api=core.services.API;
const state={requests:[],originals:{},restore:undefined};
for(const name of ['webCompatFetch','nativeFetch']) {
state.originals[name]=api[name];
api[name]=function(request,options) {
const url=typeof request==='string'?request:request.url;
const method=options?.method??(typeof request==='string'?'GET':request.method);
state.requests.push({transport:name,method,url,cache:options?.cache});
return state.originals[name].call(this,request,options);
};
}
state.restore=()=>{for(const name of Object.keys(state.originals)) api[name]=state.originals[name];};
globalThis.couchDBHttpCacheObservations=state;
return JSON.stringify(true);
})()`);
observingRequests = true;
};
const restoreCommonlibRequests = async (): Promise<void> => {
await evaluate(`return (() => {
const state=globalThis.couchDBHttpCacheObservations;
if(state)state.restore();
delete globalThis.couchDBHttpCacheObservations;
return JSON.stringify(true);
})()`);
observingRequests = false;
};
const readCommonlibDocument = async (id: string) =>
await evaluate<{
document: CouchDbDocument;
requests: ObservedRequest[];
}>(`const state=globalThis.couchDBHttpCacheObservations;
if(!state)throw new Error('HTTP request observation is not active');
const firstRequest=state.requests.length;
const replicator=core.services.replicator.getActiveReplicator();
const connection=await replicator.connectRemoteCouchDBWithSetting(
core.services.setting.currentSettings(),false,false,true);
if(typeof connection==='string')throw new Error('Could not open the owned Commonlib connection: '+connection);
try {
const document=await connection.db.get(${JSON.stringify(id)});
return JSON.stringify({document,requests:state.requests.slice(firstRequest)});
} finally {
await connection.close();
}`);
const metadataRequest = (
read: Awaited<ReturnType<typeof readCommonlibDocument>>,
id: string
): ObservedRequest => {
const request = read.requests
.filter((candidate) => {
const path = new URL(candidate.url).pathname;
return decodeURIComponent(path.slice(path.lastIndexOf("/") + 1)) === id;
})
.slice(-1)[0];
assert.ok(request, `The owned Commonlib read did not request Metadata ${id}.`);
assert.equal(request.transport, useRequestAPI ? "nativeFetch" : "webCompatFetch");
assert.equal(request.method.toUpperCase(), "GET");
return request;
};
const setHeadersOnlyThroughUI = async (enabled: boolean, expectedBefore: boolean): Promise<void> => {
await withObsidianPage(obsidianRemoteDebuggingPort(), async (page) => {
const navigator = await openLiveSyncSettings(page);
try {
const pane = await navigator.openPage("Power users");
const row = pane.locator(".setting-item").filter({
hasText: "Use headers only for HTTP cache control (compatibility)",
});
await row.waitFor({ state: "visible" });
assert.equal(await row.locator(".checkbox-container.is-enabled").count(), Number(expectedBefore));
await row.locator(".checkbox-container").click();
await page.waitForFunction(
`app.plugins.plugins['obsidian-livesync'].core.services.setting.currentSettings().useCouchDBCacheControlHeadersOnly === ${enabled}`
);
} finally {
await navigator.close();
}
});
const saved = JSON.parse(await readFile(join(vault.path, ".obsidian/plugins/obsidian-livesync/data.json"), "utf8"));
assert.equal(saved.useCouchDBCacheControlHeadersOnly, enabled, "The compatibility switch was not saved.");
};
const assertLogicalDocument = (document: CouchDbDocument, original: CouchDbDocument): void => {
assert.equal(document._id, original._id);
assert.equal(document._rev, original._rev, "The logical Metadata revision changed.");
assert.equal(document.path, ordinaryPath, "The owned connection did not return the logical file path.");
assert.equal(document.type, original.type);
assert.equal(document.size, Buffer.byteLength(ordinaryContents));
assert.ok(Array.isArray(document.children) && document.children.length > 0);
};
const readRestartState = async (): Promise<RestartState> =>
await evaluate<RestartState>([
"const settings=core.services.setting.currentSettings();",
"const database=core.localDatabase.localDatabase;",
"const databaseInfo=await database.info();",
"const nodeInfo=await database.get('_local/obsydian_livesync_nodeinfo').catch(()=>null);",
"const localMetadata=await core.localDatabase.getDBEntry('example.md',undefined,false,true).catch(()=>null);",
"return JSON.stringify({settings:{",
"useCouchDBCacheControlHeadersOnly:settings.useCouchDBCacheControlHeadersOnly===true,",
"couchDB_DBNAME:settings.couchDB_DBNAME,deviceAndVaultName:core.services.setting.getDeviceAndVaultName(),",
"encrypt:settings.encrypt,encryptInternalMetadata:settings.encryptInternalMetadata,",
"usePathObfuscation:settings.usePathObfuscation},",
"localDatabaseName:databaseInfo.db_name,",
"localMetadata:localMetadata?{id:localMetadata._id,revision:localMetadata._rev,path:localMetadata.path,children:localMetadata.children??[]}:null,",
"nodeId:nodeInfo?.nodeid??''});",
].join(""));
try { try {
await createCouchDbDatabase(couchDb, dbName); await createCouchDbDatabase(couchDb, dbName);
for (const path of ["example.md", ".http-cache/example.json", customPath]) { for (const path of [ordinaryPath, ".http-cache/example.json", customPath]) {
await mkdir(dirname(join(vault.path, path)), { recursive: true }); await mkdir(dirname(join(vault.path, path)), { recursive: true });
await writeFile(join(vault.path, path), "/* HTTP cache fixture */\n"); await writeFile(join(vault.path, path), ordinaryContents);
} }
session = await startObsidianLiveSyncSession({ session = await startObsidianLiveSyncSession({
binary, binary,
@@ -114,6 +253,27 @@ async function main(): Promise<void> {
const initialParameters = await fetchCouchDbDocument(couchDb, dbName, DOCID_SYNC_PARAMETERS); const initialParameters = await fetchCouchDbDocument(couchDb, dbName, DOCID_SYNC_PARAMETERS);
// Populate the HTTP cache as an earlier plug-in version would have done. // Populate the HTTP cache as an earlier plug-in version would have done.
assert.deepEqual(await readCachedDocument(original._id, "reload"), original); assert.deepEqual(await readCachedDocument(original._id, "reload"), original);
await observeCommonlibRequests();
const initialRead = await readCommonlibDocument(original._id);
assertLogicalDocument(initialRead.document, original);
const initialMetadataRequest = metadataRequest(initialRead, original._id);
const initialEpoch = new URL(initialMetadataRequest.url).searchParams.get("_livesync_epoch");
assert.ok(initialEpoch, "The ordinary Metadata read did not include a Seed cache namespace.");
assert.match(initialEpoch, /^[0-9a-f]{64}$/, "The URL must contain only the combined hash.");
await setHeadersOnlyThroughUI(true, false);
const compatibilityRead = await readCommonlibDocument(original._id);
assertLogicalDocument(compatibilityRead.document, original);
const compatibilityRequest = metadataRequest(compatibilityRead, original._id);
assert.equal(new URL(compatibilityRequest.url).searchParams.has("_livesync_epoch"), false);
assert.equal(compatibilityRequest.cache, "no-store");
await setHeadersOnlyThroughUI(false, true);
const restoredRead = await readCommonlibDocument(original._id);
assertLogicalDocument(restoredRead.document, original);
const restoredRequest = metadataRequest(restoredRead, original._id);
assert.equal(new URL(restoredRequest.url).searchParams.get("_livesync_epoch"), initialEpoch);
assert.equal(restoredRequest.cache, "no-cache");
await evaluate(`await core.services.setting.applyPartial({encryptInternalMetadata:true},true); await evaluate(`await core.services.setting.applyPartial({encryptInternalMetadata:true},true);
await core.services.control.applySettings(); await core.services.control.applySettings();
@@ -138,6 +298,17 @@ async function main(): Promise<void> {
"The stale browser HTTP cache fixture is no longer present." "The stale browser HTTP cache fixture is no longer present."
); );
} }
const rebuiltRead = await readCommonlibDocument(original._id);
assertLogicalDocument(rebuiltRead.document, original);
assert.deepEqual(
rebuiltRead.document.children,
initialRead.document.children,
"The logical file content references changed during Rebuild."
);
const rebuiltMetadataRequest = metadataRequest(rebuiltRead, original._id);
const rebuiltEpoch = new URL(rebuiltMetadataRequest.url).searchParams.get("_livesync_epoch");
assert.ok(rebuiltEpoch, "The post-Rebuild Metadata read did not include a Seed cache namespace.");
assert.notEqual(rebuiltEpoch, initialEpoch, "The cache namespace did not change with the Security Seed.");
await evaluate(`await core.services.setting.applyPartial({usePluginSync:true,syncInternalFiles:true},true); await evaluate(`await core.services.setting.applyPartial({usePluginSync:true,syncInternalFiles:true},true);
await core.services.control.applySettings();return JSON.stringify(true);`); await core.services.control.applySettings();return JSON.stringify(true);`);
@@ -148,13 +319,229 @@ async function main(): Promise<void> {
if(opened)await opened.close();return JSON.stringify({admitted:!!opened}); if(opened)await opened.close();return JSON.stringify({admitted:!!opened});
}catch(error){return JSON.stringify({admitted:false,error:error.name});}`); }catch(error){return JSON.stringify({admitted:false,error:error.name});}`);
assert.ok(admission.admitted, `Replication admission failed: ${JSON.stringify(admission)}`); assert.ok(admission.admitted, `Replication admission failed: ${JSON.stringify(admission)}`);
assert.equal((await readCachedDocument(original._id, "no-store")).path, rebuilt.path); const repeatedRead = await readCommonlibDocument(original._id);
assertLogicalDocument(repeatedRead.document, original);
assert.deepEqual(
repeatedRead.document.children,
initialRead.document.children,
"The logical file content references changed after replication admission."
);
const repeatedMetadataRequest = metadataRequest(repeatedRead, original._id);
const repeatedEpoch = new URL(repeatedMetadataRequest.url).searchParams.get("_livesync_epoch");
assert.equal(
repeatedEpoch,
rebuiltEpoch,
"A new connection at the same Seed did not reuse its cache namespace."
);
await pushLocalChanges(cliBinary, session.cliEnv); await pushLocalChanges(cliBinary, session.cliEnv);
await pushLocalChanges(cliBinary, session.cliEnv); await pushLocalChanges(cliBinary, session.cliEnv);
// Include Chunk bodies for strict reconciliation after replacing the local database.
await evaluate(
`await core.services.setting.applyPartial({readChunksOnline:false},true);return JSON.stringify(true);`
);
const fetchAttempt = await evaluate<{ succeeded: boolean; error?: string; diagnostics?: unknown }>(`try {
await core.rebuilder.fetchLocal(false,true);return JSON.stringify({succeeded:true});
} catch(error) {
await core.services.API.showWindow('log-log');
await new Promise(resolve=>setTimeout(resolve,100));
const log=Array.from(document.querySelectorAll('.logpane .log pre')).map(e=>e.textContent??'').join('\\n').slice(-16000);
return JSON.stringify({succeeded:false,error:String(error),diagnostics:{
databaseReady:core.services.database.isDatabaseReady(),appReady:core.services.appLifecycle.isReady(),
unresolvedMessages:(await core.services.appLifecycle.getUnresolvedMessages()).flat(),log}});
}`);
assert.ok(fetchAttempt.succeeded, `Standard Fetch failed: ${JSON.stringify(fetchAttempt)}`);
await waitForLiveSyncCoreReady(cliBinary, session.cliEnv);
const fetchedRead = await readCommonlibDocument(original._id);
assertLogicalDocument(fetchedRead.document, original);
assert.deepEqual(fetchedRead.document.children, initialRead.document.children);
assert.equal(
new URL(metadataRequest(fetchedRead, original._id).url).searchParams.get("_livesync_epoch"),
rebuiltEpoch
);
assert.equal(await readFile(join(vault.path, ordinaryPath), "utf8"), ordinaryContents);
await pushLocalChanges(cliBinary, session.cliEnv);
const remoteBeforeRestart = await fetchCouchDbDocument(couchDb, dbName, original._id);
const seedBeforeRestart = await fetchCouchDbDocument(couchDb, dbName, DOCID_SYNC_PARAMETERS);
assert.equal(remoteBeforeRestart._rev, rebuilt._rev, "The Metadata revision changed before restart.");
assert.equal(remoteBeforeRestart.path, rebuilt.path, "The remote Metadata ciphertext changed before restart.");
assert.equal(
seedBeforeRestart.pbkdf2salt,
rebuiltParameters.pbkdf2salt,
"The Security Seed changed before restart."
);
const stateBeforeRestart = await readRestartState();
assert.equal(stateBeforeRestart.settings.useCouchDBCacheControlHeadersOnly, false);
assert.equal(stateBeforeRestart.settings.couchDB_DBNAME, dbName);
assert.equal(stateBeforeRestart.settings.deviceAndVaultName, "http-cache-source");
assert.equal(stateBeforeRestart.settings.encrypt, true);
assert.equal(stateBeforeRestart.settings.encryptInternalMetadata, true);
assert.equal(stateBeforeRestart.settings.usePathObfuscation, true);
assert.equal(stateBeforeRestart.localMetadata?.path, ordinaryPath);
assert.ok(stateBeforeRestart.nodeId, "The device identity was not persisted before restart.");
const previousUnixSecond = Math.floor(Date.now() / 1000);
await restoreCommonlibRequests();
if (!session) throw new Error("No active Obsidian session to stop.");
await session.app.stop();
session = undefined;
await waitForNextUnixSecond(previousUnixSecond);
// Reuse the same Vault and isolated profile. Do not reseed settings or local device state.
session = await startObsidianLiveSyncSession({
binary,
cliBinary,
vault,
artifactRoot: resolve(process.env.E2E_OBSIDIAN_ARTIFACT_ROOT ?? "."),
pluginStartup: "natural",
});
await waitForLiveSyncCoreReady(cliBinary, session.cliEnv);
const stateAfterRestart = await readRestartState();
assert.deepEqual(stateAfterRestart.settings, stateBeforeRestart.settings);
assert.equal(stateAfterRestart.localDatabaseName, stateBeforeRestart.localDatabaseName);
assert.deepEqual(stateAfterRestart.localMetadata, stateBeforeRestart.localMetadata);
assert.equal(stateAfterRestart.nodeId, stateBeforeRestart.nodeId, "Restart changed the persisted device identity.");
const remoteAfterRestart = await fetchCouchDbDocument(couchDb, dbName, original._id);
const seedAfterRestart = await fetchCouchDbDocument(couchDb, dbName, DOCID_SYNC_PARAMETERS);
assert.equal(remoteAfterRestart._rev, remoteBeforeRestart._rev, "Restart changed the remote Metadata revision.");
assert.equal(
remoteAfterRestart.path,
remoteBeforeRestart.path,
"Restart changed the remote Metadata ciphertext."
);
assert.equal(seedAfterRestart.pbkdf2salt, seedBeforeRestart.pbkdf2salt, "Restart changed the Security Seed.");
assert.equal(await readFile(join(vault.path, ordinaryPath), "utf8"), ordinaryContents);
if (!useRequestAPI) {
assert.equal(
(await readCachedDocument(original._id, "default")).path,
original.path,
"The isolated browser HTTP cache did not survive the application restart."
);
}
await observeCommonlibRequests();
const restartedRead = await readCommonlibDocument(original._id);
assertLogicalDocument(restartedRead.document, original);
assert.deepEqual(restartedRead.document.children, initialRead.document.children);
const restartedMetadataRequest = metadataRequest(restartedRead, original._id);
const restartedEpoch = new URL(restartedMetadataRequest.url).searchParams.get("_livesync_epoch");
assert.ok(restartedEpoch, "The restarted Metadata read did not include a cache namespace.");
assert.match(restartedEpoch, /^[0-9a-f]{64}$/, "The restarted URL must contain only the combined hash.");
assert.notEqual(
restartedEpoch,
rebuiltEpoch,
"A full application restart reused its earlier non-compatibility cache namespace."
);
assert.equal(restartedMetadataRequest.cache, "no-cache");
await evaluate("await core.services.setting.applyPartial({readChunksOnline:false},true);return JSON.stringify(true);");
const restartedFetchAttempt = await evaluate<{ succeeded: boolean; error?: string }>([
"try{await core.rebuilder.fetchLocal(false,true);return JSON.stringify({succeeded:true});}",
"catch(error){return JSON.stringify({succeeded:false,error:String(error)});}",
].join(""));
assert.ok(
restartedFetchAttempt.succeeded,
`Standard Fetch after restart failed: ${JSON.stringify(restartedFetchAttempt)}`
);
await waitForLiveSyncCoreReady(cliBinary, session.cliEnv);
const afterRestartFetch = await readCommonlibDocument(original._id);
assertLogicalDocument(afterRestartFetch.document, original);
assert.deepEqual(afterRestartFetch.document.children, initialRead.document.children);
assert.equal(
new URL(metadataRequest(afterRestartFetch, original._id).url).searchParams.get("_livesync_epoch"),
restartedEpoch,
"Standard Fetch changed the restarted cache namespace."
);
assert.equal(await readFile(join(vault.path, ordinaryPath), "utf8"), ordinaryContents);
const remoteAfterRestartFetch = await fetchCouchDbDocument(couchDb, dbName, original._id);
const seedAfterRestartFetch = await fetchCouchDbDocument(couchDb, dbName, DOCID_SYNC_PARAMETERS);
assert.equal(remoteAfterRestartFetch._rev, remoteBeforeRestart._rev);
assert.equal(remoteAfterRestartFetch.path, remoteBeforeRestart.path);
assert.equal(seedAfterRestartFetch.pbkdf2salt, seedBeforeRestart.pbkdf2salt);
await writeFile(join(vault.path, restartNotePath), restartNoteContents);
const restartNoteEntry = await waitForLocalDatabaseEntry(cliBinary, session.cliEnv, restartNotePath);
assert.equal(restartNoteEntry.path, restartNotePath);
await pushLocalChanges(cliBinary, session.cliEnv);
const uploadedRestartNote = await readCommonlibDocument(restartNoteEntry.id);
assert.equal(uploadedRestartNote.document.path, restartNotePath);
assert.equal(uploadedRestartNote.document.size, Buffer.byteLength(restartNoteContents));
assert.ok(
Array.isArray(uploadedRestartNote.document.children) && uploadedRestartNote.document.children.length > 0
);
assert.equal(
new URL(metadataRequest(uploadedRestartNote, restartNoteEntry.id).url).searchParams.get("_livesync_epoch"),
restartedEpoch,
"Subsequent synchronisation did not use the restarted cache namespace."
);
assert.equal(await readFile(join(vault.path, restartNotePath), "utf8"), restartNoteContents);
const originalAfterRestartSync = await fetchCouchDbDocument(couchDb, dbName, original._id);
assert.equal(originalAfterRestartSync._rev, remoteBeforeRestart._rev);
assert.equal(originalAfterRestartSync.path, remoteBeforeRestart.path);
const uploadedRestartNoteRemote = await fetchCouchDbDocument(couchDb, dbName, restartNoteEntry.id);
await evaluate("await core.services.setting.applyPartial({readChunksOnline:false},true);return JSON.stringify(true);");
const uploadVerificationFetch = await evaluate<{ succeeded: boolean; error?: string }>([
"try{await core.rebuilder.fetchLocal(false,true);return JSON.stringify({succeeded:true});}",
"catch(error){return JSON.stringify({succeeded:false,error:String(error)});}",
].join(""));
assert.ok(
uploadVerificationFetch.succeeded,
`Standard Fetch after the upload failed: ${JSON.stringify(uploadVerificationFetch)}`
);
await waitForLiveSyncCoreReady(cliBinary, session.cliEnv);
const fetchedRestartNoteEntry = await waitForLocalDatabaseEntry(cliBinary, session.cliEnv, restartNotePath);
assert.equal(fetchedRestartNoteEntry.id, restartNoteEntry.id);
assert.equal(fetchedRestartNoteEntry.rev, uploadedRestartNote.document._rev);
assert.deepEqual(fetchedRestartNoteEntry.children, uploadedRestartNote.document.children);
const fetchedRestartNoteBody = await evaluate<string>([
"const file=await core.serviceModules.databaseFileAccess.fetch(" + JSON.stringify(restartNotePath) + ");",
"if(!file||file.deleted||!file.body)throw new Error('The uploaded note was not readable from the replaced local database.');",
"return JSON.stringify(await file.body.text());",
].join(""));
assert.equal(
fetchedRestartNoteBody,
restartNoteContents,
"The replaced local database did not return the exact uploaded Chunk content."
);
const fetchedRestartNote = await readCommonlibDocument(restartNoteEntry.id);
assert.equal(fetchedRestartNote.document.path, restartNotePath);
assert.equal(fetchedRestartNote.document.size, Buffer.byteLength(restartNoteContents));
assert.equal(fetchedRestartNote.document._rev, uploadedRestartNote.document._rev);
assert.deepEqual(fetchedRestartNote.document.children, uploadedRestartNote.document.children);
assert.equal(
new URL(metadataRequest(fetchedRestartNote, restartNoteEntry.id).url).searchParams.get("_livesync_epoch"),
restartedEpoch,
"Standard Fetch after the upload changed the restarted cache namespace."
);
assert.equal(await readFile(join(vault.path, restartNotePath), "utf8"), restartNoteContents);
assert.equal(await readFile(join(vault.path, ordinaryPath), "utf8"), ordinaryContents);
const restartNoteAfterFetch = await fetchCouchDbDocument(couchDb, dbName, restartNoteEntry.id);
assert.equal(restartNoteAfterFetch._rev, uploadedRestartNoteRemote._rev);
assert.equal(restartNoteAfterFetch.path, uploadedRestartNoteRemote.path);
const originalAfterUploadFetch = await fetchCouchDbDocument(couchDb, dbName, original._id);
const seedAfterUploadFetch = await fetchCouchDbDocument(couchDb, dbName, DOCID_SYNC_PARAMETERS);
assert.equal(originalAfterUploadFetch._rev, remoteBeforeRestart._rev);
assert.equal(originalAfterUploadFetch.path, remoteBeforeRestart.path);
assert.equal(seedAfterUploadFetch.pbkdf2salt, seedBeforeRestart.pbkdf2salt);
await restoreCommonlibRequests();
console.log( console.log(
`Rebuild and subsequent replication succeeded after warming the ${useRequestAPI ? "Internal API" : "browser"} HTTP cache.` `Cache compatibility switch persistence, Rebuild, Standard Fetch, and subsequent replication succeeded with the ${useRequestAPI ? "Internal API" : "browser"} HTTP cache.`
);
console.log(
`Full application restart on the same Vault and profile retained device identity, ` +
`changed the cache namespace, and passed post-restart Fetch and upload (${useRequestAPI ? "Internal API" : "browser"}).`
); );
} finally { } finally {
if (observingRequests && session) {
try {
await restoreCommonlibRequests();
} catch {
// The isolated Obsidian process is stopped immediately below.
}
}
await session?.app.stop(); await session?.app.stop();
await vault.dispose(); await vault.dispose();
await deleteCouchDbDatabase(couchDb, dbName); await deleteCouchDbDatabase(couchDb, dbName);
+6
View File
@@ -24,6 +24,12 @@ Earlier releases remain available in the 1.0 release history, the 1.0 preview hi
- If a Journal cannot be recovered and missing content or history is acceptable, **Maintenance → Syncing → Skip stopped Journal and resume** asks for confirmation of its exact key and failure stage, then skips only that Journal and resumes receipt. The next Journal failure still stops replication. The action does not add a persistent ignore setting. - If a Journal cannot be recovered and missing content or history is acceptable, **Maintenance → Syncing → Skip stopped Journal and resume** asks for confirmation of its exact key and failure stage, then skips only that Journal and resumes receipt. The next Journal failure still stops replication. The action does not add a persistent ignore setting.
- **Reset journal received history** replays Journals which remain available remotely, except those sent by this device. It cannot recreate missing remote Journals; earlier failures already silently acknowledged also require this explicit replay. - **Reset journal received history** replays Journals which remain available remotely, except those sent by this device. It cannot recreate missing remote Journals; earlier failures already silently acknowledged also require this explicit replay.
#### Synchronisation
- We can synchronise and Fetch an encrypted CouchDB remote when the Internal API retains responses from before a Rebuild. (#1234)
- Metadata and Chunk reads use a cache URL derived from the startup time and Security Seed together. The URL remains stable within the same startup and Seed.
- The advanced CouchDB setting **Use headers only for HTTP cache control (compatibility)** is disabled by default. Enable it only if your server or proxy rejects the additional query parameter; affected native caches may then reuse stale encrypted responses after Rebuild.
#### Conflict resolution #### Conflict resolution
- Disabling or reloading the plug-in no longer causes a secondary error when pending work writes to the log. Logs arriving after the log display closes go to Obsidian's console. - Disabling or reloading the plug-in no longer causes a secondary error when pending work writes to the log. Logs arriving after the log display closes go to Obsidian's console.