feat: client query negation

client/handler.go

@@ -511,8 +511,8 @@ func (h *Handler) listOAuth2Clients(w http.ResponseWriter, r *http.Request, ps h
 	filters := Filter{
 		Limit:  itemsPerPage,
 		Offset: page * itemsPerPage,
-		Name:   r.URL.Query().Get("client_name"),
-		Owner:  r.URL.Query().Get("owner"),
+		Name:   field(r.URL.Query().Get("client_name")),
+		Owner:  field(r.URL.Query().Get("owner")),
 	}
 
 	c, err := h.r.ClientManager().GetClients(r.Context(), filters)

client/manager.go

@@ -5,6 +5,7 @@ package client
 
 import (
 	"context"
+	"strings"
 
 	"github.com/ory/fosite"
 )
@@ -21,11 +22,24 @@ type Filter struct {
 
 	// The name of the clients to filter by.
 	// in: query
-	Name string `json:"client_name"`
+	Name field `json:"client_name"`
 
 	// The owner of the clients to filter by.
 	// in: query
-	Owner string `json:"owner"`
+	Owner field `json:"owner"`
+}
+
+type field string
+
+func (f field) Value() string {
+	if f.IsNegated() {
+		return string(f[2:])
+	}
+	return string(f)
+}
+
+func (f field) IsNegated() bool {
+	return strings.HasPrefix(string(f), "!=")
 }
 
 type Manager interface {

client/manager_test_helpers.go

@@ -298,6 +298,12 @@ func TestHelperCreateGetUpdateDeleteClient(k string, connection *pop.Connection,
 		assert.Len(t, ds, 1)
 		assert.Equal(t, ds[0].Name, "name")
 
+		// get by name negated prefix
+		ds, err = t1.GetClients(ctx, Filter{Limit: 100, Offset: 0, Name: "!=name"})
+		assert.NoError(t, err)
+		assert.Len(t, ds, 1)
+		assert.Equal(t, ds[0].GetID(), "2-1234")
+
 		// get by name not exist
 		ds, err = t1.GetClients(ctx, Filter{Limit: 100, Offset: 0, Name: "bad name"})
 		assert.NoError(t, err)
@@ -309,6 +315,12 @@ func TestHelperCreateGetUpdateDeleteClient(k string, connection *pop.Connection,
 		assert.Len(t, ds, 1)
 		assert.Equal(t, ds[0].Owner, "aeneas")
 
+		// get by owner negated prefix
+		ds, err = t1.GetClients(ctx, Filter{Limit: 100, Offset: 0, Owner: "!=aeneas"})
+		assert.NoError(t, err)
+		assert.Len(t, ds, 1)
+		assert.Equal(t, ds[0].GetID(), "2-1234")
+
 		testHelperUpdateClient(t, ctx, t1, k)
 		testHelperUpdateClient(t, ctx, t2, k)
 

internal/httpclient/api/openapi.yaml

@@ -109,15 +109,15 @@ paths:
           minimum: 1
           type: string
         style: form
-      - description: The name of the clients to filter by.
+      - description: The name of the clients to filter by. Prefix with "!=" to filter with negative matching.
         explode: true
         in: query
         name: client_name
         required: false
         schema:
           type: string
         style: form
-      - description: The owner of the clients to filter by.
+      - description: The owner of the clients to filter by. Prefix with "!=" to filter with negative matching.
         explode: true
         in: query
         name: owner

internal/httpclient/docs/OAuth2API.md

@@ -960,8 +960,8 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **pageSize** | **int64** | Items per Page  This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). | [default to 250]
  **pageToken** | **string** | Next Page Token  The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). | [default to "1"]
- **clientName** | **string** | The name of the clients to filter by. | 
- **owner** | **string** | The owner of the clients to filter by. | 
+ **clientName** | **string** | The name of the clients to filter by. Prefix with "!=" to filter with negative matching. | 
+ **owner** | **string** | The owner of the clients to filter by. Prefix with "!=" to filter with negative matching. | 
 
 ### Return type
 

persistence/sql/persister_client.go

@@ -147,10 +147,18 @@ func (p *Persister) GetClients(ctx context.Context, filters client.Filter) (_ []
 		Order("id")
 
 	if filters.Name != "" {
-		query.Where("client_name = ?", filters.Name)
+		stmt := "client_name = ?"
+		if filters.Name.IsNegated() {
+			stmt = "client_name != ?"
+		}
+		query.Where(stmt, filters.Name.Value())
 	}
 	if filters.Owner != "" {
-		query.Where("owner = ?", filters.Owner)
+		stmt := "owner = ?"
+		if filters.Owner.IsNegated() {
+			stmt = "owner != ?"
+		}
+		query.Where(stmt, filters.Owner.Value())
 	}
 
 	if err := query.All(&cs); err != nil {