fix: Enhance SCIM payload handling and attribute creation by hariombalhara · Pull Request #18427 · calcom/cal.com

hariombalhara · 2024-12-31T06:18:48Z

fix: the issue where a user update from Okta didn't sync attributes
fix: When creating a new attribute, OptionGroup was getting saved as regular Option itself.
Ignore core user attributes( as defined in the SCIM spec) from attributes syncing

Detailed Changes:

Updated getAttributesFromScimPayload to accept directoryId and ignore core attributes as defined in the SCIM spec.
Modified handleUserEvents to pass directoryId when calling getAttributesFromScimPayload.
Improved test cases for getAttributesFromScimPayload to reflect the new parameter and behavior.
Refactored attribute creation logic in attributes-create-view.tsx to streamline attribute submission.
Updated attribute creation schema to include optional isGroup property for options.
Introduced utility function getOptionsWithValidContains to ensure valid sub-option references during attribute creation.

These changes improve the robustness of user event handling and attribute management in the application.

What does this PR do?

Fixes #XXXX (GitHub issue number)
Fixes CAL-XXXX (Linear issue number - should be visible at the bottom of the GitHub issue description)

Mandatory Tasks (DO NOT REMOVE)

I have self-reviewed the code (A decent size PR without self-review might be rejected).
N/A I have updated the developer docs in /docs if this PR makes changes that would require a documentation change. If N/A, write N/A here and check the checkbox.
I confirm automated tests are in place that prove my fix is effective or that my feature works.

How should this be tested?

Create an attribute with option group
Try syncing the attribute from Okta for an already synced user.

vercel · 2024-12-31T06:18:53Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
cal	⬜️ Ignored (Inspect)	Visit Preview		Dec 31, 2024 10:18am
calcom-web-canary	⬜️ Ignored (Inspect)	Visit Preview		Dec 31, 2024 10:18am

graphite-app · 2024-12-31T06:20:12Z

Graphite Automations

"Add consumer team as reviewer" took an action on this PR • (12/31/24)

1 reviewer was added to this PR based on Keith Williams's automation.

github-actions · 2024-12-31T07:12:09Z

E2E results are ready!

Workflow #42659.1 latest results

- 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.

- 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.

hariombalhara · 2024-12-31T11:07:33Z

packages/features/ee/dsync/lib/handleUserEvents.ts

  });

-  // User is already a part of that org
-  if (user && UserRepository.isAMemberOfOrganization({ user, organizationId }) && eventData.active) {


It was causing the update to not sync attribues as the user is already a part of org.

hariombalhara · 2024-12-31T11:07:44Z

packages/features/ee/dsync/lib/handleUserEvents.ts

-        org,
-        directoryId,
-      });
+      if (UserRepository.isAMemberOfOrganization({ user, organizationId })) {


Still allow attributes sync for existing user.

hariombalhara · 2024-12-31T11:08:16Z

packages/trpc/server/routers/viewer/attributes/create.handler.ts

  const slug = slugify(input.name);
-  const options = input.options.map((v) => v.value);
-  const optionsWithoutDuplicates = Array.from(new Set(options));
+  const uniqueOptions = getOptionsWithValidContains(input.options);


Using common utility

hariombalhara · 2024-12-31T11:08:44Z

packages/trpc/server/routers/viewer/attributes/create.schema.ts

  type: z.enum(["TEXT", "NUMBER", "SINGLE_SELECT", "MULTI_SELECT"]),
  isLocked: z.boolean().optional(),
-  options: z.array(z.object({ value: z.string() })),
+  options: z.array(z.object({ value: z.string(), isGroup: z.boolean().optional() })),


It was causing a groupOption to become regular option when created during the attribute creation itself.

hbjORbj

LGTM!

* 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.

graphite-app bot requested a review from a team December 31, 2024 06:18

keithwillcode added the core area: core, team members only label Dec 31, 2024

dosubot bot added the enterprise area: enterprise, audit log, organisation, SAML, SSO label Dec 31, 2024

keithwillcode added the enterprise area: enterprise, audit log, organisation, SAML, SSO label Dec 31, 2024

hariombalhara changed the base branch from okta-sync-fixes to main December 31, 2024 06:19

vercel bot deployed to Preview – api December 31, 2024 06:27 View deployment

hariombalhara added the ready-for-e2e label Dec 31, 2024

hariombalhara closed this Dec 31, 2024

hariombalhara force-pushed the okta-attributes-sync-fixes branch from 67dd2d8 to 63013d4 Compare December 31, 2024 07:16

hariombalhara reopened this Dec 31, 2024

vercel bot deployed to Preview – api December 31, 2024 07:32 View deployment

vercel bot deployed to Preview – api December 31, 2024 10:25 View deployment

hariombalhara commented Dec 31, 2024

View reviewed changes

hariombalhara self-assigned this Dec 31, 2024

hariombalhara requested a review from joeauyeung December 31, 2024 11:09

hbjORbj approved these changes Jan 3, 2025

View reviewed changes

hariombalhara merged commit 727f7df into main Jan 3, 2025

hariombalhara deleted the okta-attributes-sync-fixes branch January 3, 2025 08:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Enhance SCIM payload handling and attribute creation#18427

fix: Enhance SCIM payload handling and attribute creation#18427
hariombalhara merged 2 commits intomainfrom
okta-attributes-sync-fixes

hariombalhara commented Dec 31, 2024 •

edited

Loading

Uh oh!

vercel bot commented Dec 31, 2024 •

edited

Loading

Uh oh!

graphite-app bot commented Dec 31, 2024

Uh oh!

github-actions bot commented Dec 31, 2024 •

edited

Loading

Uh oh!

hariombalhara Dec 31, 2024

Uh oh!

hariombalhara Dec 31, 2024

Uh oh!

hariombalhara Dec 31, 2024

Uh oh!

hariombalhara Dec 31, 2024

Uh oh!

hbjORbj left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

hariombalhara commented Dec 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Mandatory Tasks (DO NOT REMOVE)

How should this be tested?

Uh oh!

vercel bot commented Dec 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

graphite-app bot commented Dec 31, 2024

Graphite Automations

Uh oh!

github-actions bot commented Dec 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

E2E results are ready!

Uh oh!

hariombalhara Dec 31, 2024

Choose a reason for hiding this comment

Uh oh!

hariombalhara Dec 31, 2024

Choose a reason for hiding this comment

Uh oh!

hariombalhara Dec 31, 2024

Choose a reason for hiding this comment

Uh oh!

hariombalhara Dec 31, 2024

Choose a reason for hiding this comment

Uh oh!

hbjORbj left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

hariombalhara commented Dec 31, 2024 •

edited

Loading

vercel bot commented Dec 31, 2024 •

edited

Loading

github-actions bot commented Dec 31, 2024 •

edited

Loading