Skip to content

feat: add AWS SES payload adapter #65

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

Merged
merged 20 commits into from
Sep 15, 2022

Conversation

woutercouvaras
Copy link
Contributor

New Pull Request Checklist

Issue Description

Add support for an AWS SES Adapter

Related issue: #64

Approach

Very simply, I've just added a transformer to match the required SES payload for the v3 SDK.
I've also updated two parameter names in the documentation as they did not match the original Parse payload I was receiving. I've also added an example of how to use it in the docs.

This is my first ever open source PR, so happy for any guidance :)

TODOs before merging

  • Add test cases
  • Add entry to changelog
  • Add changes to documentation (guides, repository pages, in-code descriptions)

@parse-github-assistant
Copy link

parse-github-assistant bot commented Sep 13, 2022

Thanks for opening this pull request!

  • 🎉 We are excited about your hands-on contribution!

@woutercouvaras woutercouvaras mentioned this pull request Sep 13, 2022
3 tasks
@codecov
Copy link

codecov bot commented Sep 13, 2022

Codecov Report

Base: 100.00% // Head: 100.00% // No change to project coverage 👍

Coverage data is based on head (82f8d43) compared to base (4db06d2).
Patch coverage: 100.00% of modified lines in pull request are covered.

❗ Current head 82f8d43 differs from pull request most recent head 360c773. Consider uploading reports for the commit 360c773 to get more accurate results

Additional details and impacted files
@@            Coverage Diff            @@
##             alpha       #65   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            8         8           
  Lines          515       546   +31     
  Branches        41        47    +6     
=========================================
+ Hits           515       546   +31     
Impacted Files Coverage Δ
spec/ApiMailAdapter.spec.js 100.00% <100.00%> (ø)
src/ApiPayloadConverter.js 100.00% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@woutercouvaras
Copy link
Contributor Author

I'm embarassed to say that I didn't see the tests before :) I'll take a look at them and try to fix the coverage issue, as well as these other issues.

@woutercouvaras woutercouvaras changed the title Ses provider feat: A SES provider for v3 SDK Sep 13, 2022
@parse-github-assistant
Copy link

I will reformat the title to use the proper commit message syntax.

@parse-github-assistant parse-github-assistant bot changed the title feat: A SES provider for v3 SDK feat: a SES provider for v3 SDK Sep 13, 2022
@mtrezza mtrezza linked an issue Sep 13, 2022 that may be closed by this pull request
3 tasks
@mtrezza mtrezza changed the title feat: a SES provider for v3 SDK feat: add AWS SES payload adapter Sep 13, 2022
@woutercouvaras
Copy link
Contributor Author

@mtrezza let me know if you need me to tackle anything else.

@woutercouvaras
Copy link
Contributor Author

I've pushed the suggested changes. Not sure I should be the one to resolve those, sorry. I should have checked with you first.

Copy link
Member

@mtrezza mtrezza left a comment

Choose a reason for hiding this comment

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

Looks good! Waiting for CI to pass, then let's merge!

@mtrezza
Copy link
Member

mtrezza commented Sep 15, 2022

I refactored the payload converter to remove some code duplication.

The test pass, so it should be fine, but could you still just check whether this works?

@woutercouvaras
Copy link
Contributor Author

Yes, all still works! 💪

Copy link
Member

@mtrezza mtrezza left a comment

Choose a reason for hiding this comment

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

Looks good! Thanks for adding the SES converter!

@mtrezza mtrezza merged commit 4ecc4c9 into parse-community:alpha Sep 15, 2022
github-actions bot pushed a commit that referenced this pull request Sep 15, 2022
# [2.1.0-alpha.9](2.1.0-alpha.8...2.1.0-alpha.9) (2022-09-15)

### Features

