fix: implements serialization of enum collections (#1578)

fix: implements serialization of enum collections

Author: rkodev

packages/abstractions/src/serialization/serializationWriter.ts

@@ -93,6 +93,13 @@ export interface SerializationWriter {
 	 * @param values the value to write to the stream.
 	 */
 	writeEnumValue<T>(key?: string, ...values: (T | null | undefined)[]): void;
+
+	/**
+	 * Writes the specified collection of enum values to the stream with an optional given key.
+	 * @param key the key to write the value with.
+	 * @param values the value to write to the stream.
+	 */
+	writeCollectionOfEnumValues<T>(key?: string, values?: (T | null | undefined)[]): void;
 	/**
 	 * Writes a null value for the specified key.
 	 * @param key the key to write the value with.

packages/serialization/form/src/formSerializationWriter.ts

@@ -131,6 +131,15 @@ export class FormSerializationWriter implements SerializationWriter {
 			}
 		}
 	};
+	public writeCollectionOfEnumValues = <T>(key?: string, values?: (T | null | undefined)[]): void => {
+		if (key && values && values.length > 0) {
+			// eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+			const rawValues = values.filter((x) => x !== undefined).map((x) => `${x}`);
+			if (rawValues.length > 0) {
+				this.writeCollectionOfPrimitiveValues<string>(key, rawValues);
+			}
+		}
+	};
 	public getSerializedContent = (): ArrayBuffer => {
 		return this.convertStringToArrayBuffer(this.writer.join(``));
 	};

packages/serialization/form/test/common/formSerializationWriter.ts

@@ -9,7 +9,7 @@ import { DateOnly, Duration, TimeOnly } from "@microsoft/kiota-abstractions";
 import { assert, describe, it } from "vitest";
 
 import { FormSerializationWriter } from "../../src";
-import { serializeTestEntity, type TestEntity } from "../testEntity";
+import { LongRunningOperationStatusObject, serializeTestEntity, type TestEntity } from "../testEntity";
 
 describe("FormSerializationWriter", () => {
 	it("writesSampleObjectValue", () => {
@@ -34,6 +34,8 @@ describe("FormSerializationWriter", () => {
 		testEntity.additionalData["jobTitle"] = "Author";
 		testEntity.additionalData["createdDateTime"] = new Date(0);
 		testEntity.deviceNames = ["device1", "device2"];
+		testEntity.status = LongRunningOperationStatusObject.NotStarted;
+		testEntity.nextStatuses = [LongRunningOperationStatusObject.Running, LongRunningOperationStatusObject.Succeeded];
 		const formSerializationWriter = new FormSerializationWriter();
 		formSerializationWriter.writeObjectValue(undefined, testEntity, serializeTestEntity);
 		const formContent = formSerializationWriter.getSerializedContent();
@@ -51,6 +53,9 @@ describe("FormSerializationWriter", () => {
 			"deviceNames=device2", // Serializes collections
 			"officeLocation=null", // Serializes null values
 			"endWorkTime=null", // Serializes null values
+			"status=notStarted", // Serializes enum values
+			"nextStatuses=running", // Serializes collection of enum values
+			"nextStatuses=succeeded",
 		];
 		const arr = form.split("&");
 		let count = 0;
@@ -65,6 +70,15 @@ describe("FormSerializationWriter", () => {
 		assert.equal(arr.length, 0);
 	});
 
+	it("writeCollectionOfEnumValues", () => {
+		const enums = [LongRunningOperationStatusObject.Running, LongRunningOperationStatusObject.Succeeded];
+		const formSerializationWriter = new FormSerializationWriter();
+		formSerializationWriter.writeCollectionOfEnumValues("nextStatuses", enums);
+		const formContent = formSerializationWriter.getSerializedContent();
+		const form = new TextDecoder().decode(formContent);
+		assert.equal("nextStatuses=running&nextStatuses=succeeded&", form);
+	});
+
 	it("writesSampleCollectionOfObjectValues", () => {
 		const testEntity = {} as TestEntity;
 		testEntity.id = "48d31887-5fad-4d73-a9f5-3c356e68a038";

packages/serialization/form/test/testEntity.ts

@@ -16,7 +16,19 @@ export interface TestEntity extends Parsable, AdditionalDataHolder {
 	endWorkTime?: TimeOnly | null;
 	officeLocation?: string | null;
 	deviceNames?: string[] | null;
+	status?: LongRunningOperationStatus | null;
+	nextStatuses?: LongRunningOperationStatus[] | null;
 }
+
+export const LongRunningOperationStatusObject = {
+	NotStarted: "notStarted",
+	Running: "running",
+	Succeeded: "succeeded",
+	Failed: "failed",
+	UnknownFutureValue: "unknownFutureValue",
+} as const;
+export type LongRunningOperationStatus = (typeof LongRunningOperationStatusObject)[keyof typeof LongRunningOperationStatusObject];
+
 export function createTestParserFromDiscriminatorValue(parseNode: ParseNode | undefined) {
 	if (!parseNode) throw new Error("parseNode cannot be undefined");
 	return deserializeTestEntity;
@@ -48,6 +60,12 @@ export function deserializeTestEntity(testEntity: TestEntity | undefined = {}):
 		deviceNames: (n) => {
 			testEntity.deviceNames = n.getCollectionOfPrimitiveValues();
 		},
+		status: (n) => {
+			testEntity.status = n.getEnumValue<LongRunningOperationStatus>(LongRunningOperationStatusObject);
+		},
+		nextStatuses: (n) => {
+			testEntity.nextStatuses = n.getCollectionOfEnumValues<LongRunningOperationStatus>(LongRunningOperationStatusObject);
+		},
 	};
 }
 
@@ -61,4 +79,6 @@ export function serializeTestEntity(writer: SerializationWriter, testEntity: Tes
 	writer.writeStringValue("officeLocation", testEntity.officeLocation);
 	writer.writeAdditionalData(testEntity.additionalData);
 	writer.writeCollectionOfPrimitiveValues("deviceNames", testEntity.deviceNames);
+	writer.writeEnumValue<LongRunningOperationStatus>("status", testEntity.status);
+	writer.writeCollectionOfEnumValues<LongRunningOperationStatus>("nextStatuses", testEntity.nextStatuses);
 }

packages/serialization/json/src/jsonSerializationWriter.ts

@@ -221,6 +221,22 @@ export class JsonSerializationWriter implements SerializationWriter {
 			}
 		}
 	};
+
+	public writeCollectionOfEnumValues = <T>(key?: string, values?: (T | undefined | null)[]): void => {
+		if (values && values.length > 0) {
+			// eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+			const rawValues = values.filter((x) => x !== undefined).map((x) => `${x}`);
+
+			if (rawValues.length === 0) {
+				return;
+			}
+
+			key && this.writePropertyName(key);
+			this.writer.push(JSON.stringify(rawValues));
+			key && this.writer.push(JsonSerializationWriter.propertySeparator);
+		}
+	};
+
 	public getSerializedContent = (): ArrayBuffer => {
 		return this.convertStringToArrayBuffer(this.writer.join(``));
 	};

packages/serialization/json/test/common/jsonSerializationWriter.ts

@@ -8,7 +8,7 @@
 import { assert, describe, it, beforeEach } from "vitest";
 
 import { JsonParseNode, JsonSerializationWriter } from "../../src/index";
-import { createTestBackedModelFromDiscriminatorValue, createTestParserFromDiscriminatorValue, serializeTestParser, TestBackedModel, type TestParser } from "./testEntity";
+import { createTestBackedModelFromDiscriminatorValue, createTestParserFromDiscriminatorValue, LongRunningOperationStatusObject, serializeTestParser, TestBackedModel, type TestParser } from "./testEntity";
 import { UntypedTestEntity, serializeUntypedTestEntity } from "./untypedTestEntiy";
 import { BackingStore, BackingStoreFactorySingleton, createBackedModelProxyHandler, createUntypedArray, createUntypedBoolean, createUntypedNull, createUntypedNumber, createUntypedObject, createUntypedString } from "@microsoft/kiota-abstractions";
 
@@ -59,6 +59,37 @@ describe("JsonParseNode", () => {
 		assert.deepEqual(stringValueResult, expectedObject);
 	});
 
+	it("Test enum serialization", async () => {
+		const inputObject: TestParser = {
+			status: LongRunningOperationStatusObject.NotStarted,
+			nextStatuses: [LongRunningOperationStatusObject.Succeeded, LongRunningOperationStatusObject.Failed],
+		};
+		const expectedObject: TestParser = {
+			status: LongRunningOperationStatusObject.NotStarted,
+			nextStatuses: [LongRunningOperationStatusObject.Succeeded, LongRunningOperationStatusObject.Failed],
+		};
+
+		const writer = new JsonSerializationWriter();
+		writer.writeObjectValue("", inputObject, serializeTestParser);
+		const serializedContent = writer.getSerializedContent();
+		const decoder = new TextDecoder();
+		const contentAsStr = decoder.decode(serializedContent);
+		const result = JSON.parse(contentAsStr);
+		const stringValueResult = new JsonParseNode(result).getObjectValue(createTestParserFromDiscriminatorValue) as TestParser;
+		assert.deepEqual(stringValueResult, expectedObject);
+	});
+
+	it("Test collection of enum serialization", async () => {
+		const writer = new JsonSerializationWriter();
+		const enums = [LongRunningOperationStatusObject.NotStarted, LongRunningOperationStatusObject.Succeeded];
+
+		writer.writeCollectionOfEnumValues("enum", enums);
+		const serializedContent = writer.getSerializedContent();
+		const decoder = new TextDecoder();
+		const contentAsStr = decoder.decode(serializedContent);
+		assert.equal(contentAsStr, '"enum":["notStarted","succeeded"],');
+	});
+
 	it("encodes characters properly", async () => {
 		const inputObject: TestParser = {
 			testCollection: ["2", "3"],

packages/serialization/json/test/common/testEntity.ts

@@ -22,7 +22,19 @@ export interface TestParser {
 	testNumber?: number | null | undefined;
 	testGuid?: Guid | null | undefined;
 	testUnionObject?: TestUnionObject | null | undefined;
+	status?: LongRunningOperationStatus | null;
+	nextStatuses?: LongRunningOperationStatus[] | null;
 }
+
+export const LongRunningOperationStatusObject = {
+	NotStarted: "notStarted",
+	Running: "running",
+	Succeeded: "succeeded",
+	Failed: "failed",
+	UnknownFutureValue: "unknownFutureValue",
+} as const;
+export type LongRunningOperationStatus = (typeof LongRunningOperationStatusObject)[keyof typeof LongRunningOperationStatusObject];
+
 export interface TestBackedModel extends TestParser, BackedModel {
 	backingStoreEnabled?: boolean | undefined;
 }
@@ -89,6 +101,12 @@ export function deserializeTestParser(testParser: TestParser | undefined = {}):
 		testUnionObject: (n) => {
 			testParser.testUnionObject = n.getStringValue() ?? n.getNumberValue() ?? n.getObjectValue(createTestUnionObjectFromDiscriminatorValue);
 		},
+		status: (n) => {
+			testParser.status = n.getEnumValue<LongRunningOperationStatus>(LongRunningOperationStatusObject);
+		},
+		nextStatuses: (n) => {
+			testParser.nextStatuses = n.getCollectionOfEnumValues<LongRunningOperationStatus>(LongRunningOperationStatusObject);
+		},
 	};
 }
 
@@ -148,6 +166,8 @@ export function serializeTestParser(writer: SerializationWriter, entity: TestPar
 	} else {
 		writer.writeObjectValue("testUnionObject", entity.testUnionObject as any, serializeTestUnionObject);
 	}
+	writer.writeEnumValue("status", entity.status);
+	writer.writeCollectionOfEnumValues("nextStatuses", entity.nextStatuses);
 }
 
 export function serializeFoo(writer: SerializationWriter, entity: FooResponse | undefined = {}): void {

packages/serialization/multipart/src/multipartSerializationWriter.ts

@@ -113,6 +113,14 @@ export class MultipartSerializationWriter implements SerializationWriter {
 	): void => {
 		throw new Error(`serialization of enum values is not supported with multipart`);
 	};
+	public writeCollectionOfEnumValues = <T>(
+		// eslint-disable-next-line @typescript-eslint/no-unused-vars
+		key?: string,
+		// eslint-disable-next-line @typescript-eslint/no-unused-vars
+		values?: (T | null | undefined)[],
+	): void => {
+		throw new Error(`serialization of collection of enum values is not supported with multipart`);
+	};
 	public getSerializedContent = (): ArrayBuffer => {
 		return this.writer;
 	};

packages/serialization/text/src/textSerializationWriter.ts

@@ -128,11 +128,14 @@ export class TextSerializationWriter implements SerializationWriter {
 			if (rawValues.length > 0) {
 				this.writeStringValue(
 					key,
-					rawValues.reduce((x, y) => `${x}, ${y}`),
+					rawValues.reduce((x, y) => `${x},${y}`),
 				);
 			}
 		}
 	};
+	public writeCollectionOfEnumValues = <T>(key?: string, values?: T[] | null): void => {
+		this.writeEnumValue(key, values);
+	};
 	public getSerializedContent = (): ArrayBuffer => {
 		return this.convertStringToArrayBuffer(this.writer.join(``));
 	};

packages/serialization/text/test/common/textSerializationWriter.ts

@@ -0,0 +1,32 @@
+import { assert, describe, it } from "vitest";
+import { TextSerializationWriter } from "../../src";
+
+describe("TextSerializationWriter", () => {
+	it("writeEnumValue", () => {
+		const textSerializationWriter = new TextSerializationWriter();
+
+		const statuses = [LongRunningOperationStatusObject.NotStarted, LongRunningOperationStatusObject.Running];
+		textSerializationWriter.writeEnumValue("", ...statuses);
+		const formContent = textSerializationWriter.getSerializedContent();
+		const form = new TextDecoder().decode(formContent);
+		const expectedString = "notStarted,running";
+		assert.equal(form, expectedString);
+	});
+	it("writeCollectionOfEnumValues", () => {
+		const textSerializationWriter = new TextSerializationWriter();
+		const statuses = [LongRunningOperationStatusObject.NotStarted, LongRunningOperationStatusObject.Running];
+		textSerializationWriter.writeCollectionOfEnumValues("", statuses);
+		const formContent = textSerializationWriter.getSerializedContent();
+		const form = new TextDecoder().decode(formContent);
+		const expectedString = "notStarted,running";
+		assert.equal(form, expectedString);
+	});
+});
+
+export const LongRunningOperationStatusObject = {
+	NotStarted: "notStarted",
+	Running: "running",
+	Succeeded: "succeeded",
+	Failed: "failed",
+	UnknownFutureValue: "unknownFutureValue",
+} as const;