Various problems with cruise-config encoding on Windows

[cinex-ru]

Issue Type

• Bug Report

Summary

Various problems with cruise-config encoding

Basic environment details

"java.runtime.version": "17.0.4+8"
"os.arch": "amd64",
"os.name": "Windows 10",
"os.version": "10.0",
"Go Server Version": "22.2.0 (14697-4bdda4e0d769e66da651926c7066979740bd7ae7)"
"browser": "Chrome 105.0.5195.127"

Steps to Reproduce

Updating pipeline:

1. Add Custom Command task
2. Edit command to '開始'
3. Save task
4. Check cruise-config.xml tasks section

Editing config xml Part One

1. Go Admin / Config XML
2. Press Edit button
3. Edit command in tasks section

              <exec command="開始">
                <arg />
                <runif status="passed" />
              </exec>

4. Try to save
5. Check new command

Editing config xml Part Two

1. Go Admin / Config XML
2. Press Edit button
3. Edit command in tasks section

              <exec command="Команда">
                <arg />
                <runif status="passed" />
              </exec>

4. Try to save

[chadlwilson]

I haven't validated, but is it possible that a workaround for this may be to set -Dfile.encoding=UTF-8 in the config\wrapper-properties.conf of your installation? In theory the config files should be read, written and declared as UTF-8 everywhere but I suppose it's possible something might have been missed somewhere along the line or a regression introduced on Windows.

The last line here does look a bit dubious

gocd/server/src/main/java/com/thoughtworks/go/config/GoFileConfigDataSource.java

Lines 405 to 411 in 5c7c6c2

	public String configAsXml(CruiseConfig config, boolean skipPreprocessingAndValidation) throws Exception {
	LOGGER.debug("[Config Save] === Converting config to XML");
	ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
	magicalGoConfigXmlWriter.write(config, outputStream, skipPreprocessingAndValidation);
	LOGGER.debug("[Config Save] === Done converting config to XML");
	return outputStream.toString();
	}

As does

gocd/config/config-server/src/main/java/com/thoughtworks/go/config/MagicalGoConfigXmlWriter.java

Lines 126 to 131 in 5c7c6c2

	try (ByteArrayOutputStream output = new ByteArrayOutputStream(32 * 1024)) {
	XmlUtils.writeXml(element, output);
	return output.toString();
	} catch (IOException e) {
	throw bomb("Unable to write xml to String");
	}

[chadlwilson]

FWIW, setting-Dfile.encoding=UTF-8 isn't enough. You need to set the wrapper specific property of either wrapper.jvm.encoding=UTF-8 or wrapper.lang.windows.encoding=UTF-8. There's some weird wrapper behaviour at https://wrapper.tanukisoftware.com/doc/english/props-lang.html#platform

Example of error you can get on Admin when the default encoding is something like cp2252 and you try to save something

[stale]

This issue has been automatically marked as stale because it has not had activity in the last 90 days.
If you can still reproduce this error on the master branch using local development environment or on the latest GoCD Release, please reply with all of the information you have about it in order to keep the issue open.
Thank you for all your contributions.