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

🎉 Declare Oauth init parameters for 4 connector #6438

Conversation

yevhenii-ldv
Copy link
Contributor

Annotate Oauth init parameters for connectors: Facebook Marketing/Pages, Instagram, Salesforce

What

closes #6166 (except for Google Connectors).

How

Describe the solution

Recommended reading order

  1. x.java
  2. y.python

Pre-merge Checklist

Expand the relevant checklist and delete the others.

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

@github-actions github-actions bot added area/connectors Connector related issues area/documentation Improvements or additions to documentation labels Sep 24, 2021
@yevhenii-ldv
Copy link
Contributor Author

yevhenii-ldv commented Sep 24, 2021

/test connector=connectors/source-facebook-marketing

🕑 connectors/source-facebook-marketing https://github.com/airbytehq/airbyte/actions/runs/1269852514
❌ connectors/source-facebook-marketing https://github.com/airbytehq/airbyte/actions/runs/1269852514
🐛 https://gradle.com/s/vrheukb52ppo6

@yevhenii-ldv
Copy link
Contributor Author

yevhenii-ldv commented Sep 24, 2021

/test connector=connectors/source-facebook-pages

🕑 connectors/source-facebook-pages https://github.com/airbytehq/airbyte/actions/runs/1269852841
✅ connectors/source-facebook-pages https://github.com/airbytehq/airbyte/actions/runs/1269852841
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                        45     45     0%
	 source_acceptance_test/tests/__init__.py                 4      0   100%
	 source_acceptance_test/tests/test_core.py              158    109    31%
	 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     25    39%
	 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      75     11    85%
	 ------------------------------------------------------------------------
	 TOTAL                                                  776    430    45%
	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                                Stmts   Miss  Cover
	 -------------------------------------------------------
	 source_facebook_pages/__init__.py       2      0   100%
	 source_facebook_pages/metrics.py        4      0   100%
	 source_facebook_pages/source.py        20     11    45%
	 source_facebook_pages/streams.py       72     34    53%
	 -------------------------------------------------------
	 TOTAL                                  98     45    54%

@yevhenii-ldv
Copy link
Contributor Author

yevhenii-ldv commented Sep 24, 2021

/test connector=connectors/source-instagram

🕑 connectors/source-instagram https://github.com/airbytehq/airbyte/actions/runs/1269853389
❌ connectors/source-instagram https://github.com/airbytehq/airbyte/actions/runs/1269853389
🐛 https://gradle.com/s/uuf3r6m62ckqu

@yevhenii-ldv
Copy link
Contributor Author

yevhenii-ldv commented Sep 24, 2021

/test connector=connectors/source-salesforce

🕑 connectors/source-salesforce https://github.com/airbytehq/airbyte/actions/runs/1269853778
✅ connectors/source-salesforce https://github.com/airbytehq/airbyte/actions/runs/1269853778
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                        45     45     0%
	 source_acceptance_test/tests/__init__.py                 4      0   100%
	 source_acceptance_test/tests/test_core.py              158    109    31%
	 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     25    39%
	 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      75     11    85%
	 ------------------------------------------------------------------------
	 TOTAL                                                  776    430    45%
	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                                 Stmts   Miss  Cover
	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------Coverage.py warning: No data was collected. (no-data-collected)
	 --------------------------------------------------------
	 source_salesforce/__init__.py            2      2     0%
	 source_salesforce/api.py               114    114     0%
	 source_salesforce/exceptions.py          1      1     0%
	 source_salesforce/rate_limiting.py      22     22     0%
	 source_salesforce/source.py             51     51     0%
	 source_salesforce/streams.py           201    201     0%
	 --------------------------------------------------------
	 TOTAL                                  391    391     0%

@jrhizor jrhizor temporarily deployed to more-secrets September 24, 2021 12:45 Inactive
@jrhizor jrhizor temporarily deployed to more-secrets September 24, 2021 12:45 Inactive
@jrhizor jrhizor temporarily deployed to more-secrets September 24, 2021 12:45 Inactive
@jrhizor jrhizor temporarily deployed to more-secrets September 24, 2021 12:45 Inactive
Copy link
Contributor

@avida avida left a comment

Choose a reason for hiding this comment

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

Please update all the oauthFlowInitParameters according to reference

You commit is ok, my bad

Copy link
Contributor

@Zirochkaa Zirochkaa left a comment

Choose a reason for hiding this comment

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

btw, why there are no changes for google connectors as mentioned here #5634?
Google Analytics is covered by #6414, but what about Google Ads and Google Search console?

@yevhenii-ldv
Copy link
Contributor Author

