Remix quickstart

1. Install `hypertune`

Once you have a Remix application ready, install Hypertune's JavaScript SDK:

npm install hypertune

yarn add hypertune

pnpm add hypertune

2. Set environment variables

Define the following environment variables in your .env file:

HYPERTUNE_TOKEN=token
HYPERTUNE_FRAMEWORK=remix
HYPERTUNE_OUTPUT_DIRECTORY_PATH=app/generated

Replace token with your main project token which you can find in the Settings tab of your project.

3. Generate the client

Generate a type-safe client to access your flags by running:

npx hypertune

yarn hypertune

pnpm hypertune

4. Use the client

Add a new file called getHypertune.server.ts that exports a getHypertune function:

import { createSource } from "~/generated/hypertune";

const hypertuneSource = createSource({
  token: process.env.HYPERTUNE_TOKEN!,
});

export default async function getHypertune() {
  await hypertuneSource.initIfNeeded(); // Check for flag updates

  return hypertuneSource.root({
    args: {
      context: {
        environment: process.env.NODE_ENV,
        user: { id: "1", name: "Test", email: "hi@test.com" },
      },
    },
  });
}

To access flags in loader during server-side rendering, use the getHypertune function:

import { json } from "@remix-run/node";
import { useLoaderData } from "@remix-run/react";
import getHypertune from "~/lib/getHypertune.server";

export async function loader() {
  const hypertune = await getHypertune();

  const exampleFlag = hypertune.exampleFlag({ fallback: false });

  return json({ exampleFlag });
}

export default function Page() {
  const { exampleFlag } = useLoaderData<typeof loader>();

  return <div>Example Flag: {exampleFlag}</div>;
}

To access flags in the browser during client-side rendering, first wrap your root layout with the generated <HypertuneProvider> component in app/root.tsx:

import { json } from "@remix-run/node";
import {
  useLoaderData,
  Links,
  Meta,
  Outlet,
  Scripts,
  ScrollRestoration,
} from "@remix-run/react";
import { DehydratedState } from "./generated/hypertune";
import { HypertuneProvider } from "~/generated/hypertune.react";
import getHypertune from "~/lib/getHypertune.server";

export async function loader() {
  const hypertune = await getHypertune();

  const token = process.env.HYPERTUNE_TOKEN!;
  const serverDehydratedState = hypertune.dehydrate();
  const serverRootArgs = hypertune.getRootArgs();

  return json({ token, serverDehydratedState, serverRootArgs });
}

export default function App() {
  const { token, serverDehydratedState, serverRootArgs } =
    useLoaderData<typeof loader>();

  return (
    <HypertuneProvider
      createSourceOptions={{ token }}
      dehydratedState={serverDehydratedState as DehydratedState}
      rootArgs={serverRootArgs}
    >
      <html lang="en">
        <head>
          <Meta />
          <Links />
        </head>
        <body>
          <Outlet />
          <ScrollRestoration />
          <Scripts />
        </body>
      </html>
    </HypertuneProvider>
  );
}

Then use the generated useHypertune hook:

import { useHypertune } from "~/generated/hypertune.react";

export default function ClientComponent() {
  const hypertune = useHypertune();

  const exampleFlag = hypertune.exampleFlag({ fallback: false });

  return <div>Example Flag: {String(exampleFlag)}</div>;
}

Note how we pass serverDehydratedState to <HypertuneProvider>. This instantly hydrates or "bootstraps" the SDK in the browser with the state of the SDK on the server so you can use your flags in the first app render with no layout shift, UI flickers or page load delay. This is optional — if you don't pass this prop, the SDK will initialize as usual in the background and <HypertuneProvider> will trigger a re-render when it's done.

Also note how we pass serverRootArgs to <HypertuneProvider>. This lets you reuse the root args that you used in getHypertune on the server. This is optional — you can also manually create root args for <HypertuneProvider>.

If you have a Content Security Policy, add the following URLs to the connect-src directive: https://edge.hypertune.com https://gcp.fasthorse.workers.dev

This lets the browser send analytics back to Hypertune so you can see how often different parts of your flag logic are evaluated, e.g. to see how many sessions fall into each targeting rule, as well as analytics for your events, A/B tests and machine learning loops.

5. (Optional) Include a build-time logic snapshot

To improve reliability, you can include a snapshot of your flag logic in the generated client at build time. The SDK will instantly initialize from the snapshot first before fetching the latest flag logic from Hypertune Edge.

Add the following environment variable to your .env file:

HYPERTUNE_INCLUDE_INIT_DATA=true

Then regenerate the client.

You can keep the snapshot fresh by setting up a webhook to regenerate the client on every Hypertune commit. In this case, you don't need to initialize from Hypertune Edge at all, eliminating network latency and bandwidth, improving both performance and efficiency.

6. (Optional) Use Vercel Edge Config

If your Remix app is deployed on Vercel, you can use Edge Config to initialize the Hypertune SDK on the server with near-zero latency.

1. Install the integration

Go to the Hypertune page in the Vercel Integrations marketplace and click "Add Integration".
Select your Vercel team and project.
Continue and log into Hypertune.
Connect your Hypertune project to a new or existing Edge Config store. Copy the displayed environment variables for later. They contain your Hypertune Token, Edge Config Connection String and Edge Config Item Key.
Go to your Vercel dashboard and select the project you want to use the Hypertune integration with. Go to Settings > Environment Variables and add the following:
1. HYPERTUNE_TOKEN, set to your Hypertune Token
2. EDGE_CONFIG, set to your Edge Config Connection String
3. EDGE_CONFIG_HYPERTUNE_ITEM_KEY, set to your Edge Config Item Key

2. Use the integration

Add the environment variables to your .env file too.

Install the @vercel/edge-config package:

npm install @vercel/edge-config

yarn add @vercel/edge-config

pnpm add @vercel/edge-config

Finally, update your getHypertune function to create an Edge Config client and pass it along with your Edge Config Item Key when creating the Hypertune source:

import { VercelEdgeConfigInitDataProvider } from "hypertune";
import { createClient } from "@vercel/edge-config";
import { createSource } from "~/generated/hypertune";

const hypertuneSource = createSource({
  token: process.env.HYPERTUNE_TOKEN!,
  initDataProvider:
    process.env.EDGE_CONFIG &&
    process.env.EDGE_CONFIG_HYPERTUNE_ITEM_KEY
      ? new VercelEdgeConfigInitDataProvider({
          edgeConfigClient: createClient(
            process.env.EDGE_CONFIG,
          ),
          itemKey: process.env.EDGE_CONFIG_HYPERTUNE_ITEM_KEY,
        })
      : undefined,
});

export default async function getHypertune() {
  await hypertuneSource.initIfNeeded(); // Check for flag updates

  return hypertuneSource.root({
    args: {
      context: {
        environment: process.env.NODE_ENV,
        user: { id: "1", name: "Test", email: "hi@test.com" },
      },
    },
  });
}

That's it

Now you can update the logic for exampleFlag from the Hypertune UI without updating your code or waiting for a new build, deployment or app release.

To add a new flag, create it in the Hypertune UI then regenerate the client.

PreviousReact quickstart NextGatsby quickstart

Last updated 28 days ago

1. Install hypertune