imdone-core 2.3.3 → 2.3.5

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.3.5
+
+- Incorporate newly added watched files into repository state before emitting `file.update`, so live board consumers can render the new task without a reload or restart.
+
 ## 2.3.3
 
 - Update `adm-zip` to `0.6.0` to address a high-severity ZIP parsing memory allocation vulnerability.

package/_index.md

@@ -1,6 +1,5 @@
 # imdone-core
 
-- [:file_folder: **backlog**](backlog/README)
 - [:file_folder: **docs**](docs/README)
 - [:file_folder: **notes**](notes/_index.md)
 - [CHANGELOG](CHANGELOG.md)

package/lib/default-filtered-move-position.js

@@ -0,0 +1,36 @@
+function sameTask(left, right) {
+  return Boolean(left && right && left.equals(right))
+}
+
+export function resolveDefaultFilteredMovePosition({
+  task,
+  newList,
+  newPosition,
+  filteredCards,
+  repositoryListCards,
+}) {
+  const visibleDestinationCards = filteredCards
+    .filter(candidate => candidate.list === newList && !sameTask(candidate, task))
+
+  if (!Number.isInteger(newPosition)
+    || newPosition < 0
+    || newPosition > visibleDestinationCards.length) {
+    throw new RangeError(`Filtered task position is outside ${newList}: ${newPosition}`)
+  }
+
+  const destinationCards = repositoryListCards
+    .filter(candidate => !sameTask(candidate, task))
+  if (visibleDestinationCards.length === 0) return destinationCards.length
+
+  const anchor = visibleDestinationCards[
+    Math.min(newPosition, visibleDestinationCards.length - 1)
+  ]
+  const anchorPosition = destinationCards.findIndex(candidate => sameTask(candidate, anchor))
+  if (anchorPosition < 0) {
+    throw new Error(`Filtered task is missing from ${newList}: ${anchor.id}`)
+  }
+
+  return newPosition < visibleDestinationCards.length
+    ? anchorPosition
+    : anchorPosition + 1
+}

package/lib/index.js

@@ -5,6 +5,7 @@ export * from './checksum.js';
 export * from './clone.js';
 export * from './config.js';
 export * from './constants.js';
+export * from './default-filtered-move-position.js';
 export * from './default-settings.js';
 export * from './file.js';
 export * from './get-tasks-to-modify.js';

package/lib/mixins/repo-watched-fs-store.js

