Embeds: Add option to hide the Pivot view from embedded Explore dashb…

…oards (#5996) * Add `hide_pivot` boolean to Explore YAML under an `embeds` key * Consume `hide_pivot` in UI * Review --------- Co-authored-by: Benjamin Egelund-Müller <[email protected]>
rilldata · Oct 29, 2024 · 3b51664 · 3b51664 · github-actions · Oct 29, 2024
1 parent 4ddd8c0
commit 3b51664
Show file tree

Hide file tree

Showing 10 changed files with 662 additions and 623 deletions.
diff --git a/proto/gen/rill/runtime/v1/resources.pb.go b/proto/gen/rill/runtime/v1/resources.pb.go
diff --git a/proto/gen/rill/runtime/v1/resources.pb.validate.go b/proto/gen/rill/runtime/v1/resources.pb.validate.go
diff --git a/proto/gen/rill/runtime/v1/runtime.swagger.yaml b/proto/gen/rill/runtime/v1/runtime.swagger.yaml
@@ -4061,6 +4061,9 @@ definitions:
       defaultPreset:
         $ref: '#/definitions/v1ExplorePreset'
         description: Preset UI state to show by default.
+      embedsHidePivot:
+        type: boolean
+        description: If true, the pivot tab will be hidden when the explore is embedded.
       securityRules:
         type: array
         items:

diff --git a/proto/rill/runtime/v1/resources.proto b/proto/rill/runtime/v1/resources.proto
@@ -348,6 +348,8 @@ message ExploreSpec {
   repeated string time_zones = 10;
   // Preset UI state to show by default.
   ExplorePreset default_preset = 15;
+  // If true, the pivot tab will be hidden when the explore is embedded.
+  bool embeds_hide_pivot = 16;
   // Security for the explore dashboard.
   // These are not currently parsed from YAML, but will be derived from the parent metrics view.
   repeated SecurityRule security_rules = 12;

diff --git a/runtime/compilers/rillv1/parse_explore.go b/runtime/compilers/rillv1/parse_explore.go
@@ -28,6 +28,9 @@ type ExploreYAML struct {
 		ComparisonMode      string             `yaml:"comparison_mode"`
 		ComparisonDimension string             `yaml:"comparison_dimension"`
 	} `yaml:"defaults"`
+	Embeds struct {
+		HidePivot bool `yaml:"hide_pivot"`
+	} `yaml:"embeds"`
 	Security *SecurityPolicyYAML `yaml:"security"`
 }
 
@@ -254,6 +257,7 @@ func (p *Parser) parseExplore(node *Node) error {
 	r.ExploreSpec.TimeRanges = timeRanges
 	r.ExploreSpec.TimeZones = tmp.TimeZones
 	r.ExploreSpec.DefaultPreset = defaultPreset
+	r.ExploreSpec.EmbedsHidePivot = tmp.Embeds.HidePivot
 	r.ExploreSpec.SecurityRules = rules
 
 	return nil

diff --git a/web-admin/src/features/embeds/ExploreEmbed.svelte b/web-admin/src/features/embeds/ExploreEmbed.svelte
@@ -41,7 +41,7 @@
         <DashboardStateProvider {exploreName}>
           <DashboardURLStateProvider {metricsViewName}>
             <DashboardThemeProvider>
-              <Dashboard {exploreName} {metricsViewName} />
+              <Dashboard {exploreName} {metricsViewName} isEmbedded />
             </DashboardThemeProvider>
           </DashboardURLStateProvider>
         </DashboardStateProvider>

diff --git a/web-common/src/features/dashboards/tab-bar/TabBar.svelte b/web-common/src/features/dashboards/tab-bar/TabBar.svelte
@@ -1,19 +1,18 @@
 <script lang="ts">
   import Chart from "@rilldata/web-common/components/icons/Chart.svelte";
   import Pivot from "@rilldata/web-common/components/icons/Pivot.svelte";
+  import Tag from "@rilldata/web-common/components/tag/Tag.svelte";
   import { getStateManagers } from "@rilldata/web-common/features/dashboards/state-managers/state-managers";
   import { metricsExplorerStore } from "@rilldata/web-common/features/dashboards/stores/dashboard-stores";
-  import Tab from "./Tab.svelte";
-  import Tag from "@rilldata/web-common/components/tag/Tag.svelte";
   import { behaviourEvent } from "@rilldata/web-common/metrics/initMetrics";
   import { BehaviourEventMedium } from "@rilldata/web-common/metrics/service/BehaviourEventTypes";
   import {
     MetricsEventScreenName,
     MetricsEventSpace,
   } from "@rilldata/web-common/metrics/service/MetricsTypes";
-  // import { featureFlags } from "../../feature-flags";
+  import Tab from "./Tab.svelte";
 
-  // const { pivot: pivotAllowed } = featureFlags;
+  export let hidePivot: boolean = false;
 
   const StateManagers = getStateManagers();
 
@@ -24,17 +23,21 @@
     },
   } = StateManagers;
 
