Next.js (App Router) quickstart

1. Install `hypertune`

Once you have a Next.js application (using the App Router) ready, install the hypertune and server-only packages:

npm install hypertune server-only

2. Set environment variables

Set the following environment variables in your .env file:

.env

NEXT_PUBLIC_HYPERTUNE_TOKEN=token
HYPERTUNE_FRAMEWORK=nextApp
HYPERTUNE_OUTPUT_DIRECTORY_PATH=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

4. Use the client

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

lib/getHypertune.ts

import 'server-only'
import { unstable_noStore as noStore } from 'next/cache'
import { createSource } from '@/generated/hypertune'

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

export default async function getHypertune({
  isRouteHandler = false,
}: {
  isRouteHandler?: boolean
} = {}) {
  noStore()

  await hypertuneSource.initIfNeeded()

  hypertuneSource.setRemoteLoggingMode(
    isRouteHandler ? 'normal' : 'off'
  )

  return hypertuneSource.root({
    args: {
      context: {
        environment: process.env.NODE_ENV,
        user: {
          id: 'e23cc9a8-0287-40aa-8500-6802df91e56a',
          name: 'Example User',
          email: '[email protected]',
        },
      },
    },
  })
}

To use flags in Client Components, first wrap your app with the generated <HypertuneProvider> component in your root layout:

app/layout.tsx

import { HypertuneProvider } from '@/generated/hypertune.react'
import getHypertune from '@/lib/getHypertune'
import './globals.css'

export default async function RootLayout({
  children,
}: Readonly<{
  children: React.ReactNode
}>) {
  const hypertune = await getHypertune()
  
  const dehydratedState = hypertune.dehydrate()
  const rootArgs = hypertune.getRootArgs()

  return (
    <HypertuneProvider
      createSourceOptions={{
        token: process.env.NEXT_PUBLIC_HYPERTUNE_TOKEN!,
      }}
      dehydratedState={dehydratedState}
      rootArgs={rootArgs}
    >
      <html lang="en">
        <body>{children}</body>
      </html>
    </HypertuneProvider>
  )
}

Then use the generated useHypertune hook:

components/ClientComponent.tsx

'use client'

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>
}

Notes

Dynamic rendering: Calling getHypertune in your root layout makes your entire app dynamic. To keep parts of your app static (e.g. marketing pages), see (Static) Client Components.
Hydration: Passing dehydratedState from the server instantly hydrates the SDK in the browser. This ensures you can use flags on the first render with no layout shift, flicker, or delay. If omitted, the SDK will initialize in the background and trigger a re-render once ready.
Root args: Passing rootArgs from the server lets you reuse the root args from getHypertune on the server. This is optional — you can also construct root args on the client.
Content Security Policy: If you use a CSP, add the following to your connect-src directive: https://edge.hypertune.com https://gcp.fasthorse.workers.dev. This enables reporting of flag evaluations, experiment exposures, and analytics events.

To use flags in Client Components while keeping parts of your app static (e.g. marketing pages), first create a new <AppHypertuneProvider> component that wraps the generated <HypertuneProvider> component:

components/AppHypertuneProvider.tsx

'use client'

import { HypertuneProvider } from '@/generated/hypertune.react'

export default function AppHypertuneProvider({
  children,
}: {
  children: React.ReactNode
}) {
  return (
    <HypertuneProvider
      createSourceOptions={{
        token: process.env.NEXT_PUBLIC_HYPERTUNE_TOKEN!,
      }}
      rootArgs={{
        context: {
          environment: process.env.NODE_ENV,
          user: {
            id: 'e23cc9a8-0287-40aa-8500-6802df91e56a',
            name: 'Example User',
            email: '[email protected]',
          },
        },
      }}
    >
      {children}
    </HypertuneProvider>
  )
}

Wrap your app with the <AppHypertuneProvider> component in your root layout:

app/layout.tsx

import AppHypertuneProvider from '@/components/AppHypertuneProvider'
import './globals.css'

export default async function RootLayout({
  children,
}: Readonly<{
  children: React.ReactNode
}>) {
  return (
    <AppHypertuneProvider>
      <html lang="en">
        <body>{children}</body>
      </html>
    </AppHypertuneProvider>
  )
}

Then use the generated useHypertune hook:

components/ClientComponent.tsx

'use client'

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>
}

If you access a flag immediately after your app loads, you'll get your hardcoded fallback value if the SDK hasn't initialized from Hypertune Edge yet. This can result in layout shift or a flicker if the flag value changes when the SDK initializes.

