@automattic/vip 4.1.5 → 4.1.6

package/cmd/vip-next/commands/devenv_sync_sites.go

@@ -1,116 +0,0 @@
-package commands
-
-import (
-	"context"
-	"fmt"
-	"strings"
-
-	"github.com/Khan/genqlient/graphql"
-
-	"github.com/Automattic/vip/internal/devenv"
-	"github.com/Automattic/vip/internal/gql"
-)
-
-const devEnvSyncSitesPageSize int64 = 100
-
-// fetchDevEnvSyncSites reads the complete SDS catalog. The returned issue is a
-// stable, sanitized category: callers may offer explicit recovery mappings,
-// while telemetry can classify failures without recording URLs or raw server
-// errors. A non-empty issue always returns an empty site slice so a partial or
-// malformed catalog can never drive automatic rewrites.
-func fetchDevEnvSyncSites(
-	ctx context.Context,
-	client graphql.Client,
-	appID, envID int64,
-	log func(string),
-) ([]devenv.SyncSite, string) {
-	if client == nil {
-		return nil, "transport"
-	}
-
-	var after *string
-	seenCursors := map[string]bool{}
-	byBlogID := map[int64]devenv.SyncSite{}
-	var sites []devenv.SyncSite
-	var expectedTotal int64 = -1
-	var rawCount int64
-
-	for {
-		resp, err := gql.DevEnvSyncSites(
-			gql.WithAllowGQLErrors(ctx),
-			client,
-			appID,
-			envID,
-			after,
-			devEnvSyncSitesPageSize,
-		)
-		if err != nil {
-			return nil, "transport"
-		}
-		if resp == nil || resp.App == nil || len(resp.App.Environments) == 0 ||
-			resp.App.Environments[0] == nil || resp.App.Environments[0].WpSitesSDS == nil {
-			return nil, "missing_payload"
-		}
-
-		page := resp.App.Environments[0].WpSitesSDS
-		if page.Total == nil || *page.Total < 0 {
-			return nil, "missing_payload"
-		}
-		if expectedTotal < 0 {
-			expectedTotal = *page.Total
-		} else if expectedTotal != *page.Total {
-			return nil, "total_mismatch"
-		}
-
-		for _, node := range page.Nodes {
-			rawCount++
-			if node == nil || node.BlogId == nil || *node.BlogId <= 0 {
-				return nil, "invalid_nodes"
-			}
-			homeURL := ""
-			if node.HomeUrl != nil {
-				homeURL = strings.TrimSpace(*node.HomeUrl)
-			}
-			siteURL := ""
-			if node.SiteUrl != nil {
-				siteURL = strings.TrimSpace(*node.SiteUrl)
-			}
-			if homeURL == "" && siteURL == "" {
-				return nil, "invalid_nodes"
-			}
-			site := devenv.SyncSite{BlogID: *node.BlogId, HomeURL: homeURL, SiteURL: siteURL}
-			if previous, exists := byBlogID[site.BlogID]; exists {
-				if previous != site {
-					return nil, "invalid_nodes"
-				}
-				continue
-			}
-			byBlogID[site.BlogID] = site
-			sites = append(sites, site)
-		}
-
-		if log != nil {
-			log(fmt.Sprintf("Fetched %d of %d sites...", rawCount, expectedTotal))
-		}
-		next := ""
-		if page.NextCursor != nil {
-			next = strings.TrimSpace(*page.NextCursor)
-		}
-		if next == "" {
-			break
-		}
-		if seenCursors[next] {
-			return nil, "cursor_loop"
-		}
-		seenCursors[next] = true
-		after = &next
-	}
-
-	if rawCount != expectedTotal {
-		return nil, "total_mismatch"
-	}
-	if rawCount == 0 || len(sites) == 0 {
-		return nil, "empty_catalog"
-	}
-	return sites, ""
-}

package/cmd/vip-next/commands/devenv_sync_sites_test.go

