feat: formbricks v5 changes#46
Merged
Merged
Conversation
- Getter: fall back to legacy key when new-key blob fails to decode, and only migrate/delete legacy after it decodes as WorkspaceResponse so a corrupt blob can't poison the new key. - refreshWorkspaceIfNeeded: schedule startRefreshTimer on the cached-valid path so refresh still fires when the cached response later expires. - FormbricksConfig.workspaceId: expose as @objc public to match the deprecated environmentId alias visibility. - Tests: clear persisted workspace cache keys in setUp/tearDown to avoid cross-test leakage (Formbricks.cleanup() intentionally leaves them). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
macos-15 runners no longer ship the iPhone SE (3rd generation) iOS 18.5 simulator runtime, so the pinned destination fails with "no available devices matched the request". Switch to iPhone 16 with OS=latest so the runner picks whatever simulator runtime is installed. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Previous run on macos-15 reported zero available iOS Simulator devices (only placeholders), meaning xcode-select was pointing at an Xcode without any installed simulator runtimes. Use maxim-lobanov/setup-xcode to pin to the latest stable Xcode (which ships with simulators), and print the sim device list so future failures are self-diagnosing. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
feat: adds workspace support
WalkthroughThis pull request systematically refactors the Formbricks iOS SDK to replace all 🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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 |
Dhruwang
approved these changes
May 18, 2026
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
Sources/FormbricksSDK/Model/Workspace/WorkspaceResponse.swift (1)
14-45: 🧹 Nitpick | 🔵 Trivial | 💤 Low valueConsider extracting common JSON parsing logic.
The
getSurveyJson,getSurveyStylingJson, andgetSettingsStylingJsonmethods all repeat the same JSON deserialization pattern to reachdataDict. This could be extracted into a private helper for clarity, though the current approach works correctly.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@Sources/FormbricksSDK/Model/Workspace/WorkspaceResponse.swift` around lines 14 - 45, Extract the repeated JSON deserialization into a private helper on WorkspaceResponse (e.g. a private func like parsedDataDict() -> [String: Any]?) that performs the guard using responseString, JSONSerialization and returns the nested dataDict (the value currently assigned to dataDict in getSurveyJson/getSurveyStylingJson/getSettingsStylingJson). Replace the duplicated code in getSurveyJson(forSurveyId:), getSurveyStylingJson(forSurveyId:) and getSettingsStylingJson() to call that helper and then run only the remaining logic (search surveys array or pull styling/settings) so the three public methods become thin and de-duplicated.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@Sources/FormbricksSDK/Formbricks.swift`:
- Around line 76-80: The guard block that checks url.scheme (guard
url.scheme?.lowercased() == "https") is indented with 3 spaces whereas the file
uses 4-space indentation; fix the whitespace so the guard, its body (let
errorMessage ... Formbricks.logger?.error(...)) and return lines use 4-space
indentation to match the rest of the file and keep the block aligned with
surrounding code (reference symbols: url.scheme, config.appUrl,
Formbricks.logger?.error).
In `@Sources/FormbricksSDK/Manager/SurveyManager.swift`:
- Around line 254-276: The getter currently returns decoded WorkspaceResponse
without updating the cached backingWorkspaceResponse and the setter may encode a
nil Optional into a JSON null blob; update the SurveyManager computed property
so that on successful decode from UserDefaults (both workspaceResponseObjectKey
and legacyEnvironmentResponseObjectKey) you assign backingWorkspaceResponse =
decoded before returning, and in the setter handle nil explicitly: if newValue
is non-nil encode and write that value and remove the legacy key, otherwise
remove the workspaceResponseObjectKey and legacyEnvironmentResponseObjectKey
from UserDefaults and set backingWorkspaceResponse = nil so persisted data is
cleared instead of writing a JSON null.
In `@Sources/FormbricksSDK/Model/Workspace/WorkspaceResponseData.swift`:
- Around line 1-6: When decoding cached WorkspaceResponse/WorkspaceResponseData
in SurveyManager (the code that calls JSONDecoder().decode(...) for
WorkspaceResponse), switch the decoder to use JSONDecoder.iso8601Full instead of
plain JSONDecoder so the expiresAt: Date field is parsed correctly; locate the
decode call that targets WorkspaceResponse/WorkspaceResponseData and replace the
decoder instance with JSONDecoder.iso8601Full (from JSON+Formatter.swift) so the
ISO8601 date strings decode using the configured dateDecodingStrategy.
In `@Sources/FormbricksSDK/Networking/Base/APIClient.swift`:
- Around line 33-37: The guard block that checks the URL scheme (the lines
starting with "guard let scheme = components.scheme?.lowercased(), scheme ==
\"https\" else {", the Formbricks.logger?.error(...) call, and "return nil")
uses 3-space indentation instead of the file's 4-space convention; update those
lines to use 4-space indentation so they match the surrounding code style and
the rest of the file.
- Around line 81-84: The code currently force-casts back to Request.Response
after mutating a temporary workspace value; replace the force-cast with a safe
conditional cast and explicit cast when assigning back: use the existing
conditional binding (if var workspace = body as? WorkspaceResponse, let
jsonString = ...) then set workspace.responseString = jsonString and assign body
= workspace as Request.Response using an explicit safe cast instead of `as!`;
reference the WorkspaceResponse type, the body variable, its responseString
property, and Request.Response to locate and change the snippet.
In `@Tests/FormbricksSDKTests/FormbricksSDKTests.swift`:
- Around line 233-237: The test currently corrupts the new-key data and removes
the legacy key so it only verifies "new-key decode fails" rather than exercising
the fallback; update the test to write a valid legacy blob into
UserDefaults.standard under SurveyManager.legacyEnvironmentResponseObjectKey
(instead of removing it) so manager.workspaceResponse exercises the fallback
path to the legacy format, or if you intended to only test absence of fallback,
change the comment to match; locate the lines that set/remove UserDefaults for
SurveyManager.workspaceResponseObjectKey and
SurveyManager.legacyEnvironmentResponseObjectKey and replace the removal with
seeding a valid legacy-encoded value that matches the legacy decoding path used
by SurveyManager.
---
Outside diff comments:
In `@Sources/FormbricksSDK/Model/Workspace/WorkspaceResponse.swift`:
- Around line 14-45: Extract the repeated JSON deserialization into a private
helper on WorkspaceResponse (e.g. a private func like parsedDataDict() ->
[String: Any]?) that performs the guard using responseString, JSONSerialization
and returns the nested dataDict (the value currently assigned to dataDict in
getSurveyJson/getSurveyStylingJson/getSettingsStylingJson). Replace the
duplicated code in getSurveyJson(forSurveyId:),
getSurveyStylingJson(forSurveyId:) and getSettingsStylingJson() to call that
helper and then run only the remaining logic (search surveys array or pull
styling/settings) so the three public methods become thin and de-duplicated.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: f58ea161-c92f-48e1-97ef-538ebd5ea526
📒 Files selected for processing (32)
.github/workflows/sonarqube.ymlSources/FormbricksSDK/Formbricks.swiftSources/FormbricksSDK/Helpers/ConfigBuilder.swiftSources/FormbricksSDK/Helpers/FormbricksEnvironment.swiftSources/FormbricksSDK/Helpers/FormbricksWorkspace.swiftSources/FormbricksSDK/Manager/PresentSurveyManager.swiftSources/FormbricksSDK/Manager/SurveyManager.swiftSources/FormbricksSDK/Model/Environment/EnvironmentData.swiftSources/FormbricksSDK/Model/Environment/EnvironmentResponseData.swiftSources/FormbricksSDK/Model/Workspace/ActionClass/ActionClass.swiftSources/FormbricksSDK/Model/Workspace/Common/LocalizedText.swiftSources/FormbricksSDK/Model/Workspace/Settings/BrandColor.swiftSources/FormbricksSDK/Model/Workspace/Settings/Settings.swiftSources/FormbricksSDK/Model/Workspace/Settings/Styling.swiftSources/FormbricksSDK/Model/Workspace/Survey.swiftSources/FormbricksSDK/Model/Workspace/Surveys/ActionClassReference.swiftSources/FormbricksSDK/Model/Workspace/Surveys/Segment.swiftSources/FormbricksSDK/Model/Workspace/Surveys/Trigger.swiftSources/FormbricksSDK/Model/Workspace/WorkspaceData.swiftSources/FormbricksSDK/Model/Workspace/WorkspaceResponse.swiftSources/FormbricksSDK/Model/Workspace/WorkspaceResponseData.swiftSources/FormbricksSDK/Networking/Base/APIClient.swiftSources/FormbricksSDK/Networking/ClientAPI/Endpoints/Environment/GetEnvironmentRequest.swiftSources/FormbricksSDK/Networking/ClientAPI/Endpoints/User/PostUserRequest.swiftSources/FormbricksSDK/Networking/ClientAPI/Endpoints/Workspace/GetWorkspaceRequest.swiftSources/FormbricksSDK/Networking/Service/FormbricksService.swiftSources/FormbricksSDK/WebView/FormbricksViewModel.swiftTests/FormbricksSDKTests/FormbricksSDKTests.swiftTests/FormbricksSDKTests/FormbricksWorkspaceTests.swiftTests/FormbricksSDKTests/MockFormbricksService/MockFormbricksService.swiftTests/FormbricksSDKTests/Networking/APIClientTests.swiftTests/FormbricksSDKTests/Networking/ClientAPIEndpointsTests.swift
💤 Files with no reviewable changes (4)
- Sources/FormbricksSDK/Networking/ClientAPI/Endpoints/Environment/GetEnvironmentRequest.swift
- Sources/FormbricksSDK/Model/Environment/EnvironmentData.swift
- Sources/FormbricksSDK/Helpers/FormbricksEnvironment.swift
- Sources/FormbricksSDK/Model/Environment/EnvironmentResponseData.swift
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Adds the formbricks v5 changes into the main branch through the epic/v5