Merge pull request #50 from zaghaghi/30-format-json-output-integrate-with-jq

feat: integrate jq filtering and search functionality in response viewer

Author: zaghaghi

Cargo.lock

@@ -32,6 +32,9 @@ human-panic = "2.0.0"
 humansize = "2.1.3"
 json5 = "0.4.1"
 boon = { version = "0.6.1", default-features = false }
+jaq-core = "2"
+jaq-std = "2"
+jaq-json = { version = "1.0.0", features = ["serde_json"] }
 lazy_static = "1.4.0"
 libc = "0.2.153"
 log = "0.4.21"

Cargo.toml

@@ -170,7 +170,11 @@ Then, add `openapi-tui` to your `configuration.nix`
 | `query`, `q` | Add or remove query strings. sub-commands are `add` or `rm`. e.g. `query add page` |
 | `header`, `h` | Add or remove headers. sub-commands are `add` or `rm`. e.g. `header add x-api-key` |
 | `request`, `r` | Load request payload. e.g. `request open /home/hamed/payload.json` |
-| `response`, `s` | Save response payload e.g/ `response save /home/hamed/result.json` |
+| `response`, `s` | Save response payload e.g. `response save /home/hamed/result.json` |
+| `jq <expr>` | Filter JSON response with a jq expression. e.g. `jq .items[0]` |
+| `jq` | Clear jq filter and return to normal response view |
+| `search <term>` | Search for a term in the response body (case-insensitive). e.g. `search error` |
+| `search` | Clear search and return to normal response view |
 
 # Environment Variables
 | Variable | Description |
@@ -204,6 +208,12 @@ Then, add `openapi-tui` to your `configuration.nix`
 - [X] Support array query strings
 - [X] Suppert extra headers
 - [X] Support multiple servers
+- [X] Format response body by content-type (JSON pretty-print)
+- [X] Syntax highlighting in response viewer
+- [X] Line numbers in response viewer
+- [X] Scroll response body with j/k
+- [X] JQ filter for JSON responses
+- [X] Text search in response body
 
 # Backlog
 - [ ] Schema Types (openapi-31)

README.md

@@ -45,4 +45,6 @@ pub enum Action {
   RemoveHeader(String),
   OpenRequestPayload(String),
   SaveResponsePayload(String),
+  ApplyJqQuery(String),
+  ApplySearch(String),
 }

src/action.rs

@@ -0,0 +1,19 @@
+use super::Formatter;
+
+pub struct JsonFormatter;
+
+impl Formatter for JsonFormatter {
+  fn can_format(&self, content_type: &str) -> bool {
+    content_type.contains("json")
+  }
+
+  fn syntax_name(&self) -> Option<&'static str> {
+    Some("json")
+  }
+
+  fn format(&self, input: &str) -> String {
+    serde_json::from_str::<serde_json::Value>(input)
+      .and_then(|v| serde_json::to_string_pretty(&v))
+      .unwrap_or_else(|_| input.to_string())
+  }
+}

src/formatters/json.rs

@@ -0,0 +1,42 @@
+pub mod json;
+
+pub trait Formatter: Send + Sync {
+  fn can_format(&self, content_type: &str) -> bool;
+  fn format(&self, input: &str) -> String;
+  fn syntax_name(&self) -> Option<&'static str> {
+    None
+  }
+}
+
+pub struct FormatterRegistry {
+  formatters: Vec<Box<dyn Formatter>>,
+}
+
+impl Default for FormatterRegistry {
+  fn default() -> Self {
+    Self::new()
+  }
+}
+
+impl FormatterRegistry {
+  pub fn new() -> Self {
+    Self { formatters: vec![] }
+  }
+
+  pub fn register(&mut self, formatter: Box<dyn Formatter>) {
+    self.formatters.push(formatter);
+  }
+
+  pub fn format(&self, content_type: &str, input: &str) -> String {
+    self
+      .formatters
+      .iter()
+      .find(|f| f.can_format(content_type))
+      .map(|f| f.format(input))
+      .unwrap_or_else(|| input.to_string())
+  }
+
+  pub fn syntax_name(&self, content_type: &str) -> Option<&'static str> {
+    self.formatters.iter().find(|f| f.can_format(content_type)).and_then(|f| f.syntax_name())
+  }
+}

src/formatters/mod.rs

@@ -3,6 +3,7 @@ pub mod app;
 pub mod cli;
 pub mod components;
 pub mod config;
+pub mod formatters;
 pub mod pages;
 pub mod panes;
 pub mod request;

src/main.rs

@@ -118,8 +118,20 @@ impl Phone {
       }
       return Some(Action::TimedStatusLine("invalid response args. response save <payload-file-name>".into(), 3));
     }
+    if let Some(expr) = command_args.strip_prefix("jq ") {
+      return Some(Action::ApplyJqQuery(expr.trim().to_string()));
+    }
+    if command_args.eq("jq") {
+      return Some(Action::ApplyJqQuery(String::new()));
+    }
+    if let Some(term) = command_args.strip_prefix("search ") {
+      return Some(Action::ApplySearch(term.trim().to_string()));
+    }
+    if command_args.eq("search") {
+      return Some(Action::ApplySearch(String::new()));
+    }
     Some(Action::TimedStatusLine(
-      "unknown command. available commands are: send, query, header, request, response".into(),
+      "unknown command. available commands are: send, query, header, request, response, jq, search".into(),
       3,
     ))
   }
@@ -238,11 +250,12 @@ impl Page for Phone {
           pane.update(Action::Focus, state)?;
         }
         if let Some(action) = self.handle_commands(args) {
-          for pane in self.panes.iter_mut() {
-            actions.push(pane.update(action.clone(), state)?);
-          }
           if let Action::TimedStatusLine(_, _) = action {
-            actions.push(Some(action))
+            actions.push(Some(action));
+          } else {
+            for pane in self.panes.iter_mut() {
+              actions.push(pane.update(action.clone(), state)?);
+            }
           }
         }
       },