client_test.go

  1// SPDX-FileCopyrightText: Amolith <amolith@secluded.site>
  2//
  3// SPDX-License-Identifier: LicenseRef-MutuaL-1.2
  4
  5package cooked
  6
  7import (
  8	"context"
  9	"encoding/json"
 10	"net/http"
 11	"net/http/httptest"
 12	"net/url"
 13	"testing"
 14)
 15
 16func TestReadShoppingListACIDAuthenticationLogin3StoresCookies(t *testing.T) {
 17	var sawSessionCookie bool
 18	client, closeServer := newTestClient(t, shoppingListTestHandler(t, &sawSessionCookie))
 19	defer closeServer()
 20
 21	shoppingList, err := client.ReadShoppingList(context.Background())
 22	if err != nil {
 23		t.Fatalf("ReadShoppingList() error = %v", err)
 24	}
 25
 26	if !sawSessionCookie {
 27		t.Fatal("shopping-list request did not receive session cookie")
 28	}
 29	if len(shoppingList.Aisles) != 1 || shoppingList.Aisles[0].ProductGroups[0].Name != "Pasta" {
 30		t.Fatalf("shopping list = %#v, want one Pasta item", shoppingList)
 31	}
 32}
 33
 34func TestListRecipesACIDRecipesRead1ListsSavedRecipes(t *testing.T) {
 35	client, closeServer := newTestClient(t, listRecipesTestHandler(t))
 36	defer closeServer()
 37
 38	recipes, err := client.ListRecipes(context.Background(), 2, 5)
 39	if err != nil {
 40		t.Fatalf("ListRecipes() error = %v", err)
 41	}
 42
 43	if len(recipes) != 1 {
 44		t.Fatalf("recipes length = %d, want 1", len(recipes))
 45	}
 46	if recipes[0].ID != "recipe-1" || recipes[0].Title != "Pasta" {
 47		t.Fatalf("recipe = %#v, want recipe-1 Pasta", recipes[0])
 48	}
 49}
 50
 51func TestSearchRecipesACIDRecipesRead2SearchesSavedRecipes(t *testing.T) {
 52	client, closeServer := newTestClient(t, searchRecipesTestHandler(t))
 53	defer closeServer()
 54
 55	recipes, err := client.SearchRecipes(context.Background(), "pasta & tomato", 3)
 56	if err != nil {
 57		t.Fatalf("SearchRecipes() error = %v", err)
 58	}
 59
 60	if len(recipes) != 1 {
 61		t.Fatalf("recipes length = %d, want 1", len(recipes))
 62	}
 63	if recipes[0].ID != "recipe-1" || recipes[0].Title != "Pasta" {
 64		t.Fatalf("recipe = %#v, want recipe-1 Pasta", recipes[0])
 65	}
 66}
 67
 68func TestReadRecipeMetadataACIDRecipesRead6ReadsMetadata(t *testing.T) {
 69	client, closeServer := newTestClient(t, recipeMetadataTestHandler(t))
 70	defer closeServer()
 71
 72	metadata, err := client.ReadRecipeMetadata(context.Background(), "recipe/with space")
 73	if err != nil {
 74		t.Fatalf("ReadRecipeMetadata() error = %v", err)
 75	}
 76
 77	if metadata.Title != "Pasta with Tomato Sauce" {
 78		t.Fatalf("metadata title = %q, want Pasta with Tomato Sauce", metadata.Title)
 79	}
 80	if len(metadata.ImageURLs) != 1 || metadata.ImageURLs[0] != "https://example.invalid/pasta.jpg" {
 81		t.Fatalf("metadata image URLs = %#v, want one pasta image", metadata.ImageURLs)
 82	}
 83	if metadata.Owner != "returned-user" || !metadata.EditPermission {
 84		t.Fatalf("metadata owner/edit = %q/%v, want returned-user/true", metadata.Owner, metadata.EditPermission)
 85	}
 86}
 87
 88func TestReadRecipeContentACIDRecipesRead7And8ReadsContentAndPortions(t *testing.T) {
 89	client, closeServer := newTestClient(t, recipeContentTestHandler(t))
 90	defer closeServer()
 91
 92	content, err := client.ReadRecipeContent(context.Background(), "recipe/with space")
 93	if err != nil {
 94		t.Fatalf("ReadRecipeContent() error = %v", err)
 95	}
 96
 97	if content.Content != "# Pasta\n\n- 200g pasta\n\n1. Boil pasta." {
 98		t.Fatalf("content = %q, want recipe markdown", content.Content)
 99	}
100	if content.Portions != 2 {
101		t.Fatalf("portions = %d, want 2", content.Portions)
102	}
103}
104
105func TestPreviewRecipeTextACIDRecipesPreviewText1To4PreviewsWithoutSaving(t *testing.T) {
106	var previewCalls int
107	client, closeServer := newTestClient(t, previewRecipeTextTestHandler(t, &previewCalls))
108	defer closeServer()
109
110	preview, err := client.PreviewRecipeText(context.Background(), "Pasta", "Boil pasta.")
111	if err != nil {
112		t.Fatalf("PreviewRecipeText() error = %v", err)
113	}
114
115	if previewCalls != 1 {
116		t.Fatalf("preview calls = %d, want 1", previewCalls)
117	}
118	if preview.Title != "Pasta with Tomato Sauce" {
119		t.Fatalf("preview title = %q, want Pasta with Tomato Sauce", preview.Title)
120	}
121	if preview.Markdown != "# Pasta\n\n1. Boil pasta." {
122		t.Fatalf("preview markdown = %q, want recipe markdown", preview.Markdown)
123	}
124	if preview.Portions != 2 {
125		t.Fatalf("preview portions = %d, want 2", preview.Portions)
126	}
127}
128
129func TestSavePreparedRecipeACIDRecipesSave2And9And13SavesMarkdownAsDescription(t *testing.T) {
130	var saveCalls int
131	client, closeServer := newTestClient(t, savePreparedRecipeTestHandler(t, &saveCalls))
132	defer closeServer()
133
134	recipeID, err := client.SavePreparedRecipe(context.Background(), "Pasta", "# Pasta\n\n1. Boil pasta.", 2)
135	if err != nil {
136		t.Fatalf("SavePreparedRecipe() error = %v", err)
137	}
138
139	if saveCalls != 1 {
140		t.Fatalf("save calls = %d, want 1", saveCalls)
141	}
142	if recipeID != "recipe-1" {
143		t.Fatalf("recipe ID = %q, want recipe-1", recipeID)
144	}
145}
146
147func TestUpdateRecipeContentACIDRecipesSave8And9And13UpdatesExistingRecipe(t *testing.T) {
148	var updateCalls int
149	client, closeServer := newTestClient(t, updateRecipeContentTestHandler(t, &updateCalls))
150	defer closeServer()
151
152	err := client.UpdateRecipeContent(context.Background(), "recipe/with space", "# Pasta\n\n1. Boil pasta.", 4)
153	if err != nil {
154		t.Fatalf("UpdateRecipeContent() error = %v", err)
155	}
156
157	if updateCalls != 1 {
158		t.Fatalf("update calls = %d, want 1", updateCalls)
159	}
160}
161
162func TestDeleteRecipeDeletesSavedRecipe(t *testing.T) {
163	var deleteCalls int
164	client, closeServer := newTestClient(t, deleteRecipeTestHandler(t, &deleteCalls))
165	defer closeServer()
166
167	err := client.DeleteRecipe(context.Background(), "recipe/with space")
168	if err != nil {
169		t.Fatalf("DeleteRecipe() error = %v", err)
170	}
171
172	if deleteCalls != 1 {
173		t.Fatalf("delete calls = %d, want 1", deleteCalls)
174	}
175}
176
177func TestClearShoppingListACIDShoppingListClear1ClearsAllItems(t *testing.T) {
178	var clearCalls int
179	client, closeServer := newTestClient(t, clearShoppingListTestHandler(t, &clearCalls))
180	defer closeServer()
181
182	err := client.ClearShoppingList(context.Background())
183	if err != nil {
184		t.Fatalf("ClearShoppingList() error = %v", err)
185	}
186
187	if clearCalls != 1 {
188		t.Fatalf("clear calls = %d, want 1", clearCalls)
189	}
190}
191
192func TestAddShoppingListIngredientsACIDShoppingListAdd1To4AddsIngredients(t *testing.T) {
193	var addCalls int
194	client, closeServer := newTestClient(t, addShoppingListIngredientsTestHandler(t, &addCalls))
195	defer closeServer()
196
197	result, err := client.AddShoppingListIngredients(
198		context.Background(),
199		"200g pasta\n1 cup tomato sauce",
200		"recipe-1",
201	)
202	if err != nil {
203		t.Fatalf("AddShoppingListIngredients() error = %v", err)
204	}
205
206	if addCalls != 1 {
207		t.Fatalf("add calls = %d, want 1", addCalls)
208	}
209	if result.AddedCount != 2 {
210		t.Fatalf("added count = %d, want 2", result.AddedCount)
211	}
212	if len(result.Ingredients) != 2 || result.Ingredients[0] != "200g pasta" {
213		t.Fatalf("added ingredients = %#v, want two added ingredients", result.Ingredients)
214	}
215}
216
217func TestUserPathEscapesAuthenticatedUsername(t *testing.T) {
218	client := &Client{authenticatedUsername: "user/name"}
219
220	got := client.userPath("/api/user/{username}/shopping-list")
221	if got != "/api/user/user%2Fname/shopping-list" {
222		t.Fatalf("userPath() = %q, want escaped username", got)
223	}
224}
225
226func TestNewRequestPreservesEscapedUserPathWithQuery(t *testing.T) {
227	baseURL, err := url.Parse("https://example.invalid")
228	if err != nil {
229		t.Fatalf("parse base URL: %v", err)
230	}
231	client := &Client{baseURL: baseURL}
232
233	request, err := client.newRequest(
234		context.Background(),
235		http.MethodGet,
236		"/api/user/user%2Fname/recipes?page=2&page-count=5",
237		nil,
238	)
239	if err != nil {
240		t.Fatalf("newRequest() error = %v", err)
241	}
242
243	if request.URL.String() != "https://example.invalid/api/user/user%2Fname/recipes?page=2&page-count=5" {
244		t.Fatalf("request URL = %q, want escaped username preserved", request.URL.String())
245	}
246}
247
248func newTestClient(t *testing.T, handler http.HandlerFunc) (*Client, func()) {
249	t.Helper()
250
251	server := httptest.NewServer(handler)
252	baseURL, err := url.Parse(server.URL)
253	if err != nil {
254		server.Close()
255		t.Fatalf("parse server URL: %v", err)
256	}
257	client, err := NewClient(baseURL, "configured-user", "configured-password")
258	if err != nil {
259		server.Close()
260		t.Fatalf("NewClient() error = %v", err)
261	}
262
263	return client, server.Close
264}
265
266func shoppingListTestHandler(t *testing.T, sawSessionCookie *bool) http.HandlerFunc {
267	t.Helper()
268
269	return func(w http.ResponseWriter, r *http.Request) {
270		switch r.URL.Path {
271		case "/api/public/login":
272			requireLoginRequest(t, r)
273			writeLoginResponse(t, w)
274		case "/api/user/returned-user/shopping-list":
275			requireSessionCookie(t, r)
276			*sawSessionCookie = true
277			writeShoppingListResponse(t, w)
278		default:
279			t.Fatalf("unexpected path %s", r.URL.Path)
280		}
281	}
282}
283
284func listRecipesTestHandler(t *testing.T) http.HandlerFunc {
285	t.Helper()
286
287	return func(w http.ResponseWriter, r *http.Request) {
288		switch r.URL.Path {
289		case "/api/public/login":
290			writeLoginResponse(t, w)
291		case "/api/user/returned-user/recipes":
292			requireQueryValue(t, r, "page", "2")
293			requireQueryValue(t, r, "page-count", "5")
294			writeRecipeListResponse(t, w)
295		default:
296			t.Fatalf("unexpected path %s", r.URL.Path)
297		}
298	}
299}
300
301func searchRecipesTestHandler(t *testing.T) http.HandlerFunc {
302	t.Helper()
303
304	return func(w http.ResponseWriter, r *http.Request) {
305		switch r.URL.Path {
306		case "/api/public/login":
307			writeLoginResponse(t, w)
308		case "/api/user/returned-user/recipes/search":
309			requireMethod(t, r, http.MethodGet, "search")
310			requireQueryValue(t, r, "q", "pasta & tomato")
311			requireQueryValue(t, r, "page", "3")
312			writeRecipeListResponse(t, w)
313		default:
314			t.Fatalf("unexpected path %s", r.URL.Path)
315		}
316	}
317}
318
319func recipeMetadataTestHandler(t *testing.T) http.HandlerFunc {
320	t.Helper()
321
322	return func(w http.ResponseWriter, r *http.Request) {
323		switch r.URL.EscapedPath() {
324		case "/api/public/login":
325			writeLoginResponse(t, w)
326		case "/api/recipe/recipe%2Fwith%20space/metadata":
327			requireMethod(t, r, http.MethodGet, "metadata")
328			requireSessionCookie(t, r)
329			writeRecipeMetadataResponse(t, w)
330		default:
331			t.Fatalf("unexpected path %s", r.URL.EscapedPath())
332		}
333	}
334}
335
336func recipeContentTestHandler(t *testing.T) http.HandlerFunc {
337	t.Helper()
338
339	return func(w http.ResponseWriter, r *http.Request) {
340		switch r.URL.EscapedPath() {
341		case "/api/public/login":
342			writeLoginResponse(t, w)
343		case "/api/recipe/recipe%2Fwith%20space/content":
344			requireMethod(t, r, http.MethodGet, "content")
345			requireSessionCookie(t, r)
346			writeJSON(t, w, RecipeContent{Content: "# Pasta\n\n- 200g pasta\n\n1. Boil pasta.", Portions: 2})
347		default:
348			t.Fatalf("unexpected path %s", r.URL.EscapedPath())
349		}
350	}
351}
352
353func previewRecipeTextTestHandler(t *testing.T, previewCalls *int) http.HandlerFunc {
354	t.Helper()
355
356	return func(w http.ResponseWriter, r *http.Request) {
357		switch r.URL.Path {
358		case "/api/public/login":
359			writeLoginResponse(t, w)
360		case "/api/new/from-text/preview":
361			requireMethod(t, r, http.MethodPost, "preview")
362			requireSessionCookie(t, r)
363			requirePreviewRecipeTextRequest(t, r)
364			(*previewCalls)++
365			writeJSON(t, w, RecipeTextPreview{
366				Title:    "Pasta with Tomato Sauce",
367				Markdown: "# Pasta\n\n1. Boil pasta.",
368				Portions: 2,
369			})
370		default:
371			t.Fatalf("unexpected path %s", r.URL.Path)
372		}
373	}
374}
375
376func savePreparedRecipeTestHandler(t *testing.T, saveCalls *int) http.HandlerFunc {
377	t.Helper()
378
379	return func(w http.ResponseWriter, r *http.Request) {
380		switch r.URL.Path {
381		case "/api/public/login":
382			writeLoginResponse(t, w)
383		case "/api/recipe/import/save":
384			requireMethod(t, r, http.MethodPost, "save prepared recipe")
385			requireSessionCookie(t, r)
386			requireSavePreparedRecipeRequest(t, r)
387			(*saveCalls)++
388			writeJSON(t, w, saveRecipeResponse{RecipeID: "recipe-1"})
389		default:
390			t.Fatalf("unexpected path %s", r.URL.Path)
391		}
392	}
393}
394
395func updateRecipeContentTestHandler(t *testing.T, updateCalls *int) http.HandlerFunc {
396	t.Helper()
397
398	return func(w http.ResponseWriter, r *http.Request) {
399		switch r.URL.EscapedPath() {
400		case "/api/public/login":
401			writeLoginResponse(t, w)
402		case "/api/recipe/recipe%2Fwith%20space/content":
403			requireMethod(t, r, http.MethodPost, "update recipe content")
404			requireSessionCookie(t, r)
405			requireUpdateRecipeContentRequest(t, r)
406			(*updateCalls)++
407			w.WriteHeader(http.StatusNoContent)
408		default:
409			t.Fatalf("unexpected path %s", r.URL.EscapedPath())
410		}
411	}
412}
413
414func deleteRecipeTestHandler(t *testing.T, deleteCalls *int) http.HandlerFunc {
415	t.Helper()
416
417	return func(w http.ResponseWriter, r *http.Request) {
418		switch r.URL.EscapedPath() {
419		case "/api/public/login":
420			writeLoginResponse(t, w)
421		case "/api/recipe/recipe%2Fwith%20space":
422			requireMethod(t, r, http.MethodDelete, "delete recipe")
423			requireSessionCookie(t, r)
424			(*deleteCalls)++
425			w.WriteHeader(http.StatusNoContent)
426		default:
427			t.Fatalf("unexpected path %s", r.URL.EscapedPath())
428		}
429	}
430}
431
432func clearShoppingListTestHandler(t *testing.T, clearCalls *int) http.HandlerFunc {
433	t.Helper()
434
435	return func(w http.ResponseWriter, r *http.Request) {
436		switch r.URL.EscapedPath() {
437		case "/api/public/login":
438			writeLoginResponse(t, w)
439		case "/api/user/returned-user/shopping-list":
440			requireMethod(t, r, http.MethodDelete, "clear shopping list")
441			requireSessionCookie(t, r)
442			(*clearCalls)++
443			w.WriteHeader(http.StatusNoContent)
444		default:
445			t.Fatalf("unexpected path %s", r.URL.EscapedPath())
446		}
447	}
448}
449
450func addShoppingListIngredientsTestHandler(t *testing.T, addCalls *int) http.HandlerFunc {
451	t.Helper()
452
453	return func(w http.ResponseWriter, r *http.Request) {
454		switch r.URL.EscapedPath() {
455		case "/api/public/login":
456			writeLoginResponse(t, w)
457		case "/api/user/shopping-list":
458			requireMethod(t, r, http.MethodPut, "add shopping-list ingredients")
459			requireSessionCookie(t, r)
460			requireAddShoppingListIngredientsRequest(t, r)
461			(*addCalls)++
462			writeAddShoppingListIngredientsResponse(t, w)
463		default:
464			t.Fatalf("unexpected path %s", r.URL.EscapedPath())
465		}
466	}
467}
468
469func requireAddShoppingListIngredientsRequest(t *testing.T, r *http.Request) {
470	t.Helper()
471
472	var request struct {
473		Ingredients string `json:"ingredients"`
474		RecipeID    string `json:"recipe-id"`
475	}
476	if err := json.NewDecoder(r.Body).Decode(&request); err != nil {
477		t.Fatalf("decode add shopping-list ingredients request: %v", err)
478	}
479	if request.Ingredients != "200g pasta\n1 cup tomato sauce" {
480		t.Fatalf("ingredients = %q, want newline-separated ingredients", request.Ingredients)
481	}
482	if request.RecipeID != "recipe-1" {
483		t.Fatalf("recipe ID = %q, want recipe-1", request.RecipeID)
484	}
485}
486
487func writeAddShoppingListIngredientsResponse(t *testing.T, w http.ResponseWriter) {
488	t.Helper()
489
490	w.Header().Set("Content-Type", "application/json")
491	if _, err := w.Write([]byte(`{
492		"success": true,
493		"added-count": 2,
494		"ingredients": ["200g pasta", "1 cup tomato sauce"]
495	}`)); err != nil {
496		t.Fatalf("write add shopping-list ingredients response: %v", err)
497	}
498}
499
500func requirePreviewRecipeTextRequest(t *testing.T, r *http.Request) {
501	t.Helper()
502
503	var request previewRecipeTextRequest
504	if err := json.NewDecoder(r.Body).Decode(&request); err != nil {
505		t.Fatalf("decode preview request: %v", err)
506	}
507	if request.RecipeName != "Pasta" || request.RecipeText != "Boil pasta." {
508		t.Fatalf("preview request = %#v, want configured title/text", request)
509	}
510}
511
512func requireSavePreparedRecipeRequest(t *testing.T, r *http.Request) {
513	t.Helper()
514
515	var request savePreparedRecipeRequest
516	if err := json.NewDecoder(r.Body).Decode(&request); err != nil {
517		t.Fatalf("decode save prepared recipe request: %v", err)
518	}
519	if request.Title != "Pasta" {
520		t.Fatalf("save title = %q, want Pasta", request.Title)
521	}
522	if request.Description != "# Pasta\n\n1. Boil pasta." {
523		t.Fatalf("save description = %q, want markdown", request.Description)
524	}
525	if request.Portions != 2 {
526		t.Fatalf("save portions = %d, want 2", request.Portions)
527	}
528}
529
530func requireUpdateRecipeContentRequest(t *testing.T, r *http.Request) {
531	t.Helper()
532
533	var request updateRecipeContentRequest
534	if err := json.NewDecoder(r.Body).Decode(&request); err != nil {
535		t.Fatalf("decode update recipe content request: %v", err)
536	}
537	if request.Description != "# Pasta\n\n1. Boil pasta." {
538		t.Fatalf("update description = %q, want markdown", request.Description)
539	}
540	if request.Portions != 4 {
541		t.Fatalf("update portions = %d, want 4", request.Portions)
542	}
543}
544
545func requireLoginRequest(t *testing.T, r *http.Request) {
546	t.Helper()
547	requireMethod(t, r, http.MethodPost, "login")
548
549	var request loginRequest
550	if err := json.NewDecoder(r.Body).Decode(&request); err != nil {
551		t.Fatalf("decode login request: %v", err)
552	}
553	if request.Username != "configured-user" || request.Password != "configured-password" {
554		t.Fatalf("login request = %#v, want configured credentials", request)
555	}
556}
557
558func requireMethod(t *testing.T, r *http.Request, want string, label string) {
559	t.Helper()
560
561	if r.Method != want {
562		t.Fatalf("%s method = %s, want %s", label, r.Method, want)
563	}
564}
565
566func requireSessionCookie(t *testing.T, r *http.Request) {
567	t.Helper()
568
569	cookie, err := r.Cookie("cooked_session")
570	if err != nil {
571		t.Fatalf("missing session cookie: %v", err)
572	}
573	if cookie.Value != "session-value" {
574		t.Fatalf("session cookie = %q, want session-value", cookie.Value)
575	}
576}
577
578func requireQueryValue(t *testing.T, r *http.Request, name string, want string) {
579	t.Helper()
580
581	if got := r.URL.Query().Get(name); got != want {
582		t.Fatalf("%s query = %q, want %q", name, got, want)
583	}
584}
585
586func writeLoginResponse(t *testing.T, w http.ResponseWriter) {
587	t.Helper()
588
589	http.SetCookie(w, &http.Cookie{Name: "cooked_session", Value: "session-value", Path: "/"})
590	writeJSON(t, w, loginResponse{Username: "returned-user"})
591}
592
593func writeShoppingListResponse(t *testing.T, w http.ResponseWriter) {
594	t.Helper()
595
596	writeJSON(t, w, shoppingListResponse{
597		ShoppingList: ShoppingList{
598			Aisles: []Aisle{{
599				ID:   "pantry",
600				Name: "Pantry",
601				ProductGroups: []ProductGroup{{
602					ID:       "pasta",
603					Name:     "Pasta",
604					Quantity: "200g",
605				}},
606			}},
607		},
608		Recipes: []string{"recipe-id"},
609	})
610}
611
612func writeRecipeListResponse(t *testing.T, w http.ResponseWriter) {
613	t.Helper()
614
615	writeJSON(t, w, recipeListResponse{
616		Recipes: []RecipeCard{{
617			ID:           "recipe-1",
618			Title:        "Pasta",
619			ThumbnailURL: "https://example.invalid/thumb.jpg",
620		}},
621	})
622}
623
624func writeRecipeMetadataResponse(t *testing.T, w http.ResponseWriter) {
625	t.Helper()
626
627	w.Header().Set("Content-Type", "application/json")
628	if _, err := w.Write([]byte(`{
629		"title": "Pasta with Tomato Sauce",
630		"image-urls": ["https://example.invalid/pasta.jpg"],
631		"owner": "returned-user",
632		"edit-permission": true
633	}`)); err != nil {
634		t.Fatalf("write metadata response: %v", err)
635	}
636}
637
638func writeJSON[
639	T loginResponse | shoppingListResponse | recipeListResponse | RecipeContent | RecipeTextPreview | saveRecipeResponse,
640](
641	t *testing.T,
642	w http.ResponseWriter,
643	value T,
644) {
645	t.Helper()
646
647	w.Header().Set("Content-Type", "application/json")
648	if err := json.NewEncoder(w).Encode(value); err != nil {
649		t.Fatalf("write JSON: %v", err)
650	}
651}