ensure localStorage is included on persistence, otherwise log warning

Author: lucasheriques

packages/browser/src/__tests__/extensions/surveys-persistence.test.ts

@@ -16,7 +16,7 @@ describe('Surveys Persistence Migration - Simple Test', () => {
 
     const config = {
         token: 'test-token',
-        persistence: 'memory',
+        persistence: 'localStorage+cookie',
         api_host: 'https://app.posthog.com',
     } as PostHogConfig
 

packages/browser/src/__tests__/posthog-surveys.test.ts

@@ -90,6 +90,7 @@ describe('posthog-surveys', () => {
                     disable_surveys: false,
                     token: 'test-token',
                     surveys_request_timeout_ms: SURVEYS_REQUEST_TIMEOUT_MS,
+                    persistence: 'localStorage+cookie',
                 },
                 persistence: {
                     register: jest.fn(),

packages/browser/src/__tests__/surveys.test.ts

@@ -189,7 +189,7 @@ describe('surveys', () => {
         config = {
             token: 'testtoken',
             api_host: 'https://app.posthog.com',
-            persistence: 'memory',
+            persistence: 'localStorage+cookie',
             surveys_request_timeout_ms: SURVEYS_REQUEST_TIMEOUT_MS,
         } as unknown as PostHogConfig
 

packages/browser/src/extensions/surveys.tsx

@@ -420,7 +420,7 @@ export class SurveyManager {
 
     private _internalFlagCheckSatisfied(survey: Survey): boolean {
         return (
-            canActivateRepeatedly(survey) ||
+            canActivateRepeatedly(survey, this._posthog) ||
             this._isSurveyFeatureFlagEnabled(survey.internal_targeting_flag_key) ||
             isSurveyInProgress(survey, this._posthog)
         )

packages/browser/src/extensions/surveys/surveys-extension-utils.tsx

@@ -521,12 +521,13 @@ export const hasEvents = (survey: Pick<Survey, 'conditions'>): boolean => {
 }
 
 export const canActivateRepeatedly = (
-    survey: Pick<Survey, 'schedule' | 'conditions' | 'id' | 'current_iteration'>
+    survey: Pick<Survey, 'schedule' | 'conditions' | 'id' | 'current_iteration'>,
+    posthog?: PostHog
 ): boolean => {
     return (
         !!(survey.conditions?.events?.repeatedActivation && hasEvents(survey)) ||
         survey.schedule === SurveySchedule.Always ||
-        isSurveyInProgress(survey)
+        isSurveyInProgress(survey, posthog)
     )
 }
 
@@ -541,7 +542,7 @@ export const getSurveySeen = (survey: Survey, posthog?: PostHog): boolean => {
     if (surveySeen) {
         // if a survey has already been seen,
         // we will override it with the event repeated activation value.
-        return !canActivateRepeatedly(survey)
+        return !canActivateRepeatedly(survey, posthog)
     }
 
     return false

packages/browser/src/posthog-surveys.ts

@@ -16,6 +16,7 @@ import {
     doesSurveyActivateByAction,
     doesSurveyActivateByEvent,
     IN_APP_SURVEY_TYPES,
+    isPersistenceEnabledWithLocalStorage,
     isSurveyRunning,
     LAST_SEEN_SURVEY_DATE_KEY,
     SURVEY_LOGGER as logger,
@@ -86,6 +87,11 @@ export class PostHogSurveys {
             logger.info('Not loading surveys in cookieless mode without consent.')
             return
         }
+        if (isPersistenceEnabledWithLocalStorage(this._instance)) {
+            logger.warn(
+                'Persistence does not include localStorage, but surveys it to work properly. Please set persistence to include localStorage to avoid this warning, or set disable_surveys to true. Falling back to localStorage usage directly to maintain backwards compatibility.'
+            )
+        }
 
         const phExtensions = assignableWindow?.__PosthogExtensions__
         if (!phExtensions) {

packages/browser/src/utils/survey-utils.ts

@@ -42,8 +42,14 @@ export const getSurveySeenKey = (survey: Pick<Survey, 'id' | 'current_iteration'
     return surveySeenKey
 }
 
-function isPersistenceEnabled(posthog?: PostHog): posthog is PostHog & { persistence: PostHogPersistence } {
-    return !!(posthog?.persistence && !posthog.persistence.isDisabled())
+export function isPersistenceEnabledWithLocalStorage(
+    posthog?: PostHog
+): posthog is PostHog & { persistence: PostHogPersistence } {
+    return !!(
+        posthog?.persistence &&
+        !posthog.persistence.isDisabled() &&
+        posthog.config?.persistence?.includes('localStorage')
+    )
 }
 
 /**
@@ -52,7 +58,7 @@ function isPersistenceEnabled(posthog?: PostHog): posthog is PostHog & { persist
  * to maintain backwards compatibility.
  */
 export const getFromPersistenceWithLocalStorageFallback = (key: string, posthog?: PostHog) => {
-    if (!isPersistenceEnabled(posthog)) {
+    if (!isPersistenceEnabledWithLocalStorage(posthog)) {
         try {
             return localStorage.getItem(key)
         } catch (e) {
@@ -75,7 +81,7 @@ export const getFromPersistenceWithLocalStorageFallback = (key: string, posthog?
  * to maintain backwards compatibility.
  */
 export const setOnPersistenceWithLocalStorageFallback = (key: string, value: any, posthog?: PostHog) => {
-    if (!isPersistenceEnabled(posthog)) {
+    if (!isPersistenceEnabledWithLocalStorage(posthog)) {
         try {
             localStorage.setItem(key, value)
         } catch (e) {
@@ -96,7 +102,7 @@ export const setOnPersistenceWithLocalStorageFallback = (key: string, value: any
  * When removing a property from persistence, remove from localStorage for backwards compatibility.
  */
 export const clearFromPersistenceWithLocalStorageFallback = (key: string, posthog?: PostHog) => {
-    if (!isPersistenceEnabled(posthog)) {
+    if (!isPersistenceEnabledWithLocalStorage(posthog)) {
         try {
             localStorage.removeItem(key)
         } catch (e) {