Merge pull request #3555 from obsidian-tasks-group/store-destination-path

feat: Add `Link.destinationPath`

Author: claremacrae

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

@@ -1,8 +1,6 @@
 ---
 TQ_short_mode: true
-TQ_extra_instructions: |-
-  group by folder
-  group by function task.file.filenameWithoutExtension
+TQ_extra_instructions:
 ---
 
 # Accessing Links
@@ -16,6 +14,14 @@ TQ_extra_instructions: |-
 
 ### `task.outlinks`: Task lines containing an outgoing link
 
+````text
+```tasks
+# Task line has a link
+filter by function task.outlinks.length > 0
+limit groups 1
+```
+````
+
 ```tasks
 # Task line has a link
 filter by function task.outlinks.length > 0
@@ -24,32 +30,132 @@ limit groups 1
 
 ### `task.file.outlinksInProperties`: Tasks in files whose properties/frontmatter contains a link
 
+````text
+```tasks
+filter by function task.file.outlinksInProperties.length > 0
+limit groups 1
+```
+````
+
 ```tasks
 filter by function task.file.outlinksInProperties.length > 0
 limit groups 1
 ```
 
 ### `task.file.outlinksInBody`: Tasks in files whose markdown body contains a link
 
+````text
+```tasks
+filter by function task.file.outlinksInBody.length > 0
+limit groups 1
+```
+````
+
 ```tasks
 filter by function task.file.outlinksInBody.length > 0
 limit groups 1
 ```
 
 ### `task.file.outlinks`: Tasks in files whose file contains a link anywhere
 
+````text
+```tasks
+filter by function task.file.outlinks.length > 0
+limit groups 1
+```
+````
+
 ```tasks
 filter by function task.file.outlinks.length > 0
 limit groups 1
 ```
 
+### Task lines that contain broken links
+
+````text
+```tasks
+filter by function task.outlinks.some(link => link.destinationPath === null)
+```
+````
+
+```tasks
+filter by function task.outlinks.some(link => link.destinationPath === null)
+```
+
+### Tasks lines that link to the file containing the query
+
+#### Tasks - version 1
+
+This should match one task, in [[Link to Access links file]].
+
+````text
+```tasks
+filter by function task.outlinks.some(link => link.destinationPath === query.file.path)
+```
+````
+
+```tasks
+filter by function task.outlinks.some(link => link.destinationPath === query.file.path)
+```
+
+#### Tasks - version 2
+
+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))
+```
+````
+
+```tasks
+filter by function task.outlinks.some(link => link.isLinkTo(query.file))
+```
+
+#### Dataview version
+
+````text
+```dataview
+TASK
+WHERE contains(file.outlinks, this.file.link)
+```
+````
+
+```dataview
+TASK
+WHERE contains(file.outlinks, this.file.link)
+```
+
 ## Grouping
 
 ### Group by task outlinks
 
+````text
 ```tasks
-# Task line has a link
 filter by function task.outlinks.length > 0
 group by function task.outlinks.map(link => link.markdown).sort().join(' · ')
-limit groups 1
+```
+````
+
+```tasks
+filter by function task.outlinks.length > 0
+group by function task.outlinks.map(link => link.markdown).sort().join(' · ')
+```
+
+### Group tasks by the files they link to
+
+The value of `link.destinationPath`  is null if the link is broken.
+
+````text
+```tasks
+filter by function task.outlinks.length > 0
+group by function task.outlinks.map(link => link.destinationPath).sort().join(' · ')
+```
+````
+
+```tasks
+filter by function task.outlinks.length > 0
+group by function task.outlinks.map(link => link.destinationPath).sort().join(' · ')
 ```

resources/sample_vaults/Tasks-Demo/Test Attachments/Link to Access links file.md

@@ -0,0 +1,3 @@
+# Link to Access links file
+
+- [ ] #task I link to [[Access links]]

resources/sample_vaults/Tasks-Demo/Test Attachments/markdownLink.md

@@ -0,0 +1,9 @@
+# markdownLink
+
+This file exists to ensure all links in [[all_link_types]] exist.
+
+## heading
+
+### sub-heading
+
+block ^block

resources/sample_vaults/Tasks-Demo/Test Attachments/wikilink.md

@@ -0,0 +1,9 @@
+# wikilink
+
+This file exists to ensure all links in [[all_link_types]] exist.
+
+## heading
+
+### sub-heading
+
+block ^block

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

@@ -0,0 +1,37 @@
+# all_link_types
+
+1. [ ] #task 1 in 'all_link_types' [markdownLink](markdownLink.md)
+2. [ ] #task 2 in 'all_link_types' [markdownLink with alias](markdownLink.md)
+
+3. [ ] #task 3 in 'all_link_types' [[wikilink]]
+4. [ ] #task 4 in 'all_link_types' [[wikilink|wikilink with alias]]
+
+5. [ ] #task 5 in 'all_link_types' [[#heading]]
+6. [ ] #task 6 in 'all_link_types' [[#heading|internal wikilink with alias and heading]]
+7. [ ] #task 7 in 'all_link_types' [[#heading#sub-heading]]
+8. [ ] #task 7 in 'all_link_types' [[#heading#sub-heading||internal wikilink with alias and two headings]]
+
+9. [ ] #task 8 in 'all_link_types' [[wikilink#heading]]
+10. [ ] #task 9 in 'all_link_types' [[wikilink#heading|wikilink with alias and heading]]
+11. [ ] #task 10 in 'all_link_types' [[wikilink#heading#sub-heading]]
+12. [ ] #task 11 in 'all_link_types' [[wikilink#heading#sub-heading|wikilink with alias and two headings]]
+
+13. [ ] #task 12 in 'all_link_types' [markdownLink](markdownLink.md#heading)
+14. [ ] #task 13 in 'all_link_types' [markdownLink with alias and heading](markdownLink.md#heading)
+15. [ ] #task 14 in 'all_link_types' [markdownLink](markdownLink.md#heading#sub-heading)
+16. [ ] #task 15 in 'all_link_types' [markdownLink with alias and two headings](markdownLink.md#heading#sub-heading)
+
+17. [ ] #task 16 in 'all_link_types' [[#^block]]
+18. [ ] #task 17 in 'all_link_types' [[#^block|wikilink with alias and block]]
+
+19. [ ] #task 18 in 'all_link_types' [[wikilink#^block]]
+20. [ ] #task 19 in 'all_link_types' [[wikilink#^block|wikilink with alias and block]]
+
+21. [ ] #task 20 in 'all_link_types' [markdownLink](markdownLink.md#^block)
+22. [ ] #task 21 in 'all_link_types' [markdownLink with alias and block](markdownLink.md#^block)
+
+## heading
+
+### sub-heading
+
+block ^block

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

@@ -0,0 +1,3 @@
+# embed_link_in_task
+
+- [ ] #task Task in 'embed_link_in_task' ![[empty_yaml]]

resources/sample_vaults/Tasks-Demo/_meta/templater_scripts/convert_test_data_markdown_to_js.js

@@ -2,6 +2,7 @@ const fs = require('node:fs');
 const path = require('node:path');
 
 const vault = app.vault;
