Merge pull request #189 from github/copilot/update-public-api-to-use-optional

refactor: use Optional return types instead of nullable boxed primitives in public API

Author: edburns

src/main/java/com/github/copilot/sdk/json/InputOptions.java

@@ -4,12 +4,15 @@
 
 package com.github.copilot.sdk.json;
 
+import com.fasterxml.jackson.annotation.JsonInclude;
+
 /**
  * Options for the {@link SessionUiApi#input(String, InputOptions)} convenience
  * method.
  *
  * @since 1.0.0
  */
+@JsonInclude(JsonInclude.Include.NON_NULL)
 public class InputOptions {
 
     private String title;

src/main/java/com/github/copilot/sdk/json/SessionUiCapabilities.java

@@ -4,11 +4,14 @@
 
 package com.github.copilot.sdk.json;
 
+import com.fasterxml.jackson.annotation.JsonInclude;
+
 /**
  * UI-specific capability flags for a session.
  *
  * @since 1.0.0
  */
+@JsonInclude(JsonInclude.Include.NON_NULL)
 public class SessionUiCapabilities {
 
     private Boolean elicitation;

src/main/java/com/github/copilot/sdk/json/TelemetryConfig.java

@@ -4,6 +4,8 @@
 
 package com.github.copilot.sdk.json;
 
+import com.fasterxml.jackson.annotation.JsonInclude;
+
 /**
  * OpenTelemetry configuration for the Copilot CLI server.
  * <p>
@@ -21,6 +23,7 @@
  * @see CopilotClientOptions#setTelemetry(TelemetryConfig)
  * @since 1.2.0
  */
+@JsonInclude(JsonInclude.Include.NON_NULL)
 public class TelemetryConfig {
 
     private String otlpEndpoint;

src/main/java/com/github/copilot/sdk/json/UserInputRequest.java

@@ -8,6 +8,7 @@
 import java.util.List;
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
 /**
@@ -19,6 +20,7 @@
  * @since 1.0.6
  */
 @JsonIgnoreProperties(ignoreUnknown = true)
+@JsonInclude(JsonInclude.Include.NON_NULL)
 public class UserInputRequest {
 
     @JsonProperty("question")

src/test/java/com/github/copilot/sdk/JsonIncludeNonNullTest.java

@@ -0,0 +1,159 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *--------------------------------------------------------------------------------------------*/
+
+package com.github.copilot.sdk;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import org.junit.jupiter.api.Test;
+
+import com.github.copilot.sdk.json.CopilotClientOptions;
+import com.github.copilot.sdk.json.CustomAgentConfig;
+import com.github.copilot.sdk.json.InfiniteSessionConfig;
+import com.github.copilot.sdk.json.InputOptions;
+import com.github.copilot.sdk.json.ModelCapabilitiesOverride;
+import com.github.copilot.sdk.json.ProviderConfig;
+import com.github.copilot.sdk.json.ResumeSessionConfig;
+import com.github.copilot.sdk.json.SessionConfig;
+import com.github.copilot.sdk.json.SessionUiCapabilities;
+import com.github.copilot.sdk.json.TelemetryConfig;
+import com.github.copilot.sdk.json.UserInputRequest;
+
+/**
+ * Verifies that public DTO classes in the {@code com.github.copilot.sdk.json}
+ * package are annotated with {@code @JsonInclude(JsonInclude.Include.NON_NULL)}
+ * so that null-valued fields are omitted during JSON serialization.
+ */
+class JsonIncludeNonNullTest {
+
+    private static final ObjectMapper MAPPER = new ObjectMapper();
+
+    // --- Annotation presence checks ---
+
+    @Test
+    void copilotClientOptionsHasNonNullAnnotation() {
+        assertHasNonNullInclude(CopilotClientOptions.class);
+    }
+
+    @Test
+    void sessionConfigHasNonNullAnnotation() {
+        assertHasNonNullInclude(SessionConfig.class);
+    }
+
+    @Test
+    void resumeSessionConfigHasNonNullAnnotation() {
+        assertHasNonNullInclude(ResumeSessionConfig.class);
+    }
+
+    @Test
+    void infiniteSessionConfigHasNonNullAnnotation() {
+        assertHasNonNullInclude(InfiniteSessionConfig.class);
+    }
+
+    @Test
+    void inputOptionsHasNonNullAnnotation() {
+        assertHasNonNullInclude(InputOptions.class);
+    }
+
+    @Test
+    void modelCapabilitiesOverrideHasNonNullAnnotation() {
+        assertHasNonNullInclude(ModelCapabilitiesOverride.class);
+    }
+
+    @Test
+    void providerConfigHasNonNullAnnotation() {
+        assertHasNonNullInclude(ProviderConfig.class);
+    }
+
+    @Test
+    void telemetryConfigHasNonNullAnnotation() {
+        assertHasNonNullInclude(TelemetryConfig.class);
+    }
+
+    @Test
+    void sessionUiCapabilitiesHasNonNullAnnotation() {
+        assertHasNonNullInclude(SessionUiCapabilities.class);
+    }
+
+    @Test
+    void customAgentConfigHasNonNullAnnotation() {
+        assertHasNonNullInclude(CustomAgentConfig.class);
+    }
+
+    @Test
+    void userInputRequestHasNonNullAnnotation() {
+        assertHasNonNullInclude(UserInputRequest.class);
+    }
+
+    // --- Serialization tests: null fields are omitted ---
+
+    @Test
+    void inputOptionsOmitsNullFieldsInJson() throws JsonProcessingException {
+        var opts = new InputOptions();
+        String json = MAPPER.writeValueAsString(opts);
+        assertEquals("{}", json, "All-null InputOptions should serialize to empty JSON");
+    }
+
+    @Test
+    void telemetryConfigOmitsNullFieldsInJson() throws JsonProcessingException {
+        var config = new TelemetryConfig();
+        String json = MAPPER.writeValueAsString(config);
+        assertEquals("{}", json, "All-null TelemetryConfig should serialize to empty JSON");
+    }
+
+    @Test
+    void sessionUiCapabilitiesOmitsNullFieldsInJson() throws JsonProcessingException {
+        var caps = new SessionUiCapabilities();
+        String json = MAPPER.writeValueAsString(caps);
+        assertEquals("{}", json, "All-null SessionUiCapabilities should serialize to empty JSON");
+    }
+
+    @Test
+    void userInputRequestOmitsNullFieldsInJson() throws JsonProcessingException {
+        var req = new UserInputRequest();
+        String json = MAPPER.writeValueAsString(req);
+        assertFalse(json.contains("null"), "UserInputRequest with no fields set should not contain 'null' values");
+    }
+
+    @Test
+    void inputOptionsIncludesSetFieldsInJson() throws JsonProcessingException {
+        var opts = new InputOptions();
+        opts.setMinLength(5);
+        opts.setMaxLength(100);
+        String json = MAPPER.writeValueAsString(opts);
+        assertTrue(json.contains("\"minLength\":5"), "Set minLength should appear in JSON");
+        assertTrue(json.contains("\"maxLength\":100"), "Set maxLength should appear in JSON");
+        assertFalse(json.contains("\"title\""), "Unset title should be omitted from JSON");
+    }
+
+    @Test
+    void telemetryConfigIncludesSetFieldsInJson() throws JsonProcessingException {
+        var config = new TelemetryConfig();
+        config.setOtlpEndpoint("http://localhost:4318");
+        String json = MAPPER.writeValueAsString(config);
+        assertTrue(json.contains("\"otlpEndpoint\":\"http://localhost:4318\""),
+                "Set otlpEndpoint should appear in JSON");
+        assertFalse(json.contains("\"filePath\""), "Unset filePath should be omitted from JSON");
+    }
+
+    @Test
+    void sessionUiCapabilitiesIncludesSetFieldsInJson() throws JsonProcessingException {
+        var caps = new SessionUiCapabilities();
+        caps.setElicitation(true);
+        String json = MAPPER.writeValueAsString(caps);
+        assertTrue(json.contains("\"elicitation\":true"), "Set elicitation should appear in JSON");
+    }
+
+    private void assertHasNonNullInclude(Class<?> clazz) {
+        JsonInclude annotation = clazz.getAnnotation(JsonInclude.class);
+        assertNotNull(annotation, clazz.getSimpleName() + " should be annotated with @JsonInclude");
+        assertEquals(JsonInclude.Include.NON_NULL, annotation.value(),
+                clazz.getSimpleName() + " @JsonInclude should use Include.NON_NULL");
+    }
+
+}