refactor: clean up Outlit SDK integration #1374
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -28,6 +28,7 @@ import { setupAutoUpdater } from "./lib/auto-updater"; | |||||||||||||||
| import { setWorkspaceDockIcon } from "./lib/dock-icon"; | ||||||||||||||||
| import { loadWebviewBrowserExtension } from "./lib/extensions"; | ||||||||||||||||
| import { localDb } from "./lib/local-db"; | ||||||||||||||||
| import { outlit } from "./lib/outlit"; | ||||||||||||||||
| import { ensureProjectIconsDir, getProjectIconPath } from "./lib/project-icons"; | ||||||||||||||||
| import { initSentry } from "./lib/sentry"; | ||||||||||||||||
| import { | ||||||||||||||||
|
|
@@ -187,7 +188,10 @@ app.on("before-quit", async (event) => { | |||||||||||||||
| } | ||||||||||||||||
| } | ||||||||||||||||
|
|
||||||||||||||||
| // Quit confirmed or no confirmation needed - exit immediately | ||||||||||||||||
| // Let OS clean up child processes, tray, etc. | ||||||||||||||||
| isQuitting = true; | ||||||||||||||||
| await outlit.shutdown(); | ||||||||||||||||
|
Contributor
There was a problem hiding this comment.
If the SDK call throws or never resolves, 🛡️ Proposed fix- await outlit.shutdown();
+ await Promise.race([
+ outlit.shutdown().catch((err) =>
+ console.error("[main] Outlit shutdown failed:", err),
+ ),
+ new Promise((resolve) => setTimeout(resolve, 2000)),
+ ]);📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents
Contributor
There was a problem hiding this comment. P1: Unhandled rejection in (Based on your team's feedback about handling async calls with proper await and catch.) Prompt for AI agents
|
||||||||||||||||
| disposeTray(); | ||||||||||||||||
| app.exit(0); | ||||||||||||||||
| }); | ||||||||||||||||
|
|
||||||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,8 @@ | ||
| import { app } from "electron"; | ||
| import { env } from "main/env.main"; | ||
| import { outlit } from "main/lib/outlit"; | ||
| import { PostHog } from "posthog-node"; | ||
| import { toOutlitProperties } from "shared/analytics"; | ||
| import { DEFAULT_TELEMETRY_ENABLED } from "shared/constants"; | ||
|
|
||
| export let posthog: PostHog | null = null; | ||
|
|
@@ -37,16 +39,27 @@ export function track( | |
| if (!isTelemetryEnabled()) return; | ||
|
|
||
| const client = getClient(); | ||
| if (client) { | ||
| client.capture({ | ||
| distinctId: userId, | ||
| event, | ||
| properties: { | ||
| ...properties, | ||
| app_name: "desktop", | ||
| platform: process.platform, | ||
| desktop_version: app.getVersion(), | ||
| }, | ||
| }); | ||
| } | ||
|
|
||
| outlit.track({ | ||
|
Contributor
There was a problem hiding this comment. P2: Outlit tracking is missing the enriched properties ( Prompt for AI agents |
||
| eventName: event, | ||
| userId, | ||
| properties: toOutlitProperties(properties), | ||
| }); | ||
|
|
||
| // Fire user.activate() on project_opened (activation moment) | ||
| if (event === "project_opened") { | ||
| outlit.user.activate({ userId }); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| import { Outlit } from "@outlit/node"; | ||
| import { env } from "main/env.main"; | ||
|
|
||
| export const outlit = new Outlit({ | ||
| publicKey: env.NEXT_PUBLIC_OUTLIT_KEY, | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,7 +2,7 @@ import { Button } from "@superset/ui/button"; | |
| import { Dialog, DialogContent } from "@superset/ui/dialog"; | ||
| import { useNavigate } from "@tanstack/react-router"; | ||
| import { useEffect, useRef, useState } from "react"; | ||
| import { track } from "renderer/lib/analytics"; | ||
| import { FeaturePreview } from "./components/FeaturePreview"; | ||
| import { FeatureSidebar } from "./components/FeatureSidebar"; | ||
| import type { GatedFeature } from "./constants"; | ||
|
|
@@ -51,7 +51,7 @@ export const Paywall = () => { | |
| featuresViewedRef.current = new Set([initialFeatureId]); | ||
|
|
||
| const feature = PRO_FEATURES.find((f) => f.id === initialFeatureId); | ||
| track("paywall_opened", { | ||
| trigger_source: paywallOptions.feature, | ||
| feature_id: initialFeatureId, | ||
| feature_title: feature?.title, | ||
|
|
@@ -72,7 +72,7 @@ export const Paywall = () => { | |
| const handleSelectFeature = (featureId: string) => { | ||
| if (featureId !== selectedFeatureId) { | ||
| const feature = PRO_FEATURES.find((f) => f.id === featureId); | ||
| track("paywall_feature_clicked", { | ||
| trigger_source: triggerSource, | ||
| feature_id: featureId, | ||
| feature_title: feature?.title, | ||
|
|
@@ -88,7 +88,7 @@ export const Paywall = () => { | |
| const timeSpent = openTimeRef.current | ||
| ? Date.now() - openTimeRef.current | ||
| : 0; | ||
| track("paywall_cancelled", { | ||
| trigger_source: triggerSource, | ||
| feature_id: selectedFeatureId, | ||
| features_viewed_count: featuresViewedRef.current.size, | ||
|
|
@@ -109,7 +109,7 @@ export const Paywall = () => { | |
| const timeSpent = openTimeRef.current | ||
| ? Date.now() - openTimeRef.current | ||
| : 0; | ||
| track("paywall_upgrade_clicked", { | ||
| trigger_source: triggerSource, | ||
| feature_id: selectedFeatureId, | ||
| feature_title: selectedFeature.title, | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| import { useEffect } from "react"; | ||
| import { track } from "renderer/lib/analytics"; | ||
| import { authClient } from "renderer/lib/auth-client"; | ||
| import { electronTrpc } from "renderer/lib/electron-trpc"; | ||
| import { posthog } from "../../lib/posthog"; | ||
|
|
||
| const AUTH_COMPLETED_KEY = "superset_auth_completed"; | ||
|
|
@@ -23,7 +23,7 @@ export function PostHogUserIdentifier() { | |
|
|
||
| const trackedUserId = localStorage.getItem(AUTH_COMPLETED_KEY); | ||
| if (trackedUserId !== user.id) { | ||
| track("auth_completed"); | ||
| localStorage.setItem(AUTH_COMPLETED_KEY, user.id); | ||
| } | ||
| } else if (session !== undefined && !user) { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| import { useEffect } from "react"; | ||
| import { electronTrpc } from "renderer/lib/electron-trpc"; | ||
| import { outlit } from "renderer/lib/outlit"; | ||
| import { posthog } from "renderer/lib/posthog"; | ||
|
|
||
| export function TelemetrySync() { | ||
|
|
@@ -9,21 +10,16 @@ export function TelemetrySync() { | |
| useEffect(() => { | ||
| if (telemetryEnabled === undefined) return; | ||
|
|
||
| if (telemetryEnabled) { | ||
|
Contributor
There was a problem hiding this comment. P1: Removing the (Based on your team's feedback about handling async calls with proper await and catch.) Prompt for AI agents |
||
| if (typeof posthog?.opt_in_capturing === "function") { | ||
| posthog.opt_in_capturing(); | ||
| } | ||
| outlit.enableTracking(); | ||
| } else { | ||
| if (typeof posthog?.opt_out_capturing === "function") { | ||
| posthog.opt_out_capturing(); | ||
| } | ||
| outlit.disableTracking(); | ||
| } | ||
| }, [telemetryEnabled]); | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -22,6 +22,7 @@ const envSchema = z.object({ | |
| .default("https://api.superset.sh/api/electric"), | ||
| NEXT_PUBLIC_POSTHOG_KEY: z.string().optional(), | ||
| NEXT_PUBLIC_POSTHOG_HOST: z.string().default("https://us.i.posthog.com"), | ||
| NEXT_PUBLIC_OUTLIT_KEY: z.string(), | ||
| SENTRY_DSN_DESKTOP: z.string().optional(), | ||
| }); | ||
|
|
||
|
|
@@ -43,6 +44,9 @@ const rawEnv = { | |
| NEXT_PUBLIC_POSTHOG_HOST: import.meta.env.NEXT_PUBLIC_POSTHOG_HOST as | ||
| | string | ||
| | undefined, | ||
| NEXT_PUBLIC_OUTLIT_KEY: import.meta.env.NEXT_PUBLIC_OUTLIT_KEY as | ||
| | string | ||
| | undefined, | ||
| SENTRY_DSN_DESKTOP: import.meta.env.SENTRY_DSN_DESKTOP as string | undefined, | ||
| }; | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,6 +12,7 @@ import { | |
| markBootMounted, | ||
| reportBootError, | ||
| } from "./lib/boot-errors"; | ||
| import { outlit } from "./lib/outlit"; | ||
| import { persistentHistory } from "./lib/persistent-hash-history"; | ||
| import { posthog } from "./lib/posthog"; | ||
| import { electronQueryClient } from "./providers/ElectronTRPCProvider"; | ||
|
|
@@ -35,6 +36,9 @@ const unsubscribe = router.subscribe("onResolved", (event) => { | |
| posthog.capture("$pageview", { | ||
| $current_url: event.toLocation.pathname, | ||
| }); | ||
| outlit.track("pageview", { | ||
| url: event.toLocation.pathname, | ||
| }); | ||
| }); | ||
|
|
||
| const handleDeepLink = (path: string) => { | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
P2: Using a repository secret directly for this required env var makes
pull_requestruns from forks unreliable, because fork-triggered workflows do not receive secrets. Add a safe fallback value for CI (or gate secret-dependent steps) so external PR checks remain runnable.Prompt for AI agents