Avoid empty oneOf keyword

If `oneOf` is set to an empty array this will result in an exception thrown on schema validation.
systopia · Feb 6, 2024 · 3bdace4 · 3bdace4
1 parent f0c13f5
commit 3bdace4
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 3 deletions.
diff --git a/Civi/RemoteTools/JsonSchema/FormSpec/Factory/OptionFieldFactory.php b/Civi/RemoteTools/JsonSchema/FormSpec/Factory/OptionFieldFactory.php
@@ -32,8 +32,16 @@ public function createSchema(AbstractFormField $field): JsonSchema {
     /** @var \Civi\RemoteTools\Form\FormSpec\Field\AbstractOptionField $field */
     $keywords = [
       'type' => ['string', 'integer'],
-      'oneOf' => JsonSchemaUtil::buildTitledOneOf($field->getOptions()),
     ];
+
+    // 'oneOf' must not be empty.
+    if ($field->getOptions() !== []) {
+      $keywords['oneOf'] = JsonSchemaUtil::buildTitledOneOf($field->getOptions());
+    }
+    elseif (!$field->isNullable()) {
+      $keywords['oneOf'] = JsonSchema::fromArray(['const' => NULL]);
+    }
+
     if ($field->isNullable()) {
       $keywords['type'][] = 'null';
       $keywords['oneOf'][] = JsonSchema::fromArray(['const' => NULL]);

diff --git a/Civi/RemoteTools/JsonSchema/Util/JsonSchemaUtil.php b/Civi/RemoteTools/JsonSchema/Util/JsonSchemaUtil.php
@@ -24,10 +24,12 @@
 final class JsonSchemaUtil {
 
   /**
-   * @phpstan-param array<int|string, string> $titles
+   * The 'oneOf' keyword must not be empty.
+   *
+   * @phpstan-param non-empty-array<int|string, string> $titles
    *   Allowed values mapped to titles.
    *
-   * @phpstan-return array<JsonSchema> To be used as value of "oneOf" keyword.
+   * @phpstan-return non-empty-array<JsonSchema> To be used as value of "oneOf" keyword.
    */
   public static function buildTitledOneOf(array $titles): array {
     $oneOf = [];