[project_settings] Load devtools.json for DevTools-on-DevTools.

For the DevTools-on-DevTools case, we need to add some additional magic
in the `ProjectSettingsModel` in order to also load the project settings
from the well-known URI, mainly because the base URL is different from
the origin (`devtools://devtools/bundled` vs. `devtools://devtools`).

Bug: 399502654, 395037775
Change-Id: I7d22320124ab0790a2257b6be563b8499a343048
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/6304925
Commit-Queue: Simon Zünd <[email protected]>
Reviewed-by: Simon Zünd <[email protected]>
Auto-Submit: Benedikt Meurer <[email protected]>

Author: bmeurer

front_end/models/project_settings/ProjectSettingsModel.test.ts

@@ -60,6 +60,7 @@ describe('ProjectSettingsModel', () => {
     const frame = sinon.createStubInstance(SDK.ResourceTreeModel.ResourceTreeFrame);
     resourceTreeModel.mainFrame = frame;
     sinon.stub(frame, 'securityOriginDetails').get(() => ({isLocalhost: false}));
+    sinon.stub(frame, 'url').get(() => urlString`http://www.example.com/`);
 
     const projectSettingsModel = ProjectSettingsModel.instance({
       forceNew: true,
@@ -92,8 +93,9 @@ describe('ProjectSettingsModel', () => {
     sinon.stub(frame, 'url').get(() => initiatorUrl);
     sinon.stub(frame, 'id').get(() => frameId);
 
+    const content = '{"workspace":{"root":"/home/foo","uuid":"8f7b028c-0323-485f-bcb9-b404edc0f186"}}';
     pageResourceLoader.loadResource.withArgs(url, sinon.match({target, frameId, initiatorUrl}))
-        .returns(Promise.resolve({content: '{"workspace":{"root":"/home/foo","uuid":"foo"}}'}));
+        .returns(Promise.resolve({content}));
 
     const projectSettingsModel = ProjectSettingsModel.instance({
       forceNew: true,
@@ -106,7 +108,72 @@ describe('ProjectSettingsModel', () => {
     assert.deepEqual(projectSettings, {
       workspace: {
         root: '/home/foo' as Platform.DevToolsPath.RawPathString,
-        uuid: 'foo',
+        uuid: '8f7b028c-0323-485f-bcb9-b404edc0f186',
+      }
+    });
+  });
+
+  it('doesn\'t load the devtools.json from DevTools-on-DevTools (without --custom-devtools-frontend)', async () => {
+    const hostConfig = {devToolsWellKnown: {enabled: true}};
+    const pageResourceLoader = sinon.createStubInstance(SDK.PageResourceLoader.PageResourceLoader);
+    const targetManager = sinon.createStubInstance(SDK.TargetManager.TargetManager);
+
+    const target = sinon.createStubInstance(SDK.Target.Target);
+    targetManager.primaryPageTarget.returns(target);
+
+    const resourceTreeModel = sinon.createStubInstance(SDK.ResourceTreeModel.ResourceTreeModel);
+    target.model.withArgs(SDK.ResourceTreeModel.ResourceTreeModel).returns(resourceTreeModel);
+
+    const frame = sinon.createStubInstance(SDK.ResourceTreeModel.ResourceTreeFrame);
+    resourceTreeModel.mainFrame = frame;
+    sinon.stub(frame, 'url').get(() => urlString`devtools://devtools/bundled/devtools_app.html`);
+
+    const projectSettingsModel = ProjectSettingsModel.instance({
+      forceNew: true,
+      hostConfig,
+      pageResourceLoader,
+      targetManager,
+    });
+
+    const projectSettings = await projectSettingsModel.projectSettingsPromise;
+    assert.deepEqual(projectSettings, {});
+  });
+
+  it('correctly loads the devtools.json for DevTools-on-DevTools (with --custom-devtools-frontend)', async () => {
+    const hostConfig = {devToolsWellKnown: {enabled: true}};
+    const pageResourceLoader = sinon.createStubInstance(SDK.PageResourceLoader.PageResourceLoader);
+    const targetManager = sinon.createStubInstance(SDK.TargetManager.TargetManager);
+
+    const target = sinon.createStubInstance(SDK.Target.Target);
+    targetManager.primaryPageTarget.returns(target);
+
+    const resourceTreeModel = sinon.createStubInstance(SDK.ResourceTreeModel.ResourceTreeModel);
+    target.model.withArgs(SDK.ResourceTreeModel.ResourceTreeModel).returns(resourceTreeModel);
+
+    const url = urlString`devtools://devtools/bundled/.well-known/appspecific/com.chrome.devtools.json`;
+    const frameId = 'mainFrame';
+    const initiatorUrl = urlString`devtools://devtools/bundled/devtools_app.html?debugFrontend=true`;
+    const frame = sinon.createStubInstance(SDK.ResourceTreeModel.ResourceTreeFrame);
+    resourceTreeModel.mainFrame = frame;
+    sinon.stub(frame, 'url').get(() => initiatorUrl);
+    sinon.stub(frame, 'id').get(() => frameId);
+
+    const content = '{"workspace":{"root":"/path/to/front_end","uuid":"5a509b03-1da9-460d-bc38-0c8166ba0c41"}}';
+    pageResourceLoader.loadResource.withArgs(url, sinon.match({target, frameId, initiatorUrl}))
+        .returns(Promise.resolve({content}));
+
+    const projectSettingsModel = ProjectSettingsModel.instance({
+      forceNew: true,
+      hostConfig,
+      pageResourceLoader,
+      targetManager,
+    });
+
+    const projectSettings = await projectSettingsModel.projectSettingsPromise;
+    assert.deepEqual(projectSettings, {
+      workspace: {
+        root: '/path/to/front_end' as Platform.DevToolsPath.RawPathString,
+        uuid: '5a509b03-1da9-460d-bc38-0c8166ba0c41',
       }
     });
   });

front_end/models/project_settings/ProjectSettingsModel.ts

@@ -7,6 +7,50 @@ import * as Platform from '../../core/platform/platform.js';
 import type * as Root from '../../core/root/root.js';
 import * as SDK from '../../core/sdk/sdk.js';
 
+/** The security origin for all DevTools (front-end) resources. */
+const DEVTOOLS_SECURITY_ORIGIN = 'devtools://devtools';
+
+/** The (absolute) path to the project settings file. */
+const WELL_KNOWN_DEVTOOLS_JSON_PATH = '/.well-known/appspecific/com.chrome.devtools.json';
+
+/**
+ * Checks if the origin of the `url` is `devtools://devtools` (meaning that it's
+ * served by the `DevToolsDataSource` in Chromium) and it's path starts with
+ * `/bundled/`.
+ *
+ * @param url the URL string to check.
+ * @returns `true` if `url` refers to a resource in the Chromium DevTools bundle.
+ */
+function isDevToolsBundledURL(url: string): boolean {
+  return url.startsWith(`${DEVTOOLS_SECURITY_ORIGIN}/bundled/`);
+}
+
+/**
+ * Checks if the `frame` should be considered local and safe for loading the
+ * project settings from.
+ *
+ * This checks the security origin of `frame` for whether Chromium considers it
+ * to be localhost. It also supports special logic for when the origin of the
+ * `frame` is `'devtools://devtools'`, in which case we check whether the path
+ * starts with `'/bundled/'` and `debugFrontend=true` is passed as a query
+ * parameter (indicating that `--custom-devtools-frontend=` command line option
+ * was used).
+ *
+ * @param frame the `ResourceTreeFrame` to check.
+ * @returns `true` if `frame` is considered safe for loading the project settings.
+ * @see https://goo.gle/devtools-json-design
+ */
+function isLocalFrame(frame: SDK.ResourceTreeModel.ResourceTreeFrame|null|undefined):
+    frame is SDK.ResourceTreeModel.ResourceTreeFrame {
+  if (!frame) {
+    return false;
+  }
+  if (isDevToolsBundledURL(frame.url)) {
+    return new URL(frame.url).searchParams.get('debugFrontend') === 'true';
+  }
+  return frame.securityOriginDetails?.isLocalhost ?? false;
+}
+
 /**
  * The structure of the project settings.
  *
@@ -124,12 +168,16 @@ export class ProjectSettingsModel extends Common.ObjectWrapper.ObjectWrapper<Eve
 
   async #loadAndValidateProjectSettings(target: SDK.Target.Target): Promise<ProjectSettings> {
     const frame = target.model(SDK.ResourceTreeModel.ResourceTreeModel)?.mainFrame;
-    if (!frame?.securityOriginDetails?.isLocalhost) {
+    if (!isLocalFrame(frame)) {
       return EMPTY_PROJECT_SETTINGS;
     }
     const initiatorUrl = frame.url;
     const frameId = frame.id;
-    const url = new URL('/.well-known/appspecific/com.chrome.devtools.json', initiatorUrl);
+    let url = WELL_KNOWN_DEVTOOLS_JSON_PATH;
+    if (isDevToolsBundledURL(initiatorUrl)) {
+      url = '/bundled' + url;
+    }
+    url = new URL(url, initiatorUrl).toString();
     const {content} = await this.#pageResourceLoader.loadResource(
         Platform.DevToolsPath.urlString`${url}`,
         {target, frameId, initiatorUrl},