fix: Weakly reference parents in file tree to avoid cycles

Author: effigies

src/files/browser.ts

@@ -12,7 +12,7 @@ export class BIDSFileBrowser implements BIDSFile {
   #file: File
   name: string
   path: string
-  parent: FileTree
+  #parent!: WeakRef<FileTree>
   viewed: boolean = false
 
   constructor(file: File, ignore: FileIgnoreRules, parent?: FileTree) {
@@ -25,6 +25,14 @@ export class BIDSFileBrowser implements BIDSFile {
     this.parent = parent ?? new FileTree('', '/', undefined)
   }
 
+  get parent(): FileTree {
+    return this.#parent.deref() as FileTree
+  }
+
+  set parent(tree: FileTree) {
+    this.#parent = new WeakRef(tree)
+  }
+
   get size(): number {
     return this.#file.size
   }

src/files/deno.ts

@@ -17,7 +17,7 @@ export class BIDSFileDeno implements BIDSFile {
   #ignore: FileIgnoreRules
   name: string
   path: string
-  parent: FileTree
+  #parent!: WeakRef<FileTree>
   #fileInfo?: Deno.FileInfo
   #datasetAbsPath: string
   viewed: boolean = false
@@ -41,6 +41,14 @@ export class BIDSFileDeno implements BIDSFile {
     return join(this.#datasetAbsPath, this.path)
   }
 
+  get parent(): FileTree {
+    return this.#parent.deref() as FileTree
+  }
+
+  set parent(tree: FileTree) {
+    this.#parent = new WeakRef(tree)
+  }
+
   get size(): number {
     return this.#fileInfo ? this.#fileInfo.size : -1
   }

src/types/filetree.ts

@@ -32,7 +32,7 @@ export class FileTree {
   files: BIDSFile[]
   directories: FileTree[]
   viewed: boolean
-  parent?: FileTree
+  #parent?: WeakRef<FileTree>
   #ignore: FileIgnoreRules
 
   constructor(path: string, name: string, parent?: FileTree, ignore?: FileIgnoreRules) {
@@ -45,6 +45,14 @@ export class FileTree {
     this.#ignore = ignore ?? new FileIgnoreRules([])
   }
 
+  get parent(): FileTree | undefined {
+    return this.#parent?.deref()
+  }
+
+  set parent(tree: FileTree | undefined) {
+    this.#parent = tree ? new WeakRef(tree) : undefined
+  }
+
   get ignored(): boolean {
     if (!this.parent) return false
     return this.#ignore.test(this.path)