Custom httpStatusCode in redirect()

.github/workflows/main.yml

@@ -1,33 +1,28 @@
-name: tests
+name: Main test
+
 on:
   push:
   pull_request:
     branches: [master]
-  schedule:
-    - cron: '0 0 * * 1'
 
 jobs:
   tests:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        nimversion:
-        - 1.4.8
-        - git:6b97889f44d06f66
+        nim:
+        - 1.6.18
+        - 2.0.2
         os:
         - ubuntu-latest
         - macOS-latest
         - windows-latest
     steps:
-    - uses: actions/checkout@v1
-      with:
-        submodules: true
-    - uses: iffy/[email protected]
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      with:
-        nimversion: ${{ matrix.nimversion }}
-    - name: Test
-      run: |
-        nimble test
-        nimble refresh
+      - uses: actions/checkout@v3
+      - name: Setup nim
+        uses: jiro4989/setup-nim-action@v1
+        with:
+          nim-version: ${{ matrix.nim }}
+      - run: |
+          nimble test -Y
+          nimble refresh

.gitignore

@@ -1,5 +1,7 @@
 /tests/*
 !/tests/*.nim
 !/tests/*/
+!/tests/nim-in-action-code/*
+/tests/nim-in-action-code/Chapter7/Tweeter/src/tweeter
 
 nimcache

jester.nim

@@ -83,8 +83,14 @@ type
     of RouteCode:
       data: ResponseData
 
+  Startup = proc () {.closure, gcsafe.}
+
 const jesterVer = "0.6.0"
 
+proc doNothing(): Startup {.gcsafe.} =
+  result = proc () {.closure, gcsafe.} =
+    discard
+
 proc toStr(headers: Option[RawHeaders]): string =
   return $newHttpHeaders(headers.get(@({:})))
 
@@ -421,7 +427,8 @@ proc handleRequest(jes: Jester, httpReq: NativeRequest): Future[void] =
 proc newSettings*(
   port = Port(5000), staticDir = getCurrentDir() / "public",
   appName = "", bindAddr = "", reusePort = false, maxBody = 8388608, numThreads = 0,
-  futureErrorHandler: proc (fut: Future[void]) {.closure, gcsafe.} = nil
+  futureErrorHandler: proc (fut: Future[void]) {.closure, gcsafe.} = nil,
+  startup: Startup = doNothing()
 ): Settings =
   result = Settings(
     staticDir: normalizedPath(staticDir),
@@ -431,7 +438,8 @@ proc newSettings*(
     reusePort: reusePort,
     maxBody: maxBody,
     numThreads: numThreads,
-    futureErrorHandler: futureErrorHandler
+    futureErrorHandler: futureErrorHandler,
+    startup: startup
   )
 
 proc register*(self: var Jester, matcher: MatchProc) =
@@ -524,20 +532,29 @@ proc serve*(
                    [$self.settings.port, self.settings.appName])
 
   var jes = self
+  let domain = block:
+    if self.settings.bindAddr != "":
+      let ip = self.settings.bindAddr.parseIpAddress()
+      if ip.family == IPv4:
+        AF_INET
+      else:
+        AF_INET6
+    else:
+      AF_INET
   when useHttpBeast:
     run(
       proc (req: httpbeast.Request): Future[void] =
-         {.gcsafe.}:
+        {.gcsafe.}:
           result = handleRequest(jes, req),
-      httpbeast.initSettings(self.settings.port, self.settings.bindAddr, self.settings.numThreads)
+      httpbeast.initSettings(self.settings.port, self.settings.bindAddr, self.settings.numThreads, startup = self.settings.startup, domain = domain)
     )
   else:
     self.httpServer = newAsyncHttpServer(reusePort=self.settings.reusePort, maxBody=self.settings.maxBody)
     let serveFut = self.httpServer.serve(
       self.settings.port,
       proc (req: asynchttpserver.Request): Future[void] {.gcsafe, closure.} =
         result = handleRequest(jes, req),
-      self.settings.bindAddr)
+      self.settings.bindAddr, domain = domain)
     if not self.settings.futureErrorHandler.isNil:
       serveFut.callback = self.settings.futureErrorHandler
     else:
@@ -612,15 +629,15 @@ template resp*(code: HttpCode): typed =
   result.matched = true
   break route
 
-template redirect*(url: string, halt = true): typed =
+template redirect*(url: string, halt = true, httpStatusCode = Http303): typed =
   ## Redirects to ``url``. Returns from this request handler immediately.
   ##
   ## If ``halt`` is true, skips executing future handlers, too.
   ##
   ## Any set response headers are preserved for this request.
   bind TCActionSend, newHttpHeaders
   result[0] = TCActionSend
-  result[1] = Http303
+  result[1] = httpStatusCode
   setHeader(result[2], "Location", url)
   result[3] = ""
   result.matched = true

jester.nimble

@@ -10,11 +10,17 @@ skipDirs = @["tests"]
 
 # Deps
 
-requires "nim >= 1.0.0"
+requires "nim >= 1.6.18"
 
 when not defined(windows):
-  requires "httpbeast >= 0.4.0"
+  when NimMajor >= 2:
+    requires "https://github.com/ThomasTJdev/httpbeast_fork >= 0.4.2"
+  else:
+    requires "https://github.com/ThomasTJdev/httpbeast_fork >= 0.4.0"
 
 task test, "Runs the test suite.":
+  when NimMajor >= 2:
+    # Due to tests/nim-in-action-code/Chapter7
+    exec "nimble install -y [email protected]"
   exec "nimble install -y asynctools@#0e6bdc3ed5bae8c7cc9"
   exec "nim c -r tests/tester"

jester/private/utils.nim

@@ -19,6 +19,7 @@ type
     maxBody*: int
     futureErrorHandler*: proc (fut: Future[void]) {.closure, gcsafe.}
     numThreads*: int # Only available with Httpbeast (`useHttpBeast = true`)
+    startup*: proc () {.closure, gcsafe.} # Only available with Httpbeast (`useHttpBeast = true`)
 
   JesterError* = object of Exception
 

jester/request.nim

@@ -1,6 +1,7 @@
 import uri, cgi, tables, logging, strutils, re, options
+from sequtils import map
 
-import jester/private/utils
+import private/utils
 
 when useHttpBeast:
   import httpbeast except Settings
@@ -93,28 +94,62 @@ proc ip*(req: Request): string =
 
 proc params*(req: Request): Table[string, string] =
   ## Parameters from the pattern and the query string.
+  ##
+  ## Note that this doesn't allow for duplicated keys (it simply returns the last occuring value)
+  ## Use `paramValuesAsSeq` if you need multiple values for a key
   if req.patternParams.isSome():
     result = req.patternParams.get()
   else:
     result = initTable[string, string]()
 
-  when useHttpBeast:
-    let query = req.req.path.get("").parseUri().query
+  var queriesToDecode: seq[string] = @[]
+  queriesToDecode.add query(req)
+
+  let contentType = req.headers.getOrDefault("Content-Type")
+  if contentType.startswith("application/x-www-form-urlencoded"):
+    queriesToDecode.add req.body
+
+  for query in queriesToDecode:
+    try:
+      for key, val in cgi.decodeData(query):
+        result[key] = decodeUrl(val)
+    except CgiError:
+      logging.warn("Incorrect query. Got: $1" % [query])
+
+proc paramValuesAsSeq*(req: Request): Table[string, seq[string]] =
+  ## Parameters from the pattern and the query string.
+  ##
+  ## This allows for duplicated keys in the query (in contrast to `params`)
+  if req.patternParams.isSome():
+    let patternParams: Table[string, string] = req.patternParams.get()
+    var patternParamsSeq: seq[(string, string)] = @[]
+    for key, val in pairs(patternParams):
+      patternParamsSeq.add (key, val)
+
+    # We are not url-decoding the key/value for the patternParams (matches implementation in `params`
+    result = sequtils.map(patternParamsSeq,
+              proc(entry: (string, string)): (string, seq[string]) =
+                (entry[0], @[entry[1]])
+    ).toTable()
   else:
-    let query = req.req.url.query
+    result = initTable[string, seq[string]]()
 
-  try:
-    for key, val in cgi.decodeData(query):
-      result[key] = decodeUrl(val)
-  except CgiError:
-    logging.warn("Incorrect query. Got: $1" % [query])
+  var queriesToDecode: seq[string] = @[]
+  queriesToDecode.add query(req)
 
   let contentType = req.headers.getOrDefault("Content-Type")
   if contentType.startswith("application/x-www-form-urlencoded"):
+    queriesToDecode.add req.body
+
+  for query in queriesToDecode:
     try:
-      parseUrlQuery(req.body, result)
-    except:
-      logging.warn("Could not parse URL query.")
+      for key, value in cgi.decodeData(query):
+        if result.hasKey(key):
+          result[key].add value
+        else:
+          result[key] = @[value]
+    except CgiError:
+      logging.warn("Incorrect query. Got: $1" % [query])
 
 proc formData*(req: Request): MultiData =
   let contentType = req.headers.getOrDefault("Content-Type")

readme.markdown

@@ -1,3 +1,16 @@
+# FORK OF Jester
+
+This repo with jester is updated to work with Nim version 2.0
+
+**Reason:**
+* Pull requests not being merged (or closed) in main repo
+* Dependency to `httpbeast` does not support Nim 2.0
+* Full support for Nim 2.0
+
+The minimum Nim version the fork supports is 1.6.18. Test are done with
+Nim 1.6.18 and stable (2.x.x) versions.
+
+
 # 🃏 Jester 🃏
 
 The sinatra-like web framework for Nim. Jester provides a DSL for quickly

tests/alltest.nim

@@ -228,3 +228,12 @@ routes:
     setHeader(responseHeaders, "foo", "foo")
     setHeader(responseHeaders, "bar", "bar")
     resp Http200, {"Content-Type": "text/plain"}, "result"
+
+  get "/redirectDefault":
+    redirect("/")
+
+  get "/redirect301":
+    redirect("/", httpStatusCode = Http301)
+
+  get "/redirect302":
+    redirect("/", httpStatusCode = Http302)

tests/issue247.nim

@@ -0,0 +1,41 @@
+from std/cgi import decodeUrl
+from std/strformat import fmt
+from std/strutils import join
+import jester
+
+settings:
+  port = Port(5454)
+  bindAddr = "127.0.0.1"
+
+proc formatParams(params: Table[string, string]): string =
+  result = ""
+  for key, value in params.pairs:
+    result.add fmt"{key}: {value}"
+
+proc formatSeqParams(params: Table[string, seq[string]]): string =
+  result = ""
+  for key, values in params.pairs:
+    let value = values.join ","
+    result.add fmt"{key}: {value}"
+
+routes:
+  get "/":
+    resp Http200
+  get "/params":
+    let params = params request
+    resp formatParams params
+  get "/params/@val%23ue":
+    let params = params request
+    resp formatParams params
+  post "/params/@val%23ue":
+    let params = params request
+    resp formatParams params
+  get "/multi":
+    let params = paramValuesAsSeq request
+    resp formatSeqParams(params)
+  get "/@val%23ue":
+    let params = paramValuesAsSeq request
+    resp formatSeqParams(params)
+  post "/@val%23ue":
+    let params = paramValuesAsSeq request
+    resp formatSeqParams(params)

tests/nim-in-action-code copy/Chapter7/Tweeter/Tweeter.nimble

@@ -0,0 +1,11 @@
+# Package
+
+version       = "0.1.0"
+author        = "Dominik Picheta"
+description   = "A simple Twitter clone developed in Nim in Action."
+license       = "MIT"
+
+# Dependencies
+
+requires "nim >= 0.13.1"
+requires "jester >= 0.0.1"