@@ -1,151 +0,0 @@
-package commands
-
-import (
-	"encoding/json"
-	"fmt"
-	"net/http"
-	"net/http/httptest"
-	"reflect"
-	"strings"
-	"testing"
-
-	"github.com/Khan/genqlient/graphql"
-)
-
-type syncSitesRequest struct {
-	Variables struct {
-		After *string `json:"after"`
-		First int64   `json:"first"`
-	} `json:"variables"`
-}
-
-func TestFetchDevEnvSyncSitesPaginatesStrictly(t *testing.T) {
-	var afters []string
-	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-		var request syncSitesRequest
-		if err := json.NewDecoder(r.Body).Decode(&request); err != nil {
-			t.Fatalf("decode request: %v", err)
-		}
-		if request.Variables.First != 100 {
-			t.Errorf("first = %d, want 100", request.Variables.First)
-		}
-		after := "<nil>"
-		if request.Variables.After != nil {
-			after = *request.Variables.After
-		}
-		afters = append(afters, after)
-		w.Header().Set("Content-Type", "application/json")
-		if request.Variables.After == nil {
-			_, _ = w.Write([]byte(`{"data":{"app":{"environments":[{"wpSitesSDS":{"total":3,"nextCursor":"page-2","nodes":[{"blogId":1,"homeUrl":"https://primary.example.com","siteUrl":"https://primary.example.com/wp"},{"blogId":2,"homeUrl":"https://two.primary.example.com","siteUrl":"https://two.primary.example.com/wp"}]}}]}}}`))
-			return
-		}
-		_, _ = w.Write([]byte(`{"data":{"app":{"environments":[{"wpSitesSDS":{"total":3,"nextCursor":null,"nodes":[{"blogId":3,"homeUrl":"https://three.primary.example.com","siteUrl":"https://three.primary.example.com/wp"}]}}]}}}`))
-	}))
-	defer server.Close()
-
-	var progress []string
-	sites, issue := fetchDevEnvSyncSites(t.Context(), graphql.NewClient(server.URL, server.Client()), 42, 7, func(line string) {
-		progress = append(progress, line)
-	})
-	if issue != "" {
-		t.Fatalf("issue = %q", issue)
-	}
-	if got, want := afters, []string{"<nil>", "page-2"}; !reflect.DeepEqual(got, want) {
-		t.Fatalf("after cursors = %#v, want %#v", got, want)
-	}
-	if len(sites) != 3 || sites[0].BlogID != 1 || sites[2].BlogID != 3 {
-		t.Fatalf("sites = %#v", sites)
-	}
-	if got, want := progress, []string{"Fetched 2 of 3 sites...", "Fetched 3 of 3 sites..."}; !reflect.DeepEqual(got, want) {
-		t.Fatalf("progress = %#v, want %#v", got, want)
-	}
-}
-
-func TestFetchDevEnvSyncSitesRejectsUnsafeCatalogs(t *testing.T) {
-	tests := []struct {
-		name      string
-		responses []string
-		status    int
-		wantIssue string
-	}{
-		{name: "transport", status: http.StatusInternalServerError, wantIssue: "transport"},
-		{name: "missing payload", responses: []string{`{"data":{"app":null}}`}, wantIssue: "missing_payload"},
-		{name: "empty catalog", responses: []string{`{"data":{"app":{"environments":[{"wpSitesSDS":{"total":0,"nextCursor":null,"nodes":[]}}]}}}`}, wantIssue: "empty_catalog"},
-		{name: "nil node", responses: []string{`{"data":{"app":{"environments":[{"wpSitesSDS":{"total":1,"nextCursor":null,"nodes":[null]}}]}}}`}, wantIssue: "invalid_nodes"},
-		{name: "total mismatch", responses: []string{`{"data":{"app":{"environments":[{"wpSitesSDS":{"total":2,"nextCursor":null,"nodes":[{"blogId":1,"homeUrl":"https://primary.example.com"}]}}]}}}`}, wantIssue: "total_mismatch"},
-		{
-			name: "cursor loop",
-			responses: []string{
-				`{"data":{"app":{"environments":[{"wpSitesSDS":{"total":2,"nextCursor":"same","nodes":[{"blogId":1,"homeUrl":"https://primary.example.com"}]}}]}}}`,
-				`{"data":{"app":{"environments":[{"wpSitesSDS":{"total":2,"nextCursor":"same","nodes":[{"blogId":2,"homeUrl":"https://two.primary.example.com"}]}}]}}}`,
-			},
-			wantIssue: "cursor_loop",
-		},
-	}
-
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			calls := 0
-			server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-				if tt.status != 0 {
-					http.Error(w, "local test failure", tt.status)
-					return
-				}
-				w.Header().Set("Content-Type", "application/json")
-				index := calls
-				if index >= len(tt.responses) {
-					index = len(tt.responses) - 1
-				}
-				calls++
-				_, _ = fmt.Fprint(w, tt.responses[index])
-			}))
-			defer server.Close()
-
-			sites, issue := fetchDevEnvSyncSites(t.Context(), graphql.NewClient(server.URL, server.Client()), 42, 7, nil)
-			if issue != tt.wantIssue {
-				t.Fatalf("issue = %q, want %q; sites=%#v", issue, tt.wantIssue, sites)
-			}
-			if len(sites) != 0 {
-				t.Fatalf("unsafe catalog returned trusted sites: %#v", sites)
-			}
-		})
-	}
-}
-
-func TestFetchDevEnvSyncSitesDeduplicatesIdenticalNodes(t *testing.T) {
-	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-		w.Header().Set("Content-Type", "application/json")
-		_, _ = w.Write([]byte(`{"data":{"app":{"environments":[{"wpSitesSDS":{"total":2,"nextCursor":null,"nodes":[{"blogId":1,"homeUrl":"https://primary.example.com","siteUrl":"https://primary.example.com/wp"},{"blogId":1,"homeUrl":"https://primary.example.com","siteUrl":"https://primary.example.com/wp"}]}}]}}}`))
-	}))
-	defer server.Close()
-
-	sites, issue := fetchDevEnvSyncSites(t.Context(), graphql.NewClient(server.URL, server.Client()), 42, 7, nil)
-	if issue != "" || len(sites) != 1 {
-		t.Fatalf("sites=%#v issue=%q, want one deduplicated site", sites, issue)
-	}
-}
-
-func TestFetchDevEnvSyncSitesRejectsConflictingDuplicateIDs(t *testing.T) {
-	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-		w.Header().Set("Content-Type", "application/json")
-		_, _ = w.Write([]byte(`{"data":{"app":{"environments":[{"wpSitesSDS":{"total":2,"nextCursor":null,"nodes":[{"blogId":1,"homeUrl":"https://primary.example.com"},{"blogId":1,"homeUrl":"https://other.example.com"}]}}]}}}`))
-	}))
-	defer server.Close()
-
-	sites, issue := fetchDevEnvSyncSites(t.Context(), graphql.NewClient(server.URL, server.Client()), 42, 7, nil)
-	if issue != "invalid_nodes" || len(sites) != 0 {
-		t.Fatalf("sites=%#v issue=%q", sites, issue)
-	}
-}
-
-func TestFetchDevEnvSyncSitesDoesNotLeakRawTransportErrors(t *testing.T) {
-	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-		http.Error(w, "secret upstream details", http.StatusBadGateway)
-	}))
-	defer server.Close()
-
-	_, issue := fetchDevEnvSyncSites(t.Context(), graphql.NewClient(server.URL, server.Client()), 42, 7, nil)
-	if strings.Contains(issue, "secret") || issue != "transport" {
-		t.Fatalf("issue = %q", issue)
-	}
-}

