Skip to content

Fix pre or post deploy commands if it contains = #8918

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

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

Conversation

aaharu
Copy link

@aaharu aaharu commented Jul 31, 2025

Description

cross-env-shell.js fails silently when commands includes equal signs.
Therefore, I changed it to @yarnpkg/shell.

closes #5339

Scenarios Tested

{
  "functions": [
    {
      "source": "functions",
      "codebase": "default",
      "ignore": [
        "node_modules",
        ".git",
        "firebase-debug.log",
        "firebase-debug.*.log",
        "*.local"
      ],
      "predeploy": [
        "echo 11111111111",
        "echo e=1",
        "npm run build --workspace=foo"
      ]
    }
  ]
}

Sample Commands

firebase deploy

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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 @aaharu, 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 addresses a long-standing bug where pre or post deploy commands containing an equals sign (=) would fail silently. The fix involves migrating from cross-env to @yarnpkg/shell for command execution, which provides more reliable parsing and execution of complex shell commands, thereby enhancing the stability of deployment lifecycle hooks.

Highlights

  • Dependency Update: Replaced the cross-env dependency with @yarnpkg/shell to improve command execution robustness.
  • Command Execution Logic: Updated the runCommand function in src/deploy/lifecycleHooks.ts to utilize @yarnpkg/shell for executing pre/post deploy commands, addressing an issue where commands containing an equals sign (=) would fail silently.
  • Warning Removal: Removed the warning message that previously advised users to avoid using equals signs in their commands, as the new shell integration resolves this limitation.
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 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 or fill out our survey 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

  1. 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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request aims to fix an issue where pre/post-deploy commands containing an equals sign (=) fail silently. The fix involves replacing the cross-env package with @yarnpkg/shell, which is intended to handle such commands correctly. The changes in package.json and the removal of a related warning in lifecycleHooks.ts are appropriate. However, I've identified a critical issue in lifecycleHooks.ts where special path handling for the VSCode extension environment has been removed. This is likely to cause a regression for VSCode extension users, and I've provided feedback to address it.

const crossEnvShellPath = isVSCodeExtension()
? path.resolve(__dirname, "./cross-env/dist/bin/cross-env-shell.js")
: path.resolve(require.resolve("cross-env"), "..", "bin", "cross-env-shell.js");
const crossEnvShellPath = path.resolve(require.resolve("@yarnpkg/shell"), "..", "cli.js");
Copy link
Contributor

Choose a reason for hiding this comment

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

critical

This change removes the special handling for resolving the shell script's path when running as a VSCode extension. The previous implementation used a different path resolution strategy when isVSCodeExtension() was true, which strongly indicates that require.resolve() does not work as expected in that environment, likely due to how dependencies are bundled for the extension.

Removing this conditional logic is likely to cause a regression, breaking pre/post-deploy hooks for users of the Firebase VSCode extension.

To prevent this, the conditional path logic for the VSCode extension environment should be restored. The correct path to the bundled @yarnpkg/shell/cli.js will need to be determined and used when isVSCodeExtension() returns true.

Copy link
Author

Choose a reason for hiding this comment

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

The cross-env/dist is included in cross-env@5 but not in cross-env@7.
So it does not appear to have worked before.
#8080
#8107

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.

functions predeploy/postdeploy do not work when contains =
1 participant