chore: track lastChangeTimestamp for each Document to make sense of ongoing changes

Author: abose

src/document/Document.js

@@ -119,6 +119,13 @@ define(function (require, exports, module) {
      */
     Document.prototype.diskTimestamp = null;
 
+    /**
+     * Keeps a running timestamp of when the document was last changed. You can use this timestamp to see a
+     * document was recently changed or not.
+     * @type {number}
+     */
+    Document.prototype.lastChangeTimestamp = null;
+
     /**
      * The timestamp of the document at the point where the user last said to keep changes that conflict
      * with the current disk version. Can also be -1, indicating that the file was deleted on disk at the
@@ -337,6 +344,7 @@ define(function (require, exports, module) {
      * @param {Object} changeList Changelist in CodeMirror format
      */
     Document.prototype._notifyDocumentChange = function (changeList) {
+        this.lastChangeTimestamp = Date.now();
         this.trigger("change", this, changeList);
         exports.trigger("documentChange", this, changeList);
     };
@@ -501,6 +509,7 @@ define(function (require, exports, module) {
      */
     Document.prototype._updateTimestamp = function (timestamp) {
         this.diskTimestamp = timestamp;
+        this.lastChangeTimestamp = Date.now();
         // Clear the "keep changes" timestamp since it's no longer relevant.
         this.keepChangesTime = null;
     };

src/document/DocumentManager.js

@@ -94,6 +94,14 @@ define(function (require, exports, module) {
         ProjectManager      = require("project/ProjectManager"),
         Strings             = require("strings");
 
+    const EVENT_AFTER_DOCUMENT_CREATE = "afterDocumentCreate",
+        EVENT_PATH_DELETED = "pathDeleted",
+        EVENT_FILE_NAME_CHANGE = "fileNameChange",
+        EVENT_BEFORE_DOCUMENT_DELETE = "beforeDocumentDelete",
+        EVENT_DOCUMENT_REFRESHED = "documentRefreshed",
+        EVENT_DOCUMENT_CHANGE = "documentChange",
+        EVENT_DIRTY_FLAG_CHANGED = "dirtyFlagChange";
+
 
     /**
      * @private
@@ -472,7 +480,7 @@ define(function (require, exports, module) {
      */
     function notifyFileDeleted(file) {
         // Notify all editors to close as well
-        exports.trigger("pathDeleted", file.fullPath);
+        exports.trigger(EVENT_PATH_DELETED, file.fullPath);
 
         var doc = getOpenDocumentForPath(file.fullPath);
 
@@ -515,7 +523,7 @@ define(function (require, exports, module) {
             // For images not open in the workingset,
             // FileSyncManager.syncOpenDocuments() will
             //  not tell us to close those views
-            exports.trigger("pathDeleted", fullPath);
+            exports.trigger(EVENT_PATH_DELETED, fullPath);
         }
     }
 
@@ -536,7 +544,7 @@ define(function (require, exports, module) {
         });
 
         // Send a "fileNameChange" event. This will trigger the views to update.
-        exports.trigger("fileNameChange", oldName, newName);
+        exports.trigger(EVENT_FILE_NAME_CHANGE, oldName, newName);
     }
 
 
@@ -578,25 +586,27 @@ define(function (require, exports, module) {
             }
 
             _openDocuments[doc.file.id] = doc;
-            exports.trigger("afterDocumentCreate", doc);
+            exports.trigger(EVENT_AFTER_DOCUMENT_CREATE, doc);
         })
         .on("_beforeDocumentDelete", function (event, doc) {
             if (!_openDocuments[doc.file.id]) {
                 console.error("Document with references was not in _openDocuments!");
                 return true;
             }
 
-            exports.trigger("beforeDocumentDelete", doc);
+            exports.trigger(EVENT_BEFORE_DOCUMENT_DELETE, doc);
             delete _openDocuments[doc.file.id];
         })
         .on("_documentRefreshed", function (event, doc) {
-            exports.trigger("documentRefreshed", doc);
+            exports.trigger(EVENT_DOCUMENT_REFRESHED, doc);
+        }).on(EVENT_DOCUMENT_CHANGE, function (event, doc, changelist) {
+            exports.trigger(EVENT_DOCUMENT_CHANGE, doc, changelist);
         })
         .on("_dirtyFlagChange", function (event, doc) {
             // Modules listening on the doc instance notified about dirtyflag change
             // To be used internally by Editor
             doc.trigger("_dirtyFlagChange", doc);
-            exports.trigger("dirtyFlagChange", doc);
+            exports.trigger(EVENT_DIRTY_FLAG_CHANGED, doc);
             if (doc.isDirty) {
                 MainViewManager.addToWorkingSet(MainViewManager.ACTIVE_PANE, doc.file);
 

test/spec/Document-test.js

@@ -58,7 +58,7 @@ define(function (require, exports, module) {
                 }
             });
 
-            it("should do a single edit, tracking a beforeEdit selection and preserving reversed flag", function () {
+            function _verifySingleEdit() {
                 var result = myDocument.doMultipleEdits([{edit: {text: "new content", start: {line: 2, ch: 0}, end: {line: 2, ch: 14}},
                     selection: {start: {line: 2, ch: 4}, end: {line: 2, ch: 4}, reversed: true, isBeforeEdit: true}}]);
                 initialContentLines[2] = "new content";
@@ -69,6 +69,17 @@ define(function (require, exports, module) {
                 expect(result[0].end.line).toEqual(2);
                 expect(result[0].end.ch).toEqual(11);
                 expect(result[0].reversed).toBe(true);
+            }
+
+            it("should do a single edit, tracking a beforeEdit selection and preserving reversed flag", function () {
+                _verifySingleEdit();
+            });
+
+            it("should edit update change lastChangeTimestamp", function () {
+                let lastTimestamp = myDocument.lastChangeTimestamp;
+                expect(typeof myDocument.lastChangeTimestamp).toBe('number');
+                _verifySingleEdit();
+                expect(myDocument.lastChangeTimestamp).not.toBe(lastTimestamp);
             });
 
             it("should do a single edit, leaving a non-beforeEdit selection untouched and preserving reversed flag", function () {