Skip to content

Commit 59a54be

Browse files
behinddwallsbehinddwalls
authored
rename(queue/mysql): rename extension/queue/sql to extension/queue/mysql (#60)
## Summary - Renames `extension/queue/sql` → `extension/queue/mysql` to align with existing naming conventions (`extension/storage/mysql`, `extension/counter/mysql`) - Updates package declarations, import paths, BUILD.bazel files, and all references across the codebase (Makefile, docs, test utilities, integration tests, e2e tests) - The generic `sql` package name is replaced with `mysql` to make the backend explicit ## Test plan - [x] `make gazelle` — BUILD files regenerated successfully - [x] `make build` — all 54 targets build successfully - [x] `make test` — all 8 unit tests pass (including `//extension/queue/mysql:mysql_test`) ## Stack 1. @ #60 1. #61
1 parent 0d62ae5 commit 59a54be

40 files changed

Lines changed: 73 additions & 73 deletions

‎Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ local-init-schemas: ## Manually apply all database schemas
120120
docker exec -i $(LOCAL_PROJECT)-mysql-app-1 mysql -uroot -proot submitqueue < $$file 2>&1 | grep -v "Using a password" || true; \
121121
done
122122
@echo "Applying queue schema to mysql-queue..."
123-
@for file in extension/queue/sql/schema/*.sql; do \
123+
@for file in extension/queue/mysql/schema/*.sql; do \
124124
echo " - Applying $$(basename $$file)..."; \
125125
docker exec -i $(LOCAL_PROJECT)-mysql-queue-1 mysql -uroot -proot submitqueue < $$file 2>&1 | grep -v "Using a password" || true; \
126126
done

‎doc/howto/TESTING.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ SubmitQueue uses **two separate databases** to demonstrate proper architectural
2929

3030
### 2. Queue Database
3131
- **Purpose**: Messaging infrastructure (queue messages, offsets, partition leases)
32-
- **Schema**: `extension/queue/sql/schema`
32+
- **Schema**: `extension/queue/mysql/schema`
3333
- **Used by**: Gateway (publishes), Orchestrator (consumes)
3434
- **Connection**: `QUEUE_MYSQL_DSN`
3535

‎doc/rfc/sql-queue-rfc.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ We chose **custom database-backed queue** because:
159159
- `(topic, partition_key, invisible_until, offset)`: Core fetch query - find visible messages in partition ordered by offset
160160
- `(topic, partition_key, id)`: Unique constraint and fast lookup for Ack/Nack
161161

162-
See `extension/queue/sql/schema/queue_messages.sql` for full schema.
162+
See `extension/queue/mysql/schema/queue_messages.sql` for full schema.
163163

164164
### Partition Leases Table
165165

@@ -172,7 +172,7 @@ See `extension/queue/sql/schema/queue_messages.sql` for full schema.
172172
- `(leased_by)`: Find all partitions owned by a worker
173173
- `(lease_renewed_at)`: Detect stale leases across workers
174174

175-
See `extension/queue/sql/schema/queue_partition_leases.sql` for full schema.
175+
See `extension/queue/mysql/schema/queue_partition_leases.sql` for full schema.
176176

177177
### Consumer Offsets Table
178178

@@ -185,7 +185,7 @@ See `extension/queue/sql/schema/queue_partition_leases.sql` for full schema.
185185
- `(consumer_group)`: Monitor all offsets for a consumer group
186186
- `(topic)`: Find all consumers for a topic
187187

188-
See `extension/queue/sql/schema/queue_offsets.sql` for full schema.
188+
See `extension/queue/mysql/schema/queue_offsets.sql` for full schema.
189189

190190
### Dead Letter Queue Table
191191

@@ -201,7 +201,7 @@ See `extension/queue/sql/schema/queue_offsets.sql` for full schema.
201201
- `(failed_at)`: Time-based queries and cleanup
202202
- `(topic, partition_key, id)`: Unique constraint, prevents duplicates
203203

204-
See `extension/queue/sql/schema/queue_dlq.sql` for full schema.
204+
See `extension/queue/mysql/schema/queue_dlq.sql` for full schema.
205205

206206
## Message Flow
207207

‎example/server/gateway/BUILD.bazel‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ go_library(
1313
deps = [
1414
"//core/consumer",
1515
"//extension/counter/mysql",
16-
"//extension/queue/sql",
16+
"//extension/queue/mysql",
1717
"//extension/storage/mysql",
1818
"//gateway/controller",
1919
"//gateway/protopb",

‎example/server/gateway/main.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import (
1515
"github.com/uber-go/tally/v4"
1616
"github.com/uber/submitqueue/core/consumer"
1717
mysqlcounter "github.com/uber/submitqueue/extension/counter/mysql"
18-
queueSQL "github.com/uber/submitqueue/extension/queue/sql"
18+
queueMySQL "github.com/uber/submitqueue/extension/queue/mysql"
1919
"github.com/uber/submitqueue/extension/storage/mysql"
2020
"github.com/uber/submitqueue/gateway/controller"
2121
pb "github.com/uber/submitqueue/gateway/protopb"
@@ -122,15 +122,15 @@ func run() error {
122122
defer queueDB.Close()
123123

124124
// Initialize queue
125-
sqlQueue, err := queueSQL.NewQueue(queueSQL.Params{
125+
mysqlQueue, err := queueMySQL.NewQueue(queueMySQL.Params{
126126
DB: queueDB,
127127
Logger: logger,
128128
MetricsScope: scope.SubScope("queue"),
129129
})
130130
if err != nil {
131131
return fmt.Errorf("failed to create queue: %w", err)
132132
}
133-
defer sqlQueue.Close()
133+
defer mysqlQueue.Close()
134134

135135
logger.Info("initialized dependencies",
136136
zap.String("app_dsn", appDSN),
@@ -142,7 +142,7 @@ func run() error {
142142

143143
// Create controllers and wrap them for gRPC
144144
pingController := controller.NewPingController(logger, scope)
145-
landController := controller.NewLandController(logger.Sugar(), scope, store, cnt, sqlQueue.Publisher(), consumer.TopicRequest.String())
145+
landController := controller.NewLandController(logger.Sugar(), scope, store, cnt, mysqlQueue.Publisher(), consumer.TopicRequest.String())
146146
gatewayServer := &GatewayServer{
147147
pingController: pingController,
148148
landController: landController,

‎example/server/orchestrator/BUILD.bazel‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ go_library(
1313
deps = [
1414
"//core/consumer",
1515
"//extension/queue",
16-
"//extension/queue/sql",
16+
"//extension/queue/mysql",
1717
"//orchestrator/controller",
1818
"//orchestrator/controller/request",
1919
"//orchestrator/protopb",

‎example/server/orchestrator/main.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import (
1515
"github.com/uber-go/tally/v4"
1616
"github.com/uber/submitqueue/core/consumer"
1717
extqueue "github.com/uber/submitqueue/extension/queue"
18-
queueSQL "github.com/uber/submitqueue/extension/queue/sql"
18+
queueMySQL "github.com/uber/submitqueue/extension/queue/mysql"
1919
"github.com/uber/submitqueue/orchestrator/controller"
2020
"github.com/uber/submitqueue/orchestrator/controller/request"
2121
pb "github.com/uber/submitqueue/orchestrator/protopb"
@@ -98,15 +98,15 @@ func run() error {
9898
defer queueDB.Close()
9999

100100
// Initialize queue
101-
sqlQueue, err := queueSQL.NewQueue(queueSQL.Params{
101+
mysqlQueue, err := queueMySQL.NewQueue(queueMySQL.Params{
102102
DB: queueDB,
103103
Logger: logger,
104104
MetricsScope: scope.SubScope("queue"),
105105
})
106106
if err != nil {
107107
return fmt.Errorf("failed to create queue: %w", err)
108108
}
109-
defer sqlQueue.Close()
109+
defer mysqlQueue.Close()
110110

111111
logger.Info("initialized queue", zap.String("dsn", queueDSN))
112112

@@ -118,8 +118,8 @@ func run() error {
118118

119119
registry := consumer.NewTopicRegistry(
120120
[]consumer.TopicConfig{
121-
{Topic: consumer.TopicRequest, Queue: sqlQueue},
122-
{Topic: consumer.TopicToBatch, Queue: sqlQueue},
121+
{Topic: consumer.TopicRequest, Queue: mysqlQueue},
122+
{Topic: consumer.TopicToBatch, Queue: mysqlQueue},
123123
},
124124
[]extqueue.SubscriptionConfig{
125125
extqueue.DefaultSubscriptionConfig(

extension/queue/sql/BUILD.bazel renamed to extension/queue/mysql/BUILD.bazel

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
load("@rules_go//go:def.bzl", "go_library", "go_test")
22

33
go_library(
4-
name = "sql",
4+
name = "mysql",
55
srcs = [
66
"constants.go",
77
"errors.go",
@@ -15,7 +15,7 @@ go_library(
1515
"subscriber.go",
1616
"validation.go",
1717
],
18-
importpath = "github.com/uber/submitqueue/extension/queue/sql",
18+
importpath = "github.com/uber/submitqueue/extension/queue/mysql",
1919
visibility = ["//visibility:public"],
2020
deps = [
2121
"//entity/queue",
@@ -27,7 +27,7 @@ go_library(
2727
)
2828

2929
go_test(
30-
name = "sql_test",
30+
name = "mysql_test",
3131
srcs = [
3232
"message_store_test.go",
3333
"offset_store_test.go",
@@ -36,7 +36,7 @@ go_test(
3636
"sql_test.go",
3737
"subscriber_test.go",
3838
],
39-
embed = [":sql"],
39+
embed = [":mysql"],
4040
deps = [
4141
"//entity/queue",
4242
"//extension/queue",

extension/queue/sql/README.md renamed to extension/queue/mysql/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ MySQL-based distributed queue with partition leasing, visibility timeout, and at
1515
import (
1616
"database/sql"
1717
_ "github.com/go-sql-driver/mysql"
18-
queueSQL "github.com/uber/submitqueue/extension/queue/sql"
18+
queueMySQL "github.com/uber/submitqueue/extension/queue/mysql"
1919
extqueue "github.com/uber/submitqueue/extension/queue"
2020
"github.com/uber/submitqueue/entity/queue"
2121
)
2222

2323
// Setup
2424
db, _ := sql.Open("mysql", "user:pass@tcp(localhost:3306)/db")
25-
q, _ := queueSQL.NewQueue(queueSQL.Params{
25+
q, _ := queueMySQL.NewQueue(queueMySQL.Params{
2626
DB: db,
2727
Logger: logger,
2828
MetricsScope: metrics,

extension/queue/sql/constants.go renamed to extension/queue/mysql/constants.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package sql
1+
package mysql
22

33
// Common constants for frequently repeated strings across stores
44

0 commit comments

Comments
 (0)