DevTools: Extract workspace mapping suggesting logic from sources panel.

Source/devtools/front_end/sources/SourcesPanel.js

 /*
  * Copyright (C) 2008 Apple Inc. All Rights Reserved.
  * Copyright (C) 2011 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
@@ skipping 89 matching lines @@
     WebInspector.breakpointManager.addEventListener(WebInspector.BreakpointManager.Events.BreakpointsActiveStateChanged, this._breakpointsActiveStateChanged, this);
     WebInspector.context.addFlavorChangeListener(WebInspector.Target, this._onCurrentTargetChanged, this);
     WebInspector.targetManager.addModelListener(WebInspector.DebuggerModel, WebInspector.DebuggerModel.Events.DebuggerWasEnabled, this._debuggerWasEnabled, this);
     WebInspector.targetManager.addModelListener(WebInspector.DebuggerModel, WebInspector.DebuggerModel.Events.DebuggerWasDisabled, this._debuggerReset, this);
     WebInspector.targetManager.addModelListener(WebInspector.DebuggerModel, WebInspector.DebuggerModel.Events.DebuggerPaused, this._debuggerPaused, this);
     WebInspector.targetManager.addModelListener(WebInspector.DebuggerModel, WebInspector.DebuggerModel.Events.DebuggerResumed, this._debuggerResumed, this);
     WebInspector.targetManager.addModelListener(WebInspector.DebuggerModel, WebInspector.DebuggerModel.Events.CallFrameSelected, this._callFrameSelected, this);
     WebInspector.targetManager.addModelListener(WebInspector.DebuggerModel, WebInspector.DebuggerModel.Events.ConsoleCommandEvaluatedInSelectedCallFrame, this._consoleCommandEvaluatedInSelectedCallFrame, this);
     WebInspector.targetManager.addModelListener(WebInspector.DebuggerModel, WebInspector.DebuggerModel.Events.GlobalObjectCleared, this._debuggerReset, this);
     WebInspector.targetManager.observeTargets(this);
+    new WebInspector.WorkspaceMappingTip(this, this._workspace);
 }
 
 WebInspector.SourcesPanel.minToolbarWidth = 215;
 
-WebInspector.SourcesPanel._infobarSymbol = Symbol("infobar");
-
 WebInspector.SourcesPanel.prototype = {
     /**
      * @param {?WebInspector.Target} target
      */
     _setTarget: function(target)
     {
         if (!target)
             return;
 
         if (target.debuggerModel.isPaused()) {
@@ skipping 345 matching lines @@
         return true;
     },
 
     /**
      * @param {!WebInspector.Event} event
      */
     _editorSelected: function(event)
     {
         var uiSourceCode = /** @type {!WebInspector.UISourceCode} */ (event.data);
         this._editorChanged(uiSourceCode);
-        if (Runtime.experiments.isEnabled("suggestUsingWorkspace")) {
-            if (this._editorSelectedTimer)
-                clearTimeout(this._editorSelectedTimer);
-            this._editorSelectedTimer = setTimeout(this._updateSuggestedMappingInfobar.bind(this, uiSourceCode), 3000);
-        }
     },
 
     /**
-     * @param {!WebInspector.UISourceCode} uiSourceCode
-     */
-    _updateSuggestedMappingInfobar: function(uiSourceCode)
-    {
-        if (!this.isShowing())
-            return;
-        if (uiSourceCode[WebInspector.SourcesPanel._infobarSymbol])
-            return;
-
-        // First try mapping filesystem -> network.
-        var uiSourceCodeFrame = this._sourcesView.viewForFile(uiSourceCode);
-        if (uiSourceCode.project().type() === WebInspector.projectTypes.FileSystem) {
-            var hasMappings = !!uiSourceCode.url;
-            if (hasMappings)
-                return;
-
-            var targets = WebInspector.targetManager.targets();
-            for (var i = 0; i < targets.length; ++i)
-                targets[i].resourceTreeModel.forAllResources(matchResource.bind(this));
-        }
-
-        /**
-         * @param {!WebInspector.Resource} resource
-         * @return {boolean}
-         * @this {WebInspector.SourcesPanel}
-         */
-        function matchResource(resource)
-        {
-            if (resource.contentURL().endsWith(uiSourceCode.name())) {
-                createMappingInfobar.call(this, false);
-                return true;
-            }
-            return false;
-        }
-
-        // Then map network -> filesystem.
-        if (uiSourceCode.project().type() === WebInspector.projectTypes.Network || uiSourceCode.project().type() === WebInspector.projectTypes.ContentScripts) {
-            if (this._workspace.uiSourceCodeForURL(uiSourceCode.url) !== uiSourceCode)
-                return;
-
-            var filesystemProjects = this._workspace.projectsForType(WebInspector.projectTypes.FileSystem);
-            for (var i = 0; i < filesystemProjects.length; ++i) {
-                var name = uiSourceCode.name();
-                var fsUiSourceCodes = filesystemProjects[i].uiSourceCodes();
-                for (var j = 0; j < fsUiSourceCodes.length; ++j) {
-                    if (fsUiSourceCodes[j].name() === name) {
-                        createMappingInfobar.call(this, true);
-                        return;
-                    }
-                }
-            }
-
-            // There are no matching filesystems. Suggest adding a filesystem in case of localhost.
-            var originURL = uiSourceCode.originURL().asParsedURL();
-            if (originURL && originURL.host === "localhost")
-                createWorkspaceInfobar();
-        }
-
-        /**
-         * @param {boolean} isNetwork
-         * @this {WebInspector.SourcesPanel}
-         */
-        function createMappingInfobar(isNetwork)
-        {
-            var title;
-            if (isNetwork)
-                title = WebInspector.UIString("Map network resource '%s' to workspace?", uiSourceCode.originURL());
-            else
-                title = WebInspector.UIString("Map workspace resource '%s' to network?", uiSourceCode.path());
-
-            var infobar = new WebInspector.UISourceCodeFrame.Infobar(WebInspector.UISourceCodeFrame.Infobar.Level.Info, title);
-            infobar.createDetailsRowMessage(WebInspector.UIString("You can map files in your workspace to the ones loaded over the network. As a result, changes made in DevTools will be persisted to disk."));
-            infobar.createDetailsRowMessage(WebInspector.UIString("Use context menu to establish the mapping at any time."));
-            var actionLink = infobar.createDetailsRowMessage("").createChild("a");
-            actionLink.href = "";
-            actionLink.onclick = establishTheMapping.bind(this);
-            actionLink.textContent = WebInspector.UIString("Establish the mapping now...");
-            appendInfobar(infobar);
-        }
-
-        /**
-         * @param {?Event} event
-         * @this {WebInspector.SourcesPanel}
-         */
-        function establishTheMapping(event)
-        {
-            event.consume(true);
-            if (uiSourceCode.project().type() === WebInspector.projectTypes.FileSystem)
-                this._mapFileSystemToNetwork(uiSourceCode);
-            else
-                this._mapNetworkToFileSystem(uiSourceCode);
-        }
-
-        function createWorkspaceInfobar()
-        {
-            var infobar = new WebInspector.UISourceCodeFrame.Infobar(WebInspector.UISourceCodeFrame.Infobar.Level.Info, WebInspector.UIString("Serving from the file system? Add your files into the workspace."));
-            infobar.createDetailsRowMessage(WebInspector.UIString("If you add files into your DevTools workspace, your changes will be persisted to disk."));
-            infobar.createDetailsRowMessage(WebInspector.UIString("To add a folder into the workspace, drag and drop it into the Sources panel."));
-            appendInfobar(infobar);
-        }
-
-        /**
-         * @param {!WebInspector.UISourceCodeFrame.Infobar} infobar
-         */
-        function appendInfobar(infobar)
-        {
-            infobar.createDetailsRowMessage("").createChild("br");
-            var rowElement = infobar.createDetailsRowMessage(WebInspector.UIString("For more information on workspaces, refer to the "));
-            var a = rowElement.createChild("a");
-            a.textContent = "workspaces documentation";
-            a.href = "https://developer.chrome.com/devtools/docs/workspaces";
-            rowElement.createTextChild(".");
-            uiSourceCode[WebInspector.SourcesPanel._infobarSymbol] = infobar;
-            uiSourceCodeFrame.attachInfobars([infobar]);
-        }
-    },
-
-    /**
      * @param {!WebInspector.Event} event
      */
     _editorClosed: function(event)
     {
         var wasSelected = /** @type {boolean} */ (event.data.wasSelected);
         if (wasSelected)
             this._editorChanged(null);
     },
 
     /**
@@ skipping 288 matching lines @@
 
     _suggestReload: function()
     {
         if (window.confirm(WebInspector.UIString("It is recommended to restart inspector after making these changes. Would you like to restart it?")))
             WebInspector.reload();
     },
 
     /**
      * @param {!WebInspector.UISourceCode} uiSourceCode
      */
-    _mapFileSystemToNetwork: function(uiSourceCode)
+    mapFileSystemToNetwork: function(uiSourceCode)
     {
         WebInspector.SelectUISourceCodeForProjectTypesDialog.show(uiSourceCode.name(), [WebInspector.projectTypes.Network, WebInspector.projectTypes.ContentScripts], mapFileSystemToNetwork.bind(this), this.editorView.mainElement())
 
         /**
          * @param {!WebInspector.UISourceCode} networkUISourceCode
          * @this {WebInspector.SourcesPanel}
          */
         function mapFileSystemToNetwork(networkUISourceCode)
         {
             this._workspace.addMapping(networkUISourceCode, uiSourceCode, WebInspector.fileSystemWorkspaceBinding);
             this._suggestReload();
         }
     },
 
     /**
-     * @param {!WebInspector.UISourceCode} uiSourceCode
-     */
-    _removeNetworkMapping: function(uiSourceCode)
-    {
-        if (confirm(WebInspector.UIString("Are you sure you want to remove network mapping?"))) {
-            this._workspace.removeMapping(uiSourceCode);
-            this._suggestReload();
-        }
-    },
-
-    /**
      * @param {!WebInspector.UISourceCode} networkUISourceCode
      */
-    _mapNetworkToFileSystem: function(networkUISourceCode)
+    mapNetworkToFileSystem: function(networkUISourceCode)
     {
         WebInspector.SelectUISourceCodeForProjectTypesDialog.show(networkUISourceCode.name(), [WebInspector.projectTypes.FileSystem], mapNetworkToFileSystem.bind(this), this.editorView.mainElement())
 
         /**
          * @param {!WebInspector.UISourceCode} uiSourceCode
          * @this {WebInspector.SourcesPanel}
          */
         function mapNetworkToFileSystem(uiSourceCode)
         {
             this._workspace.addMapping(networkUISourceCode, uiSourceCode, WebInspector.fileSystemWorkspaceBinding);
             this._suggestReload();
         }
     },
 
     /**
+     * @param {!WebInspector.UISourceCode} uiSourceCode
+     */
+    _removeNetworkMapping: function(uiSourceCode)
+    {
+        if (confirm(WebInspector.UIString("Are you sure you want to remove network mapping?"))) {
+            this._workspace.removeMapping(uiSourceCode);
+            this._suggestReload();
+        }
+    },
+
+    /**
      * @param {!WebInspector.ContextMenu} contextMenu
      * @param {!WebInspector.UISourceCode} uiSourceCode
      */
     _appendUISourceCodeMappingItems: function(contextMenu, uiSourceCode)
     {
         if (uiSourceCode.project().type() === WebInspector.projectTypes.FileSystem) {
             var hasMappings = !!uiSourceCode.url;
             if (!hasMappings)
-                contextMenu.appendItem(WebInspector.UIString(WebInspector.useLowerCaseMenuTitles() ? "Map to network resource\u2026" : "Map to Network Resource\u2026"), this._mapFileSystemToNetwork.bind(this, uiSourceCode));
+                contextMenu.appendItem(WebInspector.UIString(WebInspector.useLowerCaseMenuTitles() ? "Map to network resource\u2026" : "Map to Network Resource\u2026"), this.mapFileSystemToNetwork.bind(this, uiSourceCode));
             else
                 contextMenu.appendItem(WebInspector.UIString(WebInspector.useLowerCaseMenuTitles() ? "Remove network mapping" : "Remove Network Mapping"), this._removeNetworkMapping.bind(this, uiSourceCode));
         }
 
         /**
          * @param {!WebInspector.Project} project
          */
         function filterProject(project)
         {
             return project.type() === WebInspector.projectTypes.FileSystem;
         }
 
         if (uiSourceCode.project().type() === WebInspector.projectTypes.Network || uiSourceCode.project().type() === WebInspector.projectTypes.ContentScripts) {
             if (!this._workspace.projects().filter(filterProject).length)
                 return;
             if (this._workspace.uiSourceCodeForURL(uiSourceCode.url) === uiSourceCode)
-                contextMenu.appendItem(WebInspector.UIString(WebInspector.useLowerCaseMenuTitles() ? "Map to file system resource\u2026" : "Map to File System Resource\u2026"), this._mapNetworkToFileSystem.bind(this, uiSourceCode));
+                contextMenu.appendItem(WebInspector.UIString(WebInspector.useLowerCaseMenuTitles() ? "Map to file system resource\u2026" : "Map to File System Resource\u2026"), this.mapNetworkToFileSystem.bind(this, uiSourceCode));
         }
     },
 
     /**
      * @param {!Event} event
      * @param {!WebInspector.ContextMenu} contextMenu
      * @param {!Object} target
      */
     _appendUISourceCodeItems: function(event, contextMenu, target)
     {
@@ skipping 532 matching lines @@
 
 WebInspector.SourcesPanelFactory.prototype = {
     /**
      * @return {!WebInspector.Panel}
      */
     createPanel: function()
     {
         return WebInspector.SourcesPanel.instance();
     }
 }