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

Consider drive root to be a folder when syncing onedrive/sharepoint #703

Merged
merged 1 commit into from
Sep 20, 2024

Conversation

amuwal
Copy link
Collaborator

@amuwal amuwal commented Sep 17, 2024

Summary by CodeRabbit

  • New Features

    • Introduced functionality to retrieve root folder data from OneDrive and SharePoint, enhancing folder management capabilities.
    • Added optional root property to OnedriveFolderInput and SharepointFolderInput interfaces for better handling of folder structures.
  • Documentation

    • Updated comments to clarify permissions associated with shared links in SharePoint.

@naelob
Copy link
Contributor

naelob commented Sep 17, 2024

Qovery Preview

Qovery can create a Preview Environment for this PR.
To trigger its creation, please post a comment with one of the following command.

Command Blueprint environment
/qovery preview 783d0240-ec38-4387-a9a9-8e225f1bd3e1 dev
/qovery preview {all|UUID1,UUID2,...} To preview multiple environments

This comment has been generated from Qovery AI 🤖.
Below, a word from its wisdom :

There are two hard problems in computer science: naming things, cache invalidation and off-by-1 errors

Copy link

changeset-bot bot commented Sep 17, 2024

⚠️ No Changeset found

Latest commit: 7ae8489

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@CLAassistant
Copy link

CLAassistant commented Sep 17, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

coderabbitai bot commented Sep 17, 2024

Walkthrough

Walkthrough

The changes involve enhancements to the OnedriveService and SharepointService classes, specifically adding functionality to retrieve root folder data from OneDrive and SharePoint, respectively. Both services now make asynchronous HTTP GET requests to their respective APIs to obtain root folder information, which is then integrated into their result arrays. Additionally, both services introduce a new optional root property in their folder input interfaces to indicate whether a driveItem is the top-most item in the folder hierarchy.

Changes

File Path Change Summary
packages/api/src/filestorage/folder/services/onedrive/index.ts Enhanced OnedriveService to retrieve root folder data from OneDrive and include it in the result array.
packages/api/src/filestorage/folder/services/onedrive/types.ts Added optional readonly root? property to OnedriveFolderInput interface.
packages/api/src/filestorage/folder/services/sharepoint/index.ts Enhanced SharepointService to retrieve root folder data from SharePoint and include it in the result array.
packages/api/src/filestorage/folder/services/sharepoint/types.ts Added optional readonly root? property to SharepointFolderInput interface.

Possibly related PRs

  • feat: Add integration with: Sharepoint #693: The changes in the SharepointService class to retrieve the root folder data from SharePoint are closely related to the enhancements made in the OnedriveService class for retrieving root folder data from OneDrive, indicating a parallel development in handling folder structures for both services.

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 generate interesting stats about this repository and render them as a table.
    -- @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 or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

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: 2

Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between df225e6 and 7ae8489.

Files selected for processing (4)
  • packages/api/src/filestorage/folder/services/onedrive/index.ts (1 hunks)
  • packages/api/src/filestorage/folder/services/onedrive/types.ts (1 hunks)
  • packages/api/src/filestorage/folder/services/sharepoint/index.ts (2 hunks)
  • packages/api/src/filestorage/folder/services/sharepoint/types.ts (1 hunks)
Additional comments not posted (4)
packages/api/src/filestorage/folder/services/sharepoint/index.ts (2)

83-94: LGTM!

The code segment correctly retrieves the root folder data from SharePoint by making an HTTP GET request to the appropriate API endpoint. The request includes the necessary headers and securely handles the access token using the cryptoService.


120-120: Documentation update looks good!

The updated comment clarifies that shared link permissions are also included in SharePoint permissions. This aligns the documentation with the actual functionality and helps improve the understanding of the service's behavior.

packages/api/src/filestorage/folder/services/onedrive/index.ts (2)

86-97: LGTM!

The code segment correctly retrieves the root folder data from OneDrive using an asynchronous HTTP GET request. The request URL, headers, and response handling are implemented properly.

This addition enhances the functionality by providing the necessary context for subsequent operations related to folder management in OneDrive.


99-99: Looks good!

Initializing the result array with the rootFolderData.data is a logical addition that ensures the root folder's data is included in the result set. This change aligns well with the overall functionality of the iterativeGetOnedriveFolders method.

Tools
Biome

[error] 99-101: Declare variables separately

Unsafe fix: Break out into multiple declarations

(lint/style/useSingleVarDeclarator)

Comment on lines +58 to +59
/** If this property is non-null, it indicates that the driveItem is the top-most driveItem in the drive. */
readonly root?: any;
Copy link
Contributor

Choose a reason for hiding this comment

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

LGTM! Consider using a more specific type if possible.

The addition of the root property enhances the OnedriveFolderInput interface by providing additional context about the state of the driveItem. The read-only nature of the property aligns with its purpose of indicating the top-most item in the drive hierarchy. The comment provides a clear explanation of the property's purpose, which is helpful for developers using this interface.

However, consider using a more specific type than any for the root property if possible, as it may provide better type safety and improve code maintainability.

Comment on lines +58 to +59
/** If this property is non-null, it indicates that the driveItem is the top-most driveItem in the drive. */
readonly root?: any;
Copy link
Contributor

Choose a reason for hiding this comment

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

Approve the addition of the root property, but consider defining a specific type.

The new root property enhances the SharepointFolderInput interface by allowing it to indicate whether the associated driveItem is the top-most item in the drive. This addition improves the interface's ability to represent the SharePoint folder structure accurately.

However, the any type for the root property might lead to inconsistencies or confusion. Consider defining a specific type, such as boolean, to clearly convey the expected values and improve type safety.

@naelob naelob merged commit a12f389 into panoratech:main Sep 20, 2024
10 of 14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants