Add 'unique-string' as an available type for marker payloads and schemas

docs-developer/CHANGELOG-formats.md

@@ -66,6 +66,10 @@ Older versions are not documented in this changelog but can be found in [process
 
 ## Gecko profile format
 
+### Version 28
+
+A new `unique-string` marker schema format type has been added, allowing markers to carry unique-strings in their payloads.
+
 ### Version 27
 
 The `optimizations` field is removed from the `frameTable` schema.

src/app-logic/constants.js

@@ -9,7 +9,7 @@ import type { MarkerPhase } from 'firefox-profiler/types';
 // The current version of the Gecko profile format.
 // Please don't forget to update the gecko profile format changelog in
 // `docs-developer/CHANGELOG-formats.md`.
-export const GECKO_PROFILE_VERSION = 27;
+export const GECKO_PROFILE_VERSION = 28;
 
 // The current version of the "processed" profile format.
 // Please don't forget to update the processed profile format changelog in

src/components/app/MenuButtons/MetaInfo.js

@@ -33,6 +33,7 @@ import type {
   ExtraProfileInfoSection,
 } from 'firefox-profiler/types';
 import type { ConnectedProps } from 'firefox-profiler/utils/connect';
+import { UniqueStringArray } from 'firefox-profiler/utils/unique-string-array';
 
 import './MetaInfo.css';
 
@@ -148,7 +149,12 @@ class MetaInfoPanelImpl extends React.PureComponent<Props, State> {
               <div className="moreInfoRow" key={label}>
                 <span className="metaInfoWideLabel">{label}</span>
                 <div className="moreInfoValue">
-                  {formatFromMarkerSchema('moreInfo', format, value)}
+                  {formatFromMarkerSchema(
+                    'moreInfo',
+                    format,
+                    value,
+                    new UniqueStringArray()
+                  )}
                 </div>
               </div>
             );

src/components/tooltip/Marker.js

@@ -251,7 +251,12 @@ class MarkerTooltipContents extends React.PureComponent<Props> {
                     key={schema.name + '-' + key}
                     label={label || key}
                   >
-                    {formatMarkupFromMarkerSchema(schema.name, format, value)}
+                    {formatMarkupFromMarkerSchema(
+                      schema.name,
+                      format,
+                      value,
+                      thread.stringTable
+                    )}
                   </TooltipDetail>
                 );
               }

src/profile-logic/gecko-profile-versioning.js

@@ -1445,6 +1445,13 @@ const _upgraders = {
     }
     convertToVersion27Recursive(profile);
   },
+  [28]: (_) => {
+    // This version bump added a new marker schema format type, named "unique-string",
+    // which older frontends will not be able to display.
+    // No upgrade is needed, as older versions of firefox would not generate
+    // marker data with unique-string typed data, and no modification is needed in the
+    // frontend to display older formats.
+  },
   // If you add a new upgrader here, please document the change in
   // `docs-developer/CHANGELOG-formats.md`.
 };

src/profile-logic/marker-schema.js

@@ -24,6 +24,7 @@ import type {
   MarkerIndex,
   MarkerPayload,
 } from 'firefox-profiler/types';
