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

[NV-992] Test Netcore provider connection when creating/updating integration #4805

Closed
BiswaViraj opened this issue Nov 9, 2023 · 1 comment

Comments

@BiswaViraj
Copy link
Member

Why?

Currently, when the user connects a provider from the Integration store, there's no option to Test the provider connection before saving/updating it for wrong/bad credentials or other possible issues.

Without the Test functionality, the provider connection is saved with the possible wrong credentials and the issue is discovered at a much later stage.

We want to have a Test functionality during the connection stage to let users catch the errors as early as possible.

How?

We will need to create a new method i.e,checkIntegration for the Netcore provider.

Currently, we have a placeholder checkIntegration method, you will need to update this method accordingly.

Path to the file : providers/netcore/src/lib/netcore.provider.ts

Look into the Netcore docs and if they provide a dedicated endpoint or method to test the connection, then implement the same inside the checkIntegration method.

If there's no dedicated endpoint/method provided by Netcore, then re-use the send functionality of the provider to check and ensure proper integration, and return the errors if any.

P.S: We have integrated the same for the sendgrid provider, you may use it as a reference or follow this pr for more details.

From SyncLinear.com | NV-992

@BiswaViraj BiswaViraj self-assigned this Nov 9, 2023
@BiswaViraj BiswaViraj removed their assignment Nov 9, 2023
Copy link

github-actions bot commented Nov 9, 2023

Hi, I'm Jarvis 🤖%0A%0AI'm a bot built to help you with your contribution to Novu. %0AI will add instructions and guides on how to run the subset of the Novu platform associated to this issue and make your first contribution.%0A%0AThis issue was tagged as related to @novu/api and the related code is located at the apps/api folder, here is how I can help you:%0A%0A

%0A First time contributing to Novu?%0A%0A If that's the first time you want to contribute to Novu here are a few simple steps to get you started:%0A 1. Fork the repository and clone your fork to your local machine.%0A 2. Install the dependencies using npm run setup:project.%0A 3. Create a new branch with the number of the issue, for example: 1454-fix-something-cool and start contributing based on the Contributing Guide or the short guide in the section below.%0A 4. Create a Pull request and follow the template of creation %0A
%0A%0A
%0A Run and test @novu/api locally%0A%0A ### Run API in watch mode%0A The easiest way to start the API is to run npm run start:api from the root of the repository%0A%0A ### Run API integration tests%0A To validate your changes or simply to run the e2e tests run npm run start:e2e:api. All the e2e tests have the .e2e.ts suffix and usually are located near the controller files of each module.%0A

@scopsy scopsy closed this as completed Nov 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants