feat(providers): Add Whatsapp business as provider #5232

vitoorgomes · 2024-02-23T21:56:38Z

What change does this PR introduce?

This PR adds the option to use WhatsApp Business as a provider. The requested issue is #1019.

Although there is already a PR opened, I decide to create this fresh one for two main reasons: firstly because I don't think the OP it's working anymore on that based on replies not being answered and secondly because it only implements sending message as a template, where the Meta API allows to send it as a simple text as well, I wanted to give a little more customization to the user.

There some improvements that could be done here, but they aren't breaking changes, so I think it's worth to open this now, like allowing some other configurations like preview_url and other fields available in the Meta's API.

There is also the #2689 issue, while it's valid, it would be nice to have this provider as a SMS now, and port this later when Chat Providers are able to receive more data following this issue thread updates.

Why was this change needed?

This Closes #1019 and Closes #4128

Other information (Screenshots)

netlify · 2024-02-23T21:56:41Z

✅ Deploy Preview for dev-web-novu ready!

Name	Link
🔨 Latest commit	`86d79e6`
🔍 Latest deploy log	https://app.netlify.com/sites/dev-web-novu/deploys/66316b659506260008267f07
😎 Deploy Preview	https://deploy-preview-5232--dev-web-novu.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.

Cliftonz · 2024-03-04T16:01:15Z

@vitoorgomes Thanks for bringing this to our attention, we will take a look at it as soon as we can!

Cliftonz · 2024-03-04T16:02:22Z

@vitoorgomes What are the other improvements you think could be done?

providers/whatsapp-business/src/lib/whatsapp-business.provider.spec.ts

vitoorgomes · 2024-03-07T16:47:52Z

@vitoorgomes What are the other improvements you think could be done?

Meta's API docs have lots of options to send a message, with media, location and so on, but since they don't affect the usability as of right now, I've decided to not try to implement it, because it would need a lot effort to be able to define each property but could be done in the future as devs request

Cliftonz

@vitoorgomes There is two things you need to fix here.

The hard coded authentication header
adding the whatsapp names to the cspell list

vitoorgomes · 2024-03-15T20:44:46Z

@vitoorgomes There is two things you need to fix here.

The hard coded authentication header

adding the whatsapp names to the cspell list

done

netlify · 2024-04-30T15:03:11Z

✅ Deploy Preview for novu-design ready!

Name	Link
🔨 Latest commit	`86d79e6`
🔍 Latest deploy log	https://app.netlify.com/sites/novu-design/deploys/66316b659304f10008d64b08
😎 Deploy Preview	https://deploy-preview-5232--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.

providers/whatsapp-business/src/lib/whatsapp-business.provider.spec.ts

antonjoel82

Thanks for the hard work here, Vitor! Added a couple comments regarding CI and to ensure we have good handling around phone numbers.

antonjoel82 · 2024-02-28T00:06:17Z

providers/whatsapp-business/src/consts/whatsapp-business.enum.ts

Please consider a more semantic name for the file: whatsapp-message-type.ts

antonjoel82 · 2024-02-28T00:08:25Z

providers/whatsapp-business/src/lib/whatsapp-business.provider.ts

+  channelType = ChannelTypeEnum.SMS as ChannelTypeEnum.SMS;
+
+  private readonly axiosClient: AxiosInstance;
+  private readonly baseUrl = 'https://graph.facebook.com/v18.0/';


❔ question: Is this correct?‏

Yep. tested it out.

providers/whatsapp-business/src/types/whatsapp-business.types.ts

antonjoel82 · 2024-04-30T16:36:28Z

libs/shared/src/consts/providers/credentials/provider-credentials.ts

@@ -1120,3 +1120,21 @@ export const eazySmsConfig: IConfigCredentials[] = [
    description: 'Your SMS Channel Id',
  },
 ];
