Drainpipe not reading correctly the URLs for visual diffs

[beto-aveiga]

When an override file is used for Tugboat config, it may produce URLs for visual diffs that break Tugboat builds.
If there is a way to build these URLs it should be documented. I tried double quotes and scaping them, but it didn't work.

On Tugboat

Tags

composer install, .tugboat/config.drainpipe-override.yml, tugboat, visual diffs, visualdiffs

[mrdavidburns]

This would be a blocker now that our static tests are checking for uncommitted changes.

[beto-aveiga]

This would be a blocker now that our static tests are checking for uncommitted changes.
I'm not clear about this @mrdavidburns

I just think that overriding URLs with parameters for VIsual Diffs doesn't work as expected.

[mrdavidburns]

Relates to:

• Add config overrides support for Tugboat #388
• Support a config.overrides.yml file for Tugboat #441

[mrdavidburns]

@beto-aveiga Looks like this is the section of code where query parameters are being encoded. Thoughts on how we can fix that?

https://github.com/Lullabot/drainpipe/pull/441/files#diff-fccaa14362cd8508cb094a15287d2e442fc57d94205c6b2146087a552815d1fcR346-R356

            // Filter out unsupported config overrides.
            if (!empty($tugboatConfigOverride['php']) && is_array($tugboatConfigOverride['php'])) {
                $tugboatConfigOverride['php'] = array_filter($tugboatConfigOverride['php'], function($key) {
                    return in_array($key, ['aliases', 'urls', 'visualdiff', 'screenshot']);
                }, ARRAY_FILTER_USE_KEY);
                $overrideOutput = [];
                foreach (explode(PHP_EOL, Yaml::dump($tugboatConfigOverride['php'], 2, 2)) as $line) {
                    $overrideOutput[] = str_repeat(' ', 4) . $line;
                }
                $tugboatConfig['overrides']['php'] = rtrim(implode("\n", $overrideOutput));
            }

Or should that be fixed when we insert these values back into the tugboat config file?
https://github.com/Lullabot/drainpipe/pull/441/files#diff-fccaa14362cd8508cb094a15287d2e442fc57d94205c6b2146087a552815d1fcR407-R410

                // Reinstate the override file.
                if (isset($tugboatConfigOverrideFile)) {
                    file_put_contents('./.tugboat/config.drainpipe-override.yml', $tugboatConfigOverrideFile);
                }

Seems YAML::dump() is doing the encoding.

Here's what ChatGPT is suggesting to allow query parameters.
https://chatgpt.com/share/91f4b461-a8e5-4aae-9bda-9da19ff2ddee

[beto-aveiga]

Thoughts on how we can fix that?

My first idea is to encode them before or encode them after, and see what happens when I run composer install.
However, Xdebugging and seeing the values in real-time would be easier and more effective for discovering new approaches.

Writing a simple test sounds reasonable, too.