-
Notifications
You must be signed in to change notification settings - Fork 2
[2/N] feat(runway): add Merger extension interface, mock, and noop impl #250
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.
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
Open
kevinlnew
wants to merge
2
commits into
runway/rfc
Choose a base branch
from
runway/vcs-extension
base: runway/rfc
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 = ["extension.go"], | ||
| importpath = "github.com/uber/submitqueue/runway/extension", | ||
| visibility = ["//visibility:public"], | ||
| ) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 Runway-specific extension implementations. | ||
| package extension |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| load("@rules_go//go:def.bzl", "go_library") | ||
|
|
||
| go_library( | ||
| name = "merger", | ||
| srcs = ["merger.go"], | ||
| importpath = "github.com/uber/submitqueue/runway/extension/merger", | ||
| visibility = ["//visibility:public"], | ||
| deps = ["//api/runway/messagequeue"], | ||
| ) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| // 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 merger defines the pluggable interface for version-control merge | ||
| // operations that Runway performs on behalf of its callers. Implementations | ||
| // resolve change URIs, apply changes to a target branch, and (for a committing | ||
| // merge) push the result and finalize the change lifecycle (e.g. close PRs). | ||
| package merger | ||
|
|
||
| //go:generate mockgen -source=merger.go -destination=mock/merger_mock.go -package=mock | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
|
|
||
| runwaymq "github.com/uber/submitqueue/api/runway/messagequeue" | ||
| ) | ||
|
|
||
| // ErrConflict signals that the ordered steps could not be applied cleanly. | ||
| // Controllers treat this as an expected outcome (ack + publish a failure | ||
| // result), not an infrastructure error. | ||
| var ErrConflict = errors.New("merge conflict") | ||
|
|
||
| // Merger performs version-control operations against a single landing target. | ||
| // Both methods accept the same MergeRequest payload; the behavioral difference | ||
| // is whether the result is committed to the remote. | ||
| type Merger interface { | ||
| // CheckMergeability performs a dry-run merge without committing. The | ||
| // returned MergeResult reports per-step mergeability; Outputs are empty. | ||
| CheckMergeability(ctx context.Context, req *runwaymq.MergeRequest) (*runwaymq.MergeResult, error) | ||
| // Merge applies the ordered steps, commits the result to the remote, and | ||
| // reports per-step Outputs (the VCS-neutral revision identifiers produced). | ||
| Merge(ctx context.Context, req *runwaymq.MergeRequest) (*runwaymq.MergeResult, error) | ||
| } | ||
|
|
||
| // Config identifies the landing target a Merger instance operates on. The factory | ||
| // resolves deployment-specific details (remote URL, credentials) from this. | ||
| type Config struct { | ||
| // QueueName is the caller-provided queue name from the MergeRequest. | ||
| QueueName string | ||
| } | ||
|
|
||
| // Factory creates Merger instances bound to a landing target. | ||
| type Factory interface { | ||
| // For returns a Merger instance configured for the given landing target. | ||
| For(cfg Config) (Merger, error) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| load("@rules_go//go:def.bzl", "go_library") | ||
|
|
||
| go_library( | ||
| name = "mock", | ||
| srcs = ["merger_mock.go"], | ||
| importpath = "github.com/uber/submitqueue/runway/extension/merger/mock", | ||
| visibility = ["//visibility:public"], | ||
| deps = [ | ||
| "//api/runway/messagequeue", | ||
| "//runway/extension/merger", | ||
| "@org_uber_go_mock//gomock", | ||
| ], | ||
| ) |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| load("@rules_go//go:def.bzl", "go_library", "go_test") | ||
|
|
||
| go_library( | ||
| name = "noop", | ||
| srcs = ["noop.go"], | ||
| importpath = "github.com/uber/submitqueue/runway/extension/merger/noop", | ||
| visibility = ["//visibility:public"], | ||
| deps = [ | ||
| "//api/runway/messagequeue", | ||
| "//api/runway/messagequeue/protopb", | ||
| "//runway/extension/merger", | ||
| ], | ||
| ) | ||
|
|
||
| go_test( | ||
| name = "noop_test", | ||
| srcs = ["noop_test.go"], | ||
| embed = [":noop"], | ||
| deps = [ | ||
| "//api/base/change/protopb", | ||
| "//api/base/mergestrategy/protopb", | ||
| "//api/runway/messagequeue", | ||
| "//api/runway/messagequeue/protopb", | ||
| "@com_github_stretchr_testify//assert", | ||
| "@com_github_stretchr_testify//require", | ||
| ], | ||
| ) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| // 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 noop provides a no-op Merger implementation for local development and | ||
| // testing. CheckMergeability always reports success; Merge produces synthetic | ||
| // output IDs from an atomic counter. | ||
| package noop | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "sync/atomic" | ||
|
|
||
| runwaymq "github.com/uber/submitqueue/api/runway/messagequeue" | ||
| runwaypb "github.com/uber/submitqueue/api/runway/messagequeue/protopb" | ||
| "github.com/uber/submitqueue/runway/extension/merger" | ||
| ) | ||
|
|
||
| var _ merger.Merger = (*Merger)(nil) | ||
|
|
||
| // Merger is a no-op implementation that always succeeds. | ||
| type Merger struct { | ||
| seq atomic.Uint64 | ||
| } | ||
|
|
||
| // New returns a new no-op Merger instance. | ||
| func New() *Merger { return &Merger{} } | ||
|
|
||
| func (v *Merger) CheckMergeability(_ context.Context, req *runwaymq.MergeRequest) (*runwaymq.MergeResult, error) { | ||
| steps := make([]*runwaymq.StepResult, len(req.GetSteps())) | ||
| for i, s := range req.GetSteps() { | ||
| steps[i] = &runwaymq.StepResult{StepId: s.GetStepId()} | ||
| } | ||
| return &runwaymq.MergeResult{ | ||
| Id: req.GetId(), | ||
| Outcome: runwaypb.Outcome_SUCCEEDED, | ||
| Steps: steps, | ||
| }, nil | ||
| } | ||
|
|
||
| func (v *Merger) Merge(_ context.Context, req *runwaymq.MergeRequest) (*runwaymq.MergeResult, error) { | ||
| steps := make([]*runwaymq.StepResult, len(req.GetSteps())) | ||
| for i, s := range req.GetSteps() { | ||
| n := v.seq.Add(1) | ||
| steps[i] = &runwaymq.StepResult{ | ||
| StepId: s.GetStepId(), | ||
| Outputs: []*runwaymq.StepOutput{ | ||
| {Id: fmt.Sprintf("%040x", n)}, | ||
| }, | ||
| } | ||
| } | ||
| return &runwaymq.MergeResult{ | ||
| Id: req.GetId(), | ||
| Outcome: runwaypb.Outcome_SUCCEEDED, | ||
| Steps: steps, | ||
| }, nil | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lets rename the file and folder as well