Skip to content

A fully open source & end-to-end encrypted note taking alternative to Evernote.

10.6 KB
Raw Blame
/*
This file is part of the Notesnook project (https://notesnook.com/)

Copyright (C) 2023 Streetwriters (Private) Limited

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

import { logger } from "../../logger.js";
import { isHTMLEqual } from "../../utils/html-diff.js";
import Database from "../index.js";
import {
  Attachment,
  ContentItem,
  Item,
  MaybeDeletedItem,
  Note,
  isDeleted
} from "../../types.js";
import { SyncInboxItem } from "./types.js";
import { InboxItemsHistoryErrorContext } from "../../types.js";
import { z } from "zod";
import { sanitizeHtml } from "../../utils/html-parser.js";
import { strings } from "@notesnook/intl";

const THRESHOLD = process.env.NODE_ENV === "test" ? 2 * 1000 : 60 * 1000;
class Merger {
  logger = logger.scope("Merger");
  constructor(private readonly db: Database) {}

  // isSyncCollection(type: string): type is keyof typeof SYNC_COLLECTIONS_MAP {
  //   return type in SYNC_COLLECTIONS_MAP;
  // }

  mergeItem(
    remoteItem: MaybeDeletedItem<Item>,
    localItem: MaybeDeletedItem<Item> | undefined
  ) {
    if (!localItem || remoteItem.dateModified > localItem.dateModified) {
      this.logger.debug(`Remote item is newer. Using remote item.`, {
        id: remoteItem.id,
        remoteDateModified: remoteItem.dateModified,
        localDateModified: localItem?.dateModified
      });
      return remoteItem;
    }

    if (
      !remoteItem.deleted &&
      remoteItem.type === "note" &&
      !localItem.deleted &&
      localItem.type === "trash" &&
      localItem.itemType === "note" &&
      localItem.deletedBy === "expired"
    ) {
      if (
        remoteItem.expiryDate &&
        remoteItem.expiryDate.dateModified > localItem.expiryDate.dateModified
      ) {
        localItem.expiryDate = remoteItem.expiryDate;
        (localItem as unknown as Note).type = "note";
        (localItem as unknown as Note).deletedBy = null;
        (localItem as unknown as Note).dateDeleted = null;
        (localItem as unknown as Note).itemType = null;

        this.logger.debug(
          `Remote note has newer expiry date. Restoring expired note.`,
          {
            id: remoteItem.id,
            remoteExpiryDateModified: remoteItem.expiryDate.dateModified,
            localExpiryDateModified: localItem.expiryDate.dateModified
          }
        );
        return localItem;
      }
    }
  }

  mergeContent(
    remoteItem: MaybeDeletedItem<Item>,
    localItem: MaybeDeletedItem<Item> | undefined
  ) {
    if (localItem && "localOnly" in localItem && localItem.localOnly) {
      this.logger.debug(
        `Local item is marked as localOnly. Skipping merge and keeping local item.`,
        {
          id: localItem.id,
          localOnly: localItem.localOnly
        }
      );
      return;
    }

    if (
      !localItem ||
      isDeleted(localItem) ||
      isDeleted(remoteItem) ||
      remoteItem.type !== "tiptap" ||
      localItem.type !== "tiptap" ||
      !localItem.data ||
      !remoteItem.data
    ) {
      return this.mergeItem(remoteItem, localItem);
    } else {
      // it's possible that the local item already has a conflict so
      // we can just replace the conflicted content
      const conflicted = localItem.conflicted
        ? "conflict"
        : isContentConflicted(localItem, remoteItem, THRESHOLD);

      this.logger.debug(`Content conflict check result: ${conflicted}`, {
        id: localItem.id,
        localDateModified: localItem.dateModified,
        remoteDateModified: remoteItem.dateModified,
        localDateResolved: localItem.dateResolved,
        timeDifference:
          Math.max(remoteItem.dateEdited, localItem.dateEdited) -
          Math.min(remoteItem.dateEdited, localItem.dateEdited)
      });
      if (conflicted === "merge") return remoteItem;
      else if (!conflicted) return;

      // otherwise we trigger the conflicts
      this.logger.info("conflict marked", { id: localItem.noteId });
      localItem.conflicted = remoteItem;
      return localItem;
    }
  }

  async mergeAttachment(
    remoteItem: MaybeDeletedItem<Attachment>,
    localItem: MaybeDeletedItem<Attachment> | undefined
  ) {
    if (
      !localItem ||
      isDeleted(localItem) ||
      isDeleted(remoteItem) ||
      !localItem.dateUploaded ||
      !remoteItem.dateUploaded ||
      localItem.dateUploaded === remoteItem.dateUploaded
    ) {
      return this.mergeItem(remoteItem, localItem);
    }

    if (localItem.dateUploaded > remoteItem.dateUploaded) return;

    logger.debug("Removing local attachment file due to conflict", {
      hash: localItem.hash
    });
    const isRemoved = await this.db.fs().deleteFile(localItem.hash, true);
    if (!isRemoved)
      throw new Error(
        "Conflict could not be resolved in one of the attachments."
      );
    return remoteItem;
  }
}
export default Merger;

export function isContentConflicted(
  localItem: ContentItem,
  remoteItem: ContentItem,
  conflictThreshold: number
) {
  const isResolved =
    localItem.dateResolved &&
    remoteItem.dateModified &&
    localItem.dateResolved === remoteItem.dateModified;
  const isEdited =
    // the local item is edited if it wasn't synced yet.
    !localItem.synced;
  if (isEdited && !isResolved) {
    // If time difference between local item's edits & remote item's edits
    // is less than threshold, we shouldn't trigger a merge conflict; instead
    // we will keep the most recently changed item.
    const timeDiff =
      Math.max(remoteItem.dateEdited, localItem.dateEdited) -
      Math.min(remoteItem.dateEdited, localItem.dateEdited);

    if (
      timeDiff < conflictThreshold ||
      isHTMLEqual(localItem.data, remoteItem.data)
    ) {
      if (remoteItem.dateModified > localItem.dateModified) {
        return "merge";
      }
      return;
    }

    return "conflict";
  } else if (!isResolved) {
    return "merge";
  }
}

const RawInboxItemSchema = z.object({
  title: z.string().min(1, "Title is required"),
  pinned: z.boolean().optional(),
  favorite: z.boolean().optional(),
  readonly: z.boolean().optional(),
  archived: z.boolean().optional(),
  notebookIds: z.array(z.string()).optional(),
  tagIds: z.array(z.string()).optional(),
  type: z.enum(["note"]),
  source: z.string().min(1, "Source is required"),
  version: z.literal(1),
  content: z
    .object({
      type: z.enum(["html"]),
      data: z.string()
    })
    .optional()
});

export async function handleInboxItems(
  inboxItems: SyncInboxItem[],
  db: Database
) {
  const inboxKeys = await db.user.getInboxKeys();
  if (!inboxKeys) {
    logger.error("No inbox keys found, cannot process inbox items.");
    return;
  }

  for (const item of inboxItems) {
    try {
      if (await db.inboxItemsHistory.exists(item.id)) {
        logger.info("Inbox item already processed, skipping.", {
          inboxItemId: item.id
        });
        continue;
      }

      let decryptedItem: string;
      try {
        decryptedItem = await db
          .storage()
          .decryptPGPMessage(inboxKeys.privateKey, item.cipher);
      } catch (e) {
        logger.error(e, "Failed to decrypt inbox item.", {
          inboxItemId: item.id
        });
        await db.inboxItemsHistory.add({
          id: item.id,
          status: "failed",
          errorContext: JSON.stringify({
            message: strings.decryptionFailed(),
            description: (e as Error).message,
            inboxItem: { id: item.id, v: item.v, alg: item.alg }
          } satisfies InboxItemsHistoryErrorContext)
        });
        continue;
      }

      let parsed: unknown;
      try {
        parsed = JSON.parse(decryptedItem);
      } catch (e) {
        logger.error(e, "Failed to parse inbox item JSON.", {
          inboxItemId: item.id
        });
        await db.inboxItemsHistory.add({
          id: item.id,
          status: "failed",
          errorContext: JSON.stringify({
            message: strings.invalidJson(),
            description: (e as Error).message,
            inboxItem: { id: item.id, v: item.v, alg: item.alg },
            decryptedItem
          } satisfies InboxItemsHistoryErrorContext)
        });
        continue;
      }

      const validation = RawInboxItemSchema.safeParse(parsed);
      if (!validation.success) {
        logger.warn("Failed to validate inbox item.", {
          inboxItem: item,
          errors: validation.error.issues
        });
        const { content: _content, ...parsedWithoutContent } = parsed as Record<
          string,
          unknown
        >;
        await db.inboxItemsHistory.add({
          id: item.id,
          status: "failed",
          errorContext: JSON.stringify({
            message: strings.validationFailed(),
            description: validation.error.issues
              .map((i) => `${i.path.join(".")}: ${i.message}`)
              .join("; "),
            inboxItem: { id: item.id, v: item.v, alg: item.alg },
            parsedItem: parsedWithoutContent
          } satisfies InboxItemsHistoryErrorContext)
        });
        continue;
      }

      const data = validation.data;
      await db.notes.add({
        id: item.id,
        title: data.title,
        favorite: data.favorite,
        pinned: data.pinned,
        readonly: data.readonly,
        content: {
          data: sanitizeHtml(data?.content?.data ?? ""),
          type: "tiptap"
        }
      });
      if (data.archived !== undefined) {
        await db.notes.archive(data.archived, item.id);
      }
      for (const notebookId of data.notebookIds || []) {
        if (!(await db.notebooks.exists(notebookId))) continue;
        await db.notes.addToNotebook(notebookId, item.id);
      }
      for (const tagId of data.tagIds || []) {
        if (!(await db.tags.exists(tagId))) continue;
        await db.relations.add(
          { type: "tag", id: tagId },
          { type: "note", id: item.id }
        );
      }
      await db.inboxItemsHistory.add({
        id: item.id,
        status: "success",
        source: data.source
      });
      await db.relations.add(
        { type: "inboxitemhistory", id: item.id },
        { type: "note", id: item.id }
      );
    } catch (e) {
      logger.error(e, "Failed to process inbox item.", {
        inboxItem: item
      });
    }
  }
}