@automattic/vip 4.1.5 → 4.1.6

package/internal/gql/SCHEMA.md

@@ -1,21 +0,0 @@
-# GraphQL schema vendoring
-
-`internal/gql/schema.gql` is vendored from the Node project's `schema.gql`,
-which is itself generated by `npm run typescript:codegen:generate` against
-the live VIP GraphQL API.
-
-## Refreshing the schema
-
-1. From the repo root: `npm install` and run `npm run typescript:codegen:generate`.
-   This requires a valid Node-CLI token (`vip login` if needed).
-2. Copy the generated `schema.gql` to `internal/gql/schema.gql`.
-3. Run `go generate ./internal/gql/...` to regenerate the typed client.
-4. Run the full test suite + parity harness.
-5. Commit the new `schema.gql` and the regenerated `generated.go` in one commit
-   with subject `chore(gql): refresh vendored schema and regenerated client`.
-
-## Why we vendor
-
-The schema is the source of truth for typed query generation. The Node project
-generates it on demand and gitignores the result. The Go project pins a copy
-so deterministic builds don't depend on having a live API endpoint or token.

package/internal/gql/client.go

@@ -1,54 +0,0 @@
-package gql
-
-import (
-	"net/http"
-
-	"github.com/Automattic/vip/internal/httpproxy"
-)
-
-// Doer mirrors genqlient's interface plus what middleware needs.
-type Doer interface {
-	Do(req *http.Request) (*http.Response, error)
-}
-
-// Middleware wraps a Doer with a new Doer.
-type Middleware func(next Doer) Doer
-
-// Config selects the GraphQL endpoint and per-environment behaviors.
-type Config struct {
-	APIHost     string // e.g. "https://api.wpvip.com"
-	TestMode    bool   // if true, skip the x_query rewrite (matches NODE_ENV=test)
-	Token       string // bearer token (set by callers; auth package supplies)
-	HTTPClient  *http.Client
-	Middleware  []Middleware // outermost first
-	ExitOnError bool         // honored by Error middleware (Task 5)
-	SilenceAuth bool         // honored by Error middleware (Task 5)
-}
-
-// Client composes a transport with middleware. It implements Doer.
-type Client struct {
-	chain Doer
-	cfg   Config
-}
-
-func NewClient(cfg Config) *Client {
-	if cfg.HTTPClient == nil {
-		// NOT http.DefaultClient: its proxy policy is the inverse of Node's
-		// (see internal/httpproxy). This client carries the bearer token.
-		cfg.HTTPClient = httpproxy.Client()
-	}
-	base := newTransport(cfg)
-	chain := Doer(base)
-	for i := len(cfg.Middleware) - 1; i >= 0; i-- {
-		chain = cfg.Middleware[i](chain)
-	}
-	return &Client{chain: chain, cfg: cfg}
-}
-
-func (c *Client) Do(req *http.Request) (*http.Response, error) {
-	return c.chain.Do(req)
-}
-
-// APIHost returns the configured API host. Used by callers (e.g. defensivemode)
-// that need to POST directly to /graphql.
-func (c *Client) APIHost() string { return c.cfg.APIHost }

package/internal/gql/client_test.go

