feat: add base survey integration #314

ioannisj · 2025-03-10T07:33:46Z

💡 Motivation and Context

Added base logic for survey integration, including flag-based/internal targeting and device type checks for display conditions.
Added some draft/test implementation on presentation logic.
- iOS: Surveys are displayed via a separate passthrough window rather than the root view controller of the host app. This avoids conflicts with existing modal presentations in the host app. We do all our work in a separate context without affecting or introducing any side effects to the app's root view controller.
- SwiftUI: Some limitations since Apple introduced the majority of bottom sheet functionality in SwiftUI with iOS 16+. Will probably need to dive into UIKit world for proper display here.
No event trigger handling yet—considering a simple surveyIntegration.onEventCaptured() call for now. Ideally, though, internal delegates or handlers could provide better decoupling and would also enable us exposing these to the public API in the near future, something which is already requested here
Public API is still draft

#skip-changelog

TODO:

💚 How did you test it?

Unit tests

📝 Checklist

I reviewed the submitted code.
I added tests to verify the changes.
I updated the docs if needed.
No breaking change or entry added to the changelog.

# Conflicts: # CHANGELOG.md # Makefile # PostHog.podspec # PostHog.xcodeproj/project.pbxproj # PostHog/PostHogApi.swift # PostHog/PostHogSDK.swift # PostHog/PostHogVersion.swift # PostHogTests/PostHogFeatureFlagsTest.swift # PostHogTests/PostHogSessionManagerTest.swift # PostHogTests/TestUtils/MockApplicationLifecyclePublisher.swift # PostHogTests/TestUtils/TestPostHog.swift

ioannisj · 2025-03-10T07:35:39Z

PostHog/PostHogConfig.swift

@@ -59,11 +59,11 @@ import Foundation
        @objc public let sessionReplayConfig: PostHogSessionReplayConfig = .init()
    #endif

-    #if os(iOS)
+    #if os(iOS) || TESTING


Public api is still draft here. Just added TESTING so that tests can run on CI as well for now

ioannisj · 2025-03-10T07:36:41Z

PostHog/PostHogContext.swift

-        #else
-            properties["$is_emulator"] = false
-        #endif
+        if let deviceType = PostHogContext.deviceType {


Had to extract deviceType logic here since it was needed for surveys as well. Cleaned up/refactored a bit PostHogContext

ioannisj · 2025-03-10T07:38:05Z

PostHog/PostHogSDK.swift

@@ -37,7 +37,7 @@ let maxRetryDelay = 30.0

    private var queue: PostHogQueue?
    private var replayQueue: PostHogQueue?
-    private var storage: PostHogStorage?
+    private(set) var storage: PostHogStorage?


Changed to internal visibility since it will be used by surveys to check survey seen info

ioannisj · 2025-03-10T07:40:11Z

PostHog/Surveys/PostHogSurveyIntegration.swift

+            return postHog.isFeatureEnabled(flagKey)
+        }
+
+        private func canRenderSurvey(survey _: Survey) -> Bool {


Temp. Not called yet

ioannisj · 2025-03-10T07:40:22Z

PostHog/Surveys/PostHogSurveyIntegration.swift

+        private func setActiveSurvey(survey: Survey) {
+            activeSurveyLock.withLock {
+                if let activeSurvey {
+                    hedgeLog("Survey \(activeSurvey) already in focus. Cannot add survey \(survey).")
+                    return
+                }
+                activeSurvey = survey
+            }
+        }
+
+        /// Removes given survey as active survey
+        private func removeActiveSurvey(survey: Survey) {
+            activeSurveyLock.withLock {
+                guard activeSurvey?.id != survey.id else {
+                    hedgeLog("Survey \(survey) is not in focus. Cannot remove survey \(survey)")
+                    return
+                }
+                activeSurvey = nil
+            }
+        }


Temp. Not called yet

ioannisj · 2025-03-10T07:40:45Z

PostHog/Surveys/PostHogSurveyIntegration.swift

+            return matchType.matches(targets: deviceTypes, value: deviceType)
+        }
+
+        private func getNextSurveyStep(


Temp. Not called yet

ioannisj · 2025-03-21T12:01:10Z

Will yolo this since base is the feature branch anw. Should review with coming big PR

* feat: load remote config and feature flags (#283) * feat: load remote config and feature flags * fix: cleanup * fix: redundant assignment * fix: hasFeatureFlags * fix: lint * feat: add survey domain models (#284) * feat: add survey domain models * fix: reuse date formatter * fix: improve test fixtures and model consistency * Merge branch 'main' into feat/mobile-surveys-merge-main (#313) * chore: session replay ga (#286) * fix: xcframework builds (#288) * fix: xcframework builds * fix: import access level * feat: add sample xcframework project * fix: build examples * chore: update CHANGELOG * Update version * chore: skip creating a visionOS simulator if not needed (#289) * chore: skip creating a visionOS simulator if not needed * fix: external sdk example * Update version * feat: add survey domain models * Merge branch 'main' into feat/mobile-surveys-merge-main # Conflicts: # CHANGELOG.md # Makefile # PostHog.podspec # PostHog.xcodeproj/project.pbxproj # PostHog/PostHogApi.swift # PostHog/PostHogSDK.swift # PostHog/PostHogVersion.swift # PostHogTests/PostHogFeatureFlagsTest.swift # PostHogTests/PostHogSessionManagerTest.swift # PostHogTests/TestUtils/MockApplicationLifecyclePublisher.swift # PostHogTests/TestUtils/TestPostHog.swift * fix: lint * feat: add base survey integration (#314) * feat: add survey domain models * Merge branch 'main' into feat/mobile-surveys-merge-main # Conflicts: # CHANGELOG.md # Makefile # PostHog.podspec # PostHog.xcodeproj/project.pbxproj # PostHog/PostHogApi.swift # PostHog/PostHogSDK.swift # PostHog/PostHogVersion.swift # PostHogTests/PostHogFeatureFlagsTest.swift # PostHogTests/PostHogSessionManagerTest.swift # PostHogTests/TestUtils/MockApplicationLifecyclePublisher.swift # PostHogTests/TestUtils/TestPostHog.swift * feat: base surveys integration * feat: base survey display * fix: builds * fix: test * fix: tests * fix: remote config tests * feat: add survey UI and display logic (#320) * feat: add survey domain models * Merge branch 'main' into feat/mobile-surveys-merge-main # Conflicts: # CHANGELOG.md # Makefile # PostHog.podspec # PostHog.xcodeproj/project.pbxproj # PostHog/PostHogApi.swift # PostHog/PostHogSDK.swift # PostHog/PostHogVersion.swift # PostHogTests/PostHogFeatureFlagsTest.swift # PostHogTests/PostHogSessionManagerTest.swift # PostHogTests/TestUtils/MockApplicationLifecyclePublisher.swift # PostHogTests/TestUtils/TestPostHog.swift * feat: base surveys integration * feat: base survey display * fix: builds * fix: test * fix: tests * fix: remote config tests * feat: add survey ui components * feat: survey question type display and next question logic * feat: send survey seen, sent, dismissed events * feat: add event-activated surveys * fix: empty question description * fix: hit test on iOS 18 * fix: safe area inset * refactor: move display related to logic to display manager * fix: handle case displayThankYouMessage is false * fix: tests * fix: handle optional questions * fix: build * feat: public api * chore: update CHANGELOG * feat: iOS15 presentation detents (#324) * feat: add survey domain models * Merge branch 'main' into feat/mobile-surveys-merge-main # Conflicts: # CHANGELOG.md # Makefile # PostHog.podspec # PostHog.xcodeproj/project.pbxproj # PostHog/PostHogApi.swift # PostHog/PostHogSDK.swift # PostHog/PostHogVersion.swift # PostHogTests/PostHogFeatureFlagsTest.swift # PostHogTests/PostHogSessionManagerTest.swift # PostHogTests/TestUtils/MockApplicationLifecyclePublisher.swift # PostHogTests/TestUtils/TestPostHog.swift * feat: base surveys integration * feat: base survey display * fix: builds * fix: test * fix: tests * fix: remote config tests * feat: add survey ui components * feat: survey question type display and next question logic * feat: send survey seen, sent, dismissed events * feat: add event-activated surveys * fix: empty question description * fix: hit test on iOS 18 * fix: safe area inset * refactor: move display related to logic to display manager * fix: handle case displayThankYouMessage is false * fix: tests * feat: add backport for iOS 15 presentation detents * fix: lint * fix: sheet height * fix: remove ViewBuilder attribute * feat: add configuration option for remoteConfig * chore: prefix survey models * fix: cache needed integrations in sdk instance * chore: split survey models to multiple files * chore: refactor remote config callback

ioannisj added 4 commits March 5, 2025 13:14

feat: add survey domain models

0645c2d

feat: base surveys integration

671e84d

feat: base survey display

cda87eb

ioannisj commented Mar 10, 2025

View reviewed changes

ioannisj marked this pull request as ready for review March 10, 2025 07:41

ioannisj requested a review from marandaneto as a code owner March 10, 2025 07:41

ioannisj requested a review from a team March 10, 2025 07:41

fix: builds

4610ad4

ioannisj changed the title ~~feat: add base display logic~~ feat: add base survey integration Mar 10, 2025

ioannisj added 3 commits March 10, 2025 10:03

fix: test

9c627ac

fix: tests

873a433

fix: remote config tests

fff69b3

ioannisj merged commit 816f129 into feat/mobile-surveys Mar 21, 2025
8 checks passed

ioannisj deleted the feat/mobile-surveys-display-logic branch March 21, 2025 12:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: add base survey integration #314

feat: add base survey integration #314

Uh oh!

ioannisj commented Mar 10, 2025 •

edited

Loading

Uh oh!

ioannisj Mar 10, 2025

Uh oh!

ioannisj Mar 10, 2025

Uh oh!

ioannisj Mar 10, 2025

Uh oh!

ioannisj Mar 10, 2025

Uh oh!

ioannisj Mar 10, 2025

Uh oh!

ioannisj Mar 10, 2025

Uh oh!

ioannisj commented Mar 21, 2025

Uh oh!

Uh oh!

Uh oh!

feat: add base survey integration #314

feat: add base survey integration #314

Uh oh!

Conversation

ioannisj commented Mar 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💡 Motivation and Context

TODO:

💚 How did you test it?

📝 Checklist

Uh oh!

ioannisj Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

ioannisj Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

ioannisj Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

ioannisj Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

ioannisj Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

ioannisj Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

ioannisj commented Mar 21, 2025

Uh oh!

Uh oh!

Uh oh!

ioannisj commented Mar 10, 2025 •

edited

Loading