⬆️ client: added published to enable filtering clients by published…

… state.

client.go

@@ -101,6 +101,10 @@ type Client struct {
 	// Contacts contains a list ways to contact the developers responsible for
 	// this OAuth 2.0 client, typically email addresses.
 	Contacts []string `bson:"contacts" json:"contacts" xml:"contacts"`
+
+	// Published provides a switch to hide specific clients if not quite ready
+	// for the prime time, or if wanting to keep them hidden.
+	Published bool `bson:"published" json:"published" xml:"published"`
 }
 
 // GetID returns the client's Client ID.
@@ -325,6 +329,10 @@ func (c Client) Equal(x Client) bool {
 		return false
 	}
 
+	if c.Published != x.Published {
+		return false
+	}
+
 	return true
 }
 

client_manager.go

@@ -68,4 +68,6 @@ type ListClientsRequest struct {
 	Public bool `json:"public" xml:"public"`
 	// Disabled filters clients based on denied access.
 	Disabled bool `json:"disabled" xml:"disabled"`
+	// Published filters clients based on published status.
+	Published bool `json:"published" xml:"published"`
 }

mongo/client_manager.go

@@ -160,6 +160,9 @@ func (c *ClientManager) List(ctx context.Context, filter storage.ListClientsRequ
 	if filter.Disabled {
 		query["disabled"] = filter.Disabled
 	}
+	if filter.Published {
+		query["published"] = filter.Published
+	}
 
 	// Trace how long the Mongo operation takes to complete.
 	span, _ := traceMongoCall(ctx, dbTrace{

mongo/client_manager_test.go

@@ -23,6 +23,23 @@ func TestClientManager_List(t *testing.T) {
 	// generate our expected data.
 	expected := createClient(t, ctx, store)
 
+	publishedClient := storage.Client{
+		ID:                  uuid.New(),
+		CreateTime:          time.Now().Unix(),
+		UpdateTime:          time.Now().Unix() + 600,
+		AllowedAudiences:    []string{},
+		AllowedRegions:      []string{},
+		AllowedTenantAccess: []string{},
+		GrantTypes:          []string{},
+		ResponseTypes:       []string{},
+		Scopes:              []string{},
+		Name:                "published client",
+		RedirectURIs:        []string{},
+		Contacts:            []string{},
+		Published:           true,
+	}
+	publishedClient = createNewClient(t, ctx, store, publishedClient)
+
 	type args struct {
 		filter storage.ListClientsRequest
 	}
@@ -351,6 +368,19 @@ func TestClientManager_List(t *testing.T) {
 			wantErr:     false,
 			err:         nil,
 		},
+		{
+			name: "should filter for published clients",
+			args: args{
+				filter: storage.ListClientsRequest{
+					Published: true,
+				},
+			},
+			wantResults: []storage.Client{
+				publishedClient,
+			},
+			wantErr: false,
+			err:     nil,
+		},
 	}
 
 	for _, tt := range tests {
@@ -413,11 +443,16 @@ func expectedClient() storage.Client {
 		Contacts: []string{
 			"John Doe <j.doe@example.com>",
 		},
+		Published: false,
 	}
 }
 
 func createClient(t *testing.T, ctx context.Context, store *mongo.Store) storage.Client {
 	expected := expectedClient()
+	return createNewClient(t, ctx, store, expected)
+}
+
+func createNewClient(t *testing.T, ctx context.Context, store *mongo.Store, expected storage.Client) storage.Client {
 	got, err := store.ClientManager.Create(ctx, expected)
 	if err != nil {
 		AssertError(t, err, nil, "create should return no database errors")
@@ -429,6 +464,9 @@ func createClient(t *testing.T, ctx context.Context, store *mongo.Store) storage
 		t.FailNow()
 	}
 
+	expected.ID = got.ID
+	expected.CreateTime = got.CreateTime
+	expected.UpdateTime = got.UpdateTime
 	expected.Secret = got.Secret
 	if !reflect.DeepEqual(got, expected) {
 		AssertError(t, got, expected, "client not equal")