obsidian-livesync/src/serviceFeatures/redFlag.simpleFetch.ts

import { LOG_LEVEL_NOTICE } from "octagonal-wheels/common/logger";
import type { NecessaryServices } from "@lib/interfaces/ServiceModule";
import { type LogFunction } from "@lib/services/lib/logUtils";
import { UnresolvedErrorManager } from "@lib/services/base/UnresolvedErrorManager";
import {
    ExtraOnLocal,
    ExtraOnRemote,
    FullScanModes,
    normaliseFullScanOptions,
    synchroniseAllFilesBetweenDBandStorage,
    type FullScanOptions,
} from "@lib/serviceFeatures/offlineScanner";
import { adjustSettingToRemoteIfNeeded, processVaultInitialisation } from "./redFlag";

export const SIMPLE_FETCH_STAGE1_REMOTE_WINS = "Overwrite all with remote files";
export const SIMPLE_FETCH_STAGE1_NEWER_WINS = "Compare time and take newer";
export const SIMPLE_FETCH_STAGE1_LEGACY = "Use the detailed flow";
export const SIMPLE_FETCH_STAGE1_CANCEL = "Cancel";

export const SIMPLE_FETCH_STAGE2_REMOTE_DELETE_NONE = "Keep local files even if not on remote";
export const SIMPLE_FETCH_STAGE2_REMOTE_DELETE_ALL = "Delete local files if not on remote";

export const SIMPLE_FETCH_STAGE2_NEWER_CLEANUP = "Delete local files if deleted on remote";
export const SIMPLE_FETCH_STAGE2_NEWER_SYNC_ALL = "Keep local files even if deleted on remote";
export const STAGE2_ABORT = "Cancel all and reboot";

export async function askSimpleFetchMode(
    host: NecessaryServices<"UI" | "vault", "storageAccess">
): Promise<{ mode: string; options: Partial<FullScanOptions> } | "cancelled" | "aborted"> {
    const msg = `We are about to retrieve the remote data.

Firstly, how shall we handle the data retrieved from this remote server?

- **${SIMPLE_FETCH_STAGE1_NEWER_WINS}**: Compares the modified time of files and takes the newer one.
  If you have been using Self-hosted LiveSync and have made changes on multiple devices, this option may be suitable for you as it tries to merge changes based on modified time.
- **${SIMPLE_FETCH_STAGE1_REMOTE_WINS}**: Remote data is the source of truth.
  If you are new to using Self-hosted LiveSync. This option may be easiest to understand and get started with.
  It will overwrite all your local files with the remote data, so please make sure you have a backup if there is any important data in your vault.
- **${SIMPLE_FETCH_STAGE1_LEGACY}**: Opens the detailed setup wizard.
  If you want to have more control over the synchronisation process, or want to review the changes before applying, you can choose this option to use the detailed flow.
    `;
    const stage1 = await host.services.UI.confirm.confirmWithMessage(
        "Data retrieval scheduled",
        msg,
        [
            SIMPLE_FETCH_STAGE1_NEWER_WINS,
            SIMPLE_FETCH_STAGE1_REMOTE_WINS,
            SIMPLE_FETCH_STAGE1_LEGACY,
            SIMPLE_FETCH_STAGE1_CANCEL,
        ],
        SIMPLE_FETCH_STAGE1_NEWER_WINS,
        0
    );

    if (!stage1 || stage1 === SIMPLE_FETCH_STAGE1_CANCEL) return "cancelled";

    if (stage1 === SIMPLE_FETCH_STAGE1_LEGACY) {
        return { mode: "legacy", options: {} };
    }

    if (stage1 === SIMPLE_FETCH_STAGE1_REMOTE_WINS) {
        const msg = `Since you have chosen to overwrite all local files with remote data, **how would you like to handle local files that are not present in the remote database?**

- **${SIMPLE_FETCH_STAGE2_REMOTE_DELETE_ALL}**: Local-only files and remote-deleted files will be removed.
  This option will make your local vault exactly the same as the remote database, but please make sure you have a backup if there is any important data in your vault.
- **${SIMPLE_FETCH_STAGE2_REMOTE_DELETE_NONE}**: All existing local files will be preserved.
  This option will keep all your local files, but it may cause duplicates if there are files that exist on local but not on remote. You can clean up these duplicates manually after the synchronisation.`;

        const stage2 = await host.services.UI.confirm.confirmWithMessage(
            "How to handle extra existing local files?",
            msg,
            [SIMPLE_FETCH_STAGE2_REMOTE_DELETE_ALL, SIMPLE_FETCH_STAGE2_REMOTE_DELETE_NONE, STAGE2_ABORT],
            SIMPLE_FETCH_STAGE2_REMOTE_DELETE_NONE,
            0
        );
        if (!stage2) return "cancelled";
        if (stage2 === STAGE2_ABORT) {
            return "aborted";
        }
        return {
            mode: "remote-only",
            options: {
                mode: FullScanModes.DB_APPLY,
                extraOnRemote:
                    stage2 === SIMPLE_FETCH_STAGE2_REMOTE_DELETE_ALL ? ExtraOnRemote.DELETE_LOCAL_MISSING : undefined,
            },
        };
    }

    if (stage1 === SIMPLE_FETCH_STAGE1_NEWER_WINS) {
        const msg = `How should files that were deleted on other devices be handled?

- **${SIMPLE_FETCH_STAGE2_NEWER_CLEANUP}**: Delete local files if they were deleted on remote.
  This is useful if you want to keep your vault clean and consistent across devices, but please make sure you have a backup if there is already any important data in your vault.
- **${SIMPLE_FETCH_STAGE2_NEWER_SYNC_ALL}**: Recreate remote files even if they were deleted on remote.
  This option will keep all your local files, but it may cause duplicates if there are files that exist on local but not on remote. You can clean up these duplicates manually after the synchronisation.
  `;

        const stage2 = await host.services.UI.confirm.confirmWithMessage(
            "Conflict & Deletion Options",
            msg,
            [SIMPLE_FETCH_STAGE2_NEWER_CLEANUP, SIMPLE_FETCH_STAGE2_NEWER_SYNC_ALL, STAGE2_ABORT],
            SIMPLE_FETCH_STAGE2_NEWER_SYNC_ALL,
            0
        );
        if (!stage2) return "cancelled";
        if (stage2 === STAGE2_ABORT) {
            return "aborted";
        }
        return {
            mode: "newer-wins",
            options: {
                mode: FullScanModes.NEWER_WINS,
                extraOnLocal:
                    stage2 === SIMPLE_FETCH_STAGE2_NEWER_CLEANUP
                        ? ExtraOnLocal.DELETE_DB_DELETED
                        : ExtraOnLocal.APPEND_STORAGE_ONLY,
            },
        };
    }

    return "cancelled";
}