@Zirochkaa Google Ads is here. As for the rest of Google connectors, @gaart took over this issue, so I did not touch them.

@ChristopheDuong
Copy link
Contributor

Beware, we're having to slightly modify the oauth specs in this PR:
#6456

So connectors will have to be tweaked accordingly

@ChristopheDuong
Copy link
Contributor

In the case of facebook connectors, see this comment too: #5989 (comment)

@CLAassistant
Copy link

CLAassistant commented Sep 27, 2021

CLA assistant check
All committers have signed the CLA.

…urochkin/annotate-oauth-init-parameters-for-initial-cloud-release
Copy link
Contributor

@sherifnada sherifnada left a comment

Choose a reason for hiding this comment

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

@yevhenii-ldv could you update this to the new spec format?

"authSpecification": {
"auth_type": "oauth2.0",
"oauth2Specification": {
"oauthFlowInitParameters": [["access_token"]]
Copy link
Contributor

Choose a reason for hiding this comment

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

this should be updated as a output parameter using the new spec

Copy link
Contributor Author

@yevhenii-ldv yevhenii-ldv Sep 29, 2021

Choose a reason for hiding this comment

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

@sherifnada Done, could u review this PR one more time, please?

…urochkin/annotate-oauth-init-parameters-for-initial-cloud-release

� Conflicts:
�	docs/integrations/sources/facebook-marketing.md
@yevhenii-ldv yevhenii-ldv temporarily deployed to more-secrets September 29, 2021 13:10 Inactive
@jrhizor jrhizor temporarily deployed to more-secrets September 30, 2021 08:48 Inactive
…urochkin/annotate-oauth-init-parameters-for-initial-cloud-release
@yevhenii-ldv
Copy link
Contributor Author

yevhenii-ldv commented Sep 30, 2021

/test connector=connectors/source-facebook-pages

🕑 connectors/source-facebook-pages https://github.com/airbytehq/airbyte/actions/runs/1291377723
✅ connectors/source-facebook-pages https://github.com/airbytehq/airbyte/actions/runs/1291377723
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     111     11    90%
	 ------------------------------------------------------------------------
	 TOTAL                                                  856    416    51%
	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                                Stmts   Miss  Cover
	 -------------------------------------------------------
	 source_facebook_pages/__init__.py       2      0   100%
	 source_facebook_pages/metrics.py        4      0   100%
	 source_facebook_pages/source.py        20     11    45%
	 source_facebook_pages/streams.py       72     34    53%
	 -------------------------------------------------------
	 TOTAL                                  98     45    54%

@yevhenii-ldv
Copy link
Contributor Author

yevhenii-ldv commented Sep 30, 2021

/test connector=connectors/source-facebook-marketing

🕑 connectors/source-facebook-marketing https://github.com/airbytehq/airbyte/actions/runs/1291378065
✅ connectors/source-facebook-marketing https://github.com/airbytehq/airbyte/actions/runs/1291378065
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     111     11    90%
	 ------------------------------------------------------------------------
	 TOTAL                                                  856    416    51%
	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                                    Stmts   Miss  Cover
	 -----------------------------------------------------------
	 source_facebook_marketing/__init__.py       2      0   100%
	 source_facebook_marketing/api.py           74     17    77%
	 source_facebook_marketing/common.py        35     11    69%
	 source_facebook_marketing/source.py        36     11    69%
	 source_facebook_marketing/streams.py      239     91    62%
	 -----------------------------------------------------------
	 TOTAL                                     386    130    66%
	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                                    Stmts   Miss  Cover
	 -----------------------------------------------------------
	 source_facebook_marketing/__init__.py       2      0   100%
	 source_facebook_marketing/api.py           74     18    76%
	 source_facebook_marketing/common.py        35      1    97%
	 source_facebook_marketing/source.py        36     15    58%
	 source_facebook_marketing/streams.py      239     85    64%
	 -----------------------------------------------------------
	 TOTAL                                     386    119    69%

@yevhenii-ldv
Copy link
Contributor Author

yevhenii-ldv commented Sep 30, 2021

/test connector=connectors/source-instagram

🕑 connectors/source-instagram https://github.com/airbytehq/airbyte/actions/runs/1291378580
✅ connectors/source-instagram https://github.com/airbytehq/airbyte/actions/runs/1291378580
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     111     11    90%
	 ------------------------------------------------------------------------
	 TOTAL                                                  856    416    51%
	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                           Stmts   Miss  Cover
	 --------------------------------------------------
	 source_instagram/__init__.py       2      0   100%
	 source_instagram/api.py           59      5    92%
	 source_instagram/common.py        39     26    33%
	 source_instagram/source.py        38     11    71%
	 source_instagram/streams.py      207     90    57%
	 --------------------------------------------------
	 TOTAL                            345    132    62%
	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                           Stmts   Miss  Cover
	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------Coverage.py warning: No data was collected. (no-data-collected)
	 --------------------------------------------------
	 source_instagram/__init__.py       2      2     0%
	 source_instagram/api.py           59     59     0%
	 source_instagram/common.py        39     39     0%
	 source_instagram/source.py        38     38     0%
	 source_instagram/streams.py      207    207     0%
	 --------------------------------------------------
	 TOTAL                            345    345     0%

@yevhenii-ldv yevhenii-ldv temporarily deployed to more-secrets September 30, 2021 14:08 Inactive
@jrhizor jrhizor temporarily deployed to more-secrets September 30, 2021 14:09 Inactive
@jrhizor jrhizor temporarily deployed to more-secrets September 30, 2021 14:10 Inactive
@jrhizor jrhizor temporarily deployed to more-secrets September 30, 2021 14:10 Inactive
@yevhenii-ldv
Copy link
Contributor Author

yevhenii-ldv commented Sep 30, 2021

/publish connector=connectors/source-facebook-marketing

🕑 connectors/source-facebook-marketing https://github.com/airbytehq/airbyte/actions/runs/1291451484
✅ connectors/source-facebook-marketing https://github.com/airbytehq/airbyte/actions/runs/1291451484

@yevhenii-ldv yevhenii-ldv temporarily deployed to more-secrets September 30, 2021 14:28 Inactive
@jrhizor jrhizor temporarily deployed to more-secrets September 30, 2021 14:29 Inactive
@yevhenii-ldv
Copy link
Contributor Author

yevhenii-ldv commented Sep 30, 2021

/publish connector=connectors/source-instagram

🕑 connectors/source-instagram https://github.com/airbytehq/airbyte/actions/runs/1291496416
✅ connectors/source-instagram https://github.com/airbytehq/airbyte/actions/runs/1291496416

@yevhenii-ldv
Copy link
Contributor Author

yevhenii-ldv commented Sep 30, 2021

/publish connector=connectors/source-salesforce

🕑 connectors/source-salesforce https://github.com/airbytehq/airbyte/actions/runs/1291500169
❌ connectors/source-salesforce https://github.com/airbytehq/airbyte/actions/runs/1291500169

@yevhenii-ldv
Copy link
Contributor Author

yevhenii-ldv commented Sep 30, 2021

/publish connector=connectors/source-facebook-pages

🕑 connectors/source-facebook-pages https://github.com/airbytehq/airbyte/actions/runs/1291501123
✅ connectors/source-facebook-pages https://github.com/airbytehq/airbyte/actions/runs/1291501123

@jrhizor jrhizor temporarily deployed to more-secrets September 30, 2021 14:42 Inactive
@jrhizor jrhizor temporarily deployed to more-secrets September 30, 2021 14:42 Inactive
@jrhizor jrhizor temporarily deployed to more-secrets September 30, 2021 14:42 Inactive
@yevhenii-ldv
Copy link
Contributor Author

yevhenii-ldv commented Sep 30, 2021

/publish connector=connectors/source-salesforce

🕑 connectors/source-salesforce https://github.com/airbytehq/airbyte/actions/runs/1291575024
❌ connectors/source-salesforce https://github.com/airbytehq/airbyte/actions/runs/1291575024

@yevhenii-ldv yevhenii-ldv temporarily deployed to more-secrets September 30, 2021 15:03 Inactive
@jrhizor jrhizor temporarily deployed to more-secrets September 30, 2021 15:04 Inactive
@yevhenii-ldv
Copy link
Contributor Author

yevhenii-ldv commented Sep 30, 2021

/publish connector=connectors/source-salesforce

🕑 connectors/source-salesforce https://github.com/airbytehq/airbyte/actions/runs/1291623978
✅ connectors/source-salesforce https://github.com/airbytehq/airbyte/actions/runs/1291623978

@jrhizor jrhizor temporarily deployed to more-secrets September 30, 2021 15:17 Inactive
@yevhenii-ldv yevhenii-ldv merged commit 65d62eb into master Sep 30, 2021
@yevhenii-ldv yevhenii-ldv deleted the ykurochkin/annotate-oauth-init-parameters-for-initial-cloud-release branch September 30, 2021 15:29
schlattk pushed a commit to schlattk/airbyte that referenced this pull request Jan 4, 2022
* Annotate Oauth init parameters for connectors: Facebook Marketing/Pages, Instagram, Salesforce
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
8 participants