feat(router): forward query string in declarative redirects

Author: RomainLanz

src/router/brisk.ts

@@ -22,6 +22,18 @@ import type {
   RouteBuilderArguments,
 } from '../types/url_builder.ts'
 
+/**
+ * Options for declarative route redirects
+ */
+type RedirectResponseOptions = {
+  /** HTTP status code for the redirect response */
+  status?: number
+  /** Whether to forward the incoming request query string */
+  forwardQueryString?: boolean
+}
+
+type RedirectOptions = URLOptions & RedirectResponseOptions
+
 /**
  * Brisk routes exposes the API to configure the route handler by chaining
  * one of the pre-defined methods.
@@ -102,7 +114,7 @@ export class BriskRoute extends Macroable {
    */
   redirect<Identifier extends keyof GetRoutesForMethod<RoutesList, 'GET'> & string>(
     ...args: RoutesList extends LookupList
-      ? RouteBuilderArguments<Identifier, RoutesList['GET'][Identifier], URLOptions>
+      ? RouteBuilderArguments<Identifier, RoutesList['GET'][Identifier], RedirectOptions>
       : []
   ): Route {
     const [identifier, params, options] = args as any[]
@@ -112,6 +124,9 @@ export class BriskRoute extends Macroable {
       if (options?.status) {
         redirector.status(options.status)
       }
+      if (options?.forwardQueryString !== undefined) {
+        redirector.withQs(options.forwardQueryString)
+      }
       return (redirector.toRoute as any)(identifier, params || ctx.params, options)
     }
 
@@ -122,15 +137,18 @@ export class BriskRoute extends Macroable {
   /**
    * Redirect request to a fixed URL
    * @param url - The URL to redirect to
-   * @param options - Optional redirect options including HTTP status code
+   * @param options - Optional redirect options including HTTP status code and query string forwarding
    * @returns The created route instance
    */
-  redirectToPath(url: string, options?: { status: number }): Route {
+  redirectToPath(url: string, options?: RedirectResponseOptions): Route {
     function redirectsToPath(ctx: HttpContext) {
       const redirector = ctx.response.redirect()
       if (options?.status) {
         redirector.status(options.status)
       }
+      if (options?.forwardQueryString !== undefined) {
+        redirector.withQs(options.forwardQueryString)
+      }
       return redirector.toPath(url)
     }
 

tests/server.spec.ts

@@ -323,6 +323,30 @@ test.group('Server | Response handling', () => {
     assert.equal(headers.location, '/dashboard')
   })
 
+  test('redirect to a route and forward the incoming query string', async ({ assert }) => {
+    const app = new AppFactory().create(BASE_URL, () => {})
+    const server = new ServerFactory().merge({ app }).create()
+    const httpServer = createServer(server.handle.bind(server))
+
+    await app.init()
+
+    server.use([])
+
+    server
+      .getRouter()
+      .get('/dashboard', () => 'dashboard')
+      .as('dashboard')
+
+    // @ts-expect-error "Because RoutesList" does not have this route
+    server.getRouter().on('/').redirect('dashboard', {}, { forwardQueryString: true })
+
+    await server.boot()
+
+    const { status, headers } = await supertest(httpServer).get('/?tab=profile')
+    assert.equal(status, 302)
+    assert.equal(headers.location, '/dashboard?tab=profile')
+  })
+
   test('redirect to a path using route.redirectToPath method', async ({ assert }) => {
     const app = new AppFactory().create(BASE_URL, () => {})
     const server = new ServerFactory().merge({ app }).create()
@@ -341,6 +365,23 @@ test.group('Server | Response handling', () => {
     assert.equal(headers.location, '/dashboard')
   })
 
+  test('redirect to a path and forward the incoming query string', async ({ assert }) => {
+    const app = new AppFactory().create(BASE_URL, () => {})
+    const server = new ServerFactory().merge({ app }).create()
+    const httpServer = createServer(server.handle.bind(server))
+
+    await app.init()
+
+    server.use([])
+    server.getRouter().on('/').redirectToPath('/dashboard', { forwardQueryString: true })
+
+    await server.boot()
+
+    const { status, headers } = await supertest(httpServer).get('/?tab=profile')
+    assert.equal(status, 302)
+    assert.equal(headers.location, '/dashboard?tab=profile')
+  })
+
   test('redirect to a route with custom status code', async ({ assert }) => {
     const app = new AppFactory().create(BASE_URL, () => {})
     const server = new ServerFactory().merge({ app }).create()