-
Notifications
You must be signed in to change notification settings - Fork 112
chore!: @google-cloud/storage package upgrade from v1.5.2 to v7.16 #683
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
base: master
Are you sure you want to change the base?
chore!: @google-cloud/storage package upgrade from v1.5.2 to v7.16 #683
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @Itzaprado, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request primarily focuses on a critical upgrade of the @google-cloud/storage
library to its latest major version. This substantial version bump required adapting the existing Google Cloud Storage integration code to align with the new library's API. The changes also introduce more robust error handling and better metadata management for uploaded files, ensuring continued compatibility and improving the overall reliability of GCS operations.
Highlights
- Dependency Upgrade: Upgraded the
@google-cloud/storage
package from version1.5.2
to7.16.0
, a significant major version jump that brings the library up to date. - GCS Client Configuration: Updated the Google Cloud Storage client instantiation to explicitly include
apiEndpoint: "https://storage.googleapis.com"
anduseAuthWithCustomEndpoint: true
. This ensures proper authentication and connectivity with the updated library. - File Metadata Handling: Enhanced the file upload process by adding
contentType
to the metadata of files uploaded viacreateWriteStream
. This ensures the correct MIME type is set for uploaded objects, using the attachment's MIME type if available, or defaulting toapplication/octet-stream
. - Error Handling Improvements: Improved error logging for both stream-specific errors during file upload and general upload failures, providing more descriptive messages for better debugging and issue resolution.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
Feature | Command | Description |
---|---|---|
Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/
folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
The pull request upgrades the @google-cloud/storage
package, adds API endpoint configuration, improves error messages, and includes content type in metadata. The changes look good, with some minor suggestions for improved clarity and maintainability.
@@ -42,6 +42,7 @@ class GoogleCloudStorageAction extends Hub.Action { | |||
]; | |||
} | |||
async execute(request) { | |||
var _a, _b; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
.on("error", (error) => { | ||
winston.error(`${LOG_PREFIX} Stream error: ${error.message}`, { error, webhookId: request.webhookId }); | ||
writeStream.end(); | ||
reject(error); | ||
}) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider adding a comment explaining why writeStream.end()
is called within the error handler. This clarifies the intent, especially if it's related to resource cleanup or preventing further writes after an error.
winston.error(`${LOG_PREFIX} Stream error: ${error.message}`, { error, webhookId: request.webhookId });
writeStream.end(); // Ensure stream is closed after an error
reject(error);
.on("error", (error: any) => { | ||
winston.error(`${LOG_PREFIX} Stream error: ${error.message}`, {error, webhookId: request.webhookId}) | ||
writeStream.end() | ||
reject(error) | ||
}) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider adding a comment explaining why writeStream.end()
is called within the error handler. This clarifies the intent, especially if it's related to resource cleanup or preventing further writes after an error.
.on("error", (error: any) => { | |
winston.error(`${LOG_PREFIX} Stream error: ${error.message}`, {error, webhookId: request.webhookId}) | |
writeStream.end() | |
reject(error) | |
}) | |
.on("error", (error: any) => { | |
winston.error(`${LOG_PREFIX} Stream error: ${error.message}`, {error, webhookId: request.webhookId}) | |
writeStream.end() // Ensure stream is closed after an error | |
reject(error) | |
}) |
Change log:
[ ] Package upgrade from v1.5.2 to v7.16
[ ] add apiEndpoint to GCS client creation
[ ] add useAuthWithCustomEndpoint : true to allow auth connection
[ ] add better error messages when uploading file
[ ] add contentType to metadata object in the stream creation