feat: add flag to allow exclamation mark in channel ID (#151)

* feat: add flag to allow exlamation mark in channel ID

Author: yaziine

.github/CODEOWNERS

@@ -1 +1 @@
-* @ferhatelmas @gumuz @yaziine
+* @gumuz @yaziine

pkg/cmd/chat/imports/imports.go

@@ -25,24 +25,28 @@ func NewCmds() []*cobra.Command {
 	}
 }
 
-func validateFile(ctx context.Context, c *stream.Client, filename string) (*validator.Results, error) {
+func validateFile(cmd *cobra.Command, c *stream.Client, filename string) (*validator.Results, error) {
 	reader, err := os.Open(filename)
 	if err != nil {
 		return nil, err
 	}
 	defer reader.Close()
 
-	rolesResp, err := c.Permissions().ListRoles(ctx)
+	rolesResp, err := c.Permissions().ListRoles(cmd.Context())
 	if err != nil {
 		return nil, err
 	}
 
-	channelTypesResp, err := c.ListChannelTypes(ctx)
+	channelTypesResp, err := c.ListChannelTypes(cmd.Context())
 	if err != nil {
 		return nil, err
 	}
 
-	return validator.New(reader, rolesResp.Roles, channelTypesResp.ChannelTypes).Validate(), nil
+	var options []validator.Options
+	if light, _ := cmd.Flags().GetBool("lighter-validation-id"); light {
+		options = append(options, validator.LighterValidationChannelID())
+	}
+	return validator.New(reader, rolesResp.Roles, channelTypesResp.ChannelTypes, options...).Validate(), nil
 }
 
 func validateCmd() *cobra.Command {
@@ -60,7 +64,7 @@ func validateCmd() *cobra.Command {
 				return err
 			}
 
-			results, err := validateFile(cmd.Context(), c, args[0])
+			results, err := validateFile(cmd, c, args[0])
 			if err != nil {
 				return err
 			}
@@ -71,6 +75,7 @@ func validateCmd() *cobra.Command {
 
 	fl := cmd.Flags()
 	fl.StringP("output-format", "o", "json", "[optional] Output format. Can be json or tree")
+	fl.Bool("lighter-validation-id", false, "[optional] allows to pass ! in channel ID")
 
 	return cmd
 }
@@ -123,7 +128,7 @@ func uploadCmd() *cobra.Command {
 
 			filename := args[0]
 
-			results, err := validateFile(cmd.Context(), c, filename)
+			results, err := validateFile(cmd, c, filename)
 			if err != nil {
 				return err
 			}
@@ -156,6 +161,7 @@ func uploadCmd() *cobra.Command {
 	fl := cmd.Flags()
 	fl.StringP("mode", "m", "upsert", "[optional] Import mode. Canbe upsert or insert")
 	fl.StringP("output-format", "o", "json", "[optional] Output format. Can be json or tree")
+	fl.Bool("lighter-validation-id", false, "[optional] allows to pass ! in channel ID")
 
 	return cmd
 }

pkg/cmd/chat/imports/validator/items.go

@@ -14,8 +14,10 @@ import (
 )
 
 var (
+	// validChannelIDRe regex differs if lighter-validation-id flag is given
+	validChannelIDRe *regexp.Regexp
+
 	validUserIDRe       = regexp.MustCompile(`^[@\w-]*$`)
-	validChannelIDRe    = regexp.MustCompile(`^[\w-]*$`)
 	validReactionTypeRe = regexp.MustCompile(`^[\w-+:.]*$`)
 )
 
@@ -278,7 +280,7 @@ func (c *channelItem) validateFields() error {
 	}
 
 	if !validChannelIDRe.MatchString(c.ID) {
-		return fmt.Errorf(`channel.id invalid ("%s" allowed)`, validChannelIDRe)
+		return fmt.Errorf(`channel.id %q invalid ("%s" allowed)`, c.ID, validChannelIDRe)
 	}
 
 	if c.Type == "" {

pkg/cmd/chat/imports/validator/testdata/valid-channels-with-light.json

@@ -0,0 +1,58 @@
+[
+  {
+    "type": "user",
+    "item": {
+      "id": "user1",
+      "role": "user"
+    }
+  },
+  {
+    "type": "user",
+    "item": {
+      "id": "user2",
+      "role": "user"
+    }
+  },
+  {
+    "type": "channel",
+    "item": {
+      "id": "channelA",
+      "type": "messaging",
+      "created_by": "user1"
+    }
+  },
+  {
+    "type": "member",
+    "item": {
+      "channel_id": "channelA",
+      "channel_type": "messaging",
+      "user_id": "user1"
+    }
+  },
+  {
+    "type": "channel",
+    "item": {
+      "id": "!members-channelB",
+      "type": "messaging",
+      "created_by": "user2"
+    }
+  },
+  {
+    "type": "member",
+    "item": {
+      "channel_id": "!members-channelB",
+      "channel_type": "messaging",
+      "user_id": "user2"
+    }
+  },
+  {
+    "type": "message",
+    "item": {
+      "id": "message2",
+      "channel_id": "!members-channelB",
+      "channel_type": "messaging",
+      "user": "user2",
+      "text": "hi!"
+    }
+  }
+]

pkg/cmd/chat/imports/validator/validator.go

@@ -2,6 +2,7 @@ package validator
 
 import (
 	"io"
+	"regexp"
 
 	streamchat "github.com/GetStream/stream-chat-go/v5"
 )
@@ -22,17 +23,41 @@ func newResults(stats map[string]int, errs *multiError) *Results {
 	}
 }
 
+type Options func(*option)
+
+type option struct {
+	lighterValidationChannelID bool
+}
+
+func LighterValidationChannelID() Options {
+	return func(o *option) {
+		o.lighterValidationChannelID = true
+	}
+}
+
 type Validator struct {
 	decoder *Decoder
 	index   *index
 }
 
-func New(r io.ReadSeeker, roles []*streamchat.Role, channelTypes channelTypeMap) *Validator {
+func New(r io.ReadSeeker, roles []*streamchat.Role, channelTypes channelTypeMap, options ...Options) *Validator {
 	roleMap := make(roleMap, len(roles))
 	for _, role := range roles {
 		roleMap[role.Name] = role
 	}
 
+	opt := &option{}
+	for _, o := range options {
+		o(opt)
+	}
+
+	if opt.lighterValidationChannelID {
+		// allows to pass ! in channel ID
+		validChannelIDRe = regexp.MustCompile(`^[\w!-]*$`)
+	} else {
+		validChannelIDRe = regexp.MustCompile(`^[\w-]*$`)
+	}
+
 	return &Validator{
 		decoder: NewDecoder(r),
 		index:   newIndex(roleMap, channelTypes),

pkg/cmd/chat/imports/validator/validator_test.go

@@ -15,11 +15,17 @@ func TestValidator_Validate(t *testing.T) {
 		name     string
 		filename string
 		want     *Results
+
+		lighterChanIDValidation bool
 	}{
 		{name: "Valid data", filename: "valid-data.json", want: &Results{
 			Stats:  map[string]int{"channels": 3, "devices": 2, "members": 4, "messages": 3, "reactions": 3, "users": 4},
 			Errors: nil,
 		}},
+		{name: "Valid channels with lighter channel ID validation", filename: "valid-channels-with-light.json", lighterChanIDValidation: true, want: &Results{
+			Stats:  map[string]int{"channels": 2, "devices": 0, "members": 2, "messages": 1, "reactions": 0, "users": 2},
+			Errors: nil,
+		}},
 		{name: "Invalid users", filename: "invalid-users.json", want: &Results{
 			Stats: map[string]int{"channels": 0, "devices": 0, "members": 0, "messages": 0, "reactions": 0, "users": 1},
 			Errors: []error{
@@ -38,7 +44,7 @@ func TestValidator_Validate(t *testing.T) {
 				errors.New(`validation error: either channel.id or channel.member_ids required`),
 				errors.New(`validation error: channel.id max length exceeded (64)`),
 				errors.New(`validation error: channel.type required`),
-				errors.New(`validation error: channel.id invalid ("^[\w-]*$" allowed)`),
+				errors.New(`validation error: channel.id "channelA@abc" invalid ("^[\w-]*$" allowed)`),
 				errors.New(`validation error: channel.created_by required`),
 				errors.New(`validation error: channel.cid is a reserved field`),
 				errors.New(`reference error: channel.type "" doesn't exist (channel ":channelA")`),
@@ -108,12 +114,16 @@ func TestValidator_Validate(t *testing.T) {
 			require.NoError(t, err)
 			defer f.Close()
 
-			v := New(f, []*stream.Role{{Name: "user"}}, map[string]*stream.ChannelType{"messaging": nil})
+			var options []Options
+			if tt.lighterChanIDValidation {
+				options = append(options, LighterValidationChannelID())
+			}
+			v := New(f, []*stream.Role{{Name: "user"}}, map[string]*stream.ChannelType{"messaging": nil}, options...)
 
 			got := v.Validate()
 
 			require.Equal(t, tt.want.Stats, got.Stats)
-			require.Equal(t, len(tt.want.Errors), len(got.Errors))
+			require.Equal(t, len(tt.want.Errors), len(got.Errors), got.Errors)
 			for i := range tt.want.Errors {
 				require.Equal(t, tt.want.Errors[i].Error(), got.Errors[i].Error(), fmt.Sprintf(`errors #%d doesn't match`, i))
 			}