SMQ-2761 - Add route field to channels

[felixgateru]

What type of PR is this?

This is a feature as it adds a route field to channels.

What does this do?

• Introduces route attribute for channels
• Updates relevent repository, service and api methods for this addition
• Updates documentation and tests

Which issue(s) does this PR fix/relate to?

• Resolves Add topic field to channels #2761

Have you included tests for your changes?

Yes, tests have been added for my changes.

Did you document any new/modified feature?

Yes, api documentation has been updated for the change

Notes

[codecov]

Codecov Report

Attention: Patch coverage is 42.85714% with 60 lines in your changes missing coverage. Please review.

Project coverage is 31.19%. Comparing base (7f4633a) to head (e7d7a91).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
channels/mocks/repository.go	0.00%	34 Missing ⚠️
channels/postgres/channels.go	66.66%	11 Missing and 2 partials ⚠️
channels/events/events.go	0.00%	7 Missing ⚠️
channels/api/http/requests.go	57.14%	4 Missing and 2 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2772      +/-   ##
==========================================
+ Coverage   27.68%   31.19%   +3.50%     
==========================================
  Files         353       65     -288     
  Lines       55931    15355   -40576     
==========================================
- Hits        15485     4790   -10695     
+ Misses      39679    10312   -29367     
+ Partials      767      253     -514     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[dborovcanin]

@felixgateru Please rebase.

[arvindh123]

I have applied these migration in existing channels
I get error like this in channels

2025-05-21 14:25:56 {"time":"2025-05-21T08:55:56.963692336Z","level":"ERROR","msg":"failed to apply migrations : ERROR: column \"route\" of relation \"channels\" contains null values (SQLSTATE 23502) handling channels_03"}

---

In order make this work with existing deployments
We can simply copy channel id to route

-- Step 1: Add the 'route' column, allowing NULLs temporarily
ALTER TABLE channels ADD COLUMN route VARCHAR(36);

-- Step 2: Populate the 'route' column for existing rows with values from 'id'
-- Assuming 'id' is a UUID or a type that can be cast to VARCHAR(36)
-- If 'id' is a different type (e.g., INT), you might need a different casting or conversion
UPDATE channels SET route = id::VARCHAR(36);

-- Step 3: Add the NOT NULL constraint to the 'route' column
-- This will succeed now because all existing rows have a value for 'route'
ALTER TABLE channels ALTER COLUMN route SET NOT NULL;

-- Step 4: Add the unique constraint
ALTER TABLE channels ADD CONSTRAINT unique_domain_route UNIQUE (domain_id, route);

[dborovcanin]

Why do we make route required?

[dborovcanin]

If nothing, routes must not be in UUID format so we can easily and quickly make a difference between ID and route; something like username and email.

[arvindh123]

Suggested change

	}
	if req.Channel.Route != "" {
	if err := api.ValidateRoute(req.Channel.Route); err != nil {
	return err
	}
	}

[arvindh123]

LGTM

[dborovcanin]

Also, add a check for UUID format. We must not allow UUIDs in routes to prevent confusion and make our lives easier.

[dborovcanin]

Add test here as well:

		{
			desc:     "create channel with UUID route",
			token:    validToken,
			domainID: validID,
			req: channels.Channel{
				Name:  valid,
				Route: testsutil.GenerateUUID(t),
			},
			contentType: contentType,
			status:      http.StatusBadRequest,
			err:         apiutil.ErrInvalidRouteFormat,
		},

Validation testing is fine, but it only works if decoding request works properly, so we to test it here as well.