feat: Salesforce - on booking write to fields on person record [CAL-4575] by joeauyeung · Pull Request #17477 · calcom/cal.diy

joeauyeung · 2024-11-05T04:05:20Z

What does this PR do?

This PR introduces the ability to write to custom fields on a person record (lead, contact, account) in Salesforce when a booking is created. There are currently two data types we handle, text and dates.

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

https://www.loom.com/share/06dc1ad0acce47bcb076ddec3bbedb3a

Mandatory Tasks (DO NOT REMOVE)

I have self-reviewed the code (A decent size PR without self-review might be rejected).
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?

Install Salesforce on an event type
Enable "On booking, write to a custom field on the attendee Contact record" on the Salesforce options
Add an entry to write the booking date on a date field in Salesforce
Add an entry to write text to a text field in Salesforce
Create a booking
The values should be written on those fields

github-actions · 2024-11-05T04:05:34Z

Hey there and thank you for opening this pull request! 👋🏼

We require pull request titles to follow the Conventional Commits specification and it looks like your proposed title needs to be adjusted.

Details:

No release type found in pull request title "Salesforce - on booking write to fields on person record". Add a prefix to indicate what kind of release this pull request corresponds to. For reference, see https://www.conventionalcommits.org/

Available types:
 - feat: A new feature
 - fix: A bug fix
 - docs: Documentation only changes
 - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
 - refactor: A code change that neither fixes a bug nor adds a feature
 - perf: A code change that improves performance
 - test: Adding missing tests or correcting existing tests
 - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
 - ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
 - chore: Other changes that don't modify src or test files
 - revert: Reverts a previous commit

joeauyeung · 2024-11-05T04:06:25Z

+
+    if (
+      createEventOn === SalesforceRecordEnum.LEAD &&
+      appOptions.createEventOnLeadCheckForContact &&


This option allows us to write to either a lead or a contact. So we need to determine what record to query.

joeauyeung · 2024-11-05T04:06:59Z

-      if (contactSearch && contactSearch.records.length > 0)
+      if (contactSearch && contactSearch.records.length > 0) {
        records = contactSearch.records as ContactRecord[];
+        this.setFallbackToContact(true);


If we're falling back to a contact, let's store that as a variable so in other methods, we know to query the contact objects.

joeauyeung · 2024-11-05T04:07:23Z


        if (fieldSet.has(field.name)) {
-          foundFields.push(field.name);
+          foundFields.push(field);


Instead of returning just the field names, we're returning the whole field object.

joeauyeung · 2024-11-05T04:07:45Z

+    // Search the fields and ensure 1. they exist 2. they're the right type
+    const fieldsToWriteOn = Object.keys(onBookingWriteToRecordFields);
+
+    const existingFields = await this.ensureFieldsExistOnObject(fieldsToWriteOn, personRecordType);


Determine that the fields exist on the record or else it would throw an error.

joeauyeung · 2024-11-05T04:08:13Z

+      // Determine if the field to write on matches the field type
+      if (fieldToWriteOn.fieldType === salesforceField.type) {
+        if (salesforceField.type === SalesforceFieldType.TEXT) {
+          const stringToWrite = fieldToWriteOn.value.substring(0, salesforceField.length);


The string length is determined by the custom field in Salesforce

joeauyeung · 2024-11-05T04:08:27Z

+
+    // Update the person record
+    const response = await conn.sobject(personRecordType).update({
+      Id: contactId,


The first property in the update object is the WHERE clause.

joeauyeung · 2024-11-05T04:08:36Z

Renamed this file

vercel · 2024-11-05T04:09:17Z

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		Nov 6, 2024 8:07am
calcom-web-canary	⬜️ Ignored (Inspect)	Visit Preview		Nov 6, 2024 8:07am

graphite-app · 2024-11-05T04:10:12Z

Graphite Automations

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

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

"Add ready-for-e2e label" took an action on this PR • (11/06/24)

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

Udit-takkar · 2024-11-05T08:18:13Z

+
+export enum SalesforceFieldType {
+  DATE = "date",
+  TEXT = "string",
+}


what about other field types?

We can add those later. I want to get this feature out now as a customer has been waiting.

Udit-takkar · 2024-11-05T08:19:32Z

+              return;
+            }
+
+            writeOnRecordBody[salesforceField.name] = new Date(booking.createdAt).toISOString();


booking.creaedAt is already in ISO format

What if we left it as is? Right now it's typed as a Date but when calling .toISOString() it converts it to type string which the function getDateFieldValue expects as a return value.

Udit-takkar

Ideally a function in a class should be responsible for one thing.

I have refactored the CRM service function that you created here #17481 to make it more readable, easier to test and maintainable

emrysal · 2024-11-05T11:04:29Z

+  const [writeToPersonObjectFieldType, setWriteToPersonObjectFieldType] = useState(fieldTypeOptions[0]);
+
+  const whenToWriteToRecordOptions = [
+    { label: "On every booking", value: WhenToWriteToRecord.EVERY_BOOKING },


Do we want to translate these?

…17481)

linear · 2024-11-05T17:30:43Z

CAL-4575 Salesforce - when creating a booking for the first time in an event type, write the date to the contact/lead

Udit-takkar

LGTM

github-actions · 2024-11-06T08:23:46Z

E2E results are ready!

Workflow #37037.1 latest results

joeauyeung added 6 commits November 4, 2024 14:50

Create data type

3458a30

Start FE component

b3dd6e5

Rename and add new enums

6462376

Add new schema for write on record options

1cac58d

Add options on the frontend

1923e70

Backend write to custom fields

2900c6e

dosubot Bot added crm-apps area: crm apps, salesforce, hubspot, close.com, sendgrid ✨ feature New feature or request labels Nov 5, 2024

keithwillcode added consumer core area: core, team members only labels Nov 5, 2024

vercel Bot deployed to Preview – dev November 5, 2024 04:06 View deployment

graphite-app Bot requested a review from a team November 5, 2024 04:06

joeauyeung commented Nov 5, 2024

View reviewed changes

joeauyeung changed the title ~~Salesforce - on booking write to fields on person record~~ feat: Salesforce - on booking write to fields on person record Nov 5, 2024

Merge branch 'main' into salesforce-write-to-person-record

c4cb154

vercel Bot had a problem deploying to Preview – api November 5, 2024 04:14 Failure

vercel Bot deployed to Preview – dev November 5, 2024 04:24 View deployment

Merge branch 'main' into salesforce-write-to-person-record

01a77ce

vercel Bot had a problem deploying to Preview – api November 5, 2024 07:57 Failure

vercel Bot deployed to Preview – dev November 5, 2024 08:07 View deployment

Udit-takkar reviewed Nov 5, 2024

View reviewed changes

Udit-takkar mentioned this pull request Nov 5, 2024

refactor: Salesforce - on booking write to fields on person record #17481

Merged

3 tasks

Udit-takkar added this to the v4.7 milestone Nov 5, 2024

Udit-takkar reviewed Nov 5, 2024

View reviewed changes

emrysal reviewed Nov 5, 2024

View reviewed changes

refactor: Salesforce - on booking write to fields on person record (#…

6455feb

…17481)

vercel Bot had a problem deploying to Preview – api November 5, 2024 15:03 Failure

vercel Bot deployed to Preview – dev November 5, 2024 15:21 View deployment

Add translations

41b1db4

joeauyeung requested review from Udit-takkar and emrysal November 5, 2024 15:42

vercel Bot had a problem deploying to Preview – api November 5, 2024 15:43 Failure

vercel Bot deployed to Preview – dev November 5, 2024 15:54 View deployment

joeauyeung changed the title ~~feat: Salesforce - on booking write to fields on person record~~ feat: Salesforce - on booking write to fields on person record [CAL-4575] Nov 5, 2024

Merge branch 'main' into salesforce-write-to-person-record

2168744

vercel Bot had a problem deploying to Preview – api November 5, 2024 17:58 Failure

vercel Bot deployed to Preview – dev November 5, 2024 18:09 View deployment

Udit-takkar previously approved these changes Nov 6, 2024

View reviewed changes

graphite-app Bot added the ready-for-e2e label Nov 6, 2024

fix: type err

39824cf

Udit-takkar dismissed their stale review via 39824cf November 6, 2024 08:02

Udit-takkar approved these changes Nov 6, 2024

View reviewed changes

Udit-takkar enabled auto-merge (squash) November 6, 2024 08:09

vercel Bot deployed to Preview – api November 6, 2024 08:11 View deployment

vercel Bot deployed to Preview – dev November 6, 2024 08:20 View deployment

Udit-takkar merged commit e07a28a into main Nov 6, 2024

Udit-takkar deleted the salesforce-write-to-person-record branch November 6, 2024 08:20

Conversation

joeauyeung commented Nov 5, 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!

github-actions Bot commented Nov 5, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vercel Bot commented Nov 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

graphite-app Bot commented Nov 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Graphite Automations

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Udit-takkar left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

linear Bot commented Nov 5, 2024

Uh oh!

Udit-takkar left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Nov 6, 2024

E2E results are ready!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

joeauyeung commented Nov 5, 2024 •

edited

Loading

vercel Bot commented Nov 5, 2024 •

edited

Loading

graphite-app Bot commented Nov 5, 2024 •

edited

Loading