Report conflicted OTA requests (#151)

rjtokenring · web-flow · commit 01df93b5103c · 2024-05-06T09:01:03.000+02:00
* Print conflicted OTA in report

* Refactored print error
diff --git a/command/ota/upload.go b/command/ota/upload.go
@@ -19,6 +19,7 @@ package ota
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"os"
 	"path/filepath"
@@ -101,17 +102,33 @@ func Upload(ctx context.Context, params *UploadParams, cred *config.Credentials)
 		expiration = otaDeferredExpirationMins
 	}
 
+	var conflictedOta *otaapi.Ota
 	err = iotClient.DeviceOTA(ctx, params.DeviceID, file, expiration)
 	if err != nil {
-		return err
+		if errors.Is(err, iot.ErrOtaAlreadyInProgress) {
+			conflictedOta = &otaapi.Ota{
+				DeviceID:    params.DeviceID,
+				Status:      "Skipped",
+				ErrorReason: "OTA already in progress",
+			}
+		} else {
+			return err
+		}
 	}
 	// Try to get ota-id from API
 	otaID, err := otapi.GetOtaLastStatusByDeviceID(params.DeviceID)
 	if err != nil {
 		return err
 	}
 	if otaID != nil && len(otaID.Ota) > 0 {
-		feedback.PrintResult(otaID.Ota[0])
+		if conflictedOta != nil {
+			toPrint := otaapi.OtaStatusList{
+				Ota: []otaapi.Ota{*conflictedOta, otaID.Ota[0]},
+			}
+			feedback.PrintResult(toPrint)
+		} else {
+			feedback.PrintResult(otaID.Ota[0])
+		}
 	}
 
 	return nil
diff --git a/internal/iot/client.go b/internal/iot/client.go
@@ -28,6 +28,8 @@ import (
 	"golang.org/x/oauth2"
 )
 
+var ErrOtaAlreadyInProgress = fmt.Errorf("ota already in progress")
+
 // Client can perform actions on Arduino IoT Cloud.
 type Client struct {
 	api   *iotclient.APIClient
@@ -196,9 +198,12 @@ func (cl *Client) DeviceOTA(ctx context.Context, id string, file *os.File, expir
 		Async:        optional.NewBool(true),
 	}
 	resp, err := cl.api.DevicesV2OtaApi.DevicesV2OtaUpload(ctx, id, file, opt)
-	if err != nil && resp.StatusCode != 409 { // 409 (Conflict) is the status code for an already existing OTA for the same SHA/device, so ignoring it.
-		err = fmt.Errorf("uploading device ota: %w", errorDetail(err))
-		return err
+	if err != nil {
+		// 409 (Conflict) is the status code for an already existing OTA in progress for the same device. Handling it in a different way.
+		if resp.StatusCode == 409 {
+			return ErrOtaAlreadyInProgress
+		}
+		return fmt.Errorf("uploading device ota: %w", errorDetail(err))
 	}
 	return nil
 }

Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,8 @@ import (`
`28`	`28`	`"golang.org/x/oauth2"`
`29`	`29`	`)`
`30`	`30`
	`31`	`+var ErrOtaAlreadyInProgress = fmt.Errorf("ota already in progress")`
	`32`	`+`
`31`	`33`	`// Client can perform actions on Arduino IoT Cloud.`
`32`	`34`	`type Client struct {`
`33`	`35`	`api *iotclient.APIClient`
`@@ -196,9 +198,12 @@ func (cl Client) DeviceOTA(ctx context.Context, id string, file os.File, expir`
`196`	`198`	`Async: optional.NewBool(true),`
`197`	`199`	`}`
`198`	`200`	`resp, err := cl.api.DevicesV2OtaApi.DevicesV2OtaUpload(ctx, id, file, opt)`
`199`		`- if err != nil && resp.StatusCode != 409 { // 409 (Conflict) is the status code for an already existing OTA for the same SHA/device, so ignoring it.`
`200`		`- err = fmt.Errorf("uploading device ota: %w", errorDetail(err))`
`201`		`- return err`
	`201`	`+ if err != nil {`
	`202`	`+ // 409 (Conflict) is the status code for an already existing OTA in progress for the same device. Handling it in a different way.`
	`203`	`+ if resp.StatusCode == 409 {`
	`204`	`+ return ErrOtaAlreadyInProgress`
	`205`	`+ }`
	`206`	`+ return fmt.Errorf("uploading device ota: %w", errorDetail(err))`
`202`	`207`	`}`
`203`	`208`	`return nil`
`204`	`209`	`}`