Merge pull request #3556 from obsidian-tasks-group/fix-isLinkTo

fix: `Link.isLinkTo()` now works when passed `TasksFile` objects

Author: claremacrae

resources/sample_vaults/Tasks-Demo/How To/Access links.md

@@ -102,8 +102,6 @@ filter by function task.outlinks.some(link => link.destinationPath === query.fil
 
 This should match one task, in [[Link to Access links file]].
 
-There is a bug: this does not yet find the task it should do.
-
 ````text
 ```tasks
 filter by function task.outlinks.some(link => link.isLinkTo(query.file))

resources/sample_vaults/Tasks-Demo/Test Data/link_in_task_wikilink_different_case.md

@@ -0,0 +1,3 @@
+# link_in_task_wikilink_different_case
+
+- [ ] #task Task in 'link_in_task_wikilink_different_case' [[liNk_in_YaMl]]

src/Task/Link.ts

@@ -95,6 +95,9 @@ export class Link {
             return false;
         }
 
-        return this.isLinkTo(destination.path);
+        // Links only match if they resolve to the full path,
+        // thus distinguishing between multiple identically named files
+        // in different folders in the vault.
+        return this.destinationPath === destination.path;
     }
 }

tests/Obsidian/AllCacheSampleData.ts

@@ -47,6 +47,7 @@ import link_in_heading from './__test_data__/link_in_heading.json';
 import link_in_task_html from './__test_data__/link_in_task_html.json';
 import link_in_task_markdown_link from './__test_data__/link_in_task_markdown_link.json';
 import link_in_task_wikilink from './__test_data__/link_in_task_wikilink.json';
+import link_in_task_wikilink_different_case from './__test_data__/link_in_task_wikilink_different_case.json';
 import link_in_yaml from './__test_data__/link_in_yaml.json';
 import link_is_broken from './__test_data__/link_is_broken.json';
 import links_everywhere from './__test_data__/links_everywhere.json';
@@ -144,6 +145,7 @@ export function allCacheSampleData(): SimulatedFile[] {
         link_in_task_html,
         link_in_task_markdown_link,
         link_in_task_wikilink,
+        link_in_task_wikilink_different_case,
         link_in_yaml,
         link_is_broken,
         links_everywhere,

tests/Obsidian/__test_data__/link_in_task_wikilink_different_case.json

@@ -0,0 +1,117 @@
+{
+  "cachedMetadata": {
+    "headings": [
+      {
+        "heading": "link_in_task_wikilink_different_case",
+        "level": 1,
+        "position": {
+          "end": {
+            "col": 38,
+            "line": 0,
+            "offset": 38
+          },
+          "start": {
+            "col": 0,
+            "line": 0,
+            "offset": 0
+          }
+        }
+      }
+    ],
+    "links": [
+      {
+        "displayText": "liNk_in_YaMl",
+        "link": "liNk_in_YaMl",
+        "original": "[[liNk_in_YaMl]]",
+        "position": {
+          "end": {
+            "col": 75,
+            "line": 2,
+            "offset": 115
+          },
+          "start": {
+            "col": 59,
+            "line": 2,
+            "offset": 99
+          }
+        }
+      }
+    ],
+    "listItems": [
+      {
+        "parent": -2,
+        "position": {
+          "end": {
+            "col": 75,
+            "line": 2,
+            "offset": 115
+          },
+          "start": {
+            "col": 0,
+            "line": 2,
+            "offset": 40
+          }
+        },
+        "task": " "
+      }
+    ],
+    "sections": [
+      {
+        "position": {
+          "end": {
+            "col": 38,
+            "line": 0,
+            "offset": 38
+          },
+          "start": {
+            "col": 0,
+            "line": 0,
+            "offset": 0
+          }
+        },
+        "type": "heading"
+      },
+      {
+        "position": {
+          "end": {
+            "col": 75,
+            "line": 2,
+            "offset": 115
+          },
+          "start": {
+            "col": 0,
+            "line": 2,
+            "offset": 40
+          }
+        },
+        "type": "list"
+      }
+    ],
+    "tags": [
+      {
+        "position": {
+          "end": {
+            "col": 11,
+            "line": 2,
+            "offset": 51
+          },
+          "start": {
+            "col": 6,
+            "line": 2,
+            "offset": 46
+          }
+        },
+        "tag": "#task"
+      }
+    ]
+  },
+  "fileContents": "# link_in_task_wikilink_different_case\n\n- [ ] #task Task in 'link_in_task_wikilink_different_case' [[liNk_in_YaMl]]\n",
+  "filePath": "Test Data/link_in_task_wikilink_different_case.md",
+  "getAllTags": [
+    "#task"
+  ],
+  "parseFrontMatterTags": null,
+  "resolveLinkToPath": {
+    "liNk_in_YaMl": "Test Data/link_in_yaml.md"
+  }
+}

tests/Obsidian/__test_data__/metadataCache/resolvedLinks.json

@@ -16,7 +16,9 @@
   "Functions/Custom Filters With Simple Caching.md": {},
   "Functions/Custom Sorting.md": {},
   "Functions/Fields for Functions - Demo.md": {},
-  "How To/Access links.md": {},
+  "How To/Access links.md": {
+    "Test Attachments/Link to Access links file.md": 2
+  },
   "How To/Access properties in frontmatter.md": {},
   "How To/Find properties not read by Obsidian 1.9.x/README.md": {},
   "How To/Find tasks in notes with particular tag.md": {},
@@ -127,6 +129,9 @@
   "Styling/Theme - Minimal Theme.md": {},
   "Styling/Theme - Things Theme.md": {},
   "Tasks.md": {},
+  "Test Attachments/Link to Access links file.md": {
+    "How To/Access links.md": 1
+  },
   "Test Attachments/markdownLink.md": {
     "Test Data/all_link_types.md": 1
   },
@@ -207,6 +212,9 @@
     "Test Data/multiple_headings.md": 1,
     "Test Attachments/a_pdf_file.pdf": 1
   },
+  "Test Data/link_in_task_wikilink_different_case.md": {
+    "Test Data/link_in_yaml.md": 1
+  },
   "Test Data/link_in_yaml.md": {
     "Test Data/yaml_tags_is_empty.md": 1
   },

tests/Obsidian/__test_data__/metadataCache/unresolvedLinks.json

@@ -101,6 +101,7 @@
   "Styling/Theme - Minimal Theme.md": {},
   "Styling/Theme - Things Theme.md": {},
   "Tasks.md": {},
+  "Test Attachments/Link to Access links file.md": {},
   "Test Attachments/markdownLink.md": {},
   "Test Attachments/wikilink.md": {},
   "Test Data/all_link_types.md": {},
@@ -153,6 +154,7 @@
     "|": 2,
     "|alias": 1
   },
+  "Test Data/link_in_task_wikilink_different_case.md": {},
   "Test Data/link_in_yaml.md": {},
   "Test Data/link_is_broken.md": {
     "broken link - do not fix me": 1

tests/Task/Link.test.ts

@@ -2,8 +2,10 @@ import type { Reference } from 'obsidian';
 import { TasksFile } from '../../src/Scripting/TasksFile';
 import { Link } from '../../src/Task/Link';
 import internal_heading_links from '../Obsidian/__test_data__/internal_heading_links.json';
+import link_in_heading from '../Obsidian/__test_data__/link_in_heading.json';
 import link_in_task_markdown_link from '../Obsidian/__test_data__/link_in_task_markdown_link.json';
 import link_in_task_wikilink from '../Obsidian/__test_data__/link_in_task_wikilink.json';
+import link_is_broken from '../Obsidian/__test_data__/link_is_broken.json';
 
 import link_in_file_body from '../Obsidian/__test_data__/link_in_file_body.json';
 import links_everywhere from '../Obsidian/__test_data__/links_everywhere.json';
@@ -13,11 +15,12 @@ import { addBackticks, formatToRepresentType } from '../Scripting/ScriptingTestH
 import { getTasksFileFromMockData } from '../TestingTools/MockDataHelpers';
 import { verifyMarkdown } from '../TestingTools/VerifyMarkdown';
 import { LinkResolver } from '../../src/Task/LinkResolver';
-import { getFirstLinkpathDest } from '../__mocks__/obsidian';
+import { getFirstLinkpathDest, getFirstLinkpathDestFromData } from '../__mocks__/obsidian';
 
 function getLink(data: any, index: number) {
     const rawLink = data.cachedMetadata.links[index];
-    return new Link(rawLink, data.filePath);
+    const destinationPath = getFirstLinkpathDestFromData(data, rawLink);
+    return new Link(rawLink, data.filePath, destinationPath);
 }
 
 describe('linkClass', () => {
@@ -33,6 +36,18 @@ describe('linkClass', () => {
         expect(link.isLinkTo('link_in_file_body.md')).toEqual(true);
     });
 
+    describe('getLink() configures Link.destinationPath automatically', () => {
+        it('should set the full path for a resolved link', () => {
+            const link = getLink(link_in_heading, 0);
+            expect(link.destinationPath).toEqual('Test Data/multiple_headings.md');
+        });
+
+        it('should not set the full path for a broken/unresolved link', () => {
+            const link = getLink(link_is_broken, 0);
+            expect(link.destinationPath).toEqual(null);
+        });
+    });
+
     describe('return markdown to navigate to a link', () => {
         // These links are useful
         it('should return the filename if simple [[filename]]', () => {
@@ -300,12 +315,12 @@ describe('linkClass', () => {
             expect(linkToAFolder.isLinkTo('Test Data/link_in_task_wikilink.md')).toEqual(true);
         });
 
-        it('matches TasksFile', () => {
+        it('matches TasksFile - only exact paths match', () => {
             const linkToAFolder = getLink(link_in_task_wikilink, 2);
             expect(linkToAFolder.originalMarkdown).toMatchInlineSnapshot('"[[Test Data/link_in_task_wikilink]]"');
 
             expect(linkToAFolder.isLinkTo(new TasksFile('Test Data/link_in_task_wikilink.md'))).toEqual(true);
-            expect(linkToAFolder.isLinkTo(new TasksFile('link_in_task_wikilink.md'))).toEqual(true);
+            expect(linkToAFolder.isLinkTo(new TasksFile('link_in_task_wikilink.md'))).toEqual(false);
             expect(linkToAFolder.isLinkTo(new TasksFile('Wrong Test Data/link_in_task_wikilink.md'))).toEqual(false);
             expect(linkToAFolder.isLinkTo(new TasksFile('something_obviously_different.md'))).toEqual(false);
         });

tests/Task/Link.test.visualise_links_note_bodies.approved.md

@@ -380,6 +380,14 @@
 `link.destinationPath      `: `'null'`
 `link.displayText          `: `'| > alias'`
 
+## Test Data/link_in_task_wikilink_different_case.md
+
+`link.originalMarkdown     `: `'[[liNk_in_YaMl]]'`
+`link.markdown             `: `'[[liNk_in_YaMl]]'`
+`link.destination          `: `'liNk_in_YaMl'`
+`link.destinationPath      `: `'Test Data/link_in_yaml.md'`
+`link.displayText          `: `'liNk_in_YaMl'`
+
 ## Test Data/link_is_broken.md
 
 `link.originalMarkdown     `: `'[[broken link - do not fix me]]'`

tests/Task/Link.test.visualise_links_outlinks.approved.md

@@ -400,6 +400,14 @@
 `link.destinationPath      `: `'null'`
 `link.displayText          `: `'| > alias'`
 
+## Test Data/link_in_task_wikilink_different_case.md
+
+`link.originalMarkdown     `: `'[[liNk_in_YaMl]]'`
+`link.markdown             `: `'[[liNk_in_YaMl]]'`
+`link.destination          `: `'liNk_in_YaMl'`
+`link.destinationPath      `: `'Test Data/link_in_yaml.md'`
+`link.displayText          `: `'liNk_in_YaMl'`
+
 ## Test Data/link_in_yaml.md
 
 `link.originalMarkdown     `: `'[[yaml_tags_is_empty]]'`