mirror of
https://github.com/HeyPuter/puter.git
synced 2026-11-13 20:12:57 -10:00
Compare commits
23
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6050ff78c3 | ||
|
|
abb647d227 | ||
|
|
fa2d2d226a | ||
|
|
bb55d6c6a4 | ||
|
|
11107f3108 | ||
|
|
2c3b69011f | ||
|
|
eefc1f2f2e | ||
|
|
7e093d2ba7 | ||
|
|
bd7614372a | ||
|
|
61b5aa4900 | ||
|
|
a6e75b46cb | ||
|
|
dd32c7f9b2 | ||
|
|
aaa5c82236 | ||
|
|
8b68c103c5 | ||
|
|
454f94fc54 | ||
|
|
8b7d380de1 | ||
|
|
8052a4287e | ||
|
|
f114b13306 | ||
|
|
ce70728eeb | ||
|
|
8518023b0b | ||
|
|
33988ac84c | ||
|
|
72de6e16b2 | ||
|
|
234994d3af |
No files matched your search
+1
-1
@@ -40,7 +40,7 @@ The following have already been reviewed and determined **not to be vulnerabilit
|
||||
- **SSRF via `secureFetch`.** Production routes outbound requests through an isolated proxy that has no access to internal/SSRF-sensitive resources.
|
||||
- **Attacks that depend on guessing an `appInstanceID` or app UID.** These are random 128-bit secret values and are not considered guessable.
|
||||
- **Apps invoking drivers, creating workers, or using KV.** Applications are intended to do this; worker permissions are scoped to the owning app. This is by design.
|
||||
- **App metadata or app user-count "leaks".** This information is currently public by design. This covers **private apps** too: private apps are an unreleased, admin-only beta for paid listings in the Puter App Center. Their `index_url` and other metadata are not secret, the flag is not user-settable, and no production app relies on it. Reports that a private app's metadata is reachable through a sibling route (taskbar items, `/get-launch-apps`, `index_url` drift on the hosting gate, etc.) are normalization work, not vulnerabilities.
|
||||
- **App metadata or app user-count "leaks".** This information is currently public by design. This covers **private apps** too: private apps are an unreleased, admin-only beta for paid listings in the Puter App Center. Their `index_url` and other metadata are not secret, the flag is not user-settable, and no production app relies on it. Reports that a private app's metadata is reachable through a sibling route (`/get-launch-apps`, `index_url` drift on the hosting gate, etc.) are normalization work, not vulnerabilities.
|
||||
- **Worker hot-reload driven by a share recipient.** Sharing a worker's source file with write access is how you let a collaborator change that worker's code and have it deploy live. The redeploy running as the file owner, with the owner's worker credentials, is the intended behavior of that grant — the owner chose to hand out write access to executable code. If you do not want that, do not share the source file with write access.
|
||||
- **Re-claiming a site or worker name its owner deleted.** A hosted site or worker name that its owner deletes is treated as abandoned by that owner. If one of their apps still points at it, whoever claims the name next serves that app's `index_url` and receives what the app is launched with, and a new app on the same origin may share the old one's identity. Guarding app identities against being recycled this way is ongoing hardening, not a security boundary, so new ways to re-claim an abandoned name, or to inherit an app's tokens or data through one, are not eligible.
|
||||
- **Share-mode downgrades that do not cascade.** Demoting a delegate does not retroactively revoke the grants that delegate already issued downstream. Shares are independent grants once issued, not a live-evaluated chain. Revoking the downstream grant is a separate, supported action.
|
||||
|
||||
+40
-10
@@ -257,8 +257,41 @@ describe('whoami extension — handleWhoami', () => {
|
||||
expect(body.created_ts).toBeGreaterThan(0);
|
||||
// `directories` is only sent to user actors — confirm it’s present.
|
||||
expect(body.directories).toBeDefined();
|
||||
// taskbar_items is only sent to user actors.
|
||||
expect(body).toHaveProperty('taskbar_items');
|
||||
});
|
||||
|
||||
it('leaves out taskbar items saved on the account', async () => {
|
||||
const user = await seedUser();
|
||||
await server.stores.user.update(user.id as number, {
|
||||
taskbar_items: JSON.stringify([{ type: 'app', name: 'editor' }]),
|
||||
});
|
||||
const { res, captured } = makeRes();
|
||||
|
||||
await runWithContext(
|
||||
{ actor: { user: { uuid: user.uuid, id: user.id as number } } },
|
||||
() => handleWhoami(makeReq(), res),
|
||||
);
|
||||
|
||||
expect(captured.body).not.toHaveProperty('taskbar_items');
|
||||
});
|
||||
|
||||
it('leaves out a desktop background saved on the account', async () => {
|
||||
const user = await seedUser();
|
||||
await server.stores.user.update(user.id as number, {
|
||||
desktop_bg_url: 'https://cdn.test/wallpaper.png',
|
||||
desktop_bg_color: '#000000',
|
||||
desktop_bg_fit: 'cover',
|
||||
});
|
||||
const { res, captured } = makeRes();
|
||||
|
||||
await runWithContext(
|
||||
{ actor: { user: { uuid: user.uuid, id: user.id as number } } },
|
||||
() => handleWhoami(makeReq(), res),
|
||||
);
|
||||
|
||||
const body = captured.body as Record<string, unknown>;
|
||||
expect(body).not.toHaveProperty('desktop_bg_url');
|
||||
expect(body).not.toHaveProperty('desktop_bg_color');
|
||||
expect(body).not.toHaveProperty('desktop_bg_fit');
|
||||
});
|
||||
|
||||
it('reports the SMS-to-card fallback only once a send has opened it', async () => {
|
||||
@@ -322,7 +355,7 @@ describe('whoami extension — handleWhoami', () => {
|
||||
expect(flags.payment_bypass).toBeUndefined();
|
||||
});
|
||||
|
||||
it('strips desktop_bg_*, created_ts and human_readable_age fields for app actors', async () => {
|
||||
it('strips created_ts and human_readable_age fields for app actors', async () => {
|
||||
const user = await seedUser();
|
||||
const { res, captured } = makeRes();
|
||||
|
||||
@@ -340,9 +373,6 @@ describe('whoami extension — handleWhoami', () => {
|
||||
expect(body.app_name).toBe('app-test-actor');
|
||||
// is_user_token is stripped for app actors.
|
||||
expect(body.is_user_token).toBeUndefined();
|
||||
expect(body.desktop_bg_url).toBeUndefined();
|
||||
expect(body.desktop_bg_color).toBeUndefined();
|
||||
expect(body.desktop_bg_fit).toBeUndefined();
|
||||
expect(body.human_readable_age).toBeUndefined();
|
||||
// Account age, in either form, is not exposed to apps.
|
||||
expect(body.created_ts).toBeUndefined();
|
||||
@@ -432,7 +462,7 @@ describe('whoami extension — handleWhoami', () => {
|
||||
});
|
||||
});
|
||||
|
||||
it('cannot add taskbar_items for an app actor, which core omits', async () => {
|
||||
it('cannot add directories for an app actor, which core omits', async () => {
|
||||
const user = await seedUser();
|
||||
const body = await whoamiWithListener(
|
||||
makeActor({
|
||||
@@ -440,11 +470,11 @@ describe('whoami extension — handleWhoami', () => {
|
||||
app: { uid: 'app-test-actor' },
|
||||
}),
|
||||
(_key, event) => {
|
||||
event.details.taskbar_items = [{ name: 'injected' }];
|
||||
event.details.directories = { '/injected': 'uuid' };
|
||||
},
|
||||
);
|
||||
|
||||
expect(body).not.toHaveProperty('taskbar_items');
|
||||
expect(body).not.toHaveProperty('directories');
|
||||
});
|
||||
});
|
||||
|
||||
@@ -525,7 +555,7 @@ describe('whoami extension — handleWhoami', () => {
|
||||
expect(body.otp_secret).toBeUndefined();
|
||||
expect(body.signup_ip).toBeUndefined();
|
||||
// Not just absent as a key — the values must not appear anywhere
|
||||
// in the payload (nested under metadata, taskbar items, …).
|
||||
// in the payload (nested under metadata, …).
|
||||
const serialized = JSON.stringify(body);
|
||||
expect(serialized).not.toContain('5551234567');
|
||||
expect(serialized).not.toContain('fp_ABC123');
|
||||
|
||||
+2
-16
@@ -1,6 +1,5 @@
|
||||
import { Context } from '@heyputer/backend/src/core';
|
||||
import { extension } from '@heyputer/backend/src/extensions';
|
||||
import { APP_ICON_SIZES } from '@heyputer/backend/src/util/appIcon.js';
|
||||
import {
|
||||
buildUserDetails,
|
||||
scrubSensitive,
|
||||
@@ -54,19 +53,10 @@ export const handleWhoami = async (
|
||||
return;
|
||||
}
|
||||
|
||||
const rawIconSize =
|
||||
typeof req.query?.icon_size === 'string'
|
||||
? Number(req.query.icon_size)
|
||||
: undefined;
|
||||
const iconSize =
|
||||
rawIconSize !== undefined && APP_ICON_SIZES.includes(rawIconSize)
|
||||
? rawIconSize
|
||||
: undefined;
|
||||
|
||||
const details = await buildUserDetails(
|
||||
user,
|
||||
{ config: extension.config, clients, stores, services },
|
||||
{ isUser, iconSize, noIcons: !iconSize },
|
||||
{ isUser },
|
||||
);
|
||||
details.human_readable_age = user.timestamp
|
||||
? timeago.format(new Date(user.timestamp as string))
|
||||
@@ -81,9 +71,6 @@ export const handleWhoami = async (
|
||||
delete details.email;
|
||||
delete details.unconfirmed_email;
|
||||
}
|
||||
delete details.desktop_bg_url;
|
||||
delete details.desktop_bg_color;
|
||||
delete details.desktop_bg_fit;
|
||||
delete details.human_readable_age;
|
||||
delete details.created_ts;
|
||||
delete details.is_user_token;
|
||||
@@ -121,8 +108,7 @@ export const handleWhoami = async (
|
||||
}
|
||||
|
||||
const subscription = details.subscription as
|
||||
| { offering?: Record<string, unknown> }
|
||||
| undefined;
|
||||
{ offering?: Record<string, unknown> } | undefined;
|
||||
if (subscription?.offering) {
|
||||
delete subscription.offering.group;
|
||||
delete subscription.offering.benefits;
|
||||
|
||||
@@ -190,6 +190,13 @@ S3_BUCKET=puter-local
|
||||
providers = [ordered]@{
|
||||
ollama = [ordered]@{ enabled = $false }
|
||||
}
|
||||
# Off because a self-hosted install has no paid plans: every account
|
||||
# is on the free policy, so the plan gates would 402 the surfaces that
|
||||
# declare one (the OpenAI/Anthropic-compatible AI endpoints) for
|
||||
# everybody. Same as install.sh.
|
||||
meteringEnforcement = [ordered]@{
|
||||
subscriptions = $false
|
||||
}
|
||||
trust_proxy = 1
|
||||
}
|
||||
$configJson = $config | ConvertTo-Json -Depth 10
|
||||
|
||||
@@ -125,7 +125,6 @@ describe('core without a teams registration', () => {
|
||||
actor: { user: row },
|
||||
} as never,
|
||||
{ title: 'Puter' } as never,
|
||||
{} as never,
|
||||
);
|
||||
const params = JSON.parse(
|
||||
/gui\((\{.*?\})\);/s.exec(html)![1].replaceAll('\\u003c', '<'),
|
||||
|
||||
@@ -736,6 +736,8 @@ export type EventMap = {
|
||||
'outer.permission.flatInvalidated': {
|
||||
entries: Array<{ holderUserId: number; permission: string }>;
|
||||
};
|
||||
/** Links on these nodes were removed; read them from the primary. */
|
||||
'outer.share.linksRevoked': { fsentryIds: number[]; uuids: string[] };
|
||||
/**
|
||||
* A user's subscription set changed, so every process must drop its cached
|
||||
* "does this user have any subscriptions" answer. Carries the counter the
|
||||
@@ -874,8 +876,11 @@ export type EventMap = {
|
||||
session_uids: string[];
|
||||
};
|
||||
|
||||
/** One access token was revoked; only its own connections should drop. */
|
||||
'auth.access-token.revoked': { token_uid: string };
|
||||
/**
|
||||
* One access token was revoked; only its own connections should drop.
|
||||
* `outer.*` for the same reason as `outer.auth.sessions.revoked`.
|
||||
*/
|
||||
'outer.auth.access-token.revoked': { token_uid: string };
|
||||
|
||||
/** Same-cluster eviction for raw realtime WebSockets. */
|
||||
'pubsub.realtime.auth-revoked': {
|
||||
@@ -1083,11 +1088,10 @@ export type EventKey = keyof EventMap & string;
|
||||
// Generates a wildcard for every non-final dot-separated prefix of K.
|
||||
export type WildcardPrefixes<K extends string> =
|
||||
K extends `${infer Head}.${infer Tail}`
|
||||
?
|
||||
| `${Head}.*`
|
||||
| (Tail extends `${string}.${string}`
|
||||
? `${Head}.${WildcardPrefixes<Tail>}`
|
||||
: never)
|
||||
? | `${Head}.*`
|
||||
| (Tail extends `${string}.${string}`
|
||||
? `${Head}.${WildcardPrefixes<Tail>}`
|
||||
: never)
|
||||
: never;
|
||||
|
||||
export type ListenKey = EventKey | WildcardPrefixes<EventKey>;
|
||||
@@ -1098,10 +1102,7 @@ export type MatchingEvents<P extends ListenKey> = P extends `${infer Prefix}.*`
|
||||
|
||||
/** Acked, not acked, no socket anywhere, or sockets only in a peer region. */
|
||||
export type NotifDeliveryOutcome =
|
||||
| 'received'
|
||||
| 'unreceived'
|
||||
| 'no-socket'
|
||||
| 'remote-only';
|
||||
'received' | 'unreceived' | 'no-socket' | 'remote-only';
|
||||
|
||||
/** One socket's receipt for a live notification. */
|
||||
export interface NotifDeliveryResponder {
|
||||
|
||||
@@ -52,8 +52,8 @@ const APP_READ_LIMIT = {
|
||||
/**
|
||||
* Unauthenticated icon serving; no actor to key on, so the bucket is the
|
||||
* address — and an address is a NAT, a campus or a carrier gateway that can
|
||||
* hold hundreds of desktops. Each desktop boot pulls the taskbar's icons at
|
||||
* once, so a single burst from one network is already thousands of requests.
|
||||
* hold hundreds of desktops. Each dashboard load pulls its app icons at once,
|
||||
* so a single burst from one network is already thousands of requests.
|
||||
* Responses are publicly cacheable and usually a redirect, so the ceiling is
|
||||
* not protecting bandwidth; it is there so a client looping on a broken icon
|
||||
* can't spin unbounded.
|
||||
@@ -523,7 +523,7 @@ export class AppController extends PuterController {
|
||||
};
|
||||
|
||||
// Icons are <img src> targets from the GUI (root) AND resolved via
|
||||
// api_base_url in taskbar payloads. Register on both so either origin
|
||||
// api_base_url in app summaries. Register on both so either origin
|
||||
// works without a cross-subdomain redirect.
|
||||
router.get(
|
||||
'/app-icon/:app_uid',
|
||||
|
||||
@@ -1271,7 +1271,7 @@ describe('AppController app-icon rate limit', () => {
|
||||
it('sizes the icon bucket for a whole network rather than one desktop', () => {
|
||||
// Icons are unauthenticated `<img src>` targets, so the only key is
|
||||
// the address — which one NAT shares across every desktop behind it,
|
||||
// and each boot pulls the taskbar's icons in a burst.
|
||||
// and each dashboard load pulls its app icons in a burst.
|
||||
for (const path of ['/app-icon/:app_uid', '/app-icon/:app_uid/:size']) {
|
||||
const route = router.routes.find(
|
||||
(r) => r.method === 'get' && r.path === path,
|
||||
|
||||
@@ -23,6 +23,7 @@ import { makeActor } from '../../core/actor.js';
|
||||
import { runWithContext } from '../../core/context.js';
|
||||
import { createSecret as otpCreateSecret } from '../../services/auth/OTPUtil.js';
|
||||
import { FULL_API_ACCESS } from '../../services/permission/consts.js';
|
||||
import { tokenClaimsDigest } from '../../../gui/src/helpers/guiToken.js';
|
||||
import {
|
||||
createTestUser,
|
||||
setupPuterTestEnv,
|
||||
@@ -714,4 +715,67 @@ describe('session token helpers over HTTP', () => {
|
||||
'puter_auth_token=',
|
||||
);
|
||||
});
|
||||
|
||||
describe("the shell's guiTokenDigest", () => {
|
||||
/** The session cookie `/session/sync-cookie` sets for `token`. */
|
||||
const sessionCookie = async (token: string) => {
|
||||
const sync = await get('/session/sync-cookie', token);
|
||||
expect(sync.status).toBe(204);
|
||||
const value = /puter_auth_token=([^;]+)/.exec(
|
||||
sync.headers.get('set-cookie') ?? '',
|
||||
)?.[1];
|
||||
expect(value).toBeTruthy();
|
||||
return `puter_auth_token=${value}`;
|
||||
};
|
||||
|
||||
/** What the shell at `path` renders for `guiTokenDigest`. */
|
||||
const shellDigest = async (path: string, cookie?: string) => {
|
||||
const res = await fetch(new URL(path, env.origin), {
|
||||
headers: cookie ? { cookie } : {},
|
||||
});
|
||||
expect(res.status).toBe(200);
|
||||
const html = await res.text();
|
||||
const match = /"guiTokenDigest":(null|"[0-9a-f]{32}")/.exec(html);
|
||||
if (!match) {
|
||||
expect(html).not.toContain('guiTokenDigest');
|
||||
return undefined;
|
||||
}
|
||||
return JSON.parse(match[1]) as string | null;
|
||||
};
|
||||
|
||||
it("names the token /get-gui-token hands over for the session cookie", async () => {
|
||||
const { token } = await signupTemp();
|
||||
const cookie = await sessionCookie(token);
|
||||
|
||||
const gui = await fetch(new URL('/get-gui-token', env.origin), {
|
||||
headers: { cookie },
|
||||
});
|
||||
expect(gui.status).toBe(200);
|
||||
const { token: guiToken } = (await gui.json()) as { token: string };
|
||||
|
||||
const digest = await shellDigest('/', cookie);
|
||||
expect(digest).toBe(await tokenClaimsDigest(guiToken));
|
||||
// The token the browser stored at sign-up is for the same session.
|
||||
expect(await tokenClaimsDigest(token)).toBe(digest);
|
||||
});
|
||||
|
||||
it('is null without a session cookie, even with a token in the URL', async () => {
|
||||
const { token } = await signupTemp();
|
||||
expect(await shellDigest('/')).toBe(null);
|
||||
expect(
|
||||
await shellDigest(`/?auth_token=${encodeURIComponent(token)}`),
|
||||
).toBe(null);
|
||||
});
|
||||
|
||||
it('is left out when the session cookie does not resolve to a session', async () => {
|
||||
const { token } = await signupTemp();
|
||||
const cookie = await sessionCookie(token);
|
||||
await env.server.services.auth.revokeSession(claims(token).session_uid);
|
||||
|
||||
expect(await shellDigest('/', cookie)).toBe(undefined);
|
||||
expect(await shellDigest('/', 'puter_auth_token=garbage')).toBe(
|
||||
undefined,
|
||||
);
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -1416,7 +1416,7 @@ describe('AuthController.handleLogin', () => {
|
||||
is_user_token: true,
|
||||
});
|
||||
expect(body.user.directories).toBeTypeOf('object');
|
||||
expect(Array.isArray(body.user.taskbar_items)).toBe(true);
|
||||
expect(body.user).not.toHaveProperty('taskbar_items');
|
||||
});
|
||||
|
||||
// A deleted row still answering from cache reaches the session INSERT.
|
||||
@@ -8293,11 +8293,10 @@ describe('AuthController session endpoints', () => {
|
||||
).rejects.toMatchObject({ statusCode: 400 });
|
||||
});
|
||||
|
||||
it('revoke-session: 403 when revoking someone else’s session', async () => {
|
||||
it('revoke-session: 404 when revoking someone else’s session', async () => {
|
||||
const { user: u1 } = await makeUserAndActor();
|
||||
const { actor: a2 } = await makeUserAndActor();
|
||||
// Create a real session for u1 so the lookup succeeds, then attempt
|
||||
// to revoke it as a2 — must 403.
|
||||
// A real session of u1, revoked as a2: answers as a missing one.
|
||||
const sessionRes = await server.services.auth.createSessionToken(
|
||||
u1,
|
||||
{},
|
||||
@@ -8310,7 +8309,7 @@ describe('AuthController session endpoints', () => {
|
||||
),
|
||||
makeRes(),
|
||||
),
|
||||
).rejects.toMatchObject({ statusCode: 403 });
|
||||
).rejects.toMatchObject({ statusCode: 404 });
|
||||
});
|
||||
|
||||
it('rename-session: 400 when uuid param is missing', async () => {
|
||||
@@ -10082,6 +10081,77 @@ describe('AuthController.handleRevokeSession additional branches', () => {
|
||||
expect(Array.isArray(body.sessions)).toBe(true);
|
||||
});
|
||||
|
||||
const expiredSessionOf = async (user: { id: number }) => {
|
||||
const row = await server.stores.session.create(user.id, {
|
||||
expires_at: Math.floor(Date.now() / 1000) - 1,
|
||||
});
|
||||
return row.uuid as string;
|
||||
};
|
||||
|
||||
it('revokes an expired session the caller owns', async () => {
|
||||
const { user, actor } = await makeUserAndActor();
|
||||
const uuid = await expiredSessionOf(user);
|
||||
const res = makeRes();
|
||||
await controller.handleRevokeSession(makeReq({ uuid }, { actor }), res);
|
||||
|
||||
const body = res.body as { sessions: Array<{ uuid: string }> };
|
||||
expect(body.sessions.map((s) => s.uuid)).not.toContain(uuid);
|
||||
const rows = await server.clients.db.read(
|
||||
'SELECT `revoked_at` FROM `sessions` WHERE `uuid` = ?',
|
||||
[uuid],
|
||||
);
|
||||
expect(rows[0].revoked_at).not.toBeNull();
|
||||
});
|
||||
|
||||
it('revoking an expired session ends its live child token', async () => {
|
||||
const { user, actor } = await makeUserAndActor();
|
||||
const parent = await expiredSessionOf(user);
|
||||
const child = await server.stores.session.getOrCreateGodmodeToken(
|
||||
user.id,
|
||||
{
|
||||
parentSessionUid: parent,
|
||||
appUid: `app-${uuidv4()}`,
|
||||
expiresAt: Math.floor(Date.now() / 1000) + 3600,
|
||||
maxAgeSeconds: 3600,
|
||||
label: 'Godmode app',
|
||||
auth_id: user.uuid,
|
||||
},
|
||||
);
|
||||
const childUuid = child!.row.uuid as string;
|
||||
expect(await server.stores.session.getByUuid(childUuid)).toBeTruthy();
|
||||
|
||||
await controller.handleRevokeSession(
|
||||
makeReq({ uuid: parent }, { actor }),
|
||||
makeRes(),
|
||||
);
|
||||
|
||||
expect(await server.stores.session.getByUuid(childUuid)).toBeNull();
|
||||
});
|
||||
|
||||
it('answers 404 for an expired session of another user', async () => {
|
||||
const { user: owner } = await makeUserAndActor();
|
||||
const { actor } = await makeUserAndActor();
|
||||
const uuid = await expiredSessionOf(owner);
|
||||
await expect(
|
||||
controller.handleRevokeSession(
|
||||
makeReq({ uuid }, { actor }),
|
||||
makeRes(),
|
||||
),
|
||||
).rejects.toMatchObject({ statusCode: 404 });
|
||||
});
|
||||
|
||||
it('answers 404 for a session that is already revoked', async () => {
|
||||
const { user, actor } = await makeUserAndActor();
|
||||
const row = await server.stores.session.create(user.id);
|
||||
await server.stores.session.removeByUuid(row.uuid);
|
||||
await expect(
|
||||
controller.handleRevokeSession(
|
||||
makeReq({ uuid: row.uuid }, { actor }),
|
||||
makeRes(),
|
||||
),
|
||||
).rejects.toMatchObject({ statusCode: 404 });
|
||||
});
|
||||
|
||||
it('refuses to revoke the caller’s OWN current session row (400)', async () => {
|
||||
// Invariant: a self-revoke leaves the client in an ambiguous
|
||||
// identity state because the response can't write fresh auth
|
||||
|
||||
@@ -3585,21 +3585,18 @@ export class AuthController extends PuterController {
|
||||
{ legacyCode: 'bad_request' },
|
||||
);
|
||||
}
|
||||
// `getByUuid` returns null when the row is missing, already
|
||||
// soft-revoked, or past `expires_at` — surface as 404 so a stale
|
||||
// manage-sessions UI doesn't 500 when it clicks revoke on a row
|
||||
// that already went away.
|
||||
const session = await this.stores.session.getByUuid(uuid);
|
||||
if (!session) {
|
||||
// Missing, already revoked and other users' rows all answer 404; an
|
||||
// expired row is still revoked so its children go with it.
|
||||
const session = await this.stores.session.getByUuidAny(uuid);
|
||||
if (
|
||||
!session ||
|
||||
session.revoked_at != null ||
|
||||
session.user_id !== req.actor!.user.id
|
||||
) {
|
||||
throw new HttpError(404, 'Session not found', {
|
||||
legacyCode: 'not_found',
|
||||
});
|
||||
}
|
||||
if (session.user_id !== req.actor!.user.id) {
|
||||
throw new HttpError(403, 'Can only revoke your own sessions', {
|
||||
legacyCode: 'unauthorized',
|
||||
});
|
||||
}
|
||||
await this.services.auth.revokeSession(uuid);
|
||||
const sessions = await this.services.auth.listSessions(req.actor!);
|
||||
res.json({ sessions });
|
||||
|
||||
@@ -25,18 +25,13 @@ const ALLOWED_SORT_BY = ['name', 'size', 'modified', 'type'];
|
||||
const ALLOWED_SORT_ORDER = ['asc', 'desc'];
|
||||
|
||||
/**
|
||||
* Desktop/UI preference routes.
|
||||
*
|
||||
* Two categories:
|
||||
*
|
||||
* - User-level: desktop background, taskbar items (UserStore)
|
||||
* - Folder-level: layout, sort_by/sort_order (fsentries table)
|
||||
* Folder view preference routes: layout and sort_by/sort_order, stored on the
|
||||
* folder's fsentries row.
|
||||
*/
|
||||
/**
|
||||
* Desktop preference writes — background, taskbar, layout, sort order. All four
|
||||
* persist to the user row on every call, and the GUI fires them on direct user
|
||||
* action, so a per-minute ceiling well above human speed is enough to catch a
|
||||
* stuck client.
|
||||
* Desktop preference writes — layout, sort order. Each persists on every call,
|
||||
* and the GUI fires them on direct user action, so a per-minute ceiling well
|
||||
* above human speed is enough to catch a stuck client.
|
||||
*/
|
||||
const PREFERENCE_WRITE_LIMIT = {
|
||||
scope: 'desktop-preference',
|
||||
@@ -47,89 +42,6 @@ const PREFERENCE_WRITE_LIMIT = {
|
||||
|
||||
export class DesktopController extends PuterController {
|
||||
registerRoutes(router) {
|
||||
// -- Desktop background --------------------------------------
|
||||
|
||||
router.post(
|
||||
'/set-desktop-bg',
|
||||
{
|
||||
subdomain: 'api',
|
||||
requireUserActor: true,
|
||||
allowFullAccessToken: true,
|
||||
rateLimit: PREFERENCE_WRITE_LIMIT,
|
||||
},
|
||||
async (req, res) => {
|
||||
const { url, color, fit } = req.body ?? {};
|
||||
|
||||
const patch = {};
|
||||
if (url !== undefined) {
|
||||
if (url !== null && typeof url !== 'string') {
|
||||
throw new HttpError(
|
||||
400,
|
||||
'`url` must be a string or null',
|
||||
{ legacyCode: 'bad_request' },
|
||||
);
|
||||
}
|
||||
patch.desktop_bg_url = url;
|
||||
}
|
||||
if (color !== undefined) {
|
||||
if (color !== null && typeof color !== 'string') {
|
||||
throw new HttpError(
|
||||
400,
|
||||
'`color` must be a string or null',
|
||||
{ legacyCode: 'bad_request' },
|
||||
);
|
||||
}
|
||||
patch.desktop_bg_color = color;
|
||||
}
|
||||
if (fit !== undefined) {
|
||||
if (fit !== null && typeof fit !== 'string') {
|
||||
throw new HttpError(
|
||||
400,
|
||||
'`fit` must be a string or null',
|
||||
{ legacyCode: 'bad_request' },
|
||||
);
|
||||
}
|
||||
patch.desktop_bg_fit = fit;
|
||||
}
|
||||
|
||||
if (Object.keys(patch).length === 0) {
|
||||
throw new HttpError(400, 'No fields provided', {
|
||||
legacyCode: 'bad_request',
|
||||
});
|
||||
}
|
||||
|
||||
await this.stores.user.update(req.actor.user.id, patch);
|
||||
res.json({});
|
||||
},
|
||||
);
|
||||
|
||||
// -- Taskbar items -------------------------------------------
|
||||
|
||||
router.post(
|
||||
'/update-taskbar-items',
|
||||
{
|
||||
subdomain: 'api',
|
||||
requireUserActor: true,
|
||||
allowFullAccessToken: true,
|
||||
rateLimit: PREFERENCE_WRITE_LIMIT,
|
||||
},
|
||||
async (req, res) => {
|
||||
const { items } = req.body ?? {};
|
||||
if (!Array.isArray(items)) {
|
||||
throw new HttpError(
|
||||
400,
|
||||
'Missing or invalid `items` array',
|
||||
{ legacyCode: 'bad_request' },
|
||||
);
|
||||
}
|
||||
|
||||
await this.stores.user.update(req.actor.user.id, {
|
||||
taskbar_items: JSON.stringify(items),
|
||||
});
|
||||
res.json({});
|
||||
},
|
||||
);
|
||||
|
||||
// -- Folder layout -------------------------------------------
|
||||
|
||||
router.post(
|
||||
|
||||
@@ -130,147 +130,17 @@ const callRoute = async (
|
||||
});
|
||||
};
|
||||
|
||||
// ── /set-desktop-bg ─────────────────────────────────────────────────
|
||||
|
||||
describe('DesktopController POST /set-desktop-bg', () => {
|
||||
it('persists url/color/fit on the user row', async () => {
|
||||
const { actor, userId } = await makeUser();
|
||||
const { res, captured } = makeRes();
|
||||
await callRoute(
|
||||
'post',
|
||||
'/set-desktop-bg',
|
||||
makeReq({
|
||||
body: {
|
||||
url: 'https://cdn.test/wallpaper.png',
|
||||
color: '#000000',
|
||||
fit: 'cover',
|
||||
},
|
||||
actor,
|
||||
}),
|
||||
res,
|
||||
);
|
||||
expect(captured.body).toEqual({});
|
||||
|
||||
const refreshed = await server.stores.user.getById(userId);
|
||||
expect(refreshed?.desktop_bg_url).toBe(
|
||||
'https://cdn.test/wallpaper.png',
|
||||
);
|
||||
expect(refreshed?.desktop_bg_color).toBe('#000000');
|
||||
expect(refreshed?.desktop_bg_fit).toBe('cover');
|
||||
describe('DesktopController routes', () => {
|
||||
it('has no desktop background route', () => {
|
||||
expect(
|
||||
router.routes.some((r) => r.path === '/set-desktop-bg'),
|
||||
).toBe(false);
|
||||
});
|
||||
|
||||
it('persists only the supplied fields (partial update)', async () => {
|
||||
const { actor, userId } = await makeUser();
|
||||
const { res } = makeRes();
|
||||
await callRoute(
|
||||
'post',
|
||||
'/set-desktop-bg',
|
||||
makeReq({ body: { color: '#ffffff' }, actor }),
|
||||
res,
|
||||
);
|
||||
const refreshed = await server.stores.user.getById(userId);
|
||||
expect(refreshed?.desktop_bg_color).toBe('#ffffff');
|
||||
// Untouched fields remain at their column default.
|
||||
expect(refreshed?.desktop_bg_url).toBeFalsy();
|
||||
expect(refreshed?.desktop_bg_fit).toBeFalsy();
|
||||
});
|
||||
|
||||
it('passes through `null` to clear a field', async () => {
|
||||
const { actor, userId } = await makeUser();
|
||||
// First populate, then clear.
|
||||
const populate = makeRes();
|
||||
await callRoute(
|
||||
'post',
|
||||
'/set-desktop-bg',
|
||||
makeReq({
|
||||
body: { url: 'https://cdn.test/x.png' },
|
||||
actor,
|
||||
}),
|
||||
populate.res,
|
||||
);
|
||||
const before = await server.stores.user.getById(userId);
|
||||
expect(before?.desktop_bg_url).toBe('https://cdn.test/x.png');
|
||||
|
||||
const clear = makeRes();
|
||||
await callRoute(
|
||||
'post',
|
||||
'/set-desktop-bg',
|
||||
makeReq({ body: { url: null }, actor }),
|
||||
clear.res,
|
||||
);
|
||||
const after = await server.stores.user.getById(userId);
|
||||
expect(after?.desktop_bg_url).toBeNull();
|
||||
});
|
||||
|
||||
it('throws 400 when url is not a string or null', async () => {
|
||||
const { actor } = await makeUser();
|
||||
const { res } = makeRes();
|
||||
await expect(
|
||||
callRoute(
|
||||
'post',
|
||||
'/set-desktop-bg',
|
||||
makeReq({ body: { url: 123 }, actor }),
|
||||
res,
|
||||
),
|
||||
).rejects.toMatchObject({ statusCode: 400 });
|
||||
});
|
||||
|
||||
it('throws 400 when no fields are provided', async () => {
|
||||
const { actor } = await makeUser();
|
||||
const { res } = makeRes();
|
||||
await expect(
|
||||
callRoute(
|
||||
'post',
|
||||
'/set-desktop-bg',
|
||||
makeReq({ body: {}, actor }),
|
||||
res,
|
||||
),
|
||||
).rejects.toMatchObject({ statusCode: 400 });
|
||||
});
|
||||
});
|
||||
|
||||
// ── /update-taskbar-items ───────────────────────────────────────────
|
||||
|
||||
describe('DesktopController POST /update-taskbar-items', () => {
|
||||
it('persists items as a JSON-encoded string', async () => {
|
||||
const { actor, userId } = await makeUser();
|
||||
const items = [{ name: 'editor' }, { name: 'browser' }];
|
||||
const { res } = makeRes();
|
||||
await callRoute(
|
||||
'post',
|
||||
'/update-taskbar-items',
|
||||
makeReq({ body: { items }, actor }),
|
||||
res,
|
||||
);
|
||||
|
||||
const refreshed = await server.stores.user.getById(userId);
|
||||
expect(refreshed?.taskbar_items).toBe(JSON.stringify(items));
|
||||
});
|
||||
|
||||
it('throws 400 when items is missing', async () => {
|
||||
const { actor } = await makeUser();
|
||||
const { res } = makeRes();
|
||||
await expect(
|
||||
callRoute(
|
||||
'post',
|
||||
'/update-taskbar-items',
|
||||
makeReq({ body: {}, actor }),
|
||||
res,
|
||||
),
|
||||
).rejects.toMatchObject({ statusCode: 400 });
|
||||
});
|
||||
|
||||
it('throws 400 when items is not an array', async () => {
|
||||
const { actor } = await makeUser();
|
||||
const { res } = makeRes();
|
||||
await expect(
|
||||
callRoute(
|
||||
'post',
|
||||
'/update-taskbar-items',
|
||||
makeReq({ body: { items: 'oops' }, actor }),
|
||||
res,
|
||||
),
|
||||
).rejects.toMatchObject({ statusCode: 400 });
|
||||
it('has no taskbar items route', () => {
|
||||
expect(
|
||||
router.routes.some((r) => r.path === '/update-taskbar-items'),
|
||||
).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
@@ -154,6 +154,26 @@ describe('GET /fs/readdir over HTTP', () => {
|
||||
).toEqual(['a', 'a/b']);
|
||||
});
|
||||
|
||||
it('answers 404 for a directory whose parent chain is broken', async () => {
|
||||
const { username, token } = env.users.user;
|
||||
const path = `/${username}/Documents/http-orphan-${Date.now()}`;
|
||||
const created = await fetch(new URL('/fs/mkdir', env.apiOrigin), {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({ path, auth_token: token }),
|
||||
});
|
||||
expect(created.status).toBe(200);
|
||||
const { uid } = (await created.json()) as { uid: string };
|
||||
await env.server.clients.db.write(
|
||||
'UPDATE fsentries SET path = NULL, parent_uid = ? WHERE uuid = ?',
|
||||
['does-not-exist', uid],
|
||||
);
|
||||
await env.server.stores.fsEntry.invalidateEntryCacheByUuid(uid);
|
||||
|
||||
const response = await fetch(readdirUrl({ uid, auth_token: token }));
|
||||
expect(response.status).toBe(404);
|
||||
});
|
||||
|
||||
it('mkdir does not return internal ids, storage columns or tokens', async () => {
|
||||
const { username, token } = env.users.user;
|
||||
const response = await fetch(new URL('/fs/mkdir', env.apiOrigin), {
|
||||
|
||||
@@ -5111,9 +5111,8 @@ describe('LegacyFSController.updateFsentryThumbnail', () => {
|
||||
// ── GET /get-launch-apps ────────────────────────────────────────────
|
||||
//
|
||||
// `recent` is a launch-metadata producer: it returns `index_url` for
|
||||
// apps the user has opened before. The taskbar happens to launch these
|
||||
// by name (so AppDriver's hosted-backing guard applies), but the field
|
||||
// is served regardless, so the guard is applied here too.
|
||||
// apps the user has opened before. The field is served whoever reads it,
|
||||
// so AppDriver's hosted-backing guard is applied here too.
|
||||
|
||||
describe('LegacyFSController GET /get-launch-apps', () => {
|
||||
const hostedUrl = (sub: string) => `https://${sub}.site.puter.localhost/`;
|
||||
|
||||
@@ -401,11 +401,9 @@ export class LegacyFSController extends PuterController {
|
||||
.filter(Boolean);
|
||||
|
||||
// Don't hand out an index_url whose puter-hosted backing is
|
||||
// gone or reclaimed. The taskbar launches recents by name (so
|
||||
// AppDriver's guard applies), but this list is a
|
||||
// launch-metadata producer like any other — a future consumer
|
||||
// reading index_url straight off it shouldn't inherit a stale
|
||||
// origin.
|
||||
// gone or reclaimed. This list is a launch-metadata producer
|
||||
// like any other — a consumer reading index_url straight off
|
||||
// it shouldn't inherit a stale origin.
|
||||
let backingGoneFlags: boolean[];
|
||||
try {
|
||||
backingGoneFlags =
|
||||
@@ -950,9 +948,7 @@ export class LegacyFSController extends PuterController {
|
||||
// Trash, and `null`/`{}` when restoring. See
|
||||
// `src/gui/src/helpers.js` → `window.move_items`.
|
||||
newMetadata: (body.new_metadata ?? undefined) as
|
||||
| Record<string, unknown>
|
||||
| null
|
||||
| undefined,
|
||||
Record<string, unknown> | null | undefined,
|
||||
});
|
||||
const overwrittenEntry = replacedByMove(overwriteTarget, moved, name);
|
||||
const oldPath = source.path;
|
||||
@@ -1426,8 +1422,7 @@ export class LegacyFSController extends PuterController {
|
||||
}
|
||||
|
||||
type SignedOrEmpty =
|
||||
| (SignedFile & { path?: string })
|
||||
| Record<string, never>;
|
||||
(SignedFile & { path?: string }) | Record<string, never>;
|
||||
const result: { signatures: SignedOrEmpty[]; token?: string } = {
|
||||
signatures: [],
|
||||
};
|
||||
@@ -2054,10 +2049,7 @@ export class LegacyFSController extends PuterController {
|
||||
const subjectRef = body.subject;
|
||||
const appRef = body.app;
|
||||
const mode = (getString(body, 'mode') ?? 'read') as
|
||||
| 'see'
|
||||
| 'list'
|
||||
| 'read'
|
||||
| 'write';
|
||||
'see' | 'list' | 'read' | 'write';
|
||||
if (!subjectRef || !appRef)
|
||||
throw new HttpError(400, '`subject` and `app` are required', {
|
||||
legacyCode: 'bad_request',
|
||||
|
||||
@@ -79,6 +79,7 @@ interface CapturedResponse {
|
||||
statusCode: number;
|
||||
body: unknown;
|
||||
contentType?: string;
|
||||
location?: string;
|
||||
}
|
||||
|
||||
const makeReq = (init: {
|
||||
@@ -87,6 +88,7 @@ const makeReq = (init: {
|
||||
actor?: Actor;
|
||||
hostname?: string;
|
||||
protocol?: string;
|
||||
originalUrl?: string;
|
||||
}): Request => {
|
||||
return {
|
||||
body: {},
|
||||
@@ -94,6 +96,7 @@ const makeReq = (init: {
|
||||
headers: {},
|
||||
params: init.params ?? {},
|
||||
path: init.path ?? '/',
|
||||
originalUrl: init.originalUrl ?? init.path ?? '/',
|
||||
hostname: init.hostname ?? 'test.local',
|
||||
protocol: init.protocol ?? 'http',
|
||||
actor: init.actor,
|
||||
@@ -131,6 +134,11 @@ const makeRes = () => {
|
||||
captured.contentType = value;
|
||||
return res;
|
||||
}),
|
||||
redirect: vi.fn((location: string) => {
|
||||
captured.statusCode = 302;
|
||||
captured.location = location;
|
||||
return res;
|
||||
}),
|
||||
};
|
||||
return { res: res as unknown as Response, captured };
|
||||
};
|
||||
@@ -214,23 +222,72 @@ describe('HomepageController shell routes', () => {
|
||||
expect(String(captured.body)).toMatch(/<!DOCTYPE html>/i);
|
||||
});
|
||||
|
||||
it('serves the shell on /settings, /dashboard, /desktop, /action, /@:username', async () => {
|
||||
for (const path of [
|
||||
'/settings',
|
||||
'/settings/*splat',
|
||||
'/dashboard',
|
||||
'/dashboard/',
|
||||
'/desktop',
|
||||
'/desktop/',
|
||||
'/action/*splat',
|
||||
'/@:username',
|
||||
]) {
|
||||
it('leaves guiTokenDigest out for a session cookie that is not a user session', async () => {
|
||||
const { actor } = await makeUser();
|
||||
const appActor = {
|
||||
...actor,
|
||||
app: { id: 1, uid: 'app-test' },
|
||||
session: { uid: uuidv4() },
|
||||
} as unknown as Actor;
|
||||
const req = Object.assign(makeReq({ path: '/', actor: appActor }), {
|
||||
tokenSource: 'cookie',
|
||||
cookies: { puter_token_v2: 'legacy' },
|
||||
});
|
||||
const { res, captured } = makeRes();
|
||||
await callRoute('get', '/', req, res);
|
||||
expect(String(captured.body)).not.toContain('guiTokenDigest');
|
||||
});
|
||||
|
||||
it('serves the shell on /dashboard and /action', async () => {
|
||||
for (const path of ['/dashboard', '/dashboard/', '/action/*splat']) {
|
||||
const { res, captured } = makeRes();
|
||||
await callRoute('get', path, makeReq({ path }), res);
|
||||
expect(typeof captured.body).toBe('string');
|
||||
expect(String(captured.body)).toMatch(/<!DOCTYPE html>/i);
|
||||
}
|
||||
});
|
||||
|
||||
it('redirects /desktop to the root, keeping the query', async () => {
|
||||
for (const path of ['/desktop', '/desktop/']) {
|
||||
const { res, captured } = makeRes();
|
||||
await callRoute(
|
||||
'get',
|
||||
path,
|
||||
makeReq({ path, originalUrl: `${path}?ref=abc&x=1` }),
|
||||
res,
|
||||
);
|
||||
expect(captured.statusCode).toBe(302);
|
||||
expect(captured.location).toBe('/?ref=abc&x=1');
|
||||
expect(captured.body).toBeUndefined();
|
||||
}
|
||||
|
||||
const { res, captured } = makeRes();
|
||||
await callRoute('get', '/desktop', makeReq({ path: '/desktop' }), res);
|
||||
expect(captured.location).toBe('/');
|
||||
});
|
||||
|
||||
it('redirects /settings to the dashboard Home tab', async () => {
|
||||
for (const path of ['/settings', '/settings/*splat']) {
|
||||
const { res, captured } = makeRes();
|
||||
await callRoute('get', path, makeReq({ path }), res);
|
||||
expect(captured.statusCode).toBe(302);
|
||||
expect(captured.location).toBe('/dashboard#home');
|
||||
expect(captured.body).toBeUndefined();
|
||||
}
|
||||
});
|
||||
|
||||
it('redirects /@:username to the dashboard', async () => {
|
||||
const { res, captured } = makeRes();
|
||||
await callRoute(
|
||||
'get',
|
||||
'/@:username',
|
||||
makeReq({ path: '/@alice', params: { username: 'alice' } }),
|
||||
res,
|
||||
);
|
||||
expect(captured.statusCode).toBe(302);
|
||||
expect(captured.location).toBe('/');
|
||||
expect(captured.body).toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
// ── /app/:name ──────────────────────────────────────────────────────
|
||||
@@ -360,47 +417,21 @@ describe('HomepageController GET /app/:name', () => {
|
||||
expect(html).not.toContain('owner_user_id');
|
||||
});
|
||||
|
||||
it('serves the same app shell under /desktop/app/:name', async () => {
|
||||
const { userId } = await makeUser();
|
||||
const name = `desk-${Math.random().toString(36).slice(2, 10)}`;
|
||||
await server.stores.app.create(
|
||||
{
|
||||
name,
|
||||
title: 'Desktop App',
|
||||
description: 'opens on the desktop instead of the dashboard',
|
||||
index_url: `https://example.com/${name}/`,
|
||||
approved_for_listing: 1,
|
||||
},
|
||||
{ ownerUserId: userId },
|
||||
);
|
||||
|
||||
const { res, captured } = makeRes();
|
||||
await callRoute(
|
||||
'get',
|
||||
'/desktop/app/:name',
|
||||
makeReq({ params: { name }, path: `/desktop/app/${name}` }),
|
||||
res,
|
||||
);
|
||||
|
||||
expect(captured.statusCode).toBe(200);
|
||||
const html = String(captured.body);
|
||||
expect(html).toMatch(/<!DOCTYPE html>/i);
|
||||
expect(html).toContain('Desktop App');
|
||||
});
|
||||
|
||||
it('returns 404 under /desktop/app/:name when the app is unknown', async () => {
|
||||
it('redirects /desktop/app/:name to /app/:name, keeping the query', async () => {
|
||||
const { res, captured } = makeRes();
|
||||
await callRoute(
|
||||
'get',
|
||||
'/desktop/app/:name',
|
||||
makeReq({
|
||||
params: { name: 'no-such-app' },
|
||||
path: '/desktop/app/no-such-app',
|
||||
params: { name: 'editor' },
|
||||
path: '/desktop/app/editor',
|
||||
originalUrl: '/desktop/app/editor?file=%2Falice%2Fa.txt&x=1',
|
||||
}),
|
||||
res,
|
||||
);
|
||||
expect(captured.statusCode).toBe(404);
|
||||
expect(String(captured.body)).toMatch(/<!DOCTYPE html>/i);
|
||||
expect(captured.statusCode).toBe(302);
|
||||
expect(captured.location).toBe('/app/editor?file=%2Falice%2Fa.txt&x=1');
|
||||
expect(captured.body).toBeUndefined();
|
||||
});
|
||||
|
||||
it('omits index_url even for a public app — the shell is not the launch authority', async () => {
|
||||
@@ -434,40 +465,39 @@ describe('HomepageController GET /app/:name', () => {
|
||||
// -- app landing rate limit --
|
||||
|
||||
describe('HomepageController app landing rate limit', () => {
|
||||
it('rate-limits /app/:name and /desktop/app/:name per network', () => {
|
||||
for (const path of ['/app/:name', '/desktop/app/:name']) {
|
||||
const route = router.routes.find(
|
||||
(r) => r.method === 'get' && r.path === path,
|
||||
);
|
||||
if (!route) throw new Error(`No GET ${path} route`);
|
||||
expect(route.options.rateLimit).toEqual({
|
||||
scope: 'app-landing',
|
||||
limit: 600,
|
||||
window: 60_000,
|
||||
key: 'ip',
|
||||
});
|
||||
}
|
||||
it('rate-limits /app/:name per network', () => {
|
||||
const route = router.routes.find(
|
||||
(r) => r.method === 'get' && r.path === '/app/:name',
|
||||
);
|
||||
if (!route) throw new Error('No GET /app/:name route');
|
||||
expect(route.options.rateLimit).toEqual({
|
||||
scope: 'app-landing',
|
||||
limit: 600,
|
||||
window: 60_000,
|
||||
key: 'ip',
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
// ── /show/* ─────────────────────────────────────────────────────────
|
||||
|
||||
describe('HomepageController GET /show/*splat', () => {
|
||||
it('emits a launch_app explorer call with the post-/show path', async () => {
|
||||
it('redirects to the path in the dashboard Files tab, keeping the query', async () => {
|
||||
const { res, captured } = makeRes();
|
||||
await callRoute(
|
||||
'get',
|
||||
'/show/*splat',
|
||||
makeReq({ path: '/show/alice/Documents' }),
|
||||
makeReq({
|
||||
path: '/show/alice/My%20Documents',
|
||||
originalUrl: '/show/alice/My%20Documents?ref=abc',
|
||||
}),
|
||||
res,
|
||||
);
|
||||
// The launch payload is JSON-serialized into the rendered HTML.
|
||||
// We assert the rendered shell included the explorer launch hint
|
||||
// pointing at the expected (slashed) path.
|
||||
const html = String(captured.body);
|
||||
expect(html).toContain('launch_app');
|
||||
expect(html).toContain('explorer');
|
||||
expect(html).toContain('/alice/Documents');
|
||||
expect(captured.statusCode).toBe(302);
|
||||
expect(captured.location).toBe(
|
||||
'/dashboard?ref=abc#files/alice/My%20Documents',
|
||||
);
|
||||
expect(captured.body).toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
@@ -20,6 +20,7 @@
|
||||
import express from 'express';
|
||||
import path from 'node:path';
|
||||
import { PuterController } from '../types.js';
|
||||
import { isPlainUserActor } from '../../core/actor.js';
|
||||
import { toAppShellView } from '../../util/appShellView.js';
|
||||
import type { PuterRouter } from '../../core/http/PuterRouter';
|
||||
import {
|
||||
@@ -27,11 +28,12 @@ import {
|
||||
subdomainLabelOf,
|
||||
} from '../../core/http/middleware/hostRedirects.js';
|
||||
import type { IConfig } from '../../types';
|
||||
import type { UserRow } from '../../stores/user/UserStore';
|
||||
import type {
|
||||
PuterHomepageService,
|
||||
PageMeta,
|
||||
LaunchOptions,
|
||||
PopupFrame,
|
||||
ShellContext,
|
||||
} from '../../services/homepage/PuterHomepageService';
|
||||
|
||||
/**
|
||||
@@ -170,7 +172,6 @@ export class HomepageController extends PuterController {
|
||||
req: express.Request,
|
||||
res: express.Response,
|
||||
metaOverrides: Partial<PageMeta> = {},
|
||||
launch: LaunchOptions = {},
|
||||
popupFrame?: PopupFrame,
|
||||
) => {
|
||||
const meta = { ...defaultMeta(req), ...metaOverrides };
|
||||
@@ -180,7 +181,16 @@ 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,
|
||||
guiTokenDigest: this.#guiTokenDigest(req, actor),
|
||||
},
|
||||
meta,
|
||||
popupFrame,
|
||||
);
|
||||
};
|
||||
|
||||
// -- Root + path-aliased shell routes ------------------------
|
||||
@@ -252,7 +262,6 @@ export class HomepageController extends PuterController {
|
||||
req,
|
||||
res,
|
||||
{},
|
||||
{},
|
||||
{
|
||||
hostOrigin: embedHostOrigin(
|
||||
this.config,
|
||||
@@ -263,23 +272,42 @@ export class HomepageController extends PuterController {
|
||||
});
|
||||
}
|
||||
|
||||
router.get('/settings', {}, (req, res) => sendShell(req, res));
|
||||
router.get('/settings/*splat', {}, (req, res) => sendShell(req, res));
|
||||
// Old settings links land on the dashboard's Home tab.
|
||||
router.get('/settings', {}, (_req, res) =>
|
||||
res.redirect('/dashboard#home'),
|
||||
);
|
||||
router.get('/settings/*splat', {}, (_req, res) =>
|
||||
res.redirect('/dashboard#home'),
|
||||
);
|
||||
|
||||
router.get('/dashboard', {}, (req, res) => sendShell(req, res));
|
||||
router.get('/dashboard/', {}, (req, res) => sendShell(req, res));
|
||||
|
||||
router.get('/desktop', {}, (req, res) => sendShell(req, res));
|
||||
router.get('/desktop/', {}, (req, res) => sendShell(req, res));
|
||||
const queryOf = (req: express.Request) => {
|
||||
const separator = req.originalUrl.indexOf('?');
|
||||
return separator === -1 ? '' : req.originalUrl.slice(separator);
|
||||
};
|
||||
|
||||
// Old desktop links land on the dashboard, query intact.
|
||||
router.get('/desktop', {}, (req, res) =>
|
||||
res.redirect(`/${queryOf(req)}`),
|
||||
);
|
||||
router.get('/desktop/', {}, (req, res) =>
|
||||
res.redirect(`/${queryOf(req)}`),
|
||||
);
|
||||
|
||||
router.get('/action/*splat', {}, (req, res) => sendShell(req, res));
|
||||
|
||||
router.get('/@:username', {}, (req, res) => sendShell(req, res));
|
||||
// Old links to a user's public folder land on the dashboard.
|
||||
router.get('/@:username', {}, (_req, res) => res.redirect('/'));
|
||||
|
||||
// Old desktop app links open the app in the dashboard, query intact.
|
||||
router.get('/desktop/app/:name', {}, (req, res) => {
|
||||
const name = encodeURIComponent(String(req.params.name ?? ''));
|
||||
res.redirect(`/app/${name}${queryOf(req)}`);
|
||||
});
|
||||
|
||||
// -- /app/:name - app metadata baked into the shell ----------
|
||||
// `/desktop/app/:name` is the same landing booted on the desktop
|
||||
// instead of the dashboard; the GUI strips the prefix and treats the
|
||||
// rest of the path identically, so both render the same shell.
|
||||
|
||||
const sendAppShell = async (
|
||||
req: express.Request,
|
||||
@@ -334,26 +362,11 @@ export class HomepageController extends PuterController {
|
||||
{ rateLimit: APP_LANDING_LIMIT },
|
||||
sendAppShell,
|
||||
);
|
||||
router.get(
|
||||
'/desktop/app/:name',
|
||||
{ rateLimit: APP_LANDING_LIMIT },
|
||||
sendAppShell,
|
||||
);
|
||||
|
||||
// -- /show/* - launch explorer with the requested file path --
|
||||
|
||||
// Old /show links open the path in the dashboard's Files tab, query intact.
|
||||
router.get('/show/*splat', {}, (req, res) => {
|
||||
const filePath = req.path.slice('/show'.length);
|
||||
const launch: LaunchOptions = {
|
||||
on_initialized: [
|
||||
{
|
||||
$: 'window-call',
|
||||
fn_name: 'launch_app',
|
||||
args: [{ name: 'explorer', path: filePath }],
|
||||
},
|
||||
],
|
||||
};
|
||||
return sendShell(req, res, {}, launch);
|
||||
res.redirect(`/dashboard${queryOf(req)}#files${filePath}`);
|
||||
});
|
||||
|
||||
// -- /sw.js - the service worker, scoped to the whole origin --
|
||||
@@ -382,6 +395,38 @@ export class HomepageController extends PuterController {
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Lets the GUI skip `/get-gui-token`, which reads the session cookie: the
|
||||
* digest of the token it would hand over, null when there is no session
|
||||
* cookie (either name the auth probe reads), and undefined (the GUI asks)
|
||||
* when a cookie didn't resolve to a session.
|
||||
*/
|
||||
#guiTokenDigest(
|
||||
req: express.Request,
|
||||
actor: ShellContext['actor'],
|
||||
): string | null | undefined {
|
||||
if (req.tokenSource === 'cookie') {
|
||||
if (!actor || !isPlainUserActor(actor) || !actor.session?.uid) {
|
||||
return undefined;
|
||||
}
|
||||
return this.services.auth.guiTokenDigest(
|
||||
actor.user as UserRow,
|
||||
actor.session.uid,
|
||||
);
|
||||
}
|
||||
const cookies = (req.cookies ?? {}) as Record<string, unknown>;
|
||||
const hasSessionCookie = [
|
||||
this.config.cookie_name,
|
||||
'puter_token_v2',
|
||||
].some(
|
||||
(name) =>
|
||||
!!name &&
|
||||
typeof cookies[name] === 'string' &&
|
||||
cookies[name] !== '',
|
||||
);
|
||||
return hasSessionCookie ? undefined : null;
|
||||
}
|
||||
}
|
||||
|
||||
const safeJsonParse = (s: string): Record<string, unknown> | null => {
|
||||
|
||||
@@ -372,26 +372,6 @@ describe('OIDCController GET /auth/oidc/:provider/start', () => {
|
||||
);
|
||||
});
|
||||
|
||||
it('bakes a whitelisted desktop app landing (/desktop/app/<name>) into the state redirect_uri', async () => {
|
||||
const { res, captured } = makeRes();
|
||||
await callRoute(
|
||||
'get',
|
||||
'/auth/oidc/:provider/start',
|
||||
makeReq({
|
||||
params: { provider: 'custom' },
|
||||
query: { return_to: '/desktop/app/my-App_2' },
|
||||
}),
|
||||
res,
|
||||
);
|
||||
const state = new URL(captured.redirectUrl ?? '').searchParams.get(
|
||||
'state',
|
||||
);
|
||||
const decoded = oidc().verifyState(state!);
|
||||
expect(String(decoded?.redirect_uri)).toBe(
|
||||
`${TEST_ORIGIN}/desktop/app/my-App_2`,
|
||||
);
|
||||
});
|
||||
|
||||
it('ignores a non-whitelisted return_to', async () => {
|
||||
const bad_values = [
|
||||
'/app/evil/extra',
|
||||
@@ -400,6 +380,8 @@ describe('OIDCController GET /auth/oidc/:provider/start', () => {
|
||||
'//evil.test',
|
||||
'/settings',
|
||||
`/app/${'a'.repeat(101)}`,
|
||||
'/desktop',
|
||||
'/desktop/app/my-App_2',
|
||||
'/desktop/app/evil/extra',
|
||||
'/desktop/app/',
|
||||
'/dashboard/app/name',
|
||||
@@ -476,11 +458,11 @@ describe('OIDCController GET /auth/oidc/:provider/start', () => {
|
||||
sharedPath('b.txt'),
|
||||
sharedPath('a.txt'),
|
||||
],
|
||||
'/desktop',
|
||||
'/dashboard',
|
||||
),
|
||||
);
|
||||
const url = new URL(uri);
|
||||
expect(url.origin + url.pathname).toBe(`${TEST_ORIGIN}/desktop`);
|
||||
expect(url.origin + url.pathname).toBe(`${TEST_ORIGIN}/dashboard`);
|
||||
expect(url.searchParams.getAll('shared')).toEqual([
|
||||
sharedPath('a.txt'),
|
||||
sharedPath('b.txt'),
|
||||
|
||||
@@ -102,16 +102,14 @@ function signupOptionsFromState(
|
||||
}
|
||||
|
||||
// GUI pages an OIDC flow may return to: the root (where a share email lands),
|
||||
// /desktop, /dashboard, and direct app landings (/app/<name> and its
|
||||
// desktop-booted twin /desktop/app/<name>, mirroring APP_NAME_REGEX in
|
||||
// AppDriver). Strict whitelist — never a client-supplied URL (no open
|
||||
// redirect).
|
||||
// /dashboard, and direct app landings (/app/<name>, mirroring
|
||||
// APP_NAME_REGEX in AppDriver). Strict whitelist — never a client-supplied URL
|
||||
// (no open redirect).
|
||||
function isWhitelistedReturnPath(path: string): boolean {
|
||||
return (
|
||||
path === '/' ||
|
||||
path === '/desktop' ||
|
||||
path === '/dashboard' ||
|
||||
/^(\/desktop)?\/app\/[a-zA-Z0-9_-]{1,100}$/.test(path)
|
||||
/^\/app\/[a-zA-Z0-9_-]{1,100}$/.test(path)
|
||||
);
|
||||
}
|
||||
|
||||
@@ -438,9 +436,8 @@ export class OIDCController extends PuterController {
|
||||
|
||||
let appRedirectUri = flowRedirects[flow] ?? (origin || '/');
|
||||
|
||||
// Optional GUI return path so login started from /desktop,
|
||||
// /dashboard, an /app/<name> landing, or a share link lands
|
||||
// back there.
|
||||
// Optional GUI return path so login started from /dashboard,
|
||||
// an /app/<name> landing, or a share link lands back there.
|
||||
const rawReturnTo = Array.isArray(req.query.return_to)
|
||||
? req.query.return_to[0]
|
||||
: req.query.return_to;
|
||||
|
||||
@@ -314,8 +314,8 @@ describe('OIDC account second-factor login', () => {
|
||||
|
||||
it('preserves ordinary OIDC login for accounts without 2FA', async () => {
|
||||
await account(false);
|
||||
const response = await callback('login', { return_to: '/desktop' });
|
||||
expect(response.headers.get('location')).toBe(`${env.origin}/desktop`);
|
||||
const response = await callback('login', { return_to: '/dashboard' });
|
||||
expect(response.headers.get('location')).toBe(`${env.origin}/dashboard`);
|
||||
expect(
|
||||
response.headers.get('set-cookie')?.includes('puter_auth_token='),
|
||||
).toBe(true);
|
||||
|
||||
@@ -24,11 +24,7 @@ import { computeNetworkFingerprint } from '../../core/http/middleware/rateLimit.
|
||||
import type { PuterRouter } from '../../core/http/PuterRouter.js';
|
||||
import { PuterController } from '../types.js';
|
||||
import { PEER_COSTS } from './costs.js';
|
||||
import {
|
||||
readClaimedGrantIdentifier,
|
||||
signGuestGrant,
|
||||
verifyGuestGrant,
|
||||
} from './guestGrant.js';
|
||||
import { signGuestGrant, verifyGuestGrant } from './guestGrant.js';
|
||||
import {
|
||||
DEFAULT_FREE_SUBSCRIPTION,
|
||||
DEFAULT_TEMP_SUBSCRIPTION,
|
||||
@@ -191,19 +187,30 @@ export class PeerController extends PuterController {
|
||||
// guests share one bucket and no host can be relayed for by
|
||||
// more guests per minute than this — the only ceiling on guest
|
||||
// spend we can apply before the bytes are already spent.
|
||||
// A grant that doesn't parse can't name a bucket, so those
|
||||
// requests fall back to the caller's own network.
|
||||
// The limiter counts a request when it admits it, so only a
|
||||
// grant that would redeem names a host; otherwise anyone
|
||||
// holding the host's identifier could drain the bucket and
|
||||
// lock out every real guest. Anything else - forged, expired,
|
||||
// malformed, or no secret configured - is charged to the
|
||||
// caller's own network.
|
||||
rateLimit: {
|
||||
scope: 'peer-guest-turn',
|
||||
limit: 60,
|
||||
window: 60_000,
|
||||
key: (req: Request) => {
|
||||
const claimed = readClaimedGrantIdentifier(
|
||||
(req.body as { grant?: unknown } | undefined)
|
||||
?.grant,
|
||||
);
|
||||
return claimed
|
||||
? `host:${claimed}`
|
||||
const secret =
|
||||
this.config.peers?.guest_turn?.grant_secret;
|
||||
const verified = secret
|
||||
? verifyGuestGrant({
|
||||
grant: (
|
||||
req.body as
|
||||
{ grant?: unknown } | undefined
|
||||
)?.grant,
|
||||
secret,
|
||||
})
|
||||
: null;
|
||||
return verified?.status === 'ok'
|
||||
? `host:${verified.customIdentifier}`
|
||||
: `net:${computeNetworkFingerprint(req)}`;
|
||||
},
|
||||
},
|
||||
|
||||
@@ -19,7 +19,7 @@
|
||||
|
||||
import { toMicroCents } from '../../services/metering/utils';
|
||||
|
||||
// Microcents per byte of TURN egress ($0.05/GB).
|
||||
// Microcents per byte of TURN egress ($0.10/GB).
|
||||
export const PEER_COSTS = {
|
||||
'turn:egress-bytes': toMicroCents(0.1 / 1000 ** 3),
|
||||
} as const;
|
||||
@@ -1,7 +1,6 @@
|
||||
import { createHmac } from 'node:crypto';
|
||||
import { describe, expect, it } from 'vitest';
|
||||
import {
|
||||
readClaimedGrantIdentifier,
|
||||
signGuestGrant,
|
||||
verifyGuestGrant,
|
||||
} from './guestGrant.js';
|
||||
@@ -243,59 +242,3 @@ describe('signGuestGrant / verifyGuestGrant', () => {
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('readClaimedGrantIdentifier', () => {
|
||||
it('reads the identifier from a valid grant', () => {
|
||||
const { grant } = signGuestGrant({
|
||||
customIdentifier: USER_ID,
|
||||
ttlSeconds: 60,
|
||||
secret: SECRET,
|
||||
});
|
||||
|
||||
expect(readClaimedGrantIdentifier(grant)).toBe(USER_ID);
|
||||
});
|
||||
|
||||
it('reads the claimed identifier without checking the signature', () => {
|
||||
// Bucketing runs before verification, so this is expected: a forged
|
||||
// grant still names a bucket, and the handler still rejects it.
|
||||
const grant = forgeGrant(
|
||||
{ id: USER_ID, exp: 9_999_999_999, n: 'x' },
|
||||
{ secret: 'wrong-secret' },
|
||||
);
|
||||
|
||||
expect(readClaimedGrantIdentifier(grant)).toBe(USER_ID);
|
||||
});
|
||||
|
||||
it('reads an expired grant, which the handler then rejects', () => {
|
||||
const { grant } = signGuestGrant({
|
||||
customIdentifier: USER_ID,
|
||||
ttlSeconds: 60,
|
||||
secret: SECRET,
|
||||
now: 1_000_000_000_000,
|
||||
});
|
||||
|
||||
expect(readClaimedGrantIdentifier(grant)).toBe(USER_ID);
|
||||
expect(verifyGuestGrant({ grant, secret: SECRET })).toEqual({
|
||||
status: 'expired',
|
||||
});
|
||||
});
|
||||
|
||||
it.each([
|
||||
['a non-string', 42],
|
||||
['undefined', undefined],
|
||||
['a wrong-shaped string', 'not-a-grant'],
|
||||
['an unknown version', 'pg2.abc.def'],
|
||||
['an over-long string', `pg1.${'a'.repeat(600)}.sig`],
|
||||
[
|
||||
'a non-JSON payload',
|
||||
`pg1.${Buffer.from('x').toString('base64url')}.sig`,
|
||||
],
|
||||
])('returns null for %s', (_label, grant) => {
|
||||
expect(readClaimedGrantIdentifier(grant)).toBeNull();
|
||||
});
|
||||
|
||||
it('returns null for an identifier of the wrong shape', () => {
|
||||
const grant = forgeGrant({ id: 'nope', exp: 9_999_999_999 });
|
||||
expect(readClaimedGrantIdentifier(grant)).toBeNull();
|
||||
});
|
||||
});
|
||||
@@ -171,37 +171,3 @@ export const verifyGuestGrant = ({
|
||||
expiresAt: payload.exp,
|
||||
};
|
||||
};
|
||||
|
||||
/**
|
||||
* Read the claimed identifier out of a grant _without_ verifying it, for
|
||||
* rate-limit bucketing only.
|
||||
*
|
||||
* Bucketing has to happen before the handler runs, and a forged grant is
|
||||
* rejected there without reaching the upstream API — so an unverified read is
|
||||
* enough to put a host's guests in one bucket, and the worst a forger achieves
|
||||
* is choosing which bucket their own rejections land in. Never use this to
|
||||
* decide attribution.
|
||||
*
|
||||
* @returns The claimed identifier, or null if the grant doesn't parse.
|
||||
*/
|
||||
export const readClaimedGrantIdentifier = (grant: unknown): string | null => {
|
||||
if (typeof grant !== 'string' || grant.length > MAX_GRANT_LENGTH) {
|
||||
return null;
|
||||
}
|
||||
const parts = grant.split('.');
|
||||
if (parts.length !== 3 || parts[0] !== GRANT_VERSION) return null;
|
||||
try {
|
||||
const payload = JSON.parse(
|
||||
Buffer.from(parts[1]!, 'base64url').toString('utf8'),
|
||||
) as { id?: unknown };
|
||||
if (
|
||||
typeof payload?.id !== 'string' ||
|
||||
!IDENTIFIER_RE.test(payload.id)
|
||||
) {
|
||||
return null;
|
||||
}
|
||||
return payload.id;
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
};
|
||||
@@ -243,6 +243,33 @@ describe('WispController', () => {
|
||||
expect(await verifyStatus(token)).toBe(403);
|
||||
});
|
||||
|
||||
it('binds a token minted by an access token to that token while the replica lags', async () => {
|
||||
const { sessionActor, apiTokenActor, apiToken } = await freshUser();
|
||||
const db = server.clients.db;
|
||||
const original = db.read.bind(db);
|
||||
const spy = vi
|
||||
.spyOn(db, 'read')
|
||||
.mockImplementation(async (sql: string, params?: unknown[]) =>
|
||||
sql.includes("FROM `sessions` WHERE `kind` = 'access_token'")
|
||||
? []
|
||||
: original(sql, params),
|
||||
);
|
||||
let token: string;
|
||||
try {
|
||||
token = await relayTokenFor(apiTokenActor);
|
||||
} finally {
|
||||
spy.mockRestore();
|
||||
}
|
||||
expect(await verifyStatus(token)).toBe(200);
|
||||
|
||||
await server.services.auth.revokeAccessToken(
|
||||
sessionActor,
|
||||
apiToken,
|
||||
);
|
||||
|
||||
expect(await verifyStatus(token)).toBe(403);
|
||||
});
|
||||
|
||||
it('applies the account checks to a token with no session claim', async () => {
|
||||
const { row } = await freshUser();
|
||||
const token = server.services.token.sign(
|
||||
|
||||
@@ -151,11 +151,12 @@ export class WispController extends PuterController {
|
||||
|
||||
/**
|
||||
* The session a relay token lives no longer than. An access token's is its
|
||||
* own session row; the actor doesn't carry it.
|
||||
* own session row.
|
||||
*/
|
||||
async #sessionUidFor(actor: Actor): Promise<string | undefined> {
|
||||
if (actor.session?.uid) return actor.session.uid;
|
||||
if (!actor.accessToken) return undefined;
|
||||
if (actor.accessToken.sessionUid) return actor.accessToken.sessionUid;
|
||||
const row = await this.stores.session.findActiveByAccessTokenUid(
|
||||
actor.accessToken.uid,
|
||||
);
|
||||
|
||||
@@ -47,6 +47,11 @@ export interface ActorAccessToken {
|
||||
* reach while revokes, audits and gate hooks can still name the app.
|
||||
*/
|
||||
godmodeApp?: ActorApp | null;
|
||||
/**
|
||||
* The token's own session row, checked live when it authenticated. Unset
|
||||
* when the token carries no `session_uid` naming its row.
|
||||
*/
|
||||
sessionUid?: string;
|
||||
}
|
||||
|
||||
export interface Actor {
|
||||
|
||||
@@ -50,6 +50,13 @@ declare global {
|
||||
|
||||
tokenAuthFailed?: boolean;
|
||||
|
||||
/**
|
||||
* What `authenticate` threw while checking the token (a database
|
||||
* failure, say). The token may be fine; gates rethrow this instead
|
||||
* of answering 401.
|
||||
*/
|
||||
tokenAuthError?: unknown;
|
||||
|
||||
/**
|
||||
* Set when a token authenticated but its app is on the origin
|
||||
* blocklist. The auth probe leaves `actor` unset; gates translate
|
||||
|
||||
@@ -0,0 +1,110 @@
|
||||
/*
|
||||
* 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 { afterAll, beforeAll, describe, expect, it, vi } from 'vitest';
|
||||
import { setupPuterTestEnv, type PuterTestEnv } from '../../../testUtil.js';
|
||||
|
||||
const loadShed = () =>
|
||||
Object.assign(new Error('Database operation failed'), {
|
||||
code: 'dbBatchFailed',
|
||||
});
|
||||
|
||||
/**
|
||||
* A token whose lookup fails is not a dead token: clients discard a token on
|
||||
* 401 `token_auth_failed`, so that answer is kept for tokens that checked out
|
||||
* invalid.
|
||||
*/
|
||||
describe('auth probe when the token lookup fails', () => {
|
||||
let env: PuterTestEnv;
|
||||
|
||||
beforeAll(async () => {
|
||||
env = await setupPuterTestEnv();
|
||||
}, 120_000);
|
||||
|
||||
afterAll(async () => {
|
||||
await env?.shutdown();
|
||||
});
|
||||
|
||||
const get = (path: string, token: string) =>
|
||||
fetch(new URL(path, env.apiOrigin), {
|
||||
headers: { authorization: `Bearer ${token}` },
|
||||
});
|
||||
|
||||
/** Run `fn` while the next user lookup rejects with `error`. */
|
||||
const withFailedUserLookup = async <T>(
|
||||
error: Error,
|
||||
fn: () => Promise<T>,
|
||||
): Promise<T> => {
|
||||
const spy = vi
|
||||
.spyOn(env.server.stores.user, 'getByUuid')
|
||||
.mockRejectedValueOnce(error);
|
||||
try {
|
||||
return await fn();
|
||||
} finally {
|
||||
spy.mockRestore();
|
||||
}
|
||||
};
|
||||
|
||||
it.each([
|
||||
['a session token', () => env.users.user.token],
|
||||
['an access token', () => env.users.user.apiToken],
|
||||
])(
|
||||
'answers %s with 503 db_unavailable during a database outage',
|
||||
async (_kind, tokenOf) => {
|
||||
const token = tokenOf();
|
||||
const res = await withFailedUserLookup(loadShed(), () =>
|
||||
get('/whoami', token),
|
||||
);
|
||||
expect(res.status).toBe(503);
|
||||
expect(res.headers.get('retry-after')).toBe('5');
|
||||
expect(await res.json()).toEqual({
|
||||
error: 'Service temporarily unavailable',
|
||||
message: 'Service temporarily unavailable',
|
||||
code: 'db_unavailable',
|
||||
});
|
||||
|
||||
expect((await get('/whoami', token)).status).toBe(200);
|
||||
},
|
||||
);
|
||||
|
||||
it('answers an unexpected lookup failure with a generic 500, not a 401', async () => {
|
||||
const res = await withFailedUserLookup(new Error('boom'), () =>
|
||||
get('/whoami', env.users.user.token),
|
||||
);
|
||||
expect(res.status).toBe(500);
|
||||
expect((await res.json()).code).toBe('internal_error');
|
||||
});
|
||||
|
||||
it('serves a route that does not require auth anonymously', async () => {
|
||||
const res = await withFailedUserLookup(loadShed(), () =>
|
||||
get('/version', env.users.user.token),
|
||||
);
|
||||
expect(res.status).toBe(200);
|
||||
});
|
||||
|
||||
it('still answers an invalid token with 401 token_auth_failed', async () => {
|
||||
const res = await get('/whoami', 'not-a-real-jwt');
|
||||
expect(res.status).toBe(401);
|
||||
expect(await res.json()).toEqual({
|
||||
error: 'Authentication failed',
|
||||
message: 'Authentication failed',
|
||||
code: 'token_auth_failed',
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -555,17 +555,18 @@ describe('createAuthProbe — actor attachment + failure tracking', () => {
|
||||
expect(req.tokenAuthFailed).toBe(true);
|
||||
});
|
||||
|
||||
it('never rejects — sets tokenAuthFailed even when AuthService throws', async () => {
|
||||
it('never rejects — records the error, not tokenAuthFailed, when AuthService throws', async () => {
|
||||
const stub = makeStubAuth();
|
||||
stub.setNext('throw');
|
||||
const probe = createAuthProbe({ authService: stub.service });
|
||||
const { req, next } = await runProbe(
|
||||
probe,
|
||||
makeReq({ headers: { authorization: 'Bearer bad-tok' } }),
|
||||
makeReq({ headers: { authorization: 'Bearer some-tok' } }),
|
||||
);
|
||||
// Critical invariant: the probe NEVER rejects, no matter what.
|
||||
expect(next).toHaveBeenCalledWith();
|
||||
expect(req.tokenAuthFailed).toBe(true);
|
||||
expect(req.tokenAuthFailed).toBeUndefined();
|
||||
expect(req.tokenAuthError).toBeInstanceOf(Error);
|
||||
expect(req.actor).toBeUndefined();
|
||||
});
|
||||
|
||||
@@ -880,4 +881,27 @@ describe('createAuthProbe (integration) — real session token → real actor',
|
||||
expect(req.actor).toBeUndefined();
|
||||
expect(req.tokenAuthFailed).toBe(true);
|
||||
});
|
||||
|
||||
it('records a failed user lookup on a valid token without marking it invalid', async () => {
|
||||
const user = await makeUser();
|
||||
const { token } = await authService.createSessionToken(user);
|
||||
const lookupError = Object.assign(new Error('db down'), {
|
||||
code: 'dbBatchFailed',
|
||||
});
|
||||
const spy = vi
|
||||
.spyOn(server.stores.user, 'getByUuid')
|
||||
.mockRejectedValueOnce(lookupError);
|
||||
try {
|
||||
const probe = createAuthProbe({ authService });
|
||||
const { req } = await runProbe(
|
||||
probe,
|
||||
makeReq({ headers: { authorization: `Bearer ${token}` } }),
|
||||
);
|
||||
expect(req.actor).toBeUndefined();
|
||||
expect(req.tokenAuthFailed).toBeUndefined();
|
||||
expect(req.tokenAuthError).toBe(lookupError);
|
||||
} finally {
|
||||
spy.mockRestore();
|
||||
}
|
||||
});
|
||||
});
|
||||
@@ -45,9 +45,9 @@ interface AuthProbeOptions {
|
||||
* and valid — attaches an `Actor` to `req.actor`.
|
||||
*
|
||||
* Key property: this middleware **never rejects**. Missing tokens, malformed
|
||||
* tokens, expired tokens, tokens pointing at deleted users — all result in
|
||||
* `req.actor` being left undefined. Per-route gates decide whether absence is
|
||||
* acceptable.
|
||||
* tokens, expired tokens, tokens pointing at deleted users, and lookups that
|
||||
* fail outright all result in `req.actor` being left undefined. Per-route gates
|
||||
* decide whether absence is acceptable.
|
||||
*
|
||||
* Token lookup order:
|
||||
*
|
||||
@@ -153,8 +153,10 @@ export const createAuthProbe = (opts: AuthProbeOptions): RequestHandler => {
|
||||
} else if (result.invalid) {
|
||||
req.tokenAuthFailed = true;
|
||||
}
|
||||
} catch {
|
||||
req.tokenAuthFailed = true;
|
||||
} catch (err) {
|
||||
// Not a verdict on the token: routes that require auth answer
|
||||
// with this error, routes that don't serve the request anonymously.
|
||||
req.tokenAuthError = err;
|
||||
}
|
||||
next();
|
||||
};
|
||||
|
||||
@@ -288,6 +288,22 @@ describe('requireAuthGate', () => {
|
||||
});
|
||||
expectHttpError(got, 401, 'reauth_required');
|
||||
});
|
||||
|
||||
it('passes on the error when the token could not be checked', () => {
|
||||
const lookupError = Object.assign(new Error('down'), {
|
||||
code: 'dbBatchFailed',
|
||||
});
|
||||
const got = runGate(requireAuthGate(), { tokenAuthError: lookupError });
|
||||
expect(got).toBe(lookupError);
|
||||
});
|
||||
|
||||
it('still answers token_auth_failed when a check found the token invalid', () => {
|
||||
const got = runGate(requireAuthGate(), {
|
||||
tokenAuthFailed: true,
|
||||
tokenAuthError: new Error('down'),
|
||||
});
|
||||
expectHttpError(got, 401, 'token_auth_failed');
|
||||
});
|
||||
});
|
||||
|
||||
// ── requireUserActorGate ────────────────────────────────────────────
|
||||
@@ -330,6 +346,14 @@ describe('requireUserActorGate', () => {
|
||||
expectHttpError(got, 401, 'token_missing');
|
||||
});
|
||||
|
||||
it('passes on the error when the token could not be checked', () => {
|
||||
const lookupError = new Error('down');
|
||||
const got = runGate(requireUserActorGate(), {
|
||||
tokenAuthError: lookupError,
|
||||
});
|
||||
expect(got).toBe(lookupError);
|
||||
});
|
||||
|
||||
it('rejects a FULL-ACCESS access token too — account routes stay closed', () => {
|
||||
// The account wall is actor-type based: even a full-access PAT (which
|
||||
// the resource wall lets through) is rejected here, so it can never
|
||||
|
||||
@@ -50,7 +50,7 @@ import { assertVerifiedEmail } from '../verifiedEmail';
|
||||
// Make sure the `Express.Request.actor` augmentation is in scope.
|
||||
import '../expressAugmentation';
|
||||
|
||||
const rejectAuth = (req: Request): HttpError => {
|
||||
const rejectAuth = (req: Request): unknown => {
|
||||
if (req.requiresReauth) {
|
||||
return new HttpError(401, 'Re-authentication required', {
|
||||
legacyCode: 'reauth_required',
|
||||
@@ -71,6 +71,9 @@ const rejectAuth = (req: Request): HttpError => {
|
||||
legacyCode: 'token_auth_failed',
|
||||
});
|
||||
}
|
||||
// The token couldn't be checked, so a 401 would wrongly tell the client
|
||||
// to discard it; the error handler answers (503 for a database outage).
|
||||
if (req.tokenAuthError !== undefined) return req.tokenAuthError;
|
||||
return new HttpError(401, 'Missing authentication token', {
|
||||
legacyCode: 'token_missing',
|
||||
});
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
*/
|
||||
|
||||
import type { Request } from 'express';
|
||||
import { afterAll, beforeAll, describe, expect, it } from 'vitest';
|
||||
import { afterAll, beforeAll, describe, expect, it, vi } from 'vitest';
|
||||
import { v4 as uuidv4 } from 'uuid';
|
||||
import { makeActor } from '../../actor';
|
||||
import {
|
||||
@@ -1132,14 +1132,150 @@ describe('resolvePublicHostedIdentity', () => {
|
||||
const reqOf = (init: {
|
||||
cookies?: Record<string, string>;
|
||||
actor?: unknown;
|
||||
headers?: Record<string, string>;
|
||||
query?: Record<string, string>;
|
||||
}): Request =>
|
||||
({
|
||||
cookies: init.cookies ?? {},
|
||||
actor: init.actor,
|
||||
headers: {},
|
||||
query: {},
|
||||
headers: init.headers ?? {},
|
||||
query: init.query ?? {},
|
||||
}) as unknown as Request;
|
||||
|
||||
describe('with the launch token in the Referer', () => {
|
||||
const host = 'launch.site.puter.localhost';
|
||||
const cookieName = HOSTED_ASSET_COOKIES.public.name;
|
||||
|
||||
const launch = async () => {
|
||||
const user = await makeUser();
|
||||
const sub = `launch-${uuidv4().slice(0, 8)}`;
|
||||
const app = await server.stores.app.create(
|
||||
{ name: sub, title: sub, index_url: `http://${host}/` },
|
||||
{ ownerUserId: user.id },
|
||||
);
|
||||
const token = await authService.getUserAppToken(
|
||||
{ user } as unknown as Parameters<
|
||||
typeof authService.getUserAppToken
|
||||
>[0],
|
||||
app.uid,
|
||||
);
|
||||
const actor = (await authService.authenticateFromToken(token))!;
|
||||
const cookie = await authService.createHostedAssetToken('public', {
|
||||
appUid: app.uid,
|
||||
userUid: user.uuid,
|
||||
sessionUuid: actor.session?.uid,
|
||||
subdomain: 'launch',
|
||||
host,
|
||||
});
|
||||
return { user, appUid: app.uid, token, cookie, actor };
|
||||
};
|
||||
|
||||
const resolve = (
|
||||
appUid: string,
|
||||
init: Parameters<typeof reqOf>[0],
|
||||
expectedHost = host,
|
||||
) =>
|
||||
resolvePublicHostedIdentity({
|
||||
req: reqOf(init),
|
||||
authService,
|
||||
sessionCookieName: 'puter_auth_token',
|
||||
expectedAppUid: appUid,
|
||||
expectedSubdomain: 'launch',
|
||||
expectedHost,
|
||||
});
|
||||
|
||||
const refererFor = (token: string) =>
|
||||
`http://${host}/?puter.auth.token=${encodeURIComponent(token)}`;
|
||||
|
||||
it('takes the cookie when the token names its user and session', async () => {
|
||||
const { user, appUid, token, cookie } = await launch();
|
||||
const authenticate = vi.spyOn(authService, 'authenticate');
|
||||
try {
|
||||
const out = await resolve(appUid, {
|
||||
cookies: { [cookieName]: cookie },
|
||||
headers: { referer: refererFor(token) },
|
||||
});
|
||||
expect(out).toMatchObject({
|
||||
source: 'public-cookie',
|
||||
userUid: user.uuid,
|
||||
hasValidPublicCookie: true,
|
||||
});
|
||||
expect(authenticate).not.toHaveBeenCalled();
|
||||
} finally {
|
||||
authenticate.mockRestore();
|
||||
}
|
||||
});
|
||||
|
||||
it('authenticates a query token even when it names the cookie identity', async () => {
|
||||
const { user, appUid, token, cookie } = await launch();
|
||||
const out = await resolve(appUid, {
|
||||
cookies: { [cookieName]: cookie },
|
||||
query: { 'puter.auth.token': token },
|
||||
});
|
||||
expect(out.source).toBe('query');
|
||||
expect(out.userUid).toBe(user.uuid);
|
||||
expect(
|
||||
(out as { hasValidPublicCookie?: boolean })
|
||||
.hasValidPublicCookie,
|
||||
).toBeUndefined();
|
||||
});
|
||||
|
||||
it('authenticates the token when the cookie was minted for another host', async () => {
|
||||
const { user, appUid, token, cookie } = await launch();
|
||||
const out = await resolve(
|
||||
appUid,
|
||||
{
|
||||
cookies: { [cookieName]: cookie },
|
||||
headers: { referer: refererFor(token) },
|
||||
},
|
||||
'other.site.puter.localhost',
|
||||
);
|
||||
expect(out.source).toBe('referrer');
|
||||
expect(out.userUid).toBe(user.uuid);
|
||||
});
|
||||
|
||||
it('authenticates a token that names another app under the same session', async () => {
|
||||
const { user, appUid, cookie, actor } = await launch();
|
||||
const otherAppToken = server.services.token.sign('auth', {
|
||||
type: 'app-under-user',
|
||||
version: '2',
|
||||
user_uid: user.uuid,
|
||||
app_uid: `app-${uuidv4()}`,
|
||||
session_uid: actor.session!.uid,
|
||||
});
|
||||
const authenticate = vi.spyOn(authService, 'authenticate');
|
||||
try {
|
||||
const out = await resolve(appUid, {
|
||||
cookies: { [cookieName]: cookie },
|
||||
headers: { referer: refererFor(otherAppToken) },
|
||||
});
|
||||
expect(authenticate).toHaveBeenCalledTimes(1);
|
||||
expect(out.source).toBe('public-cookie');
|
||||
} finally {
|
||||
authenticate.mockRestore();
|
||||
}
|
||||
});
|
||||
|
||||
it('never resolves a scoped access token, with or without the cookie', async () => {
|
||||
const { user, appUid, cookie } = await launch();
|
||||
const scoped = await authService.createAccessToken(
|
||||
makeActor({
|
||||
user: { id: user.id, uuid: user.uuid, username: user.username },
|
||||
}),
|
||||
[[`user:${user.uuid}:email:read`]],
|
||||
);
|
||||
const withCookie = await resolve(appUid, {
|
||||
cookies: { [cookieName]: cookie },
|
||||
headers: { referer: refererFor(scoped) },
|
||||
});
|
||||
expect(withCookie.source).toBe('public-cookie');
|
||||
const withoutCookie = await resolve(appUid, {
|
||||
headers: { referer: refererFor(scoped) },
|
||||
});
|
||||
expect(withoutCookie.source).toBe('none');
|
||||
});
|
||||
});
|
||||
|
||||
it('returns the cookie identity when present and valid', async () => {
|
||||
const user = await makeUser();
|
||||
const appUid = `app-${uuidv4()}`;
|
||||
|
||||
@@ -86,6 +86,10 @@ export interface PrivateIdentity {
|
||||
hasValidPrivateCookie?: boolean;
|
||||
}
|
||||
|
||||
type PublicCookieClaims = Awaited<
|
||||
ReturnType<AuthService['verifyHostedAssetToken']>
|
||||
>;
|
||||
|
||||
interface SubdomainLike {
|
||||
user_id?: number | null;
|
||||
}
|
||||
@@ -533,8 +537,63 @@ export async function resolvePublicHostedIdentity(opts: {
|
||||
}
|
||||
}
|
||||
|
||||
const { name: publicCookieNameV2, legacyName: publicCookieNameLegacy } =
|
||||
HOSTED_ASSET_COOKIES.public;
|
||||
const publicCookieToken =
|
||||
(typeof cookies?.[publicCookieNameV2] === 'string'
|
||||
? cookies[publicCookieNameV2]
|
||||
: null) ??
|
||||
(typeof cookies?.[publicCookieNameLegacy] === 'string'
|
||||
? cookies[publicCookieNameLegacy]
|
||||
: null);
|
||||
let publicCookieClaims: Promise<PublicCookieClaims | null> | undefined;
|
||||
const verifyPublicCookie = () =>
|
||||
(publicCookieClaims ??= (async () => {
|
||||
if (!publicCookieToken) return null;
|
||||
try {
|
||||
return await authService.verifyHostedAssetToken(
|
||||
'public',
|
||||
publicCookieToken,
|
||||
{
|
||||
appUid: expectedAppUid,
|
||||
subdomain: expectedSubdomain,
|
||||
host: expectedHost,
|
||||
},
|
||||
);
|
||||
} catch {
|
||||
// v1-signed cookies land here and get re-minted.
|
||||
return null;
|
||||
}
|
||||
})());
|
||||
const publicCookieIdentity = (claims: PublicCookieClaims) => ({
|
||||
source: 'public-cookie' as const,
|
||||
userUid: claims.userUid,
|
||||
sessionUuid: claims.sessionUuid,
|
||||
hasValidPublicCookie: true,
|
||||
});
|
||||
|
||||
const bootstrap = getBootstrapToken(req);
|
||||
if (bootstrap) {
|
||||
// A launched app's own assets carry its launch token in the Referer.
|
||||
// When that token names the cookie's user and session, the cookie
|
||||
// already stands for it and nothing needs re-authenticating or minting.
|
||||
if (
|
||||
bootstrap.source === 'referrer' &&
|
||||
publicCookieToken &&
|
||||
expectedAppUid
|
||||
) {
|
||||
const named = authService.signedSessionClaims(bootstrap.token);
|
||||
if (named && (!named.appUid || named.appUid === expectedAppUid)) {
|
||||
const claims = await verifyPublicCookie();
|
||||
if (
|
||||
claims &&
|
||||
claims.userUid === named.userUid &&
|
||||
claims.sessionUuid === named.sessionUuid
|
||||
) {
|
||||
return publicCookieIdentity(claims);
|
||||
}
|
||||
}
|
||||
}
|
||||
try {
|
||||
const actor = await authService.authenticateFromToken(
|
||||
bootstrap.token,
|
||||
@@ -554,36 +613,8 @@ export async function resolvePublicHostedIdentity(opts: {
|
||||
}
|
||||
}
|
||||
|
||||
const { name: publicCookieNameV2, legacyName: publicCookieNameLegacy } =
|
||||
HOSTED_ASSET_COOKIES.public;
|
||||
const publicCookieToken =
|
||||
(typeof cookies?.[publicCookieNameV2] === 'string'
|
||||
? cookies[publicCookieNameV2]
|
||||
: null) ??
|
||||
(typeof cookies?.[publicCookieNameLegacy] === 'string'
|
||||
? cookies[publicCookieNameLegacy]
|
||||
: null);
|
||||
if (publicCookieToken) {
|
||||
try {
|
||||
const claims = await authService.verifyHostedAssetToken(
|
||||
'public',
|
||||
publicCookieToken,
|
||||
{
|
||||
appUid: expectedAppUid,
|
||||
subdomain: expectedSubdomain,
|
||||
host: expectedHost,
|
||||
},
|
||||
);
|
||||
return {
|
||||
source: 'public-cookie',
|
||||
userUid: claims.userUid,
|
||||
sessionUuid: claims.sessionUuid,
|
||||
hasValidPublicCookie: true,
|
||||
};
|
||||
} catch {
|
||||
/* fall through — v1-signed cookies land here and get re-minted */
|
||||
}
|
||||
}
|
||||
const claims = await verifyPublicCookie();
|
||||
if (claims) return publicCookieIdentity(claims);
|
||||
|
||||
return { source: 'none' };
|
||||
}
|
||||
|
||||
@@ -2763,6 +2763,321 @@ describe('public hosted asset billing identity', () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe('public hosted assets requested with the launch token in the Referer', () => {
|
||||
const cookieName = HOSTED_ASSET_COOKIES.public.name;
|
||||
|
||||
const makeLaunchedApp = async () => {
|
||||
const owner = await makeUserWithHome();
|
||||
const home = (await server.stores.fsEntry.getEntryByPath(
|
||||
`/${owner.username}`,
|
||||
))!;
|
||||
const sub = `ref-${uuidv4().slice(0, 8)}`;
|
||||
const host = `${sub}.site.puter.localhost`;
|
||||
await server.stores.subdomain.create({
|
||||
userId: owner.id,
|
||||
subdomain: sub,
|
||||
rootDirId: home.id,
|
||||
});
|
||||
await writeFile(
|
||||
owner.id,
|
||||
`/${owner.username}/index.html`,
|
||||
Buffer.from('<html></html>'),
|
||||
);
|
||||
await writeFile(
|
||||
owner.id,
|
||||
`/${owner.username}/app.css`,
|
||||
Buffer.from('body{}'),
|
||||
);
|
||||
const app = await server.stores.app.create(
|
||||
{ name: sub, title: sub, index_url: `http://${host}/` },
|
||||
{ ownerUserId: owner.id },
|
||||
);
|
||||
return { owner, sub, host, appUid: app.uid };
|
||||
};
|
||||
|
||||
const cookieFor = async (
|
||||
token: string,
|
||||
site: { sub: string; host: string; appUid: string },
|
||||
) => {
|
||||
const actor = (await server.services.auth.authenticateFromToken(
|
||||
token,
|
||||
))!;
|
||||
return server.services.auth.createHostedAssetToken('public', {
|
||||
appUid: site.appUid,
|
||||
userUid: actor.user.uuid,
|
||||
sessionUuid: actor.session?.uid,
|
||||
subdomain: site.sub,
|
||||
host: site.host,
|
||||
});
|
||||
};
|
||||
|
||||
const refererFor = (host: string, token: string) =>
|
||||
`http://${host}/?puter.app_instance_id=x&puter.auth.token=${encodeURIComponent(token)}`;
|
||||
|
||||
const serve = async (
|
||||
host: string,
|
||||
init: {
|
||||
path?: string;
|
||||
cookies?: Record<string, string>;
|
||||
headers?: Record<string, string>;
|
||||
query?: Record<string, string>;
|
||||
} = {},
|
||||
) => {
|
||||
const req = makeReq({ hostname: host, path: '/app.css', ...init });
|
||||
const { res, out } = makeRes();
|
||||
await buildMiddleware()(req, res, vi.fn());
|
||||
await new Promise<void>((resolve) => setImmediate(resolve));
|
||||
expect(out.statusCode).toBe(200);
|
||||
return { req, out };
|
||||
};
|
||||
|
||||
const claimsOf = (cookie: string, appUid: string, host: string) =>
|
||||
server.services.auth.verifyHostedAssetToken('public', cookie, {
|
||||
appUid,
|
||||
host,
|
||||
});
|
||||
|
||||
const REDIS_METHODS = [
|
||||
'get',
|
||||
'mget',
|
||||
'exists',
|
||||
'hget',
|
||||
'hgetall',
|
||||
'smembers',
|
||||
'set',
|
||||
'del',
|
||||
'expire',
|
||||
'incr',
|
||||
'incrby',
|
||||
'hset',
|
||||
'sadd',
|
||||
'pipeline',
|
||||
'multi',
|
||||
];
|
||||
|
||||
/** Redis calls, JWT signs and full authentications made by `fn`. */
|
||||
const measure = async <T>(fn: () => Promise<T>) => {
|
||||
const redis = server.clients.redis as unknown as Record<
|
||||
string,
|
||||
unknown
|
||||
>;
|
||||
const redisSpies = REDIS_METHODS.filter(
|
||||
(m) => typeof redis[m] === 'function',
|
||||
).map((m) => [m, vi.spyOn(redis as never, m as never)] as const);
|
||||
const sign = vi.spyOn(server.services.token, 'sign');
|
||||
const authenticate = vi.spyOn(server.services.auth, 'authenticate');
|
||||
try {
|
||||
const result = await fn();
|
||||
const redisCalls: Record<string, number> = {};
|
||||
for (const [m, spy] of redisSpies) {
|
||||
const n = (spy as unknown as { mock: { calls: unknown[] } })
|
||||
.mock.calls.length;
|
||||
if (n) redisCalls[m] = n;
|
||||
}
|
||||
return {
|
||||
result,
|
||||
redisCalls,
|
||||
signs: sign.mock.calls.length,
|
||||
authentications: authenticate.mock.calls.length,
|
||||
};
|
||||
} finally {
|
||||
for (const [, spy] of redisSpies) spy.mockRestore();
|
||||
sign.mockRestore();
|
||||
authenticate.mockRestore();
|
||||
}
|
||||
};
|
||||
|
||||
it('costs the same as the cookie alone when the token names the cookie user and session', async () => {
|
||||
const site = await makeLaunchedApp();
|
||||
const visitor = await makeUser();
|
||||
const token = await server.services.auth.getUserAppToken(
|
||||
actorFor(visitor),
|
||||
site.appUid,
|
||||
);
|
||||
const cookies = { [cookieName]: await cookieFor(token, site) };
|
||||
const headers = { referer: refererFor(site.host, token) };
|
||||
|
||||
// Warm the caches both paths read.
|
||||
await serve(site.host, { cookies });
|
||||
await serve(site.host, { cookies, headers });
|
||||
|
||||
const cookieOnly = await measure(() => serve(site.host, { cookies }));
|
||||
const withReferer = await measure(() =>
|
||||
serve(site.host, { cookies, headers }),
|
||||
);
|
||||
|
||||
expect(withReferer.result.req.egressActor?.user?.uuid).toBe(
|
||||
visitor.uuid,
|
||||
);
|
||||
expect(withReferer.result.out.cookies).toEqual({});
|
||||
expect(withReferer.signs).toBe(0);
|
||||
expect(withReferer.authentications).toBe(0);
|
||||
expect(withReferer.redisCalls).toEqual(cookieOnly.redisCalls);
|
||||
expect(cookieOnly.signs).toBe(0);
|
||||
});
|
||||
|
||||
it('bills the token account when the launch could not replace an older cookie', async () => {
|
||||
const site = await makeLaunchedApp();
|
||||
const previous = await makeUser();
|
||||
const current = await makeUser();
|
||||
const previousToken = await server.services.auth.getUserAppToken(
|
||||
actorFor(previous),
|
||||
site.appUid,
|
||||
);
|
||||
const currentToken = await server.services.auth.getUserAppToken(
|
||||
actorFor(current),
|
||||
site.appUid,
|
||||
);
|
||||
const oldCookies = {
|
||||
[cookieName]: await cookieFor(previousToken, site),
|
||||
};
|
||||
|
||||
const mint = vi
|
||||
.spyOn(server.services.auth, 'createHostedAssetToken')
|
||||
.mockRejectedValueOnce(new Error('mint failed'));
|
||||
const warn = vi.spyOn(console, 'warn').mockImplementation(() => {});
|
||||
let launch;
|
||||
try {
|
||||
launch = await serve(site.host, {
|
||||
path: '/index.html',
|
||||
cookies: oldCookies,
|
||||
query: { 'puter.auth.token': currentToken },
|
||||
});
|
||||
} finally {
|
||||
mint.mockRestore();
|
||||
warn.mockRestore();
|
||||
}
|
||||
expect(launch.out.cookies).toEqual({});
|
||||
expect(launch.req.egressActor?.user?.uuid).toBe(current.uuid);
|
||||
|
||||
const asset = await serve(site.host, {
|
||||
cookies: oldCookies,
|
||||
headers: { referer: refererFor(site.host, currentToken) },
|
||||
});
|
||||
expect(asset.req.egressActor?.user?.uuid).toBe(current.uuid);
|
||||
const replaced = asset.out.cookies[cookieName];
|
||||
expect(replaced).toBeTruthy();
|
||||
expect((await claimsOf(replaced, site.appUid, site.host)).userUid).toBe(
|
||||
current.uuid,
|
||||
);
|
||||
});
|
||||
|
||||
it('bills the token account when a cached page of another account loads assets', async () => {
|
||||
// The document never reaches the server (served from an app's own
|
||||
// cache), so only the assets show which account launched it.
|
||||
const site = await makeLaunchedApp();
|
||||
const previous = await makeUser();
|
||||
const current = await makeUser();
|
||||
const previousToken = await server.services.auth.getUserAppToken(
|
||||
actorFor(previous),
|
||||
site.appUid,
|
||||
);
|
||||
const currentToken = await server.services.auth.getUserAppToken(
|
||||
actorFor(current),
|
||||
site.appUid,
|
||||
);
|
||||
const oldCookies = {
|
||||
[cookieName]: await cookieFor(previousToken, site),
|
||||
};
|
||||
|
||||
for (const path of ['/app.css', '/index.html']) {
|
||||
const asset = await serve(site.host, {
|
||||
path,
|
||||
cookies: oldCookies,
|
||||
headers: { referer: refererFor(site.host, currentToken) },
|
||||
});
|
||||
expect(asset.req.egressActor?.user?.uuid).toBe(current.uuid);
|
||||
const replaced = asset.out.cookies[cookieName];
|
||||
expect(
|
||||
(await claimsOf(replaced, site.appUid, site.host)).userUid,
|
||||
).toBe(current.uuid);
|
||||
}
|
||||
});
|
||||
|
||||
it('re-mints the cookie when the token names the same user under another session', async () => {
|
||||
const site = await makeLaunchedApp();
|
||||
const visitor = await makeUser();
|
||||
const appToken = await server.services.auth.getUserAppToken(
|
||||
actorFor(visitor),
|
||||
site.appUid,
|
||||
);
|
||||
const cookies = { [cookieName]: await cookieFor(appToken, site) };
|
||||
const { session, token: sessionToken } =
|
||||
await server.services.auth.createSessionToken(visitor as never);
|
||||
|
||||
const asset = await serve(site.host, {
|
||||
cookies,
|
||||
headers: { referer: refererFor(site.host, sessionToken) },
|
||||
});
|
||||
expect(asset.req.egressActor?.user?.uuid).toBe(visitor.uuid);
|
||||
const replaced = asset.out.cookies[cookieName];
|
||||
expect(replaced).toBeTruthy();
|
||||
expect(
|
||||
(await claimsOf(replaced, site.appUid, site.host)).sessionUuid,
|
||||
).toBe(session.uuid);
|
||||
});
|
||||
|
||||
it('falls back to the cookie when the Referer token does not verify', async () => {
|
||||
const site = await makeLaunchedApp();
|
||||
const visitor = await makeUser();
|
||||
const token = await server.services.auth.getUserAppToken(
|
||||
actorFor(visitor),
|
||||
site.appUid,
|
||||
);
|
||||
const cookies = { [cookieName]: await cookieFor(token, site) };
|
||||
const tampered = `${token.slice(0, -4)}AAAA`;
|
||||
|
||||
const asset = await serve(site.host, {
|
||||
cookies,
|
||||
headers: { referer: refererFor(site.host, tampered) },
|
||||
});
|
||||
expect(asset.req.egressActor?.user?.uuid).toBe(visitor.uuid);
|
||||
expect(asset.out.cookies).toEqual({});
|
||||
});
|
||||
|
||||
it('bills the site owner once the shared session is revoked', async () => {
|
||||
const site = await makeLaunchedApp();
|
||||
const visitor = await makeUser();
|
||||
const token = await server.services.auth.getUserAppToken(
|
||||
actorFor(visitor),
|
||||
site.appUid,
|
||||
);
|
||||
const cookies = { [cookieName]: await cookieFor(token, site) };
|
||||
await server.services.auth.revokeAllSessionsForUserId(visitor.id);
|
||||
|
||||
const asset = await serve(site.host, {
|
||||
cookies,
|
||||
headers: { referer: refererFor(site.host, token) },
|
||||
});
|
||||
expect(asset.req.egressActor?.user?.uuid).toBe(site.owner.uuid);
|
||||
expect(asset.out.cookies).toEqual({});
|
||||
});
|
||||
|
||||
it('keeps responses that set the cookie out of shared caches', async () => {
|
||||
const site = await makeLaunchedApp();
|
||||
const visitor = await makeUser();
|
||||
const token = await server.services.auth.getUserAppToken(
|
||||
actorFor(visitor),
|
||||
site.appUid,
|
||||
);
|
||||
|
||||
const launch = await serve(site.host, {
|
||||
path: '/index.html',
|
||||
query: { 'puter.auth.token': token },
|
||||
});
|
||||
const cookie = launch.out.cookies[cookieName];
|
||||
expect(cookie).toBeTruthy();
|
||||
expect(launch.out.headers['Cache-Control']).toBe('private');
|
||||
|
||||
const asset = await serve(site.host, {
|
||||
cookies: { [cookieName]: cookie },
|
||||
headers: { referer: refererFor(site.host, token) },
|
||||
});
|
||||
expect(asset.out.cookies).toEqual({});
|
||||
expect(asset.out.headers['Cache-Control']).toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
describe('site rooted in the owner tree, root moved to Trash', () => {
|
||||
it('stops serving a trashed folder and resumes when restored', async () => {
|
||||
const owner = await makeUserWithHome();
|
||||
|
||||
@@ -548,6 +548,8 @@ export const createPuterSiteMiddleware = (
|
||||
requestHostname: host,
|
||||
}),
|
||||
);
|
||||
// A shared cache must not hand this visitor's cookie to others.
|
||||
res.set('Cache-Control', 'private');
|
||||
}
|
||||
} catch (e) {
|
||||
// Best-effort — don't block the public file serve.
|
||||
|
||||
@@ -186,6 +186,96 @@ describe('AuthService (integration)', () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe('signedSessionClaims', () => {
|
||||
it('names the user and session of a session token', async () => {
|
||||
const user = await makeUser();
|
||||
const { token, session } = await authService.createSessionToken(
|
||||
user,
|
||||
{},
|
||||
);
|
||||
expect(authService.signedSessionClaims(token)).toEqual({
|
||||
userUid: user.uuid,
|
||||
sessionUuid: (session as { uuid: string }).uuid,
|
||||
});
|
||||
});
|
||||
|
||||
it('names the app too for an app token', async () => {
|
||||
const user = await makeUser();
|
||||
const appUid = `app-${uuidv4()}`;
|
||||
const sessionUuid = uuidv4();
|
||||
const token = server.services.token.sign('auth', {
|
||||
type: 'app-under-user',
|
||||
version: '2',
|
||||
user_uid: user.uuid,
|
||||
app_uid: appUid,
|
||||
session_uid: sessionUuid,
|
||||
});
|
||||
expect(authService.signedSessionClaims(token)).toEqual({
|
||||
userUid: user.uuid,
|
||||
sessionUuid,
|
||||
appUid,
|
||||
});
|
||||
});
|
||||
|
||||
it('reads the session from `uuid` on a token without `session_uid`', () => {
|
||||
const [userUid, sessionUuid] = [uuidv4(), uuidv4()];
|
||||
const token = server.services.token.sign('auth', {
|
||||
type: 'gui',
|
||||
version: '0.0.0',
|
||||
uuid: sessionUuid,
|
||||
user_uid: userUid,
|
||||
});
|
||||
expect(authService.signedSessionClaims(token)).toEqual({
|
||||
userUid,
|
||||
sessionUuid,
|
||||
});
|
||||
});
|
||||
|
||||
it('returns null for worker, access, expired, tampered and session-less tokens', async () => {
|
||||
const user = await makeUser();
|
||||
const accessToken = await authService.createAccessToken(
|
||||
{
|
||||
user: {
|
||||
id: user.id,
|
||||
uuid: user.uuid,
|
||||
username: user.username,
|
||||
},
|
||||
} as Actor,
|
||||
[[`user:${user.uuid}:email:read`]],
|
||||
);
|
||||
const sign = (claims: Record<string, unknown>, expiresIn?: number) =>
|
||||
server.services.token.sign(
|
||||
'auth',
|
||||
claims,
|
||||
expiresIn === undefined ? undefined : { expiresIn },
|
||||
);
|
||||
const sessionUuid = uuidv4();
|
||||
const session = {
|
||||
type: 'session',
|
||||
version: '2',
|
||||
uuid: sessionUuid,
|
||||
session_uid: sessionUuid,
|
||||
user_uid: user.uuid,
|
||||
};
|
||||
const valid = sign(session);
|
||||
for (const token of [
|
||||
accessToken,
|
||||
sign({ ...session, worker: true, worker_name: 'w' }),
|
||||
sign({
|
||||
type: 'app-under-user',
|
||||
version: '2',
|
||||
user_uid: user.uuid,
|
||||
app_uid: `app-${uuidv4()}`,
|
||||
}),
|
||||
sign(session, -120),
|
||||
`${valid.slice(0, -4)}AAAA`,
|
||||
'not-a-jwt',
|
||||
]) {
|
||||
expect(authService.signedSessionClaims(token)).toBeNull();
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
// ── Rich `authenticate()` result shape ──────────────────────────
|
||||
|
||||
describe('authenticate (reauth signal)', () => {
|
||||
@@ -650,6 +740,60 @@ describe('AuthService (integration)', () => {
|
||||
).toBeFalsy();
|
||||
});
|
||||
|
||||
describe('listSessions and expiry', () => {
|
||||
const nowS = () => Math.floor(Date.now() / 1000);
|
||||
|
||||
const listedUuids = async (user: { id: number }) =>
|
||||
(await authService.listSessions({ user } as Actor)).map(
|
||||
(r) => (r as { uuid: string }).uuid,
|
||||
);
|
||||
|
||||
it.each(['web', 'app', 'access_token'])(
|
||||
'leaves out an expired %s session and lists a live one',
|
||||
async (kind) => {
|
||||
const user = await makeUser();
|
||||
const sessions = server.stores.session;
|
||||
const live = await sessions.create(user.id, {
|
||||
kind,
|
||||
expires_at: nowS() + 3600,
|
||||
});
|
||||
const expired = await sessions.create(user.id, {
|
||||
kind,
|
||||
expires_at: nowS() - 1,
|
||||
});
|
||||
|
||||
const uuids = await listedUuids(user);
|
||||
expect(uuids).toContain(live.uuid);
|
||||
expect(uuids).not.toContain(expired.uuid);
|
||||
},
|
||||
);
|
||||
|
||||
it('leaves out a token whose parent session has expired or is gone', async () => {
|
||||
const user = await makeUser();
|
||||
const sessions = server.stores.session;
|
||||
const token = (parent: string) =>
|
||||
sessions.create(user.id, {
|
||||
kind: 'access_token',
|
||||
parent_session_id: parent,
|
||||
expires_at: nowS() + 3600,
|
||||
});
|
||||
const liveParent = await sessions.create(user.id);
|
||||
const expiredParent = await sessions.create(user.id, {
|
||||
expires_at: nowS() - 1,
|
||||
});
|
||||
const listed = await token(liveParent.uuid);
|
||||
const underExpired = await token(expiredParent.uuid);
|
||||
const underMissing = await token(uuidv4());
|
||||
|
||||
const uuids = await listedUuids(user);
|
||||
expect(uuids).toContain(liveParent.uuid);
|
||||
expect(uuids).toContain(listed.uuid);
|
||||
expect(uuids).not.toContain(expiredParent.uuid);
|
||||
expect(uuids).not.toContain(underExpired.uuid);
|
||||
expect(uuids).not.toContain(underMissing.uuid);
|
||||
});
|
||||
});
|
||||
|
||||
it('listSessions excludes kind="asset" rows', async () => {
|
||||
// Asset rows are per-cookie children of `web` rows, revoked
|
||||
// transitively via the cascade — surfacing them in the
|
||||
@@ -3099,7 +3243,7 @@ describe('AuthService (integration)', () => {
|
||||
const emit = vi.spyOn(server.clients.event, 'emit');
|
||||
const announced = () =>
|
||||
emit.mock.calls.filter(
|
||||
(c) => c[0] === 'auth.access-token.revoked',
|
||||
(c) => c[0] === 'outer.auth.access-token.revoked',
|
||||
).length;
|
||||
|
||||
const scoped = await authService.createAccessToken(actor, [
|
||||
@@ -3117,6 +3261,35 @@ describe('AuthService (integration)', () => {
|
||||
emit.mockRestore();
|
||||
});
|
||||
|
||||
it('announces a desktop app token it replaces past its max age', async () => {
|
||||
const user = await makeUser();
|
||||
const { session } = await authService.createSessionToken(user);
|
||||
const actor = makeActor({
|
||||
user: { id: user.id, uuid: user.uuid, username: user.username },
|
||||
session: { uid: String(session.uuid), kind: 'web' },
|
||||
});
|
||||
const app = { uid: `app-${uuidv4()}`, title: 'Retire probe' };
|
||||
const { token } = await authService.getGodmodeAppToken(actor, app);
|
||||
const { token_uid } = server.services.token.verify<{
|
||||
token_uid: string;
|
||||
}>('auth', token);
|
||||
|
||||
const emit = vi.spyOn(server.clients.event, 'emit');
|
||||
const later = Date.now() + 8 * 24 * 60 * 60 * 1000;
|
||||
vi.spyOn(Date, 'now').mockReturnValue(later);
|
||||
try {
|
||||
await authService.getGodmodeAppToken(actor, app);
|
||||
expect(emit).toHaveBeenCalledWith(
|
||||
'outer.auth.access-token.revoked',
|
||||
{ token_uid },
|
||||
{},
|
||||
);
|
||||
} finally {
|
||||
vi.mocked(Date.now).mockRestore();
|
||||
emit.mockRestore();
|
||||
}
|
||||
});
|
||||
|
||||
it('revokeAccessToken rejects with 404 when the token belongs to another user', async () => {
|
||||
const u1 = await makeUser();
|
||||
const u2 = await makeUser();
|
||||
@@ -3725,6 +3898,163 @@ describe('AuthService (integration)', () => {
|
||||
).rejects.toMatchObject({ statusCode: 404 });
|
||||
expect(await authService.authenticateFromToken(jwt)).toBeTruthy();
|
||||
});
|
||||
|
||||
const migratedTokenRow = async (userId: number) => {
|
||||
const legacyUid = uuidv4();
|
||||
const row = await server.stores.session.create(userId, {
|
||||
kind: 'access_token',
|
||||
legacy_token_uid: legacyUid,
|
||||
created_via: 'legacy_backfill',
|
||||
});
|
||||
return { legacyUid, rowUuid: row.uuid as string };
|
||||
};
|
||||
|
||||
it('soft-revokes a migrated token row named by its legacy token uid', async () => {
|
||||
const user = await makeUser();
|
||||
const actor = {
|
||||
user: { id: user.id, uuid: user.uuid, username: user.username },
|
||||
} as Actor;
|
||||
const { legacyUid, rowUuid } = await migratedTokenRow(user.id);
|
||||
|
||||
await authService.revokeAccessToken(actor, legacyUid);
|
||||
|
||||
expect(await server.stores.session.getByUuid(rowUuid)).toBeNull();
|
||||
});
|
||||
|
||||
it('404s for a raw uid that names no token row', async () => {
|
||||
const user = await makeUser();
|
||||
const actor = {
|
||||
user: { id: user.id, uuid: user.uuid, username: user.username },
|
||||
} as Actor;
|
||||
|
||||
await expect(
|
||||
authService.revokeAccessToken(actor, uuidv4()),
|
||||
).rejects.toMatchObject({ statusCode: 404 });
|
||||
});
|
||||
|
||||
it("404s when another user names a migrated token's legacy uid", async () => {
|
||||
const owner = await makeUser();
|
||||
const other = await makeUser();
|
||||
const otherActor = {
|
||||
user: {
|
||||
id: other.id,
|
||||
uuid: other.uuid,
|
||||
username: other.username,
|
||||
},
|
||||
} as Actor;
|
||||
const { legacyUid, rowUuid } = await migratedTokenRow(owner.id);
|
||||
|
||||
await expect(
|
||||
authService.revokeAccessToken(otherActor, legacyUid),
|
||||
).rejects.toMatchObject({ statusCode: 404 });
|
||||
expect(
|
||||
await server.stores.session.getByUuid(rowUuid),
|
||||
).toBeTruthy();
|
||||
});
|
||||
});
|
||||
|
||||
describe('tokens minted by a full-access token', () => {
|
||||
const fullAccessToken = async () => {
|
||||
const user = await makeUser();
|
||||
const userActor = makeActor({
|
||||
user: { id: user.id, uuid: user.uuid, username: user.username },
|
||||
});
|
||||
const jwt = await authService.createAccessToken(userActor, [
|
||||
[FULL_API_ACCESS],
|
||||
]);
|
||||
const decoded = server.services.token.verify('auth', jwt) as {
|
||||
token_uid: string;
|
||||
session_uid: string;
|
||||
auth_id: string;
|
||||
};
|
||||
return { user, userActor, jwt, decoded };
|
||||
};
|
||||
|
||||
const parentOf = async (token: string) => {
|
||||
const { session_uid } = server.services.token.verify(
|
||||
'auth',
|
||||
token,
|
||||
) as { session_uid: string };
|
||||
const rows = (await server.clients.db.read(
|
||||
'SELECT `parent_session_id` FROM `sessions` WHERE `uuid` = ?',
|
||||
[session_uid],
|
||||
)) as Array<{ parent_session_id: string | null }>;
|
||||
return rows[0]?.parent_session_id;
|
||||
};
|
||||
|
||||
/** A replica that has not seen any access-token row yet. */
|
||||
const lagTokenRows = () => {
|
||||
const db = server.clients.db;
|
||||
const original = db.read.bind(db);
|
||||
const spy = vi
|
||||
.spyOn(db, 'read')
|
||||
.mockImplementation(async (sql: string, params?: unknown[]) =>
|
||||
sql.includes("FROM `sessions` WHERE `kind` = 'access_token'")
|
||||
? []
|
||||
: original(sql, params),
|
||||
);
|
||||
return () => spy.mockRestore();
|
||||
};
|
||||
|
||||
it('parents the child to the minting token row while the replica lags, and revoking it takes the child', async () => {
|
||||
const { user, userActor, jwt, decoded } = await fullAccessToken();
|
||||
const minter = await authService.authenticateFromToken(jwt);
|
||||
|
||||
const restore = lagTokenRows();
|
||||
let child: string;
|
||||
try {
|
||||
child = await authService.createAccessToken(minter!, [
|
||||
[`user:${user.uuid}:email:read`],
|
||||
]);
|
||||
} finally {
|
||||
restore();
|
||||
}
|
||||
|
||||
expect(await parentOf(child)).toBe(decoded.session_uid);
|
||||
expect(await authService.authenticateFromToken(child)).toBeTruthy();
|
||||
await authService.revokeAccessToken(userActor, jwt);
|
||||
expect(await authService.authenticateFromToken(child)).toBeNull();
|
||||
});
|
||||
|
||||
it('carries the row whether auth read it from the cache or the database', async () => {
|
||||
const { jwt, decoded } = await fullAccessToken();
|
||||
const key = `sessions:v2:uuid:${decoded.session_uid}`;
|
||||
|
||||
expect(await server.clients.redis.get(key)).toBeTruthy();
|
||||
const cached = await authService.authenticateFromToken(jwt);
|
||||
await server.clients.redis.del(key);
|
||||
const fromDb = await authService.authenticateFromToken(jwt);
|
||||
|
||||
expect(cached?.accessToken?.sessionUid).toBe(decoded.session_uid);
|
||||
expect(fromDb?.accessToken?.sessionUid).toBe(decoded.session_uid);
|
||||
});
|
||||
|
||||
it('looks the row up by token uid when the claim names no row of its own', async () => {
|
||||
const { user, decoded } = await fullAccessToken();
|
||||
const otherSession = await authService.createSessionToken(user, {});
|
||||
const claims = {
|
||||
type: 'access-token',
|
||||
version: '2',
|
||||
token_uid: decoded.token_uid,
|
||||
user_uid: user.uuid,
|
||||
auth_id: decoded.auth_id,
|
||||
full_access: true,
|
||||
};
|
||||
const unclaimed = server.services.token.sign('auth', claims);
|
||||
const misclaimed = server.services.token.sign('auth', {
|
||||
...claims,
|
||||
session_uid: (otherSession.session as { uuid: string }).uuid,
|
||||
});
|
||||
|
||||
for (const token of [unclaimed, misclaimed]) {
|
||||
const minter = await authService.authenticateFromToken(token);
|
||||
expect(minter?.accessToken?.sessionUid).toBeUndefined();
|
||||
const child = await authService.createAccessToken(minter!, [
|
||||
[`user:${user.uuid}:email:read`],
|
||||
]);
|
||||
expect(await parentOf(child)).toBe(decoded.session_uid);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
describe('revokeSession on access-token rows', () => {
|
||||
@@ -4025,6 +4355,32 @@ describe('AuthService (integration)', () => {
|
||||
},
|
||||
);
|
||||
|
||||
it.each(revokers)(
|
||||
'%s revokes an expired session and its live children',
|
||||
async (_name, revoke) => {
|
||||
const user = await makeUser();
|
||||
const sessions = server.stores.session;
|
||||
const now = Math.floor(Date.now() / 1000);
|
||||
const web = await sessions.create(user.id, {
|
||||
expires_at: now - 1,
|
||||
});
|
||||
const child = await sessions.create(user.id, {
|
||||
kind: 'access_token',
|
||||
parent_session_id: web.uuid,
|
||||
expires_at: now + 3600,
|
||||
});
|
||||
|
||||
await revoke(user);
|
||||
|
||||
const rows = await server.clients.db.read(
|
||||
'SELECT `uuid`, `revoked_at` FROM `sessions` WHERE `uuid` IN (?, ?)',
|
||||
[web.uuid, child.uuid],
|
||||
);
|
||||
expect(rows).toHaveLength(2);
|
||||
for (const row of rows) expect(row.revoked_at).not.toBeNull();
|
||||
},
|
||||
);
|
||||
|
||||
it('a password reset leaves workers and standalone access tokens; a forced sign-out takes them', async () => {
|
||||
const user = await makeUser();
|
||||
const sessions = server.stores.session;
|
||||
|
||||
@@ -216,6 +216,10 @@ const sequentialAuthenticate = async (
|
||||
if (!app || !isGodmodeApp(app)) return { invalid: true };
|
||||
godmodeApp = { uid: app.uid, id: app.id };
|
||||
}
|
||||
const ownRow =
|
||||
session?.kind === 'access_token' &&
|
||||
(session.access_token_uid === d.token_uid ||
|
||||
session.legacy_token_uid === d.token_uid);
|
||||
const actor = makeActor({
|
||||
user: actorUser(user),
|
||||
accessToken: {
|
||||
@@ -224,6 +228,7 @@ const sequentialAuthenticate = async (
|
||||
authorized: null,
|
||||
fullAccess: !d.app_uid && d.full_access === true,
|
||||
...(godmodeApp ? { godmodeApp } : {}),
|
||||
...(ownRow ? { sessionUid: session!.uuid } : {}),
|
||||
},
|
||||
});
|
||||
applyHandlerDepth(actor);
|
||||
|
||||
@@ -106,6 +106,15 @@ const HOSTED_ASSET_LABELS = {
|
||||
|
||||
export type ReauthReason = 'session_revoked' | 'session_expired';
|
||||
|
||||
/** Worker claims a session/gui token can carry. */
|
||||
interface SessionTypeTokenOptions {
|
||||
worker?: boolean;
|
||||
workerName?: string;
|
||||
workerUid?: string;
|
||||
workerSiteUid?: string;
|
||||
workerSite?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Request metadata for `authenticate`. `touch: false` checks the token without
|
||||
* recording activity on its session, for re-checks no user made.
|
||||
@@ -367,6 +376,22 @@ export class AuthService extends PuterService {
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Digest of the claims `createGuiToken` signs for this session, which
|
||||
* differ between two of its tokens only in `iat`.
|
||||
*/
|
||||
guiTokenDigest(user: UserRow, sessionUuid: string): string {
|
||||
return this.services.token.claimsDigest(
|
||||
'auth',
|
||||
this.#sessionTypeClaims(
|
||||
'gui',
|
||||
user,
|
||||
sessionUuid,
|
||||
this.#authIdFor(user),
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
/** Sign a session token for an existing session (upgrade from GUI token). */
|
||||
createSessionTokenForSession(user: UserRow, sessionUuid: string): string {
|
||||
return this.#signSessionTypeToken(
|
||||
@@ -386,14 +411,21 @@ export class AuthService extends PuterService {
|
||||
user: UserRow,
|
||||
sessionUuid: string,
|
||||
authId: string,
|
||||
opts: {
|
||||
worker?: boolean;
|
||||
workerName?: string;
|
||||
workerUid?: string;
|
||||
workerSiteUid?: string;
|
||||
workerSite?: string;
|
||||
} = {},
|
||||
opts: SessionTypeTokenOptions = {},
|
||||
): string {
|
||||
return this.services.token.sign(
|
||||
'auth',
|
||||
this.#sessionTypeClaims(type, user, sessionUuid, authId, opts),
|
||||
);
|
||||
}
|
||||
|
||||
#sessionTypeClaims(
|
||||
type: 'session' | 'gui',
|
||||
user: UserRow,
|
||||
sessionUuid: string,
|
||||
authId: string,
|
||||
opts: SessionTypeTokenOptions = {},
|
||||
): Record<string, unknown> {
|
||||
const claims: Record<string, unknown> = {
|
||||
type,
|
||||
version: '2',
|
||||
@@ -410,7 +442,7 @@ export class AuthService extends PuterService {
|
||||
if (opts.workerUid) claims.worker_uid = opts.workerUid;
|
||||
if (opts.workerSiteUid) claims.workerSiteUid = opts.workerSiteUid;
|
||||
if (opts.workerSite) claims.workerSite = opts.workerSite;
|
||||
return this.services.token.sign('auth', claims);
|
||||
return claims;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -743,9 +775,22 @@ export class AuthService extends PuterService {
|
||||
|
||||
const rows = (await this.stores.session.getByUserId(
|
||||
actor.user.id,
|
||||
)) as Array<Record<string, unknown>>;
|
||||
)) as SessionRow[];
|
||||
|
||||
const visible = rows.filter((row) => row.kind !== 'asset');
|
||||
// Listed while authentication still accepts it: not expired, and for
|
||||
// a token minted under another session, that session live as well.
|
||||
const live = new Map(
|
||||
rows
|
||||
.filter((row) => !this.#endedSession(row))
|
||||
.map((row) => [row.uuid, row]),
|
||||
);
|
||||
const visible = [...live.values()].filter(
|
||||
(row) =>
|
||||
row.kind !== 'asset' &&
|
||||
(row.kind !== 'access_token' ||
|
||||
!row.parent_session_id ||
|
||||
live.has(row.parent_session_id)),
|
||||
);
|
||||
|
||||
const appUids = [
|
||||
...new Set(
|
||||
@@ -785,7 +830,7 @@ export class AuthService extends PuterService {
|
||||
const enriched = visible.map((row) => {
|
||||
const meta =
|
||||
(typeof row.meta === 'string'
|
||||
? JSON.parse(row.meta as string)
|
||||
? JSON.parse(row.meta)
|
||||
: row.meta) ?? {};
|
||||
const isCurrent = actor.session?.uid === row.uuid;
|
||||
const appUid = typeof row.app_uid === 'string' ? row.app_uid : null;
|
||||
@@ -1889,7 +1934,7 @@ export class AuthService extends PuterService {
|
||||
}
|
||||
if (row.access_token_uid) {
|
||||
this.clients.event?.emit(
|
||||
'auth.access-token.revoked',
|
||||
'outer.auth.access-token.revoked',
|
||||
{ token_uid: row.access_token_uid },
|
||||
{},
|
||||
);
|
||||
@@ -2051,6 +2096,43 @@ export class AuthService extends PuterService {
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* User, session and app a session, GUI or app token names, checked against
|
||||
* its signature and expiry only: nothing is read from the stores, so this
|
||||
* says nothing about whether the session or user is still live. Null for
|
||||
* worker and access tokens, and for anything that doesn't verify.
|
||||
*/
|
||||
signedSessionClaims(
|
||||
token: string,
|
||||
): { userUid: string; sessionUuid: string; appUid?: string } | null {
|
||||
let decoded: AnyTokenPayload;
|
||||
try {
|
||||
decoded = this.services.token.verify<AnyTokenPayload>(
|
||||
'auth',
|
||||
token,
|
||||
);
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
if (decoded.type === 'session' || decoded.type === 'gui') {
|
||||
if (decoded.worker) return null;
|
||||
const sessionUuid = decoded.session_uid ?? decoded.uuid;
|
||||
if (!decoded.user_uid || !sessionUuid) return null;
|
||||
return { userUid: decoded.user_uid, sessionUuid };
|
||||
}
|
||||
if (decoded.type === 'app-under-user') {
|
||||
if (decoded.worker) return null;
|
||||
if (!decoded.user_uid || !decoded.session_uid || !decoded.app_uid)
|
||||
return null;
|
||||
return {
|
||||
userUid: decoded.user_uid,
|
||||
sessionUuid: decoded.session_uid,
|
||||
appUid: decoded.app_uid,
|
||||
};
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
#verifyHostedAssetToken(
|
||||
token: string,
|
||||
expectedKind: 'private' | 'public',
|
||||
@@ -2218,18 +2300,21 @@ export class AuthService extends PuterService {
|
||||
let parent_session_id =
|
||||
issuingApp && actor.session ? actor.session.uid : null;
|
||||
if (mintingToken) {
|
||||
const mintingRow =
|
||||
await this.stores.session.findActiveByAccessTokenUid(
|
||||
mintingToken.uid,
|
||||
);
|
||||
if (!mintingRow) {
|
||||
const mintingRowUuid =
|
||||
mintingToken.sessionUid ??
|
||||
(
|
||||
await this.stores.session.findActiveByAccessTokenUid(
|
||||
mintingToken.uid,
|
||||
)
|
||||
)?.uuid;
|
||||
if (!mintingRowUuid) {
|
||||
throw new HttpError(
|
||||
403,
|
||||
'Access tokens may not create access tokens',
|
||||
{ legacyCode: 'forbidden' },
|
||||
);
|
||||
}
|
||||
parent_session_id = mintingRow.uuid;
|
||||
parent_session_id = mintingRowUuid;
|
||||
}
|
||||
|
||||
const tokenSession = await this.stores.session.create(
|
||||
@@ -2511,7 +2596,7 @@ export class AuthService extends PuterService {
|
||||
// Only a token the handshake admits has a socket to drop.
|
||||
if (mayBeFullAccess) {
|
||||
this.clients.event?.emit(
|
||||
'auth.access-token.revoked',
|
||||
'outer.auth.access-token.revoked',
|
||||
{ token_uid: tokenUid },
|
||||
{},
|
||||
);
|
||||
@@ -2796,6 +2881,15 @@ export class AuthService extends PuterService {
|
||||
|
||||
if (session) void this.#touchSession(session.uuid, user.id, ctx);
|
||||
|
||||
// The row `findActiveByAccessTokenUid` would return, already checked
|
||||
// live above, so tokens this one mints can parent to it without a read.
|
||||
const ownRow =
|
||||
session?.kind === 'access_token' &&
|
||||
(session.access_token_uid === decoded.token_uid ||
|
||||
session.legacy_token_uid === decoded.token_uid)
|
||||
? session
|
||||
: null;
|
||||
|
||||
const actor = makeActor({
|
||||
user: this.#actorUserFromRow(user),
|
||||
accessToken: {
|
||||
@@ -2808,6 +2902,7 @@ export class AuthService extends PuterService {
|
||||
// claim on one is ignored here.
|
||||
fullAccess: !decoded.app_uid && decoded.full_access === true,
|
||||
...(godmodeApp ? { godmodeApp } : {}),
|
||||
...(ownRow ? { sessionUid: ownRow.uuid } : {}),
|
||||
},
|
||||
});
|
||||
this.#applyHandlerDepth(actor, decoded);
|
||||
@@ -2864,7 +2959,7 @@ export class AuthService extends PuterService {
|
||||
|
||||
#actorUserFromRow(user: UserRow) {
|
||||
// Strip the password hash; pass everything else through so callers
|
||||
// can read metadata, desktop_bg_*, otp_enabled, etc. without
|
||||
// can read metadata, otp_enabled, etc. without
|
||||
// re-fetching the user. Mirrors what /whoami exposes off of UserRow.
|
||||
const { password: _password, ...rest } = user;
|
||||
return {
|
||||
|
||||
@@ -20,6 +20,7 @@
|
||||
import { createHmac } from 'node:crypto';
|
||||
import jwt from 'jsonwebtoken';
|
||||
import { describe, expect, it } from 'vitest';
|
||||
import { tokenClaimsDigest } from '../../../gui/src/helpers/guiToken.js';
|
||||
import { isTokenForAnotherUser } from '../../../gui/src/helpers/tokenUser.js';
|
||||
import { TokenService } from './TokenService.js';
|
||||
|
||||
@@ -403,3 +404,35 @@ describe('session token read by the desktop', () => {
|
||||
expect(isTokenForAnotherUser(token, { uuid: otherUid })).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe('TokenService.claimsDigest', () => {
|
||||
const claims = {
|
||||
type: 'gui',
|
||||
version: '2',
|
||||
uuid: '6f1e2d3c-0000-4000-8000-000000000001',
|
||||
session_uid: '6f1e2d3c-0000-4000-8000-000000000001',
|
||||
user_uid: '5d4adce0-a381-4982-9c02-6e2540026238',
|
||||
auth_id: '5d4adce0-a381-4982-9c02-6e2540026238',
|
||||
};
|
||||
|
||||
it('is what the desktop computes over a token signed with those claims', async () => {
|
||||
const svc = createTokenService();
|
||||
const digest = svc.claimsDigest('auth', claims);
|
||||
expect(digest).toMatch(/^[0-9a-f]{32}$/);
|
||||
expect(await tokenClaimsDigest(svc.sign('auth', claims))).toBe(digest);
|
||||
});
|
||||
|
||||
it('differs for another session or token type', () => {
|
||||
const svc = createTokenService();
|
||||
const digest = svc.claimsDigest('auth', claims);
|
||||
expect(
|
||||
svc.claimsDigest('auth', {
|
||||
...claims,
|
||||
session_uid: 'b0b0b0b0-0000-4000-8000-000000000002',
|
||||
}),
|
||||
).not.toBe(digest);
|
||||
expect(svc.claimsDigest('auth', { ...claims, type: 'session' })).not.toBe(
|
||||
digest,
|
||||
);
|
||||
});
|
||||
});
|
||||
@@ -17,6 +17,7 @@
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
import { createHash } from 'node:crypto';
|
||||
import jwt, { type SignOptions } from 'jsonwebtoken';
|
||||
import { PuterService } from '../types';
|
||||
|
||||
@@ -268,6 +269,24 @@ export class TokenService extends PuterService {
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Digest of the claims `sign(scope, payload)` writes, minus `iat`: SHA-256
|
||||
* over the claims as key-sorted `[key, value]` pairs in JSON, first 32 hex
|
||||
* chars. The GUI computes the same over a stored token
|
||||
* (`gui/src/helpers/guiToken.js`), so the two must stay in step.
|
||||
*/
|
||||
claimsDigest(scope: string, payload: Record<string, unknown>): string {
|
||||
const claims = this.#compressPayload(COMPRESSION[scope], payload);
|
||||
const pairs = Object.keys(claims)
|
||||
.filter((key) => key !== 'iat')
|
||||
.sort()
|
||||
.map((key) => [key, claims[key]]);
|
||||
return createHash('sha256')
|
||||
.update(JSON.stringify(pairs))
|
||||
.digest('hex')
|
||||
.slice(0, 32);
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify and decompress. Only v2 tokens (`kid: 'v2'`) verify; any other
|
||||
* token — including the retired v1 format — is rejected as invalid, with no
|
||||
|
||||
@@ -126,8 +126,12 @@ export interface SessionRow {
|
||||
expires_at?: number | null;
|
||||
app_uid?: string | null;
|
||||
legacy_token_uid?: string | null;
|
||||
access_token_uid?: string | null;
|
||||
created_via?: string | null;
|
||||
auth_id?: string | null;
|
||||
label?: string | null;
|
||||
last_ip?: string | null;
|
||||
last_user_agent?: string | null;
|
||||
}
|
||||
|
||||
export {};
|
||||
@@ -124,6 +124,21 @@ describe('resolveNode', () => {
|
||||
expect(error.message).toContain('uuid=ghost');
|
||||
});
|
||||
|
||||
it('treats a path-less row found by uid or id as missing', async () => {
|
||||
const orphan = makeEntry({ path: null as unknown as string });
|
||||
const store = makeStore({
|
||||
getEntryByUuid: vi.fn(async () => orphan),
|
||||
getEntryById: vi.fn(async () => orphan),
|
||||
});
|
||||
|
||||
await expect(resolveNode(store, { uid: 'uuid-7' })).resolves.toBeNull();
|
||||
await expectHttpError(
|
||||
() => resolveNode(store, { id: 7 }, { required: true }),
|
||||
404,
|
||||
'subject_does_not_exist',
|
||||
);
|
||||
});
|
||||
|
||||
it('falls back to id lookup when uid is blank', async () => {
|
||||
const entry = makeEntry();
|
||||
const store = makeStore({ getEntryById: vi.fn(async () => entry) });
|
||||
|
||||
@@ -62,10 +62,12 @@ export async function resolveNode(
|
||||
): Promise<FSEntry | null> {
|
||||
if (ref.entry) return ref.entry;
|
||||
|
||||
// A uid/id lookup can return a legacy row with no path when its parent
|
||||
// chain is broken. Nothing can authorize or address it, so it's a miss.
|
||||
const uuid = ref.uid ?? ref.uuid;
|
||||
if (isNonEmptyString(uuid)) {
|
||||
const entry = await fsEntryStore.getEntryByUuid(uuid);
|
||||
if (entry) return entry;
|
||||
if (entry?.path) return entry;
|
||||
return notFoundOrNull(
|
||||
options.required,
|
||||
`Entry not found: uuid=${uuid}`,
|
||||
@@ -80,7 +82,7 @@ export async function resolveNode(
|
||||
});
|
||||
}
|
||||
const entry = await fsEntryStore.getEntryById(numericId);
|
||||
if (entry) return entry;
|
||||
if (entry?.path) return entry;
|
||||
return notFoundOrNull(
|
||||
options.required,
|
||||
`Entry not found: id=${numericId}`,
|
||||
|
||||
@@ -137,7 +137,6 @@ const render = async (
|
||||
service: PuterHomepageService,
|
||||
req: Request = makeReq(),
|
||||
meta: Record<string, unknown> = { title: 'Puter' },
|
||||
launchOptions: Record<string, unknown> = {},
|
||||
actor: unknown = null,
|
||||
): Promise<string> => {
|
||||
let sent = '';
|
||||
@@ -149,7 +148,6 @@ const render = async (
|
||||
await service.send(
|
||||
{ req, res, actor } as never,
|
||||
meta as never,
|
||||
launchOptions as never,
|
||||
);
|
||||
return sent;
|
||||
};
|
||||
@@ -292,7 +290,6 @@ describe('PuterHomepageService — gui() parameters', () => {
|
||||
asset_dir: '/dist',
|
||||
title: 'Editor',
|
||||
app: { name: 'editor' },
|
||||
launch_options: {},
|
||||
});
|
||||
// No `config.origin`: fall back to the request's protocol + domain.
|
||||
expect(params.app_origin).toBe('http://puter.test');
|
||||
@@ -338,7 +335,7 @@ describe('PuterHomepageService — gui() parameters', () => {
|
||||
|
||||
const staff = { user: { id: 7, email: '[email protected]' } };
|
||||
expect(
|
||||
guiParamsOf(await render(service, makeReq(), undefined, {}, staff))
|
||||
guiParamsOf(await render(service, makeReq(), undefined, staff))
|
||||
.teams_ui,
|
||||
).toBe(true);
|
||||
expect(teamsAvailableTo).toHaveBeenCalledWith(7, '[email protected]');
|
||||
@@ -349,7 +346,7 @@ describe('PuterHomepageService — gui() parameters', () => {
|
||||
teamsAvailableTo.mockResolvedValueOnce(false);
|
||||
expect(
|
||||
guiParamsOf(
|
||||
await render(service, makeReq(), undefined, {}, {
|
||||
await render(service, makeReq(), undefined, {
|
||||
user: { id: 9, email: '[email protected]' },
|
||||
}),
|
||||
).teams_ui,
|
||||
@@ -420,22 +417,6 @@ describe('PuterHomepageService — gui() parameters', () => {
|
||||
expect(html).toContain('\\u003c/script>');
|
||||
expect(guiParamsOf(html).injected).toBe('</script><img src=x>');
|
||||
});
|
||||
|
||||
it('passes launch options straight through', async () => {
|
||||
const params = guiParamsOf(
|
||||
await render(
|
||||
makeService(),
|
||||
makeReq(),
|
||||
{ title: 'Puter' },
|
||||
{
|
||||
on_initialized: [{ do: 'thing' }],
|
||||
},
|
||||
),
|
||||
);
|
||||
expect(params.launch_options).toEqual({
|
||||
on_initialized: [{ do: 'thing' }],
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('PuterHomepageService — extension hooks', () => {
|
||||
|
||||
@@ -44,10 +44,6 @@ export interface PageMeta {
|
||||
app?: { name?: string; [k: string]: unknown } | null;
|
||||
}
|
||||
|
||||
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
|
||||
@@ -57,6 +53,17 @@ export interface PopupFrame {
|
||||
hostOrigin: string | null;
|
||||
}
|
||||
|
||||
export interface ShellContext {
|
||||
req: Request;
|
||||
res: Response;
|
||||
actor?: Actor | null;
|
||||
/**
|
||||
* `AuthService.guiTokenDigest` for the request's session cookie, or null
|
||||
* when it carries none. Omitted when the caller doesn't work it out.
|
||||
*/
|
||||
guiTokenDigest?: string | null;
|
||||
}
|
||||
|
||||
interface PuterGuiAddonsEvent {
|
||||
req: Request;
|
||||
path: string;
|
||||
@@ -309,12 +316,11 @@ export class PuterHomepageService extends PuterService {
|
||||
* called on the happy path.
|
||||
*/
|
||||
async send(
|
||||
ctx: { req: Request; res: Response; actor?: Actor | null },
|
||||
ctx: ShellContext,
|
||||
meta: PageMeta,
|
||||
launchOptions: LaunchOptions = {},
|
||||
popupFrame?: PopupFrame,
|
||||
): Promise<void> {
|
||||
const { req, res, actor } = ctx;
|
||||
const { req, res, actor, guiTokenDigest } = ctx;
|
||||
|
||||
// Easter egg: puter-in-puter detection → render error page instead.
|
||||
if (
|
||||
@@ -334,9 +340,8 @@ export class PuterHomepageService extends PuterService {
|
||||
}
|
||||
|
||||
const html = await this.#renderShell(
|
||||
{ req, actor: actor ?? null },
|
||||
{ req, actor: actor ?? null, guiTokenDigest },
|
||||
meta,
|
||||
launchOptions,
|
||||
popupFrame,
|
||||
);
|
||||
res.send(html);
|
||||
@@ -345,12 +350,13 @@ export class PuterHomepageService extends PuterService {
|
||||
// -- Internals ----------------------------------------------------
|
||||
|
||||
async #renderShell(
|
||||
ctx: { req: Request; actor: Actor | null },
|
||||
ctx: Pick<ShellContext, 'req' | 'guiTokenDigest'> & {
|
||||
actor: Actor | null;
|
||||
},
|
||||
meta: PageMeta,
|
||||
launchOptions: LaunchOptions,
|
||||
popupFrame?: PopupFrame,
|
||||
): Promise<string> {
|
||||
const { req, actor } = ctx;
|
||||
const { req, actor, guiTokenDigest } = ctx;
|
||||
const env = this.config.env ?? 'prod';
|
||||
const bundled = env !== 'dev' || this.config.use_bundled_gui === true;
|
||||
const assetDir = env === 'dev' ? '/src' : '/dist';
|
||||
@@ -393,10 +399,13 @@ export class PuterHomepageService extends PuterService {
|
||||
// instead of the socket wire.
|
||||
eventsNotifications: notificationsFoldInEnabled(this.config),
|
||||
...meta,
|
||||
launch_options: launchOptions,
|
||||
// After `meta`, so nothing page-specific can name the opener.
|
||||
...(popupFrame ? { embed_host_origin: popupFrame.hostOrigin } : {}),
|
||||
};
|
||||
// Only ever this request's; without one the GUI asks for its token as
|
||||
// it always has.
|
||||
if (guiTokenDigest === undefined) delete guiParams.guiTokenDigest;
|
||||
else guiParams.guiTokenDigest = guiTokenDigest;
|
||||
|
||||
const event: PuterGuiAddonsEvent = {
|
||||
req,
|
||||
@@ -517,8 +526,6 @@ export class PuterHomepageService extends PuterService {
|
||||
<meta name="theme-color" content="#ffffff">
|
||||
${bundled ? `<link rel="stylesheet" href="${guiCss}">` : ''}
|
||||
|
||||
<link rel="preload" as="image" href="https://puter-assets.b-cdn.net/wallpaper.webp">
|
||||
|
||||
<script>
|
||||
if ( ! window.service_script ) {
|
||||
window.service_script_api_promise = (() => {
|
||||
|
||||
@@ -4579,6 +4579,209 @@ describe('MeteringService', () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe('settling when a balance read fails', () => {
|
||||
const monthKey = (a: Actor) =>
|
||||
`${METRICS_V2_PREFIX}:actor:${a.user!.uuid}:${currentMonthString()}`;
|
||||
|
||||
/** Rejects the next `times` reads `match` picks; the rest go through. */
|
||||
const failReads = (
|
||||
match: (args: {
|
||||
key: unknown;
|
||||
consistentRead?: boolean;
|
||||
}) => boolean,
|
||||
times = Infinity,
|
||||
) => {
|
||||
const kv = server.stores.kv;
|
||||
const realGet = kv.get.bind(kv);
|
||||
let left = times;
|
||||
return vi
|
||||
.spyOn(kv, 'get')
|
||||
.mockImplementation(
|
||||
async (...args: Parameters<typeof realGet>) => {
|
||||
if (left > 0 && match(args[0] as never)) {
|
||||
left--;
|
||||
throw new Error(
|
||||
'ProvisionedThroughputExceededException',
|
||||
);
|
||||
}
|
||||
return realGet(...args);
|
||||
},
|
||||
);
|
||||
};
|
||||
const isAddonsRead = ({ key }: { key: unknown }) =>
|
||||
typeof key === 'string' && key.endsWith(':addons');
|
||||
|
||||
const pools = async (a: Actor) => {
|
||||
await server.stores.meteringBuffer.flushCycle();
|
||||
const { usage } = await target.getActorCurrentMonthUsageDetails(a);
|
||||
const addons = await target.getActorAddons(a, {
|
||||
consistentRead: true,
|
||||
});
|
||||
return {
|
||||
total: usage.total,
|
||||
allowanceUsed: usage.allowanceUsed ?? 0,
|
||||
consumed: addons.consumedPurchaseCredits ?? 0,
|
||||
};
|
||||
};
|
||||
|
||||
it('charges the allowance when the purchased-credit read fails', async () => {
|
||||
await target.updateAddonCredit(actor.user.uuid!, 1_000_000);
|
||||
await target.incrementUsage(actor, 'ai:chat', 1, 1000);
|
||||
const before = await target.getAllowedUsage(actor);
|
||||
|
||||
const get = failReads(isAddonsRead);
|
||||
const result = await target.incrementUsage(
|
||||
actor,
|
||||
'ai:chat',
|
||||
1,
|
||||
5000,
|
||||
);
|
||||
get.mockRestore();
|
||||
|
||||
expect(result.total).toBe(6000);
|
||||
expect(await pools(actor)).toEqual({
|
||||
total: 6000,
|
||||
allowanceUsed: 6000,
|
||||
consumed: 0,
|
||||
});
|
||||
const after = await target.getAllowedUsage(actor);
|
||||
expect(before.remaining - after.remaining).toBe(5000);
|
||||
});
|
||||
|
||||
it('charges only the allowance share past the allowance, and nothing later charges the rest', async () => {
|
||||
const { monthUsageAllowance: allowance } =
|
||||
await target.getActorSubscription(actor);
|
||||
await target.updateAddonCredit(actor.user.uuid!, 1_000_000);
|
||||
await target.incrementUsage(actor, 'ai:chat', 1, allowance - 100);
|
||||
expect(await target.hasAnyUsageCached(actor)).toBe(true);
|
||||
|
||||
const alarm = vi.spyOn(server.clients.alarm, 'create');
|
||||
const emit = vi.spyOn(server.clients.event, 'emit');
|
||||
const get = failReads(isAddonsRead);
|
||||
await target.incrementUsage(actor, 'ai:chat', 1, 1000);
|
||||
get.mockRestore();
|
||||
|
||||
// 100 fits the allowance; the 900 credit would cover isn't drawn.
|
||||
expect(await pools(actor)).toEqual({
|
||||
total: allowance + 900,
|
||||
allowanceUsed: allowance,
|
||||
consumed: 0,
|
||||
});
|
||||
expect(alarm).toHaveBeenCalledWith(
|
||||
'metering_settle_read_failed',
|
||||
expect.any(String),
|
||||
expect.objectContaining({
|
||||
userId: actor.user.uuid,
|
||||
unchargedCost: 900,
|
||||
}),
|
||||
'info',
|
||||
);
|
||||
expect(
|
||||
alarm.mock.calls.some(([id]) =>
|
||||
String(id).startsWith('metering service error'),
|
||||
),
|
||||
).toBe(false);
|
||||
// The unread credit isn't taken as spent.
|
||||
expect(
|
||||
emit.mock.calls.some(
|
||||
([name]) => name === 'metering.credit-state',
|
||||
),
|
||||
).toBe(false);
|
||||
expect(await target.hasAnyUsageCached(actor)).toBe(true);
|
||||
alarm.mockRestore();
|
||||
emit.mockRestore();
|
||||
|
||||
// The next settle charges its own cost once, and only that.
|
||||
await target.incrementUsage(actor, 'ai:chat', 1, 700);
|
||||
expect(await pools(actor)).toEqual({
|
||||
total: allowance + 1600,
|
||||
allowanceUsed: allowance,
|
||||
consumed: 700,
|
||||
});
|
||||
});
|
||||
|
||||
it('charges the allowance from the buffered total when the exact read fails', async () => {
|
||||
const Service = target.constructor as typeof MeteringService;
|
||||
const interval = Service.EXACT_READ_MIN_INTERVAL_MS;
|
||||
Service.EXACT_READ_MIN_INTERVAL_MS = 0;
|
||||
try {
|
||||
const { monthUsageAllowance: allowance } =
|
||||
await target.getActorSubscription(actor);
|
||||
await target.incrementUsage(
|
||||
actor,
|
||||
'ai:chat',
|
||||
1,
|
||||
allowance - 3000,
|
||||
);
|
||||
await server.stores.meteringBuffer.flushCycle();
|
||||
|
||||
const key = monthKey(actor);
|
||||
const alarm = vi.spyOn(server.clients.alarm, 'create');
|
||||
const get = failReads(
|
||||
(args) => args.key === key && !!args.consistentRead,
|
||||
);
|
||||
const result = await target.incrementUsage(
|
||||
actor,
|
||||
'ai:chat',
|
||||
1,
|
||||
1000,
|
||||
);
|
||||
const failedReads = get.mock.calls.length;
|
||||
get.mockRestore();
|
||||
|
||||
expect(failedReads).toBeGreaterThan(0);
|
||||
expect(result.total).toBe(allowance - 2000);
|
||||
expect(await pools(actor)).toEqual({
|
||||
total: allowance - 2000,
|
||||
allowanceUsed: allowance - 2000,
|
||||
consumed: 0,
|
||||
});
|
||||
expect(alarm).toHaveBeenCalledWith(
|
||||
'metering_settle_read_failed',
|
||||
expect.any(String),
|
||||
expect.objectContaining({ unchargedCost: 0 }),
|
||||
'info',
|
||||
);
|
||||
alarm.mockRestore();
|
||||
} finally {
|
||||
Service.EXACT_READ_MIN_INTERVAL_MS = interval;
|
||||
}
|
||||
});
|
||||
|
||||
it('charges each of two racing calls once when one of their reads fails', async () => {
|
||||
await target.updateAddonCredit(actor.user.uuid!, 1_000_000);
|
||||
await target.incrementUsage(actor, 'ai:chat', 1, 1000);
|
||||
|
||||
const get = failReads(isAddonsRead, 1);
|
||||
await Promise.all([
|
||||
target.incrementUsage(actor, 'ai:chat', 1, 2000),
|
||||
target.incrementUsage(actor, 'ai:chat', 1, 3000),
|
||||
]);
|
||||
get.mockRestore();
|
||||
|
||||
expect(await pools(actor)).toEqual({
|
||||
total: 6000,
|
||||
allowanceUsed: 6000,
|
||||
consumed: 0,
|
||||
});
|
||||
});
|
||||
|
||||
it('charges a failed call and the calls after it exactly once each', async () => {
|
||||
await target.updateAddonCredit(actor.user.uuid!, 1_000_000);
|
||||
const costs = [1000, 2000, 3000, 4000];
|
||||
for (const [i, cost] of costs.entries()) {
|
||||
const get = failReads(isAddonsRead, i % 2 === 0 ? 1 : 0);
|
||||
await target.incrementUsage(actor, 'ai:chat', 1, cost);
|
||||
get.mockRestore();
|
||||
}
|
||||
expect(await pools(actor)).toEqual({
|
||||
total: 10_000,
|
||||
allowanceUsed: 10_000,
|
||||
consumed: 0,
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
// ── Resolver registration ────────────────────────────────────────
|
||||
|
||||
describe('resolver registration', () => {
|
||||
|
||||
@@ -342,6 +342,9 @@ export class MeteringService extends PuterService {
|
||||
/** Bumped on every drop, so a read that straddles one isn't cached. */
|
||||
#spentAddonsDrops = 0;
|
||||
|
||||
/** Running sum reported by `#alarmSettleReadFailed`. */
|
||||
#unchargedSinceStart = 0;
|
||||
|
||||
/**
|
||||
* Uuid → until when a near-allowance read bypasses the exact-read throttle.
|
||||
* Set on a credits change (a purchase, an admin correction): for a short
|
||||
@@ -675,49 +678,84 @@ export class MeteringService extends PuterService {
|
||||
appCallCount: usages.length,
|
||||
});
|
||||
|
||||
// The usage is already being recorded, so a failed balance read
|
||||
// must not skip settling it.
|
||||
let settleReadError: Error | null = null;
|
||||
const [usageResult, subscription, actorAddons] = await Promise.all([
|
||||
usageResultPromise,
|
||||
this.#actorSubscriptionWithStatus(actor),
|
||||
this.#addonsForSettle(actor),
|
||||
(async () => {
|
||||
try {
|
||||
return await this.#addonsForSettle(actor);
|
||||
} catch (e) {
|
||||
settleReadError = e as Error;
|
||||
return null;
|
||||
}
|
||||
})(),
|
||||
]);
|
||||
const { policy: actorSubscription, provisionalUntil } =
|
||||
subscription;
|
||||
|
||||
const actorUsages = await this.exactUsageNearAllowance(
|
||||
userId,
|
||||
actorUsageKey,
|
||||
usageResult,
|
||||
actorSubscription.monthUsageAllowance,
|
||||
);
|
||||
let actorUsages: UsageByType;
|
||||
try {
|
||||
actorUsages = await this.exactUsageNearAllowance(
|
||||
userId,
|
||||
actorUsageKey,
|
||||
usageResult,
|
||||
actorSubscription.monthUsageAllowance,
|
||||
);
|
||||
} catch (e) {
|
||||
settleReadError ??= e as Error;
|
||||
actorUsages = usageResult.res as unknown as UsageByType;
|
||||
}
|
||||
|
||||
// After a failed read only the allowance share is charged:
|
||||
// purchased credit is never drawn against an unread balance.
|
||||
const readAddons = settleReadError ? null : actorAddons;
|
||||
const settledAllowanceUsed = await this.settleIncrementCharges(
|
||||
userId,
|
||||
actorUsageKey,
|
||||
actorUsages,
|
||||
actorSubscription,
|
||||
actorAddons,
|
||||
readAddons ?? ({} as UsageAddons),
|
||||
totalBatchCost,
|
||||
);
|
||||
// Before any hold this usage stands for is released.
|
||||
await this.stores.creditHold.bump(userId);
|
||||
|
||||
this.maybeAlertOveruse({
|
||||
actor,
|
||||
userId,
|
||||
actorUsages,
|
||||
actorSubscription,
|
||||
actorAddons,
|
||||
incrementCost: totalBatchCost,
|
||||
batchUsages: usages,
|
||||
});
|
||||
if (!readAddons) {
|
||||
const usedBefore = MeteringService.allowanceUsedBefore(
|
||||
actorUsages,
|
||||
actorSubscription.monthUsageAllowance,
|
||||
totalBatchCost,
|
||||
);
|
||||
this.#alarmSettleReadFailed(
|
||||
actor,
|
||||
settleReadError,
|
||||
Math.max(
|
||||
0,
|
||||
totalBatchCost - (settledAllowanceUsed - usedBefore),
|
||||
),
|
||||
);
|
||||
} else {
|
||||
this.maybeAlertOveruse({
|
||||
actor,
|
||||
userId,
|
||||
actorUsages,
|
||||
actorSubscription,
|
||||
actorAddons,
|
||||
incrementCost: totalBatchCost,
|
||||
batchUsages: usages,
|
||||
});
|
||||
|
||||
this.rememberRemainingCredits(
|
||||
userId,
|
||||
settledAllowanceUsed,
|
||||
actorSubscription,
|
||||
actorAddons,
|
||||
provisionalUntil,
|
||||
);
|
||||
this.rememberRemainingCredits(
|
||||
userId,
|
||||
settledAllowanceUsed,
|
||||
actorSubscription,
|
||||
actorAddons,
|
||||
provisionalUntil,
|
||||
);
|
||||
}
|
||||
|
||||
const own = this.#withDetail(actorUsages, usageResult.detail);
|
||||
const charged = await this.applyMonthlyCharges(
|
||||
@@ -2957,6 +2995,31 @@ export class MeteringService extends PuterService {
|
||||
return usedBefore + allowanceCharge;
|
||||
}
|
||||
|
||||
/**
|
||||
* One alarm id for every actor, so a store brownout is a single alarm with
|
||||
* a count. `unchargedCost` is what credit would have covered, had any been
|
||||
* left; nothing charges it later.
|
||||
*/
|
||||
#alarmSettleReadFailed(
|
||||
actor: Actor,
|
||||
error: Error | null,
|
||||
unchargedCost: number,
|
||||
): void {
|
||||
this.#unchargedSinceStart += unchargedCost;
|
||||
this.clients.alarm.create(
|
||||
'metering_settle_read_failed',
|
||||
'Metering settled usage to the allowance only: a balance read failed',
|
||||
{
|
||||
userId: actor.user?.uuid,
|
||||
appId: actor.effectiveApp?.uid,
|
||||
unchargedCost,
|
||||
unchargedSinceStart: this.#unchargedSinceStart,
|
||||
error: error ?? undefined,
|
||||
},
|
||||
'info',
|
||||
);
|
||||
}
|
||||
|
||||
private maybeAlertOveruse(ctx: {
|
||||
actor: Actor;
|
||||
userId: string;
|
||||
|
||||
@@ -55,10 +55,7 @@ import type { IConfig } from '../../types.js';
|
||||
*/
|
||||
|
||||
export type NotifWire =
|
||||
| 'notif.message'
|
||||
| 'notif.unreads'
|
||||
| 'notif.ack'
|
||||
| 'notif.removed';
|
||||
'notif.message' | 'notif.unreads' | 'notif.ack' | 'notif.removed';
|
||||
|
||||
export const NOTIF_DELIVERY_EVENT = 'outer.notif.delivery';
|
||||
|
||||
@@ -200,7 +197,7 @@ export class NotificationSocketAdapter {
|
||||
});
|
||||
}
|
||||
|
||||
/** One notification, in the shape `UIDesktop` has always received. */
|
||||
/** One notification, in the shape the GUI's socket listeners receive. */
|
||||
message(userId: number, uid: string, notification: unknown): void {
|
||||
const response = { uid, notification };
|
||||
if (this.#dispatched(userId, 'notif.message', response)) return;
|
||||
|
||||
@@ -17,6 +17,7 @@
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
import MockRedis from 'ioredis-mock';
|
||||
import { afterAll, beforeAll, describe, expect, it, vi } from 'vitest';
|
||||
import { v4 as uuidv4 } from 'uuid';
|
||||
import { makeActor, type Actor } from '../../core/actor.js';
|
||||
@@ -27,6 +28,16 @@ import { generateDefaultFsentries } from '../../util/userProvisioning.js';
|
||||
import { kv } from '../../util/kvSingleton.js';
|
||||
import { PermissionService } from './PermissionService.js';
|
||||
|
||||
// The servers here share one redis mock; start each on an empty one.
|
||||
const setupFreshServer = async (
|
||||
...args: Parameters<typeof setupTestServer>
|
||||
): Promise<PuterServer> => {
|
||||
const redis = new MockRedis();
|
||||
await redis.flushall();
|
||||
redis.disconnect();
|
||||
return setupTestServer(...args);
|
||||
};
|
||||
|
||||
/** `default_temp_group` from config.default.json. */
|
||||
const DEFAULT_TEMP_GROUP_UID = 'b7220104-7905-4985-b996-649fdcdb3c8f';
|
||||
|
||||
@@ -190,7 +201,7 @@ describe('PermissionService (integration)', () => {
|
||||
let permService: PermissionService;
|
||||
|
||||
beforeAll(async () => {
|
||||
server = await setupTestServer();
|
||||
server = await setupFreshServer();
|
||||
permService = server.services
|
||||
.permission as unknown as PermissionService;
|
||||
});
|
||||
@@ -1641,7 +1652,7 @@ describe('PermissionService — scan paths', () => {
|
||||
let permService: PermissionService;
|
||||
|
||||
beforeAll(async () => {
|
||||
server = await setupTestServer();
|
||||
server = await setupFreshServer();
|
||||
permService = server.services
|
||||
.permission as unknown as PermissionService;
|
||||
}, 60_000);
|
||||
@@ -1898,6 +1909,77 @@ describe('PermissionService — scan paths', () => {
|
||||
expect(await permService.check(originActor, permission)).toBe(true);
|
||||
expect(await permService.check(sharerActor, permission)).toBe(true);
|
||||
}, 20_000);
|
||||
|
||||
it('does not read a revoked group grant back from a lagging replica', async () => {
|
||||
const { row: issuer } = await makeGroupedUser();
|
||||
const { row: member, actor: memberActor } = await makeGroupedUser();
|
||||
const groupUid = uuidv4();
|
||||
await server.clients.db.write(
|
||||
'INSERT INTO `group` (`uid`, `owner_user_id`, `extra`, `metadata`) ' +
|
||||
'VALUES (?, ?, ?, ?)',
|
||||
[groupUid, issuer.id, '{}', '{}'],
|
||||
);
|
||||
const [group] = await server.clients.db.read(
|
||||
'SELECT `id` FROM `group` WHERE `uid` = ?',
|
||||
[groupUid],
|
||||
);
|
||||
await server.stores.group.addUsers(groupUid, [member.username]);
|
||||
|
||||
const permission = `zztest:lag-${uuidv4()}:ii:read`;
|
||||
await server.stores.permission.setFlatUserPerm(
|
||||
issuer.id,
|
||||
permission,
|
||||
{
|
||||
permission,
|
||||
deleted: false,
|
||||
issuer_user_id: issuer.id,
|
||||
} as never,
|
||||
);
|
||||
await server.clients.db.write(
|
||||
'INSERT INTO `user_to_group_permissions` ' +
|
||||
'(`user_id`, `group_id`, `permission`, `extra`) VALUES (?, ?, ?, ?)',
|
||||
[issuer.id, group.id, permission, '{}'],
|
||||
);
|
||||
expect(await permService.check(memberActor, permission)).toBe(true);
|
||||
|
||||
await server.stores.permission.deleteUserGroupPerm(
|
||||
Number(group.id),
|
||||
issuer.id,
|
||||
permission,
|
||||
);
|
||||
await permService.bumpPermissionCacheForUsernames([
|
||||
member.username,
|
||||
]);
|
||||
|
||||
// The replica still returns the row; the primary has deleted it.
|
||||
const db = server.clients.db;
|
||||
const primaryRead = db.read.bind(db);
|
||||
const pread = vi
|
||||
.spyOn(db, 'pread')
|
||||
.mockImplementation((sql, params) => primaryRead(sql, params));
|
||||
const read = vi
|
||||
.spyOn(db, 'read')
|
||||
.mockImplementation(async (sql, params) =>
|
||||
String(sql).includes('user_to_group_permissions')
|
||||
? [
|
||||
{
|
||||
permission,
|
||||
user_id: issuer.id,
|
||||
group_id: group.id,
|
||||
extra: '{}',
|
||||
},
|
||||
]
|
||||
: primaryRead(sql, params),
|
||||
);
|
||||
try {
|
||||
expect(await permService.check(memberActor, permission)).toBe(
|
||||
false,
|
||||
);
|
||||
} finally {
|
||||
read.mockRestore();
|
||||
pread.mockRestore();
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
describe('app-under-user grants', () => {
|
||||
@@ -2606,7 +2688,7 @@ describe('PermissionService — default user permissions vs. group config', () =
|
||||
// Self-hosted deployments may run without default groups. The floor
|
||||
// is not group-derived, so it applies regardless — a deployment that
|
||||
// clears both no longer has every driver call fail closed.
|
||||
const bare = await setupTestServer({
|
||||
const bare = await setupFreshServer({
|
||||
default_user_group: '',
|
||||
default_temp_group: '',
|
||||
} as never);
|
||||
|
||||
@@ -1155,9 +1155,13 @@ export class PermissionService extends PuterService {
|
||||
}
|
||||
|
||||
/** Batched: one event for the whole group, not one per member. */
|
||||
async #bumpGroupCacheGeneration(groupId: number): Promise<void> {
|
||||
async #bumpGroupCacheGeneration(
|
||||
groupId: number,
|
||||
memberUuids?: string[],
|
||||
): Promise<void> {
|
||||
const uuids =
|
||||
await this.stores.permission.listGroupMemberUuids(groupId);
|
||||
memberUuids ??
|
||||
(await this.stores.permission.listGroupMemberUuids(groupId));
|
||||
if (uuids.length === 0) return;
|
||||
await this.stores.permission.bumpCacheGenerations(
|
||||
uuids.map((uuid) => `user:${uuid}`),
|
||||
@@ -1238,11 +1242,12 @@ export class PermissionService extends PuterService {
|
||||
|
||||
await this.#assertCanManage(actor, permission);
|
||||
|
||||
const revoked = await this.stores.permission.deleteUserGroupPerm(
|
||||
groupId,
|
||||
issuerId,
|
||||
permission,
|
||||
);
|
||||
const { removed: revoked, members } =
|
||||
await this.stores.permission.deleteUserGroupPerm(
|
||||
groupId,
|
||||
issuerId,
|
||||
permission,
|
||||
);
|
||||
|
||||
this.#audit(
|
||||
this.stores.permission.auditUserGroupPerm({
|
||||
@@ -1257,15 +1262,18 @@ export class PermissionService extends PuterService {
|
||||
);
|
||||
|
||||
// Bumped even when nothing matched: a cached allow must not survive.
|
||||
await this.#bumpGroupCacheGeneration(groupId);
|
||||
await this.#bumpGroupCacheGeneration(
|
||||
groupId,
|
||||
members
|
||||
.map((member) => member.uuid)
|
||||
.filter((uuid): uuid is string => Boolean(uuid)),
|
||||
);
|
||||
|
||||
// Nothing but the membership names the holders, so without this their
|
||||
// watches outlive the revoke.
|
||||
if (revoked) {
|
||||
for (const memberId of await this.stores.permission.listGroupMemberIds(
|
||||
groupId,
|
||||
)) {
|
||||
this.#announceRevoked(memberId, null, permission);
|
||||
for (const member of members) {
|
||||
this.#announceRevoked(member.id, null, permission);
|
||||
}
|
||||
}
|
||||
return revoked;
|
||||
|
||||
@@ -2354,6 +2354,35 @@ describe('OpenAIRealtimeRelayService relay', () => {
|
||||
b.ws.close();
|
||||
});
|
||||
|
||||
it('evicts an access token revoked on another node', async () => {
|
||||
const row = await server.stores.user.getByUsername(user.username);
|
||||
const actor = makeActor({ user: row! });
|
||||
const token = await server.services.auth.createAccessToken(actor, [
|
||||
[FULL_API_ACCESS],
|
||||
]);
|
||||
const { token_uid } = server.services.token.verify<{
|
||||
token_uid: string;
|
||||
}>('auth', token);
|
||||
const c = open(`${relayUrl}?auth_token=${token}`);
|
||||
await c.waitFor('session.created');
|
||||
|
||||
// As a peer cluster delivers it, after a malformed payload it ignores.
|
||||
server.clients.event.emit(
|
||||
'outer.auth.access-token.revoked',
|
||||
{ token_uid: 42 } as never,
|
||||
{ from_outside: true },
|
||||
);
|
||||
server.clients.event.emit(
|
||||
'outer.auth.access-token.revoked',
|
||||
{ token_uid },
|
||||
{ from_outside: true },
|
||||
);
|
||||
expect(await c.waitFor('error')).toMatchObject({
|
||||
error: { code: 'invalid_api_key' },
|
||||
});
|
||||
await c.closed;
|
||||
});
|
||||
|
||||
it('closes with a retryable error after a sustained verification outage', async () => {
|
||||
const c = open(`${relayUrl}?auth_token=${user.token}`);
|
||||
await c.waitFor('session.created');
|
||||
|
||||
@@ -838,13 +838,19 @@ export class OpenAIRealtimeRelayService extends PuterService {
|
||||
{},
|
||||
);
|
||||
});
|
||||
this.clients.event.on('auth.access-token.revoked', (_key, data) => {
|
||||
this.clients.event.emit(
|
||||
'pubsub.realtime.auth-revoked',
|
||||
{ tokenUid: data.token_uid },
|
||||
{},
|
||||
);
|
||||
});
|
||||
this.clients.event.on(
|
||||
'outer.auth.access-token.revoked',
|
||||
(_key, data) => {
|
||||
const tokenUid = (data as { token_uid?: unknown } | null)
|
||||
?.token_uid;
|
||||
if (typeof tokenUid !== 'string' || !tokenUid) return;
|
||||
this.clients.event.emit(
|
||||
'pubsub.realtime.auth-revoked',
|
||||
{ tokenUid },
|
||||
{},
|
||||
);
|
||||
},
|
||||
);
|
||||
// Raw WebSockets do not participate in socket.io's cluster adapter.
|
||||
this.clients.event.on('pubsub.realtime.auth-revoked', (_key, data) => {
|
||||
const revoked = data.sessionUids
|
||||
|
||||
@@ -1270,9 +1270,13 @@ describe('ShareService', () => {
|
||||
expect(listByFsentry).not.toHaveBeenCalled();
|
||||
expect(getEntriesByIds).not.toHaveBeenCalled();
|
||||
const prefixes = [`fs:${file.uuid}`, `manage:fs:${file.uuid}`];
|
||||
expect(revokeUserGrants).toHaveBeenCalledWith(prefixes);
|
||||
expect(revokeGroupGrants).toHaveBeenCalledWith(prefixes);
|
||||
expect(deleteRows).toHaveBeenCalledWith([file.id]);
|
||||
expect(revokeUserGrants).toHaveBeenCalledWith(prefixes, {
|
||||
primary: true,
|
||||
});
|
||||
expect(revokeGroupGrants).toHaveBeenCalledWith(prefixes, {
|
||||
primary: true,
|
||||
});
|
||||
expect(deleteRows).toHaveBeenCalledWith([file.id], [file.uuid]);
|
||||
// Grants go before the rows that record them.
|
||||
expect(
|
||||
revokeUserGrants.mock.invocationCallOrder[0]!,
|
||||
|
||||
@@ -19,7 +19,7 @@
|
||||
|
||||
import { dirname as pathDirname } from 'node:path/posix';
|
||||
import { v4 as uuidv4 } from 'uuid';
|
||||
import { afterAll, beforeAll, describe, expect, it } from 'vitest';
|
||||
import { afterAll, beforeAll, describe, expect, it, vi } from 'vitest';
|
||||
import type { Actor } from '../../core/actor.js';
|
||||
import { runWithContext } from '../../core/context.js';
|
||||
import { PuterServer } from '../../server.js';
|
||||
@@ -240,6 +240,161 @@ describe('ShareService: deleting a shared item', () => {
|
||||
);
|
||||
});
|
||||
|
||||
it('reads no grants or shares from the primary for an owner with nothing shared', async () => {
|
||||
const owner = await makeUser();
|
||||
const { dir } = await makeDirWithFile(owner.user);
|
||||
const trash = await dirAt(`/${owner.user.username}/Trash`);
|
||||
|
||||
const pread = vi.spyOn(server.clients.db, 'pread');
|
||||
try {
|
||||
await move(owner, dir, trash);
|
||||
const retireReads = pread.mock.calls
|
||||
.map(([sql]) => String(sql))
|
||||
.filter((sql) =>
|
||||
/`user_to_user_permissions`|`user_to_group_permissions`|FROM `share`/u.test(
|
||||
sql,
|
||||
),
|
||||
);
|
||||
expect(retireReads).toEqual([]);
|
||||
} finally {
|
||||
pread.mockRestore();
|
||||
}
|
||||
});
|
||||
|
||||
it('withdraws a share made just now that the replica has not seen', async () => {
|
||||
const owner = await makeUser();
|
||||
const recipient = await makeUser();
|
||||
const { dir, file } = await makeDirWithFile(owner.user);
|
||||
await share(owner.actor, {
|
||||
uid: dir.uuid,
|
||||
recipient: { username: recipient.user.username },
|
||||
mode: 'read',
|
||||
});
|
||||
expect(await canRead(recipient.actor, file.path)).toBe(true);
|
||||
const trash = await dirAt(`/${owner.user.username}/Trash`);
|
||||
|
||||
// The replica has neither the grant nor the share row yet.
|
||||
const db = server.clients.db;
|
||||
const primaryRead = db.read.bind(db);
|
||||
const pread = vi.spyOn(db, 'pread').mockImplementation(primaryRead);
|
||||
const read = vi
|
||||
.spyOn(db, 'read')
|
||||
.mockImplementation(async (sql, params) =>
|
||||
/`user_to_user_permissions`|FROM `share`/u.test(String(sql))
|
||||
? []
|
||||
: primaryRead(sql, params),
|
||||
);
|
||||
let moved;
|
||||
try {
|
||||
moved = await move(owner, dir, trash);
|
||||
} finally {
|
||||
read.mockRestore();
|
||||
pread.mockRestore();
|
||||
}
|
||||
|
||||
expect(
|
||||
await canRead(recipient.actor, `${moved.path}/${file.name}`),
|
||||
).toBe(false);
|
||||
expect(
|
||||
await server.stores.share.listAllByFsentrySubtree(dir.id),
|
||||
).toEqual([]);
|
||||
});
|
||||
|
||||
it("does not honour a lagging replica's copy of a link the delete removed", async () => {
|
||||
const owner = await makeUser();
|
||||
const stranger = await makeUser();
|
||||
const { dir, file } = await makeDirWithFile(owner.user);
|
||||
// The owner's plan covers link sharing.
|
||||
const plan = vi
|
||||
.spyOn(server.services.metering, 'getActorSubscription')
|
||||
.mockResolvedValue({ id: 'business' } as never);
|
||||
await server.stores.share.upsertAnyone({
|
||||
issuerUserId: owner.user.id,
|
||||
fsentryId: dir.id,
|
||||
mode: 'read',
|
||||
});
|
||||
expect(await canRead(stranger.actor, file.path)).toBe(true);
|
||||
|
||||
const trash = await dirAt(`/${owner.user.username}/Trash`);
|
||||
const moved = await move(owner, dir, trash);
|
||||
|
||||
// The replica still has the link row the primary just deleted.
|
||||
const db = server.clients.db;
|
||||
const primaryRead = db.read.bind(db);
|
||||
const pread = vi.spyOn(db, 'pread').mockImplementation(primaryRead);
|
||||
const read = vi
|
||||
.spyOn(db, 'read')
|
||||
.mockImplementation(async (sql, params) =>
|
||||
String(sql).includes('`share`.`anyone` = 1')
|
||||
? [
|
||||
{
|
||||
mode: 'read',
|
||||
entry_uuid: dir.uuid,
|
||||
owner_user_id: owner.user.id,
|
||||
},
|
||||
]
|
||||
: primaryRead(sql, params),
|
||||
);
|
||||
try {
|
||||
expect(
|
||||
await canRead(stranger.actor, `${moved.path}/${file.name}`),
|
||||
).toBe(false);
|
||||
} finally {
|
||||
read.mockRestore();
|
||||
pread.mockRestore();
|
||||
plan.mockRestore();
|
||||
}
|
||||
});
|
||||
|
||||
it("drops a team member's cached access when the replica lacks them", async () => {
|
||||
const owner = await makeUser();
|
||||
const member = await makeUser();
|
||||
const file = await makeFile(owner.user);
|
||||
const groupUid = uuidv4();
|
||||
await server.clients.db.write(
|
||||
'INSERT INTO `group` (`uid`, `owner_user_id`, `kind`, `name`, ' +
|
||||
'`extra`, `metadata`) VALUES (?, ?, ?, ?, ?, ?)',
|
||||
[groupUid, owner.user.id, 'team', 'Team', '{}', '{}'],
|
||||
);
|
||||
const [group] = (await server.clients.db.read(
|
||||
'SELECT id FROM `group` WHERE uid = ?',
|
||||
[groupUid],
|
||||
)) as { id: number }[];
|
||||
await server.clients.db.write(
|
||||
'INSERT INTO `jct_user_group` (`user_id`, `group_id`) VALUES (?, ?)',
|
||||
[member.user.id, group.id],
|
||||
);
|
||||
await server.stores.permission.upsertUserGroupPerm(
|
||||
Number(group.id),
|
||||
owner.user.id,
|
||||
`fs:${file.uuid}:read`,
|
||||
{},
|
||||
);
|
||||
|
||||
// The replica has not seen the member join yet.
|
||||
const db = server.clients.db;
|
||||
const primaryRead = db.read.bind(db);
|
||||
const pread = vi.spyOn(db, 'pread').mockImplementation(primaryRead);
|
||||
const read = vi
|
||||
.spyOn(db, 'read')
|
||||
.mockImplementation(async (sql, params) =>
|
||||
String(sql).includes('jct_user_group')
|
||||
? []
|
||||
: primaryRead(sql, params),
|
||||
);
|
||||
const bump = vi.spyOn(server.stores.permission, 'bumpCacheGenerations');
|
||||
try {
|
||||
await server.services.share.onEntryDeleted(file.uuid);
|
||||
expect(bump.mock.calls.flat(2)).toContain(
|
||||
`user:${member.user.uuid}`,
|
||||
);
|
||||
} finally {
|
||||
bump.mockRestore();
|
||||
read.mockRestore();
|
||||
pread.mockRestore();
|
||||
}
|
||||
});
|
||||
|
||||
it('does not answer whether a name is already in the owner\'s Trash', async () => {
|
||||
const owner = await makeUser();
|
||||
const recipient = await makeUser();
|
||||
|
||||
@@ -292,6 +292,9 @@ export const modeFromEntryPermission = (permission: string): string | null => {
|
||||
*/
|
||||
const RETIRE_CHUNK_SIZE = 100;
|
||||
|
||||
/** How long after an owner shares the retire reads stay on the primary. */
|
||||
const RECENT_SHARE_WINDOW_MS = 30_000;
|
||||
|
||||
/** Shares one user may create per UTC day, absent a config override. */
|
||||
export const DEFAULT_DAILY_SHARE_LIMIT = 200;
|
||||
|
||||
@@ -397,6 +400,11 @@ export class ShareService extends PuterService {
|
||||
* fleet-wide; its TTL covers a process the bump missed.
|
||||
*/
|
||||
readonly #ownerShares = new SubscriptionCache();
|
||||
/** Owners who shared just now: a replica may not have the row yet. */
|
||||
readonly #recentSharers = new SubscriptionCache(
|
||||
undefined,
|
||||
RECENT_SHARE_WINDOW_MS,
|
||||
);
|
||||
readonly #ownerLookups = new Map<string, Promise<boolean>>();
|
||||
|
||||
/**
|
||||
@@ -619,6 +627,11 @@ export class ShareService extends PuterService {
|
||||
const chunk = entries.slice(i, i + RETIRE_CHUNK_SIZE);
|
||||
const removed = await this.onEntryDeleted(
|
||||
chunk.map((entry) => entry.uuid),
|
||||
{
|
||||
primary: this.#sharedRecently(
|
||||
chunk.map((entry) => entry.userId),
|
||||
),
|
||||
},
|
||||
);
|
||||
|
||||
const holdersByEntry = new Map<string, Set<number>>();
|
||||
@@ -932,6 +945,16 @@ export class ShareService extends PuterService {
|
||||
this.#ownerShares.generationOf(ownerUserId),
|
||||
true,
|
||||
);
|
||||
this.#recentSharers.write(
|
||||
ownerUserId,
|
||||
this.#recentSharers.generationOf(ownerUserId),
|
||||
true,
|
||||
);
|
||||
}
|
||||
|
||||
/** Whether this process heard any of these owners share within the window. */
|
||||
#sharedRecently(ownerUserIds: number[]): boolean {
|
||||
return ownerUserIds.some((id) => this.#recentSharers.read(id) === true);
|
||||
}
|
||||
|
||||
async #emitGui(
|
||||
@@ -1555,7 +1578,9 @@ export class ShareService extends PuterService {
|
||||
// Every row, not just the applied ones: a node whose only share is a
|
||||
// pending invite or a team grant is exactly what the group and invite
|
||||
// sweeps ask about.
|
||||
const rows = await this.stores.share.listAllByFsentrySubtree(entry.id);
|
||||
const rows = await this.stores.share.listAllByFsentrySubtree(entry.id, {
|
||||
primary: true,
|
||||
});
|
||||
const nodes = await this.stores.fsEntry.getEntriesByIds(
|
||||
rows.map((row: { fsentry_id: number }) => Number(row.fsentry_id)),
|
||||
);
|
||||
@@ -1779,9 +1804,13 @@ export class ShareService extends PuterService {
|
||||
/**
|
||||
* Retire the grants pointing at a node that no longer exists. Returns the
|
||||
* rows removed, which is the only record of who had access — the index rows
|
||||
* cascade away with the fsentry.
|
||||
* cascade away with the fsentry. Reads a replica unless `primary` says a
|
||||
* grant may be too new for one.
|
||||
*/
|
||||
async onEntryDeleted(entryUids: string | string[]): Promise<
|
||||
async onEntryDeleted(
|
||||
entryUids: string | string[],
|
||||
{ primary = false }: { primary?: boolean } = {},
|
||||
): Promise<
|
||||
Array<{
|
||||
holder_user_id: number;
|
||||
issuer_user_id: number;
|
||||
@@ -1796,6 +1825,7 @@ export class ShareService extends PuterService {
|
||||
const removed =
|
||||
await this.stores.permission.deleteUserUserPermsByPermissionPrefixes(
|
||||
uids.flatMap((uid) => [`fs:${uid}`, `manage:fs:${uid}`]),
|
||||
{ primary },
|
||||
);
|
||||
|
||||
// Retiring the rows is not enough: a holder's cached scan still answers
|
||||
@@ -1808,19 +1838,14 @@ export class ShareService extends PuterService {
|
||||
|
||||
// Group grants on the same node, and their members' caches: without
|
||||
// this they outlive the file and keep answering "allowed".
|
||||
const removedGroups =
|
||||
const { members } =
|
||||
await this.stores.permission.deleteUserGroupPermsByPermissionPrefixes(
|
||||
uids.flatMap((uid) => [`fs:${uid}`, `manage:fs:${uid}`]),
|
||||
{ primary },
|
||||
);
|
||||
const memberUuids = (
|
||||
await Promise.all(
|
||||
[...new Set(removedGroups.map((row) => Number(row.group_id)))]
|
||||
.filter((id) => Number.isFinite(id))
|
||||
.map((id) =>
|
||||
this.stores.permission.listGroupMemberUuids(id),
|
||||
),
|
||||
)
|
||||
).flat();
|
||||
const memberUuids = members
|
||||
.map((member) => member.uuid)
|
||||
.filter((uuid): uuid is string => Boolean(uuid));
|
||||
|
||||
await this.stores.permission.bumpCacheGenerations([
|
||||
...new Set([
|
||||
@@ -1877,15 +1902,23 @@ export class ShareService extends PuterService {
|
||||
* the subtree stands on its own, and one left behind keeps granting the
|
||||
* issuer's recipients access under an owner who never agreed to them.
|
||||
*/
|
||||
async onEntryOwnerChanged(entry: FSEntry): Promise<void> {
|
||||
async onEntryOwnerChanged(
|
||||
entry: FSEntry,
|
||||
{ primary = true }: { primary?: boolean } = {},
|
||||
): Promise<void> {
|
||||
// A file's share rows can only name the file itself, so there is
|
||||
// nothing to list or hydrate.
|
||||
if (!entry.isDir) {
|
||||
await this.onEntryDeleted([entry.uuid]);
|
||||
await this.stores.share.deleteByFsentryIds([entry.id]);
|
||||
await this.onEntryDeleted([entry.uuid], { primary });
|
||||
await this.stores.share.deleteByFsentryIds(
|
||||
[entry.id],
|
||||
[entry.uuid],
|
||||
);
|
||||
return;
|
||||
}
|
||||
const rows = await this.stores.share.listAllByFsentrySubtree(entry.id);
|
||||
const rows = await this.stores.share.listAllByFsentrySubtree(entry.id, {
|
||||
primary,
|
||||
});
|
||||
const fsentryIds = [
|
||||
...new Set([
|
||||
entry.id,
|
||||
@@ -1897,8 +1930,8 @@ export class ShareService extends PuterService {
|
||||
|
||||
const nodes = await this.stores.fsEntry.getEntriesByIds(fsentryIds);
|
||||
const uuids = [...nodes.values()].map((node) => node.uuid);
|
||||
if (uuids.length > 0) await this.onEntryDeleted(uuids);
|
||||
await this.stores.share.deleteByFsentryIds(fsentryIds);
|
||||
if (uuids.length > 0) await this.onEntryDeleted(uuids, { primary });
|
||||
await this.stores.share.deleteByFsentryIds(fsentryIds, uuids);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -1913,7 +1946,11 @@ export class ShareService extends PuterService {
|
||||
async onEntryTrashed(entry: FSEntry): Promise<void> {
|
||||
// The same sweep as a change of owner: every kind of row in the
|
||||
// subtree, since a link share deeper down grants access on its own.
|
||||
await this.onEntryOwnerChanged(entry);
|
||||
// Nearly every trashed entry has no shares, so the reads stay off the
|
||||
// primary unless its owner shared just now.
|
||||
await this.onEntryOwnerChanged(entry, {
|
||||
primary: this.#sharedRecently([entry.userId]),
|
||||
});
|
||||
}
|
||||
|
||||
// -- Reads --------------------------------------------------------
|
||||
@@ -3015,6 +3052,7 @@ export class ShareService extends PuterService {
|
||||
mode,
|
||||
issuerAppUid: this.#actingAppUid(actor),
|
||||
});
|
||||
this.#ownerShared(entry.userId);
|
||||
return {
|
||||
...this.#resolve(row, entry, actor, { username: null }),
|
||||
anyone: true,
|
||||
@@ -3314,6 +3352,7 @@ export class ShareService extends PuterService {
|
||||
mode,
|
||||
issuerAppUid: this.#actingAppUid(actor),
|
||||
});
|
||||
this.#ownerShared(entry.userId);
|
||||
return {
|
||||
...this.#resolve(row, entry, actor, { username: null }),
|
||||
pending: true,
|
||||
|
||||
@@ -428,6 +428,43 @@ describe('SocketService (live socket.io)', () => {
|
||||
sessionSocket.disconnect();
|
||||
});
|
||||
|
||||
it('drops a token`s socket on a revocation that reached it from elsewhere', async () => {
|
||||
const row = await server.stores.user.getByUsername(user.username);
|
||||
const actor = makeActor({ user: row as never });
|
||||
const doomed = await runWithContext({ actor }, () =>
|
||||
server.services.auth.createAccessToken(actor, [[FULL_API_ACCESS]], {
|
||||
label: 'revoke-fanout-probe',
|
||||
}),
|
||||
);
|
||||
const { token_uid } = server.services.token.verify<{
|
||||
token_uid: string;
|
||||
}>('auth', doomed);
|
||||
const tokenSocket = await connect({ auth_token: doomed });
|
||||
expect(tokenSocket.connected).toBe(true);
|
||||
|
||||
// A malformed peer payload is ignored.
|
||||
for (const data of [null, {}, { token_uid: 42 }]) {
|
||||
server.clients.event.emit(
|
||||
'outer.auth.access-token.revoked',
|
||||
data as never,
|
||||
{ from_outside: true },
|
||||
);
|
||||
}
|
||||
await new Promise((r) => setTimeout(r, 200));
|
||||
expect(tokenSocket.connected).toBe(true);
|
||||
|
||||
// As a peer cluster delivers it: the token was revoked on another node.
|
||||
server.clients.event.emit(
|
||||
'outer.auth.access-token.revoked',
|
||||
{ token_uid },
|
||||
{ from_outside: true },
|
||||
);
|
||||
|
||||
await vi.waitFor(() => expect(tokenSocket.connected).toBe(false), {
|
||||
timeout: 5000,
|
||||
});
|
||||
});
|
||||
|
||||
it('rejects an app-under-user token while events are off', async () => {
|
||||
const row = await server.stores.user.getByUsername(user.username);
|
||||
const appUid = `app-${uuidv4()}`;
|
||||
@@ -926,6 +963,31 @@ describe('SocketService (live socket.io)', () => {
|
||||
socket.disconnect();
|
||||
});
|
||||
|
||||
it('keeps a connection up when its re-check lookup fails', async () => {
|
||||
const user = await createTestUser(server, {
|
||||
username: 'sock-lookup-down',
|
||||
password: 'sock-lookup-down-password',
|
||||
});
|
||||
const socket = await connect({ auth_token: `Bearer ${user.token}` });
|
||||
const authenticate = vi
|
||||
.spyOn(server.services.auth, 'authenticate')
|
||||
.mockRejectedValue(
|
||||
Object.assign(new Error('Database operation failed'), {
|
||||
code: 'dbBatchFailed',
|
||||
}),
|
||||
);
|
||||
const warn = vi.spyOn(console, 'warn').mockImplementation(() => {});
|
||||
try {
|
||||
await socketService.reauthenticateSockets();
|
||||
await new Promise((r) => setTimeout(r, 200));
|
||||
expect(socket.connected).toBe(true);
|
||||
} finally {
|
||||
authenticate.mockRestore();
|
||||
warn.mockRestore();
|
||||
socket.disconnect();
|
||||
}
|
||||
});
|
||||
|
||||
it('re-checks without recording session activity', async () => {
|
||||
const idle = await createTestUser(server, {
|
||||
username: 'sock-idle',
|
||||
|
||||
@@ -982,15 +982,22 @@ export class SocketService extends PuterService {
|
||||
},
|
||||
);
|
||||
const decisions = new Map<string, SocketAuthDecision>();
|
||||
let unchecked = 0;
|
||||
checked.forEach((token, i) => {
|
||||
const outcome = outcomes[i];
|
||||
decisions.set(
|
||||
token,
|
||||
outcome?.status === 'fulfilled'
|
||||
? outcome.value
|
||||
: { reject: new Error('socket reauth failed') },
|
||||
);
|
||||
// A lookup that failed says nothing about the credential, so its
|
||||
// sockets stay up until a later sweep gets an answer.
|
||||
if (outcome?.status === 'fulfilled') {
|
||||
decisions.set(token, outcome.value);
|
||||
} else {
|
||||
unchecked++;
|
||||
}
|
||||
});
|
||||
if (unchecked > 0) {
|
||||
console.warn(
|
||||
`[socket] reauth sweep could not check ${unchecked} credential(s)`,
|
||||
);
|
||||
}
|
||||
|
||||
for (const socket of sockets) {
|
||||
const decision = socket.authToken
|
||||
@@ -1175,10 +1182,12 @@ export class SocketService extends PuterService {
|
||||
);
|
||||
|
||||
this.clients.event.on(
|
||||
'auth.access-token.revoked',
|
||||
'outer.auth.access-token.revoked',
|
||||
(_key: string, data: unknown) => {
|
||||
const { token_uid } = data as { token_uid: string };
|
||||
this.#evictAccessTokenSockets(token_uid).catch(
|
||||
const tokenUid = (data as { token_uid?: unknown } | null)
|
||||
?.token_uid;
|
||||
if (typeof tokenUid !== 'string') return;
|
||||
this.#evictAccessTokenSockets(tokenUid).catch(
|
||||
(err: unknown) => {
|
||||
console.error('[socket] token eviction failed', err);
|
||||
},
|
||||
|
||||
@@ -64,6 +64,29 @@ describe('PermissionStore', () => {
|
||||
);
|
||||
};
|
||||
|
||||
/** Replica reads of `table` see `stale`; the primary stays real. */
|
||||
const lagReplica = (
|
||||
table: string,
|
||||
stale: (sql: string) => Record<string, unknown>[],
|
||||
) => {
|
||||
const db = server.clients.db;
|
||||
const primaryRead = db.read.bind(db);
|
||||
const pread = vi
|
||||
.spyOn(db, 'pread')
|
||||
.mockImplementation((sql, params) => primaryRead(sql, params));
|
||||
const read = vi
|
||||
.spyOn(db, 'read')
|
||||
.mockImplementation(async (sql, params) =>
|
||||
String(sql).includes(table)
|
||||
? stale(String(sql))
|
||||
: primaryRead(sql, params),
|
||||
);
|
||||
return () => {
|
||||
read.mockRestore();
|
||||
pread.mockRestore();
|
||||
};
|
||||
};
|
||||
|
||||
// -- Flat KV view --------------------------------------------------
|
||||
|
||||
describe('flat user permissions (KV view)', () => {
|
||||
@@ -911,6 +934,341 @@ describe('PermissionStore', () => {
|
||||
expect(await store.readUserGroupPerms(user.id, [])).toEqual([]);
|
||||
});
|
||||
|
||||
it('does not read a revoked grant back from a lagging replica', async () => {
|
||||
const issuer = await makeUser();
|
||||
const member = await makeUser();
|
||||
const groupId = await seedGroup(issuer.id);
|
||||
await server.clients.db.write(
|
||||
'INSERT INTO `jct_user_group` (`user_id`, `group_id`) VALUES (?, ?)',
|
||||
[member.id, groupId],
|
||||
);
|
||||
await seedGroupPerm(issuer.id, groupId, 'fs:lag:read');
|
||||
const [stale] = await store.readUserGroupPerms(member.id, [
|
||||
'fs:lag:read',
|
||||
]);
|
||||
const [staleForHolder] = await store.readUserGroupPermsForHolders(
|
||||
[member.id],
|
||||
['fs:lag:read'],
|
||||
);
|
||||
|
||||
await store.deleteUserGroupPerm(groupId, issuer.id, 'fs:lag:read');
|
||||
|
||||
// The replica still has the row the primary just deleted.
|
||||
const restore = lagReplica('user_to_group_permissions', (sql) =>
|
||||
sql.includes('holder_user_id')
|
||||
? [staleForHolder]
|
||||
: [{ ...stale, extra: '{}' }],
|
||||
);
|
||||
try {
|
||||
expect(
|
||||
await store.readUserGroupPerms(member.id, ['fs:lag:read']),
|
||||
).toEqual([]);
|
||||
expect(
|
||||
await store.readUserGroupPermsForHolders(
|
||||
[member.id],
|
||||
['fs:lag:read'],
|
||||
),
|
||||
).toEqual([]);
|
||||
} finally {
|
||||
restore();
|
||||
}
|
||||
});
|
||||
|
||||
it('does not read grants removed with their node back from a lagging replica', async () => {
|
||||
const issuer = await makeUser();
|
||||
const member = await makeUser();
|
||||
const groupId = await seedGroup(issuer.id);
|
||||
await server.clients.db.write(
|
||||
'INSERT INTO `jct_user_group` (`user_id`, `group_id`) VALUES (?, ?)',
|
||||
[member.id, groupId],
|
||||
);
|
||||
const node = uuidv4();
|
||||
await seedGroupPerm(issuer.id, groupId, `fs:${node}:read`);
|
||||
const [stale] = await store.readUserGroupPerms(member.id, [
|
||||
`fs:${node}:read`,
|
||||
]);
|
||||
|
||||
await store.deleteUserGroupPermsByPermissionPrefixes([
|
||||
`fs:${node}`,
|
||||
]);
|
||||
|
||||
const restore = lagReplica('user_to_group_permissions', () => [
|
||||
{ ...stale, extra: '{}' },
|
||||
]);
|
||||
try {
|
||||
expect(
|
||||
await store.readUserGroupPerms(member.id, [
|
||||
`fs:${node}:read`,
|
||||
]),
|
||||
).toEqual([]);
|
||||
} finally {
|
||||
restore();
|
||||
}
|
||||
});
|
||||
|
||||
it('removes a grant the replica has not seen yet with its node, when asked to read the primary', async () => {
|
||||
const issuer = await makeUser();
|
||||
const groupId = await seedGroup(issuer.id);
|
||||
const node = uuidv4();
|
||||
await seedGroupPerm(issuer.id, groupId, `fs:${node}:read`);
|
||||
|
||||
const restore = lagReplica('user_to_group_permissions', () => []);
|
||||
let unasked;
|
||||
let removed;
|
||||
try {
|
||||
unasked = await store.deleteUserGroupPermsByPermissionPrefixes([
|
||||
`fs:${node}`,
|
||||
]);
|
||||
removed = await store.deleteUserGroupPermsByPermissionPrefixes(
|
||||
[`fs:${node}`],
|
||||
{ primary: true },
|
||||
);
|
||||
} finally {
|
||||
restore();
|
||||
}
|
||||
// Unasked, the replica's answer stands and the primary is left alone.
|
||||
expect(unasked?.rows).toEqual([]);
|
||||
expect(removed?.rows).toEqual([
|
||||
{ group_id: groupId, permission: `fs:${node}:read` },
|
||||
]);
|
||||
expect(
|
||||
await store.queryIssuerGroupPermsByPrefix(
|
||||
issuer.id,
|
||||
groupId,
|
||||
`fs:${node}`,
|
||||
),
|
||||
).toEqual([]);
|
||||
});
|
||||
|
||||
it('sends a former member to the primary once membership changes', async () => {
|
||||
const issuer = await makeUser();
|
||||
const member = await makeUser();
|
||||
const groupId = await seedGroup(issuer.id);
|
||||
await server.clients.db.write(
|
||||
'INSERT INTO `jct_user_group` (`user_id`, `group_id`) VALUES (?, ?)',
|
||||
[member.id, groupId],
|
||||
);
|
||||
await seedGroupPerm(issuer.id, groupId, 'fs:left:read');
|
||||
const [stale] = await store.readUserGroupPerms(member.id, [
|
||||
'fs:left:read',
|
||||
]);
|
||||
await server.clients.db.write(
|
||||
'DELETE FROM `jct_user_group` WHERE `user_id` = ? AND `group_id` = ?',
|
||||
[member.id, groupId],
|
||||
);
|
||||
|
||||
const emit = vi.spyOn(server.clients.event, 'emit');
|
||||
try {
|
||||
await store.markGroupMembershipChanged([member.id]);
|
||||
// Only tombstones go out; there is no cached value to drop.
|
||||
const sent = emit.mock.calls
|
||||
.filter(([name]) => name === 'outer.cacheUpdate')
|
||||
.flatMap(
|
||||
([, data]) => (data as { cacheKey: string[] }).cacheKey,
|
||||
);
|
||||
expect(sent).toEqual([
|
||||
`perms:u2g:${member.id}${CACHE_TOMBSTONE_SUFFIX}`,
|
||||
]);
|
||||
} finally {
|
||||
emit.mockRestore();
|
||||
}
|
||||
|
||||
const restore = lagReplica('user_to_group_permissions', () => [
|
||||
{ ...stale, extra: '{}' },
|
||||
]);
|
||||
try {
|
||||
expect(
|
||||
await store.readUserGroupPerms(member.id, ['fs:left:read']),
|
||||
).toEqual([]);
|
||||
} finally {
|
||||
restore();
|
||||
}
|
||||
});
|
||||
|
||||
const seedMember = async (issuerId: number, permission: string) => {
|
||||
const member = await makeUser();
|
||||
const groupId = await seedGroup(issuerId);
|
||||
await server.clients.db.write(
|
||||
'INSERT INTO `jct_user_group` (`user_id`, `group_id`) VALUES (?, ?)',
|
||||
[member.id, groupId],
|
||||
);
|
||||
await seedGroupPerm(issuerId, groupId, permission);
|
||||
return { member, groupId };
|
||||
};
|
||||
|
||||
const tombstoneSet = async (userId: number) =>
|
||||
(await server.clients.redis.exists(
|
||||
`perms:u2g:${userId}${CACHE_TOMBSTONE_SUFFIX}`,
|
||||
)) > 0;
|
||||
|
||||
it('sends member reads to the primary before the grant is deleted', async () => {
|
||||
const issuer = await makeUser();
|
||||
const node = uuidv4();
|
||||
const one = await seedMember(issuer.id, 'fs:order:read');
|
||||
const many = await seedMember(issuer.id, `fs:${node}:read`);
|
||||
|
||||
const db = server.clients.db;
|
||||
const primaryWrite = db.write.bind(db);
|
||||
const seen: boolean[] = [];
|
||||
const write = vi
|
||||
.spyOn(db, 'write')
|
||||
.mockImplementation(async (sql, params) => {
|
||||
if (String(sql).startsWith('DELETE FROM')) {
|
||||
seen.push(
|
||||
(await tombstoneSet(one.member.id)) ||
|
||||
(await tombstoneSet(many.member.id)),
|
||||
);
|
||||
}
|
||||
return primaryWrite(sql, params);
|
||||
});
|
||||
try {
|
||||
await store.deleteUserGroupPerm(
|
||||
one.groupId,
|
||||
issuer.id,
|
||||
'fs:order:read',
|
||||
);
|
||||
await store.deleteUserGroupPermsByPermissionPrefixes([
|
||||
`fs:${node}`,
|
||||
]);
|
||||
} finally {
|
||||
write.mockRestore();
|
||||
}
|
||||
expect(seen).toEqual([true, true]);
|
||||
});
|
||||
|
||||
it('leaves the grant in place when the member read fails', async () => {
|
||||
const issuer = await makeUser();
|
||||
const node = uuidv4();
|
||||
const one = await seedMember(issuer.id, 'fs:retry:read');
|
||||
const many = await seedMember(issuer.id, `fs:${node}:read`);
|
||||
|
||||
const db = server.clients.db;
|
||||
const primaryRead = db.read.bind(db);
|
||||
const pread = vi
|
||||
.spyOn(db, 'pread')
|
||||
.mockImplementation(async (sql, params) => {
|
||||
if (String(sql).includes('`jct_user_group` ug')) {
|
||||
throw new Error('primary unavailable');
|
||||
}
|
||||
return primaryRead(sql, params);
|
||||
});
|
||||
try {
|
||||
await expect(
|
||||
store.deleteUserGroupPerm(
|
||||
one.groupId,
|
||||
issuer.id,
|
||||
'fs:retry:read',
|
||||
),
|
||||
).rejects.toThrow('primary unavailable');
|
||||
await expect(
|
||||
store.deleteUserGroupPermsByPermissionPrefixes([
|
||||
`fs:${node}`,
|
||||
]),
|
||||
).rejects.toThrow('primary unavailable');
|
||||
} finally {
|
||||
pread.mockRestore();
|
||||
}
|
||||
|
||||
// The retry still finds the grants and whose they were.
|
||||
expect(
|
||||
await store.deleteUserGroupPerm(
|
||||
one.groupId,
|
||||
issuer.id,
|
||||
'fs:retry:read',
|
||||
),
|
||||
).toEqual({
|
||||
removed: true,
|
||||
members: [{ id: one.member.id, uuid: expect.any(String) }],
|
||||
});
|
||||
expect(
|
||||
await store.deleteUserGroupPermsByPermissionPrefixes([
|
||||
`fs:${node}`,
|
||||
]),
|
||||
).toEqual({
|
||||
rows: [
|
||||
{ group_id: many.groupId, permission: `fs:${node}:read` },
|
||||
],
|
||||
members: [{ id: many.member.id, uuid: expect.any(String) }],
|
||||
});
|
||||
});
|
||||
|
||||
it('includes someone who joined while the grant was deleted', async () => {
|
||||
const issuer = await makeUser();
|
||||
const joiner = await makeUser();
|
||||
const { member, groupId } = await seedMember(
|
||||
issuer.id,
|
||||
'fs:joined:read',
|
||||
);
|
||||
|
||||
const db = server.clients.db;
|
||||
const primaryWrite = db.write.bind(db);
|
||||
const write = vi
|
||||
.spyOn(db, 'write')
|
||||
.mockImplementation(async (sql, params) => {
|
||||
if (String(sql).startsWith('DELETE FROM')) {
|
||||
await primaryWrite(
|
||||
'INSERT INTO `jct_user_group` (`user_id`, `group_id`) VALUES (?, ?)',
|
||||
[joiner.id, groupId],
|
||||
);
|
||||
}
|
||||
return primaryWrite(sql, params);
|
||||
});
|
||||
let result;
|
||||
try {
|
||||
result = await store.deleteUserGroupPerm(
|
||||
groupId,
|
||||
issuer.id,
|
||||
'fs:joined:read',
|
||||
);
|
||||
} finally {
|
||||
write.mockRestore();
|
||||
}
|
||||
expect(result.removed).toBe(true);
|
||||
expect(result.members.map((m) => m.id).sort()).toEqual(
|
||||
[member.id, joiner.id].sort(),
|
||||
);
|
||||
expect(await tombstoneSet(joiner.id)).toBe(true);
|
||||
});
|
||||
|
||||
it('still reports the removal when the second member read fails', async () => {
|
||||
const issuer = await makeUser();
|
||||
const { member, groupId } = await seedMember(
|
||||
issuer.id,
|
||||
'fs:reread:read',
|
||||
);
|
||||
|
||||
const db = server.clients.db;
|
||||
const primaryRead = db.read.bind(db);
|
||||
let memberReads = 0;
|
||||
const pread = vi
|
||||
.spyOn(db, 'pread')
|
||||
.mockImplementation(async (sql, params) => {
|
||||
if (
|
||||
String(sql).includes('`jct_user_group` ug') &&
|
||||
++memberReads > 1
|
||||
) {
|
||||
throw new Error('primary unavailable');
|
||||
}
|
||||
return primaryRead(sql, params);
|
||||
});
|
||||
const warn = vi.spyOn(console, 'warn').mockImplementation(() => {});
|
||||
try {
|
||||
expect(
|
||||
await store.deleteUserGroupPerm(
|
||||
groupId,
|
||||
issuer.id,
|
||||
'fs:reread:read',
|
||||
),
|
||||
).toEqual({
|
||||
removed: true,
|
||||
members: [{ id: member.id, uuid: expect.any(String) }],
|
||||
});
|
||||
} finally {
|
||||
pread.mockRestore();
|
||||
warn.mockRestore();
|
||||
}
|
||||
});
|
||||
|
||||
it('reads many issuer/group pairs under many prefixes at once', async () => {
|
||||
const issuer = await makeUser();
|
||||
const rival = await makeUser();
|
||||
@@ -1473,6 +1831,41 @@ describe('PermissionStore', () => {
|
||||
).toHaveLength(1);
|
||||
});
|
||||
|
||||
it('removes a grant the replica has not seen yet with its node, when asked to read the primary', async () => {
|
||||
const issuer = await makeUser();
|
||||
const holder = await makeUser();
|
||||
const node = uuidv4();
|
||||
await store.upsertUserUserPerm(
|
||||
holder.id,
|
||||
issuer.id,
|
||||
`fs:${node}:read`,
|
||||
{},
|
||||
);
|
||||
|
||||
const restore = lagReplica('user_to_user_permissions', () => []);
|
||||
let unasked;
|
||||
let removed;
|
||||
try {
|
||||
unasked = await store.deleteUserUserPermsByPermissionPrefixes([
|
||||
`fs:${node}`,
|
||||
]);
|
||||
removed = await store.deleteUserUserPermsByPermissionPrefixes(
|
||||
[`fs:${node}`],
|
||||
{ primary: true },
|
||||
);
|
||||
} finally {
|
||||
restore();
|
||||
}
|
||||
// Unasked, the replica's answer stands and the primary is left alone.
|
||||
expect(unasked).toEqual([]);
|
||||
expect(removed).toHaveLength(1);
|
||||
expect(
|
||||
await store.readLinkedUserUserPermsFromPrimary(holder.id, [
|
||||
`fs:${node}:read`,
|
||||
]),
|
||||
).toEqual([]);
|
||||
});
|
||||
|
||||
it('does not let a wildcard in the prefix widen the match', async () => {
|
||||
const issuer = await makeUser();
|
||||
const holder = await makeUser();
|
||||
|
||||
@@ -17,7 +17,11 @@
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
import { PuterStore } from '../types';
|
||||
import {
|
||||
CACHE_TOMBSTONE_SUFFIX,
|
||||
CACHE_TOMBSTONE_TTL_SECONDS,
|
||||
PuterStore,
|
||||
} from '../types';
|
||||
import type { LayerInstances } from '../../types';
|
||||
import type { puterStores } from '../index';
|
||||
import { PermissionUtil } from '../../services/permission/permissionUtil';
|
||||
@@ -98,6 +102,11 @@ type DbRead = (
|
||||
params: unknown[],
|
||||
) => Promise<Record<string, unknown>[]>;
|
||||
|
||||
export interface GroupMember {
|
||||
id: number;
|
||||
uuid: string | null;
|
||||
}
|
||||
|
||||
export interface LinkedUserUserPermRow {
|
||||
holder_user_id: number;
|
||||
issuer_user_id: number;
|
||||
@@ -645,25 +654,40 @@ export class PermissionStore extends PuterStore {
|
||||
}));
|
||||
}
|
||||
|
||||
/** `primary` when a grant may be too new for a replica to have it. */
|
||||
#grantRead(primary: boolean): DbRead {
|
||||
return primary
|
||||
? this.clients.db.pread.bind(this.clients.db)
|
||||
: this.clients.db.read.bind(this.clients.db);
|
||||
}
|
||||
|
||||
/** The group analogue: a deleted node's group grants must go with it. */
|
||||
async deleteUserGroupPermsByPermissionPrefixes(
|
||||
permissions: string[],
|
||||
): Promise<Array<{ group_id: number; permission: string }>> {
|
||||
if (permissions.length === 0) return [];
|
||||
{ primary = false }: { primary?: boolean } = {},
|
||||
): Promise<{
|
||||
rows: Array<{ group_id: number; permission: string }>;
|
||||
members: GroupMember[];
|
||||
}> {
|
||||
if (permissions.length === 0) return { rows: [], members: [] };
|
||||
const { where, params } = subtreeClause(permissions);
|
||||
|
||||
const rows = (await this.clients.db.read(
|
||||
const rows = (await this.#grantRead(primary)(
|
||||
'SELECT `group_id`, `permission` FROM `user_to_group_permissions` ' +
|
||||
`WHERE ${where}`,
|
||||
params,
|
||||
)) as Array<{ group_id: number; permission: string }>;
|
||||
if (rows.length === 0) return [];
|
||||
if (rows.length === 0) return { rows, members: [] };
|
||||
|
||||
await this.clients.db.write(
|
||||
`DELETE FROM \`user_to_group_permissions\` WHERE ${where}`,
|
||||
params,
|
||||
const { members } = await this.#deleteGroupGrants(
|
||||
rows.map((row) => row.group_id),
|
||||
() =>
|
||||
this.clients.db.write(
|
||||
`DELETE FROM \`user_to_group_permissions\` WHERE ${where}`,
|
||||
params,
|
||||
),
|
||||
);
|
||||
return rows;
|
||||
return { rows, members };
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -678,6 +702,7 @@ export class PermissionStore extends PuterStore {
|
||||
*/
|
||||
async deleteUserUserPermsByPermissionPrefixes(
|
||||
permissions: string[],
|
||||
{ primary = false }: { primary?: boolean } = {},
|
||||
): Promise<
|
||||
Array<{
|
||||
holder_user_id: number;
|
||||
@@ -688,7 +713,7 @@ export class PermissionStore extends PuterStore {
|
||||
if (permissions.length === 0) return [];
|
||||
const { where, params } = subtreeClause(permissions);
|
||||
|
||||
const rows = (await this.clients.db.read(
|
||||
const rows = (await this.#grantRead(primary)(
|
||||
'SELECT `holder_user_id`, `issuer_user_id`, `permission` FROM `user_to_user_permissions` ' +
|
||||
`WHERE ${where}`,
|
||||
params,
|
||||
@@ -1332,9 +1357,6 @@ export class PermissionStore extends PuterStore {
|
||||
}
|
||||
|
||||
// -- SQL: user-to-group permissions ------------------------------
|
||||
//
|
||||
// Read-only. Group grants are seeded by migration (the admin group's
|
||||
// unrestricted `driver` access); nothing writes them at runtime.
|
||||
|
||||
/**
|
||||
* Reads group permissions granted to groups the user is a member of, for a
|
||||
@@ -1351,9 +1373,15 @@ export class PermissionStore extends PuterStore {
|
||||
if (permissions.length === 0) return [];
|
||||
let permClause = permissions.map(() => 'p.permission = ?').join(' OR ');
|
||||
if (permissions.length > 1) permClause = `(${permClause})`;
|
||||
const tombstoned = await this.isCacheKeyTombstoned([
|
||||
this.#u2gCacheKey(userId),
|
||||
]);
|
||||
const read: DbRead = tombstoned
|
||||
? this.clients.db.pread.bind(this.clients.db)
|
||||
: this.clients.db.read.bind(this.clients.db);
|
||||
// Deletion leaves memberships and grants, so a deleted team would
|
||||
// otherwise keep resolving access nothing can withdraw.
|
||||
const rows = await this.clients.db.read(
|
||||
const rows = await read(
|
||||
'SELECT p.permission, p.user_id, p.group_id, p.extra FROM `user_to_group_permissions` p ' +
|
||||
'JOIN `jct_user_group` ug ON p.group_id = ug.group_id ' +
|
||||
'JOIN `group` g ON g.`id` = ug.group_id ' +
|
||||
@@ -1387,13 +1415,44 @@ export class PermissionStore extends PuterStore {
|
||||
.filter((uuid): uuid is string => Boolean(uuid));
|
||||
}
|
||||
|
||||
/** Whose standing access a grant to this group settles. */
|
||||
async listGroupMemberIds(groupId: number): Promise<number[]> {
|
||||
const rows = (await this.clients.db.read(
|
||||
'SELECT `user_id` FROM `jct_user_group` WHERE `group_id` = ?',
|
||||
[groupId],
|
||||
)) as { user_id: number }[];
|
||||
return rows.map((r) => Number(r.user_id));
|
||||
async #listGroupMembers(groupIds: number[]): Promise<GroupMember[]> {
|
||||
const ids = [...new Set(groupIds.map(Number))].filter((id) =>
|
||||
Number.isFinite(id),
|
||||
);
|
||||
if (ids.length === 0) return [];
|
||||
const rows = (await this.clients.db.pread(
|
||||
'SELECT DISTINCT u.`id`, u.`uuid` FROM `jct_user_group` ug ' +
|
||||
'JOIN `user` u ON u.`id` = ug.`user_id` ' +
|
||||
`WHERE ug.\`group_id\` IN (${ids.map(() => '?').join(', ')})`,
|
||||
ids,
|
||||
)) as { id: number; uuid: string | null }[];
|
||||
return rows.map((row) => ({ id: Number(row.id), uuid: row.uuid }));
|
||||
}
|
||||
|
||||
/**
|
||||
* Runs a delete of these groups' grants with their members' group reads
|
||||
* already on the primary. Returns the members, later joiners included.
|
||||
*/
|
||||
async #deleteGroupGrants<T>(
|
||||
groupIds: number[],
|
||||
deleteGrants: () => Promise<T>,
|
||||
): Promise<{ result: T; members: GroupMember[] }> {
|
||||
// Before the delete: a failed member read leaves the grants to retry.
|
||||
const members = await this.#listGroupMembers(groupIds);
|
||||
await this.markGroupMembershipChanged(members.map((m) => m.id));
|
||||
const result = await deleteGrants();
|
||||
try {
|
||||
const known = new Set(members.map((m) => m.id));
|
||||
const joined = (await this.#listGroupMembers(groupIds)).filter(
|
||||
(m) => !known.has(m.id),
|
||||
);
|
||||
await this.markGroupMembershipChanged(joined.map((m) => m.id));
|
||||
members.push(...joined);
|
||||
} catch (e) {
|
||||
// The grants are gone; only someone who joined meanwhile is missed.
|
||||
console.warn('[permission] group members not re-read:', e);
|
||||
}
|
||||
return { result, members };
|
||||
}
|
||||
|
||||
/** Batched `readUserGroupPerms`, tagged with the user each row reached. */
|
||||
@@ -1406,7 +1465,14 @@ export class PermissionStore extends PuterStore {
|
||||
const holders = [...new Set(userIds)];
|
||||
const perms = [...new Set(permissions)];
|
||||
if (holders.length === 0 || perms.length === 0) return [];
|
||||
const rows = await this.clients.db.read(
|
||||
const changed = await this.tombstonedCacheKeys(
|
||||
holders.map((holder) => this.#u2gCacheKey(holder)),
|
||||
);
|
||||
const read: DbRead =
|
||||
changed.size > 0
|
||||
? this.clients.db.pread.bind(this.clients.db)
|
||||
: this.clients.db.read.bind(this.clients.db);
|
||||
const rows = await read(
|
||||
'SELECT ug.`user_id` AS `holder_user_id`, p.`permission`, p.`user_id` ' +
|
||||
'FROM `user_to_group_permissions` p ' +
|
||||
'JOIN `jct_user_group` ug ON p.`group_id` = ug.`group_id` ' +
|
||||
@@ -1492,13 +1558,34 @@ export class PermissionStore extends PuterStore {
|
||||
groupId: number,
|
||||
issuerUserId: number,
|
||||
permission: string,
|
||||
): Promise<boolean> {
|
||||
const result = await this.clients.db.write(
|
||||
'DELETE FROM `user_to_group_permissions` ' +
|
||||
'WHERE `group_id` = ? AND `user_id` = ? AND `permission` = ?',
|
||||
[groupId, issuerUserId, permission],
|
||||
): Promise<{ removed: boolean; members: GroupMember[] }> {
|
||||
const { result, members } = await this.#deleteGroupGrants(
|
||||
[groupId],
|
||||
() =>
|
||||
this.clients.db.write(
|
||||
'DELETE FROM `user_to_group_permissions` ' +
|
||||
'WHERE `group_id` = ? AND `user_id` = ? AND `permission` = ?',
|
||||
[groupId, issuerUserId, permission],
|
||||
),
|
||||
);
|
||||
return result.anyRowsAffected;
|
||||
return { removed: result.anyRowsAffected, members };
|
||||
}
|
||||
|
||||
/** Group reads of these users go to the primary; for leaves and deletes. */
|
||||
async markGroupMembershipChanged(userIds: number[]): Promise<void> {
|
||||
const ids = [...new Set(userIds.map(Number))].filter((id) =>
|
||||
Number.isFinite(id),
|
||||
);
|
||||
if (ids.length === 0) return;
|
||||
// Only the tombstones: nothing is cached under the base key.
|
||||
await this.publishCacheKeys({
|
||||
keys: ids.map(
|
||||
(id) => this.#u2gCacheKey(id) + CACHE_TOMBSTONE_SUFFIX,
|
||||
),
|
||||
serializedData: '1',
|
||||
ttlSeconds: CACHE_TOMBSTONE_TTL_SECONDS,
|
||||
broadcast: true,
|
||||
});
|
||||
}
|
||||
|
||||
async auditUserGroupPerm(
|
||||
@@ -1888,6 +1975,11 @@ export class PermissionStore extends PuterStore {
|
||||
return `perms:u2u:holder:${holderUserId}`;
|
||||
}
|
||||
|
||||
/** Holds only a tombstone: group reads aren't cached here. */
|
||||
#u2gCacheKey(userId: number): string {
|
||||
return `perms:u2g:${userId}`;
|
||||
}
|
||||
|
||||
#u2aCacheKey(userId: number, appId: number): string {
|
||||
return `perms:u2a:${userId}:${appId}`;
|
||||
}
|
||||
|
||||
@@ -658,12 +658,26 @@ export class SessionStore extends PuterStore {
|
||||
*/
|
||||
async findActiveByAccessTokenUid(tokenUid) {
|
||||
if (!tokenUid) return null;
|
||||
const now = nowSeconds();
|
||||
const rows = await this.clients.db.read(
|
||||
"SELECT * FROM `sessions` WHERE `kind` = 'access_token' AND (`access_token_uid` = ? OR `legacy_token_uid` = ?) AND `revoked_at` IS NULL AND (`expires_at` IS NULL OR `expires_at` > ?) ORDER BY `id` DESC LIMIT 1",
|
||||
[tokenUid, tokenUid, now],
|
||||
);
|
||||
return this.#normalizeRow(rows[0]);
|
||||
// One indexed lookup per column: an OR across both can't use either
|
||||
// index on MySQL. MySQL indexes the legacy uid only through its
|
||||
// active-row generated column, equal to it while `revoked_at` is NULL.
|
||||
const legacyColumn = this.clients.db.case({
|
||||
mysql: 'legacy_token_unique_key',
|
||||
otherwise: 'legacy_token_uid',
|
||||
});
|
||||
const findBy = async (column) => {
|
||||
const rows = await this.clients.db.read(
|
||||
`SELECT * FROM \`sessions\` WHERE \`kind\` = 'access_token' AND \`${column}\` = ? AND \`revoked_at\` IS NULL AND (\`expires_at\` IS NULL OR \`expires_at\` > ?) ORDER BY \`id\` DESC LIMIT 1`,
|
||||
[tokenUid, nowSeconds()],
|
||||
);
|
||||
return this.#normalizeRow(rows[0]);
|
||||
};
|
||||
// Sent together, so a miss on the first costs no second round trip.
|
||||
const [own, legacy] = await Promise.all([
|
||||
findBy('access_token_uid'),
|
||||
findBy(legacyColumn),
|
||||
]);
|
||||
return own ?? legacy;
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -771,6 +771,77 @@ describe('SessionStore', () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe('findActiveByAccessTokenUid', () => {
|
||||
const tokenRow = (userId: number, fields: Record<string, unknown>) =>
|
||||
target.create(userId, { kind: 'access_token', ...fields });
|
||||
|
||||
it('finds a token row by its access_token_uid', async () => {
|
||||
const user = await makeUser();
|
||||
const tokenUid = uuidv4();
|
||||
const row = await tokenRow(user.id, { access_token_uid: tokenUid });
|
||||
|
||||
const found = await target.findActiveByAccessTokenUid(tokenUid);
|
||||
expect(found?.uuid).toBe(row.uuid);
|
||||
});
|
||||
|
||||
it('finds a migrated row by its legacy token uid', async () => {
|
||||
const user = await makeUser();
|
||||
const legacyUid = uuidv4();
|
||||
const row = await tokenRow(user.id, {
|
||||
legacy_token_uid: legacyUid,
|
||||
created_via: 'legacy_backfill',
|
||||
});
|
||||
|
||||
const found = await target.findActiveByAccessTokenUid(legacyUid);
|
||||
expect(found?.uuid).toBe(row.uuid);
|
||||
});
|
||||
|
||||
it('returns null for a uid no token row carries', async () => {
|
||||
const user = await makeUser();
|
||||
await tokenRow(user.id, { access_token_uid: uuidv4() });
|
||||
|
||||
expect(
|
||||
await target.findActiveByAccessTokenUid(uuidv4()),
|
||||
).toBeNull();
|
||||
});
|
||||
|
||||
it('skips revoked and expired rows under either uid', async () => {
|
||||
const user = await makeUser();
|
||||
const revokedUid = uuidv4();
|
||||
const revokedLegacyUid = uuidv4();
|
||||
const expiredUid = uuidv4();
|
||||
const revoked = await tokenRow(user.id, {
|
||||
access_token_uid: revokedUid,
|
||||
});
|
||||
const revokedLegacy = await tokenRow(user.id, {
|
||||
legacy_token_uid: revokedLegacyUid,
|
||||
});
|
||||
await tokenRow(user.id, {
|
||||
access_token_uid: expiredUid,
|
||||
expires_at: Math.floor(Date.now() / 1000) - 60,
|
||||
});
|
||||
await target.removeByUuid(revoked.uuid);
|
||||
await target.removeByUuid(revokedLegacy.uuid);
|
||||
|
||||
for (const uid of [revokedUid, revokedLegacyUid, expiredUid]) {
|
||||
expect(await target.findActiveByAccessTokenUid(uid)).toBeNull();
|
||||
}
|
||||
});
|
||||
|
||||
it('ignores a non-token row carrying the uid', async () => {
|
||||
const user = await makeUser();
|
||||
const tokenUid = uuidv4();
|
||||
await target.create(user.id, {
|
||||
kind: 'web',
|
||||
access_token_uid: tokenUid,
|
||||
});
|
||||
|
||||
expect(
|
||||
await target.findActiveByAccessTokenUid(tokenUid),
|
||||
).toBeNull();
|
||||
});
|
||||
});
|
||||
|
||||
describe('getOrCreateGodmodeToken', () => {
|
||||
const nowS = () => Math.floor(Date.now() / 1000);
|
||||
const mint = (
|
||||
|
||||
@@ -48,6 +48,33 @@ const SHARED_IDS_CHUNK_SIZE = 1000;
|
||||
* and no permission behind it, and is itself what the ACL reads.
|
||||
*/
|
||||
export class ShareStore extends PuterStore {
|
||||
onServerStart() {
|
||||
// A peer region's link revokes; our own emit already applied here.
|
||||
this.clients.event.on(
|
||||
'outer.share.linksRevoked',
|
||||
async (_key, data, meta) => {
|
||||
if (!meta?.from_outside) return;
|
||||
const fsentryIds = Array.isArray(data?.fsentryIds)
|
||||
? data.fsentryIds.filter((id) => Number.isInteger(id))
|
||||
: [];
|
||||
const uuids = Array.isArray(data?.uuids)
|
||||
? data.uuids.filter(
|
||||
(uuid) => typeof uuid === 'string' && uuid !== '',
|
||||
)
|
||||
: [];
|
||||
if (fsentryIds.length === 0 && uuids.length === 0) return;
|
||||
try {
|
||||
await this.#applyLinksRevoked(fsentryIds, uuids);
|
||||
} catch (e) {
|
||||
console.warn(
|
||||
'[share] remote link-revoke marker not set:',
|
||||
e,
|
||||
);
|
||||
}
|
||||
},
|
||||
);
|
||||
}
|
||||
|
||||
// -- Reads --------------------------------------------------------
|
||||
|
||||
/** Pass `primary` to read back a row just written; a replica may lag. */
|
||||
@@ -338,12 +365,17 @@ export class ShareStore extends PuterStore {
|
||||
* Every share row on a node and everything beneath it, whatever kind —
|
||||
* user, group and link shares plus unclaimed invites.
|
||||
* `listByFsentrySubtree` answers the narrower question; this one is for
|
||||
* retiring the lot.
|
||||
* retiring the lot. Pass `primary` when a share may be too new for a
|
||||
* replica.
|
||||
*
|
||||
* @param {number} fsentryId
|
||||
* @param {{ primary?: boolean }} [opts]
|
||||
*/
|
||||
async listAllByFsentrySubtree(fsentryId) {
|
||||
const rows = await this.clients.db.read(
|
||||
async listAllByFsentrySubtree(fsentryId, { primary = false } = {}) {
|
||||
const read = primary
|
||||
? this.clients.db.pread.bind(this.clients.db)
|
||||
: this.clients.db.read.bind(this.clients.db);
|
||||
const rows = await read(
|
||||
this.#subtreeCte() +
|
||||
'SELECT `share`.* FROM `share` ' +
|
||||
'JOIN `subtree` ON `share`.`fsentry_id` = `subtree`.`id` ' +
|
||||
@@ -964,14 +996,19 @@ export class ShareStore extends PuterStore {
|
||||
* its shares never fires.
|
||||
*
|
||||
* @param {number[]} fsentryIds
|
||||
* @param {string[]} [entryUuids] The nodes' uuids; looked up when omitted.
|
||||
*/
|
||||
async deleteByFsentryIds(fsentryIds) {
|
||||
async deleteByFsentryIds(fsentryIds, entryUuids) {
|
||||
if (fsentryIds.length === 0) return 0;
|
||||
const placeholders = fsentryIds.map(() => '?').join(', ');
|
||||
const result = await this.clients.db.write(
|
||||
`DELETE FROM \`share\` WHERE \`fsentry_id\` IN (${placeholders})`,
|
||||
fsentryIds,
|
||||
);
|
||||
// Which of these nodes held a link is no longer known, so mark them all.
|
||||
if (result.anyRowsAffected) {
|
||||
await this.#markLinksRevoked(fsentryIds, entryUuids);
|
||||
}
|
||||
return result.affectedRows;
|
||||
}
|
||||
|
||||
@@ -1216,36 +1253,64 @@ export class ShareStore extends PuterStore {
|
||||
[fsentryId],
|
||||
);
|
||||
const removed = result.anyRowsAffected;
|
||||
if (removed) await this.#markLinkRevoked(fsentryId, entryUuid);
|
||||
if (removed) {
|
||||
await this.#markLinksRevoked(
|
||||
[fsentryId],
|
||||
entryUuid ? [entryUuid] : undefined,
|
||||
);
|
||||
}
|
||||
return removed;
|
||||
}
|
||||
|
||||
/** Open the window in which reads of this node's link go to the primary. */
|
||||
async #markLinkRevoked(fsentryId, entryUuid) {
|
||||
try {
|
||||
let uuid = entryUuid;
|
||||
if (!uuid) {
|
||||
/** Reads of these nodes' links go to the primary, here and in peers. */
|
||||
async #markLinksRevoked(fsentryIds, entryUuids) {
|
||||
const ids = [...new Set(fsentryIds.map(Number))];
|
||||
let uuids = entryUuids?.length >= ids.length ? entryUuids : null;
|
||||
if (!uuids) {
|
||||
try {
|
||||
const rows = await this.clients.db.pread(
|
||||
'SELECT `uuid` FROM `fsentries` WHERE `id` = ? LIMIT 1',
|
||||
[fsentryId],
|
||||
'SELECT `uuid` FROM `fsentries` WHERE `id` IN ' +
|
||||
`(${ids.map(() => '?').join(', ')})`,
|
||||
ids,
|
||||
);
|
||||
uuid = rows[0]?.uuid;
|
||||
uuids = rows.map((row) => String(row.uuid));
|
||||
} catch (e) {
|
||||
console.warn('[share] link-revoke uuids not found:', e);
|
||||
uuids = entryUuids ?? [];
|
||||
}
|
||||
const keys = [ShareStore.revokedLinkKey('id', fsentryId)];
|
||||
if (uuid) keys.push(ShareStore.revokedLinkKey('uuid', uuid));
|
||||
await Promise.all(
|
||||
keys.map((key) =>
|
||||
this.clients.redis.set(
|
||||
key,
|
||||
'1',
|
||||
'EX',
|
||||
ShareStore.REVOKED_LINK_PRIMARY_WINDOW_SECONDS,
|
||||
),
|
||||
),
|
||||
);
|
||||
}
|
||||
try {
|
||||
await this.#applyLinksRevoked(ids, uuids);
|
||||
} catch (e) {
|
||||
console.warn('[share] link-revoke marker not set:', e);
|
||||
}
|
||||
// Peers still get the ids when the local half failed.
|
||||
try {
|
||||
this.clients.event.emit(
|
||||
'outer.share.linksRevoked',
|
||||
{ fsentryIds: ids, uuids },
|
||||
{},
|
||||
);
|
||||
} catch (e) {
|
||||
console.warn('[share] link-revoke not sent to peers:', e);
|
||||
}
|
||||
}
|
||||
|
||||
/** Local half of {@link #markLinksRevoked}; never emits. */
|
||||
async #applyLinksRevoked(fsentryIds, uuids) {
|
||||
const pipeline = this.clients.redis.pipeline();
|
||||
for (const key of [
|
||||
...fsentryIds.map((id) => ShareStore.revokedLinkKey('id', id)),
|
||||
...uuids.map((uuid) => ShareStore.revokedLinkKey('uuid', uuid)),
|
||||
]) {
|
||||
pipeline.set(
|
||||
key,
|
||||
'1',
|
||||
'EX',
|
||||
ShareStore.REVOKED_LINK_PRIMARY_WINDOW_SECONDS,
|
||||
);
|
||||
}
|
||||
await pipeline.exec();
|
||||
}
|
||||
|
||||
// -- Daily quota --------------------------------------------------
|
||||
|
||||
@@ -337,6 +337,176 @@ describe('ShareStore', () => {
|
||||
);
|
||||
});
|
||||
|
||||
it('does not read back a link removed with its node from a lagging replica', async () => {
|
||||
const entry = await makeEntry(issuer);
|
||||
const stale = await store.upsertAnyone({
|
||||
issuerUserId: issuer.id,
|
||||
fsentryId: entry.id,
|
||||
mode: 'read',
|
||||
});
|
||||
await store.deleteByFsentryIds([entry.id]);
|
||||
|
||||
// The replica still has the link the primary just deleted.
|
||||
const db = server.clients.db;
|
||||
const primaryRead = db.read.bind(db);
|
||||
const pread = vi.spyOn(db, 'pread').mockImplementation(primaryRead);
|
||||
const read = vi
|
||||
.spyOn(db, 'read')
|
||||
.mockImplementation(async (q, p) =>
|
||||
/FROM `share`/u.test(q)
|
||||
? [
|
||||
{
|
||||
...stale,
|
||||
data: '{}',
|
||||
entry_uuid: entry.uuid,
|
||||
owner_user_id: issuer.id,
|
||||
},
|
||||
]
|
||||
: primaryRead(q, p),
|
||||
);
|
||||
try {
|
||||
expect(await store.getAnyone(entry.id)).toBeNull();
|
||||
expect(await store.listAnyoneOnFsentries([entry.id])).toEqual(
|
||||
[],
|
||||
);
|
||||
expect(await store.listAnyoneReaching([entry.uuid])).toEqual(
|
||||
[],
|
||||
);
|
||||
} finally {
|
||||
read.mockRestore();
|
||||
pread.mockRestore();
|
||||
}
|
||||
});
|
||||
|
||||
it('tells peer regions when a link is removed', async () => {
|
||||
const entry = await makeEntry(issuer);
|
||||
await store.upsertAnyone({
|
||||
issuerUserId: issuer.id,
|
||||
fsentryId: entry.id,
|
||||
mode: 'read',
|
||||
});
|
||||
const emit = vi.spyOn(server.clients.event, 'emit');
|
||||
try {
|
||||
await store.deleteByFsentryIds([entry.id]);
|
||||
expect(emit).toHaveBeenCalledWith(
|
||||
'outer.share.linksRevoked',
|
||||
{ fsentryIds: [entry.id], uuids: [entry.uuid] },
|
||||
{},
|
||||
);
|
||||
} finally {
|
||||
emit.mockRestore();
|
||||
}
|
||||
});
|
||||
|
||||
it('applies a link removal broadcast by a peer region', async () => {
|
||||
const fsentryId = 900000 + Math.floor(Math.random() * 99999);
|
||||
const uuid = uuidv4();
|
||||
server.clients.event.emit(
|
||||
'outer.share.linksRevoked',
|
||||
{ fsentryIds: [fsentryId], uuids: [uuid] },
|
||||
{ from_outside: true },
|
||||
);
|
||||
await vi.waitFor(async () => {
|
||||
expect(
|
||||
await server.clients.redis.get(
|
||||
ShareStore.revokedLinkKey('uuid', uuid),
|
||||
),
|
||||
).toBe('1');
|
||||
});
|
||||
expect(
|
||||
await server.clients.redis.ttl(
|
||||
ShareStore.revokedLinkKey('id', fsentryId),
|
||||
),
|
||||
).toBeGreaterThan(25);
|
||||
});
|
||||
|
||||
it('still tells peer regions when the local marker cannot be set', async () => {
|
||||
const entry = await makeEntry(issuer);
|
||||
await store.upsertAnyone({
|
||||
issuerUserId: issuer.id,
|
||||
fsentryId: entry.id,
|
||||
mode: 'read',
|
||||
});
|
||||
const pipeline = vi
|
||||
.spyOn(server.clients.redis, 'pipeline')
|
||||
.mockImplementation(() => {
|
||||
throw new Error('redis unavailable');
|
||||
});
|
||||
const emit = vi.spyOn(server.clients.event, 'emit');
|
||||
try {
|
||||
await store.deleteByFsentryIds([entry.id], [entry.uuid]);
|
||||
expect(emit).toHaveBeenCalledWith(
|
||||
'outer.share.linksRevoked',
|
||||
{ fsentryIds: [entry.id], uuids: [entry.uuid] },
|
||||
{},
|
||||
);
|
||||
} finally {
|
||||
emit.mockRestore();
|
||||
pipeline.mockRestore();
|
||||
}
|
||||
});
|
||||
|
||||
it('neither marks nor tells peers when nothing was removed', async () => {
|
||||
const entry = await makeEntry(issuer);
|
||||
const emit = vi.spyOn(server.clients.event, 'emit');
|
||||
try {
|
||||
expect(await store.deleteByFsentryIds([entry.id])).toBe(0);
|
||||
expect(emit).not.toHaveBeenCalledWith(
|
||||
'outer.share.linksRevoked',
|
||||
expect.anything(),
|
||||
expect.anything(),
|
||||
);
|
||||
} finally {
|
||||
emit.mockRestore();
|
||||
}
|
||||
expect(
|
||||
await server.clients.redis.get(
|
||||
ShareStore.revokedLinkKey('uuid', entry.uuid),
|
||||
),
|
||||
).toBeNull();
|
||||
});
|
||||
|
||||
it("ignores its own region's event and malformed payloads", async () => {
|
||||
const local = uuidv4();
|
||||
const sentinel = uuidv4();
|
||||
const bogus = 900000 + Math.floor(Math.random() * 99999);
|
||||
const emit = (data, meta) =>
|
||||
server.clients.event.emit(
|
||||
'outer.share.linksRevoked',
|
||||
data,
|
||||
meta,
|
||||
);
|
||||
emit({ fsentryIds: [], uuids: [local] }, {});
|
||||
for (const data of [
|
||||
null,
|
||||
{ fsentryIds: 'x', uuids: 'y' },
|
||||
{
|
||||
fsentryIds: [String(bogus), bogus + 0.5, null],
|
||||
uuids: [bogus, '', null],
|
||||
},
|
||||
]) {
|
||||
emit(data, { from_outside: true });
|
||||
}
|
||||
// Handled in order, so once this lands the ones above have too.
|
||||
emit({ fsentryIds: [], uuids: [sentinel] }, { from_outside: true });
|
||||
await vi.waitFor(async () => {
|
||||
expect(
|
||||
await server.clients.redis.get(
|
||||
ShareStore.revokedLinkKey('uuid', sentinel),
|
||||
),
|
||||
).toBe('1');
|
||||
});
|
||||
|
||||
for (const key of [
|
||||
ShareStore.revokedLinkKey('uuid', local),
|
||||
ShareStore.revokedLinkKey('uuid', String(bogus)),
|
||||
ShareStore.revokedLinkKey('id', bogus),
|
||||
ShareStore.revokedLinkKey('id', bogus + 0.5),
|
||||
]) {
|
||||
expect(await server.clients.redis.get(key)).toBeNull();
|
||||
}
|
||||
});
|
||||
|
||||
it('reads a link past the replica once one has been withdrawn', async () => {
|
||||
const entry = await makeEntry(issuer);
|
||||
await store.upsertAnyone({
|
||||
@@ -1155,6 +1325,27 @@ describe('ShareStore', () => {
|
||||
};
|
||||
};
|
||||
|
||||
it('lists a share the replica lacks in a subtree when asked to read the primary', async () => {
|
||||
const entry = await makeEntry(issuer);
|
||||
const link = await store.upsertAnyone({
|
||||
issuerUserId: issuer.id,
|
||||
fsentryId: entry.id,
|
||||
mode: 'read',
|
||||
});
|
||||
const restore = lagShares([]);
|
||||
try {
|
||||
expect(
|
||||
await store.listAllByFsentrySubtree(entry.id),
|
||||
).toEqual([]);
|
||||
const rows = await store.listAllByFsentrySubtree(entry.id, {
|
||||
primary: true,
|
||||
});
|
||||
expect(rows.map((row) => row.uid)).toEqual([link.uid]);
|
||||
} finally {
|
||||
restore();
|
||||
}
|
||||
});
|
||||
|
||||
it('returns the rows it inserts before the replica has them', async () => {
|
||||
const entry = await makeEntry(issuer);
|
||||
// A group row written directly: the share only needs its id,
|
||||
|
||||
@@ -159,8 +159,8 @@ export interface AppSummaryOptions {
|
||||
|
||||
/**
|
||||
* The summary the desktop launches from directly, without re-reading the app
|
||||
* (suggested, recommended, recent and taskbar apps), so every launch-relevant
|
||||
* flag belongs here.
|
||||
* (suggested, recommended and recent apps), so every launch-relevant flag
|
||||
* belongs here.
|
||||
*/
|
||||
export function toAppSummary(
|
||||
app: AppRow,
|
||||
|
||||
@@ -1,271 +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 { v4 as uuidv4 } from 'uuid';
|
||||
import { afterAll, beforeAll, describe, expect, it, vi } from 'vitest';
|
||||
import { PuterServer } from '../server.ts';
|
||||
import { setupTestServer } from '../testUtil.ts';
|
||||
import { getTaskbarItems } from './taskbarItems.ts';
|
||||
|
||||
describe('getTaskbarItems', () => {
|
||||
let server: PuterServer;
|
||||
let deps: Parameters<typeof getTaskbarItems>[1];
|
||||
|
||||
beforeAll(async () => {
|
||||
server = await setupTestServer();
|
||||
deps = {
|
||||
clients: server.clients,
|
||||
stores: server.stores,
|
||||
apiBaseUrl: 'https://api.puter.com',
|
||||
config: { static_hosting_domain: 'puter.site' },
|
||||
} as unknown as Parameters<typeof getTaskbarItems>[1];
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
await server?.shutdown();
|
||||
});
|
||||
|
||||
const makeUser = async (taskbarItems?: unknown) => {
|
||||
const username = `tb-${Math.random().toString(36).slice(2, 10)}`;
|
||||
const created = await server.stores.user.create({
|
||||
username,
|
||||
uuid: uuidv4(),
|
||||
password: null,
|
||||
email: `${username}@test.local`,
|
||||
} as never);
|
||||
if (taskbarItems !== undefined) {
|
||||
await server.stores.user.update(created.id, {
|
||||
taskbar_items:
|
||||
typeof taskbarItems === 'string'
|
||||
? taskbarItems
|
||||
: JSON.stringify(taskbarItems),
|
||||
});
|
||||
}
|
||||
return (await server.stores.user.getById(created.id))!;
|
||||
};
|
||||
|
||||
const makeApp = async (ownerUserId: number, overrides = {}) => {
|
||||
const name = `tb-app-${Math.random().toString(36).slice(2, 10)}`;
|
||||
return server.stores.app.create(
|
||||
{
|
||||
name,
|
||||
title: `Title ${name}`,
|
||||
index_url: `https://${name}.example.com/`,
|
||||
description: 'a test app',
|
||||
...overrides,
|
||||
},
|
||||
{ ownerUserId },
|
||||
);
|
||||
};
|
||||
|
||||
it('seeds the default taskbar for a user that has none, and persists it', async () => {
|
||||
const user = await makeUser();
|
||||
expect(user.taskbar_items).toBeFalsy();
|
||||
|
||||
await getTaskbarItems(user as never, deps);
|
||||
|
||||
const [row] = await server.clients.db.read(
|
||||
'SELECT `taskbar_items` FROM `user` WHERE `id` = ?',
|
||||
[user.id],
|
||||
);
|
||||
const stored = JSON.parse(String(row.taskbar_items));
|
||||
expect(stored.map((e: { name: string }) => e.name)).toContain(
|
||||
'app-center',
|
||||
);
|
||||
// The cached row must not keep serving the pre-seed value.
|
||||
expect(
|
||||
(await server.stores.user.getById(user.id))?.taskbar_items,
|
||||
).toBeTruthy();
|
||||
});
|
||||
|
||||
it('resolves entries by name, uid and id', async () => {
|
||||
const owner = await makeUser([]);
|
||||
const byName = await makeApp(owner.id);
|
||||
const byUid = await makeApp(owner.id);
|
||||
const byId = await makeApp(owner.id);
|
||||
|
||||
const user = await makeUser([
|
||||
{ name: byName.name, type: 'app' },
|
||||
{ uid: byUid.uid, type: 'app' },
|
||||
{ id: byId.id, type: 'app' },
|
||||
]);
|
||||
|
||||
const items = await getTaskbarItems(user as never, deps);
|
||||
expect(items.map((i) => i.uid)).toEqual([
|
||||
byName.uid,
|
||||
byUid.uid,
|
||||
byId.uid,
|
||||
]);
|
||||
expect(items[0]).toMatchObject({
|
||||
uuid: byName.uid,
|
||||
name: byName.name,
|
||||
title: byName.title,
|
||||
godmode: false,
|
||||
maximize_on_start: false,
|
||||
description: 'a test app',
|
||||
});
|
||||
});
|
||||
|
||||
it('resolves the whole taskbar with one batched lookup per key, not one per entry', async () => {
|
||||
const owner = await makeUser([]);
|
||||
const apps = await Promise.all([0, 1, 2].map(() => makeApp(owner.id)));
|
||||
const byUid = await makeApp(owner.id);
|
||||
const user = await makeUser([
|
||||
...apps.map((app) => ({ name: app.name, type: 'app' })),
|
||||
{ uid: byUid.uid, type: 'app' },
|
||||
]);
|
||||
const appStore = server.stores.app;
|
||||
const spies = {
|
||||
getByName: vi.spyOn(appStore, 'getByName'),
|
||||
getByUid: vi.spyOn(appStore, 'getByUid'),
|
||||
getById: vi.spyOn(appStore, 'getById'),
|
||||
getByNames: vi.spyOn(appStore, 'getByNames'),
|
||||
getByUids: vi.spyOn(appStore, 'getByUids'),
|
||||
};
|
||||
try {
|
||||
const items = await getTaskbarItems(user as never, deps);
|
||||
|
||||
expect(items.map((i) => i.uid)).toEqual([
|
||||
...apps.map((app) => app.uid),
|
||||
byUid.uid,
|
||||
]);
|
||||
expect(spies.getByName).not.toHaveBeenCalled();
|
||||
expect(spies.getByUid).not.toHaveBeenCalled();
|
||||
expect(spies.getById).not.toHaveBeenCalled();
|
||||
expect(spies.getByNames).toHaveBeenCalledTimes(1);
|
||||
expect(spies.getByUids).toHaveBeenCalledTimes(1);
|
||||
} finally {
|
||||
for (const spy of Object.values(spies)) spy.mockRestore();
|
||||
}
|
||||
});
|
||||
|
||||
it('skips non-app entries, the explorer pin, and unresolvable apps', async () => {
|
||||
const owner = await makeUser([]);
|
||||
const app = await makeApp(owner.id);
|
||||
const user = await makeUser([
|
||||
{ name: 'explorer', type: 'app' },
|
||||
{ name: 'nothing-here', type: 'app' },
|
||||
{ name: app.name, type: 'separator' },
|
||||
{ type: 'app' },
|
||||
{ name: app.name, type: 'app' },
|
||||
]);
|
||||
|
||||
const items = await getTaskbarItems(user as never, deps);
|
||||
expect(items).toHaveLength(1);
|
||||
expect(items[0].name).toBe(app.name);
|
||||
});
|
||||
|
||||
it('falls back to an empty taskbar when the stored JSON is corrupt', async () => {
|
||||
const user = await makeUser('{not json');
|
||||
expect(await getTaskbarItems(user as never, deps)).toEqual([]);
|
||||
});
|
||||
|
||||
it('accepts an already-parsed taskbar array on the user row', async () => {
|
||||
const owner = await makeUser([]);
|
||||
const app = await makeApp(owner.id);
|
||||
const user = await makeUser([]);
|
||||
|
||||
const items = await getTaskbarItems(
|
||||
{ ...user, taskbar_items: [{ name: app.name, type: 'app' }] },
|
||||
deps,
|
||||
);
|
||||
expect(items.map((i) => i.name)).toEqual([app.name]);
|
||||
});
|
||||
|
||||
it('builds a sized icon URL by default and drops the icon on request', async () => {
|
||||
const owner = await makeUser([]);
|
||||
const app = await makeApp(owner.id);
|
||||
const user = await makeUser([{ name: app.name, type: 'app' }]);
|
||||
|
||||
const withIcon = await getTaskbarItems(user as never, deps, {
|
||||
iconSize: 64,
|
||||
});
|
||||
expect(withIcon[0].icon).toBe(
|
||||
`https://api.puter.com/app-icon/${app.uid}/64`,
|
||||
);
|
||||
|
||||
const withoutIcon = await getTaskbarItems(user as never, deps, {
|
||||
noIcons: true,
|
||||
});
|
||||
expect('icon' in withoutIcon[0]).toBe(false);
|
||||
});
|
||||
|
||||
it('pairs the icon URL with the direct subdomain URL when one exists', async () => {
|
||||
const owner = await makeUser([]);
|
||||
// An http(s) icon column is what the resize pipeline leaves behind, so
|
||||
// the sized PNG is on the subdomain.
|
||||
const app = await makeApp(owner.id, {
|
||||
icon: 'https://api.puter.com/app-icon/x',
|
||||
});
|
||||
const user = await makeUser([{ name: app.name, type: 'app' }]);
|
||||
|
||||
const items = await getTaskbarItems(user as never, deps, {
|
||||
iconSize: 64,
|
||||
});
|
||||
expect(items[0].icon).toBe(
|
||||
`https://api.puter.com/app-icon/${app.uid}/64`,
|
||||
);
|
||||
expect(items[0].iconCdnUrl).toBe(
|
||||
`https://puter-app-icons.puter.site/${app.uid}-64.png`,
|
||||
);
|
||||
});
|
||||
|
||||
it('reports no subdomain URL for an app whose icon was never generated', async () => {
|
||||
const owner = await makeUser([]);
|
||||
const app = await makeApp(owner.id);
|
||||
const user = await makeUser([{ name: app.name, type: 'app' }]);
|
||||
|
||||
const items = await getTaskbarItems(user as never, deps, {
|
||||
iconSize: 64,
|
||||
});
|
||||
expect(items[0].iconCdnUrl).toBeNull();
|
||||
});
|
||||
|
||||
it('falls back to the raw icon column when no API base URL is configured', async () => {
|
||||
const owner = await makeUser([]);
|
||||
const app = await makeApp(owner.id, {
|
||||
icon: 'https://cdn.example.com/i.png',
|
||||
});
|
||||
const user = await makeUser([{ name: app.name, type: 'app' }]);
|
||||
|
||||
const items = await getTaskbarItems(
|
||||
user as never,
|
||||
{
|
||||
...deps,
|
||||
apiBaseUrl: undefined,
|
||||
} as never,
|
||||
);
|
||||
expect(items[0].icon).toBe('https://cdn.example.com/i.png');
|
||||
});
|
||||
|
||||
it('reports null for an app with no icon and no API base URL', async () => {
|
||||
const owner = await makeUser([]);
|
||||
const app = await makeApp(owner.id);
|
||||
const user = await makeUser([{ name: app.name, type: 'app' }]);
|
||||
|
||||
const items = await getTaskbarItems(
|
||||
user as never,
|
||||
{
|
||||
...deps,
|
||||
apiBaseUrl: undefined,
|
||||
} as never,
|
||||
);
|
||||
expect(items[0].icon).toBeNull();
|
||||
});
|
||||
});
|
||||
@@ -1,134 +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 type { AppIconHostConfig } from './appIcon.js';
|
||||
import { toAppSummary, type AppRow } from './appView.js';
|
||||
|
||||
interface TaskbarEntry {
|
||||
name?: string;
|
||||
id?: number;
|
||||
uid?: string;
|
||||
type?: string;
|
||||
}
|
||||
|
||||
interface TaskbarOptions {
|
||||
iconSize?: number;
|
||||
noIcons?: boolean;
|
||||
}
|
||||
|
||||
interface TaskbarDeps {
|
||||
apiBaseUrl?: string;
|
||||
config?: AppIconHostConfig;
|
||||
stores: {
|
||||
app: {
|
||||
getByNames: (names: string[]) => Promise<Map<string, AppRow>>;
|
||||
getByUids: (uids: string[]) => Promise<Map<string, AppRow>>;
|
||||
getByIds: (ids: number[]) => Promise<Map<number, AppRow>>;
|
||||
};
|
||||
user: {
|
||||
update: (
|
||||
id: number,
|
||||
patch: Record<string, unknown>,
|
||||
) => Promise<unknown>;
|
||||
};
|
||||
};
|
||||
}
|
||||
|
||||
const DEFAULT_TASKBAR_ITEMS: TaskbarEntry[] = [
|
||||
{ name: 'app-center', type: 'app' },
|
||||
{ name: 'builder', type: 'app' },
|
||||
{ name: 'dev-center', type: 'app' },
|
||||
{ name: 'editor', type: 'app' },
|
||||
{ name: 'code', type: 'app' },
|
||||
{ name: 'camera', type: 'app' },
|
||||
{ name: 'recorder', type: 'app' },
|
||||
{ name: 'browser', type: 'app' },
|
||||
];
|
||||
|
||||
export async function getTaskbarItems(
|
||||
user: Record<string, unknown>,
|
||||
deps: TaskbarDeps,
|
||||
options: TaskbarOptions = {},
|
||||
): Promise<Array<Record<string, unknown>>> {
|
||||
let raw: TaskbarEntry[];
|
||||
|
||||
if (!user.taskbar_items) {
|
||||
raw = DEFAULT_TASKBAR_ITEMS;
|
||||
await deps.stores.user.update(user.id as number, {
|
||||
taskbar_items: JSON.stringify(raw),
|
||||
});
|
||||
} else {
|
||||
try {
|
||||
raw =
|
||||
typeof user.taskbar_items === 'string'
|
||||
? JSON.parse(user.taskbar_items as string)
|
||||
: (user.taskbar_items as TaskbarEntry[]);
|
||||
} catch {
|
||||
raw = [];
|
||||
}
|
||||
}
|
||||
|
||||
const entries = raw.filter(
|
||||
(entry) => entry.type === 'app' && entry.name !== 'explorer',
|
||||
);
|
||||
const [byName, byUid, byId] = await Promise.all([
|
||||
deps.stores.app.getByNames(
|
||||
entries.flatMap((entry) => (entry.name ? [entry.name] : [])),
|
||||
),
|
||||
deps.stores.app.getByUids(
|
||||
entries.flatMap((entry) =>
|
||||
!entry.name && entry.uid ? [entry.uid] : [],
|
||||
),
|
||||
),
|
||||
deps.stores.app.getByIds(
|
||||
entries.flatMap((entry) =>
|
||||
!entry.name && !entry.uid && entry.id ? [entry.id] : [],
|
||||
),
|
||||
),
|
||||
]);
|
||||
|
||||
const items: Array<Record<string, unknown>> = [];
|
||||
for (const entry of entries) {
|
||||
const app = entry.name
|
||||
? byName.get(entry.name)
|
||||
: entry.uid
|
||||
? byUid.get(entry.uid)
|
||||
: entry.id
|
||||
? byId.get(entry.id)
|
||||
: undefined;
|
||||
if (!app) continue;
|
||||
|
||||
const item: Record<string, unknown> = {
|
||||
uid: app.uid,
|
||||
...toAppSummary(app, {
|
||||
apiBaseUrl: deps.apiBaseUrl,
|
||||
config: deps.config,
|
||||
iconSize: options.iconSize,
|
||||
}),
|
||||
description: app.description,
|
||||
};
|
||||
if (options.noIcons) {
|
||||
delete item.icon;
|
||||
delete item.iconCdnUrl;
|
||||
}
|
||||
items.push(item);
|
||||
}
|
||||
|
||||
return items;
|
||||
}
|
||||
@@ -85,7 +85,17 @@ describe('buildUserDetails', () => {
|
||||
[`/${user.username}/Desktop`]: user.desktop_uuid,
|
||||
[`/${user.username}/Trash`]: user.trash_uuid,
|
||||
});
|
||||
expect(Array.isArray(details.taskbar_items)).toBe(true);
|
||||
});
|
||||
|
||||
it('leaves out taskbar items saved on the account', async () => {
|
||||
const user = {
|
||||
...(await makeUser()),
|
||||
taskbar_items: JSON.stringify([{ type: 'app', name: 'editor' }]),
|
||||
};
|
||||
const details = await buildUserDetails(user, deps(), {
|
||||
isUser: true,
|
||||
});
|
||||
expect(details).not.toHaveProperty('taskbar_items');
|
||||
});
|
||||
|
||||
it('leaves the desktop-only parts out for an app actor', async () => {
|
||||
@@ -93,7 +103,6 @@ describe('buildUserDetails', () => {
|
||||
const details = await buildUserDetails(user, deps(), {
|
||||
isUser: false,
|
||||
});
|
||||
expect(details).not.toHaveProperty('taskbar_items');
|
||||
expect(details).not.toHaveProperty('directories');
|
||||
expect(details.card_fallback_available).toBe(false);
|
||||
});
|
||||
@@ -124,7 +133,7 @@ describe('buildUserDetails lookups', () => {
|
||||
return keys.slice(keys.indexOf('hasDevAccountAccess') + 1);
|
||||
};
|
||||
|
||||
it('reads the linked provider, taskbar and seat together, listed in a fixed order', async () => {
|
||||
it('reads the linked provider and seat together, listed in a fixed order', async () => {
|
||||
const user = {
|
||||
...(await makeUser()),
|
||||
password: null,
|
||||
@@ -162,7 +171,6 @@ describe('buildUserDetails lookups', () => {
|
||||
);
|
||||
expect(tailKeys(details)).toEqual([
|
||||
'oidc_revalidate_url',
|
||||
'taskbar_items',
|
||||
'directories',
|
||||
'team',
|
||||
'last_activity_ts',
|
||||
@@ -177,7 +185,6 @@ describe('buildUserDetails lookups', () => {
|
||||
const user = {
|
||||
...(await makeUser()),
|
||||
password: null,
|
||||
taskbar_items: JSON.stringify([{ type: 'app', name: 'editor' }]),
|
||||
last_activity_ts: '2026-01-02 03:04:05',
|
||||
};
|
||||
const events: string[] = [];
|
||||
@@ -199,15 +206,6 @@ describe('buildUserDetails lookups', () => {
|
||||
},
|
||||
},
|
||||
stores: Object.assign(Object.create(d.stores), {
|
||||
app: {
|
||||
getByNames: () =>
|
||||
timed(events, 'taskbar', 20, () => {
|
||||
throw new Error('taskbar down');
|
||||
}),
|
||||
getByUids: async () => new Map(),
|
||||
getByIds: async () => new Map(),
|
||||
},
|
||||
// Fails first, but is reported after the taskbar.
|
||||
team: {
|
||||
getOrgSeat: () =>
|
||||
timed(events, 'seat', 5, () => {
|
||||
@@ -219,18 +217,12 @@ describe('buildUserDetails lookups', () => {
|
||||
{ isUser: true },
|
||||
);
|
||||
expect(warn.mock.calls).toEqual([
|
||||
['[user-details] taskbar_items failed:', expect.any(Error)],
|
||||
['[user-details] team lookup failed:', expect.any(Error)],
|
||||
]);
|
||||
} finally {
|
||||
warn.mockRestore();
|
||||
}
|
||||
expect(tailKeys(details)).toEqual([
|
||||
'taskbar_items',
|
||||
'directories',
|
||||
'last_activity_ts',
|
||||
]);
|
||||
expect(details.taskbar_items).toEqual([]);
|
||||
expect(tailKeys(details)).toEqual(['directories', 'last_activity_ts']);
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
@@ -27,18 +27,12 @@ import {
|
||||
isCardFallbackEligible,
|
||||
type CardFallbackClients,
|
||||
} from './cardFallback.js';
|
||||
import { getTaskbarItems } from './taskbarItems.js';
|
||||
import { isEmailGateLast } from './verificationOrder.js';
|
||||
|
||||
type TaskbarDeps = Parameters<typeof getTaskbarItems>[1];
|
||||
|
||||
export interface UserDetailsDeps {
|
||||
config: IConfig;
|
||||
// `db.write` backs the taskbar's first-read default row.
|
||||
clients: CardFallbackClients & {
|
||||
db: { write: (query: string, params?: unknown[]) => Promise<unknown> };
|
||||
};
|
||||
stores: TaskbarDeps['stores'] & {
|
||||
clients: CardFallbackClients;
|
||||
stores: {
|
||||
kv: Pick<SystemKVStore, 'get'>;
|
||||
team?: Pick<TeamStoreContract, 'getOrgSeat'>;
|
||||
};
|
||||
@@ -78,8 +72,8 @@ const SENSITIVE_KEYS: ReadonlySet<string> = new Set([
|
||||
]);
|
||||
|
||||
/**
|
||||
* Delete every sensitive key at any depth (`metadata` and `taskbar_items` are
|
||||
* nested). Depth-limited and cycle-safe. Runs last over a whole payload.
|
||||
* Delete every sensitive key at any depth (`metadata` is nested). Depth-limited
|
||||
* and cycle-safe. Runs last over a whole payload.
|
||||
*/
|
||||
export const scrubSensitive = (
|
||||
value: unknown,
|
||||
@@ -124,7 +118,7 @@ export const toUnixSeconds = (value: unknown): number | undefined => {
|
||||
export async function buildUserDetails(
|
||||
user: UserRow,
|
||||
deps: UserDetailsDeps,
|
||||
opts: { isUser: boolean; iconSize?: number; noIcons?: boolean },
|
||||
opts: { isUser: boolean },
|
||||
): Promise<Record<string, unknown>> {
|
||||
const { config, clients, stores, services } = deps;
|
||||
const { isUser } = opts;
|
||||
@@ -170,9 +164,6 @@ export async function buildUserDetails(
|
||||
cardFallbackDepsFrom(clients),
|
||||
)
|
||||
: false,
|
||||
desktop_bg_url: user.desktop_bg_url,
|
||||
desktop_bg_color: user.desktop_bg_color,
|
||||
desktop_bg_fit: user.desktop_bg_fit,
|
||||
is_temp: user.password === null && user.email === null,
|
||||
is_user_token: true,
|
||||
// Null until the account asks for a code; never minted here.
|
||||
@@ -185,14 +176,6 @@ export async function buildUserDetails(
|
||||
hasDevAccountAccess: !!user.metadata?.hasDevAccountAccess,
|
||||
};
|
||||
|
||||
// Not an inline literal, so a `TaskbarDeps` without `clients` still
|
||||
// accepts it.
|
||||
const taskbarDeps = {
|
||||
clients,
|
||||
stores,
|
||||
apiBaseUrl: String(config.api_base_url ?? ''),
|
||||
config,
|
||||
};
|
||||
const linkedProvider = async () => {
|
||||
if (!oidcOnly) return null;
|
||||
try {
|
||||
@@ -202,19 +185,6 @@ export async function buildUserDetails(
|
||||
return null;
|
||||
}
|
||||
};
|
||||
const taskbarItems = async () => {
|
||||
if (!isUser) return null;
|
||||
try {
|
||||
return {
|
||||
items: await getTaskbarItems(user, taskbarDeps, {
|
||||
iconSize: opts.iconSize,
|
||||
noIcons: opts.noIcons,
|
||||
}),
|
||||
};
|
||||
} catch (error) {
|
||||
return { error };
|
||||
}
|
||||
};
|
||||
// The team that pays for the account; every seat restriction keys on it.
|
||||
const orgSeat = async () => {
|
||||
if (!isUser || config.teams_enabled !== true) return null;
|
||||
@@ -226,26 +196,14 @@ export async function buildUserDetails(
|
||||
};
|
||||
// Independent and each best-effort, so read together; the results land
|
||||
// below in the order the payload has always listed them.
|
||||
const [provider, taskbar, team] = await Promise.all([
|
||||
linkedProvider(),
|
||||
taskbarItems(),
|
||||
orgSeat(),
|
||||
]);
|
||||
const [provider, team] = await Promise.all([linkedProvider(), orgSeat()]);
|
||||
|
||||
if (provider) {
|
||||
const origin = (config.origin ?? '').replace(/\/$/, '');
|
||||
details.oidc_revalidate_url = `${origin}/auth/oidc/${provider}/start?flow=revalidate&user_uuid=${encodeURIComponent(user.uuid)}`;
|
||||
}
|
||||
|
||||
if (taskbar) {
|
||||
// Best-effort: the account still works without them.
|
||||
if ('error' in taskbar) {
|
||||
console.warn('[user-details] taskbar_items failed:', taskbar.error);
|
||||
details.taskbar_items = [];
|
||||
} else {
|
||||
details.taskbar_items = taskbar.items;
|
||||
}
|
||||
|
||||
if (isUser) {
|
||||
const directories: Record<string, unknown> = {};
|
||||
const nameToProp: Record<string, string> = {
|
||||
desktop_uuid: `/${user.username}/Desktop`,
|
||||
|
||||
@@ -196,7 +196,6 @@ async function create_app (title, source_path = null, items = null) {
|
||||
feedbackEnabled: true,
|
||||
metadata: {
|
||||
window_resizable: true,
|
||||
fullpage_on_landing: true,
|
||||
},
|
||||
})
|
||||
.then(async (app) => {
|
||||
@@ -225,7 +224,6 @@ async function create_app (title, source_path = null, items = null) {
|
||||
metadata: {
|
||||
category: null, // default category on creation
|
||||
window_resizable: true,
|
||||
fullpage_on_landing: true,
|
||||
},
|
||||
}).then(async (app) => {
|
||||
// refresh app list
|
||||
@@ -471,11 +469,6 @@ function generate_edit_app_section (app) {
|
||||
<label for="edit-app-background" style="display: inline;">Run as a background process.</label>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<input type="checkbox" id="edit-app-fullpage-on-landing" name="edit-app-fullpage-on-landing" value="true" style="margin-top:30px;" ${app.metadata?.fullpage_on_landing ? 'checked' : ''} ${app.background ? 'disabled' : ''}>
|
||||
<label for="edit-app-fullpage-on-landing" style="display: inline;">Load in full-page mode when a user lands directly on this app.</label>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<input type="checkbox" id="edit-app-maximize-on-start" name="edit-app-maximize-on-start" value="true" style="margin-top:30px;" ${maximize_on_start ? 'checked' : ''} ${app.background ? 'disabled' : ''}>
|
||||
<label for="edit-app-maximize-on-start" style="display: inline;">Maximize window on start</label>
|
||||
@@ -593,7 +586,6 @@ function trackOriginalValues () {
|
||||
resizableWindow: $('#edit-app-window-resizable').is(':checked'),
|
||||
hideTitleBar: $('#edit-app-hide-titlebar').is(':checked'),
|
||||
locked: $('#edit-app-locked').is(':checked'),
|
||||
fullPageOnLanding: $('#edit-app-fullpage-on-landing').is(':checked'),
|
||||
setTitleToFile: $('#edit-app-set-title-to-file').is(':checked'),
|
||||
userFeedback: $('#edit-app-user-feedback').is(':checked'),
|
||||
},
|
||||
@@ -635,7 +627,6 @@ function hasChanges () {
|
||||
$('#edit-app-window-resizable').is(':checked') !== originalValues.checkboxes.resizableWindow ||
|
||||
$('#edit-app-hide-titlebar').is(':checked') !== originalValues.checkboxes.hideTitleBar ||
|
||||
$('#edit-app-locked').is(':checked') !== originalValues.checkboxes.locked ||
|
||||
$('#edit-app-fullpage-on-landing').is(':checked') !== originalValues.checkboxes.fullPageOnLanding ||
|
||||
$('#edit-app-set-title-to-file').is(':checked') !== originalValues.checkboxes.setTitleToFile ||
|
||||
$('#edit-app-user-feedback').is(':checked') !== originalValues.checkboxes.userFeedback
|
||||
);
|
||||
@@ -683,7 +674,6 @@ function resetToOriginalValues () {
|
||||
$('#edit-app-window-resizable').prop('checked', originalValues.checkboxes.resizableWindow);
|
||||
$('#edit-app-hide-titlebar').prop('checked', originalValues.checkboxes.hideTitleBar);
|
||||
$('#edit-app-locked').prop('checked', originalValues.checkboxes.locked);
|
||||
$('#edit-app-fullpage-on-landing').prop('checked', originalValues.checkboxes.fullPageOnLanding);
|
||||
$('#edit-app-set-title-to-file').prop('checked', originalValues.checkboxes.setTitleToFile);
|
||||
$('#edit-app-user-feedback').prop('checked', originalValues.checkboxes.userFeedback);
|
||||
|
||||
@@ -1299,7 +1289,6 @@ async function saveEditedApp (mode) {
|
||||
background: $('#edit-app-background').is(':checked'),
|
||||
feedbackEnabled: $('#edit-app-user-feedback').is(':checked'),
|
||||
metadata: {
|
||||
fullpage_on_landing: $('#edit-app-fullpage-on-landing').is(':checked'),
|
||||
social_image: socialImageUrl,
|
||||
category: category || null,
|
||||
window_size: {
|
||||
@@ -2583,7 +2572,6 @@ $(document).on('change', '#edit-app-background', function (e) {
|
||||
|
||||
function disable_window_settings () {
|
||||
$('#edit-app-maximize-on-start').prop('disabled', true);
|
||||
$('#edit-app-fullpage-on-landing').prop('disabled', true);
|
||||
$('#edit-app-window-width, #edit-app-window-height').prop('disabled', true);
|
||||
$('#edit-app-window-top, #edit-app-window-left').prop('disabled', true);
|
||||
$('#edit-app-window-resizable').prop('disabled', true);
|
||||
@@ -2592,7 +2580,6 @@ function disable_window_settings () {
|
||||
|
||||
function enable_window_settings () {
|
||||
$('#edit-app-maximize-on-start').prop('disabled', false);
|
||||
$('#edit-app-fullpage-on-landing').prop('disabled', false);
|
||||
$('#edit-app-window-width, #edit-app-window-height').prop('disabled', false);
|
||||
$('#edit-app-window-top, #edit-app-window-left').prop('disabled', false);
|
||||
$('#edit-app-window-resizable').prop('disabled', false);
|
||||
|
||||
@@ -41,21 +41,52 @@ An object with the following properties:
|
||||
|
||||
| Option | Type | Description |
|
||||
|--------|------|-------------|
|
||||
| `path` | `String` | The item. Required when passing options as the only argument. |
|
||||
| `recipient` | `String \| Object` | Whose access to withdraw. |
|
||||
| `path` | `String` | The item. Required when passing options as the only argument, unless `paths` or `uid` names it. |
|
||||
| `paths` | `Array` | Several items to withdraw in one call. |
|
||||
| `uid` | `String` | The item, by UID. Can be used instead of `path`. |
|
||||
| `recipient` | `String \| Object \| Array` | Whose access to withdraw. An array withdraws several recipients in one call. |
|
||||
| `recipients` | `String \| Object \| Array` | Alias for `recipient`. |
|
||||
|
||||
## Return value
|
||||
|
||||
A `Promise` that resolves to `{ revoked }`, where `revoked` is how many grants were actually removed. It is `0` when there was nothing to withdraw, which is not an error.
|
||||
A `Promise` that resolves to an object with the following properties:
|
||||
|
||||
| Property | Type | Description |
|
||||
|----------|------|-------------|
|
||||
| `revoked` | `Number` | How many grants were actually removed. It is `0` when there was nothing to withdraw, which is not an error. |
|
||||
| `failed` | `Array` | The recipient/item pairs that were refused. Empty when none were. |
|
||||
|
||||
Each entry of `failed` has the following properties:
|
||||
|
||||
| Property | Type | Description |
|
||||
|----------|------|-------------|
|
||||
| `recipient` | `String` | The recipient as the call named it. This is a username, an email address, a team's uid or handle, or `anyone`. |
|
||||
| `path` | `String` | The item's absolute path, when the call named it by path. A relative path comes back resolved against the app's root directory, and a path that starts with `~` comes back under the user's home directory, such as `/username/report.txt`. |
|
||||
| `uid` | `String` | The item's UID as the call passed it, when the call named it by UID. |
|
||||
| `message` | `String` | Why the pair was refused. |
|
||||
| `code` | `String` | One of the codes below. |
|
||||
|
||||
Each recipient/item pair is withdrawn on its own. With several items or recipients, every combination is one pair. A refused pair does not stop the others. The promise resolves, `revoked` counts what the others removed, and `failed` lists the pairs that were refused.
|
||||
|
||||
## Errors
|
||||
|
||||
A rejection carries `{ message, code }`.
|
||||
The promise rejects only when every pair was refused, and at least one of them for a reason other than the recipient or the item being gone. A pair refused with `user_does_not_exist` or `subject_does_not_exist` has nothing left to withdraw, so a call made only of those resolves with `revoked: 0` and the pairs listed in `failed`.
|
||||
|
||||
That rejection carries `{ message, code, failed }`. The `message` and `code` come from the first refused pair that names a code other than those two. The `failed` array lists every refused pair, with the same properties as in the return value.
|
||||
|
||||
A request that fails as a whole also rejects, with the server's error and no `failed`. This happens when a call names no recipient or no item, or names a team by both `team` and `teamHandle` (`bad_request`), when it names more recipients or items than one call allows (`too_many_recipients`, `too_many_items`), and when it's over the [rate limit](/rate-limits-and-quotas/).
|
||||
|
||||
The codes a refused pair carries, in `failed` or on a rejection:
|
||||
|
||||
| `code` | Meaning |
|
||||
| --- | --- |
|
||||
| `team_share` | You tried to leave an item you hold only through a team. That access is the team's grant, not yours to drop; ask whoever shared it with the team, or leave the team. Returned with status `409`. If you also hold a share of your own, leaving drops that one and succeeds. |
|
||||
| `team_share` | You tried to leave an item you hold only through a team. That access is the team's grant, not yours to drop; ask whoever shared it with the team, or leave the team. If you also hold a share of your own, leaving drops that one and succeeds. |
|
||||
| `forbidden` | You may not withdraw shares of this item, or you tried to close its "anyone with the link" share, which only the owner may do, in person rather than through an app. |
|
||||
| `subject_does_not_exist` | No such item, or you cannot see it. It is listed in `failed` and never causes a rejection on its own. |
|
||||
| `user_does_not_exist` | The username has no account. It is listed in `failed` and never causes a rejection on its own. |
|
||||
| `team_not_found` | No team has that uid. |
|
||||
| `cannot_revoke_owner` | The recipient owns the item. |
|
||||
| `unshare_failed` | No refused pair named a code, as when the server could not complete the request. |
|
||||
|
||||
## Who can withdraw what
|
||||
|
||||
@@ -96,6 +127,19 @@ Passing an email address that was **invited** but has not yet joined cancels the
|
||||
</html>
|
||||
```
|
||||
|
||||
### Withdraw several items and see which were refused
|
||||
|
||||
```js
|
||||
const { revoked, failed } = await puter.fs.unshare({
|
||||
paths: ['report.txt', 'budget.txt', 'notes.txt'],
|
||||
recipient: 'friend',
|
||||
});
|
||||
console.log(`Removed ${revoked} share(s)`);
|
||||
for (const pair of failed) {
|
||||
console.log(`${pair.path} was not withdrawn from ${pair.recipient}: ${pair.message} (${pair.code})`);
|
||||
}
|
||||
```
|
||||
|
||||
### Leave a share someone gave you
|
||||
|
||||
```js
|
||||
|
||||
@@ -27,7 +27,7 @@ A set of key/value pairs that configure the window.
|
||||
| `is_resizable` | `Boolean` | If set to `true`, the user can resize the window. |
|
||||
| `has_head` | `Boolean` | If set to `true`, the window has a head which contains the icon and the close, minimize, and maximize buttons. |
|
||||
| `disable_parent_window` | `Boolean` | If set to `true`, the parent window is blocked until the current window is closed. |
|
||||
| `show_in_taskbar` | `Boolean` | If set to `true`, the window is represented in the taskbar. |
|
||||
| `show_in_taskbar` | `Boolean` | Deprecated. It has no effect. |
|
||||
|
||||
## Return value
|
||||
A `Promise` that resolves to a window handle object with an `id` (String) property identifying the created window. This `id` can be passed as the `window_id` argument to the `setWindow*` methods.
|
||||
@@ -50,7 +50,6 @@ A `Promise` that resolves to a window handle object with an `id` (String) proper
|
||||
is_resizable: false,
|
||||
has_head: true,
|
||||
center: true,
|
||||
show_in_taskbar: false,
|
||||
})
|
||||
</script>
|
||||
</body>
|
||||
|
||||
@@ -36,12 +36,11 @@ Without `background`, Puter creates and shows the window before the app's own co
|
||||
runs, so a service app cannot avoid briefly appearing on screen.
|
||||
|
||||
A background instance stays private to your app for as long as it is hidden: it has no
|
||||
taskbar item and no running mark on its icon, and opening the app from the
|
||||
taskbar or from Puter's app list starts a separate, ordinary instance for the
|
||||
user rather than handing them the one you are talking to. It can show itself at
|
||||
any time with [`puter.ui.showWindow()`](/UI/showWindow), and from that moment it
|
||||
is an ordinary window. It takes its place in the taskbar, and the user can
|
||||
return to it, hide it, or close it like any other.
|
||||
running mark on its icon, and opening the app from Puter's app list starts a
|
||||
separate, ordinary instance for the user rather than handing them the one you
|
||||
are talking to. It can show itself at any time with
|
||||
[`puter.ui.showWindow()`](/UI/showWindow), and from that moment it is an
|
||||
ordinary window that the user can return to, hide, or close like any other.
|
||||
|
||||
A background app closes when the app that launched it closes: it was launched to
|
||||
serve that app, and the user never saw it. Once it has shown itself it keeps
|
||||
|
||||
@@ -33,20 +33,6 @@ Sent on app startup, and whenever the user's locale on Puter is changed. The val
|
||||
}
|
||||
```
|
||||
|
||||
#### `themeChanged`
|
||||
Sent on app startup, and whenever the user's desktop theme on Puter is changed. The value passed to `handler` is:
|
||||
```js
|
||||
{
|
||||
palette: {
|
||||
primaryHue, // (Float) Hue of the theme color
|
||||
primarySaturation, // (String) Saturation of the theme color as a percentage, with % sign
|
||||
primaryLightness, // (String) Lightness of the theme color as a percentage, with % sign
|
||||
primaryAlpha, // (Float) Opacity of the theme color from 0 to 1
|
||||
primaryColor, // (String) CSS color value for text
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### `connection`
|
||||
Sent when another app requests a connection to your app. The value passed to `handler` is:
|
||||
```js
|
||||
|
||||
@@ -418,7 +418,7 @@ For long-lived mounts, sign in with a `-token` username and an API token as the
|
||||
| ------------------------------------------------------------------ | ------------------------------- | ----------- |
|
||||
| `nameAvailable` | 60/min | |
|
||||
| App icon | 12,000/min | Per network |
|
||||
| App landing page (`/app/<name>`, `/desktop/app/<name>`) | 600/min | Per network |
|
||||
| App landing page (`/app/<name>`) | 600/min | Per network |
|
||||
| Names per batch app lookup (`GET /apps/:names`, `POST /query/app`) | 200, up to 200 characters each | |
|
||||
| `metadata` | 16 KiB, measured as JSON | |
|
||||
| `filetypeAssociations` | 200 entries, 60 characters each | |
|
||||
|
||||
@@ -1,7 +1,5 @@
|
||||
## Credits
|
||||
|
||||
The default wallpaper is created by [Milad Fakurian](https://unsplash.com/photos/blue-orange-and-yellow-wallpaper-E8Ufcyxz514) and published on [Unsplash](https://unsplash.com/).
|
||||
|
||||
Icons by [Papirus](https://github.com/PapirusDevelopmentTeam/papirus-icon-theme) under GPL-3.0 license.
|
||||
|
||||
Icons by [Iconoir](https://iconoir.com/) under MIT license.
|
||||
|
||||
@@ -144,7 +144,7 @@ try {
|
||||
|
||||
startServer(1);
|
||||
|
||||
app.get(['/', '/app/*splat', '/action/*splat', '/desktop', '/desktop/app/*splat', '/dashboard'], (req, res) => {
|
||||
app.get(['/', '/app/*splat', '/action/*splat', '/dashboard'], (req, res) => {
|
||||
res.send(generateDevHtml({
|
||||
env: env,
|
||||
api_origin: apiOrigin,
|
||||
|
||||
+4
-5
@@ -484,7 +484,6 @@ const ipc_listener = async (event, handled) => {
|
||||
is_resizable: event.data.options.is_resizable,
|
||||
has_head: event.data.options.has_head,
|
||||
center: event.data.options.center,
|
||||
show_in_taskbar: event.data.options.show_in_taskbar,
|
||||
iframe_srcdoc: event.data.options.content,
|
||||
parent_uuid: event.data.appInstanceID,
|
||||
});
|
||||
@@ -1149,9 +1148,9 @@ const ipc_listener = async (event, handled) => {
|
||||
if ( event.data.y !== undefined ) {
|
||||
event.data.y = parseFloat(event.data.y);
|
||||
// we don't want the window to go off the top edge of the screen
|
||||
if ( event.data.y < window.taskbar_height )
|
||||
if ( event.data.y < 0 )
|
||||
{
|
||||
event.data.y = window.taskbar_height;
|
||||
event.data.y = 0;
|
||||
}
|
||||
// we don't want the window to go off the bottom edge of the screen
|
||||
if ( event.data.y > window.innerHeight - 100 )
|
||||
@@ -1217,9 +1216,9 @@ const ipc_listener = async (event, handled) => {
|
||||
if ( event.data.y !== undefined ) {
|
||||
event.data.y = parseFloat(event.data.y);
|
||||
// we don't want the window to go off the top edge of the screen
|
||||
if ( event.data.y < window.taskbar_height )
|
||||
if ( event.data.y < 0 )
|
||||
{
|
||||
event.data.y = window.taskbar_height;
|
||||
event.data.y = 0;
|
||||
}
|
||||
// we don't want the window to go off the bottom edge of the screen
|
||||
if ( event.data.y > window.innerHeight - 100 )
|
||||
|
||||
@@ -424,15 +424,14 @@ export const authHeadHtml = (flow, title, { openerNotice = true } = {}) => {
|
||||
};
|
||||
|
||||
/**
|
||||
* On a cover page, the logo is a way out: desktop users stay on the desktop,
|
||||
* everyone else goes to the root dashboard.
|
||||
* On a cover page, the logo is a way out, to the root dashboard.
|
||||
*
|
||||
* @param {AuthFlow} flow
|
||||
* @returns {string} Empty where the logo leads nowhere.
|
||||
*/
|
||||
const logoHref = (flow) => {
|
||||
if ( ! flow.page || window.embedded_in_popup ) return '';
|
||||
return window.location.pathname === '/desktop' ? '/desktop' : '/';
|
||||
return '/';
|
||||
};
|
||||
|
||||
/**
|
||||
|
||||
@@ -1,61 +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/>.
|
||||
*/
|
||||
|
||||
const Component = use('util.Component');
|
||||
|
||||
/**
|
||||
* Allows a flex layout of composed components to be
|
||||
* treated as a component.
|
||||
*/
|
||||
export default def(class Flexer extends Component {
|
||||
static ID = 'ui.component.Flexer';
|
||||
|
||||
static PROPERTIES = {
|
||||
children: {},
|
||||
gap: { value: '20pt' },
|
||||
};
|
||||
|
||||
static CSS = `
|
||||
:host > div {
|
||||
height: 100%;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
justify-content: center;
|
||||
}
|
||||
`;
|
||||
|
||||
create_template ({ template }) {
|
||||
// TODO: The way we handle loading assets doesn't work well
|
||||
// with web components, so for now it goes in the template.
|
||||
$(template).html(`
|
||||
<div><slot name="inside"></slot></div>
|
||||
`);
|
||||
}
|
||||
|
||||
on_ready ({ listen }) {
|
||||
for ( const child of this.get('children') ) {
|
||||
child.setAttribute('slot', 'inside');
|
||||
child.attach(this);
|
||||
}
|
||||
|
||||
listen('gap', gap => {
|
||||
$(this.dom_).find('div').first().css('gap', gap);
|
||||
});
|
||||
}
|
||||
});
|
||||
@@ -75,8 +75,7 @@ async function UIDashboard (options) {
|
||||
// eslint-disable-next-line no-unused-vars
|
||||
options = options ?? {};
|
||||
|
||||
// Mark dashboard mode on <body> so window chrome can adapt — e.g. app
|
||||
// windows keep their minimize button even though fullpage-mode hides it.
|
||||
// Mark dashboard mode on <body> so window chrome and notifications can adapt.
|
||||
$('body').addClass('dashboard-mode');
|
||||
|
||||
// Create mutable tabs array from built-in tabs
|
||||
@@ -205,8 +204,8 @@ async function UIDashboard (options) {
|
||||
$item.addClass('active').attr('aria-current', 'page');
|
||||
};
|
||||
|
||||
// Remove `?ref=...` from the URL, keeping the path and tab hash (mirrors
|
||||
// UIDesktop). Replaced, not pushed, so Back leaves the dashboard.
|
||||
// Remove `?ref=...` from the URL, keeping the path and tab hash.
|
||||
// Replaced, not pushed, so Back leaves the dashboard.
|
||||
if ( window.url_query_params?.has('ref') ) {
|
||||
window.history.replaceState(null, document.title, window.location.pathname + window.location.hash);
|
||||
}
|
||||
@@ -273,7 +272,6 @@ async function UIDashboard (options) {
|
||||
|
||||
// =========================================================================
|
||||
// Socket initialization
|
||||
// In dashboard mode, UIDesktop is never loaded, so we create the socket here.
|
||||
// This runs inside the function (not at module level) to ensure window.gui_origin
|
||||
// and window.auth_token are already set.
|
||||
// =========================================================================
|
||||
@@ -368,8 +366,7 @@ async function UIDashboard (options) {
|
||||
// =========================================================================
|
||||
// Item event handlers
|
||||
// Incremental DOM updates using UIDashboardFileItem for item creation and
|
||||
// direct jQuery manipulation for removals/updates. Mirrors UIDesktop's
|
||||
// approach but adapted for Dashboard's list-view structure.
|
||||
// direct jQuery manipulation for removals/updates.
|
||||
// =========================================================================
|
||||
|
||||
// A row taken away from elsewhere: keep the footer's count and size in
|
||||
|
||||
@@ -672,10 +672,30 @@ export default function UIShareModal ({ items, path: item_path, name, owner, fse
|
||||
return created;
|
||||
};
|
||||
|
||||
// Same runs as grant_access. Resolves with the refused items, each with
|
||||
// its error, and rejects with the first when every item was refused. A
|
||||
// run that fails otherwise (rate limit, network) ends it there, rejecting
|
||||
// with that error and the count withdrawn before it as `withdrawn`.
|
||||
const revoke_access = async (recipient, paths) => {
|
||||
const failed = [];
|
||||
let attempted = 0;
|
||||
for ( const run of chunk(paths, MAX_ITEMS_PER_REQUEST) ) {
|
||||
await puter.fs.unshare({ paths: run, recipient });
|
||||
try {
|
||||
const result = await puter.fs.unshare({ paths: run, recipient });
|
||||
failed.push(...(result?.failed ?? []));
|
||||
} catch (err) {
|
||||
// Only a rejection for refused pairs lists them.
|
||||
if ( ! Array.isArray(err?.failed) ) {
|
||||
const withdrawn = attempted - failed.length;
|
||||
if ( withdrawn && err && typeof err === 'object' ) err.withdrawn = withdrawn;
|
||||
throw err;
|
||||
}
|
||||
failed.push(...err.failed);
|
||||
}
|
||||
attempted += run.length;
|
||||
}
|
||||
if ( failed.length >= paths.length ) throw failed[0];
|
||||
return failed;
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -685,6 +705,8 @@ export default function UIShareModal ({ items, path: item_path, name, owner, fse
|
||||
const set_link_access = async (mode, el_control) => {
|
||||
$link_access.prop('disabled', true);
|
||||
$link_mode.prop('disabled', true);
|
||||
// Shown once the refresh settles, so its own notice can't replace it.
|
||||
let outcome_error = null;
|
||||
try {
|
||||
if ( mode ) {
|
||||
const created = await grant_access({ anyone: true }, mode, target_paths);
|
||||
@@ -692,26 +714,37 @@ export default function UIShareModal ({ items, path: item_path, name, owner, fse
|
||||
link_state = { access: 'anyone', mode };
|
||||
show_success(i18n(`share_link_on_${mode === 'write' ? 'write' : 'read'}${is_multi ? '_items' : ''}`));
|
||||
} else {
|
||||
await revoke_access({ anyone: true }, target_paths);
|
||||
link_state = { access: 'restricted', mode: null };
|
||||
show_success(i18n(is_multi ? 'share_link_off_items' : 'share_link_off'));
|
||||
const failed = await revoke_access({ anyone: true }, target_paths);
|
||||
if ( failed.length ) {
|
||||
link_state = { access: 'mixed', mode: null };
|
||||
outcome_error = `${i18n('share_link_off_partial', { count: total - failed.length, total })}. ${error_html(failed[0])}`;
|
||||
} else {
|
||||
link_state = { access: 'restricted', mode: null };
|
||||
show_success(i18n(is_multi ? 'share_link_off_items' : 'share_link_off'));
|
||||
}
|
||||
}
|
||||
} catch (err) {
|
||||
// A plan gate gets the flow that clears it, where the deployment
|
||||
// has one; a refusal is otherwise reported like any other.
|
||||
if ( is_plan_gate_error(err) ) {
|
||||
if ( ! open_upgrade_flow() ) show_error(i18n('share_link_requires_plan'));
|
||||
if ( ! open_upgrade_flow() ) outcome_error = i18n('share_link_requires_plan');
|
||||
} else if ( err?.withdrawn ) {
|
||||
// Runs that landed before the failure closed the link all the same.
|
||||
link_state = { access: 'mixed', mode: null };
|
||||
outcome_error = `${i18n('share_link_off_partial', { count: err.withdrawn, total })}. ${error_html(err)}`;
|
||||
} else {
|
||||
show_error(error_html(err));
|
||||
outcome_error = error_html(err);
|
||||
}
|
||||
} finally {
|
||||
$link_access.prop('disabled', false);
|
||||
$link_mode.prop('disabled', false);
|
||||
}
|
||||
if ( outcome_error ) show_error(outcome_error);
|
||||
// The listings are the truth either way, and they put the control
|
||||
// back; a selection too large to list keeps what was just applied.
|
||||
invalidate_shared_roots();
|
||||
await refresh();
|
||||
if ( outcome_error ) show_error(outcome_error);
|
||||
render_link_access();
|
||||
if ( el_control && $(el_control).is(':visible') ) el_control.focus({ preventScroll: true });
|
||||
else focus_dialog();
|
||||
@@ -978,7 +1011,22 @@ export default function UIShareModal ({ items, path: item_path, name, owner, fse
|
||||
const revoke_paths = group.pending ? group.pendingPaths : group.directPaths;
|
||||
$(this).closest('.share-modal-row-confirm').find('button').prop('disabled', true);
|
||||
try {
|
||||
await revoke_access(recipient_of(group), revoke_paths);
|
||||
const failed = await revoke_access(recipient_of(group), revoke_paths);
|
||||
// Some items were refused: say how many went through, and stay
|
||||
// open on what the listing now shows.
|
||||
if ( failed.length ) {
|
||||
invalidate_shared_roots();
|
||||
await refresh();
|
||||
// After the refresh: a refused item may not list any more,
|
||||
// and that notice must not replace this one.
|
||||
show_error(`${i18n('share_access_removed_partial', {
|
||||
recipient: group.name,
|
||||
count: revoke_paths.length - failed.length,
|
||||
total: revoke_paths.length,
|
||||
})}. ${error_html(failed[0])}`);
|
||||
focus_list_control('.share-modal-row-mode', key) || focus_dialog();
|
||||
return;
|
||||
}
|
||||
// Leaving takes away the access this list is read with, and the
|
||||
// items may leave the listing behind it (the Shared view) too.
|
||||
if ( ! group.teamUid && ! group.pending && group.name === window.user.username ) {
|
||||
|
||||
@@ -43,6 +43,7 @@ globalThis.def = globalThis.def ?? (value => value);
|
||||
globalThis.use = globalThis.use ?? (() => class {});
|
||||
|
||||
const { default: UIShareModal } = await import('./UIShareModal.js');
|
||||
const { unshareAnswering, allRefused, refusing } = await import('../../../tests/fixtures/sdkUnshare.js');
|
||||
|
||||
const settle = async () => {
|
||||
for ( let i = 0; i < 5; i++ ) await new Promise(resolve => setTimeout(resolve, 0));
|
||||
@@ -82,6 +83,126 @@ describe('UIShareModal general access', () => {
|
||||
expect($('.share-modal-link-access').val()).toBe('restricted');
|
||||
});
|
||||
|
||||
it('shows the error when closing the link is refused', async () => {
|
||||
puter.fs.getShares = vi.fn(async () => [{ holder: null, anyone: true, mode: 'read', issuer: 'alice' }]);
|
||||
puter.fs.unshare = unshareAnswering(allRefused);
|
||||
UIShareModal({ path: '/alice/a.txt' });
|
||||
await settle();
|
||||
expect($('.share-modal-link-access').val()).toBe('anyone');
|
||||
|
||||
$('.share-modal-link-access').val('restricted').trigger('change');
|
||||
await settle();
|
||||
expect($('.share-modal-status').hasClass('share-modal-status-error')).toBe(true);
|
||||
expect($('.share-modal-status').text()).toBe('Held through a team');
|
||||
expect($('.share-modal-link-access').val()).toBe('anyone');
|
||||
});
|
||||
|
||||
it('says how many items the link was closed on when some were refused', async () => {
|
||||
puter.fs.getShares = vi.fn(async () => [{ holder: null, anyone: true, mode: 'read', issuer: 'alice' }]);
|
||||
puter.fs.unshare = unshareAnswering((request) => refusing(
|
||||
request,
|
||||
(path) => path === '/alice/f1.txt',
|
||||
{ code: 'forbidden', message: 'Not allowed' },
|
||||
));
|
||||
UIShareModal({ items: items(3) });
|
||||
await settle();
|
||||
|
||||
$('.share-modal-link-access').val('restricted').trigger('change');
|
||||
await settle();
|
||||
expect($('.share-modal-status').hasClass('share-modal-status-error')).toBe(true);
|
||||
expect($('.share-modal-status').text()).toBe(
|
||||
'Only people with access can open 2 of 3 items now. Not allowed',
|
||||
);
|
||||
});
|
||||
|
||||
it('keeps the count on screen when a refused item no longer lists, closing the link', async () => {
|
||||
let gone = false;
|
||||
puter.fs.getShares = vi.fn(async (path) => {
|
||||
if ( gone && path === '/alice/f1.txt' ) throw { message: 'Subject does not exist' };
|
||||
return [{ holder: null, anyone: true, mode: 'read', issuer: 'alice' }];
|
||||
});
|
||||
puter.fs.unshare = unshareAnswering((request) => refusing(
|
||||
request,
|
||||
(path) => path === '/alice/f1.txt',
|
||||
{ code: 'subject_does_not_exist', message: 'Subject does not exist' },
|
||||
));
|
||||
UIShareModal({ items: items(3) });
|
||||
await settle();
|
||||
gone = true;
|
||||
|
||||
$('.share-modal-link-access').val('restricted').trigger('change');
|
||||
await settle();
|
||||
expect($('.share-modal-status').text()).toBe(
|
||||
'Only people with access can open 2 of 3 items now. Subject does not exist',
|
||||
);
|
||||
});
|
||||
|
||||
it('goes on past a run that was refused whole, and counts every refused item', async () => {
|
||||
const requests = [];
|
||||
// Runs of 50: the second is refused whole, the third loses one item.
|
||||
puter.fs.unshare = unshareAnswering((request) => {
|
||||
requests.push(request.items.length);
|
||||
const run = requests.length;
|
||||
return refusing(
|
||||
request,
|
||||
(path) => run === 2 || path === '/alice/f119.txt',
|
||||
{ code: 'forbidden', message: 'Not allowed' },
|
||||
);
|
||||
});
|
||||
UIShareModal({ items: items(120) });
|
||||
await settle();
|
||||
|
||||
$('.share-modal-link-access').val('restricted').trigger('change');
|
||||
await settle();
|
||||
expect(requests).toEqual([50, 50, 20]);
|
||||
expect($('.share-modal-status').hasClass('share-modal-status-error')).toBe(true);
|
||||
expect($('.share-modal-status').text()).toBe(
|
||||
'Only people with access can open 69 of 120 items now. Not allowed',
|
||||
);
|
||||
expect($('.share-modal-link-access')[0].value).toBe('mixed');
|
||||
});
|
||||
|
||||
it('stops at a run the server turned away whole, and counts only what was closed before it', async () => {
|
||||
const requests = [];
|
||||
// Runs of 50: the second is rate limited, so the third is never sent.
|
||||
puter.fs.unshare = unshareAnswering((request, xhr) => {
|
||||
requests.push(request.items.length);
|
||||
if ( requests.length === 2 ) {
|
||||
xhr.status = 429;
|
||||
return { message: 'Too many requests', code: 'too_many_requests' };
|
||||
}
|
||||
return refusing(request, () => false);
|
||||
});
|
||||
UIShareModal({ items: items(120) });
|
||||
await settle();
|
||||
|
||||
$('.share-modal-link-access').val('restricted').trigger('change');
|
||||
await settle();
|
||||
expect(requests).toEqual([50, 50]);
|
||||
expect($('.share-modal-status').hasClass('share-modal-status-error')).toBe(true);
|
||||
expect($('.share-modal-status').text()).toBe(
|
||||
'Only people with access can open 50 of 120 items now. Too many requests',
|
||||
);
|
||||
expect($('.share-modal-link-access')[0].value).toBe('mixed');
|
||||
});
|
||||
|
||||
it('reports a failed request as it is, with no item counted as refused', async () => {
|
||||
const requests = [];
|
||||
puter.fs.unshare = unshareAnswering((request, xhr) => {
|
||||
requests.push(request.items.length);
|
||||
xhr.status = 429;
|
||||
return { message: 'Too many requests', code: 'too_many_requests' };
|
||||
});
|
||||
UIShareModal({ items: items(120) });
|
||||
await settle();
|
||||
|
||||
$('.share-modal-link-access').val('restricted').trigger('change');
|
||||
await settle();
|
||||
expect(requests).toEqual([50]);
|
||||
expect($('.share-modal-status').text()).toBe('Too many requests');
|
||||
expect($('.share-modal-link-access')[0].value).toBe('unchecked');
|
||||
});
|
||||
|
||||
it('shows a listed selection as the listings say', async () => {
|
||||
UIShareModal({ items: items(2) });
|
||||
await settle();
|
||||
@@ -154,6 +275,67 @@ describe('UIShareModal removing access', () => {
|
||||
expect(puter.fs.unshare).toHaveBeenCalledWith({ paths: ['/alice/a.txt'], recipient: 'bob' });
|
||||
});
|
||||
|
||||
it('keeps the row and shows the error when the removal is refused', async () => {
|
||||
puter.fs.getShares = vi.fn(async () => [{ holder: 'bob', mode: 'read', issuer: 'alice' }]);
|
||||
puter.fs.unshare = unshareAnswering(allRefused);
|
||||
UIShareModal({ path: '/alice/a.txt' });
|
||||
await settle();
|
||||
|
||||
$('.share-modal-row-mode').val('__remove').trigger('change');
|
||||
$('.share-modal-confirm-remove').trigger('click');
|
||||
await settle();
|
||||
expect($('.share-modal-status').hasClass('share-modal-status-error')).toBe(true);
|
||||
expect($('.share-modal-status').text()).toBe('Held through a team');
|
||||
expect($('.share-modal-row-mode').attr('data-key')).toBeTruthy();
|
||||
expect($('.share-modal-row-mode').val()).toBe('read');
|
||||
});
|
||||
|
||||
it('says how many items a person was removed from when one was refused', async () => {
|
||||
puter.fs.getShares = vi.fn(async () => [{ holder: 'bob', mode: 'read', issuer: 'alice' }]);
|
||||
puter.fs.unshare = unshareAnswering((request) => refusing(
|
||||
request,
|
||||
(path) => path === '/alice/f2.txt',
|
||||
{ code: 'forbidden', message: 'Not allowed' },
|
||||
));
|
||||
UIShareModal({ items: [0, 1, 2].map((i) => ({ path: `/alice/f${i}.txt` })) });
|
||||
await settle();
|
||||
|
||||
$('.share-modal-row-mode').val('__remove').trigger('change');
|
||||
$('.share-modal-confirm-remove').trigger('click');
|
||||
await settle();
|
||||
expect($('.share-modal-status').hasClass('share-modal-status-error')).toBe(true);
|
||||
expect($('.share-modal-status').text()).toBe('Removed bob from 2 of 3 items. Not allowed');
|
||||
expect($('.share-modal-row-mode').length).toBe(1);
|
||||
});
|
||||
|
||||
it('keeps the count on screen when a refused item no longer lists', async () => {
|
||||
let removed = false;
|
||||
puter.fs.getShares = vi.fn(async (path) => {
|
||||
if ( removed && path === '/alice/f2.txt' ) throw { message: 'Subject does not exist' };
|
||||
return removed ? [] : [{ holder: 'bob', mode: 'read', issuer: 'alice' }];
|
||||
});
|
||||
const answering = unshareAnswering((request) => refusing(
|
||||
request,
|
||||
(path) => path === '/alice/f2.txt',
|
||||
{ code: 'subject_does_not_exist', message: 'Subject does not exist' },
|
||||
));
|
||||
puter.fs.unshare = async (...args) => {
|
||||
removed = true;
|
||||
return answering(...args);
|
||||
};
|
||||
UIShareModal({ items: [0, 1, 2].map((i) => ({ path: `/alice/f${i}.txt` })) });
|
||||
await settle();
|
||||
|
||||
$('.share-modal-row-mode').val('__remove').trigger('change');
|
||||
$('.share-modal-confirm-remove').trigger('click');
|
||||
await settle();
|
||||
expect($('.share-modal-status').hasClass('share-modal-status-error')).toBe(true);
|
||||
expect($('.share-modal-status').text()).toBe(
|
||||
'Removed bob from 2 of 3 items. Subject does not exist',
|
||||
);
|
||||
expect($('.share-modal-row-mode').length).toBe(0);
|
||||
});
|
||||
|
||||
it('offers cancelling an invitation from its menu', async () => {
|
||||
puter.fs.getShares = vi.fn(async () => [
|
||||
{ holder: null, recipientEmail: '[email protected]', pending: true, mode: 'write', issuer: 'alice' },
|
||||
|
||||
@@ -79,7 +79,6 @@ async function UIWindowDisable2FA (options) {
|
||||
width: 350,
|
||||
height: 'auto',
|
||||
dominant: true,
|
||||
show_in_taskbar: false,
|
||||
on_before_exit: async () => {
|
||||
if ( ! disabled_successfully ) {
|
||||
promise.resolve(false);
|
||||
|
||||
@@ -136,7 +136,6 @@ function UIAlert (options) {
|
||||
selectable_body: false,
|
||||
draggable_body: options.draggable_body ?? true,
|
||||
allow_context_menu: false,
|
||||
show_in_taskbar: false,
|
||||
window_class: 'window-alert',
|
||||
dominant: true,
|
||||
body_content: h,
|
||||
|
||||
@@ -1,47 +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 UIWindow from './UIWindow.js';
|
||||
import Placeholder from '../util/Placeholder.js';
|
||||
import JustHTML from './Components/JustHTML.js';
|
||||
|
||||
/**
|
||||
* @typedef {Object} UIComponentWindowOptions
|
||||
* @property {Component} [component] A component to render in the window
|
||||
* @property {string} [html] HTML string to render in the window (uses JustHTML component)
|
||||
*/
|
||||
|
||||
/**
|
||||
* Render a UIWindow that contains an instance of Component or HTML string
|
||||
* @param {UIComponentWindowOptions} options
|
||||
*/
|
||||
export default async function UIComponentWindow (options) {
|
||||
const component = options.component ?? new JustHTML({ html: options.html ?? '' });
|
||||
const placeholder = Placeholder();
|
||||
|
||||
const win = await UIWindow({
|
||||
...options,
|
||||
|
||||
body_content: placeholder.html,
|
||||
});
|
||||
|
||||
component.attach(placeholder);
|
||||
component.focus();
|
||||
|
||||
return win;
|
||||
}
|
||||
@@ -568,9 +568,9 @@ function UIContextMenu (options) {
|
||||
|
||||
// Y position
|
||||
// is the menu going to go out of the window from the bottom?
|
||||
if ( (start_y + menu_height) > (window.innerHeight - window.taskbar_height - 10) )
|
||||
if ( (start_y + menu_height) > (window.innerHeight - 10) )
|
||||
{
|
||||
y_pos = window.innerHeight - menu_height - window.taskbar_height - 10;
|
||||
y_pos = window.innerHeight - menu_height - 10;
|
||||
}
|
||||
else
|
||||
{
|
||||
@@ -801,9 +801,6 @@ function UIContextMenu (options) {
|
||||
$(options.parent_element).css('overflow', 'scroll');
|
||||
|
||||
$(options.parent_element).removeClass('has-open-contextmenu');
|
||||
if ( $(options.parent_element).hasClass('taskbar-item') ) {
|
||||
window.make_taskbar_sortable();
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
|
||||
File diff suppressed because it is too large.
Load diff
@@ -25,8 +25,6 @@ import path from '../lib/path.js';
|
||||
import truncate_filename from '../helpers/truncateFilename.js';
|
||||
import launch_app from '../helpers/launchApp.js';
|
||||
import open_item from '../helpers/openItem.js';
|
||||
import publish_as_website from '../helpers/publishAsWebsite.js';
|
||||
import mime from '../lib/mime.js';
|
||||
import { isWeblinkName, weblinkChangeIconMenuItem } from '../helpers/weblink.js';
|
||||
import { is_owned_by_me } from '../helpers/pathOwner.js';
|
||||
import { can_rename, can_restructure, invalidate_shared_roots } from '../helpers/sharedAccess.js';
|
||||
@@ -236,17 +234,6 @@ async function UIItem (options) {
|
||||
window.update_explorer_footer_item_count(el_window);
|
||||
}
|
||||
|
||||
// manual positioning
|
||||
if ( !window.is_auto_arrange_enabled &&
|
||||
options.position &&
|
||||
// item is on the desktop (must be desktop itself and not a window, hence the '.desktop' class check)
|
||||
$(el_item).closest('.item-container.desktop').attr('data-path') === window.desktop_path
|
||||
) {
|
||||
el_item.style.position = 'absolute';
|
||||
el_item.style.left = `${options.position.left }px`;
|
||||
el_item.style.top = `${options.position.top }px`;
|
||||
}
|
||||
|
||||
// --------------------------------------------------------
|
||||
// Dragster
|
||||
// allow dragging of local files on this window, if it's is_dir
|
||||
@@ -331,8 +318,8 @@ async function UIItem (options) {
|
||||
// Constrain item within desktop bounds
|
||||
const minLeft = -50;
|
||||
const maxLeft = window.desktop_width - 50;
|
||||
const minTop = window.toolbar_height;
|
||||
const maxTop = window.desktop_height + window.toolbar_height;
|
||||
const minTop = 0;
|
||||
const maxTop = window.desktop_height;
|
||||
|
||||
// Apply constraints to ui.position
|
||||
ui.position.left = Math.max(minLeft, Math.min(maxLeft, ui.position.left));
|
||||
@@ -411,21 +398,6 @@ async function UIItem (options) {
|
||||
}
|
||||
},
|
||||
stop: function (event, ui) {
|
||||
// Allow rearranging only if item is on desktop, not trash container, auto arrange is disabled and item is not dropped into another item
|
||||
// the desktop itself, not a window showing the Desktop folder
|
||||
if ( $(el_item).closest('.item-container').hasClass('desktop') &&
|
||||
!window.is_auto_arrange_enabled && $(el_item).attr('data-path') !== window.trash_path && !ui.helper.data('dropped') &&
|
||||
// Item must be dropped on the Desktop and not on the taskbar
|
||||
window.mouseover_window === undefined && ui.position.top <= window.desktop_height - window.taskbar_height - 15 ) {
|
||||
|
||||
el_item.style.position = 'absolute';
|
||||
el_item.style.left = `${ui.position.left }px`;
|
||||
el_item.style.top = `${ui.position.top }px`;
|
||||
$('.ui-draggable-dragging').remove();
|
||||
window.desktop_item_positions[$(el_item).attr('data-uid')] = ui.position;
|
||||
window.save_desktop_item_positions();
|
||||
}
|
||||
|
||||
$('.item-selected-clone').remove();
|
||||
$('.draggable-count-badge').remove();
|
||||
// re-enable all droppable UIItems that are not a dir
|
||||
@@ -548,11 +520,6 @@ async function UIItem (options) {
|
||||
else if ( options.is_dir ) {
|
||||
// a selected folder can be the drop target of its own selection; it stays where it is
|
||||
const items_to_drop = items_to_move.filter(item => $(item).attr('data-uid') !== $(el_item).attr('data-uid'));
|
||||
if ( $(el_item).closest('.item-container').attr('data-path') === window.desktop_path ) {
|
||||
// the items leaving the desktop lose their saved positions, not the folder they land in
|
||||
items_to_drop.forEach(item => delete window.desktop_item_positions[$(item).attr('data-uid')]);
|
||||
window.save_desktop_item_positions();
|
||||
}
|
||||
window.move_items(items_to_drop, $(el_item).attr('data-shortcut_to_path') !== '' ? $(el_item).attr('data-shortcut_to_path') : $(el_item).attr('data-path'));
|
||||
}
|
||||
}
|
||||
@@ -1243,23 +1210,6 @@ async function UIItem (options) {
|
||||
}
|
||||
}
|
||||
// -------------------------------------------
|
||||
// Publish As Website
|
||||
// -------------------------------------------
|
||||
if ( !is_trashed && !is_trash && options.is_dir ) {
|
||||
menu_items.push({
|
||||
html: i18n('publish_as_website'),
|
||||
disabled: !options.is_dir,
|
||||
onClick: async function () {
|
||||
await publish_as_website({
|
||||
uid: options.uid,
|
||||
name: $(el_item).attr('data-name'),
|
||||
path: $(el_item).attr('data-path'),
|
||||
});
|
||||
},
|
||||
});
|
||||
|
||||
}
|
||||
// -------------------------------------------
|
||||
// Deploy As App
|
||||
// -------------------------------------------
|
||||
if ( !is_trashed && !is_trash && options.is_dir ) {
|
||||
@@ -1311,48 +1261,6 @@ async function UIItem (options) {
|
||||
});
|
||||
}
|
||||
// -------------------------------------------
|
||||
// Set as Wallpaper
|
||||
// -------------------------------------------
|
||||
const mime_type = mime.getType($(el_item).attr('data-name')) ??
|
||||
'application/octet-stream';
|
||||
if ( !is_trashed && !is_trash && !options.is_dir && mime_type.startsWith('image/') ) {
|
||||
menu_items.push({
|
||||
html: i18n('set_as_background'),
|
||||
onClick: async function () {
|
||||
const read_url = await puter.fs.sign(undefined, { uid: $(el_item).attr('data-uid'), action: 'read' });
|
||||
window.set_desktop_background({
|
||||
url: read_url.items.read_url,
|
||||
fit: window.desktop_bg_fit,
|
||||
});
|
||||
try {
|
||||
$.ajax({
|
||||
url: `${window.api_origin }/set-desktop-bg`,
|
||||
type: 'POST',
|
||||
data: JSON.stringify({
|
||||
url: window.desktop_bg_url,
|
||||
color: window.desktop_bg_color,
|
||||
fit: window.desktop_bg_fit,
|
||||
}),
|
||||
async: true,
|
||||
contentType: 'application/json',
|
||||
headers: {
|
||||
'Authorization': `Bearer ${window.auth_token}`,
|
||||
},
|
||||
statusCode: {
|
||||
401: function (xhr) {
|
||||
window.handle401(xhr);
|
||||
},
|
||||
},
|
||||
});
|
||||
$(el_window).close();
|
||||
resolve(true);
|
||||
} catch ( err ) {
|
||||
// Ignore
|
||||
}
|
||||
},
|
||||
});
|
||||
}
|
||||
// -------------------------------------------
|
||||
// Zip
|
||||
// -------------------------------------------
|
||||
if ( !is_trash && !is_trashed && !$(el_item).attr('data-path').endsWith('.zip') ) {
|
||||
@@ -1509,10 +1417,11 @@ async function UIItem (options) {
|
||||
html: i18n('share_remove_from_shared'),
|
||||
onClick: async function () {
|
||||
try {
|
||||
await puter.fs.unshare(
|
||||
const left = await puter.fs.unshare(
|
||||
$(el_item).attr('data-path'),
|
||||
window.user.username,
|
||||
);
|
||||
if ( left?.failed?.length ) throw left.failed[0];
|
||||
// Or mode lookups keep answering for a share we
|
||||
// just walked away from.
|
||||
invalidate_shared_roots();
|
||||
@@ -1597,7 +1506,7 @@ async function UIItem (options) {
|
||||
left = left > (window.innerWidth - window_width) ? (window.innerWidth - window_width) : left;
|
||||
|
||||
let top = $(el_item).position().top + $(el_item).height();
|
||||
top = top > (window.innerHeight - (window_height + window.taskbar_height + window.toolbar_height)) ? (window.innerHeight - (window_height + window.taskbar_height + window.toolbar_height)) : top;
|
||||
top = top > (window.innerHeight - window_height) ? (window.innerHeight - window_height) : top;
|
||||
|
||||
UIWindowItemProperties(
|
||||
$(el_item).attr('data-name'),
|
||||
@@ -1614,7 +1523,7 @@ async function UIItem (options) {
|
||||
|
||||
// Create ContextMenu
|
||||
UIContextMenu({
|
||||
parent_element: ($(options.appendTo).hasClass('desktop') ? undefined : options.appendTo),
|
||||
parent_element: options.appendTo,
|
||||
position: menu_position,
|
||||
items: menu_items,
|
||||
});
|
||||
|
||||
@@ -29,7 +29,6 @@ vi.mock('./UIContextMenu.js', () => ({ default: vi.fn() }));
|
||||
vi.mock('./UIAlert.js', () => ({ default: vi.fn() }));
|
||||
vi.mock('../helpers/launchApp.js', () => ({ default: vi.fn() }));
|
||||
vi.mock('../helpers/openItem.js', () => ({ default: vi.fn() }));
|
||||
vi.mock('../helpers/publishAsWebsite.js', () => ({ default: vi.fn() }));
|
||||
vi.mock('../helpers/openWithAI.js', () => ({ default: vi.fn() }));
|
||||
vi.mock('../helpers/refreshItemContainer.js', () => ({ default: vi.fn() }));
|
||||
|
||||
@@ -66,10 +65,13 @@ Object.assign(window, {
|
||||
|
||||
const { default: UIItem } = await import('./UIItem.js');
|
||||
const { default: UIContextMenu } = await import('./UIContextMenu.js');
|
||||
const { default: UIAlert } = await import('./UIAlert.js');
|
||||
const { unshareAnswering, allRefused, goneRefused } =
|
||||
await import('../../tests/fixtures/sdkUnshare.js');
|
||||
const { default: refresh_item_container } =
|
||||
await import('../helpers/refreshItemContainer.js');
|
||||
|
||||
const menuLabels = async (options) => {
|
||||
const menuItems = async (options) => {
|
||||
document.body.innerHTML =
|
||||
'<div class="window"><div class="item-container"></div></div>';
|
||||
await UIItem({
|
||||
@@ -88,9 +90,12 @@ const menuLabels = async (options) => {
|
||||
UIContextMenu.mockClear();
|
||||
$('.item').trigger('contextmenu');
|
||||
await vi.waitFor(() => expect(UIContextMenu).toHaveBeenCalled());
|
||||
return UIContextMenu.mock.calls[0][0].items.map((item) => item?.html);
|
||||
return UIContextMenu.mock.calls[0][0].items;
|
||||
};
|
||||
|
||||
const menuLabels = async (options) =>
|
||||
(await menuItems(options)).map((item) => item?.html);
|
||||
|
||||
const removeFromShared = async (options) => {
|
||||
await menuLabels(options);
|
||||
await UIContextMenu.mock.calls[0][0].items
|
||||
@@ -110,6 +115,7 @@ describe('UIItem Remove from Shared', () => {
|
||||
};
|
||||
globalThis.puter = window.puter;
|
||||
refresh_item_container.mockClear();
|
||||
UIAlert.mockClear();
|
||||
});
|
||||
|
||||
it('is offered on an item shared with the user directly', async () => {
|
||||
@@ -122,6 +128,29 @@ describe('UIItem Remove from Shared', () => {
|
||||
expect(labels).not.toContain('share_remove_from_shared');
|
||||
});
|
||||
|
||||
it('keeps the item and shows the error when leaving is refused', async () => {
|
||||
puter.fs.unshare = unshareAnswering(allRefused);
|
||||
const items = await menuItems({});
|
||||
await items
|
||||
.find((item) => item?.html === 'share_remove_from_shared')
|
||||
.onClick();
|
||||
|
||||
expect(UIAlert).toHaveBeenCalledWith({
|
||||
message: 'Held through a team',
|
||||
});
|
||||
expect($('.item').length).toBe(1);
|
||||
});
|
||||
|
||||
it('keeps the item and shows why when the unshare resolves with the pair refused', async () => {
|
||||
puter.fs.unshare = unshareAnswering(goneRefused);
|
||||
await removeFromShared({});
|
||||
|
||||
expect(UIAlert).toHaveBeenCalledWith({
|
||||
message: 'Subject does not exist',
|
||||
});
|
||||
expect($('.item').length).toBe(1);
|
||||
});
|
||||
|
||||
it('takes the item away once the user has left it', async () => {
|
||||
await removeFromShared({});
|
||||
expect(puter.fs.unshare).toHaveBeenCalledWith('/bob/u-1/Photos', 'alice');
|
||||
@@ -175,3 +204,24 @@ describe('UIItem Publish as Worker', () => {
|
||||
expect(labels).not.toContain('publish_as_serverless_worker');
|
||||
});
|
||||
});
|
||||
|
||||
describe('UIItem Publish as Website', () => {
|
||||
beforeEach(() => {
|
||||
window.user = { username: 'alice' };
|
||||
window.trash_path = '/alice/Trash';
|
||||
});
|
||||
|
||||
it('is not offered, even on a folder the user owns', async () => {
|
||||
const labels = await menuLabels({
|
||||
path: '/alice/Site',
|
||||
name: 'Site',
|
||||
is_dir: true,
|
||||
owner: 'alice',
|
||||
shared_with_me: false,
|
||||
share_mode: undefined,
|
||||
shared_by: undefined,
|
||||
});
|
||||
expect(labels).not.toContain('publish_as_website');
|
||||
expect(labels).toContain('deploy_as_app');
|
||||
});
|
||||
});
|
||||
@@ -62,47 +62,17 @@ function UIPopover (options) {
|
||||
function position_popover () {
|
||||
// X position
|
||||
const popover_width = options.width ?? $(el_popover).width();
|
||||
if ( options.center_horizontally ) {
|
||||
// Check taskbar position to determine popover positioning
|
||||
const taskbar_position = window.taskbar_position || 'bottom';
|
||||
|
||||
if ( taskbar_position === 'left' ) {
|
||||
// Position in top-left corner for left taskbar
|
||||
x_pos = window.taskbar_height + 10; // Just to the right of the taskbar
|
||||
} else if ( taskbar_position === 'right' ) {
|
||||
// Position in top-right corner for right taskbar
|
||||
x_pos = window.innerWidth - popover_width - window.taskbar_height - 40; // Just to the left of the taskbar
|
||||
} else {
|
||||
// Default bottom taskbar behavior - center horizontally
|
||||
x_pos = window.innerWidth / 2 - popover_width / 2 - 15;
|
||||
}
|
||||
} else {
|
||||
if ( options.position === 'bottom' || options.position === 'top' )
|
||||
{
|
||||
x_pos = options.left ?? ($(options.snapToElement).offset().left - (popover_width / 2) + 10);
|
||||
}
|
||||
else
|
||||
{
|
||||
x_pos = options.left ?? ($(options.snapToElement).offset().left + 5);
|
||||
}
|
||||
if ( options.position === 'bottom' || options.position === 'top' )
|
||||
{
|
||||
x_pos = options.left ?? ($(options.snapToElement).offset().left - (popover_width / 2) + 10);
|
||||
}
|
||||
else
|
||||
{
|
||||
x_pos = options.left ?? ($(options.snapToElement).offset().left + 5);
|
||||
}
|
||||
|
||||
// Y position
|
||||
const popover_height = options.height ?? $(el_popover).height();
|
||||
if ( options.center_horizontally ) {
|
||||
// Check taskbar position to determine popover positioning
|
||||
const taskbar_position = window.taskbar_position || 'bottom';
|
||||
|
||||
if ( taskbar_position === 'left' || taskbar_position === 'right' ) {
|
||||
// Position at top for left/right taskbars
|
||||
y_pos = window.toolbar_height + 10; // Just below the toolbar
|
||||
} else {
|
||||
// Default bottom taskbar behavior - position above taskbar
|
||||
y_pos = options.top ?? (window.innerHeight - (window.taskbar_height + popover_height + 10));
|
||||
}
|
||||
} else {
|
||||
y_pos = options.top ?? ($(options.snapToElement).offset().top + $(options.snapToElement).height() + 5);
|
||||
}
|
||||
y_pos = options.top ?? ($(options.snapToElement).offset().top + $(options.snapToElement).height() + 5);
|
||||
|
||||
$(el_popover).css({
|
||||
left: `${x_pos }px`,
|
||||
|
||||
@@ -71,7 +71,6 @@ function UIPrompt (options) {
|
||||
selectable_body: false,
|
||||
draggable_body: true,
|
||||
allow_context_menu: false,
|
||||
show_in_taskbar: false,
|
||||
window_class: 'window-alert',
|
||||
dominant: true,
|
||||
body_content: h,
|
||||
|
||||
@@ -82,21 +82,6 @@ function UIQRCode (options) {
|
||||
}
|
||||
}
|
||||
|
||||
// Compatibility shim: Component-based containers (e.g. Flexer) call
|
||||
// `.attach(parent)` on their children. Returning a plain DOM element with
|
||||
// an `attach` method lets this work without making UIQRCode a Component.
|
||||
el.attach = function (destination) {
|
||||
if ( destination instanceof HTMLElement || destination instanceof ShadowRoot ) {
|
||||
destination.appendChild(el);
|
||||
return;
|
||||
}
|
||||
if ( destination && destination.$ === 'placeholder' ) {
|
||||
destination.replaceWith(el);
|
||||
return;
|
||||
}
|
||||
throw new Error(`Unknown destination type: ${destination}`);
|
||||
};
|
||||
|
||||
return el;
|
||||
}
|
||||
|
||||
|
||||
@@ -1,468 +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 UITaskbarItem from './UITaskbarItem.js';
|
||||
import launch_app from '../helpers/launchApp.js';
|
||||
import { appIconSrc } from '../helpers/appIcon.js';
|
||||
|
||||
const TASKBAR_POSITIONS = ['left', 'bottom', 'right'];
|
||||
|
||||
async function UITaskbar (options) {
|
||||
window.global_element_id++;
|
||||
|
||||
options = options ?? {};
|
||||
options.content = options.content ?? '';
|
||||
|
||||
let taskbar_position;
|
||||
|
||||
// if first visit ever, set taskbar position to left
|
||||
if ( window.first_visit_ever ) {
|
||||
puter.kv.set('taskbar_position', 'left').catch(err => console.warn('Could not save taskbar_position:', err));
|
||||
taskbar_position = 'left';
|
||||
} else {
|
||||
taskbar_position = await puter.kv.get('taskbar_position').catch(() => null);
|
||||
// if this is not first visit, set taskbar position to bottom since it's from a user that
|
||||
// used puter before customizing taskbar position was added and the taskbar position was set to bottom
|
||||
// Unknown values are discarded too: this ends up in markup and stored values may be poisoned.
|
||||
if ( ! TASKBAR_POSITIONS.includes(taskbar_position) ) {
|
||||
taskbar_position = 'bottom'; // default position
|
||||
puter.kv.set('taskbar_position', taskbar_position).catch(err => console.warn('Could not save taskbar_position:', err));
|
||||
}
|
||||
}
|
||||
|
||||
// Force bottom position on mobile devices
|
||||
if ( isMobile.phone || isMobile.tablet ) {
|
||||
taskbar_position = 'bottom';
|
||||
}
|
||||
|
||||
// Set global taskbar position
|
||||
window.taskbar_position = taskbar_position;
|
||||
|
||||
let h = '';
|
||||
h += `<div id="ui-taskbar_${window.global_element_id}" class="taskbar taskbar-position-${taskbar_position}" style="height:${window.taskbar_height}px;">`;
|
||||
h += '<div class="taskbar-sortable" style="display: flex; justify-content: center; z-index: 99999;"></div>';
|
||||
h += '</div>';
|
||||
|
||||
if ( taskbar_position === 'left' || taskbar_position === 'right' ) {
|
||||
$('.desktop').addClass(`desktop-taskbar-position-${taskbar_position}`);
|
||||
}
|
||||
|
||||
$('.desktop').append(h);
|
||||
|
||||
//---------------------------------------------
|
||||
// add `Explorer` to the taskbar
|
||||
//---------------------------------------------
|
||||
UITaskbarItem({
|
||||
icon: window.icons['folders.svg'],
|
||||
app: 'explorer',
|
||||
name: 'Explorer',
|
||||
sortable: false,
|
||||
keep_in_taskbar: true,
|
||||
lock_keep_in_taskbar: true,
|
||||
onClick: function () {
|
||||
let open_window_count = parseInt($('.taskbar-item[data-app="explorer"]').attr('data-open-windows'));
|
||||
if ( open_window_count === 0 ) {
|
||||
launch_app({ name: 'explorer', path: window.home_path });
|
||||
} else {
|
||||
return false;
|
||||
}
|
||||
},
|
||||
});
|
||||
|
||||
//---------------------------------------------
|
||||
// add separator before trash
|
||||
//---------------------------------------------
|
||||
UITaskbarItem({
|
||||
icon: '', // No icon for separator
|
||||
name: 'separator',
|
||||
app: 'separator',
|
||||
sortable: false,
|
||||
keep_in_taskbar: true,
|
||||
lock_keep_in_taskbar: true,
|
||||
disable_context_menu: true,
|
||||
style: 'pointer-events: none;', // Make it non-interactive
|
||||
onClick: function () {
|
||||
// Separator is non-interactive
|
||||
return false;
|
||||
},
|
||||
});
|
||||
|
||||
//---------------------------------------------
|
||||
// Add other useful apps to the taskbar
|
||||
//---------------------------------------------
|
||||
if ( window.user.taskbar_items && window.user.taskbar_items.length > 0 ) {
|
||||
for ( let index = 0; index < window.user.taskbar_items.length; index++ ) {
|
||||
const app_info = window.user.taskbar_items[index];
|
||||
const icon = appIconSrc(app_info);
|
||||
// add taskbar item for each app
|
||||
UITaskbarItem({
|
||||
icon: icon.src,
|
||||
iconFallback: icon.fallback,
|
||||
app: app_info.name,
|
||||
name: app_info.title,
|
||||
keep_in_taskbar: true,
|
||||
onClick: function () {
|
||||
let open_window_count = parseInt($(`.taskbar-item[data-app="${app_info.name}"]`).attr('data-open-windows'));
|
||||
if ( open_window_count === 0 ) {
|
||||
launch_app({
|
||||
name: app_info.name,
|
||||
});
|
||||
} else {
|
||||
return false;
|
||||
}
|
||||
},
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
//---------------------------------------------
|
||||
// add `Trash` to the taskbar
|
||||
//---------------------------------------------
|
||||
const trash = await puter.fs.stat({ path: window.trash_path, consistency: 'eventual' });
|
||||
if ( window.socket ) {
|
||||
window.socket.emit('trash.is_empty', { is_empty: trash.is_empty });
|
||||
}
|
||||
|
||||
UITaskbarItem({
|
||||
icon: trash.is_empty ? window.icons['trash.svg'] : window.icons['trash-full.svg'],
|
||||
app: 'trash',
|
||||
name: `${i18n('trash')}`,
|
||||
sortable: false,
|
||||
keep_in_taskbar: true,
|
||||
lock_keep_in_taskbar: true,
|
||||
onClick: function () {
|
||||
let open_windows = $(`.window[data-path="${html_encode(window.trash_path)}"]`);
|
||||
if ( open_windows.length === 0 ) {
|
||||
launch_app({ name: 'explorer', path: window.trash_path });
|
||||
} else {
|
||||
open_windows.focusWindow();
|
||||
}
|
||||
},
|
||||
onItemsDrop: function (items) {
|
||||
window.move_items(items, window.trash_path);
|
||||
},
|
||||
});
|
||||
|
||||
//---------------------------------------------
|
||||
// add separator before trash
|
||||
//---------------------------------------------
|
||||
UITaskbarItem({
|
||||
icon: '', // No icon for separator
|
||||
name: 'separator',
|
||||
app: 'separator',
|
||||
sortable: false,
|
||||
keep_in_taskbar: true,
|
||||
lock_keep_in_taskbar: true,
|
||||
disable_context_menu: true,
|
||||
style: 'pointer-events: none;', // Make it non-interactive
|
||||
onClick: function () {
|
||||
// Separator is non-interactive
|
||||
return false;
|
||||
},
|
||||
});
|
||||
|
||||
window.make_taskbar_sortable();
|
||||
}
|
||||
|
||||
//-------------------------------------------
|
||||
// Taskbar is sortable
|
||||
//-------------------------------------------
|
||||
window.make_taskbar_sortable = function () {
|
||||
const position = window.taskbar_position || 'bottom';
|
||||
const axis = position === 'bottom' ? 'x' : 'y';
|
||||
|
||||
$('.taskbar-sortable').sortable({
|
||||
axis: axis,
|
||||
items: '.taskbar-item-sortable:not(.has-open-contextmenu):not([data-app="separator"])',
|
||||
cancel: '.has-open-contextmenu',
|
||||
placeholder: 'taskbar-item-sortable-placeholder',
|
||||
helper: 'clone',
|
||||
distance: 5,
|
||||
revert: 10,
|
||||
update: function (event, ui) {
|
||||
// only update the DB if the sorted item is pinned
|
||||
if ( $(ui.item).attr('data-keep-in-taskbar') === 'true' ) {
|
||||
window.update_taskbar();
|
||||
}
|
||||
},
|
||||
});
|
||||
};
|
||||
|
||||
// Function to update taskbar position
|
||||
window.update_taskbar_position = async function (new_position) {
|
||||
// Prevent position changes on mobile devices - always keep bottom
|
||||
if ( isMobile.phone || isMobile.tablet ) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ( ! TASKBAR_POSITIONS.includes(new_position) ) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Store the new position
|
||||
puter.kv.set('taskbar_position', new_position).catch(err => console.warn('Could not save taskbar_position:', err));
|
||||
window.taskbar_position = new_position;
|
||||
|
||||
// Remove old position classes and add new one
|
||||
$('.taskbar').removeClass('taskbar-position-left taskbar-position-bottom taskbar-position-right');
|
||||
$('.taskbar').addClass(`taskbar-position-${new_position}`);
|
||||
|
||||
// update desktop class, if left or right, add `desktop-taskbar-position-left` or `desktop-taskbar-position-right`
|
||||
$('.desktop').removeClass('desktop-taskbar-position-left');
|
||||
$('.desktop').removeClass('desktop-taskbar-position-right');
|
||||
$('.desktop').addClass(`desktop-taskbar-position-${new_position}`);
|
||||
|
||||
// Update desktop height/width calculations based on new position
|
||||
window.update_desktop_dimensions_for_taskbar();
|
||||
|
||||
// Update window positions if needed (for maximized windows)
|
||||
$('.window[data-is_maximized="1"]').each(function () {
|
||||
const el_window = this;
|
||||
window.update_maximized_window_for_taskbar(el_window);
|
||||
});
|
||||
|
||||
// Re-initialize sortable with correct axis
|
||||
$('.taskbar-sortable').sortable('destroy');
|
||||
window.make_taskbar_sortable();
|
||||
|
||||
// Adjust taskbar item sizes for the new position
|
||||
setTimeout(() => {
|
||||
window.adjust_taskbar_item_sizes();
|
||||
}, 10);
|
||||
|
||||
// Reinitialize all taskbar item tooltips with new position
|
||||
$('.taskbar-item').each(function () {
|
||||
const $item = $(this);
|
||||
// Destroy existing tooltip
|
||||
if ( $item.data('ui-tooltip') ) {
|
||||
$item.tooltip('destroy');
|
||||
}
|
||||
|
||||
// Helper function to get tooltip position based on taskbar position
|
||||
function getTooltipPosition () {
|
||||
const taskbarPosition = window.taskbar_position || 'bottom';
|
||||
|
||||
if ( taskbarPosition === 'bottom' ) {
|
||||
return {
|
||||
my: 'center bottom-20',
|
||||
at: 'center top',
|
||||
};
|
||||
} else if ( taskbarPosition === 'top' ) {
|
||||
return {
|
||||
my: 'center top+20',
|
||||
at: 'center bottom',
|
||||
};
|
||||
} else if ( taskbarPosition === 'left' ) {
|
||||
return {
|
||||
my: 'left+20 center',
|
||||
at: 'right center',
|
||||
};
|
||||
} else if ( taskbarPosition === 'right' ) {
|
||||
return {
|
||||
my: 'right-20 center',
|
||||
at: 'left center',
|
||||
};
|
||||
}
|
||||
return {
|
||||
my: 'center bottom-20',
|
||||
at: 'center top',
|
||||
}; // fallback
|
||||
}
|
||||
|
||||
const tooltipPosition = getTooltipPosition();
|
||||
|
||||
// Reinitialize tooltip with new position
|
||||
$item.tooltip({
|
||||
items: ".taskbar:not(.children-have-open-contextmenu) .taskbar-item:not([data-app='separator'])",
|
||||
position: {
|
||||
my: tooltipPosition.my,
|
||||
at: tooltipPosition.at,
|
||||
using: function ( position, feedback ) {
|
||||
$(this).css( position);
|
||||
$('<div>')
|
||||
.addClass( 'arrow')
|
||||
.addClass( feedback.vertical)
|
||||
.addClass( feedback.horizontal)
|
||||
.appendTo( this);
|
||||
},
|
||||
},
|
||||
});
|
||||
});
|
||||
};
|
||||
|
||||
// Function to update desktop dimensions based on taskbar position
|
||||
window.update_desktop_dimensions_for_taskbar = function () {
|
||||
const position = window.taskbar_position || 'bottom';
|
||||
|
||||
if ( position === 'bottom' ) {
|
||||
$('.desktop').css({
|
||||
'height': `calc(100vh - ${window.taskbar_height + window.toolbar_height}px)`,
|
||||
'width': '100%',
|
||||
'left': '0',
|
||||
'top': `${window.toolbar_height}px`,
|
||||
});
|
||||
} else if ( position === 'left' ) {
|
||||
$('.desktop').css({
|
||||
'height': `calc(100vh - ${window.toolbar_height}px)`,
|
||||
'width': `calc(100% - ${window.taskbar_height}px)`,
|
||||
'left': `${window.taskbar_height}px`,
|
||||
'top': `${window.toolbar_height}px`,
|
||||
});
|
||||
} else if ( position === 'right' ) {
|
||||
$('.desktop').css({
|
||||
'height': `calc(100vh - ${window.toolbar_height}px)`,
|
||||
'width': `calc(100% - ${window.taskbar_height}px)`,
|
||||
'left': '0',
|
||||
'top': `${window.toolbar_height}px`,
|
||||
});
|
||||
}
|
||||
};
|
||||
|
||||
//-------------------------------------------
|
||||
// Dynamic taskbar item resizing for left/right positions
|
||||
//-------------------------------------------
|
||||
window.adjust_taskbar_item_sizes = function () {
|
||||
const position = window.taskbar_position || 'bottom';
|
||||
|
||||
// Only apply to left and right positions
|
||||
if ( position !== 'left' && position !== 'right' ) {
|
||||
// Reset to default sizes for bottom position
|
||||
$('.taskbar .taskbar-item').css({
|
||||
'width': '40px',
|
||||
'height': '40px',
|
||||
'min-width': '40px',
|
||||
'min-height': '40px',
|
||||
});
|
||||
$('.taskbar-icon').css('height', '40px');
|
||||
return;
|
||||
}
|
||||
|
||||
const taskbar = $('.taskbar')[0];
|
||||
const taskbarItems = $('.taskbar .taskbar-item:visible');
|
||||
|
||||
if ( !taskbar || taskbarItems.length === 0 ) return;
|
||||
|
||||
// Get available height (minus padding)
|
||||
const totalItemsNeeded = taskbarItems.length;
|
||||
const taskbarHeight = taskbar.clientHeight;
|
||||
const paddingTop = 20; // from CSS
|
||||
const paddingBottom = 20; // from CSS
|
||||
const availableHeight = taskbarHeight - paddingTop - paddingBottom - 180;
|
||||
|
||||
// Calculate space needed with default sizes
|
||||
const defaultItemSize = 40;
|
||||
const defaultMargin = 5;
|
||||
const spaceNeededDefault = (totalItemsNeeded * defaultItemSize) + ((totalItemsNeeded - 1) * defaultMargin);
|
||||
|
||||
if ( spaceNeededDefault <= availableHeight ) {
|
||||
// No overflow, use default sizes
|
||||
taskbarItems.css({
|
||||
'width': '40px',
|
||||
'height': '40px',
|
||||
'min-width': '40px',
|
||||
'min-height': '40px',
|
||||
'padding': '6px 5px 10px 5px', // default padding
|
||||
});
|
||||
$('.taskbar-icon').css('height', `${defaultItemSize }px`);
|
||||
$('.taskbar-icon').css('width', '40px');
|
||||
$('.taskbar-icon > img').css('width', 'auto');
|
||||
$('.taskbar-icon > img').css('margin', 'auto');
|
||||
$('.taskbar-icon > img').css('display', 'block');
|
||||
|
||||
// Reset margins to default
|
||||
taskbarItems.css('margin-bottom', '5px');
|
||||
taskbarItems.last().css('margin-bottom', '0px');
|
||||
} else {
|
||||
// Overflow detected, calculate smaller sizes
|
||||
// Reserve some margin space (minimum 2px between items)
|
||||
const minMargin = 2;
|
||||
const marginSpace = (totalItemsNeeded - 1) * minMargin;
|
||||
const availableForItems = availableHeight - marginSpace;
|
||||
const newItemSize = Math.floor(availableForItems / totalItemsNeeded);
|
||||
|
||||
// Ensure minimum size of 20px
|
||||
const finalItemSize = Math.max(20, newItemSize);
|
||||
|
||||
// Calculate proportional padding based on size ratio
|
||||
const sizeRatio = finalItemSize / defaultItemSize;
|
||||
const paddingTop = Math.max(1, Math.floor(6 * sizeRatio));
|
||||
const paddingRight = Math.max(1, Math.floor(5 * sizeRatio));
|
||||
const paddingBottom = Math.max(1, Math.floor(10 * sizeRatio));
|
||||
const paddingLeft = Math.max(1, Math.floor(5 * sizeRatio));
|
||||
|
||||
// Apply new sizes and padding
|
||||
taskbarItems.css({
|
||||
'width': '40px',
|
||||
'height': `${finalItemSize }px`,
|
||||
'min-width': '40px',
|
||||
'min-height': `${finalItemSize }px`,
|
||||
'padding': `${paddingTop}px ${paddingRight}px ${paddingBottom}px ${paddingLeft}px`,
|
||||
});
|
||||
$('.taskbar-icon').css('height', `${finalItemSize }px`);
|
||||
$('.taskbar-icon').css('width', '40px');
|
||||
$('.taskbar-icon > img').css('width', 'auto');
|
||||
$('.taskbar-icon > img').css('margin', 'auto');
|
||||
$('.taskbar-icon > img').css('display', 'block');
|
||||
// Adjust margins
|
||||
taskbarItems.css('margin-bottom', `${minMargin }px`);
|
||||
taskbarItems.last().css('margin-bottom', '0px');
|
||||
}
|
||||
};
|
||||
|
||||
// Hook into existing taskbar functionality
|
||||
$(document).ready(function () {
|
||||
// Watch for taskbar item changes
|
||||
const observer = new MutationObserver(function (mutations) {
|
||||
mutations.forEach(function (mutation) {
|
||||
if ( mutation.type === 'childList' || mutation.type === 'attributes' ) {
|
||||
// Delay to ensure DOM updates are complete
|
||||
setTimeout(() => {
|
||||
window.adjust_taskbar_item_sizes();
|
||||
}, 10);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
// Start observing when taskbar is available
|
||||
const checkTaskbar = setInterval(() => {
|
||||
const taskbar = document.querySelector('.taskbar-sortable');
|
||||
if ( taskbar ) {
|
||||
observer.observe(taskbar, {
|
||||
childList: true,
|
||||
attributes: true,
|
||||
subtree: true,
|
||||
});
|
||||
clearInterval(checkTaskbar);
|
||||
|
||||
// Initial call
|
||||
setTimeout(() => {
|
||||
window.adjust_taskbar_item_sizes();
|
||||
}, 100);
|
||||
}
|
||||
}, 100);
|
||||
|
||||
// Also watch for window resize events
|
||||
window.addEventListener('resize', () => {
|
||||
setTimeout(() => {
|
||||
window.adjust_taskbar_item_sizes();
|
||||
}, 10);
|
||||
});
|
||||
});
|
||||
|
||||
export default UITaskbar;
|
||||
@@ -1,75 +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 { afterEach, beforeEach, expect, it, vi } from 'vitest';
|
||||
import jQuery from '../lib/jquery-3.6.1/jquery-3.6.1.min.js';
|
||||
|
||||
vi.mock('../helpers/launchApp.js', () => ({ default: vi.fn() }));
|
||||
|
||||
globalThis.$ = globalThis.jQuery = jQuery;
|
||||
globalThis.i18n = (key) => key;
|
||||
globalThis.html_encode = (value) => String(value ?? '');
|
||||
globalThis.isMobile = { phone: false, tablet: false };
|
||||
await import('../lib/jquery-ui-1.13.2/jquery-ui.js');
|
||||
const { default: UITaskbar } = await import('./UITaskbar.js');
|
||||
|
||||
let requests;
|
||||
|
||||
afterEach(() => {
|
||||
$('.taskbar').remove();
|
||||
$(document).off();
|
||||
$(window).off();
|
||||
document.body.innerHTML = '';
|
||||
vi.unstubAllGlobals();
|
||||
vi.restoreAllMocks();
|
||||
});
|
||||
|
||||
beforeEach(async () => {
|
||||
document.body.innerHTML = '<div class="desktop"></div>';
|
||||
Object.assign(window, {
|
||||
global_element_id: 0,
|
||||
taskbar_height: 50,
|
||||
toolbar_height: 0,
|
||||
api_origin: 'http://api.test',
|
||||
auth_token: 'test-token',
|
||||
icons: {},
|
||||
user: { taskbar_items: [{ name: 'notes', title: 'Notes' }] },
|
||||
trash_path: '/test/Trash',
|
||||
});
|
||||
vi.stubGlobal('puter', {
|
||||
kv: { get: async () => 'bottom' },
|
||||
fs: { stat: async () => ({ is_empty: true }) },
|
||||
});
|
||||
requests = [];
|
||||
$.ajaxTransport('+*', (options) => {
|
||||
requests.push(options.url);
|
||||
return { send () {}, abort () {} };
|
||||
});
|
||||
await UITaskbar();
|
||||
});
|
||||
|
||||
it('starts the taskbar at Explorer, followed by pinned apps and Trash', () => {
|
||||
const apps = $('.taskbar .taskbar-item').map((_, el) => el.dataset.app).get();
|
||||
expect(apps).toEqual(['explorer', 'separator', 'notes', 'separator', 'trash']);
|
||||
});
|
||||
|
||||
it('does not fetch launch apps when the taskbar loads', () => {
|
||||
expect(requests.filter(url => url.includes('/get-launch-apps'))).toEqual([]);
|
||||
});
|
||||
@@ -1,531 +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 UIContextMenu from './UIContextMenu.js';
|
||||
import path from '../lib/path.js';
|
||||
import launch_app from '../helpers/launchApp.js';
|
||||
import { user_facing_windows } from '../helpers/windowVisibility.js';
|
||||
import { appIconFallbackAttr } from '../helpers/appIcon.js';
|
||||
|
||||
let tray_item_id = 1;
|
||||
|
||||
function UITaskbarItem (options) {
|
||||
let h = '';
|
||||
tray_item_id++;
|
||||
options.sortable = options.sortable ?? true;
|
||||
options.open_windows_count = options.open_windows_count ?? 0;
|
||||
options.lock_keep_in_taskbar = options.lock_keep_in_taskbar ?? false;
|
||||
options.before_trash = options.before_trash ?? false;
|
||||
|
||||
// The windows this item stands for: the user's own. An instance another
|
||||
// app launched in the background is not counted in data-open-windows and
|
||||
// has no item of its own (see UIWindow's taskbar block) — it must not be
|
||||
// shown, hidden, or closed through the item its app's OTHER windows own.
|
||||
const item_windows = () => $(user_facing_windows($(`.window[data-app="${options.app}"]`)));
|
||||
|
||||
const element_id = window.global_element_id++;
|
||||
|
||||
h += `<div class = "taskbar-item ${options.sortable ? 'taskbar-item-sortable' : ''} disable-user-select"
|
||||
id = "taskbar-item-${tray_item_id}"
|
||||
data-taskbar-item-id = "${tray_item_id}"
|
||||
data-element-id = "${html_encode(element_id)}"
|
||||
data-name = "${html_encode(options.name)}"
|
||||
data-app = "${html_encode(options.app)}"
|
||||
data-keep-in-taskbar = "${html_encode(options.keep_in_taskbar ?? 'false')}"
|
||||
data-open-windows="${(options.open_windows_count)}"
|
||||
title = "${html_encode(options.name)}"
|
||||
style= "${options.style ? html_encode(options.style) : ''}"
|
||||
>`;
|
||||
let icon = options.icon ? options.icon : window.icons['app.svg'];
|
||||
// App icons carry a retry URL (see helpers/appIcon.js); the bundled icons
|
||||
// below never need one.
|
||||
let icon_fallback = options.iconFallback ?? '';
|
||||
if ( options.app === 'explorer' )
|
||||
{
|
||||
icon = window.icons['folders.svg'];
|
||||
icon_fallback = '';
|
||||
}
|
||||
|
||||
// taskbar icon
|
||||
h += '<div class="taskbar-icon">';
|
||||
// Don't add img tag for separator
|
||||
if ( options.app !== 'separator' ) {
|
||||
h += `<img src="${html_encode(icon)}"${appIconFallbackAttr(icon_fallback)} style="${options.group === 'apps' ? 'filter:none;' : ''}">`;
|
||||
}
|
||||
h += '</div>';
|
||||
|
||||
// active indicator
|
||||
if ( options.app !== 'apps' )
|
||||
{
|
||||
h += '<span class="active-taskbar-indicator"></span>';
|
||||
}
|
||||
h += '</div>';
|
||||
|
||||
if ( options.before_trash ) {
|
||||
$('.taskbar-sortable').append(h);
|
||||
} else {
|
||||
if ( options.sortable )
|
||||
{
|
||||
$('.taskbar-sortable').append(h);
|
||||
}
|
||||
else {
|
||||
// if taskbar-sortable is empty then append before it
|
||||
if ( $('.taskbar-sortable').children().length === 0 )
|
||||
{
|
||||
$('.taskbar').find('.taskbar-sortable').before(h);
|
||||
}
|
||||
else
|
||||
{
|
||||
$('.taskbar').find('.taskbar-sortable').after(h);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const el_taskbar_item = document.querySelector(`#taskbar-item-${tray_item_id}`);
|
||||
|
||||
// fade in the taskbar item
|
||||
$(el_taskbar_item).show(50);
|
||||
|
||||
// Adjust taskbar item sizes after adding new item
|
||||
if ( window.adjust_taskbar_item_sizes ) {
|
||||
setTimeout(() => {
|
||||
window.adjust_taskbar_item_sizes();
|
||||
}, 100);
|
||||
}
|
||||
|
||||
$(el_taskbar_item).on('click', function (e) {
|
||||
e.preventDefault();
|
||||
e.stopPropagation();
|
||||
|
||||
// Don't handle clicks for separators
|
||||
if ( options.app === 'separator' ) {
|
||||
return;
|
||||
}
|
||||
|
||||
// If this item has an open context menu, don't do anything
|
||||
if ( $(el_taskbar_item).hasClass('has-open-contextmenu') )
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
if ( options.onClick === undefined || options.onClick(el_taskbar_item) === false ) {
|
||||
// re-show each window in this app group
|
||||
item_windows().showWindow();
|
||||
}
|
||||
});
|
||||
|
||||
$(el_taskbar_item).on('contextmenu taphold', function (e) {
|
||||
// seems like the only way to stop sortable is to destroy it
|
||||
if ( options.sortable ) {
|
||||
$('.taskbar-sortable').sortable('destroy');
|
||||
}
|
||||
|
||||
e.preventDefault();
|
||||
e.stopPropagation();
|
||||
|
||||
// Don't show context menu for separators
|
||||
if ( options.app === 'separator' ) {
|
||||
return;
|
||||
}
|
||||
|
||||
// If context menu is disabled on this item, return
|
||||
if ( options.disable_context_menu )
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
// don't allow context menu to open if it's already open
|
||||
if ( $(el_taskbar_item).hasClass('has-open-contextmenu') )
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
const menu_items = [];
|
||||
const open_windows = parseInt($(el_taskbar_item).attr('data-open-windows'));
|
||||
// -------------------------------------------
|
||||
// List of open windows belonging to this app
|
||||
// -------------------------------------------
|
||||
item_windows().each(function () {
|
||||
menu_items.push({
|
||||
html: $(this).find('.window-head-title').html(),
|
||||
val: $(this).attr('data-id'),
|
||||
onClick: function (e) {
|
||||
$(`.window[data-id="${e.value}"]`).showWindow();
|
||||
},
|
||||
});
|
||||
});
|
||||
// -------------------------------------------
|
||||
// divider
|
||||
// -------------------------------------------
|
||||
if ( menu_items.length > 0 )
|
||||
{
|
||||
menu_items.push('-');
|
||||
}
|
||||
//------------------------------------------
|
||||
// New Window
|
||||
//------------------------------------------
|
||||
if ( options.app && options.app !== 'trash' ) {
|
||||
menu_items.push({
|
||||
html: i18n('new_window'),
|
||||
val: $(this).attr('data-id'),
|
||||
onClick: function () {
|
||||
// is trash?
|
||||
launch_app({
|
||||
name: options.app,
|
||||
maximized: (isMobile.phone || isMobile.tablet),
|
||||
});
|
||||
},
|
||||
});
|
||||
}
|
||||
//------------------------------------------
|
||||
// Open Trash
|
||||
//------------------------------------------
|
||||
else if ( options.app && options.app === 'trash' ) {
|
||||
menu_items.push({
|
||||
html: i18n('open_trash'),
|
||||
val: $(this).attr('data-id'),
|
||||
onClick: function () {
|
||||
launch_app({
|
||||
name: options.app,
|
||||
path: window.trash_path,
|
||||
maximized: (isMobile.phone || isMobile.tablet),
|
||||
});
|
||||
},
|
||||
});
|
||||
}
|
||||
//------------------------------------------
|
||||
// Empty Trash
|
||||
//------------------------------------------
|
||||
if ( options.app && options.app === 'trash' ) {
|
||||
// divider
|
||||
menu_items.push('-');
|
||||
|
||||
// Empty Trash menu item
|
||||
menu_items.push({
|
||||
html: i18n('empty_trash'),
|
||||
val: $(this).attr('data-id'),
|
||||
onClick: async function () {
|
||||
window.empty_trash();
|
||||
},
|
||||
});
|
||||
}
|
||||
//------------------------------------------
|
||||
// Remove from Taskbar
|
||||
//------------------------------------------
|
||||
if ( options.keep_in_taskbar && !options.lock_keep_in_taskbar ) {
|
||||
menu_items.push({
|
||||
html: i18n('remove_from_taskbar'),
|
||||
val: $(this).attr('data-id'),
|
||||
onClick: function () {
|
||||
$(el_taskbar_item).attr('data-keep-in-taskbar', 'false');
|
||||
if ( $(el_taskbar_item).attr('data-open-windows') === '0' ) {
|
||||
window.remove_taskbar_item(el_taskbar_item);
|
||||
}
|
||||
window.update_taskbar();
|
||||
options.keep_in_taskbar = false;
|
||||
},
|
||||
});
|
||||
}
|
||||
//------------------------------------------
|
||||
// Keep in Taskbar
|
||||
//------------------------------------------
|
||||
else if ( ! options.keep_in_taskbar ) {
|
||||
menu_items.push({
|
||||
html: i18n('keep_in_taskbar'),
|
||||
val: $(this).attr('data-id'),
|
||||
onClick: function () {
|
||||
$(el_taskbar_item).attr('data-keep-in-taskbar', 'true');
|
||||
window.update_taskbar();
|
||||
options.keep_in_taskbar = true;
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
if ( open_windows > 0 ) {
|
||||
// -------------------------------------------
|
||||
// divider
|
||||
// -------------------------------------------
|
||||
menu_items.push('-');
|
||||
// -------------------------------------------
|
||||
// Show All Windows
|
||||
// -------------------------------------------
|
||||
menu_items.push({
|
||||
html: i18n('show_all_windows'),
|
||||
onClick: function () {
|
||||
item_windows().showWindow();
|
||||
},
|
||||
});
|
||||
// -------------------------------------------
|
||||
// Hide All Windows
|
||||
// -------------------------------------------
|
||||
menu_items.push({
|
||||
html: i18n('hide_all_windows'),
|
||||
onClick: function () {
|
||||
if ( open_windows > 0 )
|
||||
{
|
||||
item_windows().hideWindow();
|
||||
}
|
||||
},
|
||||
});
|
||||
// -------------------------------------------
|
||||
// Close All Windows
|
||||
// -------------------------------------------
|
||||
menu_items.push({
|
||||
html: i18n('close_all_windows'),
|
||||
onClick: function () {
|
||||
// "All" means the windows this item lists — a background
|
||||
// helper belongs to the app running it, and goes when
|
||||
// that app does (UIWindow's close path).
|
||||
item_windows().close();
|
||||
},
|
||||
});
|
||||
}
|
||||
const pos = el_taskbar_item.getBoundingClientRect();
|
||||
UIContextMenu({
|
||||
parent_element: el_taskbar_item,
|
||||
position: getContextMenuPosition(pos),
|
||||
items: menu_items,
|
||||
});
|
||||
|
||||
return false;
|
||||
});
|
||||
|
||||
// Helper function to get tooltip position based on taskbar position
|
||||
function getTooltipPosition () {
|
||||
const taskbarPosition = window.taskbar_position || 'bottom';
|
||||
|
||||
if ( taskbarPosition === 'bottom' ) {
|
||||
return {
|
||||
my: 'center bottom-20',
|
||||
at: 'center top',
|
||||
};
|
||||
} else if ( taskbarPosition === 'top' ) {
|
||||
return {
|
||||
my: 'center top+20',
|
||||
at: 'center bottom',
|
||||
};
|
||||
} else if ( taskbarPosition === 'left' ) {
|
||||
return {
|
||||
my: 'left+20 center',
|
||||
at: 'right center',
|
||||
};
|
||||
} else if ( taskbarPosition === 'right' ) {
|
||||
return {
|
||||
my: 'right-20 center',
|
||||
at: 'left center',
|
||||
};
|
||||
}
|
||||
return {
|
||||
my: 'center bottom-20',
|
||||
at: 'center top',
|
||||
}; // fallback
|
||||
}
|
||||
|
||||
// Helper function to get context menu position based on taskbar position
|
||||
function getContextMenuPosition (pos) {
|
||||
const taskbarPosition = window.taskbar_position || 'bottom';
|
||||
|
||||
if ( taskbarPosition === 'bottom' ) {
|
||||
return {
|
||||
top: pos.top - 15,
|
||||
left: pos.left + 5,
|
||||
};
|
||||
} else if ( taskbarPosition === 'top' ) {
|
||||
return {
|
||||
top: pos.bottom + 15,
|
||||
left: pos.left + 5,
|
||||
};
|
||||
} else if ( taskbarPosition === 'left' ) {
|
||||
return {
|
||||
top: pos.top + 5,
|
||||
left: pos.right + 5,
|
||||
};
|
||||
} else if ( taskbarPosition === 'right' ) {
|
||||
return {
|
||||
top: pos.top + 5,
|
||||
left: pos.left - 20,
|
||||
};
|
||||
}
|
||||
return {
|
||||
top: pos.top - 15,
|
||||
left: pos.left + 5,
|
||||
}; // fallback
|
||||
}
|
||||
|
||||
const tooltipPosition = getTooltipPosition();
|
||||
|
||||
$(el_taskbar_item).tooltip({
|
||||
// only show tooltip if desktop is not selectable active
|
||||
items: ".desktop:not(.desktop-selectable-active) .taskbar:not(.children-have-open-contextmenu) .taskbar-item:not([data-app='separator'])",
|
||||
position: {
|
||||
my: tooltipPosition.my,
|
||||
at: tooltipPosition.at,
|
||||
using: function ( position, feedback ) {
|
||||
$(this).css( position);
|
||||
$('<div>')
|
||||
.addClass( 'arrow')
|
||||
.addClass( feedback.vertical)
|
||||
.addClass( feedback.horizontal)
|
||||
.appendTo( this);
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
// --------------------------------------------------------
|
||||
// Droppable
|
||||
// --------------------------------------------------------
|
||||
// Don't make separators droppable
|
||||
if ( options.app !== 'separator' ) {
|
||||
$(el_taskbar_item).droppable({
|
||||
accept: '.item',
|
||||
// 'pointer' is very important because of active window tracking is based on the position of cursor.
|
||||
tolerance: 'pointer',
|
||||
drop: async function ( event, ui ) {
|
||||
// Check if hovering over an item that is VISIBILE
|
||||
if ( $(event.target).closest('.window').attr('data-id') !== $(window.mouseover_window).attr('data-id') )
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
// If ctrl is pressed and source is Trashed, cancel whole operation
|
||||
if ( event.ctrlKey && path.dirname($(ui.draggable).attr('data-path')) === window.trash_path )
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
const items_to_move = [];
|
||||
|
||||
// First item
|
||||
items_to_move.push(ui.draggable);
|
||||
|
||||
// All subsequent items
|
||||
const cloned_items = document.getElementsByClassName('item-selected-clone');
|
||||
for ( let i = 0; i < cloned_items.length; i++ ) {
|
||||
const source_item = document.getElementById(`item-${ $(cloned_items[i]).attr('data-id')}`);
|
||||
if ( source_item !== null )
|
||||
{
|
||||
items_to_move.push(source_item);
|
||||
}
|
||||
}
|
||||
|
||||
// --------------------------------------------------------
|
||||
// If `options.onItemsDrop` is set, call it with the items to move
|
||||
//--------------------------------------------------------
|
||||
if ( options.onItemsDrop && typeof options.onItemsDrop === 'function' ) {
|
||||
options.onItemsDrop(items_to_move);
|
||||
return;
|
||||
}
|
||||
// --------------------------------------------------------
|
||||
// If dropped on an app, open the app with the dropped item as an argument
|
||||
//--------------------------------------------------------
|
||||
else if ( options.app ) {
|
||||
// an array that hold the items to sign
|
||||
const items_to_sign = [];
|
||||
|
||||
// prepare items to sign
|
||||
for ( let i = 0; i < items_to_move.length; i++ ) {
|
||||
items_to_sign.push({
|
||||
name: $(items_to_move[i]).attr('data-name'),
|
||||
uid: $(items_to_move[i]).attr('data-uid'),
|
||||
action: 'write',
|
||||
path: $(items_to_move[i]).attr('data-path'),
|
||||
});
|
||||
}
|
||||
|
||||
// open each item
|
||||
for ( let i = 0; i < items_to_sign.length; i++ ) {
|
||||
const item = items_to_sign[i];
|
||||
launch_app({
|
||||
name: options.app,
|
||||
file_path: item.path,
|
||||
// app_obj: open_item_meta.suggested_apps[0],
|
||||
window_title: item.name,
|
||||
file_uid: item.uid,
|
||||
// file_signature: item,
|
||||
});
|
||||
}
|
||||
|
||||
// deselect dragged item
|
||||
for ( let i = 0; i < items_to_move.length; i++ )
|
||||
{
|
||||
$(items_to_move[i]).removeClass('item-selected');
|
||||
}
|
||||
}
|
||||
|
||||
// Unselect directory/app if item is dropped
|
||||
if ( options.is_dir || options.app ) {
|
||||
$(el_taskbar_item).removeClass('active');
|
||||
$(el_taskbar_item).tooltip('close');
|
||||
$('.ui-draggable-dragging .item-name, .item-selected-clone .item-name').css('opacity', 'initial');
|
||||
$('.item-container').removeClass('item-container-transparent-border');
|
||||
}
|
||||
|
||||
// Re-enable droppable on all item-container
|
||||
$('.item-container').droppable('enable');
|
||||
|
||||
return false;
|
||||
},
|
||||
over: function (event, ui) {
|
||||
// Check hovering over an item that is VISIBILE
|
||||
const $event_parent_win = $(event.target).closest('.window');
|
||||
if ( $event_parent_win.length > 0 && $event_parent_win.attr('data-id') !== $(window.mouseover_window).attr('data-id') )
|
||||
{
|
||||
return;
|
||||
}
|
||||
// Don't do anything if the dragged item is NOT a UIItem
|
||||
if ( ! $(ui.draggable).hasClass('item') )
|
||||
{
|
||||
return;
|
||||
}
|
||||
// If this is a directory or an app, and an item was dragged over it, highlight it.
|
||||
if ( options.is_dir || options.app ) {
|
||||
$(el_taskbar_item).addClass('active');
|
||||
// show tooltip of this item
|
||||
$(el_taskbar_item).tooltip().mouseover();
|
||||
// make item name partially transparent
|
||||
$('.ui-draggable-dragging .item-name, .item-selected-clone .item-name').css('opacity', 0.1);
|
||||
// remove all item-container active borders
|
||||
$('.item-container').addClass('item-container-transparent-border');
|
||||
}
|
||||
// Disable all window bodies
|
||||
$('.item-container').droppable( 'disable');
|
||||
},
|
||||
out: function (event, ui) {
|
||||
// Don't do anything if the dragged item is NOT a UIItem
|
||||
if ( ! $(ui.draggable).hasClass('item') )
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
// Unselect directory/app if item is dragged out
|
||||
if ( options.is_dir || options.app ) {
|
||||
$(el_taskbar_item).removeClass('active');
|
||||
$(el_taskbar_item).tooltip('close');
|
||||
$('.ui-draggable-dragging .item-name, .item-selected-clone .item-name').css('opacity', 'initial');
|
||||
$('.item-container').removeClass('item-container-transparent-border');
|
||||
}
|
||||
$('.item-container').droppable( 'enable');
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
return el_taskbar_item;
|
||||
}
|
||||
|
||||
export default UITaskbarItem;
|
||||
@@ -0,0 +1,122 @@
|
||||
// @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 { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
||||
import jQuery from '../lib/jquery-3.6.1/jquery-3.6.1.min.js';
|
||||
|
||||
vi.mock('../helpers/launchApp.js', () => ({ default: vi.fn() }));
|
||||
|
||||
globalThis.$ = globalThis.jQuery = jQuery;
|
||||
globalThis.i18n = (key) => key;
|
||||
globalThis.html_encode = (value) => String(value ?? '');
|
||||
globalThis.isMobile = { phone: false, tablet: false };
|
||||
globalThis.def = globalThis.def ?? ((value) => value);
|
||||
await import('../lib/jquery-ui-1.13.2/jquery-ui.js');
|
||||
// The page loads this plugin from a vendored script; nothing here drops files.
|
||||
$.fn.dragster = function () {
|
||||
return this;
|
||||
};
|
||||
const { default: UIWindow } = await import('./UIWindow.js');
|
||||
|
||||
const openWindow = (options = {}) => UIWindow({
|
||||
title: 'Notes',
|
||||
app: 'notes',
|
||||
body_content: '<p>hello</p>',
|
||||
width: 400,
|
||||
height: 300,
|
||||
...options,
|
||||
});
|
||||
|
||||
/** Opens the window head's context menu and returns its item labels. */
|
||||
const headMenuLabels = (el_window) => {
|
||||
$(el_window).find('.window-head').trigger('contextmenu');
|
||||
return $('.context-menu .contextmenu-label').map((_, el) => $(el).text().toLowerCase()).get();
|
||||
};
|
||||
|
||||
beforeEach(() => {
|
||||
document.body.innerHTML = '';
|
||||
Object.assign(window, {
|
||||
global_element_id: 0,
|
||||
window_counter: 0,
|
||||
last_window_zindex: 1,
|
||||
window_stack: [],
|
||||
icons: {},
|
||||
uuidv4: () => crypto.randomUUID(),
|
||||
is_dashboard_mode: false,
|
||||
is_fullpage_mode: false,
|
||||
is_embedded: false,
|
||||
});
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
$(document).off();
|
||||
document.body.innerHTML = '';
|
||||
});
|
||||
|
||||
describe('minimize', () => {
|
||||
it('is not offered on the desktop, where nothing could restore the window', async () => {
|
||||
const el_window = await openWindow();
|
||||
|
||||
expect($(el_window).find('.window-minimize-btn').length).toBe(0);
|
||||
|
||||
const labels = headMenuLabels(el_window);
|
||||
expect(labels.some((label) => label === 'maximize')).toBe(true);
|
||||
expect(labels.some((label) => label === 'minimize')).toBe(false);
|
||||
});
|
||||
|
||||
it('is offered on the dashboard, which restores the window from its tile', async () => {
|
||||
window.is_dashboard_mode = true;
|
||||
const el_window = await openWindow();
|
||||
|
||||
expect($(el_window).find('.window-minimize-btn').length).toBe(1);
|
||||
expect(headMenuLabels(el_window).some((label) => label === 'minimize')).toBe(true);
|
||||
});
|
||||
|
||||
it('hides the window in place and brings it back', async () => {
|
||||
window.is_dashboard_mode = true;
|
||||
const el_window = await openWindow();
|
||||
const before = { top: el_window.style.top, left: el_window.style.left };
|
||||
|
||||
await $(el_window).hideWindow();
|
||||
expect($(el_window).attr('data-is_minimized')).toBe('true');
|
||||
expect($(el_window).attr('data-minimized_in_place')).toBe('1');
|
||||
|
||||
await $(el_window).showWindow({ no_history: true });
|
||||
expect($(el_window).attr('data-is_minimized')).toBe('false');
|
||||
expect({ top: el_window.style.top, left: el_window.style.left }).toEqual(before);
|
||||
});
|
||||
});
|
||||
|
||||
describe('backdrop', () => {
|
||||
const backdropZ = (el_window) => Number($(el_window).closest('.window-backdrop').css('z-index'));
|
||||
|
||||
it('stays above ordinary windows on the desktop', async () => {
|
||||
const el_window = await openWindow({ backdrop: true });
|
||||
|
||||
expect(backdropZ(el_window)).toBeGreaterThan(window.last_window_zindex + 1000);
|
||||
});
|
||||
|
||||
it('stacks at the window counter on the dashboard', async () => {
|
||||
window.is_dashboard_mode = true;
|
||||
const el_window = await openWindow({ backdrop: true });
|
||||
|
||||
expect(backdropZ(el_window)).toBeLessThanOrEqual(window.last_window_zindex);
|
||||
});
|
||||
});
|
||||
+276
-845
File diff suppressed because it is too large.
Load diff
Loaded 100 of 223 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user