router
router copied to clipboard
Upgrade serde_yaml from 0.8.26 to 0.9.34
Update serde_yaml from 0.8.26 to 0.9.34, This aligns the quoting and whitespace behaviours with existing yaml handling tools like helm
For example when using the following values.yml with helm template -f values.yml apollo-router oci://ghcr.io/apollographql/helm-charts/router --version 1.53.0
router:
configuration:
health_check:
listen: "0.0.0.0:8088"
Helm strips the quotes off the string value, resulting in generated ConfigMap data of
router:
configuration:
health_check:
listen: 0.0.0.0:8088
And when serializing the config for use in router config upgrade --diff the current version of serde_yaml adds the quotes back in, making it appear that the configuration has a difference when there isn't really one
+ listen: "0.0.0.0:8088"
- listen: 0.0.0.0:8088
Checklist
Complete the checklist (and note appropriate exceptions) before the PR is marked ready-for-review.
- [ ] Changes are compatible[^1]
- [ ] Documentation[^2] completed
- [ ] Performance impact assessed and acceptable
- Tests added and passing[^3]
- [ ] Unit Tests
- [ ] Integration Tests
- [ ] Manual Tests
Exceptions
Note any exceptions here
Notes
[^1]: It may be appropriate to bring upcoming changes to the attention of other (impacted) groups. Please endeavour to do this before seeking PR approval. The mechanism for doing this will vary considerably, so use your judgement as to how and when to do this. [^2]: Configuration is an important part of many changes. Where applicable please try to document configuration examples. [^3]: Tick whichever testing boxes are applicable. If you are adding Manual Tests, please document the manual testing (extensively) in the Exceptions.
@joshhayes-sheen-vt: Thank you for submitting a pull request! Before we can merge it, you'll need to sign the Apollo Contributor License Agreement here: https://contribute.apollographql.com/
@joshhayes-sheen-vt: Thank you for submitting a pull request! Before we can merge it, you'll need to sign the Apollo Contributor License Agreement here: https://contribute.apollographql.com/
Just waiting to hear back from my company legal department for an all clear on signing the CLA, Also, I'm not sure anyone actually wants this change but wanted to try it out and put it up for consideration
I have signed the CLA and I hope to get back to this at some point, but it basically breaks every single configuration test because of changes in the file formatting of the goldfiles/fixtures, so it's super annoying and time consuming to fix each one
Closing this for now, changing the expectations around the serialized configuration format breaks like 900 test fixtures, and this change doesn't feel worthwhile to me to go and fix all of those