feat: list response type

Author: Teajey

crates/json_http/src/route/frontmatter_list.rs

@@ -36,14 +36,14 @@ fn get_inner(
         .transpose()
         .map_err(|_| StatusCode::BAD_REQUEST)?;
 
-    let files = custard_lib::list::get(
+    let response = custard_lib::list::get(
         keeper,
         custard_lib::list::Get::new(sort_key, order_desc, offset, limit),
     );
 
-    let headers = assign_headers(files.len());
+    let headers = assign_headers(response.total);
 
-    Ok((headers, files))
+    Ok((headers, response.files))
 }
 
 pub async fn get(
@@ -81,14 +81,14 @@ fn post_inner(
         .map_err(|_| StatusCode::BAD_REQUEST)?
         .unwrap_or_default();
 
-    let files = custard_lib::list::query(
+    let response = custard_lib::list::query(
         keeper,
         custard_lib::list::Query::new(query, sort_key, order_desc, offset, limit, intersect),
     );
 
-    let headers = assign_headers(files.len());
+    let headers = assign_headers(response.total);
 
-    Ok((headers, files))
+    Ok((headers, response.files))
 }
 
 pub async fn post(

crates/lib/src/list.rs

@@ -1,4 +1,4 @@
-use serde::Deserialize;
+use serde::{Deserialize, Serialize};
 
 use crate::frontmatter_file::{self, Keeper, Short};
 use crate::frontmatter_query::FrontmatterQuery;
@@ -59,13 +59,23 @@ impl<'a> Get<'a> {
     }
 }
 
+#[derive(Serialize, Debug)]
+pub struct Response {
+    pub files: Vec<frontmatter_file::Short>,
+    pub total: usize,
+}
+
 #[allow(clippy::needless_pass_by_value)]
-pub fn get(keeper: &Keeper, args: Get<'_>) -> Vec<frontmatter_file::Short> {
+pub fn get(keeper: &Keeper, args: Get<'_>) -> Response {
     let mut files = keeper.files().cloned().map(Short::from).collect::<Vec<_>>();
 
+    let total = files.len();
+
     sort_with_params(args.sort_key, args.order_desc, &mut files);
 
-    paginate(files, args.offset, args.limit)
+    let files = paginate(files, args.offset, args.limit);
+
+    Response { files, total }
 }
 
 #[derive(Deserialize)]
@@ -106,14 +116,18 @@ impl<'a> Query<'a> {
 }
 
 #[must_use]
-pub fn query(keeper: &Keeper, args: Query<'_>) -> Vec<frontmatter_file::Short> {
+pub fn query(keeper: &Keeper, args: Query<'_>) -> Response {
     let files = keeper.files();
 
+    let total = files.len();
+
     let mut filtered_files = query_files(files, args.query, None, args.intersect)
         .map(|file| file.clone().into())
         .collect::<Vec<_>>();
 
     sort_with_params(args.sort_key, args.order_desc, &mut filtered_files);
 
-    paginate(filtered_files, args.offset, args.limit)
+    let files = paginate(filtered_files, args.offset, args.limit);
+
+    Response { files, total }
 }

crates/sock/src/main.rs

@@ -30,7 +30,7 @@ fn internal_server_error_bytes() -> Vec<u8> {
 #[serde(tag = "tag", content = "value")]
 enum Response<'a> {
     Single(Option<single::Response<'a>>),
-    List(Vec<frontmatter_file::Short>),
+    List(list::Response),
     Collate(Vec<String>),
 }
 
@@ -100,9 +100,9 @@ fn in_buf_2_out_buf(markdown_files: &frontmatter_file::keeper::ArcMutex, in_buf:
 
     let out_buf = match resp {
         Response::Single(response) => rmp_serde::to_vec(&Result::Ok(response)),
-        Response::List(vec) => {
-            debug!("Sending list of length: {}", vec.len());
-            rmp_serde::to_vec(&Result::Ok(vec))
+        Response::List(list) => {
+            debug!("Sending list of length: {}", list.files.len());
+            rmp_serde::to_vec(&Result::Ok(list))
         }
         Response::Collate(vec) => rmp_serde::to_vec(&Result::Ok(vec)),
     };

go/client/sock/client.go

@@ -71,14 +71,19 @@ type SingleResponse struct {
 	NextFileName string       `msgpack:"next_file_name"`
 }
 
-type ListResponse struct {
+type ShortResponse struct {
 	Name        string         `msgpack:"name"`
 	Frontmatter map[string]any `msgpack:"frontmatter,omitempty"`
 	OneLiner    string         `msgpack:"one_liner,omitempty"`
 	Modified    string         `msgpack:"modified"`
 	Created     string         `msgpack:"created"`
 }
 
+type ListResponse struct {
+	Files []ShortResponse `msgpack:"files"`
+	Total uint            `msgpack:"total"`
+}
+
 type Client struct {
 	socketPath string
 }
@@ -90,7 +95,7 @@ func NewClient(socketPath string) *Client {
 	return &c
 }
 
-func (c *Client) runListRequest(listReq any, tag string) ([]ListResponse, error) {
+func (c *Client) runListRequest(listReq any, tag string) (*ListResponse, error) {
 	conn, err := net.Dial("unix", c.socketPath)
 	if err != nil {
 		return nil, fmt.Errorf("Failed to dial: %w", err)
@@ -115,12 +120,12 @@ func (c *Client) runListRequest(listReq any, tag string) ([]ListResponse, error)
 
 	switch resp.Tag {
 	case "Ok":
-		var listResp []ListResponse
+		var listResp ListResponse
 		err := msgpack.Unmarshal(resp.Value, &listResp)
 		if err != nil {
 			return nil, fmt.Errorf("Could not unmarshal response value: %w", err)
 		}
-		return listResp, nil
+		return &listResp, nil
 	case "InternalServerError":
 		return nil, fmt.Errorf("Custard had internal server error")
 	default:
@@ -215,11 +220,11 @@ func (c *Client) QuerySingle(req QuerySingleRequest) (*SingleResponse, error) {
 	return c.runSingleRequest(req, "SingleQuery")
 }
 
-func (c *Client) GetList(req GetListRequest) ([]ListResponse, error) {
+func (c *Client) GetList(req GetListRequest) (*ListResponse, error) {
 	return c.runListRequest(req, "ListGet")
 }
 
-func (c *Client) QueryList(req QueryListRequest) ([]ListResponse, error) {
+func (c *Client) QueryList(req QueryListRequest) (*ListResponse, error) {
 	return c.runListRequest(req, "ListQuery")
 }
 

go/client/sock/test/client_test.go

@@ -85,7 +85,7 @@ func TestGetList(t *testing.T) {
 	if err != nil {
 		t.Fatalf("Request failed: %s", err)
 	}
-	respLen := len(resp)
+	respLen := len(resp.Files)
 	if respLen != 3 {
 		t.Fatalf("Unexpected response length: %d", respLen)
 	}
@@ -99,7 +99,7 @@ func TestQueryList(t *testing.T) {
 	if err != nil {
 		t.Fatalf("Request failed: %s", err)
 	}
-	respLen := len(resp)
+	respLen := len(resp.Files)
 	if respLen != 5 {
 		t.Fatalf("Unexpected response length: %d", respLen)
 	}