Sync monorepo state at 11b980faba6eb53dad59c54e0d9ac11204ce5b01

Author: uc-build-user

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.5.0 - 30-07-2024
+
+- Update userstore sample to exercise multi-key execute accessor pagination
+
 ## 1.4.0 - 18-07-2024
 
 - Deprecate v1.0.0 and v1.1.0

idp/policy/models.go

@@ -230,6 +230,10 @@ func (a AccessPolicy) extraValidate() error {
 		return ucerr.Friendlyf(nil, `Access policy name "%s" has invalid characters`, a.Name)
 	}
 
+	if len(a.Components) == 0 {
+		return ucerr.New("AccessPolicy must have at least one component")
+	}
+
 	return nil
 }
 

idp/userstore/types.go

@@ -135,16 +135,18 @@ const (
 // in the user data store of a tenant.
 type Column struct {
 	// Columns may be renamed, but their ID cannot be changed.
-	ID           uuid.UUID         `json:"id"`
-	Table        string            `json:"table"` // TODO (sgarrity 6/24): validate & mark as required once people update
-	Name         string            `json:"name" validate:"length:1,128" required:"true"`
-	DataType     ResourceID        `json:"data_type" required:"true"`
-	Type         DataType          `json:"type" validate:"skip"`
-	IsArray      bool              `json:"is_array" required:"true"`
-	DefaultValue string            `json:"default_value"`
-	IndexType    ColumnIndexType   `json:"index_type" required:"true"`
-	IsSystem     bool              `json:"is_system" description:"Whether this column is a system column. System columns cannot be deleted or modified. This property cannot be changed."`
-	Constraints  ColumnConstraints `json:"constraints" description:"Optional constraints for configuring the behavior of the associated column Type."`
+	ID                       uuid.UUID         `json:"id"`
+	Table                    string            `json:"table"` // TODO (sgarrity 6/24): validate & mark as required once people update
+	Name                     string            `json:"name" validate:"length:1,128" required:"true"`
+	DataType                 ResourceID        `json:"data_type" required:"true"`
+	Type                     DataType          `json:"type" validate:"skip"`
+	IsArray                  bool              `json:"is_array" required:"true"`
+	DefaultValue             string            `json:"default_value"`
+	DefaultTransformer       ResourceID        `json:"default_transformer" validate:"skip"`
+	DefaultTokenAccessPolicy ResourceID        `json:"default_token_access_policy" validate:"skip"`
+	IndexType                ColumnIndexType   `json:"index_type" required:"true"`
+	IsSystem                 bool              `json:"is_system" description:"Whether this column is a system column. System columns cannot be deleted or modified. This property cannot be changed."`
+	Constraints              ColumnConstraints `json:"constraints" description:"Optional constraints for configuring the behavior of the associated column Type."`
 }
 
 //go:generate genvalidate Column
@@ -238,7 +240,7 @@ func (r ResourceID) Validate() error {
 // ColumnOutputConfig is a struct that contains a column and the transformer to apply to that column
 type ColumnOutputConfig struct {
 	Column      ResourceID `json:"column"`
-	Transformer ResourceID `json:"transformer"`
+	Transformer ResourceID `json:"transformer" validate:"skip"`
 }
 
 // GetRetentionTimeoutImmediateDeletion returns the immediate deletion retention timeout
@@ -348,10 +350,6 @@ func (o *Accessor) extraValidate() error {
 		if err := ct.Column.Validate(); err != nil {
 			return ucerr.Friendlyf(err, "Each element of Accessor.Columns (%v) must have a column ID or name", o.ID)
 		}
-
-		if err := ct.Transformer.Validate(); err != nil {
-			return ucerr.Friendlyf(err, "Each element of Accessor.Columns (%v) must have a transformer ID or name", o.ID)
-		}
 	}
 
 	if err := o.AccessPolicy.Validate(); err != nil {

infra/namespace/region/regions.go

@@ -9,7 +9,8 @@ import (
 	"userclouds.com/infra/ucerr"
 )
 
-const regionEnvVar = "UC_REGION"
+// RegionEnvVar is the environment variable that contains the region
+const RegionEnvVar = "UC_REGION"
 
 // MachineRegion represents a region for our systems or located
 type MachineRegion string
@@ -33,7 +34,7 @@ func MachineRegionsForUniverse(u universe.Universe) []MachineRegion {
 // Current returns the current region, or empty string
 // TODO: error check against known list?
 func Current() MachineRegion {
-	r := os.Getenv(regionEnvVar)
+	r := os.Getenv(RegionEnvVar)
 	return MachineRegion(r)
 }
 

infra/namespace/universe/universe.go

@@ -17,7 +17,6 @@ const (
 )
 
 // Supported universes.
-// NOTE: keep in sync with `enum Universe` in TSX codebase
 const (
 	Undefined Universe = "undefined" // undefined universe
 	Dev       Universe = "dev"       // local dev laptops

infra/pagination/options.go

@@ -50,14 +50,19 @@ func EndingBefore(cursor Cursor) Option {
 // For LEAF queries, KEY must be a valid result type key for type of the result being returned. Valid keys are stored
 // in a KeyTypes map in a configured paginator, mapping a key name to a KeyType. Supported KeyTypes include:
 //
-//	ArrayKeyType     (must be a string value to be searched for in an array of strings)
-//	BoolKeyType      (value may be specified as any string that can be parsed by https://pkg.go.dev/strconv#example-ParseBool)
-//	IntKeyType       (must be a valid string representation of an int64)
-//	StringKeyType    (string value can only have single-quotes or double-quotes in the string that are escaped with a
-//	                  back-slash (i.e., \' or \"))
-//	TimestampKeyType (the number of microseconds since January 1, 1970 UTC)
-//	UUIDArrayKeyType (must be a valid string representation of a UUID)
-//	UUIDKeyType      (must be a valid string representation of a UUID)
+//	ArrayKeyType             (must be a string value to be searched for in an array of strings)
+//	BoolKeyType              (value may be specified as any string that can be parsed by https://pkg.go.dev/strconv#example-ParseBool)
+//	IntKeyType               (must be a valid string representation of an int64)
+//	NullableBoolKeyType      (value must either be unspecified (i.e., NULL) or a valid BoolKeyType
+//	NullableIntKeyType       (value must either be unspecified (i.e., NULL) or a valid IntKeyType
+//	NullableStringKeyType    (value must either be unspecified (i.e., NULL) or a valid StringKeyType
+//	NullableTimestampKeyType (value must either be unspecified (i.e., NULL) or a valid TimestampKeyType
+//	NullableUUIDKeyType      (value must either be unspecified (i.e., NULL) or a valid UUIDKeyType
+//	StringKeyType            (string value can only have single-quotes or double-quotes in the string that are escaped with a
+//	                          back-slash (i.e., \' or \"))
+//	TimestampKeyType         (the number of microseconds since January 1, 1970 UTC)
+//	UUIDArrayKeyType         (must be a valid string representation of a UUID)
+//	UUIDKeyType              (must be a valid string representation of a UUID)
 //
 // By default, all result types support "id" as a valid key of KeyType UUIDKeyType. New supported keys can be added
 // to a result type by defining the GetPaginationKeys() method of the PageableType interface for the result type,

infra/pagination/pager.go

@@ -19,15 +19,18 @@ type Paginator struct {
 	hasResultType          bool                       // set if type of result has been specified
 	limit                  int                        // set via Limit option or defaulted to DefaultLimit
 	sortKey                Key                        // set via SortKey option, defaults to "id"
-	sortOrder              Order                      // set via SortOrder option, defaults to SortAscending
+	sortOrder              Order                      // set via SortOrder option, defaults to OrderAscending
 	filter                 string                     // set via Filter option
 	filterQuery            *FilterQuery               // parsed filter
 	supportedKeys          KeyTypes                   // set based on type of result
 	anyDuplicateSortKeys   bool                       // set as part of initialization and validation of sort keys
 	anyUnsupportedSortKeys bool                       // set as part of initialization and validation of sort keys
+	finalSortKeyValid      bool                       // set as part of initialization and validation of sort keys
 	options                []Option                   // collection of options used to produce the Paginator
 	version                Version                    // the pagination request version
 	isKeySupported         func(string) bool          // function that checks whether key is supported
+	isNullableKey          func(string) bool          // function that checks whether key has a nullable key type
+	isValidFinalSortKey    func(string) bool          // function that checks whether key is a valid final sort key
 	keyValueValidator      func(string, string) error // function that returns an error if key or value are invalid
 	supportedKeysValidator func() error               // function that returns an error if the supported keys are invalid
 }
@@ -39,6 +42,7 @@ func ApplyOptions(options ...Option) (*Paginator, error) {
 		sortOrder:     OrderAscending,
 		supportedKeys: KeyTypes{},
 		version:       Version3,
+		isNullableKey: func(string) bool { return false },
 	}
 
 	for _, option := range options {
@@ -96,13 +100,20 @@ func (p *Paginator) AdvanceCursor(rf ResponseFields) bool {
 }
 
 func (p *Paginator) classifySortKeys() {
+	p.finalSortKeyValid = true
+
 	uniqueSortKeys := map[string]bool{}
 	for _, key := range strings.Split(string(p.sortKey), ",") {
 		if uniqueSortKeys[key] {
 			p.anyDuplicateSortKeys = true
-		} else if p.isKeySupported != nil {
-			if !p.isKeySupported(key) {
-				p.anyUnsupportedSortKeys = true
+		} else {
+			if p.isKeySupported != nil {
+				if !p.isKeySupported(key) {
+					p.anyUnsupportedSortKeys = true
+				}
+			}
+			if p.isValidFinalSortKey != nil {
+				p.finalSortKeyValid = p.isValidFinalSortKey(key)
 			}
 		}
 		uniqueSortKeys[key] = true
@@ -134,11 +145,6 @@ func (p Paginator) IsForward() bool {
 	return p.direction == DirectionForward
 }
 
-// IsCachable returns true if the paginator is configured to be default and cached value can be returned
-func (p Paginator) IsCachable() bool {
-	return p.filter == "" && p.sortKey == "id" && p.sortOrder == OrderAscending
-}
-
 // Query converts the paginator settings into HTTP GET query parameters.
 func (p Paginator) Query() url.Values {
 	query := url.Values{}
@@ -240,6 +246,10 @@ func (p Paginator) Validate() error {
 		return ucerr.Errorf("specified sort key contains duplicate keys: %v", p.sortKey)
 	}
 
+	if !p.finalSortKeyValid {
+		return ucerr.Errorf("final sort key must be 'id', which is guaranteed to be non-nil and unique: %v", p.sortKey)
+	}
+
 	if p.filter != "" {
 		if p.filterQuery == nil {
 			return ucerr.Errorf("could not successfully parse filter '%s'", p.filter)

infra/pagination/query.go

@@ -64,8 +64,8 @@ type QueryParams struct {
 	EndingBefore  *string `description:"A cursor value before which the returned list will end" query:"ending_before"`
 	Limit         *string `description:"The maximum number of results to be returned per page" query:"limit"`
 	Filter        *string `description:"A filter clause to use in the pagination query" query:"filter"`
-	SortKey       *string `description:"The field(s) used to sort the results" query:"sort_key"`
-	SortOrder     *string `description:"The sort order for each field (ascending or descending)" query:"sort_order"`
+	SortKey       *string `description:"A comma-delimited list of field names to sort the returned results by - the last field name must be 'id'" query:"sort_key"`
+	SortOrder     *string `description:"The order in which results should be sorted (ascending or descending)" query:"sort_order"`
 	Version       *string `description:"The version of the API to be called" query:"version"`
 }
 

infra/pagination/types.go

@@ -29,13 +29,18 @@ type KeyType string
 
 // Valid KeyTypes
 const (
-	ArrayKeyType     KeyType = "Array"
-	BoolKeyType      KeyType = "Boolean"
-	IntKeyType       KeyType = "Int"
-	StringKeyType    KeyType = "String"
-	TimestampKeyType KeyType = "Timestamp"
-	UUIDArrayKeyType KeyType = "UUIDArray"
-	UUIDKeyType      KeyType = "UUID"
+	ArrayKeyType             KeyType = "Array"
+	BoolKeyType              KeyType = "Boolean"
+	IntKeyType               KeyType = "Int"
+	NullableBoolKeyType      KeyType = "NullableBoolean"
+	NullableIntKeyType       KeyType = "NullableInt"
+	NullableStringKeyType    KeyType = "NullableString"
+	NullableTimestampKeyType KeyType = "NullableTimestamp"
+	NullableUUIDKeyType      KeyType = "NullableUUID"
+	StringKeyType            KeyType = "String"
+	TimestampKeyType         KeyType = "Timestamp"
+	UUIDArrayKeyType         KeyType = "UUIDArray"
+	UUIDKeyType              KeyType = "UUID"
 )
 
 // Validate implements the Validatable interface
@@ -44,6 +49,11 @@ func (kt KeyType) Validate() error {
 	case ArrayKeyType:
 	case BoolKeyType:
 	case IntKeyType:
+	case NullableBoolKeyType:
+	case NullableIntKeyType:
+	case NullableStringKeyType:
+	case NullableTimestampKeyType:
+	case NullableUUIDKeyType:
 	case StringKeyType:
 	case TimestampKeyType:
 	case UUIDArrayKeyType:

infra/sdkclient/version.go

@@ -1,6 +1,6 @@
 package sdkclient
 
-var sdkVersion = "1.4.0"
+var sdkVersion = "1.5.0"
 
 func getSDKVersion() string {
 	return sdkVersion