feat: add webhook parser for NetCore (email)

[abhilipsasahoo03]

What change does this PR introduce?

• Created webhook parser for NetCore provider (email).

Why was this change needed?

• Fixes [NV-1005] - Create webhook parser for NetCore (email) #1645

• To give better answers why a message was not sent to a subscriber we need to get some info from the provider with a webhook.

Additional Context

• Resources: https://cpaasdocs.netcorecloud.com/docs/pepipost-api/c2d895762f832-send-an-email

[abhilipsasahoo03]

@scopsy @davidsoderberg the failing check is due to lack of default case in switch-case statement in netcore.provider.ts file. I'm not sure what to include in the default case! Please let me know and Kindly review.

[abhilipsasahoo03]

@p-fernandez please take a look and let me know if any change is required.

[LetItRock]

@abhilipsasahoo03 to solve the default case issue you can instead use the object as the map between enums like:

const NET_CORE_STATUS_TO_EMAIL_EVENT = {
   [NetCoreStatusEnum.OPENED]: EmailEventStatusEnum.OPENED,
   [NetCoreStatusEnum.BOUNCED]: EmailEventStatusEnum.BOUNCED,
...
}

and then use it like:

const status = NET_CORE_STATUS_TO_EMAIL_EVENT[body.EVENT];

[abhilipsasahoo03]

@abhilipsasahoo03 to solve the default case issue you can instead use the object as the map between enums like:

const NET_CORE_STATUS_TO_EMAIL_EVENT = {
   [NetCoreStatusEnum.OPENED]: EmailEventStatusEnum.OPENED,
   [NetCoreStatusEnum.BOUNCED]: EmailEventStatusEnum.BOUNCED,
...
}

and then use it like:

const status = NET_CORE_STATUS_TO_EMAIL_EVENT[body.EVENT];

@LetItRock The failing Javascript check has been resolved. Thanks for the suggestion, I'll keep that in mind.

[p-fernandez]

🌟

[abhilipsasahoo03]

@p-fernandez I've made the changes. Please take a look.

[abhilipsasahoo03]

@scopsy @p-fernandez kindly review!

[p-fernandez]

Please add TRANSID inside of the file .cspell.json to pass the spelling integration check. You can do it here:

novu/.cspell.json

Line 200 in f5b92c5

"varname"

[abhilipsasahoo03]

@p-fernandez kindly review!

[p-fernandez]

@p-fernandez kindly review!

The linter for providers integration checks failed:

providers/netcore test: /home/runner/work/novu/novu/providers/netcore/src/lib/netcore.provider.ts
providers/netcore test:    91:22  warning  Unexpected any. Specify a different type       @typescript-eslint/no-explicit-any
providers/netcore test:    91:28  warning  Unexpected any. Specify a different type       @typescript-eslint/no-explicit-any
providers/netcore test:    93:38  error    ["TRANSID"] is better written in dot notation  @typescript-eslint/dot-notation
providers/netcore test:    96:18  error    ["TRANSID"] is better written in dot notation  @typescript-eslint/dot-notation
providers/netcore test:   100:11  warning  Unexpected any. Specify a different type       @typescript-eslint/no-explicit-any
providers/netcore test:   100:17  warning  Unexpected any. Specify a different type       @typescript-eslint/no-explicit-any
providers/netcore test:   104:39  error    ["TRANSID"] is better written in dot notation  @typescript-eslint/dot-notation
providers/netcore test:   111:40  error    ["EVENT"] is better written in dot notation    @typescript-eslint/dot-notation
providers/netcore test:   120:24  error    ["TRANSID"] is better written in dot notation  @typescript-eslint/dot-notation

In the netcore.provider.ts file replace the ocurrences of the object accesses to TRANSID and EVENT like: obj.TRANSID and obj.EVENT so we can solve that problem.

[abhilipsasahoo03]

@p-fernandez kindly review!

The linter for providers integration checks failed:

providers/netcore test: /home/runner/work/novu/novu/providers/netcore/src/lib/netcore.provider.ts
providers/netcore test:    91:22  warning  Unexpected any. Specify a different type       @typescript-eslint/no-explicit-any
providers/netcore test:    91:28  warning  Unexpected any. Specify a different type       @typescript-eslint/no-explicit-any
providers/netcore test:    93:38  error    ["TRANSID"] is better written in dot notation  @typescript-eslint/dot-notation
providers/netcore test:    96:18  error    ["TRANSID"] is better written in dot notation  @typescript-eslint/dot-notation
providers/netcore test:   100:11  warning  Unexpected any. Specify a different type       @typescript-eslint/no-explicit-any
providers/netcore test:   100:17  warning  Unexpected any. Specify a different type       @typescript-eslint/no-explicit-any
providers/netcore test:   104:39  error    ["TRANSID"] is better written in dot notation  @typescript-eslint/dot-notation
providers/netcore test:   111:40  error    ["EVENT"] is better written in dot notation    @typescript-eslint/dot-notation
providers/netcore test:   120:24  error    ["TRANSID"] is better written in dot notation  @typescript-eslint/dot-notation

In the netcore.provider.ts file replace the ocurrences of the object accesses to TRANSID and EVENT like: obj.TRANSID and obj.EVENT so we can solve that problem.

@p-fernandez just came across that error in the automated test. I suppose it doesn't support bracket notation. I have made the required changes.

[abhilipsasahoo03]

@p-fernandez @scopsy please take a look.

[abhilipsasahoo03]

@scopsy @p-fernandez @davidsoderberg please take a look

[davidsoderberg]

when do this case happen?

[abhilipsasahoo03]

According to the docs:
All API requests with syntactically incorrect email ids will be treated as Invalid and no further processing will be done on such ids.

[davidsoderberg]

Hm @p-fernandez what do you think of adding an INVALID to our generic email event status enum?

[p-fernandez]

Netcore already explains in their documentation that a syntactically incorrect email generates a hard bounce. So I think we should use our BOUNCED status. They might send invalid just to narrow down the case for internal functionalities.
https://netcorecloud.com/tutorials/troubleshoot-email-bounce/#hard-bounce-email

[davidsoderberg]

the body does not contain a date we can use?

[abhilipsasahoo03]

Here is a sample webhook from the docs:

[ {
"TRANSID": 15536250111702803, "RESPONSE": " - 2.0.0 (success)",
"EMAIL": "test@gmail.com",
"TIMESTAMP": 1553681625,
"FROMADDRESS": "info@mydomain.com",
"EVENT": "sent",
"MSIZE": 2155,
"X-APIHEADER": "UNIQUEID",
"TAGS": "mytag1"
} ]

we do have a timestamp here but no date.

[davidsoderberg]

Okay then we keep it like you have it now 👍

[p-fernandez]

We can use the timestamp and generate the date from it.

[abhilipsasahoo03]

I think we can do that by passing the timestamp to Date(). Correct me if I'm wrong. I'll look into it. :) @p-fernandez

[abhilipsasahoo03]

@davidsoderberg @p-fernandez please review! :)

[ghost]

👇 Click on the image for a new way to code review

• Make big changes easier — review code in small groups of related files

• Know where to start — see the whole change at a glance

• Take a code tour — explore the change with an interactive tour

• Make comments and review — all fully sync’ed with github

  Try it now!

Legend

[p-fernandez]

🌟