Skip to content
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

chore: add connection mode in schema json for moengage #1929

Merged
merged 2 commits into from
Mar 12, 2025

Conversation

maheshkutty
Copy link
Collaborator

@maheshkutty maheshkutty commented Mar 11, 2025

What are the changes introduced in this PR?

This PR addresses an error in the web app: must NOT have additional properties.
Upon investigation, we discovered that schema validation for connectionMode was missing, so we’ve added the necessary validation rules.

What is the related Linear task?

Resolves INT-3279

Please explain the objectives of your changes below

Put down any required details on the broader aspect of your changes. If there are any dependent changes, mandatorily mention them here

Any changes to existing capabilities/behaviour, mention the reason & what are the changes ?

N/A

Any new dependencies introduced with this change?

N/A

Any new checks got introduced or modified in test suites. Please explain the changes.

N/A


Developer checklist

  • My code follows the style guidelines of this project

  • No breaking changes are being introduced.

  • All related docs linked with the PR?

  • All changes manually tested?

  • Any documentation changes needed with this change?

  • I have executed schemaGenerator tests and updated schema if needed

  • Are sensitive fields marked as secret in definition config?

  • My test cases and placeholders use only masked/sample values for sensitive fields

  • Is the PR limited to 10 file changes & one task?

Reviewer checklist

  • Is the type of change in the PR title appropriate as per the changes?

  • Verified that there are no credentials or confidential data exposed with the changes.

Summary by CodeRabbit

  • New Features
    • Introduced enhanced connection configuration options that offer more tailored integration setups across various platforms. Users can now benefit from distinct connectivity choices, bolstering reliability and ensuring integration options are aligned with platform-specific capabilities.
    • Updated schema to allow additional properties, enhancing flexibility in configuration options.

Copy link

coderabbitai bot commented Mar 11, 2025

Walkthrough

The change modifies the configSchema object in the JSON schema for the MoEngage destination by updating the additionalProperties attribute. The previous setting of "additionalProperties": false has been changed to "additionalProperties": true, allowing for additional properties to be included in the schema. This adjustment alters the validation behavior, enabling acceptance of properties not explicitly defined within the properties section.

Changes

File Change Summary
src/configurations/destinations/moengage/schema.json Updated additionalProperties from false to true, allowing additional properties in the schema.

Possibly related PRs

Suggested reviewers

  • lvrach
  • am6010
  • ssbeefeater
  • debanjan97
  • cisse21
  • 1abhishekpandey
  • sandeepdsvs
  • krishna2020
  • ItsSudip

Poem

Hop, hop, hop in the schema's embrace,
Additional properties now find their place.
With a flick of the code, new paths we explore,
A world of options opens, who could ask for more?
A bunny's delight in this coding race!
🐇✨


🪧 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.
    • 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 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 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 generate docstrings to generate docstrings for 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.

Copy link

codecov bot commented Mar 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (d0d0296) to head (8ae2129).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@            Coverage Diff            @@
##           develop     #1929   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines           53        53           
  Branches         7         7           
=========================================
  Hits            53        53           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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)
src/configurations/destinations/moengage/schema.json (1)

25-73: Review of New "connectionMode" Property Structure
The addition of the connectionMode property is clear and well-structured. It correctly defines an object with sub-properties for different platforms and explicitly restricts allowed string values via enum. This adheres to the design goal of constraining connection modes per platform.

A minor suggestion:
To ensure that no unexpected properties are added within connectionMode, consider adding "additionalProperties": false inside its definition. This would tighten the schema validation in line with the overall schema’s intent (using "additionalProperties": false at the root level).

Example diff suggestion:

"connectionMode": {
  "type": "object",
+ "additionalProperties": false,
  "properties": {
    "web": {
      "type": "string",
      "enum": ["cloud", "device"]
    },
    "android": {
      "type": "string",
      "enum": ["cloud", "device"]
    },
    "ios": {
      "type": "string",
      "enum": ["cloud", "device"]
    },
    "reactnative": {
      "type": "string",
      "enum": ["cloud", "device"]
    },
    "unity": {
      "type": "string",
      "enum": ["cloud"]
    },
    "amp": {
      "type": "string",
      "enum": ["cloud"]
    },
    "flutter": {
      "type": "string",
      "enum": ["cloud"]
    },
    "cordova": {
      "type": "string",
      "enum": ["cloud"]
    },
    "shopify": {
      "type": "string",
      "enum": ["cloud"]
    },
    "cloud": {
      "type": "string",
      "enum": ["cloud"]
    },
    "warehouse": {
      "type": "string",
      "enum": ["cloud"]
    }
  }
}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d0d0296 and df73fa8.

📒 Files selected for processing (1)
  • src/configurations/destinations/moengage/schema.json (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (java-kotlin)

krishna2020
krishna2020 previously approved these changes Mar 11, 2025
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)
src/configurations/destinations/moengage/schema.json (1)

912-913: Relaxed Top-Level Schema Validation

Changing "additionalProperties" from false to true at the top level of the configuration schema addresses the error by allowing properties not explicitly defined. This resolves the must NOT have additional properties error. However, ensure that this intentional relaxation aligns with your overall design requirements and does not permit unexpected data to be added unintentionally.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between df73fa8 and 8ae2129.

📒 Files selected for processing (2)
  • src/configurations/destinations/moengage/schema.json (1 hunks)
  • src/configurations/destinations/moengage/schema.json (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/configurations/destinations/moengage/schema.json
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (java-kotlin)
🔇 Additional comments (1)
src/configurations/destinations/moengage/schema.json (1)

24-71: ConnectionMode Schema Addition & Migration Considerations

The new "connectionMode" property provides structured validations for various platforms (e.g., "web", "android", "ios", etc.) with clearly defined enumerated values. This addition should help in validating the connection mode input. Consider whether you might want stricter control on extra keys by adding an "additionalProperties": false within this object if only the specified keys should be accepted.
Also, note the earlier reviewer comment () regarding running connection mode migrations for the legacy form builder. Please verify that these changes have been thoroughly evaluated against older implementations.

@maheshkutty maheshkutty requested a review from krishna2020 March 11, 2025 12:22
@maheshkutty maheshkutty merged commit 2523ca1 into develop Mar 12, 2025
15 checks passed
@maheshkutty maheshkutty deleted the fix.moengage_config branch March 12, 2025 03:47
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.

3 participants