@automattic/vip 4.1.3 → 4.1.4

package/cmd/vip-next/debug_test.go

@@ -0,0 +1,122 @@
+package main
+
+import (
+	"bytes"
+	"fmt"
+	"strings"
+	"testing"
+
+	"github.com/Automattic/vip/cmd/vip-next/commands"
+	"github.com/Automattic/vip/internal/debuglog"
+	"github.com/spf13/cobra"
+)
+
+func TestDebugEnablesDiagnosticsOnStderr(t *testing.T) {
+	for _, tc := range []struct {
+		name    string
+		args    []string
+		env     string
+		enabled bool
+	}{
+		{"default", nil, "", false},
+		{"short", []string{"-d"}, "", true},
+		{"long", []string{"--debug"}, "", true},
+		{"equals", []string{"-d=@automattic/vip:http"}, "", true},
+		{"separate", []string{"--debug", "@automattic/vip:http"}, "", true},
+		{"separate nonmatching", []string{"--debug", "unrelated"}, "", false},
+		{"excluded", []string{"--debug=*,-@automattic/vip:http"}, "", false},
+		{"environment", nil, "@automattic/vip:*", true},
+		{"flag overrides environment", []string{"--debug=other"}, "*", false},
+		{"empty flag keeps environment", []string{"--debug="}, "*", true},
+	} {
+		t.Run(tc.name, func(t *testing.T) {
+			t.Setenv("DEBUG", tc.env)
+			var stdout, stderr bytes.Buffer
+			root := newRootBase(&rootContext{})
+			root.SetOut(&stdout)
+			root.SetErr(&stderr)
+			root.AddCommand(&cobra.Command{Use: "probe", RunE: func(cmd *cobra.Command, args []string) error {
+				if len(args) != 0 {
+					t.Fatalf("namespace leaked into positional arguments: %q", args)
+				}
+				debuglog.Printf(cmd.Context(), "@automattic/vip:http", "running fetch")
+				_, err := fmt.Fprintln(cmd.OutOrStdout(), `{"ok":true}`)
+				return err
+			}})
+			root.SetArgs(prepareArgs(root, append([]string{"probe"}, tc.args...)))
+			if err := root.Execute(); err != nil {
+				t.Fatal(err)
+			}
+			if stdout.String() != "{\"ok\":true}\n" {
+				t.Fatalf("stdout polluted: %q", stdout.String())
+			}
+			if got := strings.Contains(stderr.String(), "running fetch"); got != tc.enabled {
+				t.Fatalf("diagnostics enabled=%v, want %v; stderr=%q", got, tc.enabled, stderr.String())
+			}
+		})
+	}
+}
+
+func TestWPDebugBeforeCommandPreservesPassthrough(t *testing.T) {
+	for _, tc := range []struct {
+		args    []string
+		want    []string
+		enabled bool
+	}{
+		{[]string{"-d", "wp", "option", "get", "secret", "--debug"}, []string{"option", "get", "secret", "--debug"}, true},
+		{[]string{"--debug=@automattic/vip:wp", "wp", "--", "--debug"}, []string{"--", "--debug"}, true},
+		{[]string{"--debug", "@automattic/vip:wp", "wp", "option", "get"}, []string{"option", "get"}, true},
+		{[]string{"--debug", "@automattic/vip:wp", "--", "wp", "user", "list"}, []string{"user", "list"}, true},
+		{[]string{"--debug", "@automattic/vip:wp", "--yes", "wp", "user", "list"}, []string{"user", "list"}, true},
+		{[]string{"wp", "--debug"}, []string{"--debug"}, false},
+	} {
+		t.Run(strings.Join(tc.args, " "), func(t *testing.T) {
+			t.Setenv("DEBUG", "")
+			var stderr bytes.Buffer
+			root := newRootBase(&rootContext{})
+			root.SetErr(&stderr)
+			wp := commands.WPCmd()
+			wp.RunE = func(cmd *cobra.Command, args []string) error {
+				if strings.Join(args, "|") != strings.Join(tc.want, "|") {
+					t.Fatalf("passthrough changed: %q", args)
+				}
+				debuglog.Printf(cmd.Context(), "@automattic/vip:wp", "connect")
+				return nil
+			}
+			root.AddCommand(wp)
+			normalized, _ := normalizeWPArgs(tc.args)
+			root.SetArgs(prepareArgs(root, normalized))
+			if err := root.Execute(); err != nil {
+				t.Fatal(err)
+			}
+			if (stderr.Len() > 0) != tc.enabled {
+				t.Fatalf("debug output=%q, enabled=%v", stderr.String(), tc.enabled)
+			}
+		})
+	}
+}
+
+func TestDebugSelectorPositions(t *testing.T) {
+	for _, argv := range [][]string{
+		{"--debug", "selected", "parent", "leaf"},
+		{"parent", "-d", "selected", "leaf"},
+		{"parent", "leaf", "--debug", "selected"},
+	} {
+		t.Run(strings.Join(argv, " "), func(t *testing.T) {
+			root := newRootBase(&rootContext{})
+			parent := &cobra.Command{Use: "parent"}
+			parent.AddCommand(&cobra.Command{Use: "leaf", RunE: func(cmd *cobra.Command, args []string) error {
+				selector, _ := cmd.Flags().GetString("debug")
+				if selector != "selected" || len(args) != 0 {
+					t.Fatalf("selector=%q args=%q", selector, args)
+				}
+				return nil
+			}})
+			root.AddCommand(parent)
+			root.SetArgs(prepareArgs(root, argv))
+			if err := root.Execute(); err != nil {
+				t.Fatal(err)
+			}
+		})
+	}
+}

