🎉 Source Klaviyo: improve performance and make Global Exclusions stream incremental #8592

keu · 2021-12-07T15:56:00Z

What

closes #8002
Two biggest/slowest streams are:

Events (incrmental)
GlobalExclusions (full refresh)

This PR focused mainly on improving the performance of GlobalExclusion stream.

How

make it semi-incremental by introducing a reverse incremental stream
increase page_size from 100 to 5k
set cursor_field
remove validation of the records by pydantic models

Bonus

enable Metrics stream

🚨 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

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
Credentials added to Github CI. Instructions.
/test connector=connectors/<name> command is passing.
New Connector version released on Dockerhub by running the /publish command described here
After the new connector version is published, connector version bumped in the seed directory 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

+ make it semi-incremental by introducing reverse incremental stream + increase page_size from 100 to 5k + set cursor_field + remove validation of the records by pydantic models

CLAassistant · 2021-12-07T15:56:26Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

…rformance

keu · 2021-12-10T01:30:04Z

/test connector=connectors/source-klaviyo

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

	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                                                 Stmts   Miss  Cover
	 ------------------------------------------------------------------------
	 source_acceptance_test/__init__.py                       2      0   100%
	 source_acceptance_test/base.py                          10      4    60%
	 source_acceptance_test/config.py                        76      8    89%
	 source_acceptance_test/conftest.py                     109    109     0%
	 source_acceptance_test/plugin.py                        47     47     0%
	 source_acceptance_test/tests/__init__.py                 4      0   100%
	 source_acceptance_test/tests/test_core.py              235     95    60%
	 source_acceptance_test/tests/test_full_refresh.py       38     27    29%
	 source_acceptance_test/tests/test_incremental.py        69     38    45%
	 source_acceptance_test/utils/__init__.py                 6      0   100%
	 source_acceptance_test/utils/asserts.py                 37      2    95%
	 source_acceptance_test/utils/common.py                  54     24    56%
	 source_acceptance_test/utils/compare.py                 62     25    60%
	 source_acceptance_test/utils/connector_runner.py        82     49    40%
	 source_acceptance_test/utils/json_schema_helper.py     115     14    88%
	 ------------------------------------------------------------------------
	 TOTAL                                                  946    442    53%
	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                         Stmts   Miss  Cover
	   self._warn("No data was collected.", slug="no-data-collected")
	 ------------------------------------------------
	 source_klaviyo/__init__.py       2      2     0%
	 source_klaviyo/schemas.py       91     91     0%
	 source_klaviyo/source.py        28     28     0%
	 source_klaviyo/streams.py      117    117     0%
	 ------------------------------------------------
	 TOTAL                          238    238     0%
	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                         Stmts   Miss  Cover
	 ------------------------------------------------
	 source_klaviyo/__init__.py       2      0   100%
	 source_klaviyo/schemas.py       91     26    71%
	 source_klaviyo/source.py        28     12    57%
	 source_klaviyo/streams.py      117     10    91%
	 ------------------------------------------------
	 TOTAL                          238     48    80%

marcosmarxm

LGTM please enable Metrics streams.

marcosmarxm · 2021-12-10T22:06:39Z

airbyte-integrations/connectors/source-klaviyo/source_klaviyo/source.py

