Bug 1070719 - Autosave project files before running. r=jryans

browser/locales/en-US/chrome/browser/devtools/webide.dtd

@@ -137,6 +137,8 @@
 <!ENTITY prefs_options_autoclosebrackets_tooltip "Automatically insert closing brackets">
 <!ENTITY prefs_options_keybindings "Keybindings">
 <!ENTITY prefs_options_keybindings_default "Default">
+<!ENTITY prefs_options_autosavefiles "Autosave files">
+<!ENTITY prefs_options_autosavefiles_tooltip "Automatically save edited files before running project">
 
 <!-- Permissions Table -->
 <!ENTITY permissionstable_title "Permissions Table">

devtools/client/projecteditor/lib/projecteditor.js

@@ -19,6 +19,7 @@ const promise = require("promise");
 const { ViewHelpers } = Cu.import("resource:///modules/devtools/client/shared/widgets/ViewHelpers.jsm", {});
 const { DOMHelpers } = Cu.import("resource:///modules/devtools/client/shared/DOMHelpers.jsm");
 const { Services } = Cu.import("resource://gre/modules/Services.jsm", {});
+const { Task } = Cu.import("resource://gre/modules/Task.jsm", {});
 const ITCHPAD_URL = "chrome://devtools/content/projecteditor/chrome/content/projecteditor.xul";
 const { confirm } = require("devtools/client/projecteditor/lib/helpers/prompts");
 const { getLocalizedString } = require("devtools/client/projecteditor/lib/helpers/l10n");
