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 Slack: Implement OAuth support with OAuth authenticator #6570

Merged
merged 5 commits into from
Oct 7, 2021

Conversation

yevhenii-ldv
Copy link
Contributor

What

closes #6256 .

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 30, 2021
@yevhenii-ldv
Copy link
Contributor Author

yevhenii-ldv commented Sep 30, 2021

/test connector=connectors/source-slack

🕑 connectors/source-slack https://github.com/airbytehq/airbyte/actions/runs/1290994004

@jrhizor jrhizor temporarily deployed to more-secrets September 30, 2021 12:23 Inactive
@@ -101,6 +108,7 @@ We recommend creating a restricted, read-only key specifically for Airbyte acces

| Version | Date | Pull Request | Subject |
| :------ | :-------- | :----- | :------ |
| 0.1.12 | 2021-08-?? | [????](https://github.com/airbytehq/airbyte/pull/????) | Implement OAuth support with OAuth authenticator |
Copy link
Contributor

Choose a reason for hiding this comment

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

don't forget to replace it

airbyte-integrations/connectors/source-slack/setup.py Outdated Show resolved Hide resolved
@yevhenii-ldv yevhenii-ldv changed the title Source Slack: Implement OAuth support with OAuth authenticator 🎉 Source Slack: Implement OAuth support with OAuth authenticator Sep 30, 2021
@yevhenii-ldv
Copy link
Contributor Author

yevhenii-ldv commented Sep 30, 2021

/test connector=connectors/source-slack

🕑 connectors/source-slack https://github.com/airbytehq/airbyte/actions/runs/1292259722
✅ connectors/source-slack https://github.com/airbytehq/airbyte/actions/runs/1292259722
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              197     93    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                                                  853    415    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 -----------
	 Coverage.py warning: No data was collected. (no-data-collected)
	 Name                       Stmts   Miss  Cover
	 ----------------------------------------------
	 source_slack/__init__.py       2      2     0%
	 source_slack/source.py       187    187     0%
	 ----------------------------------------------
	 TOTAL                        189    189     0%
	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                       Stmts   Miss  Cover
	 ----------------------------------------------
	 source_slack/__init__.py       2      2     0%
	 source_slack/source.py       187    187     0%
	 ----------------------------------------------
	 TOTAL                        189    189     0%

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

yevhenii-ldv commented Oct 1, 2021

/test connector=connectors/source-slack

🕑 connectors/source-slack https://github.com/airbytehq/airbyte/actions/runs/1295089981
✅ connectors/source-slack https://github.com/airbytehq/airbyte/actions/runs/1295089981
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              197     93    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                                                  853    415    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_slack/__init__.py       2      2     0%
	 source_slack/source.py       187    187     0%
	 ----------------------------------------------
	 TOTAL                        189    189     0%
	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                       Stmts   Miss  Cover
	 ----------------------------------------------
	 source_slack/__init__.py       2      2     0%
	 source_slack/source.py       187    187     0%
	 source_slack/source.py       187    187     0%Coverage.py warning: No data was collected. (no-data-collected)
	 ----------------------------------------------
	 TOTAL                        189    189     0%

@yevhenii-ldv yevhenii-ldv temporarily deployed to more-secrets October 1, 2021 12:48 Inactive
@jrhizor jrhizor temporarily deployed to more-secrets October 1, 2021 12:49 Inactive
if credentials_title == "Default OAuth2.0 authorization":
# We can get `refresh_token` only if the token rotation function is enabled for the Slack Application.
# If it is disabled, then we use the generated `access_token`, which acts without expiration.
if credentials.get("refresh_token", "").strip():
Copy link
Contributor

Choose a reason for hiding this comment

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

we should use the option name, as that is the only thing guaranteed to be uniquely present

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There is a fork here that needs to be handled. If Token rotation is enabled for the application, then in the response to the oauth.v2.access request we will receive both Access token(which expires after some time) and Refresh token(with which we can create a new Access token).
However, if the Token rotation function is disabled for the application, then in this case we will receive only Access token in the response to oauth.v2.access and it will be unlimited.
For this reason, we cannot indicate in the specification that Refresh Token is a required field (since it simply may not exist) and we cannot remove Access Token from required (since it may be unlimited and we will need to use it).

"type": "object",
"title": "OAuth2.0 authorization",
"required": [
"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.

refresh token is the required one since it can be used to generate access tokens

Suggested change
"access_token",
"refresh_token",

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Comment above

docs/integrations/sources/slack.md Show resolved Hide resolved
docs/integrations/sources/slack.md Outdated Show resolved Hide resolved
"examples": ["slack-client-secret-example"],
"airbyte_secret": true
},
"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.

i suggest we remove the access token since it expires anyways, and just rely on refresh token

Copy link
Contributor Author

Choose a reason for hiding this comment

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

comment above

@@ -285,16 +284,36 @@ def request_body_json(self, stream_slice: Mapping = None, **kwargs) -> Optional[


class SourceSlack(AbstractSource):
def _get_authenticator(self, config: Mapping[str, Any]):
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 backwards compatible with the previous config format to prevent a breaking change for current users

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added backward compatibility, but for this it was necessary to remove credentials from required.
@avida described this issue in more detail in this comment.

@yevhenii-ldv yevhenii-ldv temporarily deployed to more-secrets October 6, 2021 14:01 Inactive
@yevhenii-ldv
Copy link
Contributor Author

yevhenii-ldv commented Oct 6, 2021

/test connector=connectors/source-slack

🕑 connectors/source-slack https://github.com/airbytehq/airbyte/actions/runs/1312237943
✅ connectors/source-slack https://github.com/airbytehq/airbyte/actions/runs/1312237943
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              197     93    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                                                  853    415    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_slack/__init__.py       2      2     0%
	 source_slack/source.py       189    189     0%
	 ----------------------------------------------
	 TOTAL                        191    191     0%
	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                       Stmts   Miss  Cover
	 ----------------------------------------------
	 Name                       Stmts   Miss  Cover/actions-runner/_work/airbyte/airbyte/airbyte-integrations/connectors/source-slack/.venv/lib/python3.8/site-packages/coverage/control.py:761: CoverageWarning: No data was collected. (no-data-collected)
	   self._warn("No data was collected.", slug="no-data-collected")
	 source_slack/__init__.py       2      2     0%
	 source_slack/source.py       189    189     0%
	 ----------------------------------------------
	 TOTAL                        191    191     0%

@jrhizor jrhizor temporarily deployed to more-secrets October 6, 2021 14:12 Inactive
credentials = config.get("credentials")
credentials_title = credentials.get("option_title")
if credentials_title == "Default OAuth2.0 authorization":
# We can get `refresh_token` only if the token rotation function is enabled for the Slack Application.
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
# We can get `refresh_token` only if the token rotation function is enabled for the Slack Application.
# We can get `refresh_token` only if the token rotation function is enabled for the Slack Oauth Application.

@yevhenii-ldv
Copy link
Contributor Author

yevhenii-ldv commented Oct 7, 2021

/publish connector=connectors/source-slack

🕑 connectors/source-slack https://github.com/airbytehq/airbyte/actions/runs/1315624616
❌ connectors/source-slack https://github.com/airbytehq/airbyte/actions/runs/1315624616

@yevhenii-ldv yevhenii-ldv temporarily deployed to more-secrets October 7, 2021 09:44 Inactive
@jrhizor jrhizor temporarily deployed to more-secrets October 7, 2021 09:46 Inactive
@yevhenii-ldv
Copy link
Contributor Author

yevhenii-ldv commented Oct 7, 2021

/publish connector=connectors/source-slack

🕑 connectors/source-slack https://github.com/airbytehq/airbyte/actions/runs/1315737146
✅ connectors/source-slack https://github.com/airbytehq/airbyte/actions/runs/1315737146

@yevhenii-ldv yevhenii-ldv temporarily deployed to more-secrets October 7, 2021 10:19 Inactive
@jrhizor jrhizor temporarily deployed to more-secrets October 7, 2021 10:19 Inactive
@yevhenii-ldv yevhenii-ldv merged commit 00d56e7 into master Oct 7, 2021
@yevhenii-ldv yevhenii-ldv deleted the ykurochkin/slack-oauth-support branch October 7, 2021 11:01
schlattk pushed a commit to schlattk/airbyte that referenced this pull request Jan 4, 2022
…bytehq#6570)

* Source Slack: Implement OAuth support with OAuth authenticator
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 Slack: support Oauth
6 participants