🎉 Source mixpanel - disable streams "export", "engage" on discover if no access

[grubberr]

Signed-off-by: Sergey Chvalyuk [email protected]

What

Try to fix https://github.com/airbytehq/alpha-beta-issues/issues/296

Streams Engage, Export are streams with dynamically generated schemas.
It looks like API call for generating schema can fail for un-paid account(s).
We don't have any another option but to skip this streams if such problem happens for them.

to work-around this

{"request": "/api/2.0/events/properties/top", "error": "Your plan does not allow API calls. Upgrade at mixpanel.com/pricing"}

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.

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

Tests

Unit

Put your unit tests output here.

Integration

Put your integration tests output here.

Acceptance

Put your acceptance tests output here.

[grubberr]

/test connector=connectors/source-mixpanel

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

Name                                         Stmts   Miss  Cover
----------------------------------------------------------------
source_mixpanel/utils.py                         8      0   100%
source_mixpanel/streams/revenue.py              14      0   100%
source_mixpanel/streams/funnels.py              57      0   100%
source_mixpanel/streams/cohorts.py              15      0   100%
source_mixpanel/streams/__init__.py              9      0   100%
source_mixpanel/property_transformation.py      19      0   100%
source_mixpanel/__init__.py                      2      0   100%
source_mixpanel/streams/export.py               55      1    98%
source_mixpanel/streams/base.py                 89      2    98%
source_mixpanel/streams/engage.py               88      6    93%
source_mixpanel/source.py                       79     10    87%
source_mixpanel/streams/annotations.py          16      3    81%
source_mixpanel/streams/cohort_members.py       21      7    67%
source_mixpanel/testing.py                      29     11    62%
----------------------------------------------------------------
TOTAL                                          501     40    92%
	 Name                                                 Stmts   Miss  Cover   Missing
	 ----------------------------------------------------------------------------------
	 source_acceptance_test/base.py                          10      4    60%   15-18
	 source_acceptance_test/config.py                        83      6    93%   78-80, 84-86
	 source_acceptance_test/conftest.py                     164    164     0%   6-282
	 source_acceptance_test/plugin.py                        48     48     0%   6-104
	 source_acceptance_test/tests/test_core.py              329    111    66%   39, 50-58, 63-70, 74-75, 79-80, 164, 202-219, 228-236, 240-245, 251, 284-289, 327-334, 374-376, 379, 439-448, 477-478, 484, 487, 520-530, 543-568, 573-577
	 source_acceptance_test/tests/test_full_refresh.py       52      2    96%   34, 65
	 source_acceptance_test/tests/test_incremental.py       152     26    83%   21-23, 29-31, 36-43, 48-61, 239, 250-258
	 source_acceptance_test/utils/asserts.py                 37      2    95%   57-58
	 source_acceptance_test/utils/common.py                  77     17    78%   15-16, 24-30, 47-54, 64, 67
	 source_acceptance_test/utils/compare.py                 62     23    63%   21-51, 68, 97-99
	 source_acceptance_test/utils/connector_runner.py       112     50    55%   23-26, 32, 36, 39-67, 70-72, 75-77, 80-82, 85-87, 90-92, 95-113, 147-149
	 source_acceptance_test/utils/json_schema_helper.py     105     13    88%   30-31, 38, 41, 65-68, 96, 120, 190-192
	 ----------------------------------------------------------------------------------
	 TOTAL                                                 1358    466    66%

Build Passed

Test summary info:

All Passed

[bazarnov]

nit: Added permission check for the "export" and "engage" streams, on the schema discover stage.

[bazarnov]

@grubberr
Another comment to think about:

• if the User doesn't have the access to the export or engage stream currently and created the connection without them, what are the steps to add them later? Does the User need to refresh the schema to add those later, once they are paid and ready to use?

[grubberr]

@bazarnov

The problem with get_json_schema
we cannot generate schema because we don't have access
I think the only option to skip this streams

[grubberr]

/publish connector=connectors/source-mixpanel

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

Connector	Did it publish?	Were definitions generated?
connectors/source-mixpanel	✅	✅

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