From bd0719ceabce25444a58e19d5bf42fdc5678ec6d Mon Sep 17 00:00:00 2001 From: Chirag Aggarwal Date: Thu, 12 Nov 2026 17:18:19 +0000 Subject: [PATCH] fix(patch): send JSON patches with slashes and unicode unescaped The API server compares a JSON patch test operation's strings by their encoded bytes, so PHP's default \/ never matched a stored / and any test on a value containing a path (an init container's command, a mount path) was refused with 422 Invalid. toJsonPayload already used JSON_UNESCAPED_SLASHES; the patch encoders now match it, and keep unicode verbatim for the same reason. --- src/Kinds/K8sResource.php | 6 ++++-- tests/PatchPayloadTest.php | 29 ++++++++++++++++++++++++++--- 2 files changed, 30 insertions(+), 5 deletions(-) diff --git a/src/Kinds/K8sResource.php b/src/Kinds/K8sResource.php index f224a4e..994b825 100644 --- a/src/Kinds/K8sResource.php +++ b/src/Kinds/K8sResource.php @@ -178,7 +178,9 @@ public function toJsonPatchPayload(JsonPatch|array $patch): string } } - return json_encode($operations, JSON_THROW_ON_ERROR); + // The API server compares a test operation's strings by their encoded bytes, + // so `\/` never matches a stored `/` and the patch is refused. + return json_encode($operations, JSON_THROW_ON_ERROR | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE); } /** @@ -195,7 +197,7 @@ public function toJsonMergePatchPayload(JsonMergePatch|array $patch): string return json_encode( $document === [] ? (object) [] : $this->coerceEmptyArraysToObjects($document), - JSON_THROW_ON_ERROR + JSON_THROW_ON_ERROR | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE ); } diff --git a/tests/PatchPayloadTest.php b/tests/PatchPayloadTest.php index 7f98c7c..72c299d 100644 --- a/tests/PatchPayloadTest.php +++ b/tests/PatchPayloadTest.php @@ -108,13 +108,36 @@ public function test_json_patch_scalar_and_valueless_operations_are_untouched() ]); $this->assertSame( - '[{"op":"replace","path":"\/spec\/replicas","value":3},' - .'{"op":"remove","path":"\/metadata\/labels\/deprecated"},' - .'{"op":"add","path":"\/metadata\/labels\/app","value":null}]', + '[{"op":"replace","path":"/spec/replicas","value":3},' + .'{"op":"remove","path":"/metadata/labels/deprecated"},' + .'{"op":"add","path":"/metadata/labels/app","value":null}]', $payload ); } + public function test_json_patch_test_values_keep_slashes_and_unicode_verbatim() + { + $payload = $this->cluster->statefulSet()->toJsonPatchPayload([ + ['op' => 'test', 'path' => '/spec/template/spec/initContainers', 'value' => [ + ['name' => 'init', 'command' => ['sh', '-c', "chmod 1777 '/var/run/mysqld'"], 'env' => [['name' => 'NOTE', 'value' => 'café']]], + ]], + ]); + + $this->assertStringContainsString("'/var/run/mysqld'", $payload); + $this->assertStringContainsString('"path":"/spec/template/spec/initContainers"', $payload); + $this->assertStringContainsString('café', $payload); + $this->assertStringNotContainsString('\\/', $payload); + } + + public function test_json_merge_patch_keeps_slashes_verbatim() + { + $payload = $this->cluster->statefulSet()->toJsonMergePatchPayload([ + 'metadata' => ['annotations' => ['appwrite.io/owner' => 'a/b']], + ]); + + $this->assertStringContainsString('"appwrite.io/owner":"a/b"', $payload); + } + public function test_empty_json_patch_encodes_as_list() { $this->assertSame('[]', $this->cluster->configmap()->toJsonPatchPayload([]));