remove query param from URL when its value is default

zth · Jan 6, 2025 · becb82c · becb82c
1 parent 01a927c
commit becb82c
Show file tree

Hide file tree

Showing 13 changed files with 31 additions and 20 deletions.
diff --git a/.changeset/kind-rings-attend.md b/.changeset/kind-rings-attend.md
@@ -0,0 +1,8 @@
+---
+"@rescript-relay-router-example/client-rendering": minor
+"@rescript-relay-router-example/express": minor
+"rescript-relay-router": minor
+"@rescript-relay-router/utils": minor
+---
+
+remove query param from URL when its value is default
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -38,11 +38,6 @@ jobs:
       - name: Build all projects
         run: |
           yarn build
-      # Since we don't want to have generated code formatted in the router we regenerate
-      # the router code after formatting.
-      - name: Sync router code generation
-        run: |
-          yarn workspaces foreach --topological-dev run router:generate
       - name: git status
         id: git_status
         shell: bash

diff --git a/examples/client-rendering/package.json b/examples/client-rendering/package.json
@@ -8,7 +8,7 @@
   "type": "module",
   "packageManager": "[email protected]",
   "scripts": {
-    "build": "run-s 'build:*'",
+    "build": "yarn router:generate && run-s 'build:*'",
     "build:relay": "rescript-relay-compiler",
     "build:rescript": "rescript build -with-deps",
     "build:vite": "vite build --outDir dist/client",

diff --git a/...ent-rendering/src/routes/__generated__/Route__Root__Todos__ByStatusDecodedExtra_route.res b/...ent-rendering/src/routes/__generated__/Route__Root__Todos__ByStatusDecodedExtra_route.res
diff --git a/...t-rendering/src/routes/__generated__/Route__Root__Todos__ByStatusDecoded__Child_route.res b/...t-rendering/src/routes/__generated__/Route__Root__Todos__ByStatusDecoded__Child_route.res
diff --git a/...s/client-rendering/src/routes/__generated__/Route__Root__Todos__ByStatusDecoded_route.res b/...s/client-rendering/src/routes/__generated__/Route__Root__Todos__ByStatusDecoded_route.res
diff --git a/examples/client-rendering/src/routes/__generated__/Route__Root__Todos__ByStatus_route.res b/examples/client-rendering/src/routes/__generated__/Route__Root__Todos__ByStatus_route.res
diff --git a/examples/client-rendering/src/routes/__generated__/Route__Root__Todos__Single_route.res b/examples/client-rendering/src/routes/__generated__/Route__Root__Todos__Single_route.res
diff --git a/examples/client-rendering/src/routes/__generated__/Route__Root__Todos_route.res b/examples/client-rendering/src/routes/__generated__/Route__Root__Todos_route.res
diff --git a/examples/client-rendering/test/UrlEncodingDecoding.test.res b/examples/client-rendering/test/UrlEncodingDecoding.test.res
@@ -17,6 +17,11 @@ describe("makeLink", () => {
     let link = Routes.Root.Todos.Route.makeLink(~byValue="/incorrect value, for url")
     expect(link)->Expect.toBe("/todos?byValue=%2Fincorrect%20value%2C%20for%20url")
   })
+
+  test("should omit query param when value is default value", _t => {
+    let link = Routes.Root.Todos.Route.makeLink(~statusWithDefault=NotCompleted)
+    expect(link)->Expect.toBe("/todos")
+  })
 })
 
 describe("parsing", () => {

diff --git a/examples/express/package.json b/examples/express/package.json
@@ -8,7 +8,7 @@
   "type": "module",
   "packageManager": "[email protected]",
   "scripts": {
-    "build": "run-s 'build:*'",
+    "build": "yarn router:generate && run-s 'build:*'",
     "build:relay": "rescript-relay-compiler",
     "build:rescript": "rescript build -with-deps",
     "build:vite": "run-s 'build:vite:*'",

diff --git a/packages/rescript-relay-router/cli/RescriptRelayRouterCli__Codegen.res b/packages/rescript-relay-router/cli/RescriptRelayRouterCli__Codegen.res
@@ -100,6 +100,7 @@ let routePattern = "${route.path->RoutePath.toPattern}"
     queryParamSerializers->Array.forEach(((key, serializer, paramType)) => {
       let serializerStr = `queryParams->QueryParams.${switch paramType {
         | Array(_) => "setParamArray"
+        | CustomModule({required: true}) => "setParamOpt"
         | _ => "setParam"
         }}(~key="${key->SafeParam.getOriginalKey}", ~value=${serializer})`
 
@@ -231,7 +232,7 @@ let applyQueryParams = (
                 ~variableName=key,
               )})))`
           | CustomModule({required: true}) =>
-            `\n  queryParams->QueryParams.setParam(~key="${key}", ~value=${queryParam->Utils.QueryParams.toSerializer(
+            `\n  queryParams->QueryParams.setParamOpt(~key="${key}", ~value=${queryParam->Utils.QueryParams.toSerializer(
                 ~variableName=`newParams.${key}`,
               )})`
           | queryParam =>

diff --git a/packages/rescript-relay-router/cli/RescriptRelayRouterCli__Utils.res b/packages/rescript-relay-router/cli/RescriptRelayRouterCli__Utils.res
@@ -85,6 +85,8 @@ module QueryParams = {
     | Boolean => `switch ${variableName} { | true => "true" | false => "false" }`
     | Int => `Int.toString(${variableName})`
     | Float => `Float.toString(${variableName})`
+    | CustomModule({moduleName, required: true}) =>
+      `${variableName} == ${moduleName}.defaultValue ? None : ${variableName}->${moduleName}.serialize->Some`
     | CustomModule({moduleName}) => `${variableName}->${moduleName}.serialize`
     | Array(inner) =>
       switch inner {