@@ -1,71 +0,0 @@
-package gql
-
-import (
-	"net/http"
-	"net/http/httptest"
-	"strings"
-	"testing"
-)
-
-func TestClientPostsToGraphQLEndpointWithXQuery(t *testing.T) {
-	var got struct {
-		path  string
-		query string
-		body  string
-	}
-	srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-		got.path = r.URL.Path
-		got.query = r.URL.RawQuery
-		b := make([]byte, 4096)
-		n, _ := r.Body.Read(b)
-		got.body = string(b[:n])
-		w.Header().Set("Content-Type", "application/json")
-		w.Write([]byte(`{"data":{"me":null}}`))
-	}))
-	defer srv.Close()
-
-	c := NewClient(Config{APIHost: srv.URL})
-	req, _ := http.NewRequest("POST", srv.URL+"/graphql", strings.NewReader(`{"query":"query Me{me{id}}","operationName":"Me"}`))
-	req.Header.Set("Content-Type", "application/json")
-	if _, err := c.Do(req); err != nil {
-		t.Fatalf("Do: %v", err)
-	}
-	if got.path != "/graphql" {
-		t.Errorf("path = %q, want /graphql", got.path)
-	}
-	if !strings.HasPrefix(got.query, "x_query=Me") {
-		t.Errorf("query = %q, want prefix x_query=Me", got.query)
-	}
-}
-
-func TestClientSkipsXQueryInTestEnv(t *testing.T) {
-	srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-		if r.URL.RawQuery != "" {
-			t.Errorf("test-mode client must not append x_query; got %q", r.URL.RawQuery)
-		}
-		w.Header().Set("Content-Type", "application/json")
-		w.Write([]byte(`{"data":{}}`))
-	}))
-	defer srv.Close()
-
-	c := NewClient(Config{APIHost: srv.URL, TestMode: true})
-	req, _ := http.NewRequest("POST", srv.URL+"/graphql", strings.NewReader(`{"query":"{me{id}}","operationName":"Me"}`))
-	if _, err := c.Do(req); err != nil {
-		t.Fatalf("Do: %v", err)
-	}
-}
-
-func TestClientSetsAuthHeaderWhenTokenPresent(t *testing.T) {
-	var got string
-	srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-		got = r.Header.Get("Authorization")
-		w.Write([]byte(`{"data":{}}`))
-	}))
-	defer srv.Close()
-	c := NewClient(Config{APIHost: srv.URL, TestMode: true, Token: "abc.def.ghi"})
-	req, _ := http.NewRequest("POST", srv.URL+"/graphql", strings.NewReader(`{"operationName":"Me","query":"{me{id}}"}`))
-	c.Do(req)
-	if got != "Bearer abc.def.ghi" {
-		t.Errorf("Authorization = %q, want Bearer abc.def.ghi", got)
-	}
-}

package/internal/gql/debug_test.go

@@ -1,79 +0,0 @@
-package gql
-
-import (
-	"bytes"
-	"context"
-	"io"
-	"net/http"
-	"strings"
-	"testing"
-
-	"github.com/Automattic/vip/internal/debuglog"
-)
-
-type debugTransportFunc func(*http.Request) (*http.Response, error)
-
-func (f debugTransportFunc) RoundTrip(r *http.Request) (*http.Response, error) { return f(r) }
-
-func TestHTTPDiagnosticsPreserveRequestAndOmitSecrets(t *testing.T) {
-	var out bytes.Buffer
-	ctx := debuglog.WithLogger(context.Background(), "@automattic/vip:http", &out)
-	body := `{"operationName":"EdgeWorkers","query":"query EdgeWorkers { me { id } }","variables":{"secret":"body-secret"}}`
-	req, _ := http.NewRequestWithContext(ctx, "POST", "https://user:password-secret@example.test/graphql?token=query-secret", strings.NewReader(body))
-	c := NewClient(Config{Token: "header-secret", HTTPClient: &http.Client{Transport: debugTransportFunc(func(r *http.Request) (*http.Response, error) {
-		got, _ := io.ReadAll(r.Body)
-		if string(got) != body || r.URL.Query().Get("token") != "query-secret" || r.Header.Get("Authorization") != "Bearer header-secret" {
-			t.Fatal("diagnostics changed request")
-		}
-		return &http.Response{StatusCode: 200, Body: io.NopCloser(strings.NewReader(`{"data":{}}`)), Header: make(http.Header)}, nil
-	})}})
-	resp, err := c.Do(req)
-	if err != nil {
-		t.Fatal(err)
-	}
-	resp.Body.Close()
-	if !strings.Contains(out.String(), "running fetch https://example.test/graphql") {
-		t.Fatalf("missing fetch diagnostic: %q", out.String())
-	}
-	for _, secret := range []string{"password-secret", "body-secret", "query-secret", "header-secret"} {
-		if strings.Contains(out.String(), secret) {
-			t.Fatalf("diagnostic exposed %s", secret)
-		}
-	}
-}
-
-func TestGraphQLDebugWithHandledErrorsAndRetries(t *testing.T) {
-	var out, ordinaryErrors bytes.Buffer
-	ctx := WithAllowGQLErrors(debuglog.WithLogger(context.Background(), "@automattic/vip:http:graphql", &out))
-	responseBody := `{"errors":[{"message":"message-secret","path":["app"],"extensions":{"code":"FORBIDDEN","token":"extension-secret"}}]}`
-	calls := 0
-	c := NewClient(Config{HTTPClient: &http.Client{Transport: debugTransportFunc(func(r *http.Request) (*http.Response, error) {
-		_, _ = io.Copy(io.Discard, r.Body)
-		calls++
-		status := 200
-		if calls == 1 {
-			status = 503
-		}
-		return &http.Response{StatusCode: status, Body: io.NopCloser(strings.NewReader(responseBody)), Header: make(http.Header)}, nil
-	})}, Middleware: []Middleware{NewErrorMiddleware(ErrorConfig{Stderr: &ordinaryErrors, ExitOnError: true, Exit: func(int) { t.Fatal("handled error exited") }}), NewRetryMiddleware(RetryConfig{MaxAttempts: 2, NoDelay: true})}})
-	req, _ := http.NewRequestWithContext(ctx, "POST", "https://example.test/graphql", strings.NewReader(`{"operationName":"EdgeWorkers","query":"query EdgeWorkers { me { id } }"}`))
-	resp, err := c.Do(req)
-	if err != nil {
-		t.Fatal(err)
-	}
-	defer resp.Body.Close()
-	body, _ := io.ReadAll(resp.Body)
-	if string(body) != responseBody || calls != 2 || ordinaryErrors.Len() != 0 {
-		t.Fatal("diagnostics changed retry/error handling")
-	}
-	for _, want := range []string{"Retrying", "EdgeWorkers", "Attempt: 1", "GraphQL errors", "FORBIDDEN"} {
-		if !strings.Contains(out.String(), want) {
-			t.Errorf("missing %q in %q", want, out.String())
-		}
-	}
-	for _, secret := range []string{"message-secret", "extension-secret"} {
-		if strings.Contains(out.String(), secret) {
-			t.Fatalf("diagnostic exposed %s", secret)
-		}
-	}
-}