To avoid this, wrap your page with the generated <HypertuneHydrator> and <HypertuneRootProvider> components, passing them dehydratedState and rootArgs from the server:

app/page.tsx

import React from 'react'
import ClientComponent from '@/components/ClientComponent'
import ServerComponent from '@/components/ServerComponent'
import {
  HypertuneHydrator,
  HypertuneRootProvider,
} from '@/generated/hypertune.react'
import getHypertune from '@/lib/getHypertune'

export default async function Home() {
  const hypertune = await getHypertune()

  const dehydratedState = hypertune.dehydrate()
  const rootArgs = hypertune.getRootArgs()

  return (
    <HypertuneHydrator dehydratedState={dehydratedState}>
      <HypertuneRootProvider rootArgs={rootArgs}>
        <ServerComponent />
        <ClientComponent />
      </HypertuneRootProvider>
    </HypertuneHydrator>
  )
}

Notes

Dynamic rendering: Calling getHypertune makes your entire page dynamic. To use flags and run experiments on static pages (e.g. marketing pages), see the guide on using Hypertune on static pages.
Content Security Policy: If you have a CSP, add the following to your connect-src directive: https://edge.hypertune.com https://gcp.fasthorse.workers.dev. This enables reporting of flag evaluations, experiment exposures, and analytics events.

To use flags in Server Components, use the getHypertune function. Include the <HypertuneClientLogger> component in your component tree, passing it the paths of any flags you use via the flagPaths prop. This ensures that flag evaluations and experiment exposures are logged on the client (in the browser):

components/ServerComponent.tsx

import { HypertuneClientLogger } from '@/generated/hypertune.react'
import getHypertune from '@/lib/getHypertune'

export default async function ServerComponent() {
  const hypertune = await getHypertune()

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

  return (
    <div>
      Example Flag: {String(exampleFlag)}
      <HypertuneClientLogger flagPaths={['exampleFlag']} />
    </div>
  )
}

By default, remote logging is disabled on Next.js servers because prefetching and caching of pages and layouts can cause logs for flag evaluations, experiment exposures, and analytics events to differ from actual user behaviour. To ensure accuracy, remote logging is enabled by default on the client (in the browser) only. This is why you need to include the <HypertuneClientLogger> component in your component tree.

To use flags in Route Handlers, use the getHypertune function:

app/api/route.ts

import { waitUntil } from '@vercel/functions'
import { NextResponse } from 'next/server'
import getHypertune from '@/lib/getHypertune'

export const runtime = 'edge'

export async function GET() {
  const hypertune = await getHypertune({ isRouteHandler: true })

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

  waitUntil(hypertune.flushLogs())

  return NextResponse.json({ exampleFlag })
}

Notes

Enable remote logging: By default, remote logging is disabled on Next.js servers because prefetching and caching of pages and layouts can cause logs for flag evaluations, experiment exposures, and analytics events to differ from actual user behaviour. To ensure accuracy, remote logging is enabled by default on the client (in the browser) only. However, since Route Handlers aren't subject to the same prefetching and caching patterns, remote logging is enabled for them by passing { isRouteHandler: true } in the call to getHypertune.
Flush logs: waitUntil(hypertune.flushLogs()) ensures that logs are sent. Without this, logs may still flush in the background, but this isn't guaranteed in serverless environments like Vercel deployments.

To use flags in Middleware, use the getHypertune function:

middleware.ts

import { NextRequest } from 'next/server'
import getHypertune from '@/lib/getHypertune'

export const config = {
  matcher: '/:path*',
}

export async function middleware(request: NextRequest) {
  const hypertune = await getHypertune()

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

  console.log(`Example Flag: ${exampleFlag}`)
}

Include the <HypertuneClientLogger> component in your component tree, passing it the paths of any flags you use via the flagPaths prop. This ensures that flag evaluations and experiment exposures are logged on the client (in the browser):

app/page.tsx

import React from 'react'
import { HypertuneClientLogger } from '@/generated/hypertune.react'

export default async function Home() {
  return (
    <div>
      <h1>Home</h1>
      <HypertuneClientLogger flagPaths={['exampleFlag']} />
    </div>
  )
}

The Hypertune Toolbar lets you view and override feature flags directly in your frontend. Follow the guide to add it to your app.

6. (Optional) Include a build-time 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:

.env

