Feat eazy sms #5393

sr-26 · 2024-04-10T15:46:27Z

What change does this PR introduce?

Closes #5195

Why was this change needed?

New Sms Provider.

Other information (Screenshots)

netlify · 2024-04-10T15:46:32Z

👷 Deploy request for dev-web-novu pending review.

Visit the deploys page to approve it

Name	Link
🔨 Latest commit	`6b1003a`

netlify · 2024-04-10T15:46:45Z

✅ Deploy Preview for novu-design ready!

Name	Link
🔨 Latest commit	`6b1003a`
🔍 Latest deploy log	https://app.netlify.com/sites/novu-design/deploys/6626983b6098980008b6dc9c
😎 Deploy Preview	https://deploy-preview-5393--novu-design.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

ainouzgali · 2024-04-11T09:05:11Z

@coderabbitai review

coderabbitai · 2024-04-11T09:05:27Z

Walkthrough

This update introduces the EazySMS provider to the Novu system for SMS notifications. It includes backend schema updates, new DTOs, provider configurations, and handler implementations. The integration ensures that Novu can utilize EazySMS to send SMS messages, aligning with community requests for more diverse SMS provider options.

Changes

File Path	Change Summary
`.../dtos/credentials.dto.ts`	Added `channelId` to `CredentialsDto`
`.../integration/integration.schema.ts`	Added `channelId` to `integrationSchema`
`.../channels/sms.ts`, `.../provider-credentials.ts`	Added EazySMS configuration details
`.../provider.enum.ts`, `.../credential.interface.ts`	Updated enums and interfaces for new SMS provider
`.../package.json`, `.../eazy-sms.handler.ts`	Added dependency and handler for EazySMS
`.../sms.factory.ts`, `.../index.ts`	Integrated EazySMS handler into SMS factory
`providers/eazy-sms/...`	Introduced EazySMS provider library and configurations

Assessment against linked issues

