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

fix(api): Add missing content type header for Campaign Monitor email signup #16936

Merged

Conversation

RunarVestmann
Copy link
Member

@RunarVestmann RunarVestmann commented Nov 19, 2024

Add missing content type header for Campaign Monitor email signup

Summary by CodeRabbit

  • New Features

    • Enhanced the mailing list subscription process by adding a Content-Type header to ensure proper API request formatting.
  • Bug Fixes

    • Maintained existing error handling for subscription responses, ensuring consistent user feedback.

@RunarVestmann RunarVestmann added the deprecated:automerge (Disabled) Merge this PR as soon as all checks pass label Nov 19, 2024
@RunarVestmann RunarVestmann requested a review from a team as a code owner November 19, 2024 13:48
Copy link
Contributor

coderabbitai bot commented Nov 19, 2024

Walkthrough

The pull request modifies the CampaignMonitorSignupService class in the campaignMonitor.service.ts file. An additional Content-Type header with the value application/json has been included in the Axios POST request within the subscribeToMailingList method. This change ensures that the content type is explicitly set for the API call when subscribing to the mailing list, while the error handling mechanism remains unchanged.

Changes

File Change Summary
libs/api/domains/email-signup/src/lib/services/campaignMonitor/campaignMonitor.service.ts Added Content-Type: application/json header to the Axios POST request in subscribeToMailingList method.

Possibly related PRs

  • feat(web): Add campaign monitor email signup service #16240: The changes in this PR relate to the integration of the CampaignMonitorSignupService, which is directly connected to the modifications made in the campaignMonitor.service.ts file, specifically regarding the handling of email subscriptions through the Campaign Monitor API.

Suggested reviewers

  • svanaeinars
  • baering

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
🪧 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 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.

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
Contributor

@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

🧹 Outside diff range and nitpick comments (2)
libs/api/domains/email-signup/src/lib/services/campaignMonitor/campaignMonitor.service.ts (2)

38-43: Consider adding request validation

The current implementation could benefit from additional validation:

  1. Verify that the URL is not empty before making the request
  2. Ensure the payload is JSON-serializable

Consider adding these checks:

 async subscribeToMailingList(
   emailSignupModel: EmailSignup,
   inputFields: EmailSignupInput['inputFields'],
 ) {
   const url = (emailSignupModel.configuration?.signupUrl as string) ?? ''
+  if (!url) {
+    throw new Error('Campaign Monitor signup URL is required')
+  }
   
   // ... existing code ...
   
   const obj = Object.fromEntries(map)
+  try {
+    JSON.stringify(obj) // Validate JSON serialization
+  } catch (e) {
+    throw new Error('Invalid payload for Campaign Monitor API')
+  }
   
   return axios

Line range hint 44-52: Enhance error handling and response processing

The current error handling could be improved in several ways:

  1. The success check logic response?.data?.result === 'error' ? false : true is unnecessarily complex
  2. Generic error handling loses valuable debug information
  3. Missing error logging for monitoring purposes

Consider this improved implementation:

     })
     .then((response) => {
+      const isError = response?.data?.result === 'error'
+      if (isError) {
+        console.error('Campaign Monitor subscription failed:', response.data)
+      }
       return {
-        subscribed: response?.data?.result === 'error' ? false : true,
+        subscribed: !isError,
       }
     })
-    .catch(() => {
+    .catch((error) => {
+      console.error('Campaign Monitor API error:', error.message)
       return { subscribed: false }
     })
🧰 Tools
🪛 Biome

[error] 46-46: Unnecessary use of boolean literals in conditional expression.

Simplify your code by directly assigning the result without using a ternary operator.
If your goal is negation, you may use the logical NOT (!) or double NOT (!!) operator for clearer and concise code.
Check for more details about NOT operator.
Unsafe fix: Remove the conditional expression with

(lint/complexity/noUselessTernary)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 025f1f8 and 30a5e75.

📒 Files selected for processing (1)
  • libs/api/domains/email-signup/src/lib/services/campaignMonitor/campaignMonitor.service.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
libs/api/domains/email-signup/src/lib/services/campaignMonitor/campaignMonitor.service.ts (1)

Pattern libs/**/*: "Confirm that the code adheres to the following:

  • Reusability of components and hooks across different NextJS apps.
  • TypeScript usage for defining props and exporting types.
  • Effective tree-shaking and bundling practices."
🔇 Additional comments (1)
libs/api/domains/email-signup/src/lib/services/campaignMonitor/campaignMonitor.service.ts (1)

38-43: LGTM: Content-Type header addition is correct

The addition of the 'Content-Type: application/json' header is appropriate for the JSON payload being sent.

Copy link

codecov bot commented Nov 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.43%. Comparing base (025f1f8) to head (30a5e75).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main   #16936   +/-   ##
=======================================
  Coverage   36.43%   36.43%           
=======================================
  Files        6904     6904           
  Lines      144701   144701           
  Branches    41345    41345           
=======================================
  Hits        52723    52723           
  Misses      91978    91978           
Flag Coverage Δ
api 3.34% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 025f1f8...30a5e75. Read the comment docs.

---- 🚨 Try these New Features:

@datadog-island-is
Copy link

Datadog Report

Branch report: fix/api-campaign-monitor-email-signup-content-type-header
Commit report: 78b7552
Test service: api

✅ 0 Failed, 4 Passed, 0 Skipped, 2.7s Total Time
➡️ Test Sessions change in coverage: 1 no change

@kodiakhq kodiakhq bot merged commit ff67649 into main Nov 19, 2024
42 of 51 checks passed
@kodiakhq kodiakhq bot deleted the fix/api-campaign-monitor-email-signup-content-type-header branch November 19, 2024 14:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecated:automerge (Disabled) Merge this PR as soon as all checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants