@pippit-dev/cli 0.0.26 → 0.0.28

package/checksums.txt

@@ -1,6 +1,6 @@
-852db25f92e31d7791332a67d9fe321e09471ac59a4051a86cd10d120df5504b  pippit-tool-cli-0.0.26-darwin-amd64.tar.gz
-d6b01e0b0784bc951785a9120adf5b81aeb8fd9e9591a9f5e361d59ad521043d  pippit-tool-cli-0.0.26-darwin-arm64.tar.gz
-8cab08ec5fa9fb5c2c933ef986313134b98bfd118c9d5997b6b328d63017143f  pippit-tool-cli-0.0.26-linux-amd64.tar.gz
-81f2783696ddfd374507d21d10a2854f8ac3fbb2df32bcb78559f0b9153b41f3  pippit-tool-cli-0.0.26-linux-arm64.tar.gz
-b089a0a1f27cc7e27e7905ad32863a90e8f401b914a9133e49476142e51e5824  pippit-tool-cli-0.0.26-windows-amd64.zip
-41df908598017d53b857b475c080793f81956c9706c6d990d875d48432b27395  pippit-tool-cli-0.0.26-windows-arm64.zip
+91f6452453768a4af724e7f478c1d5834b117dfd57545eb28f79838bcefee72c  pippit-tool-cli-0.0.28-darwin-amd64.tar.gz
+72784be227214d5821793241ec19c0d41227cbcf1bf10b8d8a3675b8a1093219  pippit-tool-cli-0.0.28-darwin-arm64.tar.gz
+1b7197befef5930b91816a1021a7ab66b9f3d95c0cbd5b0ba5fea20c1a7a1173  pippit-tool-cli-0.0.28-linux-amd64.tar.gz
+2452ba5f9dc74b516af47e4e4620cfcc247ffe0b2d46a847681910442535f62b  pippit-tool-cli-0.0.28-linux-arm64.tar.gz
+bdb744c4e3cc57774c97148665ba99a6952fd4a1293902728e16a655544b20dc  pippit-tool-cli-0.0.28-windows-amd64.zip
+52e660a8b334067fa056021dcf68f1bb13a0385f6792a45b93277463cd583200  pippit-tool-cli-0.0.28-windows-arm64.zip

package/cmd/update/update.go

@@ -1,24 +1,44 @@
 package updatecmd
 
 import (
+	"bytes"
+	"encoding/json"
 	"fmt"
 	"io"
+	"net/http"
 	"os"
 	"os/exec"
 	"path/filepath"
 	"runtime"
 	"strings"
+	"sync"
+	"time"
 
+	"github.com/Pippit-dev/pippit-cli/internal/version"
 	"github.com/spf13/cobra"
 )
 
 const defaultPackage = "@pippit-dev/cli"
 
+const (
+	defaultTelemetryBaseURL = "https://xyq.jianying.com"
+	telemetryPath           = "/api/biz/v1/skill/report_telemetry"
+	telemetryAuthHeader     = "Bearer pippit-cli-skill-telemetry"
+	telemetryWaitTimeout    = time.Second
+)
+
 var legacyGlobalSkills = []string{
 	"pippit-short-drama-skill",
 	"xyq-nest-skill",
 }
 
