checkpointManager.ts

/*!
 * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
 * Licensed under the MIT License.
 */

import type {
	ICheckpointService,
	IDeliState,
	IQueuedMessage,
} from "@fluidframework/server-services-core";

import type { CheckpointReason } from "../utils";

/**
 * @internal
 */
export interface IDeliCheckpointManager {
	writeCheckpoint(
		checkpoint: IDeliState,
		isLocal: boolean,
		reason: CheckpointReason,
	): Promise<void>;
	deleteCheckpoint(checkpointParams: ICheckpointParams, isLocal: boolean): Promise<void>;
}

/**
 * @internal
 */
export interface ICheckpointParams {
	/**
	 * The reason why this checkpoint was triggered
	 */
	reason: CheckpointReason;

	/**
	 * The deli checkpoint state \@ deliCheckpointMessage
	 */
	deliState: IDeliState;

	/**
	 * The message to checkpoint for deli (mongodb)
	 */
	deliCheckpointMessage: IQueuedMessage;

	/**
	 * The message to checkpoint for kafka
	 */
	kafkaCheckpointMessage: IQueuedMessage | undefined;

	/**
	 * Flag that decides if the deli checkpoint should be deleted
	 */
	clear?: boolean;
}

// TODO: documentation
// eslint-disable-next-line jsdoc/require-description
/**
 * @internal
 */
export function createDeliCheckpointManagerFromCollection(
	tenantId: string,
	documentId: string,
	checkpointService: ICheckpointService,
): IDeliCheckpointManager {
	const checkpointManager = {
		writeCheckpoint: async (checkpoint: IDeliState, isLocal: boolean): Promise<void> => {
			return checkpointService.writeCheckpoint(
				documentId,
				tenantId,
				"deli",
				checkpoint,
				isLocal,
			);
		},
		deleteCheckpoint: async (
			checkpointParams: ICheckpointParams,
			isLocal: boolean,
		): Promise<void> => {
			return checkpointService.clearCheckpoint(documentId, tenantId, "deli", isLocal);
		},
	};
	return checkpointManager;
}