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

🎉 New Destination: Implement Destination Google Sheets using CDK #12135

Merged
merged 46 commits into from
May 11, 2022

Conversation

bazarnov
Copy link
Collaborator

@bazarnov bazarnov commented Apr 19, 2022

What

Resolving: #11918

How

  • based on the Scoping Document implemented the Destination Google Sheets using Airbyte Python CDK

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • 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:destination-google-sheets:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/SUMMARY.md
    • docs/integrations/destination/google-sheets.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

@bazarnov bazarnov self-assigned this Apr 19, 2022
@github-actions github-actions bot added the area/connectors Connector related issues label Apr 19, 2022
@bazarnov bazarnov linked an issue Apr 19, 2022 that may be closed by this pull request
4 tasks
@bazarnov bazarnov temporarily deployed to more-secrets April 19, 2022 12:43 Inactive
@bazarnov bazarnov temporarily deployed to more-secrets April 19, 2022 12:43 Inactive
@bazarnov bazarnov temporarily deployed to more-secrets April 21, 2022 00:43 Inactive
@bazarnov bazarnov temporarily deployed to more-secrets April 21, 2022 00:43 Inactive
@bazarnov bazarnov requested a review from sherifnada May 6, 2022 13:56
@sherifnada sherifnada requested a review from Phlair May 6, 2022 23:57
@sherifnada
Copy link
Contributor

@bazarnov wasn't able to review today, assigning @Phlair to review since I'm out next week

@bazarnov bazarnov removed the request for review from sherifnada May 9, 2022 10:47
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.

This is looking great!

No major blocking comments, but mainly around correctness & thus readability.

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.

Requesting change after reading the scoping doc:

  • We need to gracefully handle the case where there are more than 200 streams as described in this comment thread. We should also integration test this behaviour.

@bazarnov
Copy link
Collaborator Author

bazarnov commented May 10, 2022

  • this comment thread

As for this part, I'm completely aware this is the biggest limitation at this moment. We need to understand how customers will use the connector first (a lot of data vs small data amounts, one time syncs vs continuous sync process) before we try to workaround this. There are couple of ways how this could be handled correctly, however we need to understand how to deliver the new spreadsheet or new worksheet to customer for this to be effective.

it's should be agreed with the @sherifnada we go this way, correct me if I'm wrong here.
From the comment in the scoping doc:

In either case, we need to make it very very clear to the user in the UI & docs that the connector can only write 200 streams
due to limitations from Google. We should also mention the connector is in alpha, and that this limitation will be worked
around in subsequent version when it goes to beta/GA by splitting the output streams across multiple sheets.

The documentation describes these limitations, so the customer should be informed.
Also, i've added the streams limitation logic and the test to cover this case.

@bazarnov
Copy link
Collaborator Author

bazarnov commented May 10, 2022

/test connector=connectors/destination-google-sheets

🕑 connectors/destination-google-sheets https://github.com/airbytehq/airbyte/actions/runs/2300991763
✅ connectors/destination-google-sheets https://github.com/airbytehq/airbyte/actions/runs/2300991763
Python tests coverage:

Name                                       Stmts   Miss  Cover
--------------------------------------------------------------
destination_google_sheets/buffer.py           27      0   100%
destination_google_sheets/__init__.py          2      0   100%
destination_google_sheets/writer.py           41      1    98%
destination_google_sheets/client.py           25      1    96%
destination_google_sheets/spreadsheet.py      46      2    96%
destination_google_sheets/helpers.py          47      4    91%
destination_google_sheets/destination.py      46      8    83%
--------------------------------------------------------------
TOTAL                                        234     16    93%

@bazarnov bazarnov temporarily deployed to more-secrets May 10, 2022 13:37 Inactive
@bazarnov bazarnov temporarily deployed to more-secrets May 10, 2022 13:37 Inactive
@bazarnov bazarnov requested a review from Phlair May 10, 2022 13:37
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.

LGTM! Thanks for making the changes 🚀

@bazarnov bazarnov temporarily deployed to more-secrets May 11, 2022 21:17 Inactive
@bazarnov bazarnov temporarily deployed to more-secrets May 11, 2022 21:17 Inactive
@bazarnov bazarnov temporarily deployed to more-secrets May 11, 2022 21:57 Inactive
@bazarnov bazarnov temporarily deployed to more-secrets May 11, 2022 21:57 Inactive
@bazarnov
Copy link
Collaborator Author

bazarnov commented May 11, 2022

/publish connector=connectors/destination-google-sheets

🕑 connectors/destination-google-sheets https://github.com/airbytehq/airbyte/actions/runs/2309943301
🚀 Successfully published connectors/destination-google-sheets
🚀 Auto-bumped version for connectors/destination-google-sheets
✅ connectors/destination-google-sheets https://github.com/airbytehq/airbyte/actions/runs/2309943301

@bazarnov bazarnov merged commit feb0d2f into master May 11, 2022
@bazarnov bazarnov deleted the bazarnov/11918-destination-google-sheets branch May 11, 2022 22:10
@octavia-squidington-iii octavia-squidington-iii temporarily deployed to more-secrets May 11, 2022 22:11 Inactive
@octavia-squidington-iii octavia-squidington-iii temporarily deployed to more-secrets May 11, 2022 22:12 Inactive
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 area/platform issues related to the platform
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🎉 New Destination: Google Sheets [Python CDK]
6 participants