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

🎉 Source Snapchat Marketing - enable default availability strategy #22808

Merged

Conversation

midavadim
Copy link
Contributor

What

Describe what the change is solving
It helps to add screenshots if it affects the frontend.

How

Describe the solution

Recommended reading order

  1. x.java
  2. y.python

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user? If yes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • Community member? Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
    • docs/integrations/README.md
    • airbyte-integrations/builds.md
  • PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • If new credentials are required for use in CI, add them to GSM. Instructions.
  • /test connector=connectors/<name> command is passing
  • New Connector version released on Dockerhub by running the /publish command described here
  • After the connector is published, connector added to connector index as described here
  • Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here
Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • If new credentials are required for use in CI, add them to GSM. Instructions.
  • /test connector=connectors/<name> command is passing
  • New Connector version released on Dockerhub and connector version bumped by running the /publish command described here
Connector Generator
  • Issue acceptance criteria met
  • PR name follows PR naming conventions
  • If adding a new generator, add it to the list of scaffold modules being tested
  • The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:testScaffoldTemplates then checking in your changes
  • Documentation which references the generator is updated as needed

@CLAassistant
Copy link

CLAassistant commented Feb 10, 2023

CLA assistant check
All committers have signed the CLA.

@octavia-squidington-iii octavia-squidington-iii added area/connectors Connector related issues area/documentation Improvements or additions to documentation connectors/source/snapchat-marketing labels Feb 10, 2023
@midavadim
Copy link
Contributor Author

midavadim commented Feb 10, 2023

/test connector=connectors/source-snapchat-marketing

🕑 connectors/source-snapchat-marketing https://github.com/airbytehq/airbyte/actions/runs/4144212483
❌ connectors/source-snapchat-marketing https://github.com/airbytehq/airbyte/actions/runs/4144212483
🐛 https://gradle.com/s/h2acyuq5vxcda

Build Failed

Test summary info:

Could not find result summary

@midavadim midavadim requested review from pedroslopez and removed request for erohmensing February 10, 2023 13:21
@midavadim
Copy link
Contributor Author

midavadim commented Feb 10, 2023

/test connector=connectors/source-snapchat-marketing

🕑 connectors/source-snapchat-marketing https://github.com/airbytehq/airbyte/actions/runs/4144283255
❌ connectors/source-snapchat-marketing https://github.com/airbytehq/airbyte/actions/runs/4144283255
🐛

Build Passed

Test summary info:

=========================== short test summary info ============================
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/connector_acceptance_test/tests/test_core.py:98: The previous and actual specifications are identical.
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/connector_acceptance_test/tests/test_core.py:507: The previous and actual discovered catalogs are identical.
================== 40 passed, 2 skipped in 353.91s (0:05:53) ===================

@midavadim
Copy link
Contributor Author

midavadim commented Feb 11, 2023

/test connector=connectors/source-snapchat-marketing

🕑 connectors/source-snapchat-marketing https://github.com/airbytehq/airbyte/actions/runs/4151001824
✅ connectors/source-snapchat-marketing https://github.com/airbytehq/airbyte/actions/runs/4151001824
Python tests coverage:

Name                                    Stmts   Miss  Cover
-----------------------------------------------------------
source_snapchat_marketing/__init__.py       2      0   100%
source_snapchat_marketing/source.py       284     22    92%
-----------------------------------------------------------
TOTAL                                     286     22    92%
	 Name                                                    Stmts   Miss  Cover   Missing
	 -------------------------------------------------------------------------------------
	 connector_acceptance_test/base.py                          12      4    67%   16-19
	 connector_acceptance_test/config.py                       141      5    96%   87, 93, 239, 243-244
	 connector_acceptance_test/conftest.py                     217    101    53%   37, 43-45, 50, 55, 78, 84, 90-92, 111, 116-118, 124-126, 132-133, 138-139, 144, 150, 159-168, 174-179, 194, 218, 249, 255, 263-271, 279-292, 300-313, 318-324, 331-342, 349-365
	 connector_acceptance_test/plugin.py                        69     25    64%   22-23, 31, 36, 120-140, 144-148
	 connector_acceptance_test/tests/test_core.py              476    117    75%   53, 58, 97-108, 113-120, 124-125, 129-130, 380, 400, 438, 476-493, 506-517, 521-526, 532, 565-570, 608-615, 658-660, 663, 728-736, 748-751, 756, 812-813, 819, 822, 858-868, 881-906
	 connector_acceptance_test/tests/test_incremental.py       162     14    91%   58-65, 70-83, 252
	 connector_acceptance_test/utils/asserts.py                 39      2    95%   62-63
	 connector_acceptance_test/utils/common.py                  94     10    89%   16-17, 32-38, 72, 75
	 connector_acceptance_test/utils/compare.py                 62     23    63%   21-51, 68, 97-99
	 connector_acceptance_test/utils/connector_runner.py       133     33    75%   24-27, 46-47, 50-54, 57-58, 73-75, 78-80, 83-85, 88-90, 93-95, 124-125, 159-161, 208
	 connector_acceptance_test/utils/json_schema_helper.py     114     13    89%   31-32, 39, 42, 66-69, 97, 121, 203-205
	 -------------------------------------------------------------------------------------
	 TOTAL                                                    1711    347    80%

Build Passed

Test summary info:

=========================== short test summary info ============================
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/connector_acceptance_test/tests/test_core.py:98: The previous and actual specifications are identical.
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/connector_acceptance_test/tests/test_core.py:507: The previous and actual discovered catalogs are identical.
================== 40 passed, 2 skipped in 360.45s (0:06:00) ===================

