fix: using parseGuidString as validator function

markovav-official · markovav-official · commit 7a7c9edce621 · 2024-11-05T22:41:55.000+03:00
diff --git a/packages/abstractions/src/multipartBody.ts b/packages/abstractions/src/multipartBody.ts
@@ -5,8 +5,7 @@
  * -------------------------------------------------------------------------------------------
  */
 import type { RequestAdapter } from "./requestAdapter";
-import type { ModelSerializerFunction, Parsable, ParseNode, SerializationWriter
-} from "./serialization";
+import type { ModelSerializerFunction, Parsable, ParseNode, SerializationWriter } from "./serialization";
 import { createGuid } from "./utils/guidUtils";
 
 /**
diff --git a/packages/abstractions/src/requestInformation.ts b/packages/abstractions/src/requestInformation.ts
@@ -18,7 +18,6 @@ import type { RequestConfiguration } from "./requestConfiguration";
 import type { RequestOption } from "./requestOption";
 import type { ModelSerializerFunction, Parsable, SerializationWriter } from "./serialization";
 import { TimeOnly } from "./timeOnly";
-import { Guid } from "guid-typescript";
 
 /** This class represents an abstract HTTP request. */
 export class RequestInformation implements RequestInformationSetContent {
@@ -241,7 +240,7 @@ export class RequestInformation implements RequestInformationSetContent {
 	};
 
 	private normalizeValue(value: unknown): unknown {
-		if (value instanceof Guid || value instanceof DateOnly || value instanceof TimeOnly) {
+		if (value instanceof DateOnly || value instanceof TimeOnly) {
 			return value.toString();
 		}
 		if (value instanceof Date) {
@@ -268,7 +267,7 @@ export class RequestInformation implements RequestInformationSetContent {
 				}
 			}
 			if (typeof v === "boolean" || typeof v === "number" || typeof v === "string" || Array.isArray(v)) this.queryParameters[key] = v;
-			else if (v instanceof Guid || v instanceof DateOnly || v instanceof TimeOnly) this.queryParameters[key] = v.toString();
+			else if (v instanceof DateOnly || v instanceof TimeOnly) this.queryParameters[key] = v.toString();
 			else if (v instanceof Date) this.queryParameters[key] = v.toISOString();
 			else if (v === undefined) this.queryParameters[key] = undefined;
 		});
diff --git a/packages/abstractions/src/utils/guidUtils.ts b/packages/abstractions/src/utils/guidUtils.ts
@@ -4,17 +4,38 @@
  * See License in the project root for license information.
  * -------------------------------------------------------------------------------------------
  */
-export type Guid = string
+export type Guid = string;
 
-export function createGuid(): Guid {
-  return ([gen(2), gen(1), gen(1), gen(1), gen(3)].join("-"));
-}
+const guidValidator = new RegExp("^[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$", "i");
 
-function gen(count: number) {
-  let out: string = "";
-  for (let i: number = 0; i < count; i++) {
-    // tslint:disable-next-line:no-bitwise
-    out += (((1 + Math.random()) * 0x10000) | 0).toString(16).substring(1);
-  }
-  return out;
-}
+/**
+ * Checks if the string is a valid GUID.
+ * @param source the string to check.
+ * @returns unchanged string if it is a valid GUID; otherwise, undefined.
+ */
+export const parseGuidString = (source?: string) => {
+	if (source && guidValidator.test(source)) {
+		return source;
+	}
+	return undefined;
+};
+
+/**
+ * Generates a GUID.
+ * @returns a GUID.
+ */
+export const createGuid = () => [gen(2), gen(1), gen(1), gen(1), gen(3)].join("-");
+
+/**
+ * Generates a part of a GUID.
+ * @param count the number of 2 byte chunks to generate.
+ * @returns a part of a GUID.
+ */
+export const gen = (count: number) => {
+	let out = "";
+	for (let i = 0; i < count; i++) {
+		// eslint-disable-next-line no-bitwise
+		out += (((1 + Math.random()) * 0x10000) | 0).toString(16).substring(1);
+	}
+	return out;
+};
diff --git a/packages/abstractions/test/common/requestInformation.ts b/packages/abstractions/test/common/requestInformation.ts
@@ -7,10 +7,9 @@
 
 import { assert, describe, it } from "vitest";
 
-import { DateOnly, HttpMethod, type Parsable, parseGuidString, type RequestAdapter, RequestInformation, type SerializationWriter, type SerializationWriterFactory, TimeOnly } from "../../src";
+import { DateOnly, HttpMethod, type Guid, type Parsable, parseGuidString, type RequestAdapter, RequestInformation, type SerializationWriter, type SerializationWriterFactory, TimeOnly } from "../../src";
 import { MultipartBody } from "../../src/multipartBody";
 import { TestEnum } from "./store/testEnum";
-import { Guid } from "guid-typescript";
 
 interface GetQueryParameters {
 	select?: string[];
@@ -225,7 +224,7 @@ describe("RequestInformation", () => {
 		const expected: string = `http://localhost/users/33933a8d-32bb-c6a8-784a-f60b5a1dd66a/2021-12-12?objectId=83afbf49-5583-152c-d7fb-176105d518bc&startDate=2021-12-12&startTime=23%3A12%3A00.0000000&timeStamp=2024-06-11T00%3A00%3A00.000Z`;
 		const requestInformation = new RequestInformation(HttpMethod.GET);
 		requestInformation.pathParameters["baseurl"] = baseUrl;
-		requestInformation.pathParameters["userId"] = Guid.parse("33933a8d-32bb-c6a8-784a-f60b5a1dd66a");
+		requestInformation.pathParameters["userId"] = parseGuidString("33933a8d-32bb-c6a8-784a-f60b5a1dd66a");
 		requestInformation.pathParameters["date"] = DateOnly.parse("2021-12-12");
 		requestInformation.urlTemplate = "http://localhost/users/{userId}/{date}{?objectId,startDate,startTime,endDate,endTime,timeStamp}";
 		requestInformation.setQueryStringParametersFromRawObject<GetQueryParameters>({ objectId: parseGuidString("83afbf49-5583-152c-d7fb-176105d518bc"), startDate: new DateOnly({ year: 2021, month: 12, day: 12 }), startTime: new TimeOnly({ hours: 23, minutes: 12 }), timeStamp: new Date("2024-06-11T00:00:00.000Z") }, getQueryParameterMapper);
diff --git a/packages/http/fetch/test/common/mockParseNodeFactory.ts b/packages/http/fetch/test/common/mockParseNodeFactory.ts
@@ -8,7 +8,6 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 import type { DateOnly, Duration, Guid, Parsable, ParsableFactory, ParseNode, ParseNodeFactory, TimeOnly } from "@microsoft/kiota-abstractions";
 
-
 export class MockParseNodeFactory implements ParseNodeFactory {
 	parseNodeValue: ParseNode;
 	/**
diff --git a/packages/serialization/form/src/formSerializationWriter.ts b/packages/serialization/form/src/formSerializationWriter.ts
@@ -6,15 +6,7 @@
  */
 
 /* eslint-disable @typescript-eslint/no-unused-expressions */
-import {
-  DateOnly,
-  Duration,
-  type ModelSerializerFunction,
-  type Parsable,
-  type SerializationWriter,
-  type Guid,
-  TimeOnly
-} from "@microsoft/kiota-abstractions";
+import { DateOnly, Duration, type Guid, type ModelSerializerFunction, type Parsable, type SerializationWriter, TimeOnly } from "@microsoft/kiota-abstractions";
 
 export class FormSerializationWriter implements SerializationWriter {
 	public writeByteArrayValue(
diff --git a/packages/serialization/json/src/jsonSerializationWriter.ts b/packages/serialization/json/src/jsonSerializationWriter.ts
@@ -6,23 +6,7 @@
  */
 
 /* eslint-disable @typescript-eslint/no-unused-expressions */
-import {
-  DateOnly,
-  Duration,
-  type Guid,
-  isUntypedNode,
-  type ModelSerializerFunction,
-  type Parsable,
-  type SerializationWriter,
-  TimeOnly,
-  type UntypedNode,
-  isUntypedBoolean,
-  isUntypedString,
-  isUntypedNull,
-  isUntypedNumber,
-  isUntypedObject,
-  isUntypedArray,
-inNodeEnv} from "@microsoft/kiota-abstractions";
+import { DateOnly, Duration, type Guid, isUntypedNode, type ModelSerializerFunction, type Parsable, type SerializationWriter, TimeOnly, type UntypedNode, isUntypedBoolean, isUntypedString, isUntypedNull, isUntypedNumber, isUntypedObject, isUntypedArray, inNodeEnv } from "@microsoft/kiota-abstractions";
 
 export class JsonSerializationWriter implements SerializationWriter {
 	public writeByteArrayValue(key?: string, value?: ArrayBuffer): void {
diff --git a/packages/serialization/multipart/src/multipartSerializationWriter.ts b/packages/serialization/multipart/src/multipartSerializationWriter.ts
@@ -6,15 +6,7 @@
  */
 
 /* eslint-disable @typescript-eslint/no-unused-expressions */
-import {
-  type DateOnly,
-  type Duration,
-  type Guid,
-  MultipartBody,
-  type Parsable,
-  type SerializationWriter,
-  type ModelSerializerFunction,
-  type TimeOnly } from "@microsoft/kiota-abstractions";
+import { type DateOnly, type Duration, type Guid, MultipartBody, type Parsable, type SerializationWriter, type ModelSerializerFunction, type TimeOnly } from "@microsoft/kiota-abstractions";
 
 /** Serialization writer for multipart/form-data */
 export class MultipartSerializationWriter implements SerializationWriter {
