mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-17 01:25:26 +02:00
## Thinking Path
> - Paperclip is the open source app people use to manage AI agents for
work
> - Humans sign in through the auth layer; every authenticated request
parses the session/user profile with `currentUserProfileSchema` in
`packages/shared`
> - The schema requires `name` to be `null` or a non-empty string, but
some identity providers hand back `name: ""` for users who never set a
display name
> - For those users the session payload fails validation on every
request, so the app treats them as unauthenticated and bounces them to
`/auth` in a loop — they can never get in
> - This pull request preprocesses empty/whitespace-only names to `null`
before validation, so the existing `min(1).max(120).nullable()` rule
still holds for real names
> - Review found the sibling `email` field has the same failure mode
(the DB `auth` schema declares `email` as `notNull`, so a provider that
supplies no email stores `""`, which `z.string().email()` rejects); the
same preprocess is applied there
> - The benefit is that users whose provider reports an empty name (or
email) can sign in normally instead of being locked out, with no change
in behavior for anyone else
## Linked Issues or Issue Description
No existing issue; described in-PR following the bug report template:
**What happened?**
Users whose auth provider returns `name: ""` (empty string) in the
profile payload fail `currentUserProfileSchema` / `authSessionSchema`
parsing (`name: z.string().min(1)...`). The parse failure makes the
session look invalid and the UI redirects to `/auth` on every attempt —
an endless sign-in loop. The `email` field has the same failure mode
(`z.string().email()` rejects `""`).
**Expected behavior:**
An empty display name (or email) should be treated the same as a missing
one (`null`); the user should be signed in normally.
**Steps to reproduce:**
Sign in with an account whose upstream identity record has an
empty-string name (or set a user's `name` column to `''` directly), then
load the app: session parse fails and you are bounced back to `/auth`.
**Adapter(s) involved:**
Not adapter-specific (core bug).
**Deployment mode / version:**
Any; reproduces on current `master`.
## What Changed
- `packages/shared/src/validators/access.ts`:
`currentUserProfileSchema.name` now runs through `z.preprocess` that
coerces empty or whitespace-only strings to `null` before the existing
`z.string().min(1).max(120).nullable()` validation.
- `packages/shared/src/validators/access.ts`: the same preprocess is
applied to `email` (review follow-up): `users.email` is `notNull` in the
DB schema, so a provider without an email stores `""`, which
`z.string().email()` rejects — the identical lockout loop.
Empty/whitespace-only emails now coerce to `null` (the field was already
nullable); malformed non-empty emails are still rejected.
- `packages/shared/src/validators/access.test.ts` (new): covers
empty-string → `null`, whitespace-only → `null`, real values preserved,
`null` preserved, and malformed non-empty email still rejected — for
both `name` and `email`, and the same cases through `authSessionSchema`.
## Verification
- `vitest run src/validators/access.test.ts` in `packages/shared` — 13
tests pass.
- `tsc --noEmit -p packages/shared` passes.
- Manual: parse `{ id, email: "", name: "", image: null }` with
`currentUserProfileSchema` — succeeds with `name: null` and `email:
null` instead of failing validation.
## Risks
- Low risk. The change only widens accepted input (empty/whitespace
string → `null` for `name` and `email`); every previously valid payload
parses identically. `updateCurrentUserProfileSchema` (user-initiated
rename) is untouched and still rejects empty names.
## Model Used
Claude Fable 5 (Anthropic, `claude-fable-5`, agentic coding harness via
Claude Code, extended reasoning enabled). Original fix drafted with
Claude Sonnet 4.6.
## Checklist
- [x] I have included a thinking path that traces from project context
to this change
- [x] I have specified the model used (with version and capability
details)
- [x] I have checked ROADMAP.md and confirmed this PR does not duplicate
planned core work
- [x] I have searched GitHub for duplicate or related PRs and linked
them above
- [x] I have either (a) linked existing issues with `Fixes: #` / `Closes
#` / `Refs #` OR (b) described the issue in-PR following the relevant
issue template
- [x] I have not referenced internal/instance-local Paperclip issues or
links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip`
URLs)
- [x] My branch name describes the change (e.g. `docs/...`, `fix/...`)
and contains no internal Paperclip ticket id or instance-derived details
- [x] I have run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [ ] All Paperclip CI gates are green
- [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [x] I will address all Greptile and reviewer comments before
requesting merge
---------
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
214 lines
7.3 KiB
TypeScript
214 lines
7.3 KiB
TypeScript
import { z } from "zod";
|
|
import {
|
|
AGENT_ADAPTER_TYPES,
|
|
HUMAN_COMPANY_MEMBERSHIP_ROLES,
|
|
INVITE_JOIN_TYPES,
|
|
JOIN_REQUEST_STATUSES,
|
|
JOIN_REQUEST_TYPES,
|
|
PERMISSION_KEYS,
|
|
} from "../constants.js";
|
|
import { optionalAgentAdapterTypeSchema } from "../adapter-type.js";
|
|
|
|
export const createCompanyInviteSchema = z.object({
|
|
allowedJoinTypes: z.enum(INVITE_JOIN_TYPES).default("both"),
|
|
humanRole: z.enum(HUMAN_COMPANY_MEMBERSHIP_ROLES).optional().nullable(),
|
|
defaultsPayload: z.record(z.string(), z.unknown()).optional().nullable(),
|
|
agentMessage: z.string().max(4000).optional().nullable(),
|
|
});
|
|
|
|
export type CreateCompanyInvite = z.infer<typeof createCompanyInviteSchema>;
|
|
|
|
export const createOpenClawInvitePromptSchema = z.object({
|
|
agentMessage: z.string().max(4000).optional().nullable(),
|
|
});
|
|
|
|
export type CreateOpenClawInvitePrompt = z.infer<
|
|
typeof createOpenClawInvitePromptSchema
|
|
>;
|
|
|
|
export const acceptInviteSchema = z.object({
|
|
requestType: z.enum(JOIN_REQUEST_TYPES),
|
|
agentName: z.string().min(1).max(120).optional(),
|
|
adapterType: optionalAgentAdapterTypeSchema,
|
|
capabilities: z.string().max(4000).optional().nullable(),
|
|
agentDefaultsPayload: z.record(z.string(), z.unknown()).optional().nullable(),
|
|
// OpenClaw join compatibility fields accepted at top level.
|
|
responsesWebhookUrl: z.string().max(4000).optional().nullable(),
|
|
responsesWebhookMethod: z.string().max(32).optional().nullable(),
|
|
responsesWebhookHeaders: z.record(z.string(), z.unknown()).optional().nullable(),
|
|
paperclipApiUrl: z.string().max(4000).optional().nullable(),
|
|
webhookAuthHeader: z.string().max(4000).optional().nullable(),
|
|
});
|
|
|
|
export type AcceptInvite = z.infer<typeof acceptInviteSchema>;
|
|
|
|
export const listJoinRequestsQuerySchema = z.object({
|
|
status: z.enum(JOIN_REQUEST_STATUSES).optional(),
|
|
requestType: z.enum(JOIN_REQUEST_TYPES).optional(),
|
|
});
|
|
|
|
export type ListJoinRequestsQuery = z.infer<typeof listJoinRequestsQuerySchema>;
|
|
|
|
export const listCompanyInvitesQuerySchema = z.object({
|
|
state: z.enum(["active", "revoked", "accepted", "expired"]).optional(),
|
|
limit: z.coerce.number().int().min(1).max(100).optional().default(20),
|
|
offset: z.coerce.number().int().min(0).optional().default(0),
|
|
});
|
|
|
|
export type ListCompanyInvitesQuery = z.infer<typeof listCompanyInvitesQuerySchema>;
|
|
|
|
export const claimJoinRequestApiKeySchema = z.object({
|
|
claimSecret: z.string().min(16).max(256),
|
|
});
|
|
|
|
export type ClaimJoinRequestApiKey = z.infer<typeof claimJoinRequestApiKeySchema>;
|
|
|
|
export const boardCliAuthAccessLevelSchema = z.enum([
|
|
"board",
|
|
"instance_admin_required",
|
|
]);
|
|
|
|
export type BoardCliAuthAccessLevel = z.infer<typeof boardCliAuthAccessLevelSchema>;
|
|
|
|
export const createCliAuthChallengeSchema = z.object({
|
|
command: z.string().min(1).max(240),
|
|
clientName: z.string().max(120).optional().nullable(),
|
|
requestedAccess: boardCliAuthAccessLevelSchema.default("board"),
|
|
requestedCompanyId: z.string().uuid().optional().nullable(),
|
|
});
|
|
|
|
export type CreateCliAuthChallenge = z.infer<typeof createCliAuthChallengeSchema>;
|
|
|
|
export const resolveCliAuthChallengeSchema = z.object({
|
|
token: z.string().min(16).max(256),
|
|
});
|
|
|
|
export type ResolveCliAuthChallenge = z.infer<typeof resolveCliAuthChallengeSchema>;
|
|
|
|
export const createBoardApiKeySchema = z.object({
|
|
name: z.string().trim().min(1).max(120).default("paperclipai cli"),
|
|
expiresAt: z.coerce.date().optional().nullable(),
|
|
requestedCompanyId: z.string().uuid().optional().nullable(),
|
|
});
|
|
|
|
export type CreateBoardApiKey = z.infer<typeof createBoardApiKeySchema>;
|
|
|
|
export const updateMemberPermissionsSchema = z.object({
|
|
grants: z.array(
|
|
z.object({
|
|
permissionKey: z.enum(PERMISSION_KEYS),
|
|
scope: z.record(z.string(), z.unknown()).optional().nullable(),
|
|
}),
|
|
),
|
|
});
|
|
|
|
export type UpdateMemberPermissions = z.infer<typeof updateMemberPermissionsSchema>;
|
|
|
|
const editableMembershipStatuses = ["pending", "active", "suspended"] as const;
|
|
|
|
export const updateCompanyMemberSchema = z.object({
|
|
membershipRole: z.enum(HUMAN_COMPANY_MEMBERSHIP_ROLES).optional().nullable(),
|
|
status: z.enum(editableMembershipStatuses).optional(),
|
|
}).refine((value) => value.membershipRole !== undefined || value.status !== undefined, {
|
|
message: "membershipRole or status is required",
|
|
});
|
|
|
|
export type UpdateCompanyMember = z.infer<typeof updateCompanyMemberSchema>;
|
|
|
|
export const updateCompanyMemberWithPermissionsSchema = z.object({
|
|
membershipRole: z.enum(HUMAN_COMPANY_MEMBERSHIP_ROLES).optional().nullable(),
|
|
status: z.enum(editableMembershipStatuses).optional(),
|
|
grants: updateMemberPermissionsSchema.shape.grants.default([]),
|
|
}).refine((value) => value.membershipRole !== undefined || value.status !== undefined, {
|
|
message: "membershipRole or status is required",
|
|
});
|
|
|
|
export type UpdateCompanyMemberWithPermissions = z.infer<typeof updateCompanyMemberWithPermissionsSchema>;
|
|
|
|
export const archiveCompanyMemberSchema = z.object({
|
|
reassignment: z
|
|
.object({
|
|
assigneeAgentId: z.string().uuid().optional().nullable(),
|
|
assigneeUserId: z.string().uuid().optional().nullable(),
|
|
})
|
|
.optional()
|
|
.nullable(),
|
|
}).superRefine((value, ctx) => {
|
|
if (value.reassignment?.assigneeAgentId && value.reassignment.assigneeUserId) {
|
|
ctx.addIssue({
|
|
code: z.ZodIssueCode.custom,
|
|
message: "Choose either an agent or user reassignment target",
|
|
path: ["reassignment"],
|
|
});
|
|
}
|
|
});
|
|
|
|
export type ArchiveCompanyMember = z.infer<typeof archiveCompanyMemberSchema>;
|
|
|
|
export const updateUserCompanyAccessSchema = z.object({
|
|
companyIds: z.array(z.string().uuid()).default([]),
|
|
});
|
|
|
|
export type UpdateUserCompanyAccess = z.infer<typeof updateUserCompanyAccessSchema>;
|
|
|
|
export const searchAdminUsersQuerySchema = z.object({
|
|
query: z.string().trim().max(120).optional().default(""),
|
|
});
|
|
|
|
export type SearchAdminUsersQuery = z.infer<typeof searchAdminUsersQuerySchema>;
|
|
|
|
const profileImageAssetPathPattern = /^\/api\/assets\/[^/?#]+\/content(?:\?[^#]*)?(?:#.*)?$/;
|
|
|
|
function isValidProfileImage(value: string): boolean {
|
|
if (profileImageAssetPathPattern.test(value)) return true;
|
|
|
|
try {
|
|
const url = new URL(value);
|
|
return url.protocol === "https:" || url.protocol === "http:";
|
|
} catch {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
const profileImageSchema = z
|
|
.string()
|
|
.trim()
|
|
.min(1)
|
|
.max(4000)
|
|
.refine(isValidProfileImage, { message: "Invalid profile image URL" });
|
|
|
|
export const currentUserProfileSchema = z.object({
|
|
id: z.string().min(1),
|
|
email: z.preprocess(
|
|
(v) => (typeof v === "string" && v.trim() === "" ? null : v),
|
|
z.string().email().nullable(),
|
|
),
|
|
name: z.preprocess(
|
|
(v) => (typeof v === "string" && v.trim() === "" ? null : v),
|
|
z.string().min(1).max(120).nullable(),
|
|
),
|
|
image: profileImageSchema.nullable(),
|
|
});
|
|
|
|
export type CurrentUserProfile = z.infer<typeof currentUserProfileSchema>;
|
|
|
|
export const authSessionSchema = z.object({
|
|
session: z.object({
|
|
id: z.string().min(1),
|
|
userId: z.string().min(1),
|
|
}),
|
|
user: currentUserProfileSchema,
|
|
});
|
|
|
|
export type AuthSession = z.infer<typeof authSessionSchema>;
|
|
|
|
export const updateCurrentUserProfileSchema = z.object({
|
|
name: z.string().trim().min(1).max(120),
|
|
image: z
|
|
.union([profileImageSchema, z.literal(""), z.null()])
|
|
.optional()
|
|
.transform((value) => value === "" ? null : value),
|
|
});
|
|
|
|
export type UpdateCurrentUserProfile = z.infer<typeof updateCurrentUserProfileSchema>;
|