Skip to content

fix: webview scroll issue #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 4, 2025
Merged

fix: webview scroll issue #21

merged 2 commits into from
Jun 4, 2025

Conversation

pandeymangg
Copy link
Contributor

@pandeymangg pandeymangg commented Jun 4, 2025

This pull request introduces enhancements to the FormbricksSDK to improve survey handling and user experience. The most important changes include adding functionality to track response submission status and disabling scrolling in the survey web view.

Enhancements to survey handling:

Improvements to user experience:

Summary by CodeRabbit

  • New Features
    • Improved survey integration by enabling custom handling of survey response completion.
  • Style
    • Disabled scrolling within the embedded survey view for a more streamlined user experience.

Copy link

coderabbitai bot commented Jun 4, 2025

Walkthrough

The updates modify the embedded JavaScript in the HTML template of FormbricksViewModel by introducing a callback mechanism for response completion, and adjust the SurveyWebView to disable scrolling in its WKWebView component. No changes were made to public API surfaces or exported entities.

Changes

Files Change Summary
Sources/FormbricksSDK/WebView/FormbricksViewModel.swift Extended embedded JavaScript: added setResponseFinished variable, getSetIsResponseSendingFinished function, and passed it via surveyProps.
Sources/FormbricksSDK/WebView/SurveyWebView.swift Disabled WKWebView scrolling by setting webView.scrollView.isScrollEnabled = false in makeUIView.
✨ Finishing Touches
  • 📝 Generate Docstrings

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@pandeymangg pandeymangg requested review from Copilot and mattinannt June 4, 2025 09:29
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR enhances survey handling by tracking response submission status and improves user experience by disabling scrolling in the embedded survey web view.

  • Introduces a JS callback registration (getSetIsResponseSendingFinished) to notify when a response has finished sending.
  • Disables scrolling on the WKWebView to prevent unwanted scroll behavior.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
Sources/FormbricksSDK/WebView/SurveyWebView.swift Disabled the scroll view on the survey web view
Sources/FormbricksSDK/WebView/FormbricksViewModel.swift Added JS callback registration for response finish tracking
Comments suppressed due to low confidence (2)

Sources/FormbricksSDK/WebView/SurveyWebView.swift:33

  • [nitpick] Add a comment explaining why scrolling is disabled in the survey web view to clarify user experience intent and aid future maintainers.
webView.scrollView.isScrollEnabled = false

Sources/FormbricksSDK/WebView/FormbricksViewModel.swift:56

  • [nitpick] The function name getSetIsResponseSendingFinished is confusing as it registers a callback. Consider renaming it to onResponseSendingFinished or registerResponseFinishedCallback to make its purpose clearer.
function getSetIsResponseSendingFinished(callback) {

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
Sources/FormbricksSDK/WebView/FormbricksViewModel.swift (1)

55-58: Implementation looks good, consider improving function naming.

The callback mechanism for tracking response submission status is correctly implemented. However, the function name getSetIsResponseSendingFinished is quite verbose and unclear about its purpose.

Consider renaming for better clarity:

-                let setResponseFinished = null;
-                function getSetIsResponseSendingFinished(callback) {
-                    setResponseFinished = callback;
-                }
+                let setResponseFinished = null;
+                function setResponseFinishedCallback(callback) {
+                    setResponseFinished = callback;
+                }

And update the corresponding reference:

-                        getSetIsResponseSendingFinished,
+                        setResponseFinishedCallback,
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ba4559b and b191b8c.

📒 Files selected for processing (2)
  • Sources/FormbricksSDK/WebView/FormbricksViewModel.swift (1 hunks)
  • Sources/FormbricksSDK/WebView/SurveyWebView.swift (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build-and-analyze
🔇 Additional comments (2)
Sources/FormbricksSDK/WebView/SurveyWebView.swift (1)

33-33: LGTM! Correctly disables webview scrolling.

This change appropriately disables scrolling in the survey webview, which aligns with the PR objective to fix the webview scroll issue and improve user experience during survey interaction.

Sources/FormbricksSDK/WebView/FormbricksViewModel.swift (1)

64-64: Correctly integrates the callback into survey props.

The addition of the callback function to the surveyProps object properly exposes the response tracking functionality to the external survey library.

@pandeymangg pandeymangg requested a review from Dhruwang June 4, 2025 09:37
Copy link

sonarqubecloud bot commented Jun 4, 2025

Copy link
Member

@Dhruwang Dhruwang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works well 🚀✅

Screen.Recording.2025-06-04.at.5.11.09.PM.mp4

@pandeymangg pandeymangg added this pull request to the merge queue Jun 4, 2025
Merged via the queue into main with commit b6e80d8 Jun 4, 2025
4 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Jun 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants