From 7336344bb87b56edb942e7edb36adc8c9e6102e7 Mon Sep 17 00:00:00 2001 From: Steven Zhang Date: Wed, 1 Apr 2026 14:42:41 -0500 Subject: [PATCH] refactor(react-sdk): renamed example `server-only` `react-server-example` --- .github/workflows/react.yml | 6 +++--- package.json | 2 +- packages/sdk/react/.eslintrc.cjs | 2 +- packages/sdk/react/examples/README.md | 2 +- .../{server-only => react-server-example}/.gitignore | 0 .../{server-only => react-server-example}/README.md | 0 .../{server-only => react-server-example}/app/App.tsx | 0 .../app/BootstrappedClient.tsx | 0 .../{server-only => react-server-example}/app/layout.tsx | 0 .../{server-only => react-server-example}/app/page.tsx | 0 .../{server-only => react-server-example}/app/styles.css | 0 .../e2e/verify.spec.ts | 0 .../{server-only => react-server-example}/next.config.ts | 0 .../{server-only => react-server-example}/package.json | 2 +- .../playwright.config.ts | 0 .../{server-only => react-server-example}/tsconfig.json | 0 packages/sdk/react/src/server/LDIsomorphicProvider.tsx | 2 ++ release-please-config.json | 4 ++-- 18 files changed, 11 insertions(+), 9 deletions(-) rename packages/sdk/react/examples/{server-only => react-server-example}/.gitignore (100%) rename packages/sdk/react/examples/{server-only => react-server-example}/README.md (100%) rename packages/sdk/react/examples/{server-only => react-server-example}/app/App.tsx (100%) rename packages/sdk/react/examples/{server-only => react-server-example}/app/BootstrappedClient.tsx (100%) rename packages/sdk/react/examples/{server-only => react-server-example}/app/layout.tsx (100%) rename packages/sdk/react/examples/{server-only => react-server-example}/app/page.tsx (100%) rename packages/sdk/react/examples/{server-only => react-server-example}/app/styles.css (100%) rename packages/sdk/react/examples/{server-only => react-server-example}/e2e/verify.spec.ts (100%) rename packages/sdk/react/examples/{server-only => react-server-example}/next.config.ts (100%) rename packages/sdk/react/examples/{server-only => react-server-example}/package.json (89%) rename packages/sdk/react/examples/{server-only => react-server-example}/playwright.config.ts (100%) rename packages/sdk/react/examples/{server-only => react-server-example}/tsconfig.json (100%) diff --git a/.github/workflows/react.yml b/.github/workflows/react.yml index bd1c400877..aa2fa43583 100644 --- a/.github/workflows/react.yml +++ b/.github/workflows/react.yml @@ -98,7 +98,7 @@ jobs: aws_assume_role: ${{ vars.AWS_ROLE_ARN }} before_test: 'yarn workspace @launchdarkly/react-sdk-example-hello-react playwright install --with-deps chromium' - run-server-only-example: + run-react-server-example: runs-on: ubuntu-latest permissions: id-token: write @@ -109,6 +109,6 @@ jobs: node-version: 24 - uses: ./actions/run-example with: - workspace_name: '@launchdarkly/react-sdk-example-server-only' + workspace_name: '@launchdarkly/react-sdk-example-react-server' aws_assume_role: ${{ vars.AWS_ROLE_ARN }} - before_test: 'yarn workspace @launchdarkly/react-sdk-example-server-only playwright install --with-deps chromium' + before_test: 'yarn workspace @launchdarkly/react-sdk-example-react-server playwright install --with-deps chromium' diff --git a/package.json b/package.json index aaedd7dfcc..bd7398fd5e 100644 --- a/package.json +++ b/package.json @@ -21,7 +21,7 @@ "packages/sdk/react", "packages/sdk/react/contract-tests", "packages/sdk/react/examples/hello-react", - "packages/sdk/react/examples/server-only", + "packages/sdk/react/examples/react-server-example", "packages/sdk/react-native", "packages/sdk/react-native/example", "packages/sdk/react-native/contract-tests/entity", diff --git a/packages/sdk/react/.eslintrc.cjs b/packages/sdk/react/.eslintrc.cjs index 4f7f447669..2351fdec34 100644 --- a/packages/sdk/react/.eslintrc.cjs +++ b/packages/sdk/react/.eslintrc.cjs @@ -1,5 +1,5 @@ module.exports = { - ignorePatterns: ['contract-tests/next-env.d.ts', 'examples/server-only/next-env.d.ts'], + ignorePatterns: ['contract-tests/next-env.d.ts', 'examples/react-server-example/next-env.d.ts'], overrides: [ { files: ['contract-tests/**/*.ts', 'contract-tests/**/*.tsx'], diff --git a/packages/sdk/react/examples/README.md b/packages/sdk/react/examples/README.md index 0d75b91da0..a407ee82a9 100644 --- a/packages/sdk/react/examples/README.md +++ b/packages/sdk/react/examples/README.md @@ -5,4 +5,4 @@ This directory contains example applications demonstrating the LaunchDarkly Reac | Example | Description | |---------|-------------| | [hello-react](./hello-react/) | Minimal Vite + React app that evaluates a boolean feature flag and displays the result with real-time updates. This is the recommended starting point. | -| [server-only](./server-only/) | Next.js App Router example demonstrating server-side flag evaluation with React Server Components. | +| [react-server-example](./react-server-example/) | Next.js App Router example demonstrating server-side flag evaluation with React Server Components. | diff --git a/packages/sdk/react/examples/server-only/.gitignore b/packages/sdk/react/examples/react-server-example/.gitignore similarity index 100% rename from packages/sdk/react/examples/server-only/.gitignore rename to packages/sdk/react/examples/react-server-example/.gitignore diff --git a/packages/sdk/react/examples/server-only/README.md b/packages/sdk/react/examples/react-server-example/README.md similarity index 100% rename from packages/sdk/react/examples/server-only/README.md rename to packages/sdk/react/examples/react-server-example/README.md diff --git a/packages/sdk/react/examples/server-only/app/App.tsx b/packages/sdk/react/examples/react-server-example/app/App.tsx similarity index 100% rename from packages/sdk/react/examples/server-only/app/App.tsx rename to packages/sdk/react/examples/react-server-example/app/App.tsx diff --git a/packages/sdk/react/examples/server-only/app/BootstrappedClient.tsx b/packages/sdk/react/examples/react-server-example/app/BootstrappedClient.tsx similarity index 100% rename from packages/sdk/react/examples/server-only/app/BootstrappedClient.tsx rename to packages/sdk/react/examples/react-server-example/app/BootstrappedClient.tsx diff --git a/packages/sdk/react/examples/server-only/app/layout.tsx b/packages/sdk/react/examples/react-server-example/app/layout.tsx similarity index 100% rename from packages/sdk/react/examples/server-only/app/layout.tsx rename to packages/sdk/react/examples/react-server-example/app/layout.tsx diff --git a/packages/sdk/react/examples/server-only/app/page.tsx b/packages/sdk/react/examples/react-server-example/app/page.tsx similarity index 100% rename from packages/sdk/react/examples/server-only/app/page.tsx rename to packages/sdk/react/examples/react-server-example/app/page.tsx diff --git a/packages/sdk/react/examples/server-only/app/styles.css b/packages/sdk/react/examples/react-server-example/app/styles.css similarity index 100% rename from packages/sdk/react/examples/server-only/app/styles.css rename to packages/sdk/react/examples/react-server-example/app/styles.css diff --git a/packages/sdk/react/examples/server-only/e2e/verify.spec.ts b/packages/sdk/react/examples/react-server-example/e2e/verify.spec.ts similarity index 100% rename from packages/sdk/react/examples/server-only/e2e/verify.spec.ts rename to packages/sdk/react/examples/react-server-example/e2e/verify.spec.ts diff --git a/packages/sdk/react/examples/server-only/next.config.ts b/packages/sdk/react/examples/react-server-example/next.config.ts similarity index 100% rename from packages/sdk/react/examples/server-only/next.config.ts rename to packages/sdk/react/examples/react-server-example/next.config.ts diff --git a/packages/sdk/react/examples/server-only/package.json b/packages/sdk/react/examples/react-server-example/package.json similarity index 89% rename from packages/sdk/react/examples/server-only/package.json rename to packages/sdk/react/examples/react-server-example/package.json index 54db21b170..7809abc412 100644 --- a/packages/sdk/react/examples/server-only/package.json +++ b/packages/sdk/react/examples/react-server-example/package.json @@ -1,5 +1,5 @@ { - "name": "@launchdarkly/react-sdk-example-server-only", + "name": "@launchdarkly/react-sdk-example-react-server", "private": true, "scripts": { "dev": "next dev", diff --git a/packages/sdk/react/examples/server-only/playwright.config.ts b/packages/sdk/react/examples/react-server-example/playwright.config.ts similarity index 100% rename from packages/sdk/react/examples/server-only/playwright.config.ts rename to packages/sdk/react/examples/react-server-example/playwright.config.ts diff --git a/packages/sdk/react/examples/server-only/tsconfig.json b/packages/sdk/react/examples/react-server-example/tsconfig.json similarity index 100% rename from packages/sdk/react/examples/server-only/tsconfig.json rename to packages/sdk/react/examples/react-server-example/tsconfig.json diff --git a/packages/sdk/react/src/server/LDIsomorphicProvider.tsx b/packages/sdk/react/src/server/LDIsomorphicProvider.tsx index 161b00a56d..171db1c14a 100644 --- a/packages/sdk/react/src/server/LDIsomorphicProvider.tsx +++ b/packages/sdk/react/src/server/LDIsomorphicProvider.tsx @@ -40,6 +40,8 @@ export interface LDIsomorphicProviderProps { * @remarks * **NOTE:** This component is designed to be used in conjunction with {@link LDIsomorphicClientProvider} * in a server component to compute the bootstrap data and render this provider automatically. + * + * See the `react-server-example` example for how to use this component. */ export async function LDIsomorphicProvider({ session, diff --git a/release-please-config.json b/release-please-config.json index 594a958368..cea480fd43 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -59,7 +59,7 @@ "src/platform/NodeInfo.ts", { "type": "json", - "path": "/packages/sdk/react/examples/server-only/package.json", + "path": "/packages/sdk/react/examples/react-server-example/package.json", "jsonpath": "$.dependencies['@launchdarkly/node-server-sdk']" } ] @@ -119,7 +119,7 @@ }, { "type": "json", - "path": "examples/server-only/package.json", + "path": "examples/react-server-example/package.json", "jsonpath": "$.dependencies['@launchdarkly/react-sdk']" } ]