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.

Sign up for GitHub

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

Jump to bottom

feat: Add data residency for eu and global regions #1390

Merged
merged 10 commits into from
Dec 6, 2023
Merged

feat: Add data residency for eu and global regions #1390

merged 10 commits into from
Dec 6, 2023
+119 −3

Conversation

shrutiburman
Copy link
Contributor

Fixes DII-1230

This PR:

  • Adds a setter setDataResidency() which allows the users to switch to EU sub region, reidrecting their requests to api.eu.sendgrid.com
  • Upgrades the testing pipeline to node v10+ (eslint and typescript do not work well on <10 versions)
  • Upgrades typescript, which was causing the pipleine failure for very long

Checklist

  • I acknowledge that all my contributions will be made under the project's license
  • I have made a material change to the repo (functionality, testing, spelling, grammar)
  • I have read the Contribution Guidelines and my PR follows them
  • I have titled the PR appropriately
  • I have updated my branch with the main branch
  • I have added tests that prove my fix is effective or that my feature works
  • I have added the necessary documentation about the functionality in the appropriate .md file
  • I have added inline documentation to the code I modified

If you have questions, please file a support ticket.

manisha1997
manisha1997 approved these changes Nov 20, 2023
View reviewed changes
Copy link
Contributor

@manisha1997 manisha1997 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@k725 k725 mentioned this pull request Nov 21, 2023
Open
8 tasks
gladysmae08
gladysmae08 reviewed Nov 21, 2023
View reviewed changes
Copy link

@gladysmae08 gladysmae08 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CR

packages/client/src/client.spec.js Show resolved Hide resolved
tiwarishubham635
tiwarishubham635 approved these changes Nov 22, 2023
View reviewed changes
Copy link
Contributor

@tiwarishubham635 tiwarishubham635 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@tiwarishubham635 tiwarishubham635 mentioned this pull request Nov 22, 2023
Open
8 tasks
tbischel
tbischel reviewed Nov 28, 2023
View reviewed changes
docs/use-cases/data-residency-set-hostname.md Outdated

## Limitations

1. Setting the API Key (via `client.setApiKey()`) or Twilio Authentication (via `client.setTwilioEmailAuth()`) will override the hostname to default value. Use the setter call after this set-up.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this something we should figure out a better path for? This is not an ideal scenario.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tbischel @gladysmae08
Hi, I hope my PR offers a solution to this issue. Please take a look and I would appreciate any feedback.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this limitation is no longer necessary after the changes that were just added

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this won't introduce breaking changes for existing customers, right?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if customers don't have to change their code to achieve the same functionality, I think I'm good. if they do, we might want to look into a major version bump?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This wont introduce a breaking change, as the region attribute that's newly introduced has a default value, and will only get updated if the setter for data residency is called.

tbischel
tbischel requested changes Nov 28, 2023
View reviewed changes
Copy link

@tbischel tbischel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need to resolve this usability gap on the setApiKey and setDataResidency before we release.

gladysmae08
gladysmae08 reviewed Nov 29, 2023
View reviewed changes
Copy link

@gladysmae08 gladysmae08 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CR

packages/client/src/classes/client.js Outdated Show resolved Hide resolved
packages/client/src/classes/client.js Outdated
Comment on lines 47 to 50
// this means that region was never set before
if (this.sendgrid_region == '') {
this.setDefaultRequest('baseUrl', SENDGRID_BASE_URL);
}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This technically works but I think it is unnecessary. We can just always reset the baseUrl here based on the saved region

this.setDefaultRequest('baseUrl', REGION_HOST_MAP[this.sendgrid_region]);

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup, I have set the default region as 'global', we can reset based on that now. Thanks.

docs/use-cases/data-residency-set-hostname.md Outdated

## Limitations

1. Setting the API Key (via `client.setApiKey()`) or Twilio Authentication (via `client.setTwilioEmailAuth()`) will override the hostname to default value. Use the setter call after this set-up.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this limitation is no longer necessary after the changes that were just added

@mvanzoest
Copy link

Hi, would it be possible to open a separate PR for the version upgrades? A number of people are awaiting #1387 in order to complete their security upgrades.

@shrutiburman
Copy link
Contributor Author

I think we need to resolve this usability gap on the setApiKey and setDataResidency before we release.

We have resolved the discrepancy in the latest commits. The limitation no longer exists.

gladysmae08
gladysmae08 approved these changes Dec 1, 2023
View reviewed changes
Copy link

@gladysmae08 gladysmae08 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@shrutiburman shrutiburman merged commit eed8ba2 into main Dec 6, 2023
13 checks passed
@shrutiburman shrutiburman deleted the add-region-setter branch December 6, 2023 05:07
@paaschdigital paaschdigital mentioned this pull request Sep 9, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Be3751 Be3751 Be3751 left review comments

@tiwarishubham635 tiwarishubham635 tiwarishubham635 approved these changes

@manisha1997 manisha1997 manisha1997 approved these changes

@gladysmae08 gladysmae08 gladysmae08 approved these changes

@tbischel tbischel tbischel approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@shrutiburman @mvanzoest @tbischel @gladysmae08 @manisha1997 @Be3751 @tiwarishubham635