Merge pull request #18706 from storybookjs/run-interactions-condition…

…ally Interactions: Run conditionally based on query param
storybookjs · Aug 2, 2022 · 25e1c62 · 25e1c62
1 parent 20db22a
commit 25e1c62
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 3 deletions.
diff --git a/docs/configure/features-and-behavior.md b/docs/configure/features-and-behavior.md
@@ -55,4 +55,5 @@ You can use URL parameters to configure some of the available features:
 | **showNav**         |    `nav`     |          `false`           |
 | **showPanel**       |   `panel`    | `false`, `right`, `bottom` |
 | **selectedPanel**   | `addonPanel` |        Any panel ID        |
-| **showTabs**        |    `tabs`    |           `true`           |
+| **showTabs**        |    `tabs`    |           `true`           |
+|       ---           | `instrument` |      `false`, `true`       |
diff --git a/lib/instrumenter/src/instrumenter.ts b/lib/instrumenter/src/instrumenter.ts
@@ -543,8 +543,19 @@ export function instrument<TObj extends Record<string, any>>(
   options: Options = {}
 ): TObj {
   try {
-    // Don't do any instrumentation if not loaded in an iframe.
-    if (global.window.parent === global.window) return obj;
+    let forceInstrument = false;
+    let skipInstrument = false;
+
+    if (global.window.location?.search?.includes('instrument=true')) {
+      forceInstrument = true;
+    } else if (global.window.location?.search?.includes('instrument=false')) {
+      skipInstrument = true;
+    }
+
+    // Don't do any instrumentation if not loaded in an iframe unless it's forced - instrumentation can also be skipped.
+    if ((global.window.parent === global.window && !forceInstrument) || skipInstrument) {
+      return obj;
+    }
 
     // Only create an instance if we don't have one (singleton) yet.
     if (!global.window.__STORYBOOK_ADDON_INTERACTIONS_INSTRUMENTER__) {