Files
calendar/packages/features/ee/dsync/lib/handleUserEvents.ts
T
Hariom BalharaandGitHub 727f7df2c2 fix: Enhance SCIM payload handling and attribute creation (#18427)
* feat: Enhance SCIM user attribute handling and sync process

- Introduced a new PR_TODO.md file to track ongoing tasks and fixes.
- Updated `getAttributesFromScimPayload` to accept a directoryId and ignore core user attributes during syncing.
- Modified `handleUserEvents` to pass directoryId when syncing custom attributes.
- Improved attribute creation logic to handle unique options and added support for optional isGroup property in attribute options.
- Added utility function `getOptionsWithValidContains` to ensure valid sub-options in attribute options.
- Updated tests to reflect changes in attribute handling and ensure proper functionality.

This commit addresses issues with user attribute syncing and enhances the overall attribute management process.

* test: Add unit tests for getOptionsWithValidContains utility function

- Introduced a new test file for the getOptionsWithValidContains function.
- Added tests to verify the removal of duplicate options, initialization of empty contains arrays, filtering of non-existent sub-options, and handling of empty options arrays.
- Ensured comprehensive coverage of the utility's functionality to enhance reliability and maintainability.
2025-01-03 13:36:21 +05:30

149 lines
4.4 KiB
TypeScript

import type { DirectorySyncEvent, User } from "@boxyhq/saml-jackson";
import removeUserFromOrg from "@calcom/features/ee/dsync/lib/removeUserFromOrg";
import logger from "@calcom/lib/logger";
import { safeStringify } from "@calcom/lib/safeStringify";
import { getTranslation } from "@calcom/lib/server/i18n";
import { UserRepository } from "@calcom/lib/server/repository/user";
import { assignValueToUserInOrgBulk } from "@calcom/lib/service/attribute/server/assignValueToUser";
import prisma from "@calcom/prisma";
import { IdentityProvider } from "@calcom/prisma/enums";
import { getTeamOrThrow } from "@calcom/trpc/server/routers/viewer/teams/inviteMember/utils";
import type { UserWithMembership } from "@calcom/trpc/server/routers/viewer/teams/inviteMember/utils";
import { sendExistingUserTeamInviteEmails } from "@calcom/trpc/server/routers/viewer/teams/inviteMember/utils";
import { sendSignupToOrganizationEmail } from "@calcom/trpc/server/routers/viewer/teams/inviteMember/utils";
import getAttributesFromScimPayload from "./getAttributesFromScimPayload";
import createUsersAndConnectToOrg from "./users/createUsersAndConnectToOrg";
import dSyncUserSelect from "./users/dSyncUserSelect";
import inviteExistingUserToOrg from "./users/inviteExistingUserToOrg";
const log = logger.getSubLogger({ prefix: ["handleUserEvents"] });
async function syncCustomAttributesToUser({
event,
userEmail,
org,
directoryId,
}: {
event: DirectorySyncEvent;
userEmail: string;
org: {
id: number;
};
directoryId: string;
}) {
const user = await prisma.user.findFirst({
where: {
email: userEmail,
},
select: dSyncUserSelect,
});
if (!user) {
log.error(`User not found in DB ${userEmail}. Skipping custom attributes sync.`);
return;
}
const customAttributes = getAttributesFromScimPayload({ event, directoryId });
await assignValueToUserInOrgBulk({
orgId: org.id,
userId: user.id,
attributeLabelToValueMap: customAttributes,
updater: {
dsyncId: directoryId,
},
});
}
const handleUserEvents = async (event: DirectorySyncEvent, organizationId: number) => {
log.debug("called", safeStringify(event));
const directoryId = event.directory_id;
const eventData = event.data as User;
const userEmail = eventData.email;
// Check if user exists in DB
const user = await prisma.user.findFirst({
where: {
email: userEmail,
},
select: dSyncUserSelect,
});
const translation = await getTranslation(user?.locale || "en", "common");
const org = await getTeamOrThrow(organizationId);
if (!org) {
throw new Error("Org not found");
}
if (user) {
if (eventData.active) {
if (UserRepository.isAMemberOfOrganization({ user, organizationId })) {
await syncCustomAttributesToUser({
event,
userEmail,
org,
directoryId,
});
} else {
// If data.active is true then provision the user into the org
const addedUser = await inviteExistingUserToOrg({
user: user as UserWithMembership,
org,
translation,
});
await sendExistingUserTeamInviteEmails({
currentUserName: user.username,
currentUserTeamName: org.name,
existingUsersWithMemberships: [
{
...addedUser,
profile: null,
},
],
language: translation,
isOrg: true,
teamId: org.id,
isAutoJoin: true,
currentUserParentTeamName: org?.parent?.name,
orgSlug: org.slug,
});
}
} else {
// If data.active is false then remove the user from the org
await removeUserFromOrg({
userId: user.id,
orgId: organizationId,
});
}
// If user is not in DB, create user and add to the org
} else {
const createUsersAndConnectToOrgProps = {
emailsToCreate: [userEmail],
organizationId: org.id,
identityProvider: IdentityProvider.CAL,
identityProviderId: null,
};
await createUsersAndConnectToOrg(createUsersAndConnectToOrgProps);
await sendSignupToOrganizationEmail({
usernameOrEmail: userEmail,
team: org,
translation,
inviterName: org.name,
teamId: organizationId,
isOrg: true,
});
await syncCustomAttributesToUser({
event,
userEmail,
org,
directoryId,
});
}
};
export default handleUserEvents;