feat(notes): add completed task cleanup controls (#854)

* feat(notes): add completed task cleanup API

* feat(notes): add completed task controls

* test(notes): cover completed task cleanup

Author: antonreshetov

src/main/api/dto/notes.ts

@@ -65,10 +65,15 @@ const notesCountsResponse = t.Object({
   trash: t.Number(),
 })
 
+const notesTasksCleanupResponse = t.Object({
+  count: t.Number(),
+})
+
 export const notesDTO = new Elysia().model({
   notesAdd,
   notesContentUpdate,
   notesCountsResponse,
+  notesTasksCleanupResponse,
   noteItemResponse: noteItem,
   noteProperties,
   notesResponse,
@@ -86,6 +91,7 @@ export const notesDTO = new Elysia().model({
     propertyStatus: t.Optional(t.String()),
     propertyStatusNot: t.Optional(t.String()),
     propertyType: t.Optional(t.String()),
+    hideCompletedTasks: t.Optional(t.Number({ minimum: 0, maximum: 1 })),
   }),
   notePropertiesUpdate,
   notesUpdate,

src/main/api/routes/notes.ts

@@ -1,6 +1,7 @@
 import type { NoteItemResponse, NotesResponse } from '../dto/notes'
 import Elysia from 'elysia'
 import { useNotesStorage } from '../../storage'
+import { runTasksCleanupNow } from '../../tasks'
 import {
   commonAddResponse,
   commonMessageResponse,
@@ -313,5 +314,18 @@ app
       },
     },
   )
+  .post(
+    '/tasks/cleanup',
+    () => {
+      const count = runTasksCleanupNow()
+      return { count }
+    },
+    {
+      response: 'notesTasksCleanupResponse',
+      detail: {
+        tags: ['Notes'],
+      },
+    },
+  )
 
 export default app

src/main/i18n/locales/en_US/menu.json

@@ -57,7 +57,8 @@
       "ascending": "Ascending",
       "descending": "Descending"
     },
-    "compactMode": "Compact List"
+    "compactMode": "Compact List",
+    "hideCompletedTasks": "Hide Completed Tasks"
   },
   "edit": {
     "label": "Edit",

src/main/i18n/locales/en_US/preferences.json

@@ -99,7 +99,7 @@
     }
   },
   "notesEditor": {
-    "label": "Note Editor",
+    "label": "Notes",
     "fontSize": {
       "label": "Font Size",
       "description": "Base font size in pixels for the notes editor."
@@ -185,6 +185,22 @@
       "rateLimited": "Rate limit exceeded. Try again later."
     }
   },