package/internal/gql/decoder_compat_helpers_test.go

@@ -1,35 +0,0 @@
-// Package-level helpers shared by decoder_compat_test.go.
-package gql
-
-import (
-	"fmt"
-	"reflect"
-)
-
-// reflectedField is a tiny shape used by the forward-compat audit test.
-type reflectedField struct {
-	Name string
-	Type string
-}
-
-// reflectExportedFields enumerates exported fields of v (which may be a
-// struct value or pointer to one). Used to enforce the "all generated
-// optional fields must be pointers" invariant from genqlient.yaml.
-func reflectExportedFields(v any) []reflectedField {
-	t := reflect.TypeOf(v)
-	if t.Kind() == reflect.Ptr {
-		t = t.Elem()
-	}
-	if t.Kind() != reflect.Struct {
-		return nil
-	}
-	out := make([]reflectedField, 0, t.NumField())
-	for i := 0; i < t.NumField(); i++ {
-		f := t.Field(i)
-		if !f.IsExported() {
-			continue
-		}
-		out = append(out, reflectedField{Name: f.Name, Type: fmt.Sprintf("%v", f.Type)})
-	}
-	return out
-}

package/internal/gql/decoder_compat_test.go

@@ -1,78 +0,0 @@
-package gql
-
-import (
-	"net/http"
-	"net/http/httptest"
-	"strings"
-	"testing"
-
-	"github.com/Khan/genqlient/graphql"
-
-	json "encoding/json/v2"
-)
-
-func TestDecodeIgnoresUnknownTopLevelFields(t *testing.T) {
-	type known struct {
-		ID   *int64  `json:"id"`
-		Name *string `json:"name"`
-	}
-	payload := []byte(`{"id":42,"name":"x","newField":"surprise","anotherNew":{"nested":1}}`)
-	var k known
-	if err := json.Unmarshal(payload, &k); err != nil {
-		t.Fatalf("decode failed on extra fields — forward-compat lost: %v", err)
-	}
-	if k.ID == nil || *k.ID != 42 || k.Name == nil || *k.Name != "x" {
-		t.Errorf("decoded values wrong: %+v", k)
-	}
-}
-
-func TestDecodeAcceptsNullForOptionalFields(t *testing.T) {
-	type opt struct {
-		Name *string `json:"name"`
-	}
-	var o opt
-	if err := json.Unmarshal([]byte(`{"name":null}`), &o); err != nil {
-		t.Fatalf("decode failed on null: %v", err)
-	}
-	if o.Name != nil {
-		t.Errorf("null should yield nil pointer; got %v", *o.Name)
-	}
-}
-
-func TestGenqlientResponseIgnoresUnknownFields(t *testing.T) {
-	srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-		w.Header().Set("Content-Type", "application/json")
-		w.Write([]byte(`{"data":{"me":{"id":7,"displayName":"x","isVIP":true,"newServerOnlyField":"surprise"}}}`))
-	}))
-	defer srv.Close()
-	c := graphql.NewClient(srv.URL+"/graphql", http.DefaultClient)
-	res, err := Me(t.Context(), c)
-	if err != nil {
-		t.Fatalf("Me: %v", err)
-	}
-	if res.Me == nil || res.Me.Id == nil || *res.Me.Id != 7 {
-		t.Errorf("decoded Me wrong: %+v", res.Me)
-	}
-}
-
-func TestAuditNoNonPointerOptionals(t *testing.T) {
-	type checked struct {
-		typ  string
-		read func() any
-	}
-	cases := []checked{
-		{typ: "MeMe", read: func() any { return MeMe{} }},
-	}
-	for _, c := range cases {
-		v := c.read()
-		fields := reflectExportedFields(v)
-		for _, f := range fields {
-			if strings.HasPrefix(f.Name, "GetType") || f.Name == "Typename" {
-				continue
-			}
-			if !strings.HasPrefix(f.Type, "*") && !strings.HasPrefix(f.Type, "[]") {
-				t.Errorf("%s.%s is %s (expected pointer/slice for forward-compat tolerance)", c.typ, f.Name, f.Type)
-			}
-		}
-	}
-}

