// Vikunja is a to-do list application to facilitate your life.
// Copyright 2018-present Vikunja and contributors. All rights reserved.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

package middleware_test

import (
	"net/http/httptest"
	"testing"

	"code.vikunja.io/api/pkg/routes/middleware"

	"github.com/labstack/echo/v5"
	"github.com/stretchr/testify/assert"
)

func TestNormalizeArrayParams(t *testing.T) {
	cases := []struct {
		name     string
		rawQuery string
	}{
		{"literal brackets", "foo[]=a&foo[]=b&bar=x"},
		{"percent-encoded uppercase", "foo%5B%5D=a&foo%5B%5D=b&bar=x"},
		{"percent-encoded lowercase", "foo%5b%5d=a&foo%5b%5d=b&bar=x"},
		{"mixed plain and bracketed", "foo=a&foo%5B%5D=b&bar=x"},
	}

	for _, tc := range cases {
		t.Run(tc.name, func(t *testing.T) {
			e := echo.New()
			e.Use(middleware.NormalizeArrayParams())
			e.GET("/", func(c *echo.Context) error {
				got := (*c).Request().URL.RawQuery
				return (*c).String(200, got)
			})

			req := httptest.NewRequest("GET", "/?"+tc.rawQuery, nil)
			rec := httptest.NewRecorder()
			e.ServeHTTP(rec, req)

			assert.Equal(t, 200, rec.Code)
			body := rec.Body.String()
			assert.Contains(t, body, "foo=a")
			assert.Contains(t, body, "foo=b")
			assert.Contains(t, body, "bar=x")
			assert.NotContains(t, body, "foo[]")
			assert.NotContains(t, body, "%5B%5D")
			assert.NotContains(t, body, "%5b%5d")
		})
	}
}

// TestNormalizeArrayParamsPreservesOrder locks in the left-to-right
// ordering the normalizer promises. Sort precedence (sort_by/order_by) is
// load-bearing, so a client mixing plain and bracketed forms of the same
// key must see its values in the exact order it sent them — not whatever a
// map would yield. Asserts the full rewritten query, not just membership.
func TestNormalizeArrayParamsPreservesOrder(t *testing.T) {
	cases := []struct {
		name      string
		rawQuery  string
		wantQuery string
	}{
		{"plain then bracketed", "foo=a&foo[]=b&foo=c", "foo=a&foo=b&foo=c"},
		{
			"interleaved percent-encoded",
			"sort_by=a&sort_by%5B%5D=b&sort_by=c&sort_by%5B%5D=d",
			"sort_by=a&sort_by=b&sort_by=c&sort_by=d",
		},
	}

	for _, tc := range cases {
		t.Run(tc.name, func(t *testing.T) {
			e := echo.New()
			e.Use(middleware.NormalizeArrayParams())
			e.GET("/", func(c *echo.Context) error {
				return (*c).String(200, (*c).Request().URL.RawQuery)
			})

			req := httptest.NewRequest("GET", "/?"+tc.rawQuery, nil)
			rec := httptest.NewRecorder()
			e.ServeHTTP(rec, req)

			assert.Equal(t, 200, rec.Code)
			assert.Equal(t, tc.wantQuery, rec.Body.String())
		})
	}
}