Skip to content

SNS: v2 add http endpoint for opting out phone numbers #13540

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
Merged
baermat merged 3 commits into from
Jan 8, 2026
Merged

SNS: v2 add http endpoint for opting out phone numbers #13540

baermat merged 3 commits into from
Jan 8, 2026
+47 −4

Conversation

@baermat
Copy link
Member

@baermat baermat commented Dec 17, 2025 •
edited
Loading

Motivation

In AWS, you can opt-out phone numbers so they are not included in sms push notifications. This opt-out is usually done via keyword response (STOP and similar words) to the sms message, or can be done in AWS Console in a Service called Pinpoint.

  • The sms response is very involved to setup, especially since I don't have an US phone number and I am based in Austria.
  • Our current implementation of pinpoint doesn't support the operation we need.
    • Furthermore, it would require a completely new pinpoint <-> sns integration, for a service that is scheduled for deprecation.
      This PR therefore implements a simple endpoint to allow users opting-out phone numbers for the sake testing and using SNS' opted-out operations.

closes PNX-549
ref DOC-26

Changes

  • adds /_aws/sns/phone-opt-outs as POST endpoint to SNS
  • adds test
  • changes the type of opted out phone numbers to a set.

Tests

Related

@baermat baermat added semver: minor Non-breaking changes which can be included in minor releases, but not in patch releases docs: skip Pull request does not require documentation changes notes: skip Pull request does not have to be mentioned in the release notes and removed docs: skip Pull request does not require documentation changes labels Dec 17, 2025
@github-actions
Copy link

github-actions bot commented Dec 17, 2025 •
edited
Loading

Test Results - Preflight, Unit

23 046 tests  ±0   21 201 ✅ ±0   6m 23s ⏱️ +7s
     1 suites ±0    1 845 💤 ±0 
     1 files   ±0        0 ❌ ±0 

Results for commit a94e85a. ± Comparison against base commit 0832e59.

♻️ This comment has been updated with latest results.

@github-actions
Copy link

github-actions bot commented Dec 17, 2025 •
edited
Loading

Test Results (amd64) - Acceptance

7 tests  ±0   5 ✅ ±0   3m 0s ⏱️ -1s
1 suites ±0   2 💤 ±0 
1 files   ±0   0 ❌ ±0 

Results for commit a94e85a. ± Comparison against base commit 0832e59.

♻️ This comment has been updated with latest results.

@github-actions
Copy link

github-actions bot commented Dec 17, 2025 •
edited
Loading

Test Results - Alternative Providers

210 tests   166 ✅  2m 7s ⏱️
  1 suites   44 💤
  1 files      0 ❌

Results for commit a94e85a.

♻️ This comment has been updated with latest results.

@github-actions
Copy link

github-actions bot commented Dec 17, 2025 •
edited
Loading

Test Results (amd64) - Integration, Bootstrap

    5 files      5 suites   1h 30m 28s ⏱️
3 143 tests 2 972 ✅ 171 💤 0 ❌
3 154 runs  2 977 ✅ 177 💤 0 ❌

Results for commit a94e85a.

♻️ This comment has been updated with latest results.

@github-actions
Copy link

github-actions bot commented Dec 17, 2025 •
edited
Loading

LocalStack Community integration with Pro

    2 files  ±    0      2 suites  ±0   1h 5m 0s ⏱️ - 51m 34s
3 124 tests  - 2 031  2 950 ✅  - 1 808  174 💤  - 223  0 ❌ ±0 
3 128 runs   - 2 029  2 952 ✅  - 1 806  176 💤  - 223  0 ❌ ±0 

Results for commit a94e85a. ± Comparison against base commit 0832e59.

This pull request removes 2032 and adds 1 tests. Note that renamed tests count towards both. 
tests.aws.scenario.bookstore.test_bookstore.TestBookstoreApplication ‑ test_lambda_dynamodb
tests.aws.scenario.bookstore.test_bookstore.TestBookstoreApplication ‑ test_opensearch_crud
tests.aws.scenario.bookstore.test_bookstore.TestBookstoreApplication ‑ test_search_books
tests.aws.scenario.bookstore.test_bookstore.TestBookstoreApplication ‑ test_setup
tests.aws.scenario.kinesis_firehose.test_kinesis_firehose.TestKinesisFirehoseScenario ‑ test_kinesis_firehose_s3
tests.aws.scenario.lambda_destination.test_lambda_destination_scenario.TestLambdaDestinationScenario ‑ test_destination_sns
tests.aws.scenario.lambda_destination.test_lambda_destination_scenario.TestLambdaDestinationScenario ‑ test_infra
tests.aws.scenario.loan_broker.test_loan_broker.TestLoanBrokerScenario ‑ test_prefill_dynamodb_table
tests.aws.scenario.loan_broker.test_loan_broker.TestLoanBrokerScenario ‑ test_stepfunctions_input_recipient_list[step_function_input0-SUCCEEDED]
tests.aws.scenario.loan_broker.test_loan_broker.TestLoanBrokerScenario ‑ test_stepfunctions_input_recipient_list[step_function_input1-SUCCEEDED]
…