+var telemetrySkillNames = []string{
+	"xyq-skill",
+	"xyq-short-drama-skill",
+}
+
+var telemetryHTTPClient = &http.Client{Timeout: telemetryWaitTimeout}
+
 // NewCommand builds the update command.
 func NewCommand(stdout, stderr io.Writer) *cobra.Command {
 	cmd := &cobra.Command{
@@ -57,6 +77,7 @@ func runUpdate(stdout, stderr io.Writer) error {
 		return fmt.Errorf("update pippit-tool-cli skills: %w", err)
 	}
 
+	reportBundledSkillTelemetry("update", "cli_update", stderr)
 	fmt.Fprintln(stdout, "pippit-tool-cli and skills updated")
 	return nil
 }
@@ -105,6 +126,95 @@ func cleanupLegacyGlobalSkills(globalSkillsDir string) error {
 	return nil
 }
 
+type telemetryPayload struct {
+	Event      string `json:"event"`
+	SkillName  string `json:"skill_name"`
+	Source     string `json:"source"`
+	CliVersion string `json:"cli_version"`
+	Platform   string `json:"platform"`
+	Arch       string `json:"arch"`
+}
+
+func reportBundledSkillTelemetry(event string, source string, stderr io.Writer) {
+	if os.Getenv("PIPPIT_CLI_DISABLE_TELEMETRY") == "1" {
+		return
+	}
+	var wg sync.WaitGroup
+	for _, skillName := range telemetrySkillNames {
+		payload := telemetryPayload{
+			Event:      event,
+			SkillName:  skillName,
+			Source:     source,
+			CliVersion: telemetryCliVersion(),
+			Platform:   runtime.GOOS,
+			Arch:       runtime.GOARCH,
+		}
+		wg.Add(1)
+		go func(payload telemetryPayload) {
+			defer wg.Done()
+			if err := reportSkillTelemetry(payload); err != nil && os.Getenv("PIPPIT_CLI_DEBUG_TELEMETRY") == "1" {
+				fmt.Fprintf(stderr, "[pippit-tool-cli] telemetry failed: %v\n", err)
+			}
+		}(payload)
+	}
+	done := make(chan struct{})
+	go func() {
+		wg.Wait()
+		close(done)
+	}()
+	select {
+	case <-done:
+	case <-time.After(telemetryWaitTimeout):
+	}
+}
+
+func reportSkillTelemetry(payload telemetryPayload) error {
+	body, err := json.Marshal(payload)
+	if err != nil {
+		return err
+	}
+
+	req, err := http.NewRequest(http.MethodPost, telemetryBaseURL()+telemetryPath, bytes.NewReader(body))
+	if err != nil {
+		return err
+	}
+	req.Header.Set("Content-Type", "application/json")
+	req.Header.Set("Authorization", telemetryAuthHeader)
+	req.Header.Set("x-use-ppe", "1")
+	req.Header.Set("x-tt-env", "ppe_harness_novel_v2")
+
+	resp, err := telemetryHTTPClient.Do(req)
+	if err != nil {
+		return err
+	}
+	defer resp.Body.Close()
+	_, _ = io.Copy(io.Discard, resp.Body)
+	if resp.StatusCode >= 400 {
+		return fmt.Errorf("telemetry returned HTTP %d", resp.StatusCode)
+	}
+	return nil
+}
+
+func telemetryBaseURL() string {
+	for _, key := range []string{"PIPPIT_CLI_TELEMETRY_BASE_URL", "XYQ_OPENAPI_BASE", "XYQ_BASE_URL"} {
+		if value := strings.TrimRight(strings.TrimSpace(os.Getenv(key)), "/"); value != "" {
+			return value
+		}
+	}
+	return defaultTelemetryBaseURL
+}
+
+func telemetryCliVersion() string {
+	return stripPrereleaseVersion(version.Current())
+}
+
+func stripPrereleaseVersion(value string) string {
+	if idx := strings.Index(value, "-"); idx >= 0 {
+		return value[:idx]
+	}
+	return value
+}
+
 func runInherit(stderr io.Writer, name string, args ...string) error {
 	return runInheritEnv(stderr, nil, name, args...)
 }

package/cmd/update/update_test.go

@@ -2,11 +2,15 @@ package updatecmd
 
 import (
 	"bytes"
+	"encoding/json"
+	"net/http"
+	"net/http/httptest"
 	"os"
 	"path/filepath"
 	"runtime"
 	"strings"
 	"testing"
+	"time"
 )
 
 func TestInstallSkillsInstallsAllBundledSkills(t *testing.T) {
@@ -70,3 +74,108 @@ func TestCleanupLegacyGlobalSkills(t *testing.T) {
 		}
 	}
 }
