[cleanup] rename DISK to WORKSPACE_PROJECT for clarity

+ additional documentation

Bug: 399333674
Change-Id: Iceb733882d6d4f7838d66936ce01006da7834700
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/6304802
Auto-Submit: Alex Rudenko <[email protected]>
Commit-Queue: Benedikt Meurer <[email protected]>
Reviewed-by: Benedikt Meurer <[email protected]>

Author: OrKoN

front_end/models/persistence/IsolatedFileSystemManager.ts

@@ -368,6 +368,6 @@ function hostFileSystemTypeToPlatformFileSystemType(type: string): PlatformFileS
     case 'overrides':
       return PlatformFileSystemType.OVERRIDES;
     default:
-      return PlatformFileSystemType.DISK;
+      return PlatformFileSystemType.WORKSPACE_PROJECT;
   }
 }

front_end/models/persistence/PersistenceImpl.test.ts

@@ -115,7 +115,11 @@ describeWithMockConnection('PersistenceImpl', () => {
     const fileSystemPath = urlString`file://path/to/filesystem`;
     const fileSystemFileUrl = urlString`${fileSystemPath + '/script.js'}`;
     const {uiSourceCode: fileSystemUiSourceCode, project} = createFileSystemFileForPersistenceTests(
-        {fileSystemPath, fileSystemFileUrl, type: Persistence.PlatformFileSystem.PlatformFileSystemType.DISK},
+        {
+          fileSystemPath,
+          fileSystemFileUrl,
+          type: Persistence.PlatformFileSystem.PlatformFileSystemType.WORKSPACE_PROJECT
+        },
         SCRIPT_DESCRIPTION.url, SCRIPT_DESCRIPTION.content, target);
     const breakpointLine = 0;
 
@@ -141,7 +145,11 @@ describeWithMockConnection('PersistenceImpl', () => {
        const fileSystemPath = urlString`file://path/to/filesystem`;
        const fileSystemFileUrl = urlString`${fileSystemPath + '/script.js'}`;
        const {uiSourceCode: fileSystemUiSourceCode, project} = createFileSystemFileForPersistenceTests(
-           {fileSystemPath, fileSystemFileUrl, type: Persistence.PlatformFileSystem.PlatformFileSystemType.DISK},
+           {
+             fileSystemPath,
+             fileSystemFileUrl,
+             type: Persistence.PlatformFileSystem.PlatformFileSystemType.WORKSPACE_PROJECT
+           },
            SCRIPT_DESCRIPTION.url, SCRIPT_DESCRIPTION.content, target);
        const breakpointLine = 0;
 

front_end/models/persistence/PlatformFileSystem.test.ts

@@ -10,10 +10,10 @@ const {urlString} = Platform.DevToolsPath;
 describe('PlatformFileSystem', () => {
   it('can be instantiated successfully', () => {
     const platformFileSystem = new Persistence.PlatformFileSystem.PlatformFileSystem(
-        urlString`Test Path`, Persistence.PlatformFileSystem.PlatformFileSystemType.DISK, false);
+        urlString`Test Path`, Persistence.PlatformFileSystem.PlatformFileSystemType.WORKSPACE_PROJECT, false);
     assert.strictEqual(platformFileSystem.path(), 'Test Path', 'path was not set or retrieved correctly');
     assert.strictEqual(
-        platformFileSystem.type(), Persistence.PlatformFileSystem.PlatformFileSystemType.DISK,
+        platformFileSystem.type(), Persistence.PlatformFileSystem.PlatformFileSystemType.WORKSPACE_PROJECT,
         'Type was not set or retrieved correctly');
   });
 });

front_end/models/persistence/PlatformFileSystem.ts

@@ -17,9 +17,32 @@ const str_ = i18n.i18n.registerUIStrings('models/persistence/PlatformFileSystem.
 const i18nString = i18n.i18n.getLocalizedString.bind(undefined, str_);
 
 export enum PlatformFileSystemType {
+  /**
+   * Snippets are implemented as a PlatformFileSystem but they are
+   * actually stored in the browser's profile directory and do not
+   * create files on the actual filesystem.
+   *
+   * See Sources > Snippets in the UI.
+   */
   SNIPPETS = 'snippets',
+  /**
+   * Overrides is a filesystem that represents a user-selected folder on
+   * disk. This folder is used to replace page resources using request
+   * interception.
+   *
+   * See Sources > Overrides in the UI.
+   */
   OVERRIDES = 'overrides',
-  DISK = 'disk',
+  /**
+   * Represents a filesystem for a workspace folder that the user added
+   * to DevTools. It can be manually connected or it can be
+   * automatically discovered based on the hints found in devtools.json
+   * served by the inspected page (see
+   * https://goo.gle/devtools-json-design). DevTools tries to map the
+   * page content to the content in such folder but does not use request
+   * interception for this.
+   */
+  WORKSPACE_PROJECT = 'workspace-project',
 }
 
 export class PlatformFileSystem {
@@ -56,6 +79,10 @@ export class PlatformFileSystem {
     return this.#type;
   }
 
+  /**
+   * True if the filesystem was automatically discovered (see
+   * https://goo.gle/devtools-json-design).
+   */
   automatic(): boolean {
     return this.#automatic;
   }

front_end/panels/ai_assistance/AiAssistancePanel.ts

@@ -487,7 +487,7 @@ export class AiAssistancePanel extends UI.Panel.Panel {
         if (!(project instanceof Persistence.FileSystemWorkspaceBinding.FileSystem)) {
           continue;
         }
-        if (project.fileSystem().type() !== Persistence.PlatformFileSystem.PlatformFileSystemType.DISK) {
+        if (project.fileSystem().type() !== Persistence.PlatformFileSystem.PlatformFileSystemType.WORKSPACE_PROJECT) {
           continue;
         }
         this.#project = project;

front_end/testing/UISourceCodeHelpers.ts

@@ -130,7 +130,7 @@ export function createFileSystemUISourceCode(options: {
   const type = options.type || '';
   const content = options.content || '';
   const platformFileSystem = new TestPlatformFileSystem(
-      fileSystemPath, type || Persistence.PlatformFileSystem.PlatformFileSystemType.DISK, options.mimeType,
+      fileSystemPath, type || Persistence.PlatformFileSystem.PlatformFileSystemType.WORKSPACE_PROJECT, options.mimeType,
       Boolean(options.autoMapping));
   const metadata = options.metadata || new Workspace.UISourceCode.UISourceCodeMetadata(null, null);