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

End date configuration for tiktok #12838

Merged

Conversation

Zawar92
Copy link
Contributor

@Zawar92 Zawar92 commented May 13, 2022

What

Want to add user specified end-date configuration for tiktok. This use case is important for us, as we require to refetch data for specific date ranges. As of now the connector fetch data from the start_date till current date.

How

Source configuration should allow for the specification of an end_date. It would be optional based on the current setup. If someone doesn't want to use the end_date, it's up-to them.

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.

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

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 by running the /publish command described here
  • After the connector is published, connector added to connector index 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
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
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

Tests

Unit

Put your unit tests output here.

Integration

Put your integration tests output here.

Acceptance

Put your acceptance tests output here.

@github-actions github-actions bot added the area/connectors Connector related issues label May 13, 2022
@Zawar92
Copy link
Contributor Author

Zawar92 commented May 13, 2022

Need assistance for the failing of unit test.

Failed Unit test,

  1. airbyte-integrations/connectors/source-tiktok-marketing/unit_tests/unit_test.py::test_backoff
  2. airbyte-integrations/connectors/source-tiktok-marketing/unit_tests/unit_test.py::test_random_items

What is required in config.json and prod_config.json?

  1. When advertiser_id is not passed in config.json test_backoff fails.
  2. When advertiser_id is passed in credentials in config.json then test_backoff is success but cannot retrieve the data, as it cannot retrieve the data test_random_items fails. Attached are the screen shots of my error.

My config.json

{
    "start_date": "2022-04-20",
    "end_date": "2022-04-25",
    "credentials": {
      "auth_type": "oauth2.0",
      "advertiser_id": "",
      "app_id": "",
      "secret": "",
      "access_token": ""
    }
}

Screen Shots of Error
test_backoff

test_random_items

@Zawar92
Copy link
Contributor Author

Zawar92 commented May 13, 2022

Submitted an issue previously. Source tiktok marketing: add end_date configuration

@Zawar92 Zawar92 marked this pull request as ready for review May 18, 2022 11:56
@alafanechere
Copy link
Contributor

alafanechere commented May 18, 2022

Thank you @Zawar92 for the contribution. @harshithmullapudi do you mind helping @Zawar92 solve the unit test and provide a review? 🙏

@Zawar92
Copy link
Contributor Author

Zawar92 commented May 19, 2022

I found this issue. I think it's related.
https://github.com/airbytehq/airbyte-internal-issues/issues/552

@harshithmullapudi
Copy link
Contributor

harshithmullapudi commented May 23, 2022

/test connector=connectors/source-tiktok-marketing

🕑 connectors/source-tiktok-marketing https://github.com/airbytehq/airbyte/actions/runs/2370535569
❌ connectors/source-tiktok-marketing https://github.com/airbytehq/airbyte/actions/runs/2370535569
🐛 https://gradle.com/s/yplq4jxbmyhdw
Python short test summary info:

=========================== short test summary info ============================
FAILED test_core.py::TestSpec::test_match_expected[inputs0] - AssertionError:...
=================== 1 failed, 60 passed in 967.76s (0:16:07) ===================

@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label May 23, 2022
@harshithmullapudi
Copy link
Contributor

harshithmullapudi commented May 23, 2022

/test connector=connectors/source-tiktok-marketing

🕑 connectors/source-tiktok-marketing https://github.com/airbytehq/airbyte/actions/runs/2370878681
❌ connectors/source-tiktok-marketing https://github.com/airbytehq/airbyte/actions/runs/2370878681
🐛 https://gradle.com/s/vnj4zfhlwk2tk
Python short test summary info:

=========================== short test summary info ============================
ERROR test_core.py::TestSpec::test_match_expected[inputs0] - pydantic.error_w...
=================== 60 passed, 1 error in 864.40s (0:14:24) ====================

@harshithmullapudi
Copy link
Contributor

harshithmullapudi commented May 23, 2022

/test connector=connectors/source-tiktok-marketing

