Make `testInboxID` optional param #70

narekhovhannisyan · 2025-07-01T13:58:13Z

Motivation

Unblock using the testing api without testInboxId.

Summary by CodeRabbit

Bug Fixes
- Improved error handling when sending mail in sandbox mode, ensuring clearer messages if required information is missing.
Documentation
- Added documentation for the templates feature.

…date test inbox ID only in sandbox mode

coderabbitai · 2025-07-01T13:58:20Z

Walkthrough

The changes introduce a private validation method in MailtrapClient to ensure testInboxId is present in sandbox mode, updating send, batchSend, and the testing getter to use this method. URL construction now conditionally appends testInboxId only when sandbox mode is active and the ID is provided. Corresponding tests were added and redundant ones removed.

Changes

File	Change Summary
src/lib/MailtrapClient.ts	Added private `validateTestInboxIdPresence()` method; reordered error constants; refactored `testing` getter; updated `send` and `batchSend` to validate `testInboxId` and conditionally append it to URLs; added JSDoc for `templates` getter.
src/tests/lib/mailtrap-client.test.ts	Added tests verifying `send()` and `batchSend()` throw error if `testInboxId` missing in sandbox mode; replaced redundant `testing` getter test; reordered error constants; added test for `testing` getter returning `TestingAPI` when `accountId` present without `testInboxId`.

Possibly related PRs

Restructure SDK #51: The main PR and this one both modify MailtrapClient error handling and sandbox mode validation, showing a direct connection in client send logic and error management.
Batch Sending Api #63: Introduced the batchSend method and related tests; this PR builds on that by adding sandbox validation for batchSend and send.

Suggested reviewers

VladimirTaytor
mklocek

Poem

A hop and a skip through the code we go,
With errors in order, and checks in tow.
Now sandbox is safe, test inbox in sight,
URLs are tidy, everything’s right!
🐇✨

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d7f7042 and 1e10d77.

📒 Files selected for processing (1)

src/__tests__/lib/mailtrap-client.test.ts (4 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

src/tests/lib/mailtrap-client.test.ts

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

coderabbitai

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6d5ba68 and 0a2d134.

📒 Files selected for processing (1)

src/lib/MailtrapClient.ts (3 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

src/lib/MailtrapClient.ts (1)

src/lib/MailtrapError.ts (1)

MailtrapError (1-1)

🔇 Additional comments (4)

src/lib/MailtrapClient.ts (4)

35-35: LGTM: Minor reordering of constants.

The reordering of error constants doesn't affect functionality but appears to be a stylistic preference.

131-133: LGTM: Improved documentation.

Good addition of JSDoc comment for consistency with other getter methods.

167-169: LGTM: Appropriate validation for sandbox mode.

The validation correctly enforces that testInboxId is required when in sandbox mode, aligning with the PR objective of making it optional for other use cases.

172-172: LGTM: Correct URL construction logic.

The updated URL construction appropriately includes testInboxId only when both sandbox mode is active and testInboxId is present.

src/lib/MailtrapClient.ts

…n testInboxId is missing in sandbox mode

… improved code clarity

…own when testInboxId is missing in sandbox mode during batch sending

vittorius · 2025-07-01T15:43:49Z

src/__tests__/lib/mailtrap-client.test.ts

@@ -664,20 +706,6 @@ describe("lib/mailtrap-client: ", () => {
  });

  describe("get testing(): ", () => {
-    it("rejects with Mailtrap error, when `testInboxId` is missing.", () => {


It would also be nice to have a test that the absence of testInboxId doesn't raise an error when client.testing is called.

And remove testInboxId from all client setup cases where it's not needed anymore (like here).

…n accountId is provided without testInboxId

refactor: rearrange error constants and update testing getter to vali…

0a2d134

…date test inbox ID only in sandbox mode

coderabbitai bot reviewed Jul 1, 2025

View reviewed changes

src/lib/MailtrapClient.ts Outdated Show resolved Hide resolved

narekhovhannisyan added 3 commits July 1, 2025 18:17

test: add unit test for MailtrapClient to validate error handling whe…

6a534cd

…n testInboxId is missing in sandbox mode

refactor: extract test inbox ID validation into a separate method for…

b72e941

… improved code clarity

test: add unit test for MailtrapClient to ensure MailtrapError is thr…

d7f7042

…own when testInboxId is missing in sandbox mode during batch sending

narekhovhannisyan requested review from vittorius and mklocek July 1, 2025 15:14

narekhovhannisyan self-assigned this Jul 1, 2025

vittorius reviewed Jul 1, 2025

View reviewed changes

mklocek approved these changes Jul 1, 2025

View reviewed changes

test: add unit test for MailtrapClient to verify correct behavior whe…

1e10d77

…n accountId is provided without testInboxId

narekhovhannisyan requested a review from vittorius July 2, 2025 06:17

vittorius approved these changes Jul 2, 2025

View reviewed changes

narekhovhannisyan merged commit c5f1d30 into main Jul 2, 2025
4 checks passed

narekhovhannisyan deleted the optional-test-inbox branch July 2, 2025 14:17

narekhovhannisyan mentioned this pull request Jul 2, 2025

Unnecessary testInboxId validation in testing #69

Closed

vittorius mentioned this pull request Jul 8, 2025

Version 4.2.0 #76

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Make `testInboxID` optional param #70

Make `testInboxID` optional param #70

Uh oh!

narekhovhannisyan commented Jul 1, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jul 1, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

vittorius Jul 1, 2025

Uh oh!

vittorius Jul 1, 2025

Uh oh!

Uh oh!

Uh oh!

Make testInboxID optional param #70

Make testInboxID optional param #70

Uh oh!

Conversation

narekhovhannisyan commented Jul 1, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jul 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related PRs

Suggested reviewers

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

vittorius Jul 1, 2025

Choose a reason for hiding this comment

Uh oh!

vittorius Jul 1, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Make `testInboxID` optional param #70

Make `testInboxID` optional param #70

narekhovhannisyan commented Jul 1, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 1, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)