@keyframerdev/vitals 0.1.3 → 0.1.5

package/README.md

@@ -27,12 +27,15 @@ At the app's entry, with the project's field key (`kfp_live_…`, public and wri
 ```ts
 import { startVitals } from '@keyframerdev/vitals'
 import AsyncStorage from '@react-native-async-storage/async-storage'
-import * as Application from 'expo-application'
+import Constants from 'expo-constants'
+import { Platform } from 'react-native'
+
+const build = Platform.OS === 'ios' ? Constants.platform?.ios?.buildNumber : Constants.expoConfig?.android?.versionCode
 
 startVitals({
   key: 'kfp_live_…',
-  appVersion: Application.nativeApplicationVersion!,
-  build: Application.nativeBuildVersion ?? undefined,
+  appVersion: Constants.expoConfig?.version ?? '0',
+  build: build == null ? undefined : String(build),
   navigationRef, // React Navigation's createNavigationContainerRef() or expo-router's useNavigationContainerRef()
   storage: AsyncStorage, // optional: checkpoints, retries and the daily cap survive restarts
 })
@@ -40,6 +43,10 @@ startVitals({
 
 Nothing is measured or sent before `startVitals`. If your app asks for consent, call it after.
 
+`expo-constants` rather than `expo-application`: the latter is a native module, and an EAS Update that adds it crashes every installed binary built without it. Without Expo, use `react-native-device-info` or your own constants.
+
+Before your store release, declare it in the stores' privacy forms (App Store: Diagnostics > Performance Data; Google Play: Diagnostics) and add a sentence to your privacy policy: [what to declare](https://keyframer.dev/inspector/docs/vitals/store-privacy).
+
 | Option | Default | What it does |
 | --- | --- | --- |
 | `key` | required | The project's field key |
@@ -53,6 +60,7 @@ Nothing is measured or sent before `startVitals`. If your app asks for consent,
 | `device` | none | `{ model, memoryBytes, memoryGb, tier, displayHz }`, read by the app (for example from `expo-device`) |
 | `appId` | none | The bundle id or package name |
 | `endpoint` | `https://vitals.keyframer.dev` | The ingest server |
+| `debug` | `false` | Logs what the SDK decides, measures and sends: the session and its sampling, frames a second per thread, each report against the server's limits. Lines are tagged `[Keyframer.dev]` and go through `console.debug`, so Metro shows them as `DEBUG` (a note for you, such as development builds being off, is `INFO`; a refused report is `WARN`). For development builds |
 
 ## Call sites with file and line
 

package/dist/index.js

@@ -624,7 +624,7 @@ var MAX_FRAME_MS = 10 * 60 * 1000;
 
 // src/version.ts
 var SDK_NAME = "@keyframerdev/vitals";
-var SDK_VERSION = "0.1.3";
+var SDK_VERSION = "0.1.5";
 
 // src/controller.ts
 var STORAGE_KEYS = {
@@ -684,6 +684,7 @@ async function write(storage, key, value) {
       await storage.setItem(key, JSON.stringify(value));
   } catch {}
 }
+var TAG = "[Keyframer.dev]";
 
 class VitalsController {
   env;
@@ -813,7 +814,7 @@ class VitalsController {
       }
     }
     this.sampled = sampled;
-    this.debug(`session ${this.nonce.slice(0, 6)}: ${sampled ? "sampled" : "not sampled"} (rate ${this.sampleRate}, environment ${env}` + `${devOk ? "" : ", the project does not collect development builds"})`);
+    this.debug(`Motion Vitals ${SDK_VERSION}, session ${this.nonce.slice(0, 6)}: ${sampled ? "sampled" : "not sampled"} (rate ${this.sampleRate}, environment ${env}` + `${devOk ? "" : ", the project does not collect development builds"})`);
     if (!sampled)
       return;
     this.collector.clear();
@@ -1221,7 +1222,11 @@ class VitalsController {
     if (run !== this.run || !this.opts)
       return;
     try {
-      const res = await this.env.fetch(`${this.endpoint()}/v1/config/${encodeURIComponent(this.opts.key)}`, { method: "GET", headers: {} });
+      const fresh = Math.round(this.env.wall()).toString(36);
+      const res = await this.env.fetch(`${this.endpoint()}/v1/config/${encodeURIComponent(this.opts.key)}?t=${fresh}`, {
+        method: "GET",
+        headers: { "Cache-Control": "no-cache" }
+      });
       if (run !== this.run)
         return;
       if (res.status === 200) {
@@ -1254,7 +1259,7 @@ class VitalsController {
       if (kept)
         this.debug("this project keeps development builds: this build's reports show in the dashboard's Development view");
       else
-        this.env.log?.("[keyframer vitals] This project does not keep reports from development builds, so this build sends nothing. " + `To test here, turn on "Development builds" in the project's setup on keyframer.dev, then reload. Release builds are not affected.`, "info");
+        this.env.log?.(`${TAG} This project does not keep reports from development builds, so this build sends nothing. ` + `To test here, turn on "Development builds" in the project's setup on keyframer.dev, then reload. Release builds are not affected.`, "info");
     }
     if (!kept && this.sampled)
       this.endSampling();
@@ -1291,11 +1296,11 @@ class VitalsController {
     }
   }
   log(message) {
-    this.env.log?.(`[keyframer vitals] ${message}`);
+    this.env.log?.(`${TAG} ${message}`, "warn");
   }
   debug(message) {
     if (this.opts?.debug)
-      this.env.log?.(`[keyframer vitals] ${message}`, "debug");
+      this.env.log?.(`${TAG} ${message}`, "debug");
   }
 }
 
@@ -1446,7 +1451,7 @@ var env = {
   setTimeout: (fn, ms) => setTimeout(fn, ms),
   clearTimeout: (h) => clearTimeout(h),
   platform: { os: Platform.OS === "ios" ? "ios" : "android", osMajor: osMajor() },
-  log: (m, level) => level === "debug" || level === "info" ? console.log(m) : console.warn(m)
+  log: (m, level) => level === "debug" ? console.debug(m) : level === "info" ? console.info(m) : console.warn(m)
 };
 var controller = new VitalsController(env);
 var jsHook = createJsHook(controller, () => checkScreen());

package/dist/types/version.d.ts

@@ -1,3 +1,3 @@
 /** This package's version: sent in every report's `sdk`, and compared with the config's `minSdk`. Keep it in step with package.json. */
 export declare const SDK_NAME = "@keyframerdev/vitals";
-export declare const SDK_VERSION = "0.1.3";
+export declare const SDK_VERSION = "0.1.5";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@keyframerdev/vitals",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "Motion Vitals for React Native: slow frames and janky animations from production, by screen and call site",
   "keywords": [
     "react-native",