Merge pull request #3509 from justise/create-task-line-modal-alltasks

fix: Enable adding dependencies from modal created via API's createTaskLineModal()

Author: claremacrae

docs/Advanced/Tasks Api.md

@@ -151,7 +151,6 @@ This can be used, for example, to display the Auto-Suggest on non-task lines. [S
 
 - Editing tasks:
   - It is not yet possible to use the API to edit an *existing task line* with Tasks [[Create or edit Task|Create or edit task UI]]. We are tracking this in [issue #1945](https://github.com/obsidian-tasks-group/obsidian-tasks/issues/1945).
-  - It is not yet possible to use the API to add [[Task Dependencies|dependencies]] with the Tasks [[Create or edit Task|Create or edit task UI]]. We are tracking this in [issue #2993](https://github.com/obsidian-tasks-group/obsidian-tasks/issues/2993).
 - Auto Suggest:
   - It is not yet possible for [[auto-suggest]] to add [[Task Dependencies|dependencies]] when Auto-Suggest is used in [[Kanban plugin]] cards - or any other plugins that use the [[Tasks Api#Auto-Suggest Integration|Auto-Suggest Integration]]. We are tracking this in [issue #3274](https://github.com/obsidian-tasks-group/obsidian-tasks/issues/3274).
 - Searching tasks:

src/Api/createTaskLineModal.ts

@@ -1,35 +1,17 @@
 import type { App } from 'obsidian';
 import type { Task } from '../Task/Task';
-
-/**
- * Interface to remove all references to {TaskModal} in this file.
- * This is necessary to make {createTaskLineModal} testable.
- * Once Jest is configured to work with Svelte, this can be removed.
- */
-export interface ITaskModal {
-    open(): void;
-}
-
-/**
- * Signature of the factory method for {@link TaskModal}.
- * This is necessary to make {@link createTaskLineModal} testable.
- * Once Jest is configured to work with Svelte, this can be removed.
- */
-export type taskModalFactory = {
-    (app: App, onSubmit: (updatedTasks: Task[]) => void): ITaskModal;
-};
+import { taskFromLine } from '../Commands/CreateOrEditTaskParser';
+import { TaskModal } from '../Obsidian/TaskModal';
 
 /**
  * Opens the Tasks UI and returns the Markdown string for the task entered.
  *
  * @param app - The Obsidian App
- * @param taskModalFactory - Factory method to instantiate {@link TaskModal}. Default value is {@link defaultTaskModalFactory}.
- *                           Used only for testing.
  *
  * @returns {Promise<string>} A promise that contains the Markdown string for the task entered or
  * an empty string, if data entry was cancelled.
  */
-export const createTaskLineModal = (app: App, taskModalFactory: taskModalFactory): Promise<string> => {
+export const createTaskLineModal = (app: App, allTasks: Task[]): Promise<string> => {
     let resolvePromise: (input: string) => void;
     const waitForClose = new Promise<string>((resolve, _) => {
         resolvePromise = resolve;
@@ -40,7 +22,10 @@ export const createTaskLineModal = (app: App, taskModalFactory: taskModalFactory
         resolvePromise(line);
     };
 
-    const taskModal = taskModalFactory(app, onSubmit);
+    const task = taskFromLine({ line: '', path: '' });
+    const taskModal = new TaskModal({ app, task, onSubmit, allTasks });
+
     taskModal.open();
+
     return waitForClose;
 };

src/Api/createTaskLineModalHelper.ts

@@ -1,18 +1,19 @@
-import type { App } from 'obsidian';
+import type TasksPlugin from '../main';
 import { toggleLine } from '../Commands/ToggleDone';
 import { createTaskLineModal } from './createTaskLineModal';
 import type { TasksApiV1 } from './TasksApiV1';
-import { defaultTaskModalFactory } from './createTaskLineModalHelper';
 
 /**
  * Factory method for API v1
  *
  * @param app - The Obsidian App
  */
-export const tasksApiV1 = (app: App): TasksApiV1 => {
+export const tasksApiV1 = (plugin: TasksPlugin): TasksApiV1 => {
+    const app = plugin.app;
+
     return {
         createTaskLineModal: (): Promise<string> => {
-            return createTaskLineModal(app, defaultTaskModalFactory);
+            return createTaskLineModal(app, plugin.getTasks());
         },
         executeToggleTaskDoneCommand: (line: string, path: string) => toggleLine(line, path).text,
     };

src/Api/index.ts

@@ -26,7 +26,7 @@ export default class TasksPlugin extends Plugin {
     public queryRenderer: QueryRenderer | undefined;
 
     get apiV1() {
-        return tasksApiV1(this.app);
+        return tasksApiV1(this);
     }
 
     async onload() {

src/main.ts

@@ -2,79 +2,78 @@ import type { App } from 'obsidian';
 import type { Task } from '../../src/Task/Task';
 import { taskFromLine } from '../../src/Commands/CreateOrEditTaskParser';
 import { createTaskLineModal } from '../../src/Api/createTaskLineModal';
-import type { ITaskModal, taskModalFactory } from '../../src/Api/createTaskLineModal';
+import { TaskModal } from '../__mocks__/TaskModal';
 
 const app = {} as App;
 
-class TaskModalMock implements ITaskModal {
-    public task: Task;
-    public onSubmit: (updatedTasks: Task[]) => void;
-    public openWasCalled: boolean = false;
-
-    constructor() {
-        this.task = createNewTask();
-        this.onSubmit = (_: Task[]) => {};
-    }
-
-    public open() {
-        this.openWasCalled = true;
-    }
-
-    // helper method to simulate pressing the submit button
-    public submit() {
-        this.onSubmit([this.task]);
-    }
-
-    // helper method to simulate pressing the cancel button
-    public cancel() {
-        this.onSubmit([]);
-    }
-}
-
 const createNewTask = (line = ''): Task => {
     return taskFromLine({ line, path: '' });
 };
 
-function mockModalFactory(modalMock: TaskModalMock) {
-    return (_: App, onSubmit: (updatedTasks: Task[]) => void): ITaskModal => {
-        modalMock.onSubmit = onSubmit;
-        return modalMock;
+jest.mock('../../src/Obsidian/TaskModal', () => {
+    return {
+        TaskModal: jest.fn(
+            ({
+                app,
+                task,
+                onSubmit,
+                allTasks,
+            }: {
+                app: App;
+                task: Task;
+                onSubmit: (updatedTasks: Task[]) => void;
+                allTasks: Task[];
+            }) => {
+                return new TaskModal({ app, task, onSubmit, allTasks });
+            },
+        ),
     };
-}
+});
 
 describe('APIv1 - createTaskLineModal', () => {
-    let modalMock: TaskModalMock;
-    let modalFactory: taskModalFactory;
-
     beforeEach(() => {
-        modalMock = new TaskModalMock();
-        modalFactory = mockModalFactory(modalMock);
+        jest.clearAllMocks();
     });
 
+    /**
+     * When we ask to create the task line modal, it should call open() on the TaskModal instance.
+     */
     it('TaskModal.open() should be called', () => {
-        createTaskLineModal(app, modalFactory);
-        expect(modalMock.openWasCalled).toBeTruthy();
+        createTaskLineModal(app, []);
+
+        expect(TaskModal.instance.open).toHaveBeenCalledTimes(1);
     });
 
+    /**
+     * If the Modal returns the expected text, the api function createTaskLineModal() returns that text
+     */
     it('should return the Markdown for a task if submitted', async () => {
-        const taskLinePromise = createTaskLineModal(app, modalFactory);
+        const taskLinePromise = createTaskLineModal(app, []);
         const expected = '- [ ] test';
 
-        modalMock.task = createNewTask(expected);
-        modalMock.submit();
+        TaskModal.instance.onSubmit([createNewTask(expected)]);
         const result = await taskLinePromise;
 
         expect(result).toEqual(expected);
     });
 
+    /**
+     * If the Modal is cancelled, the api function createTaskLineModal() should return an empty string
+     */
     it('should return an empty string if cancelled', async () => {
-        const taskLinePromise = createTaskLineModal(app, mockModalFactory(modalMock));
+        const taskLinePromise = createTaskLineModal(app, []);
         const expected = '';
 
-        modalMock.task = createNewTask(expected);
-        modalMock.cancel();
+        TaskModal.instance.cancel();
 
         const result = await taskLinePromise;
         expect(result).toEqual(expected);
     });
+
+    it('should pass allTasks to TaskModal', async () => {
+        const allTasks = [createNewTask('- [ ] test')];
+        createTaskLineModal(app, allTasks);
+
+        expect(TaskModal.instance.allTasks).toEqual(allTasks);
+    });
 });

tests/Api/createTaskLineModal.test.ts

@@ -3,7 +3,7 @@
  */
 
 import moment from 'moment';
-import type { App } from 'obsidian';
+import type TasksPlugin from '../../src/main';
 import { tasksApiV1 } from '../../src/Api';
 
 // This needs to be mocked because the API imports TaskModal which extends Obsidian's Modal
@@ -24,7 +24,7 @@ describe('APIv1 - executeToggleTaskDoneCommand', () => {
         jest.useRealTimers();
     });
 
-    const api = tasksApiV1({} as App);
+    const api = tasksApiV1({} as TasksPlugin);
 
     // This is a simple smoke test to make sure executeToggleTaskDoneCommand is working. Its core
     // functionality is covered by other tests

tests/Api/executeToggleTaskDoneCommand.test.ts

@@ -0,0 +1,26 @@
+import type { App } from 'obsidian';
+import type TasksPlugin from '../../src/main';
+import type { Task } from '../../src/Task/Task';
+import { createTaskLineModal } from '../../src/Api/createTaskLineModal';
+import { tasksApiV1 } from '../../src/Api/index';
+
+jest.mock('../../src/Api/createTaskLineModal', () => ({
+    createTaskLineModal: jest.fn(),
+}));
+
+describe('definition of public Api', () => {
+    it('should call createTaskLineModal with the app and allTasks', async () => {
+        const task = jest.fn();
+        const app = {} as App; // Mock the app object
+        const tasks = [task as Partial<Task>];
+        const mockPlugin = {
+            getTasks: () => tasks,
+            app,
+        } as Partial<TasksPlugin> as TasksPlugin;
+
+        const publicApi = tasksApiV1(mockPlugin);
+
+        await publicApi.createTaskLineModal();
+        expect(createTaskLineModal).toHaveBeenCalledWith(app, tasks);
+    });
+});

tests/Api/index.test.ts

@@ -0,0 +1,39 @@
+import type { App } from 'obsidian';
+import type { Task } from '../../src/Task/Task';
+
+/**
+ * {@link TaskModal} needs to be mocked, because it depends on {@link obsidian.Modal}, which is not available.
+ */
+export class TaskModal {
+    public static instance: TaskModal;
+    public readonly app: App;
+    public readonly task: Task;
+    public readonly onSubmit: (updateTasks: Task[]) => void;
+    public readonly allTasks: Task[];
+
+    public readonly open: () => void;
+
+    constructor({
+        app,
+        task,
+        onSubmit,
+        allTasks,
+    }: {
+        app: App;
+        task: Task;
+        onSubmit: (updatedTasks: Task[]) => void;
+        allTasks?: Task[];
+    }) {
+        this.app = app;
+        this.task = task;
+        this.onSubmit = onSubmit;
+        this.open = jest.fn();
+        this.allTasks = allTasks || [];
+
+        TaskModal.instance = this;
+    }
+
+    public cancel(): void {
+        this.onSubmit([]);
+    }
+}