+
+func TestReportSkillTelemetry(t *testing.T) {
+	var gotAuth string
+	var gotHeaders http.Header
+	var gotPayload telemetryPayload
+	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		if r.URL.Path != telemetryPath {
+			t.Fatalf("path = %q, want %q", r.URL.Path, telemetryPath)
+		}
+		gotAuth = r.Header.Get("Authorization")
+		gotHeaders = r.Header.Clone()
+		if err := json.NewDecoder(r.Body).Decode(&gotPayload); err != nil {
+			t.Fatalf("decode request body: %v", err)
+		}
+		_, _ = w.Write([]byte(`{"ret":"0","errmsg":""}`))
+	}))
+	defer server.Close()
+
+	t.Setenv("PIPPIT_CLI_TELEMETRY_BASE_URL", server.URL+"/")
+	err := reportSkillTelemetry(telemetryPayload{
+		Event:      "update",
+		SkillName:  "xyq-skill",
+		Source:     "cli_update",
+		CliVersion: "0.0.26",
+		Platform:   "darwin",
+		Arch:       "arm64",
+	})
+	if err != nil {
+		t.Fatalf("reportSkillTelemetry() error = %v", err)
+	}
+	if gotAuth != telemetryAuthHeader {
+		t.Fatalf("Authorization = %q, want %q", gotAuth, telemetryAuthHeader)
+	}
+	if got := gotHeaders.Get("x-use-ppe"); got != "1" {
+		t.Fatalf("x-use-ppe = %q, want 1", got)
+	}
+	if got := gotHeaders.Get("x-tt-env"); got != "ppe_harness_novel_v2" {
+		t.Fatalf("x-tt-env = %q, want ppe_harness_novel_v2", got)
+	}
+	if gotPayload.Event != "update" || gotPayload.SkillName != "xyq-skill" || gotPayload.Source != "cli_update" {
+		t.Fatalf("payload = %#v", gotPayload)
+	}
+}
+
+func TestReportBundledSkillTelemetryWaitsBriefly(t *testing.T) {
+	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		time.Sleep(2 * time.Second)
+		_, _ = w.Write([]byte(`{"ret":"0","errmsg":""}`))
+	}))
+	defer server.Close()
+
+	t.Setenv("PIPPIT_CLI_TELEMETRY_BASE_URL", server.URL)
+	start := time.Now()
+	reportBundledSkillTelemetry("update", "cli_update", &bytes.Buffer{})
+	if elapsed := time.Since(start); elapsed > 1500*time.Millisecond {
+		t.Fatalf("reportBundledSkillTelemetry() blocked for %v, want <= 1.5s", elapsed)
+	}
+}
+
+func TestReportBundledSkillTelemetryReportsBothSkills(t *testing.T) {
+	skillNames := make(chan string, len(telemetrySkillNames))
+	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		var payload telemetryPayload
+		if err := json.NewDecoder(r.Body).Decode(&payload); err != nil {
+			t.Fatalf("decode request body: %v", err)
+		}
+		skillNames <- payload.SkillName
+		_, _ = w.Write([]byte(`{"ret":"0","errmsg":""}`))
+	}))
+	defer server.Close()
+
+	t.Setenv("PIPPIT_CLI_TELEMETRY_BASE_URL", server.URL)
+	reportBundledSkillTelemetry("update", "cli_update", &bytes.Buffer{})
+
+	got := map[string]bool{}
+	for i := 0; i < len(telemetrySkillNames); i++ {
+		got[<-skillNames] = true
+	}
+	for _, skillName := range telemetrySkillNames {
+		if !got[skillName] {
+			t.Fatalf("missing telemetry for %s, got %#v", skillName, got)
+		}
+	}
+}
+
+func TestTelemetryBaseURL(t *testing.T) {
+	t.Setenv("PIPPIT_CLI_TELEMETRY_BASE_URL", "   ")
+	t.Setenv("XYQ_OPENAPI_BASE", "https://example.com///")
+	if got := telemetryBaseURL(); got != "https://example.com" {
+		t.Fatalf("telemetryBaseURL() = %q, want https://example.com", got)
+	}
+}
+
+func TestStripPrereleaseVersion(t *testing.T) {
+	cases := map[string]string{
+		"0.0.27":       "0.0.27",
+		"0.0.27-rc.1":  "0.0.27",
+		"1.2.3-beta.4": "1.2.3",
+	}
+	for input, want := range cases {
+		if got := stripPrereleaseVersion(input); got != want {
+			t.Fatalf("stripPrereleaseVersion(%q) = %q, want %q", input, got, want)
+		}
+	}
+}

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@pippit-dev/cli",
-  "version": "0.0.26",
+  "version": "0.0.28",
   "description": "Pippit CLI",
   "bin": {
     "pippit-tool-cli": "scripts/run.js"
   },
   "scripts": {
     "postinstall": "node scripts/install.js",
-    "test": "node scripts/version-check.test.js && node scripts/skills.test.js && go test ./... && go vet ./..."
+    "test": "node scripts/version-check.test.js && node scripts/skills.test.js && node scripts/install-wizard.test.js && go test ./... && go vet ./..."
   },
   "os": [
     "darwin",
@@ -35,6 +35,7 @@
     "scripts/platform.js",
     "scripts/run.js",
     "scripts/skills.js",
+    "scripts/telemetry.js",
     "scripts/version-check.js",
     "checksums.txt",
     "README.md",

package/scripts/install-wizard.js

@@ -4,8 +4,17 @@ const fs = require("fs");
 const path = require("path");
 const { isWindows, run, runSilent } = require("./platform");
 const { DEFAULT_PKG, installGlobalPackageSkills } = require("./skills");
+const { reportBundledSkillTelemetry } = require("./telemetry");
 
-const PKG = process.env.PIPPIT_CLI_INSTALL_PACKAGE || DEFAULT_PKG;
+const VERSION = require("../package.json").version.replace(/-.*$/, "");
+
+function defaultInstallPackage() {
+  return `${DEFAULT_PKG}@${VERSION}`;
+}
+
+function installPackage() {
+  return process.env.PIPPIT_CLI_INSTALL_PACKAGE || defaultInstallPackage();
+}
 
 function getGloballyInstalledVersion() {
   try {
@@ -37,13 +46,14 @@ function whichPippitToolCli() {
 }
 
 function main() {
+  const pkg = installPackage();
   const installed = getGloballyInstalledVersion();
   if (installed) {
-    console.log(`Updating global pippit-tool-cli (${installed}) via ${PKG}...`);
+    console.log(`Updating global pippit-tool-cli (${installed}) via ${pkg}...`);
   } else {
-    console.log(`Installing ${PKG} globally...`);
+    console.log(`Installing ${pkg} globally...`);
   }
-  run("npm", ["install", "-g", PKG], {
+  run("npm", ["install", "-g", pkg], {
     timeout: 120000,
     env: { ...process.env, PIPPIT_CLI_SKIP_SKILLS: "1" },
   });
@@ -56,7 +66,7 @@ function main() {
       throw err;
     }
     console.log("Existing global package does not contain skills; reinstalling...");
-    run("npm", ["install", "-g", PKG], { timeout: 120000 });
+    run("npm", ["install", "-g", pkg], { timeout: 120000 });
     installGlobalPackageSkills(DEFAULT_PKG);
   }
 
@@ -68,7 +78,16 @@ function main() {
   }
 
   console.log(`pippit-tool-cli is ready: ${bin}`);
+  reportBundledSkillTelemetry("install", "npx_install");
   console.log("Try: pippit-tool-cli short-drama +submit-run --message \"写一个短剧开头\"");
 }
 
-main();
+if (require.main === module) {
+  main();
+}
+
+module.exports = {
+  defaultInstallPackage,
+  installPackage,
+  main,
+};

package/scripts/install.js

@@ -6,6 +6,7 @@ const os = require("os");
 const path = require("path");
 const { isWindows, run } = require("./platform");
 const { cleanupLegacyGlobalSkills, installSkillsFromRoot } = require("./skills");
+const { reportBundledSkillTelemetry } = require("./telemetry");
 
 const VERSION = require("../package.json").version.replace(/-.*$/, "");
 const REPO = "Pippit-dev/cli";
@@ -134,6 +135,7 @@ function install() {
 
     if (process.env.PIPPIT_CLI_SKIP_SKILLS !== "1") {
       installSkillsFromRoot(ROOT);
+      reportBundledSkillTelemetry("install", "npm_install");
     } else {
       cleanupLegacyGlobalSkills();
     }

package/scripts/run.js

@@ -38,7 +38,7 @@ if (process.platform === "win32" && fs.existsSync(oldBin)) {
 // Match the lark-cli install entry: `npx @pippit-dev/cli@latest install`
 // should run the JS setup flow before the native binary exists.
 if (args[0] === "install") {
-  require("./install-wizard.js");
+  require("./install-wizard.js").main();
 } else {
   maybeWarnNewVersion(args);
 

package/scripts/telemetry.js

@@ -0,0 +1,83 @@
+const os = require("os");
+const http = require("http");
+const https = require("https");
+
+const VERSION = require("../package.json").version.replace(/-.*$/, "");
+const DEFAULT_BASE_URL = "https://xyq.jianying.com";
+const REPORT_PATH = "/api/biz/v1/skill/report_telemetry";
+const AUTH_HEADER = "Bearer pippit-cli-skill-telemetry";
+const SKILL_NAMES = [
+  "xyq-skill",
+  "xyq-short-drama-skill",
+];
+
+function telemetryBaseURL() {
+  for (const key of ["PIPPIT_CLI_TELEMETRY_BASE_URL", "XYQ_OPENAPI_BASE", "XYQ_BASE_URL"]) {
+    const value = (process.env[key] || "").trim().replace(/\/+$/, "");
+    if (value) return value;
+  }
+  return DEFAULT_BASE_URL;
+}
+
+function reportBundledSkillTelemetry(event, source) {
+  if (process.env.PIPPIT_CLI_DISABLE_TELEMETRY === "1") {
+    return;
+  }
+  for (const skillName of SKILL_NAMES) {
+    reportSkillTelemetry({
+      event,
+      skill_name: skillName,
+      source,
+      cli_version: VERSION,
+      platform: os.platform(),
+      arch: os.arch(),
+    });
+  }
+}
+
+function reportSkillTelemetry(payload) {
+  const body = JSON.stringify(payload);
+  const url = new URL(`${telemetryBaseURL()}${REPORT_PATH}`);
+  const client = url.protocol === "http:" ? http : https;
+
+  try {
+    const req = client.request(url, {
+      method: "POST",
+      timeout: 2000,
+      headers: {
+        "Content-Type": "application/json",
+        "Content-Length": Buffer.byteLength(body),
+        "Authorization": AUTH_HEADER,
+        "x-use-ppe": "1",
+        "x-tt-env": "ppe_harness_novel_v2",
+      },
+    }, (res) => {
+      res.resume();
+      if (process.env.PIPPIT_CLI_DEBUG_TELEMETRY === "1" && res.statusCode >= 400) {
+        console.warn(`[pippit-tool-cli] telemetry failed: HTTP ${res.statusCode}`);
+      }
+    });
+
+    req.on("timeout", () => {
+      req.destroy(new Error("telemetry request timeout"));
+    });
+    req.on("error", (err) => {
+      if (process.env.PIPPIT_CLI_DEBUG_TELEMETRY === "1") {
+        const msg = err && err.message ? err.message : String(err);
+        console.warn(`[pippit-tool-cli] telemetry failed: ${msg}`);
+      }
+    });
+    req.end(body);
+  } catch (err) {
+    if (process.env.PIPPIT_CLI_DEBUG_TELEMETRY === "1") {
+      const msg = err && err.message ? err.message : String(err);
+      console.warn(`[pippit-tool-cli] telemetry failed: ${msg}`);
+    }
+  }
+}
+
+module.exports = {
+  reportBundledSkillTelemetry,
+  reportSkillTelemetry,
+  telemetryBaseURL,
+};