Merge pull request #2211 from pyth-network/cprussin/add-test-feed-toggle

feat(insights): add a toggle to include test price components

Author: cprussin

apps/insights/src/components/PriceFeed/price-components-card.tsx

@@ -2,12 +2,13 @@
 
 import { Card } from "@pythnetwork/component-library/Card";
 import { Paginator } from "@pythnetwork/component-library/Paginator";
+import { Switch } from "@pythnetwork/component-library/Switch";
 import {
   type RowConfig,
   type SortDescriptor,
   Table,
 } from "@pythnetwork/component-library/Table";
-import { type ReactNode, Suspense, useMemo } from "react";
+import { type ReactNode, Suspense, useMemo, useState } from "react";
 import { useFilter, useCollator } from "react-aria";
 
 import { useQueryParamFilterPagination } from "../../use-query-param-filter-pagination";
@@ -33,6 +34,7 @@ type PriceComponent = {
   deviationScore: number;
   stalledPenalty: number;
   stalledScore: number;
+  isTest: boolean;
 };
 
 export const PriceComponentsCard = ({
@@ -56,6 +58,16 @@ const ResolvedPriceComponentsCard = ({
 }: Props) => {
   const collator = useCollator();
   const filter = useFilter({ sensitivity: "base", usage: "search" });
+  const [includeTestComponents, setIncludeTestComponents] = useState(false);
+
+  const filteredPriceComponents = useMemo(
+    () =>
+      includeTestComponents
+        ? priceComponents
+        : priceComponents.filter((component) => !component.isTest),
+    [includeTestComponents, priceComponents],
+  );
+
   const {
     search,
     sortDescriptor,
@@ -70,7 +82,7 @@ const ResolvedPriceComponentsCard = ({
     numPages,
     mkPageLink,
   } = useQueryParamFilterPagination(
-    priceComponents,
+    filteredPriceComponents,
     (priceComponent, search) =>
       filter.contains(priceComponent.id, search) ||
       (priceComponent.publisherNameAsString !== undefined &&
@@ -181,6 +193,8 @@ const ResolvedPriceComponentsCard = ({
 
   return (
     <PriceComponentsCardContents
+      includeTestComponents={includeTestComponents}
+      setIncludeTestComponents={setIncludeTestComponents}
       numResults={numResults}
       search={search}
       sortDescriptor={sortDescriptor}
@@ -206,6 +220,8 @@ type PriceComponentsCardProps = Pick<
     | { isLoading: true }
     | {
         isLoading?: false;
+        includeTestComponents: boolean;
+        setIncludeTestComponents: (newValue: boolean) => void;
         numResults: number;
         search: string;
         sortDescriptor: SortDescriptor;
@@ -237,6 +253,18 @@ const PriceComponentsCardContents = ({
   <Card
     className={className}
     title="Price components"
+    toolbar={
+      <Switch
+        {...(props.isLoading
+          ? { isPending: true }
+          : {
+              isSelected: props.includeTestComponents,
+              onChange: props.setIncludeTestComponents,
+            })}
+      >
+        Show test components
+      </Switch>
+    }
     {...(!props.isLoading && {
       footer: (
         <Paginator

apps/insights/src/components/PriceFeed/price-components.tsx

@@ -31,6 +31,7 @@ export const PriceComponents = async ({ children, params }: Props) => {
           id: ranking.publisher,
           publisherNameAsString: lookupPublisher(ranking.publisher)?.name,
           score: ranking.final_score,
+          isTest: ranking.cluster === "pythtest-conformance",
           name: (
             <div className={styles.publisherName}>
               <PublisherTag publisherKey={ranking.publisher} />

apps/insights/src/components/PriceFeed/price-feed-select.module.scss

@@ -86,6 +86,7 @@
           border-color 100ms linear,
           outline-color 100ms linear,
           color 100ms linear;
+        background-color: transparent;
 
         &[data-hovered] {
           border-color: theme.color("forms", "input", "hover", "border");

apps/insights/src/components/PriceFeed/price-feed-select.tsx

@@ -12,11 +12,9 @@ import {
   ListBoxItem,
 } from "@pythnetwork/component-library/unstyled/ListBox";
 import { Popover } from "@pythnetwork/component-library/unstyled/Popover";
+import { SearchField } from "@pythnetwork/component-library/unstyled/SearchField";
 import { Select } from "@pythnetwork/component-library/unstyled/Select";
-import {
-  TextField,
-  Input,
-} from "@pythnetwork/component-library/unstyled/TextField";
+import { Input } from "@pythnetwork/component-library/unstyled/TextField";
 import { type ReactNode, useMemo, useState } from "react";
 import { useCollator, useFilter } from "react-aria";
 
@@ -66,7 +64,7 @@ export const PriceFeedSelect = ({ children, feeds }: Props) => {
       </Button>
       <Popover placement="bottom start" className={styles.popover ?? ""}>
         <Dialog aria-label="Price Feeds" className={styles.dialog ?? ""}>
-          <TextField
+          <SearchField
             value={search}
             onChange={setSearch}
             className={styles.searchField ?? ""}
@@ -78,7 +76,7 @@ export const PriceFeedSelect = ({ children, feeds }: Props) => {
               className={styles.searchInput ?? ""}
               placeholder="Symbol, asset class, or key"
             />
-          </TextField>
+          </SearchField>
           <Virtualizer layout={new ListLayout()}>
             <ListBox
               items={filteredFeeds}

packages/component-library/package.json

@@ -57,6 +57,7 @@
     "postcss-loader": "catalog:",
     "prettier": "catalog:",
     "react": "catalog:",
+    "react-dom": "catalog:",
     "sass": "catalog:",
     "sass-loader": "catalog:",
     "storybook": "catalog:",

packages/component-library/src/Drawer/index.stories.tsx

@@ -26,6 +26,11 @@ const meta = {
         category: "Contents",
       },
     },
+    closeHref: {
+      table: {
+        disable: true,
+      },
+    },
   },
 } satisfies Meta<typeof DrawerComponent>;
 export default meta;

packages/component-library/src/MainNavTabs/index.stories.tsx

@@ -11,6 +11,11 @@ const meta = {
         disable: true,
       },
     },
+    pathname: {
+      table: {
+        disable: true,
+      },
+    },
   },
 } satisfies Meta<typeof MainNavTabsComponent>;
 export default meta;

packages/component-library/src/SearchInput/index.tsx

@@ -5,10 +5,11 @@ import { MagnifyingGlass } from "@phosphor-icons/react/dist/ssr/MagnifyingGlass"
 import { XCircle } from "@phosphor-icons/react/dist/ssr/XCircle";
 import clsx from "clsx";
 import { type CSSProperties, type ComponentProps } from "react";
-import { Input, SearchField } from "react-aria-components";
 
 import styles from "./index.module.scss";
 import { Button } from "../unstyled/Button/index.js";
+import { SearchField } from "../unstyled/SearchField/index.js";
+import { Input } from "../unstyled/TextField/index.js";
 
 export const SIZES = ["xs", "sm", "md", "lg"] as const;
 

packages/component-library/src/Switch/index.module.scss

@@ -0,0 +1,83 @@
+@use "../theme";
+
+.switch {
+  cursor: pointer;
+  line-height: theme.spacing(4);
+
+  .indicator {
+    flex: none;
+    width: theme.spacing(6);
+    height: theme.spacing(4);
+    background: theme.color("border");
+    border-radius: theme.border-radius("2xl");
+    display: inline-flex;
+    align-items: center;
+    padding: 0 theme.spacing(0.5);
+    margin-right: theme.spacing(2);
+    justify-content: flex-start;
+    transition-property: background-color, border-color, outline-color;
+    transition-duration: 100ms;
+    transition-timing-function: linear;
+    border: 1px solid transparent;
+    outline-offset: 0;
+    outline: theme.spacing(1) solid transparent;
+
+    .dot {
+      width: theme.spacing(2.5);
+      height: theme.spacing(2.5);
+      background-color: theme.color("background", "primary");
+      border-radius: theme.border-radius("full");
+      transition: background-color 100ms linear;
+    }
+  }
+
+  .label {
+    @include theme.text("sm", "normal");
+
+    display: inline-block;
+  }
+
+  &[data-hovered] {
+    .indicator {
+      background-color: theme.color("forms", "input", "hover", "border");
+    }
+  }
+
+  &[data-selected] {
+    .indicator {
+      justify-content: flex-end;
+      background-color: theme.color(
+        "button",
+        "primary",
+        "background",
+        "normal"
+      );
+    }
+  }
+
+  &[data-disabled],
+  &[data-pending] {
+    .indicator {
+      background-color: theme.color("button", "disabled", "background");
+
+      .dot {
+        background-color: theme.color("button", "disabled", "foreground");
+      }
+    }
+  }
+
+  &[data-disabled] {
+    cursor: not-allowed;
+  }
+
+  &[data-pending] {
+    cursor: wait;
+  }
+
+  &[data-focus-visible] {
+    .indicator {
+      border-color: theme.color("focus");
+      outline-color: theme.color("focus-dim");
+    }
+  }
+}

packages/component-library/src/Switch/index.stories.tsx

@@ -0,0 +1,41 @@
+import type { Meta, StoryObj } from "@storybook/react";
+
+import { Switch as SwitchComponent } from "./index.js";
+
+const meta = {
+  component: SwitchComponent,
+  argTypes: {
+    isDisabled: {
+      control: "boolean",
+      table: {
+        category: "State",
+      },
+    },
+    isPending: {
+      control: "boolean",
+      table: {
+        category: "State",
+      },
+    },
+    onChange: {
+      table: {
+        category: "Behavior",
+      },
+    },
+    children: {
+      control: "text",
+      table: {
+        category: "Label",
+      },
+    },
+  },
+} satisfies Meta<typeof SwitchComponent>;
+export default meta;
+
+export const Switch = {
+  args: {
+    children: "Click me!",
+    isDisabled: false,
+    isPending: false,
+  },
+} satisfies StoryObj<typeof SwitchComponent>;