package/internal/gql/doc.go

@@ -1,13 +0,0 @@
-// Package gql is the typed GraphQL client for the vip-cli Go rewrite.
-//
-// The schema is vendored from the Node project (see SCHEMA.md). Operations
-// live in operations/*.graphql. Run `go generate ./internal/gql/...` to
-// regenerate the typed client into generated.go.
-//
-// The client is composed of stacked middleware (transport -> retry ->
-// rechallenge -> error-handling, applied outermost-first). Each middleware
-// is a Doer that wraps a next Doer. The rechallenge slot is a no-op in
-// M2; M3 will fill it in with the step-up flow per project_rechallenge_v2.md.
-package gql
-
-//go:generate genqlient

package/internal/gql/edgeworkerinput/input.go

@@ -1,58 +0,0 @@
-// Package edgeworkerinput preserves omitted, null, and empty write values.
-// It is independent of the generated client, which binds its mutation inputs here.
-package edgeworkerinput
-
-import json "encoding/json/v2"
-
-type Location struct {
-	Operator string `json:"operator"`
-	Value    string `json:"value"`
-}
-
-type LocationValue struct {
-	Present bool
-	Value   *Location
-}
-
-type Fields struct {
-	Name       string
-	WASMBinary string
-	Location   LocationValue
-	OnFailure  *string
-	Source     *string
-}
-
-type Create struct {
-	EnvironmentID int64
-	Fields
-}
-
-type Update struct {
-	EnvironmentID int64
-	EdgeWorkerID  int64
-	Fields
-}
-
-func fieldsMap(envID int64, f Fields, update bool) map[string]any {
-	out := map[string]any{"environmentId": envID, "name": f.Name, "wasmBinary": f.WASMBinary}
-	if f.OnFailure != nil {
-		out["onFailure"] = *f.OnFailure
-	}
-	if f.Source != nil {
-		out["source"] = *f.Source
-	}
-	if f.Location.Present && (update || f.Location.Value != nil) {
-		out["location"] = f.Location.Value
-	}
-	return out
-}
-
-func (in Create) MarshalJSON() ([]byte, error) {
-	return json.Marshal(fieldsMap(in.EnvironmentID, in.Fields, false))
-}
-
-func (in Update) MarshalJSON() ([]byte, error) {
-	out := fieldsMap(in.EnvironmentID, in.Fields, true)
-	out["edgeWorkerId"] = in.EdgeWorkerID
-	return json.Marshal(out)
-}

