5e63db575b
Closes the architecture item from the #119 review: drop the "vendored from docmost-sync" framing and the CJS↔ESM `Function('import()')` bridge so the engine is a normal first-class gitmost package. Part 1 — vendoring markers removed (prose only, zero behavior change): reworded "VENDORED into gitmost" / "vendored from docmost-sync" / "Engine LOGIC is byte-identical" / "it's a port" comments across the engine. Behavior-bearing strings are untouched: BOT_AUTHOR_NAME/EMAIL and the `Docmost-Sync-Source:` provenance trailers (changing them would break git authorship + the loop-guard). Part 2 — the package is now ESM (matching the sibling @docmost/mcp): `type: module`, tsconfig Node16, `.js` extensions on relative imports, and a static `import { marked }` replacing the `new Function('return import(...)')` / `loadMarked` hack — the bridge is GONE from the package. The CommonJS NestJS server loads the now-ESM engine via a new `git-sync.loader.ts` that mirrors the existing `docmost-client.loader.ts` mcp loader exactly (Function-indirected dynamic import + cached promise + retry-on-reject). The 4 server consumers (orchestrator/datasource/vault-registry/git-http-backend) call `await loadGitSync()` for value exports; types stay `import type` (erased). The converter-gate spec — which needs the real converter — loads the package's TS source via a jest moduleNameMapper + isolatedModules (documented in that spec); the other git-sync specs mock the loader. Verified: engine builds pure ESM (no Function/require leftover), vitest 614, editor-ext build, server + client tsc, full server jest 1397/0. Live stand smoke-test: server starts clean on the ESM engine (no ERR_REQUIRE_ESM), a real sync cycle runs through the loader, and the basic e2e suite is 12/12 (clone via git-http-backend, push, pull, delete, 3-way merge — all through the new loader). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
60 lines
2.2 KiB
TypeScript
60 lines
2.2 KiB
TypeScript
import { pathToFileURL } from 'node:url';
|
|
import type {
|
|
VaultGit as VaultGitClass,
|
|
vaultGitEnv as vaultGitEnvFn,
|
|
runCycle as runCycleFn,
|
|
parseDocmostMarkdown as parseDocmostMarkdownFn,
|
|
markdownToProseMirror as markdownToProseMirrorFn,
|
|
} from '@docmost/git-sync';
|
|
|
|
/**
|
|
* Runtime value-export surface of the ESM-only `@docmost/git-sync` package that
|
|
* the server consumes. Types are imported with `import type` (erased at compile,
|
|
* no runtime require); only the VALUE exports below need the dynamic-load
|
|
* treatment so a CJS `require()` of the ESM package never happens.
|
|
*/
|
|
interface GitSyncModule {
|
|
VaultGit: typeof VaultGitClass;
|
|
vaultGitEnv: typeof vaultGitEnvFn;
|
|
runCycle: typeof runCycleFn;
|
|
parseDocmostMarkdown: typeof parseDocmostMarkdownFn;
|
|
markdownToProseMirror: typeof markdownToProseMirrorFn;
|
|
}
|
|
|
|
// TS with module:commonjs downlevels a literal `import()` to `require()`, which
|
|
// cannot load the ESM-only `@docmost/git-sync` package. Indirect through
|
|
// Function so the real dynamic `import()` survives compilation and can load ESM
|
|
// from CommonJS at runtime (same trick as
|
|
// apps/server/src/core/ai-chat/tools/docmost-client.loader.ts and
|
|
// integrations/mcp/mcp.service.ts).
|
|
const esmImport = new Function(
|
|
'specifier',
|
|
'return import(specifier)',
|
|
) as (specifier: string) => Promise<unknown>;
|
|
|
|
// Memoize the in-flight/loaded module so the dynamic import runs at most once.
|
|
let modulePromise: Promise<GitSyncModule> | null = null;
|
|
|
|
/**
|
|
* Lazily load the ESM-only `@docmost/git-sync` package (cached). Resolves the
|
|
* package entry to an absolute path, then imports it as a `file://` URL so the
|
|
* package "exports" map is honoured without bare-specifier resolution-base
|
|
* fragility.
|
|
*/
|
|
export async function loadGitSync(): Promise<GitSyncModule> {
|
|
if (!modulePromise) {
|
|
modulePromise = (async () => {
|
|
const entry = require.resolve('@docmost/git-sync');
|
|
const mod = (await esmImport(
|
|
pathToFileURL(entry).href,
|
|
)) as GitSyncModule;
|
|
return mod;
|
|
})().catch((err) => {
|
|
// Do not cache a rejected import — allow the next call to retry.
|
|
modulePromise = null;
|
|
throw err;
|
|
});
|
|
}
|
|
return modulePromise;
|
|
}
|