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.

Sign up for GitHub

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

Jump to bottom

🎉 Source Iterable - API key is passed in headers #15670

Merged
merged 10 commits into from
Aug 25, 2022
Merged

🎉 Source Iterable - API key is passed in headers #15670

merged 10 commits into from
Aug 25, 2022

Conversation

midavadim
Copy link
Contributor

@midavadim midavadim commented Aug 15, 2022 •
edited
Loading

What

Connector sync fails with 401 as response code status due to not set the api-key through request headers.
For more info Iterable API-keys docs

How

api key is passed via header instead of query param

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/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.

@CLAassistant
Copy link

CLAassistant commented Aug 15, 2022 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the area/connectors Connector related issues label Aug 15, 2022
@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label Aug 15, 2022
@midavadim
Copy link
Contributor Author

midavadim commented Aug 15, 2022 •
edited by github-actions bot
Loading

/test connector=connectors/source-iterable

🕑 connectors/source-iterable https://github.com/airbytehq/airbyte/actions/runs/2863307096
❌ connectors/source-iterable https://github.com/airbytehq/airbyte/actions/runs/2863307096
🐛 https://gradle.com/s/sfs7pywjsclwu

Build Failed

Test summary info:

Could not find result summary

@midavadim midavadim linked an issue Aug 15, 2022 that may be closed by this pull request
Source Iterable: apikey should go through request headers instead as query param #12669
Closed
@midavadim
Copy link
Contributor Author

midavadim commented Aug 15, 2022 •
edited by github-actions bot
Loading

/test connector=connectors/source-iterable

🕑 connectors/source-iterable https://github.com/airbytehq/airbyte/actions/runs/2863571354

@midavadim midavadim requested review from lazebnyi and removed request for grubberr August 17, 2022 18:53
@midavadim
Copy link
Contributor Author

midavadim commented Aug 17, 2022 •
edited by github-actions bot
Loading

/test connector=connectors/source-iterable

🕑 connectors/source-iterable https://github.com/airbytehq/airbyte/actions/runs/2877916335
❌ connectors/source-iterable https://github.com/airbytehq/airbyte/actions/runs/2877916335
🐛 https://gradle.com/s/u5nimamswea54

Build Failed

Test summary info:

=========================== short test summary info ============================
FAILED test_incremental.py::TestIncremental::test_read_sequential_slices[inputs0]
FAILED test_incremental.py::TestIncremental::test_state_with_abnormally_large_values[inputs0]
================== 2 failed, 27 passed in 3571.39s (0:59:31) ===================

@midavadim
Copy link
Contributor Author

midavadim commented Aug 18, 2022 •
edited by github-actions bot
Loading

/test connector=connectors/source-iterable

🕑 connectors/source-iterable https://github.com/airbytehq/airbyte/actions/runs/2881201883
❌ connectors/source-iterable https://github.com/airbytehq/airbyte/actions/runs/2881201883
🐛 https://gradle.com/s/mekjvyf7dandy

Build Failed

Test summary info:

=========================== short test summary info ============================
FAILED test_incremental.py::TestIncremental::test_read_sequential_slices[inputs0]
================== 1 failed, 28 passed in 3185.47s (0:53:05) ===================

@midavadim
Copy link
Contributor Author

midavadim commented Aug 18, 2022 •
edited by github-actions bot
Loading

/test connector=connectors/source-iterable

🕑 connectors/source-iterable https://github.com/airbytehq/airbyte/actions/runs/2882422483
❌ connectors/source-iterable https://github.com/airbytehq/airbyte/actions/runs/2882422483
🐛 https://gradle.com/s/jj2fpcn7od22m

Build Failed

Test summary info:

=========================== short test summary info ============================
FAILED test_incremental.py::TestIncremental::test_read_sequential_slices[inputs0]
================== 1 failed, 28 passed in 3257.92s (0:54:17) ===================

@midavadim
Copy link
Contributor Author

midavadim commented Aug 21, 2022 •
edited by github-actions bot
Loading

/test connector=connectors/source-iterable

🕑 connectors/source-iterable https://github.com/airbytehq/airbyte/actions/runs/2900016285
❌ connectors/source-iterable https://github.com/airbytehq/airbyte/actions/runs/2900016285
🐛 https://gradle.com/s/4bs6pqnn3cfz2

Build Failed

Test summary info:

=========================== short test summary info ============================
FAILED test_incremental.py::TestIncremental::test_read_sequential_slices[inputs0]
FAILED test_incremental.py::TestIncremental::test_state_with_abnormally_large_values[inputs0]
================== 2 failed, 27 passed in 3498.87s (0:58:18) ===================

@midavadim
Copy link
Contributor Author

midavadim commented Aug 22, 2022 •
edited by github-actions bot
Loading

/test connector=connectors/source-iterable

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

	 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       121     25    79%   21-23, 29-31, 36-43, 48-61, 208-216
	 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       110     48    56%   23-26, 32, 36, 39-64, 67-69, 72-74, 77-79, 82-84, 87-89, 92-110, 144-146
	 source_acceptance_test/utils/json_schema_helper.py     105     13    88%   30-31, 38, 41, 65-68, 96, 120, 190-192
	 ----------------------------------------------------------------------------------
	 TOTAL                                                 1321    463    65%
Name                                  Stmts   Miss  Cover
---------------------------------------------------------
source_iterable/slice_generators.py      73      0   100%
source_iterable/__init__.py               2      0   100%
source_iterable/iterable_streams.py     105     17    84%
source_iterable/source.py                18      7    61%
source_iterable/api.py                  165     67    59%
---------------------------------------------------------
TOTAL                                   363     91    75%

Build Passed

Test summary info:

All Passed

@midavadim midavadim requested a review from Phlair August 22, 2022 18:17
Phlair
Phlair approved these changes Aug 25, 2022
View reviewed changes
Copy link
Contributor

@Phlair Phlair left a comment

Choose a reason for hiding this comment

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

Code changes lgtm. Could you edit the main comment of the PR to explain the what and why of this change please (for clarity) :)

@midavadim midavadim temporarily deployed to more-secrets August 25, 2022 12:36 Inactive
@midavadim
Copy link
Contributor Author

midavadim commented Aug 25, 2022 •
edited by github-actions bot
Loading

/publish connector=connectors/source-iterable

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


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

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

@midavadim midavadim merged commit 1a7cae0 into master Aug 25, 2022
@midavadim midavadim deleted the midavadim/12669-source-iterable-use-apikey-in-header branch August 25, 2022 15:11
rodireich pushed a commit that referenced this pull request Aug 25, 2022
@midavadim @octavia-squidington-iii @rodireich
🎉 Source Iterable - API key is passed in headers (#15670)
aa70354 
* API key is passed in headers

* updated docs

* removed log

* formatted

* fixed tests

* increased timeout for incremental stream

* bumper source version

* bumper source version in seed

* auto-bump connector version [ci skip]

Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
@octavia-squidington-iii octavia-squidington-iii mentioned this pull request Aug 26, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Phlair Phlair Phlair approved these changes

@lazebnyi lazebnyi lazebnyi approved these changes

Assignees
No one assigned
Labels
area/connectors Connector related issues area/documentation Improvements or additions to documentation connectors/source/iterable
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Source Iterable: apikey should go through request headers instead as query param
5 participants
@midavadim @CLAassistant @Phlair @lazebnyi @octavia-squidington-iii