mirror of
https://github.com/HeyPuter/puter.git
synced 2026-11-13 20:12:57 -10:00
Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 jelveh
|
74ef0ac959 |
No files matched your search
@@ -147,9 +147,9 @@ page's origin, which the server reads from the referrer and pins with
|
||||
`frame-ancestors`; opened top-level, it does nothing. Its page is transparent
|
||||
so the dialog's own scrim covers the host.
|
||||
|
||||
puter.js uses it on a page one label under the GUI origin, other than the
|
||||
subdomains the server refuses, when the page is signed in, framing it in a
|
||||
modal `<dialog>` that stays hidden until the embed is ready. A session check that takes longer than 200ms shows a loading scrim
|
||||
puter.js uses it on a page one label under the GUI origin when the page is
|
||||
signed in, framing it in a modal `<dialog>` that stays hidden until the embed
|
||||
is ready. A session check that takes longer than 200ms shows a loading scrim
|
||||
with a spinner in its place; Escape or a click on it cancels. The embed posts `{ msg: 'feedbackEmbed', state }` to its parent
|
||||
(`loading`, then `ready` or `unavailable`) and finally
|
||||
`{ msg: 'feedbackDialogClosed', sent }`. It reports `unavailable` without the
|
||||
@@ -160,105 +160,6 @@ is the entry, sharing `embedSession` in `src/gui/src/helpers/embedSession.js`
|
||||
with the app browser; `showFeedbackEmbed` in `src/puter-js/src/lib/guiEmbed.js`
|
||||
is the host side.
|
||||
|
||||
## Sign-in and file pickers
|
||||
|
||||
`GET /embed/sign-in`, `/embed/show-open-file-picker`, `/embed/show-save-file-picker`
|
||||
and `/embed/show-directory-picker` serve the same GUI popups as `/action/<action>`
|
||||
for a first-party page, with the same framing rules, query redirect, and
|
||||
`no-store` as `/embed/apps`. Any other spelling of the path (another case, a
|
||||
trailing slash) redirects to it, since the shell boots the desktop for it. They render the normal GUI shell, which names the
|
||||
framing page (read from the referrer, pinned with `frame-ancestors`) as
|
||||
`gui_params.embed_host_origin`. The GUI then runs the popup boot unchanged, with
|
||||
the framing page as `window.opener`, and `window.close()` asks the page to
|
||||
remove the frame (`src/gui/src/helpers/popupFrame.js`). Without a framing page
|
||||
to answer (opened top-level, or framed by a refused page) it does nothing. The
|
||||
popup's parameters come from the fragment instead of the query: `msg_id`,
|
||||
`options` and `request_auth`, plus `user` for a picker.
|
||||
|
||||
The frame posts `{ msg: 'puterPopupFrame', state }` to its parent: `loading` as
|
||||
soon as the shell boots, `ready` once it shows a window or dialog, `unavailable`
|
||||
when the page has to use the popup, `provider` when the user picks a sign-in
|
||||
provider (below), and `closed` where a popup would close. Its
|
||||
answers (`puter.token`, `fileOpenPicked`, `directoryPicked`, `fileSaved`, the
|
||||
cancel messages, `sendMeFileData`) are the popup's.
|
||||
|
||||
puter.js uses them on a page one label under the GUI origin, other than the
|
||||
subdomains the server refuses, unless the page is cross-origin isolated or in a
|
||||
frame of another site (which `frame-ancestors` refuses too).
|
||||
`showPopupFrame` in `src/puter-js/src/lib/guiEmbed.js` shows the frame in a box
|
||||
the size of the popup window, over a scrim, hidden until `ready` and behind the
|
||||
loading spinner after 200ms. Escape closes it, on the page or in the frame. One shows per popup, as each
|
||||
popup has its own window name: a second picker request of the same kind
|
||||
replaces the one showing, and a `signIn()` call made while a framed sign-in is
|
||||
open settles with it. On
|
||||
screens up to 600px wide the box fills the screen. A frame that is refused,
|
||||
never answers, or reports `unavailable` falls back to the popup, opened through
|
||||
a consent dialog when the click that asked for it has expired. A reload or navigation the frame
|
||||
starts itself (logging out, a sign-out in another tab) names the frame as its
|
||||
referrer, so the server refuses it; the page then shows its spinner and opens
|
||||
the frame again, once per `ready`.
|
||||
|
||||
- **Sign-in** (`puter.auth.signIn()`) has no host-user binding: it is how the
|
||||
page gets a user. The box has a close button, which rejects with
|
||||
`auth_window_closed` as closing the popup does. Providers refuse to be
|
||||
framed, so choosing one posts `{ state: 'provider', url }` with the
|
||||
provider's start URL for this sign-in's `msg_id`, then `unavailable`. The
|
||||
page opens the popup straight at that URL, once it checks the URL is the
|
||||
GUI's `/auth/oidc/<provider>/start` for this `msg_id`, and the provider
|
||||
returns it as this sign-in's popup. `attempt_temp_user_creation` keeps the popup, since
|
||||
only the popup creates a temporary account.
|
||||
- **Pickers** frame only for a signed-in page. The GUI reports `unavailable`
|
||||
unless its session belongs to the user named in `user`, and the page then uses
|
||||
the popup, which can sign in and switch accounts. The token the GUI sends
|
||||
before a picker's answer isn't adopted, since it is for the page's own user.
|
||||
Dismissing the loading scrim settles the picker as cancelled.
|
||||
|
||||
## Upgrade
|
||||
|
||||
`GET /embed/upgrade` is the deployment's upgrade dialog for a first-party page,
|
||||
served like the popups above: the GUI shell with the same framing rules, query
|
||||
redirect, exact-path redirect and `no-store`, naming the framing page as
|
||||
`gui_params.embed_host_origin`. It runs only when framed by an allowed page.
|
||||
|
||||
puter.js frames it on a signed-in first-party page (the same pages as the
|
||||
pickers) for `puter.ui.requestUpgrade(details)`, and for the Upgrade button of
|
||||
the usage limit dialog a refused call shows there. Elsewhere both keep their
|
||||
behavior: inside an app `requestUpgrade()` asks the desktop, and on any other
|
||||
page the usage limit dialog opens the dashboard's upgrade page in a new tab.
|
||||
|
||||
The frame covers the page with no box or close button, and the GUI page is
|
||||
transparent (`html.popup-frame-transparent`) so the dialog's own scrim covers
|
||||
the host. The frame allows `payment` as well as `otp-credentials`. Escape on the
|
||||
page is left to the dialog, since one there shouldn't drop a payment in
|
||||
progress. Its fragment names `user` (the page's signed-in user) and, when the
|
||||
refusal gave them, `reason` (`funds`, `subscription` or `storage`) and `method`.
|
||||
|
||||
The GUI reports `unavailable` unless its session belongs to `user`, the account
|
||||
has no verification or password change waiting (which the frame couldn't be
|
||||
closed from), and the deployment defines `window.UIUpgradeAccount` with
|
||||
`UIUpgradeAccount.embeddable === true`. Otherwise it runs:
|
||||
|
||||
```js
|
||||
new UIUpgradeAccount({ attribution: { appUid, reason, method }, onClose }).open_as_window();
|
||||
```
|
||||
|
||||
`appUid` is the app the framing page's origin resolves to, never one the
|
||||
fragment names. `open_as_window()` resolves once the dialog shows, and the GUI
|
||||
then posts `ready`. While the page still hides the frame, which Chromium and
|
||||
WebKit lay out at 0x0, the GUI posts `ready` first and opens the dialog once
|
||||
the frame has a viewport, so a window it opens doesn't center on 0x0.
|
||||
`onClose({ upgraded })` must run exactly once, when the
|
||||
dialog closes or when it declines to open for the account; the GUI then posts
|
||||
`{ msg: 'puterPopupFrame', state: 'closed', upgraded }` and the page removes
|
||||
the frame. If `open_as_window()` rejects, the GUI posts `unavailable` instead. `requestUpgrade()` resolves `{ upgraded }`. A call made while the
|
||||
frame shows settles with it rather than replacing it, and a call refused while
|
||||
it shows still rejects but opens no usage limit dialog over it.
|
||||
|
||||
When the frame can't show the upgrade (refused, never ready, `unavailable`, or
|
||||
no user to name), puter.js opens the dashboard's upgrade page in a new tab with
|
||||
what was refused, through a consent dialog when the click has expired or the
|
||||
tab is blocked, and `requestUpgrade()` resolves `{ upgraded: false }`.
|
||||
|
||||
## Checks
|
||||
|
||||
Run the GUI component/browser tests (with the SDK bundle built and Playwright
|
||||
@@ -266,7 +167,6 @@ Chromium installed), and the backend route tests:
|
||||
|
||||
```sh
|
||||
npx vitest run --config src/gui/vitest.config.js src/gui/src/UI/Dashboard/AppBrowser src/feedbackEmbed
|
||||
npx vitest run src/puter-js/src/lib/guiEmbed.test.js src/puter-js/src/modules/UI.showFeedbackDialog.test.js src/puter-js/src/modules/Auth.signInFrame.test.js src/puter-js/src/modules/UI.pickerFrame.test.js src/puter-js/src/modules/UI.requestUpgrade.test.js src/puter-js/src/lib/upgradePrompt.test.js src/puter-js/src/modules/UsageLimitDialog.upgrade.test.js
|
||||
npx vitest run --config src/gui/vitest.config.js src/gui/src/helpers/popupFrame.test.js
|
||||
npx vitest run src/puter-js/src/lib/guiEmbed.test.js src/puter-js/src/modules/UI.showFeedbackDialog.test.js
|
||||
npx vitest run --config src/backend/vitest.config.ts src/backend/server.test.ts
|
||||
```
|
||||
@@ -31,22 +31,8 @@ import type {
|
||||
PuterHomepageService,
|
||||
PageMeta,
|
||||
LaunchOptions,
|
||||
PopupFrame,
|
||||
} from '../../services/homepage/PuterHomepageService';
|
||||
|
||||
/**
|
||||
* GUI popups a first-party page can show in a frame at `/embed/<action>`,
|
||||
* instead of opening `/action/<action>` in a window, and the upgrade dialog,
|
||||
* which it would otherwise open in a dashboard tab.
|
||||
*/
|
||||
export const FRAMED_POPUP_ACTIONS = [
|
||||
'sign-in',
|
||||
'show-open-file-picker',
|
||||
'show-save-file-picker',
|
||||
'show-directory-picker',
|
||||
'upgrade',
|
||||
] as const;
|
||||
|
||||
/** Longest description/og:description/twitter:description on `/app/<name>`. */
|
||||
export const APP_META_DESCRIPTION_MAX = 150;
|
||||
|
||||
@@ -167,7 +153,6 @@ export class HomepageController extends PuterController {
|
||||
res: express.Response,
|
||||
metaOverrides: Partial<PageMeta> = {},
|
||||
launch: LaunchOptions = {},
|
||||
popupFrame?: PopupFrame,
|
||||
) => {
|
||||
const meta = { ...defaultMeta(req), ...metaOverrides };
|
||||
const actor =
|
||||
@@ -176,7 +161,7 @@ export class HomepageController extends PuterController {
|
||||
actor?: Parameters<typeof homepage.send>[0]['actor'];
|
||||
}
|
||||
).actor ?? null;
|
||||
await homepage.send({ req, res, actor }, meta, launch, popupFrame);
|
||||
await homepage.send({ req, res, actor }, meta, launch);
|
||||
};
|
||||
|
||||
// -- Root + path-aliased shell routes ------------------------
|
||||
@@ -231,34 +216,6 @@ export class HomepageController extends PuterController {
|
||||
);
|
||||
});
|
||||
|
||||
// The GUI runs the popup's own boot, answering the framing page
|
||||
// instead of an opener.
|
||||
for (const action of FRAMED_POPUP_ACTIONS) {
|
||||
const embedPath = `/embed/${action}`;
|
||||
router.get(embedPath, {}, async (req, res) => {
|
||||
// Routes match case-insensitively and with a trailing slash,
|
||||
// and the shell boots the desktop for any other spelling, so
|
||||
// only the exact one may be framed.
|
||||
if (req.originalUrl !== embedPath) {
|
||||
res.redirect(embedPath);
|
||||
return;
|
||||
}
|
||||
if (!prepareEmbed(req, res, embedPath)) return;
|
||||
await sendShell(
|
||||
req,
|
||||
res,
|
||||
{},
|
||||
{},
|
||||
{
|
||||
hostOrigin: embedHostOrigin(
|
||||
this.config,
|
||||
req.get('referer'),
|
||||
),
|
||||
},
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
router.get('/settings', {}, (req, res) => sendShell(req, res));
|
||||
router.get('/settings/*splat', {}, (req, res) => sendShell(req, res));
|
||||
|
||||
|
||||
@@ -408,68 +408,6 @@ describe('PuterServer host header validation', () => {
|
||||
expect(redirected.headers.location).toBe('/embed/feedback');
|
||||
});
|
||||
|
||||
it.each([
|
||||
'sign-in',
|
||||
'show-open-file-picker',
|
||||
'show-save-file-picker',
|
||||
'show-directory-picker',
|
||||
'upgrade',
|
||||
])('lets a deployment subdomain frame the %s popup and names it to the GUI', async (action) => {
|
||||
const parent = `http://spreadsheet.puter.localhost:${port}`;
|
||||
const guiParams = (body: string) =>
|
||||
JSON.parse(body.match(/gui\((\{.*\})\);/)[1]);
|
||||
const res = await request(`/embed/${action}`, {
|
||||
host: `puter.localhost:${port}`,
|
||||
referer: `${parent}/sheet/1`,
|
||||
});
|
||||
expect(res.status).toBe(200);
|
||||
expect(res.headers['x-frame-options']).toBeUndefined();
|
||||
expect(res.headers['content-security-policy']).toBe(
|
||||
`frame-ancestors 'self' ${parent}`,
|
||||
);
|
||||
expect(res.headers['cache-control']).toBe('no-store');
|
||||
expect(guiParams(res.body).embed_host_origin).toBe(parent);
|
||||
|
||||
const hosted = await request(`/embed/${action}`, {
|
||||
host: `puter.localhost:${port}`,
|
||||
referer: `http://someone.site.puter.localhost:${port}/`,
|
||||
});
|
||||
expect(hosted.headers['content-security-policy']).toBe("frame-ancestors 'self'");
|
||||
expect(guiParams(hosted.body).embed_host_origin).toBeNull();
|
||||
|
||||
const redirected = await request(`/embed/${action}?auth_token=x&embedded_in_popup=true`, {
|
||||
host: `puter.localhost:${port}`,
|
||||
referer: `${parent}/sheet/1`,
|
||||
});
|
||||
expect(redirected.status).toBe(302);
|
||||
expect(redirected.headers.location).toBe(`/embed/${action}`);
|
||||
expect(redirected.headers['x-frame-options']).toBe('SAMEORIGIN');
|
||||
});
|
||||
|
||||
it.each(['/embed/SIGN-IN', '/embed/Show-Open-File-Picker', '/embed/sign-in/', '/embed/Upgrade', '/embed/upgrade/'])(
|
||||
'lets a first-party page frame only the exact spelling of %s',
|
||||
async (spelling) => {
|
||||
const res = await request(spelling, {
|
||||
host: `puter.localhost:${port}`,
|
||||
referer: `http://spreadsheet.puter.localhost:${port}/`,
|
||||
});
|
||||
expect(res.status).toBe(302);
|
||||
expect(res.headers.location).toBe(spelling.toLowerCase().replace(/\/$/, ''));
|
||||
expect(res.headers['x-frame-options']).toBe('SAMEORIGIN');
|
||||
expect(res.headers['content-security-policy']).toBeUndefined();
|
||||
},
|
||||
);
|
||||
|
||||
it('names no framing page to the popups it serves in a window', async () => {
|
||||
const res = await request('/action/sign-in?embedded_in_popup=true', {
|
||||
host: `puter.localhost:${port}`,
|
||||
referer: `http://spreadsheet.puter.localhost:${port}/`,
|
||||
});
|
||||
expect(res.headers['x-frame-options']).toBe('SAMEORIGIN');
|
||||
expect(res.headers['content-security-policy']).toBeUndefined();
|
||||
expect(res.body).not.toContain('embed_host_origin');
|
||||
});
|
||||
|
||||
it.each([
|
||||
['a user-hosted site', 'http://someone.site.puter.localhost:PORT/'],
|
||||
['a private app host', 'http://someone.app.puter.localhost:PORT/'],
|
||||
|
||||
@@ -48,15 +48,6 @@ export interface LaunchOptions {
|
||||
on_initialized?: Array<Record<string, unknown>>;
|
||||
}
|
||||
|
||||
/**
|
||||
* A GUI popup a first-party page frames at `/embed/<action>`. `hostOrigin` is
|
||||
* that page, read from the referrer and pinned with frame-ancestors; null when
|
||||
* no allowed page frames it.
|
||||
*/
|
||||
export interface PopupFrame {
|
||||
hostOrigin: string | null;
|
||||
}
|
||||
|
||||
interface PuterGuiAddonsEvent {
|
||||
req: Request;
|
||||
path: string;
|
||||
@@ -312,7 +303,6 @@ export class PuterHomepageService extends PuterService {
|
||||
ctx: { req: Request; res: Response; actor?: Actor | null },
|
||||
meta: PageMeta,
|
||||
launchOptions: LaunchOptions = {},
|
||||
popupFrame?: PopupFrame,
|
||||
): Promise<void> {
|
||||
const { req, res, actor } = ctx;
|
||||
|
||||
@@ -337,7 +327,6 @@ export class PuterHomepageService extends PuterService {
|
||||
{ req, actor: actor ?? null },
|
||||
meta,
|
||||
launchOptions,
|
||||
popupFrame,
|
||||
);
|
||||
res.send(html);
|
||||
}
|
||||
@@ -348,7 +337,6 @@ export class PuterHomepageService extends PuterService {
|
||||
ctx: { req: Request; actor: Actor | null },
|
||||
meta: PageMeta,
|
||||
launchOptions: LaunchOptions,
|
||||
popupFrame?: PopupFrame,
|
||||
): Promise<string> {
|
||||
const { req, actor } = ctx;
|
||||
const env = this.config.env ?? 'prod';
|
||||
@@ -394,8 +382,6 @@ export class PuterHomepageService extends PuterService {
|
||||
eventsNotifications: notificationsFoldInEnabled(this.config),
|
||||
...meta,
|
||||
launch_options: launchOptions,
|
||||
// After `meta`, so nothing page-specific can name the opener.
|
||||
...(popupFrame ? { embed_host_origin: popupFrame.hostOrigin } : {}),
|
||||
};
|
||||
|
||||
const event: PuterGuiAddonsEvent = {
|
||||
|
||||
@@ -6,7 +6,7 @@ platforms: [websites]
|
||||
|
||||
Initiates the sign in process for the user.
|
||||
|
||||
This will open a popup window with the appropriate authentication method. Puter automatically handles the authentication process and will resolve the promise when the user has signed in. Puter's own apps on puter.com subdomains show the sign-in in a frame over the page instead, and open the popup when the user picks a sign-in provider such as Google.
|
||||
This will open a popup window with the appropriate authentication method. Puter automatically handles the authentication process and will resolve the promise when the user has signed in.
|
||||
|
||||
It is important to note that all essential methods in Puter handle authentication automatically. This method is only necessary if you want to handle authentication manually, for example if you want to build your own custom authentication flow.
|
||||
|
||||
|
||||
@@ -225,29 +225,6 @@ describe('OIDC buttons on the login and signup screens', () => {
|
||||
window.location = original;
|
||||
expect(assign.mock.calls[0][0]).toBe('https://puter.test/auth/oidc/google/start?flow=login&referrer=ref');
|
||||
});
|
||||
|
||||
it('hands a framed sign-in to the popup instead of leaving for the provider', async () => {
|
||||
asPopup('msg_id=1');
|
||||
window.embedded_in_frame = true;
|
||||
window.tell_popup_frame = vi.fn();
|
||||
try {
|
||||
void UIAuthLogin();
|
||||
await vi.waitFor(() => expect($('.oidc-google-btn')).toHaveLength(1));
|
||||
const href = window.location.href;
|
||||
$('.oidc-google-btn').trigger('click');
|
||||
expect(window.tell_popup_frame.mock.calls).toEqual([
|
||||
['provider', { url: expect.stringContaining('https://puter.test/auth/oidc/google/start?flow=login') }],
|
||||
['unavailable'],
|
||||
]);
|
||||
const start = new URL(window.tell_popup_frame.mock.calls[0][1].url);
|
||||
expect(start.searchParams.get('embedded_in_popup')).toBe('true');
|
||||
expect(start.searchParams.get('msg_id')).toBe('1');
|
||||
expect(window.location.href).toBe(href);
|
||||
} finally {
|
||||
delete window.embedded_in_frame;
|
||||
delete window.tell_popup_frame;
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
describe('second factor', () => {
|
||||
|
||||
@@ -191,15 +191,9 @@ export default function openAuthFlow ({ page = false, dismissable = ! page, clos
|
||||
/** @type {Array<AuthScreen & { $el: jQuery, el_return?: Element | null }>} */
|
||||
const stack = [];
|
||||
|
||||
// A frame's focus() calls do nothing until the framing page focuses it,
|
||||
// so the screen takes focus then, unless something already has it.
|
||||
const onFrameFocus = () => {
|
||||
if ( ! document.activeElement || document.activeElement === document.body ) flow.focus();
|
||||
};
|
||||
const teardown = () => {
|
||||
if ( torn_down ) return;
|
||||
torn_down = true;
|
||||
window.removeEventListener('focus', onFrameFocus);
|
||||
if ( active_flow === flow ) active_flow = null;
|
||||
// Screens waiting on the user (the second factor) hear they won't get an answer.
|
||||
while ( stack.length ) stack.pop().onLeave?.();
|
||||
@@ -358,14 +352,8 @@ export default function openAuthFlow ({ page = false, dismissable = ! page, clos
|
||||
$overlay.on('keydown keyup keypress', function (e) {
|
||||
e.stopPropagation();
|
||||
if ( e.type !== 'keydown' || e.key !== 'Escape' ) return;
|
||||
// An Escape that cancels an IME conversion is the IME's; jQuery's
|
||||
// event doesn't carry isComposing, the browser's does.
|
||||
if ( e.originalEvent?.isComposing || e.keyCode === 229 ) return;
|
||||
e.preventDefault();
|
||||
if ( busy ) return;
|
||||
if ( dismissable ) $dialog.find('.dashboard-dialog-close').trigger('click');
|
||||
// A framed sign-in's ✕ is the framing page's, which close() asks.
|
||||
else if ( window.embedded_in_frame ) window.close();
|
||||
if ( dismissable && ! busy ) $dialog.find('.dashboard-dialog-close').trigger('click');
|
||||
});
|
||||
// A press on the backdrop (or a page's background) would move focus to
|
||||
// the page, and with it the keys; it stays where it was.
|
||||
@@ -373,8 +361,6 @@ export default function openAuthFlow ({ page = false, dismissable = ! page, clos
|
||||
if ( e.target === this ) e.preventDefault();
|
||||
});
|
||||
|
||||
if ( window.embedded_in_frame ) window.addEventListener('focus', onFrameFocus);
|
||||
|
||||
active_flow = flow;
|
||||
return flow;
|
||||
}
|
||||
|
||||
@@ -75,56 +75,6 @@ describe('openAuthFlow', () => {
|
||||
expect(flow.isClosed()).toBe(false);
|
||||
});
|
||||
|
||||
it('lets Escape ask the framing page to close a framed sign-in, unless busy', async () => {
|
||||
window.embedded_in_frame = true;
|
||||
const close = vi.spyOn(window, 'close').mockImplementation(() => {});
|
||||
try {
|
||||
const flow = openAuthFlow({ page: true });
|
||||
flow.push({ name: 'a', html: '<input>' });
|
||||
await tick();
|
||||
flow.setBusy(true);
|
||||
key($('.auth-dialog input').get(0), 'Escape');
|
||||
expect(close).not.toHaveBeenCalled();
|
||||
flow.setBusy(false);
|
||||
// Escape that cancels an IME conversion is the IME's.
|
||||
$('.auth-dialog input').get(0).dispatchEvent(new KeyboardEvent('keydown', { key: 'Escape', isComposing: true, bubbles: true }));
|
||||
expect(close).not.toHaveBeenCalled();
|
||||
key($('.auth-dialog input').get(0), 'Escape');
|
||||
expect(close).toHaveBeenCalledTimes(1);
|
||||
flow.finish(false);
|
||||
} finally {
|
||||
close.mockRestore();
|
||||
delete window.embedded_in_frame;
|
||||
}
|
||||
});
|
||||
|
||||
it('focuses a framed screen once the framing page focuses the frame', async () => {
|
||||
window.embedded_in_frame = true;
|
||||
try {
|
||||
const flow = openAuthFlow({ page: true });
|
||||
flow.push({ name: 'a', html: '<input>' });
|
||||
// What a frame's focus() amounts to before the page focuses it.
|
||||
document.activeElement.blur();
|
||||
window.dispatchEvent(new FocusEvent('focus'));
|
||||
// jsdom lays nothing out, so the screen's fallback, the card, takes it.
|
||||
expect($('.auth-dialog').get(0).contains(document.activeElement)).toBe(true);
|
||||
|
||||
// Focus the user moved elsewhere stays there.
|
||||
const el_outside = $('<button class="outside">').appendTo('body').get(0);
|
||||
el_outside.focus();
|
||||
window.dispatchEvent(new FocusEvent('focus'));
|
||||
expect(document.activeElement).toBe(el_outside);
|
||||
el_outside.remove();
|
||||
|
||||
flow.finish(false);
|
||||
document.activeElement.blur();
|
||||
window.dispatchEvent(new FocusEvent('focus'));
|
||||
expect(document.activeElement).toBe(document.body);
|
||||
} finally {
|
||||
delete window.embedded_in_frame;
|
||||
}
|
||||
});
|
||||
|
||||
it('ignores the backdrop unless asked, so a stray click keeps typed credentials', async () => {
|
||||
const kept = openAuthFlow();
|
||||
kept.push({ name: 'a', html: '' });
|
||||
|
||||
@@ -134,15 +134,7 @@ export async function renderProviderButtons ($list, { kind, referrer, flow }) {
|
||||
}
|
||||
$list.html(h);
|
||||
$list.on('click', '.auth-provider-btn', function () {
|
||||
const url = providerStartUrl($(this).attr('data-provider'), kind, referrer());
|
||||
// A provider won't load in a frame, so the framing page opens this
|
||||
// in a popup instead. `unavailable` covers an SDK that can't.
|
||||
if ( window.embedded_in_frame ) {
|
||||
window.tell_popup_frame('provider', { url });
|
||||
window.tell_popup_frame('unavailable');
|
||||
return;
|
||||
}
|
||||
window.location.href = url;
|
||||
window.location.href = providerStartUrl($(this).attr('data-provider'), kind, referrer());
|
||||
});
|
||||
return { providers: ordered, signupOidcOnly: data.signupOidcOnly === true };
|
||||
}
|
||||
@@ -383,7 +383,7 @@ export function createAppBrowser ({ editable = true, onLaunch, actions = {}, gue
|
||||
function trapModalTab ($overlay) {
|
||||
$overlay.on('keydown', function (e) {
|
||||
if ( e.key !== 'Tab' ) return;
|
||||
const focusables = $overlay.find('button, textarea, input:not([type="hidden"]), select, a[href]').toArray()
|
||||
const focusables = $overlay.find('button, textarea').toArray()
|
||||
.filter(el => ! el.disabled && el.offsetParent !== null);
|
||||
if ( focusables.length === 0 ) return;
|
||||
const first = focusables[0];
|
||||
@@ -456,12 +456,6 @@ export function createAppBrowser ({ editable = true, onLaunch, actions = {}, gue
|
||||
// restores its position if it comes back.
|
||||
const deleteData = $overlay.find('.myapps-modal-delete-data').is(':checked');
|
||||
const removedIndex = self._apps.findIndex(a => a.name === appName);
|
||||
// Uninstalled from inside an open folder: where focus goes after.
|
||||
const fromGroupId = $el_window.find('.myapps-group-panel-grid .myapps-tile').toArray()
|
||||
.some(el => el.dataset.appName === appName) ? self._openGroupId : null;
|
||||
const groupMates = fromGroupId
|
||||
? (findGroupById(self._groups, fromGroupId)?.apps ?? []).filter(name => name !== appName)
|
||||
: [];
|
||||
const removedApp = removedIndex === -1 ? null : self._apps[removedIndex];
|
||||
// A running instance would be stranded: the tile is a headless
|
||||
// app's only switcher, so once it's gone a minimized window could
|
||||
@@ -469,9 +463,6 @@ export function createAppBrowser ({ editable = true, onLaunch, actions = {}, gue
|
||||
// also consumes the app's URL entry if it owns one).
|
||||
$(`.window[data-app="${html_encode(appName)}"]`).close();
|
||||
self._invalidateInFlightLoads();
|
||||
// Until the revoke lands the server still lists the app as
|
||||
// installed, so loads started meanwhile leave it out themselves.
|
||||
self._pendingUninstalls.add(appName);
|
||||
self._setAppRemoved(appName, true);
|
||||
close({ restoreFocus: false });
|
||||
|
||||
@@ -503,19 +494,9 @@ export function createAppBrowser ({ editable = true, onLaunch, actions = {}, gue
|
||||
self.renderApps($el_window, { preservePage: true, instant: true });
|
||||
// The confirm button left with the modal; keep a keyboard user on
|
||||
// the grid, at the slot the app vacated.
|
||||
if ( ! document.activeElement || document.activeElement === document.body ) {
|
||||
if ( slot !== -1 ) {
|
||||
const tiles = $el_window.find('.myapps-page .myapps-tile').toArray();
|
||||
tiles[Math.min(slot, tiles.length - 1)]?.focus({ preventScroll: true });
|
||||
} else if ( fromGroupId ) {
|
||||
// The folder may still be open, closed, or dissolved
|
||||
// into the one app left in it.
|
||||
const target = $el_window.find('.myapps-group-panel-grid .myapps-tile')[0]
|
||||
?? $el_window.find(`.myapps-group-tile[data-group-id="${CSS.escape(fromGroupId)}"]`)[0]
|
||||
?? $el_window.find('.myapps-page .myapps-tile').toArray()
|
||||
.find(el => groupMates.includes(el.dataset.appName));
|
||||
target?.focus({ preventScroll: true });
|
||||
}
|
||||
if ( slot !== -1 && (! document.activeElement || document.activeElement === document.body) ) {
|
||||
const tiles = $el_window.find('.myapps-page .myapps-tile').toArray();
|
||||
tiles[Math.min(slot, tiles.length - 1)]?.focus({ preventScroll: true });
|
||||
}
|
||||
// FLIP the survivors from their old boxes into the new layout.
|
||||
const moved = [];
|
||||
@@ -565,9 +546,6 @@ export function createAppBrowser ({ editable = true, onLaunch, actions = {}, gue
|
||||
puter.perms.revokeApp(appUid, '*', { deleteData }).then(async (result) => {
|
||||
// revokeApp resolves (never rejects) with `error` set on failure.
|
||||
if ( result?.error ) throw result;
|
||||
// Loads started before now may have read the app as installed.
|
||||
self._invalidateInFlightLoads();
|
||||
self._pendingUninstalls.delete(appName);
|
||||
// Clearing the grants is only half of it. An app the user already
|
||||
// opened holds a token that authenticates against a session row,
|
||||
// and that row outlives the permission rows — so without this an
|
||||
@@ -589,7 +567,6 @@ export function createAppBrowser ({ editable = true, onLaunch, actions = {}, gue
|
||||
}
|
||||
}).catch(async err => {
|
||||
console.error('Failed to uninstall app:', err);
|
||||
self._pendingUninstalls.delete(appName);
|
||||
await removalSettled;
|
||||
self._invalidateInFlightLoads();
|
||||
// The uninstall didn't happen — take the name back off the
|
||||
@@ -716,8 +693,6 @@ export function createAppBrowser ({ editable = true, onLaunch, actions = {}, gue
|
||||
$overlay.on('click', '.myapps-add-back', () => showPane('options'));
|
||||
$(document).on('keydown.add-app-modal', function (e) {
|
||||
if ( e.key !== 'Escape' ) return;
|
||||
// Escape while composing (CJK input) cancels the composition only.
|
||||
if ( e.originalEvent?.isComposing || e.keyCode === 229 ) return;
|
||||
// Escape steps back out of the form before it closes the modal, so a
|
||||
// half-written request survives a mis-hit key.
|
||||
if ( currentPane() === 'request' ) showPane('options');
|
||||
@@ -942,8 +917,6 @@ export function createAppBrowser ({ editable = true, onLaunch, actions = {}, gue
|
||||
// The last uninstalled-apps list a read returned, for loads whose read fails.
|
||||
_lastRemovedApps: null,
|
||||
_launchingApps: new Set(),
|
||||
// Apps whose uninstall was confirmed but hasn't landed on the server.
|
||||
_pendingUninstalls: new Set(),
|
||||
// A deep-link install mid-arrival ({ name, $el_window }) — its tile is
|
||||
// parked invisible until the intro's arrival beat (see
|
||||
// _spliceDeepLinkApp); and the session's landing-installed apps, kept
|
||||
@@ -1389,7 +1362,7 @@ export function createAppBrowser ({ editable = true, onLaunch, actions = {}, gue
|
||||
// account dialog, the touch action sheet, or the phone drawer.
|
||||
if ( $('.dashboard-notifications-panel.open, .dashboard-dialog-overlay, .context-menu-modal-backdrop, .dashboard-sidebar.open').length ) return;
|
||||
|
||||
const $panelGrid = $el_window.find('.myapps-group-overlay:not([inert]) .myapps-group-panel-grid');
|
||||
const $panelGrid = $el_window.find('.myapps-group-panel-grid');
|
||||
const pageTiles = ($panelGrid.length
|
||||
? $panelGrid
|
||||
: $el_window.find('.myapps-page').eq(self._page)
|
||||
@@ -2264,8 +2237,6 @@ export function createAppBrowser ({ editable = true, onLaunch, actions = {}, gue
|
||||
// removal below, so the tile a user reaches for the instant a folder
|
||||
// shuts would do nothing.
|
||||
$overlay.css('pointer-events', 'none');
|
||||
// Nor may its tiles take focus (Tab, the arrow keys) on the way out.
|
||||
$overlay.attr('inert', '');
|
||||
|
||||
// Back into the tile it grew out of; if that tile is gone (the folder
|
||||
// dissolved, the page flipped) the card simply recedes where it is.
|
||||
@@ -2363,32 +2334,14 @@ export function createAppBrowser ({ editable = true, onLaunch, actions = {}, gue
|
||||
// boundary so their stale snapshot can't replay over it (see
|
||||
// _resolveGroups).
|
||||
this._groupsSavedAtSeq = this._loadSeq || 0;
|
||||
this._persistLatest(APP_GROUPS_KV_KEY, JSON.stringify(groups), 'Failed to save app folders:');
|
||||
},
|
||||
|
||||
// Saves `value` under `key` one write at a time, sending only the
|
||||
// newest value once the write before it lands: two writes of a key in
|
||||
// flight together (an eject's save, then the drop's) can land in
|
||||
// either order, leaving the older layout stored.
|
||||
_persistLatest (key, value, failureMessage) {
|
||||
this._kvWrites ??= new Map();
|
||||
let slot = this._kvWrites.get(key);
|
||||
if ( ! slot ) this._kvWrites.set(key, slot = { pending: undefined, running: false });
|
||||
slot.pending = value;
|
||||
if ( slot.running ) return;
|
||||
slot.running = true;
|
||||
(async () => {
|
||||
while ( slot.pending !== undefined ) {
|
||||
const next = slot.pending;
|
||||
slot.pending = undefined;
|
||||
try {
|
||||
await puter.kv.set(key, next);
|
||||
} catch ( err ) {
|
||||
console.error(failureMessage, err);
|
||||
}
|
||||
try {
|
||||
const p = puter.kv.set(APP_GROUPS_KV_KEY, JSON.stringify(groups));
|
||||
if ( p && typeof p.catch === 'function' ) {
|
||||
p.catch(err => console.error('Failed to save app folders:', err));
|
||||
}
|
||||
slot.running = false;
|
||||
})();
|
||||
} catch ( err ) {
|
||||
console.error('Failed to save app folders:', err);
|
||||
}
|
||||
},
|
||||
|
||||
// -- Drag-to-reorder --
|
||||
@@ -3316,7 +3269,14 @@ export function createAppBrowser ({ editable = true, onLaunch, actions = {}, gue
|
||||
// boundary so their stale snapshot can't replay over it (see
|
||||
// _resolveOrderNames).
|
||||
this._orderSavedAtSeq = this._loadSeq || 0;
|
||||
this._persistLatest(APPS_ORDER_KV_KEY, JSON.stringify(names), 'Failed to save app order:');
|
||||
try {
|
||||
const p = puter.kv.set(APPS_ORDER_KV_KEY, JSON.stringify(names));
|
||||
if ( p && typeof p.catch === 'function' ) {
|
||||
p.catch(err => console.error('Failed to save app order:', err));
|
||||
}
|
||||
} catch ( err ) {
|
||||
console.error('Failed to save app order:', err);
|
||||
}
|
||||
},
|
||||
|
||||
loadApps ($el_window) {
|
||||
@@ -3484,7 +3444,7 @@ export function createAppBrowser ({ editable = true, onLaunch, actions = {}, gue
|
||||
|
||||
// Append installed apps that aren't already in the list
|
||||
for ( const app of installedApps ) {
|
||||
if ( seen.has(app.name) || this._pendingUninstalls.has(app.name) ) continue;
|
||||
if ( seen.has(app.name) ) continue;
|
||||
seen.add(app.name);
|
||||
merged.push(app);
|
||||
}
|
||||
|
||||
@@ -68,86 +68,6 @@ async function mount (options = {}) {
|
||||
}
|
||||
|
||||
describe('shared app browser', () => {
|
||||
it('keeps an app off the grid while its uninstall is still on its way to the server', async () => {
|
||||
const actions = { showAlert: vi.fn(), revokeAppSessions: vi.fn(async () => {}) };
|
||||
await mount({ editable: true, actions });
|
||||
let finishRevoke;
|
||||
puter.perms = { revokeApp: vi.fn(() => new Promise(resolve => { finishRevoke = resolve; })) };
|
||||
// The app's windows are closed first; the test has none.
|
||||
$.fn.close ??= function () { return this; };
|
||||
window.matchMedia = () => ({ matches: true });
|
||||
browser._setReorderMode($root, true);
|
||||
$('.myapps-tile[data-app-name="editor"] .myapps-tile-remove').trigger('click');
|
||||
$('.myapps-modal-confirm').trigger('click');
|
||||
expect(puter.perms.revokeApp).toHaveBeenCalled();
|
||||
|
||||
// A refresh before the revoke lands still lists the app as installed.
|
||||
await browser.loadApps($root);
|
||||
expect(browser._apps.map(app => app.name)).not.toContain('editor');
|
||||
|
||||
installed = installed.filter(app => app.name !== 'editor');
|
||||
finishRevoke({});
|
||||
await vi.waitFor(() => expect(browser._pendingUninstalls.size).toBe(0));
|
||||
await browser.loadApps($root);
|
||||
expect(browser._apps.map(app => app.name)).not.toContain('editor');
|
||||
expect(actions.showAlert).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('saves one layout at a time, sending only the newest once the last write lands', async () => {
|
||||
await mount({ editable: true });
|
||||
const writes = [];
|
||||
puter.kv.set = vi.fn((key, value) => new Promise(resolve => writes.push({ key, value, resolve })));
|
||||
const orderWrites = () => writes.filter(w => w.key === APPS_ORDER_KV_KEY);
|
||||
|
||||
browser._apps = [{ name: 'a' }, { name: 'b' }];
|
||||
browser.saveOrder();
|
||||
browser._apps = [{ name: 'b' }, { name: 'a' }];
|
||||
browser.saveOrder();
|
||||
browser._apps = [{ name: 'a' }, { name: 'b' }, { name: 'c' }];
|
||||
browser.saveOrder();
|
||||
expect(orderWrites()).toHaveLength(1);
|
||||
|
||||
orderWrites()[0].resolve();
|
||||
await vi.waitFor(() => expect(orderWrites()).toHaveLength(2));
|
||||
expect(orderWrites()[1].value).toBe(JSON.stringify(browser._savedOrderNames));
|
||||
expect(orderWrites()[1].value).not.toBe(orderWrites()[0].value);
|
||||
orderWrites()[1].resolve();
|
||||
await new Promise(resolve => setTimeout(resolve, 0));
|
||||
expect(orderWrites()).toHaveLength(2);
|
||||
});
|
||||
|
||||
it('leaves the app request form open on an Escape that ends an IME composition', async () => {
|
||||
await mount({ editable: true });
|
||||
$('.myapps-add-tile').trigger('click');
|
||||
$('.myapps-add-option[data-add-option="request"]').trigger('click');
|
||||
const pane = () => $('.myapps-add-pane:not([hidden])').attr('data-pane');
|
||||
expect(pane()).toBe('request');
|
||||
|
||||
$('.myapps-add-message')[0].dispatchEvent(new KeyboardEvent('keydown', { key: 'Escape', isComposing: true, bubbles: true }));
|
||||
expect(pane()).toBe('request');
|
||||
$('.myapps-add-message')[0].dispatchEvent(new KeyboardEvent('keydown', { key: 'Escape', bubbles: true }));
|
||||
expect(pane()).toBe('options');
|
||||
$(document).off('keydown.add-app-modal');
|
||||
});
|
||||
|
||||
it('lets Tab reach the delete-data option in the Uninstall dialog', async () => {
|
||||
// jsdom lays nothing out; the focus trap skips elements with no offsetParent.
|
||||
vi.spyOn(HTMLElement.prototype, 'offsetParent', 'get').mockReturnValue(document.body);
|
||||
await mount({ editable: true });
|
||||
browser._setReorderMode($root, true);
|
||||
$('.myapps-tile[data-app-name="editor"] .myapps-tile-remove').trigger('click');
|
||||
const $overlay = $('.myapps-modal-overlay');
|
||||
expect(document.activeElement.classList.contains('myapps-modal-cancel')).toBe(true);
|
||||
|
||||
// Tab from the last control wraps to the first, the checkbox.
|
||||
$overlay.find('.myapps-modal-confirm')[0].focus();
|
||||
$overlay.trigger($.Event('keydown', { key: 'Tab', shiftKey: false }));
|
||||
expect(document.activeElement.classList.contains('myapps-modal-delete-data')).toBe(true);
|
||||
// Shift+Tab from it wraps back to the last.
|
||||
$overlay.trigger($.Event('keydown', { key: 'Tab', shiftKey: true }));
|
||||
expect(document.activeElement.classList.contains('myapps-modal-confirm')).toBe(true);
|
||||
});
|
||||
|
||||
it('uses saved order, folders, and removed recommendations in read-only mode', async () => {
|
||||
await mount();
|
||||
expect(browser._apps.map(app => app.name)).toEqual(['notes', 'sheet', 'editor']);
|
||||
|
||||
@@ -68,7 +68,7 @@ describe('TabApps.beginDeepLinkLaunch', () => {
|
||||
});
|
||||
|
||||
describe('TabApps cancelling a drag out of a folder', () => {
|
||||
it('puts the folder and the order back as they were', async () => {
|
||||
it('puts the folder and the order back as they were', () => {
|
||||
document.body.innerHTML = '<div class="window"><div class="dashboard-section-apps active"><div class="myapps-container"><div class="myapps-page"><div class="myapps-tile" data-app-name="a"></div></div></div></div></div>';
|
||||
window.puter = { kv: { set: vi.fn(async () => {}), get: vi.fn(async () => null) } };
|
||||
TabApps._groupsLoaded = true;
|
||||
@@ -91,9 +91,7 @@ describe('TabApps cancelling a drag out of a folder', () => {
|
||||
TabApps._endDrag(false);
|
||||
|
||||
expect(TabApps._groups).toEqual([{ id: 'g1', name: 'Work', apps: ['a', 'b'] }]);
|
||||
// The restore is written once the eject's own write lands.
|
||||
const lastSaved = key => JSON.parse(window.puter.kv.set.mock.calls.filter(([k]) => k === key).at(-1)[1]);
|
||||
await vi.waitFor(() => expect(lastSaved('dashboard_app_groups')).toEqual([{ id: 'g1', name: 'Work', apps: ['a', 'b'] }]));
|
||||
expect(JSON.parse(window.puter.kv.set.mock.calls.at(-2)[1])).toEqual([{ id: 'g1', name: 'Work', apps: ['a', 'b'] }]);
|
||||
vi.restoreAllMocks();
|
||||
});
|
||||
});
|
||||
|
||||
@@ -37,7 +37,6 @@ import UIItemPropertiesModal from './UIItemPropertiesModal.js';
|
||||
import UIShareModal from './UIShareModal.js';
|
||||
import { openPublishWebsiteDialog, openPublishWorkerDialog } from './UIPublishDialogs.js';
|
||||
import { dedupedName } from '../../helpers/dedupedName.js';
|
||||
import { runLimited } from '../../helpers/runLimited.js';
|
||||
import { compareEntries, compareNames } from './sortEntries.js';
|
||||
import { middleTruncate } from './middleTruncate.js';
|
||||
import { resolveTypedPath } from './typedPath.js';
|
||||
@@ -55,14 +54,6 @@ import { paintAvatars } from '../../helpers/profilePictures.js';
|
||||
|
||||
const { html_encode, SelectionArea } = window;
|
||||
|
||||
// Permanent deletes in flight at once: a browser's connections to one host.
|
||||
const DELETE_CONCURRENCY = 6;
|
||||
|
||||
// The "New" menu's stand-ins for window.create_file, one per create in
|
||||
// flight (newest last), and the function they stand in for.
|
||||
const createFileInterceptors = [];
|
||||
let realCreateFile = null;
|
||||
|
||||
/**
|
||||
* `p` with the folder `from` (itself, or anything under it) moved to `to`;
|
||||
* any other path, or a non-string, comes back as it was.
|
||||
@@ -1251,9 +1242,8 @@ const TabFiles = {
|
||||
return false;
|
||||
}
|
||||
|
||||
// Arrow keys, Home/End and PageUp/PageDown - Navigate items. Not
|
||||
// with Alt or Cmd: those are the browser's (Alt+Left is Back).
|
||||
if ( e.which >= 33 && e.which <= 40 && ! e.altKey && ! e.metaKey ) {
|
||||
// Arrow keys, Home/End and PageUp/PageDown - Navigate items
|
||||
if ( e.which >= 33 && e.which <= 40 ) {
|
||||
e.preventDefault();
|
||||
e.stopPropagation();
|
||||
|
||||
@@ -1917,9 +1907,9 @@ const TabFiles = {
|
||||
if ( confirmed !== 'delete' ) return;
|
||||
// The phone selection bar acts on rows that are going away.
|
||||
this.$el_window.find('.files-selection-actions').removeClass('visible');
|
||||
// A few at a time rather than one after another: a few hundred items
|
||||
// took a round trip each. delete_item reports its own failures.
|
||||
await runLimited(list, DELETE_CONCURRENCY, row => window.delete_item(row));
|
||||
for ( const row of list ) {
|
||||
await window.delete_item(row);
|
||||
}
|
||||
await window.refresh_trash_state();
|
||||
},
|
||||
|
||||
@@ -2393,19 +2383,11 @@ const TabFiles = {
|
||||
};
|
||||
|
||||
if ( isList ) {
|
||||
// The name's padding (8px a side) takes room from a set width. An
|
||||
// auto-width column fills the row, so its room is read off the
|
||||
// name's wrapper, less the wrapper's padding: all reads before any
|
||||
// write, so the writes don't force a layout each.
|
||||
const paddingOf = s => (parseFloat(s.paddingLeft) || 0) + (parseFloat(s.paddingRight) || 0);
|
||||
const padding = paddingOf(style);
|
||||
const wrapperPadding = nameWidth ? 0 : paddingOf(getComputedStyle(names[0].parentElement));
|
||||
const rooms = nameWidth ? null : names.map(el => el.parentElement.clientWidth - wrapperPadding);
|
||||
names.forEach((el, i) => {
|
||||
const room = (nameWidth || rooms[i]) - padding;
|
||||
// A listing that isn't laid out yet (hidden tab) has no room to fit to.
|
||||
write(el, room > 0 ? truncateFilenameToWidth(fullNameOf(el), room, font) : fullNameOf(el));
|
||||
});
|
||||
for ( const el of names ) {
|
||||
// 8px padding on each side; an auto-width column shows the
|
||||
// full name, clipped by CSS.
|
||||
write(el, nameWidth ? truncateFilenameToWidth(fullNameOf(el), nameWidth - 16, font) : fullNameOf(el));
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -3330,9 +3312,6 @@ const TabFiles = {
|
||||
// the directories sidebar is hidden — Home carries a row for each.
|
||||
this.renderPlaceRows();
|
||||
|
||||
// Something that ran while the listing loaded (a restore finishing,
|
||||
// a failed mkdir) may have found the pane empty and said so.
|
||||
$files.find('.files-empty-notice').remove();
|
||||
if ( directoryContents.length === 0 ) {
|
||||
this.renderEmptyPlaceholderIfNeeded();
|
||||
this.updateFooterStats();
|
||||
@@ -4454,14 +4433,11 @@ const TabFiles = {
|
||||
const metadata = metadataStr ? JSON.parse(metadataStr) : {};
|
||||
|
||||
// Only a direct child of Trash carries restore metadata.
|
||||
const name = $(el_item).attr('data-name') || '';
|
||||
if ( path.dirname($(el_item).attr('data-path') || '') !== window.trash_path ) {
|
||||
throw new Error(i18n('restore_only_trash_items', { name }, false));
|
||||
throw new Error('Cannot restore: only top-level Trash items can be restored');
|
||||
}
|
||||
// An item an app or the API moved into the Trash has no record of
|
||||
// where it came from.
|
||||
if ( ! metadata.original_path ) {
|
||||
throw new Error(i18n('restore_location_unknown', { name }, false));
|
||||
throw new Error('Cannot restore: original path not found in metadata');
|
||||
}
|
||||
|
||||
const destPath = path.dirname(metadata.original_path);
|
||||
@@ -5394,14 +5370,10 @@ const TabFiles = {
|
||||
return async () => {
|
||||
$('.context-menu').remove();
|
||||
|
||||
// Where the user was, so an upload that lands after
|
||||
// they've moved on neither pulls them back nor draws
|
||||
// its row into another folder's listing.
|
||||
const pathAtClick = _this.currentPath;
|
||||
|
||||
// Temporarily intercept create_file to capture the upload promise
|
||||
let uploadPromise = null;
|
||||
const createFile = (options) => {
|
||||
const origCreateFile = window.create_file;
|
||||
window.create_file = (options) => {
|
||||
// Counted from here, not from the click: Web Link
|
||||
// waits on a prompt first, and other items added
|
||||
// to the folder meanwhile must still show up.
|
||||
@@ -5412,12 +5384,6 @@ const TabFiles = {
|
||||
// a caller that awaits this.
|
||||
return uploadPromise.catch(() => undefined);
|
||||
};
|
||||
// Creates can overlap. Each one's interceptor stays
|
||||
// installed until it finishes, the newest on top, and
|
||||
// the real create_file comes back once none is left.
|
||||
if ( createFileInterceptors.length === 0 ) realCreateFile = window.create_file;
|
||||
createFileInterceptors.push(createFile);
|
||||
window.create_file = createFile;
|
||||
|
||||
try {
|
||||
await originalOnClick();
|
||||
@@ -5435,10 +5401,7 @@ const TabFiles = {
|
||||
operation: 'create_file',
|
||||
data: $('<div>').attr({ 'data-uid': result.uid, 'data-path': result.path }),
|
||||
});
|
||||
// Not mid-way to another folder (currentPath
|
||||
// only moves once its listing arrives).
|
||||
const settled = ! _this.loadingFolder;
|
||||
if ( settled && targetPath === _this.currentPath ) {
|
||||
if ( targetPath === _this.currentPath ) {
|
||||
// Remove empty-directory placeholder if present
|
||||
_this.$el_window.find('.files-tab .files > div:not(.item):not(.place-row):not(.tabfiles-selection-area)').remove();
|
||||
// Add the new file incrementally
|
||||
@@ -5449,15 +5412,11 @@ const TabFiles = {
|
||||
_this.applyColumnWidths();
|
||||
_this.updateFooterStats();
|
||||
}
|
||||
} else if ( settled && _this.currentPath === pathAtClick ) {
|
||||
} else {
|
||||
// Same navigate-to-target treatment as New
|
||||
// Folder above.
|
||||
_this.pushNavHistory(targetPath);
|
||||
await _this.renderDirectory(targetPath, { consistency: 'strong' });
|
||||
} else {
|
||||
// The user went elsewhere meanwhile; the
|
||||
// file is there when they come back.
|
||||
return;
|
||||
}
|
||||
const $newRow = _this.$el_window.find(`.files-tab .files .item[data-uid='${result.uid}']`);
|
||||
if ( $newRow.length > 0 ) {
|
||||
@@ -5468,8 +5427,7 @@ const TabFiles = {
|
||||
} catch ( err ) {
|
||||
UIAlert(err?.message || i18n('error_unknown_cause', [], false));
|
||||
} finally {
|
||||
createFileInterceptors.splice(createFileInterceptors.indexOf(createFile), 1);
|
||||
window.create_file = createFileInterceptors.at(-1) ?? realCreateFile;
|
||||
window.create_file = origCreateFile;
|
||||
if ( uploadPromise ) _this.doneCreating();
|
||||
}
|
||||
};
|
||||
|
||||
@@ -116,131 +116,6 @@ describe('TabFiles emptying the Trash', () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe('TabFiles restoring from the Trash', () => {
|
||||
beforeEach(() => {
|
||||
window.trash_path = TRASH;
|
||||
window.byte_format = bytes => `${bytes} B`;
|
||||
window.refresh_trash_state = vi.fn(async () => {});
|
||||
window.puter = { fs: { move: vi.fn(async () => ({})) } };
|
||||
});
|
||||
|
||||
afterEach(() => vi.restoreAllMocks());
|
||||
|
||||
it('says in the user\'s language when an item has no record of where it came from', async () => {
|
||||
const { default: UIAlert } = await import('../UIAlert.js');
|
||||
UIAlert.mockClear();
|
||||
mountListing(['uid-1']);
|
||||
const row = $('.files .row')[0];
|
||||
row.setAttribute('data-name', 'notes.txt');
|
||||
row.setAttribute('data-uid', 'uid-1');
|
||||
|
||||
vi.spyOn(console, 'error').mockImplementation(() => {});
|
||||
await TabFiles.restoreRows([row]);
|
||||
|
||||
expect(puter.fs.move).not.toHaveBeenCalled();
|
||||
expect(UIAlert).toHaveBeenCalledWith('“notes.txt” can’t be restored because where it was deleted from isn’t known.');
|
||||
expect($('.files .row')).toHaveLength(1);
|
||||
});
|
||||
});
|
||||
|
||||
describe('TabFiles New menu creates', () => {
|
||||
const menuItem = (pattern, folder) => TabFiles.generateFolderContextMenu(folder)
|
||||
.find(item => item && item.items).items.find(item => item && pattern.test(item.html));
|
||||
let uploads;
|
||||
|
||||
beforeEach(() => {
|
||||
mountListing([], '/alice/Documents');
|
||||
window.user = { username: 'alice' };
|
||||
window.trash_path = TRASH;
|
||||
window.shared_path = '/alice/Shared';
|
||||
window.file_templates = [];
|
||||
window.sites = [];
|
||||
window.actions_history = [];
|
||||
window.activate_item_name_editor = vi.fn();
|
||||
vi.spyOn(TabFiles, 'pushNavHistory').mockImplementation(() => {});
|
||||
uploads = [];
|
||||
window.puter = { fs: { upload: vi.fn((file, dirname) => new Promise(resolve => {
|
||||
uploads.push(() => resolve({ uid: `u${uploads.length}`, name: file.name, path: `${dirname}/${file.name}` }));
|
||||
})) } };
|
||||
vi.spyOn(TabFiles, 'acceptsNewItemsHere').mockReturnValue(true);
|
||||
vi.spyOn(TabFiles, 'acceptsNewItems').mockReturnValue(true);
|
||||
vi.spyOn(TabFiles, 'renderItem').mockResolvedValue();
|
||||
TabFiles.loadingFolder = false;
|
||||
TabFiles._creatingItem = 0;
|
||||
TabFiles.trashedNames ??= new Map();
|
||||
TabFiles.deferredAdds ??= [];
|
||||
});
|
||||
|
||||
afterEach(() => vi.restoreAllMocks());
|
||||
|
||||
it('puts the real create_file back when two overlap, whichever finishes first', async () => {
|
||||
const real = vi.fn();
|
||||
window.create_file = real;
|
||||
|
||||
const first = menuItem(/text_document|Text/).onClick();
|
||||
const second = menuItem(/html_document|HTML/).onClick();
|
||||
await new Promise(resolve => setTimeout(resolve, 0));
|
||||
expect(uploads).toHaveLength(2);
|
||||
uploads[0]();
|
||||
await first;
|
||||
uploads[1]();
|
||||
await second;
|
||||
|
||||
expect(window.create_file).toBe(real);
|
||||
expect(TabFiles._creatingItem).toBe(0);
|
||||
|
||||
const third = menuItem(/text_document|Text/).onClick();
|
||||
const fourth = menuItem(/html_document|HTML/).onClick();
|
||||
await new Promise(resolve => setTimeout(resolve, 0));
|
||||
uploads[3]();
|
||||
await fourth;
|
||||
uploads[2]();
|
||||
await third;
|
||||
|
||||
expect(window.create_file).toBe(real);
|
||||
expect(TabFiles._creatingItem).toBe(0);
|
||||
});
|
||||
|
||||
it('leaves a listing the user moved to alone when the upload lands after', async () => {
|
||||
window.create_file = vi.fn();
|
||||
vi.spyOn(TabFiles, 'renderDirectory').mockResolvedValue();
|
||||
const created = menuItem(/text_document|Text/).onClick();
|
||||
await new Promise(resolve => setTimeout(resolve, 0));
|
||||
|
||||
// The user opened Pictures; its listing is still loading.
|
||||
TabFiles.loadingFolder = true;
|
||||
uploads[0]();
|
||||
await created;
|
||||
expect(TabFiles.renderItem).not.toHaveBeenCalled();
|
||||
expect(TabFiles.renderDirectory).not.toHaveBeenCalled();
|
||||
expect(window.activate_item_name_editor).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('does not pull the user back once they are in another folder', async () => {
|
||||
window.create_file = vi.fn();
|
||||
vi.spyOn(TabFiles, 'renderDirectory').mockResolvedValue();
|
||||
const created = menuItem(/text_document|Text/).onClick();
|
||||
await new Promise(resolve => setTimeout(resolve, 0));
|
||||
|
||||
TabFiles.currentPath = '/alice/Pictures';
|
||||
uploads[0]();
|
||||
await created;
|
||||
expect(TabFiles.renderDirectory).not.toHaveBeenCalled();
|
||||
expect(TabFiles.renderItem).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('still goes to the folder whose menu made the file', async () => {
|
||||
window.create_file = vi.fn();
|
||||
vi.spyOn(TabFiles, 'renderDirectory').mockResolvedValue();
|
||||
const created = menuItem(/text_document|Text/, '/alice/Videos').onClick();
|
||||
await new Promise(resolve => setTimeout(resolve, 0));
|
||||
|
||||
uploads[0]();
|
||||
await created;
|
||||
expect(TabFiles.renderDirectory).toHaveBeenCalledWith('/alice/Videos', { consistency: 'strong' });
|
||||
});
|
||||
});
|
||||
|
||||
describe('failedUploadsMessage', () => {
|
||||
it('puts each failed item on its own line', () => {
|
||||
const message = failedUploadsMessage({ failedItems: [
|
||||
@@ -1211,57 +1086,6 @@ describe('TabFiles names in a narrow listing', () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe('TabFiles names in an auto-width name column', () => {
|
||||
const mountNames = (names) => {
|
||||
document.body.innerHTML = `
|
||||
<div class="window"><div class="files-tab">
|
||||
<div class="header"><div class="columns"></div></div>
|
||||
<div class="files files-list-view">${names.map(name => `
|
||||
<div class="row item" data-name="${name}">
|
||||
<div class="item-name-wrapper" style="padding: 0 40px 0 0"><pre class="item-name" style="padding: 0 8px"></pre></div>
|
||||
</div>`).join('')}
|
||||
</div>
|
||||
</div></div>`;
|
||||
TabFiles.$el_window = $('.window');
|
||||
TabFiles.currentView = 'list';
|
||||
TabFiles.appliedColumnWidths = { name: null, sharedBy: 160, size: 60, modified: 80 };
|
||||
};
|
||||
|
||||
beforeEach(() => {
|
||||
// 10px a character; jsdom has no canvas.
|
||||
vi.spyOn(HTMLCanvasElement.prototype, 'getContext').mockReturnValue({ measureText: text => ({ width: text.length * 10 }) });
|
||||
});
|
||||
|
||||
afterEach(() => vi.restoreAllMocks());
|
||||
|
||||
it('cut a long name in the middle to the room its wrapper leaves, keeping the end', () => {
|
||||
const long = `${'x'.repeat(60)} (1).txt`;
|
||||
mountNames([long, 'short.txt']);
|
||||
// 256px wrapper, less its 40px and the name's 16px of padding: 200px, 20 characters.
|
||||
vi.spyOn(HTMLElement.prototype, 'clientWidth', 'get').mockReturnValue(256);
|
||||
|
||||
TabFiles.fitItemNames($('.files .item-name'));
|
||||
|
||||
const [$long, $short] = $('.files .item-name').toArray().map(el => $(el));
|
||||
expect($long.text().length).toBeLessThanOrEqual(20);
|
||||
expect($long.text().length).toBeGreaterThan(15);
|
||||
expect($long.text()).toMatch(/^x+…x* \(1\)\.txt$/);
|
||||
expect($long.attr('title')).toBe(long);
|
||||
expect($short.text()).toBe('short.txt');
|
||||
expect($short.attr('title') ?? '').toBe('');
|
||||
});
|
||||
|
||||
it('show the full name while the listing has no width yet', () => {
|
||||
const long = 'y'.repeat(80);
|
||||
mountNames([long]);
|
||||
vi.spyOn(HTMLElement.prototype, 'clientWidth', 'get').mockReturnValue(0);
|
||||
|
||||
TabFiles.fitItemNames($('.files .item-name'));
|
||||
|
||||
expect($('.files .item-name').text()).toBe(long);
|
||||
});
|
||||
});
|
||||
|
||||
describe('TabFiles uploads', () => {
|
||||
beforeEach(async () => {
|
||||
vi.restoreAllMocks();
|
||||
@@ -1545,22 +1369,6 @@ describe('TabFiles keyboard', () => {
|
||||
expect(selected()).toEqual(['/alice/Documents/a.txt']);
|
||||
});
|
||||
|
||||
it('leaves Alt and Cmd arrows to the browser', () => {
|
||||
mountKeyboard(['a.txt', 'b.txt']);
|
||||
$('.files .row').first().addClass('selected');
|
||||
|
||||
const back = new KeyboardEvent('keydown', { key: 'ArrowLeft', which: 37, keyCode: 37, altKey: true, bubbles: true, cancelable: true });
|
||||
document.body.dispatchEvent(back);
|
||||
const down = new KeyboardEvent('keydown', { key: 'ArrowDown', which: 40, keyCode: 40, metaKey: true, bubbles: true, cancelable: true });
|
||||
document.body.dispatchEvent(down);
|
||||
|
||||
expect(back.defaultPrevented).toBe(false);
|
||||
expect(down.defaultPrevented).toBe(false);
|
||||
expect(selected()).toEqual(['/alice/Documents/a.txt']);
|
||||
press(document.body, 'ArrowDown', { which: 40, keyCode: 40 });
|
||||
expect(selected()).toEqual(['/alice/Documents/b.txt']);
|
||||
});
|
||||
|
||||
it('takes a space typed into a name as part of it', () => {
|
||||
mountKeyboard(['my notes.txt', 'my zebra.txt']);
|
||||
for ( const key of ['m', 'y', ' ', 'z'] ) press(document.body, key, { which: key.toUpperCase().charCodeAt(0) });
|
||||
|
||||
@@ -168,19 +168,15 @@ function buildUsageHTML() {
|
||||
// what the badge carries: a date says when, only a countdown says how long
|
||||
// there is to decide. Returns null when the subscription carries no end date,
|
||||
// so callers fall back to unqualified "Free trial" wording.
|
||||
export function formatTrialEnd(trialEndsAt, now = Date.now()) {
|
||||
function formatTrialEnd(trialEndsAt) {
|
||||
if (!Number.isFinite(trialEndsAt)) return null;
|
||||
const date = new Date(trialEndsAt);
|
||||
if (Number.isNaN(date.getTime())) return null;
|
||||
// Calendar days in the user's time zone, so the countdown agrees with the
|
||||
// date beside it: a trial ending this afternoon ends "today", and one
|
||||
// ending tomorrow morning has one day left. Rounded, for the 23- and
|
||||
// 25-hour days daylight saving makes.
|
||||
const startOfDay = (d) =>
|
||||
new Date(d.getFullYear(), d.getMonth(), d.getDate()).getTime();
|
||||
// Rounded up, so a trial with any time on it never reads "0 days left"
|
||||
// before the day it actually converts.
|
||||
const days = Math.max(
|
||||
0,
|
||||
Math.round((startOfDay(date) - startOfDay(new Date(now))) / 86400000),
|
||||
Math.ceil((date.getTime() - Date.now()) / 86400000),
|
||||
);
|
||||
// In the dashboard's language, which the sentences around it are in.
|
||||
const locale = intlLocale(window.locale);
|
||||
|
||||
@@ -31,7 +31,7 @@ globalThis.i18n = key => key;
|
||||
window.icons = {};
|
||||
window.launch_apps = { recent: [] };
|
||||
|
||||
const { default: TabHome, formatTrialEnd } = await import('./TabHome.js');
|
||||
const { default: TabHome } = await import('./TabHome.js');
|
||||
const { openAppInNewTab } = await import('../../helpers/dashboardAppLaunch.js');
|
||||
|
||||
describe('TabHome recently used', () => {
|
||||
@@ -96,25 +96,3 @@ describe('TabHome recent app clicks', () => {
|
||||
expect(openAppInNewTab).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
});
|
||||
|
||||
describe('formatTrialEnd', () => {
|
||||
const at = (day, hour) => new Date(2026, 10, day, hour).getTime();
|
||||
|
||||
it('counts calendar days, so the countdown agrees with the date', () => {
|
||||
// Ends at 3pm today: today, not "1 day left".
|
||||
expect(formatTrialEnd(at(8, 15), at(8, 9)).days).toBe(0);
|
||||
// Ends tomorrow at 11am: one day, not two.
|
||||
expect(formatTrialEnd(at(9, 11), at(8, 9)).days).toBe(1);
|
||||
expect(formatTrialEnd(at(9, 11), at(8, 23)).days).toBe(1);
|
||||
expect(formatTrialEnd(at(15, 0), at(8, 23)).days).toBe(7);
|
||||
});
|
||||
|
||||
it('reads an end that has passed as today', () => {
|
||||
expect(formatTrialEnd(at(7, 12), at(8, 9)).days).toBe(0);
|
||||
});
|
||||
|
||||
it('has nothing to say without an end date', () => {
|
||||
expect(formatTrialEnd(undefined)).toBeNull();
|
||||
expect(formatTrialEnd(NaN)).toBeNull();
|
||||
});
|
||||
});
|
||||
@@ -49,9 +49,7 @@ const ICONS = {
|
||||
puter: svg('<rect x="3" y="3" width="18" height="18" rx="4"/><path d="M8 12h8M12 8v8"/>'),
|
||||
};
|
||||
|
||||
// `webpush` is Puter's own Web Push (see webPushClient.js); both are browsers.
|
||||
const PLATFORM_KEYS = { web: 'push_platform_web', webpush: 'push_platform_web', ios: 'push_platform_ios', android: 'push_platform_android' };
|
||||
const BROWSER_PLATFORMS = new Set(['web', 'webpush']);
|
||||
const PLATFORM_KEYS = { web: 'push_platform_web', ios: 'push_platform_ios', android: 'push_platform_android' };
|
||||
|
||||
/** @param {{ pushEnabled?: boolean }|undefined} params - `window.gui_params` */
|
||||
export const notificationsTabEnabled = (params) => params?.pushEnabled === true;
|
||||
@@ -108,7 +106,7 @@ export const deviceCardHtml = (device, now) => {
|
||||
? i18n('push_device_last_seen', { time: formatRelativeTime(seenAt, now, locale) })
|
||||
: '';
|
||||
return card({
|
||||
icon: BROWSER_PLATFORMS.has(device.platform) ? ICONS.laptop : ICONS.phone,
|
||||
icon: device.platform === 'web' ? ICONS.laptop : ICONS.phone,
|
||||
title: html_encode(deviceName(device)),
|
||||
badge: device.current ? i18n('push_this_browser') : '',
|
||||
detail: [platform, seen].filter(Boolean).join(' · '),
|
||||
@@ -232,18 +230,11 @@ const TabNotifications = {
|
||||
? devices.map(device => deviceCardHtml(device, now)).join('')
|
||||
: emptyHtml('push_devices_empty'));
|
||||
};
|
||||
// Only the newest listing draws, and a local removal outdates any
|
||||
// listing still in flight: it may predate the removal.
|
||||
let devicesSeq = 0;
|
||||
const refreshDevices = async () => {
|
||||
const seq = ++devicesSeq;
|
||||
try {
|
||||
const listed = await listPushDevices();
|
||||
if ( seq !== devicesSeq ) return;
|
||||
devices = listed;
|
||||
devices = await listPushDevices();
|
||||
renderDevices();
|
||||
} catch ( e ) {
|
||||
if ( seq !== devicesSeq ) return;
|
||||
console.warn('[push] device list failed', e);
|
||||
$section.find('.push-devices-list').html(emptyHtml(loadFailedKey(e)));
|
||||
}
|
||||
@@ -254,16 +245,11 @@ const TabNotifications = {
|
||||
? apps.map(appCardHtml).join('')
|
||||
: emptyHtml('push_apps_empty'));
|
||||
};
|
||||
let appsSeq = 0;
|
||||
const refreshApps = async () => {
|
||||
const seq = ++appsSeq;
|
||||
try {
|
||||
const listed = await listPushApps();
|
||||
if ( seq !== appsSeq ) return;
|
||||
apps = listed;
|
||||
apps = await listPushApps();
|
||||
renderApps();
|
||||
} catch ( e ) {
|
||||
if ( seq !== appsSeq ) return;
|
||||
console.warn('[push] app list failed', e);
|
||||
$section.find('.push-apps-list').html(emptyHtml(loadFailedKey(e)));
|
||||
}
|
||||
@@ -271,15 +257,12 @@ const TabNotifications = {
|
||||
|
||||
const refreshPreference = async () => {
|
||||
const $toggle = $section.find('.push-puter-toggle');
|
||||
const $hint = $section.find('.push-puter-card .dashboard-settings-card-info > span');
|
||||
try {
|
||||
$toggle.prop('checked', await getPuterPushPreference()).prop('disabled', false);
|
||||
// A failed earlier read replaced the hint.
|
||||
$hint.html(i18n('push_puter_notifications_hint'));
|
||||
} catch ( e ) {
|
||||
console.warn('[push] preference read failed', e);
|
||||
$toggle.prop('checked', false).prop('disabled', true);
|
||||
$hint.html(i18n(loadFailedKey(e)));
|
||||
$section.find('.push-puter-card .dashboard-settings-card-info > span').html(i18n(loadFailedKey(e)));
|
||||
}
|
||||
};
|
||||
|
||||
@@ -379,21 +362,13 @@ const TabNotifications = {
|
||||
if ( confirmed !== true ) return;
|
||||
// disable() drops the token and record; the DELETE covers a lost record.
|
||||
const client = device.current ? getPushClient() : null;
|
||||
let disabled = false;
|
||||
try {
|
||||
if ( client ) {
|
||||
await client.disable();
|
||||
disabled = true;
|
||||
// Push is off here even if the DELETE fails; without the
|
||||
// opt-out the next load would turn it back on.
|
||||
setBrowserPushOptOut(window.user?.uuid, true);
|
||||
}
|
||||
if ( client ) await client.disable();
|
||||
await removePushDevice(uid);
|
||||
} catch ( e ) {
|
||||
if ( e?.status !== 404 || e?.code === PUSH_UNAVAILABLE ) {
|
||||
console.warn('[push] device removal failed', e);
|
||||
showError('push_device_remove_failed', $el_window);
|
||||
if ( disabled ) refreshBrowser();
|
||||
return;
|
||||
}
|
||||
}
|
||||
@@ -402,7 +377,6 @@ const TabNotifications = {
|
||||
await Promise.all([refreshBrowser(), refreshDevices()]);
|
||||
return;
|
||||
}
|
||||
devicesSeq++;
|
||||
devices = devices.filter(d => d.uid !== uid);
|
||||
renderDevices();
|
||||
if ( device.current ) refreshBrowser();
|
||||
@@ -419,7 +393,6 @@ const TabNotifications = {
|
||||
showError('push_app_turn_off_failed', $el_window);
|
||||
return;
|
||||
}
|
||||
appsSeq++;
|
||||
apps = apps.filter(app => app.uid !== appUid);
|
||||
renderApps();
|
||||
});
|
||||
|
||||
@@ -412,26 +412,6 @@ describe('Puter notifications', () => {
|
||||
expect($('.push-puter-card').text()).toContain('push_load_failed');
|
||||
});
|
||||
|
||||
it('puts the hint back once a later visit reads the preference', async () => {
|
||||
serve({
|
||||
'GET /push/devices': { devices: [] },
|
||||
'GET /push/apps': { apps: [] },
|
||||
'GET /push/preferences': () => reply(500, {}),
|
||||
});
|
||||
await open();
|
||||
serve({
|
||||
'GET /push/devices': { devices: [] },
|
||||
'GET /push/apps': { apps: [] },
|
||||
'GET /push/preferences': { puter: true },
|
||||
});
|
||||
await tab.onActivate($('.win'));
|
||||
await settle();
|
||||
|
||||
expect($('.push-puter-toggle').prop('disabled')).toBe(false);
|
||||
expect($('.push-puter-card').text()).toContain('push_puter_notifications_hint');
|
||||
expect($('.push-puter-card').text()).not.toContain('push_load_failed');
|
||||
});
|
||||
|
||||
it('puts the switch back when the save fails', async () => {
|
||||
serve({
|
||||
'GET /push/devices': { devices: [] },
|
||||
@@ -491,21 +471,6 @@ describe('your devices', () => {
|
||||
expect($cards.eq(2).find('strong').text()).toBe('push_device_unknown');
|
||||
});
|
||||
|
||||
it('labels a browser on Puter\'s own Web Push as a browser', async () => {
|
||||
serve({
|
||||
'GET /push/devices': { devices: [device({ uid: 'a', platform: 'webpush' }), device({ uid: 'b', platform: 'ios' })] },
|
||||
'GET /push/apps': { apps: [] },
|
||||
'GET /push/preferences': { puter: true },
|
||||
});
|
||||
await open();
|
||||
|
||||
const $cards = $('.push-device-card');
|
||||
expect($cards.eq(0).find('.dashboard-settings-card-info > span').text()).toContain('push_platform_web');
|
||||
// Laptop, not phone.
|
||||
expect($cards.eq(0).find('svg rect').attr('width')).toBe('18');
|
||||
expect($cards.eq(1).find('svg rect').attr('width')).toBe('12');
|
||||
});
|
||||
|
||||
it('removes a device once the user confirms', async () => {
|
||||
const remove = vi.fn(() => reply(200, { removed: true }));
|
||||
serve({
|
||||
@@ -557,30 +522,6 @@ describe('your devices', () => {
|
||||
expect(pushClient.browserPushOptedOut('u-1')).toBe(true);
|
||||
});
|
||||
|
||||
it('keeps this browser opted out when its push is off but the server removal fails', async () => {
|
||||
const client = fakeClient({ permission: 'granted', registered: true, deviceUid: 'a' });
|
||||
pushClient.registerPushClient(client);
|
||||
serve({
|
||||
'GET /push/devices': { devices: [device({ uid: 'a', current: true })] },
|
||||
'GET /push/apps': { apps: [] },
|
||||
'GET /push/preferences': { puter: true },
|
||||
'DELETE /push/devices/a': () => reply(500, {}),
|
||||
});
|
||||
await open();
|
||||
client.disable.mockImplementation(async () => {
|
||||
client.status.mockResolvedValue({ permission: 'granted', registered: false });
|
||||
});
|
||||
|
||||
$('.push-remove-device[data-uid="a"]').trigger('click');
|
||||
await settle();
|
||||
dialogButton('push_device_remove').trigger('click');
|
||||
await settle();
|
||||
|
||||
expect(dialog('.dashboard-dialog-message').text()).toContain('push_device_remove_failed');
|
||||
expect(pushClient.browserPushOptedOut('u-1')).toBe(true);
|
||||
expect(browserCard().hasClass('push-browser-off')).toBe(true);
|
||||
});
|
||||
|
||||
it('still removes this browser on the server when it has no local record', async () => {
|
||||
const client = fakeClient({ permission: 'granted', registered: false });
|
||||
pushClient.registerPushClient(client);
|
||||
@@ -607,36 +548,6 @@ describe('your devices', () => {
|
||||
expect($('.push-device-card')).toHaveLength(0);
|
||||
});
|
||||
|
||||
it('does not bring back a removed device when an older listing lands after the removal', async () => {
|
||||
const both = [device({ uid: 'a' }), device({ uid: 'b', label: 'Phone' })];
|
||||
let releaseListing;
|
||||
let deferred = false;
|
||||
serve({
|
||||
'GET /push/devices': () => (deferred
|
||||
? new Promise(resolve => { releaseListing = () => resolve(reply(200, { devices: both })); })
|
||||
: reply(200, { devices: both })),
|
||||
'GET /push/apps': { apps: [] },
|
||||
'GET /push/preferences': { puter: true },
|
||||
'DELETE /push/devices/b': () => reply(200, { removed: true }),
|
||||
});
|
||||
await open();
|
||||
// Coming back to the tab starts a listing that is slow to answer.
|
||||
deferred = true;
|
||||
void tab.onActivate($('.win'));
|
||||
await settle();
|
||||
|
||||
$('.push-remove-device[data-uid="b"]').trigger('click');
|
||||
await settle();
|
||||
dialogButton('push_device_remove').trigger('click');
|
||||
await settle();
|
||||
expect($('.push-remove-device[data-uid="b"]')).toHaveLength(0);
|
||||
|
||||
releaseListing();
|
||||
await settle();
|
||||
expect($('.push-remove-device[data-uid="b"]')).toHaveLength(0);
|
||||
expect($('.push-device-card')).toHaveLength(1);
|
||||
});
|
||||
|
||||
it('removes another device with the server alone', async () => {
|
||||
const client = fakeClient({ permission: 'granted', registered: true, deviceUid: 'a' });
|
||||
pushClient.registerPushClient(client);
|
||||
|
||||
@@ -17,7 +17,7 @@
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
import { formatCount, formatCredits, formatDollarsFromMicrocents, usageIsCredits } from './credits.js';
|
||||
import { formatCredits, formatDollarsFromMicrocents, usageIsCredits } from './credits.js';
|
||||
import { isOrgSeat } from './orgSeat.js';
|
||||
import { addonCreditsRemaining, meterPercent, monthlyUsageOrThrow, usageBudget } from './usageBudget.js';
|
||||
import { getMonthlyUsage, getStorageSpace } from './usageRequests.js';
|
||||
@@ -281,7 +281,7 @@ function renderUsageTable () {
|
||||
for ( const row of rowsToShow ) {
|
||||
h += `
|
||||
<tr>
|
||||
<td title="${window.html_encode(row.resource.replaceAll('_dot_', '.'))}">${window.html_encode(row.resource.replaceAll('_dot_', '.'))}</td>
|
||||
<td>${window.html_encode(row.resource.replaceAll('_dot_', '.'))}</td>
|
||||
<td>${row.formattedUnits}</td>
|
||||
<td>${row.formattedCost}</td>
|
||||
</tr>`;
|
||||
@@ -351,7 +351,7 @@ async function update_usage_details ($el_window) {
|
||||
if ( key.endsWith(':bytes') ) {
|
||||
formattedUnits = window.byte_format(rawUnits);
|
||||
} else {
|
||||
formattedUnits = formatCount(rawUnits);
|
||||
formattedUnits = window.number_format(rawUnits, { decimals: 0, thousandSeparator: ',' });
|
||||
}
|
||||
|
||||
usageTableData.push({
|
||||
|
||||
@@ -548,13 +548,12 @@ async function UIDashboard (options) {
|
||||
const filePath = route.path;
|
||||
notifications.close({ restoreFocus: false });
|
||||
// What was open over the tab being left goes with it, as on a
|
||||
// sidebar click: the phone drawer, a menu, Files' Share and
|
||||
// sidebar click: the phone drawer, a menu, and Files' Share and
|
||||
// Properties, which act on its rows (their changes are already saved),
|
||||
// its image preview, and a dialog or the photo crop, each through its
|
||||
// own close button.
|
||||
// and its image preview.
|
||||
setMobileSidebar(false);
|
||||
$('.context-menu').remove();
|
||||
$el_window.find('.share-modal-close, .item-props-close, .dashboard-dialog-overlay .dashboard-dialog-close, .profile-crop-close').trigger('click');
|
||||
$el_window.find('.share-modal-close, .item-props-close').trigger('click');
|
||||
if ( tab !== 'files' && TabFiles.previewOpen ) TabFiles.closeImagePreview();
|
||||
|
||||
// Switch to correct tab
|
||||
|
||||
@@ -33,7 +33,6 @@ import { startPushWorker } from '../../helpers/pushWorker.js';
|
||||
import { syncBrowserPush } from '../../helpers/pushSync.js';
|
||||
import { get_app_by_uid } from '../../helpers/getAppByUid.js';
|
||||
import launch_app from '../../helpers/launchApp.js';
|
||||
import { runLimited } from '../../helpers/runLimited.js';
|
||||
import {
|
||||
badgeLabel,
|
||||
glyphKey,
|
||||
@@ -47,7 +46,6 @@ import {
|
||||
senderNameFor,
|
||||
setReadAt,
|
||||
takeMarksSince,
|
||||
titleBadge,
|
||||
titleWithBadge,
|
||||
toEntry,
|
||||
unreadCount,
|
||||
@@ -146,6 +144,27 @@ const whenFilesIdle = async (filesTab, timeoutMs = 4_000) => {
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Run `task` over `items`, at most `limit` at a time. Resolves to the items
|
||||
* whose task rejected.
|
||||
*/
|
||||
const runLimited = async (items, limit, task) => {
|
||||
const failed = [];
|
||||
let index = 0;
|
||||
const worker = async () => {
|
||||
while ( index < items.length ) {
|
||||
const item = items[index++];
|
||||
try {
|
||||
await task(item);
|
||||
} catch {
|
||||
failed.push(item);
|
||||
}
|
||||
}
|
||||
};
|
||||
await Promise.all(Array.from({ length: Math.min(limit, items.length) }, worker));
|
||||
return failed;
|
||||
};
|
||||
|
||||
/**
|
||||
* The dashboard's notification center: a bell in the sidebar with the unread
|
||||
* count, a panel listing the most recent notifications read or not, and
|
||||
@@ -341,26 +360,7 @@ export default function UIDashboardNotifications ({ $el_window, socket }) {
|
||||
target.focus({ preventScroll: true });
|
||||
};
|
||||
|
||||
// The badge last put in front of the title, the only prefix replaced.
|
||||
let appliedBadge = '';
|
||||
const applyTitleBadge = () => {
|
||||
const count = unreadCount(entries);
|
||||
const wanted = titleWithBadge(document.title, count, appliedBadge);
|
||||
appliedBadge = titleBadge(count);
|
||||
if ( document.title !== wanted ) document.title = wanted;
|
||||
};
|
||||
|
||||
// Changes made in other tabs arrive one socket event per notification
|
||||
// (Mark all read there sends one ack each), so they redraw once a beat.
|
||||
// Not a frame: a hidden tab's title still carries the count.
|
||||
let renderTimer = null;
|
||||
const scheduleRender = () => {
|
||||
renderTimer ??= setTimeout(render, 50);
|
||||
};
|
||||
|
||||
const render = () => {
|
||||
clearTimeout(renderTimer);
|
||||
renderTimer = null;
|
||||
const hadFocus = $panel[0].contains(document.activeElement);
|
||||
const count = unreadCount(entries);
|
||||
const label = badgeLabel(count);
|
||||
@@ -373,7 +373,7 @@ export default function UIDashboardNotifications ({ $el_window, socket }) {
|
||||
$sidebarToggle.toggleClass('has-unread', count > 0);
|
||||
$count.text(label);
|
||||
$markAll.attr('hidden', count > 0 ? null : '');
|
||||
applyTitleBadge();
|
||||
document.title = titleWithBadge(document.title, count);
|
||||
|
||||
const showLoading = ! loaded && loading !== null;
|
||||
const showError = ! loaded && loadFailed && loading === null;
|
||||
@@ -582,12 +582,9 @@ export default function UIDashboardNotifications ({ $el_window, socket }) {
|
||||
timeout: TOAST_TIMEOUT_MS,
|
||||
// With nothing to open on the dashboard, a click only dismisses;
|
||||
// it mustn't send the apps the user is working in away.
|
||||
// A regrouped notification rewrites the toast under the same uid,
|
||||
// so a click acts on what it says now.
|
||||
click: () => {
|
||||
const current = entries.find((e) => e.uid === entry.uid) ?? entry;
|
||||
if ( notificationTarget(current.notification) === null ) void markRead(current.uid);
|
||||
else void reveal_dashboard().then(() => actOn(current));
|
||||
if ( notificationTarget(notification) === null ) void markRead(entry.uid);
|
||||
else void reveal_dashboard().then(() => actOn(entry));
|
||||
},
|
||||
// The ✕ is a dismissal; timing out is not, so `close` alone acks.
|
||||
close: () => void markRead(entry.uid),
|
||||
@@ -801,8 +798,10 @@ export default function UIDashboardNotifications ({ $el_window, socket }) {
|
||||
// same title again is a no-op, so this can't loop.
|
||||
const titleEl = document.querySelector('title');
|
||||
if ( titleEl ) {
|
||||
new MutationObserver(applyTitleBadge)
|
||||
.observe(titleEl, { childList: true, characterData: true, subtree: true });
|
||||
new MutationObserver(() => {
|
||||
const wanted = titleWithBadge(document.title, unreadCount(entries));
|
||||
if ( document.title !== wanted ) document.title = wanted;
|
||||
}).observe(titleEl, { childList: true, characterData: true, subtree: true });
|
||||
}
|
||||
|
||||
// -- Arrivals -----------------------------------------------------------------
|
||||
@@ -841,7 +840,7 @@ export default function UIDashboardNotifications ({ $el_window, socket }) {
|
||||
acked.set(uid, now);
|
||||
if ( ! entries.some((e) => e.uid === uid && isUnread(e)) ) return;
|
||||
entries = setReadAt(entries, uid, now);
|
||||
scheduleRender();
|
||||
render();
|
||||
});
|
||||
// Removed in another tab. Not gated, for the same reason as the ack.
|
||||
socket.on('notif.removed', ({ uid }) => {
|
||||
@@ -849,7 +848,7 @@ export default function UIDashboardNotifications ({ $el_window, socket }) {
|
||||
removed.set(uid, Date.now());
|
||||
const listed = entries.some((e) => e.uid === uid);
|
||||
dropEntry(uid);
|
||||
if ( listed ) scheduleRender();
|
||||
if ( listed ) render();
|
||||
});
|
||||
// Every (re)connection: anything read elsewhere while this tab was
|
||||
// offline is marked so in the server's list, and anything new is in it.
|
||||
|
||||
@@ -291,24 +291,10 @@ export default function UIItemPropertiesModal ({ name, path: item_path, uid, $co
|
||||
const $link = $(this);
|
||||
if ( $link.prop('disabled') ) return;
|
||||
$link.prop('disabled', true);
|
||||
const subdomain = $link.attr('data-subdomain');
|
||||
puter.hosting.update(subdomain, null).then(() => {
|
||||
puter.hosting.update($link.attr('data-subdomain'), null).then(() => {
|
||||
const $entry = $link.closest('.item-props-website-entry');
|
||||
const $row = $entry.closest('.item-props-row');
|
||||
$entry.remove();
|
||||
// Rows inside the folder carry addresses under the site:
|
||||
// work them out again without it (another site may still
|
||||
// serve them).
|
||||
if ( Array.isArray(window.sites) ) {
|
||||
window.sites = window.sites.filter((site) => site.subdomain !== subdomain);
|
||||
}
|
||||
$('.item').each(function () {
|
||||
const path = this.dataset.path ?? '';
|
||||
if ( ! path.startsWith(`${item_path}/`) ) return;
|
||||
const url = window.determine_website_url?.(path) || '';
|
||||
$(this).attr('data-website_url', url)
|
||||
.find('.item-has-website-url-badge').css('display', url ? 'block' : 'none');
|
||||
});
|
||||
// The focused button just left the DOM; keep focus in the dialog.
|
||||
el_modal.focus({ preventScroll: true });
|
||||
if ( $row.find('.item-props-website-entry').length > 0 ) return;
|
||||
|
||||
@@ -68,40 +68,4 @@ describe('UIItemPropertiesModal', () => {
|
||||
expect(window.update_sites_cache).toHaveBeenCalled();
|
||||
expect(puter._cache.del).toHaveBeenCalledWith('readdir:/alice');
|
||||
});
|
||||
|
||||
it('takes the site address off rows inside the folder, keeping one another site serves', async () => {
|
||||
const fsentry = { uid: 'u1', name: 'site', path: '/alice/site', is_dir: true, has_website: true };
|
||||
$('<div class="item" data-uid="u1" data-has_website="1"><img class="item-has-website-badge"></div>')
|
||||
.data('fsentry', fsentry).appendTo('body');
|
||||
const child = (path, url) => $(`<div class="item" data-path="${path}" data-website_url="${url}"><img class="item-has-website-url-badge" style="display:block"></div>`).appendTo('body');
|
||||
const $inside = child('/alice/site/a.txt', 'https://mysite.puter.site/a.txt');
|
||||
const $nested = child('/alice/site/docs/b.txt', 'https://docs.puter.site/b.txt');
|
||||
const site = (subdomain, path) => ({ subdomain, root_dir: { path, subdomains: [{ subdomain, address: `https://${subdomain}.puter.site` }] } });
|
||||
window.sites = [site('mysite', '/alice/site'), site('docs', '/alice/site/docs')];
|
||||
window.determine_website_url = (path) => {
|
||||
const match = window.sites.find((s) => path.startsWith(`${s.root_dir.path}/`));
|
||||
return match ? `https://${match.subdomain}.puter.site${path.slice(match.root_dir.path.length)}` : null;
|
||||
};
|
||||
window.extractSubdomain = () => 'mysite';
|
||||
window.update_sites_cache = vi.fn();
|
||||
globalThis.puter = {
|
||||
fs: { stat: vi.fn(({ success }) => {
|
||||
success({ ...fsentry, id: 'u1', modified: 1700000000, created: 1700000000, subdomains: [{ uuid: 's1', address: 'https://mysite.puter.site' }] });
|
||||
return Promise.resolve();
|
||||
}) },
|
||||
hosting: { update: vi.fn(async () => ({})) },
|
||||
fsCacheKey: (kind, path) => `${kind}:${path}`,
|
||||
_cache: { del: vi.fn() },
|
||||
};
|
||||
|
||||
UIItemPropertiesModal({ name: 'site', path: '/alice/site', uid: 'u1' });
|
||||
await tick();
|
||||
$('.item-props-disassociate').trigger('click');
|
||||
await tick();
|
||||
|
||||
expect($inside.attr('data-website_url')).toBe('');
|
||||
expect($inside.find('.item-has-website-url-badge').css('display')).toBe('none');
|
||||
expect($nested.attr('data-website_url')).toBe('https://docs.puter.site/b.txt');
|
||||
expect($nested.find('.item-has-website-url-badge').css('display')).toBe('block');
|
||||
});
|
||||
});
|
||||
@@ -651,25 +651,17 @@ export default function UIShareModal ({ items, path: item_path, name, owner, fse
|
||||
// One request per run of MAX_ITEMS_PER_REQUEST, in series so a large
|
||||
// selection can't burst through the share rate limit. Resolves with every
|
||||
// grant that landed, the way a single call would.
|
||||
// A run that fails after others landed rejects with those grants on the
|
||||
// error as `landed`.
|
||||
const grant_access = async (recipient, mode, paths) => {
|
||||
const created = [];
|
||||
try {
|
||||
for ( const run of chunk(paths, MAX_ITEMS_PER_REQUEST) ) {
|
||||
created.push(...(await with_verification_gate(
|
||||
() => puter.fs.share({ paths: run, recipient, mode }),
|
||||
) ?? []));
|
||||
}
|
||||
} catch (err) {
|
||||
if ( created.length && err && typeof err === 'object' ) err.landed = created;
|
||||
throw err;
|
||||
} finally {
|
||||
// A selection too large to list again (see refresh) learns which
|
||||
// rows are now shared from the grants themselves.
|
||||
if ( total > MAX_ITEMS_PER_REQUEST ) {
|
||||
for ( const share of created ) mark_item_shared(share.path, true);
|
||||
}
|
||||
for ( const run of chunk(paths, MAX_ITEMS_PER_REQUEST) ) {
|
||||
created.push(...(await with_verification_gate(
|
||||
() => puter.fs.share({ paths: run, recipient, mode }),
|
||||
) ?? []));
|
||||
}
|
||||
// A selection too large to list again (see refresh) learns which rows
|
||||
// are now shared from the grants themselves.
|
||||
if ( total > MAX_ITEMS_PER_REQUEST ) {
|
||||
for ( const share of created ) mark_item_shared(share.path, true);
|
||||
}
|
||||
return created;
|
||||
};
|
||||
@@ -856,16 +848,8 @@ export default function UIShareModal ({ items, path: item_path, name, owner, fse
|
||||
if ( ! focus_moved_on() ) $recipient.get(0)?.focus({ preventScroll: true });
|
||||
} catch (err) {
|
||||
sharing = false;
|
||||
// Runs that landed before the failure are shared all the same.
|
||||
const landed = err?.landed?.length ?? 0;
|
||||
show_error(landed
|
||||
? `${i18n('share_shared_with_partial', { recipient, count: landed, total })}. ${error_html(err)}`
|
||||
: error_html(err));
|
||||
show_error(error_html(err));
|
||||
sync_add_actions();
|
||||
if ( landed ) {
|
||||
invalidate_shared_roots();
|
||||
await refresh();
|
||||
}
|
||||
// Disabling the clicked button dropped focus to <body>; put it
|
||||
// where the correction happens.
|
||||
$recipient.get(0)?.focus({ preventScroll: true });
|
||||
|
||||
@@ -226,28 +226,4 @@ describe('UIShareModal adding people', () => {
|
||||
await settle();
|
||||
expect($('.share-modal-submit').prop('disabled')).toBe(false);
|
||||
});
|
||||
|
||||
it('says how many items were shared when a later run fails, and badges those rows', async () => {
|
||||
const selection = Array.from({ length: 60 }, (_, i) => ({ path: `/alice/f${i}.txt` }));
|
||||
document.body.insertAdjacentHTML('beforeend', selection
|
||||
.map(item => `<div class="item" data-path="${item.path}" data-is_shared="0"></div>`).join(''));
|
||||
let call = 0;
|
||||
puter.fs.share = vi.fn(async ({ paths }) => {
|
||||
if ( ++call === 2 ) throw { message: 'Daily share limit reached', code: 'share_daily_limit_reached' };
|
||||
return paths.map(p => ({ path: p }));
|
||||
});
|
||||
UIShareModal({ items: selection });
|
||||
await settle();
|
||||
picked.recipient = { value: 'bob', label: 'bob' };
|
||||
picked.onChange();
|
||||
|
||||
$('.share-modal-add').trigger('submit');
|
||||
await settle();
|
||||
|
||||
expect(puter.fs.share).toHaveBeenCalledTimes(2);
|
||||
const status = $('.share-modal-status').text();
|
||||
expect(status).toContain('Shared with bob on 50 of 60 items');
|
||||
expect(status).toContain('Daily share limit reached');
|
||||
expect($('.item[data-is_shared="1"]')).toHaveLength(50);
|
||||
});
|
||||
});
|
||||
@@ -36,16 +36,6 @@ const numberFormat = (options) => {
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* A whole count (usage units) in the dashboard's language: "1,234,567" in
|
||||
* English, "1.234.567" in German.
|
||||
*
|
||||
* @param {number} count
|
||||
* @returns {string}
|
||||
*/
|
||||
export const formatCount = (count) =>
|
||||
numberFormat({ maximumFractionDigits: 0 }).format(Number.isFinite(count) ? count : 0);
|
||||
|
||||
/** Whether a `getMonthlyUsage()` response reports credits. */
|
||||
export const usageIsCredits = (allowanceInfo) =>
|
||||
allowanceInfo?.unit === 'credits';
|
||||
|
||||
@@ -19,7 +19,6 @@
|
||||
|
||||
import { describe, expect, it, beforeEach, afterEach } from 'vitest';
|
||||
import {
|
||||
formatCount,
|
||||
formatCredits,
|
||||
formatDollarsFromMicrocents,
|
||||
usageIsCredits,
|
||||
@@ -87,14 +86,6 @@ describe('amounts in the dashboard\'s language', () => {
|
||||
expect(formatCredits(2.5)).toBe('2,5');
|
||||
expect(formatCredits(0.001)).toBe('<0,01');
|
||||
expect(formatDollarsFromMicrocents(123_450_000_000).replace(/\s/g, ' ')).toBe('1.234,50 $');
|
||||
expect(formatCount(1234567)).toBe('1.234.567');
|
||||
});
|
||||
|
||||
it('counts usage units in English by default', () => {
|
||||
delete globalThis.window.locale;
|
||||
expect(formatCount(1234567)).toBe('1,234,567');
|
||||
expect(formatCount(12.6)).toBe('13');
|
||||
expect(formatCount(undefined)).toBe('0');
|
||||
});
|
||||
|
||||
it("reads Puter's codes that aren't BCP 47 tags", () => {
|
||||
|
||||
@@ -346,26 +346,20 @@ export const badgeLabel = (count) => {
|
||||
return count > 99 ? '99+' : String(count);
|
||||
};
|
||||
|
||||
/** What the unread count puts in front of the title: "(3) ", or nothing. */
|
||||
export const titleBadge = (count) => {
|
||||
const label = badgeLabel(count);
|
||||
return label ? `(${label}) ` : '';
|
||||
};
|
||||
const TITLE_BADGE = /^\((\d+\+?)\) /;
|
||||
|
||||
/**
|
||||
* The document title with the unread count in front. Only `applied`, the
|
||||
* badge this page last put there, is replaced, so repeated application never
|
||||
* stacks prefixes and an app's own "(3) Inbox" title keeps its count.
|
||||
* The document title with the unread count in front, replacing any count
|
||||
* already there so repeated application never stacks prefixes.
|
||||
*
|
||||
* @param {string} title
|
||||
* @param {number} count
|
||||
* @param {string} [applied]
|
||||
* @returns {string}
|
||||
*/
|
||||
export const titleWithBadge = (title, count, applied = '') => {
|
||||
let base = String(title ?? '');
|
||||
if ( applied && base.startsWith(applied) ) base = base.slice(applied.length);
|
||||
return titleBadge(count) + base;
|
||||
export const titleWithBadge = (title, count) => {
|
||||
const base = String(title ?? '').replace(TITLE_BADGE, '');
|
||||
const label = badgeLabel(count);
|
||||
return label ? `(${label}) ${base}` : base;
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -376,17 +370,16 @@ export const titleWithBadge = (title, count, applied = '') => {
|
||||
export const MAX_BURST_TOASTS = 3;
|
||||
|
||||
/**
|
||||
* Split a burst into the entries that get their own toast, newest first, and
|
||||
* the number that don't. Bursts arrive in either order (a catch-up listing is
|
||||
* oldest first), and the newest are the ones worth a toast.
|
||||
* Split a burst into the entries that get their own toast and the number
|
||||
* that don't.
|
||||
*
|
||||
* @param {NotificationEntry[]} entries
|
||||
* @param {NotificationEntry[]} entries - Newest first
|
||||
* @param {number} [max]
|
||||
* @returns {{ shown: NotificationEntry[], folded: number }}
|
||||
*/
|
||||
export const planBurstToasts = (entries, max = MAX_BURST_TOASTS) => {
|
||||
const newestFirst = sortEntries(entries);
|
||||
if ( entries.length <= max ) return { shown: entries, folded: 0 };
|
||||
// One over the cap is no quieter shown as a summary than as a toast.
|
||||
if ( newestFirst.length <= max + 1 ) return { shown: newestFirst, folded: 0 };
|
||||
return { shown: newestFirst.slice(0, max), folded: newestFirst.length - max };
|
||||
if ( entries.length === max + 1 ) return { shown: entries, folded: 0 };
|
||||
return { shown: entries.slice(0, max), folded: entries.length - max };
|
||||
};
|
||||
@@ -35,7 +35,6 @@ import {
|
||||
setReadAt,
|
||||
sortEntries,
|
||||
takeMarksSince,
|
||||
titleBadge,
|
||||
titleWithBadge,
|
||||
toEntry,
|
||||
unreadCount,
|
||||
@@ -425,24 +424,16 @@ describe('titleWithBadge', () => {
|
||||
expect(titleWithBadge('Puter', 3)).toBe('(3) Puter');
|
||||
});
|
||||
|
||||
it('replaces the count it put there instead of stacking', () => {
|
||||
expect(titleWithBadge('(2) Puter', 5, '(2) ')).toBe('(5) Puter');
|
||||
expect(titleWithBadge('(99+) Puter', 1, '(99+) ')).toBe('(1) Puter');
|
||||
it('replaces an existing count instead of stacking', () => {
|
||||
expect(titleWithBadge('(2) Puter', 5)).toBe('(5) Puter');
|
||||
expect(titleWithBadge('(99+) Puter', 1)).toBe('(1) Puter');
|
||||
});
|
||||
|
||||
it('clears the prefix at zero', () => {
|
||||
expect(titleWithBadge('(2) Puter', 0, '(2) ')).toBe('Puter');
|
||||
expect(titleWithBadge('(2) Puter', 0)).toBe('Puter');
|
||||
expect(titleWithBadge('Puter', 0)).toBe('Puter');
|
||||
});
|
||||
|
||||
it('leaves a count that is part of an app\'s own title alone', () => {
|
||||
expect(titleWithBadge('(3) Inbox', 0)).toBe('(3) Inbox');
|
||||
expect(titleWithBadge('(3) Inbox', 2)).toBe('(2) (3) Inbox');
|
||||
// The app rewrote the title after the badge was applied.
|
||||
expect(titleWithBadge('(3) Inbox', 2, '(2) ')).toBe('(2) (3) Inbox');
|
||||
expect(titleWithBadge('(2) (3) Inbox', 0, '(2) ')).toBe('(3) Inbox');
|
||||
});
|
||||
|
||||
it('leaves a parenthesised title that is not a badge alone', () => {
|
||||
expect(titleWithBadge('(draft) Notes', 0)).toBe('(draft) Notes');
|
||||
expect(titleWithBadge('(draft) Notes', 2)).toBe('(2) (draft) Notes');
|
||||
@@ -454,14 +445,6 @@ describe('titleWithBadge', () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe('titleBadge', () => {
|
||||
it('is the prefix a count puts in front of the title', () => {
|
||||
expect(titleBadge(3)).toBe('(3) ');
|
||||
expect(titleBadge(120)).toBe('(99+) ');
|
||||
expect(titleBadge(0)).toBe('');
|
||||
});
|
||||
});
|
||||
|
||||
describe('planBurstToasts', () => {
|
||||
const many = (n) => Array.from({ length: n }, (_, i) => entry(`n${i}`, NOW - i));
|
||||
|
||||
@@ -480,12 +463,6 @@ describe('planBurstToasts', () => {
|
||||
expect(shown.map((e) => e.uid)).toEqual(['n0', 'n1', 'n2']);
|
||||
expect(folded).toBe(9);
|
||||
});
|
||||
|
||||
it('toasts the newest of a burst that arrives oldest first', () => {
|
||||
const { shown, folded } = planBurstToasts(many(6).reverse());
|
||||
expect(shown.map((e) => e.uid)).toEqual(['n0', 'n1', 'n2']);
|
||||
expect(folded).toBe(3);
|
||||
});
|
||||
});
|
||||
|
||||
describe('senderNameFor', () => {
|
||||
|
||||
@@ -666,22 +666,22 @@ const UIWindow2FASetup = async function UIWindow2FASetup () {
|
||||
h += '<div class="tfa-progress" style="display:none;">';
|
||||
h += ' <div class="tfa-progress-step">';
|
||||
h += ' <div class="tfa-progress-dot active" data-step="1">1</div>';
|
||||
h += ` <span class="tfa-progress-label active">${i18n('setup2fa_step_scan')}</span>`;
|
||||
h += ' <span class="tfa-progress-label active">Scan</span>';
|
||||
h += ' </div>';
|
||||
h += ' <div class="tfa-progress-line"><div class="tfa-progress-line-fill"></div></div>';
|
||||
h += ' <div class="tfa-progress-step">';
|
||||
h += ' <div class="tfa-progress-dot" data-step="2">2</div>';
|
||||
h += ` <span class="tfa-progress-label">${i18n('setup2fa_step_backup')}</span>`;
|
||||
h += ' <span class="tfa-progress-label">Backup</span>';
|
||||
h += ' </div>';
|
||||
h += ' <div class="tfa-progress-line"><div class="tfa-progress-line-fill"></div></div>';
|
||||
h += ' <div class="tfa-progress-step">';
|
||||
h += ' <div class="tfa-progress-dot" data-step="3">3</div>';
|
||||
h += ` <span class="tfa-progress-label">${i18n('setup2fa_step_verify')}</span>`;
|
||||
h += ' <span class="tfa-progress-label">Verify</span>';
|
||||
h += ' </div>';
|
||||
h += ' <div class="tfa-progress-line"><div class="tfa-progress-line-fill"></div></div>';
|
||||
h += ' <div class="tfa-progress-step">';
|
||||
h += ` <div class="tfa-progress-dot" data-step="4">${SVG_CHECK}</div>`;
|
||||
h += ` <span class="tfa-progress-label">${i18n('done')}</span>`;
|
||||
h += ' <span class="tfa-progress-label">Done</span>';
|
||||
h += ' </div>';
|
||||
h += '</div>';
|
||||
|
||||
@@ -703,7 +703,7 @@ const UIWindow2FASetup = async function UIWindow2FASetup () {
|
||||
// Manual secret key, filled in once setup returns it
|
||||
h += '<div class="tfa-secret-row" style="display:none;">';
|
||||
h += ' <span class="tfa-secret-key"></span>';
|
||||
h += ` <button class="tfa-copy-secret" title="${i18n('setup2fa_copy_secret')}" aria-label="${i18n('setup2fa_copy_secret')}">${SVG_COPY}</button>`;
|
||||
h += ` <button class="tfa-copy-secret" title="Copy secret key">${SVG_COPY}</button>`;
|
||||
h += '</div>';
|
||||
|
||||
h += `<button class="tfa-btn tfa-btn-primary tfa-scan-continue-btn">${i18n('continue')}</button>`;
|
||||
@@ -747,7 +747,7 @@ const UIWindow2FASetup = async function UIWindow2FASetup () {
|
||||
}
|
||||
h += ' </div>';
|
||||
h += ' <div class="tfa-code-error"></div>';
|
||||
h += ` <div class="tfa-code-spinner"><div class="tfa-spinner-icon"></div><span>${i18n('setup2fa_enabling')}</span></div>`;
|
||||
h += ` <div class="tfa-code-spinner"><div class="tfa-spinner-icon"></div><span>Enabling...</span></div>`;
|
||||
h += '</div>';
|
||||
h += '</div>'; // end screen 3
|
||||
|
||||
@@ -755,8 +755,8 @@ const UIWindow2FASetup = async function UIWindow2FASetup () {
|
||||
h += '<div class="tfa-screen" data-screen="4">';
|
||||
h += `<div class="tfa-success-icon">${SVG_SHIELD_CHECK}</div>`;
|
||||
h += `<div class="tfa-success-title">${i18n('two_factor_enabled')}</div>`;
|
||||
h += `<p class="tfa-success-text">${i18n('setup2fa_success_text')}</p>`;
|
||||
h += `<button class="tfa-btn tfa-btn-success tfa-done-btn">${i18n('done')}</button>`;
|
||||
h += '<p class="tfa-success-text">Your account is now protected with two-factor authentication. You\'ll be asked for a verification code each time you sign in.</p>';
|
||||
h += `<button class="tfa-btn tfa-btn-success tfa-done-btn">Done</button>`;
|
||||
h += '</div>'; // end screen 4
|
||||
|
||||
h += '</div>'; // end tfa-setup
|
||||
@@ -1019,7 +1019,7 @@ const UIWindow2FASetup = async function UIWindow2FASetup () {
|
||||
navigator.clipboard.writeText(setup_data.codes.join('\n'));
|
||||
const $span = $(this).find('span');
|
||||
const orig = $span.text();
|
||||
$span.text(i18n('copied', [], false));
|
||||
$span.text('Copied!');
|
||||
$(this).addClass('copied');
|
||||
setTimeout(() => {
|
||||
$span.text(orig);
|
||||
@@ -1031,7 +1031,7 @@ const UIWindow2FASetup = async function UIWindow2FASetup () {
|
||||
const grid_html = $w.find('.tfa-codes-grid').get(0).outerHTML;
|
||||
const print_frame = $w.find('.tfa-print-frame').get(0);
|
||||
const style = '<style>body{font-family:monospace;padding:20px} .tfa-codes-grid{display:grid;grid-template-columns:1fr 1fr;gap:8px} .tfa-code-item{padding:8px;font-size:14px;display:flex;gap:8px} .tfa-code-item-idx{color:#999}</style>';
|
||||
print_frame.contentWindow.document.body.innerHTML = `${style}<h2>${i18n('setup2fa_recovery_codes')}</h2>${grid_html}`;
|
||||
print_frame.contentWindow.document.body.innerHTML = style + '<h2>Recovery Codes</h2>' + grid_html;
|
||||
print_frame.contentWindow.focus();
|
||||
print_frame.contentWindow.print();
|
||||
});
|
||||
|
||||
@@ -40,9 +40,7 @@ let feedback_modal_seq = 0;
|
||||
* server is the authority on the app's canonical title — then submits to
|
||||
* `POST /app-feedback`.
|
||||
*
|
||||
* @param {{ app?: string, origin?: string, source?: 'app' | 'web', fullpage?: boolean }} options
|
||||
* `fullpage` fills the viewport instead of floating over it, for a popup
|
||||
* window that exists only to host this dialog.
|
||||
* @param {{ app?: string, origin?: string, source?: 'app' | 'web' }} options
|
||||
* @returns {Promise<boolean>} true iff feedback was submitted successfully.
|
||||
* Resolves false on cancel/close/unavailable — never rejects, so IPC and
|
||||
* popup callers can always report an answer.
|
||||
@@ -73,7 +71,7 @@ async function UIWindowAppFeedback (options) {
|
||||
|
||||
const titleId = `${modal_id}-title`;
|
||||
const h = `
|
||||
<div class="app-feedback-overlay${options.fullpage ? ' app-feedback-fullpage' : ''}" role="dialog" aria-modal="true" aria-labelledby="${titleId}">
|
||||
<div class="app-feedback-overlay" role="dialog" aria-modal="true" aria-labelledby="${titleId}">
|
||||
<div class="app-feedback-modal" tabindex="-1">
|
||||
<div class="app-feedback-head">
|
||||
<h2 class="app-feedback-title" id="${titleId}">${i18n('app_feedback_title')}</h2>
|
||||
@@ -82,16 +80,16 @@ async function UIWindowAppFeedback (options) {
|
||||
</button>
|
||||
</div>
|
||||
<div class="app-feedback-body">
|
||||
<div class="app-feedback-pane app-feedback-loading">${i18n('loading')}…</div>
|
||||
<div class="app-feedback-loading">${i18n('loading')}…</div>
|
||||
|
||||
<div class="app-feedback-pane app-feedback-unavailable" style="display:none;">
|
||||
<div class="app-feedback-unavailable" style="display:none;">
|
||||
<p class="app-feedback-unavailable-message"></p>
|
||||
<div class="app-feedback-actions">
|
||||
<button type="button" class="app-feedback-btn app-feedback-btn-primary app-feedback-close-btn">${i18n('close')}</button>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="app-feedback-pane app-feedback-form" style="display:none;">
|
||||
<div class="app-feedback-form" style="display:none;">
|
||||
<div class="app-feedback-target">
|
||||
<div class="app-feedback-target-title"></div>
|
||||
<div class="app-feedback-target-name"></div>
|
||||
@@ -107,7 +105,7 @@ async function UIWindowAppFeedback (options) {
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="app-feedback-pane app-feedback-success" style="display:none;">
|
||||
<div class="app-feedback-success" style="display:none;">
|
||||
<div class="app-feedback-success-check" aria-hidden="true">
|
||||
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2.4" stroke-linecap="round" stroke-linejoin="round"><path d="M20 6 9 17l-5-5"/></svg>
|
||||
</div>
|
||||
|
||||
@@ -1,68 +0,0 @@
|
||||
/*
|
||||
* Copyright (C) 2024-present Puter Technologies Inc.
|
||||
*
|
||||
* This file is part of Puter.
|
||||
*
|
||||
* Puter is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published
|
||||
* by the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
// @vitest-environment jsdom
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
||||
import jQuery from '../lib/jquery-3.6.1/jquery-3.6.1.min.js';
|
||||
|
||||
const { default: UIWindowAppFeedback } = await import('./UIWindowAppFeedback.js');
|
||||
|
||||
const flush = () => new Promise((r) => setTimeout(r, 0));
|
||||
const $ = (sel) => jQuery(sel);
|
||||
const visiblePanes = () => $('.app-feedback-pane').filter((_, el) => el.style.display !== 'none');
|
||||
|
||||
/** Opens the dialog against an app that accepts feedback and waits for the form. */
|
||||
const open = async (options) => {
|
||||
globalThis.fetch = vi.fn(async () => new Response(JSON.stringify({
|
||||
enabled: true,
|
||||
app: { title: 'Build with AI', name: 'builder' },
|
||||
}), { status: 200, headers: { 'Content-Type': 'application/json' } }));
|
||||
UIWindowAppFeedback({ origin: 'https://builder.puter.test', source: 'web', ...options });
|
||||
await flush();
|
||||
await flush();
|
||||
};
|
||||
|
||||
beforeEach(() => {
|
||||
document.body.innerHTML = '';
|
||||
globalThis.$ = jQuery;
|
||||
globalThis.i18n = (key) => key;
|
||||
globalThis.html_encode = (value) => jQuery('<div>').text(value).html();
|
||||
window.api_origin = 'https://api.puter.test';
|
||||
window.auth_token = 'token';
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
$(document).off('keydown');
|
||||
});
|
||||
|
||||
describe('UIWindowAppFeedback', () => {
|
||||
it('floats over the page by default', async () => {
|
||||
await open();
|
||||
expect($('.app-feedback-overlay').hasClass('app-feedback-fullpage')).toBe(false);
|
||||
expect(visiblePanes().hasClass('app-feedback-form')).toBe(true);
|
||||
});
|
||||
|
||||
it('fills the page when hosted in its own popup', async () => {
|
||||
await open({ fullpage: true });
|
||||
expect($('.app-feedback-overlay').hasClass('app-feedback-fullpage')).toBe(true);
|
||||
expect(visiblePanes()).toHaveLength(1);
|
||||
expect(visiblePanes().hasClass('app-feedback-form')).toBe(true);
|
||||
expect($('.app-feedback-target-title').text()).toBe('Build with AI');
|
||||
});
|
||||
});
|
||||
@@ -83,7 +83,7 @@ async function UIWindowAttachCustomDomain (options) {
|
||||
const titleId = `${modal_id}-title`;
|
||||
const closeLabel = html_encode(i18n('close'));
|
||||
const h = `
|
||||
<div class="app-feedback-overlay custom-domain-overlay${options.fullpage ? ' app-feedback-fullpage' : ''}" role="dialog" aria-modal="true" aria-labelledby="${titleId}">
|
||||
<div class="app-feedback-overlay custom-domain-overlay${options.fullpage ? ' custom-domain-fullpage' : ''}" role="dialog" aria-modal="true" aria-labelledby="${titleId}">
|
||||
<div class="app-feedback-modal custom-domain-modal" tabindex="-1">
|
||||
<div class="app-feedback-head custom-domain-head">
|
||||
<div class="custom-domain-head-icon">${ICON_GLOBE}</div>
|
||||
@@ -95,13 +95,13 @@ async function UIWindowAttachCustomDomain (options) {
|
||||
<button type="button" class="app-feedback-x" aria-label="${closeLabel}" title="${closeLabel}">${ICON_X}</button>
|
||||
</div>
|
||||
<div class="app-feedback-body custom-domain-body">
|
||||
<div class="app-feedback-pane custom-domain-pane" data-pane="loading" aria-busy="true">
|
||||
<div class="custom-domain-pane" data-pane="loading" aria-busy="true">
|
||||
<span class="custom-domain-sr">${i18n('loading')}…</span>
|
||||
<div class="custom-domain-skeleton"><span></span><span></span></div>
|
||||
<div class="custom-domain-skeleton"><span></span><span></span></div>
|
||||
</div>
|
||||
|
||||
<div class="app-feedback-pane custom-domain-pane custom-domain-state" data-pane="unavailable" style="display:none;">
|
||||
<div class="custom-domain-pane custom-domain-state" data-pane="unavailable" style="display:none;">
|
||||
<div class="custom-domain-state-icon">${ICON_ALERT}</div>
|
||||
<p class="app-feedback-unavailable-message"></p>
|
||||
<div class="app-feedback-actions">
|
||||
@@ -109,7 +109,7 @@ async function UIWindowAttachCustomDomain (options) {
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="app-feedback-pane custom-domain-pane" data-pane="list" style="display:none;">
|
||||
<div class="custom-domain-pane" data-pane="list" style="display:none;">
|
||||
<ul class="custom-domain-list"></ul>
|
||||
<div class="custom-domain-state custom-domain-empty" style="display:none;">
|
||||
<div class="custom-domain-state-icon">${ICON_GLOBE}</div>
|
||||
@@ -124,7 +124,7 @@ async function UIWindowAttachCustomDomain (options) {
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<form class="app-feedback-pane custom-domain-pane" data-pane="add" style="display:none;" novalidate>
|
||||
<form class="custom-domain-pane" data-pane="add" style="display:none;" novalidate>
|
||||
<label class="custom-domain-label" for="${modal_id}-hostname">${i18n('custom_domain_hostname_label')}</label>
|
||||
<div class="custom-domain-field">
|
||||
${ICON_GLOBE}
|
||||
@@ -143,7 +143,7 @@ async function UIWindowAttachCustomDomain (options) {
|
||||
</div>
|
||||
</form>
|
||||
|
||||
<div class="app-feedback-pane custom-domain-pane" data-pane="records" style="display:none;">
|
||||
<div class="custom-domain-pane" data-pane="records" style="display:none;">
|
||||
<div class="custom-domain-status-card">
|
||||
<div class="custom-domain-status-icon"></div>
|
||||
<div class="custom-domain-status-main">
|
||||
@@ -165,7 +165,7 @@ async function UIWindowAttachCustomDomain (options) {
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="app-feedback-pane custom-domain-pane app-feedback-success custom-domain-success" data-pane="success" role="status" style="display:none;">
|
||||
<div class="custom-domain-pane app-feedback-success custom-domain-success" data-pane="success" role="status" style="display:none;">
|
||||
<div class="app-feedback-success-check">${ICON_CHECK}</div>
|
||||
<p class="app-feedback-success-text custom-domain-success-text"></p>
|
||||
<p class="app-feedback-note custom-domain-success-note"></p>
|
||||
|
||||
@@ -2739,17 +2739,15 @@ input.myapps-group-name:focus {
|
||||
}
|
||||
}
|
||||
|
||||
/* In a popup that exists only to host one of these dialogs, the dialog is the
|
||||
page: a centered column, with the actions pinned to the bottom edge. */
|
||||
.app-feedback-fullpage {
|
||||
--afb-column: min(552px, 100% - 48px);
|
||||
/* In a popup that exists only for this dialog, the dialog is the page: a
|
||||
centered column, with the actions pinned to the bottom edge. */
|
||||
.custom-domain-fullpage {
|
||||
--cd-column: min(552px, 100% - 48px);
|
||||
padding: 0;
|
||||
align-items: stretch;
|
||||
background: var(--afb-bg);
|
||||
}
|
||||
.app-feedback-fullpage .app-feedback-modal {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
.custom-domain-fullpage .custom-domain-modal {
|
||||
width: 100%;
|
||||
height: 100dvh;
|
||||
max-height: none;
|
||||
@@ -2760,39 +2758,39 @@ input.myapps-group-name:focus {
|
||||
padding-bottom: 0;
|
||||
overflow: hidden;
|
||||
}
|
||||
.app-feedback-fullpage .app-feedback-x {
|
||||
.custom-domain-fullpage .app-feedback-x {
|
||||
display: none;
|
||||
}
|
||||
.app-feedback-fullpage .app-feedback-head {
|
||||
width: var(--afb-column);
|
||||
.custom-domain-fullpage .custom-domain-head {
|
||||
width: var(--cd-column);
|
||||
margin: 0 auto;
|
||||
padding: 28px 0 4px;
|
||||
}
|
||||
.app-feedback-fullpage .app-feedback-body {
|
||||
.custom-domain-fullpage .custom-domain-body {
|
||||
flex: 1;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
overflow-y: auto;
|
||||
padding: 20px 0 0;
|
||||
}
|
||||
.app-feedback-fullpage .app-feedback-pane {
|
||||
.custom-domain-fullpage .custom-domain-pane {
|
||||
flex: 1 0 auto;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
}
|
||||
.app-feedback-fullpage .app-feedback-pane > :not(.app-feedback-actions, .app-feedback-success-check, .custom-domain-state-icon) {
|
||||
.custom-domain-fullpage .custom-domain-pane > :not(.app-feedback-actions, .app-feedback-success-check, .custom-domain-state-icon) {
|
||||
box-sizing: border-box;
|
||||
width: var(--afb-column);
|
||||
width: var(--cd-column);
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
/* Keeps the actions off the content when it fills the page. */
|
||||
.app-feedback-fullpage .app-feedback-pane::after {
|
||||
.custom-domain-fullpage .custom-domain-pane::after {
|
||||
content: '';
|
||||
flex: 1 0 20px;
|
||||
order: 1;
|
||||
}
|
||||
.app-feedback-fullpage .app-feedback-actions {
|
||||
.custom-domain-fullpage .app-feedback-actions {
|
||||
order: 2;
|
||||
position: sticky;
|
||||
bottom: 0;
|
||||
@@ -2801,18 +2799,9 @@ input.myapps-group-name:focus {
|
||||
background: var(--afb-bg);
|
||||
border-top: 1px solid var(--afb-border);
|
||||
}
|
||||
.app-feedback-fullpage .app-feedback-unavailable .app-feedback-actions,
|
||||
.app-feedback-fullpage .custom-domain-state .app-feedback-actions {
|
||||
.custom-domain-fullpage .custom-domain-state .app-feedback-actions {
|
||||
justify-content: center;
|
||||
}
|
||||
/* The message box takes the spare height instead of the spacer. */
|
||||
.app-feedback-fullpage .app-feedback-form::after {
|
||||
flex-grow: 0;
|
||||
}
|
||||
.app-feedback-fullpage .app-feedback-message {
|
||||
flex: 1 0 160px;
|
||||
resize: none;
|
||||
}
|
||||
|
||||
/* Add-an-app chooser (see showAddAppModal): the three ways to get an app, as
|
||||
rows in the same modal shell. min-width gives the two-line rows room without
|
||||
@@ -5257,9 +5246,7 @@ body.myapps-reordering .myapps-tile {
|
||||
min-height: 0;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
/* Ends above the footer, not under it, so a drop outline drawn on its
|
||||
edge shows all the way round. */
|
||||
margin-bottom: 30px;
|
||||
padding-bottom: 30px;
|
||||
overflow-y: auto;
|
||||
touch-action: pan-y;
|
||||
}
|
||||
@@ -7039,7 +7026,7 @@ body.myapps-reordering .myapps-tile {
|
||||
}
|
||||
|
||||
.dashboard-section-files .files {
|
||||
margin-bottom: calc(30px + env(safe-area-inset-bottom, 0px));
|
||||
padding-bottom: calc(30px + env(safe-area-inset-bottom, 0px));
|
||||
}
|
||||
|
||||
/* The grids keep their own padding and clear the footer with a margin,
|
||||
|
||||
@@ -140,21 +140,6 @@ body {
|
||||
background-color: #ccccccbe !important;
|
||||
}
|
||||
|
||||
/* A popup framed over its whole page, such as the upgrade, shows the page
|
||||
around its own dialog. The root's color scheme matches the frame's, or the
|
||||
browser paints the frame opaque; the GUI inside keeps the light scheme it
|
||||
has everywhere else, so its form fields don't turn dark. */
|
||||
html.popup-frame-transparent,
|
||||
html.popup-frame-transparent body {
|
||||
background: transparent !important;
|
||||
}
|
||||
html.popup-frame-transparent {
|
||||
color-scheme: light dark;
|
||||
}
|
||||
html.popup-frame-transparent body {
|
||||
color-scheme: light;
|
||||
}
|
||||
|
||||
.disable-user-select {
|
||||
cursor: default;
|
||||
-webkit-touch-callout: none !important;
|
||||
@@ -1507,18 +1492,6 @@ span.header-sort-icon img {
|
||||
align-items: center;
|
||||
}
|
||||
|
||||
/* The file name shrinks so the buttons stay on one line, on screen, in a narrow dialog. */
|
||||
.window-filedialog-prompt > div {
|
||||
min-width: 0;
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
@media (max-width: 480px) {
|
||||
.window-filedialog-prompt .button-small {
|
||||
padding: 0 16px;
|
||||
}
|
||||
}
|
||||
|
||||
.savefiledialog-filename {
|
||||
float: left;
|
||||
margin-right: 10px;
|
||||
@@ -1526,21 +1499,10 @@ span.header-sort-icon img {
|
||||
border-width: 1px !important;
|
||||
height: 31px;
|
||||
flex-grow: 1;
|
||||
min-width: 0;
|
||||
width: initial !important;
|
||||
}
|
||||
|
||||
/* In a narrow open dialog, the upload label gives way so its buttons stay whole. */
|
||||
.window-filedialog-upload-here + div {
|
||||
flex-shrink: 0;
|
||||
}
|
||||
|
||||
.window-filedialog-upload-here {
|
||||
min-width: 0;
|
||||
margin-right: 10px;
|
||||
overflow: hidden;
|
||||
text-overflow: ellipsis;
|
||||
white-space: nowrap;
|
||||
-webkit-font-smoothing: antialiased;
|
||||
opacity: 0.7;
|
||||
font-size: 14px;
|
||||
@@ -5221,16 +5183,11 @@ html.dark-mode .usage-table-fade-overlay {
|
||||
}
|
||||
|
||||
/* On a phone, units and cost keep every digit; the resource name is the
|
||||
column that gives way, wrapping rather than cut off, since a touch screen
|
||||
has no hover to show the rest. */
|
||||
column that gives way. */
|
||||
@media (max-width: 480px) {
|
||||
.dashboard-section-usage .driver-usage-details-content-table td:not(:first-child) {
|
||||
max-width: none;
|
||||
}
|
||||
.dashboard-section-usage .driver-usage-details-content-table td:first-child {
|
||||
white-space: normal;
|
||||
overflow-wrap: anywhere;
|
||||
}
|
||||
}
|
||||
.version {
|
||||
font-size: 9px;
|
||||
|
||||
@@ -224,11 +224,10 @@ window.suggest_apps_for_fsentry = async (options) => {
|
||||
*/
|
||||
window.byte_format = (bytes) => {
|
||||
const sizes = ['Bytes', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB'];
|
||||
if ( bytes === 0 ) return '0 Byte';
|
||||
let i = parseInt(Math.floor(Math.log(bytes) / Math.log(1024)));
|
||||
if ( ! (i > 0) ) i = 0;
|
||||
if ( i < 0 ) i = 0;
|
||||
if ( i >= sizes.length ) i = sizes.length - 1;
|
||||
// Whole bytes have no fraction: "0 Bytes", "1 Byte", "512 Bytes".
|
||||
if ( i === 0 ) return `${bytes} ${bytes === 1 ? 'Byte' : 'Bytes'}`;
|
||||
return `${(bytes / Math.pow(1024, i)).toFixed(2) } ${ sizes[i]}`;
|
||||
};
|
||||
|
||||
|
||||
@@ -1,354 +0,0 @@
|
||||
/*
|
||||
* Copyright (C) 2024-present Puter Technologies Inc.
|
||||
*
|
||||
* This file is part of Puter.
|
||||
*
|
||||
* Puter is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published
|
||||
* by the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
/**
|
||||
* A GUI popup that a first-party page shows in a frame instead of a window,
|
||||
* served at `/embed/<action>`. It runs the popup boot unchanged: the framing
|
||||
* page stands in for `window.opener`, and closing asks it to remove the frame.
|
||||
*/
|
||||
|
||||
/** Popup actions a first-party page can frame. */
|
||||
export const FRAMED_POPUP_ACTIONS = new Set([
|
||||
'sign-in',
|
||||
'show-open-file-picker',
|
||||
'show-save-file-picker',
|
||||
'show-directory-picker',
|
||||
'upgrade',
|
||||
]);
|
||||
|
||||
// Actions a frame shows only for the user the framing page is signed in as.
|
||||
const HOST_USER_ACTIONS = new Set([
|
||||
'show-open-file-picker',
|
||||
'show-save-file-picker',
|
||||
'show-directory-picker',
|
||||
'upgrade',
|
||||
]);
|
||||
|
||||
// Actions framed over the whole page with no box, which their own dialog's
|
||||
// scrim covers.
|
||||
const TRANSPARENT_ACTIONS = new Set(['upgrade']);
|
||||
|
||||
const UPGRADE_REASONS = new Set(['funds', 'subscription', 'storage']);
|
||||
const UPGRADE_METHOD_MAX = 200;
|
||||
|
||||
// Modal UI the upgrade dialog and the GUI's windows show. Once some has shown
|
||||
// and all of it has been gone this long, the dialog closed without reporting
|
||||
// it, and the frame mustn't be left covering the page.
|
||||
const UPGRADE_MODAL_UI = '.window, [aria-modal="true"]';
|
||||
const UPGRADE_GONE_MS = 500;
|
||||
// How long a hidden frame waits for the page to show it before opening anyway.
|
||||
const FRAME_SIZE_TIMEOUT_MS = 1000;
|
||||
// A focus() the frame ignored is retried this often, this many times.
|
||||
const FOCUS_RETRY_MS = 50;
|
||||
const FOCUS_RETRIES = 20;
|
||||
|
||||
/** Lifecycle messages to the framing page carry this as `msg`. */
|
||||
export const POPUP_FRAME_MSG = 'puterPopupFrame';
|
||||
|
||||
// The popup's query parameters a framing page may pass, in the fragment.
|
||||
const FRAGMENT_PARAMS = ['msg_id', 'options', 'request_auth'];
|
||||
|
||||
// The account checks a sign-in can show (email, phone, card), which are
|
||||
// windows rather than auth screens.
|
||||
const ACCOUNT_CHECK_WINDOWS = '.window-confirm-email-using-code, .window-confirm-phone-using-code, .window-card-verification';
|
||||
|
||||
// What a framed popup shows first; until one is on the page the framing page
|
||||
// keeps the frame hidden behind its loading scrim.
|
||||
const VISIBLE_UI = '.window, .dashboard-dialog-overlay, .captcha-modal';
|
||||
|
||||
/**
|
||||
* The action a `/embed/<action>` path frames, or null for any other path.
|
||||
*
|
||||
* @param {string} pathname
|
||||
* @returns {string | null}
|
||||
*/
|
||||
export const framedPopupAction = (pathname) => {
|
||||
const match = /^\/embed\/([a-z-]+)\/?$/.exec(String(pathname ?? ''));
|
||||
return match && FRAMED_POPUP_ACTIONS.has(match[1]) ? match[1] : null;
|
||||
};
|
||||
|
||||
/**
|
||||
* Whether a framed `action` serves only the framing page's own user, named in
|
||||
* the fragment as `user`.
|
||||
*
|
||||
* @param {string | null | undefined} action
|
||||
* @returns {boolean}
|
||||
*/
|
||||
export const framesHostUser = (action) => HOST_USER_ACTIONS.has(action);
|
||||
|
||||
/**
|
||||
* Whether a framed `action` lets the framing page show through around its
|
||||
* dialog.
|
||||
*
|
||||
* @param {string | null | undefined} action
|
||||
* @returns {boolean}
|
||||
*/
|
||||
export const isTransparentPopupFrame = (action) => TRANSPARENT_ACTIONS.has(action);
|
||||
|
||||
/**
|
||||
* The popup parameters the framing page put in the fragment, and no others.
|
||||
* The route refuses a query string, so nothing else reaches the boot.
|
||||
*
|
||||
* @param {string} hash - `location.hash`
|
||||
* @returns {URLSearchParams}
|
||||
*/
|
||||
export const framedPopupParams = (hash) => {
|
||||
const given = new URLSearchParams(String(hash ?? '').replace(/^#/, ''));
|
||||
const params = new URLSearchParams();
|
||||
for ( const key of FRAGMENT_PARAMS ) {
|
||||
if ( given.has(key) ) params.set(key, given.get(key));
|
||||
}
|
||||
return params;
|
||||
};
|
||||
|
||||
/**
|
||||
* Starts a framed popup in `win`: the framing page, at the origin the server
|
||||
* pinned with frame-ancestors, becomes `opener`, `close()` asks it to remove
|
||||
* the frame, and it hears `ready` once the popup shows something. Returns a
|
||||
* function that sends it a lifecycle state, with any fields that go with it,
|
||||
* or null when there is no framing page to answer (opened on its own, or
|
||||
* framed by a page the server refused).
|
||||
*
|
||||
* @param {Window} win
|
||||
* @param {string | null | undefined} hostOrigin - `gui_params.embed_host_origin`
|
||||
* @returns {((state: 'loading' | 'ready' | 'unavailable' | 'closed' | 'provider', fields?: Record<string, unknown>) => void) | null}
|
||||
*/
|
||||
export const startPopupFrame = (win, hostOrigin) => {
|
||||
if ( ! hostOrigin || win.parent === win ) return null;
|
||||
const parent = win.parent;
|
||||
if ( isTransparentPopupFrame(framedPopupAction(win.location?.pathname)) ) {
|
||||
win.document.documentElement.classList.add('popup-frame-transparent');
|
||||
}
|
||||
const tell = (state, fields = {}) =>
|
||||
parent.postMessage({ ...fields, msg: POPUP_FRAME_MSG, state }, hostOrigin);
|
||||
|
||||
win.opener = parent;
|
||||
win.close = () => tell('closed');
|
||||
// The popup closes with `window.open('', '_self').close()` as well, which
|
||||
// must reach the `close` above rather than navigate the frame.
|
||||
const open = win.open.bind(win);
|
||||
win.open = (url, target, ...rest) =>
|
||||
url === '' && target === '_self' ? win : open(url, target, ...rest);
|
||||
|
||||
const announceReady = () => {
|
||||
if ( ! win.document.querySelector(VISIBLE_UI) ) return false;
|
||||
tell('ready');
|
||||
return true;
|
||||
};
|
||||
const observer = new win.MutationObserver(() => {
|
||||
if ( announceReady() ) observer.disconnect();
|
||||
});
|
||||
observer.observe(win.document.body, { childList: true, subtree: true });
|
||||
|
||||
tell('loading');
|
||||
return tell;
|
||||
};
|
||||
|
||||
/**
|
||||
* Gives a framed popup's latest focus() back whenever the frame gains focus
|
||||
* with nothing focused, until the user presses a key or the pointer in it. A
|
||||
* cross-origin frame can't take focus until the framing page focuses it, which
|
||||
* also resets it, so a save picker's file name would start unfocused.
|
||||
* Firefox and WebKit also ignore a focus() for a moment after the page shows
|
||||
* the frame, without a `focus` event after it, so one that didn't take is
|
||||
* retried for a while.
|
||||
*
|
||||
* @param {Window} win
|
||||
*/
|
||||
export const focusOnFrameFocus = (win) => {
|
||||
const focus = win.HTMLElement.prototype.focus;
|
||||
let latest = null;
|
||||
let retryTimer = null;
|
||||
let retries = 0;
|
||||
// Whether the latest focus() still needs giving back.
|
||||
const pending = () => {
|
||||
const active = win.document.activeElement;
|
||||
return !!latest?.el.isConnected && (!active || active === win.document.body);
|
||||
};
|
||||
const giveBack = () => {
|
||||
if ( pending() ) focus.apply(latest.el, latest.args);
|
||||
};
|
||||
const retry = () => {
|
||||
retryTimer = null;
|
||||
giveBack();
|
||||
if ( pending() && ++retries < FOCUS_RETRIES ) retryTimer = setTimeout(retry, FOCUS_RETRY_MS);
|
||||
};
|
||||
win.HTMLElement.prototype.focus = function (...args) {
|
||||
latest = { el: this, args };
|
||||
const result = focus.apply(this, args);
|
||||
clearTimeout(retryTimer);
|
||||
retryTimer = null;
|
||||
retries = 0;
|
||||
if ( pending() ) retryTimer = setTimeout(retry, FOCUS_RETRY_MS);
|
||||
return result;
|
||||
};
|
||||
const forget = () => {
|
||||
latest = null;
|
||||
clearTimeout(retryTimer);
|
||||
retryTimer = null;
|
||||
win.HTMLElement.prototype.focus = focus;
|
||||
};
|
||||
win.addEventListener('pointerdown', forget, { capture: true, once: true });
|
||||
win.addEventListener('keydown', forget, { capture: true, once: true });
|
||||
win.addEventListener('focus', giveBack);
|
||||
};
|
||||
|
||||
/**
|
||||
* Closes a framed sign-in on Escape in one of its account checks, as Escape
|
||||
* on its auth screens does. Those screens handle Escape themselves; the
|
||||
* account checks are windows, which don't.
|
||||
*
|
||||
* @param {Window} win
|
||||
*/
|
||||
export const closeAccountChecksOnEscape = (win) => {
|
||||
win.document.addEventListener('keydown', (e) => {
|
||||
// Safari sends the Escape that ends an IME conversion as keyCode 229
|
||||
// with isComposing false.
|
||||
if ( e.key !== 'Escape' || e.defaultPrevented || e.isComposing || e.keyCode === 229 ) return;
|
||||
const el = e.target === win.document.body ? win.document.querySelector('.window-active') : e.target;
|
||||
if ( el?.closest?.(ACCOUNT_CHECK_WINDOWS) ) win.close();
|
||||
});
|
||||
};
|
||||
|
||||
/**
|
||||
* Whether a framed upgrade can show for the GUI session `session` (its
|
||||
* `/whoami`): the deployment has an upgrade dialog that reports when it
|
||||
* closes, and no account check is waiting, which a frame couldn't be closed
|
||||
* from.
|
||||
*
|
||||
* @param {Window} win
|
||||
* @param {Record<string, unknown> | null} session
|
||||
* @returns {boolean}
|
||||
*/
|
||||
export const canShowUpgradeFrame = (win, session) =>
|
||||
win.UIUpgradeAccount?.embeddable === true &&
|
||||
!!session &&
|
||||
!session.requires_email_confirmation &&
|
||||
!session.requires_phone_verification &&
|
||||
!session.requires_card_verification &&
|
||||
!session.requires_password_change;
|
||||
|
||||
/**
|
||||
* What prompted a framed upgrade, from its `reason` and `method` fragment
|
||||
* parameters, keeping only well-formed values.
|
||||
*
|
||||
* @param {string} hash - `location.hash`
|
||||
* @returns {{ reason?: string, method?: string }}
|
||||
*/
|
||||
export const framedUpgradeDetails = (hash) => {
|
||||
const given = new URLSearchParams(String(hash ?? '').replace(/^#/, ''));
|
||||
const details = {};
|
||||
const reason = given.get('reason');
|
||||
if ( UPGRADE_REASONS.has(reason) ) details.reason = reason;
|
||||
const method = given.get('method');
|
||||
if ( method && method.length <= UPGRADE_METHOD_MAX ) details.method = method;
|
||||
return details;
|
||||
};
|
||||
|
||||
/**
|
||||
* Shows the deployment's upgrade dialog in a framed popup and tells the
|
||||
* framing page it's ready once it's open, or before it opens when the page
|
||||
* still hides the frame. Resolves whether the user upgraded,
|
||||
* once the dialog closes, or false once every dialog and window it showed has
|
||||
* gone without it reporting a close.
|
||||
*
|
||||
* @param {Window} win
|
||||
* @param {{ appUid?: string, reason?: string, method?: string }} attribution - what prompted it;
|
||||
* an empty one is passed as null, so the dialog credits the prompt it remembers
|
||||
* @param {(state: 'ready') => void} tell
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
export const showFramedUpgrade = (win, attribution, tell) => new Promise((resolve, reject) => {
|
||||
let settled = false;
|
||||
let seen = false;
|
||||
let goneTimer = null;
|
||||
const settle = (finish) => {
|
||||
if ( settled ) return;
|
||||
settled = true;
|
||||
observer.disconnect();
|
||||
clearTimeout(goneTimer);
|
||||
finish();
|
||||
};
|
||||
const shown = () => !!win.document.querySelector(UPGRADE_MODAL_UI);
|
||||
const check = () => {
|
||||
if ( shown() ) {
|
||||
seen = true;
|
||||
clearTimeout(goneTimer);
|
||||
goneTimer = null;
|
||||
} else if ( seen && ! goneTimer ) {
|
||||
goneTimer = setTimeout(() => {
|
||||
goneTimer = null;
|
||||
if ( ! shown() ) settle(() => resolve(false));
|
||||
}, UPGRADE_GONE_MS);
|
||||
}
|
||||
};
|
||||
const observer = new win.MutationObserver(check);
|
||||
observer.observe(win.document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['aria-modal'] });
|
||||
|
||||
let toldReady = false;
|
||||
const ready = () => {
|
||||
if ( toldReady || settled ) return;
|
||||
toldReady = true;
|
||||
tell('ready');
|
||||
};
|
||||
const open = () => {
|
||||
const dialog = new win.UIUpgradeAccount({
|
||||
attribution: Object.keys(attribution).length ? attribution : null,
|
||||
onClose: (result) => settle(() => resolve(result?.upgraded === true)),
|
||||
});
|
||||
return dialog.open_as_window();
|
||||
};
|
||||
whenFrameSized(win, ready)
|
||||
.then(open)
|
||||
.then(() => {
|
||||
check();
|
||||
ready();
|
||||
}, (e) => settle(() => reject(e)));
|
||||
});
|
||||
|
||||
/**
|
||||
* Resolves once the frame has a viewport. The page keeps a loading frame
|
||||
* hidden, which Chromium and WebKit lay out at 0x0, and a GUI window opened
|
||||
* then (such as an alert) centers itself on that. Without one, `reveal` asks
|
||||
* the page to show the frame first.
|
||||
*
|
||||
* @param {Window} win
|
||||
* @param {() => void} reveal
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
const whenFrameSized = (win, reveal) => new Promise((resolve) => {
|
||||
const sized = () => win.innerWidth > 0 && win.innerHeight > 0;
|
||||
if ( sized() ) {
|
||||
resolve();
|
||||
return;
|
||||
}
|
||||
let timer = null;
|
||||
const done = () => {
|
||||
win.removeEventListener('resize', onResize);
|
||||
clearTimeout(timer);
|
||||
resolve();
|
||||
};
|
||||
const onResize = () => {
|
||||
if ( sized() ) done();
|
||||
};
|
||||
win.addEventListener('resize', onResize);
|
||||
// Opening on a 0x0 viewport is better than never opening.
|
||||
timer = setTimeout(done, FRAME_SIZE_TIMEOUT_MS);
|
||||
reveal();
|
||||
});
|
||||
@@ -1,514 +0,0 @@
|
||||
// @vitest-environment jsdom
|
||||
import { afterEach, describe, expect, it, vi } from 'vitest';
|
||||
import {
|
||||
POPUP_FRAME_MSG,
|
||||
canShowUpgradeFrame,
|
||||
closeAccountChecksOnEscape,
|
||||
focusOnFrameFocus,
|
||||
framedPopupAction,
|
||||
framedPopupParams,
|
||||
framedUpgradeDetails,
|
||||
framesHostUser,
|
||||
showFramedUpgrade,
|
||||
startPopupFrame,
|
||||
} from './popupFrame.js';
|
||||
|
||||
const HOST = 'https://notes.puter.test';
|
||||
|
||||
/** A stand-in for the frame's window, with its own parent to post to. */
|
||||
const frameWindow = () => {
|
||||
const parent = { postMessage: vi.fn() };
|
||||
const open = vi.fn(() => 'opened');
|
||||
return {
|
||||
parent,
|
||||
open,
|
||||
opener: null,
|
||||
close: () => {},
|
||||
document,
|
||||
MutationObserver: window.MutationObserver,
|
||||
};
|
||||
};
|
||||
|
||||
const statesSent = (win) => win.parent.postMessage.mock.calls.map(([data, origin]) => {
|
||||
expect(origin).toBe(HOST);
|
||||
expect(data.msg).toBe(POPUP_FRAME_MSG);
|
||||
return data.state;
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
document.body.innerHTML = '';
|
||||
document.documentElement.classList.remove('popup-frame-transparent');
|
||||
});
|
||||
|
||||
describe('framedPopupAction', () => {
|
||||
it.each([
|
||||
['/embed/sign-in', 'sign-in'],
|
||||
['/embed/sign-in/', 'sign-in'],
|
||||
['/embed/show-open-file-picker', 'show-open-file-picker'],
|
||||
['/embed/show-save-file-picker', 'show-save-file-picker'],
|
||||
['/embed/show-directory-picker', 'show-directory-picker'],
|
||||
['/embed/upgrade', 'upgrade'],
|
||||
['/embed/apps', null],
|
||||
['/embed/feedback', null],
|
||||
['/embed/request-permission', null],
|
||||
['/action/sign-in', null],
|
||||
['/embed/sign-in/extra', null],
|
||||
['/', null],
|
||||
[undefined, null],
|
||||
])('%s frames %s', (pathname, expected) => {
|
||||
expect(framedPopupAction(pathname)).toBe(expected);
|
||||
});
|
||||
});
|
||||
|
||||
describe('framedPopupParams', () => {
|
||||
it('keeps only the popup parameters a framing page may pass', () => {
|
||||
const params = framedPopupParams('#msg_id=7&options=%7B%22multiple%22%3Atrue%7D&request_auth=true&user=abc&auth_token=x&attempt_temp_user_creation=true&api_origin=https%3A%2F%2Fevil.test');
|
||||
expect(Object.fromEntries(params)).toEqual({
|
||||
msg_id: '7',
|
||||
options: '{"multiple":true}',
|
||||
request_auth: 'true',
|
||||
});
|
||||
});
|
||||
|
||||
it('is empty without a fragment', () => {
|
||||
expect([...framedPopupParams('')]).toEqual([]);
|
||||
expect([...framedPopupParams(undefined)]).toEqual([]);
|
||||
});
|
||||
});
|
||||
|
||||
describe('framesHostUser', () => {
|
||||
it.each([
|
||||
['show-open-file-picker', true],
|
||||
['show-save-file-picker', true],
|
||||
['show-directory-picker', true],
|
||||
['upgrade', true],
|
||||
['sign-in', false],
|
||||
[null, false],
|
||||
])('%s serves only the framing page\'s user: %s', (action, expected) => {
|
||||
expect(framesHostUser(action)).toBe(expected);
|
||||
});
|
||||
});
|
||||
|
||||
describe('framedUpgradeDetails', () => {
|
||||
it('keeps a known reason and the method', () => {
|
||||
expect(framedUpgradeDetails('#user=abc&reason=storage&method=puter.fs.upload&appUid=app-x'))
|
||||
.toEqual({ reason: 'storage', method: 'puter.fs.upload' });
|
||||
});
|
||||
|
||||
it('drops an unknown reason and an overlong method', () => {
|
||||
expect(framedUpgradeDetails(`#reason=free-money&method=${'m'.repeat(201)}`)).toEqual({});
|
||||
expect(framedUpgradeDetails('')).toEqual({});
|
||||
expect(framedUpgradeDetails(undefined)).toEqual({});
|
||||
});
|
||||
});
|
||||
|
||||
describe('canShowUpgradeFrame', () => {
|
||||
const win = { UIUpgradeAccount: Object.assign(function () {}, { embeddable: true }) };
|
||||
const session = { uuid: 'u-1' };
|
||||
|
||||
it('shows for a session with nothing to verify, when the dialog reports its close', () => {
|
||||
expect(canShowUpgradeFrame(win, session)).toBe(true);
|
||||
});
|
||||
|
||||
it('needs a dialog that reports its close', () => {
|
||||
expect(canShowUpgradeFrame({}, session)).toBe(false);
|
||||
expect(canShowUpgradeFrame({ UIUpgradeAccount: function () {} }, session)).toBe(false);
|
||||
});
|
||||
|
||||
it.each([
|
||||
'requires_email_confirmation',
|
||||
'requires_phone_verification',
|
||||
'requires_card_verification',
|
||||
'requires_password_change',
|
||||
])('leaves an account with %s to the tab', (check) => {
|
||||
expect(canShowUpgradeFrame(win, { ...session, [check]: true })).toBe(false);
|
||||
});
|
||||
|
||||
it('needs a session', () => {
|
||||
expect(canShowUpgradeFrame(win, null)).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe('showFramedUpgrade', () => {
|
||||
const upgradeWindow = (openAsWindow, { width = 1280, height = 800 } = {}) => {
|
||||
const created = [];
|
||||
const events = new EventTarget();
|
||||
const win = {
|
||||
document,
|
||||
innerWidth: width,
|
||||
innerHeight: height,
|
||||
addEventListener: events.addEventListener.bind(events),
|
||||
removeEventListener: events.removeEventListener.bind(events),
|
||||
dispatchEvent: events.dispatchEvent.bind(events),
|
||||
MutationObserver: window.MutationObserver,
|
||||
UIUpgradeAccount: function (options) {
|
||||
created.push(options);
|
||||
this.open_as_window = () => openAsWindow(options);
|
||||
},
|
||||
};
|
||||
return { win, created };
|
||||
};
|
||||
/** Stands in for the dialog's own modal root. */
|
||||
const showModal = () => {
|
||||
const root = document.createElement('div');
|
||||
root.setAttribute('aria-modal', 'true');
|
||||
document.body.append(root);
|
||||
return root;
|
||||
};
|
||||
|
||||
afterEach(() => {
|
||||
vi.useRealTimers();
|
||||
});
|
||||
|
||||
it('passes what prompted it, tells the page it is ready once open, and resolves the close', async () => {
|
||||
const tell = vi.fn();
|
||||
let options;
|
||||
const { win, created } = upgradeWindow(async (o) => {
|
||||
options = o;
|
||||
});
|
||||
const result = showFramedUpgrade(win, { appUid: 'app-1', reason: 'funds' }, tell);
|
||||
await vi.waitFor(() => expect(tell).toHaveBeenCalledWith('ready'));
|
||||
expect(created[0].attribution).toEqual({ appUid: 'app-1', reason: 'funds' });
|
||||
expect(tell).toHaveBeenCalledTimes(1);
|
||||
|
||||
options.onClose({ upgraded: true });
|
||||
await expect(result).resolves.toBe(true);
|
||||
});
|
||||
|
||||
it('passes no attribution when nothing is known, so the dialog credits the prompt it remembers', async () => {
|
||||
const { win, created } = upgradeWindow(async (o) => o.onClose());
|
||||
await showFramedUpgrade(win, {}, vi.fn());
|
||||
expect(created[0].attribution).toBeNull();
|
||||
});
|
||||
|
||||
it('resolves false for a close without an upgrade, even one before it opened', async () => {
|
||||
const { win } = upgradeWindow(async (o) => o.onClose({ upgraded: false }));
|
||||
await expect(showFramedUpgrade(win, {}, vi.fn())).resolves.toBe(false);
|
||||
const { win: bare } = upgradeWindow(async (o) => o.onClose());
|
||||
await expect(showFramedUpgrade(bare, {}, vi.fn())).resolves.toBe(false);
|
||||
});
|
||||
|
||||
it('resolves false once the dialog is gone without reporting a close', async () => {
|
||||
vi.useFakeTimers();
|
||||
const tell = vi.fn();
|
||||
let root;
|
||||
const { win } = upgradeWindow(async () => {
|
||||
root = showModal();
|
||||
});
|
||||
const result = showFramedUpgrade(win, {}, tell);
|
||||
await vi.advanceTimersByTimeAsync(0);
|
||||
expect(tell).toHaveBeenCalledWith('ready');
|
||||
|
||||
root.remove();
|
||||
await vi.advanceTimersByTimeAsync(499);
|
||||
await expect(Promise.race([result, 'pending'])).resolves.toBe('pending');
|
||||
await vi.advanceTimersByTimeAsync(1);
|
||||
await expect(result).resolves.toBe(false);
|
||||
});
|
||||
|
||||
it('keeps waiting while one window replaces another', async () => {
|
||||
vi.useFakeTimers();
|
||||
let options;
|
||||
const { win } = upgradeWindow(async (o) => {
|
||||
options = o;
|
||||
// An alert, which is a GUI window, rather than the dialog itself.
|
||||
document.body.append(Object.assign(document.createElement('div'), { className: 'window' }));
|
||||
});
|
||||
const result = showFramedUpgrade(win, {}, vi.fn());
|
||||
await vi.advanceTimersByTimeAsync(0);
|
||||
document.querySelector('.window').remove();
|
||||
showModal();
|
||||
await vi.advanceTimersByTimeAsync(2000);
|
||||
await expect(Promise.race([result, 'pending'])).resolves.toBe('pending');
|
||||
|
||||
options.onClose({ upgraded: true });
|
||||
await expect(result).resolves.toBe(true);
|
||||
});
|
||||
|
||||
it('waits for the dialog to show before watching for it to go', async () => {
|
||||
vi.useFakeTimers();
|
||||
let options;
|
||||
const { win } = upgradeWindow(async (o) => {
|
||||
options = o;
|
||||
});
|
||||
const result = showFramedUpgrade(win, {}, vi.fn());
|
||||
await vi.advanceTimersByTimeAsync(2000);
|
||||
await expect(Promise.race([result, 'pending'])).resolves.toBe('pending');
|
||||
options.onClose({ upgraded: false });
|
||||
await expect(result).resolves.toBe(false);
|
||||
});
|
||||
|
||||
it('has a hidden frame shown before opening the dialog, so it lays out on a real viewport', async () => {
|
||||
vi.useFakeTimers();
|
||||
const tell = vi.fn();
|
||||
const sizes = [];
|
||||
const { win, created } = upgradeWindow(async () => {
|
||||
sizes.push([win.innerWidth, win.innerHeight]);
|
||||
}, { width: 0, height: 0 });
|
||||
const result = showFramedUpgrade(win, {}, tell);
|
||||
await vi.advanceTimersByTimeAsync(0);
|
||||
expect(tell).toHaveBeenCalledWith('ready');
|
||||
expect(created).toHaveLength(0);
|
||||
|
||||
win.innerWidth = 1280;
|
||||
win.innerHeight = 800;
|
||||
win.dispatchEvent(new Event('resize'));
|
||||
await vi.advanceTimersByTimeAsync(0);
|
||||
expect(sizes).toEqual([[1280, 800]]);
|
||||
// Told once, not again once it opens.
|
||||
expect(tell).toHaveBeenCalledTimes(1);
|
||||
|
||||
created[0].onClose({ upgraded: false });
|
||||
await expect(result).resolves.toBe(false);
|
||||
});
|
||||
|
||||
it('opens the dialog anyway when a hidden frame never gets a viewport', async () => {
|
||||
vi.useFakeTimers();
|
||||
const { win, created } = upgradeWindow(async () => {}, { width: 0, height: 0 });
|
||||
showFramedUpgrade(win, {}, vi.fn());
|
||||
await vi.advanceTimersByTimeAsync(999);
|
||||
expect(created).toHaveLength(0);
|
||||
await vi.advanceTimersByTimeAsync(1);
|
||||
expect(created).toHaveLength(1);
|
||||
});
|
||||
|
||||
it('rejects when the dialog fails to open', async () => {
|
||||
const { win } = upgradeWindow(async () => {
|
||||
throw new Error('broken');
|
||||
});
|
||||
await expect(showFramedUpgrade(win, {}, vi.fn())).rejects.toThrow('broken');
|
||||
});
|
||||
});
|
||||
|
||||
describe('startPopupFrame', () => {
|
||||
it('does nothing without a framing page to answer', () => {
|
||||
const win = frameWindow();
|
||||
expect(startPopupFrame(win, null)).toBeNull();
|
||||
const top = frameWindow();
|
||||
top.parent = top;
|
||||
expect(startPopupFrame(top, HOST)).toBeNull();
|
||||
expect(win.opener).toBeNull();
|
||||
});
|
||||
|
||||
it('makes the framing page the opener and tells it the frame is loading', () => {
|
||||
const win = frameWindow();
|
||||
startPopupFrame(win, HOST);
|
||||
expect(win.opener).toBe(win.parent);
|
||||
expect(statesSent(win)).toEqual(['loading']);
|
||||
});
|
||||
|
||||
it('asks the framing page to remove the frame on close, either way the popup closes', () => {
|
||||
const win = frameWindow();
|
||||
startPopupFrame(win, HOST);
|
||||
win.close();
|
||||
win.open('', '_self').close();
|
||||
expect(statesSent(win)).toEqual(['loading', 'closed', 'closed']);
|
||||
});
|
||||
|
||||
it('sends the fields that go with a state, without letting them rename it', () => {
|
||||
const win = frameWindow();
|
||||
const tell = startPopupFrame(win, HOST);
|
||||
tell('provider', { url: 'https://puter.test/auth/oidc/google/start', msg: 'x', state: 'y' });
|
||||
expect(win.parent.postMessage).toHaveBeenLastCalledWith(
|
||||
{ url: 'https://puter.test/auth/oidc/google/start', msg: POPUP_FRAME_MSG, state: 'provider' },
|
||||
HOST,
|
||||
);
|
||||
});
|
||||
|
||||
it('lets the framing page show through an upgrade frame only', () => {
|
||||
startPopupFrame({ ...frameWindow(), location: { pathname: '/embed/sign-in' } }, HOST);
|
||||
expect(document.documentElement.classList.contains('popup-frame-transparent')).toBe(false);
|
||||
|
||||
startPopupFrame({ ...frameWindow(), location: { pathname: '/embed/upgrade' } }, HOST);
|
||||
expect(document.documentElement.classList.contains('popup-frame-transparent')).toBe(true);
|
||||
});
|
||||
|
||||
it('sends a boolean field with a state', () => {
|
||||
const win = frameWindow();
|
||||
const tell = startPopupFrame(win, HOST);
|
||||
tell('closed', { upgraded: true });
|
||||
expect(win.parent.postMessage).toHaveBeenLastCalledWith(
|
||||
{ upgraded: true, msg: POPUP_FRAME_MSG, state: 'closed' },
|
||||
HOST,
|
||||
);
|
||||
});
|
||||
|
||||
it('leaves other window.open calls alone', () => {
|
||||
const win = frameWindow();
|
||||
const open = win.open;
|
||||
startPopupFrame(win, HOST);
|
||||
expect(win.open('https://puter.com/terms', '_blank')).toBe('opened');
|
||||
expect(open).toHaveBeenCalledWith('https://puter.com/terms', '_blank');
|
||||
});
|
||||
|
||||
it('tells the framing page it is ready once the popup shows something', async () => {
|
||||
const win = frameWindow();
|
||||
startPopupFrame(win, HOST);
|
||||
document.body.append(Object.assign(document.createElement('div'), { className: 'busy' }));
|
||||
await Promise.resolve();
|
||||
expect(statesSent(win)).toEqual(['loading']);
|
||||
|
||||
const dialog = document.createElement('div');
|
||||
dialog.className = 'dashboard-dialog-overlay auth-dialog-page';
|
||||
document.body.append(dialog);
|
||||
await Promise.resolve();
|
||||
document.body.append(Object.assign(document.createElement('div'), { className: 'window' }));
|
||||
await Promise.resolve();
|
||||
expect(statesSent(win)).toEqual(['loading', 'ready']);
|
||||
});
|
||||
});
|
||||
|
||||
describe('focusOnFrameFocus', () => {
|
||||
/** A window of its own, so patching its focus() leaves the test's alone. */
|
||||
const ownWindow = () => {
|
||||
const iframe = document.createElement('iframe');
|
||||
document.body.append(iframe);
|
||||
const win = iframe.contentWindow;
|
||||
const input = win.document.createElement('input');
|
||||
win.document.body.append(input);
|
||||
return { win, input };
|
||||
};
|
||||
/** The frame losing its focus, then the framing page focusing it again. */
|
||||
const refocusFrame = (win) => {
|
||||
win.document.activeElement?.blur();
|
||||
win.dispatchEvent(new win.FocusEvent('focus'));
|
||||
};
|
||||
|
||||
it('gives the popup\'s latest focus back each time the frame gains focus with nothing focused', () => {
|
||||
const { win, input } = ownWindow();
|
||||
focusOnFrameFocus(win);
|
||||
input.focus();
|
||||
refocusFrame(win);
|
||||
expect(win.document.activeElement).toBe(input);
|
||||
refocusFrame(win);
|
||||
expect(win.document.activeElement).toBe(input);
|
||||
});
|
||||
|
||||
it('leaves focus to the user once they press a key or the pointer', () => {
|
||||
for ( const type of ['keydown', 'pointerdown'] ) {
|
||||
const { win, input } = ownWindow();
|
||||
const focus = win.HTMLElement.prototype.focus;
|
||||
focusOnFrameFocus(win);
|
||||
input.focus();
|
||||
win.document.body.dispatchEvent(new win.Event(type, { bubbles: true }));
|
||||
refocusFrame(win);
|
||||
expect(win.document.activeElement).toBe(win.document.body);
|
||||
expect(win.HTMLElement.prototype.focus).toBe(focus);
|
||||
}
|
||||
});
|
||||
|
||||
/** A window whose focus() is ignored while `blocked`, as a frame just shown is. */
|
||||
const blockableWindow = () => {
|
||||
const { win, input } = ownWindow();
|
||||
const nativeFocus = win.HTMLElement.prototype.focus;
|
||||
const state = { blocked: true };
|
||||
win.HTMLElement.prototype.focus = function (...args) {
|
||||
if ( ! state.blocked ) nativeFocus.apply(this, args);
|
||||
};
|
||||
return { win, input, state };
|
||||
};
|
||||
|
||||
it('retries a focus() the frame ignored until it takes', async () => {
|
||||
vi.useFakeTimers();
|
||||
try {
|
||||
const { win, input, state } = blockableWindow();
|
||||
focusOnFrameFocus(win);
|
||||
input.focus();
|
||||
expect(win.document.activeElement).toBe(win.document.body);
|
||||
await vi.advanceTimersByTimeAsync(120);
|
||||
expect(win.document.activeElement).toBe(win.document.body);
|
||||
state.blocked = false;
|
||||
await vi.advanceTimersByTimeAsync(50);
|
||||
expect(win.document.activeElement).toBe(input);
|
||||
} finally {
|
||||
vi.useRealTimers();
|
||||
}
|
||||
});
|
||||
|
||||
it('stops retrying after a while, and once the user presses a key', async () => {
|
||||
vi.useFakeTimers();
|
||||
try {
|
||||
const { win, input, state } = blockableWindow();
|
||||
focusOnFrameFocus(win);
|
||||
input.focus();
|
||||
await vi.advanceTimersByTimeAsync(1000);
|
||||
state.blocked = false;
|
||||
await vi.advanceTimersByTimeAsync(1000);
|
||||
expect(win.document.activeElement).toBe(win.document.body);
|
||||
|
||||
const other = blockableWindow();
|
||||
focusOnFrameFocus(other.win);
|
||||
other.input.focus();
|
||||
other.win.document.body.dispatchEvent(new other.win.Event('keydown', { bubbles: true }));
|
||||
other.state.blocked = false;
|
||||
await vi.advanceTimersByTimeAsync(1000);
|
||||
expect(other.win.document.activeElement).toBe(other.win.document.body);
|
||||
} finally {
|
||||
vi.useRealTimers();
|
||||
}
|
||||
});
|
||||
|
||||
it('leaves an element that has focus, and one that has left the page', () => {
|
||||
const { win, input } = ownWindow();
|
||||
const nativeFocus = win.HTMLElement.prototype.focus;
|
||||
const other = win.document.createElement('button');
|
||||
win.document.body.append(other);
|
||||
focusOnFrameFocus(win);
|
||||
input.focus();
|
||||
nativeFocus.call(other);
|
||||
win.dispatchEvent(new win.FocusEvent('focus'));
|
||||
expect(win.document.activeElement).toBe(other);
|
||||
|
||||
input.remove();
|
||||
refocusFrame(win);
|
||||
expect(win.document.activeElement).toBe(win.document.body);
|
||||
});
|
||||
});
|
||||
|
||||
describe('closeAccountChecksOnEscape', () => {
|
||||
/** A sign-in window with its own document, whose close() is spied on. */
|
||||
const signInWindow = () => {
|
||||
const win = { document: document.implementation.createHTMLDocument(), close: vi.fn() };
|
||||
closeAccountChecksOnEscape(win);
|
||||
return win;
|
||||
};
|
||||
const escapeOn = (el, init = {}) => {
|
||||
el.dispatchEvent(new KeyboardEvent('keydown', { key: 'Escape', bubbles: true, cancelable: true, ...init }));
|
||||
};
|
||||
const showWindow = (win, className = 'window window-active window-confirm-email-using-code') => {
|
||||
const el = Object.assign(win.document.createElement('div'), { className });
|
||||
el.innerHTML = '<input class="digit-input">';
|
||||
win.document.body.append(el);
|
||||
return el;
|
||||
};
|
||||
|
||||
it.each([
|
||||
'window-confirm-email-using-code',
|
||||
'window-confirm-phone-using-code',
|
||||
'window-card-verification',
|
||||
])('closes on Escape in the %s window', (cls) => {
|
||||
const win = signInWindow();
|
||||
escapeOn(showWindow(win, `window window-active ${cls}`).querySelector('input'));
|
||||
expect(win.close).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it('closes on Escape with focus on the page behind an account check', () => {
|
||||
const win = signInWindow();
|
||||
showWindow(win);
|
||||
escapeOn(win.document.body);
|
||||
expect(win.close).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it('leaves Escape that something or an IME handled, other keys, and other windows alone', () => {
|
||||
const win = signInWindow();
|
||||
const input = showWindow(win).querySelector('input');
|
||||
input.addEventListener('keydown', (e) => e.preventDefault(), { once: true });
|
||||
escapeOn(input);
|
||||
escapeOn(input, { key: 'Enter' });
|
||||
escapeOn(input, { isComposing: true });
|
||||
// Safari ends a conversion with keyCode 229 and isComposing false.
|
||||
escapeOn(input, { keyCode: 229 });
|
||||
escapeOn(showWindow(win, 'window window-alert').querySelector('input'));
|
||||
expect(win.close).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
@@ -1,46 +0,0 @@
|
||||
/*
|
||||
* Copyright (C) 2024-present Puter Technologies Inc.
|
||||
*
|
||||
* This file is part of Puter.
|
||||
*
|
||||
* Puter is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published
|
||||
* by the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
|
||||
/**
|
||||
* Run `task` over `items`, at most `limit` at a time. Resolves to the items
|
||||
* whose task rejected.
|
||||
*
|
||||
* @template T
|
||||
* @param {T[]} items
|
||||
* @param {number} limit
|
||||
* @param {(item: T) => Promise<unknown>} task
|
||||
* @returns {Promise<T[]>}
|
||||
*/
|
||||
export const runLimited = async (items, limit, task) => {
|
||||
const failed = [];
|
||||
let index = 0;
|
||||
const worker = async () => {
|
||||
while ( index < items.length ) {
|
||||
const item = items[index++];
|
||||
try {
|
||||
await task(item);
|
||||
} catch {
|
||||
failed.push(item);
|
||||
}
|
||||
}
|
||||
};
|
||||
await Promise.all(Array.from({ length: Math.min(limit, items.length) }, worker));
|
||||
return failed;
|
||||
};
|
||||
@@ -1,50 +0,0 @@
|
||||
/*
|
||||
* Copyright (C) 2024-present Puter Technologies Inc.
|
||||
*
|
||||
* This file is part of Puter.
|
||||
*
|
||||
* Puter is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published
|
||||
* by the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
|
||||
import { describe, expect, it } from 'vitest';
|
||||
import { runLimited } from './runLimited.js';
|
||||
|
||||
describe('runLimited', () => {
|
||||
it('runs every item, never more than the limit at once', async () => {
|
||||
let running = 0;
|
||||
let peak = 0;
|
||||
const done = [];
|
||||
await runLimited([1, 2, 3, 4, 5, 6, 7], 3, async (n) => {
|
||||
running++;
|
||||
peak = Math.max(peak, running);
|
||||
await new Promise(resolve => setTimeout(resolve, 5));
|
||||
done.push(n);
|
||||
running--;
|
||||
});
|
||||
expect(done.sort()).toEqual([1, 2, 3, 4, 5, 6, 7]);
|
||||
expect(peak).toBe(3);
|
||||
});
|
||||
|
||||
it('resolves to the items whose task rejected, after running the rest', async () => {
|
||||
const failed = await runLimited(['a', 'b', 'c'], 2, async (item) => {
|
||||
if ( item === 'b' ) throw new Error('no');
|
||||
});
|
||||
expect(failed).toEqual(['b']);
|
||||
});
|
||||
|
||||
it('does nothing for no items', async () => {
|
||||
expect(await runLimited([], 4, async () => {})).toEqual([]);
|
||||
});
|
||||
});
|
||||
@@ -27,8 +27,7 @@ const update_username_in_gui = function (new_username) {
|
||||
// ------------------------------------------------------------
|
||||
// Update all item/window/... paths, with the new username
|
||||
// ------------------------------------------------------------
|
||||
// With no earlier username there are no paths under it to rewrite.
|
||||
if ( old_username ) $('[data-path], [data-item-path], [data-shortcut_to_path]').each((i, el) => {
|
||||
$(':not([data-path=""]),:not([data-item-path=""])').each((i, el) => {
|
||||
const $el = $(el);
|
||||
const attr_path = $el.attr('data-path');
|
||||
const attr_item_path = $el.attr('data-item-path');
|
||||
@@ -92,10 +91,10 @@ const update_username_in_gui = function (new_username) {
|
||||
$el.attr('data-item-path', attr_item_path.replace(`/${ window.user.username }/`, `/${ new_username }/`));
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
// any element with username class
|
||||
$('.username').text(new_username);
|
||||
// any element with username class
|
||||
$('.username').text(new_username);
|
||||
});
|
||||
|
||||
// todo update all window paths
|
||||
$('.window').each((i, el) => {
|
||||
|
||||
@@ -1,63 +0,0 @@
|
||||
// @vitest-environment jsdom
|
||||
/*
|
||||
* Copyright (C) 2024-present Puter Technologies Inc.
|
||||
*
|
||||
* This file is part of Puter.
|
||||
*
|
||||
* Puter is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published
|
||||
* by the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
import { beforeEach, describe, expect, it, vi } from 'vitest';
|
||||
import jQuery from '../lib/jquery-3.6.1/jquery-3.6.1.min.js';
|
||||
|
||||
globalThis.$ = jQuery;
|
||||
globalThis.jQuery = jQuery;
|
||||
|
||||
const { default: update_username_in_gui } = await import('./updateUsernameInGui.js');
|
||||
|
||||
beforeEach(() => {
|
||||
globalThis.puter = { _cache: { flushall: vi.fn() } };
|
||||
document.body.innerHTML = `
|
||||
<div class="item" data-path="/alice/Documents/a.txt"></div>
|
||||
<div class="item" data-path="/alice"></div>
|
||||
<div class="item" data-path="/alicex/b.txt"></div>
|
||||
<div class="window" data-item-path="/alice/Pictures"></div>
|
||||
<div class="shortcut" data-shortcut_to_path="/alice/Videos"></div>
|
||||
<span class="username">alice</span>
|
||||
<span class="username">alice</span>`;
|
||||
});
|
||||
|
||||
describe('update_username_in_gui', () => {
|
||||
it('rewrites the paths under the old username and every username label', () => {
|
||||
window.user = { username: 'alice' };
|
||||
|
||||
update_username_in_gui('bob');
|
||||
|
||||
const paths = $('[data-path]').toArray().map(el => el.dataset.path);
|
||||
expect(paths).toEqual(['/bob/Documents/a.txt', '/bob', '/alicex/b.txt']);
|
||||
expect($('.window').attr('data-item-path')).toBe('/bob/Pictures');
|
||||
expect($('.shortcut').attr('data-shortcut_to_path')).toBe('/bob/Videos');
|
||||
expect($('.username').toArray().map(el => el.textContent)).toEqual(['bob', 'bob']);
|
||||
expect(window.home_path).toBe('/bob');
|
||||
});
|
||||
|
||||
it('only sets the labels while signing in, with no earlier username', () => {
|
||||
window.user = undefined;
|
||||
|
||||
update_username_in_gui('bob');
|
||||
|
||||
expect($('.item').first().attr('data-path')).toBe('/alice/Documents/a.txt');
|
||||
expect($('.username').first().text()).toBe('bob');
|
||||
});
|
||||
});
|
||||
@@ -550,8 +550,6 @@ const en = {
|
||||
'Resources': 'Resources',
|
||||
restart_puter_confirm: 'Are you sure you want to restart Puter?',
|
||||
restore: 'Restore',
|
||||
restore_location_unknown: '“{{name}}” can’t be restored because where it was deleted from isn’t known.',
|
||||
restore_only_trash_items: '“{{name}}” is inside a folder in the Trash. Restore that folder instead.',
|
||||
retry: 'Retry',
|
||||
save: 'Save',
|
||||
saturation: 'Saturation',
|
||||
@@ -889,13 +887,6 @@ const en = {
|
||||
setup2fa_5_button: 'Enable 2FA',
|
||||
setup2fa_password_instructions: 'Enter your password to set up 2FA.',
|
||||
setup2fa_code_expired: 'That code has expired. Enter the current code from your authenticator app to finish.',
|
||||
setup2fa_step_scan: 'Scan',
|
||||
setup2fa_step_backup: 'Backup',
|
||||
setup2fa_step_verify: 'Verify',
|
||||
setup2fa_enabling: 'Enabling…',
|
||||
setup2fa_success_text: 'Your account is now protected with two-factor authentication. You’ll be asked for a verification code each time you sign in.',
|
||||
setup2fa_copy_secret: 'Copy secret key',
|
||||
setup2fa_recovery_codes: 'Recovery Codes',
|
||||
|
||||
// === 2FA Login ===
|
||||
login2fa_otp_title: 'Enter 2FA Code',
|
||||
|
||||
@@ -60,10 +60,6 @@ window.gui = async (options) => {
|
||||
window.co_isolation_enabled = options.co_isolation_enabled;
|
||||
window.teams_ui = options.teams_ui ?? false;
|
||||
|
||||
// A popup a first-party page frames answers it before the SDK loads, so
|
||||
// the page knows the frame wasn't refused.
|
||||
window.start_popup_frame?.(options.embed_host_origin);
|
||||
|
||||
// DEV: Load the initgui.js file if we are in development mode
|
||||
if ( !window.gui_env || window.gui_env === 'dev' ) {
|
||||
await window.loadScript('/sdk/puter.dev.js');
|
||||
|
||||
+11
-110
@@ -46,18 +46,6 @@ import UIAuthSignup from './UI/Auth/UIAuthSignup.js';
|
||||
import UIAuthRecoverPassword from './UI/Auth/UIAuthRecoverPassword.js';
|
||||
import { PROCESS_RUNNING } from './definitions.js';
|
||||
import { isAttestedOrigin } from './helpers/attestedOrigin.js';
|
||||
import { embedHostUser } from './helpers/embedHostUser.js';
|
||||
import {
|
||||
canShowUpgradeFrame,
|
||||
closeAccountChecksOnEscape,
|
||||
focusOnFrameFocus,
|
||||
framedPopupAction,
|
||||
framedPopupParams,
|
||||
framedUpgradeDetails,
|
||||
framesHostUser,
|
||||
showFramedUpgrade,
|
||||
startPopupFrame,
|
||||
} from './helpers/popupFrame.js';
|
||||
import confirm_before_unload from './helpers/confirmBeforeUnload.js';
|
||||
import create_access_token from './helpers/createAccessToken.js';
|
||||
import create_gui_token from './helpers/createGuiToken.js';
|
||||
@@ -578,9 +566,6 @@ const postAuthActions = async (action) => {
|
||||
msg,
|
||||
original_msg_id: msg_id,
|
||||
}, '*');
|
||||
// Escape closes only the picker window, which would leave the
|
||||
// page's frame open over an empty desktop.
|
||||
if ( window.embedded_in_frame ) window.close();
|
||||
};
|
||||
|
||||
if ( action === 'show-open-file-picker' ) {
|
||||
@@ -647,15 +632,12 @@ const postAuthActions = async (action) => {
|
||||
msg: 'sendMeFileData',
|
||||
}, '*');
|
||||
|
||||
// listen for 'showSaveFilePickerPopup' event from parent. Only the
|
||||
// page that asked supplies the file, once; any other window that
|
||||
// can reach this one (a sibling frame of the framing page) can't.
|
||||
window.addEventListener('message', async function onFileData (event) {
|
||||
if ( event.data?.msg !== 'showSaveFilePickerPopup' || event.source !== window.opener )
|
||||
// listen for 'showSaveFilePickerPopup' event from parent
|
||||
window.addEventListener('message', async (event) => {
|
||||
if ( event.data.msg !== 'showSaveFilePickerPopup' )
|
||||
{
|
||||
return;
|
||||
}
|
||||
window.removeEventListener('message', onFileData);
|
||||
|
||||
// Open dialog
|
||||
UIWindow({
|
||||
@@ -668,7 +650,6 @@ const postAuthActions = async (action) => {
|
||||
title: 'Save',
|
||||
is_dir: true,
|
||||
is_saveFileDialog: true,
|
||||
saveFileDialog_default_filename: event.data.suggestedName ?? '',
|
||||
is_resizable: false,
|
||||
has_head: false,
|
||||
cover_page: true,
|
||||
@@ -728,14 +709,7 @@ const postAuthActions = async (action) => {
|
||||
catch ( err ) {
|
||||
// item with same name exists
|
||||
if ( err.code === 'item_with_same_name_exists' ) {
|
||||
// Escape closes the alert without an answer,
|
||||
// which counts as Cancel, so the picker isn't
|
||||
// left behind its busy mask.
|
||||
let alert_closed;
|
||||
const alert_dismissed = new Promise((resolve) => {
|
||||
alert_closed = () => resolve('cancel');
|
||||
});
|
||||
const alert_resp = await Promise.race([UIAlert({
|
||||
const alert_resp = await UIAlert({
|
||||
message: `<strong>${html_encode(err.entry_name)}</strong> already exists.`,
|
||||
buttons: [
|
||||
{
|
||||
@@ -749,11 +723,10 @@ const postAuthActions = async (action) => {
|
||||
},
|
||||
],
|
||||
parent_uuid: $(el_filedialog_window).attr('data-element_uuid'),
|
||||
window_options: { on_close: alert_closed },
|
||||
}), alert_dismissed]);
|
||||
});
|
||||
if ( alert_resp === 'replace' ) {
|
||||
overwrite = true;
|
||||
} else {
|
||||
} else if ( alert_resp === 'cancel' ) {
|
||||
// enable parent window
|
||||
$(el_filedialog_window).find('.window-disable-mask, .busy-indicator').hide();
|
||||
return;
|
||||
@@ -968,7 +941,6 @@ const postAuthActions = async (action) => {
|
||||
sent = await UIWindowAppFeedback({
|
||||
origin,
|
||||
source: 'web',
|
||||
fullpage: window.embedded_in_popup === true,
|
||||
});
|
||||
} catch (e) {
|
||||
console.error('send-feedback action failed', e);
|
||||
@@ -1001,27 +973,6 @@ const postAuthActions = async (action) => {
|
||||
}
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------------------
|
||||
// Action: upgrade — the deployment's upgrade dialog for the first-party page framing
|
||||
// it, which hears whether the user upgraded once the dialog closes. The app it credits
|
||||
// is the one the framing page's origin resolves to, never one the fragment names.
|
||||
// -------------------------------------------------------------------------------------
|
||||
if ( action === 'upgrade' && window.embedded_in_frame ) {
|
||||
let upgraded;
|
||||
try {
|
||||
upgraded = await showFramedUpgrade(window, {
|
||||
...(window.host_app_uid ? { appUid: window.host_app_uid } : {}),
|
||||
...framedUpgradeDetails(window.location.hash),
|
||||
}, window.tell_popup_frame);
|
||||
} catch (e) {
|
||||
// A dialog that failed to open leaves the page to open the upgrade in a tab.
|
||||
console.error('upgrade action failed', e);
|
||||
window.tell_popup_frame('unavailable');
|
||||
return;
|
||||
}
|
||||
window.tell_popup_frame('closed', { upgraded });
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------------------
|
||||
// Action: attach-custom-domain — puter.hosting.attach() on a website. Hosts the custom
|
||||
// domain dialog for `subdomain` and posts the chosen domain back to the opener.
|
||||
@@ -1203,17 +1154,9 @@ if (jQuery) {
|
||||
{
|
||||
const pathname = window.location.pathname;
|
||||
const search_params = new URLSearchParams(window.location.search);
|
||||
// A popup a first-party page frames at `/embed/<action>` boots as one.
|
||||
if (['true', '1'].includes(search_params.get('embedded_in_popup')) || framedPopupAction(pathname)) {
|
||||
if (['true', '1'].includes(search_params.get('embedded_in_popup'))) {
|
||||
window.embedded_in_popup = true;
|
||||
}
|
||||
// Called by the bootstrap in index.js, which can't import.
|
||||
window.start_popup_frame = (hostOrigin) => {
|
||||
if (!framedPopupAction(pathname)) return;
|
||||
window.tell_popup_frame = startPopupFrame(window, hostOrigin);
|
||||
window.embedded_in_frame = !!window.tell_popup_frame;
|
||||
if (window.embedded_in_frame) focusOnFrameFocus(window);
|
||||
};
|
||||
// note: iframe detection is inlined because globals.js (window.is_embedded) loads after this module
|
||||
const in_iframe = window.location !== window.parent.location;
|
||||
const needs_desktop_at_root =
|
||||
@@ -1468,16 +1411,8 @@ window.initgui = async function (options) {
|
||||
const url_paths = parse_url_paths(window.location.pathname);
|
||||
window.url_paths = url_paths;
|
||||
|
||||
// A framed popup without a framing page to answer (opened on its own, or
|
||||
// framed by a page the server refused) has nothing to do.
|
||||
const framed_action = framedPopupAction(window.location.pathname);
|
||||
if (framed_action && !window.embedded_in_frame) return;
|
||||
|
||||
// GET query params provided. A framed popup takes the popup's parameters
|
||||
// from its fragment; its route refuses a query string.
|
||||
window.url_query_params = framed_action
|
||||
? framedPopupParams(window.location.hash)
|
||||
: new URLSearchParams(window.location.search);
|
||||
// GET query params provided
|
||||
window.url_query_params = new URLSearchParams(window.location.search);
|
||||
window.signup_bonus_code = readSignupBonusCode(window.url_query_params);
|
||||
|
||||
// Install device signal helpers; collection is lazy. The fingerprint is
|
||||
@@ -1571,9 +1506,7 @@ window.initgui = async function (options) {
|
||||
// Extract 'action' from URL
|
||||
//--------------------------------------------------------------------------------------
|
||||
let action;
|
||||
if (framed_action) {
|
||||
action = framed_action;
|
||||
} else if (
|
||||
if (
|
||||
window.url_paths[0]?.toLocaleLowerCase() === 'action' &&
|
||||
window.url_paths[1]
|
||||
) {
|
||||
@@ -1587,8 +1520,6 @@ window.initgui = async function (options) {
|
||||
// action. See util/popupAuth.js.
|
||||
window.gui_action = action;
|
||||
|
||||
if (window.embedded_in_frame && action === 'sign-in') closeAccountChecksOnEscape(window);
|
||||
|
||||
if (action === 'oidc-2fa') {
|
||||
const result = oidcChallenge?.token && await UIAuth2FA(oidcChallenge.token);
|
||||
if (result?.redirectUrl) {
|
||||
@@ -1712,9 +1643,7 @@ window.initgui = async function (options) {
|
||||
action,
|
||||
);
|
||||
try {
|
||||
// A framed popup's opener is the page the server read from the
|
||||
// referrer and pinned with frame-ancestors.
|
||||
window.openerOrigin = window.embedded_in_frame ? window.gui_params.embed_host_origin : await resolveOpenerOrigin({
|
||||
window.openerOrigin = await resolveOpenerOrigin({
|
||||
relaysToken: relaysTokenAtBoot(
|
||||
action,
|
||||
window.url_query_params.get('cross_origin_isolated') ===
|
||||
@@ -1771,31 +1700,6 @@ window.initgui = async function (options) {
|
||||
// this is the referrer in terms of user acquisition
|
||||
window.referrerStr = window.openerOrigin;
|
||||
|
||||
// A framed picker or upgrade shows only the Puter session of the user
|
||||
// the framing page is signed in as; for anyone else the page uses the
|
||||
// popup or tab, which can sign in and switch accounts.
|
||||
if (window.embedded_in_frame && framesHostUser(action)) {
|
||||
const host_user = embedHostUser(window.location.hash);
|
||||
let session = null;
|
||||
let session_user = null;
|
||||
if (host_user && window.is_auth()) {
|
||||
try {
|
||||
session = await puter.os.user({ query: 'icon_size=64' });
|
||||
session_user = String(session?.uuid ?? '').toLowerCase();
|
||||
} catch (e) {
|
||||
session_user = null;
|
||||
}
|
||||
}
|
||||
if (
|
||||
!host_user ||
|
||||
session_user !== host_user ||
|
||||
(action === 'upgrade' && !canShowUpgradeFrame(window, session))
|
||||
) {
|
||||
window.tell_popup_frame('unavailable');
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
// Tell a request-permission opener that this popup can reach it. Sent
|
||||
// here, before any sign-in gate, because the SDK reads its absence as
|
||||
// "the opener link was severed by COOP" — where a close means the
|
||||
@@ -2028,11 +1932,8 @@ window.initgui = async function (options) {
|
||||
);
|
||||
window.userAppToken = response?.token;
|
||||
|
||||
// A framed picker or upgrade already holds the framing page's user,
|
||||
// so it doesn't offer to switch.
|
||||
if (
|
||||
!picked_a_user_for_sdk_login &&
|
||||
!(window.embedded_in_frame && framesHostUser(action)) &&
|
||||
window.logged_in_users.length > 1 &&
|
||||
(!window.userAppToken ||
|
||||
window.url_query_params.get('request_auth'))
|
||||
|
||||
@@ -1,65 +0,0 @@
|
||||
// @vitest-environment jsdom
|
||||
/*
|
||||
* Copyright (C) 2024-present Puter Technologies Inc.
|
||||
*
|
||||
* This file is part of Puter.
|
||||
*
|
||||
* Puter is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published
|
||||
* by the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
import { beforeEach, describe, expect, it, vi } from 'vitest';
|
||||
import jQuery from './lib/jquery-3.6.1/jquery-3.6.1.min.js';
|
||||
|
||||
vi.mock('./UI/UIAlert.js', () => ({ default: vi.fn() }));
|
||||
vi.mock('./UI/UIWindowSearch.js', () => ({ default: vi.fn() }));
|
||||
vi.mock('./helpers/launchApp.js', () => ({ default: vi.fn() }));
|
||||
vi.mock('./helpers/openItem.js', () => ({ default: vi.fn() }));
|
||||
|
||||
globalThis.$ = jQuery;
|
||||
globalThis.jQuery = jQuery;
|
||||
globalThis.i18n = key => key;
|
||||
globalThis.def = globalThis.def ?? (value => value);
|
||||
globalThis.use = globalThis.use ?? (() => class {});
|
||||
|
||||
await import('./keyboard.js');
|
||||
|
||||
const escape = () => document.body.dispatchEvent(new KeyboardEvent('keydown', { key: 'Escape', keyCode: 27, which: 27, bubbles: true }));
|
||||
|
||||
describe('Escape on a file dialog', () => {
|
||||
const closed = [];
|
||||
|
||||
beforeEach(() => {
|
||||
closed.length = 0;
|
||||
jQuery.fn.close = function () {
|
||||
closed.push(...this.toArray());
|
||||
return this;
|
||||
};
|
||||
document.body.innerHTML = '<div class="window window-active window-filedialog"></div>';
|
||||
});
|
||||
|
||||
it('closes the file dialog', () => {
|
||||
escape();
|
||||
expect(closed).toEqual([document.querySelector('.window-filedialog')]);
|
||||
});
|
||||
|
||||
it('closes only a context menu open over it', () => {
|
||||
document.body.insertAdjacentHTML('beforeend', '<div class="context-menu"></div>');
|
||||
escape();
|
||||
expect(document.querySelector('.context-menu')).toBeNull();
|
||||
expect(closed).toEqual([]);
|
||||
|
||||
escape();
|
||||
expect(closed).toEqual([document.querySelector('.window-filedialog')]);
|
||||
});
|
||||
});
|
||||
@@ -448,8 +448,6 @@ $(document).bind('keydown', async function (e) {
|
||||
else if (
|
||||
// escape key code
|
||||
e.which === 27 &&
|
||||
// an open context menu takes the Escape (below) instead
|
||||
$('.context-menu').length === 0 &&
|
||||
// active window must be a FileDialog or Alert
|
||||
($('.window-active').hasClass('window-filedialog') || $('.window-active').hasClass('window-alert')) &&
|
||||
// either don't close if an input is focused or if the input is the filename input
|
||||
|
||||
Vendored
-1
@@ -28,7 +28,6 @@ export type {
|
||||
ToolSchema,
|
||||
UpgradeReason,
|
||||
UpgradeRequestDetails,
|
||||
UpgradeResult,
|
||||
} from './types/lib/types.js';
|
||||
export type { default as APICallLogger } from './types/lib/APICallLogger.js';
|
||||
|
||||
|
||||
+114
-454
@@ -11,136 +11,22 @@ const READY_TIMEOUT_MS = 15_000;
|
||||
// A session check slower than this shows a loading scrim over the page.
|
||||
const LOADING_DELAY_MS = 200;
|
||||
|
||||
// The loading scrim matches the feedback embed's own, which fades in over it
|
||||
// once ready. A popup frame keeps it as the scrim behind its box. Scrolling
|
||||
// over the dialog stays there rather than scrolling the page behind it.
|
||||
const embedStyle = (cls) => `
|
||||
dialog.${cls}{overscroll-behavior:contain}
|
||||
dialog.${cls}::backdrop{background:transparent}
|
||||
dialog.${cls}:focus{outline:none}
|
||||
.${cls}-loading{position:absolute;inset:0;display:flex;align-items:center;justify-content:center;background:rgba(0,0,0,.5);opacity:0;pointer-events:none;transition:opacity .16s ease-in-out}
|
||||
.${cls}.is-loading .${cls}-loading{opacity:1;pointer-events:auto}
|
||||
.${cls}.is-loading iframe{visibility:hidden}
|
||||
.${cls}-loading span{width:28px;height:28px;box-sizing:border-box;border:3px solid rgba(255,255,255,.3);border-top-color:#fff;border-radius:50%;animation:${cls}-spin .7s linear infinite}
|
||||
@keyframes ${cls}-spin{to{transform:rotate(360deg)}}
|
||||
@media (prefers-color-scheme:dark){.${cls}-loading{background:rgba(0,0,0,.66)}}
|
||||
@media (prefers-reduced-motion:reduce){.${cls}-loading{transition:none}.${cls}-loading span{animation-duration:1.6s}}
|
||||
// The loading scrim matches the embed's own, which fades in over it once ready.
|
||||
const STYLE = `
|
||||
dialog.puter-feedback-embed::backdrop{background:transparent}
|
||||
dialog.puter-feedback-embed:focus{outline:none}
|
||||
.puter-feedback-embed-loading{position:absolute;inset:0;display:flex;align-items:center;justify-content:center;background:rgba(0,0,0,.5);opacity:0;pointer-events:none;transition:opacity .16s ease-in-out}
|
||||
.puter-feedback-embed.is-loading .puter-feedback-embed-loading{opacity:1;pointer-events:auto}
|
||||
.puter-feedback-embed.is-loading iframe{visibility:hidden}
|
||||
.puter-feedback-embed-loading span{width:28px;height:28px;box-sizing:border-box;border:3px solid rgba(255,255,255,.3);border-top-color:#fff;border-radius:50%;animation:puter-feedback-embed-spin .7s linear infinite}
|
||||
@keyframes puter-feedback-embed-spin{to{transform:rotate(360deg)}}
|
||||
@media (prefers-color-scheme:dark){.puter-feedback-embed-loading{background:rgba(0,0,0,.66)}}
|
||||
@media (prefers-reduced-motion:reduce){.puter-feedback-embed-loading{transition:none}.puter-feedback-embed-loading span{animation-duration:1.6s}}
|
||||
`;
|
||||
|
||||
// A popup frame sits in a box the size of the popup window it replaces, over
|
||||
// the scrim, and fills the screen on a phone as the popup's tab would. It's
|
||||
// centered by margins, which snap to device pixels where a translate can
|
||||
// leave its edge on a fraction of one. Its white backing stops 1px inside the
|
||||
// rounded edge, so in dark mode it doesn't show as a light fringe around the
|
||||
// frame. The close button starts from `all:unset` so the page's own button
|
||||
// styles don't reach it.
|
||||
const BOX_STYLE = `
|
||||
.puter-popup-frame .puter-popup-frame-loading{opacity:1;pointer-events:auto}
|
||||
.puter-popup-frame:not(.is-loading) .puter-popup-frame-loading span{display:none}
|
||||
.puter-popup-frame.is-loading .puter-popup-frame-box{visibility:hidden}
|
||||
.puter-popup-frame-box{position:absolute;inset:0;margin:auto;isolation:isolate;box-sizing:border-box;width:min(var(--puter-popup-frame-width),calc(100% - 32px));height:min(var(--puter-popup-frame-height),calc(100% - 32px));border-radius:12px;overflow:hidden;box-shadow:0 24px 64px rgba(0,0,0,.35)}
|
||||
.puter-popup-frame-box::before{content:"";position:absolute;inset:1px;z-index:-1;border-radius:11px;background:#fff}
|
||||
.puter-popup-frame-close{all:unset;box-sizing:border-box;position:absolute;top:10px;right:10px;width:32px;height:32px;display:flex;align-items:center;justify-content:center;padding:0;border:0;border-radius:50%;background:transparent;color:#6b7280;cursor:pointer}
|
||||
.puter-popup-frame-close:hover{background:rgba(127,127,127,.15)}
|
||||
.puter-popup-frame-close:focus-visible{outline:2px solid #3b82f6;outline-offset:1px}
|
||||
.puter-popup-frame-close svg{width:16px;height:16px}
|
||||
@media (prefers-color-scheme:dark){.puter-popup-frame-close{color:#9ca3af}}
|
||||
@media (max-width:600px){.puter-popup-frame-box{width:100%;height:100%;border-radius:0}.puter-popup-frame-box::before{inset:0;border-radius:0}}
|
||||
.puter-popup-frame[open] .puter-popup-frame-loading,.puter-popup-frame:not(.is-loading) .puter-popup-frame-box{animation:puter-popup-frame-in .16s ease-out}
|
||||
@keyframes puter-popup-frame-in{from{opacity:0}}
|
||||
@media (prefers-reduced-motion:reduce){.puter-popup-frame[open] .puter-popup-frame-loading,.puter-popup-frame:not(.is-loading) .puter-popup-frame-box{animation:none}}
|
||||
`;
|
||||
|
||||
const CLOSE_ICON = '<svg viewBox="0 0 16 16" aria-hidden="true"><path d="M3.5 3.5l9 9m0-9l-9 9" stroke="currentColor" stroke-width="1.6" stroke-linecap="round" fill="none"/></svg>';
|
||||
|
||||
// Subdomains the server answers or reserves itself, which it never lets frame
|
||||
// an embed (the backend's `isReservedSubdomain`). Framing from one would wait
|
||||
// on a refused frame before falling back.
|
||||
const RESERVED_LABELS = new Set(['www', 'api', 'js', 'dav', 'about', 'developer', 'docs', 'apps', 'puter-app-icons']);
|
||||
|
||||
// Dismisses the single-instance embed showing at each path.
|
||||
const showingEmbeds = new Map();
|
||||
|
||||
// Embed dialogs showing over the page, and the page's own styles to put back
|
||||
// once none is.
|
||||
const scrollLockers = new Set();
|
||||
let pageStyle = null;
|
||||
|
||||
/**
|
||||
* The element whose overflow the page's viewport uses: the body's while the
|
||||
* root's is `visible`. Hiding the root's then would make the body a scroller
|
||||
* of its own, which starts at the top.
|
||||
*
|
||||
* @returns {HTMLElement}
|
||||
*/
|
||||
const viewportOverflowElement = () => {
|
||||
const root = document.documentElement;
|
||||
const body = document.body;
|
||||
const visible = (el) => {
|
||||
const style = getComputedStyle(el);
|
||||
return style.overflowX === 'visible' && style.overflowY === 'visible';
|
||||
};
|
||||
return body && visible(root) && ! visible(body) ? body : root;
|
||||
};
|
||||
|
||||
/**
|
||||
* Stops the page scrolling behind `dialog` while it shows: Firefox and WebKit
|
||||
* pass a scroll over the frame on to the page, whatever the dialog's
|
||||
* `overscroll-behavior`. The root takes the width its scrollbar gave back as
|
||||
* padding, so the page doesn't shift. Returns the function that lets it scroll again.
|
||||
*
|
||||
* @param {HTMLDialogElement} dialog
|
||||
* @returns {() => void}
|
||||
*/
|
||||
const lockPageScroll = (dialog) => {
|
||||
const root = document.documentElement;
|
||||
const unlockPage = () => {
|
||||
const { scroller, overflow, overflowX, overflowY } = pageStyle;
|
||||
scroller.style.overflow = overflow;
|
||||
// A shorthand reads empty when the page set only one axis.
|
||||
if ( ! overflow ) {
|
||||
scroller.style.overflowX = overflowX;
|
||||
scroller.style.overflowY = overflowY;
|
||||
}
|
||||
root.style.paddingRight = pageStyle.paddingRight;
|
||||
pageStyle = null;
|
||||
};
|
||||
// One the page removed itself never unlocks, so the page's own styles
|
||||
// go back before they're read again.
|
||||
for ( const shown of scrollLockers ) if ( ! shown.isConnected ) scrollLockers.delete(shown);
|
||||
if ( scrollLockers.size === 0 && pageStyle ) unlockPage();
|
||||
if ( scrollLockers.size === 0 ) {
|
||||
const scroller = viewportOverflowElement();
|
||||
pageStyle = {
|
||||
scroller,
|
||||
overflow: scroller.style.overflow,
|
||||
overflowX: scroller.style.overflowX,
|
||||
overflowY: scroller.style.overflowY,
|
||||
paddingRight: root.style.paddingRight,
|
||||
};
|
||||
const hasScrollbar = window.innerWidth > root.clientWidth;
|
||||
const width = hasScrollbar ? root.getBoundingClientRect().width : 0;
|
||||
scroller.style.overflow = 'hidden';
|
||||
// Measured, since a gutter the page keeps (`scrollbar-gutter: stable`)
|
||||
// gives nothing back.
|
||||
const released = hasScrollbar ? root.getBoundingClientRect().width - width : 0;
|
||||
if ( released > 0 ) {
|
||||
const padding = parseFloat(getComputedStyle(root).paddingRight) || 0;
|
||||
root.style.paddingRight = `${padding + released}px`;
|
||||
}
|
||||
}
|
||||
scrollLockers.add(dialog);
|
||||
return () => {
|
||||
if ( ! scrollLockers.delete(dialog) ) return;
|
||||
for ( const shown of scrollLockers ) if ( ! shown.isConnected ) scrollLockers.delete(shown);
|
||||
if ( scrollLockers.size === 0 && pageStyle ) unlockPage();
|
||||
};
|
||||
};
|
||||
|
||||
/**
|
||||
* Whether a page at `pageUrl` may frame an embed served by `guiOrigin`:
|
||||
* exactly one label under its host, on the same scheme and port, and not one
|
||||
* of the GUI's reserved subdomains.
|
||||
* exactly one label under its host, on the same scheme and port.
|
||||
*
|
||||
* @param {string | undefined} pageUrl
|
||||
* @param {string} guiOrigin
|
||||
@@ -159,264 +45,9 @@ export const canFrameGuiEmbed = (pageUrl, guiOrigin) => {
|
||||
const suffix = `.${gui.hostname.toLowerCase()}`;
|
||||
if ( page.protocol !== gui.protocol || page.port !== gui.port || !host.endsWith(suffix) ) return false;
|
||||
const label = host.slice(0, -suffix.length);
|
||||
return label.length > 0 && !label.includes('.') && !RESERVED_LABELS.has(label);
|
||||
return label.length > 0 && !label.includes('.');
|
||||
};
|
||||
|
||||
/**
|
||||
* Whether every frame above `win` may frame an embed too. The server's
|
||||
* frame-ancestors allows only the GUI and the page, so in a frame of any other
|
||||
* site the embed is refused, and opening the popup straight away is faster.
|
||||
*
|
||||
* @param {Window} win - the page
|
||||
* @param {string} guiOrigin
|
||||
* @returns {boolean}
|
||||
*/
|
||||
export const ancestorsAllowGuiEmbed = (win, guiOrigin) => {
|
||||
let gui;
|
||||
try {
|
||||
gui = new URL(guiOrigin).origin;
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
const page = win.location.origin;
|
||||
const ancestors = win.location.ancestorOrigins;
|
||||
if ( ancestors ) return Array.from(ancestors).every((origin) => origin === page || origin === gui);
|
||||
// Without ancestorOrigins (Firefox), only a same-origin ancestor can be named.
|
||||
try {
|
||||
for ( let w = win; w.parent !== w; w = w.parent ) {
|
||||
if ( w.parent.location.origin !== page ) return false;
|
||||
}
|
||||
return true;
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Mounts `/embed/<path>` in a modal frame, hidden until the embed reports
|
||||
* `ready` and behind a loading scrim once its start takes longer than
|
||||
* LOADING_DELAY_MS. Resolves what `onMessage` finishes with, what `dismissed`
|
||||
* returns when the user cancels, or null when the frame is refused, never
|
||||
* answers, or reports itself unavailable. Never rejects.
|
||||
*
|
||||
* @template T
|
||||
* @param {Object} opts
|
||||
* @param {string} opts.guiOrigin
|
||||
* @param {string} opts.path - under the GUI origin, such as `/embed/feedback`
|
||||
* @param {Record<string, string>} opts.fragment - what the embed reads from its fragment
|
||||
* @param {string} opts.className - the dialog's class, prefixing its parts'
|
||||
* @param {string} opts.title - the frame's accessible name
|
||||
* @param {string} opts.stateMsg - `msg` of the embed's loading, ready and unavailable messages
|
||||
* @param {{ width: number, height: number }} [opts.box] - shows the frame in a box this size over a scrim; without it the frame covers the page and the embed draws its own scrim
|
||||
* @param {string} [opts.closeLabel] - puts a close button on the box, which dismisses it
|
||||
* @param {string} [opts.allow] - the frame's permissions policy, for features the embed uses
|
||||
* @param {boolean} [opts.escapeDismisses] - Escape on the page dismisses a ready embed too, instead of handing it the keys
|
||||
* @param {boolean} [opts.single] - a newer embed at this path dismisses this one, as a named popup window is reused
|
||||
* @param {() => T} opts.dismissed - the result of a dismissal: Escape or a click on the loading scrim, or the close button
|
||||
* @param {(data: Record<string, unknown>, finish: (result: T | null) => void) => void} opts.onMessage - every other message from the embed
|
||||
* @param {(frame: Window) => void} [opts.onFrame] - the frame's window, once it exists
|
||||
* @returns {Promise<T | null>}
|
||||
*/
|
||||
const mountGuiEmbed = ({ guiOrigin, path, fragment, className, title, stateMsg, box, closeLabel, allow, escapeDismisses = false, single = false, dismissed, onMessage, onFrame }) => new Promise((resolve) => {
|
||||
let origin;
|
||||
try {
|
||||
origin = new URL(guiOrigin).origin;
|
||||
} catch {
|
||||
resolve(null);
|
||||
return;
|
||||
}
|
||||
const url = new URL(path, origin);
|
||||
url.hash = new URLSearchParams(fragment).toString();
|
||||
// Before reading the focus this one restores, which the older one hands back.
|
||||
if ( single ) showingEmbeds.get(path)?.();
|
||||
|
||||
const dialog = document.createElement('dialog');
|
||||
dialog.className = className;
|
||||
dialog.setAttribute('aria-label', title);
|
||||
// Inline, so the page's own `dialog` and `iframe` styles can't move,
|
||||
// round or shrink them.
|
||||
dialog.style.cssText = 'position:fixed;inset:0;width:100%;height:100%;min-width:0;min-height:0;max-width:none;max-height:none;margin:0;padding:0;border:0;border-radius:0;box-shadow:none;transform:none;background:transparent;overflow:hidden;';
|
||||
const style = document.createElement('style');
|
||||
style.textContent = embedStyle(className) + (box ? BOX_STYLE : '');
|
||||
const frame = document.createElement('iframe');
|
||||
frame.title = title;
|
||||
// The embed allows a framing page it can name from the referrer.
|
||||
frame.setAttribute('referrerpolicy', 'origin');
|
||||
if ( allow ) frame.setAttribute('allow', allow);
|
||||
const frameBase = 'display:block;width:100%;height:100%;min-width:0;min-height:0;max-width:none;max-height:none;margin:0;padding:0;border:0;';
|
||||
// A frame whose color-scheme differs from its document's is painted
|
||||
// opaque, so this matches the embed's. WebKit also gives the frame this
|
||||
// scheme as its preferred one, so it has to follow the OS.
|
||||
frame.style.cssText = box
|
||||
? frameBase
|
||||
: `${frameBase}background:transparent;color-scheme:light dark;`;
|
||||
const loading = document.createElement('div');
|
||||
loading.className = `${className}-loading`;
|
||||
loading.setAttribute('role', 'status');
|
||||
loading.setAttribute('aria-label', 'Loading');
|
||||
loading.setAttribute('aria-hidden', 'true');
|
||||
loading.append(document.createElement('span'));
|
||||
dialog.append(style, loading);
|
||||
if ( box ) {
|
||||
const container = document.createElement('div');
|
||||
container.className = `${className}-box`;
|
||||
container.style.setProperty('--puter-popup-frame-width', `${box.width}px`);
|
||||
container.style.setProperty('--puter-popup-frame-height', `${box.height}px`);
|
||||
container.append(frame);
|
||||
if ( closeLabel ) {
|
||||
const close = document.createElement('button');
|
||||
close.type = 'button';
|
||||
close.className = `${className}-close`;
|
||||
close.setAttribute('aria-label', closeLabel);
|
||||
close.title = closeLabel;
|
||||
close.innerHTML = CLOSE_ICON;
|
||||
close.addEventListener('click', () => dismiss());
|
||||
container.append(close);
|
||||
}
|
||||
dialog.append(container);
|
||||
} else {
|
||||
dialog.insertBefore(frame, loading);
|
||||
}
|
||||
|
||||
let settled = false;
|
||||
let heard = false;
|
||||
let shown = false;
|
||||
let ready = false;
|
||||
let timer = null;
|
||||
let loadingTimer = null;
|
||||
// Each embed document posts `loading` once; these tell a document that
|
||||
// never did (one the server refused) from one that did.
|
||||
let loads = 0;
|
||||
let boots = 0;
|
||||
let wasReady = false;
|
||||
let restarted = false;
|
||||
let restartTimer = null;
|
||||
let unlockScroll = null;
|
||||
// A dialog the page removes itself, such as by re-rendering its body,
|
||||
// counts as dismissed, so whoever awaits it isn't left waiting.
|
||||
const removal = new MutationObserver(() => {
|
||||
if ( ! dialog.isConnected ) dismiss();
|
||||
});
|
||||
const restoreFocus = document.activeElement;
|
||||
const wait = (ms) => {
|
||||
clearTimeout(timer);
|
||||
timer = setTimeout(() => finish(null), ms);
|
||||
};
|
||||
const finish = (result) => {
|
||||
if ( settled ) return;
|
||||
settled = true;
|
||||
clearTimeout(timer);
|
||||
clearTimeout(loadingTimer);
|
||||
clearTimeout(restartTimer);
|
||||
removal.disconnect();
|
||||
window.removeEventListener('message', onWindowMessage);
|
||||
if ( showingEmbeds.get(path) === dismiss ) showingEmbeds.delete(path);
|
||||
dialog.remove();
|
||||
unlockScroll?.();
|
||||
if ( shown ) restoreFocus?.focus?.({ preventScroll: true });
|
||||
resolve(result);
|
||||
};
|
||||
const dismiss = () => finish(dismissed());
|
||||
if ( single ) showingEmbeds.set(path, dismiss);
|
||||
// The spinner is only faded out, so assistive tech hears it only while it shows.
|
||||
const setLoading = (on) => {
|
||||
dialog.classList.toggle('is-loading', on);
|
||||
if ( on ) loading.removeAttribute('aria-hidden');
|
||||
else loading.setAttribute('aria-hidden', 'true');
|
||||
};
|
||||
const show = () => {
|
||||
if ( dialog.open ) return;
|
||||
shown = true;
|
||||
dialog.showModal();
|
||||
unlockScroll = lockPageScroll(dialog);
|
||||
};
|
||||
const onWindowMessage = (event) => {
|
||||
if ( event.origin !== origin || event.source !== frame.contentWindow ) return;
|
||||
const data = event.data;
|
||||
if ( !data || typeof data !== 'object' ) return;
|
||||
if ( data.msg !== stateMsg || !['loading', 'ready', 'unavailable'].includes(data.state) ) {
|
||||
onMessage(data, finish);
|
||||
} else if ( data.state === 'loading' ) {
|
||||
heard = true;
|
||||
boots++;
|
||||
wait(READY_TIMEOUT_MS);
|
||||
} else if ( data.state === 'ready' ) {
|
||||
heard = true;
|
||||
ready = true;
|
||||
wasReady = true;
|
||||
restarted = false;
|
||||
clearTimeout(timer);
|
||||
clearTimeout(loadingTimer);
|
||||
setLoading(false);
|
||||
show();
|
||||
frame.focus();
|
||||
} else {
|
||||
finish(null);
|
||||
}
|
||||
};
|
||||
// A reload or navigation the embed starts itself names the embed, not
|
||||
// this page, as its referrer, so the server refuses to let it frame. This
|
||||
// page opens the embed again, once, which it allows.
|
||||
const restart = () => {
|
||||
if ( restarted ) {
|
||||
finish(null);
|
||||
return;
|
||||
}
|
||||
restarted = true;
|
||||
ready = false;
|
||||
loads = boots;
|
||||
setLoading(true);
|
||||
// As long as its first start may take, then the popup.
|
||||
wait(READY_TIMEOUT_MS);
|
||||
// WebKit takes the refused URL itself as a fragment navigation of its
|
||||
// error page, which loads nothing. The server redirects a query away,
|
||||
// and the fragment carries over the redirect.
|
||||
const reopen = new URL(url);
|
||||
reopen.search = 'reopen';
|
||||
frame.src = reopen.href;
|
||||
};
|
||||
window.addEventListener('message', onWindowMessage);
|
||||
frame.addEventListener('load', () => {
|
||||
loads++;
|
||||
if ( ! heard ) wait(LOAD_GRACE_MS);
|
||||
if ( ! wasReady || boots >= loads ) return;
|
||||
// Most likely refused: the spinner covers the error page meanwhile.
|
||||
ready = false;
|
||||
setLoading(true);
|
||||
const expected = loads;
|
||||
clearTimeout(restartTimer);
|
||||
restartTimer = setTimeout(() => {
|
||||
if ( boots < expected ) restart();
|
||||
}, LOAD_GRACE_MS);
|
||||
});
|
||||
// Once ready, Escape outside the frame would close the dialog with the
|
||||
// embed's own dialog still open inside it, so the embed owns dismissal
|
||||
// unless it dismisses on Escape too.
|
||||
dialog.addEventListener('cancel', (event) => {
|
||||
event.preventDefault();
|
||||
if ( ready && ! escapeDismisses ) frame.focus();
|
||||
else dismiss();
|
||||
});
|
||||
loading.addEventListener('click', () => {
|
||||
if ( ! ready ) dismiss();
|
||||
});
|
||||
|
||||
try {
|
||||
frame.src = url.href;
|
||||
// Hidden at first, so a quickly refused session shows nothing.
|
||||
document.body.append(dialog);
|
||||
removal.observe(document.documentElement, { childList: true, subtree: true });
|
||||
onFrame?.(frame.contentWindow);
|
||||
wait(READY_TIMEOUT_MS);
|
||||
loadingTimer = setTimeout(() => {
|
||||
setLoading(true);
|
||||
show();
|
||||
}, LOADING_DELAY_MS);
|
||||
} catch {
|
||||
finish(null);
|
||||
}
|
||||
});
|
||||
|
||||
/**
|
||||
* Shows the app feedback dialog from `/embed/feedback` in a modal frame over
|
||||
* the page, as the user named, behind a loading scrim while a slow session
|
||||
@@ -430,79 +61,108 @@ const mountGuiEmbed = ({ guiOrigin, path, fragment, className, title, stateMsg,
|
||||
* @param {string} opts.userUuid - the page's signed-in user
|
||||
* @returns {Promise<{ sent: boolean } | null>}
|
||||
*/
|
||||
export const showFeedbackEmbed = ({ guiOrigin, userUuid }) => mountGuiEmbed({
|
||||
guiOrigin,
|
||||
path: '/embed/feedback',
|
||||
fragment: { user: userUuid },
|
||||
className: 'puter-feedback-embed',
|
||||
title: 'Send feedback',
|
||||
stateMsg: 'feedbackEmbed',
|
||||
dismissed: () => ({ sent: false }),
|
||||
onMessage: ({ msg, sent }, finish) => {
|
||||
if ( msg === 'feedbackDialogClosed' ) finish({ sent: sent === true });
|
||||
},
|
||||
});
|
||||
export const showFeedbackEmbed = ({ guiOrigin, userUuid }) => new Promise((resolve) => {
|
||||
let origin;
|
||||
try {
|
||||
origin = new URL(guiOrigin).origin;
|
||||
} catch {
|
||||
resolve(null);
|
||||
return;
|
||||
}
|
||||
const url = new URL('/embed/feedback', origin);
|
||||
url.hash = new URLSearchParams({ user: userUuid }).toString();
|
||||
|
||||
/** Popup actions a first-party page shows framed, each in a box its popup window's size. */
|
||||
const POPUP_FRAME_BOXES = {
|
||||
'sign-in': { width: 600, height: 700 },
|
||||
'show-open-file-picker': { width: 700, height: 400 },
|
||||
'show-save-file-picker': { width: 700, height: 400 },
|
||||
'show-directory-picker': { width: 700, height: 400 },
|
||||
};
|
||||
const dialog = document.createElement('dialog');
|
||||
dialog.className = 'puter-feedback-embed';
|
||||
dialog.style.cssText = 'position:fixed;inset:0;width:100%;height:100%;max-width:none;max-height:none;margin:0;padding:0;border:0;background:transparent;overflow:hidden;';
|
||||
const style = document.createElement('style');
|
||||
style.textContent = STYLE;
|
||||
const frame = document.createElement('iframe');
|
||||
frame.title = 'Send feedback';
|
||||
// The embed allows a framing page it can name from the referrer.
|
||||
frame.setAttribute('referrerpolicy', 'origin');
|
||||
// A frame whose color-scheme differs from its document's is painted
|
||||
// opaque, so this matches the embed's. WebKit also gives the frame this
|
||||
// scheme as its preferred one, so it has to follow the OS.
|
||||
frame.style.cssText = 'display:block;width:100%;height:100%;border:0;background:transparent;color-scheme:light dark;';
|
||||
const loading = document.createElement('div');
|
||||
loading.className = 'puter-feedback-embed-loading';
|
||||
loading.setAttribute('role', 'status');
|
||||
loading.setAttribute('aria-label', 'Loading');
|
||||
loading.append(document.createElement('span'));
|
||||
dialog.append(style, frame, loading);
|
||||
|
||||
// The upgrade has no box: it covers the page and its dialog draws its own
|
||||
// scrim. A payment in it may use the Payment Request API, which a frame can
|
||||
// use only when allowed, and Escape is left to the dialog, which doesn't close
|
||||
// mid-entry.
|
||||
const UNBOXED_POPUP_FRAMES = {
|
||||
upgrade: { allow: 'payment; otp-credentials', escapeDismisses: false },
|
||||
};
|
||||
let settled = false;
|
||||
let heard = false;
|
||||
let shown = false;
|
||||
let ready = false;
|
||||
let timer = null;
|
||||
let loadingTimer = null;
|
||||
const restoreFocus = document.activeElement;
|
||||
const wait = (ms) => {
|
||||
clearTimeout(timer);
|
||||
timer = setTimeout(() => finish(null), ms);
|
||||
};
|
||||
const finish = (result) => {
|
||||
if ( settled ) return;
|
||||
settled = true;
|
||||
clearTimeout(timer);
|
||||
clearTimeout(loadingTimer);
|
||||
window.removeEventListener('message', onMessage);
|
||||
dialog.remove();
|
||||
if ( shown ) restoreFocus?.focus?.({ preventScroll: true });
|
||||
resolve(result);
|
||||
};
|
||||
const show = () => {
|
||||
if ( dialog.open ) return;
|
||||
shown = true;
|
||||
dialog.showModal();
|
||||
};
|
||||
const onMessage = (event) => {
|
||||
if ( event.origin !== origin || event.source !== frame.contentWindow ) return;
|
||||
const { msg, state, sent } = event.data ?? {};
|
||||
if ( msg === 'feedbackDialogClosed' ) {
|
||||
finish({ sent: sent === true });
|
||||
} else if ( msg === 'feedbackEmbed' && state === 'loading' ) {
|
||||
heard = true;
|
||||
wait(READY_TIMEOUT_MS);
|
||||
} else if ( msg === 'feedbackEmbed' && state === 'ready' ) {
|
||||
heard = true;
|
||||
ready = true;
|
||||
clearTimeout(timer);
|
||||
clearTimeout(loadingTimer);
|
||||
dialog.classList.remove('is-loading');
|
||||
show();
|
||||
frame.focus();
|
||||
} else if ( msg === 'feedbackEmbed' && state === 'unavailable' ) {
|
||||
finish(null);
|
||||
}
|
||||
};
|
||||
window.addEventListener('message', onMessage);
|
||||
frame.addEventListener('load', () => {
|
||||
if ( ! heard ) wait(LOAD_GRACE_MS);
|
||||
});
|
||||
// Once ready, Escape outside the frame would close the dialog with the
|
||||
// embed's dialog still open inside it; the embed owns dismissal.
|
||||
dialog.addEventListener('cancel', (event) => {
|
||||
event.preventDefault();
|
||||
if ( ready ) frame.focus();
|
||||
else finish({ sent: false });
|
||||
});
|
||||
loading.addEventListener('click', () => {
|
||||
if ( ! ready ) finish({ sent: false });
|
||||
});
|
||||
|
||||
/**
|
||||
* Shows the GUI popup for `action` in a frame over the page instead of a
|
||||
* window, from `/embed/<action>`. The GUI runs the popup unchanged and posts
|
||||
* its answers to this page as it would to an opener; `onMessage` sees each of
|
||||
* them and finishes with the result. The frame closing on its own, as the
|
||||
* popup would, finishes with `closed(data)`, `data` being its closing
|
||||
* message, and the user dismissing it finishes with `closed()`. Resolves null
|
||||
* when the frame can't serve the request (refused, never answering, or
|
||||
* reporting itself unavailable), so the caller can open the popup instead.
|
||||
* Never rejects.
|
||||
*
|
||||
* @template T
|
||||
* @param {Object} opts
|
||||
* @param {string} opts.guiOrigin
|
||||
* @param {'sign-in' | 'show-open-file-picker' | 'show-save-file-picker' | 'show-directory-picker' | 'upgrade'} opts.action
|
||||
* @param {Record<string, string>} opts.fragment - the popup's parameters, and `user` for a picker or the upgrade
|
||||
* @param {string} opts.title - the frame's accessible name
|
||||
* @param {string} [opts.closeLabel] - puts a close button on the frame
|
||||
* @param {(data?: Record<string, unknown>) => T} opts.closed
|
||||
* @param {(data: Record<string, unknown>, finish: (result: T) => void) => void} opts.onMessage
|
||||
* @param {(frame: Window) => void} [opts.onFrame]
|
||||
* @returns {Promise<T | null>}
|
||||
*/
|
||||
export const showPopupFrame = ({ guiOrigin, action, fragment, title, closeLabel, closed, onMessage, onFrame }) => mountGuiEmbed({
|
||||
guiOrigin,
|
||||
path: `/embed/${action}`,
|
||||
fragment,
|
||||
className: 'puter-popup-frame',
|
||||
title,
|
||||
stateMsg: 'puterPopupFrame',
|
||||
box: POPUP_FRAME_BOXES[action],
|
||||
closeLabel,
|
||||
// Signup and the account checks fill in a texted code, as in the popup.
|
||||
allow: 'otp-credentials',
|
||||
// Escape inside the frame closes it as well.
|
||||
escapeDismisses: true,
|
||||
...UNBOXED_POPUP_FRAMES[action],
|
||||
// A second request for this popup, such as from a double click, replaces the
|
||||
// first. Each popup has its own window name, so other popups stay open.
|
||||
single: true,
|
||||
dismissed: () => closed(),
|
||||
onFrame,
|
||||
onMessage: (data, finish) => {
|
||||
if ( data.msg === 'puterPopupFrame' && data.state === 'closed' ) finish(closed(data));
|
||||
else onMessage(data, finish);
|
||||
},
|
||||
try {
|
||||
frame.src = url.href;
|
||||
// Hidden at first, so a quickly refused session shows nothing.
|
||||
document.body.append(dialog);
|
||||
wait(READY_TIMEOUT_MS);
|
||||
loadingTimer = setTimeout(() => {
|
||||
dialog.classList.add('is-loading');
|
||||
show();
|
||||
}, LOADING_DELAY_MS);
|
||||
} catch {
|
||||
finish(null);
|
||||
}
|
||||
});
|
||||
@@ -1,6 +1,6 @@
|
||||
// @vitest-environment jsdom
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
||||
import { ancestorsAllowGuiEmbed, canFrameGuiEmbed, showFeedbackEmbed, showPopupFrame } from './guiEmbed.js';
|
||||
import { canFrameGuiEmbed, showFeedbackEmbed } from './guiEmbed.js';
|
||||
|
||||
const GUI_ORIGIN = 'https://puter.test';
|
||||
const USER = '0b1c9a52-3f0e-4c7a-9a65-2f6d1e8b7c40';
|
||||
@@ -36,48 +36,12 @@ describe('canFrameGuiEmbed', () => {
|
||||
['http://notes.puter.com/', 'https://puter.com', false],
|
||||
['https://notes.puter.com:8443/', 'https://puter.com', false],
|
||||
['https://notes.puter.site/', 'https://puter.com', false],
|
||||
['https://docs.puter.com/playground/', 'https://puter.com', false],
|
||||
['https://api.puter.com/', 'https://puter.com', false],
|
||||
['https://www.puter.com/', 'https://puter.com', false],
|
||||
['http://apps.puter.localhost:4100/', 'http://puter.localhost:4100', false],
|
||||
[undefined, 'https://puter.com', false],
|
||||
])('%s under %s is %s', (page, gui, expected) => {
|
||||
expect(canFrameGuiEmbed(page, gui)).toBe(expected);
|
||||
});
|
||||
});
|
||||
|
||||
describe('ancestorsAllowGuiEmbed', () => {
|
||||
const PAGE = 'https://notes.puter.test';
|
||||
/** A window at `origin` under `parent`; a cross-origin parent throws on `location`, as in a browser. */
|
||||
const fakeWindow = ({ origin = PAGE, ancestorOrigins, parent } = {}) => {
|
||||
const win = { location: { origin, ancestorOrigins } };
|
||||
win.parent = parent ?? win;
|
||||
return win;
|
||||
};
|
||||
const crossOrigin = () => {
|
||||
const win = {};
|
||||
Object.defineProperty(win, 'location', { get: () => { throw new DOMException('Blocked', 'SecurityError'); } });
|
||||
win.parent = win;
|
||||
return win;
|
||||
};
|
||||
|
||||
it.each([
|
||||
['a top-level page', [], true],
|
||||
['a frame of the same page', [PAGE], true],
|
||||
['a frame in the GUI', [PAGE, GUI_ORIGIN], true],
|
||||
['a frame of another site', ['https://other.test'], false],
|
||||
['a frame of the page inside another site', [PAGE, 'https://other.test'], false],
|
||||
])('reads ancestorOrigins for %s', (_, ancestorOrigins, expected) => {
|
||||
expect(ancestorsAllowGuiEmbed(fakeWindow({ ancestorOrigins }), GUI_ORIGIN)).toBe(expected);
|
||||
});
|
||||
|
||||
it('walks same-origin parents without ancestorOrigins', () => {
|
||||
expect(ancestorsAllowGuiEmbed(fakeWindow(), GUI_ORIGIN)).toBe(true);
|
||||
expect(ancestorsAllowGuiEmbed(fakeWindow({ parent: fakeWindow() }), GUI_ORIGIN)).toBe(true);
|
||||
expect(ancestorsAllowGuiEmbed(fakeWindow({ parent: crossOrigin() }), GUI_ORIGIN)).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe('showFeedbackEmbed', () => {
|
||||
it('loads the embed for the named user, hidden until it is ready', () => {
|
||||
showFeedbackEmbed({ guiOrigin: `${GUI_ORIGIN}/`, userUuid: USER });
|
||||
@@ -123,11 +87,10 @@ describe('showFeedbackEmbed', () => {
|
||||
await vi.advanceTimersByTimeAsync(1);
|
||||
expect(dialog.open).toBe(true);
|
||||
expect(dialog.classList.contains('is-loading')).toBe(true);
|
||||
expect(dialog.querySelector('[role="status"]').hasAttribute('aria-hidden')).toBe(false);
|
||||
expect(dialog.querySelector('[role="status"]')).not.toBeNull();
|
||||
|
||||
fromEmbed({ msg: 'feedbackEmbed', state: 'ready' });
|
||||
expect(dialog.classList.contains('is-loading')).toBe(false);
|
||||
expect(dialog.querySelector('[role="status"]').getAttribute('aria-hidden')).toBe('true');
|
||||
expect(document.activeElement).toBe(frame());
|
||||
fromEmbed({ msg: 'feedbackDialogClosed', sent: true });
|
||||
await expect(result).resolves.toEqual({ sent: true });
|
||||
@@ -229,394 +192,3 @@ describe('showFeedbackEmbed', () => {
|
||||
expect(document.querySelector('dialog')).toBeNull();
|
||||
});
|
||||
});
|
||||
|
||||
describe('showPopupFrame', () => {
|
||||
const popupFrame = () => document.querySelector('dialog.puter-popup-frame iframe');
|
||||
const fromPopup = (data, { origin = GUI_ORIGIN, source = popupFrame().contentWindow } = {}) =>
|
||||
window.dispatchEvent(new MessageEvent('message', { data, origin, source }));
|
||||
const show = (overrides = {}) => showPopupFrame({
|
||||
guiOrigin: GUI_ORIGIN,
|
||||
action: 'show-open-file-picker',
|
||||
fragment: { msg_id: '3', user: USER },
|
||||
title: 'Open file',
|
||||
closed: () => 'closed',
|
||||
onMessage: () => {},
|
||||
...overrides,
|
||||
});
|
||||
|
||||
it('loads the popup action with its parameters in the fragment, hidden until ready', () => {
|
||||
let framed;
|
||||
show({ onFrame: (win) => {
|
||||
framed = win;
|
||||
} });
|
||||
const url = new URL(popupFrame().src);
|
||||
expect(url.origin + url.pathname).toBe(`${GUI_ORIGIN}/embed/show-open-file-picker`);
|
||||
expect(url.search).toBe('');
|
||||
expect(Object.fromEntries(new URLSearchParams(url.hash.slice(1)))).toEqual({ msg_id: '3', user: USER });
|
||||
expect(popupFrame().getAttribute('referrerpolicy')).toBe('origin');
|
||||
expect(popupFrame().closest('dialog').getAttribute('aria-label')).toBe('Open file');
|
||||
expect(popupFrame().getAttribute('allow')).toBe('otp-credentials');
|
||||
expect(framed).toBe(popupFrame().contentWindow);
|
||||
expect(popupFrame().closest('dialog').open).toBe(false);
|
||||
});
|
||||
|
||||
it('sizes the box like the popup window it replaces', () => {
|
||||
show({ action: 'sign-in', fragment: { msg_id: 'a' } });
|
||||
const box = document.querySelector('.puter-popup-frame-box');
|
||||
expect(box.style.getPropertyValue('--puter-popup-frame-width')).toBe('600px');
|
||||
expect(box.style.getPropertyValue('--puter-popup-frame-height')).toBe('700px');
|
||||
expect(box.contains(popupFrame())).toBe(true);
|
||||
});
|
||||
|
||||
it('shows once ready and hands every other message to the caller to finish with', async () => {
|
||||
const seen = [];
|
||||
const result = show({ onMessage: (data, finish) => {
|
||||
seen.push(data.msg);
|
||||
if ( data.msg === 'fileOpenPicked' ) finish('picked');
|
||||
} });
|
||||
const dialog = popupFrame().closest('dialog');
|
||||
const status = dialog.querySelector('[role="status"]');
|
||||
expect(status.getAttribute('aria-hidden')).toBe('true');
|
||||
fromPopup({ msg: 'puterPopupFrame', state: 'loading' });
|
||||
fromPopup({ msg: 'puterPopupFrame', state: 'ready' });
|
||||
expect(dialog.open).toBe(true);
|
||||
expect(status.getAttribute('aria-hidden')).toBe('true');
|
||||
expect(document.activeElement).toBe(popupFrame());
|
||||
fromPopup({ msg: 'puter.token', success: true });
|
||||
fromPopup({ msg: 'fileOpenPicked' });
|
||||
await expect(result).resolves.toBe('picked');
|
||||
expect(seen).toEqual(['puter.token', 'fileOpenPicked']);
|
||||
expect(dialog.isConnected).toBe(false);
|
||||
});
|
||||
|
||||
it('opens itself again when the embed reloads into a refused frame, once per ready', async () => {
|
||||
vi.useFakeTimers();
|
||||
const result = show();
|
||||
const iframe = popupFrame();
|
||||
const dialog = iframe.closest('dialog');
|
||||
const srcSet = vi.spyOn(iframe, 'src', 'set');
|
||||
const load = () => iframe.dispatchEvent(new Event('load'));
|
||||
fromPopup({ msg: 'puterPopupFrame', state: 'loading' });
|
||||
load();
|
||||
fromPopup({ msg: 'puterPopupFrame', state: 'ready' });
|
||||
|
||||
// A reload the embed starts itself loads a document that never posts.
|
||||
load();
|
||||
expect(dialog.classList.contains('is-loading')).toBe(true);
|
||||
vi.advanceTimersByTime(1000);
|
||||
expect(srcSet).toHaveBeenCalledTimes(1);
|
||||
// Not just the refused URL again, which WebKit takes as a fragment
|
||||
// navigation of the error page: the server redirects the query away.
|
||||
const opened = new URL(iframe.src);
|
||||
const reopened = new URL(srcSet.mock.calls[0][0]);
|
||||
expect(reopened.search).not.toBe('');
|
||||
expect(reopened.origin + reopened.pathname + reopened.hash).toBe(opened.origin + opened.pathname + opened.hash);
|
||||
expect(dialog.classList.contains('is-loading')).toBe(true);
|
||||
|
||||
// The page's own reload boots, before or after its load event.
|
||||
fromPopup({ msg: 'puterPopupFrame', state: 'loading' });
|
||||
load();
|
||||
vi.advanceTimersByTime(1000);
|
||||
expect(srcSet).toHaveBeenCalledTimes(1);
|
||||
fromPopup({ msg: 'puterPopupFrame', state: 'ready' });
|
||||
expect(dialog.classList.contains('is-loading')).toBe(false);
|
||||
|
||||
// Ready again, so a later refusal is retried too, but not twice running.
|
||||
load();
|
||||
vi.advanceTimersByTime(1000);
|
||||
expect(srcSet).toHaveBeenCalledTimes(2);
|
||||
load();
|
||||
vi.advanceTimersByTime(1000);
|
||||
await expect(result).resolves.toBeNull();
|
||||
expect(srcSet).toHaveBeenCalledTimes(2);
|
||||
});
|
||||
|
||||
it('falls back to the popup when the embed it opens again never loads', async () => {
|
||||
vi.useFakeTimers();
|
||||
const result = show();
|
||||
const iframe = popupFrame();
|
||||
const dialog = iframe.closest('dialog');
|
||||
const load = () => iframe.dispatchEvent(new Event('load'));
|
||||
fromPopup({ msg: 'puterPopupFrame', state: 'loading' });
|
||||
load();
|
||||
fromPopup({ msg: 'puterPopupFrame', state: 'ready' });
|
||||
|
||||
// Refused after a reload of its own, then reopened on a stalled connection.
|
||||
load();
|
||||
vi.advanceTimersByTime(1000);
|
||||
vi.advanceTimersByTime(14_999);
|
||||
expect(dialog.isConnected).toBe(true);
|
||||
vi.advanceTimersByTime(1);
|
||||
await expect(result).resolves.toBeNull();
|
||||
expect(dialog.isConnected).toBe(false);
|
||||
});
|
||||
|
||||
it('keeps showing an embed that was ready before its load event fired', () => {
|
||||
vi.useFakeTimers();
|
||||
show();
|
||||
const iframe = popupFrame();
|
||||
const dialog = iframe.closest('dialog');
|
||||
const srcSet = vi.spyOn(iframe, 'src', 'set');
|
||||
const load = () => iframe.dispatchEvent(new Event('load'));
|
||||
fromPopup({ msg: 'puterPopupFrame', state: 'loading' });
|
||||
load();
|
||||
fromPopup({ msg: 'puterPopupFrame', state: 'ready' });
|
||||
load();
|
||||
vi.advanceTimersByTime(1000);
|
||||
expect(srcSet).toHaveBeenCalledTimes(1);
|
||||
|
||||
// The page's reload shows its UI while a slow image still loads.
|
||||
fromPopup({ msg: 'puterPopupFrame', state: 'loading' });
|
||||
fromPopup({ msg: 'puterPopupFrame', state: 'ready' });
|
||||
load();
|
||||
vi.advanceTimersByTime(5000);
|
||||
expect(dialog.classList.contains('is-loading')).toBe(false);
|
||||
expect(srcSet).toHaveBeenCalledTimes(1);
|
||||
expect(dialog.isConnected).toBe(true);
|
||||
});
|
||||
|
||||
it('closes on Escape outside the frame once ready, as Escape inside it does', async () => {
|
||||
const result = show();
|
||||
const dialog = popupFrame().closest('dialog');
|
||||
fromPopup({ msg: 'puterPopupFrame', state: 'ready' });
|
||||
const cancel = new Event('cancel', { cancelable: true });
|
||||
dialog.dispatchEvent(cancel);
|
||||
expect(cancel.defaultPrevented).toBe(true);
|
||||
await expect(result).resolves.toBe('closed');
|
||||
expect(dialog.isConnected).toBe(false);
|
||||
});
|
||||
|
||||
it('finishes as closed when the popup closes itself', async () => {
|
||||
const result = show();
|
||||
fromPopup({ msg: 'puterPopupFrame', state: 'ready' });
|
||||
fromPopup({ msg: 'puterPopupFrame', state: 'closed' });
|
||||
await expect(result).resolves.toBe('closed');
|
||||
expect(document.querySelector('dialog')).toBeNull();
|
||||
});
|
||||
|
||||
it('offers a close button only when asked, which finishes as closed', async () => {
|
||||
show();
|
||||
expect(document.querySelector('.puter-popup-frame-close')).toBeNull();
|
||||
document.body.innerHTML = '';
|
||||
|
||||
const result = show({ action: 'sign-in', closeLabel: 'Close' });
|
||||
fromPopup({ msg: 'puterPopupFrame', state: 'ready' });
|
||||
const close = document.querySelector('.puter-popup-frame-close');
|
||||
expect(close.getAttribute('aria-label')).toBe('Close');
|
||||
close.click();
|
||||
await expect(result).resolves.toBe('closed');
|
||||
});
|
||||
|
||||
it('resolves null for the popup when the frame is unavailable or refused', async () => {
|
||||
const unavailable = show();
|
||||
fromPopup({ msg: 'puterPopupFrame', state: 'loading' });
|
||||
fromPopup({ msg: 'puterPopupFrame', state: 'unavailable' });
|
||||
await expect(unavailable).resolves.toBeNull();
|
||||
|
||||
vi.useFakeTimers();
|
||||
const refused = show();
|
||||
popupFrame().dispatchEvent(new Event('load'));
|
||||
await vi.advanceTimersByTimeAsync(1000);
|
||||
await expect(refused).resolves.toBeNull();
|
||||
});
|
||||
|
||||
it('lets the user dismiss the loading scrim, finishing as closed', async () => {
|
||||
vi.useFakeTimers();
|
||||
const result = show();
|
||||
await vi.advanceTimersByTimeAsync(200);
|
||||
document.querySelector('.puter-popup-frame-loading').click();
|
||||
await expect(result).resolves.toBe('closed');
|
||||
});
|
||||
|
||||
it('replaces a popup frame that is showing, finishing it as closed', async () => {
|
||||
const button = document.createElement('button');
|
||||
document.body.append(button);
|
||||
button.focus();
|
||||
const first = show();
|
||||
fromPopup({ msg: 'puterPopupFrame', state: 'ready' });
|
||||
const firstDialog = popupFrame().closest('dialog');
|
||||
const second = show({ fragment: { msg_id: '4', user: USER } });
|
||||
await expect(first).resolves.toBe('closed');
|
||||
expect(firstDialog.isConnected).toBe(false);
|
||||
expect(document.querySelectorAll('dialog.puter-popup-frame')).toHaveLength(1);
|
||||
fromPopup({ msg: 'puterPopupFrame', state: 'ready' });
|
||||
fromPopup({ msg: 'puterPopupFrame', state: 'closed' });
|
||||
await expect(second).resolves.toBe('closed');
|
||||
expect(document.activeElement).toBe(button);
|
||||
});
|
||||
|
||||
it('leaves a popup frame for another action showing, as its popup window would stay open', async () => {
|
||||
const picker = show();
|
||||
fromPopup({ msg: 'puterPopupFrame', state: 'ready' });
|
||||
const pickerFrame = popupFrame();
|
||||
const signIn = show({ action: 'sign-in', fragment: { msg_id: 'a' } });
|
||||
expect(document.querySelectorAll('dialog.puter-popup-frame')).toHaveLength(2);
|
||||
const signInFrame = document.querySelectorAll('dialog.puter-popup-frame iframe')[1];
|
||||
fromPopup({ msg: 'puterPopupFrame', state: 'closed' }, { source: signInFrame.contentWindow });
|
||||
await expect(signIn).resolves.toBe('closed');
|
||||
expect(pickerFrame.isConnected).toBe(true);
|
||||
fromPopup({ msg: 'puterPopupFrame', state: 'closed' }, { source: pickerFrame.contentWindow });
|
||||
await expect(picker).resolves.toBe('closed');
|
||||
});
|
||||
|
||||
it('finishes as closed when the page removes it, letting the page scroll again', async () => {
|
||||
const result = show({ action: 'upgrade', fragment: { user: USER } });
|
||||
fromPopup({ msg: 'puterPopupFrame', state: 'ready' });
|
||||
expect(document.documentElement.style.overflow).toBe('hidden');
|
||||
document.body.innerHTML = '<main>re-rendered</main>';
|
||||
await expect(result).resolves.toBe('closed');
|
||||
expect(document.documentElement.style.overflow).toBe('');
|
||||
});
|
||||
|
||||
it('keeps the scrim behind a ready frame from dismissing it', () => {
|
||||
show();
|
||||
fromPopup({ msg: 'puterPopupFrame', state: 'ready' });
|
||||
document.querySelector('.puter-popup-frame-loading').click();
|
||||
expect(popupFrame().closest('dialog').isConnected).toBe(true);
|
||||
});
|
||||
|
||||
it('ignores messages from another origin or another window', async () => {
|
||||
const onMessage = vi.fn();
|
||||
show({ onMessage });
|
||||
fromPopup({ msg: 'puterPopupFrame', state: 'closed' }, { origin: 'https://other.test' });
|
||||
fromPopup({ msg: 'fileOpenPicked' }, { source: window });
|
||||
expect(onMessage).not.toHaveBeenCalled();
|
||||
expect(popupFrame().closest('dialog').isConnected).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe('page scroll behind an embed', () => {
|
||||
const root = document.documentElement;
|
||||
const popupFrame = (action) => document.querySelector(`dialog.puter-popup-frame iframe[src*="/embed/${action}"]`);
|
||||
const show = (action, closed = () => 'closed') => showPopupFrame({
|
||||
guiOrigin: GUI_ORIGIN,
|
||||
action,
|
||||
fragment: { user: USER },
|
||||
title: action,
|
||||
closed,
|
||||
onMessage: () => {},
|
||||
});
|
||||
const tell = (action, state) => window.dispatchEvent(new MessageEvent('message', {
|
||||
data: { msg: 'puterPopupFrame', state },
|
||||
origin: GUI_ORIGIN,
|
||||
source: popupFrame(action).contentWindow,
|
||||
}));
|
||||
/**
|
||||
* Gives the page a classic scrollbar this wide, or none, whose space comes
|
||||
* back once the root stops scrolling unless the page keeps its gutter.
|
||||
*/
|
||||
const scrollbar = (width, { gutterKept = false } = {}) => {
|
||||
vi.spyOn(root, 'clientWidth', 'get').mockReturnValue(window.innerWidth - width);
|
||||
vi.spyOn(root, 'getBoundingClientRect').mockImplementation(() => ({
|
||||
width: window.innerWidth - (root.style.overflow === 'hidden' && ! gutterKept ? 0 : width),
|
||||
}));
|
||||
};
|
||||
|
||||
// Earlier tests leave dialogs that never closed, which locked the page.
|
||||
beforeEach(() => {
|
||||
root.removeAttribute('style');
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
vi.restoreAllMocks();
|
||||
root.removeAttribute('style');
|
||||
document.body.removeAttribute('style');
|
||||
});
|
||||
|
||||
it('stops while the embed shows and comes back as the page had it once it closes', async () => {
|
||||
scrollbar(0);
|
||||
root.style.overflow = 'clip';
|
||||
const result = show('upgrade');
|
||||
tell('upgrade', 'loading');
|
||||
expect(root.style.overflow).toBe('clip');
|
||||
|
||||
tell('upgrade', 'ready');
|
||||
expect(root.style.overflow).toBe('hidden');
|
||||
expect(root.style.paddingRight).toBe('');
|
||||
|
||||
tell('upgrade', 'closed');
|
||||
await expect(result).resolves.toBe('closed');
|
||||
expect(root.style.overflow).toBe('clip');
|
||||
});
|
||||
|
||||
it('stops the body instead when the viewport scrolls by the body\'s overflow', async () => {
|
||||
scrollbar(0);
|
||||
root.style.overflow = 'visible';
|
||||
document.body.style.overflowX = 'hidden';
|
||||
const result = show('upgrade');
|
||||
tell('upgrade', 'ready');
|
||||
expect(document.body.style.overflow).toBe('hidden');
|
||||
expect(root.style.overflow).toBe('visible');
|
||||
|
||||
tell('upgrade', 'closed');
|
||||
await result;
|
||||
expect(document.body.style.overflowX).toBe('hidden');
|
||||
expect(document.body.style.overflowY).toBe('');
|
||||
});
|
||||
|
||||
it('keeps the space of a classic scrollbar, so the page doesn\'t shift', async () => {
|
||||
scrollbar(15);
|
||||
root.style.paddingRight = '8px';
|
||||
const result = show('upgrade');
|
||||
tell('upgrade', 'ready');
|
||||
expect(root.style.overflow).toBe('hidden');
|
||||
expect(root.style.paddingRight).toBe('23px');
|
||||
tell('upgrade', 'closed');
|
||||
await result;
|
||||
expect(root.style.paddingRight).toBe('8px');
|
||||
expect(root.style.overflow).toBe('');
|
||||
});
|
||||
|
||||
it('adds no space for a scrollbar whose gutter the page keeps', async () => {
|
||||
scrollbar(15, { gutterKept: true });
|
||||
const result = show('upgrade');
|
||||
tell('upgrade', 'ready');
|
||||
expect(root.style.overflow).toBe('hidden');
|
||||
expect(root.style.paddingRight).toBe('');
|
||||
tell('upgrade', 'closed');
|
||||
await result;
|
||||
});
|
||||
|
||||
it('stops behind the loading scrim too, and stays stopped until the last embed closes', async () => {
|
||||
vi.useFakeTimers();
|
||||
scrollbar(0);
|
||||
const upgrade = show('upgrade');
|
||||
await vi.advanceTimersByTimeAsync(200);
|
||||
expect(root.style.overflow).toBe('hidden');
|
||||
const signIn = show('sign-in');
|
||||
tell('sign-in', 'ready');
|
||||
|
||||
tell('sign-in', 'closed');
|
||||
await signIn;
|
||||
expect(root.style.overflow).toBe('hidden');
|
||||
tell('upgrade', 'closed');
|
||||
await upgrade;
|
||||
expect(root.style.overflow).toBe('');
|
||||
});
|
||||
|
||||
it('gives the page its own styles back after an embed the page removed itself', async () => {
|
||||
scrollbar(15);
|
||||
root.style.paddingRight = '8px';
|
||||
show('upgrade');
|
||||
tell('upgrade', 'ready');
|
||||
document.querySelector('dialog.puter-popup-frame').remove();
|
||||
|
||||
const signIn = show('sign-in');
|
||||
tell('sign-in', 'ready');
|
||||
expect(root.style.overflow).toBe('hidden');
|
||||
expect(root.style.paddingRight).toBe('23px');
|
||||
tell('sign-in', 'closed');
|
||||
await signIn;
|
||||
|
||||
expect(root.style.overflow).toBe('');
|
||||
expect(root.style.paddingRight).toBe('8px');
|
||||
});
|
||||
|
||||
it('leaves the page alone for an embed that never showed', async () => {
|
||||
scrollbar(0);
|
||||
const result = show('upgrade');
|
||||
tell('upgrade', 'unavailable');
|
||||
await expect(result).resolves.toBeNull();
|
||||
expect(root.style.overflow).toBe('');
|
||||
});
|
||||
});
|
||||
@@ -50,15 +50,6 @@
|
||||
* @property {string} [message] One sentence saying what was refused and why.
|
||||
*/
|
||||
|
||||
/**
|
||||
* How a framed upgrade on a first-party page ended.
|
||||
*
|
||||
* @typedef {Object} UpgradeResult
|
||||
* @property {boolean} upgraded `true` when the user subscribed to a plan or upgraded to a higher
|
||||
* one before closing the dialog. `false` otherwise, including after a downgrade or cancellation,
|
||||
* or when the upgrade opened in a new tab instead.
|
||||
*/
|
||||
|
||||
/**
|
||||
* The legacy positional callbacks most methods accept alongside the promise
|
||||
* they return.
|
||||
|
||||
@@ -26,7 +26,7 @@ import { showUsageLimitDialog } from '../modules/UsageLimitDialog.js';
|
||||
*
|
||||
* @typedef {{
|
||||
* env?: string,
|
||||
* ui?: { requestUpgrade: Function, canShowUpgradeFrame_?: () => boolean, upgradeFrameShowing_?: () => boolean },
|
||||
* ui?: { requestUpgrade: Function },
|
||||
* authToken?: string,
|
||||
* appID?: string,
|
||||
* getAppIDFromAuthToken?: (token: unknown) => string | null,
|
||||
@@ -109,8 +109,7 @@ const messageFor = (reason, error, context) => {
|
||||
* Inside an app the desktop's upgrade flow is asked for (and not awaited: it
|
||||
* never answers). The SDK's own dialog covers storage refusals everywhere
|
||||
* else - the desktop leans on it for those - and funding / plan refusals on
|
||||
* websites only. On a first-party page its Upgrade button shows the upgrade
|
||||
* in a frame over the page. The error is not consumed; callers still reject.
|
||||
* third-party sites only. The error is not consumed; callers still reject.
|
||||
*
|
||||
* @param {unknown} error The rejection, in whatever shape it arrived.
|
||||
* @param {UpgradePromptContext} [context] Which SDK method was refused and,
|
||||
@@ -128,26 +127,11 @@ export const promptIfUpgradeRequired = (error, context = {}, puter = globalThis.
|
||||
if ( puter?.env === 'app' ) {
|
||||
puter.ui.requestUpgrade({ reason, method, message });
|
||||
} else if ( puter?.env === 'web' || reason === 'storage' ) {
|
||||
// The upgrade a first-party page already shows answers this refusal
|
||||
// too, and a dialog over it would block it.
|
||||
if ( puter.ui?.upgradeFrameShowing_?.() === true ) return;
|
||||
// A first-party page shows the upgrade in a frame over itself
|
||||
// instead of a dashboard tab.
|
||||
const framed = puter?.env === 'web' && puter.ui?.canShowUpgradeFrame_?.() === true;
|
||||
showUsageLimitDialog(message, {
|
||||
title: TITLES[reason],
|
||||
method,
|
||||
reason,
|
||||
appID: appIDOf(puter),
|
||||
...(framed ? {
|
||||
// The page may have stopped being able to frame it, such as
|
||||
// by signing out, since the dialog opened.
|
||||
onUpgrade: () => {
|
||||
if ( puter.ui.canShowUpgradeFrame_?.() !== true ) return false;
|
||||
puter.ui.requestUpgrade({ reason, method, message });
|
||||
return true;
|
||||
},
|
||||
} : {}),
|
||||
});
|
||||
}
|
||||
};
|
||||
@@ -159,5 +143,5 @@ export const promptIfUpgradeRequired = (error, context = {}, puter = globalThis.
|
||||
* @param {PromptingSdk | undefined} puter
|
||||
* @returns {string | undefined}
|
||||
*/
|
||||
export const appIDOf = (puter) =>
|
||||
const appIDOf = (puter) =>
|
||||
puter?.getAppIDFromAuthToken?.(puter.authToken) || puter?.appID || undefined;
|
||||
@@ -179,57 +179,6 @@ describe('promptIfUpgradeRequired', () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe('on a first-party page that can frame the upgrade', () => {
|
||||
beforeEach(() => {
|
||||
globalThis.puter = {
|
||||
env: 'web',
|
||||
ui: { requestUpgrade: vi.fn(), canShowUpgradeFrame_: () => true },
|
||||
};
|
||||
});
|
||||
|
||||
it('has the dialog ask for the framed upgrade instead of opening a tab', () => {
|
||||
promptIfUpgradeRequired({ code: 'insufficient_funds', status: 402 }, { method: 'puter.ai.chat' });
|
||||
expect(globalThis.puter.ui.requestUpgrade).not.toHaveBeenCalled();
|
||||
const [message, options] = showUsageLimitDialog.mock.calls[0];
|
||||
expect(message).toBe('Your account does not have enough funding to complete this request.');
|
||||
expect(options).toMatchObject({ title: 'Low Balance', method: 'puter.ai.chat', reason: 'funds' });
|
||||
|
||||
expect(options.onUpgrade()).toBe(true);
|
||||
expect(globalThis.puter.ui.requestUpgrade).toHaveBeenCalledWith({
|
||||
reason: 'funds',
|
||||
method: 'puter.ai.chat',
|
||||
message: 'Your account does not have enough funding to complete this request.',
|
||||
});
|
||||
});
|
||||
|
||||
it('leaves the tab to the dialog when the page can no longer frame it by the click', () => {
|
||||
promptIfUpgradeRequired({ code: 'insufficient_funds', status: 402 }, { method: 'puter.ai.chat' });
|
||||
globalThis.puter.ui.canShowUpgradeFrame_ = () => false;
|
||||
expect(showUsageLimitDialog.mock.calls[0][1].onUpgrade()).toBe(false);
|
||||
expect(globalThis.puter.ui.requestUpgrade).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('shows no dialog over an upgrade the page already shows', () => {
|
||||
globalThis.puter.ui.upgradeFrameShowing_ = () => true;
|
||||
promptIfUpgradeRequired({ code: 'insufficient_funds', status: 402 }, { method: 'puter.ai.chat' });
|
||||
promptIfUpgradeRequired({ code: 'storage_limit_reached' }, { method: 'puter.fs.upload' });
|
||||
expect(showUsageLimitDialog).not.toHaveBeenCalled();
|
||||
expect(globalThis.puter.ui.requestUpgrade).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('keeps the tab when the page cannot frame it', () => {
|
||||
globalThis.puter.ui.canShowUpgradeFrame_ = () => false;
|
||||
promptIfUpgradeRequired({ code: 'storage_limit_reached' }, { method: 'puter.fs.upload' });
|
||||
expect(showUsageLimitDialog.mock.calls[0][1]).not.toHaveProperty('onUpgrade');
|
||||
});
|
||||
|
||||
it('keeps the tab for a storage refusal outside a website', () => {
|
||||
globalThis.puter.env = 'gui';
|
||||
promptIfUpgradeRequired({ code: 'storage_limit_reached' }, { method: 'puter.fs.upload' });
|
||||
expect(showUsageLimitDialog.mock.calls[0][1]).not.toHaveProperty('onUpgrade');
|
||||
});
|
||||
});
|
||||
|
||||
it('does nothing for a rejection an upgrade would not clear', () => {
|
||||
promptIfUpgradeRequired({ status: 403 });
|
||||
promptIfUpgradeRequired(new Error('offline'));
|
||||
|
||||
@@ -3,7 +3,6 @@ import { fetchUrl } from '../lib/networkUtils.js';
|
||||
import { PuterModule } from '../lib/PuterModule.js';
|
||||
import PuterDialog from './PuterDialog.js';
|
||||
import { hasOpaqueOrigin } from '../lib/auth-popup.js';
|
||||
import { ancestorsAllowGuiEmbed, canFrameGuiEmbed, showPopupFrame } from '../lib/guiEmbed.js';
|
||||
|
||||
/**
|
||||
* Puter user details, as returned by `getUser()`.
|
||||
@@ -116,19 +115,12 @@ export class AuthModule extends PuterModule {
|
||||
/** @internal */
|
||||
pendingSignInMessageIds_ = new Set();
|
||||
|
||||
/** The framed sign-in in progress, which a repeated call joins. */
|
||||
#framedSignIn = null;
|
||||
|
||||
/**
|
||||
* Signs the user in, opening a popup with the appropriate authentication
|
||||
* method. Must be called from a user gesture (such as a click) — without
|
||||
* one, a consent dialog is shown first so the popup can be opened from the
|
||||
* user's click on it. Resolves once the user has signed in.
|
||||
*
|
||||
* On a page one label under the Puter origin, the sign-in shows in a frame
|
||||
* over the page instead, and continues in the popup when the user picks a
|
||||
* federated provider or the frame can't be shown.
|
||||
*
|
||||
* Rejects with `{ error: 'popup_blocked' }` if the browser blocked the
|
||||
* popup, `{ error: 'auth_window_closed' }` if the user closed it, `{ error:
|
||||
* 'not_available_in_app' }` when called from an app — an app's token comes
|
||||
@@ -176,128 +168,12 @@ export class AuthModule extends PuterModule {
|
||||
: this.signIn(options));
|
||||
}
|
||||
|
||||
if (this.#canSignInInFrame(options)) {
|
||||
// A second call, such as from a double click or a `puter.*` call
|
||||
// asking for implicit auth, waits on the first rather than
|
||||
// replacing its frame, which would reject the first.
|
||||
if (this.#framedSignIn) return this.#framedSignIn;
|
||||
const promise = this.#signInInFrame(options).then((result) =>
|
||||
result ?? this.#signInWithPopup(options));
|
||||
const done = () => {
|
||||
if (this.#framedSignIn === promise) this.#framedSignIn = null;
|
||||
};
|
||||
this.#framedSignIn = promise;
|
||||
promise.then(done, done);
|
||||
return promise;
|
||||
}
|
||||
return this.#signInWithPopup(options);
|
||||
};
|
||||
|
||||
/**
|
||||
* Whether this page can show the sign-in framed: a first-party page one
|
||||
* label under the GUI origin, not in a frame of another site. Only the
|
||||
* popup creates a temporary account, so a sign-in that asks for one keeps
|
||||
* it.
|
||||
*/
|
||||
#canSignInInFrame (options) {
|
||||
return !options.attempt_temp_user_creation &&
|
||||
!globalThis.crossOriginIsolated &&
|
||||
!!globalThis.document?.body &&
|
||||
canFrameGuiEmbed(globalThis.location?.href, puter.defaultGUIOrigin) &&
|
||||
ancestorsAllowGuiEmbed(globalThis, puter.defaultGUIOrigin);
|
||||
}
|
||||
|
||||
/** Runs `puter.onAuth`, if set, with the user just signed in. */
|
||||
#notifyAuth () {
|
||||
if (typeof puter.onAuth !== 'function') return;
|
||||
void (async () => {
|
||||
try {
|
||||
const user = await puter.whoamiCache_;
|
||||
puter.onAuth(user ?? (await puter.getUser()));
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
})();
|
||||
}
|
||||
|
||||
/**
|
||||
* The sign-in in a frame over the page. Settles as the popup would, or
|
||||
* resolves null when the popup has to take over.
|
||||
*
|
||||
* @returns {Promise<SignInResult | null>}
|
||||
*/
|
||||
async #signInInFrame (options) {
|
||||
const msg_id = crypto.randomUUID();
|
||||
this.pendingSignInMessageIds_.add(msg_id);
|
||||
const fragment = { msg_id };
|
||||
if (options.request_auth) fragment.request_auth = 'true';
|
||||
let outcome;
|
||||
try {
|
||||
outcome = await showPopupFrame({
|
||||
guiOrigin: puter.defaultGUIOrigin,
|
||||
action: 'sign-in',
|
||||
fragment,
|
||||
title: 'Sign in to Puter',
|
||||
closeLabel: 'Close',
|
||||
closed: () => ({ closed: true }),
|
||||
onMessage: (data, finish) => {
|
||||
if (data.msg === 'puterPopupFrame' && data.state === 'provider') {
|
||||
if (this.#isProviderStart(data.url, msg_id)) finish({ providerUrl: data.url });
|
||||
return;
|
||||
}
|
||||
if (data.msg !== 'puter.token' || data.msg_id != msg_id) return;
|
||||
finish({ reply: data });
|
||||
},
|
||||
});
|
||||
} finally {
|
||||
this.pendingSignInMessageIds_.delete(msg_id);
|
||||
}
|
||||
if (!outcome) return null;
|
||||
// A provider won't load in a frame, so its sign-in continues in the
|
||||
// popup, which the provider returns as this attempt's sign-in popup.
|
||||
if (outcome.providerUrl) {
|
||||
return this.#signInWithPopup(options, { url: outcome.providerUrl, msgId: msg_id });
|
||||
}
|
||||
if (outcome.closed) {
|
||||
throw {
|
||||
error: 'auth_window_closed',
|
||||
msg: 'Authentication window was closed by the user without completing the process.',
|
||||
};
|
||||
}
|
||||
const { msg: _msg, msg_id: _msgId, ...result } = outcome.reply;
|
||||
if (!result.success) throw result;
|
||||
puter.setAuthToken(result.token);
|
||||
this.#notifyAuth();
|
||||
return result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether `url` is the GUI's start of a provider sign-in that returns as
|
||||
* the popup for sign-in `msgId`.
|
||||
*/
|
||||
#isProviderStart (url, msgId) {
|
||||
try {
|
||||
const start = new URL(url);
|
||||
return start.origin === new URL(puter.defaultGUIOrigin).origin &&
|
||||
/^\/auth\/oidc\/[^/]+\/start$/.test(start.pathname) &&
|
||||
start.searchParams.get('embedded_in_popup') === 'true' &&
|
||||
start.searchParams.get('msg_id') === msgId;
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* The sign-in in a popup window, opened at `start.url` for sign-in
|
||||
* `start.msgId` when a framed sign-in hands one over.
|
||||
*/
|
||||
#signInWithPopup (options, start = {}) {
|
||||
return new Promise((resolve, reject) => {
|
||||
const signinsession = crypto.randomUUID();
|
||||
const msg_id = start.msgId ?? signinsession;
|
||||
const msg_id = signinsession;
|
||||
this.pendingSignInMessageIds_.add(msg_id);
|
||||
const popupName = `Puter-sign-in-${signinsession}`;
|
||||
const url = start.url ?? `${puter.defaultGUIOrigin}/action/sign-in?embedded_in_popup=true&msg_id=${msg_id}${window.crossOriginIsolated ? `&cross_origin_isolated=true&signin_session=${signinsession}` : ''}${options.attempt_temp_user_creation ? '&attempt_temp_user_creation=true' : ''}${options.request_auth ? '&request_auth=true' : ''}`;
|
||||
const url = `${puter.defaultGUIOrigin}/action/sign-in?embedded_in_popup=true&msg_id=${msg_id}${window.crossOriginIsolated ? `&cross_origin_isolated=true&signin_session=${signinsession}` : ''}${options.attempt_temp_user_creation ? '&attempt_temp_user_creation=true' : ''}${options.request_auth ? '&request_auth=true' : ''}`;
|
||||
|
||||
// Guards against settling the promise more than once across the
|
||||
// message, popup-closed, and dialog-cancel code paths.
|
||||
@@ -320,7 +196,17 @@ export class AuthModule extends PuterModule {
|
||||
consentDialog = null;
|
||||
};
|
||||
|
||||
const notifyAuth = () => this.#notifyAuth();
|
||||
const notifyAuth = () => {
|
||||
if (typeof puter.onAuth !== 'function') return;
|
||||
void (async () => {
|
||||
try {
|
||||
const user = await puter.whoamiCache_;
|
||||
puter.onAuth(user ?? (await puter.getUser()));
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
}
|
||||
})();
|
||||
};
|
||||
|
||||
if (window.crossOriginIsolated) {
|
||||
(async () => {
|
||||
@@ -480,7 +366,7 @@ export class AuthModule extends PuterModule {
|
||||
rejectBlocked();
|
||||
}
|
||||
});
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Whether the user is currently signed in.
|
||||
|
||||
@@ -1,235 +0,0 @@
|
||||
// @vitest-environment jsdom
|
||||
// @vitest-environment-options {"url": "https://notes.puter.test/doc"}
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
||||
import { AuthModule } from './Auth.js';
|
||||
|
||||
// An isolated page polls the sign-in relay; nothing here answers it.
|
||||
vi.mock('../lib/networkUtils.js', () => ({ fetchUrl: vi.fn(() => new Promise(() => {})) }));
|
||||
|
||||
const GUI_ORIGIN = 'https://puter.test';
|
||||
|
||||
// jsdom has no top-layer dialogs.
|
||||
HTMLDialogElement.prototype.showModal = function () {
|
||||
this.open = true;
|
||||
};
|
||||
HTMLDialogElement.prototype.close = function () {
|
||||
this.open = false;
|
||||
};
|
||||
|
||||
const signInFrame = () => document.querySelector('dialog.puter-popup-frame iframe');
|
||||
|
||||
/** The framed sign-in's `msg_id`, from its fragment. */
|
||||
const frameMsgId = () => new URLSearchParams(new URL(signInFrame().src).hash.slice(1)).get('msg_id');
|
||||
|
||||
const fromFrame = (data, source = signInFrame().contentWindow) =>
|
||||
window.dispatchEvent(new MessageEvent('message', { data, origin: GUI_ORIGIN, source }));
|
||||
|
||||
let auth;
|
||||
|
||||
beforeEach(() => {
|
||||
document.body.innerHTML = '';
|
||||
vi.stubGlobal('puter', {
|
||||
env: 'web',
|
||||
defaultGUIOrigin: GUI_ORIGIN,
|
||||
setAuthToken: vi.fn(),
|
||||
trackOpenedWindow_: vi.fn(),
|
||||
});
|
||||
vi.spyOn(window, 'open').mockImplementation((url, name) => ({ name, url, closed: false }));
|
||||
Object.defineProperty(navigator, 'userActivation', {
|
||||
configurable: true,
|
||||
value: { hasBeenActive: true, isActive: true },
|
||||
});
|
||||
auth = new AuthModule(puter);
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
delete navigator.userActivation;
|
||||
vi.restoreAllMocks();
|
||||
vi.unstubAllGlobals();
|
||||
vi.useRealTimers();
|
||||
});
|
||||
|
||||
describe('auth.signIn on a first-party page', () => {
|
||||
it('signs in through the frame instead of a popup', async () => {
|
||||
const result = auth.signIn();
|
||||
const url = new URL(signInFrame().src);
|
||||
expect(url.origin + url.pathname).toBe(`${GUI_ORIGIN}/embed/sign-in`);
|
||||
expect(url.search).toBe('');
|
||||
expect(auth.pendingSignInMessageIds_.has(frameMsgId())).toBe(true);
|
||||
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'ready' });
|
||||
fromFrame({ msg: 'puter.token', msg_id: frameMsgId(), success: true, token: 'tok', app_uid: 'app-1', username: 'alice' });
|
||||
|
||||
await expect(result).resolves.toEqual({ success: true, token: 'tok', app_uid: 'app-1', username: 'alice' });
|
||||
expect(puter.setAuthToken).toHaveBeenCalledWith('tok');
|
||||
expect(window.open).not.toHaveBeenCalled();
|
||||
expect(signInFrame()).toBeNull();
|
||||
expect(auth.pendingSignInMessageIds_.size).toBe(0);
|
||||
});
|
||||
|
||||
it('passes request_auth on to the frame', () => {
|
||||
auth.signIn({ request_auth: true }).catch(() => {});
|
||||
expect(new URLSearchParams(new URL(signInFrame().src).hash.slice(1)).get('request_auth')).toBe('true');
|
||||
});
|
||||
|
||||
it('ignores a token for another sign-in or from another window', async () => {
|
||||
const result = auth.signIn();
|
||||
let settled = false;
|
||||
result.then(() => {
|
||||
settled = true;
|
||||
}, () => {
|
||||
settled = true;
|
||||
});
|
||||
fromFrame({ msg: 'puter.token', msg_id: 'other', success: true, token: 'x' });
|
||||
fromFrame({ msg: 'puter.token', msg_id: frameMsgId(), success: true, token: 'x' }, window);
|
||||
await Promise.resolve();
|
||||
expect(settled).toBe(false);
|
||||
expect(puter.setAuthToken).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('rejects as a closed popup when the user closes the frame', async () => {
|
||||
const result = auth.signIn();
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'ready' });
|
||||
document.querySelector('.puter-popup-frame-close').click();
|
||||
await expect(result).rejects.toMatchObject({ error: 'auth_window_closed' });
|
||||
expect(window.open).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('rejects as a closed popup when the frame closes without a token', async () => {
|
||||
const result = auth.signIn();
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'closed' });
|
||||
await expect(result).rejects.toMatchObject({ error: 'auth_window_closed' });
|
||||
});
|
||||
|
||||
it('shares one framed sign-in between calls made while it is open', async () => {
|
||||
const first = auth.signIn();
|
||||
const second = auth.signIn();
|
||||
expect(document.querySelectorAll('dialog.puter-popup-frame')).toHaveLength(1);
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'ready' });
|
||||
fromFrame({ msg: 'puter.token', msg_id: frameMsgId(), success: true, token: 'tok' });
|
||||
await expect(first).resolves.toEqual({ success: true, token: 'tok' });
|
||||
await expect(second).resolves.toEqual({ success: true, token: 'tok' });
|
||||
|
||||
// Once it settles, the next call starts a new one.
|
||||
const third = auth.signIn();
|
||||
expect(signInFrame()).not.toBeNull();
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'closed' });
|
||||
await expect(third).rejects.toMatchObject({ error: 'auth_window_closed' });
|
||||
});
|
||||
|
||||
it('shares the framed sign-in with a call that differs in request_auth', async () => {
|
||||
// Implicit auth (a `puter.*` call without a token) asks with request_auth.
|
||||
const implicit = auth.signIn({ request_auth: true });
|
||||
const explicit = auth.signIn();
|
||||
expect(document.querySelectorAll('dialog.puter-popup-frame')).toHaveLength(1);
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'ready' });
|
||||
fromFrame({ msg: 'puter.token', msg_id: frameMsgId(), success: true, token: 'tok' });
|
||||
await expect(implicit).resolves.toEqual({ success: true, token: 'tok' });
|
||||
await expect(explicit).resolves.toEqual({ success: true, token: 'tok' });
|
||||
});
|
||||
|
||||
it('rejects with the reply a failed sign-in sends, as the popup does', async () => {
|
||||
const result = auth.signIn();
|
||||
fromFrame({ msg: 'puter.token', msg_id: frameMsgId(), success: false, token: null });
|
||||
await expect(result).rejects.toEqual({ success: false, token: null });
|
||||
expect(puter.setAuthToken).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('continues in the popup when the frame hands off, such as for a federated provider', async () => {
|
||||
const result = auth.signIn();
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'loading' });
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'unavailable' });
|
||||
await vi.waitFor(() => expect(window.open).toHaveBeenCalledTimes(1));
|
||||
const [url] = window.open.mock.calls[0];
|
||||
expect(url).toContain(`${GUI_ORIGIN}/action/sign-in?embedded_in_popup=true`);
|
||||
expect(signInFrame()).toBeNull();
|
||||
|
||||
const popup = window.open.mock.results[0].value;
|
||||
const msgId = new URL(url).searchParams.get('msg_id');
|
||||
window.dispatchEvent(new MessageEvent('message', {
|
||||
data: { msg: 'puter.token', msg_id: msgId, success: true, token: 'tok' },
|
||||
origin: GUI_ORIGIN,
|
||||
source: popup,
|
||||
}));
|
||||
await expect(result).resolves.toMatchObject({ success: true, token: 'tok' });
|
||||
});
|
||||
|
||||
it('opens the provider the user picked in the frame straight in the popup', async () => {
|
||||
const result = auth.signIn();
|
||||
const msgId = frameMsgId();
|
||||
const start = `${GUI_ORIGIN}/auth/oidc/google/start?flow=login&referrer=x&embedded_in_popup=true&msg_id=${msgId}&opener_origin=https%3A%2F%2Fnotes.puter.test`;
|
||||
const frameWindow = signInFrame().contentWindow;
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'ready' });
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'provider', url: start });
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'unavailable' }, frameWindow);
|
||||
await vi.waitFor(() => expect(window.open).toHaveBeenCalledTimes(1));
|
||||
expect(window.open.mock.calls[0][0]).toBe(start);
|
||||
expect(signInFrame()).toBeNull();
|
||||
expect(auth.pendingSignInMessageIds_.has(msgId)).toBe(true);
|
||||
|
||||
// The provider returns the popup as a sign-in popup for the same attempt.
|
||||
window.dispatchEvent(new MessageEvent('message', {
|
||||
data: { msg: 'puter.token', msg_id: msgId, success: true, token: 'tok' },
|
||||
origin: GUI_ORIGIN,
|
||||
source: window.open.mock.results[0].value,
|
||||
}));
|
||||
await expect(result).resolves.toMatchObject({ success: true, token: 'tok' });
|
||||
expect(puter.setAuthToken).toHaveBeenCalledWith('tok');
|
||||
expect(auth.pendingSignInMessageIds_.size).toBe(0);
|
||||
});
|
||||
|
||||
it.each([
|
||||
['another origin', (id) => `https://evil.test/auth/oidc/google/start?embedded_in_popup=true&msg_id=${id}`],
|
||||
['another path', (id) => `${GUI_ORIGIN}/action/sign-in?embedded_in_popup=true&msg_id=${id}&auth_token=x`],
|
||||
['another sign-in', () => `${GUI_ORIGIN}/auth/oidc/google/start?embedded_in_popup=true&msg_id=other`],
|
||||
['no popup return', (id) => `${GUI_ORIGIN}/auth/oidc/google/start?msg_id=${id}`],
|
||||
['no URL', () => undefined],
|
||||
])('opens the sign-in popup instead of a provider URL to %s', async (_, url) => {
|
||||
auth.signIn();
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'provider', url: url(frameMsgId()) });
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'unavailable' });
|
||||
await vi.waitFor(() => expect(window.open).toHaveBeenCalledTimes(1));
|
||||
expect(window.open.mock.calls[0][0]).toContain(`${GUI_ORIGIN}/action/sign-in?embedded_in_popup=true`);
|
||||
});
|
||||
|
||||
it('continues in the popup when the frame is refused', async () => {
|
||||
vi.useFakeTimers();
|
||||
auth.signIn();
|
||||
signInFrame().dispatchEvent(new Event('load'));
|
||||
await vi.advanceTimersByTimeAsync(1000);
|
||||
expect(window.open).toHaveBeenCalledTimes(1);
|
||||
expect(signInFrame()).toBeNull();
|
||||
});
|
||||
|
||||
it('keeps the popup for a temporary account', () => {
|
||||
auth.signIn({ attempt_temp_user_creation: true });
|
||||
expect(signInFrame()).toBeNull();
|
||||
expect(window.open).toHaveBeenCalledTimes(1);
|
||||
expect(window.open.mock.calls[0][0]).toContain('attempt_temp_user_creation=true');
|
||||
});
|
||||
|
||||
it('keeps the popup for a page outside the Puter origin', () => {
|
||||
puter.defaultGUIOrigin = 'https://puter.com';
|
||||
auth.signIn();
|
||||
expect(signInFrame()).toBeNull();
|
||||
expect(window.open).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it('keeps the popup for a page in a frame of another site', () => {
|
||||
Object.defineProperty(window.location, 'ancestorOrigins', { configurable: true, value: ['https://other.test'] });
|
||||
try {
|
||||
auth.signIn();
|
||||
expect(signInFrame()).toBeNull();
|
||||
expect(window.open).toHaveBeenCalledTimes(1);
|
||||
} finally {
|
||||
delete window.location.ancestorOrigins;
|
||||
}
|
||||
});
|
||||
|
||||
it('keeps the popup for a cross-origin isolated page', () => {
|
||||
vi.stubGlobal('crossOriginIsolated', true);
|
||||
auth.signIn().catch(() => {});
|
||||
expect(signInFrame()).toBeNull();
|
||||
expect(window.open).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
});
|
||||
+65
-287
@@ -2,10 +2,7 @@ import EventListener from '../lib/EventListener.js';
|
||||
import { PuterJSError } from '../lib/PuterJSError.js';
|
||||
import FSItem from './FSItem.js';
|
||||
import PuterDialog from './PuterDialog.js';
|
||||
import { ancestorsAllowGuiEmbed, canFrameGuiEmbed, showFeedbackEmbed, showPopupFrame } from '../lib/guiEmbed.js';
|
||||
import { hasUserActivation } from '../lib/auth-popup.js';
|
||||
import { appIDOf } from '../lib/upgradePrompt.js';
|
||||
import { upgradeUrl } from './UsageLimitDialog.js';
|
||||
import { canFrameGuiEmbed, showFeedbackEmbed } from '../lib/guiEmbed.js';
|
||||
import { checkPermissions } from './perms/lib/holds.js';
|
||||
|
||||
|
||||
@@ -535,9 +532,6 @@ export class UIModule extends EventListener {
|
||||
// Set while the framed feedback dialog is open on a first-party page.
|
||||
#feedbackEmbedOpen = false;
|
||||
|
||||
// The framed upgrade showing, which a call made while it's open joins.
|
||||
#upgradeFrame = null;
|
||||
|
||||
// Holds the callback functions for the various events
|
||||
// that are triggered when a watched item has changed.
|
||||
itemWatchCallbackFunctions = [];
|
||||
@@ -588,142 +582,6 @@ export class UIModule extends EventListener {
|
||||
if ( popup ) this.#pickerPopups.add(popup);
|
||||
}
|
||||
|
||||
/** What a picker's consent dialog says, when the popup needs a click to open. */
|
||||
static #PICKER_CONSENT = {
|
||||
'show-open-file-picker': 'This website wants you to choose a file from your Puter account.',
|
||||
'show-save-file-picker': 'This website wants to save a file to your Puter account.',
|
||||
'show-directory-picker': 'This website wants you to choose a folder from your Puter account.',
|
||||
};
|
||||
|
||||
/** Opens a picker's popup window, centered, at the pickers' size. */
|
||||
#openPickerPopup (url, title) {
|
||||
const w = 700;
|
||||
const h = 400;
|
||||
const left = (screen.width / 2) - (w / 2);
|
||||
const top = (screen.height / 2) - (h / 2);
|
||||
return window.open(
|
||||
url,
|
||||
title,
|
||||
`toolbar=no, location=no, directories=no, status=no, menubar=no, scrollbars=no, resizable=no, copyhistory=no, width=${w}, height=${h}, top=${top}, left=${left}`,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Shows a picker on a `web` page. A first-party page one label under the
|
||||
* Puter origin that is signed in gets it in a frame over the page; every
|
||||
* other page, or a frame that can't serve this user, gets the popup.
|
||||
* `onWindow` sees the window that will ask for and answer the picker, with
|
||||
* `framed` set for a frame, and may return a function that stops listening
|
||||
* to it.
|
||||
*
|
||||
* @param {Object} opts
|
||||
* @param {'show-open-file-picker' | 'show-save-file-picker' | 'show-directory-picker'} opts.action
|
||||
* @param {number} opts.msgId
|
||||
* @param {string} opts.url - the popup's URL
|
||||
* @param {string} opts.title - the popup's window name, and the frame's accessible name
|
||||
* @param {Record<string, string>} [opts.fragment] - the popup parameters the frame needs besides `msg_id`
|
||||
* @param {(win: Window | null, how?: { framed: boolean }) => (() => void) | void} [opts.onWindow]
|
||||
*/
|
||||
#showWebPicker ({ action, msgId, url, title, fragment = {}, onWindow }) {
|
||||
if ( ! this.#canFrameForUser() ) {
|
||||
// window.open() returns synchronously and the popup cannot post
|
||||
// back until this function yields, so there is no race.
|
||||
const popup = this.#openPickerPopup(url, title);
|
||||
onWindow?.(popup);
|
||||
this.#trackPickerPopup(popup);
|
||||
return;
|
||||
}
|
||||
void (async () => {
|
||||
if ( await this.#showPickerFrame({ action, msgId, title, fragment, onWindow }) ) return;
|
||||
// The click that asked for the picker may have expired by now, so
|
||||
// without it the user opens the popup from a consent dialog.
|
||||
const launched = (popup) => {
|
||||
onWindow?.(popup);
|
||||
this.#trackPickerPopup(popup);
|
||||
};
|
||||
if ( hasUserActivation() ) {
|
||||
const popup = this.#openPickerPopup(url, title);
|
||||
if ( popup ) {
|
||||
launched(popup);
|
||||
return;
|
||||
}
|
||||
}
|
||||
let consent = null;
|
||||
try {
|
||||
consent = PuterDialog.show({
|
||||
message: UIModule.#PICKER_CONSENT[action],
|
||||
onContinue: () => {
|
||||
launched(this.#openPickerPopup(url, title));
|
||||
consent?.remove();
|
||||
},
|
||||
onCancel: () => {
|
||||
consent?.remove();
|
||||
this.#settleCallback(msgId, PICKER_CANCELLED);
|
||||
},
|
||||
});
|
||||
} catch {
|
||||
// No dialog either; as with a blocked popup, the picker never opens.
|
||||
}
|
||||
})();
|
||||
}
|
||||
|
||||
/** Whether a picker or upgrade can show framed: a signed-in first-party page, not in a frame of another site. */
|
||||
#canFrameForUser () {
|
||||
return this.env === 'web' &&
|
||||
!globalThis.crossOriginIsolated &&
|
||||
!!globalThis.document?.body &&
|
||||
canFrameGuiEmbed(globalThis.location?.href, puter.defaultGUIOrigin) &&
|
||||
ancestorsAllowGuiEmbed(globalThis, puter.defaultGUIOrigin) &&
|
||||
!!puter.auth?.isSignedIn?.();
|
||||
}
|
||||
|
||||
/**
|
||||
* The picker in a frame over the page, for the page's signed-in user. The
|
||||
* GUI answers it as it would the popup, through the module's message
|
||||
* handler. Resolves false when the popup has to take over.
|
||||
*
|
||||
* @returns {Promise<boolean>}
|
||||
*/
|
||||
async #showPickerFrame ({ action, msgId, title, fragment, onWindow }) {
|
||||
const user = await this.#frameUser();
|
||||
if ( ! user ) return false;
|
||||
let frame = null;
|
||||
let stopListening;
|
||||
// The frame only serves this page's own user, so the token it sends
|
||||
// with the answer isn't adopted; the page keeps the one it has.
|
||||
const closed = await showPopupFrame({
|
||||
guiOrigin: puter.defaultGUIOrigin,
|
||||
action,
|
||||
fragment: { ...fragment, msg_id: String(msgId), user: user.uuid },
|
||||
title,
|
||||
closed: () => true,
|
||||
onMessage: () => {},
|
||||
onFrame: (win) => {
|
||||
frame = win;
|
||||
this.#pickerPopups.add(win);
|
||||
stopListening = onWindow?.(win, { framed: true });
|
||||
},
|
||||
});
|
||||
this.#pickerPopups.delete(frame);
|
||||
stopListening?.();
|
||||
if ( ! closed ) return false;
|
||||
// Gone without an answer: dismissed, so it settles as a cancel.
|
||||
this.#settleCallback(msgId, PICKER_CANCELLED);
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* The page's signed-in user that a frame is shown for, from the cached
|
||||
* whoami when there is one, or null without a uuid.
|
||||
*
|
||||
* @returns {Promise<{ uuid: string } | null>}
|
||||
*/
|
||||
async #frameUser () {
|
||||
const known = await Promise.resolve(puter.whoami ?? puter.whoamiCache_).catch(() => null);
|
||||
const user = known?.uuid ? known : await puter.auth.getUser().catch(() => null);
|
||||
return typeof user?.uuid === 'string' && user.uuid ? user : null;
|
||||
}
|
||||
|
||||
// Whether a message on the window may drive this module.
|
||||
#isTrustedMessageSource (e) {
|
||||
if ( this.messageTarget ) {
|
||||
@@ -1524,12 +1382,20 @@ export class UIModule extends EventListener {
|
||||
env: this.env,
|
||||
}, '*');
|
||||
} else {
|
||||
this.#showWebPicker({
|
||||
action: 'show-directory-picker',
|
||||
msgId: msg_id,
|
||||
url: `${puter.defaultGUIOrigin}/action/show-directory-picker?embedded_in_popup=true&msg_id=${msg_id}&appInstanceID=${this.appInstanceID}&env=${this.env}&options=${JSON.stringify(options)}`,
|
||||
title: 'Puter: Open Directory',
|
||||
});
|
||||
let w = 700;
|
||||
let h = 400;
|
||||
let title = 'Puter: Open Directory';
|
||||
var left = (screen.width / 2) - (w / 2);
|
||||
var top = (screen.height / 2) - (h / 2);
|
||||
// Track the window we opened so the message listener accepts
|
||||
// its reply. window.open() returns synchronously and the popup
|
||||
// cannot post back until this function yields, so there is no
|
||||
// race.
|
||||
this.#trackPickerPopup(window.open(
|
||||
`${puter.defaultGUIOrigin}/action/show-directory-picker?embedded_in_popup=true&msg_id=${msg_id}&appInstanceID=${this.appInstanceID}&env=${this.env}&options=${JSON.stringify(options)}`,
|
||||
title,
|
||||
`toolbar=no, location=no, directories=no, status=no, menubar=no, scrollbars=no, resizable=no, copyhistory=no, width=${w}, height=${h}, top=${top}, left=${left}`,
|
||||
));
|
||||
}
|
||||
|
||||
this.#registerPickerCallback(msg_id, resolve, undefinedOnCancel);
|
||||
@@ -1566,13 +1432,16 @@ export class UIModule extends EventListener {
|
||||
env: this.env,
|
||||
}, '*');
|
||||
} else {
|
||||
this.#showWebPicker({
|
||||
action: 'show-open-file-picker',
|
||||
msgId: msg_id,
|
||||
url: `${puter.defaultGUIOrigin}/action/show-open-file-picker?embedded_in_popup=true&msg_id=${msg_id}&appInstanceID=${this.appInstanceID}&env=${this.env}&options=${JSON.stringify(options ?? {})}`,
|
||||
title: 'Puter: Open File',
|
||||
fragment: { options: JSON.stringify(options ?? {}) },
|
||||
});
|
||||
let w = 700;
|
||||
let h = 400;
|
||||
let title = 'Puter: Open File';
|
||||
var left = (screen.width / 2) - (w / 2);
|
||||
var top = (screen.height / 2) - (h / 2);
|
||||
this.#trackPickerPopup(window.open(
|
||||
`${puter.defaultGUIOrigin}/action/show-open-file-picker?embedded_in_popup=true&msg_id=${msg_id}&appInstanceID=${this.appInstanceID}&env=${this.env}&options=${JSON.stringify(options ?? {})}`,
|
||||
title,
|
||||
`toolbar=no, location=no, directories=no, status=no, menubar=no, scrollbars=no, resizable=no, copyhistory=no, width=${w}, height=${h}, top=${top}, left=${left}`,
|
||||
));
|
||||
}
|
||||
this.#registerPickerCallback(msg_id, resolve, undefinedOnCancel);
|
||||
});
|
||||
@@ -1716,112 +1585,16 @@ export class UIModule extends EventListener {
|
||||
* fills them in when a call is refused for want of credit, a plan, or
|
||||
* storage.
|
||||
*
|
||||
* On a signed-in first-party page one label under the Puter origin, the
|
||||
* upgrade shows in a frame over the page instead, and the promise
|
||||
* resolves once it closes. When the frame can't show it, the upgrade
|
||||
* opens in a new tab and the promise resolves `{ upgraded: false }`.
|
||||
* Anywhere else the promise never settles: the desktop doesn't answer an
|
||||
* app, and a website has no desktop to ask.
|
||||
*
|
||||
* @param {import('../lib/types.js').UpgradeRequestDetails} [details]
|
||||
* @returns {Promise<import('../lib/types.js').UpgradeResult>}
|
||||
* @returns {Promise<unknown>}
|
||||
*/
|
||||
requestUpgrade (details) {
|
||||
const { reason, method, message } = details ?? {};
|
||||
if ( this.canShowUpgradeFrame_() ) return this.#showUpgradeFrame({ reason, method });
|
||||
return new Promise((resolve) => {
|
||||
this.#postMessageWithCallback('requestUpgrade', resolve, { reason, method, message });
|
||||
});
|
||||
};
|
||||
|
||||
/**
|
||||
* Whether {@link requestUpgrade} shows the upgrade in a frame over this page.
|
||||
*
|
||||
* @internal
|
||||
* @returns {boolean}
|
||||
*/
|
||||
canShowUpgradeFrame_ () {
|
||||
return this.#canFrameForUser();
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether {@link requestUpgrade} is showing the upgrade in a frame, about
|
||||
* to, or asking to open it in a tab instead.
|
||||
*
|
||||
* @internal
|
||||
* @returns {boolean}
|
||||
*/
|
||||
upgradeFrameShowing_ () {
|
||||
return this.#upgradeFrame !== null;
|
||||
}
|
||||
|
||||
/**
|
||||
* The upgrade in a frame over the page, for the page's signed-in user, or
|
||||
* in a new tab when the frame can't show it. A call made while one is
|
||||
* showing settles with it, so a payment in progress isn't replaced.
|
||||
*
|
||||
* @param {{ reason?: string, method?: string }} details
|
||||
* @returns {Promise<import('../lib/types.js').UpgradeResult>}
|
||||
*/
|
||||
#showUpgradeFrame ({ reason, method }) {
|
||||
if ( this.#upgradeFrame ) return this.#upgradeFrame;
|
||||
this.#upgradeFrame = (async () => {
|
||||
try {
|
||||
const user = await this.#frameUser();
|
||||
const framed = user && await showPopupFrame({
|
||||
guiOrigin: puter.defaultGUIOrigin,
|
||||
action: 'upgrade',
|
||||
fragment: {
|
||||
user: user.uuid,
|
||||
...(reason ? { reason } : {}),
|
||||
...(method ? { method } : {}),
|
||||
},
|
||||
title: 'Upgrade',
|
||||
closed: (data) => ({ upgraded: data?.upgraded === true }),
|
||||
onMessage: () => {},
|
||||
});
|
||||
if ( framed ) return framed;
|
||||
await this.#openUpgradeTab(upgradeUrl({ reason, method, appID: appIDOf(puter) }));
|
||||
return { upgraded: false };
|
||||
} finally {
|
||||
this.#upgradeFrame = null;
|
||||
}
|
||||
})();
|
||||
return this.#upgradeFrame;
|
||||
}
|
||||
|
||||
/**
|
||||
* Opens the upgrade page in a new tab. The click that asked for it may
|
||||
* have expired by now, so without it the user opens it from a consent
|
||||
* dialog. Resolves once the tab opens or the user answers the dialog.
|
||||
*
|
||||
* @param {string} url
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
#openUpgradeTab (url) {
|
||||
if ( hasUserActivation() && window.open(url, '_blank') ) return Promise.resolve();
|
||||
return new Promise((resolve) => {
|
||||
let consent = null;
|
||||
const answered = () => {
|
||||
consent?.remove();
|
||||
resolve();
|
||||
};
|
||||
try {
|
||||
consent = PuterDialog.show({
|
||||
message: 'This website wants to open the Puter upgrade page.',
|
||||
onContinue: () => {
|
||||
window.open(url, '_blank');
|
||||
answered();
|
||||
},
|
||||
onCancel: answered,
|
||||
});
|
||||
} catch {
|
||||
// No dialog either; as with a blocked tab, the page never opens.
|
||||
resolve();
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Shows a picker for choosing where to save a file, and saves `content`
|
||||
* there. Resolves to the saved `FSItem`; if the user cancels, the promise
|
||||
@@ -1866,43 +1639,47 @@ export class UIModule extends EventListener {
|
||||
// Create an object URL for the Blob
|
||||
let objectUrl = URL.createObjectURL(blob);
|
||||
|
||||
// Only hand the file content to the Puter GUI window that shows
|
||||
// the picker (its popup, or its frame on a first-party page).
|
||||
// Without this, any framing parent or sibling iframe could post
|
||||
let w = 700;
|
||||
let h = 400;
|
||||
let title = 'Puter: Save File';
|
||||
var left = (screen.width / 2) - (w / 2);
|
||||
var top = (screen.height / 2) - (h / 2);
|
||||
|
||||
// Open the picker popup first so we can bind the data handler to the
|
||||
// exact window we opened. window.open() returns synchronously and the
|
||||
// popup cannot post back until this function yields, so there is no race.
|
||||
const popup = window.open(
|
||||
`${puter.defaultGUIOrigin}/action/show-save-file-picker?embedded_in_popup=true&msg_id=${msg_id}&appInstanceID=${this.appInstanceID}&env=${this.env}&blobUrl=${encodeURIComponent(objectUrl)}`,
|
||||
title,
|
||||
`toolbar=no, location=no, directories=no, status=no, menubar=no, scrollbars=no, resizable=no, copyhistory=no, width=${w}, height=${h}, top=${top}, left=${left}`,
|
||||
);
|
||||
|
||||
// Only hand the file content to the trusted Puter GUI popup we just
|
||||
// opened. Without this, any framing parent or sibling iframe could post
|
||||
// { msg: 'sendMeFileData' } and receive the content the page meant to save.
|
||||
// A frame that reloads asks again, so it's answered until it
|
||||
// closes; a popup is answered once.
|
||||
const sendFileDataTo = (picker, { framed = false } = {}) => {
|
||||
const onSendMeFileData = (e) => {
|
||||
if ( e.data?.msg !== 'sendMeFileData' ) return;
|
||||
// Reject anything that isn't our picker on the trusted GUI origin.
|
||||
if ( e.origin !== puter.defaultGUIOrigin ) return;
|
||||
if ( ! picker || e.source !== picker ) return;
|
||||
const onSendMeFileData = (e) => {
|
||||
if ( e.data?.msg !== 'sendMeFileData' ) return;
|
||||
// Reject anything that isn't our popup on the trusted GUI origin.
|
||||
if ( e.origin !== puter.defaultGUIOrigin ) return;
|
||||
if ( ! popup || e.source !== popup ) return;
|
||||
|
||||
// Send the file data to the picker, targeting the trusted origin only.
|
||||
e.source.postMessage({
|
||||
msg: 'showSaveFilePickerPopup',
|
||||
content: url ? undefined : content,
|
||||
url: url ? url.toString() : undefined,
|
||||
suggestedName: suggestedName ?? '',
|
||||
env: this.env,
|
||||
uuid: msg_id,
|
||||
}, puter.defaultGUIOrigin);
|
||||
// Send the file data to the popup, targeting the trusted origin only.
|
||||
e.source.postMessage({
|
||||
msg: 'showSaveFilePickerPopup',
|
||||
content: url ? undefined : content,
|
||||
url: url ? url.toString() : undefined,
|
||||
suggestedName: suggestedName ?? '',
|
||||
env: this.env,
|
||||
uuid: msg_id,
|
||||
}, puter.defaultGUIOrigin);
|
||||
|
||||
// A popup has the data now; remove this exact listener.
|
||||
if ( ! framed ) window.removeEventListener('message', onSendMeFileData);
|
||||
};
|
||||
window.addEventListener('message', onSendMeFileData);
|
||||
return () => window.removeEventListener('message', onSendMeFileData);
|
||||
// The trusted popup has the data; remove this exact listener.
|
||||
window.removeEventListener('message', onSendMeFileData);
|
||||
};
|
||||
window.addEventListener('message', onSendMeFileData);
|
||||
|
||||
this.#showWebPicker({
|
||||
action: 'show-save-file-picker',
|
||||
msgId: msg_id,
|
||||
url: `${puter.defaultGUIOrigin}/action/show-save-file-picker?embedded_in_popup=true&msg_id=${msg_id}&appInstanceID=${this.appInstanceID}&env=${this.env}&blobUrl=${encodeURIComponent(objectUrl)}`,
|
||||
title: 'Puter: Save File',
|
||||
onWindow: sendFileDataTo,
|
||||
});
|
||||
// Same window, for the picker's own reply on the main listener.
|
||||
this.#trackPickerPopup(popup);
|
||||
}
|
||||
this.#registerPickerCallback(msg_id, resolve, undefinedOnCancel);
|
||||
});
|
||||
@@ -2535,8 +2312,9 @@ export class UIModule extends EventListener {
|
||||
if ( this.#feedbackEmbedOpen ) return { sent: false };
|
||||
this.#feedbackEmbedOpen = true;
|
||||
try {
|
||||
const user = await this.#frameUser();
|
||||
if ( ! user ) return null;
|
||||
const known = await Promise.resolve(puter.whoami ?? puter.whoamiCache_).catch(() => null);
|
||||
const user = known?.uuid ? known : await puter.auth.getUser().catch(() => null);
|
||||
if ( typeof user?.uuid !== 'string' || ! user.uuid ) return null;
|
||||
return await showFeedbackEmbed({ guiOrigin: puter.defaultGUIOrigin, userUuid: user.uuid });
|
||||
} finally {
|
||||
this.#feedbackEmbedOpen = false;
|
||||
|
||||
@@ -1,236 +0,0 @@
|
||||
// @vitest-environment jsdom
|
||||
// @vitest-environment-options {"url": "https://notes.puter.test/doc"}
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
||||
|
||||
const { UIModule } = await import('./UI.js');
|
||||
|
||||
// jsdom has no top-layer dialogs.
|
||||
HTMLDialogElement.prototype.showModal = function () {
|
||||
this.open = true;
|
||||
};
|
||||
HTMLDialogElement.prototype.close = function () {
|
||||
this.open = false;
|
||||
};
|
||||
|
||||
const GUI_ORIGIN = 'https://puter.test';
|
||||
const USER = '0b1c9a52-3f0e-4c7a-9a65-2f6d1e8b7c40';
|
||||
|
||||
const pickerFrame = () => document.querySelector('dialog.puter-popup-frame iframe');
|
||||
const fragment = () => Object.fromEntries(new URLSearchParams(new URL(pickerFrame().src).hash.slice(1)));
|
||||
|
||||
const fromFrame = (data, source = pickerFrame().contentWindow) =>
|
||||
window.dispatchEvent(new MessageEvent('message', { data, origin: GUI_ORIGIN, source }));
|
||||
|
||||
const makeUI = () => new UIModule(
|
||||
{ env: 'web', authToken: 'token-1', APIOrigin: 'https://api.puter.test', appID: 'app-1', util: {} },
|
||||
{ appInstanceID: 'instance-1' },
|
||||
);
|
||||
|
||||
const fakePuter = ({ signedIn = true } = {}) => {
|
||||
globalThis.puter = {
|
||||
defaultGUIOrigin: GUI_ORIGIN,
|
||||
whoamiCache_: Promise.resolve({ uuid: USER }),
|
||||
trackOpenedWindow_: vi.fn(),
|
||||
auth: {
|
||||
isSignedIn: () => signedIn,
|
||||
getUser: vi.fn(async () => ({ uuid: USER })),
|
||||
},
|
||||
};
|
||||
};
|
||||
|
||||
const PENDING = Symbol('pending');
|
||||
const settled = (promise) => Promise.race([promise, new Promise((r) => setTimeout(() => r(PENDING), 0))]);
|
||||
|
||||
let popup;
|
||||
|
||||
beforeEach(() => {
|
||||
document.body.innerHTML = '';
|
||||
popup = { closed: false, postMessage: vi.fn() };
|
||||
window.open = vi.fn(() => popup);
|
||||
Object.defineProperty(navigator, 'userActivation', {
|
||||
configurable: true,
|
||||
value: { hasBeenActive: true, isActive: true },
|
||||
});
|
||||
fakePuter();
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
delete navigator.userActivation;
|
||||
delete globalThis.puter;
|
||||
vi.useRealTimers();
|
||||
});
|
||||
|
||||
describe('pickers on a signed-in first-party page', () => {
|
||||
it('shows the open file picker in a frame and resolves what it picks', async () => {
|
||||
const ui = makeUI();
|
||||
const result = ui.showOpenFilePicker({ multiple: false, accept: '.txt' });
|
||||
await vi.waitFor(() => expect(pickerFrame()).not.toBeNull());
|
||||
const url = new URL(pickerFrame().src);
|
||||
expect(url.pathname).toBe('/embed/show-open-file-picker');
|
||||
expect(fragment()).toEqual({ options: '{"multiple":false,"accept":".txt"}', msg_id: '1', user: USER });
|
||||
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'ready' });
|
||||
fromFrame({
|
||||
msg: 'fileOpenPicked',
|
||||
original_msg_id: '1',
|
||||
items: [{ uid: 'uid-1', name: 'a.txt', path: '~/Desktop/a.txt' }],
|
||||
});
|
||||
await expect(result).resolves.toMatchObject({ uid: 'uid-1', name: 'a.txt' });
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'closed' });
|
||||
expect(pickerFrame()).toBeNull();
|
||||
expect(window.open).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('keeps the page token instead of adopting the one the frame sends', async () => {
|
||||
makeUI().showDirectoryPicker();
|
||||
await vi.waitFor(() => expect(pickerFrame()).not.toBeNull());
|
||||
expect(puter.trackOpenedWindow_).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('settles a picker the GUI reports cancelled', async () => {
|
||||
const result = makeUI().showDirectoryPicker();
|
||||
await vi.waitFor(() => expect(pickerFrame()).not.toBeNull());
|
||||
expect(new URL(pickerFrame().src).pathname).toBe('/embed/show-directory-picker');
|
||||
fromFrame({ msg: 'directoryOpenCancelled', original_msg_id: '1' });
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'closed' });
|
||||
await expect(result.undefinedOnCancel).resolves.toBeUndefined();
|
||||
expect(await settled(result)).toBe(PENDING);
|
||||
});
|
||||
|
||||
it('settles as cancelled when the frame is dismissed without an answer', async () => {
|
||||
vi.useFakeTimers();
|
||||
const result = makeUI().showOpenFilePicker();
|
||||
await vi.waitFor(() => expect(pickerFrame()).not.toBeNull());
|
||||
await vi.advanceTimersByTimeAsync(200);
|
||||
document.querySelector('.puter-popup-frame-loading').click();
|
||||
await expect(result.undefinedOnCancel).resolves.toBeUndefined();
|
||||
expect(pickerFrame()).toBeNull();
|
||||
});
|
||||
|
||||
it('hands the file content to the save picker frame, and only to it', async () => {
|
||||
const result = makeUI().showSaveFilePicker('hello', 'a.txt');
|
||||
await vi.waitFor(() => expect(pickerFrame()).not.toBeNull());
|
||||
expect(new URL(pickerFrame().src).pathname).toBe('/embed/show-save-file-picker');
|
||||
const frameWindow = pickerFrame().contentWindow;
|
||||
const post = vi.spyOn(frameWindow, 'postMessage').mockImplementation(() => {});
|
||||
|
||||
window.dispatchEvent(new MessageEvent('message', { data: { msg: 'sendMeFileData' }, origin: GUI_ORIGIN, source: window }));
|
||||
window.dispatchEvent(new MessageEvent('message', { data: { msg: 'sendMeFileData' }, origin: 'https://other.test', source: frameWindow }));
|
||||
expect(post).not.toHaveBeenCalled();
|
||||
|
||||
fromFrame({ msg: 'sendMeFileData' });
|
||||
expect(post).toHaveBeenCalledWith(
|
||||
expect.objectContaining({ msg: 'showSaveFilePickerPopup', content: 'hello', suggestedName: 'a.txt' }),
|
||||
GUI_ORIGIN,
|
||||
);
|
||||
fromFrame({ msg: 'fileSaved', original_msg_id: '1', saved_file: { name: 'a.txt', uid: 'uid-2' } });
|
||||
await expect(result).resolves.toMatchObject({ name: 'a.txt' });
|
||||
});
|
||||
|
||||
it('hands the file content again to a save picker frame that reloads, until it closes', async () => {
|
||||
const result = makeUI().showSaveFilePicker('hello', 'a.txt');
|
||||
await vi.waitFor(() => expect(pickerFrame()).not.toBeNull());
|
||||
const frameWindow = pickerFrame().contentWindow;
|
||||
const post = vi.spyOn(frameWindow, 'postMessage').mockImplementation(() => {});
|
||||
|
||||
fromFrame({ msg: 'sendMeFileData' });
|
||||
// The reloaded document asks again.
|
||||
fromFrame({ msg: 'sendMeFileData' });
|
||||
expect(post).toHaveBeenCalledTimes(2);
|
||||
expect(post.mock.calls[1][0]).toMatchObject({ msg: 'showSaveFilePickerPopup', content: 'hello' });
|
||||
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'closed' });
|
||||
await expect(result.undefinedOnCancel).resolves.toBeUndefined();
|
||||
fromFrame({ msg: 'sendMeFileData' }, frameWindow);
|
||||
expect(post).toHaveBeenCalledTimes(2);
|
||||
});
|
||||
|
||||
it('opens the popup instead when the frame cannot serve the user', async () => {
|
||||
const ui = makeUI();
|
||||
const result = ui.showOpenFilePicker();
|
||||
await vi.waitFor(() => expect(pickerFrame()).not.toBeNull());
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'loading' });
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'unavailable' });
|
||||
await vi.waitFor(() => expect(window.open).toHaveBeenCalledTimes(1));
|
||||
expect(pickerFrame()).toBeNull();
|
||||
expect(window.open.mock.calls[0][0]).toContain(`${GUI_ORIGIN}/action/show-open-file-picker?embedded_in_popup=true&msg_id=1`);
|
||||
expect(puter.trackOpenedWindow_).toHaveBeenCalledWith(popup);
|
||||
|
||||
// The popup's answer reaches the picker as before.
|
||||
window.dispatchEvent(new MessageEvent('message', {
|
||||
data: { msg: 'fileOpenPicked', original_msg_id: 1, items: [{ uid: 'uid-1', name: 'a.txt' }] },
|
||||
origin: GUI_ORIGIN,
|
||||
source: popup,
|
||||
}));
|
||||
await expect(result).resolves.toMatchObject({ uid: 'uid-1' });
|
||||
});
|
||||
|
||||
it('asks for a click before opening the popup once the original click has expired', async () => {
|
||||
const result = makeUI().showOpenFilePicker();
|
||||
await vi.waitFor(() => expect(pickerFrame()).not.toBeNull());
|
||||
Object.defineProperty(navigator, 'userActivation', {
|
||||
configurable: true,
|
||||
value: { hasBeenActive: true, isActive: false },
|
||||
});
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'unavailable' });
|
||||
await vi.waitFor(() => expect(document.querySelector('puter-dialog')).not.toBeNull());
|
||||
expect(window.open).not.toHaveBeenCalled();
|
||||
expect(document.querySelector('puter-dialog').shadowRoot.querySelector('.about').textContent)
|
||||
.toBe('This website wants you to choose a file from your Puter account.');
|
||||
|
||||
document.querySelector('puter-dialog').shadowRoot.querySelector('#launch-auth-popup').click();
|
||||
expect(window.open).toHaveBeenCalledTimes(1);
|
||||
expect(window.open.mock.calls[0][2]).toContain('width=700, height=400');
|
||||
expect(document.querySelector('puter-dialog')).toBeNull();
|
||||
|
||||
const cancelled = makeUI().showDirectoryPicker();
|
||||
await vi.waitFor(() => expect(pickerFrame()).not.toBeNull());
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'unavailable' });
|
||||
await vi.waitFor(() => expect(document.querySelector('puter-dialog')).not.toBeNull());
|
||||
expect(document.querySelector('puter-dialog').shadowRoot.querySelector('.about').textContent)
|
||||
.toBe('This website wants you to choose a folder from your Puter account.');
|
||||
document.querySelector('puter-dialog').shadowRoot.querySelector('#launch-auth-popup-cancel').click();
|
||||
await expect(cancelled.undefinedOnCancel).resolves.toBeUndefined();
|
||||
expect(document.querySelector('puter-dialog')).toBeNull();
|
||||
expect(await settled(result)).toBe(PENDING);
|
||||
expect(await settled(result.undefinedOnCancel)).toBe(PENDING);
|
||||
});
|
||||
|
||||
it('opens the popup when the page has no user to name', async () => {
|
||||
puter.whoamiCache_ = Promise.resolve(null);
|
||||
puter.auth.getUser = vi.fn(async () => {
|
||||
throw new Error('nope');
|
||||
});
|
||||
makeUI().showDirectoryPicker();
|
||||
await vi.waitFor(() => expect(window.open).toHaveBeenCalledTimes(1));
|
||||
expect(pickerFrame()).toBeNull();
|
||||
});
|
||||
});
|
||||
|
||||
describe('pickers that keep the popup', () => {
|
||||
it('opens it synchronously for a signed-out first-party page', () => {
|
||||
fakePuter({ signedIn: false });
|
||||
makeUI().showOpenFilePicker();
|
||||
expect(window.open).toHaveBeenCalledTimes(1);
|
||||
expect(pickerFrame()).toBeNull();
|
||||
});
|
||||
|
||||
it('opens it synchronously for a page in a frame of another site', () => {
|
||||
Object.defineProperty(window.location, 'ancestorOrigins', { configurable: true, value: ['https://other.test'] });
|
||||
try {
|
||||
makeUI().showOpenFilePicker();
|
||||
expect(window.open).toHaveBeenCalledTimes(1);
|
||||
expect(pickerFrame()).toBeNull();
|
||||
} finally {
|
||||
delete window.location.ancestorOrigins;
|
||||
}
|
||||
});
|
||||
|
||||
it('opens it synchronously for a page outside the Puter origin', () => {
|
||||
globalThis.puter.defaultGUIOrigin = 'https://puter.com';
|
||||
makeUI().showSaveFilePicker('x', 'a.txt');
|
||||
makeUI().showDirectoryPicker();
|
||||
expect(window.open).toHaveBeenCalledTimes(2);
|
||||
expect(pickerFrame()).toBeNull();
|
||||
});
|
||||
});
|
||||
@@ -1,260 +0,0 @@
|
||||
// @vitest-environment jsdom
|
||||
// @vitest-environment-options {"url": "https://notes.puter.test/doc"}
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
||||
|
||||
const { UIModule } = await import('./UI.js');
|
||||
|
||||
// jsdom has no top-layer dialogs.
|
||||
HTMLDialogElement.prototype.showModal = function () {
|
||||
this.open = true;
|
||||
};
|
||||
HTMLDialogElement.prototype.close = function () {
|
||||
this.open = false;
|
||||
};
|
||||
|
||||
const GUI_ORIGIN = 'https://puter.test';
|
||||
const USER = '0b1c9a52-3f0e-4c7a-9a65-2f6d1e8b7c40';
|
||||
const APP = 'app-0b8a6d4e-6c1f-4a52-9d3e-2f7b1c9e8a10';
|
||||
const DETAILS = { reason: 'funds', method: 'puter.ai.chat', message: 'Your account does not have enough funding.' };
|
||||
|
||||
const upgradeDialog = () => document.querySelector('dialog.puter-popup-frame');
|
||||
const upgradeFrame = () => upgradeDialog()?.querySelector('iframe') ?? null;
|
||||
const fragment = () => Object.fromEntries(new URLSearchParams(new URL(upgradeFrame().src).hash.slice(1)));
|
||||
|
||||
const fromFrame = (data) => window.dispatchEvent(new MessageEvent('message', {
|
||||
data, origin: GUI_ORIGIN, source: upgradeFrame().contentWindow,
|
||||
}));
|
||||
|
||||
const makeUI = (env = 'web') => new UIModule(
|
||||
{ env, authToken: 'token-1', APIOrigin: 'https://api.puter.test', appID: APP, util: {} },
|
||||
{ appInstanceID: 'instance-1' },
|
||||
);
|
||||
|
||||
const fakePuter = ({ signedIn = true, guiOrigin = GUI_ORIGIN } = {}) => {
|
||||
globalThis.puter = {
|
||||
defaultGUIOrigin: guiOrigin,
|
||||
appID: APP,
|
||||
whoamiCache_: Promise.resolve({ uuid: USER }),
|
||||
auth: {
|
||||
isSignedIn: () => signedIn,
|
||||
getUser: vi.fn(async () => ({ uuid: USER })),
|
||||
},
|
||||
};
|
||||
};
|
||||
|
||||
const setActivation = (isActive) => Object.defineProperty(navigator, 'userActivation', {
|
||||
configurable: true,
|
||||
value: { hasBeenActive: true, isActive },
|
||||
});
|
||||
|
||||
const PENDING = Symbol('pending');
|
||||
const settled = (promise) => Promise.race([promise, new Promise((r) => setTimeout(() => r(PENDING), 0))]);
|
||||
|
||||
beforeEach(() => {
|
||||
document.body.innerHTML = '';
|
||||
window.open = vi.fn(() => ({ closed: false }));
|
||||
setActivation(true);
|
||||
fakePuter();
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
delete navigator.userActivation;
|
||||
delete globalThis.puter;
|
||||
vi.restoreAllMocks();
|
||||
});
|
||||
|
||||
describe('ui.requestUpgrade on a signed-in first-party page', () => {
|
||||
it('shows the upgrade in a frame over the page and resolves what the dialog reports', async () => {
|
||||
const ui = makeUI();
|
||||
expect(ui.canShowUpgradeFrame_()).toBe(true);
|
||||
const result = ui.requestUpgrade(DETAILS);
|
||||
await vi.waitFor(() => expect(upgradeFrame()).not.toBeNull());
|
||||
|
||||
expect(new URL(upgradeFrame().src).pathname).toBe('/embed/upgrade');
|
||||
expect(fragment()).toEqual({ user: USER, reason: 'funds', method: 'puter.ai.chat' });
|
||||
// It covers the page, and the dialog inside draws the scrim.
|
||||
expect(upgradeDialog().querySelector('.puter-popup-frame-box')).toBeNull();
|
||||
expect(upgradeDialog().querySelector('.puter-popup-frame-close')).toBeNull();
|
||||
expect(upgradeFrame().getAttribute('allow')).toBe('payment; otp-credentials');
|
||||
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'loading' });
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'ready' });
|
||||
expect(upgradeDialog().open).toBe(true);
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'closed', upgraded: true });
|
||||
|
||||
await expect(result).resolves.toEqual({ upgraded: true });
|
||||
expect(upgradeFrame()).toBeNull();
|
||||
expect(window.open).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('says the upgrade is showing from the call until it closes', async () => {
|
||||
const ui = makeUI();
|
||||
expect(ui.upgradeFrameShowing_()).toBe(false);
|
||||
const result = ui.requestUpgrade();
|
||||
expect(ui.upgradeFrameShowing_()).toBe(true);
|
||||
await vi.waitFor(() => expect(upgradeFrame()).not.toBeNull());
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'ready' });
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'closed' });
|
||||
await result;
|
||||
expect(ui.upgradeFrameShowing_()).toBe(false);
|
||||
});
|
||||
|
||||
it('settles, and stops showing, when the page removes the frame', async () => {
|
||||
const ui = makeUI();
|
||||
const result = ui.requestUpgrade();
|
||||
await vi.waitFor(() => expect(upgradeFrame()).not.toBeNull());
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'ready' });
|
||||
upgradeDialog().remove();
|
||||
await expect(result).resolves.toEqual({ upgraded: false });
|
||||
expect(ui.upgradeFrameShowing_()).toBe(false);
|
||||
expect(window.open).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('resolves upgraded false when the dialog closes without an upgrade', async () => {
|
||||
const result = makeUI().requestUpgrade();
|
||||
await vi.waitFor(() => expect(upgradeFrame()).not.toBeNull());
|
||||
expect(fragment()).toEqual({ user: USER });
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'ready' });
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'closed' });
|
||||
await expect(result).resolves.toEqual({ upgraded: false });
|
||||
});
|
||||
|
||||
it('leaves Escape on the page to the dialog once it shows', async () => {
|
||||
const result = makeUI().requestUpgrade(DETAILS);
|
||||
await vi.waitFor(() => expect(upgradeFrame()).not.toBeNull());
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'ready' });
|
||||
|
||||
upgradeDialog().dispatchEvent(new Event('cancel', { cancelable: true }));
|
||||
|
||||
expect(upgradeFrame()).not.toBeNull();
|
||||
expect(await settled(result)).toBe(PENDING);
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'closed', upgraded: false });
|
||||
await expect(result).resolves.toEqual({ upgraded: false });
|
||||
});
|
||||
|
||||
it('settles a call made while the upgrade shows with it, without replacing it', async () => {
|
||||
const ui = makeUI();
|
||||
const first = ui.requestUpgrade(DETAILS);
|
||||
await vi.waitFor(() => expect(upgradeFrame()).not.toBeNull());
|
||||
const frame = upgradeFrame();
|
||||
|
||||
const second = ui.requestUpgrade({ reason: 'storage' });
|
||||
|
||||
expect(second).toBe(first);
|
||||
expect(document.querySelectorAll('dialog.puter-popup-frame')).toHaveLength(1);
|
||||
expect(upgradeFrame()).toBe(frame);
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'ready' });
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'closed', upgraded: true });
|
||||
await expect(second).resolves.toEqual({ upgraded: true });
|
||||
|
||||
// A later call shows a new one.
|
||||
ui.requestUpgrade(DETAILS);
|
||||
await vi.waitFor(() => expect(upgradeFrame()).not.toBeNull());
|
||||
expect(upgradeFrame()).not.toBe(frame);
|
||||
});
|
||||
|
||||
it('opens the dashboard upgrade in a tab when the frame cannot show it', async () => {
|
||||
const result = makeUI().requestUpgrade(DETAILS);
|
||||
await vi.waitFor(() => expect(upgradeFrame()).not.toBeNull());
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'loading' });
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'unavailable' });
|
||||
|
||||
await expect(result).resolves.toEqual({ upgraded: false });
|
||||
expect(upgradeFrame()).toBeNull();
|
||||
expect(window.open).toHaveBeenCalledTimes(1);
|
||||
const [url, target] = window.open.mock.calls[0];
|
||||
expect(target).toBe('_blank');
|
||||
expect(url).toBe(`https://puter.com/dashboard/?upgrade=funds&upgrade_app=${APP}&upgrade_method=puter.ai.chat#home`);
|
||||
});
|
||||
|
||||
it('asks for a click before opening the tab once the original click has expired', async () => {
|
||||
const ui = makeUI();
|
||||
const result = ui.requestUpgrade(DETAILS);
|
||||
await vi.waitFor(() => expect(upgradeFrame()).not.toBeNull());
|
||||
setActivation(false);
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'unavailable' });
|
||||
await vi.waitFor(() => expect(document.querySelector('puter-dialog')).not.toBeNull());
|
||||
|
||||
const consent = document.querySelector('puter-dialog');
|
||||
expect(window.open).not.toHaveBeenCalled();
|
||||
expect(consent.shadowRoot.querySelector('.about').textContent)
|
||||
.toBe('This website wants to open the Puter upgrade page.');
|
||||
// Until it's answered the upgrade counts as showing, so a second call
|
||||
// joins it instead of asking again.
|
||||
expect(ui.upgradeFrameShowing_()).toBe(true);
|
||||
expect(await settled(result)).toBe(PENDING);
|
||||
const again = ui.requestUpgrade(DETAILS);
|
||||
expect(document.querySelectorAll('puter-dialog')).toHaveLength(1);
|
||||
|
||||
consent.shadowRoot.querySelector('#launch-auth-popup').click();
|
||||
await expect(result).resolves.toEqual({ upgraded: false });
|
||||
await expect(again).resolves.toEqual({ upgraded: false });
|
||||
expect(ui.upgradeFrameShowing_()).toBe(false);
|
||||
expect(window.open).toHaveBeenCalledTimes(1);
|
||||
expect(window.open.mock.calls[0][0]).toContain('https://puter.com/dashboard/?upgrade=funds');
|
||||
expect(document.querySelector('puter-dialog')).toBeNull();
|
||||
});
|
||||
|
||||
it('asks for a click when the browser blocks the tab', async () => {
|
||||
window.open = vi.fn(() => null);
|
||||
const result = makeUI().requestUpgrade(DETAILS);
|
||||
await vi.waitFor(() => expect(upgradeFrame()).not.toBeNull());
|
||||
fromFrame({ msg: 'puterPopupFrame', state: 'unavailable' });
|
||||
await vi.waitFor(() => expect(document.querySelector('puter-dialog')).not.toBeNull());
|
||||
document.querySelector('puter-dialog').shadowRoot.querySelector('#launch-auth-popup-cancel').click();
|
||||
expect(document.querySelector('puter-dialog')).toBeNull();
|
||||
await expect(result).resolves.toEqual({ upgraded: false });
|
||||
expect(window.open).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it('opens the tab when the page has no user to name', async () => {
|
||||
puter.whoamiCache_ = Promise.resolve(null);
|
||||
puter.auth.getUser = vi.fn(async () => {
|
||||
throw new Error('nope');
|
||||
});
|
||||
await expect(makeUI().requestUpgrade(DETAILS)).resolves.toEqual({ upgraded: false });
|
||||
expect(upgradeFrame()).toBeNull();
|
||||
expect(window.open).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
});
|
||||
|
||||
describe('ui.requestUpgrade elsewhere', () => {
|
||||
it('asks the desktop inside an app, as before', () => {
|
||||
const post = vi.spyOn(window, 'postMessage').mockImplementation(() => {});
|
||||
const ui = makeUI('app');
|
||||
expect(ui.canShowUpgradeFrame_()).toBe(false);
|
||||
|
||||
const result = ui.requestUpgrade(DETAILS);
|
||||
|
||||
expect(post).toHaveBeenCalledWith(expect.objectContaining({
|
||||
msg: 'requestUpgrade',
|
||||
env: 'app',
|
||||
appInstanceID: 'instance-1',
|
||||
...DETAILS,
|
||||
}), '*');
|
||||
expect(result).toBeInstanceOf(Promise);
|
||||
expect(upgradeFrame()).toBeNull();
|
||||
});
|
||||
|
||||
it.each([
|
||||
['a signed-out first-party page', { signedIn: false }],
|
||||
['a page outside the Puter origin', { guiOrigin: 'https://puter.com' }],
|
||||
])('neither frames nor opens a tab on %s', async (_label, options) => {
|
||||
fakePuter(options);
|
||||
const ui = makeUI();
|
||||
expect(ui.canShowUpgradeFrame_()).toBe(false);
|
||||
const result = ui.requestUpgrade(DETAILS);
|
||||
expect(await settled(result)).toBe(PENDING);
|
||||
expect(upgradeFrame()).toBeNull();
|
||||
expect(window.open).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('does not frame on a page in a frame of another site', () => {
|
||||
Object.defineProperty(window.location, 'ancestorOrigins', { configurable: true, value: ['https://other.test'] });
|
||||
try {
|
||||
expect(makeUI().canShowUpgradeFrame_()).toBe(false);
|
||||
} finally {
|
||||
delete window.location.ancestorOrigins;
|
||||
}
|
||||
});
|
||||
});
|
||||
@@ -6,8 +6,6 @@ import { escapeHtml } from '../lib/html.js';
|
||||
* @property {string} [method] The SDK call that was refused.
|
||||
* @property {string} [reason] Which upgrade the refusal asks for.
|
||||
* @property {string} [appID] The app the refused call ran as.
|
||||
* @property {() => boolean} [onUpgrade] Runs when the user clicks Upgrade, instead of
|
||||
* opening the dashboard's upgrade page in a new tab. Returning false opens the tab anyway.
|
||||
*/
|
||||
|
||||
const UPGRADE_PAGE = 'https://puter.com/dashboard/';
|
||||
@@ -33,14 +31,13 @@ class UsageLimitDialog extends (globalThis.HTMLElement || Object) {
|
||||
* @param {string} message Plain-text line saying what was refused.
|
||||
* @param {UsageLimitDialogOptions} [options]
|
||||
*/
|
||||
constructor (message, { title = 'Low Balance', method, reason, appID, onUpgrade } = {}) {
|
||||
constructor (message, { title = 'Low Balance', method, reason, appID } = {}) {
|
||||
super();
|
||||
this.message = message || 'You have reached your usage limit for this account.';
|
||||
// Not `this.title`: on an HTMLElement that is the tooltip attribute.
|
||||
this.heading = title;
|
||||
this.method = method;
|
||||
this.upgradeUrl = upgradeUrl({ reason, appID, method });
|
||||
this.onUpgrade = onUpgrade;
|
||||
|
||||
this.attachShadow({ mode: 'open' });
|
||||
|
||||
@@ -273,10 +270,8 @@ class UsageLimitDialog extends (globalThis.HTMLElement || Object) {
|
||||
});
|
||||
|
||||
this.shadowRoot.querySelector('#upgrade-btn').addEventListener('click', () => {
|
||||
// Closed first, so the frame the upgrade shows in isn't under this modal.
|
||||
window.open(this.upgradeUrl, '_blank');
|
||||
this.close();
|
||||
const shown = this.onUpgrade ? this.onUpgrade() !== false : false;
|
||||
if ( ! shown ) window.open(this.upgradeUrl, '_blank');
|
||||
});
|
||||
|
||||
// Close on backdrop click
|
||||
|
||||
@@ -1,51 +0,0 @@
|
||||
// @vitest-environment jsdom
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
||||
import { showUsageLimitDialog } from './UsageLimitDialog.js';
|
||||
|
||||
// jsdom has no top-layer dialogs.
|
||||
HTMLDialogElement.prototype.showModal = function () {
|
||||
this.open = true;
|
||||
};
|
||||
HTMLDialogElement.prototype.close = function () {
|
||||
this.open = false;
|
||||
};
|
||||
|
||||
const upgradeButton = () => document.querySelector('usage-limit-dialog').shadowRoot.querySelector('#upgrade-btn');
|
||||
|
||||
beforeEach(() => {
|
||||
document.body.innerHTML = '';
|
||||
window.open = vi.fn();
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
vi.restoreAllMocks();
|
||||
});
|
||||
|
||||
describe('the usage limit dialog Upgrade button', () => {
|
||||
it('opens the dashboard upgrade in a new tab', () => {
|
||||
showUsageLimitDialog('Not enough storage space available.', { reason: 'storage', method: 'puter.fs.upload' });
|
||||
upgradeButton().click();
|
||||
expect(window.open).toHaveBeenCalledWith(
|
||||
'https://puter.com/dashboard/?upgrade=storage&upgrade_method=puter.fs.upload#home',
|
||||
'_blank',
|
||||
);
|
||||
expect(document.querySelector('usage-limit-dialog')).toBeNull();
|
||||
});
|
||||
|
||||
it('runs onUpgrade instead, once the dialog has closed', () => {
|
||||
const onUpgrade = vi.fn(() => {
|
||||
expect(document.querySelector('usage-limit-dialog')).toBeNull();
|
||||
});
|
||||
showUsageLimitDialog('Not enough storage space available.', { reason: 'storage', onUpgrade });
|
||||
upgradeButton().click();
|
||||
expect(onUpgrade).toHaveBeenCalledTimes(1);
|
||||
expect(window.open).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('opens the tab after all when onUpgrade can\'t show the upgrade', () => {
|
||||
showUsageLimitDialog('Not enough storage space available.', { reason: 'storage', onUpgrade: () => false });
|
||||
upgradeButton().click();
|
||||
expect(window.open).toHaveBeenCalledWith('https://puter.com/dashboard/?upgrade=storage#home', '_blank');
|
||||
expect(document.querySelector('usage-limit-dialog')).toBeNull();
|
||||
});
|
||||
});
|
||||
@@ -346,7 +346,7 @@ The account button and Puter's app browser for a first-party app on a Puter subd
|
||||
- **Send feedback**, which calls `puter.ui.showFeedbackDialog()`.
|
||||
- **Sign out**, which calls `puter.auth.signOut()`.
|
||||
- The menu opens with focus on its first item. ArrowUp and ArrowDown move between items and wrap around, and Home and End jump to the first and last.
|
||||
- On a page exactly one label under the Puter origin, with the same scheme and port, other than Puter's own subdomains such as `api` and `docs`, an **Apps** button opens the app browser (`/embed/apps`) in a panel under the button. It names the signed-in user as `#user=<uuid>`, so the app browser shows the Puter session's apps only to that user (see `doc/embedding-app-browser.md`), and passes a forced `theme` on as `theme=`. Elsewhere the button is hidden, because the server refuses the framing.
|
||||
- On a page exactly one label under the Puter origin, with the same scheme and port, an **Apps** button opens the app browser (`/embed/apps`) in a panel under the button. It names the signed-in user as `#user=<uuid>`, so the app browser shows the Puter session's apps only to that user (see `doc/embedding-app-browser.md`), and passes a forced `theme` on as `theme=`. Elsewhere the button is hidden, because the server refuses the framing.
|
||||
- The menu and the Apps panel hang under their button with a caret pointing at it, and close on Escape, a press outside them, or their button. They're in the browser's top layer where it has one, so a host's `transform`, `overflow` or `z-index` can't clip or cover them. On screens up to 600px wide, the Apps panel spans the width below the button.
|
||||
- Closing the Apps panel keeps the app browser, so reopening it keeps its scroll and search. Any change to the page's sign-in discards it, so it never stays loaded for the previous user.
|
||||
- It renders nothing outside a top-level page (`puter.env !== 'web'`), such as inside the Puter desktop.
|
||||
|
||||
@@ -540,9 +540,8 @@ class PuterUserMenu extends PuterWebComponent {
|
||||
else this._closePanels();
|
||||
});
|
||||
this.$('.sign-in').addEventListener('click', () => this._signIn());
|
||||
this.$('.avatar').addEventListener('click', (event) => {
|
||||
// detail is 0 for a click from Enter or Space.
|
||||
if ( this.$('.menu').hidden ) this._openMenu({ fromKeyboard: event.detail === 0 });
|
||||
this.$('.avatar').addEventListener('click', () => {
|
||||
if ( this.$('.menu').hidden ) this._openMenu();
|
||||
else this._closePanels();
|
||||
});
|
||||
for ( const link of MENU_LINKS ) {
|
||||
@@ -698,15 +697,10 @@ class PuterUserMenu extends PuterWebComponent {
|
||||
panel.style.setProperty('--caret-x', `${Math.round(Math.min(width - CARET_INSET, Math.max(CARET_INSET, caret)))}px`);
|
||||
}
|
||||
|
||||
/**
|
||||
* Opened from the keyboard, focus goes to the first item. Opened with the
|
||||
* pointer, it goes to the menu itself, where no item looks focused, so the
|
||||
* first ArrowDown lands on the first item.
|
||||
*/
|
||||
_openMenu ({ fromKeyboard = false } = {}) {
|
||||
_openMenu () {
|
||||
const menu = this.$('.menu');
|
||||
this._showPanel(menu);
|
||||
(fromKeyboard ? this.$('.menu-item') : menu).focus({ preventScroll: true });
|
||||
this.$('.menu-item').focus({ preventScroll: true });
|
||||
}
|
||||
|
||||
/** Moves focus between menu items for an arrow, Home or End key; false for any other key. */
|
||||
|
||||
@@ -253,18 +253,6 @@ describe('<puter-user-menu>', () => {
|
||||
expect(shown(el, '.menu')).toBe(true);
|
||||
});
|
||||
|
||||
it('lands the first ArrowDown on the first item when the menu was opened with the pointer', async () => {
|
||||
vi.stubGlobal('puter', fakePuter({ token: 'app-token', user: USER }));
|
||||
const el = await mount();
|
||||
part(el, '.avatar').dispatchEvent(new MouseEvent('click', { detail: 1, bubbles: true, composed: true }));
|
||||
expect(shown(el, '.menu')).toBe(true);
|
||||
expect(el.shadowRoot.activeElement).toBe(part(el, '.menu'));
|
||||
|
||||
const press = (key) => el.shadowRoot.activeElement.dispatchEvent(new KeyboardEvent('keydown', { key, bubbles: true, composed: true, cancelable: true }));
|
||||
press('ArrowDown');
|
||||
expect(el.shadowRoot.activeElement.classList[1]).toBe('manage-account');
|
||||
});
|
||||
|
||||
it('hangs the panel under its button with the caret pointing at it', async () => {
|
||||
vi.stubGlobal('puter', fakePuter({ token: 'app-token', user: USER }));
|
||||
const el = await mount();
|
||||
|
||||
@@ -1,516 +0,0 @@
|
||||
import { test, expect, devices } from '@playwright/test';
|
||||
import { readFileSync } from 'node:fs';
|
||||
import path from 'node:path';
|
||||
import { fileURLToPath } from 'node:url';
|
||||
|
||||
const PUTER_ORIGIN = process.env.PUTER_TEST_ORIGIN || 'http://puter.localhost:4100';
|
||||
const API_ORIGIN = PUTER_ORIGIN.replace('://', '://api.');
|
||||
// One label under the GUI origin: a first-party app page.
|
||||
const FIRST_PARTY = PUTER_ORIGIN.replace('://', '://notes.');
|
||||
const SDK = readFileSync(
|
||||
path.join(path.dirname(fileURLToPath(import.meta.url)), '../../../dist/puter.dev.js'),
|
||||
'utf8',
|
||||
);
|
||||
|
||||
// Locally both origins are loopback, which Chromium's local network checks
|
||||
// refuse to frame from a page the test serves itself.
|
||||
test.use({
|
||||
launchOptions: {
|
||||
args: ['--disable-features=LocalNetworkAccessChecks,BlockInsecurePrivateNetworkRequests,PrivateNetworkAccessForNavigations'],
|
||||
},
|
||||
});
|
||||
|
||||
/** Opens the first-party page, serving it and the SDK from the test. */
|
||||
const openFirstPartyPage = async (page) => {
|
||||
await page.context().route(`${FIRST_PARTY}/**`, (route) => {
|
||||
if ( new URL(route.request().url()).pathname === '/sdk.js' ) {
|
||||
return route.fulfill({ contentType: 'text/javascript', body: SDK });
|
||||
}
|
||||
return route.fulfill({
|
||||
contentType: 'text/html',
|
||||
body: `<!doctype html><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1"><button id="go">Go</button>
|
||||
<script>window.PUTER_ORIGIN = ${JSON.stringify(PUTER_ORIGIN)}; window.PUTER_API_ORIGIN = ${JSON.stringify(API_ORIGIN)};</script>
|
||||
<script src="/sdk.js"></script>`,
|
||||
});
|
||||
});
|
||||
await page.goto(`${FIRST_PARTY}/`);
|
||||
await page.waitForFunction(() => !!window.puter);
|
||||
};
|
||||
|
||||
/** Runs `expr` from a click on the page, settling into `window.__result`. */
|
||||
const runFromClick = async (page, expr) => {
|
||||
await page.evaluate((expr) => {
|
||||
window.__result = undefined;
|
||||
document.getElementById('go').onclick = () => {
|
||||
Promise.resolve().then(() => (0, eval)(expr)).then(
|
||||
(value) => {
|
||||
window.__result = { ok: true, value: JSON.parse(JSON.stringify(value ?? null)) };
|
||||
},
|
||||
(error) => {
|
||||
window.__result = { ok: false, error: JSON.parse(JSON.stringify(error ?? null)) };
|
||||
},
|
||||
);
|
||||
};
|
||||
}, expr);
|
||||
await page.click('#go');
|
||||
};
|
||||
const result = (page) => page.waitForFunction(() => window.__result, null, { timeout: 60_000 }).then((h) => h.jsonValue());
|
||||
|
||||
const frame = (page) => page.frameLocator('dialog.puter-popup-frame iframe');
|
||||
const frameReady = (page) => page.locator('dialog.puter-popup-frame[open]:not(.is-loading)').waitFor({ timeout: 60_000 });
|
||||
|
||||
/** The red channel of a screenshot of `clip`, row by row, decoded in the page. */
|
||||
const screenshotRed = async (page, clip) => {
|
||||
const png = await page.screenshot({ clip });
|
||||
return page.evaluate(async (base64) => {
|
||||
const image = await createImageBitmap(await (await fetch(`data:image/png;base64,${base64}`)).blob());
|
||||
const context = new OffscreenCanvas(image.width, image.height).getContext('2d');
|
||||
context.drawImage(image, 0, 0);
|
||||
const { data } = context.getImageData(0, 0, image.width, image.height);
|
||||
return { width: image.width, red: Array.from(data.filter((_, i) => i % 4 === 0)) };
|
||||
}, png.toString('base64'));
|
||||
};
|
||||
|
||||
/** Waits for the box's fade-in to finish, so screenshots show it as it stays. */
|
||||
const boxSettled = (page) => page.waitForFunction(() =>
|
||||
document.querySelector('.puter-popup-frame-box')?.getAnimations().length === 0);
|
||||
|
||||
test.describe('popups a first-party page shows framed', () => {
|
||||
test('signs in, then picks and saves files, without opening a window', async ({ page }) => {
|
||||
// The admin's Puter session, and a file of theirs to pick.
|
||||
await page.goto('/');
|
||||
await page.waitForFunction(() => !!window.user?.username && !!window.puter?.authToken, null, { timeout: 60_000 });
|
||||
const username = await page.evaluate(() => window.user.username);
|
||||
await page.evaluate((u) => puter.fs.write(`/${u}/Desktop/popup-frame.txt`, 'framed'), username);
|
||||
|
||||
await openFirstPartyPage(page);
|
||||
const popups = [];
|
||||
page.on('popup', (p) => popups.push(p));
|
||||
|
||||
await runFromClick(page, 'puter.auth.signIn()');
|
||||
await frameReady(page);
|
||||
await frame(page).locator('.auth-dialog [data-screen="accounts"] button').first().click();
|
||||
const signedIn = await result(page);
|
||||
expect(signedIn.ok).toBe(true);
|
||||
expect(signedIn.value).toMatchObject({ success: true, username });
|
||||
await expect(page.locator('dialog.puter-popup-frame')).toHaveCount(0);
|
||||
|
||||
await runFromClick(page, 'puter.ui.showOpenFilePicker()');
|
||||
await frameReady(page);
|
||||
await frame(page).locator('.item[data-name="popup-frame.txt"]').dblclick();
|
||||
const picked = await result(page);
|
||||
expect(picked.value).toMatchObject({ name: 'popup-frame.txt' });
|
||||
await expect(page.locator('dialog.puter-popup-frame')).toHaveCount(0);
|
||||
|
||||
// A name no earlier run left behind, so the save doesn't ask to replace it.
|
||||
const suggestedName = `popup-frame-${Date.now()}.txt`;
|
||||
await runFromClick(page, `puter.ui.showSaveFilePicker("saved in a frame", ${JSON.stringify(suggestedName)})`);
|
||||
await frameReady(page);
|
||||
await expect(frame(page).locator('.savefiledialog-filename')).toHaveValue(suggestedName);
|
||||
// As in the popup, the name has focus with all but its extension
|
||||
// selected, so typing renames it straight away.
|
||||
const savedName = `renamed-${suggestedName}`;
|
||||
await page.keyboard.type(savedName.replace(/\.txt$/, ''));
|
||||
await expect(frame(page).locator('.savefiledialog-filename')).toHaveValue(savedName);
|
||||
await frame(page).locator('.savefiledialog-save-btn').click();
|
||||
const saved = await result(page);
|
||||
expect(saved.value).toMatchObject({ name: savedName });
|
||||
|
||||
// Escape on the alert asking to replace that file goes back to the
|
||||
// picker, as its Cancel does, rather than leaving it behind its mask.
|
||||
await runFromClick(page, `puter.ui.showSaveFilePicker("again", ${JSON.stringify(savedName)}).undefinedOnCancel`);
|
||||
await frameReady(page);
|
||||
await frame(page).locator('.savefiledialog-save-btn').click();
|
||||
await expect(frame(page).locator('.window-alert')).toHaveCount(1);
|
||||
await page.keyboard.press('Escape');
|
||||
await expect(frame(page).locator('.window-alert')).toHaveCount(0);
|
||||
await expect(frame(page).locator('.window-filedialog .window-disable-mask')).toBeHidden();
|
||||
await frame(page).getByRole('button', { name: 'Cancel' }).click();
|
||||
expect(await result(page)).toEqual({ ok: true, value: null });
|
||||
|
||||
await runFromClick(page, 'puter.ui.showDirectoryPicker().undefinedOnCancel');
|
||||
await frameReady(page);
|
||||
await frame(page).getByRole('button', { name: 'Cancel' }).click();
|
||||
expect(await result(page)).toEqual({ ok: true, value: null });
|
||||
|
||||
// Escape closes the picker, and the frame goes with it.
|
||||
await runFromClick(page, 'puter.ui.showOpenFilePicker().undefinedOnCancel');
|
||||
await frameReady(page);
|
||||
await frame(page).locator('.window-filedialog').click({ position: { x: 5, y: 5 } });
|
||||
await page.keyboard.press('Escape');
|
||||
expect(await result(page)).toEqual({ ok: true, value: null });
|
||||
await expect(page.locator('dialog.puter-popup-frame')).toHaveCount(0);
|
||||
|
||||
expect(popups).toHaveLength(0);
|
||||
});
|
||||
|
||||
test('closing the framed sign-in rejects as closing its popup would', async ({ page }) => {
|
||||
await openFirstPartyPage(page);
|
||||
await page.evaluate(() => {
|
||||
document.body.style.minHeight = '4000px';
|
||||
});
|
||||
await runFromClick(page, 'puter.auth.signIn()');
|
||||
await frameReady(page);
|
||||
|
||||
// Scrolling over the scrim leaves the page behind it where it was.
|
||||
await page.mouse.move(5, 300);
|
||||
await page.mouse.wheel(0, 800);
|
||||
await page.waitForTimeout(300);
|
||||
expect(await page.evaluate(() => window.scrollY)).toBe(0);
|
||||
|
||||
await page.locator('.puter-popup-frame-close').click();
|
||||
const closed = await result(page);
|
||||
expect(closed).toMatchObject({ ok: false, error: { error: 'auth_window_closed' } });
|
||||
await expect(page.locator('dialog.puter-popup-frame')).toHaveCount(0);
|
||||
});
|
||||
|
||||
test('the page\'s own dialog, frame and button styles leave the framed sign-in as it is', async ({ page }) => {
|
||||
await openFirstPartyPage(page);
|
||||
await page.addStyleTag({
|
||||
content: `dialog { top: 50%; left: 50%; transform: translate(-50%, -50%); border-radius: 24px; }
|
||||
iframe { max-width: 420px; margin: 12px; }
|
||||
button { margin: 0 6px 8px 0; min-width: 88px; min-height: 44px; box-shadow: 0 1px 2px #000; }`,
|
||||
});
|
||||
await runFromClick(page, 'puter.auth.signIn()');
|
||||
await frameReady(page);
|
||||
|
||||
const viewport = page.viewportSize();
|
||||
const dialog = await page.locator('dialog.puter-popup-frame').boundingBox();
|
||||
expect(dialog).toEqual({ x: 0, y: 0, width: viewport.width, height: viewport.height });
|
||||
const box = await page.locator('.puter-popup-frame-box').boundingBox();
|
||||
expect(await page.locator('.puter-popup-frame-box iframe').boundingBox()).toEqual(box);
|
||||
const close = await page.locator('.puter-popup-frame-close').boundingBox();
|
||||
expect([close.width, close.height]).toEqual([32, 32]);
|
||||
expect(box.x + box.width - (close.x + close.width)).toBe(10);
|
||||
await expect(page.locator('.puter-popup-frame-close')).toHaveCSS('box-shadow', 'none');
|
||||
});
|
||||
|
||||
test.describe('in dark mode', () => {
|
||||
test.use({ colorScheme: 'dark', deviceScaleFactor: 2 });
|
||||
|
||||
test('the framed sign-in\'s rounded corners show no light fringe', async ({ page }) => {
|
||||
await openFirstPartyPage(page);
|
||||
await runFromClick(page, 'puter.auth.signIn()');
|
||||
await frameReady(page);
|
||||
await boxSettled(page);
|
||||
|
||||
// The bottom-left corner: the dialog at the top right, the scrim
|
||||
// at the bottom left, and the curve between them.
|
||||
const box = await page.locator('.puter-popup-frame-box').boundingBox();
|
||||
const { width, red } = await screenshotRed(page, { x: box.x, y: box.y + box.height - 12, width: 12, height: 12 });
|
||||
const inside = red[width - 1];
|
||||
const outside = red[red.length - width];
|
||||
expect(Math.max(...red)).toBeLessThanOrEqual(Math.max(inside, outside) + 3);
|
||||
});
|
||||
});
|
||||
|
||||
test.describe('on a phone with a fractional pixel ratio', () => {
|
||||
// A describe group can't switch browsers; the profile's is Chromium anyway.
|
||||
const { defaultBrowserType: _browser, ...pixel7 } = devices['Pixel 7'];
|
||||
test.use(pixel7);
|
||||
|
||||
test('the framed sign-in fills the screen with no line of scrim along its edge', async ({ page }) => {
|
||||
await openFirstPartyPage(page);
|
||||
await runFromClick(page, 'puter.auth.signIn()');
|
||||
await frameReady(page);
|
||||
await boxSettled(page);
|
||||
|
||||
// A column down the middle of the top: the white sign-in all the way up.
|
||||
const { width } = page.viewportSize();
|
||||
const { red } = await screenshotRed(page, { x: width / 2, y: 0, width: 1, height: 4 });
|
||||
expect(red[0]).toBe(red[red.length - 1]);
|
||||
});
|
||||
|
||||
test('the framed save picker keeps its file name and buttons on screen', async ({ page }) => {
|
||||
await page.goto('/');
|
||||
await page.waitForFunction(() => !!window.puter?.authToken, null, { timeout: 60_000 });
|
||||
await openFirstPartyPage(page);
|
||||
await runFromClick(page, 'puter.auth.signIn()');
|
||||
await frameReady(page);
|
||||
await frame(page).locator('.auth-dialog [data-screen="accounts"] button').first().click();
|
||||
expect((await result(page)).ok).toBe(true);
|
||||
|
||||
await runFromClick(page, 'puter.ui.showSaveFilePicker("x", "a-long-suggested-file-name.txt")');
|
||||
await frameReady(page);
|
||||
const { width } = page.viewportSize();
|
||||
for ( const control of ['.savefiledialog-filename', '.filedialog-cancel-btn', '.savefiledialog-save-btn'] ) {
|
||||
const box = await frame(page).locator(control).boundingBox();
|
||||
expect(box.x).toBeGreaterThanOrEqual(0);
|
||||
expect(box.x + box.width).toBeLessThanOrEqual(width);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
test.describe('on a small phone', () => {
|
||||
const { defaultBrowserType: _browser, ...iPhoneSE } = devices['iPhone SE'];
|
||||
test.use(iPhoneSE);
|
||||
|
||||
test('the framed open picker keeps its buttons on one line inside its bar', async ({ page }) => {
|
||||
await page.goto('/');
|
||||
await page.waitForFunction(() => !!window.puter?.authToken, null, { timeout: 60_000 });
|
||||
await openFirstPartyPage(page);
|
||||
await runFromClick(page, 'puter.auth.signIn()');
|
||||
await frameReady(page);
|
||||
await frame(page).locator('.auth-dialog [data-screen="accounts"] button').first().click();
|
||||
expect((await result(page)).ok).toBe(true);
|
||||
|
||||
await runFromClick(page, 'puter.ui.showOpenFilePicker()');
|
||||
await frameReady(page);
|
||||
const bar = await frame(page).locator('.window-filedialog-prompt').boundingBox();
|
||||
const cancel = await frame(page).locator('.filedialog-cancel-btn').boundingBox();
|
||||
const open = await frame(page).locator('.openfiledialog-open-btn').boundingBox();
|
||||
expect(open.y).toBe(cancel.y);
|
||||
expect(open.x).toBeGreaterThan(cancel.x + cancel.width);
|
||||
expect(open.y + open.height).toBeLessThan(bar.y + bar.height);
|
||||
|
||||
// With German's longer labels, the upload label gives way so both
|
||||
// buttons stay whole on screen.
|
||||
await frame(page).locator('.window-filedialog-prompt').evaluate((el) => {
|
||||
el.querySelector('.window-filedialog-upload-here').lastChild.textContent = ' Hochladen';
|
||||
el.querySelector('.filedialog-cancel-btn').textContent = 'Abbrechen';
|
||||
el.querySelector('.openfiledialog-open-btn').textContent = 'Öffnen';
|
||||
});
|
||||
const germanOpen = await frame(page).locator('.openfiledialog-open-btn').boundingBox();
|
||||
expect(germanOpen.x + germanOpen.width).toBeLessThanOrEqual(bar.x + bar.width);
|
||||
});
|
||||
});
|
||||
|
||||
test('a provider picked in the framed sign-in opens straight in the popup', async ({ page }) => {
|
||||
await page.goto('/');
|
||||
await page.waitForFunction(() => !!window.user?.username && !!window.puter?.authToken, null, { timeout: 60_000 });
|
||||
const username = await page.evaluate(() => window.user.username);
|
||||
// Offer Google, and stand in for its round trip: the provider returns
|
||||
// the popup to the sign-in popup for the same attempt.
|
||||
await page.context().route('**/auth/oidc/providers', (route) =>
|
||||
route.fulfill({ contentType: 'application/json', body: JSON.stringify({ providers: ['google'] }) }));
|
||||
let started = null;
|
||||
await page.context().route('**/auth/oidc/google/start?*', (route) => {
|
||||
started = new URL(route.request().url());
|
||||
const back = new URL('/action/sign-in', PUTER_ORIGIN);
|
||||
back.searchParams.set('embedded_in_popup', 'true');
|
||||
back.searchParams.set('msg_id', started.searchParams.get('msg_id'));
|
||||
return route.fulfill({ status: 302, headers: { location: back.href } });
|
||||
});
|
||||
|
||||
await openFirstPartyPage(page);
|
||||
const popups = [];
|
||||
page.on('popup', (p) => popups.push(p));
|
||||
await runFromClick(page, 'puter.auth.signIn()');
|
||||
await frameReady(page);
|
||||
const frameMsgId = await page.evaluate(() =>
|
||||
new URLSearchParams(new URL(document.querySelector('dialog.puter-popup-frame iframe').src).hash.slice(1)).get('msg_id'));
|
||||
await frame(page).locator('.auth-dialog [data-screen="accounts"]').waitFor();
|
||||
await frame(page).locator('.auth-dialog .auth-to-login').click();
|
||||
await frame(page).locator('.oidc-google-btn').click();
|
||||
|
||||
await expect.poll(() => popups.length).toBe(1);
|
||||
await expect(page.locator('dialog.puter-popup-frame')).toHaveCount(0);
|
||||
expect(started.origin + started.pathname).toBe(`${PUTER_ORIGIN}/auth/oidc/google/start`);
|
||||
expect(started.searchParams.get('msg_id')).toBe(frameMsgId);
|
||||
expect(started.searchParams.get('embedded_in_popup')).toBe('true');
|
||||
expect(started.searchParams.get('opener_origin')).toBe(FIRST_PARTY);
|
||||
|
||||
const popup = popups[0];
|
||||
await popup.locator('.auth-dialog [data-screen="accounts"] button').first().click();
|
||||
const signedIn = await result(page);
|
||||
expect(signedIn).toMatchObject({ ok: true, value: { success: true, username } });
|
||||
expect(popups).toHaveLength(1);
|
||||
});
|
||||
|
||||
test('a page signed in as someone else gets the picker popup', async ({ page }) => {
|
||||
await page.goto('/');
|
||||
await page.waitForFunction(() => !!window.puter?.authToken, null, { timeout: 60_000 });
|
||||
await openFirstPartyPage(page);
|
||||
await runFromClick(page, 'puter.auth.signIn()');
|
||||
await frameReady(page);
|
||||
await frame(page).locator('.auth-dialog [data-screen="accounts"] button').first().click();
|
||||
await result(page);
|
||||
// Name another user as the page's own, once sign-in's own whoami has landed.
|
||||
await page.evaluate(async () => {
|
||||
await puter.whoamiCache_;
|
||||
puter.whoami = { uuid: '00000000-0000-4000-8000-000000000000' };
|
||||
});
|
||||
|
||||
const popup = page.waitForEvent('popup', { timeout: 60_000 });
|
||||
await runFromClick(page, 'puter.ui.showOpenFilePicker()');
|
||||
expect(new URL((await popup).url()).pathname).toBe('/action/show-open-file-picker');
|
||||
await expect(page.locator('dialog.puter-popup-frame')).toHaveCount(0);
|
||||
});
|
||||
});
|
||||
|
||||
// The open-source GUI has no upgrade dialog, so the frame gets a stand-in for
|
||||
// the deployment's: it records what prompted it and closes from its buttons.
|
||||
const STUB_UPGRADE_DIALOG = () => {
|
||||
if ( location.pathname !== '/embed/upgrade' ) return;
|
||||
window.UIUpgradeAccount = class {
|
||||
static embeddable = true;
|
||||
constructor ({ attribution, onClose }) {
|
||||
window.__upgradeAttribution = attribution;
|
||||
this.onClose = onClose;
|
||||
}
|
||||
async open_as_window () {
|
||||
const dialog = document.createElement('div');
|
||||
dialog.className = 'stub-upgrade';
|
||||
dialog.setAttribute('role', 'dialog');
|
||||
dialog.style.cssText = 'position:fixed;inset:0;background:rgba(0,0,0,.5)';
|
||||
dialog.innerHTML = '<button id="buy">Buy</button><button id="done">Close</button>';
|
||||
dialog.querySelector('#buy').onclick = () => {
|
||||
this.upgraded = true;
|
||||
};
|
||||
dialog.querySelector('#done').onclick = () => {
|
||||
dialog.remove();
|
||||
this.onClose({ upgraded: this.upgraded === true });
|
||||
};
|
||||
document.body.append(dialog);
|
||||
}
|
||||
};
|
||||
};
|
||||
|
||||
/** Signs the first-party page in as the admin, whose Puter session the GUI holds. */
|
||||
const signInFirstPartyPage = async (page) => {
|
||||
await page.goto('/');
|
||||
await page.waitForFunction(() => !!window.puter?.authToken, null, { timeout: 60_000 });
|
||||
await openFirstPartyPage(page);
|
||||
await runFromClick(page, 'puter.auth.signIn()');
|
||||
await frameReady(page);
|
||||
await frame(page).locator('.auth-dialog [data-screen="accounts"] button').first().click();
|
||||
expect(await result(page)).toMatchObject({ ok: true });
|
||||
await expect(page.locator('dialog.puter-popup-frame')).toHaveCount(0);
|
||||
};
|
||||
|
||||
/** Stands in for the dashboard the upgrade falls back to, so no request leaves the machine. */
|
||||
const routeDashboard = (page) => page.context().route('https://puter.com/**', (route) =>
|
||||
route.fulfill({ contentType: 'text/html', body: '<!doctype html><title>dashboard</title>' }));
|
||||
|
||||
test.describe('the upgrade a first-party page shows framed', () => {
|
||||
test('requestUpgrade() shows it over the page and resolves whether the user upgraded', async ({ page }) => {
|
||||
await page.context().addInitScript(STUB_UPGRADE_DIALOG);
|
||||
await signInFirstPartyPage(page);
|
||||
const popups = [];
|
||||
page.on('popup', (p) => popups.push(p));
|
||||
|
||||
await runFromClick(page, 'puter.ui.requestUpgrade({ reason: "funds", method: "puter.ai.chat", message: "x" })');
|
||||
await frameReady(page);
|
||||
const upgradeFrame = page.frames().find((f) => new URL(f.url()).pathname === '/embed/upgrade');
|
||||
// The app it credits is the page's own, resolved from its origin.
|
||||
expect(await upgradeFrame.evaluate(() => window.__upgradeAttribution)).toEqual({
|
||||
appUid: expect.stringMatching(/^app-/),
|
||||
reason: 'funds',
|
||||
method: 'puter.ai.chat',
|
||||
});
|
||||
// The page shows through around the dialog.
|
||||
expect(await upgradeFrame.evaluate(() => [
|
||||
getComputedStyle(document.documentElement).backgroundColor,
|
||||
getComputedStyle(document.body).backgroundColor,
|
||||
])).toEqual(['rgba(0, 0, 0, 0)', 'rgba(0, 0, 0, 0)']);
|
||||
|
||||
await frame(page).locator('#buy').click();
|
||||
await frame(page).locator('#done').click();
|
||||
expect(await result(page)).toEqual({ ok: true, value: { upgraded: true } });
|
||||
await expect(page.locator('dialog.puter-popup-frame')).toHaveCount(0);
|
||||
expect(popups).toHaveLength(0);
|
||||
});
|
||||
|
||||
test('the usage limit dialog\'s Upgrade button shows it instead of a tab', async ({ page }) => {
|
||||
await page.context().addInitScript(STUB_UPGRADE_DIALOG);
|
||||
await signInFirstPartyPage(page);
|
||||
const popups = [];
|
||||
page.on('popup', (p) => popups.push(p));
|
||||
// The account is out of credit.
|
||||
await page.route(`${API_ORIGIN}/drivers/call`, (route) => route.fulfill({
|
||||
status: route.request().method() === 'OPTIONS' ? 204 : 402,
|
||||
headers: {
|
||||
'access-control-allow-origin': FIRST_PARTY,
|
||||
'access-control-allow-headers': '*',
|
||||
'access-control-allow-credentials': 'true',
|
||||
},
|
||||
contentType: 'application/json',
|
||||
body: JSON.stringify({ success: false, error: { code: 'insufficient_funds', message: 'Not enough credit.' } }),
|
||||
}));
|
||||
|
||||
await page.evaluate(() => puter.kv.set('upgrade-frame', 'x').catch(() => {}));
|
||||
await page.locator('usage-limit-dialog #upgrade-btn').click();
|
||||
await frameReady(page);
|
||||
await expect(page.locator('usage-limit-dialog')).toHaveCount(0);
|
||||
const upgradeFrame = page.frames().find((f) => new URL(f.url()).pathname === '/embed/upgrade');
|
||||
expect(await upgradeFrame.evaluate(() => window.__upgradeAttribution)).toMatchObject({ reason: 'funds' });
|
||||
|
||||
await frame(page).locator('#done').click();
|
||||
await expect(page.locator('dialog.puter-popup-frame')).toHaveCount(0);
|
||||
expect(popups).toHaveLength(0);
|
||||
});
|
||||
|
||||
test('a call refused while the upgrade shows leaves it uncovered', async ({ page }) => {
|
||||
await page.context().addInitScript(STUB_UPGRADE_DIALOG);
|
||||
await signInFirstPartyPage(page);
|
||||
await page.route(`${API_ORIGIN}/drivers/call`, (route) => route.fulfill({
|
||||
status: route.request().method() === 'OPTIONS' ? 204 : 402,
|
||||
headers: {
|
||||
'access-control-allow-origin': FIRST_PARTY,
|
||||
'access-control-allow-headers': '*',
|
||||
'access-control-allow-credentials': 'true',
|
||||
},
|
||||
contentType: 'application/json',
|
||||
body: JSON.stringify({ success: false, error: { code: 'insufficient_funds', message: 'Not enough credit.' } }),
|
||||
}));
|
||||
|
||||
await runFromClick(page, 'puter.ui.requestUpgrade({ reason: "funds" })');
|
||||
await frameReady(page);
|
||||
const refused = await page.evaluate(() => puter.kv.set('upgrade-frame', 'x').then(() => false, () => true));
|
||||
expect(refused).toBe(true);
|
||||
await expect(page.locator('usage-limit-dialog')).toHaveCount(0);
|
||||
|
||||
await frame(page).locator('#done').click();
|
||||
expect(await result(page)).toEqual({ ok: true, value: { upgraded: false } });
|
||||
await page.evaluate(() => puter.kv.set('upgrade-frame', 'x').catch(() => {}));
|
||||
await expect(page.locator('usage-limit-dialog')).toHaveCount(1);
|
||||
});
|
||||
|
||||
test('a deployment without an upgrade dialog opens the dashboard upgrade in a tab', async ({ page }) => {
|
||||
await routeDashboard(page);
|
||||
await signInFirstPartyPage(page);
|
||||
|
||||
const popup = page.waitForEvent('popup', { timeout: 60_000 });
|
||||
await runFromClick(page, 'puter.ui.requestUpgrade({ reason: "storage", method: "puter.fs.upload" })');
|
||||
const url = new URL((await popup).url());
|
||||
expect(url.origin + url.pathname).toBe('https://puter.com/dashboard/');
|
||||
expect(url.searchParams.get('upgrade')).toBe('storage');
|
||||
expect(url.searchParams.get('upgrade_method')).toBe('puter.fs.upload');
|
||||
expect(await result(page)).toEqual({ ok: true, value: { upgraded: false } });
|
||||
await expect(page.locator('dialog.puter-popup-frame')).toHaveCount(0);
|
||||
});
|
||||
|
||||
test('an upgrade dialog that fails to open leaves the dashboard upgrade in a tab', async ({ page }) => {
|
||||
await page.context().addInitScript(STUB_UPGRADE_DIALOG);
|
||||
await page.context().addInitScript(() => {
|
||||
if ( location.pathname !== '/embed/upgrade' ) return;
|
||||
window.UIUpgradeAccount.prototype.open_as_window = async () => {
|
||||
throw new Error('broken dialog');
|
||||
};
|
||||
});
|
||||
await routeDashboard(page);
|
||||
await signInFirstPartyPage(page);
|
||||
|
||||
const popup = page.waitForEvent('popup', { timeout: 60_000 });
|
||||
await runFromClick(page, 'puter.ui.requestUpgrade({ reason: "funds" })');
|
||||
expect(new URL((await popup).url()).pathname).toBe('/dashboard/');
|
||||
expect(await result(page)).toEqual({ ok: true, value: { upgraded: false } });
|
||||
await expect(page.locator('dialog.puter-popup-frame')).toHaveCount(0);
|
||||
});
|
||||
|
||||
test('a page signed in as someone else gets the dashboard upgrade in a tab', async ({ page }) => {
|
||||
await page.context().addInitScript(STUB_UPGRADE_DIALOG);
|
||||
await routeDashboard(page);
|
||||
await signInFirstPartyPage(page);
|
||||
await page.evaluate(async () => {
|
||||
await puter.whoamiCache_;
|
||||
puter.whoami = { uuid: '00000000-0000-4000-8000-000000000000' };
|
||||
});
|
||||
|
||||
const popup = page.waitForEvent('popup', { timeout: 60_000 });
|
||||
await runFromClick(page, 'puter.ui.requestUpgrade({ reason: "funds" })');
|
||||
expect(new URL((await popup).url()).pathname).toBe('/dashboard/');
|
||||
expect(await result(page)).toEqual({ ok: true, value: { upgraded: false } });
|
||||
await expect(page.locator('dialog.puter-popup-frame')).toHaveCount(0);
|
||||
});
|
||||
});
|
||||
Reference in new issue
Block a user