package/internal/gql/edgeworkerinput/input_test.go

@@ -1,52 +0,0 @@
-package edgeworkerinput
-
-import (
-	json "encoding/json/v2"
-	"reflect"
-	"testing"
-)
-
-func TestWriteFieldPresence(t *testing.T) {
-	empty, failure := "", "error"
-	for _, tc := range []struct {
-		name      string
-		location  LocationValue
-		source    *string
-		onFailure *string
-		want      map[string]any
-	}{
-		{"omitted", LocationValue{}, nil, nil, map[string]any{}},
-		{"clear location", LocationValue{Present: true}, nil, nil, map[string]any{"location": nil}},
-		{"replace location", LocationValue{Present: true, Value: &Location{"starts_with", "/api/"}}, nil, nil, map[string]any{"location": map[string]any{"operator": "starts_with", "value": "/api/"}}},
-		{"empty source", LocationValue{}, &empty, nil, map[string]any{"source": ""}},
-		{"failure policy", LocationValue{}, nil, &failure, map[string]any{"onFailure": "error"}},
-	} {
-		t.Run(tc.name, func(t *testing.T) {
-			fields := Fields{Name: "headers", WASMBinary: "AGFzbQ==", Location: tc.location, Source: tc.source, OnFailure: tc.onFailure}
-			for _, update := range []bool{false, true} {
-				var input any = Create{EnvironmentID: 7, Fields: fields}
-				want := map[string]any{"environmentId": float64(7), "name": "headers", "wasmBinary": "AGFzbQ=="}
-				for k, v := range tc.want {
-					if k != "location" || update || v != nil {
-						want[k] = v
-					}
-				}
-				if update {
-					input = Update{EnvironmentID: 7, EdgeWorkerID: 9, Fields: fields}
-					want["edgeWorkerId"] = float64(9)
-				}
-				data, err := json.Marshal(input)
-				if err != nil {
-					t.Fatal(err)
-				}
-				var got map[string]any
-				if err := json.Unmarshal(data, &got); err != nil {
-					t.Fatal(err)
-				}
-				if !reflect.DeepEqual(got, want) {
-					t.Fatalf("update=%v: got %s, want %#v", update, data, want)
-				}
-			}
-		})
-	}
-}

package/internal/gql/error.go