HYPERTUNE_INCLUDE_INIT_DATA=true

Then run npx hypertune to 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.

7. (Optional) Use Vercel Edge Config

If your Next.js 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. NEXT_PUBLIC_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

Pull the environment variables to your .env.development.local file by running:

vercel env pull .env.development.local

Install the @vercel/edge-config package:

npm install @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:

lib/getHypertune.ts

import 'server-only'
import { createClient } from '@vercel/edge-config'
import { VercelEdgeConfigInitDataProvider } from 'hypertune'
import { unstable_noStore as noStore } from 'next/cache'
import { createSource } from '@/generated/hypertune'

const hypertuneSource = createSource({
  token: process.env.NEXT_PUBLIC_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({
  isRouteHandler = false,
}: {
  isRouteHandler?: boolean
} = {}) {
  noStore()

  await hypertuneSource.initIfNeeded()

  hypertuneSource.setRemoteLoggingMode(
    isRouteHandler ? 'normal' : 'off'
  )

  return hypertuneSource.root({
    args: {
      context: {
        environment: process.env.NODE_ENV,
        user: {
          id: 'e23cc9a8-0287-40aa-8500-6802df91e56a',
          name: 'Example User',
          email: '[email protected]',
        },
      },
    },
  })
}

Follow the guide to add the Vercel Toolbar to your local environment.

2. Generate a `FLAGS_SECRET` environment variable

Open the Flags Explorer from the Toolbar and follow the prompts to generate a FLAGS_SECRET environment variable and pull it locally with vercel env pull.

Install the flags package:

npm install flags

Then add a new route handler in app/.well-known/vercel/flags/route.ts to provide flag definitions to the Vercel Toolbar using the generated vercelFlagDefinitions constant:

app/.well-known/vercel/flags/route.ts

import { createFlagsDiscoveryEndpoint } from 'flags/next'
import { vercelFlagDefinitions } from '../../../../generated/hypertune'

export const GET = createFlagsDiscoveryEndpoint(() => {
  return { definitions: vercelFlagDefinitions }
})

4. Generate Vercel integration helpers

Add the following environment variable to your .env file:

.env

HYPERTUNE_PLATFORM=vercel

Then run npx hypertune to regenerate the client.

Update your getHypertune function to respect flag overrides set by the Vercel Toolbar using the generated getVercelOverride function:

lib/getHypertune.ts

import 'server-only'
import { unstable_noStore as noStore } from 'next/cache'
import { createSource } from '@/generated/hypertune'
import { getVercelOverride } from '@/generated/hypertune.vercel'

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

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

  // Respect flag overrides set by the Vercel Toolbar
  hypertuneSource.setOverride(await getVercelOverride())

  return hypertuneSource.root({
    args: {
      context: {
        environment: process.env.NODE_ENV,
        user: {
          id: 'e23cc9a8-0287-40aa-8500-6802df91e56a',
          name: 'Example User',
          email: '[email protected]',
        },
      },
    },
  })
}

Add the generated <VercelFlagValues> component to your app to tell the Vercel Toolbar about your flag values:

components/ServerComponent.tsx

import { HypertuneProvider } from '@/generated/hypertune.react'
import { VercelFlagValues } from '@/generated/hypertune.vercel'
import getHypertune from '@/lib/getHypertune'
import './globals.css'

export default async function RootLayout({
  children,
}: Readonly<{
  children: React.ReactNode
}>) {
  const hypertune = await getHypertune()

  const serverDehydratedState = hypertune.dehydrate()
  const serverRootArgs = hypertune.getRootArgs()

  return (
    <HypertuneProvider
      createSourceOptions={{
        token: process.env.NEXT_PUBLIC_HYPERTUNE_TOKEN!,
      }}
      dehydratedState={serverDehydratedState}
      rootArgs={serverRootArgs}
    >
      <html lang="en">
        <body>
          {children}
          <VercelFlagValues flagValues={hypertune.get()} />
        </body>
      </html>
    </HypertuneProvider>
  )
}

9. (Optional) Integrate with Vercel's Flags SDK

You can integrate Hypertune with Vercel's Flags SDK to use Vercel's Flags pattern on the server, e.g. in Server Components, Route Handlers, or Middleware.

Install the required dependencies:

npm install flags @flags-sdk/hypertune @vercel/edge-config

Create a new file called flags.ts that contains an identify function and a hypertuneAdapter, and defines your flag functions:

flags.ts

import { createHypertuneAdapter } from '@flags-sdk/hypertune'
import { Identify } from 'flags'
import { dedupe, flag } from 'flags/next'
import {
  createSource,
  flagFallbacks,
  vercelFlagDefinitions as flagDefinitions,
  Context,
  RootFlagValues,
} from './generated/hypertune'

const identify: Identify<Context> = dedupe(
  async ({ headers, cookies }) => {
    return {
      environment: process.env.NODE_ENV,
      user: {
        id: 'e23cc9a8-0287-40aa-8500-6802df91e56a',
        name: 'Example User',
        email: '[email protected]',
      },
    }
  }
)

const hypertuneAdapter = createHypertuneAdapter<
  RootFlagValues,
  Context
>({
  createSource,
  flagFallbacks,
  flagDefinitions,
  identify,
})

export const exampleFlagFlag = flag(
  hypertuneAdapter.declarations.exampleFlag
)

export const enableDesignV2Flag = flag(
  hypertuneAdapter.declarations.enableDesignV2
)

To use flags, import and await your flag functions:

components/ServerComponent.tsx

import { exampleFlagFlag } from '@/flags'

export default async function ServerComponent() {
  const exampleFlag = await exampleFlagFlag()

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

To use the Flags Explorer in the Vercel Toolbar, add a new route handler in app/.well-known/vercel/flags/route.ts to provide flag definitions to it using the generated vercelFlagDefinitions constant:

app/.well-known/vercel/flags/route.ts

import { createFlagsDiscoveryEndpoint } from 'flags/next'
import { vercelFlagDefinitions } from '../../../../generated/hypertune'

export const GET = createFlagsDiscoveryEndpoint(() => {
  return { definitions: vercelFlagDefinitions }
})

To use Vercel Edge Config with the Flags SDK, configure it via environment variables:

.env

EXPERIMENTATION_CONFIG="https://edge-config.vercel.com/ecfg_xyz?token=abc"
EXPERIMENTATION_CONFIG_ITEM_KEY="hypertune_99999"

Or via the adapter:

flags.ts

import { createHypertuneAdapter } from '@flags-sdk/hypertune'
import { createClient } from '@vercel/edge-config'
import { Identify } from 'flags'
import { dedupe, flag } from 'flags/next'
import { VercelEdgeConfigInitDataProvider } from 'hypertune'
import {
  createSource,
  flagFallbacks,
  vercelFlagDefinitions as flagDefinitions,
  Context,
  RootFlagValues,
} from './generated/hypertune'

const identify: Identify<Context> = dedupe(
  async ({ headers, cookies }) => {
    return {
      environment: process.env.NODE_ENV,
      user: {
        id: 'e23cc9a8-0287-40aa-8500-6802df91e56a',
        name: 'Example User',
        email: '[email protected]',
      },
    }
  }
)

const hypertuneAdapter = createHypertuneAdapter<
  RootFlagValues,
  Context
>({
  createSource,
  flagFallbacks,
  flagDefinitions,
  identify,
  createSourceOptions: {
    initDataProvider: new VercelEdgeConfigInitDataProvider({
      edgeConfigClient: createClient(
        'https://edge-config.vercel.com/ecfg_xyz?token=abc'
      ),
      itemKey: 'hypertune_99999',
    }),
  },
})

export const exampleFlagFlag = flag(
  hypertuneAdapter.declarations.exampleFlag
)

export const enableDesignV2Flag = flag(
  hypertuneAdapter.declarations.enableDesignV2
)

Next steps

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.

PreviousSet up Hypertune NextNext.js (Pages Router) quickstart

Last updated 2 months ago

1. Install hypertune

2. Set environment variables

3. Generate the client

4. Use the client

5. (Optional) Add the Hypertune Toolbar

6. (Optional) Include a build-time snapshot

7. (Optional) Use Vercel Edge Config

1. Install the integration

2. Use the integration

8. (Optional) Integrate with the Vercel Toolbar and Flags Explorer

1. Set up the Vercel Toolbar

2. Generate a FLAGS_SECRET environment variable

3. Provide flag definitions to the Vercel Toolbar

4. Generate Vercel integration helpers

5. Respect flag overrides set by the Vercel Toolbar

6. Provide flag values to the Vercel Toolbar

9. (Optional) Integrate with Vercel's Flags SDK

Next steps

1. Install `hypertune`

2. Generate a `FLAGS_SECRET` environment variable