Remove searchable from the processed format.

Now all marker fields are searchable.

Fixes #5517.

Author: mstange

docs-developer/CHANGELOG-formats.md

@@ -6,6 +6,10 @@ Note that this is not an exhaustive list. Processed profile format upgraders can
 
 ## Processed profile format
 
+### Version 57
+
+The `searchable` property in marker schemas, originally added in version 44, is now removed again. Now all marker fields are searchable.
+
 ### Version 56
 
 The `stringArray` is now shared across threads. The shared array is stored at `profile.shared.stringArray`.

docs-user/guide-ui-tour-panels.md

@@ -80,10 +80,10 @@ can be a substring to match, `key:substring` to match more specifically,
 or `-key:substring` to drop anything matching. (`-substring` will not work;
 negative matches require a `key`.) Valid `key` values are: `name`, `cat` (for
 marker category), `type` (for markers with payload objects), and any marker
-payload field key that is searchable according to the marker's schema.
+payload field key declared in the marker's schema.
 
 Example: `DOM,cat:GC,-name:CSS` will match anything with DOM in its category,
-name, type, or searchable field, plus anything with "GC" in its category,
+name, type, or any field, plus anything with "GC" in its category,
 but omitting markers with "CSS" anywhere in their names.
 
 ## The Marker Table

src/app-logic/constants.js

@@ -14,7 +14,7 @@ export const GECKO_PROFILE_VERSION = 31;
 // The current version of the "processed" profile format.
 // Please don't forget to update the processed profile format changelog in
 // `docs-developer/CHANGELOG-formats.md`.
-export const PROCESSED_PROFILE_VERSION = 56;
+export const PROCESSED_PROFILE_VERSION = 57;
 
 // The following are the margin sizes for the left and right of the timeline. Independent
 // components need to share these values.

src/profile-logic/import/chrome.js

@@ -945,7 +945,6 @@ function extractMarkers(
           key: 'type2',
           label: 'Event Type',
           format: 'string',
-          searchable: true,
         },
       ],
     },

src/profile-logic/marker-data.js

@@ -223,7 +223,7 @@ function positiveFilterMarker(
       return true;
     }
 