tests.aws.services.sns.test_sns.TestSNSSMS ‑ test_opt_out_phone_number_via_endpoint
This pull request removes 224 skipped tests and adds 1 skipped test. Note that renamed tests count towards both. 
tests.aws.scenario.kinesis_firehose.test_kinesis_firehose.TestKinesisFirehoseScenario ‑ test_kinesis_firehose_s3
tests.aws.scenario.loan_broker.test_loan_broker.TestLoanBrokerScenario ‑ test_stepfunctions_input_recipient_list[step_function_input4-FAILED]
tests.aws.scenario.mythical_mysfits.test_mythical_misfits.TestMythicalMisfitsScenario ‑ test_deployed_infra_state
tests.aws.scenario.mythical_mysfits.test_mythical_misfits.TestMythicalMisfitsScenario ‑ test_populate_data
tests.aws.scenario.mythical_mysfits.test_mythical_misfits.TestMythicalMisfitsScenario ‑ test_user_clicks_are_stored
tests.aws.services.cloudcontrol.test_cloudcontrol_api.TestCloudControlResourceApi ‑ test_api_exceptions
tests.aws.services.cloudcontrol.test_cloudcontrol_api.TestCloudControlResourceApi ‑ test_create_exceptions
tests.aws.services.cloudcontrol.test_cloudcontrol_api.TestCloudControlResourceApi ‑ test_create_invalid_desiredstate
tests.aws.services.cloudcontrol.test_cloudcontrol_api.TestCloudControlResourceApi ‑ test_double_create_with_client_token
tests.aws.services.cloudcontrol.test_cloudcontrol_api.TestCloudControlResourceApi ‑ test_lifecycle
…

tests.aws.services.sns.test_sns.TestSNSSMS ‑ test_opt_out_phone_number_via_endpoint

♻️ This comment has been updated with latest results.

@baermat baermat added the docs: needed Pull request requires documentation updates label Dec 18, 2025
@baermat baermat marked this pull request as ready for review December 18, 2025 11:15
@baermat baermat requested a review from bentsku as a code owner December 18, 2025 11:15
bentsku
bentsku reviewed Dec 18, 2025
View reviewed changes
Copy link
Contributor

@bentsku bentsku left a comment

Choose a reason for hiding this comment

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

Awesome, nice addition! Just a minor comment regarding marking the test as not runnable in a different process, but then we're good to go 🚀

localstack-core/localstack/services/sns/v2/models.py
TAGS: TaggingService = CrossRegionAttribute(default=TaggingService)

PHONE_NUMBERS_OPTED_OUT: list[PhoneNumber] = CrossRegionAttribute(default=list)
PHONE_NUMBERS_OPTED_OUT: set[PhoneNumber] = CrossRegionAttribute(default=set)
Copy link
Contributor

@bentsku bentsku Dec 18, 2025

Choose a reason for hiding this comment

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

quick followup question from the previous PR: should we put this back as lower case to follow the rest of the attributes?

Copy link
Member Author

@baermat baermat Jan 8, 2026

Choose a reason for hiding this comment

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

I was under the impression that local attributes are lower case, while cross region attributes like TAGS are all uppercase. Since this is per account, I uppercased it. Wrong approach?

Copy link
Contributor

@bentsku bentsku Jan 8, 2026

Choose a reason for hiding this comment

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

Good question, the only one I know that was using the uppercase was the TAGS and wasn't aware of any others. I'm not sure why tags got uppercased actually 😄 but I'd suggest to use lowercase as to me uppercase in Python is synonym with constants. If it is actually a convention then we can leave it. It's a nit anyway, we can leave it like that too 👍

tests/aws/services/sns/test_sns.py Outdated
response = aws_client.sns.check_if_phone_number_is_opted_out(phoneNumber=phone_number)
assert not response["isOptedOut"]
data = {"phoneNumber": phone_number, "accountId": account_id}
requests.post("http://localhost:4566/_aws/sns/phone-opt-outs", data=json.dumps(data))
Copy link
Contributor

@bentsku bentsku Dec 18, 2025

Choose a reason for hiding this comment

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

nit: might be worth switch this to phone_url = config.external_service_url() + SMS_PHONE_NUMBER_OPT_OUT_ENDPOINT like the other tests.

Also worth saying that the other endpoint tests are using internal_service_url, so those won't work in the k8s environment, so it might be worth marking this test as @markers.requires_in_process for now until we can validate they would work 👍

@baermat baermat force-pushed the sns/v2-opt-out-endpoint branch from b306086 to a94e85a Compare January 8, 2026 09:34
@baermat baermat requested a review from bentsku January 8, 2026 10:34
bentsku
bentsku approved these changes Jan 8, 2026
View reviewed changes
Copy link
Contributor

@bentsku bentsku left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for addressing the comments 👍

@baermat baermat merged commit e6b3714 into main Jan 8, 2026
43 checks passed
@baermat baermat deleted the sns/v2-opt-out-endpoint branch January 8, 2026 10:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bentsku bentsku bentsku approved these changes

Assignees

No one assigned

Labels

docs: needed Pull request requires documentation updates notes: skip Pull request does not have to be mentioned in the release notes semver: minor Non-breaking changes which can be included in minor releases, but not in patch releases

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@baermat @bentsku