Objective	Addressed	Explanation
Add a new provider for SMS called 'Eazy' (#5195)	✅
Novu supporting Eazy for SMS notifications (#5195)	✅

Possibly related issues

NV-3507: This issue is essentially the same as 🚀 Feature: Add a new provider for sms (Eazy) #5195, which this PR addresses by adding Eazy as an SMS provider.
[NV-2942] 🚀 Feature: Add SMS.to sms provider #4339: While this issue requests adding a different SMS provider (SMS.to), the framework established in this PR for adding new providers could simplify the addition of SMS.to.
[NV-2955] 🚀 Feature: Add Signal SMS Provider #4372: Similar to [NV-2942] 🚀 Feature: Add SMS.to sms provider #4339, the infrastructure for adding new SMS providers like Signal could benefit from the changes made in this PR.
DVRL-156: Documentation on integrating SMS providers, like the EazySMS documentation provided here, aligns with the objectives of improving documentation for generic SMS provider integration.
NV-2945: This issue about adding Bulksms as a provider could leverage the new provider integration pattern established in this PR.

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>.
- 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 show all the console.log statements in this repository.
- @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.

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 as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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: 3

providers/eazy-sms/README.md

coderabbitai · 2024-04-11T09:10:14Z

providers/eazy-sms/src/lib/eazy-sms.provider.spec.ts

+import { EazySmsProvider } from './eazy-sms.provider';
+
+const mockConfig = {
+  apiKey: 'test-key',
+  channelId: '[email protected]',
+};
+
+const mockSMSMessage = {
+  to: '1234567890',
+  content: 'sms content',
+};
+
+test('should trigger eazy-sms library correctly', async () => {
+  const smsProvider = new EazySmsProvider(mockConfig);
+  const spy = jest
+    .spyOn(smsProvider, 'sendMessage')
+    .mockImplementation(async () => {
+      return {
+        id: '2574a339-86ff',
+        date: new Date().toISOString(),
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      } as any;
+    });
+
+  await smsProvider.sendMessage(mockSMSMessage);
+  expect(spy).toHaveBeenCalled();
+  expect(spy).toHaveBeenCalledWith({
+    content: 'sms content',
+    to: '1234567890',
+  });
+});


The test for the EazySmsProvider is well-structured and covers the basic functionality of the sendMessage method. The use of Jest for spying and mocking the method ensures that the test is isolated and reliable. However, consider adding more test cases to cover error handling and edge cases to ensure robustness.

Would you like me to help in writing additional test cases for error scenarios and edge cases?

packages/application-generic/package.json

fix: readability Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

BiswaViraj

Please add the provider to this file

sr-26 · 2024-04-16T15:21:10Z

Please add the provider to this file

Added @BiswaViraj.

BiswaViraj

@sr-26 Can you please fix the pipeline errors?
You'll need to add the failing words in the .cspell file
and also need to regenerate the pnpm.lock file by running pnpm i

sr-26 · 2024-04-22T17:11:33Z

Added @BiswaViraj, the package.lock has significant version changes. Is this okay?

BiswaViraj · 2024-04-22T18:50:21Z

Added @BiswaViraj, the package.lock has significant version changes. Is this okay?

Yes, it is fine

sr-26 added 3 commits April 10, 2024 20:24

feat: eazy sms provider

7bf0ecd

feat: eazy sms provider

f149ac3

feat: eazy sms provider

4c51f2f

github-actions bot added @novu/api @novu/web @novu/dal @novu/shared providers labels Apr 10, 2024

github-actions bot added the community label Apr 10, 2024

ainouzgali requested review from a team, rifont and antonjoel82 and removed request for a team April 11, 2024 09:04

coderabbitai bot reviewed Apr 11, 2024

View reviewed changes

sr-26 and others added 2 commits April 11, 2024 19:36

Update providers/eazy-sms/README.md

1ee283b

fix: readability Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

feat: eazy sms provider

292be87

BiswaViraj requested changes Apr 15, 2024

View reviewed changes

fix: added eazy sms in sort list

c84851a

sr-26 requested a review from BiswaViraj April 16, 2024 15:20

BiswaViraj approved these changes Apr 17, 2024

View reviewed changes

BiswaViraj added 2 commits April 17, 2024 23:16

Merge branch 'next' into feat-eazy-sms

1fab824

Merge branch 'next' into feat-eazy-sms

e4e6fa1

BiswaViraj requested changes Apr 22, 2024

View reviewed changes

fix: added eazy in cspell

6b1003a

BiswaViraj approved these changes Apr 22, 2024

View reviewed changes

BiswaViraj merged commit 26f5bfb into novuhq:next Apr 22, 2024
30 of 33 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat eazy sms #5393

Feat eazy sms #5393

sr-26 commented Apr 10, 2024

netlify bot commented Apr 10, 2024 •

edited

Loading

netlify bot commented Apr 10, 2024 •

edited

Loading

ainouzgali commented Apr 11, 2024

coderabbitai bot commented Apr 11, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot Apr 11, 2024

BiswaViraj left a comment

sr-26 commented Apr 16, 2024

BiswaViraj left a comment

sr-26 commented Apr 22, 2024

BiswaViraj commented Apr 22, 2024

Feat eazy sms #5393

Feat eazy sms #5393

Conversation

sr-26 commented Apr 10, 2024

What change does this PR introduce?

Why was this change needed?

Other information (Screenshots)

netlify bot commented Apr 10, 2024 • edited Loading

👷 Deploy request for dev-web-novu pending review.

netlify bot commented Apr 10, 2024 • edited Loading

✅ Deploy Preview for novu-design ready!

ainouzgali commented Apr 11, 2024

coderabbitai bot commented Apr 11, 2024 • edited Loading

Walkthrough

Changes

Assessment against linked issues

Possibly related issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot Apr 11, 2024

Choose a reason for hiding this comment

BiswaViraj left a comment

Choose a reason for hiding this comment

sr-26 commented Apr 16, 2024

BiswaViraj left a comment

Choose a reason for hiding this comment

sr-26 commented Apr 22, 2024

BiswaViraj commented Apr 22, 2024

netlify bot commented Apr 10, 2024 •

edited

Loading

netlify bot commented Apr 10, 2024 •

edited

Loading

coderabbitai bot commented Apr 11, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)