+import type { UniqueStringArray } from '../utils/unique-string-array';
 
 /**
  * The marker schema comes from Gecko, and is embedded in the profile. However,
@@ -142,6 +143,7 @@ export function getSchemaFromMarker(
 export function parseLabel(
   markerSchema: MarkerSchema,
   categories: CategoryList,
+  stringTable: UniqueStringArray,
   label: string
 ): (Marker) => string {
   // Split the label on the "{key}" capture groups.
@@ -262,7 +264,12 @@ export function parseLabel(
           return '';
         }
         return format
-          ? formatFromMarkerSchema(markerSchema.name, format, value)
+          ? formatFromMarkerSchema(
+              markerSchema.name,
+              format,
+              value,
+              stringTable
+            )
           : value;
       };
     }
@@ -327,14 +334,18 @@ export function getLabelGetter(
   markerSchemaList: MarkerSchema[],
   markerSchemaByName: MarkerSchemaByName,
   categoryList: CategoryList,
+  stringTable: UniqueStringArray,
   labelKey: LabelKey
 ): (MarkerIndex) => string {
   // Build up a list of label functions, that are tied to the schema name.
   const labelFns: Map<string, (Marker) => string> = new Map();
   for (const schema of markerSchemaList) {
     const labelString = schema[labelKey];
     if (labelString) {
-      labelFns.set(schema.name, parseLabel(schema, categoryList, labelString));
+      labelFns.set(
+        schema.name,
+        parseLabel(schema, categoryList, stringTable, labelString)
+      );
     }
   }
 
@@ -381,7 +392,8 @@ export function getLabelGetter(
 export function formatFromMarkerSchema(
   markerType: string,
   format: MarkerFormatType,
-  value: any
+  value: any,
+  stringTable: UniqueStringArray
 ): string {
   if (value === undefined || value === null) {
     console.warn(
@@ -414,7 +426,12 @@ export function formatFromMarkerSchema(
           }
           return row.map((cell, j) => {
             const { format } = columns[j];
-            return formatFromMarkerSchema(markerType, format || 'string', cell);
+            return formatFromMarkerSchema(
+              markerType,
+              format || 'string',
+              cell,
+              stringTable
+            );
           });
         });
         rows.push(...cellRows);
@@ -432,6 +449,8 @@ export function formatFromMarkerSchema(
     case 'string':
       // Make sure a non-empty string is returned here.
       return String(value) || '(empty)';
+    case 'unique-string':
+      return stringTable.getString(value, '(empty)');
     case 'duration':
     case 'time':
       return formatTimestamp(value);
@@ -456,7 +475,9 @@ export function formatFromMarkerSchema(
         throw new Error('Expected an array for list format');
       }
       return value
-        .map((v) => formatFromMarkerSchema(markerType, 'string', v))
+        .map((v) =>
+          formatFromMarkerSchema(markerType, 'string', v, stringTable)
+        )
         .join(', ');
     default:
       console.warn(
@@ -479,14 +500,15 @@ const URL_SCHEME_REGEXP = /^http(s?):\/\//;
 export function formatMarkupFromMarkerSchema(
   markerType: string,
   format: MarkerFormatType,
-  value: any
+  value: any,
+  stringTable: UniqueStringArray
 ): React.Element<any> | string {
   if (value === undefined || value === null) {
     console.warn(`Formatting ${value} for ${JSON.stringify(markerType)}`);
     return '(empty)';
   }
   if (format !== 'url' && typeof format !== 'object' && format !== 'list') {
-    return formatFromMarkerSchema(markerType, format, value);
+    return formatFromMarkerSchema(markerType, format, value, stringTable);
   }
   if (typeof format === 'object') {
     switch (format.type) {
@@ -526,7 +548,8 @@ export function formatMarkupFromMarkerSchema(
                           {formatMarkupFromMarkerSchema(
                             markerType,
                             columns[i].type || 'string',
-                            cell
+                            cell,
+                            stringTable
                           )}
                         </td>
                       );
@@ -553,7 +576,12 @@ export function formatMarkupFromMarkerSchema(
         <ul className="marker-list-value">
           {value.map((entry, i) => (
             <li key={i}>
-              {formatFromMarkerSchema(markerType, 'string', value[i])}
+              {formatFromMarkerSchema(
+                markerType,
+                'string',
+                value[i],
+                stringTable
+              )}
             </li>
           ))}
         </ul>

src/selectors/per-thread/markers.js

@@ -414,6 +414,7 @@ export function getMarkerSelectorsPerThread(
       ProfileSelectors.getMarkerSchema,
       ProfileSelectors.getMarkerSchemaByName,
       ProfileSelectors.getCategories,
+      threadSelectors.getStringTable,
       () => 'tooltipLabel',
       getLabelGetter
     );
@@ -427,6 +428,7 @@ export function getMarkerSelectorsPerThread(
       ProfileSelectors.getMarkerSchema,
       ProfileSelectors.getMarkerSchemaByName,
       ProfileSelectors.getCategories,
+      threadSelectors.getStringTable,
       () => 'tableLabel',
       getLabelGetter
     );
@@ -440,6 +442,7 @@ export function getMarkerSelectorsPerThread(
       ProfileSelectors.getMarkerSchema,
       ProfileSelectors.getMarkerSchemaByName,
       ProfileSelectors.getCategories,
+      threadSelectors.getStringTable,
       () => 'chartLabel',
       getLabelGetter
     );

src/test/store/__snapshots__/profile-view.test.js.snap

@@ -431,7 +431,7 @@ Object {
     "startTime": 0,
     "symbolicated": true,
     "toolkit": "",
-    "version": 27,
+    "version": 28,
   },
   "pages": Array [
     Object {

src/test/unit/__snapshots__/profile-conversion.test.js.snap

@@ -479,7 +479,7 @@ Object {
     "symbolicated": true,
     "toolkit": undefined,
     "updateChannel": undefined,
-    "version": 27,
+    "version": 28,
     "visualMetrics": undefined,
   },
   "pages": Array [],
@@ -100230,7 +100230,7 @@ Object {
     "symbolicated": true,
     "toolkit": undefined,
     "updateChannel": undefined,
-    "version": 27,
+    "version": 28,
     "visualMetrics": undefined,
   },
   "pages": Array [],
@@ -382170,7 +382170,7 @@ Object {
     "startTime": 0,
     "symbolicated": true,
     "toolkit": "",
-    "version": 27,
+    "version": 28,
   },
   "pages": Array [],
   "threads": Array [
@@ -430874,7 +430874,7 @@ Object {
     "startTime": 0,
     "symbolicated": true,
     "toolkit": "",
-    "version": 27,
+    "version": 28,
   },
   "pages": Array [],
   "threads": Array [
@@ -479578,7 +479578,7 @@ Object {
     "startTime": 0,
     "symbolicated": true,
     "toolkit": "",
-    "version": 27,
+    "version": 28,
   },
   "pages": Array [],
   "threads": Array [
@@ -482618,7 +482618,7 @@ Object {
     "startTime": 0,
     "symbolicated": true,
     "toolkit": "",
-    "version": 27,
+    "version": 28,
   },
   "pages": Array [],
   "threads": Array [
@@ -485736,7 +485736,7 @@ Object {
     "startTime": 0,
     "symbolicated": true,
     "toolkit": "",
-    "version": 27,
+    "version": 28,
   },
   "pages": Array [],
   "threads": Array [
@@ -486936,7 +486936,7 @@ Object {
     "symbolicated": true,
     "toolkit": undefined,
     "updateChannel": undefined,
-    "version": 27,
+    "version": 28,
     "visualMetrics": undefined,
   },
   "pages": Array [],
@@ -494461,7 +494461,7 @@ Object {
     "symbolicated": true,
     "toolkit": undefined,
     "updateChannel": undefined,
-    "version": 27,
+    "version": 28,
     "visualMetrics": undefined,
   },
   "pages": Array [],
@@ -513874,7 +513874,7 @@ Object {
     "symbolicated": true,
     "toolkit": undefined,
     "updateChannel": undefined,
-    "version": 27,
+    "version": 28,
     "visualMetrics": undefined,
   },
   "pages": Array [],
@@ -521392,7 +521392,7 @@ Object {
     "symbolicated": true,
     "toolkit": undefined,
     "updateChannel": undefined,
-    "version": 27,
+    "version": 28,
     "visualMetrics": undefined,
   },
   "pages": Array [],
@@ -544990,7 +544990,7 @@ Object {
     "startTime": 0,
     "symbolicated": true,
     "toolkit": "",
-    "version": 27,
+    "version": 28,
   },
   "pages": Array [],
   "threads": Array [

src/test/unit/__snapshots__/profile-upgrading.test.js.snap

@@ -50,7 +50,7 @@ Object {
     "symbolicated": true,
     "toolkit": undefined,
     "updateChannel": undefined,
-    "version": 27,
+    "version": 28,
     "visualMetrics": undefined,
   },
   "pages": Array [],
@@ -7975,7 +7975,7 @@ Object {
     "stackwalk": 1,
     "startTime": 1460221352723.438,
     "toolkit": "cocoa",
-    "version": 27,
+    "version": 28,
   },
   "pausedRanges": Array [],
   "processes": Array [
@@ -9436,7 +9436,7 @@ Object {
     "stackwalk": 1,
     "startTime": 1460221352723.438,
     "toolkit": "cocoa",
-    "version": 27,
+    "version": 28,
   },
   "pages": Array [
     Object {