chore: added a common serializer and its tests by sbansla · Pull Request #878 · twilio/twilio-java

sbansla · 2025-07-24T11:51:29Z

Fixes

Added a centralized serialization so that we don't have to identify variable type in twilio-oai-generator.

Checklist

I acknowledge that all my contributions will be made under the project's license
I have made a material change to the repo (functionality, testing, spelling, grammar)
I have read the Contribution Guidelines and my PR follows them
I have titled the PR appropriately
I have updated my branch with the main branch
I have added tests that prove my fix is effective or that my feature works
I have added the necessary documentation about the functionality in the appropriate .md file
I have added inline documentation to the code I modified

If you have questions, please file a support ticket, or create a GitHub Issue in this repository.

* fix: use Object for types instead of Map * fix: use Object for anyType * fix: use Object for anyType

* fix: use Object for types instead of Map * fix: use Object for anyType * fix: use Object for anyType * fix: handle array of objects correctly * fix: add converter import statement

…8634d10afc0145e18ccb8d90598b642b67ad87

…1169e3becf53bb375f9c7413aec0c78fe78fcc

…518c9f2f9294597fd0471d5c647016ef4023ee

…ce code duplication (#883)

sonarqubecloud · 2025-08-08T05:16:57Z

Quality Gate passed

Issues
4 New issues
0 Accepted issues

Measures
0 Security Hotspots
83.3% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Copilot

Pull Request Overview

This PR introduces a centralized serialization utility to standardize how different data types are converted to strings and added to HTTP requests. The change eliminates the need for type-specific handling in the twilio-oai-generator by providing a common Serializer class.

Added a Serializer class with overloaded toString methods for various data types
Introduced a ParameterType enum to distinguish between query, header, and URL-encoded parameters
Comprehensive test coverage for all supported data types and edge cases

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.

File	Description
src/main/java/com/twilio/converter/Serializer.java	Core serializer implementation with generic and date-specific toString methods
src/test/java/com/twilio/converter/SerializerTest.java	Comprehensive test suite covering all data types and parameter types
src/main/java/com/twilio/constant/EnumConstants.java	Added ParameterType enum for distinguishing parameter destinations

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-09T06:03:18Z

src/main/java/com/twilio/converter/Serializer.java

+
+    private static <T> String convertToString(T value) {
+        if (value instanceof Map) {
+            return Converter.mapToJson((Map<String, ? extends Object>) value);


The cast to (Map<String, ? extends Object>) is unsafe and may cause ClassCastException at runtime. Consider using a type-safe approach with instanceof checks or generic bounds to ensure the cast is valid.

Suggested change

return Converter.mapToJson((Map<String, ? extends Object>) value);

Map<?, ?> map = (Map<?, ?>) value;

boolean allStringKeys = true;

for (Object key : map.keySet()) {

if (!(key instanceof String)) {

allStringKeys = false;

break;

}

}

if (allStringKeys) {

@SuppressWarnings("unchecked")

Map<String, ? extends Object> stringKeyMap = (Map<String, ? extends Object>) map;

return Converter.mapToJson(stringKeyMap);

} else {

// Fallback: not a Map<String, ?>, use toString

return String.valueOf(value);

}

Copilot · 2025-09-09T06:03:19Z

src/test/java/com/twilio/converter/SerializerTest.java

+    @Test
+    public void testToStringWithLocalDate() {
+        Request request = buildRequest();
+        LocalDate date = LocalDate.of(2025, 07, 1);


The month value 07 should be written as 7 instead of using octal notation. While 07 equals 7 in this context, using leading zeros can be misleading and suggests octal representation.

Copilot · 2025-09-09T06:03:19Z

src/test/java/com/twilio/converter/SerializerTest.java

+        LocalDate dateBefore = LocalDate.of(2025, 07, 5);
+        LocalDate dateAfter = LocalDate.of(2025, 07, 1);


The month value 07 should be written as 7 instead of using octal notation. While 07 equals 7 in this context, using leading zeros can be misleading and suggests octal representation.

Copilot · 2025-09-09T06:03:19Z

src/test/java/com/twilio/converter/SerializerTest.java

+        Request request = buildRequest();
+        LocalDate date = null;
+        LocalDate dateBefore = null;
+        LocalDate dateAfter = LocalDate.of(2025, 07, 1);


The month value 07 should be written as 7 instead of using octal notation. While 07 equals 7 in this context, using leading zeros can be misleading and suggests octal representation.

Copilot · 2025-09-09T06:03:19Z

src/test/java/com/twilio/converter/SerializerTest.java

+    public void testToStringWithLocalDateRangeAfterNull() {
+        Request request = buildRequest();
+        LocalDate date = null;
+        LocalDate dateBefore = LocalDate.of(2025, 07, 5);


The month value 07 should be written as 7 instead of using octal notation. While 07 equals 7 in this context, using leading zeros can be misleading and suggests octal representation.

tiwarishubham635 · 2025-09-09T06:04:04Z

src/main/java/com/twilio/converter/Serializer.java

+        addParamToRequest(request, key, stringValue, parameterType);
+    }
+
+    private static <T> String convertToString(T value) {


The objectToJson() can be used here instead

You mean using mapper to convert to string ?
We can not use it, because \n (new line) is treated as actual new line for toString method, whereas mapper keep /n as it as.

tiwarishubham635 · 2025-09-09T06:06:15Z

src/main/java/com/twilio/converter/Serializer.java

+                break;
+            case URLENCODED:
+                request.addPostParam(key, value);
+                break;


How will body params be added?

addressed json content type serialization.

sonarqubecloud · 2025-09-09T11:14:49Z

Quality Gate passed

Issues
98 New issues
0 Accepted issues

Measures
0 Security Hotspots
90.8% Coverage on New Code
2.8% Duplication on New Code

See analysis details on SonarQube Cloud

tiwarishubham635 and others added 14 commits July 2, 2025 19:48

chore: use Object for anyType (#873)

baf498e

* fix: use Object for types instead of Map * fix: use Object for anyType * fix: use Object for anyType

chore: Handle List<Object> serialization (#874)

e348355

* fix: use Object for types instead of Map * fix: use Object for anyType * fix: use Object for anyType * fix: handle array of objects correctly * fix: add converter import statement

chore: prepare for RC release (#875)

b737594

[Librarian] Regenerated @ d122b05026327019e18cb5763c557a68138cc2c8 0e…

953e73e

…8634d10afc0145e18ccb8d90598b642b67ad87

Release 11.0.0-rc.1

04f1e08

chore: updating maven repository link in release notes (#876)

9c2ba4d

[Librarian] Regenerated @ 39bbd47c92a659f8a7464cedcc75b92c7ba69773 f5…

c469b61

…1169e3becf53bb375f9c7413aec0c78fe78fcc

Release 11.0.0-rc.2

3ba6d3c

[Librarian] Regenerated @ 4b32678e9d8859e19f1feb1af566eea8533a36c9 51…

5845dc3

…518c9f2f9294597fd0471d5c647016ef4023ee

Release 11.0.0-rc.3

0810ce5

chore: added a common serializer and its tests

ac0ac22

added map test cases for serialization

76fa5e1

added date range test cases

9228a41

added test cases for array

51c3e57

sbansla marked this pull request as draft July 24, 2025 12:41

Copilot AI and others added 3 commits August 6, 2025 13:27

chore: Fix ResourceSet iterator to allow multiple iterations and redu…

2ae7c6b

…ce code duplication (#883)

Merge branch '11.0.0-rc' into main

cceb784

Merge branch 'main' into centralized-serializations

81d565a

sbansla marked this pull request as ready for review August 8, 2025 05:13

sbansla requested a review from tiwarishubham635 August 8, 2025 11:36

tiwarishubham635 requested a review from Copilot September 9, 2025 06:02

Copilot AI reviewed Sep 9, 2025

View reviewed changes

tiwarishubham635 requested changes Sep 9, 2025

View reviewed changes

tiwarishubham635 force-pushed the main branch 2 times, most recently from 6533f63 to 78a8ccd Compare September 9, 2025 08:08

added json serializer

1d53b88

sbansla requested a review from tiwarishubham635 September 9, 2025 11:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: added a common serializer and its tests#878

chore: added a common serializer and its tests#878
sbansla wants to merge 18 commits intomainfrom
centralized-serializations

sbansla commented Jul 24, 2025

Uh oh!

sonarqubecloud bot commented Aug 8, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Sep 9, 2025

Uh oh!

Copilot AI Sep 9, 2025

Uh oh!

Copilot AI Sep 9, 2025

Uh oh!

Copilot AI Sep 9, 2025

Uh oh!

Copilot AI Sep 9, 2025

Uh oh!

tiwarishubham635 Sep 9, 2025

Uh oh!

sbansla Sep 9, 2025

Uh oh!

tiwarishubham635 Sep 9, 2025

Uh oh!

sbansla Sep 9, 2025

Uh oh!

sonarqubecloud bot commented Sep 9, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

-            return Converter.mapToJson((Map<String, ? extends Object>) value);
+            Map<?, ?> map = (Map<?, ?>) value;
+            boolean allStringKeys = true;
+            for (Object key : map.keySet()) {
+                if (!(key instanceof String)) {
+                    allStringKeys = false;
+                    break;
+                }
+            }
+            if (allStringKeys) {
+                @SuppressWarnings("unchecked")
+                Map<String, ? extends Object> stringKeyMap = (Map<String, ? extends Object>) map;
+                return Converter.mapToJson(stringKeyMap);
+            } else {
+                // Fallback: not a Map<String, ?>, use toString
+                return String.valueOf(value);
+            }

		LocalDate dateBefore = LocalDate.of(2025, 07, 5);
		LocalDate dateAfter = LocalDate.of(2025, 07, 1);

Conversation

sbansla commented Jul 24, 2025

Fixes

Checklist

Uh oh!

sonarqubecloud bot commented Aug 8, 2025

Quality Gate passed

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 9, 2025

Choose a reason for hiding this comment

Uh oh!

tiwarishubham635 Sep 9, 2025

Choose a reason for hiding this comment

Uh oh!

sbansla Sep 9, 2025

Choose a reason for hiding this comment

Uh oh!

tiwarishubham635 Sep 9, 2025

Choose a reason for hiding this comment

Uh oh!

sbansla Sep 9, 2025

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Sep 9, 2025

Quality Gate passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants