Make core rest client work with null and encoding (#18381)

* make core rest client work with null and add encoding options

* adding test

* adding test

* use enableUrlEncoding instead

* change to skipUrlEncoding

* add change log

* update dependencies

* upate format

* update according comments

* update format

* change back dependencies

* update pnpm-lock

* resolve ci failure

sdk/core/core-client-rest/CHANGELOG.md

@@ -1,4 +1,9 @@
 # Release History
+## 1.0.0-beta.8 (Unreleased)
+
+### Features Added
+
+- Add options skipUrlEncoding to support skip path parameter encoding.
 
 ## 1.0.0-beta.7 (2021-09-02)
 

sdk/core/core-client-rest/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-rest/core-client",
-  "version": "1.0.0-beta.7",
+  "version": "1.0.0-beta.8",
   "description": "Core library for interfacing with AutoRest rest level generated code",
   "sdk-type": "client",
   "main": "dist/index.js",

sdk/core/core-client-rest/review/core-client.api.md

@@ -82,14 +82,14 @@ export type RequestParameters = {
     queryParameters?: Record<string, unknown>;
     contentType?: string;
     allowInsecureConnection?: boolean;
+    skipUrlEncoding?: boolean;
 };
 
 // @public
 export type RouteParams<TRoute extends string> = TRoute extends `${infer _Head}/{${infer _Param}}${infer Tail}` ? [
-    pathParam: string,
-    ...pathParams: RouteParams<Tail>
+pathParam: string,
+...pathParams: RouteParams<Tail>
 ] : [
 ];
 
-
 ```

sdk/core/core-client-rest/src/pathClientTypes.ts

@@ -31,6 +31,8 @@ export type RequestParameters = {
   contentType?: string;
   /** Set to true if the request is sent over HTTP instead of HTTPS */
   allowInsecureConnection?: boolean;
+  /** Set to true if you want to skip encoding the path parameters */
+  skipUrlEncoding?: boolean;
 };
 
 /**

sdk/core/core-client-rest/src/urlHelpers.ts

@@ -25,7 +25,12 @@ export function buildRequestUrl(
   }
 
   for (const pathParam of pathParameters) {
-    path = path.replace(/{([^/]+)}/, pathParam);
+    let value = pathParam;
+    if (!options.skipUrlEncoding) {
+      value = encodeURIComponent(pathParam);
+    }
+
+    path = path.replace(/{([^/]+)}/, value);
   }
 
   const url = new URL(`${baseUrl}/${path}`);
@@ -34,6 +39,9 @@ export function buildRequestUrl(
     const queryParams = options.queryParameters;
     for (const key of Object.keys(queryParams)) {
       const param = queryParams[key] as any;
+      if (param === undefined || param === null) {
+        continue;
+      }
       if (!param.toString || typeof param.toString !== "function") {
         throw new Error(`Query parameters must be able to be represented as string, ${key} can't`);
       }

sdk/core/core-client-rest/test/urlHelpers.spec.ts

@@ -53,7 +53,25 @@ describe("urlHelpers", () => {
 
   it("should handle full urls as path", () => {
     const result = buildRequestUrl(mockBaseUrl, "https://example2.org", []);
-
     assert.equal(result, `https://example2.org`);
   });
+
+  it("should encode url when enable path parameter encoding", () => {
+    const result = buildRequestUrl(mockBaseUrl, "/foo bar", []);
+    assert.equal(result, `https://example.org/foo%20bar`);
+  });
+
+  it("should encode url when enable query parameter encoding", () => {
+    const result = buildRequestUrl(mockBaseUrl, "/foo", [], {
+      queryParameters: { foo: " aaaa", bar: "b= " },
+    });
+    assert.equal(result, `https://example.org/foo?foo=+aaaa&bar=b%3D+`);
+  });
+
+  it("should encode url when skip encoding path parameter", () => {
+    const result = buildRequestUrl(mockBaseUrl, "/foo%bar", [], {
+      skipUrlEncoding: true,
+    });
+    assert.equal(result, `https://example.org/foo%bar`);
+  });
 });