mirror of
https://github.com/mauriceboe/TREK.git
synced 2026-11-21 11:36:05 +00:00
feat(native): an app lock with Face ID, Touch ID or the device passcode
A switch in the account settings, inside the app on a device that can unlock that way (iOS LocalAuthentication, Android BiometricPrompt with the screen lock as fallback). Turning it on asks once, so nobody locks themselves out. With it on, TREK asks at launch and after half a minute in the background before showing anything, and the app switcher shows a blurred cover (iOS) or no snapshot (Android) instead of the screen. The setting stays on the device, not the account.
This commit is contained in:
@@ -0,0 +1,63 @@
|
||||
import { App } from '@capacitor/app';
|
||||
import { beforeEach, describe, expect, it, vi } from 'vitest';
|
||||
import { act, fireEvent, render, screen, waitFor } from '../../../tests/helpers/render';
|
||||
import { isAppLockEnabled, unlockApp } from '../../native/appLock';
|
||||
import AppLockGate from './AppLockGate';
|
||||
|
||||
vi.mock('@capacitor/app', () => ({ App: { addListener: vi.fn(() => Promise.resolve({ remove: vi.fn() })) } }));
|
||||
vi.mock('../../native/appLock', () => ({
|
||||
RELOCK_AFTER_MS: 30_000,
|
||||
isAppLockEnabled: vi.fn(),
|
||||
unlockApp: vi.fn(),
|
||||
}));
|
||||
|
||||
function stateListener(): (state: { isActive: boolean }) => void {
|
||||
const call = vi.mocked(App.addListener).mock.calls.find(([name]) => name === 'appStateChange');
|
||||
if (!call) throw new Error('no appStateChange listener');
|
||||
return call[1] as unknown as (state: { isActive: boolean }) => void;
|
||||
}
|
||||
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
vi.mocked(isAppLockEnabled).mockReturnValue(true);
|
||||
vi.mocked(unlockApp).mockResolvedValue(false);
|
||||
});
|
||||
|
||||
describe('AppLockGate', () => {
|
||||
it('covers the app at launch and asks at once; a successful unlock lifts it', async () => {
|
||||
render(<AppLockGate />);
|
||||
expect(screen.getByRole('dialog')).toBeInTheDocument();
|
||||
await waitFor(() => expect(unlockApp).toHaveBeenCalledTimes(1));
|
||||
|
||||
vi.mocked(unlockApp).mockResolvedValue(true);
|
||||
fireEvent.click(screen.getByRole('button'));
|
||||
await waitFor(() => expect(screen.queryByRole('dialog')).not.toBeInTheDocument());
|
||||
});
|
||||
|
||||
it('locks again after half a minute in the background, not after a glance away', async () => {
|
||||
vi.mocked(unlockApp).mockResolvedValue(true);
|
||||
const now = vi.spyOn(Date, 'now');
|
||||
render(<AppLockGate />);
|
||||
await waitFor(() => expect(screen.queryByRole('dialog')).not.toBeInTheDocument());
|
||||
|
||||
vi.mocked(unlockApp).mockResolvedValue(false);
|
||||
now.mockReturnValue(1_000);
|
||||
act(() => stateListener()({ isActive: false }));
|
||||
now.mockReturnValue(10_000);
|
||||
act(() => stateListener()({ isActive: true }));
|
||||
expect(screen.queryByRole('dialog')).not.toBeInTheDocument();
|
||||
|
||||
act(() => stateListener()({ isActive: false }));
|
||||
now.mockReturnValue(60_000);
|
||||
act(() => stateListener()({ isActive: true }));
|
||||
expect(screen.getByRole('dialog')).toBeInTheDocument();
|
||||
now.mockRestore();
|
||||
});
|
||||
|
||||
it('is nothing while the lock is off', () => {
|
||||
vi.mocked(isAppLockEnabled).mockReturnValue(false);
|
||||
const { container } = render(<AppLockGate />);
|
||||
expect(container).toBeEmptyDOMElement();
|
||||
expect(unlockApp).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,80 @@
|
||||
/**
|
||||
* AppLockGate: covers TREK until Face ID, Touch ID or the passcode unlocks it,
|
||||
* when the app lock is on (native/appLock.ts). It locks at launch and again
|
||||
* after the app spent more than half a minute in the background, and asks at
|
||||
* once rather than waiting for a tap; the button is there for a second try.
|
||||
* Rendered once in App; outside the app, or with the lock off, it is nothing.
|
||||
*/
|
||||
import { App } from '@capacitor/app';
|
||||
import { Lock } from 'lucide-react';
|
||||
import React, { useCallback, useEffect, useRef, useState } from 'react';
|
||||
import { useTranslation } from '../../i18n';
|
||||
import { RELOCK_AFTER_MS, isAppLockEnabled, unlockApp } from '../../native/appLock';
|
||||
import { useNativeCapabilities } from '../../native/capabilities';
|
||||
|
||||
export default function AppLockGate(): React.ReactElement | null {
|
||||
const { t } = useTranslation();
|
||||
// Re-read once the binary has said what it can do.
|
||||
const { caps } = useNativeCapabilities();
|
||||
const [locked, setLocked] = useState(false);
|
||||
const asking = useRef(false);
|
||||
const backgroundSince = useRef<number | null>(null);
|
||||
|
||||
const ask = useCallback(async () => {
|
||||
if (asking.current) return;
|
||||
asking.current = true;
|
||||
const ok = await unlockApp(t('native.lock.reason'));
|
||||
asking.current = false;
|
||||
if (ok) setLocked(false);
|
||||
}, [t]);
|
||||
|
||||
// At launch, once the capabilities are known.
|
||||
useEffect(() => {
|
||||
if (!isAppLockEnabled()) return;
|
||||
setLocked(true);
|
||||
void ask();
|
||||
}, [caps, ask]);
|
||||
|
||||
// Back from the background after a while.
|
||||
useEffect(() => {
|
||||
if (!isAppLockEnabled()) return;
|
||||
const listener = App.addListener('appStateChange', ({ isActive }) => {
|
||||
if (!isActive) {
|
||||
backgroundSince.current = Date.now();
|
||||
return;
|
||||
}
|
||||
const since = backgroundSince.current;
|
||||
backgroundSince.current = null;
|
||||
if (since != null && Date.now() - since > RELOCK_AFTER_MS) {
|
||||
setLocked(true);
|
||||
void ask();
|
||||
}
|
||||
});
|
||||
return () => {
|
||||
void listener.then((handle) => handle.remove());
|
||||
};
|
||||
}, [caps, ask]);
|
||||
|
||||
if (!locked) return null;
|
||||
|
||||
return (
|
||||
<div
|
||||
role="dialog"
|
||||
aria-modal="true"
|
||||
aria-label={t('native.lock.title')}
|
||||
className="fixed inset-0 z-[100001] flex flex-col items-center justify-center gap-5 bg-surface p-8 text-center backdrop-blur-2xl"
|
||||
>
|
||||
<span className="flex h-16 w-16 items-center justify-center rounded-full bg-surface-card text-content shadow-lg">
|
||||
<Lock size={26} strokeWidth={2} aria-hidden="true" />
|
||||
</span>
|
||||
<p className="text-title font-semibold text-content">{t('native.lock.title')}</p>
|
||||
<button
|
||||
type="button"
|
||||
onClick={() => void ask()}
|
||||
className="rounded-full bg-accent px-6 py-3 text-body font-semibold text-accent-text transition-transform active:scale-[.98]"
|
||||
>
|
||||
{t('native.lock.unlock')}
|
||||
</button>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
Reference in New Issue
Block a user