Adjust refresh interval and listen for file change events

Author: kgryte

schema/plugin.json

@@ -16,6 +16,12 @@
       "title": "Simple staging flag",
       "description": "If true, use a simplified concept of staging. Only files with changes are shown (instead of showing staged/changed/untracked), and all files with changes will be automatically staged",
       "default": false
+    },
+    "refreshInterval": {
+      "type": "integer",
+      "title": "Refresh interval",
+      "description": "Number of milliseconds between polling the file system for changes.",
+      "default": 4000
     }
   }
 }

src/index.ts

@@ -72,13 +72,21 @@ function activate(
 
   // Create the Git model
   let gitExtension = new GitExtension(app);
+
   // Connect file browser with git model
   const filebrowser = factory.defaultBrowser;
+
+  // Whenever the file browser path changes, sync the Git extension path
   filebrowser.model.pathChanged.connect(
     (model: FileBrowserModel, change: IChangedArgs<string>) => {
       gitExtension.pathRepository = change.newValue;
     }
   );
+
+  // Whenever a user adds/renames/saves/deletes/modifies a file within the lab environment, refresh the Git status
+  filebrowser.model.fileChanged.connect(() => gitExtension.refreshStatus());
+
+  // Whenever we restore the application, sync the Git extension path
   Promise.all([app.restored, filebrowser.model.restored]).then(() => {
     gitExtension.pathRepository = filebrowser.model.path;
   });
@@ -106,6 +114,12 @@ function activate(
         createGitMenu(app, gitExtension, factory.defaultBrowser, settings),
         { rank: 60 }
       );
+
+      // Listen for changes to extension settings:
+      settings.changed.connect((settings: ISettingRegistry.ISettings) => {
+        gitExtension.refreshInterval = settings.composite
+          .refreshInterval as number;
+      });
     })
     .catch(reason => {
       console.error(

src/model.ts

@@ -8,11 +8,6 @@ import { ISignal, Signal } from '@phosphor/signaling';
 import { httpGitRequest } from './git';
 import { IGitExtension, Git } from './tokens';
 
-/**
- * The default duration of the auto-refresh in ms
- */
-const DEFAULT_REFRESH_INTERVAL = 2000;
-
 /** Main extension class */
 export class GitExtension implements IGitExtension, IDisposable {
   constructor(app: JupyterFrontEnd = null) {
@@ -27,20 +22,35 @@ export class GitExtension implements IGitExtension, IDisposable {
         console.error(`Fail to get the server root path.\n${reason}`);
       });
 
-    const refreshInterval = DEFAULT_REFRESH_INTERVAL;
-
     // Start watching the repository
     this._poll = new Poll({
       factory: () => this._refreshStatus(),
       frequency: {
-        interval: refreshInterval,
+        interval: this._refreshInterval,
         backoff: true,
         max: 300 * 1000
       },
       standby: 'when-hidden'
     });
   }
 
+  /**
+   * Number of milliseconds between polling the file system for changes.
+   */
+  public get refreshInterval(): number {
+    return this._refreshInterval;
+  }
+
+  public set refreshInterval(v: number) {
+    const freq = this._poll.frequency;
+    this._poll.frequency = {
+      interval: v,
+      backoff: freq.backoff,
+      max: freq.max
+    };
+    this._refreshInterval = v;
+  }
+
   /**
    * A signal emitted when the HEAD of the git repository changes.
    */
@@ -914,6 +924,7 @@ export class GitExtension implements IGitExtension, IDisposable {
   private _readyPromise: Promise<void> = Promise.resolve();
   private _pendingReadyPromise = 0;
   private _poll: Poll;
+  private _refreshInterval = 4000; // ms
   private _headChanged = new Signal<IGitExtension, void>(this);
   private _markChanged = new Signal<IGitExtension, void>(this);
   private _repositoryChanged = new Signal<