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(GCS): set the response headers accordingly #9858

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

imscytha
Copy link

Change Summary

use the appropriate properties for setting the response headers in options object when requesting the signed url (based on the GetSignedUrlConfig interface).

Reference:
https://cloud.google.com/nodejs/docs/reference/storage/latest/storage/getsignedurlconfig

Change type

  • feat: (new feature for the user, not a new feature for build script)
  • fix: (bug fix for the user, not a fix to a build script)
  • docs: (changes to the documentation)
  • style: (formatting, missing semi colons, etc; no production code change)
  • refactor: (refactoring production code, eg. renaming a variable)
  • test: (adding missing tests, refactoring tests; no production code change)
  • chore: (updating grunt tasks etc; no production code change)

Additional information / screenshots (optional)

I setup Google Cloud Storage as my Storage Provider.
While the files would get uploaded correctly in the Google Cloud Storage Bucket,
when retrieving the file I encountered issue ref: #9350. I was getting the following 400 Bad Request response from Google Storage API:

<Error>
<Code>MalformedSecurityHeader</Code>
<Message>Invalid argument.</Message>
<Details>Your request has a malformed header. Header was included in signedheaders, but not in the request.</Details>
<ParameterName>responsecontentdisposition</ParameterName>
</Error>

That's when I started to checkout the signedURL generation, and updated the GetSignedUrlConfig object being passed as options when calling getSignedUrl from Google Cloud Storage Client, as they are defined in the reference i have provided above.

With this addition it respects the Content-Type and Content-Disposition headers, as they get set correctly on the response from Google Cloud Storage, and getting the files from the bucket works without resolving a Bad Request.

use the appropriate properties for setting the response headers in
options object when requesting the signed url (based on the
GetSignedUrlConfig interface).

Reference:
https://cloud.google.com/nodejs/docs/reference/storage/latest/storage/getsignedurlconfig

related to nocodb#9350
@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Nov 19, 2024
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


Roni Bytyqi seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link
Contributor

coderabbitai bot commented Nov 19, 2024

📝 Walkthrough

Walkthrough

The pull request introduces modifications to the Gcs class in the Gcs.ts file, specifically updating the getSignedUrl and fileCreateByUrl methods. The getSignedUrl method now includes new parameters for better handling of response headers, while the fileCreateByUrl method has a default value for its fetchOptions parameter. These changes enhance the functionality related to signed URLs and file creation from URLs.

Changes

File Path Change Summary
packages/nocodb/src/plugins/gcs/Gcs.ts - Updated getSignedUrl method to modify internal handling of pathParameters.
- Updated fileCreateByUrl method to include a default value for fetchOptions.

Possibly related PRs

  • fix: gcs uniform bucket_level access #9734: The changes in this PR also modify methods within the Gcs class in Gcs.ts, specifically related to file creation, which may interact with the updated fileCreateByUrl method in the main PR.

Suggested labels

🐛 Type: Bug, size:S, lgtm

Suggested reviewers

  • mertmit

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.

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.

@dosubot dosubot bot added the 🐛 Type: Bug Something is broken or incorrect unexpectedly. label Nov 19, 2024
@dstala dstala requested a review from pranavxc November 19, 2024 12:00
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 (1)
packages/nocodb/src/plugins/gcs/Gcs.ts (1)

182-183: LGTM! Consider adding type safety for response parameters.

The change correctly implements the response headers using the official GetSignedUrlConfig properties instead of custom headers, which resolves the 400 Bad Request error. This aligns with the Google Cloud Storage documentation.

Consider adding type safety for the path parameters to ensure correct header names are used:

- pathParameters?: { [key: string]: string }
+ pathParameters?: {
+   ResponseContentDisposition?: string;
+   ResponseContentType?: string;
+ }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 8f49b49 and cc564fa.

📒 Files selected for processing (1)
  • packages/nocodb/src/plugins/gcs/Gcs.ts (1 hunks)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size:XS This PR changes 0-9 lines, ignoring generated files. 🐛 Type: Bug Something is broken or incorrect unexpectedly.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants