Merge pull request #3189 from obsidian-tasks-group/refactor-remove-old-code

refactor: Remove unused Flatpickr code from Edit Task modal

Author: claremacrae

src/Obsidian/TaskModal.ts

@@ -1,21 +1,14 @@
 import { App, Modal } from 'obsidian';
-import type flatpickr from 'flatpickr';
 
 import EditTask from '../ui/EditTask.svelte';
 import type { Task } from '../Task/Task';
 import { StatusRegistry } from '../Statuses/StatusRegistry';
 import { Status } from '../Statuses/Status';
 
-export interface IFlatpickrUser {
-    setActiveFlatpickrInstance(instance: flatpickr.Instance): void;
-    clearActiveFlatpickrInstance(): void;
-}
-
-export class TaskModal extends Modal implements IFlatpickrUser {
+export class TaskModal extends Modal {
     public readonly task: Task;
     public readonly onSubmit: (updatedTasks: Task[]) => void;
     public readonly allTasks: Task[];
-    private activeFlatpickrInstance: flatpickr.Instance | null = null;
 
     constructor({
         app,
@@ -33,13 +26,6 @@ export class TaskModal extends Modal implements IFlatpickrUser {
         this.task = task;
         this.allTasks = allTasks;
         this.onSubmit = (updatedTasks: Task[]) => {
-            if (this.activeFlatpickrInstance) {
-                // Ignore onSubmit if the date-picker is open:
-                // For some unknown reason, making the date-picker lunched from a Button
-                // caused the modal to be automatically submitted before the user had
-                // even seen the date picker.
-                return;
-            }
             updatedTasks.length && onSubmit(updatedTasks);
             this.close();
         };
@@ -61,7 +47,6 @@ export class TaskModal extends Modal implements IFlatpickrUser {
                 statusOptions: statusOptions,
                 onSubmit: this.onSubmit,
                 allTasks: this.allTasks,
-                modal: this,
             },
         });
     }
@@ -84,25 +69,4 @@ export class TaskModal extends Modal implements IFlatpickrUser {
         const { contentEl } = this;
         contentEl.empty();
     }
-
-    /**
-     * Make sure that if the date picker is open, an Escape key only closes
-     * the date-picker, and not the EditTask modal as well.
-     */
-    public onEscapeKey(): void {
-        if (this.activeFlatpickrInstance?.isOpen) {
-            this.activeFlatpickrInstance.close();
-            this.activeFlatpickrInstance = null;
-        } else {
-            this.close();
-        }
-    }
-
-    public setActiveFlatpickrInstance(instance: flatpickr.Instance): void {
-        this.activeFlatpickrInstance = instance;
-    }
-
-    public clearActiveFlatpickrInstance(): void {
-        this.activeFlatpickrInstance = null;
-    }
 }

src/ui/EditTask.svelte

@@ -1,11 +1,9 @@
 <script lang="ts">
     import { onMount } from 'svelte';
-    import type flatpickr from 'flatpickr';
 
     import { TASK_FORMATS, getSettings } from '../Config/Settings';
     import type { Status } from '../Statuses/Status';
     import type { Task } from '../Task/Task';
-    import type { IFlatpickrUser } from '../Obsidian/TaskModal';
     import DateEditor from './DateEditor.svelte';
     import Dependency from './Dependency.svelte';
     import { EditableTask } from './EditableTask';
@@ -18,7 +16,6 @@
     export let onSubmit: (updatedTasks: Task[]) => void | Promise<void>;
     export let statusOptions: Status[];
     export let allTasks: Task[];
-    export let modal: IFlatpickrUser | null = null;
 
     const {
         // NEW_TASK_FIELD_EDIT_REQUIRED
@@ -149,18 +146,6 @@
         const newTasks = await editableTask.applyEdits(task, allTasks);
         onSubmit(newTasks);
     };
-
-    function handleOpen(event: CustomEvent<{ instance: flatpickr.Instance }>) {
-        if (modal) {
-            modal.setActiveFlatpickrInstance(event.detail.instance);
-        }
-    }
-
-    function handleClose() {
-        if (modal) {
-            modal.clearActiveFlatpickrInstance();
-        }
-    }
 </script>
 
 <!--
@@ -269,8 +254,6 @@ Availability of access keys:
             bind:isDateValid={isDueDateValid}
             forwardOnly={editableTask.forwardOnly}
             accesskey={accesskey('d')}
-            on:open={handleOpen}
-            on:close={handleClose}
         />
 
         <!-- --------------------------------------------------------------------------- -->
@@ -283,8 +266,6 @@ Availability of access keys:
             bind:isDateValid={isScheduledDateValid}
             forwardOnly={editableTask.forwardOnly}
             accesskey={accesskey('s')}
-            on:open={handleOpen}
-            on:close={handleClose}
         />
 
         <!-- --------------------------------------------------------------------------- -->
@@ -297,8 +278,6 @@ Availability of access keys:
             bind:isDateValid={isStartDateValid}
             forwardOnly={editableTask.forwardOnly}
             accesskey={accesskey('a')}
-            on:open={handleOpen}
-            on:close={handleClose}
         />
 
         <!-- --------------------------------------------------------------------------- -->
@@ -372,8 +351,6 @@ Availability of access keys:
             bind:isDateValid={isCreatedDateValid}
             forwardOnly={editableTask.forwardOnly}
             accesskey={accesskey('c')}
-            on:open={handleOpen}
-            on:close={handleClose}
         />
 
         <!-- --------------------------------------------------------------------------- -->
@@ -386,8 +363,6 @@ Availability of access keys:
             bind:isDateValid={isDoneDateValid}
             forwardOnly={editableTask.forwardOnly}
             accesskey={accesskey('x')}
-            on:open={handleOpen}
-            on:close={handleClose}
         />
 
         <!-- --------------------------------------------------------------------------- -->
@@ -400,8 +375,6 @@ Availability of access keys:
             bind:isDateValid={isCancelledDateValid}
             forwardOnly={editableTask.forwardOnly}
             accesskey={accesskey('-')}
-            on:open={handleOpen}
-            on:close={handleClose}
         />
     </section>
 

tests/ui/EditTask.test.ts

@@ -48,7 +48,6 @@ function renderAndCheckModal(task: Task, onSubmit: (updatedTasks: Task[]) => voi
         statusOptions: StatusRegistry.getInstance().registeredStatuses,
         onSubmit,
         allTasks,
-        modal: null,
     });
     const { container } = result;
     expect(() => container).toBeTruthy();