/*! * Copyright (c) Microsoft Corporation and contributors. All rights reserved. * Licensed under the MIT License. */ import { assert } from "@fluidframework/core-utils/internal"; import type { IIdCompressor, SessionId } from "@fluidframework/id-compressor"; import type { IJsonCodec } from "../codec/index.js"; import type { ChangeEncodingContext, ChangeDecodingContext, EncodedRevisionTag, RevisionTag, SchemaAndPolicy, } from "../core/index.js"; import { copyProperty, mapIterable, type IdentifierHealingConfig, type JsonCompatibleReadOnly, type Mutable, } from "../util/index.js"; import { decodeBranchId, encodeBranchId } from "./branchIdCodec.js"; import { decodeCustomMetadataTree, encodeCustomMetadataTree } from "./customMetadataCodec.js"; import type { SharedBranchSummaryData } from "./editManager.js"; import type { Commit, EncodedCommit, EncodedSharedBranch, SequenceId, SequencedCommit, } from "./editManagerFormatCommons.js"; export interface EditManagerEncodingContext { idCompressor: IIdCompressor; readonly schema?: SchemaAndPolicy; /** * Returns whether a changeset contains a schema change. */ readonly hasSchemaChange: (change: TChangeset) => boolean; /** * See {@link ChangeEncodingContext.isSummary}. EditManager codec callers * always set this to `true` (the codec is only invoked for summaries), * but it is carried explicitly so downstream codecs can read it. */ readonly isSummary: boolean; } /** * Context required for decoding the {@link EditManager}'s {@link SummaryData}. * @remarks * Unlike {@link EditManagerEncodingContext}, this carries {@link IdentifierHealingConfig} (used only * on decode) and omits `schema` and `hasSchemaChange` (only consulted when encoding). */ export interface EditManagerDecodingContext { readonly idCompressor: IIdCompressor; readonly isSummary: boolean; /** See {@link IdentifierHealingConfig}. */ readonly healing?: IdentifierHealingConfig; } function encodeCommit>( changeCodec: IJsonCodec< TChangeset, JsonCompatibleReadOnly, JsonCompatibleReadOnly, ChangeEncodingContext >, revisionTagCodec: IJsonCodec< RevisionTag, EncodedRevisionTag, EncodedRevisionTag, ChangeEncodingContext >, commit: T, context: ChangeEncodingContext, includeCustomMetadata: boolean, ): Mutable> { const encoded: Mutable> = { change: changeCodec.encode(commit.change, { ...context, revision: commit.revision }), revision: revisionTagCodec.encode(commit.revision, { originatorId: commit.sessionId, idCompressor: context.idCompressor, revision: undefined, isSummary: context.isSummary, }), sessionId: commit.sessionId, }; if (includeCustomMetadata && commit.customMetadata !== undefined) { encoded.customMetadata = encodeCustomMetadataTree(commit.customMetadata); } return encoded; } // eslint-disable-next-line @typescript-eslint/explicit-function-return-type function decodeCommit>( changeCodec: IJsonCodec< TChangeset, JsonCompatibleReadOnly, JsonCompatibleReadOnly, ChangeEncodingContext >, revisionTagCodec: IJsonCodec< RevisionTag, EncodedRevisionTag, EncodedRevisionTag, ChangeEncodingContext >, commit: T, context: ChangeDecodingContext, ) { const revision = revisionTagCodec.decode(commit.revision, { originatorId: commit.sessionId, idCompressor: context.idCompressor, revision: undefined, isSummary: context.isSummary, }); return { sessionId: commit.sessionId, revision, change: changeCodec.decode(commit.change, { ...context, revision }), customMetadata: decodeCustomMetadataTree(commit.customMetadata), }; } export function encodeSharedBranch( changeCodec: IJsonCodec< TChangeset, JsonCompatibleReadOnly, JsonCompatibleReadOnly, ChangeEncodingContext >, revisionTagCodec: IJsonCodec< RevisionTag, EncodedRevisionTag, EncodedRevisionTag, ChangeEncodingContext >, data: SharedBranchSummaryData, context: EditManagerEncodingContext, originatorId: SessionId | undefined, includeCustomMetadata: boolean, ): EncodedSharedBranch { const json: Mutable> = { trunk: data.trunk.map((commit) => { const encoded = encodeCommit( changeCodec, revisionTagCodec, commit, { originatorId: commit.sessionId, idCompressor: context.idCompressor, schema: context.schema, revision: undefined, isSummary: context.isSummary, }, includeCustomMetadata, ); copyProperty(commit, "sequenceNumber", encoded); copyProperty(commit, "indexInBatch", encoded); return encoded; }), peers: Array.from(data.peerLocalBranches.entries(), ([sessionId, branch]) => { // A peer's schema change may be rejected on the trunk while its original commits remain here. // Without schema changes, peer data remains compatible with the trunk's schema upgrades. // Otherwise, omit the inherited schema; the change codec can still use schemas within a commit. const schema = branch.commits.some((commit) => context.hasSchemaChange(commit.change)) ? undefined : context.schema; return [ sessionId, { base: revisionTagCodec.encode(branch.base, { originatorId: sessionId, idCompressor: context.idCompressor, revision: undefined, isSummary: context.isSummary, }), commits: branch.commits.map((commit) => encodeCommit( changeCodec, revisionTagCodec, commit, { originatorId: commit.sessionId, idCompressor: context.idCompressor, schema, revision: undefined, isSummary: context.isSummary, }, includeCustomMetadata, ), ), }, ]; }), }; if (data.session !== undefined) { json.session = data.session; } if (data.id !== undefined) { json.id = encodeBranchId(context.idCompressor, data.id); } if (data.name !== undefined) { json.name = data.name; } if (data.author !== undefined) { json.author = data.author; } if (data.base !== undefined) { assert( originatorId !== undefined, 0xc62 /* Cannot encode branch base without originatorId */, ); json.base = revisionTagCodec.encode(data.base, { originatorId, idCompressor: context.idCompressor, revision: undefined, isSummary: context.isSummary, }); } return json; } export function decodeSharedBranch( changeCodec: IJsonCodec< TChangeset, JsonCompatibleReadOnly, JsonCompatibleReadOnly, ChangeEncodingContext >, revisionTagCodec: IJsonCodec< RevisionTag, EncodedRevisionTag, EncodedRevisionTag, ChangeEncodingContext >, json: EncodedSharedBranch, context: EditManagerDecodingContext, originatorId: SessionId | undefined, ): SharedBranchSummaryData { const trunk = json.trunk as readonly (EncodedCommit & SequenceId)[]; const data: Mutable> = { trunk: trunk.map((commit): SequencedCommit => { const decoded = decodeCommit(changeCodec, revisionTagCodec, commit, { originatorId: commit.sessionId, idCompressor: context.idCompressor, revision: undefined, isSummary: context.isSummary, healing: context.healing, }); copyProperty(commit, "sequenceNumber", decoded); copyProperty(commit, "indexInBatch", decoded); return decoded; }), peerLocalBranches: new Map( mapIterable(json.peers, ([sessionId, branch]) => [ sessionId, { base: revisionTagCodec.decode(branch.base, { originatorId: sessionId, idCompressor: context.idCompressor, revision: undefined, isSummary: context.isSummary, }), commits: branch.commits.map((commit) => decodeCommit( changeCodec, revisionTagCodec, commit as EncodedCommit, { originatorId: commit.sessionId, idCompressor: context.idCompressor, revision: undefined, isSummary: context.isSummary, healing: context.healing, }, ), ), }, ]), ), }; if (json.session !== undefined) { data.session = json.session; } if (json.name !== undefined) { data.name = json.name; } if (json.author !== undefined) { data.author = json.author; } if (json.id !== undefined) { assert( originatorId !== undefined, 0xc63 /* Cannot decode branch id without originatorId */, ); data.id = decodeBranchId(context.idCompressor, json.id, { originatorId }); } if (json.base !== undefined) { assert( originatorId !== undefined, 0xc64 /* Cannot decode branch base without originatorId */, ); data.base = revisionTagCodec.decode(json.base, { originatorId, idCompressor: context.idCompressor, revision: undefined, isSummary: context.isSummary, }); } return data; }