-    // Now check the schema for the marker payload for searchable
+    // Now check the schema for the marker payload for field matches
     const markerSchema = getSchemaFromMarker(markerSchemaByName, marker.data);
     if (
       markerSchema &&
@@ -285,7 +285,7 @@ function negativeFilterMarker(
       return false;
     }
 
-    // Now check the schema for the marker payload for searchable
+    // Now check the schema for the marker payload for field matches
     const markerSchema = getSchemaFromMarker(markerSchemaByName, marker.data);
 
     if (

src/profile-logic/marker-schema.js

@@ -55,11 +55,11 @@ export const markerSchemaFrontEndOnly: MarkerSchema[] = [
     chartLabel: '{marker.data.messageType}',
     display: ['marker-chart', 'marker-table', 'timeline-ipc'],
     fields: [
-      { key: 'messageType', label: 'Type', format: 'string', searchable: true },
+      { key: 'messageType', label: 'Type', format: 'string' },
       { key: 'sync', label: 'Sync', format: 'string' },
       { key: 'sendThreadName', label: 'From', format: 'string' },
       { key: 'recvThreadName', label: 'To', format: 'string' },
-      { key: 'otherPid', label: 'Other Pid', format: 'pid', searchable: true },
+      { key: 'otherPid', label: 'Other Pid', format: 'pid' },
     ],
   },
   {
@@ -74,14 +74,12 @@ export const markerSchemaFrontEndOnly: MarkerSchema[] = [
         format: 'string',
         key: 'contentType',
         label: 'Content Type',
-        searchable: true,
         hidden: true,
       },
       {
         format: 'integer',
         key: 'responseStatus',
         label: 'Response Status',
-        searchable: true,
         hidden: true,
       },
     ],
@@ -615,7 +613,7 @@ export function formatMarkupFromMarkerSchema(
 }
 
 /**
- * Takes a marker and a RegExp and checks if any of its `searchable` marker
+ * Takes a marker and a RegExp and checks if any of its marker
  * payload fields match the search regular expression.
  */
 export function markerPayloadMatchesSearch(
@@ -629,39 +627,37 @@ export function markerPayloadMatchesSearch(
     return false;
   }
 
-  // Check if searchable fields match the search regular expression.
+  // Check if fields match the search regular expression.
   for (const payloadField of markerSchema.fields) {
-    if (payloadField.searchable) {
-      let value = data[payloadField.key];
-      if (value === undefined || value === null) {
-        // The value is missing, but this is OK, values are optional.
+    let value = data[payloadField.key];
+    if (value === undefined || value === null) {
+      // The value is missing, but this is OK, values are optional.
+      continue;
+    }
+
+    if (
+      payloadField.format === 'unique-string' ||
+      payloadField.format === 'flow-id' ||
+      payloadField.format === 'terminating-flow-id'
+    ) {
+      if (typeof value !== 'number') {
+        console.warn(
+          `In marker ${marker.name}, the key ${payloadField.key} has an invalid value "${value}" as a unique string, it isn't a number.`
+        );
         continue;
       }
 
-      if (
-        payloadField.format === 'unique-string' ||
-        payloadField.format === 'flow-id' ||
-        payloadField.format === 'terminating-flow-id'
-      ) {
-        if (typeof value !== 'number') {
-          console.warn(
-            `In marker ${marker.name}, the key ${payloadField.key} has an invalid value "${value}" as a unique string, it isn't a number.`
-          );
-          continue;
-        }
-
-        if (!stringTable.hasIndex(value)) {
-          console.warn(
-            `In marker ${marker.name}, the key ${payloadField.key} has an invalid index "${value}" as a unique string, as it's missing from the string table.`
-          );
-          continue;
-        }
-        value = stringTable.getString(value);
+      if (!stringTable.hasIndex(value)) {
+        console.warn(
+          `In marker ${marker.name}, the key ${payloadField.key} has an invalid index "${value}" as a unique string, as it's missing from the string table.`
+        );
+        continue;
       }
+      value = stringTable.getString(value);
+    }
 
-      if (value !== '' && testFun(value, payloadField.key)) {
-        return true;
-      }
+    if (value !== '' && testFun(value, payloadField.key)) {
+      return true;
     }
   }
 

src/profile-logic/process-profile.js

@@ -73,7 +73,6 @@ import type {
   GeckoThread,
   GeckoMetaMarkerSchema,
   GeckoStaticFieldSchemaData,
-  GeckoDynamicFieldSchemaData,
   GeckoMarkers,
   GeckoMarkerStruct,
   GeckoMarkerTuple,
@@ -94,6 +93,7 @@ import type {
   PhaseTimes,
   ExternalMarkersData,
   MarkerSchema,
+  MarkerSchemaField,
   ProfileMeta,
   PageList,
   ThreadIndex,
@@ -1460,11 +1460,12 @@ function _convertGeckoMarkerSchema(
     isStackBased,
   } = markerSchema;
 
-  const fields: GeckoDynamicFieldSchemaData[] = [];
+  const fields: MarkerSchemaField[] = [];
   const staticFields: GeckoStaticFieldSchemaData[] = [];
   for (const f of data) {
     if (f.value === undefined) {
-      fields.push(f);
+      const { key, label, format, hidden } = f;
+      fields.push({ key, label, format, hidden });
     } else if (f.key === undefined) {
       // extra check to placate Flow
       staticFields.push(f);

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

@@ -2594,6 +2594,15 @@ const _upgraders = {
     }
     profile.shared = { stringArray };
   },
+  [57]: (profile) => {
+    // The "searchable" property for fields in the marker schema was removed again.
+    // Now all marker fields are searchable.
+    for (const schema of profile.meta.markerSchema) {
+      for (const field of schema.fields) {
+        delete field.searchable;
+      }
+    }
+  },
   // If you add a new upgrader here, please document the change in
   // `docs-developer/CHANGELOG-formats.md`.
 };

src/test/components/TrackCustomMarker.test.js

@@ -60,8 +60,8 @@ function setup() {
     name: 'Marker',
     display: ['marker-chart', 'marker-table', 'timeline-memory'],
     fields: [
-      { key: 'first', label: 'first', format: 'integer', searchable: true },
-      { key: 'second', label: 'second', format: 'integer', searchable: true },
+      { key: 'first', label: 'first', format: 'integer' },
+      { key: 'second', label: 'second', format: 'integer' },
     ],
     graphs: [
       // multiple lines are supported

src/test/components/__snapshots__/MenuButtons.test.js.snap

@@ -1,4 +1,4 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
 
 exports[`app/MenuButtons <MetaInfoPanel> deleting a profile clicking on the button shows the confirmation 1`] = `
 <div
@@ -2211,7 +2211,7 @@ exports[`app/MenuButtons <Publish> matches the snapshot for the menu buttons and
           class="menuButtonsDownloadSize"
         >
           (
-          1.63 kB
+          1.58 kB
           )
         </span>
       </a>
@@ -2329,7 +2329,7 @@ exports[`app/MenuButtons <Publish> matches the snapshot for the opened panel for
           class="menuButtonsDownloadSize"
         >
           (
-          1.61 kB
+          1.56 kB
           )
         </span>
       </a>
@@ -2442,7 +2442,7 @@ exports[`app/MenuButtons <Publish> matches the snapshot for the opened panel for
           class="menuButtonsDownloadSize"
         >
           (
-          1.63 kB
+          1.58 kB
           )
         </span>
       </a>