Make core rest client work with null and encoding

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

@@ -1,4 +1,9 @@
 # Release History
+## 1.0.0-beta.8 (2021-10-27)
+
+### Features Added
+
+- Add options to support enable path parameter encoding and query 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;
+    enableUrlEncoding?: 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 encode the path or query parameters */
+  enableUrlEncoding?: 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);
+    if (options.enableUrlEncoding) {
+      const encodeParam = encodeURIComponent(pathParam);
+      path = path.replace(/{([^/]+)}/, encodeParam);   
+    } else {
+      path = path.replace(/{([^/]+)}/, pathParam); 
+    }  
   }
 
   const url = new URL(`${baseUrl}/${path}`);
@@ -34,11 +39,20 @@ 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`);
       }
       const value = param.toISOString !== undefined ? param.toISOString() : param.toString();
-      url.searchParams.append(key, value);
+      if (options.enableUrlEncoding) {
+        const encodeParam = encodeURIComponent(value);
+        url.searchParams.append(key, encodeParam);
+      } else {
+        url.searchParams.append(key, value);
+      }
+
     }
   }
 

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

@@ -56,4 +56,19 @@ describe("urlHelpers", () => {
 
     assert.equal(result, `https://example2.org`);
   });
+
+  it("should encode url when enable path parameter encoding", () => {
+    const result = buildRequestUrl(mockBaseUrl, "/foo bar", [], {
+      enableUrlEncoding: true
+    });
+    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= ' },
+      enableUrlEncoding: true
+    });
+    assert.equal(result, `https://example.org/foo?foo=%2520aaaa&bar=b%253D%2520`);
+  });
 });