-  const tabs = [
+  $: tabs = [
     {
       label: "Explore",
       Icon: Chart,
       beta: false,
     },
-    {
-      label: "Pivot",
-      Icon: Pivot,
-      beta: false,
-    },
+    ...(hidePivot
+      ? []
+      : [
+          {
+            label: "Pivot",
+            Icon: Pivot,
+            beta: false,
+          },
+        ]),
   ];
 
   $: currentTabIndex = $showPivot ? 1 : 0;

diff --git a/web-common/src/features/dashboards/workspace/Dashboard.svelte b/web-common/src/features/dashboards/workspace/Dashboard.svelte
@@ -19,6 +19,7 @@
 
   export let exploreName: string;
   export let metricsViewName: string;
+  export let isEmbedded: boolean = false;
 
   const { cloudDataViewer, readOnly } = featureFlags;
 
@@ -43,6 +44,8 @@
   $: explore = useExploreValidSpec($runtime.instanceId, exploreName);
   $: mockUserHasNoAccess =
     $selectedMockUserStore && $explore.error?.response?.status === 404;
+
+  $: hidePivot = isEmbedded && $explore.data?.explore?.embedsHidePivot;
 </script>
 
 <article
@@ -61,7 +64,7 @@
         <section class="flex relative justify-between gap-x-4 py-4 pb-6 px-4">
           <Filters />
           <div class="absolute bottom-0 flex flex-col right-0">
-            <TabBar />
+            <TabBar {hidePivot} />
           </div>
         </section>
       {/key}

diff --git a/web-common/src/proto/gen/rill/runtime/v1/resources_pb.ts b/web-common/src/proto/gen/rill/runtime/v1/resources_pb.ts
@@ -2137,6 +2137,13 @@ export class ExploreSpec extends Message<ExploreSpec> {
    */
   defaultPreset?: ExplorePreset;
 
+  /**
+   * If true, the pivot tab will be hidden when the explore is embedded.
+   *
+   * @generated from field: bool embeds_hide_pivot = 16;
+   */
+  embedsHidePivot = false;
+
   /**
    * Security for the explore dashboard.
    * These are not currently parsed from YAML, but will be derived from the parent metrics view.
@@ -2164,6 +2171,7 @@ export class ExploreSpec extends Message<ExploreSpec> {
     { no: 9, name: "time_ranges", kind: "message", T: ExploreTimeRange, repeated: true },
     { no: 10, name: "time_zones", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true },
     { no: 15, name: "default_preset", kind: "message", T: ExplorePreset },
+    { no: 16, name: "embeds_hide_pivot", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
     { no: 12, name: "security_rules", kind: "message", T: SecurityRule, repeated: true },
   ]);
 

diff --git a/web-common/src/runtime-client/gen/index.schemas.ts b/web-common/src/runtime-client/gen/index.schemas.ts
@@ -1870,6 +1870,8 @@ If the list is empty, a default list should be shown.
 The values should be valid IANA location identifiers. */
   timeZones?: string[];
   defaultPreset?: V1ExplorePreset;
+  /** If true, the pivot tab will be hidden when the explore is embedded. */
+  embedsHidePivot?: boolean;
   /** Security for the explore dashboard.
 These are not currently parsed from YAML, but will be derived from the parent metrics view. */
   securityRules?: V1SecurityRule[];