Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: improve onboarding flow #8327

Merged
merged 3 commits into from
Oct 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions frontend/src/component/onboarding/dialog/SdkConnected.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,10 @@ export const SdkConnected: FC<ISdkConnectedProps> = ({ sdk }) => {
<Box sx={{ mt: 2 }}>
<SectionHeader>Production settings</SectionHeader>
<Typography variant='body2'>
In order to validate the connection, we changed some
settings that you might want to revert. We recommend the
following default settings.
You have successfully connected your SDK. In the
previous code example, the settings were optimized for
development. We recommend the following setup for
production.
</Typography>
<Markdown components={{ code: CodeRenderer }}>
{productionSnippet}
Expand Down
8 changes: 0 additions & 8 deletions frontend/src/component/onboarding/dialog/snippets/nodejs.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,6 @@ setInterval(() => {
```

---
### Production settings

In order to validate the connection, we changed some settings that you might want to revert. We recommend the following default settings.

```js
const { initialize } = require('unleash-client');

Expand All @@ -35,10 +31,6 @@ const unleash = initialize({
```

---
### Additional resources

Now that we’ve validated the connection, you might want to look into more advanced use cases and examples:

- [SDK repository with documentation](https://github.com/Unleash/unleash-client-node)
- [Node.js SDK example with CodeSandbox](https://github.com/Unleash/unleash-sdk-examples/tree/main/NodeJS)
- [Node.js SDK tutorial](https://dev.to/reeshee/how-to-implement-feature-flags-in-nodejs-using-unleash-3907)
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ test('Project can start onboarding', async () => {
projectId={projectId}
setConnectSdkOpen={() => {}}
setOnboardingFlow={() => {}}
refetchFeatures={() => {}}
/>
}
/>
Expand Down Expand Up @@ -50,6 +51,7 @@ test('Project can connect SDK', async () => {
projectId={projectId}
setConnectSdkOpen={() => {}}
setOnboardingFlow={() => {}}
refetchFeatures={() => {}}
/>
}
/>
Expand Down
15 changes: 12 additions & 3 deletions frontend/src/component/onboarding/flow/ProjectOnboarding.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,12 @@ interface IProjectOnboardingProps {
projectId: string;
setConnectSdkOpen: (open: boolean) => void;
setOnboardingFlow: (status: 'visible' | 'closed') => void;
refetchFeatures: () => void;
}

interface ICreateFlagProps {
projectId: string;
refetchFeatures: () => void;
}

const Container = styled('div')(({ theme }) => ({
Expand Down Expand Up @@ -101,6 +103,7 @@ export const ProjectOnboarding = ({
projectId,
setConnectSdkOpen,
setOnboardingFlow,
refetchFeatures,
}: IProjectOnboardingProps) => {
const { project } = useProjectOverview(projectId);
const isFirstFlagCreated =
Expand Down Expand Up @@ -133,7 +136,10 @@ export const ProjectOnboarding = ({
'first-flag-created' ? (
<ExistingFlag />
) : (
<CreateFlag projectId={projectId} />
<CreateFlag
projectId={projectId}
refetchFeatures={refetchFeatures}
/>
)}
</ActionBox>
<ActionBox>
Expand Down Expand Up @@ -166,7 +172,7 @@ export const ProjectOnboarding = ({
);
};

const CreateFlag = ({ projectId }: ICreateFlagProps) => {
const CreateFlag = ({ projectId, refetchFeatures }: ICreateFlagProps) => {
const { refetch } = useProjectOverview(projectId);
return (
<>
Expand All @@ -181,7 +187,10 @@ const CreateFlag = ({ projectId }: ICreateFlagProps) => {
<FlagCreationButton
text='Create flag'
skipNavigationOnComplete={true}
onSuccess={refetch}
onSuccess={() => {
refetch();
refetchFeatures();
}}
/>
</>
);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -426,6 +426,7 @@ export const ProjectFeatureToggles = ({
projectId={projectId}
setConnectSdkOpen={setConnectSdkOpen}
setOnboardingFlow={setOnboardingFlow}
refetchFeatures={refetch}
/>
}
/>
Expand Down
Loading