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 crash due to unsanitized sort options (#5324)
Muhammad Ali159ce97e421d
diff --git a/packages/core/__tests__/reminders.test.js b/packages/core/__tests__/reminders.test.jsindex 396669fdf..e061b4ab5 100644--- a/packages/core/__tests__/reminders.test.js+++ b/packages/core/__tests__/reminders.test.js@@ -331,6 +331,39 @@ describe("format reminder time", () => {});});+test("sorting reminders by dateEdited shouldn't throw", () =>+ databaseTest().then(async (db) => {+ await db.reminders.add({+ recurringMode: "day",+ date: new Date(0).setHours(14),+ mode: "repeat",+ title: "Random reminder"+ });+ await expect(+ db.reminders.all.ids({+ groupBy: "default",+ sortBy: "dateEdited",+ sortDirection: "desc"+ })+ ).resolves.toBeDefined();+ await expect(+ db.reminders.all.groups({+ groupBy: "default",+ sortBy: "dateEdited",+ sortDirection: "desc"+ })+ ).resolves.toBeDefined();+ await expect(+ db.reminders.all+ .grouped({+ groupBy: "default",+ sortBy: "dateEdited",+ sortDirection: "desc"+ })+ .then((g) => g.item(0))+ ).resolves.toBeDefined();+ }));+async function compareReminder(reminder) {const db = await databaseTest();const id = await db.reminders.add(reminder);diff --git a/packages/core/src/collections/settings.ts b/packages/core/src/collections/settings.tsindex ada456a1a..9c66521a1 100644--- a/packages/core/src/collections/settings.ts+++ b/packages/core/src/collections/settings.ts@@ -134,11 +134,7 @@ export class Settings implements ICollection {}getGroupOptions(key: GroupingKey) {- const options = this.get(`groupOptions:${key}`);- // TODO: remove this check- if (key === "tags" && options.sortBy === "dateEdited")- options.sortBy = "dateModified";- return options;+ return this.get(`groupOptions:${key}`);}setGroupOptions(key: GroupingKey, groupOptions: GroupOptions) {diff --git a/packages/core/src/database/sql-collection.ts b/packages/core/src/database/sql-collection.tsindex 43ecffe29..48c408e52 100644--- a/packages/core/src/database/sql-collection.ts+++ b/packages/core/src/database/sql-collection.ts@@ -443,6 +443,7 @@ export class FilteredSelector<T extends Item> {}async grouped(options: GroupOptions) {+ sanitizeSortOptions(this.type, options);const count = await this.count();return new VirtualizedGrouping<T>(count,@@ -466,6 +467,8 @@ export class FilteredSelector<T extends Item> {}async groups(options: GroupOptions) {+ sanitizeSortOptions(this.type, options);+const fields: Array<| AnyColumnWithTable<DatabaseSchema, keyof DatabaseSchema>| AnyColumn<DatabaseSchema, keyof DatabaseSchema>@@ -558,6 +561,8 @@ export class FilteredSelector<T extends Item> {options: GroupOptions | SortOptions,hasDueDate?: boolean) {+ sanitizeSortOptions(this.type, options);+const sortBy: Set<SortOptions["sortBy"]> = new Set();if (isGroupOptions(options)) {if (options.groupBy === "abc") sortBy.add("title");@@ -612,7 +617,6 @@ export class FilteredSelector<T extends Item> {);}}-return qb;};}@@ -634,3 +638,30 @@ function isSortByDate(options: SortOptions | GroupOptions) {options.sortBy === "dueDate");}++const BASE_FIELDS: SortOptions["sortBy"][] = ["dateCreated", "dateModified"];+const VALID_SORT_OPTIONS: Record<+ keyof DatabaseSchema,+ SortOptions["sortBy"][]+> = {+ reminders: ["dueDate", "title"],+ tags: ["title"],+ attachments: ["filename", "dateUploaded", "size"],+ colors: ["title"],+ notebooks: ["title"],+ notes: ["title"],++ content: [],+ notehistory: [],+ relations: [],+ sessioncontent: [],+ settings: [],+ shortcuts: [],+ vaults: []+};++function sanitizeSortOptions(type: keyof DatabaseSchema, options: SortOptions) {+ const validFields = [...VALID_SORT_OPTIONS[type], ...BASE_FIELDS];+ if (!validFields.includes(options.sortBy)) options.sortBy = validFields[0];+ return options;+}