add debug flag for submit

Author: theodore-s-beers

client/lessons.go

@@ -191,6 +191,13 @@ type lessonSubmissionCLI struct {
 	CLIResults []CLIStepResult
 }
 
+type SubmissionDebugData struct {
+	Endpoint           string
+	RequestBody        string
+	ResponseStatusCode int
+	ResponseBody       string
+}
+
 type LessonSubmissionEvent struct {
 	ResultSlug       VerificationResultSlug
 	StructuredErrCLI *StructuredErrCLI
@@ -212,27 +219,36 @@ const (
 	VerificationResultSlugFailure     VerificationResultSlug = "failure"
 )
 
-func SubmitCLILesson(uuid string, results []CLIStepResult) (LessonSubmissionEvent, error) {
+func SubmitCLILesson(uuid string, results []CLIStepResult, captureDebug bool) (LessonSubmissionEvent, SubmissionDebugData, error) {
+	endpoint := fmt.Sprintf("/v1/lessons/%v/", uuid)
+	debugData := SubmissionDebugData{Endpoint: endpoint}
+
 	bytes, err := json.Marshal(lessonSubmissionCLI{CLIResults: results})
 	if err != nil {
-		return LessonSubmissionEvent{}, err
+		return LessonSubmissionEvent{}, debugData, err
 	}
-	endpoint := fmt.Sprintf("/v1/lessons/%v/", uuid)
+	if captureDebug {
+		debugData.RequestBody = string(bytes)
+	}
+
 	resp, code, err := fetchWithAuthAndPayload("POST", endpoint, bytes)
+	debugData.ResponseStatusCode = code
+	if captureDebug {
+		debugData.ResponseBody = string(resp)
+	}
 	if err != nil {
-		return LessonSubmissionEvent{}, err
+		return LessonSubmissionEvent{}, debugData, err
 	}
 	if code == 402 {
-		return LessonSubmissionEvent{}, fmt.Errorf("to run and submit the tests for this lesson, you must have an active Boot.dev membership\nhttps://boot.dev/pricing")
+		return LessonSubmissionEvent{}, debugData, fmt.Errorf("to run and submit the tests for this lesson, you must have an active Boot.dev membership\nhttps://boot.dev/pricing")
 	}
 	if code != 200 {
-		return LessonSubmissionEvent{}, fmt.Errorf("failed to submit CLI lesson (code %v): %s", code, string(resp))
+		return LessonSubmissionEvent{}, debugData, fmt.Errorf("failed to submit CLI lesson (code %v): %s", code, string(resp))
 	}
 
 	result := LessonSubmissionEvent{}
-	err = json.Unmarshal(resp, &result)
-	if err != nil {
-		return LessonSubmissionEvent{}, err
+	if err := json.Unmarshal(resp, &result); err != nil {
+		return LessonSubmissionEvent{}, debugData, err
 	}
-	return result, nil
+	return result, debugData, nil
 }

cmd/run.go

@@ -7,6 +7,7 @@ import (
 func init() {
 	rootCmd.AddCommand(runCmd)
 	runCmd.Flags().BoolVarP(&forceSubmit, "submit", "s", false, "shortcut flag to submit after running")
+	runCmd.Flags().BoolVar(&debugSubmission, "debug", false, "log submission request/response debug output")
 }
 
 // runCmd represents the run command

cmd/submit.go

@@ -3,7 +3,10 @@ package cmd
 import (
 	"errors"
 	"fmt"
+	"os"
+	"path/filepath"
 	"runtime"
+	"time"
 
 	"github.com/bootdotdev/bootdev/checks"
 	api "github.com/bootdotdev/bootdev/client"
@@ -14,10 +17,14 @@ import (
 	"github.com/spf13/viper"
 )
 
-var forceSubmit bool
+var (
+	forceSubmit     bool
+	debugSubmission bool
+)
 
 func init() {
 	rootCmd.AddCommand(submitCmd)
+	submitCmd.Flags().BoolVar(&debugSubmission, "debug", false, "log submission request/response debug output")
 }
 
 // submitCmd represents the submit command
@@ -71,7 +78,15 @@ func submissionHandler(cmd *cobra.Command, args []string) error {
 	cliResults := checks.CLIChecks(data, overrideBaseURL, ch)
 
 	if isSubmit {
-		submissionEvent, err := api.SubmitCLILesson(lessonUUID, cliResults)
+		submissionEvent, debugData, err := api.SubmitCLILesson(lessonUUID, cliResults, debugSubmission)
+		if debugSubmission {
+			var debugPath string
+			var debugWriteErr error
+			defer func() {
+				reportDebugFileWrite(debugPath, debugWriteErr)
+			}()
+			debugPath, debugWriteErr = writeSubmissionDebugFile(lessonUUID, debugData)
+		}
 		if err != nil {
 			return err
 		}
@@ -82,3 +97,42 @@ func submissionHandler(cmd *cobra.Command, args []string) error {
 	}
 	return nil
 }
+
+func reportDebugFileWrite(path string, err error) {
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "warning: failed to write submission debug output: %v\n", err)
+		return
+	}
+	fmt.Fprintf(os.Stderr, "Submission debug output written to %s\n", path)
+}
+
+func writeSubmissionDebugFile(lessonUUID string, data api.SubmissionDebugData) (string, error) {
+	now := time.Now()
+	timestamp := now.Format("20060102-150405")
+	filename := fmt.Sprintf("bootdev-submit-debug-%s-%s.txt", lessonUUID, timestamp)
+	status := "unavailable"
+	if data.ResponseStatusCode != 0 {
+		status = fmt.Sprintf("%d", data.ResponseStatusCode)
+	}
+
+	contents := fmt.Sprintf(
+		"bootdev submit debug\nTimestamp: %s\nLesson UUID: %s\nEndpoint: %s\n\n=== Request JSON ===\n%s\n\n=== Response ===\nStatus Code: %s\n%s\n",
+		now.Format(time.RFC3339),
+		lessonUUID,
+		data.Endpoint,
+		data.RequestBody,
+		status,
+		data.ResponseBody,
+	)
+
+	if err := os.WriteFile(filename, []byte(contents), 0o600); err != nil {
+		return "", err
+	}
+
+	absPath, err := filepath.Abs(filename)
+	if err != nil {
+		return filename, nil
+	}
+
+	return absPath, nil
+}