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 mixpanel: hardcoded 'standard' properties for engage stream #7505

Merged
merged 6 commits into from
Nov 3, 2021

Conversation

midavadim
Copy link
Contributor

🐛 source mixpanel: hardcoded 'standard' properties for engage stream

What

Shortly about the problem.
Mixpanel 'engage' stream has dynamic schema. There are some 'standard' fields but users can create custom fields as well.
I have tried to create such 'custom' fields but there is no way to specify type for such custom field. I tried to create fields with different values: abc or 1. Such attrs are reported as string for me. I was not able to find any way to change this.
Customer has a problem with 'browser_version' field, which is a 'standard' field. It is reported as:
'number' - for customer
'string' - for our account.
Customer and I have similar values in this field, like "86.3.112.2", which is definitely a string.
So it is not clear what to do in this situation.

How

solution is: we can hard-code types for known 'standard' fields, but rely on API for another 'custom' fields. What do you think?

Recommended reading order

  1. x.java
  2. y.python

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/SUMMARY.md
    • 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
  • Connector added to connector index like described here

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

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
  • Connector version bumped like described here

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

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.

…ion error (particularly for 'browser_version')
@CLAassistant
Copy link

CLAassistant commented Oct 30, 2021

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added area/connectors Connector related issues area/documentation Improvements or additions to documentation labels Oct 30, 2021
@midavadim midavadim linked an issue Oct 30, 2021 that may be closed by this pull request
@midavadim
Copy link
Contributor Author

midavadim commented Oct 30, 2021

/test connector=connectors/source-mixpanel

🕑 connectors/source-mixpanel https://github.com/airbytehq/airbyte/actions/runs/1402909229
❌ connectors/source-mixpanel https://github.com/airbytehq/airbyte/actions/runs/1402909229
🐛 https://gradle.com/s/avr4p56y7xnfq

@jrhizor jrhizor temporarily deployed to more-secrets October 30, 2021 18:31 Inactive
@midavadim
Copy link
Contributor Author

midavadim commented Oct 30, 2021

/test connector=connectors/source-mixpanel

🕑 connectors/source-mixpanel https://github.com/airbytehq/airbyte/actions/runs/1402996205
✅ connectors/source-mixpanel https://github.com/airbytehq/airbyte/actions/runs/1402996205
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                        74      8    89%
	 source_acceptance_test/conftest.py                     108    108     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              200     94    53%
	 source_acceptance_test/tests/test_full_refresh.py       18     11    39%
	 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                  41     24    41%
	 source_acceptance_test/utils/compare.py                 47     20    57%
	 source_acceptance_test/utils/connector_runner.py        82     49    40%
	 source_acceptance_test/utils/json_schema_helper.py     115     14    88%
	 ------------------------------------------------------------------------
	 TOTAL                                                  860    419    51%
	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                                       Stmts   Miss  Cover
	 --------------------------------------------------------------
	 base_python/__init__.py                       13      0   100%
	 base_python/catalog_helpers.py                10      6    40%
	 base_python/cdk/__init__.py                    0      0   100%
	 base_python/cdk/abstract_source.py            83     59    29%
	 base_python/cdk/streams/__init__.py            0      0   100%
	 base_python/cdk/streams/auth/__init__.py       0      0   100%
	 base_python/cdk/streams/auth/core.py           8      1    88%
	 base_python/cdk/streams/auth/jwt.py            5      5     0%
	 base_python/cdk/streams/auth/oauth.py         37     26    30%
	 base_python/cdk/streams/auth/token.py          9      4    56%
	 base_python/cdk/streams/core.py               63     32    49%
	 base_python/cdk/streams/exceptions.py         10      2    80%
	 base_python/cdk/streams/http.py               67     33    51%
	 base_python/cdk/streams/rate_limiting.py      30     14    53%
	 base_python/cdk/utils/__init__.py              0      0   100%
	 base_python/cdk/utils/casing.py                4      0   100%
	 base_python/client.py                         56     33    41%
	 base_python/entrypoint.py                     70     56    20%
	 base_python/integration.py                    52     25    52%
	 base_python/logger.py                         33     19    42%
	 base_python/schema_helpers.py                 56     41    27%
	 base_python/source.py                         51     34    33%
	 main_dev.py                                    3      3     0%
	 --------------------------------------------------------------
	 TOTAL                                        660    393    40%
	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                          Stmts   Miss  Cover
	 -------------------------------------------------
	 source_mixpanel/__init__.py       2      0   100%
	 source_mixpanel/source.py       298    179    40%
	 -------------------------------------------------
	 TOTAL                           300    179    40%

@jrhizor jrhizor temporarily deployed to more-secrets October 30, 2021 19:21 Inactive
Copy link
Collaborator

@bazarnov bazarnov left a comment

Choose a reason for hiding this comment

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

LGTM. Let's change the note of release inside of the change-log.

docs/integrations/sources/mixpanel.md Outdated Show resolved Hide resolved
@midavadim midavadim temporarily deployed to more-secrets November 1, 2021 17:34 Inactive
@@ -56,6 +56,7 @@ Select the correct region \(EU or US\) for your Mixpanel project. See detail [he

| Version | Date | Pull Request | Subject |
| :--- | :--- | :--- | :--- |
| `0.1.2` | 2021-10-30 | [7505](https://github.com/airbytehq/airbyte/issues/6075) | Implemented 'standard' properties for engage stream |
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
| `0.1.2` | 2021-10-30 | [7505](https://github.com/airbytehq/airbyte/issues/6075) | Implemented 'standard' properties for engage stream |
| `0.1.2` | 2021-10-30 | [7505](https://github.com/airbytehq/airbyte/issues/6075) | Guarantee that standard and custom mixpanel properties in the `Engage` stream are written as strings |

@midavadim midavadim temporarily deployed to more-secrets November 3, 2021 09:13 Inactive
@midavadim
Copy link
Contributor Author

midavadim commented Nov 3, 2021

/publish connector=connectors/source-mixpanel

🕑 connectors/source-mixpanel https://github.com/airbytehq/airbyte/actions/runs/1416026014
✅ connectors/source-mixpanel https://github.com/airbytehq/airbyte/actions/runs/1416026014

@midavadim midavadim temporarily deployed to more-secrets November 3, 2021 09:19 Inactive
@jrhizor jrhizor temporarily deployed to more-secrets November 3, 2021 09:22 Inactive
@midavadim midavadim merged commit f2ab450 into master Nov 3, 2021
@midavadim midavadim deleted the midavadim/7124-source-mixpanel-datatype-fix branch November 3, 2021 10:38
lmossman pushed a commit that referenced this pull request Nov 3, 2021
…7505)

* Hardcoded 'standard' properties for engage stream to avoid normalization error (particularly for 'browser_version')

* updated change log message

* bumped connector version, updated change log

* fix table in docs
schlattk pushed a commit to schlattk/airbyte that referenced this pull request Jan 4, 2022
…irbytehq#7505)

* Hardcoded 'standard' properties for engage stream to avoid normalization error (particularly for 'browser_version')

* updated change log message

* bumped connector version, updated change log

* fix table in docs
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

source-mixpanel sync error (datatypes)
6 participants