Improve `hono request` output

[yusukebe]

Currently, the hono request output format is as follows:

{
  "status": 200,
  "body": "content"
  "headers": {}
}

We have room for reconsideration and improvement.

One problem is that if the application returns JSON, the result is like this:

The app:

import { Hono } from 'hono.'

const app = new Hono()

app.get('/', (c) => {
  return c.json({
    message: 'Hello'
  })
})

export default app

The output:

{
  "status": 200,
  "body": "{\"message\":\"Hello\"}",
  "headers": {
    "content-type": "application/json"
  }
}

The body {\"message\":\"Hello\"} is expected format?? I think no. It should not be escaped. And more! Should status and headers be included in the output? Following curl, the output should be only the body content by default:

curl http://localhost:7070
{"message": "Hello"}

Perhaps following curl is okay, adding an option like -I. On the other hand, JSON is beneficial to parse with jq or a simpler command. But regarding this, it's okay to add the option like --json or (-w '%{json}' looks interesting but verbose).

Anyway, we have to consider the output format of hono request.

[ysknsid25]

Apparently JSON.parse will "interpret" the necessary escaping and return it to the original string.

I tried it locally, and by using JSON.parse and then JSON.stringify, it becomes "{\"message\":\"Hello\"} -> {"message": "Hello"}, which may be able to output this 🤔

    .action(async (file: string | undefined, options: RequestOptions) => {
      const path = options.path || '/'
      const result = await executeRequest(file, path, options)
+      let parsedBody: any
+      try {
+        parsedBody = JSON.parse(result.body)
+      } catch (e) {
+        parsedBody = result.body
+      }
+
+      const output = {
+        status: result.status,
+        body: parsedBody,
+        headers: result.headers,
+      }
-       console.log(JSON.stringify(result, null, 2))
+      console.log(JSON.stringify(output, null, 2))
    })

Hono/app.ts

import { Hono } from 'hono'

const app = new Hono()

app.get('/', (c) => {
  return c.json({ message: 'Hello Hono!' })
})

export default app

result

So, like this?

    .action(async (file: string | undefined, options: RequestOptions) => {
      const path = options.path || '/'
      const result = await executeRequest(file, path, options)
      let parsedBody: any // I can't help it ><
      try {
        parsedBody = JSON.parse(result.body)
      } catch (e) {
        parsedBody = result.body
      }

      // Considering the increased options, the Switch might be better.
      if(/** if -I option directed */){
        console.log(JSON.stringify({status: result.status, body: parsedBody, headers: result.headers}, null, 2)) 
      } else {
        console.log(JSON.stringify(parsedBody, null, 2))
      }

if not direct -I

[yusukebe]

@ysknsid25

Thank you for the comment.

Another thing we should consider is the possibility of returning a binary from the app. If so, putting it into JSON does not work. In this case, it would be good to show a warning like the one from the curl command.

[ysknsid25]

I have searched curl source code. curl looks like judgeing binary or not by checking data cointains NULL string.
(FYI: https://github.com/curl/curl/blob/0417d323c96db547e5ed9da733c51aed02be723e/src/tool_cb_wrt.c#L311-L320)

I'll try to resolve this issue refering curl.

[yusukebe]

@ysknsid25

I'm sorry to be super late!

I like the feature #58! This is great! And after consideration, I think Hono CLI should follow the curl options.

If you have the following app:

import { Hono } from 'hono'

const app = new Hono()

app.get('/', (c) => {
  return c.text('Hello Hono!')
})

export default app

So the default output is plain text only.

$ hono request src/index.ts
Hello Hono!

If you want to get the output as JSON, you can specify -J or --json option:

$ hono request -J src/index.ts
{
  "status": 200,
  "body": "Hello Hono!",
  "headers": {
    "content-type": "text/plain;charset=UTF-8"
  }
}

Plus, I'd like to add the following commands as the same as curl.

• -i - Show HTTP information with content
• -I - Show HTTP information
• -O - Write output to file, specifying the name
• -o - Write output to file

@ysknsid25 What do you think of this? I also want to hear @usualoma 's option.

[ysknsid25]

Hi @yusukebe 👋
I just wanted to let you know...

About -O and -o, I think so too. I also write issue #57 👍
I'm thinking about -i and -I...

[yusukebe]

@ysknsid25 Yes, I knew it! That's good.

[usualoma]

Hi @yusukebe, @ysknsid25

My apologies for the delayed comment. After giving it some thought, I fully agree with the content of the comment below.

#51 (comment)

[ysknsid25]

@yusukebe @usualoma
Sorry for the late reply. I'll try to implement it as my winter break homework.
☃️ Have a nice winter vacation ☃️

[yusukebe]

@ysknsid25

I'll try to implement it as my winter break homework.

Wooow. Please! Happy holidays!