refactor: job url propagation (#963)

saucelabs · Oct 30, 2024 · 66860b8 · 66860b8
1 parent bda17a8
commit 66860b8
Show file tree

Hide file tree

Showing 24 changed files with 254 additions and 168 deletions.
diff --git a/internal/cmd/artifacts/cmd.go b/internal/cmd/artifacts/cmd.go
@@ -46,10 +46,10 @@ func Command(preRun func(cmd *cobra.Command, args []string)) *cobra.Command {
 			artifactSvc = ArtifactService{
 				JobService: saucecloud.JobService{
 					Resto: http.NewResto(
-						url, creds.Username, creds.AccessKey, restoTimeout,
+						reg, creds.Username, creds.AccessKey, restoTimeout,
 					),
 					RDC: http.NewRDCService(
-						url, creds.Username, creds.AccessKey, rdcTimeout,
+						reg, creds.Username, creds.AccessKey, rdcTimeout,
 					),
 					TestComposer: http.NewTestComposer(
 						url, creds, testComposerTimeout,

diff --git a/internal/cmd/ini/initializer.go b/internal/cmd/ini/initializer.go
@@ -59,8 +59,8 @@ type initializer struct {
 func newInitializer(stdio terminal.Stdio, creds iam.Credentials, cfg *initConfig) *initializer {
 	r := region.FromString(cfg.region)
 	tc := http.NewTestComposer(r.APIBaseURL(), creds, testComposerTimeout)
-	rc := http.NewRDCService(r.APIBaseURL(), creds.Username, creds.AccessKey, rdcTimeout)
-	rs := http.NewResto(r.APIBaseURL(), creds.Username, creds.AccessKey, restoTimeout)
+	rc := http.NewRDCService(r, creds.Username, creds.AccessKey, rdcTimeout)
+	rs := http.NewResto(r, creds.Username, creds.AccessKey, restoTimeout)
 	us := http.NewUserService(r.APIBaseURL(), creds, 5*time.Second)
 
 	return &initializer{

diff --git a/internal/cmd/run/apitest.go b/internal/cmd/run/apitest.go
@@ -40,7 +40,7 @@ func runApitest(cmd *cobra.Command, isCLIDriven bool) (int, error) {
 	creds := regio.Credentials()
 
 	apitestingClient := http.NewAPITester(regio.APIBaseURL(), creds.Username, creds.AccessKey, apitestingTimeout)
-	restoClient := http.NewResto(regio.APIBaseURL(), creds.Username, creds.AccessKey, 0)
+	restoClient := http.NewResto(regio, creds.Username, creds.AccessKey, 0)
 
 	r := apitest.Runner{
 		Project: p,

diff --git a/internal/cmd/run/cucumber.go b/internal/cmd/run/cucumber.go
@@ -115,11 +115,11 @@ func runCucumber(cmd *cobra.Command, isCLIDriven bool) (int, error) {
 
 	creds := regio.Credentials()
 
-	restoClient := http.NewResto(regio.APIBaseURL(), creds.Username, creds.AccessKey, 0)
+	restoClient := http.NewResto(regio, creds.Username, creds.AccessKey, 0)
 	testcompClient := http.NewTestComposer(regio.APIBaseURL(), creds, testComposerTimeout)
-	webdriverClient := http.NewWebdriver(regio.WebDriverBaseURL(), creds, webdriverTimeout)
+	webdriverClient := http.NewWebdriver(regio, creds, webdriverTimeout)
 	appsClient := *http.NewAppStore(regio.APIBaseURL(), creds.Username, creds.AccessKey, gFlags.appStoreTimeout)
-	rdcClient := http.NewRDCService(regio.APIBaseURL(), creds.Username, creds.AccessKey, rdcTimeout)
+	rdcClient := http.NewRDCService(regio, creds.Username, creds.AccessKey, rdcTimeout)
 	insightsClient := http.NewInsightsService(regio.APIBaseURL(), creds, insightsTimeout)
 	iamClient := http.NewUserService(regio.APIBaseURL(), creds, iamTimeout)
 	jobService := saucecloud.JobService{

diff --git a/internal/cmd/run/cypress.go b/internal/cmd/run/cypress.go
@@ -150,11 +150,11 @@ func runCypress(cmd *cobra.Command, cflags cypressFlags, isCLIDriven bool) (int,
 
 	creds := regio.Credentials()
 
-	restoClient := http.NewResto(regio.APIBaseURL(), creds.Username, creds.AccessKey, 0)
+	restoClient := http.NewResto(regio, creds.Username, creds.AccessKey, 0)
 	testcompClient := http.NewTestComposer(regio.APIBaseURL(), creds, testComposerTimeout)
-	webdriverClient := http.NewWebdriver(regio.WebDriverBaseURL(), creds, webdriverTimeout)
+	webdriverClient := http.NewWebdriver(regio, creds, webdriverTimeout)
 	appsClient := *http.NewAppStore(regio.APIBaseURL(), creds.Username, creds.AccessKey, gFlags.appStoreTimeout)
-	rdcClient := http.NewRDCService(regio.APIBaseURL(), creds.Username, creds.AccessKey, rdcTimeout)
+	rdcClient := http.NewRDCService(regio, creds.Username, creds.AccessKey, rdcTimeout)
 	insightsClient := http.NewInsightsService(regio.APIBaseURL(), creds, insightsTimeout)
 	iamClient := http.NewUserService(regio.APIBaseURL(), creds, iamTimeout)
 	jobService := saucecloud.JobService{

diff --git a/internal/cmd/run/espresso.go b/internal/cmd/run/espresso.go
@@ -136,11 +136,11 @@ func runEspressoInCloud(p espresso.Project, regio region.Region) (int, error) {
 	log.Info().Msg("Running Espresso in Sauce Labs")
 
 	creds := regio.Credentials()
-	restoClient := http.NewResto(regio.APIBaseURL(), creds.Username, creds.AccessKey, 0)
+	restoClient := http.NewResto(regio, creds.Username, creds.AccessKey, 0)
 	testcompClient := http.NewTestComposer(regio.APIBaseURL(), creds, testComposerTimeout)
-	webdriverClient := http.NewWebdriver(regio.WebDriverBaseURL(), creds, webdriverTimeout)
+	webdriverClient := http.NewWebdriver(regio, creds, webdriverTimeout)
 	appsClient := *http.NewAppStore(regio.APIBaseURL(), creds.Username, creds.AccessKey, gFlags.appStoreTimeout)
-	rdcClient := http.NewRDCService(regio.APIBaseURL(), creds.Username, creds.AccessKey, rdcTimeout)
+	rdcClient := http.NewRDCService(regio, creds.Username, creds.AccessKey, rdcTimeout)
 	insightsClient := http.NewInsightsService(regio.APIBaseURL(), creds, insightsTimeout)
 	iamClient := http.NewUserService(regio.APIBaseURL(), creds, iamTimeout)
 	jobService := saucecloud.JobService{

diff --git a/internal/cmd/run/imagerunner.go b/internal/cmd/run/imagerunner.go
@@ -73,7 +73,7 @@ func runImageRunner(cmd *cobra.Command) (int, error) {
 	}
 
 	imageRunnerClient := http.NewImageRunner(regio.APIBaseURL(), creds, imgExecTimeout, asyncEventManager)
-	restoClient := http.NewResto(regio.APIBaseURL(), creds.Username, creds.AccessKey, 0)
+	restoClient := http.NewResto(regio, creds.Username, creds.AccessKey, 0)
 
 	r := saucecloud.NewImgRunner(p, &imageRunnerClient, &restoClient, asyncEventManager,
 		reporters, gFlags.async)

diff --git a/internal/cmd/run/playwright.go b/internal/cmd/run/playwright.go
@@ -161,11 +161,11 @@ func runPlaywright(cmd *cobra.Command, pf playwrightFlags, isCLIDriven bool) (in
 
 	creds := regio.Credentials()
 
-	restoClient := http.NewResto(regio.APIBaseURL(), creds.Username, creds.AccessKey, 0)
+	restoClient := http.NewResto(regio, creds.Username, creds.AccessKey, 0)
 	testcompClient := http.NewTestComposer(regio.APIBaseURL(), creds, testComposerTimeout)
-	webdriverClient := http.NewWebdriver(regio.WebDriverBaseURL(), creds, webdriverTimeout)
+	webdriverClient := http.NewWebdriver(regio, creds, webdriverTimeout)
 	appsClient := *http.NewAppStore(regio.APIBaseURL(), creds.Username, creds.AccessKey, gFlags.appStoreTimeout)
-	rdcClient := http.NewRDCService(regio.APIBaseURL(), creds.Username, creds.AccessKey, rdcTimeout)
+	rdcClient := http.NewRDCService(regio, creds.Username, creds.AccessKey, rdcTimeout)
 	insightsClient := http.NewInsightsService(regio.APIBaseURL(), creds, insightsTimeout)
 	iamClient := http.NewUserService(regio.APIBaseURL(), creds, iamTimeout)
 	jobService := saucecloud.JobService{

diff --git a/internal/cmd/run/replay.go b/internal/cmd/run/replay.go
@@ -124,11 +124,11 @@ func runPuppeteerReplayInSauce(p replay.Project, regio region.Region) (int, erro
 	log.Info().Msg("Replaying chrome devtools recordings")
 
 	creds := regio.Credentials()
-	restoClient := http.NewResto(regio.APIBaseURL(), creds.Username, creds.AccessKey, 0)
+	restoClient := http.NewResto(regio, creds.Username, creds.AccessKey, 0)
 	testcompClient := http.NewTestComposer(regio.APIBaseURL(), creds, testComposerTimeout)
-	webdriverClient := http.NewWebdriver(regio.WebDriverBaseURL(), creds, webdriverTimeout)
+	webdriverClient := http.NewWebdriver(regio, creds, webdriverTimeout)
 	appsClient := *http.NewAppStore(regio.APIBaseURL(), creds.Username, creds.AccessKey, gFlags.appStoreTimeout)
-	rdcClient := http.NewRDCService(regio.APIBaseURL(), creds.Username, creds.AccessKey, rdcTimeout)
+	rdcClient := http.NewRDCService(regio, creds.Username, creds.AccessKey, rdcTimeout)
 	insightsClient := http.NewInsightsService(regio.APIBaseURL(), creds, insightsTimeout)
 	iamClient := http.NewUserService(regio.APIBaseURL(), creds, iamTimeout)
 	buildService := http.NewBuildService(

diff --git a/internal/cmd/run/testcafe.go b/internal/cmd/run/testcafe.go
@@ -184,11 +184,11 @@ func runTestcafe(cmd *cobra.Command, tcFlags testcafeFlags, isCLIDriven bool) (i
 
 	creds := regio.Credentials()
 
-	restoClient := http.NewResto(regio.APIBaseURL(), creds.Username, creds.AccessKey, 0)
+	restoClient := http.NewResto(regio, creds.Username, creds.AccessKey, 0)
 	testcompClient := http.NewTestComposer(regio.APIBaseURL(), creds, testComposerTimeout)
-	webdriverClient := http.NewWebdriver(regio.WebDriverBaseURL(), creds, webdriverTimeout)
+	webdriverClient := http.NewWebdriver(regio, creds, webdriverTimeout)
 	appsClient := *http.NewAppStore(regio.APIBaseURL(), creds.Username, creds.AccessKey, gFlags.appStoreTimeout)
-	rdcClient := http.NewRDCService(regio.APIBaseURL(), creds.Username, creds.AccessKey, rdcTimeout)
+	rdcClient := http.NewRDCService(regio, creds.Username, creds.AccessKey, rdcTimeout)
 	insightsClient := http.NewInsightsService(regio.APIBaseURL(), creds, insightsTimeout)
 	iamClient := http.NewUserService(regio.APIBaseURL(), creds, iamTimeout)
 	jobService := saucecloud.JobService{

diff --git a/internal/cmd/run/xcuitest.go b/internal/cmd/run/xcuitest.go
@@ -137,11 +137,11 @@ func runXcuitestInCloud(p xcuitest.Project, regio region.Region) (int, error) {
 
 	creds := regio.Credentials()
 
-	restoClient := http.NewResto(regio.APIBaseURL(), creds.Username, creds.AccessKey, 0)
+	restoClient := http.NewResto(regio, creds.Username, creds.AccessKey, 0)
 	testcompClient := http.NewTestComposer(regio.APIBaseURL(), creds, testComposerTimeout)
-	webdriverClient := http.NewWebdriver(regio.WebDriverBaseURL(), creds, webdriverTimeout)
+	webdriverClient := http.NewWebdriver(regio, creds, webdriverTimeout)
 	appsClient := *http.NewAppStore(regio.APIBaseURL(), creds.Username, creds.AccessKey, gFlags.appStoreTimeout)
-	rdcClient := http.NewRDCService(regio.APIBaseURL(), creds.Username, creds.AccessKey, rdcTimeout)
+	rdcClient := http.NewRDCService(regio, creds.Username, creds.AccessKey, rdcTimeout)
 	insightsClient := http.NewInsightsService(regio.APIBaseURL(), creds, insightsTimeout)
 	iamClient := http.NewUserService(regio.APIBaseURL(), creds, iamTimeout)
 	jobService := saucecloud.JobService{

diff --git a/internal/http/client.go b/internal/http/client.go
@@ -23,7 +23,7 @@ func NewRetryableClient(timeout time.Duration) *retryablehttp.Client {
 			if e != nil {
 				return ok, e
 			}
-			if !ok && resp.StatusCode == http.StatusNotFound {
+			if !ok && resp != nil && resp.StatusCode == http.StatusNotFound {
 				return true, nil
 			}
 			return ok, e

diff --git a/internal/http/rdcservice.go b/internal/http/rdcservice.go
@@ -11,6 +11,7 @@ import (
 	"strings"
 	"time"
 
+	"github.com/saucelabs/saucectl/internal/region"
 	"github.com/saucelabs/saucectl/internal/slice"
 
 	"github.com/hashicorp/go-retryablehttp"
@@ -24,6 +25,7 @@ import (
 // RDCService http client.
 type RDCService struct {
 	Client    *retryablehttp.Client
+	AppURL    string
 	URL       string
 	Username  string
 	AccessKey string
@@ -83,17 +85,18 @@ type DeviceQuery struct {
 }
 
 // NewRDCService creates a new client.
-func NewRDCService(url, username, accessKey string, timeout time.Duration) RDCService {
+func NewRDCService(r region.Region, username, accessKey string, timeout time.Duration) RDCService {
 	return RDCService{
 		Client:    NewRetryableClient(timeout),
-		URL:       url,
+		AppURL:    r.AppBaseURL(),
+		URL:       r.APIBaseURL(),
 		Username:  username,
 		AccessKey: accessKey,
 	}
 }
 
 // StartJob creates a new job in Sauce Labs.
-func (c *RDCService) StartJob(ctx context.Context, opts job.StartOptions) (jobID string, err error) {
+func (c *RDCService) StartJob(ctx context.Context, opts job.StartOptions) (job.Job, error) {
 	url := fmt.Sprintf("%s/v1/rdc/native-composer/tests", c.URL)
 
 	var frameworkName string
@@ -129,31 +132,31 @@ func (c *RDCService) StartJob(ctx context.Context, opts job.StartOptions) (jobID
 	}
 
 	var b bytes.Buffer
-	err = json.NewEncoder(&b).Encode(jobReq)
+	err := json.NewEncoder(&b).Encode(jobReq)
 	if err != nil {
-		return
+		return job.Job{}, err
 	}
 
 	req, err := NewRequestWithContext(ctx, http.MethodPost, url, &b)
 	if err != nil {
-		return
+		return job.Job{}, err
 	}
 	req.Header.Set("Content-Type", "application/json")
 	req.SetBasicAuth(c.Username, c.AccessKey)
 
 	resp, err := c.Client.HTTPClient.Do(req)
 	if err != nil {
-		return
+		return job.Job{}, err
 	}
 	defer resp.Body.Close()
 	body, err := io.ReadAll(resp.Body)
 	if err != nil {
-		return
+		return job.Job{}, err
 	}
 
 	if resp.StatusCode >= 300 {
 		err = fmt.Errorf("job start failed; unexpected response code:'%d', msg:'%v'", resp.StatusCode, strings.TrimSpace(string(body)))
-		return "", err
+		return job.Job{}, err
 	}
 
 	var sessionStart struct {
@@ -162,10 +165,15 @@ func (c *RDCService) StartJob(ctx context.Context, opts job.StartOptions) (jobID
 		} `json:"test_report"`
 	}
 	if err = json.Unmarshal(body, &sessionStart); err != nil {
-		return "", fmt.Errorf("job start status unknown: unable to parse server response: %w", err)
+		return job.Job{}, fmt.Errorf("job start status unknown: unable to parse server response: %w", err)
 	}
 
-	return sessionStart.TestReport.ID, nil
+	return job.Job{
+		ID:     sessionStart.TestReport.ID,
+		IsRDC:  true,
+		Status: job.StateQueued,
+		URL:    fmt.Sprintf("%s/tests/%s", c.AppURL, sessionStart.TestReport.ID),
+	}, nil
 }
 
 func (c *RDCService) StopJob(ctx context.Context, id string, realDevice bool) (job.Job, error) {
@@ -201,7 +209,11 @@ func (c *RDCService) StopJob(ctx context.Context, id string, realDevice bool) (j
 	}
 
 	// RDC does not return any job details in the response.
-	return job.Job{}, nil
+	return job.Job{
+		ID:     id,
+		Status: job.StateInProgress,
+		URL:    fmt.Sprintf("%s/tests/%s", c.AppURL, id),
+	}, nil
 }
 
 // Job returns the job details.
@@ -485,5 +497,6 @@ func (c *RDCService) parseJob(body io.ReadCloser) (job.Job, error) {
 		OS:         j.OS,
 		OSVersion:  j.OSVersion,
 		IsRDC:      true,
+		URL:        fmt.Sprintf("%s/tests/%s", c.AppURL, j.ID),
 	}, err
 }