JhumanJ / OpnForm

Beautiful Open-Source Form Builder
https://opnform.com
GNU Affero General Public License v3.0
2.26k stars 303 forks source link

utm tracking in db #574

Closed madassdev closed 2 months ago

madassdev commented 2 months ago

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 2 months ago

[!NOTE] Currently processing new changes in this PR. This may take a few minutes, please wait...

Commits Files that changed from the base of the PR and between e1ba784692cb9990a6295002418833b848b1def0 and 1952301ec05333fd886784ea65bf0876764c9260.
Files selected for processing (1) * api/app/Http/Controllers/Auth/RegisterController.php (2 hunks)
 ___________________________________________________________________________________________________________________________
< If programmers were electricians, parallel programmers would be bomb disposal experts. Both cut wires. - Bartosz Milewski >
 ---------------------------------------------------------------------------------------------------------------------------
  \
   \   \
        \ /\
        ( )
      .( o ).

Walkthrough

The changes involve the introduction of a new field, utm_data, across multiple components in the application. This field captures UTM parameters during user registration and OAuth callback processes, enhancing the tracking of user origins and marketing effectiveness. The modifications span the OAuth and Register controllers, the User model, a migration script for the database, and several client-side components, including Vue files and configuration settings for Nuxt.js.

Changes

Files Change Summary
api/app/Http/Controllers/Auth/OAuthController.php Added utm_data field to findOrCreateUser method for capturing UTM parameters.
api/app/Http/Controllers/Auth/RegisterController.php Introduced utm_data as an optional field in validation and user creation processes.
api/app/Models/User.php Added utm_data to $fillable and defined it as an array in casts.
api/database/migrations/2024_09_18_091846_add_utm_data_to_users_table.php Created migration to add utm_data column as JSON type in the users table.
client/components/pages/auth/components/RegisterForm.vue Enhanced registration form to include utm_data from the Nuxt context.
client/nuxt.config.ts Integrated nuxt-utm module for handling UTM parameters in the application.
client/package.json Added nuxt-utm dependency to manage UTM parameters.
client/pages/oauth/callback.vue Modified OAuth callback to include utm_data in the opnFetch function call.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant RegisterForm
    participant RegisterController
    participant UserModel
    participant Database

    User->>RegisterForm: Fill out registration form
    RegisterForm->>RegisterController: Submit form with utm_data
    RegisterController->>UserModel: Create user with utm_data
    UserModel->>Database: Store user data with utm_data
sequenceDiagram
    participant User
    participant OAuthCallback
    participant OAuthController

    User->>OAuthCallback: Initiate OAuth flow
    OAuthCallback->>OAuthController: Handle callback with utm_data
    OAuthController->>ExternalService: Send request with utm_data

Poem

🐇 In fields of code where rabbits play,
New data hops in, brightening the day.
UTM whispers, tracking our trails,
Marketing magic in digital gales.
With every click, our stories unfold,
In the world of data, adventures bold! 🌼

[!TIP]

You can generate walkthrough in a markdown collapsible section to save space. Enable the `reviews.collapse_walkthrough` setting in your project's settings in CodeRabbit to generate walkthrough in a markdown collapsible section.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: -- `I pushed a fix in commit , please review it.` -- `Generate unit testing code for this file.` - `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 generate unit testing code for this file.` -- `@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 generate interesting stats about this repository and render them as a table.` -- `@coderabbitai read src/utils.ts and generate unit testing code.` -- `@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.` 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.