+const metadataCache = app.metadataCache;
 
 async function getMarkdownFiles() {
     // Get all files from Test Data/ directory
@@ -13,6 +14,12 @@ function getBasename(filePath) {
     return path.basename(filePath, '.md');
 }
 
+function writeDataAsJson(outputPath, sortedData) {
+    const testSourceFile = getOutputFilePath(outputPath);
+    const content = JSON.stringify(sortedData, null, 2);
+    writeFile(testSourceFile, content);
+}
+
 function getOutputFilePath(outputFile) {
     const rootOfVault = vault.adapter.getBasePath();
     return path.join(rootOfVault, '../../../tests/Obsidian', outputFile);
@@ -48,6 +55,21 @@ function sortObjectKeys(obj) {
     return obj;
 }
 
+/**
+ * Sorts an object's keys in alphabetical order at the top level only.
+ */
+function sortTopLevelKeys(obj) {
+    if (obj && typeof obj === 'object' && !Array.isArray(obj)) {
+        return Object.keys(obj)
+            .sort()
+            .reduce((acc, key) => {
+                acc[key] = obj[key]; // No recursive call here
+                return acc;
+            }, {});
+    }
+    return obj;
+}
+
 async function convertMarkdownFileToTestFunction(filePath, tp) {
     const tFile = vault.getAbstractFileByPath(filePath);
 
@@ -63,7 +85,24 @@ async function convertMarkdownFileToTestFunction(filePath, tp) {
 
     const getAllTags = tp.obsidian.getAllTags(cachedMetadata);
     const parseFrontMatterTags = tp.obsidian.parseFrontMatterTags(cachedMetadata.frontmatter);
-    const data = { filePath, fileContents, cachedMetadata, getAllTags, parseFrontMatterTags };
+
+    // Resolve all links in body of this file
+    const allLinks = [...(cachedMetadata.links ?? []), ...(cachedMetadata.frontmatterLinks ?? [])];
+    const resolveLinkToPath = {};
+    allLinks.forEach((link) => {
+        const linkpath = tp.obsidian.getLinkpath(link.link);
+        const tFile = app.metadataCache.getFirstLinkpathDest(linkpath, filePath);
+        resolveLinkToPath[link.link] = tFile ? tFile.path : null;
+    });
+
+    const data = {
+        filePath,
+        fileContents,
+        cachedMetadata,
+        getAllTags,
+        parseFrontMatterTags,
+        resolveLinkToPath,
+    };
 
     const filename = getBasename(filePath);
     if (filename.includes(' ')) {
@@ -77,12 +116,10 @@ async function convertMarkdownFileToTestFunction(filePath, tp) {
         return '';
     }
 
-    const testSourceFile = getOutputFilePath(`__test_data__/${filename}.json`);
-
     // Sort keys in the data object to ensure stable order
     const sortedData = sortObjectKeys(data);
-    const content = JSON.stringify(sortedData, null, 2);
-    writeFile(testSourceFile, content);
+
+    writeDataAsJson(`__test_data__/${filename}.json`, sortedData);
 }
 
 async function writeListOfAllTestFunctions(files) {
@@ -118,6 +155,12 @@ ${functions.join('\n')}
     writeFile(testSourceFile, content);
 }
 
+function writeMetadataCacheData() {
+    const outputPath = '__test_data__/metadataCache/';
+    writeDataAsJson(outputPath + 'resolvedLinks.json', sortTopLevelKeys(metadataCache.resolvedLinks));
+    writeDataAsJson(outputPath + 'unresolvedLinks.json', sortTopLevelKeys(metadataCache.unresolvedLinks));
+}
+
 async function export_files(tp) {
     const markdownFiles = await getMarkdownFiles();
 
@@ -127,6 +170,8 @@ async function export_files(tp) {
 
     await writeListOfAllTestFunctions(markdownFiles);
 
+    writeMetadataCacheData();
+
     showNotice('Success.');
     return '';
 }

src/Scripting/TasksFile.ts

@@ -1,5 +1,6 @@
-import { type CachedMetadata, type FrontMatterCache, getAllTags, parseFrontMatterTags } from 'obsidian';
-import { Link } from '../Task/Link';
+import { type CachedMetadata, type FrontMatterCache, type Reference, getAllTags, parseFrontMatterTags } from 'obsidian';
+import type { Link } from '../Task/Link';
+import { LinkResolver } from '../Task/LinkResolver';
 
 export type OptionalTasksFile = TasksFile | undefined;
 
@@ -13,6 +14,9 @@ export class TasksFile {
     private readonly _frontmatter = { tags: [] } as any;
     private readonly _tags: string[] = [];
 
+    private readonly _outlinksInProperties: Readonly<Link[]> = [];
+    private readonly _outlinksInBody: Readonly<Link[]> = [];
+
     constructor(path: string, cachedMetadata: CachedMetadata = {}) {
         this._path = path;
         this._cachedMetadata = cachedMetadata;
@@ -22,13 +26,19 @@ export class TasksFile {
             this._frontmatter = JSON.parse(JSON.stringify(rawFrontmatter));
             this._frontmatter.tags = parseFrontMatterTags(rawFrontmatter) ?? [];
         }
+        this._outlinksInProperties = this.createLinks(this.cachedMetadata.frontmatterLinks);
+        this._outlinksInBody = this.createLinks(this.cachedMetadata.links);
 
         if (Object.keys(cachedMetadata).length !== 0) {
             const tags = getAllTags(this.cachedMetadata) ?? [];
             this._tags = [...new Set(tags)];
         }
     }
 
+    private createLinks(obsidianRawLinks: Reference[] | undefined) {
+        return obsidianRawLinks?.map((link) => LinkResolver.getInstance().resolve(link, this.path)) ?? [];
+    }
+
     /**
      * Return the path to the file.
      */
@@ -60,15 +70,15 @@ export class TasksFile {
     /**
      * Return an array of {@link Link} in the file's properties/frontmatter.
      */
-    get outlinksInProperties(): Link[] {
-        return this.cachedMetadata.frontmatterLinks?.map((link) => new Link(link, this.path)) ?? [];
+    get outlinksInProperties(): Readonly<Link[]> {
+        return this._outlinksInProperties;
     }
 
     /**
      * Return an array of {@link Link} in the body of the file.
      */
-    get outlinksInBody(): Link[] {
-        return this.cachedMetadata?.links?.map((link) => new Link(link, this.path)) ?? [];
+    get outlinksInBody(): Readonly<Link[]> {
+        return this._outlinksInBody;
     }
 
     /**