fix(native): the app's browser sign-in no longer lands on the dashboard when the browser still holds an older TREK

A browser that ran TREK before 5.1.1 keeps that version's app in its service
worker. When the app opened /native-handoff, the worker answered it from its
cache with an app that has no such page, which sent the user to /, and the
sign-in ended on the dashboard in the browser instead of in the app.

The app now opens /api/auth/native/start, which every TREK service worker
passes to the server. That page takes the workers off the browser and
forwards to the handoff page. Until the sign-in is handed back, the web app
registers no service worker and does not reload for a new version: a tab
still open on the older TREK keeps its worker alive, and a registration or a
reload in the middle of the sign-in brought it back to answer the next page.
This commit is contained in:
Maurice
2026-11-09 22:21:09 +01:00
parent 5420077b98
commit 034cfb539a
14 changed files with 286 additions and 7 deletions
@@ -145,6 +145,9 @@ export const PUBLIC_ROUTE_ALLOW_LIST: string[] = [
// The native app redeems a one-time code from the system browser here. The
// code is only good together with the verifier the app kept to itself.
'NativeAuthController.exchange',
// Where the app's sign-in in the system browser starts: a page that forwards
// to the handoff page and carries no credential.
'NativeAuthController.start',
'OauthPublicController.revoke',
'OauthPublicController.token',
'OauthPublicController.userinfo',
@@ -10,7 +10,7 @@ import { ResponseContract } from '../common/response-contract';
import { sessionClientFrom } from '../sessions/sessions.service';
import { NativeExchangeDto, NativeHandoffDto } from './native-auth.dto';
import { NativeAuthService } from './native-auth.service';
import { Body, Controller, HttpCode, HttpException, Post, Req, Res, UseGuards } from '@nestjs/common';
import { Body, Controller, Get, HttpCode, HttpException, Post, Query, Req, Res, UseGuards } from '@nestjs/common';
import {
nativeHandoffResponseSchema,
successResponseSchema,
@@ -23,6 +23,36 @@ import type { Request, Response } from 'express';
const EXCHANGE_WINDOW_MS = 15 * 60 * 1000;
const EXCHANGE_MAX = 20;
const CHALLENGE = /^[0-9a-f]{64}$/;
const START = new Set(['oidc', 'passkey']);
const INVITE = /^[A-Za-z0-9_-]{1,200}$/;
/** `&`, `<`, `>` and `"` as entities, for a value inside a double-quoted attribute. */
function attr(value: string): string {
return value.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;');
}
/**
* The page /api/auth/native/start answers with: it takes a service worker of an
* older TREK off the browser, then opens the handoff page (public/native-handoff.js).
* A browser that ran TREK before 5.1.1 keeps that version's app in its service
* worker, and the worker answers /native-handoff from its cache with an app that
* has no such page: the sign-in ended on the dashboard in the browser instead of
* in the app. Every TREK service worker lets /api through to the server, so this
* page always comes from the running version.
*/
export function nativeStartPage(target: string): string {
const href = attr(target);
return [
'<!doctype html>',
'<html><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1">',
'<meta name="robots" content="noindex"><title>TREK</title>',
`<noscript><meta http-equiv="refresh" content="0;url=${href}"></noscript>`,
`<script src="/native-handoff.js" data-target="${href}"></script>`,
'</head><body></body></html>',
].join('');
}
/**
* /api/auth/native: the sign-in hand-off between the system browser and the
* native app. See the contract in @trek/shared for the whole round trip.
@@ -47,6 +77,34 @@ export class NativeAuthController {
return { code: await this.nativeAuth.issueCode(user.id, body.challenge) };
}
/**
* Where the app's sign-in in the system browser starts. Answers a small page
* instead of the handoff page itself (see nativeStartPage); the query is the
* one the handoff page takes, checked here so nothing else rides along.
*/
// response-contract-exempt: an HTML page that forwards the browser, no body to check
@Get('start')
@Public('opens the handoff page in the browser; it carries no credential and shows nothing')
start(
@Query('challenge') challenge: unknown,
@Query('start') start: unknown,
@Query('invite') invite: unknown,
@Res() res: Response,
): void {
if (typeof challenge !== 'string' || !CHALLENGE.test(challenge)) {
res.status(400).type('text/plain').send('Invalid sign-in link.');
return;
}
const params = new URLSearchParams({ challenge });
if (typeof start === 'string' && START.has(start)) params.set('start', start);
if (typeof invite === 'string' && INVITE.test(invite)) params.set('invite', invite);
res
.status(200)
.set('Cache-Control', 'no-store')
.type('text/html')
.send(nativeStartPage(`/native-handoff?${params.toString()}`));
}
@Post('exchange')
@Public('the one-time code together with its verifier is the credential')
@HttpCode(200)