Merge pull request #459 from kgryte/refresh-interval

Update refresh interval

Author: fcollonval

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": 3000
     }
   }
 }

src/index.ts

@@ -58,62 +58,71 @@ export default plugin;
 /**
  * Activate the running plugin.
  */
-function activate(
+async function activate(
   app: JupyterFrontEnd,
   mainMenu: IMainMenu,
   restorer: ILayoutRestorer,
   factory: IFileBrowserFactory,
   renderMime: IRenderMimeRegistry,
   settingRegistry: ISettingRegistry
-): IGitExtension {
-  const key = plugin.id;
+): Promise<IGitExtension> {
+  let settings: ISettingRegistry.ISettings;
 
+  // Register Git icons with the icon registry
   registerGitIcons(defaultIconRegistry);
 
-  // Create the Git model
-  let gitExtension = new GitExtension(app);
-  // Connect file browser with git model
+  // Get a reference to the default file browser extension
   const filebrowser = factory.defaultBrowser;
+
+  // Attempt to load application settings
+  try {
+    settings = await settingRegistry.load(plugin.id);
+  } catch (error) {
+    console.error(`Failed to load settings for the Git Extension.\n${error}`);
+  }
+  // Create the Git model
+  const gitExtension = new GitExtension(app, settings);
+
+  // Whenever we restore the application, sync the Git extension path
+  Promise.all([app.restored, filebrowser.model.restored]).then(() => {
+    gitExtension.pathRepository = filebrowser.model.path;
+  });
+
+  // Whenever the file browser path changes, sync the Git extension path
   filebrowser.model.pathChanged.connect(
     (model: FileBrowserModel, change: IChangedArgs<string>) => {
       gitExtension.pathRepository = change.newValue;
     }
   );
-  Promise.all([app.restored, filebrowser.model.restored]).then(() => {
-    gitExtension.pathRepository = filebrowser.model.path;
-  });
-
-  /* Create the widgets */
-  settingRegistry
-    .load(key)
-    .then(settings => {
-      // Create the Git widget sidebar
-      const gitPlugin = new GitWidget(gitExtension, settings, renderMime);
-      gitPlugin.id = 'jp-git-sessions';
-      gitPlugin.title.iconClass = `jp-SideBar-tabIcon jp-GitIcon`;
-      gitPlugin.title.caption = 'Git';
-
-      // Let the application restorer track the running panel for restoration of
-      // application state (e.g. setting the running panel as the current side bar
-      // widget).
-      restorer.add(gitPlugin, 'git-sessions');
-      // Rank has been chosen somewhat arbitrarily to give priority to the running
-      // sessions widget in the sidebar.
-      app.shell.add(gitPlugin, 'left', { rank: 200 });
-
-      // add a menu for the plugin
-      mainMenu.addMenu(
-        createGitMenu(app, gitExtension, factory.defaultBrowser, settings),
-        { rank: 60 }
-      );
-    })
-    .catch(reason => {
-      console.error(
-        `Failed to load settings for the Git Exetnsion.\n${reason}`
-      );
-    });
-
+  // Whenever a user adds/renames/saves/deletes/modifies a file within the lab environment, refresh the Git status
+  filebrowser.model.fileChanged.connect(() => gitExtension.refreshStatus());
+
+  // Provided we were able to load application settings, create the extension widgets
+  if (settings) {
+    // Create the Git widget sidebar
+    const gitPlugin = new GitWidget(gitExtension, settings, renderMime);
+    gitPlugin.id = 'jp-git-sessions';
+    gitPlugin.title.iconClass = 'jp-SideBar-tabIcon jp-GitIcon';
+    gitPlugin.title.caption = 'Git';
+
+    // Let the application restorer track the running panel for restoration of
+    // application state (e.g. setting the running panel as the current side bar
+    // widget).
+    restorer.add(gitPlugin, 'git-sessions');
+
+    // Rank has been chosen somewhat arbitrarily to give priority to the running
+    // sessions widget in the sidebar.
+    app.shell.add(gitPlugin, 'left', { rank: 200 });
+
+    // Add a menu for the plugin
+    mainMenu.addMenu(
+      createGitMenu(app, gitExtension, factory.defaultBrowser, settings),
+      { rank: 60 }
+    );
+  }
+  // Add a clone button to the file browser extension toolbar
   addCloneButton(gitExtension, factory.defaultBrowser);
+
   return gitExtension;
 }
 

src/model.ts

@@ -1,5 +1,10 @@
 import { JupyterFrontEnd } from '@jupyterlab/application';
-import { IChangedArgs, PathExt, Poll } from '@jupyterlab/coreutils';
+import {
+  IChangedArgs,
+  PathExt,
+  Poll,
+  ISettingRegistry
+} from '@jupyterlab/coreutils';
 import { ServerConnection } from '@jupyterlab/services';
 import { CommandRegistry } from '@phosphor/commands';
 import { JSONObject } from '@phosphor/coreutils';
@@ -8,14 +13,16 @@ 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 = 10000;
+// Default refresh interval (in milliseconds) for polling the current Git status (NOTE: this value should be the same value as in the plugin settings schema):
+const DEFAULT_REFRESH_INTERVAL = 3000; // ms
 
 /** Main extension class */
 export class GitExtension implements IGitExtension, IDisposable {
-  constructor(app: JupyterFrontEnd = null) {
+  constructor(
+    app: JupyterFrontEnd = null,
+    settings?: ISettingRegistry.ISettings
+  ) {
+    const model = this;
     this._app = app;
 
     // Load the server root path
@@ -27,18 +34,38 @@ 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(),
+    let interval: number;
+    if (settings) {
+      interval = settings.composite.refreshInterval as number;
+      settings.changed.connect(onSettingsChange, this);
+    } else {
+      interval = DEFAULT_REFRESH_INTERVAL;
+    }
+    const poll = new Poll({
+      factory: () => model._refreshStatus(),
       frequency: {
-        interval: refreshInterval,
+        interval: interval,
         backoff: true,
         max: 300 * 1000
       },
       standby: 'when-hidden'
     });
+    this._poll = poll;
+
+    /**
+     * Callback invoked upon a change to plugin settings.
+     *
+     * @private
+     * @param settings - settings registry
+     */
+    function onSettingsChange(settings: ISettingRegistry.ISettings) {
+      const freq = poll.frequency;
+      poll.frequency = {
+        interval: settings.composite.refreshInterval as number,
+        backoff: freq.backoff,
+        max: freq.max
+      };
+    }
   }
 
   /**