Skip to content

feat(yhub): migrate versioning client to upstream yhub API #2979

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nperez0111 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(yhub): migrate versioning client to upstream yhub API #2979

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions examples/07-collaboration/13-versioning-yjs14/src/App.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ const DAY_MS = 24 * 60 * 60 * 1000;
// fields fresh on each call, so writing new values here + re-running `list()`
// reshapes the history sidebar against the same document, no editor recreation.
const versioningOptions = {
baseUrl: `https://${yhubHost}`,
baseUrl: `https://${yhubHost}/api`,
org,
docId,
// The seeded history has a few hundred edits; a high limit lets the sidebar
Expand Down Expand Up @@ -108,7 +108,7 @@ const formatMs = (ms: number) => {

const doc = new Y.Doc();
const provider = new WebsocketProvider(
`wss://${yhubHost}/ws`,
`wss://${yhubHost}/api/ws/v1`,
`${org}/${docId}`,
doc,
{
Expand All @@ -128,7 +128,7 @@ const preparePromise: Promise<void> = (async () => {
if (!(doc.get("bn").length > 0)) {
provider.disconnect();
await seedSampleVersions({
baseUrl: `https://${yhubHost}`,
baseUrl: `https://${yhubHost}/api`,
org,
docId,
fragment: "bn",
Expand Down
4 changes: 2 additions & 2 deletions examples/07-collaboration/13-versioning-yjs14/src/seed.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ function makeVersionMarkerUpdate(): Uint8Array {
* Pre-populate a YHub document with content **and** version history from a
* {@link buildEditHistory} result, without a live editor / sync connection.
*
* Each step's captured transactions are PATCHed to `/ydoc/{org}/{docId}` as a
* Each step's captured transactions are PATCHed to `/api/ydoc/v1/{org}/{docId}` as a
* single ordered `patches` bulk request: one content patch per captured
* transaction (attributed via `by`, **no** version marker), followed by one
* marker patch carrying a `type:version` custom attribution — the same marker
Expand Down Expand Up @@ -98,7 +98,7 @@ export async function seedYHubDocument(
build: SeedableBuild,
): Promise<SeededVersion[]> {
const { baseUrl, org, docId, headers = {} } = options;
const url = `${baseUrl}/ydoc/${org}/${docId}`;
const url = `${baseUrl}/ydoc/v1/${org}/${docId}`;

const send = async (body: Record<string, unknown>) => {
const res = await fetch(url, {
Expand Down
151 changes: 92 additions & 59 deletions packages/core/src/y/versioning/__test__/yhub.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,15 +66,12 @@ const SNAPSHOT_2: VersionSnapshot = {

const PATCH_RESPONSE = { success: true, message: "Document updated" };

function makeChangeset(
opts: { nextDoc?: boolean; attributions?: boolean } = {},
) {
function makeChangeset(opts: { ydoc?: boolean; attributions?: boolean } = {}) {
const doc = new Y.Doc();
const frag = doc.get("default", "XmlFragment");
frag.insert(0, ["hello"]);
return {
prevDoc: Y.encodeStateAsUpdate(new Y.Doc()),
...(opts.nextDoc !== false ? { nextDoc: Y.encodeStateAsUpdate(doc) } : {}),
...(opts.ydoc !== false ? { ydoc: Y.encodeStateAsUpdate(doc) } : {}),
...(opts.attributions ? { attributions: new Uint8Array([0]) } : {}),
};
}
Expand All @@ -83,7 +80,7 @@ function makeChangeset(
// Helpers
// ---------------------------------------------------------------------------

const BASE_URL = "https://yhub.test";
const BASE_URL = "https://yhub.test/api";
const ORG = "test-org";
const DOC_ID = "test-doc";

Expand Down Expand Up @@ -162,13 +159,17 @@ describe("createYHubVersioningEndpoints", () => {
describe("list", () => {
it("returns version-tagged entries using the id attribution as snapshot id", async () => {
fetchSpy.mockResolvedValueOnce(
mockFetchResponse([VERSION_ENTRY_2, VERSION_ENTRY_1]),
mockFetchResponse({ activity: [VERSION_ENTRY_2, VERSION_ENTRY_1] }),
);
// Current-version probe: latest edit of any kind, then latest version
// marker. Both are VERSION_ENTRY_2, so latest edit == latest marker → no
// synthetic "current version" entry.
fetchSpy.mockResolvedValueOnce(mockFetchResponse([VERSION_ENTRY_2]));
fetchSpy.mockResolvedValueOnce(mockFetchResponse([VERSION_ENTRY_2]));
fetchSpy.mockResolvedValueOnce(
mockFetchResponse({ activity: [VERSION_ENTRY_2] }),
);
fetchSpy.mockResolvedValueOnce(
mockFetchResponse({ activity: [VERSION_ENTRY_2] }),
);

const endpoints = makeEndpoints();
const snapshots = await endpoints.list();
Expand All @@ -188,16 +189,16 @@ describe("createYHubVersioningEndpoints", () => {
it("fetches the full activity timeline (no type:version filter) with grouping defaults", async () => {
// 1: full activity timeline. 2: latest edit of any kind. 3: latest
// version marker (the current-version probe makes both 2 & 3).
fetchSpy.mockResolvedValueOnce(mockFetchResponse([]));
fetchSpy.mockResolvedValueOnce(mockFetchResponse([]));
fetchSpy.mockResolvedValueOnce(mockFetchResponse([]));
fetchSpy.mockResolvedValueOnce(mockFetchResponse({ activity: [] }));
fetchSpy.mockResolvedValueOnce(mockFetchResponse({ activity: [] }));
fetchSpy.mockResolvedValueOnce(mockFetchResponse({ activity: [] }));

const endpoints = makeEndpoints();
await endpoints.list();

expect(fetchSpy).toHaveBeenCalledTimes(3);
const versionUrl = new URL(fetchSpy.mock.calls[0][0] as string);
expect(versionUrl.pathname).toBe(`/activity/${ORG}/${DOC_ID}`);
expect(versionUrl.pathname).toBe(`/api/activity/v1/${ORG}/${DOC_ID}`);
// The `type:version` overlay filter is dropped so history entries are
// returned too.
expect(versionUrl.searchParams.get("withCustomAttributions")).toBe(null);
Expand All @@ -207,24 +208,24 @@ describe("createYHubVersioningEndpoints", () => {

// Probe A: the latest entry of *any* type (no marker filter).
const latestUrl = new URL(fetchSpy.mock.calls[1][0] as string);
expect(latestUrl.pathname).toBe(`/activity/${ORG}/${DOC_ID}`);
expect(latestUrl.pathname).toBe(`/api/activity/v1/${ORG}/${DOC_ID}`);
expect(latestUrl.searchParams.get("limit")).toBe("1");
expect(latestUrl.searchParams.has("withCustomAttributions")).toBe(false);

// Probe B: the latest *version marker*, server-filtered to `type:version`
// so grouping/mergeUsers can't conflate it with a later edit.
const markerUrl = new URL(fetchSpy.mock.calls[2][0] as string);
expect(markerUrl.pathname).toBe(`/activity/${ORG}/${DOC_ID}`);
expect(markerUrl.pathname).toBe(`/api/activity/v1/${ORG}/${DOC_ID}`);
expect(markerUrl.searchParams.get("limit")).toBe("1");
expect(markerUrl.searchParams.get("withCustomAttributions")).toBe(
"type:version",
);
});

it("forwards group + groupMaxDuration params when configured", async () => {
fetchSpy.mockResolvedValueOnce(mockFetchResponse([]));
fetchSpy.mockResolvedValueOnce(mockFetchResponse([]));
fetchSpy.mockResolvedValueOnce(mockFetchResponse([]));
fetchSpy.mockResolvedValueOnce(mockFetchResponse({ activity: [] }));
fetchSpy.mockResolvedValueOnce(mockFetchResponse({ activity: [] }));
fetchSpy.mockResolvedValueOnce(mockFetchResponse({ activity: [] }));

const endpoints = createYHubVersioningEndpoints({
baseUrl: BASE_URL,
Expand All @@ -242,9 +243,9 @@ describe("createYHubVersioningEndpoints", () => {
});

it("omits group params by default while keeping the groupMaxGap default", async () => {
fetchSpy.mockResolvedValueOnce(mockFetchResponse([]));
fetchSpy.mockResolvedValueOnce(mockFetchResponse([]));
fetchSpy.mockResolvedValueOnce(mockFetchResponse([]));
fetchSpy.mockResolvedValueOnce(mockFetchResponse({ activity: [] }));
fetchSpy.mockResolvedValueOnce(mockFetchResponse({ activity: [] }));
fetchSpy.mockResolvedValueOnce(mockFetchResponse({ activity: [] }));

// `makeEndpoints` builds the factory with no group/groupMaxDuration opts.
const endpoints = makeEndpoints();
Expand Down Expand Up @@ -275,12 +276,16 @@ describe("createYHubVersioningEndpoints", () => {
by: "user-2",
};
fetchSpy.mockResolvedValueOnce(
mockFetchResponse([namedEntry, historyEntry]),
mockFetchResponse({ activity: [namedEntry, historyEntry] }),
);
// Current-version probe: latest edit == latest marker == `namedEntry`, so
// no synthetic current row.
fetchSpy.mockResolvedValueOnce(mockFetchResponse([namedEntry]));
fetchSpy.mockResolvedValueOnce(mockFetchResponse([namedEntry]));
fetchSpy.mockResolvedValueOnce(
mockFetchResponse({ activity: [namedEntry] }),
);
fetchSpy.mockResolvedValueOnce(
mockFetchResponse({ activity: [namedEntry] }),
);

const endpoints = makeEndpoints();
const snapshots = await endpoints.list();
Expand All @@ -297,9 +302,9 @@ describe("createYHubVersioningEndpoints", () => {
});

it("returns empty array when no versions exist", async () => {
fetchSpy.mockResolvedValueOnce(mockFetchResponse([]));
fetchSpy.mockResolvedValueOnce(mockFetchResponse([]));
fetchSpy.mockResolvedValueOnce(mockFetchResponse([]));
fetchSpy.mockResolvedValueOnce(mockFetchResponse({ activity: [] }));
fetchSpy.mockResolvedValueOnce(mockFetchResponse({ activity: [] }));
fetchSpy.mockResolvedValueOnce(mockFetchResponse({ activity: [] }));

const endpoints = makeEndpoints();
const snapshots = await endpoints.list();
Expand All @@ -309,10 +314,14 @@ describe("createYHubVersioningEndpoints", () => {

it("sorts snapshots newest-first", async () => {
fetchSpy.mockResolvedValueOnce(
mockFetchResponse([VERSION_ENTRY_1, VERSION_ENTRY_2]),
mockFetchResponse({ activity: [VERSION_ENTRY_1, VERSION_ENTRY_2] }),
);
fetchSpy.mockResolvedValueOnce(
mockFetchResponse({ activity: [VERSION_ENTRY_2] }),
);
fetchSpy.mockResolvedValueOnce(
mockFetchResponse({ activity: [VERSION_ENTRY_2] }),
);
fetchSpy.mockResolvedValueOnce(mockFetchResponse([VERSION_ENTRY_2]));
fetchSpy.mockResolvedValueOnce(mockFetchResponse([VERSION_ENTRY_2]));

const endpoints = makeEndpoints();
const snapshots = await endpoints.list();
Expand All @@ -328,10 +337,14 @@ describe("createYHubVersioningEndpoints", () => {
customAttributions: [{ k: "type", v: "version" }],
};
fetchSpy.mockResolvedValueOnce(
mockFetchResponse([VERSION_ENTRY_1, noIdEntry]),
mockFetchResponse({ activity: [VERSION_ENTRY_1, noIdEntry] }),
);
fetchSpy.mockResolvedValueOnce(
mockFetchResponse({ activity: [VERSION_ENTRY_1] }),
);
fetchSpy.mockResolvedValueOnce(
mockFetchResponse({ activity: [VERSION_ENTRY_1] }),
);
fetchSpy.mockResolvedValueOnce(mockFetchResponse([VERSION_ENTRY_1]));
fetchSpy.mockResolvedValueOnce(mockFetchResponse([VERSION_ENTRY_1]));

const endpoints = makeEndpoints();
const snapshots = await endpoints.list();
Expand Down Expand Up @@ -361,9 +374,15 @@ describe("createYHubVersioningEndpoints", () => {
};
// 1: activity fetch. 2 & 3: current-version probe (latest edit, latest
// marker) — same entry both times, so no newer edit and no current row.
fetchSpy.mockResolvedValueOnce(mockFetchResponse([versionEntry]));
fetchSpy.mockResolvedValueOnce(mockFetchResponse([versionEntry]));
fetchSpy.mockResolvedValueOnce(mockFetchResponse([versionEntry]));
fetchSpy.mockResolvedValueOnce(
mockFetchResponse({ activity: [versionEntry] }),
);
fetchSpy.mockResolvedValueOnce(
mockFetchResponse({ activity: [versionEntry] }),
);
fetchSpy.mockResolvedValueOnce(
mockFetchResponse({ activity: [versionEntry] }),
);

const snapshots = await endpoints.list();

Expand All @@ -373,9 +392,15 @@ describe("createYHubVersioningEndpoints", () => {
});

it("falls back to the attribution name when the store has no entry", async () => {
fetchSpy.mockResolvedValueOnce(mockFetchResponse([VERSION_ENTRY_1]));
fetchSpy.mockResolvedValueOnce(mockFetchResponse([VERSION_ENTRY_1]));
fetchSpy.mockResolvedValueOnce(mockFetchResponse([VERSION_ENTRY_1]));
fetchSpy.mockResolvedValueOnce(
mockFetchResponse({ activity: [VERSION_ENTRY_1] }),
);
fetchSpy.mockResolvedValueOnce(
mockFetchResponse({ activity: [VERSION_ENTRY_1] }),
);
fetchSpy.mockResolvedValueOnce(
mockFetchResponse({ activity: [VERSION_ENTRY_1] }),
);

const endpoints = makeEndpoints();
const snapshots = await endpoints.list();
Expand All @@ -395,10 +420,14 @@ describe("createYHubVersioningEndpoints", () => {
// version marker (VERSION_ENTRY_2). Since latestEdit.to > VERSION_ENTRY_2.to
// a synthetic current-version row is prepended.
fetchSpy.mockResolvedValueOnce(
mockFetchResponse([VERSION_ENTRY_2, VERSION_ENTRY_1]),
mockFetchResponse({ activity: [VERSION_ENTRY_2, VERSION_ENTRY_1] }),
);
fetchSpy.mockResolvedValueOnce(
mockFetchResponse({ activity: [latestEdit] }),
);
fetchSpy.mockResolvedValueOnce(
mockFetchResponse({ activity: [VERSION_ENTRY_2] }),
);
fetchSpy.mockResolvedValueOnce(mockFetchResponse([latestEdit]));
fetchSpy.mockResolvedValueOnce(mockFetchResponse([VERSION_ENTRY_2]));

const endpoints = makeEndpoints();
const snapshots = await endpoints.list();
Expand Down Expand Up @@ -427,12 +456,18 @@ describe("createYHubVersioningEndpoints", () => {
};
// 1: activity list — newest entry is the history edit, not a marker.
fetchSpy.mockResolvedValueOnce(
mockFetchResponse([historyEdit, VERSION_ENTRY_2, VERSION_ENTRY_1]),
mockFetchResponse({
activity: [historyEdit, VERSION_ENTRY_2, VERSION_ENTRY_1],
}),
);
// 2: latest edit of any kind → the history edit.
fetchSpy.mockResolvedValueOnce(mockFetchResponse([historyEdit]));
fetchSpy.mockResolvedValueOnce(
mockFetchResponse({ activity: [historyEdit] }),
);
// 3: latest version marker → VERSION_ENTRY_2 (older than the edit).
fetchSpy.mockResolvedValueOnce(mockFetchResponse([VERSION_ENTRY_2]));
fetchSpy.mockResolvedValueOnce(
mockFetchResponse({ activity: [VERSION_ENTRY_2] }),
);

const endpoints = makeEndpoints();
const snapshots = await endpoints.list();
Expand All @@ -443,9 +478,9 @@ describe("createYHubVersioningEndpoints", () => {
});

it("forwards the mergeUsers param when configured", async () => {
fetchSpy.mockResolvedValueOnce(mockFetchResponse([]));
fetchSpy.mockResolvedValueOnce(mockFetchResponse([]));
fetchSpy.mockResolvedValueOnce(mockFetchResponse([]));
fetchSpy.mockResolvedValueOnce(mockFetchResponse({ activity: [] }));
fetchSpy.mockResolvedValueOnce(mockFetchResponse({ activity: [] }));
fetchSpy.mockResolvedValueOnce(mockFetchResponse({ activity: [] }));

const endpoints = createYHubVersioningEndpoints({
baseUrl: BASE_URL,
Expand Down Expand Up @@ -475,7 +510,7 @@ describe("createYHubVersioningEndpoints", () => {
// Only one fetch call (PATCH) — no activity fetch
expect(fetchSpy).toHaveBeenCalledOnce();
const [patchUrl, patchInit] = fetchSpy.mock.calls[0];
expect(patchUrl).toBe(`${BASE_URL}/ydoc/${ORG}/${DOC_ID}`);
expect(patchUrl).toBe(`${BASE_URL}/ydoc/v1/${ORG}/${DOC_ID}`);
expect(patchInit.method).toBe("PATCH");
expect(patchInit.body).toBeInstanceOf(Uint8Array);

Expand Down Expand Up @@ -510,9 +545,9 @@ describe("createYHubVersioningEndpoints", () => {
});

expect(snapshot.by).toBe("user-1");
// The PATCH is attributed to the same user.
// The PATCH is attributed to the same user via the body, not query params.
const patchUrl = new URL(fetchSpy.mock.calls[0][0] as string);
expect(patchUrl.searchParams.get("userid")).toBe("user-1");
expect(patchUrl.searchParams.has("userid")).toBe(false);
});

it("creates a version without a name", async () => {
Expand Down Expand Up @@ -587,17 +622,15 @@ describe("createYHubVersioningEndpoints", () => {

// changeset reconstructed by timestamp, NOT by custom attribution
const url = new URL(fetchSpy.mock.calls[0][0] as string);
expect(url.pathname).toBe(`/changeset/${ORG}/${DOC_ID}`);
expect(url.pathname).toBe(`/api/changeset/v1/${ORG}/${DOC_ID}`);
expect(url.searchParams.get("ydoc")).toBe("true");
expect(url.searchParams.get("to")).toBe(String(SNAPSHOT_1.createdAt));
expect(url.searchParams.has("from")).toBe(false);
expect(url.searchParams.has("withCustomAttributions")).toBe(false);
});

it("throws when changeset has no nextDoc", async () => {
fetchSpy.mockResolvedValueOnce(
mockFetchResponse({ prevDoc: new Uint8Array() }),
);
it("throws when changeset has no ydoc", async () => {
fetchSpy.mockResolvedValueOnce(mockFetchResponse({}));

const endpoints = makeEndpoints();
await expect(endpoints.getContent(SNAPSHOT_1)).rejects.toThrow(
Expand Down Expand Up @@ -653,7 +686,7 @@ describe("createYHubVersioningEndpoints", () => {

// changeset without attributions
fetchSpy.mockResolvedValueOnce(
mockFetchResponse({ nextDoc: new Uint8Array() }),
mockFetchResponse({ ydoc: new Uint8Array() }),
);

await expect(endpoints.getAttributions!(SNAPSHOT_1)).rejects.toThrow(
Expand Down Expand Up @@ -682,12 +715,12 @@ describe("createYHubVersioningEndpoints", () => {

// 1st call: GET changeset by timestamp
const csUrl = new URL(fetchSpy.mock.calls[0][0] as string);
expect(csUrl.pathname).toBe(`/changeset/${ORG}/${DOC_ID}`);
expect(csUrl.pathname).toBe(`/api/changeset/v1/${ORG}/${DOC_ID}`);
expect(csUrl.searchParams.get("to")).toBe(String(SNAPSHOT_1.createdAt));

// 2nd call: POST rollback
const [rollbackUrl, rollbackInit] = fetchSpy.mock.calls[1];
expect(rollbackUrl).toContain(`/rollback/${ORG}/${DOC_ID}`);
expect(rollbackUrl).toBe(`${BASE_URL}/rollback/v1/${ORG}/${DOC_ID}`);
expect(rollbackInit.method).toBe("POST");

expect(content).toBeInstanceOf(Uint8Array);
Expand Down
Loading
Loading