@buoy-gg/core 7.0.41 → 7.0.43

package/lib/commonjs/telemetry/installPing.js

@@ -1,131 +1 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.__resetInstallPingForTests = __resetInstallPingForTests;
-exports.sendInstallPing = sendInstallPing;
-var _reactNative = require("react-native");
-var _sharedUi = require("@buoy-gg/shared-ui");
-var _version = require("../version.js");
-/**
- * Anonymous install ping.
- *
- * Answers the one question licensing data cannot: how many people run Buoy at
- * all. Keygen sees every free and paid key, but by definition it cannot see an
- * install that never claimed one — so without this, "what fraction of installs
- * have an account" has no denominator.
- *
- * Constraints this is built to honor:
- *
- *  - **Development only.** Never fires from a shipped app. Buoy is a developer
- *    tool; pinging from a release build would phone home from an end user's
- *    device — someone who never chose to use Buoy — which is not a trade we are
- *    willing to make for a metric.
- *  - **No PII, no fingerprint.** The install id is a random UUID minted here.
- *    It is not derived from hardware, account, project, or app identity, so it
- *    cannot be correlated to a person or joined against anything else we hold.
- *  - **No tool usage.** What you open and inspect stays on your machine, which
- *    is the whole security story for enterprise adoption. Only the four fields
- *    below ever leave.
- *  - **Silent and harmless.** Fire-and-forget, throttled to once a day, and
- *    every failure path is swallowed. It can never block, slow, or break an app.
- *
- * Opt out with `Buoy.init({ telemetry: false })`.
- */
-
-/** Same `@react_buoy` prefix as every other Buoy key, so it is inspectable. */
-const STORAGE_KEY = "@react_buoy_install";
-const ENDPOINT = "https://buoy.gg/api/t";
-
-/** One ping per install per day is enough to count installs and daily actives. */
-const PING_INTERVAL_MS = 24 * 60 * 60 * 1000;
-/** RFC4122 v4, from Math.random — this is a counter, not a credential. */
-function uuid() {
-  return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, c => {
-    const r = Math.random() * 16 | 0;
-    const v = c === "x" ? r : r & 0x3 | 0x8;
-    return v.toString(16);
-  });
-}
-async function readState() {
-  try {
-    const raw = await _sharedUi.persistentStorage.getItem(STORAGE_KEY);
-    if (!raw) return null;
-    const parsed = JSON.parse(raw);
-    if (typeof parsed?.installId !== "string") return null;
-    return {
-      installId: parsed.installId,
-      lastPingAt: typeof parsed.lastPingAt === "number" ? parsed.lastPingAt : 0
-    };
-  } catch {
-    return null;
-  }
-}
-
-/**
- * Told once, on the very first ping of a new install — not on every launch.
- *
- * A dev tool that phones home silently deserves the reputation it would get.
- * One line, the first time, saying exactly what leaves and how to stop it.
- */
-function announceOnce() {
-  console.log("[Buoy] Anonymous usage ping enabled: a random install id, the Buoy " + "version, your platform, and your license tier — no project, app, or " + "tool data, and only in development. Opt out with " + "Buoy.init({ telemetry: false }). Details: https://buoy.gg/buoy/latest/docs/telemetry");
-}
-let sentThisSession = false;
-
-/**
- * What the ping reports about the account: the tier of an admitted account,
- * or "locked" for an install that has not been admitted (no key, or a key the
- * license server rejected). "locked" is what gives "how many installs never
- * get an account" its numerator.
- */
-
-/**
- * Send the ping if it is due. Safe to call on every mount: it is idempotent
- * within a session, throttled to once a day across sessions, and resolves
- * without throwing no matter what fails.
- */
-async function sendInstallPing(options) {
-  // Never from a shipped app — see the header. This is the single most
-  // important line in the file.
-  const isDevelopment = typeof __DEV__ !== "undefined" && __DEV__;
-  if (!isDevelopment) return;
-  if (!options.enabled) return;
-  if (sentThisSession) return;
-  sentThisSession = true;
-  try {
-    const existing = await readState();
-    const now = Date.now();
-    if (existing && now - existing.lastPingAt < PING_INTERVAL_MS) return;
-    const installId = existing?.installId ?? uuid();
-    if (!existing) announceOnce();
-
-    // Recorded BEFORE the request, so a server that is down or unreachable
-    // can't turn into a ping every single mount.
-    await _sharedUi.persistentStorage.setItem(STORAGE_KEY, JSON.stringify({
-      installId,
-      lastPingAt: now
-    }));
-    await fetch(ENDPOINT, {
-      method: "POST",
-      headers: {
-        "Content-Type": "application/json"
-      },
-      body: JSON.stringify({
-        installId,
-        version: _version.SDK_VERSION,
-        platform: _reactNative.Platform.OS,
-        tier: options.tier
-      })
-    });
-  } catch {
-    // Offline, firewalled, endpoint down — all fine. A metric is never worth
-    // a warning in someone else's console.
-  }
-}
-
-/** Test seam: forget that a ping already went out this session. */
-function __resetInstallPingForTests() {
-  sentThisSession = false;
-}
+"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.__resetInstallPingForTests=__resetInstallPingForTests;exports.sendInstallPing=sendInstallPing;var _reactNative=require("react-native");var _sharedUi=require("@buoy-gg/shared-ui");var _version=require("../version.js");const STORAGE_KEY="@react_buoy_install";const ENDPOINT="https://buoy.gg/api/t";const PING_INTERVAL_MS=24*60*60*1e3;function uuid(){return"xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g,e=>{const t=Math.random()*16|0;const n=e==="x"?t:t&3|8;return n.toString(16)})}async function readState(){try{const e=await _sharedUi.persistentStorage.getItem(STORAGE_KEY);if(!e)return null;const t=JSON.parse(e);if(typeof t?.installId!=="string")return null;return{installId:t.installId,lastPingAt:typeof t.lastPingAt==="number"?t.lastPingAt:0}}catch{return null}}function announceOnce(){console.log("[Buoy] Anonymous usage ping enabled: a random install id, the Buoy version, your platform, and your license tier \u2014 no project, app, or tool data, and only in development. Opt out with Buoy.init({ telemetry: false }). Details: https://buoy.gg/buoy/latest/docs/telemetry")}let sentThisSession=false;async function sendInstallPing(e){const t=typeof __DEV__!=="undefined"&&__DEV__;if(!t)return;if(!e.enabled)return;if(sentThisSession)return;sentThisSession=true;try{const n=await readState();const r=Date.now();if(n&&r-n.lastPingAt<PING_INTERVAL_MS)return;const s=n?.installId??uuid();if(!n)announceOnce();await _sharedUi.persistentStorage.setItem(STORAGE_KEY,JSON.stringify({installId:s,lastPingAt:r}));await fetch(ENDPOINT,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify({installId:s,version:_version.SDK_VERSION,platform:_reactNative.Platform.OS,tier:e.tier})})}catch{}}function __resetInstallPingForTests(){sentThisSession=false}