🕑 connectors/source-tiktok-marketing https://github.com/airbytehq/airbyte/actions/runs/2371084483
❌ connectors/source-tiktok-marketing https://github.com/airbytehq/airbyte/actions/runs/2371084483
🐛 https://gradle.com/s/cr2jfrgeti7pe
Python short test summary info:

=========================== short test summary info ============================
ERROR test_core.py::TestSpec::test_match_expected[inputs0] - json.decoder.JSO...
=================== 60 passed, 1 error in 889.74s (0:14:49) ====================

@harshithmullapudi
Copy link
Contributor

harshithmullapudi commented May 23, 2022

/test connector=connectors/source-tiktok-marketing

🕑 connectors/source-tiktok-marketing https://github.com/airbytehq/airbyte/actions/runs/2371242422
❌ connectors/source-tiktok-marketing https://github.com/airbytehq/airbyte/actions/runs/2371242422
🐛 https://gradle.com/s/uluiq2752577y
Python short test summary info:

=========================== short test summary info ============================
FAILED test_core.py::TestSpec::test_match_expected[inputs0] - AssertionError:...
=================== 1 failed, 60 passed in 919.01s (0:15:19) ===================

@harshithmullapudi
Copy link
Contributor

harshithmullapudi commented May 23, 2022

/test connector=connectors/source-tiktok-marketing

🕑 connectors/source-tiktok-marketing https://github.com/airbytehq/airbyte/actions/runs/2371759507
✅ connectors/source-tiktok-marketing https://github.com/airbytehq/airbyte/actions/runs/2371759507
Python tests coverage:

Name                                                 Stmts   Miss  Cover
------------------------------------------------------------------------
source_acceptance_test/utils/__init__.py                 6      0   100%
source_acceptance_test/tests/__init__.py                 4      0   100%
source_acceptance_test/__init__.py                       2      0   100%
source_acceptance_test/tests/test_full_refresh.py       52      2    96%
source_acceptance_test/utils/asserts.py                 37      2    95%
source_acceptance_test/config.py                        77      6    92%
source_acceptance_test/utils/json_schema_helper.py     105     13    88%
source_acceptance_test/tests/test_incremental.py       121     25    79%
source_acceptance_test/utils/common.py                  80     17    79%
source_acceptance_test/tests/test_core.py              294    106    64%
source_acceptance_test/utils/compare.py                 62     23    63%
source_acceptance_test/base.py                          10      4    60%
source_acceptance_test/utils/connector_runner.py       110     48    56%
------------------------------------------------------------------------
TOTAL                                                  960    246    74%
Name                                  Stmts   Miss  Cover
---------------------------------------------------------
source_tiktok_marketing/spec.py          59      0   100%
source_tiktok_marketing/source.py        49      0   100%
source_tiktok_marketing/__init__.py       2      0   100%
source_tiktok_marketing/streams.py      319     25    92%
---------------------------------------------------------
TOTAL                                   429     25    94%

@harshithmullapudi
Copy link
Contributor

harshithmullapudi commented May 23, 2022

/publish connector=connectors/source-tiktok-marketing auto-bump-version=false

🕑 connectors/source-tiktok-marketing https://github.com/airbytehq/airbyte/actions/runs/2372018108
❌ Failed to publish connectors/source-tiktok-marketing

@harshithmullapudi
Copy link
Contributor

harshithmullapudi commented May 23, 2022

/publish connector=connectors/source-tiktok-marketing auto-bump-version=false

🕑 connectors/source-tiktok-marketing https://github.com/airbytehq/airbyte/actions/runs/2372073340
❌ Failed to publish connectors/source-tiktok-marketing

@harshithmullapudi
Copy link
Contributor

harshithmullapudi commented May 23, 2022

/publish connector=connectors/source-tiktok-marketing auto-bump-version=false

🕑 connectors/source-tiktok-marketing https://github.com/airbytehq/airbyte/actions/runs/2372548803
🚀 Successfully published connectors/source-tiktok-marketing
✅ connectors/source-tiktok-marketing https://github.com/airbytehq/airbyte/actions/runs/2372548803

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 community
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants