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: migration to CDK #4566

Merged
merged 43 commits into from
Jul 19, 2021
Merged
Show file tree
Hide file tree
Changes from 40 commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
c521050
Mixpanel initiation
midavadim Jun 24, 2021
5bd81c0
copied schemas and specs file from singer connector
midavadim Jun 24, 2021
c1e0a0f
authentication and a few streams
midavadim Jun 30, 2021
e3fe6f4
Added Funnels + FunnelsList
midavadim Jun 30, 2021
263dcb3
Added example of funnel response
midavadim Jun 30, 2021
2477896
added incremental Funnels stream with tests
midavadim Jul 1, 2021
ee45604
added Annotations, CohortMembers, Engage, Cohorts, Funnels
midavadim Jul 3, 2021
974fe9e
added Revenue
midavadim Jul 3, 2021
2f0422d
fixed formatting
midavadim Jul 3, 2021
6b52533
fixed variable names
midavadim Jul 4, 2021
9662a7d
fixed cohort_members and updated export streams
midavadim Jul 4, 2021
009fc2e
moved start_date and date checks into SourceMixpanel class
midavadim Jul 5, 2021
f15fe82
added error handling
midavadim Jul 5, 2021
e126508
added unit test, update docs and ci creds
midavadim Jul 6, 2021
3a89202
fix url base for export stream
midavadim Jul 10, 2021
bb8b6de
added full and incremental read for export stream
midavadim Jul 11, 2021
3b0e243
Merge branch 'master' into midavadim/3698-source-mixpanel
midavadim Jul 11, 2021
ac35bfb
updated acceptance tests, added limit correction based on number of s…
midavadim Jul 12, 2021
f28ccac
Funnel stream - added complex state which contains state for each funnel
midavadim Jul 13, 2021
6460626
added attribution windows support and project timezone config
midavadim Jul 13, 2021
f773ff6
fixed formatting
midavadim Jul 13, 2021
4158f5d
added default timezone
midavadim Jul 13, 2021
fc63dda
added dynamic schema generation for Engage and Export streams
midavadim Jul 13, 2021
a5d906e
fixed formatting
midavadim Jul 13, 2021
2364194
fixed ability to pass start_date in datetime format as well
midavadim Jul 13, 2021
7c8b471
fixed ability to pass start_date in datetime format as well
midavadim Jul 13, 2021
6a4afa9
Merge branch 'midavadim/3698-source-mixpanel' of https://github.com/a…
midavadim Jul 13, 2021
30f7472
added additional_properties field for dynamic schemas. updates regex …
midavadim Jul 13, 2021
d58c89c
fixed formatting
midavadim Jul 13, 2021
266edc1
export stream - convert all values to default type - string
midavadim Jul 14, 2021
187f207
Merge branch 'master' into midavadim/3698-source-mixpanel
midavadim Jul 14, 2021
af6a415
added schema ref
midavadim Jul 14, 2021
157d4e5
added new properties for funnel stream
midavadim Jul 14, 2021
00553f6
fixed formatting in funnel schema
midavadim Jul 14, 2021
ebfb054
added build related files
midavadim Jul 14, 2021
f0bb9aa
update changelog
midavadim Jul 14, 2021
8873912
fixed and added comments, renamed rate_limit variable
midavadim Jul 15, 2021
d04e8cc
fixed formatting
midavadim Jul 15, 2021
aa1a029
changed normalization for reserved mixpanel attributes like $browser
midavadim Jul 15, 2021
291a4f1
alphabetise spec fields
midavadim Jul 15, 2021
bb8635c
added description about API limit handling
midavadim Jul 19, 2021
b4674fe
updated comment
midavadim Jul 19, 2021
4f90bde
Merge branch 'master' into midavadim/3698-source-mixpanel
midavadim Jul 19, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"sourceDefinitionId": "12928b32-bf0a-4f1e-964f-07e12e37153a",
"name": "Mixpanel",
"dockerRepository": "airbyte/source-mixpanel",
"dockerImageTag": "0.1.0",
"documentationUrl": "https://hub.docker.com/r/airbyte/source-mixpanel",
"icon": "mixpanel.svg"
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"sourceDefinitionId": "859e501d-2b67-471f-91bb-1c801414d28f",
"name": "Mixpanel",
"name": "Mixpanel Singer",
midavadim marked this conversation as resolved.
Show resolved Hide resolved
"dockerRepository": "airbyte/source-mixpanel-singer",
"dockerImageTag": "0.2.4",
"documentationUrl": "https://hub.docker.com/r/airbyte/source-mixpanel-singer",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -194,8 +194,14 @@
dockerImageTag: 0.2.6
documentationUrl: https://hub.docker.com/r/airbyte/source-jira
icon: jira.svg
- sourceDefinitionId: 859e501d-2b67-471f-91bb-1c801414d28f
- sourceDefinitionId: 12928b32-bf0a-4f1e-964f-07e12e37153a
name: Mixpanel
dockerRepository: airbyte/source-mixpanel
dockerImageTag: 0.1.0
documentationUrl: https://hub.docker.com/r/airbyte/source-mixpanel
icon: mixpanel.svg
- sourceDefinitionId: 859e501d-2b67-471f-91bb-1c801414d28f
name: Mixpanel Singer
dockerRepository: airbyte/source-mixpanel-singer
dockerImageTag: 0.2.4
documentationUrl: https://hub.docker.com/r/airbyte/source-mixpanel-singer
Expand Down
4 changes: 3 additions & 1 deletion airbyte-integrations/builds.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,9 @@

