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 Zoom: Replace JWT Auth methods with server-to-server Oauth #25308

Merged
merged 2 commits into from
Aug 1, 2023
Merged

Source Zoom: Replace JWT Auth methods with server-to-server Oauth #25308

merged 2 commits into from
Aug 1, 2023

Conversation

KqLLL
Copy link
Contributor

@KqLLL KqLLL commented Apr 19, 2023

What

Describe what the change is solving
Update the Auth method

Resolve Issue #23268

According to the document, the Zoom JWT auth methods will be deprecated on June 1, 2023. The Zoom source connector only supports JWT and will stop working at that time.

https://marketplace.zoom.us/docs/guides/build/jwt-app/jwt-faq/

How

Describe the solution

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?

For connector PRs, use this section to explain which type of semantic versioning bump occurs as a result of the changes. Refer to our Semantic Versioning for Connectors guidelines for more information. Breaking changes to connectors must be documented by an Airbyte engineer (PR author, or reviewer for community PRs) by using the Breaking Change Release Playbook.

If there are breaking changes, 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
  • Connector version is set to 0.0.1
    • Dockerfile has version 0.0.1
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/integrations/<source or destination>/<name>.md including changelog with an entry for the initial version. 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

  • Connector version has been incremented

  • Documentation updated

    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • Changelog updated in docs/integrations/<source or destination>/<name>.md with an entry for the new version. 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

@octavia-squidington-iii octavia-squidington-iii added area/connectors Connector related issues area/documentation Improvements or additions to documentation bounty community connectors/source/zoom labels Apr 19, 2023
@marcosmarxm marcosmarxm changed the title Replace JWT Auth methods with server-to-server Oauth Source Zoom: Replace JWT Auth methods with server-to-server Oauth Apr 20, 2023
@KqLLL KqLLL requested a review from marcosmarxm April 25, 2023 01:08
sajarin
sajarin suggested changes May 30, 2023
View reviewed changes
Copy link
Contributor

@sajarin sajarin left a comment

Choose a reason for hiding this comment

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

Thanks for this PR @KqLLL we really appreciate it. We're unable to test this PR without credentials, so we're waiting for those credentials to be generated.

In the meantime, can you bump the versions in the Dockerfile and metadata.yaml for the Zoom connector? Please keep in mind we follow semantic versioning and this would be considered a major change.

@KqLLL
Copy link
Contributor Author

KqLLL commented May 31, 2023

Thanks for this PR @KqLLL we really appreciate it. We're unable to test this PR without credentials, so we're waiting for those credentials to be generated.

In the meantime, can you bump the versions in the Dockerfile and metadata.yaml for the Zoom connector? Please keep in mind we follow semantic versioning and this would be considered a major change.

I have updated these versions in Dockerfile and metadata.yaml.
Would you mind confirming if I'm doing this correctly?

Just a gentle reminder, if you take some time to study the Zoom API, you might notice that the data provided by the Zoom connector appears to be inaccurate.

@KqLLL KqLLL requested a review from sajarin June 1, 2023 06:32
@jrolom jrolom removed the bounty label Jun 9, 2023
@marcosmarxm marcosmarxm added the team/tse Technical Support Engineers label Jun 27, 2023
@RobinHerzog
Copy link

Can please someone merge ? JWT does not exist

@marcosmarxm
Copy link
Member

Hello, we're going to prioritize the review of this contribution next week.

marcosmarxm
marcosmarxm reviewed Jul 19, 2023
View reviewed changes
Copy link
Member

@marcosmarxm marcosmarxm left a comment

Choose a reason for hiding this comment

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

Hello 👋 I'm working to get Airbyte's test account to use the new Oauth method. I'm going to return the review after we get them.

@marcosmarxm
Copy link
Member

@KqLLL still waiting to have the server-to-server Oauth enabled in our integration account. Hope this week we can have a return.

@marcosmarxm
Copy link
Member

The internal ticket created to our infra team was moved to next sprint. Hope to get this unblock next week. @KqLLL are you available to make a call and maybe show me the connector working in your side?

@KqLLL
Copy link
Contributor Author

KqLLL commented Jul 27, 2023

The internal ticket created to our infra team was moved to next sprint. Hope to get this unblock next week. @KqLLL are you available to make a call and maybe show me the connector working in your side?

Ok, I can show a snapshot of my connector working.

Set in the source dashboard.
image

Job history.
image

@KqLLL KqLLL requested a review from marcosmarxm July 27, 2023 02:39
marcosmarxm
marcosmarxm requested changes Jul 27, 2023
View reviewed changes
Copy link
Member

@marcosmarxm marcosmarxm left a comment

Choose a reason for hiding this comment

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

Can you update the documentation with the note and the Changelog with the new version?

marcosmarxm
marcosmarxm requested changes Jul 27, 2023
View reviewed changes
Copy link
Member

@marcosmarxm marcosmarxm left a comment

Choose a reason for hiding this comment

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

Some comments and we're good to merge the contribution. I'm still working to get credentials from our side but probably we can merge before that.

@KqLLL KqLLL requested a review from marcosmarxm July 28, 2023 03:13
marcosmarxm
marcosmarxm approved these changes Jul 31, 2023
View reviewed changes
Copy link
Member

@marcosmarxm marcosmarxm left a comment

Choose a reason for hiding this comment

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

Thanks @KqLLL

@marcosmarxm
Copy link
Member

/approve-and-merge reason="Today Airbyte doesnt have a separated Zoom account for only tests purpose. User showed their code implementation is working and also its using the low-code. For future I created a Github issue to have a Zoom credentials working"

@octavia-approvington
Copy link
Contributor

Check that box
TODO complete

@octavia-approvington octavia-approvington merged commit 4544eb5 into airbytehq:master Aug 1, 2023
bnchrch pushed a commit that referenced this pull request Aug 3, 2023
@KqLLL @bnchrch
Source Zoom: Replace JWT Auth methods with server-to-server Oauth (#2…
07913cb 
…5308)

* Replace JWT Auth methods with server-to-server Oauth

* Bump versions in the Dockerfile and metadata.yaml
@DiegoPiloni
Copy link

DiegoPiloni commented Sep 7, 2023 •
edited
Loading

Hi @marcosmarxm @KqLLL, thanks a lot for this work ! Do you have any idea why version 1.0.0 is not in dockerhub ?

@jcolinger3
Copy link

Hi @marcosmarxm @KqLLL, thanks a lot for this work ! Do you have any idea why version 1.0.0 is not in dockerhub ?

I'm wondering the same. @DiegoPiloni did you see any change?

@DiegoPiloni
Copy link

@jcolinger3 What I understand is that #30361 still needs to be approved and merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marcosmarxm marcosmarxm marcosmarxm approved these changes

@octavia-approvington octavia-approvington octavia-approvington approved these changes

@sajarin sajarin Awaiting requested review from sajarin

Assignees
No one assigned
Labels
area/connectors Connector related issues area/documentation Improvements or additions to documentation community connectors/source/zoom team/tse Technical Support Engineers
Projects
No open projects
Community Contributed PRs
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Source Zoom: JWT auth methods will be deprecated soon
9 participants
@KqLLL @RobinHerzog @marcosmarxm @octavia-approvington @DiegoPiloni @jcolinger3 @sajarin @octavia-squidington-iii @jrolom