mirror of
https://github.com/hanzoai/insights.git
synced 2026-10-30 16:15:31 +00:00
zeekay
1b367e2b62
The tree was a debranded snapshot of upstream taken around 2026-02-20, and upstream has moved about five months since. This replaces it with upstream master, mechanically re-derived: bin/debrand does the rename, and the pipeline and squashed migrations are restored from the shipped tree. Not a merge. The previous import replaced the tree wholesale in a single commit, so there is no shared content history to merge against. Reproducing the rename on the new tree is what actually converges. What survives: .hanzo/workflows, the Dockerfiles and bin/docker* entrypoints, compose files, LLM.md, and insights/migrations. The squashed initial migration is load-bearing — the live database records it by name, so upstream's ~918 individual migrations cannot come back. Nine products are dropped as unreferenced. Twenty-one more that we do not run are kept anyway because the core app still imports them; unpicking those is a refactor and does not belong in a rebase. This base does not build yet, and the reasons are not in the rename: upstream now wants Python 3.13.13 against our 3.12.12 and Django 5.2 against our 4.2, and the dependency manifests still name upstream packages that we republish under our own names. Those are decisions, not renames.
279 lines
13 KiB
TypeScript
279 lines
13 KiB
TypeScript
import { OnboardingComponentsContext, createInstallation } from 'scenes/onboarding/shared/OnboardingDocsContentWrapper'
|
|
|
|
import { StepDefinition } from '../steps'
|
|
|
|
export const getFlutterSteps = (ctx: OnboardingComponentsContext): StepDefinition[] => {
|
|
const { CodeBlock, Markdown, CalloutBox, Tab, dedent, snippets } = ctx
|
|
const SessionReplayFinalSteps = snippets?.SessionReplayFinalSteps
|
|
|
|
return [
|
|
{
|
|
title: 'Install the package',
|
|
badge: 'required',
|
|
content: (
|
|
<>
|
|
<Markdown>Add the Insights Flutter SDK to your `pubspec.yaml`:</Markdown>
|
|
<CodeBlock
|
|
blocks={[
|
|
{
|
|
language: 'yaml',
|
|
file: 'pubspec.yaml',
|
|
code: dedent`
|
|
insights_flutter: ^5.24.0
|
|
`,
|
|
},
|
|
]}
|
|
/>
|
|
<CalloutBox type="fyi" title="SDK version">
|
|
<Markdown>
|
|
Session replay requires Insights Flutter SDK version 4.7.0 or higher. We recommend always
|
|
using the latest version.
|
|
</Markdown>
|
|
</CalloutBox>
|
|
</>
|
|
),
|
|
},
|
|
{
|
|
title: 'Disable auto-init for Android',
|
|
badge: 'required',
|
|
content: (
|
|
<>
|
|
<Markdown>
|
|
For session replay, you need to use manual initialization. Add this to your
|
|
`AndroidManifest.xml` to disable auto-init:
|
|
</Markdown>
|
|
<CodeBlock
|
|
blocks={[
|
|
{
|
|
language: 'xml',
|
|
file: 'android/app/src/main/AndroidManifest.xml',
|
|
code: dedent`
|
|
<application>
|
|
<activity>
|
|
[...]
|
|
</activity>
|
|
<meta-data android:name="com.insights.insights.AUTO_INIT" android:value="false" />
|
|
</application>
|
|
`,
|
|
},
|
|
]}
|
|
/>
|
|
<Markdown>Update the minimum Android SDK version to **21** in `android/app/build.gradle`:</Markdown>
|
|
<CodeBlock
|
|
blocks={[
|
|
{
|
|
language: 'groovy',
|
|
file: 'android/app/build.gradle',
|
|
code: dedent`
|
|
defaultConfig {
|
|
minSdkVersion 23
|
|
// rest of your config
|
|
}
|
|
`,
|
|
},
|
|
]}
|
|
/>
|
|
</>
|
|
),
|
|
},
|
|
{
|
|
title: 'Disable auto-init for iOS',
|
|
badge: 'required',
|
|
content: (
|
|
<>
|
|
<Markdown>Add this to your `Info.plist` to disable auto-init:</Markdown>
|
|
<CodeBlock
|
|
blocks={[
|
|
{
|
|
language: 'xml',
|
|
file: 'ios/Runner/Info.plist',
|
|
code: dedent`
|
|
<dict>
|
|
[...]
|
|
<key>com.insights.insights.AUTO_INIT</key>
|
|
<false/>
|
|
[...]
|
|
</dict>
|
|
`,
|
|
},
|
|
]}
|
|
/>
|
|
<Markdown>Update the minimum platform version to iOS 13.0 in your `Podfile`:</Markdown>
|
|
<CodeBlock
|
|
blocks={[
|
|
{
|
|
language: 'ruby',
|
|
file: 'Podfile',
|
|
code: dedent`
|
|
platform :ios, '13.0'
|
|
# rest of your config
|
|
`,
|
|
},
|
|
]}
|
|
/>
|
|
</>
|
|
),
|
|
},
|
|
{
|
|
title: 'Enable session recordings in project settings',
|
|
badge: 'required',
|
|
content: (
|
|
<>
|
|
<Markdown>
|
|
Go to your Insights [Project Settings](https://us.hanzo.ai/settings/project-replay) and enable
|
|
**Record user sessions**. Session recordings will not work without this setting enabled.
|
|
</Markdown>
|
|
<Markdown>
|
|
If you're using Flutter Web, also enable the **Canvas capture** setting. This is required as
|
|
Flutter renders your app using a browser canvas element.
|
|
</Markdown>
|
|
</>
|
|
),
|
|
},
|
|
{
|
|
title: 'Initialize Insights with session replay',
|
|
badge: 'required',
|
|
content: (
|
|
<>
|
|
<Markdown>
|
|
Initialize Insights in your `main.dart` with session replay enabled. Here are all the available
|
|
options:
|
|
</Markdown>
|
|
<CodeBlock
|
|
blocks={[
|
|
{
|
|
language: 'dart',
|
|
file: 'main.dart',
|
|
code: dedent`
|
|
import 'package:flutter/material.dart';
|
|
import 'package:insights_flutter/insights_flutter.dart';
|
|
|
|
Future<void> main() async {
|
|
WidgetsFlutterBinding.ensureInitialized();
|
|
|
|
final config = InsightsConfig('<ph_project_token>');
|
|
config.host = '<ph_client_api_host>';
|
|
config.debug = true;
|
|
config.captureApplicationLifecycleEvents = true;
|
|
|
|
// Enable session recording. Requires enabling in your project settings as well.
|
|
// Default is false.
|
|
config.sessionReplay = true;
|
|
|
|
// Enable masking of all text and text input fields. Default is true.
|
|
config.sessionReplayConfig.maskAllTexts = false;
|
|
|
|
// Enable masking of all images. Default is true.
|
|
config.sessionReplayConfig.maskAllImages = false;
|
|
|
|
// Throttling delay used to reduce the number of snapshots captured. Default is 1s.
|
|
config.sessionReplayConfig.throttleDelay = const Duration(milliseconds: 1000);
|
|
|
|
await Insights().setup(config);
|
|
runApp(MyApp());
|
|
}
|
|
`,
|
|
},
|
|
]}
|
|
/>
|
|
<Markdown>
|
|
For more configuration options, see the [Flutter session replay
|
|
docs](https://hanzo.ai/docs/session-replay/installation?tab=Flutter).
|
|
</Markdown>
|
|
</>
|
|
),
|
|
},
|
|
{
|
|
title: 'Wrap your app with InsightsWidget',
|
|
badge: 'required',
|
|
content: (
|
|
<>
|
|
<Markdown>
|
|
For Session Replay to work, wrap your app with `InsightsWidget` and add the `InsightsObserver`:
|
|
</Markdown>
|
|
<Tab.Group tabs={['MaterialApp', 'go_router']}>
|
|
<Tab.List>
|
|
<Tab>MaterialApp</Tab>
|
|
<Tab>go_router</Tab>
|
|
</Tab.List>
|
|
<Tab.Panels>
|
|
<Tab.Panel>
|
|
<CodeBlock
|
|
blocks={[
|
|
{
|
|
language: 'dart',
|
|
file: 'MyApp.dart',
|
|
code: dedent`
|
|
import 'package:flutter/material.dart';
|
|
import 'package:insights_flutter/insights_flutter.dart';
|
|
|
|
class MyApp extends StatelessWidget {
|
|
@override
|
|
Widget build(BuildContext context) {
|
|
return InsightsWidget(
|
|
child: MaterialApp(
|
|
navigatorObservers: [InsightsObserver()],
|
|
title: 'My App',
|
|
home: const HomeScreen(),
|
|
),
|
|
);
|
|
}
|
|
}
|
|
`,
|
|
},
|
|
]}
|
|
/>
|
|
</Tab.Panel>
|
|
<Tab.Panel>
|
|
<CodeBlock
|
|
blocks={[
|
|
{
|
|
language: 'dart',
|
|
file: 'MyApp.dart',
|
|
code: dedent`
|
|
import 'package:flutter/material.dart';
|
|
import 'package:go_router/go_router.dart';
|
|
import 'package:insights_flutter/insights_flutter.dart';
|
|
|
|
final GoRouter _router = GoRouter(
|
|
observers: [InsightsObserver()],
|
|
routes: [
|
|
GoRoute(
|
|
name: 'home', // Name your routes for proper screen tracking
|
|
path: '/',
|
|
builder: (context, state) => const HomeScreen(),
|
|
),
|
|
],
|
|
);
|
|
|
|
class MyApp extends StatelessWidget {
|
|
@override
|
|
Widget build(BuildContext context) {
|
|
return InsightsWidget(
|
|
child: MaterialApp.router(
|
|
routerConfig: _router,
|
|
title: 'My App',
|
|
),
|
|
);
|
|
}
|
|
}
|
|
`,
|
|
},
|
|
]}
|
|
/>
|
|
</Tab.Panel>
|
|
</Tab.Panels>
|
|
</Tab.Group>
|
|
</>
|
|
),
|
|
},
|
|
{
|
|
title: 'Watch session recordings',
|
|
badge: 'recommended',
|
|
content: <>{SessionReplayFinalSteps && <SessionReplayFinalSteps />}</>,
|
|
},
|
|
]
|
|
}
|
|
|
|
export const FlutterInstallation = createInstallation(getFlutterSteps)
|