package/cmd/vip-next/commands/devenv_sync_test.go

@@ -1,63 +0,0 @@
-package commands
-
-import (
-	"errors"
-	"strings"
-	"testing"
-
-	"github.com/spf13/cobra"
-
-	"github.com/Automattic/vip/internal/devenv"
-)
-
-func TestDevEnvSyncSQLSearchReplaceFlagIsRepeatableWithShortForm(t *testing.T) {
-	cmd := newDevEnvSyncSQLCmd()
-	if err := cmd.ParseFlags([]string{"-r", "one.example,a.local.vipdev.site", "--search-replace", "two.example,b.local.vipdev.site"}); err != nil {
-		t.Fatal(err)
-	}
-	got, err := cmd.Flags().GetStringArray("search-replace")
-	if err != nil {
-		t.Fatal(err)
-	}
-	if strings.Join(got, "|") != "one.example,a.local.vipdev.site|two.example,b.local.vipdev.site" {
-		t.Fatalf("search-replace = %#v", got)
-	}
-}
-
-func TestResolveSyncMappingsNonInteractivePrintsCopyableFlags(t *testing.T) {
-	cmd := &cobra.Command{Use: "test"}
-	draft := devenv.PlanDraft{Unresolved: []devenv.UnresolvedMapping{
-		{Source: "missing.example.com", Reason: "transport"},
-		{Source: "deep.mapped.example.net/path", Reason: "missing_sds_mapping"},
-	}}
-	_, err := resolveSyncMappingsCore(cmd, draft, "mysite.vipdev.site", false, nil)
-	if err == nil {
-		t.Fatal("expected non-interactive unresolved error")
-	}
-	for _, want := range []string{"missing.example.com", "deep.mapped.example.net/path", `-r "missing.example.com,`, "mysite.vipdev.site"} {
-		if !strings.Contains(err.Error(), want) {
-			t.Errorf("error missing %q: %v", want, err)
-		}
-	}
-}
-
-func TestResolveSyncMappingsInteractiveCollectsPairsAndCancels(t *testing.T) {
-	cmd := &cobra.Command{Use: "test"}
-	draft := devenv.PlanDraft{Unresolved: []devenv.UnresolvedMapping{{Source: "missing.example.com"}}}
-	pairs, err := resolveSyncMappingsCore(cmd, draft, "mysite.vipdev.site", true,
-		func(_ *cobra.Command, message, fallback string) (string, error) {
-			if !strings.Contains(message, "missing.example.com") || fallback == "" {
-				t.Fatalf("message=%q fallback=%q", message, fallback)
-			}
-			return "recovered.mysite.vipdev.site", nil
-		})
-	if err != nil || len(pairs) != 1 || pairs[0] != "missing.example.com,recovered.mysite.vipdev.site" {
-		t.Fatalf("pairs=%#v err=%v", pairs, err)
-	}
-
-	_, err = resolveSyncMappingsCore(cmd, draft, "mysite.vipdev.site", true,
-		func(*cobra.Command, string, string) (string, error) { return "", errors.New("interrupt") })
-	if !errors.Is(err, devenv.ErrSyncCancelled) {
-		t.Fatalf("cancel err = %v", err)
-	}
-}

