feat(connector): add scope parsing utilities
ParseScopeString, FormatScopeString, UnionScopes and ScopesCover encapsulate OAuth2 scope-set arithmetic. ParseScopeString accepts both the RFC 6749 space-separated form and GitHub's comma-separated non-compliant form in one pass, so callers can stay format-agnostic. These primitives are the foundation for scope-preserving reconnect: later commits compute the union of stored and requested scopes so a reconnect never drops a previously granted scope. Signed-off-by: Aurélien Sibiril <81782+aureliensibiril@users.noreply.github.com>
This commit is contained in:
Aurélien Sibiril
96
pkg/connector/scopes.go
Normal file
96
pkg/connector/scopes.go
Normal file
@@ -0,0 +1,96 @@
|
||||
// Copyright (c) 2026 Probo Inc <hello@getprobo.com>.
|
||||
//
|
||||
// Permission to use, copy, modify, and/or distribute this software for any
|
||||
// purpose with or without fee is hereby granted, provided that the above
|
||||
// copyright notice and this permission notice appear in all copies.
|
||||
//
|
||||
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
||||
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
|
||||
// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
||||
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
||||
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
||||
// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
||||
// PERFORMANCE OF THIS SOFTWARE.
|
||||
|
||||
package connector
|
||||
|
||||
import (
|
||||
"sort"
|
||||
"strings"
|
||||
"unicode"
|
||||
)
|
||||
|
||||
// ParseScopeString splits an OAuth2 scope string into a sorted,
|
||||
// deduplicated slice. Accepts both RFC 6749 §3.3 space-separated form
|
||||
// (the standard) and GitHub's non-compliant comma-separated form. An
|
||||
// empty or whitespace-only input returns an empty slice.
|
||||
func ParseScopeString(s string) []string {
|
||||
fields := strings.FieldsFunc(s, func(r rune) bool {
|
||||
return unicode.IsSpace(r) || r == ','
|
||||
})
|
||||
if len(fields) == 0 {
|
||||
return []string{}
|
||||
}
|
||||
seen := make(map[string]struct{}, len(fields))
|
||||
out := make([]string, 0, len(fields))
|
||||
for _, f := range fields {
|
||||
if _, ok := seen[f]; ok {
|
||||
continue
|
||||
}
|
||||
seen[f] = struct{}{}
|
||||
out = append(out, f)
|
||||
}
|
||||
sort.Strings(out)
|
||||
return out
|
||||
}
|
||||
|
||||
// FormatScopeString joins scopes into the RFC 6749 §3.3 space-separated
|
||||
// form. The output order is deterministic (sorted).
|
||||
func FormatScopeString(scopes []string) string {
|
||||
if len(scopes) == 0 {
|
||||
return ""
|
||||
}
|
||||
sorted := make([]string, len(scopes))
|
||||
copy(sorted, scopes)
|
||||
sort.Strings(sorted)
|
||||
return strings.Join(sorted, " ")
|
||||
}
|
||||
|
||||
// UnionScopes returns the sorted, deduplicated union of the given scope
|
||||
// slices. Empty strings and empty slices are handled gracefully. The
|
||||
// result is a fresh slice and never aliases any input.
|
||||
func UnionScopes(scopeSets ...[]string) []string {
|
||||
seen := map[string]struct{}{}
|
||||
for _, set := range scopeSets {
|
||||
for _, s := range set {
|
||||
if s == "" {
|
||||
continue
|
||||
}
|
||||
seen[s] = struct{}{}
|
||||
}
|
||||
}
|
||||
out := make([]string, 0, len(seen))
|
||||
for s := range seen {
|
||||
out = append(out, s)
|
||||
}
|
||||
sort.Strings(out)
|
||||
return out
|
||||
}
|
||||
|
||||
// ScopesCover reports whether `granted` already contains every scope in
|
||||
// `required`. An empty `required` set is trivially covered.
|
||||
func ScopesCover(granted, required []string) bool {
|
||||
if len(required) == 0 {
|
||||
return true
|
||||
}
|
||||
grantedSet := make(map[string]struct{}, len(granted))
|
||||
for _, s := range granted {
|
||||
grantedSet[s] = struct{}{}
|
||||
}
|
||||
for _, r := range required {
|
||||
if _, ok := grantedSet[r]; !ok {
|
||||
return false
|
||||
}
|
||||
}
|
||||
return true
|
||||
}
|
||||
117
pkg/connector/scopes_test.go
Normal file
117
pkg/connector/scopes_test.go
Normal file
@@ -0,0 +1,117 @@
|
||||
// Copyright (c) 2026 Probo Inc <hello@getprobo.com>.
|
||||
//
|
||||
// Permission to use, copy, modify, and/or distribute this software for any
|
||||
// purpose with or without fee is hereby granted, provided that the above
|
||||
// copyright notice and this permission notice appear in all copies.
|
||||
//
|
||||
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
||||
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
|
||||
// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
||||
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
||||
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
||||
// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
||||
// PERFORMANCE OF THIS SOFTWARE.
|
||||
|
||||
package connector
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
)
|
||||
|
||||
func TestParseScopeString(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
cases := []struct {
|
||||
name string
|
||||
in string
|
||||
want []string
|
||||
}{
|
||||
{"empty", "", []string{}},
|
||||
{"whitespace only", " ", []string{}},
|
||||
{"single", "read:user", []string{"read:user"}},
|
||||
{"multi space", "read:user write:user", []string{"read:user", "write:user"}},
|
||||
{"multi comma github style", "repo,gist", []string{"gist", "repo"}},
|
||||
{"mixed separators", "read:user,write:user", []string{"read:user", "write:user"}},
|
||||
{"extra whitespace", " read:user write:user ", []string{"read:user", "write:user"}},
|
||||
{"duplicates", "a a b", []string{"a", "b"}},
|
||||
{"sorted output", "z y a", []string{"a", "y", "z"}},
|
||||
{"github comma with space", "repo, gist", []string{"gist", "repo"}},
|
||||
}
|
||||
for _, c := range cases {
|
||||
t.Run(c.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
assert.Equal(t, c.want, ParseScopeString(c.in))
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestUnionScopes(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
cases := []struct {
|
||||
name string
|
||||
in [][]string
|
||||
want []string
|
||||
}{
|
||||
{"both empty", [][]string{{}, {}}, []string{}},
|
||||
{"first empty", [][]string{{}, {"a", "b"}}, []string{"a", "b"}},
|
||||
{"second empty", [][]string{{"a", "b"}, {}}, []string{"a", "b"}},
|
||||
{"disjoint", [][]string{{"a"}, {"b"}}, []string{"a", "b"}},
|
||||
{"overlap", [][]string{{"a", "b"}, {"b", "c"}}, []string{"a", "b", "c"}},
|
||||
{"three sets", [][]string{{"a"}, {"b"}, {"c"}}, []string{"a", "b", "c"}},
|
||||
{"deduplicates", [][]string{{"a", "a"}, {"a"}}, []string{"a"}},
|
||||
{"drops empty strings", [][]string{{"a", ""}, {""}}, []string{"a"}},
|
||||
}
|
||||
for _, c := range cases {
|
||||
t.Run(c.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
assert.Equal(t, c.want, UnionScopes(c.in...))
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestScopesCover(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
cases := []struct {
|
||||
name string
|
||||
granted []string
|
||||
required []string
|
||||
want bool
|
||||
}{
|
||||
{"empty required is covered", []string{"a"}, []string{}, true},
|
||||
{"empty granted does not cover non-empty required", []string{}, []string{"a"}, false},
|
||||
{"exact match", []string{"a", "b"}, []string{"a", "b"}, true},
|
||||
{"granted superset", []string{"a", "b", "c"}, []string{"a", "b"}, true},
|
||||
{"missing one", []string{"a"}, []string{"a", "b"}, false},
|
||||
{"reordered match", []string{"b", "a"}, []string{"a", "b"}, true},
|
||||
}
|
||||
for _, c := range cases {
|
||||
t.Run(c.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
assert.Equal(t, c.want, ScopesCover(c.granted, c.required))
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestFormatScopeString(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
cases := []struct {
|
||||
name string
|
||||
in []string
|
||||
want string
|
||||
}{
|
||||
{"empty", []string{}, ""},
|
||||
{"single", []string{"a"}, "a"},
|
||||
{"multi sorted", []string{"b", "a"}, "a b"},
|
||||
}
|
||||
for _, c := range cases {
|
||||
t.Run(c.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
assert.Equal(t, c.want, FormatScopeString(c.in))
|
||||
})
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user