Files
Peer RichelsenGitHubDevin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>[email protected] <[email protected]>Lauris Skraucissupalarrycubic-dev-ai[bot] <1082092+cubic-dev-ai[bot]@users.noreply.github.com>CarinaWolli[email protected] <[email protected]>Morgan
a03722fd7f feat: add OAuth client developer settings page with approval workflow (#25556)
* feat: add OAuth client developer settings page with approval workflow

- Add new developer OAuth page at /settings/developer/oAuth for users to submit OAuth client requests
- Transform admin OAuth page into management dashboard for reviewing/approving submissions
- Add OAuthClientApprovalStatus enum (PENDING, APPROVED, REJECTED) to track submission status
- Add userId and createdAt fields to OAuthClient model for tracking submissions
- Create email notifications for admin (new submission) and user (approval)
- Add sidebar navigation link in developer section below API keys
- Add comprehensive translations for new UI strings
- Create OAuthClientRepository for data access following repository pattern

Co-Authored-By: [email protected] <[email protected]>

* fix: re-export generateSecret for backward compatibility

Co-Authored-By: [email protected] <[email protected]>

* feat: make logo mandatory and list items clickable for OAuth clients

Co-Authored-By: [email protected] <[email protected]>

* fix: add missing translation keys and remove client secret from details dialog

Co-Authored-By: [email protected] <[email protected]>

* fix: address cubic AI reviewer comments

- Remove duplicate 'there' JSON key in common.json
- Add select clause to findByUserId to avoid exposing clientSecret
- Add @@index([userId]) to OAuthClient model for query performance
- Update migration to include the index

Co-Authored-By: [email protected] <[email protected]>

* fix: address PR review comments - fix indentation and use useCopy hook

Co-Authored-By: [email protected] <[email protected]>

* fix: change react-dom/server import to fix Turbopack compatibility

Co-Authored-By: [email protected] <[email protected]>

* Revert "fix: change react-dom/server import to fix Turbopack compatibility"

This reverts commit c3e0b709c2d88fd221143cb4ce9cd25bb8c94277.

* fix: use email service pattern for OAuth client notifications

Co-Authored-By: [email protected] <[email protected]>

* fix: add try-catch around email sending to handle Turbopack react-dom/server issue

Co-Authored-By: [email protected] <[email protected]>

* Revert "fix: add try-catch around email sending to handle Turbopack react-dom/server issue"

This reverts commit fc9d47cd773505ebc5ee2696718aad4a8a98be77.

* fix: improve OAuth client UI with skeleton loaders and smaller dialog styling

- Replace 'Loading...' text with proper skeleton loaders in both developer and admin OAuth client views
- Make client_id and copy button smaller in dialogs using size='sm' and text-sm styling
- Add 'client_id' translation key to common.json for proper i18n

Co-Authored-By: [email protected] <[email protected]>

* fix: improve skeleton loader to match actual OAuth client list structure

- Remove divide-y from container and use conditional border-b on rows
- Match the exact structure from oauth-clients-view.tsx L126-160
- Use proper spacing for text elements (mt-1 instead of space-y-2)

Co-Authored-By: [email protected] <[email protected]>

* fix skeleton

* rename the selected oauth client dialog

* fix: address PR feedback - admin auth, dropdown styling, sidebar label

- Add defense-in-depth admin authorization check in updateClientStatus handler
- Fix broken dropdown menu by using DropdownItem with StartIcon prop
- Fix sidebar menu label from 'oAuth' to 'oauth_clients' to match developer view

Co-Authored-By: [email protected] <[email protected]>

* update common.json

* feat: show client secret in approval email for confidential OAuth clients

- Add regenerateSecret method to OAuthClientRepository
- Regenerate secret when admin approves a PENDING confidential client
- Include client secret in approval notification email
- Add one-time warning message about storing the secret securely
- Only regenerate on first approval (not re-approvals)

Co-Authored-By: [email protected] <[email protected]>

* feat: add Website URL field, fix logo styling, show client secret after approval

- Add Website URL field to OAuth client forms (admin and developer views)
- Fix Upload Logo section styling by wrapping in Label div with proper gap
- Display client secret in dialog after admin approves a confidential OAuth client
- Add websiteUrl field to Prisma schema with migration
- Update tRPC handlers and repository to support websiteUrl
- Add translation keys for new UI elements

Co-Authored-By: [email protected] <[email protected]>

* fix: move clientSecret variable declaration outside if block for proper scoping

Co-Authored-By: [email protected] <[email protected]>

* refactor: dont expose client secret in emails

* refactor: dont regenerate secret upon status change

* refactor: reuse existing hash function

* refactor: rename admin/oAuth to admin/oauth page

* refactor: deduplicate oauth repositories

* refactor: remove withGlobalPrisma from oauth repository

* refactor: developer oauth page

* refactor: oauth status by default accepted

* refactor: request oauth status when creating

* refactor ux

* fix: address Cubic AI code review feedback

- Add purpose field to plain text email body for accessibility
- Convert NewOAuthClientButton to inline JSX to avoid React anti-pattern
- Trigger re-approval when redirectUri changes for security
- Add e.preventDefault() for Space key to prevent page scroll
- Change default approvalStatus to PENDING for defense-in-depth
- Use oauth_clients translation key for consistency
- Add meaningful alt text to Avatar for accessibility
- Remove onClick from DialogClose to prevent double-run close effects
- Return NOT_FOUND for non-owner delete to prevent resource enumeration

Co-Authored-By: unknown <>

* common.json file

* refactor: delete all prisma migrations

* refactor: have just 1 prisma migration

* revert: some devin changes

* fix: typecheck

* test: owner OAuth crud

* test: admin OAuth approval / rejection

* fix: address Cubic AI review feedback (confidence 9/10 issues)

- schema.prisma: Remove @default("") from purpose field to make it required
- schema.prisma: Use UTC-aware timezone expression for createdAt default
- OAuthClientFormFields.tsx: Localize redirect URI placeholder using t()
- common.json: Add redirect_uri_placeholder translation key

Co-Authored-By: unknown <>

* cubic changes

* refactor: dont log sensitive info and rethrow error

* cubic feedback

* refactor: make oauth client purpose optional

* refactor: admin/oauth not allowed if not logged in

* refactor: admin view skeleton

* refactor: rename state

* refactor: get rid of redundant mapping

* refactor: remove redundant handler

* refactor: remove redundant handler

* refactor: re-usable new oauth client button

* refactor: dialogs

* refactor: modals

* refactor: handler names, dialog, skeleton

* fix: purpose being null

* refactor: rename handler and delete old oauth admin page

* fix: purpose in submission

* refactor: handler names

* refactor: rename

* refactor: update handler

* refactor: rename approvalStatus -> status

* refactor: simplify modal

* refactor: name

* dont require repproval if redirectUri changes

* fix: remove integration sync index creation

* refactor: require re-approval if redirectUri updated

* fix: flaky e2e test

* fix: flaky e2e test

* fix: flaky e2e test

* fix: remove duplicate common.json keys

* refactor: replace [email protected] with SUPPORT_MAIL_ADDRESS

* refactor: generate client secret on handler level

* fix: authorization code only available to approved clients

* refactor: cubic review dont display exclamation

* refactor: cubic review website_url in common json

* fix: dont default in ui to approved status

* refactor: optiona logo in schema create handler

* fix: tests

* fix: tests

* fix: /authorize redirect if client not approved or show error

* test: authorize page with invalid client id

* refactor: dont allow refreshing tokens unless approved client

* fix: flaky e2e test

* fix: flaky e2e test

* fix: flaky e2e test

* fix: flaky e2e test

* fix: flaky e2e test

* fix: flaky e2e test

* chore: warn that pending client is not usable

* fix: approve and reject buttons

* fix: /authorize show error if client not approved

* refactor: info message about editing oauth client and status

* change info alert to warning

* try to fix ci test

* debug: failing e2e test

* fix: improve session propagation in oauth-client-admin E2E test

- Add navigateToAdminOAuthPage helper that waits for listClients API call
- If the API call doesn't arrive (session issue), reload page to force session refresh
- This fixes the CI flakiness where admin page wasn't loading due to session not having ADMIN role

Co-Authored-By: [email protected] <[email protected]>

* fix: register waitForResponse before navigating in E2E test

- Register the listClients waitForResponse promise BEFORE page.goto()
- This ensures the response isn't missed during page load
- Also register the promise before reload in the catch block

Co-Authored-By: [email protected] <[email protected]>

* fix: rename oAuth folder to oauth for case-sensitive filesystems

The admin OAuth page route was at /settings/admin/oAuth (capital A) but the
code references /settings/admin/oauth (lowercase). This caused 404 errors
on case-sensitive filesystems (Linux).

Also improved the E2E test navigation helper to retry with delays if the
admin page doesn't load immediately, handling session propagation timing.

Co-Authored-By: [email protected] <[email protected]>

* test style

---------

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: [email protected] <[email protected]>
Co-authored-by: Lauris Skraucis <[email protected]>
Co-authored-by: supalarry <[email protected]>
Co-authored-by: cubic-dev-ai[bot] <1082092+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: CarinaWolli <[email protected]>
Co-authored-by: [email protected] <[email protected]>
Co-authored-by: Morgan <[email protected]>
2026-01-21 12:23:51 -03:00

311 lines
8.6 KiB
TypeScript

import { TRPCError } from "@trpc/server";
import { sendOAuthClientApprovedNotification, sendOAuthClientRejectedNotification } from "@calcom/emails/oauth-email-service";
import { getTranslation } from "@calcom/lib/server/i18n";
import { OAuthClientRepository } from "@calcom/features/oauth/repositories/OAuthClientRepository";
import type { PrismaClient } from "@calcom/prisma";
import { UserPermissionRole } from "@calcom/prisma/enums";
import type { OAuthClientStatus } from "@calcom/prisma/enums";
import type { TUpdateClientInputSchema } from "./updateClient.schema";
type UpdateClientOptions = {
ctx: {
user: {
id: number;
role: UserPermissionRole;
};
prisma: PrismaClient;
};
input: TUpdateClientInputSchema;
};
type UpdateClientOutput = {
clientId: string;
name: string;
purpose: string | null;
status: OAuthClientStatus;
redirectUri: string;
websiteUrl: string | null;
logo: string | null;
rejectionReason: string | null;
};
const updateClientHandler = async ({
ctx,
input,
}: UpdateClientOptions): Promise<UpdateClientOutput> => {
const {
clientId,
status: requestedStatus,
rejectionReason,
name,
purpose,
redirectUri,
websiteUrl,
logo,
} = input;
const oAuthClientRepository = new OAuthClientRepository(ctx.prisma);
const isAdmin = ctx.user.role === UserPermissionRole.ADMIN;
const clientWithUser = await oAuthClientRepository.findByClientIdIncludeUser(clientId);
if (!clientWithUser) {
throw new TRPCError({ code: "NOT_FOUND", message: "OAuth Client not found" });
}
const isOwner = clientWithUser.userId != null && clientWithUser.userId === ctx.user.id;
if (rejectionReason !== undefined && !isAdmin) {
throw new TRPCError({ code: "FORBIDDEN", message: "Only admins can set a rejection reason" });
}
if (requestedStatus === "REJECTED" && (!rejectionReason || rejectionReason.trim().length === 0)) {
throw new TRPCError({ code: "BAD_REQUEST", message: "Rejection reason is required" });
}
const isUpdatingFields = hasAnyFieldsChanged({ name, purpose, redirectUri, websiteUrl, logo });
const isUpdatingStatus = requestedStatus !== undefined;
if (isUpdatingStatus && !isAdmin) {
throw new TRPCError({ code: "FORBIDDEN", message: "Only admins can update OAuth client status" });
}
if (isUpdatingFields && !isAdmin && !isOwner) {
throw new TRPCError({ code: "FORBIDDEN", message: "You do not have permission to update this OAuth client" });
}
const shouldTriggerReapprovalForOwnerEdit = triggersReapprovalForOwnerEdit({
isAdmin,
isOwner,
currentClient: {
name: clientWithUser.name,
logo: clientWithUser.logo,
websiteUrl: clientWithUser.websiteUrl,
redirectUri: clientWithUser.redirectUri,
},
proposedUpdates: {
name,
logo,
websiteUrl,
redirectUri,
},
});
const nextStatus = computeNextStatus({
requestedStatus,
triggersReapprovalForOwnerEdit: shouldTriggerReapprovalForOwnerEdit,
currentStatus: clientWithUser.status,
});
const updateData = buildUpdateClientUpdateData({
name,
purpose,
redirectUri,
logo,
websiteUrl,
requestedStatus,
rejectionReason,
nextStatus,
currentStatus: clientWithUser.status,
});
const updatedClient = await ctx.prisma.oAuthClient.update({
where: { clientId },
data: updateData,
select: {
clientId: true,
name: true,
purpose: true,
status: true,
redirectUri: true,
websiteUrl: true,
logo: true,
rejectionReason: true,
},
});
await notifyOwnerAboutAdminReview({
isAdmin,
requestedStatus,
clientWithUser,
updatedClient: {
clientId: updatedClient.clientId,
name: updatedClient.name,
},
rejectionReason,
});
return {
clientId: updatedClient.clientId,
name: updatedClient.name,
purpose: updatedClient.purpose,
status: updatedClient.status,
redirectUri: updatedClient.redirectUri,
websiteUrl: updatedClient.websiteUrl,
logo: updatedClient.logo,
rejectionReason: updatedClient.rejectionReason,
};
};
function toNullableString(value: string | null | undefined) {
return value ?? null;
}
function hasAnyFieldsChanged(fields: Record<string, unknown>) {
return Object.values(fields).some((value) => value !== undefined);
}
type ClientFieldsForReapprovalCheck = {
name: string;
logo: string | null;
websiteUrl: string | null;
redirectUri: string;
};
function triggersReapprovalForOwnerEdit(params: {
isAdmin: boolean;
isOwner: boolean;
currentClient: ClientFieldsForReapprovalCheck;
proposedUpdates: Partial<{
name: string;
logo: string | null;
websiteUrl: string | null;
redirectUri: string;
}>;
}) {
const { isAdmin, isOwner, currentClient, proposedUpdates } = params;
if (isAdmin) return false;
if (!isOwner) return false;
if (proposedUpdates.name !== undefined && proposedUpdates.name !== currentClient.name) {
return true;
}
if (
proposedUpdates.logo !== undefined &&
toNullableString(proposedUpdates.logo) !== toNullableString(currentClient.logo)
) {
return true;
}
if (
proposedUpdates.websiteUrl !== undefined &&
toNullableString(proposedUpdates.websiteUrl) !== toNullableString(currentClient.websiteUrl)
) {
return true;
}
if (proposedUpdates.redirectUri !== undefined && proposedUpdates.redirectUri !== currentClient.redirectUri) {
return true;
}
return false;
}
function computeNextStatus(params: {
requestedStatus: OAuthClientStatus | undefined;
triggersReapprovalForOwnerEdit: boolean;
currentStatus: OAuthClientStatus;
}): OAuthClientStatus {
const { requestedStatus, triggersReapprovalForOwnerEdit, currentStatus } = params;
if (requestedStatus !== undefined) return requestedStatus;
if (triggersReapprovalForOwnerEdit) return "PENDING";
return currentStatus;
}
type NotifyOwnerAboutAdminReviewParams = {
isAdmin: boolean;
requestedStatus: OAuthClientStatus | undefined;
clientWithUser: Awaited<ReturnType<OAuthClientRepository["findByClientIdIncludeUser"]>> | null;
updatedClient: {
clientId: string;
name: string;
};
rejectionReason: string | undefined;
};
async function notifyOwnerAboutAdminReview(params: NotifyOwnerAboutAdminReviewParams) {
const { isAdmin, requestedStatus, clientWithUser, updatedClient, rejectionReason } = params;
if (!isAdmin) return;
if (requestedStatus !== "APPROVED" && requestedStatus !== "REJECTED") return;
if (!clientWithUser?.user) return;
const t = await getTranslation("en", "common");
if (requestedStatus === "APPROVED") {
await sendOAuthClientApprovedNotification({
t,
userEmail: clientWithUser.user.email,
userName: clientWithUser.user.name,
clientName: updatedClient.name,
clientId: updatedClient.clientId,
});
return;
}
await sendOAuthClientRejectedNotification({
t,
userEmail: clientWithUser.user.email,
userName: clientWithUser.user.name,
clientName: updatedClient.name,
clientId: updatedClient.clientId,
rejectionReason: rejectionReason?.trim() ?? "",
});
}
type UpdateOAuthClientData = {
name?: string;
purpose?: string;
redirectUri?: string;
logo?: string | null;
websiteUrl?: string | null;
status?: OAuthClientStatus;
rejectionReason?: string | null;
};
function buildUpdateClientUpdateData(params: {
name: string | undefined;
purpose: string | undefined;
redirectUri: string | undefined;
logo: string | null | undefined;
websiteUrl: string | null | undefined;
requestedStatus: OAuthClientStatus | undefined;
rejectionReason: string | undefined;
nextStatus: OAuthClientStatus;
currentStatus: OAuthClientStatus;
}): UpdateOAuthClientData {
const {
name,
purpose,
redirectUri,
logo,
websiteUrl,
requestedStatus,
rejectionReason,
nextStatus,
currentStatus,
} = params;
const updateData: UpdateOAuthClientData = {};
if (name !== undefined) updateData.name = name;
if (purpose !== undefined) updateData.purpose = purpose;
if (redirectUri !== undefined) updateData.redirectUri = redirectUri;
if (logo !== undefined) updateData.logo = logo;
if (websiteUrl !== undefined) updateData.websiteUrl = websiteUrl;
if (nextStatus !== currentStatus) updateData.status = nextStatus;
if (requestedStatus === "REJECTED") {
updateData.rejectionReason = rejectionReason?.trim() ?? null;
} else if (requestedStatus !== undefined) {
updateData.rejectionReason = null;
} else if (nextStatus !== currentStatus && nextStatus !== "REJECTED") {
updateData.rejectionReason = null;
}
return updateData;
}
export { updateClientHandler };