DevTools: introduce persistence/ module

third_party/WebKit/Source/devtools/front_end/persistence/Persistence.js

+// Copyright 2016 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+/**
+ * @constructor
+ * @extends {WebInspector.Object}
+ * @param {!WebInspector.Workspace} workspace
+ * @param {!WebInspector.BreakpointManager} breakpointManager
+ * @param {!WebInspector.FileSystemMapping} fileSystemMapping
+ */
+WebInspector.Persistence = function(workspace, breakpointManager, fileSystemMapping)
+{
+    WebInspector.Object.call(this);
+    this._workspace = workspace;
+    this._breakpointManager = breakpointManager;
+    this._fileSystemMapping = fileSystemMapping;
+    /** @type {!Set<!WebInspector.PersistenceBinding>} */
+    this._bindings = new Set();
+    this._eventListeners = [
+        workspace.addEventListener(WebInspector.Workspace.Events.UISourceCodeAdded, this._onUISourceCodeAdded, this),
+        workspace.addEventListener(WebInspector.Workspace.Events.UISourceCodeRemoved, this._onUISourceCodeRemoved, this),
+        workspace.addEventListener(WebInspector.Workspace.Events.ProjectRemoved, this._onProjectRemoved, this),
+        this._fileSystemMapping.addEventListener(WebInspector.FileSystemMapping.Events.FileMappingAdded, this._remap, this),
+        this._fileSystemMapping.addEventListener(WebInspector.FileSystemMapping.Events.FileMappingRemoved, this._remap, this)
+    ];
+    this._remap();
+}
+
+WebInspector.Persistence._binding = Symbol("Persistence.Binding");
+WebInspector.Persistence._muteCommit = Symbol("Persistence.MuteCommit");
+
+WebInspector.Persistence._NodePrefix = "(function (exports, require, module, __filename, __dirname) { ";
+WebInspector.Persistence._NodeSuffix = "\n});"
+WebInspector.Persistence._NodeShebang = "#!/usr/bin/env node\n";
+
+WebInspector.Persistence.Events = {
+    BindingCreated: Symbol("BindingCreated"),
+    BindingRemoved: Symbol("BindingRemoved")
+}
+
+WebInspector.Persistence.prototype = {
+    _remap: function()
+    {
+        for (var binding of this._bindings.valuesArray())
+            this._unbind(binding.network);
+        var networkProjects = this._workspace.projectsForType(WebInspector.projectTypes.Network);
+        for (var networkProject of networkProjects) {
+            for (var uiSourceCode of networkProject.uiSourceCodes())
+                this._bind(uiSourceCode);
+        }
+    },
+
+    /**
+     * @param {!WebInspector.Event} event
+     */
+    _onUISourceCodeAdded: function(event)
+    {
+        var uiSourceCode = /** @type {!WebInspector.UISourceCode} */(event.data);
+        this._bind(uiSourceCode);
+    },
+
+    /**
+     * @param {!WebInspector.Event} event
+     */
+    _onUISourceCodeRemoved: function(event)
+    {
+        var uiSourceCode = /** @type {!WebInspector.UISourceCode} */(event.data);
+        this._unbind(uiSourceCode);
+    },
+
+    /**
+     * @param {!WebInspector.Event} event
+     */
+    _onProjectRemoved: function(event)
+    {
+        var project = /** @type {!WebInspector.Project} */(event.data);
+        for (var uiSourceCode of project.uiSourceCodes())
+            this._unbind(uiSourceCode);
+    },
+
+    /**
+     * @param {!WebInspector.UISourceCode} uiSourceCode
+     * @return {?WebInspector.PersistenceBinding}
+     */
+    _createBinding: function(uiSourceCode)
+    {
+        if (uiSourceCode.project().type() === WebInspector.projectTypes.FileSystem) {
+            var fileSystemPath = WebInspector.FileSystemWorkspaceBinding.fileSystemPath(uiSourceCode.project().id());
+            var networkURL = this._fileSystemMapping.networkURLForFileSystemURL(fileSystemPath, uiSourceCode.url());
+            var networkSourceCode = networkURL ? this._workspace.uiSourceCodeForURL(networkURL) : null;
+            return networkSourceCode ? new WebInspector.PersistenceBinding(networkSourceCode, uiSourceCode) : null;
+        }
+        if (uiSourceCode.project().type() === WebInspector.projectTypes.Network) {
+            var file = this._fileSystemMapping.fileForURL(uiSourceCode.url());
+            var projectId = file ? WebInspector.FileSystemWorkspaceBinding.projectId(file.fileSystemPath) : null;
+            var fileSourceCode = file && projectId ? this._workspace.uiSourceCode(projectId, file.fileURL) : null;
+            return fileSourceCode ? new WebInspector.PersistenceBinding(uiSourceCode, fileSourceCode) : null;
+        }
+        return null;
+    },
+
+    /**
+     * @param {!WebInspector.UISourceCode} uiSourceCode
+     */
+    _bind: function(uiSourceCode)
+    {
+        console.assert(!uiSourceCode[WebInspector.Persistence._binding], "Cannot bind already bound UISourceCode!");
+        var binding = this._createBinding(uiSourceCode);
+        if (!binding)
+            return;
+        if (binding.network.isDirty() || binding.fileSystem.isDirty()) {
+            WebInspector.console.log(WebInspector.UIString("%s can not be persisted to file system due to unsaved changes.", binding.network.name()));
+            return;
+        }
+        this._bindings.add(binding);
+        binding.network[WebInspector.Persistence._binding] = binding;
+        binding.fileSystem[WebInspector.Persistence._binding] = binding;
+
+        binding.fileSystem.forceLoadOnCheckContent();
+
+        binding.network.addEventListener(WebInspector.UISourceCode.Events.WorkingCopyCommitted, this._onWorkingCopyCommitted, this);
+        binding.fileSystem.addEventListener(WebInspector.UISourceCode.Events.WorkingCopyCommitted, this._onWorkingCopyCommitted, this);
+        binding.fileSystem.addEventListener(WebInspector.UISourceCode.Events.TitleChanged, this._onFileSystemUISourceCodeRenamed, this);
+
+        this._moveBreakpoints(binding.fileSystem, binding.network);
+        this.dispatchEventToListeners(WebInspector.Persistence.Events.BindingCreated, binding);
+    },
+
+    /**
+     * @param {!WebInspector.UISourceCode} uiSourceCode
+     */
+    _unbind: function(uiSourceCode)
+    {
+        var binding = uiSourceCode[WebInspector.Persistence._binding];
+        if (!binding)
+            return;
+        this._bindings.delete(binding);
+        binding.network[WebInspector.Persistence._binding] = null;
+        binding.fileSystem[WebInspector.Persistence._binding] = null;
+
+        binding.network.removeEventListener(WebInspector.UISourceCode.Events.WorkingCopyCommitted, this._onWorkingCopyCommitted, this);
+        binding.fileSystem.removeEventListener(WebInspector.UISourceCode.Events.WorkingCopyCommitted, this._onWorkingCopyCommitted, this);
+        binding.fileSystem.removeEventListener(WebInspector.UISourceCode.Events.TitleChanged, this._onFileSystemUISourceCodeRenamed, this);
+
+        this._copyBreakpoints(binding.network, binding.fileSystem);
+        this.dispatchEventToListeners(WebInspector.Persistence.Events.BindingRemoved, binding);
+    },
+
+    /**
+     * @param {!WebInspector.Event} event
+     */
+    _onFileSystemUISourceCodeRenamed: function(event)
+    {
+        var uiSourceCode = /** @type {!WebInspector.UISourceCode} */(event.target);
+        var binding = uiSourceCode[WebInspector.Persistence._binding];
+        this._unbind(binding.network);
+        this._bind(binding.network);
+    },
+
+    /**
+     * @param {!WebInspector.Event} event
+     */
+    _onWorkingCopyCommitted: function(event)
+    {
+        var uiSourceCode = /** @type {!WebInspector.UISourceCode} */(event.target);
+        var binding = uiSourceCode[WebInspector.Persistence._binding];
+        if (!binding || binding[WebInspector.Persistence._muteCommit])
+            return;
+        var newContent = /** @type {string} */(event.data.content);
+        var other = binding.network === uiSourceCode ? binding.fileSystem : binding.network;
+        if (Runtime.queryParam("v8only")) {
+            other.requestContent().then(currentContent => this._syncNodeJSContent(binding, other, currentContent, newContent));
+            return;
+        }
+        binding[WebInspector.Persistence._muteCommit] = true;
+        other.addRevision(newContent);
+        binding[WebInspector.Persistence._muteCommit] = false;
+        this._contentSyncedForTest();
+    },
+
+    /**
+     * @param {!WebInspector.PersistenceBinding} binding
+     * @param {!WebInspector.UISourceCode} uiSourceCode
+     * @param {string} currentContent
+     * @param {string} newContent
+     */
+    _syncNodeJSContent: function(binding, uiSourceCode, currentContent, newContent)
+    {
+        if (uiSourceCode === binding.fileSystem) {
+            if (newContent.startsWith(WebInspector.Persistence._NodePrefix) && newContent.endsWith(WebInspector.Persistence._NodeSuffix))
+                newContent = newContent.substring(WebInspector.Persistence._NodePrefix.length, newContent.length - WebInspector.Persistence._NodeSuffix.length);
+            if (currentContent.startsWith(WebInspector.Persistence._NodeShebang))
+                newContent = WebInspector.Persistence._NodeShebang + newContent;
+        } else {
+            if (newContent.startsWith(WebInspector.Persistence._NodeShebang))
+                newContent = newContent.substring(WebInspector.Persistence._NodeShebang.length);
+            if (currentContent.startsWith(WebInspector.Persistence._NodePrefix) && currentContent.endsWith(WebInspector.Persistence._NodeSuffix))
+                newContent = WebInspector.Persistence._NodePrefix + newContent + WebInspector.Persistence._NodeSuffix;
+        }
+        binding[WebInspector.Persistence._muteCommit] = true;
+        uiSourceCode.addRevision(newContent);
+        binding[WebInspector.Persistence._muteCommit] = false;
+        this._contentSyncedForTest();
+    },
+
+    _contentSyncedForTest: function() { },
+
+    /**
+     * @param {!WebInspector.UISourceCode} from
+     * @param {!WebInspector.UISourceCode} to
+     */
+    _moveBreakpoints: function(from, to)
+    {
+        var breakpoints = this._breakpointManager.breakpointsForUISourceCode(from);
+        for (var breakpoint of breakpoints) {
+            breakpoint.remove();
+            this._breakpointManager.setBreakpoint(to, breakpoint.lineNumber(), breakpoint.columnNumber(), breakpoint.condition(), breakpoint.enabled());
+        }
+    },
+
+    /**
+     * @param {!WebInspector.UISourceCode} from
+     * @param {!WebInspector.UISourceCode} to
+     */
+    _copyBreakpoints: function(from, to)
+    {
+        var breakpoints = this._breakpointManager.breakpointsForUISourceCode(from);
+        for (var breakpoint of breakpoints)
+            this._breakpointManager.setBreakpoint(to, breakpoint.lineNumber(), breakpoint.columnNumber(), breakpoint.condition(), breakpoint.enabled());
+    },
+
+    /**
+     * @param {!WebInspector.UISourceCode} uiSourceCode
+     * @return {boolean}
+     */
+    hasUnsavedCommittedChanges: function(uiSourceCode)
+    {
+        if (this._workspace.hasResourceContentTrackingExtensions())
+            return false;
+        if (uiSourceCode.url() && WebInspector.fileManager.isURLSaved(uiSourceCode.url()))
+            return false;
+        if (uiSourceCode.project().canSetFileContent())
+            return false;
+        if (uiSourceCode[WebInspector.Persistence._binding])
+            return false;
+        return !!uiSourceCode.history.length;
+    },
+
+    /**
+     * @param {!WebInspector.UISourceCode} uiSourceCode
+     * @return {?WebInspector.PersistenceBinding}
+     */
+    binding: function(uiSourceCode)
+    {
+        return uiSourceCode[WebInspector.Persistence._binding] || null;
+    },
+
+    dispose: function()
+    {
+        WebInspector.EventTarget.removeEventListeners(this._eventListeners);
+    },
+
+    __proto__: WebInspector.Object.prototype
+}
+
+/**
+ * @constructor
+ * @param {!WebInspector.UISourceCode} network
+ * @param {!WebInspector.UISourceCode} fileSystem
+ */
+WebInspector.PersistenceBinding = function(network, fileSystem)
+{
+    this.network = network;
+    this.fileSystem = fileSystem;
+}
+
+/** @type {!WebInspector.Persistence} */
+WebInspector.persistence;