remove url paths

- require base url override if necessary
- simplify base URL handling
- remove URL paths
- add cli version request header

Author: squashd

checks/checks.go

@@ -43,16 +43,9 @@ func runHTTPRequest(
 ) (
 	result api.HTTPRequestResult,
 ) {
-	if baseURL == "" && requestStep.Request.FullURL == "" {
-		cobra.CheckErr("no base URL or full URL provided")
-	}
-
 	finalBaseURL := strings.TrimSuffix(baseURL, "/")
-	interpolatedPath := InterpolateVariables(requestStep.Request.Path, variables)
-	completeURL := fmt.Sprintf("%s%s", finalBaseURL, interpolatedPath)
-	if requestStep.Request.FullURL != "" {
-		completeURL = InterpolateVariables(requestStep.Request.FullURL, variables)
-	}
+	interpolatedURL := InterpolateVariables(requestStep.Request.FullURL, variables)
+	completeURL := strings.Replace(interpolatedURL, api.BaseURLPlaceholder, finalBaseURL, 1)
 
 	var req *http.Request
 	if requestStep.Request.BodyJSON != nil {
@@ -123,17 +116,19 @@ func runHTTPRequest(
 	return result
 }
 
-func CLIChecks(cliData api.CLIData, overrideBaseURL *string) (results []api.CLIStepResult) {
+func CLIChecks(cliData api.CLIData, overrideBaseURL string) (results []api.CLIStepResult) {
 	client := &http.Client{}
 	variables := make(map[string]string)
 	results = make([]api.CLIStepResult, len(cliData.Steps))
 
-	// use cli config url if specified or default lesson data url
-	baseURL := ""
-	if overrideBaseURL != nil && *overrideBaseURL != "" {
-		baseURL = *overrideBaseURL
-	} else if cliData.BaseURL != nil && *cliData.BaseURL != "" {
-		baseURL = *cliData.BaseURL
+	if cliData.BaseURLDefault == api.BaseURLOverrideRequired && overrideBaseURL == "" {
+		cobra.CheckErr("lesson requires a base URL override - bootdev configure base_url <url>")
+	}
+
+	// prefer overrideBaseURL if provided, otherwise use BaseURLDefault
+	baseURL := overrideBaseURL
+	if overrideBaseURL == "" {
+		baseURL = cliData.BaseURLDefault
 	}
 
 	for i, step := range cliData.Steps {

client/lessons.go

@@ -17,13 +17,17 @@ type LessonDataCLI struct {
 	CLIData CLIData
 }
 
+const BaseURLOverrideRequired = "override"
+
 type CLIData struct {
 	// ContainsCompleteDir bool
-	BaseURL *string
-	Steps   []struct {
-		CLICommand  *CLIStepCLICommand
-		HTTPRequest *CLIStepHTTPRequest
-	}
+	BaseURLDefault string
+	Steps          []CLIStep
+}
+
+type CLIStep struct {
+	CLICommand  *CLIStepCLICommand
+	HTTPRequest *CLIStepHTTPRequest
 }
 
 type CLIStepCLICommand struct {
@@ -41,20 +45,28 @@ type CLICommandTest struct {
 type CLIStepHTTPRequest struct {
 	ResponseVariables []HTTPRequestResponseVariable
 	Tests             []HTTPRequestTest
-	Request           struct {
-		Method    string
-		Path      string
-		FullURL   string // overrides BaseURL and Path if set
-		Headers   map[string]string
-		BodyJSON  map[string]interface{}
-		BasicAuth *struct {
-			Username string
-			Password string
-		}
-		Actions struct {
-			DelayRequestByMs *int32
-		}
-	}
+	Request           HTTPRequest
+}
+
+const BaseURLPlaceholder = "${baseURL}"
+
+type HTTPRequest struct {
+	Method   string
+	FullURL  string
+	Headers  map[string]string
+	BodyJSON map[string]any
+
+	BasicAuth *HTTPBasicAuth
+	Actions   HTTPActions
+}
+
+type HTTPBasicAuth struct {
+	Username string
+	Password string
+}
+
+type HTTPActions struct {
+	DelayRequestByMs *int
 }
 
 type HTTPRequestResponseVariable struct {

cmd/submit.go

@@ -43,7 +43,7 @@ func submissionHandler(cmd *cobra.Command, args []string) error {
 
 	data := lesson.Lesson.LessonDataCLI.CLIData
 	overrideBaseURL := viper.GetString("override_base_url")
-	results := checks.CLIChecks(data, &overrideBaseURL)
+	results := checks.CLIChecks(data, overrideBaseURL)
 	if isSubmit {
 		failure, err := api.SubmitCLILesson(lessonUUID, results)
 		if err != nil {

render/render.go

@@ -52,7 +52,7 @@ func renderTestResponseVars(respVars []api.HTTPRequestResponseVariable) string {
 	for _, respVar := range respVars {
 		varStr := gray.Render(fmt.Sprintf("  *  Saving `%s` from `%s`", respVar.Name, respVar.Path))
 		edges := " ├─"
-		for i := 0; i < lipgloss.Height(varStr)-1; i++ {
+		for range lipgloss.Height(varStr) - 1 {
 			edges += "\n │ "
 		}
 		str += lipgloss.JoinHorizontal(lipgloss.Top, edges, varStr)
@@ -68,7 +68,7 @@ func renderTests(tests []testModel, spinner string) string {
 		testStr = fmt.Sprintf("  %s", testStr)
 
 		edges := " ├─"
-		for i := 0; i < lipgloss.Height(testStr)-1; i++ {
+		for range lipgloss.Height(testStr) - 1 {
 			edges += "\n │ "
 		}
 		str += lipgloss.JoinHorizontal(lipgloss.Top, edges, testStr)
@@ -314,7 +314,7 @@ func printHTTPRequestResult(result api.HTTPRequestResult) string {
 	bytes := []byte(result.BodyString)
 	contentType := http.DetectContentType(bytes)
 	if contentType == "application/json" || strings.HasPrefix(contentType, "text/") {
-		var unmarshalled interface{}
+		var unmarshalled any
 		err := json.Unmarshal([]byte(result.BodyString), &unmarshalled)
 		if err == nil {
 			pretty, err := json.MarshalIndent(unmarshalled, "", "  ")
@@ -404,7 +404,7 @@ func renderer(
 			case step.CLICommand != nil && results[i].CLICommandResult != nil:
 				renderCLICommand(*step.CLICommand, *results[i].CLICommandResult, failure, isSubmit, ch, i)
 			case step.HTTPRequest != nil && results[i].HTTPRequestResult != nil:
-				renderHTTPRequest(*step.HTTPRequest, *results[i].HTTPRequestResult, failure, isSubmit, data.BaseURL, ch, i)
+				renderHTTPRequest(*step.HTTPRequest, *results[i].HTTPRequestResult, failure, isSubmit, data.BaseURLDefault, ch, i)
 			default:
 				cobra.CheckErr("unable to run lesson: missing results")
 			}
@@ -492,23 +492,19 @@ func renderHTTPRequest(
 	result api.HTTPRequestResult,
 	failure *api.StructuredErrCLI,
 	isSubmit bool,
-	baseURL *string,
+	baseURLDefault string,
 	ch chan tea.Msg,
 	index int,
 ) {
-	url := ""
-	overrideBaseURL := viper.GetString("override_base_url")
-	if overrideBaseURL != "" {
-		url = overrideBaseURL
-	} else if baseURL != nil && *baseURL != "" {
-		url = *baseURL
-	}
-	if req.Request.FullURL != "" {
-		url = req.Request.FullURL
+
+	baseURL := viper.GetString("override_base_url")
+	if baseURL == "" {
+		baseURL = baseURLDefault
 	}
-	url += req.Request.Path
+	fullURL := strings.Replace(req.Request.FullURL, api.BaseURLPlaceholder, baseURL, 1)
+
 	ch <- startStepMsg{
-		url:               checks.InterpolateVariables(url, result.Variables),
+		url:               checks.InterpolateVariables(fullURL, result.Variables),
 		method:            req.Request.Method,
 		responseVariables: req.ResponseVariables,
 	}

version.txt

@@ -1 +1 @@
-v1.17.1
+v1.18.0