@spooky-sync/core 0.0.1-canary.32 → 0.0.1-canary.321

package/src/modules/auth/index.ts

@@ -1,17 +1,57 @@
-import { RemoteDatabaseService } from '../../services/database/remote';
-import { LocalDatabaseService } from '../../services/database/local';
-import { DataModule } from '../data/index';
-import {
+import type { RemoteDatabaseService } from '../../services/database/remote';
+import type {
   SchemaStructure,
   AccessDefinition,
   ColumnSchema,
   TypeNameToTypeMap,
 } from '@spooky-sync/query-builder';
-import { Logger } from '../../services/logger/index';
-import { encodeRecordId } from '../../utils/index';
+import type { Logger } from '../../services/logger/index';
 export * from './events/index';
 import { AuthEventTypes, createAuthEventSystem } from './events/index';
-import { PersistenceClient } from '../../types';
+import type { PersistenceClient } from '../../types';
+import { classifySyncError } from '../../utils/error-classification';
+import { encodeRecordId } from '../../utils/index';
+import { RecordId } from 'surrealdb';
+import {
+  decodeTokenClaims,
+  impersonationFromToken,
+  sameImpersonation,
+  ImpersonationTimers,
+  ORIGIN_TOKEN_KEY,
+} from './impersonation';
+import type { ImpersonationInfo } from './impersonation';
+export * from './impersonation';
+
+/** What `fn::_00_impersonate::list_users` returns per row. */
+export interface ImpersonationCandidate {
+  id: string;
+  is_admin: boolean;
+  [field: string]: unknown;
+}
+
+/** An open session, as `fn::_00_impersonate::active` lists it. */
+export interface ActiveImpersonation {
+  session: string;
+  target: string;
+  admin: string;
+  reason: string;
+  started_at: unknown;
+  expires_at: unknown;
+}
+
+/** What a sign-out hook sees: the session that is about to end. */
+export interface SignOutContext {
+  /** `table:id` of the signed-in record, or null. */
+  userId: string | null;
+  token: string | null;
+  /** The session is an admin impersonation (its token is the target's). */
+  impersonating: boolean;
+}
+
+export type SignOutHook = (ctx: SignOutContext) => Promise<void> | void;
+
+/** Upper bound on the before-sign-out hooks, so a dead socket never holds a sign-out. */
+export const SIGN_OUT_HOOK_TIMEOUT_MS = 2_000;
 
 // Helper to pretty print types
 type Prettify<T> = {
@@ -38,14 +78,55 @@ type ExtractAccessParams<
       }>
     : never;
 
+function decodeAccessFromToken(token: string): string | null {
+  return decodeTokenClaims(token).access;
+}
+
 export class AuthService<S extends SchemaStructure> {
   // State
   public token: string | null = null;
   public currentUser: any | null = null;
   public isAuthenticated: boolean = false;
+  /**
+   * The record-access method name for the current session (e.g. `"account"`),
+   * derived from the token's `AC` claim. Consumed by the in-browser SSP's
+   * permission injection so `$access`-gated table predicates resolve locally,
+   * mirroring the server's `$access`. Null when logged out.
+   */
+  public access: string | null = null;
   public isLoading: boolean = true;
 
   private events = createAuthEventSystem();
+  private signOutHooks = new Set<SignOutHook>();
+
+  /** The impersonation last announced, for change detection. */
+  private announcedImpersonation: ImpersonationInfo | null = null;
+  /** Target of an impersonation that just ended, until the client purges its
+   *  local bucket (see `consumeEndedImpersonation`). */
+  private endedImpersonationTarget: string | null = null;
+  /** The way back to the admin in flight. The Stop button, the session poll,
+   *  a refused renewal and a rejected check can all end an impersonation, and
+   *  they share this one: a second stop running beside the first found the
+   *  admin token already taken and signed the admin out. */
+  private stopping: Promise<void> | null = null;
+  /** A token renewal in flight, which a stop waits out (see `renewImpersonation`). */
+  private renewing: Promise<void> | null = null;
+  private impersonationTimers = new ImpersonationTimers({
+    current: () => this.impersonation,
+    renew: () => this.renewImpersonation(),
+    stillActive: async () => {
+      const [row] = await this.remote.query<[unknown]>('RETURN fn::_00_impersonate::current()');
+      return row !== null && row !== undefined;
+    },
+    endedRemotely: async (reason) => {
+      this.logger.warn(
+        { reason, Category: 'sp00ky-client::AuthService::impersonation' },
+        'Impersonation ended on the server; returning to the admin session'
+      );
+      await this.stopImpersonating({ serverEnded: true });
+    },
+    isNetworkError: (error) => classifySyncError(error) === 'network',
+  });
 
   public get eventSystem() {
     return this.events;
@@ -72,7 +153,7 @@ export class AuthService<S extends SchemaStructure> {
    */
   subscribe(cb: (userId: string | null) => void): () => void {
     // Immediate callback
-    cb(this.currentUser?.id || null);
+    cb(this.announcedUserId());
 
     const id = this.events.subscribe(AuthEventTypes.AuthStateChanged, (event) => {
       cb(event.payload);
@@ -83,9 +164,283 @@ export class AuthService<S extends SchemaStructure> {
     };
   }
 
+  /**
+   * Run `hook` at the start of every sign-out, while the token and the socket
+   * still belong to the leaving user (Web Push removes this device's
+   * subscription here). Hooks are best-effort: they run in parallel, errors
+   * are swallowed, and the sign-out goes on after
+   * {@link SIGN_OUT_HOOK_TIMEOUT_MS} whatever they are doing. Returns a disposer.
+   */
+  onBeforeSignOut(hook: SignOutHook): () => void {
+    this.signOutHooks.add(hook);
+    return () => {
+      this.signOutHooks.delete(hook);
+    };
+  }
+
+  private async runSignOutHooks(): Promise<void> {
+    if (this.signOutHooks.size === 0 || !this.isAuthenticated) return;
+    const id = this.currentUser?.id;
+    const ctx: SignOutContext = {
+      userId: id ? (typeof id === 'string' ? id : encodeRecordId(id)) : null,
+      token: this.token,
+      impersonating: this.impersonation !== null,
+    };
+    let timer: ReturnType<typeof setTimeout> | undefined;
+    const deadline = new Promise<void>((resolve) => {
+      timer = setTimeout(resolve, SIGN_OUT_HOOK_TIMEOUT_MS);
+    });
+    const hooks = Promise.allSettled([...this.signOutHooks].map(async (hook) => hook(ctx)));
+    try {
+      await Promise.race([hooks, deadline]);
+    } finally {
+      clearTimeout(timer);
+    }
+  }
+
+  /**
+   * The signed-in user as subscribers see it: the raw `table:id` string, the
+   * way the token's `ID` claim spells it. `currentUser.id` is that string while
+   * the session is restored from the token and the server's `RecordId` once
+   * `check()` has answered, and the two must announce as the same user: every
+   * subscriber that compares ids (feature flags, app release) took the switch
+   * for a new principal and reset, so flag-gated UI blinked off and back on a
+   * few seconds into every reload. A `RecordId`'s own `toString()` will not do
+   * either, as it escapes ids like `user:⟨5abc⟩` that the claim spells raw.
+   */
+  private announcedUserId(): string | null {
+    const id = this.currentUser?.id;
+    if (!id) return null;
+    if (typeof id === 'string') return id;
+    return id instanceof RecordId ? encodeRecordId(id as RecordId<string>) : String(id);
+  }
+
   private notifyListeners() {
-    const userId = this.currentUser?.id || null;
+    const userId = this.announcedUserId();
     this.events.emit(AuthEventTypes.AuthStateChanged, userId);
+    const impersonation = this.impersonation;
+    if (!sameImpersonation(impersonation, this.announcedImpersonation)) {
+      this.announcedImpersonation = impersonation;
+      this.events.emit(AuthEventTypes.ImpersonationChanged, impersonation);
+    }
+    this.impersonationTimers.sync();
+  }
+
+  /**
+   * The impersonation the current session is, or null. Derived from the
+   * token in use, so it always describes the identity the server sees.
+   */
+  get impersonation(): ImpersonationInfo | null {
+    return this.isAuthenticated ? impersonationFromToken(this.token) : null;
+  }
+
+  /** Subscribe to impersonation changes; called immediately with the current value. */
+  subscribeImpersonation(cb: (info: ImpersonationInfo | null) => void): () => void {
+    cb(this.impersonation);
+    const id = this.events.subscribe(AuthEventTypes.ImpersonationChanged, (event) => {
+      cb(event.payload);
+    });
+    return () => {
+      this.events.unsubscribe(id);
+    };
+  }
+
+  /**
+   * Act as `targetId` (a record id such as `user:abc`). Admins only, and only
+   * when the project enabled `impersonation` in sp00ky.yml: the server refuses
+   * everything else. `reason` is recorded in the audit log.
+   *
+   * The admin's session is kept aside and restored by
+   * {@link stopImpersonating}. Local data switches to the target's bucket
+   * exactly as on a sign-in, and that bucket is removed on stop.
+   */
+  async impersonate(targetId: string, reason: string): Promise<ImpersonationInfo> {
+    if (this.impersonation) throw new Error('Already impersonating; stop first.');
+    if (!this.isAuthenticated || !this.token) throw new Error('Sign in as an admin first.');
+    const originToken = this.token;
+    const [started] = await this.remote.query<[{ token: string }]>(
+      'RETURN fn::_00_impersonate::start($target, $reason)',
+      { target: targetId, reason }
+    );
+    if (!started?.token) throw new Error('The server did not return an impersonation token.');
+
+    await this.persistenceClient.set(ORIGIN_TOKEN_KEY, originToken);
+    try {
+      await this.remote.getClient().authenticate(started.token);
+    } catch (error) {
+      // The server refused the session it just issued (for example the
+      // target is an admin, or no longer exists). Nothing changed locally
+      // yet; put the admin's token back on the transport.
+      await this.persistenceClient.remove(ORIGIN_TOKEN_KEY);
+      this.remote.setAuthToken(originToken);
+      await this.remote.getClient().authenticate(originToken).catch(() => undefined);
+      throw error;
+    }
+    await this.check(started.token);
+    // A method call, not the getter: TS narrowed the getter to null above.
+    const info = impersonationFromToken(this.isAuthenticated ? this.token : null);
+    if (!info) {
+      await this.stopImpersonating();
+      throw new Error('Impersonation could not be established.');
+    }
+    this.logger.info(
+      { target: info.target, session: info.session, Category: 'sp00ky-client::AuthService::impersonate' },
+      'Impersonation started'
+    );
+    return info;
+  }
+
+  /**
+   * Return to the admin session. Always leaves the impersonated identity,
+   * even when the server cannot be reached: the admin token is restored
+   * locally first and verified afterwards, and a rejected admin token ends in
+   * a full sign-out rather than staying on the target.
+   */
+  async stopImpersonating(opts: { serverEnded?: boolean } = {}): Promise<void> {
+    if (this.stopping) return this.stopping;
+    if (!this.impersonation) return;
+    this.stopping = this.leaveImpersonation(opts).finally(() => {
+      this.stopping = null;
+    });
+    return this.stopping;
+  }
+
+  private async leaveImpersonation(opts: { serverEnded?: boolean }): Promise<void> {
+    this.impersonationTimers.clear();
+    // A renewal already sent finishes first, so it cannot put the target's
+    // token back on the socket after the admin's (it sees `stopping` and
+    // stands down).
+    await this.renewing?.catch(() => undefined);
+    const info = this.impersonation;
+    if (!info) return;
+    if (!opts.serverEnded) {
+      try {
+        await this.remote.query('RETURN fn::_00_impersonate::stop($session)', { session: info.session });
+      } catch (error) {
+        // The token expires on its own; the local switch below is what matters.
+        this.logger.warn(
+          { error, Category: 'sp00ky-client::AuthService::stopImpersonating' },
+          'Could not end the impersonation session on the server'
+        );
+      }
+    }
+    this.endedImpersonationTarget = info.target;
+    const origin = await this.persistenceClient.get<string>(ORIGIN_TOKEN_KEY);
+    await this.persistenceClient.remove(ORIGIN_TOKEN_KEY);
+    if (!origin || impersonationFromToken(origin)) {
+      await this.signOut();
+      return;
+    }
+    const { access, userId } = decodeTokenClaims(origin);
+    if (!userId) {
+      await this.signOut();
+      return;
+    }
+    // Optimistic switch back, as a warm boot does, then verify.
+    this.token = origin;
+    this.remote.setAuthToken(origin);
+    this.currentUser = { id: userId };
+    this.access = access ?? this.defaultAccessName();
+    await this.persistenceClient.set('sp00ky_auth_token', origin);
+    this.notifyListeners();
+    await this.check(origin);
+    this.logger.info(
+      { target: info.target, Category: 'sp00ky-client::AuthService::stopImpersonating' },
+      'Impersonation stopped'
+    );
+  }
+
+  /** Re-sign the impersonation token before it expires. */
+  async renewImpersonation(): Promise<void> {
+    if (!this.impersonation || this.stopping) return;
+    const renewal = this.applyRenewal();
+    this.renewing = renewal;
+    try {
+      await renewal;
+    } finally {
+      if (this.renewing === renewal) this.renewing = null;
+    }
+  }
+
+  private async applyRenewal(): Promise<void> {
+    const [renewed] = await this.remote.query<[{ token: string }]>('RETURN fn::_00_impersonate::renew()');
+    if (!renewed?.token) throw new Error('Impersonation renewal returned no token.');
+    // A stop began while the server was signing: the session is being left,
+    // so a fresh token for it must not go on the socket or into storage.
+    if (this.stopping || !this.impersonation) return;
+    this.remote.setAuthToken(renewed.token);
+    await this.remote.getClient().authenticate(renewed.token);
+    this.token = renewed.token;
+    await this.persistenceClient.set('sp00ky_auth_token', renewed.token);
+    this.notifyListeners();
+  }
+
+  /** Users an admin may pick from. Admin-only on the server. */
+  async searchImpersonationTargets(search: string): Promise<ImpersonationCandidate[]> {
+    const [rows] = await this.remote.query<[ImpersonationCandidate[]]>(
+      'RETURN fn::_00_impersonate::list_users($search)',
+      { search }
+    );
+    return Array.isArray(rows) ? rows : [];
+  }
+
+  /** Open impersonation sessions. Admin-only on the server. */
+  async listActiveImpersonations(): Promise<ActiveImpersonation[]> {
+    const [rows] = await this.remote.query<[ActiveImpersonation[]]>('RETURN fn::_00_impersonate::active()');
+    return Array.isArray(rows) ? rows : [];
+  }
+
+  /**
+   * The target of an impersonation that ended, once. The bucket switch calls
+   * this after leaving a bucket so it can delete that user's local data.
+   */
+  consumeEndedImpersonation(): string | null {
+    const target = this.endedImpersonationTarget;
+    this.endedImpersonationTarget = null;
+    return target;
+  }
+
+  /**
+   * Restore a session from the locally cached JWT, with NO network.
+   *
+   * This is what makes a warm boot paint instantly and what makes an offline
+   * boot possible at all: the token is in local storage, and it already carries
+   * both the access method and the `$auth.id` record id. Everything the client
+   * needs to route queries (`setCurrentUserId`) and to satisfy `$auth`-gated
+   * permission predicates in the in-browser SSP (`setSessionAuth`) is therefore
+   * available before a socket exists.
+   *
+   * The session is OPTIMISTIC: the token is unverified here. `check()` runs
+   * afterwards in the background and downgrades to a real sign-out if the
+   * server rejects it. Nothing is trusted that the server has not also seen -
+   * the local store only ever holds rows the server previously sent.
+   *
+   * Returns the restored user id, or null when there is no usable token.
+   */
+  async restoreSessionFromToken(): Promise<string | null> {
+    const token = await this.persistenceClient.get<string>('sp00ky_auth_token');
+    if (!token) return null;
+    const { access, userId } = decodeTokenClaims(token);
+    if (!userId) return null;
+
+    this.token = token;
+    // Hand it to the transport too, so a socket rebuilt from scratch later
+    // (the supervisor's revive loop) comes back authenticated. Without this the
+    // page kept reporting this user while its session was anonymous, and every
+    // view registered afterwards was stamped with an empty identity.
+    this.remote.setAuthToken(token);
+    // Only the id: the full row is not in the token. It lands from the local
+    // cache when the app's own `user` query paints, and is replaced wholesale
+    // by `check()` once the server answers.
+    this.currentUser = { id: userId };
+    this.isAuthenticated = true;
+    this.access = access ?? this.defaultAccessName();
+    this.notifyListeners();
+    this.logger.debug(
+      { userId, Category: 'sp00ky-client::AuthService::restoreSessionFromToken' },
+      'Session restored optimistically from cached token'
+    );
+    return userId;
   }
 
   /**
@@ -94,8 +449,12 @@ export class AuthService<S extends SchemaStructure> {
   async check(accessToken?: string) {
     this.isLoading = true;
 
+    let token: string | undefined;
+    // Set once the server has accepted the token: from then on a failure is a
+    // failure to read the user row, not a verdict on the session.
+    let accepted = false;
     try {
-      const token = accessToken || (await this.persistenceClient.get<string>('sp00ky_auth_token'));
+      token = accessToken || (await this.persistenceClient.get<string>('sp00ky_auth_token')) || undefined;
 
       if (!token) {
         this.logger.debug(
@@ -108,8 +467,12 @@ export class AuthService<S extends SchemaStructure> {
         return;
       }
 
-      // Authenticate with the token
+      // Authenticate with the token, and record it for future connects so a
+      // socket rebuilt from scratch reproduces this identity (see
+      // `RemoteDatabaseService.setAuthToken`).
+      this.remote.setAuthToken(token);
       await this.remote.getClient().authenticate(token);
+      accepted = true;
 
       // Verify the session by fetching the full user record using $auth.id
       const result = await this.remote.query('SELECT * FROM ONLY $auth.id');
@@ -149,33 +512,105 @@ export class AuthService<S extends SchemaStructure> {
             { Category: 'sp00ky-client::AuthService::check' },
             'Token valid but user not found via fallback'
           );
-          await this.signOut();
+          await this.rejectToken(token);
         }
       }
     } catch (error) {
-      this.logger.error(
-        { error, stack: (error as Error).stack, Category: 'sp00ky-client::AuthService::check' },
-        'Auth check failed'
-      );
-      await this.signOut();
+      // A REACHABILITY failure is not a rejected token. This catch used to call
+      // signOut() unconditionally, which deletes `sp00ky_auth_token` - so a
+      // blip on boot silently logged the user out, and an offline boot could
+      // never stay signed in. Only an application error (the server answered,
+      // and the answer was "no") ends the session.
+      if (classifySyncError(error) === 'network') {
+        this.logger.warn(
+          { error, Category: 'sp00ky-client::AuthService::check' },
+          'Auth check unreachable; keeping the cached session and retrying later'
+        );
+      } else if (accepted && token) {
+        // The server took the token and only the read of the user row failed
+        // (a busy database, a statement error). Signing out here logged an
+        // admin out on the way back from an impersonation while the database
+        // was saturated. Keep the session on the id the token names; the row
+        // arrives with the next check or the app's own user query.
+        this.logger.warn(
+          { error, Category: 'sp00ky-client::AuthService::check' },
+          'Auth check accepted the token but could not read the user; keeping the session'
+        );
+        await this.keepAcceptedSession(token);
+      } else {
+        this.logger.error(
+          { error, stack: (error as Error).stack, Category: 'sp00ky-client::AuthService::check' },
+          'Auth check failed'
+        );
+        await this.rejectToken(token);
+      }
     } finally {
       this.isLoading = false;
     }
   }
 
+  /** Hold a session the server accepted without its user row: the id comes
+   *  from the token, as on a warm boot. A token naming no user is refused. */
+  private async keepAcceptedSession(token: string): Promise<void> {
+    if (this.isAuthenticated && this.token === token && this.currentUser) return;
+    const { userId } = decodeTokenClaims(token);
+    if (!userId) {
+      await this.rejectToken(token);
+      return;
+    }
+    await this.setSession(token, { id: userId });
+  }
+
   /**
-   * Sign out and clear session
+   * The server refused `token`. A refused impersonation token (stopped,
+   * expired, or revoked) returns to the admin session instead of signing the
+   * admin out; anything else signs out.
+   */
+  private async rejectToken(token: string | undefined): Promise<void> {
+    if (token && impersonationFromToken(token)) {
+      if (!this.impersonation || this.token !== token) {
+        // A boot or explicit check with an impersonation token that is not
+        // the session in memory yet: adopt it so stop has something to leave.
+        this.token = token;
+        this.isAuthenticated = true;
+      }
+      await this.stopImpersonating({ serverEnded: true });
+      return;
+    }
+    await this.signOut();
+  }
+
+  /**
+   * Sign out and clear session. While impersonating this ends the
+   * impersonation and signs the admin out too.
    */
   async signOut() {
+    // Before anything is dropped: hooks still act as the leaving user.
+    await this.runSignOutHooks();
+    const impersonating = this.impersonation;
+    this.impersonationTimers.clear();
+    if (impersonating) {
+      this.endedImpersonationTarget = impersonating.target;
+      try {
+        await this.remote.query('RETURN fn::_00_impersonate::stop($session)', {
+          session: impersonating.session,
+        });
+      } catch (_e) {
+        // The token expires on its own.
+      }
+    }
+    await this.persistenceClient.remove(ORIGIN_TOKEN_KEY);
     this.token = null;
+    this.remote.setAuthToken(null);
     this.currentUser = null;
     this.isAuthenticated = false;
+    this.access = null;
 
     await this.persistenceClient.remove('sp00ky_auth_token');
 
     try {
       await this.remote.getClient().invalidate();
-    } catch (e) {
+    } catch (_e) {
       // Ignore invalidation errors
     }
 
@@ -184,12 +619,24 @@ export class AuthService<S extends SchemaStructure> {
 
   private async setSession(token: string, user: any) {
     this.token = token;
+    this.remote.setAuthToken(token);
     this.currentUser = user;
     this.isAuthenticated = true;
+    // Resolve the access-method name (e.g. "account") for in-browser SSP
+    // permission injection. Prefer the token's `AC` claim; fall back to the
+    // schema's sole record-access method if the claim is absent.
+    this.access = decodeAccessFromToken(token) ?? this.defaultAccessName();
     await this.persistenceClient.set('sp00ky_auth_token', token);
     this.notifyListeners();
   }
 
+  /** Fallback when the token carries no `AC` claim: if the schema defines
+   *  exactly one record-access method, assume the session used it. */
+  private defaultAccessName(): string | null {
+    const names = Object.keys(this.schema.access ?? {});
+    return names.length === 1 ? names[0] : null;
+  }
+
   async signUp<Name extends keyof S['access'] & string>(
     accessName: Name,
     params: ExtractAccessParams<S, Name, 'signup'>