Copy link
Contributor

@erohmensing erohmensing 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 - I added a commit removing custom error handling that shouldn't be necessary anymore.

In future PRs, if you could check against this doc for anything to remove when implementing availabilitystrategy, that'd be great! I also added a note to the issue for each one that has an entry in that list.

@lazebnyi lazebnyi linked an issue Feb 14, 2023 that may be closed by this pull request
@lazebnyi lazebnyi removed the request for review from pedroslopez February 15, 2023 19:22
@lazebnyi lazebnyi temporarily deployed to more-secrets February 15, 2023 19:38 — with GitHub Actions Inactive
@lazebnyi lazebnyi temporarily deployed to more-secrets February 15, 2023 19:38 — with GitHub Actions Inactive
@github-actions
Copy link
Contributor

Airbyte Code Coverage

There is no coverage information present for the Files changed

Total Project Coverage 24.66%

@lazebnyi lazebnyi temporarily deployed to more-secrets February 15, 2023 20:22 — with GitHub Actions Inactive
@lazebnyi lazebnyi temporarily deployed to more-secrets February 15, 2023 20:22 — with GitHub Actions Inactive
@lazebnyi lazebnyi temporarily deployed to more-secrets February 15, 2023 21:13 — with GitHub Actions Inactive
@lazebnyi lazebnyi temporarily deployed to more-secrets February 15, 2023 21:13 — with GitHub Actions Inactive
@lazebnyi lazebnyi temporarily deployed to more-secrets February 16, 2023 11:34 — with GitHub Actions Inactive
@lazebnyi lazebnyi temporarily deployed to more-secrets February 16, 2023 11:34 — with GitHub Actions Inactive
…ng-availability-strategy' into midavadim/21787-snapchat-marketing-availability-strategy
@@ -219,13 +214,6 @@ def parse_response(self, response: requests.Response, **kwargs) -> Iterable[Mapp
raise SnapchatMarketingException(error_text)
yield resp.get(self.response_item_name)

def should_retry(self, response: requests.Response) -> bool:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I investigated the reasons for this custom error handling. There was a stream which was failing for one specifc slice, becuase of permissions error. that's why it handles 403 error. So in order to not fail the whole sync, we just skip one particular slice.

Copy link
Contributor

Choose a reason for hiding this comment

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

Do you know why it was failing for one specific slice? That would indeed not be covered by the availability strategy, but I'm curious as to why it happened

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@erohmensing

related PR: #20865
related issue: https://github.com/airbytehq/oncall/issues/1067

The problem happened with 'segments' stream for one of 'adaccount' in its slice.

As far as I understand snapchat credentials could have access to a couple of snapchat organization/adaccounts and for one of such accounts there was no permission access to 'segments' data.

Copy link
Contributor

Choose a reason for hiding this comment

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

Will leave this up to you as per my comment in the PR itself!

@midavadim
Copy link
Contributor Author

@erohmensing
I have added a comment about removed 'should_retry'

@erohmensing
Copy link
Contributor

@midavadim thanks, responded! Do you know why that was the case? If its legit, I am fine leaving the error handling for now, but I wouldn't expect to run into that for one stream slice so am wondering how the case occurred

@midavadim
Copy link
Contributor Author

@midavadim thanks, responded! Do you know why that was the case? If its legit, I am fine leaving the error handling for now, but I wouldn't expect to run into that for one stream slice so am wondering how the case occurred

@erohmensing

related PR: #20865
related issue: https://github.com/airbytehq/oncall/issues/1067

The problem happened with 'segments' stream for one of 'adaccount' in its slice.

As far as I understand snapchat credentials could have access to a couple of snapchat organization/adaccounts and for one of such accounts there was no permission access to 'segments' data.

@erohmensing
Copy link
Contributor

Looking at that issue and the logs for the broken connection, I don't see any indication why it would only be breaking for that one slice, just that that slice was the first one in the list. (I don't see any indication for example that they had access to the segments stream for another adaccount for example)

Since this is extra error handling, it doesn't hurt us to have it in, but I don't believe it's doing anything. If you feel strongly about it, we can leave it in for now and try removing it later on its own after comparing log messages to see if both cases still happen independently of each other.

@@ -219,13 +214,6 @@ def parse_response(self, response: requests.Response, **kwargs) -> Iterable[Mapp
raise SnapchatMarketingException(error_text)
yield resp.get(self.response_item_name)

def should_retry(self, response: requests.Response) -> bool:
Copy link
Contributor

Choose a reason for hiding this comment

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

Will leave this up to you as per my comment in the PR itself!

@midavadim
Copy link
Contributor Author

midavadim commented Feb 23, 2023

/publish connector=connectors/source-snapchat-marketing

🕑 Publishing the following connectors:
connectors/source-snapchat-marketing
https://github.com/airbytehq/airbyte/actions/runs/4257023387


Connector Did it publish? Were definitions generated?
connectors/source-snapchat-marketing

if you have connectors that successfully published but failed definition generation, follow step 4 here ▶️

@midavadim midavadim merged commit 2a90591 into master Feb 24, 2023
@midavadim midavadim deleted the midavadim/21787-snapchat-marketing-availability-strategy branch February 24, 2023 07:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/connectors Connector related issues area/documentation Improvements or additions to documentation connectors/source/snapchat-marketing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Source Snapchat Marketing: Enable AvailabilityStrategy
5 participants