Skip to content

Commit

Permalink
refactor(runners): runner <-> server comminication protocol
Browse files Browse the repository at this point in the history
  • Loading branch information
@fiftin
fiftin committed Sep 29, 2024
1 parent 859cfea commit 1ce8dd0
Show file tree
Hide file tree
Showing 7 changed files with 79 additions and 90 deletions.
6 changes: 3 additions & 3 deletions api/router.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,9 @@ func Route() *mux.Router {

runnersAPI := internalAPI.PathPrefix("/runners").Subrouter()
runnersAPI.Use(runners.RunnerMiddleware)
runnersAPI.Path("/{runner_id}").HandlerFunc(runners.GetRunner).Methods("GET", "HEAD")
runnersAPI.Path("/{runner_id}").HandlerFunc(runners.UpdateRunner).Methods("PUT")
runnersAPI.Path("/{runner_id}").HandlerFunc(runners.UnregisterRunner).Methods("DELETE")
runnersAPI.Path("/").HandlerFunc(runners.GetRunner).Methods("GET", "HEAD")
runnersAPI.Path("/").HandlerFunc(runners.UpdateRunner).Methods("PUT")
runnersAPI.Path("/").HandlerFunc(runners.UnregisterRunner).Methods("DELETE")

publicWebHookRouter := r.PathPrefix(webPath + "api").Subrouter()
publicWebHookRouter.Use(StoreMiddleware, JSONMiddleware)
Expand Down
7 changes: 4 additions & 3 deletions api/runners/runners.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -199,11 +199,12 @@ func RegisterRunner(w http.ResponseWriter, r *http.Request) {
return
}

res := util.RunnerConfig{
RunnerID: runner.ID,
Token: runner.Token,
var res struct {
Token string `json:"token"`
}

res.Token = runner.Token

helpers.WriteJSON(w, http.StatusOK, res)
}

Expand Down
1 change: 1 addition & 0 deletions db/Store.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,7 @@ type Store interface {
GetRunner(projectID int, runnerID int) (Runner, error)
GetRunners(projectID int) ([]Runner, error)
DeleteRunner(projectID int, runnerID int) error
GetGlobalRunnerByToken(token string) (Runner, error)
GetGlobalRunner(runnerID int) (Runner, error)
GetGlobalRunners(activeOnly bool) ([]Runner, error)
DeleteGlobalRunner(runnerID int) error
Expand Down
22 changes: 22 additions & 0 deletions db/bolt/runner.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,28 @@ func (d *BoltDb) DeleteRunner(projectID int, runnerID int) (err error) {
return
}

func (d *BoltDb) GetGlobalRunnerByToken(token string) (runner db.Runner, err error) {

runners := make([]db.Runner, 0)

err = d.getObjects(0, db.GlobalRunnerProps, db.RetrieveQueryParams{}, func(i interface{}) bool {
r := i.(db.Runner)
return r.Token == token
}, &runners)

if err != nil {
return
}

if len(runners) == 0 {
err = db.ErrNotFound
return
}

runner = runners[0]
return
}

func (d *BoltDb) GetGlobalRunner(runnerID int) (runner db.Runner, err error) {
err = d.getObject(0, db.GlobalRunnerProps, intObjectID(runnerID), &runner)

Expand Down
21 changes: 21 additions & 0 deletions db/sql/runner.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,27 @@ func (d *SqlDb) DeleteRunner(projectID int, runnerID int) (err error) {
return
}

func (d *SqlDb) GetGlobalRunnerByToken(token string) (runner db.Runner, err error) {

runners := make([]db.Runner, 0)

err = d.getObjects(0, db.GlobalRunnerProps, db.RetrieveQueryParams{}, func(builder squirrel.SelectBuilder) squirrel.SelectBuilder {
return builder.Where("token=?", token)
}, &runners)

if err != nil {
return
}

if len(runners) == 0 {
err = db.ErrNotFound
return
}

runner = runners[0]
return
}

func (d *SqlDb) GetGlobalRunner(runnerID int) (runner db.Runner, err error) {
err = d.getObject(0, db.GlobalRunnerProps, runnerID, &runner)
return
Expand Down
60 changes: 28 additions & 32 deletions services/runners/job_pool.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ type JobPool struct {

queue []*job

config *util.RunnerConfig
token *string

processing int32
}
Expand All @@ -56,13 +56,7 @@ func (p *JobPool) hasRunningJobs() bool {

func (p *JobPool) Unregister() (err error) {

config, err := util.LoadRunnerSettings(util.Config.Runner.ConfigFile)

if err != nil {
return
}

if config.Token == "" {
if util.Config.Runner.Token == "" {
return fmt.Errorf("runner is not registered")
}

Expand All @@ -85,9 +79,8 @@ func (p *JobPool) Unregister() (err error) {
return
}

err = os.Remove(util.Config.Runner.ConfigFile)
if err != nil {
return
if util.Config.Runner.TokenFile != "" {
err = os.Remove(util.Config.Runner.TokenFile)
}

return
Expand Down Expand Up @@ -190,7 +183,7 @@ func (p *JobPool) sendProgress() {

client := &http.Client{}

url := util.Config.Runner.ApiURL + "/runners/" + strconv.Itoa(p.config.RunnerID)
url := util.Config.Runner.ApiURL + "/runners/" + *p.token

body := RunnerProgress{
Jobs: nil,
Expand Down Expand Up @@ -220,7 +213,7 @@ func (p *JobPool) sendProgress() {
return
}

req.Header.Set("X-Runner-Token", p.config.Token)
req.Header.Set("X-Runner-Token", *p.token)

resp, err := client.Do(req)
if err != nil {
Expand All @@ -232,20 +225,20 @@ func (p *JobPool) sendProgress() {
}

func (p *JobPool) tryRegisterRunner() bool {
if p.config != nil {
if p.token != nil {
return true
}

log.Info("Attempting to register on the server")

config, err := util.LoadRunnerSettings(util.Config.Runner.ConfigFile)

if err != nil {
panic(err)
}
//config, err := util.LoadRunnerSettings(util.Config.Runner.ConfigFile)
//
//if err != nil {
// panic(err)
//}

if config.Token != "" {
p.config = &config
if util.Config.Runner.Token != "" {
p.token = &util.Config.Runner.Token
return true
}

Expand Down Expand Up @@ -285,21 +278,19 @@ func (p *JobPool) tryRegisterRunner() bool {
return false
}

err = json.Unmarshal(body, &config)
if err != nil {
fmt.Println("Error parsing JSON:", err)
return false
var res struct {
Token string `json:"token"`
}

configBytes, err := json.Marshal(config)

err = json.Unmarshal(body, &res)
if err != nil {
panic("cannot save runner config")
fmt.Println("Error parsing JSON:", err)
return false
}

err = os.WriteFile(util.Config.Runner.ConfigFile, configBytes, 0644)
err = os.WriteFile(util.Config.Runner.TokenFile, []byte(res.Token), 0644)

p.config = &config
p.token = &res.Token

defer resp.Body.Close()

Expand All @@ -309,13 +300,18 @@ func (p *JobPool) tryRegisterRunner() bool {
// checkNewJobs tries to find runner to queued jobs
func (p *JobPool) checkNewJobs() {

if p.token == nil {
fmt.Println("Error creating request:", "no token provided")
return
}

client := &http.Client{}

url := util.Config.Runner.ApiURL + "/runners/" + strconv.Itoa(p.config.RunnerID)
url := util.Config.Runner.ApiURL + "/runners/" + *p.token

req, err := http.NewRequest("GET", url, nil)

req.Header.Set("X-Runner-Token", p.config.Token)
req.Header.Set("X-Runner-Token", *p.token)

if err != nil {
fmt.Println("Error creating request:", err)
Expand Down
52 changes: 0 additions & 52 deletions util/config.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,19 +91,10 @@ const (
//
// */

// Deprecated
type RunnerConfig struct {
RunnerID int `json:"runner_id" env:"SEMAPHORE_RUNNER_ID"`
Token string `json:"token" env:"SEMAPHORE_RUNNER_TOKEN"`
}

type RunnerSettings struct {
ApiURL string `json:"api_url" env:"SEMAPHORE_RUNNER_API_URL"`
RegistrationToken string `json:"registration_token" env:"SEMAPHORE_RUNNER_REGISTRATION_TOKEN"`

// Deprecated
ConfigFile string `json:"config_file" env:"SEMAPHORE_RUNNER_CONFIG_FILE"`

Token string `json:"token" env:"SEMAPHORE_RUNNER_TOKEN"`
TokenFile string `json:"token_file" env:"SEMAPHORE_RUNNER_TOKEN_FILE"`

Expand Down Expand Up @@ -219,49 +210,6 @@ func (conf *ConfigType) ToJSON() ([]byte, error) {
return json.MarshalIndent(&conf, " ", "\t")
}

func LoadRunnerSettings(path string) (config RunnerConfig, err error) {
configFileExists := false

if path != "" {
_, err = os.Stat(path)

if os.IsNotExist(err) {
configFileExists = false
} else if err != nil {
return
} else {
configFileExists = true
}
}

if configFileExists {

var configBytes []byte
configBytes, err = os.ReadFile(path)

if err != nil {
return
}

err = json.Unmarshal(configBytes, &config)

if err != nil {
return
}

}

err = loadEnvironmentToObject(&config)

if err != nil {
return
}

err = loadDefaultsToObject(&config)

return
}

// ConfigInit reads in cli flags, and switches actions appropriately on them
func ConfigInit(configPath string, noConfigFile bool) {
fmt.Println("Loading config")
Expand Down

0 comments on commit 1ce8dd0

Please sign in to comment.