implement review feedback

Author: marceljk

.github/docs/contribution-guide/resource.go

@@ -184,7 +184,9 @@ func (r *barResource) Create(ctx context.Context, req resource.CreateRequest, re
 	if resp.Diagnostics.HasError() {
 		return
 	}
+
 	ctx = core.InitProviderContext(ctx)
+
 	projectId := model.ProjectId.ValueString()
 	region := model.Region.ValueString() // not needed for global APIs
 	ctx = tflog.SetField(ctx, "project_id", projectId)
@@ -203,6 +205,7 @@ func (r *barResource) Create(ctx context.Context, req resource.CreateRequest, re
 		core.LogAndAddError(ctx, &resp.Diagnostics, "Error creating bar", fmt.Sprintf("Calling API: %v", err))
 		return
 	}
+
 	ctx = core.LogResponse(ctx)
 
 	// only in case the create bar API call is asynchronous (Make sure to include *ALL* fields which are part of the
@@ -246,7 +249,9 @@ func (r *barResource) Read(ctx context.Context, req resource.ReadRequest, resp *
 	if resp.Diagnostics.HasError() {
 		return
 	}
+
 	ctx = core.InitProviderContext(ctx)
+
 	projectId := model.ProjectId.ValueString()
 	region := r.providerData.GetRegionWithOverride(model.Region)
 	barId := model.BarId.ValueString()
@@ -259,6 +264,7 @@ func (r *barResource) Read(ctx context.Context, req resource.ReadRequest, resp *
 		core.LogAndAddError(ctx, &resp.Diagnostics, "Error reading bar", fmt.Sprintf("Calling API: %v", err))
 		return
 	}
+
 	ctx = core.LogResponse(ctx)
 
 	// Map response body to schema
@@ -289,7 +295,9 @@ func (r *barResource) Delete(ctx context.Context, req resource.DeleteRequest, re
 	if resp.Diagnostics.HasError() {
 		return
 	}
+
 	ctx = core.InitProviderContext(ctx)
+
 	projectId := model.ProjectId.ValueString()
 	region := model.Region.ValueString()
 	barId := model.BarId.ValueString()
@@ -302,6 +310,7 @@ func (r *barResource) Delete(ctx context.Context, req resource.DeleteRequest, re
 	if err != nil {
 		core.LogAndAddError(ctx, &resp.Diagnostics, "Error deleting bar", fmt.Sprintf("Calling API: %v", err))
 	}
+
 	ctx = core.LogResponse(ctx)
 
 	// only in case the bar delete API endpoint is asynchronous: use a wait handler to wait for the delete operation to complete

stackit/internal/core/core.go

@@ -106,6 +106,7 @@ func LogAndAddError(ctx context.Context, diags *diag.Diagnostics, summary, detai
 	if traceId := runtime.GetTraceId(ctx); traceId != "" {
 		detail = fmt.Sprintf("%s\nTrace ID: %q", detail, traceId)
 	}
+
 	tflog.Error(ctx, fmt.Sprintf("%s | %s", summary, detail))
 	diags.AddError(summary, detail)
 }
@@ -115,6 +116,7 @@ func LogAndAddWarning(ctx context.Context, diags *diag.Diagnostics, summary, det
 	if traceId := runtime.GetTraceId(ctx); traceId != "" {
 		detail = fmt.Sprintf("%s\nTrace ID: %q", detail, traceId)
 	}
+
 	tflog.Warn(ctx, fmt.Sprintf("%s | %s", summary, detail))
 	diags.AddWarning(summary, detail)
 }
@@ -133,18 +135,19 @@ func LogAndAddErrorBeta(ctx context.Context, diags *diag.Diagnostics, name strin
 	diags.AddError(errTitle, errContent)
 }
 
+// InitProviderContext extends the context to capture the http response
 func InitProviderContext(ctx context.Context) context.Context {
 	// Capture http response to get trace-id
 	var httpResp *http.Response
-	ctx = runtime.WithCaptureHTTPResponse(ctx, &httpResp)
-
-	return ctx
+	return runtime.WithCaptureHTTPResponse(ctx, &httpResp)
 }
 
+// LogResponse logs the trace-id of the last request
 func LogResponse(ctx context.Context) context.Context {
 	// Logs the trace-id of the request
 	traceId := runtime.GetTraceId(ctx)
 	ctx = tflog.SetField(ctx, "x-trace-id", traceId)
+
 	tflog.Info(ctx, "response data", map[string]interface{}{
 		"x-trace-id": traceId,
 	})