+  "tasks": {
+    "label": "Tasks",
+    "autoCleanup": {
+      "label": "Auto-clean completed",
+      "description": "Move completed tasks to trash on a schedule. They stay in trash until you empty it.",
+      "never": "Never",
+      "1d": "Every day",
+      "7d": "Every 7 days",
+      "30d": "Every 30 days"
+    },
+    "cleanupNow": {
+      "label": "Clean up now",
+      "button": "Move completed to trash",
+      "description": "Move all completed tasks to trash right now."
+    }
+  },
   "http": {
     "label": "HTTP Client",
     "wrapLines": {

src/main/i18n/locales/en_US/ui.json

@@ -413,6 +413,12 @@
       "duePlaceholder": "Due",
       "clearDue": "Clear due date",
       "noDue": "No due",
+      "cleanupCompleted": "Clean up completed tasks",
+      "cleanupConfirmTitle": "Clean up completed tasks?",
+      "cleanupConfirmMessage": "All completed tasks will be moved to trash. You can restore them until you empty the trash.",
+      "cleanupDone": "Moved {{count}} completed task(s) to trash",
+      "cleanupEmpty": "No completed tasks to clean up",
+      "cleanupError": "Failed to clean up completed tasks",
       "status": {
         "todo": "Todo",
         "inProgress": "In progress",

src/main/i18n/locales/ru_RU/menu.json

@@ -57,7 +57,8 @@
       "ascending": "По возрастанию",
       "descending": "По убыванию"
     },
-    "compactMode": "Компактный список"
+    "compactMode": "Компактный список",
+    "hideCompletedTasks": "Скрывать завершённые задачи"
   },
   "edit": {
     "label": "Правка",

src/main/i18n/locales/ru_RU/preferences.json

@@ -97,7 +97,7 @@
     }
   },
   "notesEditor": {
-    "label": "Редактор заметок",
+    "label": "Заметки",
     "fontSize": {
       "label": "Размер шрифта",
       "description": "Базовый размер шрифта в пикселях для редактора заметок."
@@ -152,6 +152,22 @@
     "label": "Markdown",
     "codeRenderer": "Рендер блоков кода"
   },
+  "tasks": {
+    "label": "Задачи",
+    "autoCleanup": {
+      "label": "Автоочистка завершённых",
+      "description": "Периодически перемещать завершённые задачи в корзину. Они остаются в корзине, пока вы её не очистите.",
+      "never": "Никогда",
+      "1d": "Каждый день",
+      "7d": "Каждые 7 дней",
+      "30d": "Каждые 30 дней"
+    },
+    "cleanupNow": {
+      "label": "Очистить сейчас",
+      "button": "Переместить завершённые в корзину",
+      "description": "Переместить все завершённые задачи в корзину прямо сейчас."
+    }
+  },
   "http": {
     "label": "HTTP Client",
     "wrapLines": {

src/main/i18n/locales/ru_RU/ui.json

@@ -414,6 +414,12 @@
       "duePlaceholder": "Срок",
       "clearDue": "Очистить срок",
       "noDue": "Нет срока",
+      "cleanupCompleted": "Очистить завершённые задачи",
+      "cleanupConfirmTitle": "Очистить завершённые задачи?",
+      "cleanupConfirmMessage": "Все завершённые задачи будут перемещены в корзину. Их можно восстановить, пока корзина не очищена.",
+      "cleanupDone": "Перемещено завершённых задач в корзину: {{count}}",
+      "cleanupEmpty": "Нет завершённых задач для очистки",
+      "cleanupError": "Не удалось очистить завершённые задачи",
       "status": {
         "todo": "К выполнению",
         "inProgress": "В работе",

src/main/index.ts

@@ -12,6 +12,7 @@ import { isQuitting, setQuitting } from './quitState'
 import { startMarkdownWatcher, stopMarkdownWatcher } from './storage'
 import { ensureFlatSpacesLayout } from './storage/providers/markdown/runtime/spaces'
 import { store } from './store'
+import { startTasksCleanupScheduler, stopTasksCleanupScheduler } from './tasks'
 import { checkForUpdates } from './updates'
 import { isSqliteFile, log } from './utils'
 import { DEFAULT_WINDOW_BOUNDS, normalizeWindowBounds } from './windowBounds'
@@ -234,6 +235,13 @@ else {
       log('Error starting markdown watcher', error)
     }
 
+    try {
+      startTasksCleanupScheduler()
+    }
+    catch (error) {
+      log('Error starting tasks cleanup scheduler', error)
+    }
+
     try {
       registerIPC()
     }
@@ -286,6 +294,7 @@ else {
     flushWindowBoundsSave()
     stopThemeWatcher()
     stopMarkdownWatcher()
+    stopTasksCleanupScheduler()
   })
 
   app.on('window-all-closed', () => {

src/main/menu/__tests__/main.test.ts

@@ -62,6 +62,8 @@ describe('createMainMenu', () => {
         contentSortField: 'updatedAt',
         contentSortOrder: 'DESC',
         canToggleCompactMode: true,
+        canToggleHideCompletedTasks: false,
+        isHideCompletedTasksInFolders: false,
         canToggleMindmap: false,
         isCompactMode: true,
         isMindmapShown: false,
@@ -137,6 +139,8 @@ describe('createMainMenu', () => {
         contentSortField: null,
         contentSortOrder: null,
         canToggleCompactMode: false,
+        canToggleHideCompletedTasks: false,
+        isHideCompletedTasksInFolders: false,
         canToggleMindmap: false,
         isCompactMode: false,
         isMindmapShown: false,
@@ -186,6 +190,8 @@ describe('createMainMenu', () => {
         contentSortField: 'createdAt',
         contentSortOrder: 'DESC',
         canToggleCompactMode: true,
+        canToggleHideCompletedTasks: false,
+        isHideCompletedTasksInFolders: false,
         canToggleMindmap: false,
         isCompactMode: false,
         isMindmapShown: false,
@@ -241,6 +247,8 @@ describe('createMainMenu', () => {
         contentSortField: null,
         contentSortOrder: null,
         canToggleCompactMode: true,
+        canToggleHideCompletedTasks: false,
+        isHideCompletedTasksInFolders: false,
         canToggleMindmap: false,
         isCompactMode: true,
         isMindmapShown: false,
@@ -310,6 +318,8 @@ describe('createMainMenu', () => {
         contentSortField: 'createdAt',
         contentSortOrder: 'ASC',
         canToggleCompactMode: false,
+        canToggleHideCompletedTasks: false,
+        isHideCompletedTasksInFolders: false,
         canToggleMindmap: false,
         isCompactMode: false,
         isMindmapShown: false,