feat: add support for remote source for functions. #9701
Conversation
- Fix writeResolvedParams to only persist for local sources or when configDir is set - Fix progress bar rendering issue when content-length header is missing - Remove empty JSDoc blocks and fix typos in error messages - Add unit tests for remote source with dir, requireFunctionsYaml, and local source path - Improve error message clarity for missing source configuration
Summary of ChangesHello @taeold, 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 significantly enhances the Cloud Functions deployment process by enabling support for remote Git repositories as function sources. This allows users to deploy third-party solutions or manage monorepos more effectively without needing to vendor source code locally. The changes include new configuration options for specifying remote sources, a mechanism for local environment variable persistence, and a security measure requiring a Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe 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 by creating a comment using either
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 Limitations & Feedback Gemini Code Assist 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces support for deploying Cloud Functions from a remote Git repository. The changes include a new remoteSource configuration option, updates to config validation, and a refactoring of the loadCodebases function to handle both local and remote sources. The implementation correctly uses the GitHub archive API for downloading sources and enforces security by requiring a functions.yaml manifest for remote deployments. My review focuses on the new logic and its integration. I've identified a couple of areas for improvement: one regarding code duplication which affects maintainability, and another a potential bug in handling environment variables for remote sources with a specified configDir.
| } | ||
| wantBackends[codebase] = wantBackend; | ||
| if (functionsEnv.hasUserEnvs(userEnvOpt) || hasEnvsFromParams) { | ||
| if (isLocalConfig(config) && (functionsEnv.hasUserEnvs(userEnvOpt) || hasEnvsFromParams)) { |
There was a problem hiding this comment.
This condition prevents .env files from being considered authoritative for remote sources, even when a configDir is specified. This means environment variables from previous deployments will be merged instead of overwritten, which is likely unexpected for users who provide a configDir to manage environment variables for a remote source. To ensure consistent behavior for both local and remote sources with user-provided environment files, you should also consider the presence of config.configDir for remote sources.
| if (isLocalConfig(config) && (functionsEnv.hasUserEnvs(userEnvOpt) || hasEnvsFromParams)) { | |
| if ((isLocalConfig(config) || config.configDir) && (functionsEnv.hasUserEnvs(userEnvOpt) || hasEnvsFromParams)) { | |
| const userEnvOpt: functionsEnv.UserEnvsOpts = { | ||
| functionsSource: sourceDir, | ||
| projectId: projectId, | ||
| projectAlias: context.projectAlias, | ||
| }; | ||
| if (codebaseConfig.configDir) { | ||
| userEnvOpt.configDir = path.resolve(context.projectDir, codebaseConfig.configDir); | ||
| } |
There was a problem hiding this comment.
The logic for creating userEnvOpt on these lines is duplicated from lines 171-178 in the prepare function. To improve maintainability and reduce redundancy, consider extracting this logic into a shared helper function. Alternatively, you could construct this object once within loadCodebases and return it as part of the LoadedCodebases result to be used in the prepare function.
1 participant
Adds support for deploying Cloud Functions from a remote Git repository, allowing users to deploy third-party solutions without vendoring source code locally.
Key changes:
remoteSourceconfig option withrepository,ref, and optionaldirfieldsconfigDiroption for persisting environment variables locallyfunctions.yamlmanifest for security (prevents arbitrary code execution during discovery)Example config:
{ "functions": { "remoteSource": { "repository": "org/repo", "ref": "v1.0.0", "dir": "packages/functions" }, "runtime": "nodejs20", "configDir": "config" } }