@@ -58,7 +58,7 @@ def streams(self, config: Mapping[str, Any]) -> List[Type[Stream]]:
        return [
            Campaigns(api_key=config.api_key),
            Events(api_key=config.api_key, start_date=config.start_date),
-            GlobalExclusions(api_key=config.api_key),
+            GlobalExclusions(api_key=config.api_key, start_date=config.start_date),
            Lists(api_key=config.api_key),


@keu please enable Metrics stream? See PR #8673 I'll close in favor of yours.

@marcosmarxm done, I left configured_catalog.json unchanged because SAT is not using it anymore

marcosmarxm · 2021-12-10T22:08:26Z

airbyte-integrations/connectors/source-klaviyo/source_klaviyo/schemas.py

@@ -29,6 +30,36 @@ def schema_extra(schema: MutableMapping[str, Any], model) -> None:
                        ref = prop.pop("$ref")
                        prop["oneOf"] = [{"type": "null"}, {"$ref": ref}]

+    @classmethod
+    def _expand_refs(cls, schema: Any, ref_resolver: Optional[RefResolver] = None) -> None:


Awesome job @keu Solve the problem with CI failures!

…rformance

sherifnada

👍🏼

keu · 2021-12-13T22:06:22Z

/publish connector=connectors/source-klaviyo

🕑 connectors/source-klaviyo https://github.com/airbytehq/airbyte/actions/runs/1575116869
✅ connectors/source-klaviyo https://github.com/airbytehq/airbyte/actions/runs/1575116869

marcosmarxm

awesome @eugene-kulak

…am incremental (airbytehq#8592) * improve performance of global_exclusion stream + make it semi-incremental by introducing a reverse incremental stream + increase page_size from 100 to 5k + set cursor_field + remove validation of the records by pydantic models * enable Metrics stream Co-authored-by: Eugene Kulak <[email protected]>

improve performance of global_exclusion stream

f7265d5

+ make it semi-incremental by introducing reverse incremental stream + increase page_size from 100 to 5k + set cursor_field + remove validation of the records by pydantic models

github-actions bot added the area/connectors Connector related issues label Dec 7, 2021

keu temporarily deployed to more-secrets December 7, 2021 15:57 Inactive

eugene-kulak added 3 commits December 8, 2021 00:55

format

5d69619

Merge remote-tracking branch 'origin/master' into keu/8002-klaviyo-pe…

381a5c0

…rformance

fix test

19a5286

keu temporarily deployed to more-secrets December 8, 2021 00:22 Inactive

keu temporarily deployed to more-secrets December 9, 2021 14:40 Inactive

keu changed the title ~~Source Klaviyo: improve performance of global_exclusion stream~~ 🎉 Source Klaviyo: improve performance and make Global Exclusions stream incremental Dec 9, 2021

keu requested review from augan-rymkhan, sergei-solonitcyn, vitaliizazmic, marcosmarxm and eliziario and removed request for marcosmarxm December 9, 2021 15:38

add unittests, bump version

83d235a

github-actions bot added the area/documentation Improvements or additions to documentation label Dec 10, 2021

keu temporarily deployed to more-secrets December 10, 2021 00:24 Inactive

eliziario approved these changes Dec 10, 2021

View reviewed changes

eugene-kulak added 3 commits December 10, 2021 02:53

fix tests

fc74123

format

8dcc6b4

fix annotations

403de20

keu temporarily deployed to more-secrets December 10, 2021 00:59 Inactive

eugene-kulak added 2 commits December 10, 2021 03:17

fix SAT

d31a50b

format

b8d6d06

keu temporarily deployed to more-secrets December 10, 2021 01:20 Inactive

jrhizor temporarily deployed to more-secrets December 10, 2021 01:32 Inactive

vitaliizazmic approved these changes Dec 10, 2021

View reviewed changes

keu self-assigned this Dec 10, 2021

keu requested a review from sherifnada December 10, 2021 16:11

marcosmarxm requested changes Dec 10, 2021

View reviewed changes

marcosmarxm reviewed Dec 10, 2021

View reviewed changes

eugene-kulak added 2 commits December 12, 2021 22:01

Merge remote-tracking branch 'origin/master' into keu/8002-klaviyo-pe…

eb72000

…rformance

enable Metrics stream

0b44815

keu temporarily deployed to more-secrets December 12, 2021 20:08 Inactive

sherifnada reviewed Dec 13, 2021

View reviewed changes

sherifnada approved these changes Dec 13, 2021

View reviewed changes

jrhizor temporarily deployed to more-secrets December 13, 2021 22:08 Inactive

bump version

242bb50

keu temporarily deployed to more-secrets December 13, 2021 23:30 Inactive

marcosmarxm approved these changes Dec 13, 2021

View reviewed changes

keu merged commit 678b532 into master Dec 13, 2021

keu deleted the keu/8002-klaviyo-performance branch December 13, 2021 23:47

jrhizor mentioned this pull request Dec 14, 2021

Bump Airbyte version from 0.33.11-alpha to 0.33.12-alpha #8787

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🎉 Source Klaviyo: improve performance and make Global Exclusions stream incremental #8592

🎉 Source Klaviyo: improve performance and make Global Exclusions stream incremental #8592

keu commented Dec 7, 2021 •

edited

Loading

CLAassistant commented Dec 7, 2021

keu commented Dec 10, 2021 •

edited by github-actions bot

Loading

marcosmarxm left a comment

marcosmarxm Dec 10, 2021

keu Dec 12, 2021 •

edited

Loading

marcosmarxm Dec 10, 2021

sherifnada left a comment

keu commented Dec 13, 2021 •

edited by github-actions bot

Loading

marcosmarxm left a comment

🎉 Source Klaviyo: improve performance and make Global Exclusions stream incremental #8592

🎉 Source Klaviyo: improve performance and make Global Exclusions stream incremental #8592

Conversation

keu commented Dec 7, 2021 • edited Loading

What

How

Bonus

Recommended reading order

🚨 User Impact 🚨

Pre-merge Checklist

Community member or Airbyter

Airbyter

CLAassistant commented Dec 7, 2021

keu commented Dec 10, 2021 • edited by github-actions bot Loading

marcosmarxm left a comment

Choose a reason for hiding this comment

marcosmarxm Dec 10, 2021

Choose a reason for hiding this comment

keu Dec 12, 2021 • edited Loading

Choose a reason for hiding this comment

marcosmarxm Dec 10, 2021

Choose a reason for hiding this comment

sherifnada left a comment

Choose a reason for hiding this comment

keu commented Dec 13, 2021 • edited by github-actions bot Loading

marcosmarxm left a comment

Choose a reason for hiding this comment

keu commented Dec 7, 2021 •

edited

Loading

keu commented Dec 10, 2021 •

edited by github-actions bot

Loading

keu Dec 12, 2021 •

edited

Loading

keu commented Dec 13, 2021 •

edited by github-actions bot

Loading