Added SAMLProviderConfigs() API for iterating for configurations (#281)

Author: hiranya911

auth/provider_config.go

@@ -20,14 +20,18 @@ import (
 	"fmt"
 	"net/http"
 	"net/url"
+	"strconv"
 	"strings"
 
 	"firebase.google.com/go/internal"
+	"google.golang.org/api/iterator"
 )
 
 const (
 	providerConfigEndpoint = "https://identitytoolkit.googleapis.com/v2beta1"
 
+	maxConfigs = 100
+
 	idpEntityIDKey = "idpConfig.idpEntityId"
 	ssoURLKey      = "idpConfig.ssoUrl"
 	signRequestKey = "idpConfig.signRequest"
@@ -337,6 +341,65 @@ func (config *SAMLProviderConfigToUpdate) buildRequest() (nestedMap, error) {
 	return config.params, nil
 }
 
+// SAMLProviderConfigIterator is an iterator over SAML provider configurations.
+type SAMLProviderConfigIterator struct {
+	client   *providerConfigClient
+	ctx      context.Context
+	nextFunc func() error
+	pageInfo *iterator.PageInfo
+	configs  []*SAMLProviderConfig
+}
+
+// PageInfo supports pagination.
+func (it *SAMLProviderConfigIterator) PageInfo() *iterator.PageInfo {
+	return it.pageInfo
+}
+
+// Next returns the next SAMLProviderConfig. The error value of [iterator.Done] is
+// returned if there are no more results. Once Next returns [iterator.Done], all
+// subsequent calls will return [iterator.Done].
+func (it *SAMLProviderConfigIterator) Next() (*SAMLProviderConfig, error) {
+	if err := it.nextFunc(); err != nil {
+		return nil, err
+	}
+
+	config := it.configs[0]
+	it.configs = it.configs[1:]
+	return config, nil
+}
+
+func (it *SAMLProviderConfigIterator) fetch(pageSize int, pageToken string) (string, error) {
+	params := map[string]string{
+		"pageSize": strconv.Itoa(pageSize),
+	}
+	if pageToken != "" {
+		params["pageToken"] = pageToken
+	}
+
+	req := &internal.Request{
+		Method: http.MethodGet,
+		URL:    "/inboundSamlConfigs",
+		Opts: []internal.HTTPOption{
+			internal.WithQueryParams(params),
+		},
+	}
+
+	var result struct {
+		Configs       []samlProviderConfigDAO `json:"inboundSamlConfigs"`
+		NextPageToken string                  `json:"nextPageToken"`
+	}
+	if _, err := it.client.makeRequest(it.ctx, req, &result); err != nil {
+		return "", err
+	}
+
+	for _, config := range result.Configs {
+		it.configs = append(it.configs, config.toSAMLProviderConfig())
+	}
+
+	it.pageInfo.Token = result.NextPageToken
+	return result.NextPageToken, nil
+}
+
 type providerConfigClient struct {
 	endpoint   string
 	projectID  string
@@ -453,6 +516,24 @@ func (c *providerConfigClient) DeleteSAMLProviderConfig(ctx context.Context, id
 	return err
 }
 
+// SAMLProviderConfigs returns an iterator over SAML provider configurations.
+//
+// If nextPageToken is empty, the iterator will start at the beginning. Otherwise,
+// iterator starts after the token.
+func (c *providerConfigClient) SAMLProviderConfigs(ctx context.Context, nextPageToken string) *SAMLProviderConfigIterator {
+	it := &SAMLProviderConfigIterator{
+		ctx:    ctx,
+		client: c,
+	}
+	it.pageInfo, it.nextFunc = iterator.NewPageInfo(
+		it.fetch,
+		func() int { return len(it.configs) },
+		func() interface{} { b := it.configs; it.configs = nil; return b })
+	it.pageInfo.MaxSize = maxConfigs
+	it.pageInfo.Token = nextPageToken
+	return it
+}
+
 func (c *providerConfigClient) makeRequest(ctx context.Context, req *internal.Request, v interface{}) (*internal.Response, error) {
 	if c.projectID == "" {
 		return nil, errors.New("project id not available")

auth/provider_config_test.go

@@ -23,6 +23,8 @@ import (
 	"sort"
 	"strings"
 	"testing"
+
+	"google.golang.org/api/iterator"
 )
 
 const samlConfigResponse = `{
@@ -624,6 +626,78 @@ func TestDeleteSAMLProviderConfigError(t *testing.T) {
 	}
 }
 
+func TestSAMLProviderConfigs(t *testing.T) {
+	template := `{
+                "inboundSamlConfigs": [
+                    %s,
+                    %s,
+                    %s
+                ],
+                "nextPageToken": ""
+        }`
+	response := fmt.Sprintf(template, samlConfigResponse, samlConfigResponse, samlConfigResponse)
+	s := echoServer([]byte(response), t)
+	defer s.Close()
+
+	want := []*SAMLProviderConfig{
+		samlProviderConfig,
+		samlProviderConfig,
+		samlProviderConfig,
+	}
+
+	testIterator := func(iter *SAMLProviderConfigIterator, token string, req string) {
+		count := 0
+		for i := 0; i < len(want); i++ {
+			config, err := iter.Next()
+			if err == iterator.Done {
+				break
+			}
+			if err != nil {
+				t.Fatal(err)
+			}
+			if !reflect.DeepEqual(config, want[i]) {
+				t.Errorf("SAMLProviderConfigs(%q) = %#v; want = %#v", token, config, want[i])
+			}
+			count++
+		}
+		if count != len(want) {
+			t.Errorf("SAMLProviderConfigs(%q) = %d; want = %d", token, count, len(want))
+		}
+		if _, err := iter.Next(); err != iterator.Done {
+			t.Errorf("SAMLProviderConfigs(%q) = %v, want = %v", token, err, iterator.Done)
+		}
+
+		// Check the query string of the last HTTP request made.
+		gotReq := s.Req[len(s.Req)-1].URL.Query().Encode()
+		if gotReq != req {
+			t.Errorf("SAMLProviderConfigs(%q) = %q, want = %v", token, gotReq, req)
+		}
+	}
+
+	client := s.Client.pcc
+	testIterator(
+		client.SAMLProviderConfigs(context.Background(), ""),
+		"",
+		"pageSize=100")
+	testIterator(
+		client.SAMLProviderConfigs(context.Background(), "pageToken"),
+		"pageToken",
+		"pageSize=100&pageToken=pageToken")
+}
+
+func TestSAMLProviderConfigsError(t *testing.T) {
+	s := echoServer([]byte("{}"), t)
+	defer s.Close()
+	s.Status = http.StatusInternalServerError
+
+	client := s.Client.pcc
+	it := client.SAMLProviderConfigs(context.Background(), "")
+	config, err := it.Next()
+	if config != nil || err == nil || !IsUnknown(err) {
+		t.Errorf("SAMLProviderConfigs() = (%v, %v); want = (nil, %q)", config, err, "unknown-error")
+	}
+}
+
 func TestSAMLProviderConfigNoProjectID(t *testing.T) {
 	client := &providerConfigClient{}
 	want := "project id not available"