refactor: rename topic to route

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\",\"topic\":\"$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,7 +92,7 @@ const (
 
 var (
 	nameRegExp        = regexp.MustCompile(`^[a-z0-9][a-z0-9_-]{34}[a-z0-9]$`)
-	topicRegExp       = regexp.MustCompile(`^[a-zA-Z][a-zA-Z0-9_-]{0,35}$`)
+	routeRegExp       = regexp.MustCompile(`^[a-zA-Z][a-zA-Z0-9_-]{0,35}$`)
 	errUnreadableName = errors.New("name containing double underscores or double dashes not allowed")
 )
 
@@ -119,14 +119,14 @@ func ValidateName(id string) error {
 	return nil
 }
 
-// ValidateTopic validates topic format.
-func ValidateTopic(topic string) error {
-	if !topicRegExp.MatchString(topic) {
-		return apiutil.ErrInvalidTopicFormat
+// ValidateRoute validates route format.
+func ValidateRoute(route string) error {
+	if !routeRegExp.MatchString(route) {
+		return apiutil.ErrInvalidRouteFormat
 	}
 
-	if strings.Contains(topic, "__") || strings.Contains(topic, "--") {
-		return errors.Wrap(apiutil.ErrInvalidTopicFormat, errUnreadableName)
+	if strings.Contains(route, "__") || strings.Contains(route, "--") {
+		return errors.Wrap(apiutil.ErrInvalidRouteFormat, errUnreadableName)
 	}
 
 	return nil
@@ -176,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.ErrMissingTopic),
+		errors.Contains(err, apiutil.ErrMissingRoute),
 		errors.Contains(err, apiutil.ErrMissingEmail),
 		errors.Contains(err, apiutil.ErrInvalidEmail),
 		errors.Contains(err, apiutil.ErrMissingHost),
@@ -233,7 +233,7 @@ func EncodeError(_ context.Context, err error, w http.ResponseWriter) {
 		errors.Contains(err, apiutil.ErrMissingRoleMembers),
 		errors.Contains(err, apiutil.ErrMissingDescription),
 		errors.Contains(err, apiutil.ErrMissingEntityID),
-		errors.Contains(err, apiutil.ErrInvalidTopicFormat):
+		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")
 
-	// ErrMissingTopic indicates missing topic.
-	ErrMissingTopic = errors.New("missing topic")
+	// 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)")
@@ -263,6 +263,6 @@ var (
 	// ErrInvalidNameFormat indicates invalid name format.
 	ErrInvalidNameFormat = errors.New("invalid name format")
 
-	// ErrInvalidTopicFormat indicates invalid topic format.
-	ErrInvalidTopicFormat = errors.New("invalid topic 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 topic.
+          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 topic of the domain.
+      summary: Updates name, metadata and tags of the domain.
       description: |
-        Updates name, metadata, tags and topic 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.
-        topic:
+        route:
           type: string
-          example: domain topic
-          description: Domain topic.
+          example: domain_route
+          description: Domain route.
       required:
         - name
-        - topic
+        - route
     Domain:
       type: object
       properties:
@@ -960,10 +960,10 @@ components:
           type: object
           example: { "domain": "example.com" }
           description: Arbitrary, object-encoded domain's data.
-        topic:
+        route:
           type: string
-          example: domain topic
-          description: Domain topic.
+          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.
-        topic:
-          type: string
-          example: domain topic
-          description: Domain topic.
 
     SendInvitationReqObj:
       type: object
@@ -1291,7 +1287,7 @@ components:
           schema:
             $ref: "#/components/schemas/DomainReqObj"
     DomainUpdateReq:
-      description: JSON-formated document describing the name, topic, 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:

auth/README.md

@@ -40,15 +40,15 @@ The following actions are supported:
 
 ## Domains
 
-Domains are used to group users and clients. Each domain has a unique topic that is associated with the domain. Domains are used to group users and their entities.
+Domains are used to group users and clients. Each domain has a unique route that is associated with the domain. Domains are used to group users and their entities.
 
 Domain consists of the following fields:
 
 - ID - UUID uniquely representing domain
 - Name - name of the domain
 - Tags - array of tags
 - Metadata - Arbitrary, object-encoded domain's data
-- Topic - unique topic of the domain
+- Route - unique route of the domain used in messaging
 - CreatedAt - timestamp at which the domain is created
 - UpdatedAt - timestamp at which the domain is updated
 - UpdatedBy - user that updated the domain

cli/domains.go

@@ -12,11 +12,11 @@ import (
 
 var cmdDomains = []cobra.Command{
 	{
-		Use:   "create <name> <topic> <token>",
+		Use:   "create <name> <route> <token>",
 		Short: "Create Domain",
-		Long: "Create Domain with provided name and topic. \n" +
+		Long: "Create Domain with provided name and route. \n" +
 			"For example:\n" +
-			"\tsupermq-cli domains create domain_1 domain_1_topic $TOKEN\n",
+			"\tsupermq-cli domains create domain_1 domain_1_route $TOKEN\n",
 		Run: func(cmd *cobra.Command, args []string) {
 			if len(args) != 3 {
 				logUsageCmd(*cmd, cmd.Use)
@@ -25,7 +25,7 @@ var cmdDomains = []cobra.Command{
 
 			dom := smqsdk.Domain{
 				Name:  args[0],
-				Topic: args[1],
+				Route: args[1],
 			}
 			d, err := sdk.CreateDomain(dom, args[2])
 			if err != nil {
@@ -108,9 +108,9 @@ var cmdDomains = []cobra.Command{
 	{
 		Use:   "update <domain_id> <JSON_string> <user_auth_token>",
 		Short: "Update domains",
-		Long: "Updates domains name, topic and metadata \n" +
+		Long: "Updates domains name, route and metadata \n" +
 			"Usage:\n" +
-			"\tsupermq-cli domains update <domain_id> '{\"name\":\"new name\", \"topic\":\"new_topic\", \"metadata\":{\"key\": \"value\"}}' $TOKEN \n",
+			"\tsupermq-cli domains update <domain_id> '{\"name\":\"new name\", \"route\":\"new_route\", \"metadata\":{\"key\": \"value\"}}' $TOKEN \n",
 		Run: func(cmd *cobra.Command, args []string) {
 			if len(args) != 4 && len(args) != 3 {
 				logUsageCmd(*cmd, cmd.Use)

cli/domains_test.go

@@ -24,7 +24,7 @@ var (
 	domain = smqsdk.Domain{
 		ID:    testsutil.GenerateUUID(&testing.T{}),
 		Name:  "Test domain",
-		Topic: "topic",
+		Route: "route",
 	}
 	roleID = testsutil.GenerateUUID(&testing.T{})
 )
@@ -49,7 +49,7 @@ func TestCreateDomainsCmd(t *testing.T) {
 			desc: "create domain successfully",
 			args: []string{
 				dom.Name,
-				dom.Topic,
+				dom.Route,
 				validToken,
 			},
 			logType: entityLog,
@@ -59,7 +59,7 @@ func TestCreateDomainsCmd(t *testing.T) {
 			desc: "create domain with invalid args",
 			args: []string{
 				dom.Name,
-				dom.Topic,
+				dom.Route,
 				validToken,
 				extraArg,
 			},
@@ -69,7 +69,7 @@ func TestCreateDomainsCmd(t *testing.T) {
 			desc: "create domain with invalid token",
 			args: []string{
 				dom.Name,
-				dom.Topic,
+				dom.Route,
 				invalidToken,
 			},
 			sdkErr:        errors.NewSDKErrorWithStatus(svcerr.ErrAuthorization, http.StatusUnauthorized),

domains/api/http/endpoint.go

@@ -35,7 +35,7 @@ func createDomainEndpoint(svc domains.Service) endpoint.Endpoint {
 			Name:     req.Name,
 			Metadata: req.Metadata,
 			Tags:     req.Tags,
-			Topic:    req.Topic,
+			Route:    req.Route,
 		}
 		domain, _, err := svc.CreateDomain(ctx, session, d)
 		if err != nil {
@@ -86,7 +86,6 @@ func updateDomainEndpoint(svc domains.Service) endpoint.Endpoint {
 			Name:     req.Name,
 			Metadata: &metadata,
 			Tags:     req.Tags,
-			Topic:    req.Topic,
 		}
 		domain, err := svc.UpdateDomain(ctx, session, req.domainID, d)
 		if err != nil {