Feat: encode path parameters by default (@W-18136408@)

.github/workflows/test.yml

@@ -9,8 +9,7 @@ jobs:
   linux-tests:
     strategy:
       matrix:
-        # TODO: remove older node versions
-        node: [10, 12, 14, 16, 18, 20, 22]
+        node: [20, 22]
       fail-fast: false
     runs-on: ubuntu-latest
     steps:

CHANGELOG.md

@@ -1,5 +1,8 @@
 # CHANGELOG
 
+## 2.0.0
+* Path parameter special characters are encoded by default
+
 ## 1.8.0
 * Make request `body` for HTTP endpoint calls optional [#117](https://github.com/SalesforceCommerceCloud/commerce-sdk-core/pull/117/files)
 

src/base/resource.ts

@@ -41,9 +41,21 @@ export class Resource {
    * @returns Path with actual parameters
    */
   substitutePathParameters(path = "", parameters: PathParameters = {}): string {
+    const encodedPathParams: PathParameters = {};
+
+    Object.keys(parameters || {}).forEach((key) => {
+      const value = parameters?.[key];
+      if (value) {
+        encodedPathParams[key] = encodeURIComponent(value);
+      }
+    });
+
     return path.replace(/\{([^}]+)\}/g, (_entireMatch, param) => {
-      if (parameters.hasOwnProperty(param) && parameters[param] !== undefined) {
-        return parameters[param];
+      if (
+        encodedPathParams.hasOwnProperty(param) &&
+        encodedPathParams[param] !== undefined
+      ) {
+        return encodedPathParams[param];
       }
       throw new Error(
         `Failed to find a value for required path parameter '${param}'`

src/base/staticClient.ts

@@ -263,9 +263,7 @@ export async function _delete(options: SdkFetchOptions): Promise<object> {
  * @returns Either the Response object or the DTO inside it wrapped in a promise,
  * depending upon options.rawResponse
  */
-export async function _patch(
-  options: SdkFetchOptions
-): Promise<object> {
+export async function _patch(options: SdkFetchOptions): Promise<object> {
   return runFetch("patch", options);
 }
 

test/resource.test.ts

@@ -200,4 +200,13 @@ describe("Resource class tests", () => {
       // URI decoded: baseUri/path?expand=availability,images&refine=price=(0..150)&refine=c_refinementColor=Red
     );
   });
+
+  it("returns correct url with path param with special characters", () => {
+    assert.strictEqual(
+      new Resource("https://example.com", {}, "/path/with/{special}/chars", {
+        special: "test!@#$%",
+      }).toString(),
+      "https://example.com/path/with/test!%40%23%24%25/chars"
+    );
+  });
 });