const RERUN_PROCESS = "Reboot to re-run the process";
const RELEASE_FLAG_PROCESS = "Finalise the process and resume normal operation";
export async function askAndPerformFastSetupOnScheduledFetchAll(
    host: NecessaryServices<
        | "vault"
        | "fileProcessing"
        | "tweakValue"
        | "UI"
        | "setting"
        | "appLifecycle"
        | "path"
        | "keyValueDB"
        | "database",
        "storageAccess" | "rebuilder" | "fileHandler"
    >,
    log: LogFunction,
    cleanupFlag: () => Promise<void>
): Promise<boolean | undefined> {
    const result = await askSimpleFetchMode(host);
    if (result === "cancelled") {
        log("Fetch cancelled by user.", LOG_LEVEL_NOTICE);
        await cleanupFlag();
        host.services.appLifecycle.performRestart();
        return false;
    }
    if (result === "aborted") {
        log("Fetch exited by user.", LOG_LEVEL_NOTICE);
        host.services.appLifecycle.performRestart();
        return false;
    }
    if (result.mode === "legacy") {
        return undefined; // Let the legacy flow handle it.
    }

    return await processVaultInitialisation(host, log, async () => {
        const settings = host.services.setting.currentSettings();
        await adjustSettingToRemoteIfNeeded(host, log, { preventFetchingConfig: false }, settings);
        // 1. Perform fast DB fetch (download remote DB content to local DB)
        await host.serviceModules.rebuilder.$fetchLocalDBFast(false);

        // 2. Call the extended synchroniseAllFilesBetweenDBandStorage to reflect changes in storage
        const errorManager = new UnresolvedErrorManager(host.services.appLifecycle);
        const syncResult = await synchroniseAllFilesBetweenDBandStorage(
            host,
            log,
            errorManager,
            normaliseFullScanOptions({
                ...result.options,
                showingNotice: true,
                omitEvents: true,
                ignoreSuspending: true,
            })
        );
        if (!syncResult) {
            const canRelease = await host.services.UI.confirm.askSelectStringDialogue(
                "Some files failed to synchronise. What would you like to do?",
                [RERUN_PROCESS, RELEASE_FLAG_PROCESS],
                { defaultAction: RELEASE_FLAG_PROCESS, title: "Synchronisation Issues Detected" }
            );
            if (canRelease === RERUN_PROCESS) {
                log("User chose to reboot and re-run the process.", LOG_LEVEL_NOTICE);
                // Prevent to delete the flag, so that the process will be re-run after reboot.
                // await cleanupFlag();
                host.services.appLifecycle.performRestart();
                return false;
            }
        }
        await host.serviceModules.rebuilder.finishRebuild();
        await cleanupFlag();
        log("Simple fetch and scan operation completed.", LOG_LEVEL_NOTICE);
        return true;
    });
}