Skip to content

Restructure Stovepipe under gateway; add core/extension #174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mnoah1 wants to merge 2 commits into from
Closed

Restructure Stovepipe under gateway; add core/extension #174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8a2ad31
Restructure Stovepipe under gateway and add core/extension placeholders.
mnoah1 Jun 2, 2026
36afd47
Merge branch 'main' into refactor/stovepipe-nested-layout
mnoah1 Jun 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion BUILD.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ load("@gazelle//:def.bzl", "gazelle")
# Resolve protobuf import ambiguities - use the actual protopb packages, not the proto aliases
# gazelle:resolve go github.com/uber/submitqueue/gateway/protopb //gateway/protopb
# gazelle:resolve go github.com/uber/submitqueue/orchestrator/protopb //orchestrator/protopb
# gazelle:resolve go github.com/uber/submitqueue/stovepipe/protopb //stovepipe/protopb
# gazelle:resolve go github.com/uber/submitqueue/stovepipe/gateway/protopb //stovepipe/gateway/protopb

# Export marker files for test data dependencies (used by FindRepoRoot in tests)
exports_files(
Expand Down
10 changes: 5 additions & 5 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ clean-proto: ## Clean generated proto files
@echo "Cleaning generated proto files..."
@rm -rf gateway/protopb/*.pb.go
@rm -rf orchestrator/protopb/*.pb.go
@rm -rf stovepipe/protopb/*.pb.go
@rm -rf stovepipe/gateway/protopb/*.pb.go
@echo "Proto clean complete!"

deps: tidy-go ## Download and tidy Go dependencies
Expand Down Expand Up @@ -287,10 +287,10 @@ proto: ## Generate protobuf files from .proto definitions
--go-grpc_out=orchestrator/protopb --go-grpc_opt=paths=source_relative \
--yarpc-go_out=orchestrator/protopb --yarpc-go_opt=paths=source_relative \
--proto_path=orchestrator/proto orchestrator/proto/orchestrator.proto
@protoc --go_out=stovepipe/protopb --go_opt=paths=source_relative \
--go-grpc_out=stovepipe/protopb --go-grpc_opt=paths=source_relative \
--yarpc-go_out=stovepipe/protopb --yarpc-go_opt=paths=source_relative \
--proto_path=stovepipe/proto stovepipe/proto/stovepipe.proto
@protoc --go_out=stovepipe/gateway/protopb --go_opt=paths=source_relative \
--go-grpc_out=stovepipe/gateway/protopb --go-grpc_opt=paths=source_relative \
--yarpc-go_out=stovepipe/gateway/protopb --yarpc-go_opt=paths=source_relative \
--proto_path=stovepipe/gateway/proto stovepipe/gateway/proto/stovepipe.proto
@echo "Protobuf files generated successfully!"

# Bazel query helpers
Expand Down
8 changes: 8 additions & 0 deletions core/extension/BUILD.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
load("@rules_go//go:def.bzl", "go_library")

go_library(
name = "extension",
srcs = ["doc.go"],
importpath = "github.com/uber/submitqueue/core/extension",
visibility = ["//visibility:public"],
)
17 changes: 17 additions & 0 deletions core/extension/doc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
// Copyright (c) 2025 Uber Technologies, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Package extension holds extension interfaces and implementations shared
// across SubmitQueue, Stovepipe, and other repo-local services.
package extension
Copy link
Copy Markdown
Collaborator

@behinddwalls behinddwalls Jun 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we have been adding README.md files in such places...do we want to add those or switch to doc.go files?

Copy link
Copy Markdown
Contributor Author

@mnoah1 mnoah1 Jun 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still have it in draft, will enqueue once ready

2 changes: 1 addition & 1 deletion example/client/stovepipe/BUILD.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ go_library(
importpath = "github.com/uber/submitqueue/example/client/stovepipe",
visibility = ["//visibility:private"],
deps = [
"//stovepipe/protopb",
"//stovepipe/gateway/protopb",
"@org_golang_google_grpc//:grpc",
"@org_golang_google_grpc//credentials/insecure",
],
Expand Down
2 changes: 1 addition & 1 deletion example/client/stovepipe/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import (
"os"
"time"

pb "github.com/uber/submitqueue/stovepipe/protopb"
pb "github.com/uber/submitqueue/stovepipe/gateway/protopb"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials/insecure"
)
Expand Down
4 changes: 2 additions & 2 deletions example/server/stovepipe/BUILD.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ go_library(
importpath = "github.com/uber/submitqueue/example/server/stovepipe",
visibility = ["//visibility:private"],
deps = [
"//stovepipe/controller",
"//stovepipe/protopb",
"//stovepipe/gateway/controller",
"//stovepipe/gateway/protopb",
"@com_github_uber_go_tally_v4//:tally",
"@org_golang_google_grpc//:grpc",
"@org_golang_google_grpc//reflection",
Expand Down
4 changes: 2 additions & 2 deletions example/server/stovepipe/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ import (
"time"

"github.com/uber-go/tally/v4"
"github.com/uber/submitqueue/stovepipe/controller"
pb "github.com/uber/submitqueue/stovepipe/protopb"
"github.com/uber/submitqueue/stovepipe/gateway/controller"
pb "github.com/uber/submitqueue/stovepipe/gateway/protopb"
"go.uber.org/zap"
"google.golang.org/grpc"
"google.golang.org/grpc/reflection"
Expand Down
9 changes: 8 additions & 1 deletion stovepipe/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,8 @@
SubmitQueue Stovepipe
# Stovepipe

Stovepipe service layout:

- `gateway/` — RPC surface, gateway controllers, and generated protobufs
- `orchestrator/` — reserved for the future Stovepipe orchestrator binary
- `extension/` — Stovepipe-specific extension implementations
- `entity/` — Stovepipe-specific domain entities
8 changes: 8 additions & 0 deletions stovepipe/entity/BUILD.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
load("@rules_go//go:def.bzl", "go_library")

go_library(
name = "entity",
srcs = ["doc.go"],
importpath = "github.com/uber/submitqueue/stovepipe/entity",
visibility = ["//visibility:public"],
)
16 changes: 16 additions & 0 deletions stovepipe/entity/doc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
// Copyright (c) 2025 Uber Technologies, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Package entity holds Stovepipe-specific domain types (distinct from shared repo entity/).
package entity
8 changes: 8 additions & 0 deletions stovepipe/extension/BUILD.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
load("@rules_go//go:def.bzl", "go_library")

go_library(
name = "extension",
srcs = ["doc.go"],
importpath = "github.com/uber/submitqueue/stovepipe/extension",
visibility = ["//visibility:public"],
)
16 changes: 16 additions & 0 deletions stovepipe/extension/doc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
// Copyright (c) 2025 Uber Technologies, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Package extension holds Stovepipe-specific extension implementations.
package extension
6 changes: 3 additions & 3 deletions stovepipe/controller/BUILD.bazel → stovepipe/gateway/controller/BUILD.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ load("@rules_go//go:def.bzl", "go_library", "go_test")
go_library(
name = "controller",
srcs = ["ping.go"],
importpath = "github.com/uber/submitqueue/stovepipe/controller",
importpath = "github.com/uber/submitqueue/stovepipe/gateway/controller",
visibility = ["//visibility:public"],
deps = [
"//core/metrics",
"//stovepipe/protopb",
"//stovepipe/gateway/protopb",
"@com_github_uber_go_tally_v4//:tally",
"@org_uber_go_zap//:zap",
],
Expand All @@ -18,7 +18,7 @@ go_test(
srcs = ["ping_test.go"],
embed = [":controller"],
deps = [
"//stovepipe/protopb",
"//stovepipe/gateway/protopb",
"@com_github_stretchr_testify//assert",
"@com_github_stretchr_testify//require",
"@com_github_uber_go_tally_v4//:tally",
Expand Down
2 changes: 1 addition & 1 deletion stovepipe/controller/ping.go → stovepipe/gateway/controller/ping.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import (

"github.com/uber-go/tally/v4"
"github.com/uber/submitqueue/core/metrics"
pb "github.com/uber/submitqueue/stovepipe/protopb"
pb "github.com/uber/submitqueue/stovepipe/gateway/protopb"
"go.uber.org/zap"
)

Expand Down
2 changes: 1 addition & 1 deletion stovepipe/controller/ping_test.go → stovepipe/gateway/controller/ping_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import (
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/uber-go/tally/v4"
pb "github.com/uber/submitqueue/stovepipe/protopb"
pb "github.com/uber/submitqueue/stovepipe/gateway/protopb"
"go.uber.org/zap"
)

Expand Down
11 changes: 2 additions & 9 deletions stovepipe/proto/BUILD.bazel → stovepipe/gateway/proto/BUILD.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,14 @@ go_proto_library(
"@rules_go//proto:go_proto",
"@rules_go//proto:go_grpc_v2",
],
importpath = "github.com/uber/submitqueue/stovepipe/proto",
importpath = "github.com/uber/submitqueue/stovepipe/gateway/proto",
proto = ":stovepipepb_proto",
visibility = ["//visibility:public"],
)

go_library(
name = "proto",
embed = [":stovepipepb_go_proto"],
importpath = "github.com/uber/submitqueue/stovepipe/proto",
visibility = ["//visibility:public"],
)

go_library(
name = "protopb",
embed = [":stovepipepb_go_proto"],
importpath = "github.com/uber/submitqueue/stovepipe/protopb",
importpath = "github.com/uber/submitqueue/stovepipe/gateway/protopb",
visibility = ["//visibility:public"],
)
2 changes: 1 addition & 1 deletion stovepipe/proto/stovepipe.proto → stovepipe/gateway/proto/stovepipe.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ syntax = "proto3";

package uber.submitqueue.stovepipe;

option go_package = "github.com/uber/submitqueue/stovepipe/protopb";
option go_package = "github.com/uber/submitqueue/stovepipe/gateway/protopb";
option java_multiple_files = true;
option java_outer_classname = "StovepipeProto";
option java_package = "com.uber.submitqueue.stovepipe";
Expand Down
11 changes: 1 addition & 10 deletions stovepipe/protopb/BUILD.bazel → stovepipe/gateway/protopb/BUILD.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,15 @@ go_library(
name = "protopb",
srcs = [
"stovepipe.pb.go",
"stovepipe.pb.yarpc.go",
"stovepipe_grpc.pb.go",
],
importpath = "github.com/uber/submitqueue/stovepipe/protopb",
importpath = "github.com/uber/submitqueue/stovepipe/gateway/protopb",
visibility = ["//visibility:public"],
deps = [
"@com_github_gogo_protobuf//jsonpb",
"@com_github_gogo_protobuf//proto",
"@org_golang_google_grpc//:grpc",
"@org_golang_google_grpc//codes",
"@org_golang_google_grpc//status",
"@org_golang_google_protobuf//reflect/protoreflect",
"@org_golang_google_protobuf//runtime/protoimpl",
"@org_uber_go_fx//:fx",
"@org_uber_go_yarpc//:yarpc",
"@org_uber_go_yarpc//api/transport",
"@org_uber_go_yarpc//api/x/restriction",
"@org_uber_go_yarpc//encoding/protobuf",
"@org_uber_go_yarpc//encoding/protobuf/reflection",
],
)
Loading
Loading