@@ -752,7 +753,6 @@ var ProjectEditor = Class({
    *          Otherwise, ask the user to confirm and return the outcome.
    */
   confirmUnsaved: function() {
-
     if (this.hasUnsavedResources) {
       return confirm(
         getLocalizedString("projecteditor.confirmUnsavedTitle"),
@@ -761,7 +761,28 @@ var ProjectEditor = Class({
     }
 
     return true;
-  }
+  },
+
+  /**
+   * Save all the changes in source files.
+   *
+   * @returns Boolean
+   *          True if there were resources to save.
+   */
+  saveAllFiles: Task.async(function*() {
+    if (this.hasUnsavedResources) {
+      for (let resource of this.project.allResources()) {
+        let editor = this.editorFor(resource);
+        if (editor && !editor.isClean()) {
+          yield editor.save(resource);
+        }
+      }
+
+      return true;
+    }
+
+    return false;
+  })
 
 });
 

devtools/client/projecteditor/lib/stores/resource.js

@@ -348,19 +348,15 @@ var FileResource = Class({
    *          Resolves once it has been written to disk.
    *          Rejected if there is an error
    */
-  save: function(content) {
-    let buffer = gEncoder.encode(content);
-    let path = this.path;
-
+  save: Task.async(function*(content) {
     // XXX: writeAtomic was losing permissions after saving on OSX
     // return OS.File.writeAtomic(this.path, buffer, { tmpPath: this.path + ".tmp" });
-
-    return Task.spawn(function*() {
-        let pfh = yield OS.File.open(path, {truncate: true});
-        yield pfh.write(buffer);
-        yield pfh.close();
-    });
-  },
+    let buffer = gEncoder.encode(content);
+    let path = this.path;
+    let file = yield OS.File.open(path, {truncate: true});
+    yield file.write(buffer);
+    yield file.close();
+  }),
 
   /**
    * Attempts to get the content type from the file.

devtools/client/projecteditor/test/browser.ini

@@ -26,6 +26,8 @@ skip-if = buildapp == 'mulet'
 [browser_projecteditor_menubar_02.js]
 skip-if = true # Bug 1173950
 [browser_projecteditor_new_file.js]
+[browser_projecteditor_saveall.js]
+skip-if = buildapp == 'mulet'
 [browser_projecteditor_stores.js]
 [browser_projecteditor_tree_selection_01.js]
 [browser_projecteditor_tree_selection_02.js]

devtools/client/projecteditor/test/browser_projecteditor_saveall.js

@@ -0,0 +1,65 @@
+/* vim: set ts=2 et sw=2 tw=80: */
+/* Any copyright is dedicated to the Public Domain.
+ http://creativecommons.org/publicdomain/zero/1.0/ */
+
+"use strict";
+
+///////////////////
+//
+// Whitelisting this test.
+// As part of bug 1077403, the leaking uncaught rejection should be fixed.
+//
+thisTestLeaksUncaughtRejectionsAndShouldBeFixed("destroy");
+
+loadHelperScript("helper_edits.js");
+
+// Test ProjectEditor basic functionality
+add_task(function*() {
+  let projecteditor = yield addProjectEditorTabForTempDirectory();
+  let TEMP_PATH = projecteditor.project.allPaths()[0];
+
+  is (getTempFile("").path, TEMP_PATH, "Temp path is set correctly.");
+
+  ok (projecteditor.currentEditor, "There is an editor for projecteditor");
+  let resources = projecteditor.project.allResources();
+
+  for (let data of helperEditData) {
+    info ("Processing " + data.path);
+    let resource = resources.filter(r=>r.basename === data.basename)[0];
+    yield selectFile(projecteditor, resource);
+    yield editFile(projecteditor, getTempFile(data.path).path, data.newContent);
+  }
+
+  info ("Saving all resources");
+  ok(projecteditor.hasUnsavedResources, "hasUnsavedResources");
+  yield projecteditor.saveAllFiles();
+  ok(!projecteditor.hasUnsavedResources, "!hasUnsavedResources");
+  for (let data of helperEditData) {
+    let filePath = getTempFile(data.path).path;
+    info ("Asserting that data at " + filePath + " has been saved");
+    let resource = resources.filter(r=>r.basename === data.basename)[0];
+    yield selectFile(projecteditor, resource);
+    let editor = projecteditor.currentEditor;
+    let savedData = yield getFileData(filePath);
+    is (savedData, data.newContent, "Data has been correctly saved to disk");
+  }
+});
+
+function* editFile(projecteditor, filePath, newData) {
+  info ("Testing file editing for: " + filePath);
+
+  let initialData = yield getFileData(filePath);
+  let editor = projecteditor.currentEditor;
+  let resource = projecteditor.resourceFor(editor);
+  let viewContainer = projecteditor.projectTree.getViewContainer(resource);
+  let originalTreeLabel = viewContainer.label.textContent;
+
+  is (resource.path, filePath, "Resource path is set correctly");
+  is (editor.editor.getText(), initialData, "Editor is loaded with correct file contents");
+
+  info ("Setting text in the editor");
+
+  editor.editor.setText(newData);
+  is (editor.editor.getText(), newData, "Editor has been filled with new data");
+  is (viewContainer.label.textContent, "*" + originalTreeLabel, "Label is marked as changed");
+}

devtools/client/webide/content/prefs.xhtml

@@ -90,6 +90,12 @@
           <span>&prefs_options_autoclosebrackets;</span>
         </label>
       </li>
+      <li>
+        <label title="&prefs_options_autosavefiles_tooltip;">
+          <input type="checkbox" data-pref="devtools.webide.autosaveFiles"/>
+          <span>&prefs_options_autosavefiles;</span>
+        </label>
+      </li>
       <li>
         <label><span>&prefs_options_keybindings;</span>
           <select data-pref="devtools.editor.keymap">

devtools/client/webide/content/webide.js

@@ -1070,10 +1070,15 @@ var Cmds = {
     UI.selectDeckPanel("monitor");
   },
 
-  play: function() {
+  play: Task.async(function*() {
     let busy;
     switch(AppManager.selectedProject.type) {
       case "packaged":
+        let autosave =
+          Services.prefs.getBoolPref("devtools.webide.autosaveFiles");
+        if (autosave && UI.projecteditor) {
+          yield UI.projecteditor.saveAllFiles();
+        }
         busy = UI.busyWithProgressUntil(AppManager.installAndRunProject(),
                                         "installing and running app");
         break;
@@ -1093,7 +1098,7 @@ var Cmds = {
     }
     UI.onAction("play");
     return busy;
-  },
+  }),
 
   stop: function() {
     return UI.busyUntil(AppManager.stopRunningApp(), "stopping app");

devtools/client/webide/webide-prefs.js

@@ -32,3 +32,4 @@ pref("devtools.webide.widget.inNavbarByDefault", false);
 #endif
 pref("devtools.webide.zoom", "1");
 pref("devtools.webide.busyTimeout", 10000);
+pref("devtools.webide.autosaveFiles", true);