A fully open source & end-to-end encrypted note taking alternative to Evernote.
TypeScript asp-net-coredotnet-coreelectronfosshacktoberfestnote-managmentnote-takingnote-taking-appnotebooknotesnotes-appopen-sourceopensourceprivacyproductivityreactreact-nativereactjsself-hosted
core: fix migration errors & compact deleted items
Abdullah Atta2713f26f90c9
diff --git a/packages/core/__tests__/migrations.test.ts b/packages/core/__tests__/migrations.test.tsindex 6c04bc6b0..6e3d09b45 100644--- a/packages/core/__tests__/migrations.test.ts+++ b/packages/core/__tests__/migrations.test.ts@@ -710,7 +710,7 @@ describe.concurrent("[5.9] migrate kv", (test) => {await migrateKV(db, 5.9, 6.0);- expect(await db.kv().read(key)).toBe(key === "v" ? 6 : undefined);+ expect(await db.kv().read(key)).toBe(key === "v" ? 6.1 : undefined);expect(await db.storage().read(key)).toBe(null);}));}diff --git a/packages/core/__tests__/trash.test.ts b/packages/core/__tests__/trash.test.tsindex 60ae8fe59..c63ae3466 100644--- a/packages/core/__tests__/trash.test.ts+++ b/packages/core/__tests__/trash.test.ts@@ -362,3 +362,25 @@ test("permanently deleting a notebook should not delete independently deleted suexpect(trash.some((a) => a.id === child2)).toBe(false);expect(trash.some((a) => a.id === child)).toBe(false);}));++test.only("permanently deleted note should not have note fields", () =>+ databaseTest().then(async (db) => {+ const noteId = await db.notes.add(TEST_NOTE);+ await db.notes.moveToTrash(noteId);++ await db.trash.delete(noteId);++ const rawItem = await db+ .sql()+ .selectFrom("notes")+ .selectAll()+ .where("id", "==", noteId)+ .executeTakeFirst();+ const keys = Object.keys(rawItem!);+ expect(keys.sort()).toStrictEqual([+ "dateModified",+ "deleted",+ "id",+ "synced"+ ]);+ }));diff --git a/packages/core/src/collections/settings.ts b/packages/core/src/collections/settings.tsindex 19fd4573d..813ea1a3f 100644--- a/packages/core/src/collections/settings.ts+++ b/packages/core/src/collections/settings.ts@@ -99,7 +99,7 @@ export class Settings implements ICollection {value: SettingItemMap[TKey]) {const id = makeId(key);- const oldItem = await this.collection.get(id);+ const oldItem = this.collection.get(id);if (oldItem && oldItem.key !== key) throw new Error("Key conflict.");await this.collection.upsert({diff --git a/packages/core/src/common.ts b/packages/core/src/common.tsindex 1982d33d2..54f68bbaa 100644--- a/packages/core/src/common.ts+++ b/packages/core/src/common.ts@@ -147,4 +147,4 @@ export const DATE_FORMATS_WITHOUT_YEAR = [export const TIME_FORMATS = ["12-hour", "24-hour"];-export const CURRENT_DATABASE_VERSION = 6.0;+export const CURRENT_DATABASE_VERSION = 6.1;diff --git a/packages/core/src/database/backup.ts b/packages/core/src/database/backup.tsindex 6518bae57..b0ec9396e 100644--- a/packages/core/src/database/backup.ts+++ b/packages/core/src/database/backup.ts@@ -412,6 +412,7 @@ export default class Backup {switch (version) {case CURRENT_DATABASE_VERSION:+ case 6.0:case 5.9:case 5.8:case 5.7:diff --git a/packages/core/src/database/index.ts b/packages/core/src/database/index.tsindex d81c8777c..e4e34fc28 100644--- a/packages/core/src/database/index.ts+++ b/packages/core/src/database/index.ts@@ -54,7 +54,8 @@ import {Tag,TrashOrItem,ValueOf,- Vault+ Vault,+ isDeleted} from "../types";import { NNMigrationProvider } from "./migrations";import { createTriggers } from "./triggers";@@ -309,17 +310,28 @@ export class SqliteBooleanPlugin implements KyselyPlugin {transformResult(args: PluginTransformResultArgs): Promise<QueryResult<UnknownRow>> {- for (const row of args.result.rows) {+ for (let i = 0; i < args.result.rows.length; ++i) {+ const row = args.result.rows[i];if (typeof row !== "object") continue;+ if (isDeleted(row)) {+ args.result.rows[i] = {+ deleted: true,+ synced: row.synced,+ dateModified: row.dateModified,+ id: row.id+ };+ continue;+ }+for (const key in row) {if (BooleanProperties.has(key as BooleanFields)) {row[key] = row[key] === 1;}}- const mapper = DataMappers[row.type as ItemType];- if (row.type && mapper) {+ const mapper = !!row.type && DataMappers[row.type as ItemType];+ if (mapper) {mapper(row);}}diff --git a/packages/core/src/database/migrations.ts b/packages/core/src/database/migrations.tsindex 873c6ccfe..e7640fa26 100644--- a/packages/core/src/database/migrations.ts+++ b/packages/core/src/database/migrations.ts@@ -127,7 +127,7 @@ export class NNMigrationProvider implements MigrationProvider {.modifyEnd(sql`without rowid`).$call(addBaseColumns).addColumn("title", "text", COLLATE_NOCASE)- .addColumn("colorCode", "text")+ .addColumn("colorCode", "text", (c) => c.unique()).execute();await db.schema@@ -196,7 +196,7 @@ export class NNMigrationProvider implements MigrationProvider {.createTable("settings").modifyEnd(sql`without rowid`).$call(addBaseColumns)- .addColumn("key", "text")+ .addColumn("key", "text", (c) => c.unique()).addColumn("value", "text").execute();diff --git a/packages/core/src/database/migrator.ts b/packages/core/src/database/migrator.tsindex 7520e6ffd..b55d7cf42 100644--- a/packages/core/src/database/migrator.ts+++ b/packages/core/src/database/migrator.ts@@ -113,7 +113,7 @@ class Migrator {item,version,CURRENT_DATABASE_VERSION,- isDeleted(item) ? "all" : item.type,+ isDeleted(item) ? "never" : item.type,db,"local");diff --git a/packages/core/src/migrations.ts b/packages/core/src/migrations.tsindex f8e19e168..b29628a9f 100644--- a/packages/core/src/migrations.ts+++ b/packages/core/src/migrations.ts@@ -41,11 +41,11 @@ import { Cipher } from "@notesnook/crypto";import { KEYS } from "./database/kv";type MigrationType = "local" | "sync" | "backup";-type MigrationItemType = ItemType | "notehistory" | "content" | "all";+type MigrationItemType = ItemType | "notehistory" | "content" | "never";type MigrationItemMap = ItemMap & {notehistory: HistorySession;content: ContentItem;- all: MaybeDeletedItem<Item>;+ never: never;};type Migration = {version: number;@@ -56,6 +56,12 @@ type Migration = {migrationType: MigrationType) => "skip" | boolean | Promise<boolean | "skip"> | void;};+ all?: (+ item: MaybeDeletedItem<Item>,+ db: Database,+ migrationType: MigrationType,+ itemType: MigrationItemType+ ) => "skip" | boolean | Promise<boolean | "skip"> | void;collection?: (collection: IndexedCollection) => Promise<void> | void;vaultKey?: (db: Database, key: Cipher<"base64">) => Promise<void> | void;kv?: (db: Database) => Promise<void> | void;@@ -167,12 +173,11 @@ const migrations: Migration[] = [},{version: 5.8,- items: {- all: (item, _db, migrationType) => {- if (migrationType === "local") {- delete item.remote;- return true;- }+ items: {},+ all: (item, _db, migrationType) => {+ if (migrationType === "local") {+ delete item.remote;+ return true;}}},@@ -404,11 +409,15 @@ const migrations: Migration[] = [delete item.resolved;return true;},- all: (item) => {- delete item.deleteReason;+ notehistory: (item) => {+ delete item.data;return true;}},+ all: (item) => {+ delete item.deleteReason;+ return true;+ },async vaultKey(db, key) {await db.vaults.add({ title: "Default", key });// TODO: remove this@@ -427,8 +436,30 @@ const migrations: Migration[] = [},{version: 6.0,- items: {}- }+ items: {+ note: (item) => {+ delete item.locked;+ return true;+ }+ },+ all: (item) => {+ if (isDeleted(item)) {+ const allowedKeys = [+ "deleted",+ "dateModified",+ "id",+ "synced",+ "remote"+ ];+ for (const key in item) {+ if (allowedKeys.includes(key)) continue;+ delete (item as any)[key];+ }+ return true;+ }+ }+ },+ { version: 6.1, items: {} }];export async function migrateItem<TItemType extends MigrationItemType>(@@ -456,8 +487,8 @@ export async function migrateItem<TItemType extends MigrationItemType>(if (migration.version === databaseVersion) break;let result =- !!migration.items.all &&- (await migration.items.all(item, database, migrationType));+ !!migration.all &&+ (await migration.all(item, database, migrationType, type));if (result === "skip") return "skip";if (result) {if (diff --git a/packages/core/src/types.ts b/packages/core/src/types.tsindex a9f700f4e..31bd365e6 100644--- a/packages/core/src/types.ts+++ b/packages/core/src/types.ts@@ -399,6 +399,11 @@ export interface HistorySession extends BaseItem<"session"> {noteId: string;localOnly: boolean;locked?: boolean;++ /**+ * @deprecated+ */+ data?: never;}export interface SessionContentItem extends BaseItem<"sessioncontent"> {