@@ -19,6 +19,20 @@ export function watchedFileSystemStoreMixin(repo, fs = realFs) {
   let initializing = false
   let refreshing = false
   let watcherPaused = false
+  const watcherEvents = new Set()
+
+  function trackWatcherEvent(listener) {
+    return (...args) => {
+      const event = Promise.resolve().then(() => listener(...args))
+      const trackedEvent = event.catch((err) => {
+        logger.error('Error processing watcher event')
+        logger.error(err)
+        repo.emit('watch.error', err)
+      })
+      watcherEvents.add(trackedEvent)
+      void trackedEvent.finally(() => watcherEvents.delete(trackedEvent))
+    }
+  }
 
   function ready() {
     return !initializing && !refreshing
@@ -80,6 +94,7 @@ export function watchedFileSystemStoreMixin(repo, fs = realFs) {
 
   repo.destroy = async function () {
     if (repo.watcher) await repo.watcher.close()
+    await Promise.allSettled([...watcherEvents])
     await _destroy.apply(repo)
   }
 
@@ -147,7 +162,10 @@ export function watchedFileSystemStoreMixin(repo, fs = realFs) {
         persistent: true,
         usePolling: false,
         alwaysStat: true,
-        awaitWriteFinish: true,
+        awaitWriteFinish: {
+          stabilityThreshold: 200,
+          pollInterval: 50,
+        },
         atomic: true,
         ignoreInitial: true,
         ignored: (file) => {
@@ -169,21 +187,23 @@ export function watchedFileSystemStoreMixin(repo, fs = realFs) {
           initializing = false
           resolve()
         })
-        .on('add', async function (path, stat) {
+        .on('add', trackWatcherEvent(async function (path, stat) {
           logger.log('Watcher received add event for file: ' + path)
           if (stat.isDirectory()) return
-          let file = repo.getFile(path)
+          const relativePath = repo.getRelativePath(path)
+          let file = repo.getFile(relativePath)
           if (file === undefined) {
             log('Creating file: ' + path)
             file = new File({
               repoId: repo.getId(),
-              filePath: path,
+              filePath: relativePath,
               languages: repo.languages,
               project: repo.project,
             })
           }
 
-          stat = await repo.fileOK()
+          stat = await repo.fileOK(relativePath)
+          if (!stat) return
           log('fileOK returned: ' + JSON.stringify(stat))
           if (stat.mtime <= file.getModifiedTime()) {
             return log('File update already applied.  Change ignored for file: ' + path)
@@ -192,8 +212,8 @@ export function watchedFileSystemStoreMixin(repo, fs = realFs) {
           file = await repo.readFile(file)
           repo.emit('watch.add', file)
           repo.emitFileUpdate(file)
-        })
-        .on('change', async function (path, stat) {
+        }))
+        .on('change', trackWatcherEvent(async function (path, stat) {
           logger.log(
             `Watcher received change event for file: ${path} repoPath: ${repo.path}`,
             stat.mtime
@@ -201,10 +221,10 @@ export function watchedFileSystemStoreMixin(repo, fs = realFs) {
           if (!path || stat.isDirectory()) return
           
           const relPath = repo.getRelativePath(path)
-          if (!initializing && _isImdoneConfig(relPath)) onConfigChange(relPath)
-          if (!initializing && _isImdoneIgnore(relPath)) onIgnoreChange(relPath)
+          if (!initializing && _isImdoneConfig(relPath)) return onConfigChange(relPath)
+          if (!initializing && _isImdoneIgnore(relPath)) return onIgnoreChange(relPath)
 
-          var file = repo.getFile(path) || path
+          var file = repo.getFile(path)
           const isFile = File.isFile(file)
           // BACKLOG ## Handle the case where the file is not in the repo
           // #urgent #1.12.0
@@ -216,28 +236,37 @@ export function watchedFileSystemStoreMixin(repo, fs = realFs) {
             return
           }
 
-          const ok = await repo.fileOK((file && file.path) || path)
+          const ok = await repo.fileOK(file?.path || path)
           if (!ok) return
           log('Reading file: ' + path)
-          if (!isFile) file = repo.getFile(path)
+          if (!isFile) {
+            const relativePath = repo.getRelativePath(path)
+            file = repo.getFile(relativePath) || new File({
+              repoId: repo.getId(),
+              filePath: relativePath,
+              languages: repo.languages,
+              project: repo.project,
+            })
+          }
           file = await repo.readFile(file)
           repo.emit('watch.change', file)
           repo.emitFileUpdate(file)
-        })
-        .on('delete', async function (path) {
+        }))
+        .on('unlink', trackWatcherEvent(async function (path) {
           log('Watcher received unlink event for file: ' + path)
-          repo.removeFilePath(path)
-          var file = new File({
+          const relativePath = repo.getRelativePath(path)
+          const file = repo.getFile(relativePath) || new File({
             repoId: repo.getId(),
-            filePath: path,
+            filePath: relativePath,
             languages: repo.languages,
             project: repo.project,
           })
-          log('Removing file: ' + path)
+          repo.removeFilePath(relativePath)
+          log('Removing file: ' + relativePath)
           repo.removeFile(file)
           repo.emit('watch.delete', file)
           repo.emitFileUpdate(file, true)
-        })
+        }))
     });
   }
 

package/lib/project.js

@@ -21,6 +21,7 @@ import { renderMarkdown, extractWikilinkTopics } from './adapters/markdown.js';
 import { getFunctionSignature } from './adapters/parsers/function-parser.js';
 import { format } from './adapters/parsers/content-transformer.js';
 import { logger } from './adapters/logger.js';
+import { resolveDefaultFilteredMovePosition } from './default-filtered-move-position.js';
 
 function calculateTotals(lists = []) {
   const totals = {}
@@ -459,6 +460,17 @@ export class WorkerProject extends Project {
     return await this.repo.moveTask({task, newList, newPos})
   }
 
+  async moveTaskInDefaultFilteredCards(task, newList, newPos) {
+    const repositoryPosition = resolveDefaultFilteredMovePosition({
+      task,
+      newList,
+      newPosition: newPos,
+      filteredCards: this.getDefaultFilteredCards(),
+      repositoryListCards: this.repo.getTasksInList(newList),
+    })
+    return await this.repo.moveTask({task, newList, newPos: repositoryPosition})
+  }
+
   getFile(filePath) {
     return this.repo.getFile(filePath)
   }

package/lib/repository.js

@@ -988,7 +988,7 @@ export class Repository extends Emitter {
     if (!file.updated) return file
 
     await this.extractTasks(file)
-    await this.addFile()
+    await this.addFile(file)
 
     return file
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "imdone-core",
-  "version": "2.3.3",
+  "version": "2.3.5",
   "description": "imdone-core",
   "repository": {
     "type": "git",

package/types/default-filtered-move-position.d.ts

@@ -0,0 +1,7 @@
+export function resolveDefaultFilteredMovePosition({ task, newList, newPosition, filteredCards, repositoryListCards, }: {
+    task: any;
+    newList: any;
+    newPosition: any;
+    filteredCards: any;
+    repositoryListCards: any;
+}): any;

package/types/index.d.ts

@@ -5,6 +5,7 @@ export * from "./checksum.js";
 export * from "./clone.js";
 export * from "./config.js";
 export * from "./constants.js";
+export * from "./default-filtered-move-position.js";
 export * from "./default-settings.js";
 export * from "./file.js";
 export * from "./get-tasks-to-modify.js";

package/types/project.d.ts

@@ -79,6 +79,7 @@ export class WorkerProject {
     addTag(task: any, tag: any): Promise<any>;
     removeTag(task: any, tag: any): Promise<any>;
     moveTask(task: any, newList: any, newPos: any): Promise<any>;
+    moveTaskInDefaultFilteredCards(task: any, newList: any, newPos: any): Promise<any>;
     getFile(filePath: any): any;
     getFileForTask(task: any): any;
     rollBackFileForTask(task: any): any;

package/.imdone-cli.yml

@@ -1,3 +0,0 @@
-backlogDir: backlog
-providers:
-  - github