feat: integrate Outlit analytics SDK across all apps#1278
Conversation
📝 WalkthroughWalkthroughAdds Outlit telemetry: environment keys, dependencies, lazy Outlit singletons (main/renderer/marketing), Outlit providers, centralized track() forwarding to PostHog and Outlit, telemetry enable/disable wiring, and a main-process shutdown hook. Changes
Sequence Diagram(s)sequenceDiagram
participant UI as Renderer (UI)
participant Track as track()
participant PostHog as PostHog
participant Outlit as Outlit (getOutlit)
UI->>Track: track("event", props)
Track->>PostHog: posthog.capture("event", props)
Track->>Outlit: getOutlit()?.track("event", props)
sequenceDiagram
participant ElectronMain as Electron Main
participant OutlitMain as Outlit (main)
ElectronMain->>OutlitMain: before-quit -> shutdownOutlit()
OutlitMain-->>ElectronMain: flush/close complete
Estimated code review effort🎯 4 (Complex) | ⏱️ ~50 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
🧪 Generate unit tests (beta)
Tip Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
leo-paz
force-pushed
the
outlit-integration
branch
from
0eed2a2 to
89c6b8d
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
🤖 Fix all issues with AI agents
In `@apps/desktop/src/main/lib/outlit/index.ts`:
- Around line 17-22: shutdownOutlit may throw if outlit.shutdown() fails, which
can block later cleanup (disposeTray and app.exit(0)); wrap the call in a
try-catch inside shutdownOutlit so any thrown error is caught and logged via
your logger (or console.error) and does not rethrow, then ensure outlit is set
to null in a finally block or after catching so subsequent cleanup proceeds;
reference the shutdownOutlit function and the outlit.shutdown() call when making
the change.
In `@apps/desktop/src/renderer/lib/analytics/index.ts`:
- Around line 9-14: The renderer track call (getOutlit()?.track(...)) can throw
but isn't guarded like the main process variant; wrap the call inside a
try-catch in the renderer's track function (the function that invokes
getOutlit()?.track) and handle errors the same way as main process: catch any
thrown error, log it via the renderer logger (or console.error if no logger
exists) with a clear message and swallow the error so it doesn't propagate to UI
callers. Ensure you keep the same typed cast for properties and preserve
optional chaining while only adding the try-catch around the getOutlit()?.track
invocation.
In `@apps/desktop/src/renderer/providers/OutlitProvider/OutlitProvider.tsx`:
- Around line 22-30: The Outlit SDK is currently being sent user.email from
OutlitProvider (user.email in the user object), which may expose PII; change
this so email is only included when a clear config/consent flag is set (e.g.,
allowSendEmailToOutlit or hasAnalyticsConsent) — otherwise send only non-PII
fields like userId and traits.name (matching PostHogUserIdentifier handling), or
anonymize the email before sending; update the OutlitProvider code path that
constructs the user payload to check this flag/consent before including
user.email and add a unit/test to ensure email is omitted when the flag is
false.
In `@apps/marketing/src/lib/outlit/index.ts`:
- Around line 1-19: Add and export a shutdownOutlit() function that mirrors the
desktop pattern: check the module-level outlit variable and if it exists call
its shutdown()/flush() method to send queued events, await the call if it
returns a Promise, and then set outlit = null; ensure the exported function is
named shutdownOutlit and references the same outlit/Outlit symbols used in
getOutlit().
In `@apps/web/src/components/OutlitProvider/OutlitProvider.tsx`:
- Around line 21-29: The current OutlitProvider is sending personally
identifiable info (user.email and traits.name) to Outlit when populating the
user prop; update the implementation to only send email/name when the user has
given consent or when your privacy/data-processing agreements allow it—add a
consent check or feature flag around the user object construction inside
OutlitProvider (the block that references user.email, user.id, and traits.name)
and ensure your privacy policy and DPA with Outlit are in place and referenced
before enabling that branch.
🧹 Nitpick comments (4)
apps/desktop/src/main/lib/analytics/index.ts (1)
53-73: Outlit integration looks solid — error handling is properly in place.Two minor observations:
The
"project_opened"literal on Line 67 could be extracted to a named constant alongside other event names to avoid typo risk across the codebase. As per coding guidelines: "Extract hardcoded magic numbers, strings, and enums to named constants at module top instead of leaving them inline in logic."The type cast on Lines 61-63 will silently drop nested objects or arrays from properties if any callers pass them. The same cast is used in the renderer and marketing apps, so this is consistent — but worth being aware of.
apps/marketing/src/lib/analytics/index.ts (1)
5-16: Wrap Outlit tracking in try/catch to prevent analytics from breaking the app.If
getOutlit()?.track()throws (e.g., network error, SDK bug), it will propagate up to the caller. The desktop main process version (apps/desktop/src/main/lib/analytics/index.ts, lines 55-72) wraps Outlit calls in try/catch withconsole.error, but this and the renderer variant don't. Analytics should be fire-and-forget — a failure here should never interrupt the user flow.🛡️ Proposed fix
export function track( event: string, properties?: Record<string, unknown>, ): void { posthog.capture(event, properties); - getOutlit()?.track( - event, - properties as - | Record<string, string | number | boolean | null> - | undefined, - ); + try { + getOutlit()?.track( + event, + properties as + | Record<string, string | number | boolean | null> + | undefined, + ); + } catch (error) { + console.error("[analytics/outlit] Failed to track:", error); + } }As per coding guidelines: "Never swallow errors silently; at minimum log errors with context before rethrowing or handling them explicitly" and "Use prefixed console logging with consistent context pattern: [domain/operation] message".
apps/web/src/components/OutlitProvider/OutlitProvider.tsx (1)
13-33: Inconsistency with desktop's OutlitProvider pattern.The desktop version uses
getOutlit()to create a singleton client and passes it via theclientprop, with a null guard that skips rendering the provider when the key is missing. This web version uses thepublicKeyprop directly and always renders the provider.This isn't necessarily wrong (different apps, different constraints), but the lack of a null guard here means the provider initializes even when
NEXT_PUBLIC_OUTLIT_KEYis unset — same concern as the marketing provider.apps/marketing/src/app/providers.tsx (1)
14-18: Consider guarding against missingpublicKeyto align with existing patterns.The docs app guards against an empty
publicKeywith an early return, and desktop uses agetOutlit()helper that prevents Outlit initialization when the key is unset. Marketing's ownlib/outlit/index.tsfollows the same defensive pattern—returningnullif the key is missing. However,providers.tsxpasses an empty string directly toOutlitProviderwithout a guard.For consistency with the patterns established across the codebase (docs, desktop, and marketing's own utility), consider guarding:
Proposed guard
export function Providers({ children }: { children: React.ReactNode }) { + const outlitKey = env.NEXT_PUBLIC_OUTLIT_KEY; return ( <PostHogProvider client={posthog}> - <OutlitProvider - publicKey={env.NEXT_PUBLIC_OUTLIT_KEY ?? ""} - trackPageviews - autoTrack={false} - > + {outlitKey ? ( + <OutlitProvider + publicKey={outlitKey} + trackPageviews + autoTrack={false} + > + <ThemeProvider + attribute="class" + defaultTheme="dark" + forcedTheme="dark" + storageKey={THEME_STORAGE_KEY} + disableTransitionOnChange + > + {children} + </ThemeProvider> + </OutlitProvider> + ) : ( <ThemeProvider attribute="class" defaultTheme="dark" forcedTheme="dark" storageKey={THEME_STORAGE_KEY} disableTransitionOnChange > {children} </ThemeProvider> - </OutlitProvider> + )} </PostHogProvider> ); }
| user={ | ||
| user | ||
| ? { | ||
| email: user.email, | ||
| userId: user.id, | ||
| traits: { name: user.name }, | ||
| } | ||
| : null | ||
| } |
There was a problem hiding this comment.
PII sent to third-party analytics — verify this is intended and compliant.
user.email is passed to the Outlit SDK as part of user identity. This is consistent with how PostHog receives it in PostHogUserIdentifier, but worth confirming that sending PII (email) to Outlit is covered by your privacy policy and data processing agreements.
🤖 Prompt for AI Agents
In `@apps/desktop/src/renderer/providers/OutlitProvider/OutlitProvider.tsx` around
lines 22 - 30, The Outlit SDK is currently being sent user.email from
OutlitProvider (user.email in the user object), which may expose PII; change
this so email is only included when a clear config/consent flag is set (e.g.,
allowSendEmailToOutlit or hasAnalyticsConsent) — otherwise send only non-PII
fields like userId and traits.name (matching PostHogUserIdentifier handling), or
anonymize the email before sending; update the OutlitProvider code path that
constructs the user payload to check this flag/consent before including
user.email and add a unit/test to ensure email is omitted when the flag is
false.
| user={ | ||
| user | ||
| ? { | ||
| email: user.email, | ||
| userId: user.id, | ||
| traits: { name: user.name }, | ||
| } | ||
| : null | ||
| } |
There was a problem hiding this comment.
Verify that sending user.email to Outlit is compliant with your privacy policy.
The user's email and name are forwarded to a third-party analytics SDK. Ensure this is covered by your privacy policy / terms and that Outlit's data processing agreement is in place. This is especially relevant for GDPR/CCPA compliance.
🤖 Prompt for AI Agents
In `@apps/web/src/components/OutlitProvider/OutlitProvider.tsx` around lines 21 -
29, The current OutlitProvider is sending personally identifiable info
(user.email and traits.name) to Outlit when populating the user prop; update the
implementation to only send email/name when the user has given consent or when
your privacy/data-processing agreements allow it—add a consent check or feature
flag around the user object construction inside OutlitProvider (the block that
references user.email, user.id, and traits.name) and ensure your privacy policy
and DPA with Outlit are in place and referenced before enabling that branch.
89c6b8d to
ffb87fb
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@apps/marketing/src/app/providers.tsx`:
- Line 15: The OutlitProvider is receiving an empty string when
NEXT_PUBLIC_OUTLIT_KEY is unset, which can still trigger SDK initialization;
change the prop usage so you pass null when env.NEXT_PUBLIC_OUTLIT_KEY is falsy
(e.g. use env.NEXT_PUBLIC_OUTLIT_KEY ? env.NEXT_PUBLIC_OUTLIT_KEY : null) or
switch to the client prop pattern used by getOutlit() so OutlitProvider (or its
client) receives null when no key exists, ensuring the provider cleanly disables
itself; update the publicKey prop assignment (or replace with client) on
OutlitProvider to pass null instead of "" when the env var is undefined.
- Around line 14-18: OutlitProvider is creating a second Outlit instance with
trackPageviews enabled; instead, obtain the shared singleton via getOutlit()
(from lib/outlit/index.ts) and pass it into OutlitProvider using the client prop
(instead of relying on OutlitProvider to construct its own client), and remove
or disable trackPageviews/other duplicate config on the OutlitProvider call so
that all pageview tracking/configuration is centralized in getOutlit().
🧹 Nitpick comments (3)
apps/desktop/src/main/lib/analytics/index.ts (1)
55-69: Outlit receives un-enriched properties unlike PostHog.PostHog properties are enriched with
app_name,platform, anddesktop_version(lines 46–51), but the Outlit call passes rawpropertieswithout these fields. If you intend parity between the two analytics sinks, pass the enriched object to Outlit as well.Also,
"project_opened"is a magic string — consider extracting it to a named constant. As per coding guidelines, hardcoded magic strings should be extracted to named constants at module top.Proposed fix
+const ACTIVATION_EVENT = "project_opened" as const; + export function track( event: string, properties?: Record<string, unknown>, ): void { if (!userId) return; if (!isTelemetryEnabled()) return; const client = getClient(); if (!client) return; + const enrichedProperties = { + ...properties, + app_name: "desktop", + platform: process.platform, + desktop_version: app.getVersion(), + }; + client.capture({ distinctId: userId, event, - properties: { - ...properties, - app_name: "desktop", - platform: process.platform, - desktop_version: app.getVersion(), - }, + properties: enrichedProperties, }); // Outlit tracking try { const outlit = getOutlit(); if (outlit) { outlit.track({ eventName: event, userId, - properties: properties as + properties: enrichedProperties as | Record<string, string | number | boolean | null> | undefined, }); - if (event === "project_opened") { + if (event === ACTIVATION_EVENT) { outlit.user.activate({ userId }); } } } catch (error) { console.error("[analytics/outlit] Failed to track:", error); } }apps/marketing/src/lib/analytics/index.ts (2)
10-15: Unsafeascast may silently pass incompatible property types to Outlit.If callers pass nested objects or arrays in
properties, the cast toRecord<string, string | number | boolean | null>will mask the type mismatch at compile time, potentially causing silent data loss or SDK errors at runtime. This mirrors the desktop renderer pattern, so it's consistent — but consider a runtime filter for correctness if property shapes aren't guaranteed to be flat.
5-7: Two positional parameters — coding guidelines prefer object parameters.The guideline says to use object parameters for functions with 2+ params. However, this matches the desktop renderer's
track()signature exactly, so changing only the marketing app would introduce inconsistency. Worth aligning in a follow-up across all apps if desired. As per coding guidelines, "Use object parameters for functions with 2 or more parameters instead of positional arguments."
| <OutlitProvider | ||
| publicKey={env.NEXT_PUBLIC_OUTLIT_KEY ?? ""} | ||
| trackPageviews | ||
| autoTrack={false} | ||
| > |
There was a problem hiding this comment.
Potential duplicate pageview tracking — two Outlit instances with trackPageviews: true.
OutlitProvider here creates its own internal Outlit instance with trackPageviews enabled. Meanwhile, getOutlit() in lib/outlit/index.ts creates a separate singleton also with trackPageviews: true. This likely results in duplicate pageview events being sent to Outlit.
The desktop app avoids this by passing the shared singleton via the client prop to OutlitProvider. Consider the same approach here:
Proposed fix — share the singleton
+import { getOutlit } from "@/lib/outlit";
+
<OutlitProvider
- publicKey={env.NEXT_PUBLIC_OUTLIT_KEY ?? ""}
- trackPageviews
- autoTrack={false}
+ client={getOutlit()}
>Then ensure trackPageviews and other config remain only in getOutlit() to avoid conflicting options.
🤖 Prompt for AI Agents
In `@apps/marketing/src/app/providers.tsx` around lines 14 - 18, OutlitProvider is
creating a second Outlit instance with trackPageviews enabled; instead, obtain
the shared singleton via getOutlit() (from lib/outlit/index.ts) and pass it into
OutlitProvider using the client prop (instead of relying on OutlitProvider to
construct its own client), and remove or disable trackPageviews/other duplicate
config on the OutlitProvider call so that all pageview tracking/configuration is
centralized in getOutlit().
| storageKey={THEME_STORAGE_KEY} | ||
| disableTransitionOnChange | ||
| <OutlitProvider | ||
| publicKey={env.NEXT_PUBLIC_OUTLIT_KEY ?? ""} |
There was a problem hiding this comment.
Passing an empty string as publicKey when the env var is unset may cause unintended SDK initialization.
When NEXT_PUBLIC_OUTLIT_KEY is undefined, this passes "" to OutlitProvider, which may still initialize the SDK and attempt network calls with an invalid key. The getOutlit() pattern correctly returns null when the key is absent. If you adopt the client prop approach above, passing null would cleanly disable the provider.
🤖 Prompt for AI Agents
In `@apps/marketing/src/app/providers.tsx` at line 15, The OutlitProvider is
receiving an empty string when NEXT_PUBLIC_OUTLIT_KEY is unset, which can still
trigger SDK initialization; change the prop usage so you pass null when
env.NEXT_PUBLIC_OUTLIT_KEY is falsy (e.g. use env.NEXT_PUBLIC_OUTLIT_KEY ?
env.NEXT_PUBLIC_OUTLIT_KEY : null) or switch to the client prop pattern used by
getOutlit() so OutlitProvider (or its client) receives null when no key exists,
ensuring the provider cleanly disables itself; update the publicKey prop
assignment (or replace with client) on OutlitProvider to pass null instead of ""
when the env var is undefined.
- Add NEXT_PUBLIC_OUTLIT_KEY to .env.example - Add Outlit key to Vite define blocks (main + renderer) - Fix UserIdentity type: move name to traits object - Fix analytics wrapper type: cast properties for Outlit SDK
…der wrappers, and wire up consent controls - Bump @outlit/browser from ^1.2.0 to ^1.4.0 across all apps - Add OutlitProvider wrapper for desktop (passes singleton via client prop for shared instance + user identity) - Add OutlitProvider wrapper for web (handles authenticated user identity) - Wire up disableTracking() in desktop TelemetrySync and marketing CookieConsent - Restore original comment in desktop main process
leo-paz
force-pushed
the
outlit-integration
branch
from
ffb87fb to
386c0fe
Compare
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Fix all issues with AI agents
In `@apps/desktop/src/main/index.ts`:
- Line 161: shutdownOutlit() can reject (via outlit.shutdown()) and prevent
subsequent teardown (disposeTray() and app.exit(0)); wrap the call in a
try-catch (or try-finally) inside the shutdown sequence so any rejection is
caught and logged, then ensure disposeTray() is always called and app.exit(0)
always runs (use a finally block to guarantee disposal and exit even if
shutdownOutlit() throws).
In `@apps/desktop/src/main/lib/analytics/index.ts`:
- Around line 58-64: The current usage of outlit.track passes properties with an
unsafe cast (properties as Record<string, string | number | boolean | null>),
which can let nested objects/arrays through; update the call site that invokes
outlit.track to sanitize/validate the properties object (the local properties
variable) by iterating its keys and only keeping primitive
(string/number/boolean) or null values, converting non-primitive values to safe
string representations or omitting them, and then pass that sanitized map to
outlit.track (referencing outlit.track and the properties variable to locate the
change); ensure the resulting type matches Record<string, string | number |
boolean | null> without using an unconditional type assertion.
In `@apps/web/src/components/OutlitProvider/OutlitProvider.tsx`:
- Around line 17-33: The OutlitProvider always mounts OutlitBrowserProvider with
publicKey set to env.NEXT_PUBLIC_OUTLIT_KEY ?? "" which can pass an empty string
and cause SDK initialization/errors; change OutlitProvider to guard on
env.NEXT_PUBLIC_OUTLIT_KEY (or the same runtime check used by the desktop
getOutlit pattern) and only render OutlitBrowserProvider when the key is
present, otherwise return the passthrough children; update the conditional
around OutlitBrowserProvider (refer to OutlitBrowserProvider, OutlitProvider and
env.NEXT_PUBLIC_OUTLIT_KEY) so the SDK is not initialized with an empty
publicKey.
🧹 Nitpick comments (2)
apps/desktop/src/main/lib/analytics/index.ts (1)
67-69: Consider extracting"project_opened"to a named constant.Per coding guidelines, hardcoded magic strings should be extracted to named constants at module top. This event name represents a domain concept (activation moment) and would benefit from being a shared constant, especially if it's referenced elsewhere.
apps/marketing/src/lib/analytics/index.ts (1)
10-15: Unsafe type assertion — non-primitive values will be silently forwarded.
Record<string, unknown>can contain nested objects, arrays,Date, etc. Theascast doesn't coerce values at runtime; it just silences the compiler. If Outlit's SDK truly only acceptsstring | number | boolean | null, consider filtering or coercing the property values instead of casting.Proposed fix
- getOutlit()?.track( - event, - properties as - | Record<string, string | number | boolean | null> - | undefined, - ); + if (properties) { + const sanitized: Record<string, string | number | boolean | null> = {}; + for (const [key, value] of Object.entries(properties)) { + if ( + typeof value === "string" || + typeof value === "number" || + typeof value === "boolean" || + value === null + ) { + sanitized[key] = value; + } + } + getOutlit()?.track(event, sanitized); + } else { + getOutlit()?.track(event); + }
| // Quit confirmed or no confirmation needed - exit immediately | ||
| // Let OS clean up child processes, tray, etc. | ||
| isQuitting = true; | ||
| await shutdownOutlit(); |
There was a problem hiding this comment.
Unhandled rejection from shutdownOutlit() could prevent app.exit(0).
If outlit.shutdown() rejects (e.g., network timeout), the error propagates and skips disposeTray() + app.exit(0), leaving the app hung in a quitting state.
Proposed fix: wrap in try-catch
isQuitting = true;
- await shutdownOutlit();
+ try {
+ await shutdownOutlit();
+ } catch (error) {
+ console.error("[main] Outlit shutdown failed:", error);
+ }
disposeTray();
app.exit(0);📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| await shutdownOutlit(); | |
| isQuitting = true; | |
| try { | |
| await shutdownOutlit(); | |
| } catch (error) { | |
| console.error("[main] Outlit shutdown failed:", error); | |
| } | |
| disposeTray(); | |
| app.exit(0); |
🤖 Prompt for AI Agents
In `@apps/desktop/src/main/index.ts` at line 161, shutdownOutlit() can reject (via
outlit.shutdown()) and prevent subsequent teardown (disposeTray() and
app.exit(0)); wrap the call in a try-catch (or try-finally) inside the shutdown
sequence so any rejection is caught and logged, then ensure disposeTray() is
always called and app.exit(0) always runs (use a finally block to guarantee
disposal and exit even if shutdownOutlit() throws).
| outlit.track({ | ||
| eventName: event, | ||
| userId, | ||
| properties: properties as | ||
| | Record<string, string | number | boolean | null> | ||
| | undefined, | ||
| }); |
There was a problem hiding this comment.
Unsafe type assertion on properties.
properties is typed as Record<string, unknown>, which may contain nested objects, arrays, or other non-primitive values. The as cast silently bypasses this, potentially sending unsupported types to the Outlit SDK.
Consider filtering or validating the properties to only include primitive values:
Proposed fix
- outlit.track({
- eventName: event,
- userId,
- properties: properties as
- | Record<string, string | number | boolean | null>
- | undefined,
- });
+ const safeProperties = properties
+ ? Object.fromEntries(
+ Object.entries(properties).filter(
+ ([, v]) =>
+ v === null ||
+ typeof v === "string" ||
+ typeof v === "number" ||
+ typeof v === "boolean",
+ ),
+ )
+ : undefined;
+ outlit.track({
+ eventName: event,
+ userId,
+ properties: safeProperties as
+ | Record<string, string | number | boolean | null>
+ | undefined,
+ });📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| outlit.track({ | |
| eventName: event, | |
| userId, | |
| properties: properties as | |
| | Record<string, string | number | boolean | null> | |
| | undefined, | |
| }); | |
| const safeProperties = properties | |
| ? Object.fromEntries( | |
| Object.entries(properties).filter( | |
| ([, v]) => | |
| v === null || | |
| typeof v === "string" || | |
| typeof v === "number" || | |
| typeof v === "boolean", | |
| ), | |
| ) | |
| : undefined; | |
| outlit.track({ | |
| eventName: event, | |
| userId, | |
| properties: safeProperties as | |
| | Record<string, string | number | boolean | null> | |
| | undefined, | |
| }); |
🤖 Prompt for AI Agents
In `@apps/desktop/src/main/lib/analytics/index.ts` around lines 58 - 64, The
current usage of outlit.track passes properties with an unsafe cast (properties
as Record<string, string | number | boolean | null>), which can let nested
objects/arrays through; update the call site that invokes outlit.track to
sanitize/validate the properties object (the local properties variable) by
iterating its keys and only keeping primitive (string/number/boolean) or null
values, converting non-primitive values to safe string representations or
omitting them, and then pass that sanitized map to outlit.track (referencing
outlit.track and the properties variable to locate the change); ensure the
resulting type matches Record<string, string | number | boolean | null> without
using an unconditional type assertion.
| return ( | ||
| <OutlitBrowserProvider | ||
| publicKey={env.NEXT_PUBLIC_OUTLIT_KEY ?? ""} | ||
| trackPageviews | ||
| user={ | ||
| user | ||
| ? { | ||
| email: user.email, | ||
| userId: user.id, | ||
| traits: { name: user.name }, | ||
| } | ||
| : null | ||
| } | ||
| > | ||
| {children} | ||
| </OutlitBrowserProvider> | ||
| ); |
There was a problem hiding this comment.
publicKey="" when key is unset — may cause unnecessary SDK initialization or errors.
Unlike the desktop OutlitProvider, which returns a passthrough when getOutlit() is null, this always renders OutlitBrowserProvider even when NEXT_PUBLIC_OUTLIT_KEY is unset (passing ""). This could lead to failed API calls or silent errors depending on how the Outlit SDK handles an empty key.
Consider guarding similarly to the desktop pattern:
Proposed fix
export function OutlitProvider({ children }: OutlitProviderProps) {
const { data: session } = authClient.useSession();
const user = session?.user;
+ if (!env.NEXT_PUBLIC_OUTLIT_KEY) {
+ return <>{children}</>;
+ }
+
return (
<OutlitBrowserProvider
- publicKey={env.NEXT_PUBLIC_OUTLIT_KEY ?? ""}
+ publicKey={env.NEXT_PUBLIC_OUTLIT_KEY}
trackPageviews🤖 Prompt for AI Agents
In `@apps/web/src/components/OutlitProvider/OutlitProvider.tsx` around lines 17 -
33, The OutlitProvider always mounts OutlitBrowserProvider with publicKey set to
env.NEXT_PUBLIC_OUTLIT_KEY ?? "" which can pass an empty string and cause SDK
initialization/errors; change OutlitProvider to guard on
env.NEXT_PUBLIC_OUTLIT_KEY (or the same runtime check used by the desktop
getOutlit pattern) and only render OutlitBrowserProvider when the key is
present, otherwise return the passthrough children; update the conditional
around OutlitBrowserProvider (refer to OutlitBrowserProvider, OutlitProvider and
env.NEXT_PUBLIC_OUTLIT_KEY) so the SDK is not initialized with an empty
publicKey.
|
Closing: duplicate of #1357 which integrates the same Outlit analytics SDK. |
|
Hey — just a heads up, this was closed as part of an automated stale PR cleanup. If you think this was done in error, feel free to reopen it! |
|
Hey — this was closed by an automated cleanup of PRs with major merge conflicts that are 3+ weeks old. If you think this was done incorrectly, please feel free to reopen it. Sorry for any inconvenience! |
2 participants
Summary
@outlit/browser+@outlit/node) across all four apps (desktop, web, marketing, docs)OutlitProviderwrappers in desktop and web appstrack()calls to send events to both PostHog and Outlit in parallelChanges by app
Desktop (Electron)
@outlit/nodefor server-sideuser.activateon project openOutlitProviderwithclientprop for shared instance and user identityTelemetrySyncwires upenableTracking()/disableTracking()alongside PostHogMarketing (Next.js)
OutlitProviderin providers with pageview + form tracking enabledCookieConsentusesuseOutlit()hook forenableTracking()/disableTracking()track()wrapper sends to both PostHog and OutlitWeb (Next.js)
OutlitProviderwrapper handles authenticated user identity (setUser/clearUser)Docs (Next.js)
OutlitProviderfor cross-domain pageview trackingShared
NEXT_PUBLIC_OUTLIT_KEYadded to.env.exampleand all env schemas@outlit/browser@^1.4.0uses newclientprop to share singleton with provider (avoids dual instance issue)Test plan
NEXT_PUBLIC_OUTLIT_KEYis unsetSummary by CodeRabbit
New Features
Dependencies