SMQ-2760 - Rename domain alias to route (#2776)

Signed-off-by: Felix Gateru <felix.gateru@gmail.com>

Author: felixgateru

.github/workflows/api-tests.yaml

@@ -58,7 +58,7 @@ jobs:
       - name: Set access token
         run: |
           export USER_TOKEN=$(curl -sSX POST $TOKENS_URL -H "Content-Type: application/json" -d "{\"identity\": \"$USER_IDENTITY\",\"secret\": \"$USER_SECRET\"}" | jq -r .access_token)
-          export DOMAIN_ID=$(curl -sSX POST $CREATE_DOMAINS_URL -H "Content-Type: application/json" -H "Authorization: Bearer $USER_TOKEN" -d "{\"name\":\"$DOMAIN_NAME\",\"alias\":\"$DOMAIN_NAME\"}" | jq -r .id)
+          export DOMAIN_ID=$(curl -sSX POST $CREATE_DOMAINS_URL -H "Content-Type: application/json" -H "Authorization: Bearer $USER_TOKEN" -d "{\"name\":\"$DOMAIN_NAME\",\"route\":\"$DOMAIN_NAME\"}" | jq -r .id)
           echo "USER_TOKEN=$USER_TOKEN" >> $GITHUB_ENV
           export CLIENT_SECRET=$(supermq-cli provision test | /usr/bin/grep -Eo '"secret": "[^"]+"' | awk 'NR % 2 == 0' | sed 's/"secret": "\(.*\)"/\1/')
           echo "CLIENT_SECRET=$CLIENT_SECRET" >> $GITHUB_ENV

api/http/common.go

@@ -92,6 +92,7 @@ const (
 
 var (
 	nameRegExp        = regexp.MustCompile(`^[a-z0-9][a-z0-9_-]{34}[a-z0-9]$`)
+	routeRegExp       = regexp.MustCompile(`^[a-zA-Z][a-zA-Z0-9_-]{0,35}$`)
 	errUnreadableName = errors.New("name containing double underscores or double dashes not allowed")
 )
 
@@ -118,6 +119,19 @@ func ValidateName(id string) error {
 	return nil
 }
 
+// ValidateRoute validates route format.
+func ValidateRoute(route string) error {
+	if !routeRegExp.MatchString(route) {
+		return apiutil.ErrInvalidRouteFormat
+	}
+
+	if strings.Contains(route, "__") || strings.Contains(route, "--") {
+		return errors.Wrap(apiutil.ErrInvalidRouteFormat, errUnreadableName)
+	}
+
+	return nil
+}
+
 // EncodeResponse encodes successful response.
 func EncodeResponse(_ context.Context, w http.ResponseWriter, response interface{}) error {
 	if ar, ok := response.(supermq.Response); ok {
@@ -162,7 +176,7 @@ func EncodeError(_ context.Context, err error, w http.ResponseWriter) {
 		errors.Contains(err, errors.ErrMalformedEntity),
 		errors.Contains(err, apiutil.ErrMissingID),
 		errors.Contains(err, apiutil.ErrMissingName),
-		errors.Contains(err, apiutil.ErrMissingAlias),
+		errors.Contains(err, apiutil.ErrMissingRoute),
 		errors.Contains(err, apiutil.ErrMissingEmail),
 		errors.Contains(err, apiutil.ErrInvalidEmail),
 		errors.Contains(err, apiutil.ErrMissingHost),
@@ -218,7 +232,8 @@ func EncodeError(_ context.Context, err error, w http.ResponseWriter) {
 		errors.Contains(err, apiutil.ErrMissingPolicyEntityType),
 		errors.Contains(err, apiutil.ErrMissingRoleMembers),
 		errors.Contains(err, apiutil.ErrMissingDescription),
-		errors.Contains(err, apiutil.ErrMissingEntityID):
+		errors.Contains(err, apiutil.ErrMissingEntityID),
+		errors.Contains(err, apiutil.ErrInvalidRouteFormat):
 		err = unwrap(err)
 		w.WriteHeader(http.StatusBadRequest)
 

api/http/util/errors.go

@@ -177,8 +177,8 @@ var (
 	// ErrMissingName indicates missing identity name.
 	ErrMissingName = errors.New("missing identity name")
 
-	// ErrMissingName indicates missing alias.
-	ErrMissingAlias = errors.New("missing alias")
+	// ErrMissingRoute indicates missing route.
+	ErrMissingRoute = errors.New("missing route")
 
 	// ErrInvalidLevel indicates an invalid group level.
 	ErrInvalidLevel = errors.New("invalid group level (should be between 0 and 5)")
@@ -262,4 +262,7 @@ var (
 
 	// ErrInvalidNameFormat indicates invalid name format.
 	ErrInvalidNameFormat = errors.New("invalid name format")
+
+	// ErrInvalidRouteFormat indicates invalid route format.
+	ErrInvalidRouteFormat = errors.New("invalid route format")
 )

apidocs/openapi/domains.yaml

@@ -59,7 +59,7 @@ paths:
         "401":
           description: Missing or invalid access token provided.
         "409":
-          description: Failed due to using an existing alias.
+          description: Failed due to using an existing route.
         "415":
           description: Missing or invalid content type.
         "422":
@@ -123,9 +123,9 @@ paths:
           $ref: "#/components/responses/ServiceError"
 
     patch:
-      summary: Updates name, metadata, tags and alias of the domain.
+      summary: Updates name, metadata and tags of the domain.
       description: |
-        Updates name, metadata, tags and alias of the domain.
+        Updates name, metadata and tags of the domain.
       tags:
         - Domains
       parameters:
@@ -930,13 +930,13 @@ components:
           type: object
           example: { "domain": "example.com" }
           description: Arbitrary, object-encoded domain's data.
-        alias:
+        route:
           type: string
-          example: domain alias
-          description: Domain alias.
+          example: domain_route
+          description: Domain route.
       required:
         - name
-        - alias
+        - route
     Domain:
       type: object
       properties:
@@ -960,10 +960,10 @@ components:
           type: object
           example: { "domain": "example.com" }
           description: Arbitrary, object-encoded domain's data.
-        alias:
+        route:
           type: string
-          example: domain alias
-          description: Domain alias.
+          example: domain_route
+          description: Domain route.
         status:
           type: string
           description: Domain Status
@@ -1034,10 +1034,6 @@ components:
           type: object
           example: { "domain": "example.com" }
           description: Arbitrary, object-encoded domain's data.
-        alias:
-          type: string
-          example: domain alias
-          description: Domain alias.
 
     SendInvitationReqObj:
       type: object
@@ -1291,7 +1287,7 @@ components:
           schema:
             $ref: "#/components/schemas/DomainReqObj"
     DomainUpdateReq:
-      description: JSON-formated document describing the name, alias, tags, and metadata of the domain to be updated
+      description: JSON-formated document describing the name, tags, and metadata of the domain to be updated
       required: true
       content:
         application/json: