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

fix: shared drive support added for google sheets #37602

Merged
merged 1 commit into from
Nov 20, 2024

Conversation

sneha122
Copy link
Contributor

@sneha122 sneha122 commented Nov 20, 2024

Description

This PR adds support for accessing shared drive files for google sheets integration

Fixes #37598
or
Fixes Issue URL

Warning

If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.

Automation

/ok-to-test tags="@tag.Datasource"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/11934080947
Commit: ac6eade
Cypress dashboard.
Tags: @tag.Datasource
Spec:


Wed, 20 Nov 2024 13:51:58 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

  • Yes
  • No

Summary by CodeRabbit

  • New Features

    • Enhanced API requests for Google Sheets and Drive to include items from all drives.
  • Bug Fixes

    • Improved data retrieval processes by adjusting query parameters for API calls.

Copy link
Contributor

coderabbitai bot commented Nov 20, 2024

Walkthrough

The changes in this pull request involve modifications to the URI construction in the getExecutionClient methods of the FileInfoMethod and FileListMethod classes within the Google Sheets plugin. The updates include the addition of the query parameter supportsAllDrives=true and includeItemsFromAllDrives=true, enhancing the API requests to accommodate all drives in Google Drive. The overall structure and error handling of the methods remain unchanged.

Changes

File Change Summary
app/server/appsmith-plugins/googleSheetsPlugin/src/main/java/com/external/config/FileInfoMethod.java Updated URI in getExecutionClient to include supportsAllDrives=true.
app/server/appsmith-plugins/googleSheetsPlugin/src/main/java/com/external/config/FileListMethod.java Updated URI in getExecutionClient to include includeItemsFromAllDrives=true and supportsAllDrives=true.

Assessment against linked issues

Objective Addressed Explanation
Check if Google APIs provide support for shared drive for Google sheets integration (#37598)

Possibly related PRs

Suggested labels

DailyPromotionBlocker

Suggested reviewers

  • ApekshaBhosale
  • NilanshBansal
  • sneha122

🎉 In the realm of code, where APIs play,
A tweak here and there, brightens the day!
With drives all supported, the data flows free,
Google Sheets integration, as smooth as can be!
So here's to the changes, both clever and neat,
In the world of development, we can't be beat! 🚀


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@sneha122 sneha122 added the ok-to-test Required label for CI label Nov 20, 2024
@github-actions github-actions bot added the Bug Something isn't working label Nov 20, 2024
@sneha122
Copy link
Contributor Author

/build-deploy-preview skip-tests=true

Copy link

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/11934033608.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 37602.
recreate: .

@github-actions github-actions bot added Google Sheets Issues related to Google Sheets Integrations Pod General Issues related to the Integrations Pod that don't fit into other tags. Integrations Product Issues related to a specific integration Query & JS Pod Issues related to the query & JS Pod Task A simple Todo labels Nov 20, 2024
@sneha122 sneha122 marked this pull request as ready for review November 20, 2024 13:08
@sneha122 sneha122 added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels Nov 20, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
app/server/appsmith-plugins/googleSheetsPlugin/src/main/java/com/external/config/FileListMethod.java (1)

Line range hint 1-100: Consider extracting API URL construction to a dedicated utility class

Since both FileListMethod and FileInfoMethod handle Google Drive API URLs with similar parameters, consider creating a shared utility class to manage URL construction.

This would:

  • Centralize shared drive configuration
  • Make future API parameter updates easier to maintain
  • Reduce code duplication
app/server/appsmith-plugins/googleSheetsPlugin/src/main/java/com/external/config/FileInfoMethod.java (1)

105-105: Consider using UriComponentsBuilder for query parameters

Instead of string concatenation, consider using UriComponentsBuilder's queryParam method for better URL encoding and maintainability.

-                methodConfig.getSpreadsheetId()
-                        + "?supportsAllDrives=true&fields=id,name,permissions/role,permissions/emailAddress,createdTime,modifiedTime");
+                methodConfig.getSpreadsheetId());
+        uriBuilder.queryParam("supportsAllDrives", true)
+                  .queryParam("fields", "id,name,permissions/role,permissions/emailAddress,createdTime,modifiedTime");
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7b81c3e and ac6eade.

📒 Files selected for processing (2)
  • app/server/appsmith-plugins/googleSheetsPlugin/src/main/java/com/external/config/FileInfoMethod.java (1 hunks)
  • app/server/appsmith-plugins/googleSheetsPlugin/src/main/java/com/external/config/FileListMethod.java (1 hunks)
🔇 Additional comments (2)
app/server/appsmith-plugins/googleSheetsPlugin/src/main/java/com/external/config/FileListMethod.java (1)

43-43: LGTM! Verify shared drive access permissions

The addition of includeItemsFromAllDrives and supportsAllDrives parameters correctly implements shared drive support.

Please ensure that:

  1. The application has the necessary OAuth scopes for shared drive access
  2. Error handling adequately covers shared drive permission denied scenarios
app/server/appsmith-plugins/googleSheetsPlugin/src/main/java/com/external/config/FileInfoMethod.java (1)

105-105: LGTM: Shared drive support correctly implemented

The addition of supportsAllDrives=true properly enables shared drive access as per Google Drive API specifications.

Copy link

Deploy-Preview-URL: https://ce-37602.dp.appsmith.com

Copy link
Contributor

@NilanshBansal NilanshBansal left a comment

Choose a reason for hiding this comment

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

LGTM

@sneha122 sneha122 merged commit f21ec5e into release Nov 20, 2024
59 of 64 checks passed
@sneha122 sneha122 deleted the fix/gs-shared-drive-support branch November 20, 2024 14:23
github-actions bot pushed a commit to Zeral-Zhang/appsmith that referenced this pull request Nov 27, 2024
## Description
This PR adds support for accessing shared drive files for google sheets
integration


Fixes appsmithorg#37598 
_or_  
Fixes `Issue URL`
> [!WARNING]  
> _If no issue exists, please create an issue first, and check with the
maintainers if the issue is valid._

## Automation

/ok-to-test tags="@tag.Datasource"

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/11934080947>
> Commit: ac6eade
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=11934080947&attempt=1"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.Datasource`
> Spec:
> <hr>Wed, 20 Nov 2024 13:51:58 UTC
<!-- end of auto-generated comment: Cypress test results  -->


## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [x] No


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Enhanced API requests for Google Sheets and Drive to include items
from all drives.
  
- **Bug Fixes**
- Improved data retrieval processes by adjusting query parameters for
API calls.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Co-authored-by: “sneha122” <“[email protected]”>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working Google Sheets Issues related to Google Sheets Integrations Pod General Issues related to the Integrations Pod that don't fit into other tags. Integrations Product Issues related to a specific integration ok-to-test Required label for CI Query & JS Pod Issues related to the query & JS Pod Task A simple Todo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Task]: Check if Google APIs provide support for shared drive for Google sheets integration
2 participants