Use const enum for resource types.

Author: mstange

src/profile-logic/bottom-box.ts

@@ -2,7 +2,7 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
-import { resourceTypes } from './data-structures';
+import { ResourceType } from 'firefox-profiler/types';
 
 import type {
   Thread,
@@ -49,7 +49,7 @@ export function getBottomBoxInfoForCallNode(
   const sourceIndex = funcTable.source[funcIndex];
   const resource = funcTable.resource[funcIndex];
   const libIndex =
-    resource !== -1 && resourceTable.type[resource] === resourceTypes.library
+    resource !== -1 && resourceTable.type[resource] === ResourceType.Library
       ? resourceTable.lib[resource]
       : null;
   const callNodeFramePerStack = getCallNodeFramePerStack(
@@ -152,7 +152,7 @@ export function getBottomBoxInfoForStackFrame(
   const sourceIndex = funcTable.source[funcIndex];
   const resource = funcTable.resource[funcIndex];
   const libIndex =
-    resource !== -1 && resourceTable.type[resource] === resourceTypes.library
+    resource !== -1 && resourceTable.type[resource] === ResourceType.Library
       ? resourceTable.lib[resource]
       : null;
 

src/profile-logic/call-tree.ts

@@ -7,7 +7,6 @@ import {
   getOriginAnnotationForFunc,
   getCategoryPairLabel,
 } from './profile-data';
-import { resourceTypes } from './data-structures';
 import { getFunctionName } from './function-info';
 import type {
   CategoryList,
@@ -28,6 +27,7 @@ import type {
   SelfAndTotal,
   BalancedNativeAllocationsTable,
 } from 'firefox-profiler/types';
+import { ResourceType } from 'firefox-profiler/types';
 
 import ExtensionIcon from '../../res/img/svg/extension.svg';
 import { formatCallNodeNumber, formatPercent } from '../utils/format-numbers';
@@ -511,9 +511,9 @@ export class CallTree {
       let iconSrc = null;
       let icon = null;
 
-      if (resourceType === resourceTypes.webhost) {
+      if (resourceType === ResourceType.Webhost) {
         icon = iconSrc = extractFaviconFromLibname(libName);
-      } else if (resourceType === resourceTypes.addon) {
+      } else if (resourceType === ResourceType.Addon) {
         iconSrc = ExtensionIcon;
 
         const resourceNameIndex =

src/profile-logic/data-structures.ts

@@ -299,15 +299,6 @@ export function shallowCloneRawMarkerTable(
   };
 }
 
-export const resourceTypes = {
-  unknown: 0,
-  library: 1,
-  addon: 2,
-  webhost: 3,
-  otherhost: 4,
-  url: 5,
-};
-
 export function getEmptyExtensions(): ExtensionTable {
   return {
     // Important!

src/profile-logic/global-data-collector.ts

@@ -10,7 +10,6 @@ import {
   getEmptyRawStackTable,
   getEmptyResourceTable,
   getEmptySourceTable,
-  resourceTypes,
 } from './data-structures';
 
 import type {
@@ -33,6 +32,7 @@ import type {
   Address,
   Bytes,
 } from 'firefox-profiler/types';
+import { ResourceType } from 'firefox-profiler/types';
 
 /**
  * GlobalDataCollector collects data which is global in the processed profile
@@ -163,7 +163,7 @@ export class GlobalDataCollector {
         resourceTable.name[resourceIndex] =
           this._stringTable.indexForString(name);
         resourceTable.host[resourceIndex] = idIndex;
-        resourceTable.type[resourceIndex] = resourceTypes.addon;
+        resourceTable.type[resourceIndex] = ResourceType.Addon;
       }
     }
   }
@@ -208,15 +208,15 @@ export class GlobalDataCollector {
         this._stringTable.indexForString(origin);
       resourceTable.host[resourceIndex] =
         this._stringTable.indexForString(host);
-      resourceTable.type[resourceIndex] = resourceTypes.webhost;
+      resourceTable.type[resourceIndex] = ResourceType.Webhost;
     } else {
       // This is a URL, but it doesn't point to something on the web, e.g. a
       // chrome url.
       resourceTable.lib[resourceIndex] = null;
       resourceTable.name[resourceIndex] =
         this._stringTable.indexForString(scriptURI);
       resourceTable.host[resourceIndex] = null;
-      resourceTable.type[resourceIndex] = resourceTypes.url;
+      resourceTable.type[resourceIndex] = ResourceType.Url;
     }
     return resourceIndex;
   }
@@ -236,7 +236,7 @@ export class GlobalDataCollector {
       this._libs[libIndex].name
     );
     resourceTable.host[resourceIndex] = null;
-    resourceTable.type[resourceIndex] = resourceTypes.library;
+    resourceTable.type[resourceIndex] = ResourceType.Library;
     return resourceIndex;
   }
 
@@ -255,7 +255,7 @@ export class GlobalDataCollector {
     resourceTable.lib[resourceIndex] = null;
     resourceTable.name[resourceIndex] = libNameStringIndex;
     resourceTable.host[resourceIndex] = null;
-    resourceTable.type[resourceIndex] = resourceTypes.library;
+    resourceTable.type[resourceIndex] = ResourceType.Library;
     return resourceIndex;
   }
 

src/profile-logic/process-profile.ts

@@ -287,7 +287,7 @@ export function extractFuncsAndResourcesFromFrameLocations(
  * address.
  * We also associate the address with the library that contains it, and convert the address
  * into a library-relative offset. This association is established via the function's
- * "resource": The function points to the resource (of type resourceTypes.library), and the
+ * "resource": The function points to the resource (of type ResourceType.Library), and the
  * resource has the index to the library in thread.libs.
  * We return the index of the newly-added function, and the address as a library-relative
  * offset.

src/profile-logic/processed-profile-versioning.ts

@@ -14,7 +14,7 @@
  */
 
 import { sortDataTable } from '../utils/data-table-utils';
-import { resourceTypes } from './data-structures';
+import { ResourceType } from 'firefox-profiler/types';
 import { StringTable } from '../utils/string-table';
 import { timeCode } from '../utils/time-code';
 import { PROCESSED_PROFILE_VERSION } from '../app-logic/constants';
@@ -356,19 +356,19 @@ const _upgraders: {
       };
       function addLibResource(name: number, lib: number) {
         const index = newResourceTable.length++;
-        newResourceTable.type[index] = resourceTypes.library;
+        newResourceTable.type[index] = ResourceType.Library;
         newResourceTable.name[index] = name;
         newResourceTable.lib[index] = lib;
       }
       function addWebhostResource(origin: number, host: number) {
         const index = newResourceTable.length++;
-        newResourceTable.type[index] = resourceTypes.webhost;
+        newResourceTable.type[index] = ResourceType.Webhost;
         newResourceTable.name[index] = origin;
         newResourceTable.host[index] = host;
       }
       function addUrlResource(url: number) {
         const index = newResourceTable.length++;
-        newResourceTable.type[index] = resourceTypes.url;
+        newResourceTable.type[index] = ResourceType.Url;
         newResourceTable.name[index] = url;
       }
       const oldResourceToNewResourceMap = new Map();
@@ -378,7 +378,7 @@ const _upgraders: {
         resourceIndex < resourceTable.length;
         resourceIndex++
       ) {
-        if (resourceTable.type[resourceIndex] === resourceTypes.library) {
+        if (resourceTable.type[resourceIndex] === ResourceType.Library) {
           oldResourceToNewResourceMap.set(
             resourceIndex,
             newResourceTable.length
@@ -387,7 +387,7 @@ const _upgraders: {
             resourceTable.name[resourceIndex],
             resourceTable.lib[resourceIndex]
           );
-        } else if (resourceTable.type[resourceIndex] === resourceTypes.url) {
+        } else if (resourceTable.type[resourceIndex] === ResourceType.Url) {
           const scriptURI = stringTable.getString(
             resourceTable.name[resourceIndex]
           );
@@ -1810,7 +1810,7 @@ const _upgraders: {
           continue;
         }
         const resourceType = resourceTable.type[resourceIndex];
-        if (resourceType !== resourceTypes.library) {
+        if (resourceType !== ResourceType.Library) {
           continue;
         }
         const libIndex = resourceTable.lib[resourceIndex];

src/profile-logic/profile-data.ts

@@ -6,7 +6,6 @@ import memoize from 'memoize-immutable';
 import MixedTupleMap from 'mixedtuplemap';
 import { oneLine } from 'common-tags';
 import {
-  resourceTypes,
   getEmptyRawStackTable,
   getEmptyCallNodeTable,
   shallowCloneFrameTable,
@@ -88,7 +87,6 @@ import type {
   CallTreeSummaryStrategy,
   EventDelayInfo,
   ThreadsKey,
-  ResourceTypeEnum,
   MarkerPayload,
   Address,
   AddressProof,
@@ -101,7 +99,7 @@ import type {
   IndexIntoSourceTable,
   TransformOutput,
 } from 'firefox-profiler/types';
-import { SelectedState } from 'firefox-profiler/types';
+import { SelectedState, ResourceType } from 'firefox-profiler/types';
 import type { CallNodeInfo, SuffixOrderIndex } from './call-node-info';
 
 /**
@@ -3080,7 +3078,7 @@ export function getThreadProcessDetails(
 function _shouldShowBothOriginAndFileName(
   fileName: string,
   origin: string,
-  resourceType: ResourceTypeEnum | null
+  resourceType: ResourceType | null
 ): boolean {
   // If the origin string is just a URL prefix that's part of the
   // filename, it doesn't add any useful information, so only show
@@ -3091,7 +3089,7 @@ function _shouldShowBothOriginAndFileName(
 
   // For native code (resource type "library"), if we have the filename of the
   // source code, only show the filename and not the library name.
-  if (resourceType === resourceTypes.library) {
+  if (resourceType === ResourceType.Library) {
     return false;
   }
 
@@ -3189,10 +3187,10 @@ export function reserveFunctionsForCollapsedResources(
     IndexIntoFuncTable
   >();
   const jsResourceTypes = [
-    resourceTypes.addon,
-    resourceTypes.url,
-    resourceTypes.webhost,
-    resourceTypes.otherhost,
+    ResourceType.Addon,
+    ResourceType.Url,
+    ResourceType.Webhost,
+    ResourceType.OtherHost,
   ];
   for (
     let resourceIndex = 0;
@@ -4060,7 +4058,7 @@ export function findAddressProofForFile(
     return null;
   }
   const resource = funcTable.resource[func];
-  if (resourceTable.type[resource] !== resourceTypes.library) {
+  if (resourceTable.type[resource] !== ResourceType.Library) {
     return null;
   }
   const libIndex = resourceTable.lib[resource];

src/profile-logic/symbolication.ts

@@ -2,7 +2,6 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 import {
-  resourceTypes,
   getEmptyRawStackTable,
   shallowCloneFuncTable,
   shallowCloneNativeSymbolTable,
@@ -24,6 +23,7 @@ import type {
   CallNodePath,
   Lib,
 } from 'firefox-profiler/types';
+import { ResourceType } from 'firefox-profiler/types';
 import type {
   AbstractSymbolStore,
   AddressResult,
@@ -276,13 +276,13 @@ function getSymbolicationInfo(
     resourceIndex++
   ) {
     const resourceType = resourceTable.type[resourceIndex];
-    if (resourceType !== resourceTypes.library) {
+    if (resourceType !== ResourceType.Library) {
       continue;
     }
     const libIndex = resourceTable.lib[resourceIndex];
     if (libIndex === null) {
       // We can get here if we have pre-symbolicated "funcName (in LibraryName)"
-      // frames. Those get resourceTypes.library but no libIndex.
+      // frames. Those get ResourceType.Library but no libIndex.
       continue;
     }
     const lib = libs[libIndex];

src/test/store/symbolication.test.ts

@@ -10,6 +10,7 @@ import {
 } from '../fixtures/example-symbol-table';
 import type { ExampleSymbolTable } from '../fixtures/example-symbol-table';
 import type { MarkerPayload } from 'firefox-profiler/types';
+import { ResourceType } from 'firefox-profiler/types';
 import type {
   AddressResult,
   LibSymbolicationRequest,
@@ -23,10 +24,7 @@ import {
 import * as ProfileViewSelectors from '../../selectors/profile';
 import { selectedThreadSelectors } from '../../selectors/per-thread';
 import { INTERVAL } from 'firefox-profiler/app-logic/constants';
-import {
-  resourceTypes,
-  getEmptyRawMarkerTable,
-} from '../../profile-logic/data-structures';
+import { getEmptyRawMarkerTable } from '../../profile-logic/data-structures';
 import { doSymbolicateProfile } from '../../actions/receive-profile';
 import {
   changeSelectedCallNode,
@@ -593,7 +591,7 @@ function _createUnsymbolicatedProfile() {
     lib: [libIndex],
     name: [stringTable.indexForString('example lib')],
     host: [stringTable.indexForString('example host')],
-    type: [resourceTypes.library],
+    type: [ResourceType.Library],
   };
   for (let i = 0; i < profile.shared.funcTable.length; i++) {
     profile.shared.funcTable.resource[i] = 0;

src/test/unit/profile-data.test.ts

@@ -28,7 +28,6 @@ import {
   getCallNodeFramePerStack,
   getTotalNativeSymbolTimingsForCallNode,
 } from '../../profile-logic/profile-data';
-import { resourceTypes } from '../../profile-logic/data-structures';
 import {
   createGeckoProfile,
   createGeckoProfileWithJsTimings,
@@ -64,7 +63,7 @@ import type {
   IndexIntoCategoryList,
   IndexIntoNativeSymbolTable,
 } from 'firefox-profiler/types';
-import { SelectedState } from 'firefox-profiler/types';
+import { SelectedState, ResourceType } from 'firefox-profiler/types';
 
 describe('string-table', function () {
   const u = StringTable.withBackingArray(['foo', 'bar', 'baz']);
@@ -343,10 +342,10 @@ describe('process-profile', function () {
     it('should create one resource per used library', function () {
       const shared = profile.shared;
       expect(shared.resourceTable.length).toEqual(4);
-      expect(shared.resourceTable.type[0]).toEqual(resourceTypes.addon);
-      expect(shared.resourceTable.type[1]).toEqual(resourceTypes.library);
-      expect(shared.resourceTable.type[2]).toEqual(resourceTypes.url);
-      expect(shared.resourceTable.type[3]).toEqual(resourceTypes.library);
+      expect(shared.resourceTable.type[0]).toEqual(ResourceType.Addon);
+      expect(shared.resourceTable.type[1]).toEqual(ResourceType.Library);
+      expect(shared.resourceTable.type[2]).toEqual(ResourceType.Url);
+      expect(shared.resourceTable.type[3]).toEqual(ResourceType.Library);
       const [name0, name1, name2, name3] = shared.resourceTable.name;
       expect(shared.stringArray[name0]).toEqual(
         'Extension "Form Autofill" (ID: formautofill@mozilla.org)'