Merge pull request #64 from codecrafters-io/feat-add-ping-command

feat(ping): add ping command to test connection to repository

Author: rohitpaulk

cmd/codecrafters/main.go

@@ -33,6 +33,7 @@ COMMANDS
   submit:           Commit changes & submit to move to next step
   task:             View current stage instructions
   update-buildpack: Update language version
+  ping:             Test the connection to a CodeCrafters repository
   help:             Show usage instructions
 
 VERSION
@@ -91,6 +92,8 @@ func run() error {
 		return commands.TaskCommand(*stageSlug, *raw)
 	case "update-buildpack":
 		return commands.UpdateBuildpackCommand()
+	case "ping":
+		return commands.PingCommand()
 	case "help",
 		"": // no argument
 		flag.Usage()

internal/client/ping.go

@@ -0,0 +1,38 @@
+package client
+
+import (
+	"encoding/json"
+	"fmt"
+
+	"github.com/levigross/grequests"
+)
+
+type PingResponse struct {
+	Actions []ActionDefinition `json:"actions"`
+}
+
+func (c CodecraftersClient) Ping(repositoryId string) (PingResponse, error) {
+	response, err := grequests.Post(c.ServerUrl+"/services/cli/ping", &grequests.RequestOptions{
+		JSON: map[string]interface{}{
+			"repository_id": repositoryId,
+		},
+		Headers: c.headers(),
+	})
+
+	if err != nil {
+		return PingResponse{}, fmt.Errorf("failed to ping CodeCrafters: %s", err)
+	}
+
+	if !response.Ok {
+		return PingResponse{}, fmt.Errorf("failed to ping CodeCrafters. status code: %d, body: %s", response.StatusCode, response.String())
+	}
+
+	pingResponse := PingResponse{}
+
+	err = json.Unmarshal(response.Bytes(), &pingResponse)
+	if err != nil {
+		return PingResponse{}, fmt.Errorf("failed to parse ping response: %s", err)
+	}
+
+	return pingResponse, nil
+}

internal/commands/ping.go

@@ -0,0 +1,84 @@
+package commands
+
+import (
+	"errors"
+	"fmt"
+
+	"github.com/codecrafters-io/cli/internal/actions"
+	"github.com/codecrafters-io/cli/internal/client"
+	"github.com/codecrafters-io/cli/internal/globals"
+	"github.com/codecrafters-io/cli/internal/utils"
+	"github.com/getsentry/sentry-go"
+)
+
+func PingCommand() (err error) {
+	utils.Logger.Debug().Msg("ping command starts")
+
+	defer func() {
+		utils.Logger.Debug().Err(err).Msg("ping command ends")
+	}()
+
+	defer func() {
+		if p := recover(); p != nil {
+			utils.Logger.Panic().Str("panic", fmt.Sprintf("%v", p)).Stack().Msg("panic")
+			sentry.CurrentHub().Recover(p)
+
+			panic(p)
+		}
+
+		if err == nil {
+			return
+		}
+
+		var noRepo utils.NoCodecraftersRemoteFoundError
+		if errors.Is(err, &noRepo) {
+			// ignore
+			return
+		}
+
+		sentry.CurrentHub().CaptureException(err)
+	}()
+
+	utils.Logger.Debug().Msg("computing repository directory")
+
+	repoDir, err := utils.GetRepositoryDir()
+	if err != nil {
+		return err
+	}
+
+	utils.Logger.Debug().Msgf("found repository directory: %s", repoDir)
+
+	utils.Logger.Debug().Msg("identifying remotes")
+
+	codecraftersRemote, err := utils.IdentifyGitRemote(repoDir)
+	if err != nil {
+		return err
+	}
+
+	utils.Logger.Debug().Msgf("identified remote: %s, %s", codecraftersRemote.Name, codecraftersRemote.Url)
+
+	globals.SetCodecraftersServerURL(codecraftersRemote.CodecraftersServerURL())
+	codecraftersClient := client.NewCodecraftersClient()
+
+	utils.Logger.Debug().Msg("sending ping request")
+
+	pingResponse, err := codecraftersClient.Ping(codecraftersRemote.CodecraftersRepositoryId())
+	if err != nil {
+		return fmt.Errorf("ping: %w", err)
+	}
+
+	utils.Logger.Debug().Msgf("received %d actions", len(pingResponse.Actions))
+
+	for _, actionDefinition := range pingResponse.Actions {
+		action, err := actions.ActionFromDefinition(actionDefinition)
+		if err != nil {
+			return fmt.Errorf("parse action: %w", err)
+		}
+
+		if err := action.Execute(); err != nil {
+			return fmt.Errorf("execute action: %w", err)
+		}
+	}
+
+	return nil
+}