@@ -1,163 +0,0 @@
-package gql
-
-import (
-	"bytes"
-	"context"
-	"fmt"
-	"io"
-	"net/http"
-	"os"
-
-	json "encoding/json/v2"
-
-	"github.com/Automattic/vip/internal/debuglog"
-)
-
-// ErrorConfig controls the behavior of the error middleware.
-type ErrorConfig struct {
-	Stderr      io.Writer
-	Exit        func(int)
-	Silence     bool // mirrors silenceAuthErrors
-	ExitOnError bool // mirrors exitOnError
-}
-
-// ctxKeyAllowGQLErrors is a context key that, when set to a true bool,
-// instructs the error middleware to skip its print + exit behavior for
-// the request's response so the caller can inspect the GraphQL errors
-// inline (e.g. vip sync handles "Site is already syncing" specially).
-type ctxKeyAllowGQLErrors struct{}
-
-// WithAllowGQLErrors returns a child context that disables the error
-// middleware's print + exit-on-error behavior for any GraphQL request
-// issued with this context (or one derived from it). Network/401 paths
-// are unaffected — only the GraphQL errors[] check is bypassed.
-func WithAllowGQLErrors(ctx context.Context) context.Context {
-	return context.WithValue(ctx, ctxKeyAllowGQLErrors{}, true)
-}
-
-// allowGQLErrorsFromContext reports whether the request's context opts
-// out of the error middleware's GraphQL-error handling.
-func allowGQLErrorsFromContext(ctx context.Context) bool {
-	if ctx == nil {
-		return false
-	}
-	v, _ := ctx.Value(ctxKeyAllowGQLErrors{}).(bool)
-	return v
-}
-
-// NewErrorMiddleware returns a Middleware that:
-//   - On HTTP 401 (and !Silence): prints "Unauthorized: <message>" to Stderr and calls Exit(1).
-//   - On GraphQL errors: prints "Error: <message>" for each error; calls Exit(1) if ExitOnError.
-//
-// Message wording is exact Node parity with src/lib/api.ts errorLink.
-func NewErrorMiddleware(cfg ErrorConfig) Middleware {
-	if cfg.Stderr == nil {
-		cfg.Stderr = os.Stderr
-	}
-	if cfg.Exit == nil {
-		cfg.Exit = os.Exit
-	}
-	return func(next Doer) Doer { return &errorDoer{next: next, cfg: cfg} }
-}
-
-type errorDoer struct {
-	next Doer
-	cfg  ErrorConfig
-}
-
-func (e *errorDoer) Do(req *http.Request) (*http.Response, error) {
-	operation := ""
-	debugEnabled := debuglog.Enabled(req.Context(), "@automattic/vip:http:graphql")
-	if debugEnabled {
-		operation, _ = operationNameFromBody(req)
-	}
-	resp, err := e.next.Do(req)
-	if err != nil || resp == nil {
-		return resp, err
-	}
-
-	if resp.StatusCode == 401 && !e.cfg.Silence {
-		body, _ := io.ReadAll(resp.Body)
-		resp.Body.Close()
-		msg := decode401Message(body)
-		fmt.Fprintf(e.cfg.Stderr, "Unauthorized: %s\n", msg)
-		e.cfg.Exit(1)
-		resp.Body = io.NopCloser(bytes.NewReader(body))
-		return resp, nil
-	}
-
-	// Peek body for GraphQL errors.
-	body, _ := io.ReadAll(resp.Body)
-	resp.Body.Close()
-	resp.Body = io.NopCloser(bytes.NewReader(body))
-
-	if hasGraphQLErrors(body) {
-		// Node emits safe diagnostic metadata even when the command handles
-		// GraphQL errors itself. Never include messages, variables or extensions
-		// other than the error code in the diagnostic stream.
-		var doc struct {
-			Errors []struct {
-				Path       []any `json:"path"`
-				Extensions struct {
-					Code string `json:"code"`
-				} `json:"extensions"`
-			} `json:"errors"`
-		}
-		if debugEnabled && json.Unmarshal(body, &doc) == nil {
-			for _, item := range doc.Errors {
-				debuglog.Printf(req.Context(), "@automattic/vip:http:graphql", "GraphQL errors in response: operation=%s path=%v code=%s", operation, item.Path, item.Extensions.Code)
-			}
-		}
-		if allowGQLErrorsFromContext(req.Context()) {
-			return resp, nil
-		}
-		for _, m := range extractGraphQLErrorMessages(body) {
-			fmt.Fprintf(e.cfg.Stderr, "Error: %s\n", m)
-		}
-		if e.cfg.ExitOnError {
-			e.cfg.Exit(1)
-		}
-	}
-	return resp, nil
-}
-
-func decode401Message(body []byte) string {
-	const inactivity = "Your token has expired due to inactivity"
-	const defaultMsg = "You are not authorized to perform this request"
-	const suffix = "; please log out with `vip logout`, then try again."
-	if len(body) > 0 {
-		var doc struct {
-			Code string `json:"code"`
-		}
-		if err := json.Unmarshal(body, &doc); err == nil && doc.Code == "token-disabled-inactivity" {
-			return inactivity + suffix
-		}
-	}
-	return defaultMsg + suffix
-}
-
-func hasGraphQLErrors(body []byte) bool {
-	var doc struct {
-		Errors []map[string]any `json:"errors"`
-	}
-	if err := json.Unmarshal(body, &doc); err != nil {
-		return false
-	}
-	return len(doc.Errors) > 0
-}
-
-func extractGraphQLErrorMessages(body []byte) []string {
-	var doc struct {
-		Errors []struct {
-			Message string `json:"message"`
-		} `json:"errors"`
-	}
-	if err := json.Unmarshal(body, &doc); err != nil {
-		return nil
-	}
-	out := make([]string, 0, len(doc.Errors))
-	for _, e := range doc.Errors {
-		out = append(out, e.Message)
-	}
-	return out
-}