+
+export const whatsaAppBusinessConfig: IConfigCredentials[] = [


☑ chore: Please correct this typo‏

Suggested change

export const whatsaAppBusinessConfig: IConfigCredentials[] = [

export const whatsAppBusinessConfig: IConfigCredentials[] = [

antonjoel82 · 2024-04-30T16:38:59Z

libs/shared/src/consts/providers/credentials/provider-credentials.ts

+  {
+    key: CredentialsKeyEnum.phoneNumberIdentification,
+    displayName: 'Phone Number Identification',
+    description: 'Your WhatsApp Business phone number identification',


❓ question: What are the phone number requirements for WhatsApp? Do they require a certain format?

☑ chore: ‏‏If there is a format required, please describe / define it here, and enforce it with pattern matching

This is provided in the WhatsApp interface, you can't really control it. The needs to copy paste this. I will add this to the doccs section of the whole process

libs/shared/src/consts/providers/provider.enum.ts

scopsy · 2024-04-30T20:01:47Z

apps/worker/src/app/workflow/usecases/send-message/send-message-chat.usecase.ts

+    chatChannels.push({
+      providerId: ChatProviderIdEnum.WhatsAppBusiness,
+      credentials: {
+        phoneNumber: phone,
+      },
+    });


I don't love this implementation, but until we refactor the whole "Chat" channel flow, this workaround is needed.

scopsy · 2024-04-30T20:02:21Z

apps/worker/src/app/workflow/usecases/send-message/send-message-chat.usecase.ts

    const channelSpecification = subscriberChannel.credentials?.channel;

-    if (!chatWebhookUrl) {
+    if (!chatWebhookUrl && integration.providerId !== ChatProviderIdEnum.WhatsAppBusiness) {


Those workaround will be handeled during a more thorough refactoring of the "Chat" Channel

scopsy · 2024-04-30T20:02:43Z

apps/worker/src/app/workflow/usecases/send-message/send-message-type.usecase.ts

@@ -26,6 +26,7 @@ export abstract class SendMessageType {
  ) {
    const errorString =
      stringifyObject(error?.response?.body) ||
+      stringifyObject(error?.response?.data) ||


This needed to gracefully map axios errors

scopsy · 2024-04-30T20:03:07Z

packages/node/src/lib/events/events.spec.ts

+          headers: {
+            'X-Novu-Custom-Header': 'test-data',
+          },


This fixes a failing test on next branch

SokratisVidros

Nice!

I've added some comments regarding code structure aiming to isolate the necessary patch for now in dedicated functions that will be easier to refactor in the future.

apps/worker/src/app/workflow/usecases/send-message/send-message-chat.usecase.ts

providers/whatsapp-business/src/types/whatsapp-business.types.ts

SokratisVidros · 2024-04-30T20:53:43Z

apps/worker/src/app/workflow/usecases/send-message/send-message-chat.usecase.ts

@@ -239,8 +267,8 @@ export class SendMessageChat extends SendMessageBase {
      })
    );

-    if (chatWebhookUrl && integration) {
-      await this.sendMessage(chatWebhookUrl, integration, content, message, command, channelSpecification);
+    if ((chatWebhookUrl && integration) || (phoneNumber && integration)) {


In an attempt to start defining a naive strategy pattern until we do the proper refactoring, I want to suggest introducing two private methods:

sendChannelMessageViaWebhookUrl

sendChannelMessageViaAPIKey

That way, we will ensure that messages created in Mongo have only defined fields per use case and have fewer and shorter if conditions across the file.

The current sendError can be implemented inside the above two private methods separately for now.

vitoorgomes · 2024-04-30T22:22:25Z

thanks a lot for helping out @scopsy I didn't saw the last request changes notification, totally my bad

really happy that this was merged 🥳🤝

scopsy · 2024-04-30T22:22:41Z

Thank you @vitoorgomes so much for your contribution ❤️ and sorry it took a while to merge 🙏

github-actions bot added @novu/api @novu/web @novu/dal @novu/shared providers community labels Feb 23, 2024

github-advanced-security bot found potential problems Mar 4, 2024

View reviewed changes

providers/whatsapp-business/src/lib/whatsapp-business.provider.spec.ts Fixed Show fixed Hide fixed

providers/whatsapp-business/src/lib/whatsapp-business.provider.spec.ts Fixed Show fixed Hide fixed

Cliftonz requested changes Mar 8, 2024

View reviewed changes

feat: whatsapp business provider

4f0343b

vitoorgomes force-pushed the feat/whatsapp-business-provider branch from 017f3d0 to 4f0343b Compare March 15, 2024 20:43

github-actions bot added the stale Pull Request that needs to be reviewed label Mar 29, 2024

chore: merge next branch

1b14656

vitoorgomes requested a review from a team as a code owner April 30, 2024 15:02

github-advanced-security bot found potential problems Apr 30, 2024

View reviewed changes

providers/whatsapp-business/src/lib/whatsapp-business.provider.spec.ts Dismissed Show dismissed Hide dismissed

antonjoel82 reviewed Apr 30, 2024

View reviewed changes

fix: spelling error

22ee165

github-actions bot added the @novu/worker label Apr 30, 2024

scopsy added 5 commits April 30, 2024 20:20

fix: tests

57d64e8

refactor: chat channel specification

984b142

fix: spelling

eb07699

fix: whatsapp tests

8e9a58e

fix: remove from number

649abe8

scopsy reviewed Apr 30, 2024

View reviewed changes

scopsy changed the title ~~Add Whatsapp business as provider~~ feat(providers): Add Whatsapp business as provider Apr 30, 2024

SokratisVidros approved these changes Apr 30, 2024

View reviewed changes

scopsy added 3 commits May 1, 2024 00:34

fix: refactor pr comments

dc6f4fd

fix: fetching of execution details

e26f8be

fix: point to next

86d79e6

scopsy merged commit 00cebdd into novuhq:next Apr 30, 2024
12 of 14 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(providers): Add Whatsapp business as provider #5232

feat(providers): Add Whatsapp business as provider #5232

vitoorgomes commented Feb 23, 2024

netlify bot commented Feb 23, 2024 •

edited

Cliftonz commented Mar 4, 2024

Cliftonz commented Mar 4, 2024

vitoorgomes commented Mar 7, 2024

Cliftonz left a comment

vitoorgomes commented Mar 15, 2024

netlify bot commented Apr 30, 2024 •

edited

antonjoel82 left a comment

antonjoel82 Feb 28, 2024

antonjoel82 Feb 28, 2024

scopsy Apr 30, 2024

antonjoel82 Apr 30, 2024

scopsy Apr 30, 2024

antonjoel82 Apr 30, 2024

scopsy Apr 30, 2024

scopsy Apr 30, 2024

scopsy Apr 30, 2024

scopsy Apr 30, 2024

scopsy Apr 30, 2024

SokratisVidros left a comment

SokratisVidros Apr 30, 2024

vitoorgomes commented Apr 30, 2024

scopsy commented Apr 30, 2024

	export const whatsaAppBusinessConfig: IConfigCredentials[] = [
	export const whatsAppBusinessConfig: IConfigCredentials[] = [

feat(providers): Add Whatsapp business as provider #5232

feat(providers): Add Whatsapp business as provider #5232

Conversation

vitoorgomes commented Feb 23, 2024

What change does this PR introduce?

Why was this change needed?

Other information (Screenshots)

netlify bot commented Feb 23, 2024 • edited

✅ Deploy Preview for dev-web-novu ready!

Cliftonz commented Mar 4, 2024

Cliftonz commented Mar 4, 2024

vitoorgomes commented Mar 7, 2024

Cliftonz left a comment

Choose a reason for hiding this comment

vitoorgomes commented Mar 15, 2024

netlify bot commented Apr 30, 2024 • edited

✅ Deploy Preview for novu-design ready!

antonjoel82 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SokratisVidros left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vitoorgomes commented Apr 30, 2024

scopsy commented Apr 30, 2024

netlify bot commented Feb 23, 2024 •

edited

netlify bot commented Apr 30, 2024 •

edited