Merge pull request #1811 from appwrite/feat/cli-function-setup-flow

feat(cli): add guided function setup workflow

Author: ChiragAgg5k

src/SDK/Language/CLI.php

@@ -1102,6 +1102,11 @@ public function getFiles(): array
                 'destination'   => 'internal/cmd/initfunction.go',
                 'template'      => 'cli/internal/cmd/initfunction.go',
             ],
+            [
+                'scope'         => 'default',
+                'destination'   => 'internal/cmd/initfunction_test.go',
+                'template'      => 'cli/internal/cmd/initfunction_test.go',
+            ],
             [
                 'scope'         => 'default',
                 'destination'   => 'internal/cmd/initsite.go',

templates/cli/internal/cmd/errors.go

@@ -8,10 +8,12 @@ import (
 	"io"
 	"net/url"
 	"os"
+	"path/filepath"
 	"runtime"
 	"strings"
 
 	"github.com/{{ sdk.gitUserName }}/{{ sdk.gitRepoName | caseDash }}/internal/app"
+	"github.com/{{ sdk.gitUserName }}/{{ sdk.gitRepoName | caseDash }}/internal/config"
 	"github.com/{{ sdk.gitUserName }}/{{ sdk.gitRepoName | caseDash }}/internal/output"
 	"github.com/{{ sdk.gitUserName }}/{{ sdk.gitRepoName | caseDash }}/internal/prompt"
 	"github.com/{{ sdk.gitUserName }}/{{ sdk.gitRepoName | caseDash }}/internal/sdk"
@@ -43,6 +45,64 @@ type apiError interface {
 // rendered error page.
 const maximumMessageLength = 400
 
+// actionableError carries a known recovery path without baking terminal layout
+// into Error(). Logs and reports retain the ordinary message; Report can render
+// the title, facts and command as a readable block.
+type actionableError struct {
+	cause   error
+	title   string
+	details []output.FailureDetail
+	action  string
+	command string
+}
+
+func (e *actionableError) Error() string { return e.cause.Error() }
+func (e *actionableError) Unwrap() error { return e.cause }
+
+func endpointMismatchError(projectEndpoint, sessionEndpoint string) error {
+	switchEndpoint := config.NormalizeCloudConsoleEndpoint(projectEndpoint)
+	environment := "the project environment"
+	if base, cloud := config.CloudBaseHost(projectEndpoint); cloud {
+		environment = "Appwrite Cloud"
+		if strings.Contains(base, "staging") {
+			environment = "Appwrite Cloud Staging"
+		}
+	}
+
+	cause := fmt.Errorf("project endpoint %s does not match active session endpoint %s",
+		projectEndpoint, sessionEndpoint)
+	return &actionableError{
+		cause: cause,
+		title: "Active session doesn’t match this project",
+		details: []output.FailureDetail{
+			{Label: "Project endpoint", Value: projectEndpoint},
+			{Label: "Active session", Value: sessionEndpoint},
+		},
+		action: "Switch to " + environment + ":",
+		command: fmt.Sprintf("%s login --switch --endpoint %s",
+			app.ExecutableName, switchEndpoint),
+	}
+}
+
+func missingProjectConfigError(err error) *actionableError {
+	var pathError *os.PathError
+	if !errors.As(err, &pathError) || !errors.Is(err, os.ErrNotExist) ||
+		filepath.Base(pathError.Path) != config.LocalFileName {
+		return nil
+	}
+
+	return &actionableError{
+		cause: err,
+		title: "Appwrite project configuration not found",
+		details: []output.FailureDetail{
+			{Label: "Expected file", Value: pathError.Path},
+		},
+		action: "Run this command from a directory containing " + config.LocalFileName +
+			", or initialize a project:",
+		command: app.ExecutableName + " init project",
+	}
+}
+
 // FormatError renders a command failure for the terminal.
 func FormatError(err error) string {
 	if err == nil {
@@ -196,7 +256,16 @@ func Report(writer io.Writer, executed *cobra.Command, err error) int {
 		output.Log(writer, "For detailed error pass the --verbose or --report flag")
 	}
 
-	output.Failure(writer, "%s", FormatError(err))
+	var actionable *actionableError
+	if errors.As(err, &actionable) {
+		output.ActionableFailure(writer, actionable.title, actionable.details,
+			actionable.action, actionable.command)
+	} else if missing := missingProjectConfigError(err); missing != nil {
+		output.ActionableFailure(writer, missing.title, missing.details,
+			missing.action, missing.command)
+	} else {
+		output.Failure(writer, "%s", FormatError(err))
+	}
 
 	// --verbose has to add the response body: on the failure it matters most for
 	// -- a response the SDK could not decode -- a message naming a field and a

templates/cli/internal/cmd/errors_test.go

@@ -263,6 +263,59 @@ func TestReportDistinguishesCancellationFromFailure(t *testing.T) {
 	}
 }
 
+func TestEndpointMismatchRendersActionableBlock(t *testing.T) {
+	requestWasMade(t, false)
+	buffer := &bytes.Buffer{}
+	err := endpointMismatchError(
+		"https://sgp.cloud.appwrite.io/v1",
+		"https://cloud.staging.appwrite.io/v1",
+	)
+
+	if status := Report(buffer, nil, err); status != 1 {
+		t.Fatalf("status = %d", status)
+	}
+	printed := buffer.String()
+	for _, wanted := range []string{
+		"Active session doesn’t match this project",
+		"Project endpoint", "https://sgp.cloud.appwrite.io/v1",
+		"Active session", "https://cloud.staging.appwrite.io/v1",
+		"Switch to Appwrite Cloud:",
+		"appwrite login --switch --endpoint https://cloud.appwrite.io/v1",
+	} {
+		if !strings.Contains(printed, wanted) {
+			t.Errorf("output does not contain %q:\n%s", wanted, printed)
+		}
+	}
+	if strings.Contains(printed, "✗ Error:") {
+		t.Errorf("actionable block retained generic prefix:\n%s", printed)
+	}
+}
+
+func TestMissingProjectConfigRendersActionableBlock(t *testing.T) {
+	requestWasMade(t, false)
+	path := "/work/project/appwrite.config.json"
+	buffer := &bytes.Buffer{}
+	err := &os.PathError{Op: "open", Path: path, Err: os.ErrNotExist}
+
+	if status := Report(buffer, nil, err); status != 1 {
+		t.Fatalf("status = %d", status)
+	}
+	printed := buffer.String()
+	for _, wanted := range []string{
+		"Appwrite project configuration not found",
+		"Expected file", path,
+		"Run this command from a directory containing appwrite.config.json",
+		"appwrite init project",
+	} {
+		if !strings.Contains(printed, wanted) {
+			t.Errorf("output does not contain %q:\n%s", wanted, printed)
+		}
+	}
+	if strings.Contains(printed, "no such file or directory") {
+		t.Errorf("raw filesystem error leaked into primary output:\n%s", printed)
+	}
+}
+
 // A command that fails DURING parsing never reaches the later flags, so the
 // parsed globals cannot answer "did the user ask for detail". `users get
 // --bogus --verbose` stopped at --bogus and then advised passing --verbose.