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 Amplitude: added missing attrs in events schema, enabled default availability strategy #25842

Merged

Conversation

midavadim
Copy link
Collaborator

added missing attrs in events schema,
enabled default avilability strategy

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user?

For connector PRs, use this section to explain which type of semantic versioning bump occurs as a result of the changes. Refer to our Semantic Versioning for Connectors guidelines for more information. Breaking changes to connectors must be documented by an Airbyte engineer (PR author, or reviewer for community PRs) by using the Breaking Change Release Playbook.

If there are breaking changes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

Pre-merge Actions

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • Community member? Grant edit access to maintainers (instructions)
  • 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.
  • Connector version is set to 0.0.1
    • Dockerfile has version 0.0.1
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/integrations/<source or destination>/<name>.md including changelog with an entry for the initial version. See changelog example
    • docs/integrations/README.md

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.
Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Unit & integration tests added

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.
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 May 5, 2023

CLA assistant check
All committers have signed the CLA.

@octavia-squidington-iii octavia-squidington-iii added the area/connectors Connector related issues label May 5, 2023
@github-actions
Copy link
Contributor

github-actions bot commented May 5, 2023

Before Merging a Connector Pull Request

Wow! What a great pull request you have here! 🎉

To merge this PR, ensure the following has been done/considered for each connector added or updated:

  • PR name follows PR naming conventions
  • Breaking changes are considered. If a Breaking Change is being introduced, ensure an Airbyte engineer has created a Breaking Change Plan and you've followed all steps in the Breaking Changes Checklist
  • Connector version has been incremented in the Dockerfile and metadata.yaml according to our Semantic Versioning for Connectors guidelines
  • Secrets in the connector's spec are annotated with airbyte_secret
  • All documentation files are up to date. (README.md, bootstrap.md, docs.md, etc...)
  • Changelog updated in docs/integrations/<source or destination>/<name>.md with an entry for the new version. See changelog example
  • You, or an Airbyter, have run /test successfully on this PR - or on a non-forked branch
  • You, or an Airbyter, have run /publish successfully on this PR - or on a non-forked branch
  • You've updated the connector's metadata.yaml file (new!)
  • The Octavia bot updated the source_definitions.yaml or destination_definitions.yaml, or you ran processResources manually (deprecated)

If the checklist is complete, but the CI check is failing,

  1. Check for hidden checklists in your PR description

  2. Toggle the github label checklist-action-run on/off to re-run the checklist CI.

@midavadim midavadim changed the title 🎉 Source Amplitude: added missing attrs in events schema, enabled default avilability strategy 🎉 Source Amplitude: added missing attrs in events schema, enabled default availability strategy May 5, 2023
@midavadim
Copy link
Collaborator Author

midavadim commented May 5, 2023

/test connector=connectors/source-amplitude

🕑 connectors/source-amplitude https://github.com/airbytehq/airbyte/actions/runs/4893992230
✅ connectors/source-amplitude https://github.com/airbytehq/airbyte/actions/runs/4893992230
Python tests coverage:

Name                             Stmts   Miss  Cover
----------------------------------------------------
source_amplitude/components.py      68      0   100%
source_amplitude/__init__.py         2      0   100%
source_amplitude/source.py          19      9    53%
source_amplitude/streams.py        115     79    31%
----------------------------------------------------
TOTAL                              204     88    57%

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:100: The previous and actual specifications are identical.
============ 39 passed, 1 skipped, 1 warning in 1090.35s (0:18:10) =============

@@ -68,10 +67,6 @@ def url_base(self) -> str:
subdomain = "analytics.eu." if self.data_region == "EU Residency Server" else ""
return f"https://{subdomain}amplitude.com/api/"

@property
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Connector does have custom error handling.
But we needed to handle such errors during the whole process of read_records, not just at the begining of the sync.

Copy link
Collaborator

@artem1205 artem1205 left a comment

Choose a reason for hiding this comment

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

availability strategy was removed, because for this stream API may return 404 (see docs ) during read of first slice.

@midavadim
Copy link
Collaborator Author

availability strategy was removed, because for this stream API may return 404 (see docs ) during read of first slice.

@artem1205
404 error is caught at line 163 and stream just returns empty list of records.
So this error does not get to 'availability strategy' handler

@artem1205
Copy link
Collaborator

Yep, but this means that availability strategy is useless here, isn't it?

@midavadim
Copy link
Collaborator Author

Yep, but this means that availability strategy is useless here, isn't it?

I suppose it can handle another types of errors, what do you think?

@midavadim midavadim requested a review from maxi297 May 5, 2023 18:50
@lazebnyi lazebnyi requested a review from erohmensing May 8, 2023 12:59
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.

Nice work! Could you please also add the missing column declarations to the cohorts stream? Here are all of the missing columns from the past week (they look pretty much teh same last month)

image

This comes from the "please check the datadog dashboard" note here. I guess our test doesn't catch it because cohorts is declared as an empty stream.

@@ -30,7 +30,6 @@ acceptance_tests:
extra_fields: no
exact_order: no
extra_records: yes
fail_on_extra_columns: false
Copy link
Contributor

Choose a reason for hiding this comment

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

Woot 🥳

Comment on lines -72 to -73
def availability_strategy(self) -> Optional["AvailabilityStrategy"]:
return None
Copy link
Contributor

Choose a reason for hiding this comment

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

Just double checked - I think @midavadim is right. The availability strategy's get_first_record_for_slice calls stream.read_records so the 404 error handling that returns empty records should work, and the AS should say "connected to stream, but got 0 records". So this should work in that case 👍🏻

Copy link
Contributor

@maxi297 maxi297 left a comment

Choose a reason for hiding this comment

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

LGTM given Ella's concern is addressed!

@midavadim
Copy link
Collaborator Author

@erohmensing

I have added missing fields for cohort stream.
Unfortunately, I do not have real data in that stream to check if the real types are the same.
Types for added fields are taken from API doc:
https://www.docs.developers.amplitude.com/analytics/apis/behavioral-cohorts-api/#get-all-cohorts-response

@midavadim midavadim requested a review from erohmensing May 9, 2023 20:43
@erohmensing
Copy link
Contributor

@midavadim that's fine with me! If any of the types are wrong, that's on the documentation, not us. And we'll catch them in the schema validation errors. Thank you! ⭐

@erohmensing
Copy link
Contributor

Then I think we can safely close #24480 as well :)

@midavadim
Copy link
Collaborator Author

midavadim commented May 9, 2023

/publish connector=connectors/source-amplitude

🕑 Publishing the following connectors:
connectors/source-amplitude
https://github.com/airbytehq/airbyte/actions/runs/4930680711


Connector Version Did it publish? Were definitions generated?
connectors/source-amplitude 0.2.4

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

@midavadim midavadim enabled auto-merge (squash) May 9, 2023 22:21
@midavadim midavadim merged commit f5321d1 into master May 10, 2023
26 of 27 checks passed
@midavadim midavadim deleted the midavadim/24941-amplitude-fix-sat-and-avialability-strategy branch May 10, 2023 08:46
marcosmarxm pushed a commit to natalia-miinto/airbyte that referenced this pull request Jun 8, 2023
…ault availability strategy (airbytehq#25842)

* Added missing attrs in events schema, updated SAT, enabled default availability strategy

* updated connector version

* added missing fields for cohort stream

* auto-bump connector version

---------

Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
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/amplitude
Projects
None yet
6 participants