remove some invalid usage of the old FriendlyError function with equinix-sdk-go errors

Author: ctreatma

internal/resources/metal/device/helpers.go

@@ -12,8 +12,6 @@ import (
 
 	"github.com/equinix/terraform-provider-equinix/internal/converters"
 
-	equinix_errors "github.com/equinix/terraform-provider-equinix/internal/errors"
-
 	"github.com/equinix/equinix-sdk-go/services/metalv1"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/retry"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
@@ -120,7 +118,6 @@ func hwReservationStateRefreshFunc(ctx context.Context, client *metalv1.APIClien
 		state := deprovisioning
 		switch {
 		case err != nil:
-			err = equinix_errors.FriendlyError(err)
 			state = errstate
 		case r != nil && r.GetProvisionable():
 			state = provisionable

internal/resources/metal/device/helpers_test.go

@@ -32,8 +32,6 @@ func Test_WaitUntilReservationProvisionable(t *testing.T) {
 				reservationId: "reservationId",
 				instanceId:    "instanceId",
 				handler: func(w http.ResponseWriter, r *http.Request) {
-					w.Header().Add("Content-Type", "application/json")
-					w.Header().Add("X-Request-Id", "needed for equinix_errors.FriendlyError")
 					w.WriteHeader(http.StatusInternalServerError)
 				},
 			},
@@ -75,7 +73,6 @@ func Test_WaitUntilReservationProvisionable(t *testing.T) {
 						}
 
 						w.Header().Add("Content-Type", "application/json")
-						w.Header().Add("X-Request-Id", "needed for equinix_errors.FriendlyError")
 						w.WriteHeader(http.StatusOK)
 						_, err = w.Write(body)
 						if err != nil {
@@ -122,7 +119,6 @@ func Test_WaitUntilReservationProvisionable(t *testing.T) {
 						}
 
 						w.Header().Add("Content-Type", "application/json")
-						w.Header().Add("X-Request-Id", "needed for equinix_errors.FriendlyError")
 						w.WriteHeader(http.StatusOK)
 						_, err = w.Write(body)
 						if err != nil {
@@ -151,7 +147,6 @@ func Test_WaitUntilReservationProvisionable(t *testing.T) {
 					}
 
 					w.Header().Add("Content-Type", "application/json")
-					w.Header().Add("X-Request-Id", "needed for equinix_errors.FriendlyError")
 					w.WriteHeader(http.StatusOK)
 					_, err = w.Write(body)
 					if err != nil {

internal/resources/metal/device/resource.go

@@ -552,13 +552,12 @@ func resourceMetalDeviceCreate(ctx context.Context, d *schema.ResourceData, meta
 
 	start := time.Now()
 	projectID := d.Get("project_id").(string)
-	newDevice, _, err := client.DevicesApi.CreateDevice(ctx, projectID).CreateDeviceRequest(createRequest).Execute()
+	newDevice, resp, err := client.DevicesApi.CreateDevice(ctx, projectID).CreateDeviceRequest(createRequest).Execute()
 	if err != nil {
-		retErr := equinix_errors.FriendlyError(err)
-		if equinix_errors.IsNotFound(retErr) {
-			retErr = fmt.Errorf("%s, make sure project \"%s\" exists", retErr, projectID)
+		if resp.StatusCode == http.StatusNotFound {
+			err = fmt.Errorf("%s, make sure project \"%s\" exists", err, projectID)
 		}
-		return diag.FromErr(retErr)
+		return diag.FromErr(err)
 	}
 
 	d.SetId(newDevice.GetId())
@@ -736,7 +735,7 @@ func resourceMetalDeviceUpdate(ctx context.Context, d *schema.ResourceData, meta
 	start := time.Now()
 	if !reflect.DeepEqual(ur, metalv1.DeviceUpdateInput{}) {
 		if _, _, err := client.DevicesApi.UpdateDevice(ctx, d.Id()).DeviceUpdateInput(ur).Execute(); err != nil {
-			return diag.FromErr(equinix_errors.FriendlyError(err))
+			return diag.FromErr(err)
 		}
 	}
 
@@ -773,7 +772,7 @@ func doReinstall(ctx context.Context, client *metalv1.APIClient, d *schema.Resou
 		}
 
 		if _, err := client.DevicesApi.PerformAction(ctx, d.Id()).DeviceActionInput(reinstallOptions).Execute(); err != nil {
-			return equinix_errors.FriendlyError(err)
+			return err
 		}
 
 		updateTimeout := d.Timeout(schema.TimeoutUpdate) - 30*time.Second - time.Since(start)
@@ -798,7 +797,7 @@ func resourceMetalDeviceDelete(ctx context.Context, d *schema.ResourceData, meta
 
 	resp, err := client.DevicesApi.DeleteDevice(ctx, d.Id()).ForceDelete(fdv).Execute()
 	if equinix_errors.IgnoreHttpResponseErrors(http.StatusForbidden, http.StatusNotFound)(resp, err) != nil {
-		return diag.FromErr(equinix_errors.FriendlyError(err))
+		return diag.FromErr(err)
 	}
 
 	resId, resIdOk := d.GetOk("deployed_hardware_reservation_id")
@@ -843,13 +842,15 @@ func WaitForActiveDevice(ctx context.Context, d *schema.ResourceData, meta inter
 	state, err := waitForDeviceAttribute(ctx, d, stateConf)
 	if err != nil {
 		d.SetId("")
-		fErr := equinix_errors.FriendlyError(err)
-		if equinix_errors.IsForbidden(fErr) {
+		// TODO: this can never be true because we don't have the API response
+		// but I'm not clear if we actually need this check?  Certainly the error
+		// message seems to promise something we can't and shouldn't promise
+		if equinix_errors.IsForbidden(err) {
 			// If the device doesn't get to the active state, we can't recover it from here.
 
 			return errors.New("provisioning time limit exceeded; the Equinix Metal team will investigate")
 		}
-		return fErr
+		return err
 	}
 
 	if state != "active" {

internal/resources/metal/device/resource_test.go

@@ -48,7 +48,6 @@ func TestMetalDevice_readErrorHandling(t *testing.T) {
 				newResource: false,
 				handler: func(w http.ResponseWriter, r *http.Request) {
 					w.Header().Add("Content-Type", "application/json")
-					w.Header().Add("X-Request-Id", "needed for equinix_errors.FriendlyError")
 					w.WriteHeader(http.StatusForbidden)
 				},
 			},

internal/resources/metal/gateway/resource.go

@@ -202,7 +202,7 @@ func getGatewayAndParse(ctx context.Context, client *metalv1.APIClient, state *R
 	// API call to get the Metal Gateway
 	gw, _, err := client.MetalGatewaysApi.FindMetalGatewayById(ctx, id).Include(includes).Execute()
 	if err != nil {
-		return diags, equinix_errors.FriendlyError(err)
+		return diags, err
 	}
 
 	// Parse the API response into the Terraform state

internal/resources/metal/port/resource.go

@@ -10,7 +10,6 @@ import (
 	"slices"
 
 	"github.com/equinix/equinix-sdk-go/services/metalv1"
-	equinix_errors "github.com/equinix/terraform-provider-equinix/internal/errors"
 	equinix_schema "github.com/equinix/terraform-provider-equinix/internal/schema"
 
 	"github.com/equinix/terraform-provider-equinix/internal/config"
@@ -132,7 +131,7 @@ func resourceMetalPortUpdate(ctx context.Context, d *schema.ResourceData, meta i
 	start := time.Now()
 	cpr, _, err := getClientPortResource(ctx, d, meta)
 	if err != nil {
-		return diag.FromErr(equinix_errors.FriendlyError(err))
+		return diag.FromErr(err)
 	}
 
 	for _, f := range [](func(context.Context, *ClientPortResource) error){
@@ -146,7 +145,7 @@ func resourceMetalPortUpdate(ctx context.Context, d *schema.ResourceData, meta i
 		updateNativeVlan,
 	} {
 		if err := f(ctx, cpr); err != nil {
-			return diag.FromErr(equinix_errors.FriendlyError(err))
+			return diag.FromErr(err)
 		}
 	}
 

internal/resources/metal/project_ssh_key/datasource.go

@@ -2,7 +2,6 @@ package project_ssh_key
 
 import (
 	"github.com/equinix/equinix-sdk-go/services/metalv1"
-	equinix_errors "github.com/equinix/terraform-provider-equinix/internal/errors"
 	"github.com/equinix/terraform-provider-equinix/internal/framework"
 	"github.com/hashicorp/terraform-plugin-framework/datasource"
 
@@ -51,7 +50,6 @@ func (r *DataSource) Read(
 	// Use API client to list SSH keys
 	keysList, _, err := client.SSHKeysApi.FindProjectSSHKeys(ctx, projectID).Query(search).Execute()
 	if err != nil {
-		err = equinix_errors.FriendlyError(err)
 		resp.Diagnostics.AddError(
 			"Error listing project ssh keys",
 			err.Error(),

internal/resources/metal/project_ssh_key/resource.go

@@ -54,7 +54,7 @@ func (r *Resource) Create(
 	if err != nil {
 		resp.Diagnostics.AddError(
 			"Failed to create Project SSH Key",
-			equinix_errors.FriendlyError(err).Error(),
+			err.Error(),
 		)
 		return
 	}
@@ -87,13 +87,11 @@ func (r *Resource) Read(
 	id := state.ID.ValueString()
 
 	// Use API client to get the current state of the resource
-	key, _, err := client.SSHKeysApi.FindSSHKeyById(ctx, id).Include(nil).Execute()
+	key, apiResp, err := client.SSHKeysApi.FindSSHKeyById(ctx, id).Include(nil).Execute()
 	if err != nil {
-		err = equinix_errors.FriendlyError(err)
-
 		// If the key is somehow already destroyed, mark as
 		// succesfully gone
-		if equinix_errors.IsNotFound(err) {
+		if apiResp.StatusCode == http.StatusNotFound {
 			resp.Diagnostics.AddWarning(
 				"Equinix Metal Project SSHKey not found during refresh",
 				fmt.Sprintf("[WARN] SSHKey (%s) not found, removing from state", id),
@@ -146,7 +144,6 @@ func (r *Resource) Update(
 	// Update the resource
 	key, _, err := client.SSHKeysApi.UpdateSSHKey(ctx, id).SSHKeyInput(*updateRequest).Execute()
 	if err != nil {
-		err = equinix_errors.FriendlyError(err)
 		resp.Diagnostics.AddError(
 			"Error updating resource",
 			"Could not update resource with ID "+id+": "+err.Error(),
@@ -184,7 +181,6 @@ func (r *Resource) Delete(
 	// Use API client to delete the resource
 	deleteResp, err := client.SSHKeysApi.DeleteSSHKey(ctx, id).Execute()
 	if equinix_errors.IgnoreHttpResponseErrors(http.StatusForbidden, http.StatusNotFound)(deleteResp, err) != nil {
-		err = equinix_errors.FriendlyError(err)
 		resp.Diagnostics.AddError(
 			fmt.Sprintf("Failed to delete Project SSHKey %s", id),
 			err.Error(),

internal/resources/metal/ssh_key/resource.go

@@ -52,7 +52,7 @@ func (r *Resource) Create(
 	if err != nil {
 		resp.Diagnostics.AddError(
 			"Failed to create SSH Key",
-			equinix_errors.FriendlyError(err).Error(),
+			err.Error(),
 		)
 		return
 	}
@@ -85,13 +85,11 @@ func (r *Resource) Read(
 	id := state.ID.ValueString()
 
 	// Use API client to get the current state of the resource
-	key, _, err := client.SSHKeysApi.FindSSHKeyById(ctx, id).Include(nil).Execute()
+	key, apiResp, err := client.SSHKeysApi.FindSSHKeyById(ctx, id).Include(nil).Execute()
 	if err != nil {
-		err = equinix_errors.FriendlyError(err)
-
 		// If the key is somehow already destroyed, mark as
 		// succesfully gone
-		if equinix_errors.IsNotFound(err) {
+		if apiResp.StatusCode != http.StatusNotFound {
 			resp.Diagnostics.AddWarning(
 				"Equinix Metal SSHKey not found during refresh",
 				fmt.Sprintf("[WARN] SSHKey (%s) not found, removing from state", id),
@@ -144,7 +142,6 @@ func (r *Resource) Update(
 	// Update the resource
 	key, _, err := client.SSHKeysApi.UpdateSSHKey(ctx, id).SSHKeyInput(*updateRequest).Execute()
 	if err != nil {
-		err = equinix_errors.FriendlyError(err)
 		resp.Diagnostics.AddError(
 			"Error updating resource",
 			"Could not update resource with ID "+id+": "+err.Error(),
@@ -182,7 +179,6 @@ func (r *Resource) Delete(
 	// Use API client to delete the resource
 	deleteResp, err := client.SSHKeysApi.DeleteSSHKey(ctx, id).Execute()
 	if equinix_errors.IgnoreHttpResponseErrors(http.StatusForbidden, http.StatusNotFound)(deleteResp, err) != nil {
-		err = equinix_errors.FriendlyError(err)
 		resp.Diagnostics.AddError(
 			fmt.Sprintf("Failed to delete SSHKey %s", id),
 			err.Error(),

internal/resources/metal/vrf/resource.go

@@ -3,6 +3,7 @@ package vrf
 import (
 	"context"
 	"log"
+	"net/http"
 
 	"github.com/equinix/terraform-provider-equinix/internal/converters"
 	equinix_errors "github.com/equinix/terraform-provider-equinix/internal/errors"
@@ -82,7 +83,7 @@ func resourceMetalVRFCreate(ctx context.Context, d *schema.ResourceData, meta in
 		VrfCreateInput(createRequest).
 		Execute()
 	if err != nil {
-		return diag.FromErr(equinix_errors.FriendlyError(err))
+		return diag.FromErr(err)
 	}
 
 	d.SetId(vrf.GetId())
@@ -113,7 +114,7 @@ func resourceMetalVRFUpdate(ctx context.Context, d *schema.ResourceData, meta in
 		VrfUpdateInput(updateRequest).
 		Execute()
 	if err != nil {
-		return diag.FromErr(equinix_errors.FriendlyError(err))
+		return diag.FromErr(err)
 	}
 
 	return resourceMetalVRFRead(ctx, d, meta)
@@ -148,13 +149,12 @@ func resourceMetalVRFRead(ctx context.Context, d *schema.ResourceData, meta inte
 }
 
 func resourceMetalVRFDelete(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
-	meta.(*config.Config).AddModuleToMetalUserAgent(d)
-	client := meta.(*config.Config).Metal
+	client := meta.(*config.Config).NewMetalClientForSDK(d)
 
-	resp, err := client.VRFs.Delete(d.Id())
-	if equinix_errors.IgnoreResponseErrors(equinix_errors.HttpForbidden, equinix_errors.HttpNotFound)(resp, err) == nil {
+	resp, err := client.VRFsApi.DeleteVrf(ctx, d.Id()).Execute()
+	if equinix_errors.IgnoreHttpResponseErrors(http.StatusForbidden, http.StatusNotFound)(resp, err) == nil {
 		d.SetId("")
 	}
 
-	return diag.FromErr(equinix_errors.FriendlyError(err))
+	return diag.FromErr(err)
 }