Microsoft Teams [![source-microsoft-teams](https://img.shields.io/endpoint?url=https%3A%2F%2Fstatus-api.airbyte.io%2Ftests%2Fsummary%2Fsource-microsoft-teams%2Fbadge.json)](https://status-api.airbyte.io/tests/summary/source-microsoft-teams)

Mixpanel [![source-mixpanel-singer](https://img.shields.io/endpoint?url=https%3A%2F%2Fstatus-api.airbyte.io%2Ftests%2Fsummary%2Fsource-mixpanel-singer%2Fbadge.json)](https://status-api.airbyte.io/tests/summary/source-mixpanel-singer)
Mixpanel [![source-mixpanel](https://img.shields.io/endpoint?url=https%3A%2F%2Fstatus-api.airbyte.io%2Ftests%2Fsummary%2Fsource-mixpanel%2Fbadge.json)](https://status-api.airbyte.io/tests/summary/source-mixpanel)

Mixpanel Singer [![source-mixpanel-singer](https://img.shields.io/endpoint?url=https%3A%2F%2Fstatus-api.airbyte.io%2Ftests%2Fsummary%2Fsource-mixpanel-singer%2Fbadge.json)](https://status-api.airbyte.io/tests/summary/source-mixpanel-singer)

Mongo DB [![source-mongodb](https://img.shields.io/endpoint?url=https%3A%2F%2Fstatus-api.airbyte.io%2Ftests%2Fsummary%2Fsource-mongodb%2Fbadge.json)](https://status-api.airbyte.io/tests/summary/source-mongodb)

Expand Down
7 changes: 7 additions & 0 deletions airbyte-integrations/connectors/source-mixpanel/.dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
*
!Dockerfile
!Dockerfile.test
!main.py
!source_mixpanel
!setup.py
!secrets
16 changes: 16 additions & 0 deletions airbyte-integrations/connectors/source-mixpanel/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
FROM python:3.7-slim

# Bash is installed for more convenient debugging.
RUN apt-get update && apt-get install -y bash && rm -rf /var/lib/apt/lists/*

WORKDIR /airbyte/integration_code
COPY source_mixpanel ./source_mixpanel
COPY main.py ./
COPY setup.py ./
RUN pip install .

ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]

LABEL io.airbyte.version=0.1.0
LABEL io.airbyte.name=airbyte/source-mixpanel
131 changes: 131 additions & 0 deletions airbyte-integrations/connectors/source-mixpanel/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
# Mixpanel Source

This is the repository for the Mixpanel source connector, written in Python.
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/mixpanel).

## Local development

### Prerequisites
**To iterate on this connector, make sure to complete this prerequisites section.**

#### Minimum Python version required `= 3.7.0`

#### Build & Activate Virtual Environment and install dependencies
From this connector directory, create a virtual environment:
```
python -m venv .venv
```

This will generate a virtualenv for this module in `.venv/`. Make sure this venv is active in your
development environment of choice. To activate it from the terminal, run:
```
source .venv/bin/activate
pip install -r requirements.txt
```
If you are in an IDE, follow your IDE's instructions to activate the virtualenv.

Note that while we are installing dependencies from `requirements.txt`, you should only edit `setup.py` for your dependencies. `requirements.txt` is
used for editable installs (`pip install -e`) to pull in Python dependencies from the monorepo and will call `setup.py`.
If this is mumbo jumbo to you, don't worry about it, just put your deps in `setup.py` but install using `pip install -r requirements.txt` and everything
should work as you expect.

#### Building via Gradle
You can also build the connector in Gradle. This is typically used in CI and not needed for your development workflow.

To build using Gradle, from the Airbyte repository root, run:
```
./gradlew :airbyte-integrations:connectors:source-mixpanel:build
```

#### Create credentials
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/mixpanel)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_mixpanel/spec.json` file.
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
See `integration_tests/sample_config.json` for a sample config file.

**If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source mixpanel test creds`
and place them into `secrets/config.json`.

### Locally running the connector
```
python main.py spec
python main.py check --config secrets/config.json
python main.py discover --config secrets/config.json
python main.py read --config secrets/config.json --catalog integration_tests/configured_catalog.json
```

### Locally running the connector docker image

#### Build
First, make sure you build the latest Docker image:
```
docker build . -t airbyte/source-mixpanel:dev
```

You can also build the connector image via Gradle:
```
./gradlew :airbyte-integrations:connectors:source-mixpanel:airbyteDocker
```
When building via Gradle, the docker image name and tag, respectively, are the values of the `io.airbyte.name` and `io.airbyte.version` `LABEL`s in
the Dockerfile.

#### Run
Then run any of the connector commands as follows:
```
docker run --rm airbyte/source-mixpanel:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-mixpanel:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-mixpanel:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-mixpanel:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
```
## Testing
Make sure to familiarize yourself with [pytest test discovery](https://docs.pytest.org/en/latest/goodpractices.html#test-discovery) to know how your test files and methods should be named.
First install test dependencies into your virtual environment:
```
pip install .[tests]
```
### Unit Tests
To run unit tests locally, from the connector directory run:
```
python -m pytest unit_tests
```

### Integration Tests
There are two types of integration tests: Acceptance Tests (Airbyte's test suite for all source connectors) and custom integration tests (which are specific to this connector).
#### Custom Integration tests
Place custom tests inside `integration_tests/` folder, then, from the connector root, run
```
python -m pytest integration_tests
```
#### Acceptance Tests
Customize `acceptance-test-config.yml` file to configure tests. See [Source Acceptance Tests](source-acceptance-tests.md) for more information.
If your connector requires to create or destroy resources for use during acceptance tests create fixtures for it and place them inside integration_tests/acceptance.py.
To run your integration tests with acceptance tests, from the connector root, run
```
python -m pytest integration_tests -p integration_tests.acceptance
```
To run your integration tests with docker

### Using gradle to run tests
All commands should be run from airbyte project root.
To run unit tests:
```
./gradlew :airbyte-integrations:connectors:source-mixpanel:unitTest
```
To run acceptance and custom integration tests:
```
./gradlew :airbyte-integrations:connectors:source-mixpanel:integrationTest
```

## Dependency Management
All of your dependencies should go in `setup.py`, NOT `requirements.txt`. The requirements file is only used to connect internal Airbyte dependencies in the monorepo for local development.
We split dependencies between two groups, dependencies that are:
* required for your connector to work need to go to `MAIN_REQUIREMENTS` list.
* required for the testing need to go to `TEST_REQUIREMENTS` list

### Publishing a new version of the connector
You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
1. Make sure your changes are passing unit and integration tests.
1. Bump the connector version in `Dockerfile` -- just increment the value of the `LABEL io.airbyte.version` appropriately (we use [SemVer](https://semver.org/)).
1. Create a Pull Request.
1. Pat yourself on the back for being an awesome contributor.
1. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# See [Source Acceptance Tests](https://docs.airbyte.io/contributing-to-airbyte/building-new-connector/source-acceptance-tests.md)
# for more information about how to configure these tests
connector_image: airbyte/source-mixpanel:dev
tests:
spec:
- spec_path: "source_mixpanel/spec.json"
connection:
- config_path: "secrets/config.json"
status: "succeed"
- config_path: "integration_tests/invalid_config.json"
status: "failed"
discovery:
- config_path: "secrets/config.json"
basic_read:
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog.json"
validate_output_from_all_streams: yes
full_refresh:
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog.json"
incremental:
# incremental streams Funnels, Revenue, Export
midavadim marked this conversation as resolved.
Show resolved Hide resolved
# Funnels - fails because it has complex state, like {'funnel_idX': {'date': 'dateX'}}
# Export - fails because it could return a few previous records for the date of previous sync
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog_incremental.json"
# Test is skipped because requests fails when start_date is in the future
# Incremental streams Funnels, Revenue always return data for any valid date
# future_state_path: "integration_tests/abnormal_state.json"
cursor_paths:
revenue: ["date"]
export: ["date"]

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#!/usr/bin/env sh
docker run --rm -it \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /tmp:/tmp \
-v $(pwd):/test_input \
airbyte/source-acceptance-test \
--acceptance-test-config /test_input
14 changes: 14 additions & 0 deletions airbyte-integrations/connectors/source-mixpanel/build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
plugins {
id 'airbyte-python'
id 'airbyte-docker'
id 'airbyte-source-acceptance-test'
}

airbytePython {
moduleDirectory 'source_mixpanel'
}

dependencies {
implementation files(project(':airbyte-integrations:bases:source-acceptance-test').airbyteDocker.outputs)
implementation files(project(':airbyte-integrations:bases:base-python').airbyteDocker.outputs)
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"funnels": {
"date": "2022-07-01"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
#
# MIT License
#
# Copyright (c) 2020 Airbyte
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
#


import pytest

pytest_plugins = ("source_acceptance_test.plugin",)


@pytest.fixture(scope="session", autouse=True)
def connector_setup():
""" This fixture is a placeholder for external resources that acceptance test might require."""
yield
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
{
"streams": [
{
"stream": {
"name": "funnels",
"json_schema": {},
"supported_sync_modes": ["full_refresh", "incremental"],
"default_cursor_field": ["date"]
},
"sync_mode": "incremental",
"destination_sync_mode": "overwrite"
},
{
"stream": {
"name": "engage",
"json_schema": {},
"supported_sync_modes": ["full_refresh"]
},
"sync_mode": "full_refresh",
"destination_sync_mode": "overwrite"
},
{
"stream": {
"name": "annotations",
"json_schema": {},
"supported_sync_modes": ["full_refresh"]
},
"sync_mode": "full_refresh",
"destination_sync_mode": "overwrite"
},
{
"stream": {
"name": "export",
"json_schema": {},
"supported_sync_modes": ["full_refresh", "incremental"],
"default_cursor_field": ["time"]
},
"sync_mode": "incremental",
"destination_sync_mode": "append"
},
{
"stream": {
"name": "cohorts",
"json_schema": {},
"supported_sync_modes": ["full_refresh"]
},
"sync_mode": "full_refresh",
"destination_sync_mode": "overwrite"
},
{
"stream": {
"name": "cohort_members",
"json_schema": {},
"supported_sync_modes": ["full_refresh"]
},
"sync_mode": "full_refresh",
"destination_sync_mode": "overwrite"
},
{
"stream": {
"name": "revenue",
"json_schema": {},
"supported_sync_modes": ["full_refresh", "incremental"],
"default_cursor_field": ["date"]
},
"sync_mode": "incremental",
"destination_sync_mode": "append"
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"streams": [
{
"stream": {
"name": "annotations",
"json_schema": {},
midavadim marked this conversation as resolved.
Show resolved Hide resolved
"supported_sync_modes": ["full_refresh"]
},
"sync_mode": "full_refresh",
"destination_sync_mode": "overwrite"
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"streams": [
{
"stream": {
"name": "cohort_members",
"json_schema": {},
"supported_sync_modes": ["full_refresh"]
},
"sync_mode": "full_refresh",
"destination_sync_mode": "overwrite"
}
]
}
Loading