Merge pull request #11 from hadynz/no-index-warn

Gracefully degrade and warn if bad index

manifest.json

@@ -2,7 +2,7 @@
   "id": "obsidian-sidekick",
   "name": "Sidekick",
   "description": "A companion to identify hidden connections that match your tags and pages",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "minAppVersion": "0.13.8",
   "author": "Hady Osman",
   "authorUrl": "https://hady.geek.nz",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "obsidian-sidekick",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "A companion to identify hidden connections that match your tags and pages",
   "main": "src/index.ts",
   "repository": {

src/search/index.ts

@@ -45,8 +45,9 @@ export default class Search {
     const indexHits = results[0].matchData.metadata;
 
     return Object.keys(indexHits)
-      .reduce((acc: SearchResult[], indexHit: string) => {
-        const positions = indexHits[indexHit][DocumentKey].position;
+      .filter((indexHit) => this.existsInIndex(indexHit, indices))
+      .reduce((acc: SearchResult[], indexHit) => {
+        const positions: number[][] = indexHits[indexHit][DocumentKey].position;
 
         const searchResults = positions.map(
           (position): SearchResult => ({
@@ -62,6 +63,19 @@ export default class Search {
       .sort((a, b) => a.start - b.start); // Must sort by start position to prepare for highlighting
   }
 
+  private existsInIndex(index: string, indices: Index): boolean {
+    const exists = indices[index] != null;
+
+    if (!exists) {
+      console.warn(
+        `Search hit "${index}" was not found in Obsidian index. This could be a bug. Report on https://github.com/hadynz/obsidian-sidekick/issues`,
+        indices
+      );
+    }
+
+    return exists;
+  }
+
   private redactText(text: string): string {
     return text
       .replace(/```[\s\S]+?```/g, (m) => ' '.repeat(m.length)) // remove code blocks