-
Notifications
You must be signed in to change notification settings - Fork 13
Image processing updates #67
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
Conversation
To view this pull requests documentation preview, visit the following URL: docs.page/invertase/firebase-extensions~67 Documentation is deployed and generated using docs.page. |
a87d789
to
0096644
Compare
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.
Pull Request Overview
This PR updates the image-processing-api to work with nodejs20 and addresses several vulnerabilities while improving documentation.
- Migrates firebase-functions import from the default to the v1 version for compatibility.
- Updates the runtime in extension.yaml from nodejs14 to nodejs20.
- Refreshes documentation in README.md, PREINSTALL.md, and POSTINSTALL.md including a version bump in CHANGELOG.md.
Reviewed Changes
Copilot reviewed 8 out of 10 changed files in this pull request and generated 1 comment.
File | Description |
---|---|
functions/src/index.ts | Updates the firebase-functions import and handler definition |
extension.yaml | Updates runtime to nodejs20 and bumps the version |
README.md, PREINSTALL.md, POSTINSTALL.md | Improves documentation clarity and usage examples |
CHANGELOG.md | Records version bump and vulnerability fixes |
Files not reviewed (2)
- extensions/image-processing-api/functions/package.json: Language not supported
- package.json: Language not supported
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.
Pull Request Overview
This PR updates the image-processing API extension to support Node.js 20 and addresses several vulnerabilities while improving the documentation.
- Update to firebase-functions import and usage in index.ts for compatibility with Node.js 20
- Bump the extension version and change the runtime in extension.yaml
- Improve and update documentation in README.md, PREINSTALL.md, and POSTINSTALL.md to reflect the new API endpoint format
Reviewed Changes
Copilot reviewed 8 out of 10 changed files in this pull request and generated 1 comment.
Show a summary per file
File | Description |
---|---|
extensions/image-processing-api/functions/src/index.ts | Update to use firebase-functions/v1 and adjust https trigger |
extensions/image-processing-api/extension.yaml | Bump version and update runtime from nodejs14 to nodejs20 |
extensions/image-processing-api/README.md | Documentation improvements including example endpoint formats |
extensions/image-processing-api/PREINSTALL.md | Documentation updates to match the revised API usage |
extensions/image-processing-api/POSTINSTALL.md | Updated Cloud Function endpoint link with dynamic instance ID |
extensions/image-processing-api/CHANGELOG.md | Changelog updated to reflect the new version and fixes |
Files not reviewed (2)
- extensions/image-processing-api/functions/package.json: Language not supported
- package.json: Language not supported
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.
Pull Request Overview
This PR upgrades the image processing API to Node.js 20 and addresses several vulnerabilities while improving project documentation. Key changes include updating the firebase-functions import and function export syntax for Node.js 20 compatibility, bumping the extension version and runtime in the YAML configuration, and revising documentation samples in the README, PREINSTALL, and POSTINSTALL files.
Reviewed Changes
Copilot reviewed 8 out of 10 changed files in this pull request and generated no comments.
Show a summary per file
File | Description |
---|---|
extensions/image-processing-api/functions/src/index.ts | Updated firebase-functions import and export to use v1 syntax to support Node.js 20 and address vulnerabilities |
extensions/image-processing-api/extension.yaml | Bumped extension version and updated Cloud Functions runtime to nodejs20 |
extensions/image-processing-api/README.md | Revised documentation for endpoint usage and improved clarity of instructions |
extensions/image-processing-api/PREINSTALL.md | Updated install instructions to align with new API behavior and endpoint configuration |
extensions/image-processing-api/POSTINSTALL.md | Revised endpoint URLs in the sample links to reflect updated function naming and usage |
extensions/image-processing-api/CHANGELOG.md | Documented version bump and corresponding fixes |
Files not reviewed (2)
- extensions/image-processing-api/functions/package.json: Language not supported
- package.json: Language not supported
Comments suppressed due to low confidence (2)
extensions/image-processing-api/functions/src/index.ts:213
- Ensure that the update to firebase-functions/v1 and the removal of the 'handler' subproperty is fully compatible with the Node.js 20 runtime and that the function invocation remains consistent with deployment expectations.
exports.handler = functions.https.onRequest(app);
extensions/image-processing-api/README.md:39
- [nitpick] Clarify in the documentation that the placeholders and must be replaced with actual values, and confirm that the endpoint (i.e., '/process') matches the internal routing of the deployed Cloud Function.
https://us-central1-<your-project-id>.cloudfunctions.net/<extension-instance-id>/process${params}
This PR brings image-processing-api into nodejs20, fixes vulnerabilities.