Fix 204 strauss doesnt read custom config #205
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @BrianHenryIE, 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 critical issue where Strauss failed to recognize and utilize custom Composer configuration files, such as composer.json or composer.lock, when specified via the COMPOSER environment variable. The changes involve integrating Composer's Factory class to dynamically determine the correct paths for these files, ensuring that Strauss operates consistently with Composer's behavior. Additionally, the autoloader generation process has been refined for more accurate handling of development dependencies, and a dedicated integration test has been introduced to validate the fix.
Highlights
- Custom Composer Configuration Support: Strauss now correctly identifies and uses custom
composer.jsonandcomposer.lockfiles when theCOMPOSERenvironment variable is set. This ensures that Strauss respects alternative Composer configurations, leading to accurate dependency resolution and configuration loading based on the specified file. - Autoloader Generation Refinement: The autoloader generation logic has been updated to more accurately determine
devModebased on theinstalled.jsonrepository. This change ensures correct inclusion or exclusion of development dependencies, aligning Strauss's autoloader output more closely with Composer's behavior. - Enhanced Testing: A new integration test has been added to specifically verify that Strauss correctly processes dependencies when an alternative Composer configuration file is used. This test creates a scenario with multiple
composer.jsonfiles and asserts that Strauss uses the one specified by theCOMPOSERenvironment variable.
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.
Code Review
This pull request implements support for custom composer.json files by respecting the COMPOSER environment variable. The changes are sound, and an integration test is included. The review suggests improvements to the test suite's robustness, including a fix for environment variable parsing, using PHPUnit assertions, and strengthening an assertion in the new test.
| fn(string $pair) => explode('=', $pair), | ||
| explode(' ', $env) | ||
| ); | ||
| foreach ($envArray as $var) { | ||
| $_ENV[$var[0]] = $var[1]; | ||
| } |
There was a problem hiding this comment.
The current implementation for parsing environment variables is brittle and can lead to issues if $env is an empty string or if values contain an equals sign. explode('=', $pair) will split the value if it contains an equals sign. A more robust implementation is suggested.
$envArray = array_map(
fn(string $pair) => explode('=', $pair, 2),
array_filter(explode(' ', $env))
);
foreach ($envArray as $var) {
if (isset($var[1])) {
$_ENV[$var[0]] = $var[1];
}
}|
|
||
| $env = 'COMPOSER=composer-free.json'; | ||
| $exitCode = $this->runStrauss($output, '', $env); | ||
| assert(0 === $exitCode, $output); |
There was a problem hiding this comment.
Using assert() in tests is discouraged because its behavior depends on the zend.assertions PHP INI setting. If assertions are disabled, this check won't run. Using PHPUnit's assertion methods provides more reliable and consistent tests.
$this->assertSame(0, $exitCode, $output);| assert(0 === $exitCode, $output); | ||
|
|
||
| $php_string = file_get_contents($this->testsWorkingDir . 'vendor-prefixed/composer/installed.json'); | ||
| $this->assertStringContainsString("Saltus\\\\WP\\\\Plugin\\\\InteractiveGlobes\\\\Psr\\\\Log\\\\", $php_string); |
There was a problem hiding this comment.
To enhance the test's robustness, add another assertion to verify that a dependency only present in the main composer.json (psr/container) was not processed. This would more strongly confirm that Strauss is using the correct configuration file.
$this->assertStringContainsString("Saltus\\WP\\Plugin\\InteractiveGlobes\\Psr\\Log\\", $php_string);
$this->assertStringNotContainsString("Saltus\\WP\\Plugin\\InteractiveGlobes\\Psr\\Container\\", $php_string);|
strauss.phar.zip @ 94f7cf2 \n |
#204
https://getcomposer.org/doc/03-cli.md#composer