* add AWS SES payload adapter ([#65](#65)) ([4ecc4c9](4ecc4c9))
@github-actions
Copy link

🎉 This pull request has been released in version 2.1.0-alpha.9

@woutercouvaras
Copy link
Contributor Author

Thanks for your patience! I've learned a lot through the process. My next contribution will be of a higher quality:)

@woutercouvaras woutercouvaras deleted the ses-provider branch September 15, 2022 10:01
@woutercouvaras
Copy link
Contributor Author

@mtrezza I see npm has been updated with the new release number, yet the ses provider is not present. Am I missing something? Please forgive me if I've got my wires crossed!

@mtrezza
Copy link
Member

mtrezza commented Sep 15, 2022

yet the ses provider is not present

What do you mean by "not present"?
If you look at the source code in node_modules, it should be there. Maybe you are looking at a different version? Try to delete the node_modules and package-lock.json file in your app and run npm i. Also make sure you have added the correct adapter version 2.1.0-alpha.9 in package.json.

@woutercouvaras
Copy link
Contributor Author

woutercouvaras commented Sep 16, 2022 via email

@mtrezza
Copy link
Member

mtrezza commented Sep 16, 2022

You need to look at the right version:

https://www.npmjs.com/package/parse-server-api-mail-adapter/v/2.1.0-alpha.9#providers

The item is missing in the index (I'll correct that), but if you scroll to the text it's there.

@woutercouvaras
Copy link
Contributor Author

woutercouvaras commented Sep 16, 2022 via email

github-actions bot pushed a commit that referenced this pull request Jan 24, 2023
# [2.1.0-beta.2](2.1.0-beta.1...2.1.0-beta.2) (2023-01-24)

### Bug Fixes

* bump nanoid from 3.1.29 to 3.2.0 ([#56](#56)) ([76a374b](76a374b))
* bump trim-off-newlines from 1.0.1 to 1.0.3 ([#57](#57)) ([794cfb6](794cfb6))
* security upgrade minimist from 1.2.5 to 1.2.6 ([#59](#59)) ([1a5253f](1a5253f))
* security upgrade node-fetch from 2.6.1 to 2.6.7 ([#60](#60)) ([576d336](576d336))
* security upgrade semver-regex from 3.1.3 to 3.1.4 ([#62](#62)) ([4db06d2](4db06d2))

### Features

* add AWS SES payload adapter ([#65](#65)) ([4ecc4c9](4ecc4c9))
@github-actions
Copy link

🎉 This pull request has been released in version 2.1.0-beta.2

github-actions bot pushed a commit that referenced this pull request Jan 24, 2023
# [2.2.0](2.1.0...2.2.0) (2023-01-24)

### Bug Fixes

* bump nanoid from 3.1.29 to 3.2.0 ([#56](#56)) ([76a374b](76a374b))
* bump trim-off-newlines from 1.0.1 to 1.0.3 ([#57](#57)) ([794cfb6](794cfb6))
* security upgrade minimist from 1.2.5 to 1.2.6 ([#59](#59)) ([1a5253f](1a5253f))
* security upgrade node-fetch from 2.6.1 to 2.6.7 ([#60](#60)) ([576d336](576d336))
* security upgrade semver-regex from 3.1.3 to 3.1.4 ([#62](#62)) ([4db06d2](4db06d2))

### Features

* add AWS SES payload adapter ([#65](#65)) ([4ecc4c9](4ecc4c9))
github-actions bot pushed a commit that referenced this pull request Jan 24, 2023
# [2.2.0](2.1.0...2.2.0) (2023-01-24)

### Bug Fixes

* bump nanoid from 3.1.29 to 3.2.0 ([#56](#56)) ([76a374b](76a374b))
* bump trim-off-newlines from 1.0.1 to 1.0.3 ([#57](#57)) ([794cfb6](794cfb6))
* security upgrade minimist from 1.2.5 to 1.2.6 ([#59](#59)) ([1a5253f](1a5253f))
* security upgrade node-fetch from 2.6.1 to 2.6.7 ([#60](#60)) ([576d336](576d336))
* security upgrade semver-regex from 3.1.3 to 3.1.4 ([#62](#62)) ([4db06d2](4db06d2))

### Features

* add AWS SES payload adapter ([#65](#65)) ([4ecc4c9](4ecc4c9))
@github-actions
Copy link

🎉 This pull request has been released in version 2.2.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

SES Provider
2 participants