.png%3Falt%3Dmedia%26token%3Db44692e5-25a4-4ca0-b9e0-75a83780c05d)
.png%3Falt%3Dmedia%26token%3Db44692e5-25a4-4ca0-b9e0-75a83780c05d)
Comment on page
Remix quickstart
Once you have a Remix application ready, install Hypertune's JavaScript SDK:
npm
yarn
pnpm
npm install hypertune
yarn add hypertune
pnpm add hypertune
Define the following environment variables in your
.env file:HYPERTUNE_TOKEN=token
HYPERTUNE_OUTPUT_FILE_PATH=generated/generated.ts
Replace
token with your project token which you can find in the Settings tab of your project.Generate a type-safe client to access your flags by running:
npm
yarn
pnpm
npx hypertune
yarn hypertune
pnpm hypertune
Add a new file called
hypertune.ts that creates and exports a hypertune singleton:import { initializeHypertune } from "../generated/generated";
const hypertune = initializeHypertune({}, {
token:
typeof window === "undefined"
? process.env.HYPERTUNE_TOKEN
: (window as any).hypertuneToken,
});
export default hypertune;
Define a
useHypertune hook in a new file called useHypertune.ts:import React, { useEffect, useMemo } from "react";
import hypertune from "./hypertune";
export default function useHypertune() {
// Trigger a re-render when flags are updated.
const [, setCommitHash] = React.useState<string | null>(
hypertune.getCommitHash()
);
useEffect(() => {
hypertune.addUpdateListener(setCommitHash);
return () => {
hypertune.removeUpdateListener(setCommitHash);
};
}, []);
// Return the Hypertune root node initialized with the current user.
return useMemo(
() =>
hypertune.root({
context: {
user: { id: "test_id", name: "Test", email: "[email protected]" },
},
}),
[]
);
}
Set up your root route module in
app/root.tsx:import { json } from "@remix-run/node";
import {
useLoaderData,
Links,
LiveReload,
Meta,
Outlet,
Scripts,
} from "@remix-run/react";
import React from "react";
import hypertune from "../lib/hypertune";
import useHypertune from "../lib/useHypertune";
export async function loader() {
// Ensure the Hypertune SDK is initialized with your latest flag logic.
await hypertune.initFromServerIfNeeded();
// To get your flags on the server in loaders and actions, use the `hypertune`
// singleton directly.
const rootNode = hypertune.root({
context: {
user: { id: "test_id", name: "Test", email: "[email protected]" },
},
});
const exampleFlag = rootNode.exampleFlag().get(/* fallback */ false);
return json({
// Pass your Hypertune token to the browser.
hypertuneToken: process.env.HYPERTUNE_TOKEN,
// Pass the state of the Hypertune SDK to the browser.
hypertuneInitData: hypertune.getInitData(),
exampleFlag,
});
}
export default function App() {
const { hypertuneToken, hypertuneInitData, exampleFlag } =
useLoaderData<typeof loader>();
if (hypertuneInitData) {
// Immediately "bootstrap" the Hypertune SDK in the browser with the state
// of the SDK passed from the server. This lets you use your flags in the
// first app render without any page load delay, UI flicker or layout shift.
// This is optional; if you don't bootstrap the SDK in this way, it will
// initialize as usual in the background and the `useHypertune` hook will
// trigger a re-render when it's done.
hypertune.initFromData(hypertuneInitData);
}
// To get your flags in the browser, use the `useHypertune` hook.
const rootNode = useHypertune();
return (
<html>
<head>
<Meta />
<Links />
{/* Set `window.hypertuneToken` to the token passed from the server.
This is used in `hypertune.ts` for SDK initialization in the browser. */}
<script
dangerouslySetInnerHTML={{
__html: `window.hypertuneToken = ${JSON.stringify(hypertuneToken)}`,
}}
/>
</head>
<body>
<p>Flag passed from server: {String(exampleFlag)}</p>
<p>
Flag accessed in browser:{" "}
{String(rootNode.exampleFlag().get(/* fallback */ false))}
</p>
<Outlet />
<Scripts />
<LiveReload />
</body>
</html>
);
}
If you're using Hypertune in the browser and have a Content Security Policy, add the following URLs to the
connect-src directive: https://edge.prod.hypertune.com https://gcp.fasthorse.workers.devThis allows analytics to be sent back to Hypertune so you can see how often different parts of your flag logic are called, 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.
If you don't "bootstrap" the SDK on the client with the state of the SDK from the server, as shown above, and you try accessing your flag on the first app render, you'll get your hardcoded fallback value if the SDK hasn't had a chance to initialize from Hypertune Edge yet. This can result in a UI flicker or layout shift if the flag value changes when the SDK initializes. To avoid this, you can include a snapshot of your flag logic in the generated client as a build-time fallback.
Add the following environment variable to your
.env file:HYPERTUNE_INCLUDE_FALLBACK=true
Then regenerate the client.
The SDK will now instantly initialize from the snapshot first before fetching the latest flag logic from Hypertune Edge. And it will always successfully initialize, even if Hypertune Edge is unreachable. You can keep the snapshot fresh by setting up a webhook to regenerate the client on every Hypertune commit.
If you don't want to include the snapshot but still want to avoid UI flickers and layout shift, you can explicitly wait for initialization from Hypertune Edge with
await hypertune.initFromServerIfNeeded() or check for initialization from Hypertune Edge with hypertune.hasInitializedFromServer().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.
- 2.Select your Vercel team and project.
- 3.Continue and log into Hypertune.
- 4.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.
- 5.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
Add the environment variables to your
.env file too.Install the Vercel Edge Config package:
npm
yarn
pnpm
npm install @vercel/edge-config
yarn add @vercel/edge-config
pnpm add @vercel/edge-config
Update your
hypertune.ts to create an Edge Config client and pass it along with your Edge Config Item Key when initializing the Hypertune SDK:import { createClient } from "@vercel/edge-config";
import { initializeHypertune } from "../generated/generated";
const hypertune = initializeHypertune({},
{
token:
typeof window === "undefined"
? process.env.HYPERTUNE_TOKEN
: (window as any).hypertuneToken,
vercelEdgeConfigClient:
typeof window === "undefined" && process.env.EDGE_CONFIG
? createClient(process.env.EDGE_CONFIG)
: undefined,
vercelEdgeConfigItemKey:
typeof window === "undefined"
? process.env.EDGE_CONFIG_HYPERTUNE_ITEM_KEY
: undefined,
},
);
export default hypertune;
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.
Last modified 20d ago