package/cmd/vip-next/main.go

@@ -11,6 +11,7 @@
 package main
 
 import (
+	"context"
 	"errors"
 	"log/slog"
 	"os"
@@ -22,6 +23,7 @@ import (
 	"github.com/Automattic/vip/cmd/vip-next/commands"
 	"github.com/Automattic/vip/internal/appctx"
 	"github.com/Automattic/vip/internal/auth"
+	"github.com/Automattic/vip/internal/debuglog"
 	"github.com/Automattic/vip/internal/envalias"
 	"github.com/Automattic/vip/internal/exit"
 	"github.com/Automattic/vip/internal/gql"
@@ -82,6 +84,9 @@ func cliErrorHook(tracker *telemetry.Tracker) func(error) {
 }
 
 func runWithDeps(argv []string, deps runDeps) error {
+	// As in Node, DEBUG applies during login bootstrap; command flags take
+	// precedence once the command parser installs its invocation context.
+	deps.Tracker.SetContext(debuglog.WithLogger(context.Background(), os.Getenv("DEBUG"), os.Stderr))
 	rewritten, app, env, err := envalias.Rewrite(argv)
 	if err != nil {
 		return err
@@ -117,7 +122,7 @@ func runWithDeps(argv []string, deps runDeps) error {
 
 	var rootRef *cobra.Command
 	executeRoot := func() error {
-		rc := &rootContext{aliasApp: app, aliasEnv: env}
+		rc := &rootContext{aliasApp: app, aliasEnv: env, tracker: deps.Tracker}
 		rootRef = newRootCmd(rc)
 		rootRef.SetArgs(prepareArgs(rootRef, rewritten))
 		finish := installUpdateNotifier(rootRef, deps.StartUpdateNotice)
@@ -134,6 +139,7 @@ func runWithDeps(argv []string, deps runDeps) error {
 	apiHost := defaultAPIHost()
 	k := deps.NewKeychain(apiHost)
 	store := auth.NewStore(k)
+	deps.Tracker.SetPendoTokenSource(store.Load)
 	if !auth.ShouldBypassAuth(argv) {
 		return withAuthenticatedSession(!isNonInteractiveArgv(argv), authBootstrapDeps{
 			Keychain: k,
@@ -256,9 +262,54 @@ func defaultAPIHost() string {
 // its omitted-value default and drop the "n" on the floor, inverting Node,
 // where "n" DISABLES the service. See internal/nodeflags.
 func prepareArgs(root *cobra.Command, argv []string) []string {
+	argv = normalizeDebugValues(root, argv)
+	argv = prepareWPDebugArgs(root, argv)
 	return nodeflags.NormalizeOptionalValues(root, argv)
 }
 
+// WP-CLI owns every token after "wp". Cobra disables parsing for that command,
+// including flags before it, so consume only VIP's leading debug selector here.
+func prepareWPDebugArgs(root *cobra.Command, argv []string) []string {
+	var kept []string
+	selector := ""
+	found := false
+	for i := 0; i < len(argv); i++ {
+		tok := argv[i]
+		if tok == "wp" {
+			if !found {
+				return argv
+			}
+			_ = root.PersistentFlags().Set("debug", selector)
+			return append(kept, argv[i:]...)
+		}
+		if tok == "--" || !strings.HasPrefix(tok, "-") {
+			return argv
+		}
+		if tok == "-d" || tok == "--debug" {
+			selector, found = "*", true
+			if i+1 < len(argv) && argv[i+1] != "wp" && !strings.HasPrefix(argv[i+1], "-") {
+				i++
+				selector = argv[i]
+			}
+			continue
+		}
+		if strings.HasPrefix(tok, "--debug=") || strings.HasPrefix(tok, "-d=") {
+			_, selector, _ = strings.Cut(tok, "=")
+			found = true
+			continue
+		}
+		kept = append(kept, tok)
+		// Skip values of other leading global flags without changing them.
+		if tok == "--app" || tok == "--env" {
+			if i+1 < len(argv) {
+				i++
+				kept = append(kept, argv[i])
+			}
+		}
+	}
+	return argv
+}
+
 // normalizeWPArgs reshapes a post-envalias argv so cobra can route the
 // `vip wp` command. wp is special: everything after the `wp` token is a
 // raw WP-CLI command (with its own flags) that the wp command passes
@@ -276,7 +327,12 @@ func prepareArgs(root *cobra.Command, argv []string) []string {
 // non-"--" token is "wp"). Everything else passes through untouched.
 func normalizeWPArgs(argv []string) (out []string, yes bool) {
 	cmdIdx := -1
-	for i, tok := range argv {
+	for i := 0; i < len(argv); i++ {
+		tok := argv[i]
+		if (tok == "--debug" || tok == "-d") && i+1 < len(argv) && argv[i+1] != "wp" && !strings.HasPrefix(argv[i+1], "-") {
+			i++ // A separated debug namespace is not the command name.
+			continue
+		}
 		if tok == "--" || strings.HasPrefix(tok, "-") {
 			continue
 		}

package/cmd/vip-next/pendo_wiring_test.go

@@ -0,0 +1,148 @@
+package main
+
+import (
+	"bytes"
+	"fmt"
+	"io"
+	"net/http"
+	"net/http/httptest"
+	"os"
+	"strings"
+	"testing"
+
+	"github.com/Automattic/vip/internal/auth"
+	"github.com/Automattic/vip/internal/keychain"
+	"github.com/Automattic/vip/internal/telemetry"
+	"github.com/spf13/cobra"
+)
+
+// The Pendo endpoint requires the same bearer as the command API. A payload-only
+// test with an always-200 server did not catch the missing authentication.
+func TestPendoUsesCommandSession(t *testing.T) {
+	for _, mode := range []string{"stored", "bypassed", "login"} {
+		t.Run(mode, func(t *testing.T) {
+			for _, name := range []string{"DO_NOT_TRACK", "GO_ENV", "NODE_ENV", "VIP_TOKEN_OVERRIDE", "WPVIP_DEPLOY_TOKEN", "VIP_PROXY", "vip_proxy", "VIP_USE_SYSTEM_PROXY"} {
+				t.Setenv(name, "")
+			}
+			raw := validBootstrapRaw(t, 10000)
+			accepted, rejected := 0, 0
+			pendo := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+				if r.Header.Get("Authorization") != "Bearer "+raw {
+					rejected++
+					w.WriteHeader(http.StatusUnauthorized)
+					return
+				}
+				accepted++
+			}))
+			defer pendo.Close()
+			tracker := &telemetry.Tracker{Clients: []telemetry.Client{&telemetry.PendoClient{Endpoint: pendo.URL, UserID: "fixture"}}}
+			rec := &gqlOpRecorder{}
+			api := rec.server(t, map[string]string{
+				"ResolveAppByName":                  resolveAppByNameBody,
+				"GetEnvironmentVariablesWithValues": envVarsWithValuesBody,
+			})
+			defer api.Close()
+			t.Setenv("API_HOST", api.URL)
+			k := newBootstrapKeychain(&bootstrapBackend{})
+			if mode != "login" {
+				if err := auth.NewStore(k).Save(raw); err != nil {
+					t.Fatal(err)
+				}
+			}
+			variable := "HELP"
+			if mode == "bypassed" {
+				variable = "help"
+			}
+			err := runWithDeps([]string{"config", "envvar", "get", variable, "--app", "example", "--env", "develop"}, runDeps{
+				Tracker:     tracker,
+				NewKeychain: func(string) *keychain.Keychain { return k },
+				NewLogin: func(store *auth.Store) func() (*auth.Token, error) {
+					return func() (*auth.Token, error) {
+						// Login events before saving a token must not issue anonymous requests.
+						tracker.TrackEvent("login_command_execute", nil)
+						if err := store.Save(raw); err != nil {
+							return nil, err
+						}
+						tracker.AliasUser(10000)
+						return parsedBootstrapToken(t, raw), nil
+					}
+				},
+			})
+			if err != nil {
+				t.Fatal(err)
+			}
+			if rejected != 0 || accepted < 2 {
+				t.Fatalf("Pendo accepted=%d rejected=%d; expected authenticated command events only", accepted, rejected)
+			}
+		})
+	}
+}
+
+func TestPendoDebugFlagReachesClient(t *testing.T) {
+	for _, name := range []string{"DO_NOT_TRACK", "GO_ENV", "NODE_ENV", "DEBUG"} {
+		t.Setenv(name, "")
+	}
+	var out, diagnostics bytes.Buffer
+	srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { w.WriteHeader(401) }))
+	defer srv.Close()
+	tr := &telemetry.Tracker{Clients: []telemetry.Client{&telemetry.PendoClient{Endpoint: srv.URL, HTTP: srv.Client(), GetToken: func() (string, error) { return "private-token", nil }}}}
+	root := newRootBase(&rootContext{tracker: tr})
+	root.SetOut(&out)
+	root.SetErr(&diagnostics)
+	root.AddCommand(&cobra.Command{Use: "probe", Run: func(cmd *cobra.Command, _ []string) {
+		tr.TrackEvent("test", nil)
+		fmt.Fprintln(cmd.OutOrStdout(), "ok")
+	}})
+	root.SetArgs([]string{"probe", "-d"})
+	if err := root.Execute(); err != nil {
+		t.Fatal(err)
+	}
+	if out.String() != "ok\n" || !strings.Contains(diagnostics.String(), "401") || strings.Contains(diagnostics.String(), "private-token") {
+		t.Fatalf("stdout=%q stderr=%q", out.String(), diagnostics.String())
+	}
+}
+
+func TestPendoImplicitLoginUsesDebugEnvironment(t *testing.T) {
+	for _, name := range []string{"DO_NOT_TRACK", "GO_ENV", "NODE_ENV", "VIP_TOKEN_OVERRIDE", "WPVIP_DEPLOY_TOKEN"} {
+		t.Setenv(name, "")
+	}
+	t.Setenv("DEBUG", "@automattic/vip:analytics:clients:pendo")
+	// Like Node, DEBUG is available during bootstrap, before command flag parsing.
+	output, err := os.CreateTemp(t.TempDir(), "stderr")
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer output.Close()
+	previous := os.Stderr
+	os.Stderr = output
+	defer func() { os.Stderr = previous }()
+	srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { w.WriteHeader(401) }))
+	defer srv.Close()
+	tr := &telemetry.Tracker{Clients: []telemetry.Client{&telemetry.PendoClient{Endpoint: srv.URL, HTTP: srv.Client()}}}
+	k := newBootstrapKeychain(&bootstrapBackend{})
+	err = runWithDeps([]string{"whoami"}, runDeps{
+		Tracker: tr, NewKeychain: func(string) *keychain.Keychain { return k },
+		NewLogin: func(store *auth.Store) func() (*auth.Token, error) {
+			return func() (*auth.Token, error) {
+				if err := store.Save("private-token"); err != nil {
+					return nil, err
+				}
+				tr.TrackEvent("login_command_token_submit_success", nil)
+				return nil, auth.ErrLoginCancelled // stop before any command API requests
+			}
+		},
+	})
+	if err != nil {
+		t.Fatal(err)
+	}
+	if _, err := output.Seek(0, 0); err != nil {
+		t.Fatal(err)
+	}
+	diagnostics, err := io.ReadAll(output)
+	if err != nil {
+		t.Fatal(err)
+	}
+	if !strings.Contains(string(diagnostics), "401") || strings.Contains(string(diagnostics), "private-token") {
+		t.Fatalf("bootstrap diagnostics=%q", diagnostics)
+	}
+}

package/cmd/vip-next/root.go

@@ -1,17 +1,22 @@
 package main
 
 import (
+	"context"
 	"errors"
+	"os"
 
 	"github.com/spf13/cobra"
 
 	"github.com/Automattic/vip/cmd/vip-next/commands"
 	"github.com/Automattic/vip/internal/appctx"
+	"github.com/Automattic/vip/internal/debuglog"
+	"github.com/Automattic/vip/internal/telemetry"
 	"github.com/Automattic/vip/internal/update"
 	"github.com/Automattic/vip/internal/version"
 )
 
 type rootContext struct {
+	tracker      *telemetry.Tracker
 	updateRunner commands.UpdateRunner
 	aliasApp     string
 	aliasEnv     string
@@ -43,6 +48,18 @@ func newRootBase(rc *rootContext) *cobra.Command {
 	root.PersistentFlags().Bool("non-interactive", false, "disable prompts; fail fast if a required flag is missing")
 
 	root.PersistentPreRunE = func(cmd *cobra.Command, args []string) error {
+		namespaces := os.Getenv("DEBUG")
+		if cmd.Flags().Changed("debug") {
+			if value, _ := cmd.Flags().GetString("debug"); value != "" {
+				namespaces = value
+			}
+		}
+		ctx := cmd.Context()
+		if ctx == nil {
+			ctx = context.Background()
+		}
+		cmd.SetContext(debuglog.WithLogger(ctx, namespaces, cmd.ErrOrStderr()))
+		rc.tracker.SetContext(cmd.Context())
 		flagApp, _ := cmd.Flags().GetString("app")
 		flagEnv, _ := cmd.Flags().GetString("env")
 		hasAlias := rc.aliasApp != "" || rc.aliasEnv != ""

package/dist/bin/vip-dev-env-envvar-get.js

@@ -15,7 +15,7 @@ const examples = [{
   usage: `${exampleUsage} MY_VARIABLE`,
   description: 'Retrieve the value of the local environment variable "MY_VARIABLE".'
 }];
-async function getEnvVarsCommand(args, opt) {
+async function getEnvVarCommand(args, opt) {
   (0, _logging.debug)('args: %o, opt: %o', args, opt);
   const slug = await (0, _devEnvironmentCli.getEnvironmentName)(opt);
   const trackingInfo = (0, _devEnvironmentCli.getEnvTrackingInfo)(slug);
@@ -41,4 +41,4 @@ async function getEnvVarsCommand(args, opt) {
 (0, _command.default)({
   requiredArgs: 1,
   usage
-}).option('slug', 'A unique name for a local environment. Default is "vip-local".', undefined, _devEnvironmentCli.processSlug).examples(examples).argv(process.argv, getEnvVarsCommand);
+}).option('slug', 'A unique name for a local environment. Default is "vip-local".', undefined, _devEnvironmentCli.processSlug).examples(examples).argv(process.argv, getEnvVarCommand);

package/dist/bin/vip-dev-env-envvar-set.js

@@ -24,7 +24,7 @@ const examples = [{
   usage: `${exampleUsage} MULTILINE_ENV_VAR --from-file=envvar-value.txt`,
   description: 'Add or update the local environment variable "MULTILINE_ENV_VAR" and assign the multiline contents of local file envvar-value.txt as its value.'
 }];
-async function deleteEnvVarCommand(args, opt) {
+async function setEnvVarCommand(args, opt) {
   (0, _logging.debug)('args: %o, opt: %o', args, opt);
   const slug = await (0, _devEnvironmentCli.getEnvironmentName)(opt);
   const trackingInfo = (0, _devEnvironmentCli.getEnvTrackingInfo)(slug);
@@ -76,4 +76,4 @@ async function deleteEnvVarCommand(args, opt) {
   requiredArgs: 1,
   wildcardCommand: true,
   usage
-}).option('slug', 'A unique name for a local environment. Default is "vip-local".', undefined, _devEnvironmentCli.processSlug).option('from-file', 'Read environment variable value from a UTF-8-encoded text file (useful for multiline input). Accepts a relative or absolute path.').examples(examples).argv(process.argv, deleteEnvVarCommand);
+}).option('slug', 'A unique name for a local environment. Default is "vip-local".', undefined, _devEnvironmentCli.processSlug).option('from-file', 'Read environment variable value from a UTF-8-encoded text file (useful for multiline input). Accepts a relative or absolute path.').examples(examples).argv(process.argv, setEnvVarCommand);

package/dist/bin/vip-dev-env-update.js

@@ -61,7 +61,7 @@ cmd.argv(process.argv, async (arg, opt) => {
       muPlugins: currentInstanceData.muPlugins.dir || currentInstanceData.muPlugins.tag || 'demo',
       wordpress: currentInstanceData.wordpress.tag || 'trunk',
       elasticsearch: currentInstanceData.elasticsearch,
-      php: currentInstanceData.php || _devEnvironment.DEV_ENVIRONMENT_PHP_VERSIONS[Object.keys(_devEnvironment.DEV_ENVIRONMENT_PHP_VERSIONS)[0]].image,
+      php: currentInstanceData.php || _devEnvironment.DEV_ENVIRONMENT_PHP_VERSIONS[_devEnvironment.DEV_ENVIRONMENT_DEFAULT_PHP_VERSION].image,
       mariadb: currentInstanceData.mariadb,
       phpmyadmin: currentInstanceData.phpmyadmin,
       xdebug: currentInstanceData.xdebug,

package/dist/lib/analytics/clients/pendo.js

@@ -4,6 +4,7 @@ exports.__esModule = true;
 exports.default = void 0;
 var _debug = _interopRequireDefault(require("debug"));
 var _http = _interopRequireDefault(require("../../../lib/api/http"));
+var _token = _interopRequireDefault(require("../../token"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const debug = (0, _debug.default)('@automattic/vip:analytics:clients:pendo');
 /**
@@ -27,7 +28,7 @@ class Pendo {
     if (!eventName.startsWith(this.eventPrefix)) {
       eventName = this.eventPrefix + eventName;
     }
-    debug('trackEvent()', eventProps);
+    debug('trackEvent()');
     this.context = {
       ...this.context,
       org_id: eventProps.org_slug,
@@ -38,12 +39,17 @@ class Pendo {
     };
     try {
       return await this.send(eventName, eventProps);
-    } catch (error) {
-      debug(error);
-      return Promise.resolve(false);
+    } catch {
+      debug('Pendo event delivery failed');
+      return false;
     }
   }
   async send(eventName, eventProps) {
+    const token = await _token.default.get();
+    if (!token.raw) {
+      debug('Skipping Pendo event: authentication token unavailable');
+      throw new Error('Pendo authentication token unavailable');
+    }
     const body = {
       context: this.context,
       event: eventName,
@@ -53,13 +59,19 @@ class Pendo {
       visitorId: `${this.context.userId}`,
       accountId: `${this.context.org_sfid}`
     };
-    debug('send()', body);
+    debug('send()');
     const response = await (0, _http.default)(Pendo.ENDPOINT, {
       method: 'POST',
+      headers: {
+        Authorization: `Bearer ${token.raw}`
+      },
       body: JSON.stringify(body)
     });
-    const responseText = await response.text();
-    debug('response', responseText);
+    await response.text();
+    debug('Pendo response status=%d', response.status);
+    if (!response.ok) {
+      throw new Error(`Pendo request failed with HTTP ${response.status}`);
+    }
     return response;
   }
 }

package/dist/lib/constants/dev-environment.js

@@ -1,7 +1,7 @@
 "use strict";
 
 exports.__esModule = true;
-exports.DEV_ENVIRONMENT_WORDPRESS_VERSION_TTL = exports.DEV_ENVIRONMENT_WORDPRESS_VERSIONS_URI = exports.DEV_ENVIRONMENT_WORDPRESS_CACHE_KEY = exports.DEV_ENVIRONMENT_VERSION = exports.DEV_ENVIRONMENT_SUBCOMMAND = exports.DEV_ENVIRONMENT_RAW_GITHUB_HOST = exports.DEV_ENVIRONMENT_PROMPT_INTRO = exports.DEV_ENVIRONMENT_PHP_VERSIONS = exports.DEV_ENVIRONMENT_NOT_FOUND = exports.DEV_ENVIRONMENT_FULL_COMMAND = exports.DEV_ENVIRONMENT_DEFAULTS = exports.DEV_ENVIRONMENT_COMPONENTS_WITH_WP = exports.DEV_ENVIRONMENT_COMPONENTS = void 0;
+exports.DEV_ENVIRONMENT_WORDPRESS_VERSION_TTL = exports.DEV_ENVIRONMENT_WORDPRESS_VERSIONS_URI = exports.DEV_ENVIRONMENT_WORDPRESS_CACHE_KEY = exports.DEV_ENVIRONMENT_VERSION = exports.DEV_ENVIRONMENT_SUBCOMMAND = exports.DEV_ENVIRONMENT_RAW_GITHUB_HOST = exports.DEV_ENVIRONMENT_PROMPT_INTRO = exports.DEV_ENVIRONMENT_PHP_VERSIONS = exports.DEV_ENVIRONMENT_NOT_FOUND = exports.DEV_ENVIRONMENT_FULL_COMMAND = exports.DEV_ENVIRONMENT_DEFAULT_PHP_VERSION = exports.DEV_ENVIRONMENT_DEFAULTS = exports.DEV_ENVIRONMENT_COMPONENTS_WITH_WP = exports.DEV_ENVIRONMENT_COMPONENTS = void 0;
 const DEV_ENVIRONMENT_SUBCOMMAND = exports.DEV_ENVIRONMENT_SUBCOMMAND = 'dev-env';
 const DEV_ENVIRONMENT_FULL_COMMAND = exports.DEV_ENVIRONMENT_FULL_COMMAND = `vip ${DEV_ENVIRONMENT_SUBCOMMAND}`;
 const DEV_ENVIRONMENT_PROMPT_INTRO = exports.DEV_ENVIRONMENT_PROMPT_INTRO = 'This is a wizard to help you set up your local dev environment.\n\n' + 'Sensible default values were pre-selected for convenience. ' + 'You may also choose to create multiple environments with different settings using the --slug option.\n\n';
@@ -14,26 +14,27 @@ const DEV_ENVIRONMENT_WORDPRESS_CACHE_KEY = exports.DEV_ENVIRONMENT_WORDPRESS_CA
 const DEV_ENVIRONMENT_WORDPRESS_VERSION_TTL = exports.DEV_ENVIRONMENT_WORDPRESS_VERSION_TTL = 86400; // once per day
 
 const DEV_ENVIRONMENT_PHP_VERSIONS = exports.DEV_ENVIRONMENT_PHP_VERSIONS = {
-  8.2: {
+  '8.2': {
     image: 'ghcr.io/automattic/vip-container-images/php-fpm:8.2',
-    label: '8.2 (recommended)'
+    label: '8.2'
   },
-  8.3: {
+  '8.3': {
     image: 'ghcr.io/automattic/vip-container-images/php-fpm:8.3',
     label: '8.3'
   },
-  8.4: {
+  '8.4': {
     image: 'ghcr.io/automattic/vip-container-images/php-fpm:8.4',
     label: '8.4'
   },
-  8.5: {
+  '8.5': {
     image: 'ghcr.io/automattic/vip-container-images/php-fpm:8.5',
     label: '8.5 (experimental)'
   }
 };
+const DEV_ENVIRONMENT_DEFAULT_PHP_VERSION = exports.DEV_ENVIRONMENT_DEFAULT_PHP_VERSION = '8.4';
 const DEV_ENVIRONMENT_DEFAULTS = exports.DEV_ENVIRONMENT_DEFAULTS = {
   title: 'VIP Dev',
   multisite: false,
-  phpVersion: Object.keys(DEV_ENVIRONMENT_PHP_VERSIONS)[0]
+  phpVersion: DEV_ENVIRONMENT_DEFAULT_PHP_VERSION
 };
 const DEV_ENVIRONMENT_VERSION = exports.DEV_ENVIRONMENT_VERSION = '2.3.4';

package/dist/lib/dev-environment/dev-environment-cli.js

@@ -524,7 +524,7 @@ function resolvePhpVersion(version) {
   }
   debug(`Resolving PHP version %j`, version);
   let result;
-  if (!(version in _devEnvironment.DEV_ENVIRONMENT_PHP_VERSIONS)) {
+  if (!Object.hasOwn(_devEnvironment.DEV_ENVIRONMENT_PHP_VERSIONS, version)) {
     const images = Object.values(_devEnvironment.DEV_ENVIRONMENT_PHP_VERSIONS);
     const image = images.find(value => value.image === version);
     if (image) {
@@ -545,8 +545,9 @@ async function promptForPhpVersion(initialValue) {
     const choices = [];
     Object.keys(_devEnvironment.DEV_ENVIRONMENT_PHP_VERSIONS).forEach(version => {
       const phpImage = _devEnvironment.DEV_ENVIRONMENT_PHP_VERSIONS[version];
+      const label = version === _devEnvironment.DEV_ENVIRONMENT_DEFAULT_PHP_VERSION ? `${phpImage.label} (recommended)` : phpImage.label;
       choices.push({
-        message: phpImage.label,
+        message: label,
         value: version
       });
     });
@@ -744,6 +745,9 @@ async function getTagChoices() {
     };
   });
 }
+
+// Credentials stored in instance data must never be sent as event props (PLTFRM-2820)
+const TRACKING_EXCLUDED_KEYS = new Set(['adminPassword', 'autologinKey']);
 function getEnvTrackingInfo(slug) {
   try {
     const envData = (0, _devEnvironmentCore.readEnvironmentData)(slug);
@@ -751,6 +755,10 @@ function getEnvTrackingInfo(slug) {
       slug
     };
     for (const key of Object.keys(envData)) {
+      if (TRACKING_EXCLUDED_KEYS.has(key)) {
+        continue;
+      }
+
       // track doesn't like camelCase
       const snakeCasedKey = key.replace(/[A-Z]/g, letter => `_${letter.toLowerCase()}`);
       const value = _devEnvironment.DEV_ENVIRONMENT_COMPONENTS_WITH_WP.includes(key) ? JSON.stringify(envData[key]) : envData[key];

package/dist/lib/dev-environment/dev-environment-core.js

@@ -164,7 +164,7 @@ function preProcessInstanceData(instanceData) {
     mariadb: instanceData.mariadb ?? '',
     elasticsearch: instanceData.elasticsearch || false,
     // NOSONAR
-    php: instanceData.php ?? _devEnvironment.DEV_ENVIRONMENT_PHP_VERSIONS[Object.keys(_devEnvironment.DEV_ENVIRONMENT_PHP_VERSIONS)[0]].image,
+    php: instanceData.php ?? _devEnvironment.DEV_ENVIRONMENT_PHP_VERSIONS[_devEnvironment.DEV_ENVIRONMENT_DEFAULT_PHP_VERSION].image,
     xdebug: Boolean(instanceData.xdebug),
     phpmyadmin: Boolean(instanceData.phpmyadmin),
     photon: Boolean(instanceData.photon),