package/cmd/vip-next/commands/devenv_telemetry.go

@@ -1,265 +0,0 @@
-package commands
-
-import (
-	"bytes"
-	"context"
-	"encoding/json"
-	"errors"
-	"math"
-	"os"
-	"path/filepath"
-	"strings"
-	"time"
-
-	"github.com/Automattic/vip/internal/appctx"
-	"github.com/Automattic/vip/internal/devenv"
-	"github.com/Automattic/vip/internal/devenv/dockercli"
-	"github.com/Automattic/vip/internal/devenv/paths"
-	"github.com/Automattic/vip/internal/searchreplace"
-	"github.com/Automattic/vip/internal/telemetry"
-	"github.com/spf13/cobra"
-)
-
-type devEnvTelemetryKey struct{}
-
-type devEnvTelemetryState struct {
-	name     string
-	args     []string
-	info     map[string]any
-	started  time.Time
-	canceled bool
-}
-
-var devEnvEventNames = map[string]string{
-	"create": "dev_env_create_command_", "start": "dev_env_start_command_",
-	"stop": "dev_env_stop_command_", "destroy": "dev_env_destroy_command_",
-	"info": "dev_env_info_command_", "list": "dev_env_list_command_",
-	"purge": "dev_env_purge_command_", "update": "dev_env_update_command_",
-	"exec": "dev_env_exec_command_", "shell": "dev_env_shell_command_",
-	"logs": "dev_env_logs_command_", "import sql": "dev_env_import_sql_command_",
-	"import media": "dev_env_import_media_command_", "sync sql": "dev_env_sync_sql_command_",
-	"envvar get": "dev_env_envvar_get_command_", "envvar get-all": "dev_env_envvar_get_all_command_",
-	"envvar list": "dev_env_envvar_list_command_", "envvar set": "dev_env_envvar_set_command_",
-	"envvar delete": "dev_env_envvar_delete_command_",
-}
-
-// installDevEnvTelemetry wraps leaves after their middleware is built. Slug
-// commands emit execute from ResolveSlug, after resolution as Node does.
-func installDevEnvTelemetry(root *cobra.Command) {
-	var visit func(*cobra.Command, string)
-	visit = func(parent *cobra.Command, prefix string) {
-		for _, child := range parent.Commands() {
-			path := strings.TrimSpace(prefix + " " + child.Name())
-			if child.RunE != nil {
-				if name, ok := devEnvEventNames[path]; ok {
-					original := child.RunE
-					child.RunE = func(cmd *cobra.Command, args []string) error {
-						state := &devEnvTelemetryState{name: name, args: args}
-						ctx := cmd.Context()
-						if ctx == nil {
-							ctx = context.Background()
-						}
-						cmd.SetContext(context.WithValue(ctx, devEnvTelemetryKey{}, state))
-						if path == "list" || ((path == "info" || path == "stop") && devEnvAllFlag(cmd)) {
-							devEnvTrackingBegin(cmd, map[string]any{"all": true})
-						}
-						err := original(cmd, args)
-						if state.started.IsZero() || state.canceled {
-							return err
-						}
-						if err != nil {
-							if path == "sync sql" && errors.Is(err, devenv.ErrEnvironmentNotStarted) {
-								props := devEnvTrackingCopy(state.info)
-								props["errorMessage"] = "Environment was not running"
-								trackEvent(name+"env_not_running_error", props)
-								return err
-							}
-							props := devEnvTrackingCopy(state.info)
-							props["failure"] = telemetry.ScrubErrorText(err.Error())
-							trackEvent(name+"error", props)
-							return err
-						}
-						props := devEnvTrackingCopy(state.info)
-						if path == "start" {
-							props["processing_time"] = int64(math.Ceil(time.Since(state.started).Seconds()))
-						}
-						trackEvent(name+"success", props)
-						return nil
-					}
-				}
-			}
-			visit(child, path)
-		}
-	}
-	visit(root, "")
-}
-
-func devEnvAllFlag(cmd *cobra.Command) bool {
-	if cmd.Flags().Lookup("all") == nil {
-		return false
-	}
-	all, _ := cmd.Flags().GetBool("all")
-	return all
-}
-
-func devEnvTrackingCopy(info map[string]any) map[string]any {
-	copyInfo := make(map[string]any, len(info))
-	for k, v := range info {
-		copyInfo[k] = v
-	}
-	return copyInfo
-}
-
-func devEnvTrackingState(cmd *cobra.Command) *devEnvTelemetryState {
-	ctx := cmd.Context()
-	if ctx == nil {
-		return nil
-	}
-	state, _ := ctx.Value(devEnvTelemetryKey{}).(*devEnvTelemetryState)
-	return state
-}
-
-func devEnvTrackingBegin(cmd *cobra.Command, info map[string]any) {
-	state := devEnvTrackingState(cmd)
-	if state == nil || !state.started.IsZero() {
-		return
-	}
-	state.info = devEnvTrackingCopy(info)
-	state.started = time.Now()
-	trackEvent(state.name+"execute", devEnvTrackingCopy(state.info))
-}
-
-func devEnvTrackingResolved(cmd *cobra.Command, slug string) {
-	state := devEnvTrackingState(cmd)
-	if state == nil {
-		return
-	}
-	info := devEnvTrackingInfo(slug)
-	if cmd.Name() == "sql" && cmd.Parent() != nil && cmd.Parent().Name() == "import" {
-		if len(state.args) > 0 {
-			details, err := searchreplace.GetSqlDumpDetails(state.args[0])
-			if err != nil {
-				return // Node determines dump type before its execute event.
-			}
-			info["sqldump_type"] = string(details.Type)
-		}
-	}
-	if cmd.Name() == "sql" && cmd.Parent() != nil && cmd.Parent().Name() == "sync" {
-		if ae := appctx.FromContext(cmd.Context()); ae != nil {
-			info = map[string]any{
-				"app": ae.App.ID, "env": ae.Env.UniqueLabel,
-				"slug": slug, "multisite": ae.Env.IsMultisite,
-			}
-		}
-	}
-	if cmd.Name() == "start" {
-		editor, _ := cmd.Flags().GetString("editor")
-		vscode, _ := cmd.Flags().GetBool("vscode")
-		if editor == "" && vscode {
-			editor = "vscode"
-		}
-		if editor != "" {
-			info["editor"] = editor
-		}
-		info["vscode"] = vscode
-		versions := (&dockercli.Runner{}).Versions(cmd.Context())
-		info["docker"] = versions.Engine
-		info["docker_compose"] = versions.Compose
-		info["compose_plugin"] = versions.ComposePlugin
-	}
-	devEnvTrackingBegin(cmd, info)
-}
-
-func devEnvTrackingCreate(cmd *cobra.Command, slug string) {
-	info := map[string]any{"slug": slug}
-	if app, _ := cmd.Flags().GetString("app"); app != "" {
-		info["app"] = app
-	}
-	if env, _ := cmd.Flags().GetString("env"); env != "" {
-		info["env"] = env
-	}
-	devEnvTrackingBegin(cmd, info)
-}
-
-func devEnvTrackingCancelled(cmd *cobra.Command) {
-	state := devEnvTrackingState(cmd)
-	if state != nil {
-		state.canceled = true
-	}
-}
-
-func devEnvTrackingSpecial(cmd *cobra.Command, name string) {
-	state := devEnvTrackingState(cmd)
-	if state != nil && !state.started.IsZero() {
-		trackEvent(name, devEnvTrackingCopy(state.info))
-	}
-}
-
-// devEnvTrackingInfo mirrors Node's getEnvTrackingInfo for the shared instance
-// fields. Only known Node fields are eligible: Go also stores user environment
-// variables and volume metadata in instance_data.json, neither of which belongs
-// in telemetry. Local login credentials are excluded in both runtimes.
-func devEnvTrackingInfo(slug string) map[string]any {
-	info := map[string]any{"slug": slug}
-	data, err := os.ReadFile(filepath.Join(paths.EnvironmentPath(slug), "instance_data.json"))
-	if err != nil {
-		return info
-	}
-	var fields map[string]json.RawMessage
-	if err := json.Unmarshal(data, &fields); err != nil {
-		return info
-	}
-	// Node's readEnvironmentData maps these legacy names before tracking.
-	if legacy, ok := fields["clientCode"]; ok && string(legacy) != "null" {
-		fields["appCode"] = legacy
-	}
-	for _, legacyKey := range []string{"enterpriseSearchEnabled", "elasticsearchEnabled"} {
-		if legacy, ok := fields[legacyKey]; ok && string(legacy) == "true" {
-			fields["elasticsearch"] = legacy
-			break
-		}
-	}
-	for _, key := range []string{
-		"siteSlug", "wpTitle", "multisite", "wordpress", "muPlugins", "appCode",
-		"mediaRedirectDomain", "phpmyadmin", "xdebug", "xdebugConfig", "mariadb",
-		"php", "elasticsearch", "mailpit", "photon", "cron", "pullAfter",
-		"version",
-	} {
-		raw, ok := fields[key]
-		if !ok {
-			continue
-		}
-		var value any
-		if key == "wordpress" || key == "muPlugins" || key == "appCode" {
-			var compact bytes.Buffer
-			if err := json.Compact(&compact, raw); err != nil {
-				continue
-			}
-			value = compact.String()
-		} else if err := json.Unmarshal(raw, &value); err != nil {
-			continue
-		}
-		if key == "php" {
-			if php, ok := value.(string); ok {
-				if colon := strings.IndexByte(php, ':'); colon >= 0 {
-					value = php[colon+1:]
-				}
-			}
-		}
-		info[devEnvSnakeCase(key)] = value
-	}
-	return info
-}
-
-func devEnvSnakeCase(key string) string {
-	var b strings.Builder
-	for _, r := range key {
-		if r >= 'A' && r <= 'Z' {
-			b.WriteByte('_')
-			b.WriteRune(r + ('a' - 'A'))
-		} else {
-			b.WriteRune(r)
-		}
-	}
-	return b.String()
-}