@buoy-gg/core 7.0.41 → 7.0.42

package/lib/module/floatingMenu/deviceIdentity.js

@@ -1,163 +1 @@
-"use strict";
-
-/**
- * How a device introduces itself to the Buoy Desktop broker.
- *
- * The id used to be `<app-slug>-<platform>` — a BUILD identity, not a device
- * identity. Every phone and simulator running the same app registered under
- * the same id, and the broker (which deliberately lets one device hold
- * several sockets for Fast Refresh) treated each newcomer as a reconnect and
- * handed it the identity. Actions then landed on whichever device connected
- * most recently, silently. See DEVICE_IDENTITY_COLLISION.md.
- *
- * Now the id carries a per-install tail minted once and persisted:
- *
- *   deviceId   = "<app-slug>-<platform>-<8 hex>"      e.g. acme-app-ios-3f9a2c1d
- *   deviceName = "<App Name> (<hardware> · <last 4>)" e.g. Acme App (iPhone 17 Pro · 2c1d)
- *
- * The tail is what makes two devices on one build two devices. The name's
- * hardware label comes from expo-constants' `deviceName` when available (the
- * simulator's own name on a sim, "iPhone" on iOS 16+ hardware, the model on
- * Android) and falls back to the platform; the 4-char tail is always on so
- * two identical simulators never share a label.
- *
- * Persistence: native goes through shared's `persistentStorage` (file system
- * → AsyncStorage → memory); web uses `sessionStorage` so every browser TAB
- * is its own device — `localStorage` is shared across tabs and would collide
- * exactly the way the old default did. The id does not survive a reinstall
- * on purpose: it crosses an unauthenticated LAN socket, and deleting the app
- * should reset it.
- *
- * An explicit `externalSync.deviceId` bypasses all of this; whoever pins an
- * id owns its uniqueness.
- */
-import { useEffect, useMemo, useState } from "react";
-import { Platform } from "react-native";
-import { devToolsStorageKeys, persistentStorage } from "@buoy-gg/shared-ui";
-
-/** Minimal getItem/setItem surface, so storage can be injected in tests. */
-
-export const INSTALL_ID_LENGTH = 8;
-
-/** 8 lowercase hex chars — short enough to read, random enough for a LAN. */
-export function generateInstallId() {
-  let out = "";
-  while (out.length < INSTALL_ID_LENGTH) {
-    out += (Math.random() * 16 | 0).toString(16);
-  }
-  return out;
-}
-function slugify(name) {
-  return name.toLowerCase().replace(/[^a-z0-9]+/g, "-").replace(/(^-|-$)/g, "");
-}
-/** Pure: turns the inputs into the id/name pair the broker sees. */
-export function buildDeviceIdentity({
-  appName,
-  hardwareName,
-  platform,
-  installId,
-  deviceId
-}) {
-  const slug = slugify(appName ?? "buoy") || "buoy";
-  const label = appName ?? "Buoy Device";
-  const hardware = hardwareName?.trim() || platform;
-  if (deviceId) {
-    // The app pinned its own id: it can also pin its own name, so keep the
-    // default name free of a tail that would refer to an id nobody sees.
-    return {
-      deviceId,
-      deviceName: `${label} (${hardware})`
-    };
-  }
-  const id = `${slug}-${platform}-${installId}`;
-  return {
-    deviceId: id,
-    deviceName: `${label} (${hardware} · ${installId.slice(-4)})`
-  };
-}
-
-// Web: every tab is a device, so the id lives in the tab's sessionStorage.
-function sessionStore() {
-  const g = globalThis;
-  try {
-    return g.sessionStorage ?? null;
-  } catch {
-    return null;
-  }
-}
-/**
- * The persisted per-install tail: read it, or mint and store it on the first
- * dial. Storage failures degrade to a fresh in-memory id rather than blocking
- * the socket — a per-launch id still beats the old colliding one.
- */
-export async function loadInstallId({
-  platform = Platform.OS,
-  store,
-  mint = generateInstallId
-} = {}) {
-  const key = devToolsStorageKeys.sync.deviceId();
-  const target = store === undefined ? platform === "web" ? sessionStore() : persistentStorage : store;
-  if (!target) return mint();
-  try {
-    const existing = await target.getItem(key);
-    if (existing && existing.length > 0) return existing;
-    const fresh = mint();
-    await target.setItem(key, fresh);
-    return fresh;
-  } catch {
-    return mint();
-  }
-}
-let installIdPromise = null;
-
-/**
- * Process-wide memo so every mount (and every Fast Refresh of the component
- * that calls it) shares one storage round-trip and one id.
- */
-export function getInstallId() {
-  if (!installIdPromise) installIdPromise = loadInstallId();
-  return installIdPromise;
-}
-
-/** Tests only. */
-export function resetInstallIdForTests() {
-  installIdPromise = null;
-}
-/**
- * The identity to dial with. Null until the per-install id is read from
- * storage (one round-trip on first mount; memoized process-wide after) —
- * both sync hooks no-op on a null id, so the socket simply dials a beat
- * later. An explicit `deviceId` skips the read entirely; an explicit
- * `deviceName` is used verbatim.
- */
-export function useDeviceIdentity(options, env) {
-  const pinnedId = options?.deviceId;
-  const pinnedName = options?.deviceName;
-  const loadId = env.loadId ?? getInstallId;
-  const platform = env.platform ?? Platform.OS;
-  const [installId, setInstallId] = useState(null);
-  useEffect(() => {
-    if (pinnedId) return;
-    let cancelled = false;
-    loadId().then(id => {
-      if (!cancelled) setInstallId(id);
-    });
-    return () => {
-      cancelled = true;
-    };
-  }, [pinnedId, loadId]);
-  return useMemo(() => {
-    if (!pinnedId && !installId) return null;
-    const identity = buildDeviceIdentity({
-      appName: env.appName,
-      hardwareName: env.hardwareName,
-      platform,
-      installId: installId ?? "",
-      deviceId: pinnedId
-    });
-    return pinnedName ? {
-      ...identity,
-      deviceName: pinnedName
-    } : identity;
-  }, [pinnedId, pinnedName, installId, env.appName, env.hardwareName, platform]);
-}
+"use strict";import{useEffect as f,useMemo as I,useState as m}from"react";import{Platform as u}from"react-native";import{devToolsStorageKeys as p,persistentStorage as g}from"@buoy-gg/shared-ui";export const INSTALL_ID_LENGTH=8;export function generateInstallId(){let e="";while(e.length<INSTALL_ID_LENGTH){e+=(Math.random()*16|0).toString(16)}return e}function h(e){return e.toLowerCase().replace(/[^a-z0-9]+/g,"-").replace(/(^-|-$)/g,"")}export function buildDeviceIdentity({appName:e,hardwareName:n,platform:t,installId:r,deviceId:o}){const s=h(e??"buoy")||"buoy";const a=e??"Buoy Device";const l=n?.trim()||t;if(o){return{deviceId:o,deviceName:`${a} (${l})`}}const i=`${s}-${t}-${r}`;return{deviceId:i,deviceName:`${a} (${l} \xB7 ${r.slice(-4)})`}}function y(){const e=globalThis;try{return e.sessionStorage??null}catch{return null}}export async function loadInstallId({platform:e=u.OS,store:n,mint:t=generateInstallId}={}){const r=p.sync.deviceId();const o=n===void 0?e==="web"?y():g:n;if(!o)return t();try{const s=await o.getItem(r);if(s&&s.length>0)return s;const a=t();await o.setItem(r,a);return a}catch{return t()}}let c=null;export function getInstallId(){if(!c)c=loadInstallId();return c}export function resetInstallIdForTests(){c=null}export function useDeviceIdentity(e,n){const t=e?.deviceId;const r=e?.deviceName;const o=n.loadId??getInstallId;const s=n.platform??u.OS;const[a,l]=m(null);f(()=>{if(t)return;let i=false;o().then(d=>{if(!i)l(d)});return()=>{i=true}},[t,o]);return I(()=>{if(!t&&!a)return null;const i=buildDeviceIdentity({appName:n.appName,hardwareName:n.hardwareName,platform:s,installId:a??"",deviceId:t});return r?{...i,deviceName:r}:i},[t,r,a,n.appName,n.hardwareName,s])}