Files
calendar/packages/app-store/salesforce/lib/CrmService.ts
T
2025-02-21 20:14:28 +05:30

1427 lines
48 KiB
TypeScript

import type { TokenResponse, Connection, Field } from "@jsforce/jsforce-node";
import jsforce from "@jsforce/jsforce-node";
import { RRule } from "rrule";
import { z } from "zod";
import type { FormResponse } from "@calcom/app-store/routing-forms/types/types";
import { getLocation } from "@calcom/lib/CalEventParser";
import { WEBAPP_URL } from "@calcom/lib/constants";
import { checkIfFreeEmailDomain } from "@calcom/lib/freeEmailDomainCheck/checkIfFreeEmailDomain";
import logger from "@calcom/lib/logger";
import { safeStringify } from "@calcom/lib/safeStringify";
import { prisma } from "@calcom/prisma";
import type { CalendarEvent, CalEventResponses } from "@calcom/types/Calendar";
import type { CredentialPayload } from "@calcom/types/Credential";
import type { CRM, Contact, CrmEvent } from "@calcom/types/CrmService";
import type { ParseRefreshTokenResponse } from "../../_utils/oauth/parseRefreshTokenResponse";
import parseRefreshTokenResponse from "../../_utils/oauth/parseRefreshTokenResponse";
import { default as appMeta } from "../config.json";
import type { writeToRecordDataSchema } from "../zod";
import {
SalesforceRecordEnum,
SalesforceFieldType,
WhenToWriteToRecord,
DateFieldTypeData,
RoutingReasons,
} from "./enums";
import { getSalesforceAppKeys } from "./getSalesforceAppKeys";
type ExtendedTokenResponse = TokenResponse & {
instance_url: string;
};
type ContactSearchResult = {
attributes: {
type: string;
url: string;
};
Id: string;
Email: string;
};
const sfApiErrors = {
INVALID_EVENTWHOIDS: "INVALID_FIELD: No such column 'EventWhoIds' on sobject of type Event",
};
type ContactRecord = {
Id?: string;
Email?: string;
OwnerId?: string;
[key: string]: any;
};
type Attendee = { email: string; name: string };
const salesforceTokenSchema = z.object({
id: z.string(),
issued_at: z.string(),
instance_url: z.string(),
signature: z.string(),
access_token: z.string(),
scope: z.string(),
token_type: z.string(),
});
export default class SalesforceCRMService implements CRM {
private integrationName = "";
private conn!: Promise<Connection>;
private log: typeof logger;
private calWarnings: string[] = [];
private appOptions: any;
private doNotCreateEvent = false;
private fallbackToContact = false;
constructor(credential: CredentialPayload, appOptions: any, testMode = false) {
this.integrationName = "salesforce_other_calendar";
if (!testMode) {
this.conn = this.getClient(credential).then((c) => c);
}
this.log = logger.getSubLogger({ prefix: [`[[lib] ${this.integrationName}`] });
this.appOptions = appOptions;
}
public getAppOptions() {
return this.appOptions;
}
private getClient = async (credential: CredentialPayload) => {
const { consumer_key, consumer_secret } = await getSalesforceAppKeys();
const credentialKey = credential.key as unknown as ExtendedTokenResponse;
if (!credentialKey.refresh_token)
throw new Error(`Refresh token is missing for credential ${credential.id}`);
try {
/* XXX: This code results in 'Bad Request', which indicates something is wrong with our salesforce integration.
Needs further investigation ASAP */
const response = await fetch("https://login.salesforce.com/services/oauth2/token", {
method: "POST",
headers: {
"Content-Type": "application/x-www-form-urlencoded",
},
body: new URLSearchParams({
grant_type: "refresh_token",
client_id: consumer_key,
client_secret: consumer_secret,
refresh_token: credentialKey.refresh_token,
}),
});
if (!response.ok) {
const message = `${response.statusText}: ${JSON.stringify(await response.json())}`;
throw new Error(message);
}
const accessTokenJson = await response.json();
const accessTokenParsed: ParseRefreshTokenResponse<typeof salesforceTokenSchema> =
parseRefreshTokenResponse(accessTokenJson, salesforceTokenSchema);
await prisma.credential.update({
where: { id: credential.id },
data: { key: { ...accessTokenParsed, refresh_token: credentialKey.refresh_token } },
});
} catch (err: unknown) {
console.error(err); // log but proceed
}
return new jsforce.Connection({
oauth2: {
clientId: consumer_key,
clientSecret: consumer_secret,
redirectUri: `${WEBAPP_URL}/api/integrations/salesforce/callback`,
},
instanceUrl: credentialKey.instance_url,
accessToken: credentialKey.access_token,
refreshToken: credentialKey.refresh_token,
});
};
private getSalesforceUserIdFromEmail = async (email: string) => {
const conn = await this.conn;
const query = await conn.query(
`SELECT Id, Email FROM User WHERE Email = '${email}' AND IsActive = true LIMIT 1`
);
if (query.records.length > 0) {
return (query.records[0] as { Email: string; Id: string }).Id;
}
};
private getSalesforceUserFromUserId = async (userId: string) => {
const conn = await this.conn;
return await conn.query(`SELECT Id, Email, Name FROM User WHERE Id = '${userId}' AND IsActive = true`);
};
private getSalesforceEventBody = (event: CalendarEvent): string => {
return `${event.organizer.language.translate("invitee_timezone")}: ${
event.attendees[0].timeZone
} \r\n\r\n ${event.organizer.language.translate("share_additional_notes")}\r\n${
event.additionalNotes || "-"
}`;
};
private salesforceCreateEventApiCall = async (
event: CalendarEvent,
options: { [key: string]: unknown }
) => {
const conn = await this.conn;
return await conn.sobject("Event").create({
StartDateTime: new Date(event.startTime).toISOString(),
EndDateTime: new Date(event.endTime).toISOString(),
Subject: event.title,
Description: this.getSalesforceEventBody(event),
Location: getLocation(event),
...options,
...(event.recurringEvent && {
IsRecurrence2: true,
Recurrence2PatternText: new RRule(event.recurringEvent).toString(),
}),
});
};
private salesforceCreateEvent = async (event: CalendarEvent, contacts: Contact[]) => {
const log = logger.getSubLogger({ prefix: [`[salesforceCreateEvent]:${event.uid}`] });
const appOptions = this.getAppOptions();
const writeToEventRecord = await this.generateWriteToEventBody(event);
log.info(`Writing to event fields: ${Object.keys(writeToEventRecord)} `);
let ownerId: string | undefined = undefined;
if (event?.organizer?.email) {
ownerId = await this.getSalesforceUserIdFromEmail(event.organizer.email);
} else {
log.warn("No organizer email found for event", event?.organizer);
}
log.info(`Organizer found with Salesforce id ${ownerId}`);
/**
* Current code assume that contacts is not empty.
**/
const [firstContact] = contacts;
if (!firstContact?.id) {
log.error("No contacts found for event", { contacts });
throw new Error("No contacts found for event");
}
const eventWhoIds = contacts.reduce((contactIds, contact) => {
if (contact?.id) {
contactIds.push(contact.id);
}
return contactIds;
}, [] as string[]);
if (eventWhoIds.length !== contacts.length) {
log.warn(`Not all contacts contain ids ${contacts}`);
}
const createdEvent = await this.salesforceCreateEventApiCall(event, {
EventWhoIds: eventWhoIds,
...writeToEventRecord,
...(ownerId && { OwnerId: ownerId }),
}).catch(async (reason) => {
if (reason === sfApiErrors.INVALID_EVENTWHOIDS) {
this.calWarnings.push(
`Please enable option "Allow Users to Relate Multiple Contacts to Tasks and Events" under
"Setup > Feature Settings > Sales > Activity Settings" to be able to create events with
multiple contact attendees.`
);
// User has not configured "Allow Users to Relate Multiple Contacts to Tasks and Events"
// proceeding to create the event using just the first attendee as the primary WhoId
return await this.salesforceCreateEventApiCall(event, {
WhoId: firstContact.id,
}).catch((reason) => Promise.reject(reason));
}
log.error(`Error creating event: ${JSON.stringify(reason)}`);
// Try creating a simple object without additional records
return await this.salesforceCreateEventApiCall(event, {
WhoId: firstContact.id,
...(ownerId && { OwnerId: ownerId }),
}).catch((reason) => {
log.error(`Error creating simple event: ${JSON.stringify(reason)}`);
return Promise.reject(reason);
});
});
// Check to see if we also need to change the record owner
if (appOptions.onBookingChangeRecordOwner && appOptions.onBookingChangeRecordOwnerName) {
if (ownerId) {
// TODO: firstContact id is assumed to not be undefined. But current code doesn't check for it.
await this.checkRecordOwnerNameFromRecordId(firstContact.id, ownerId);
} else {
log.warn(
`Could not find owner with email ${event.organizer.email} to change record ${firstContact.id} ownership to`
);
}
}
if (appOptions.onBookingWriteToRecord && appOptions.onBookingWriteToRecordFields) {
await this.writeToPersonRecord(
// TODO: firstContact id is assumed to not be undefined. But current code doesn't check for it.
firstContact.id,
event.startTime,
event.organizer?.email,
event.responses,
event?.uid
);
}
return createdEvent;
};
private salesforceUpdateEvent = async (uid: string, event: CalendarEvent) => {
const conn = await this.conn;
return await conn.sobject("Event").update({
Id: uid,
StartDateTime: new Date(event.startTime).toISOString(),
EndDateTime: new Date(event.endTime).toISOString(),
Subject: event.title,
Description: this.getSalesforceEventBody(event),
Location: getLocation(event),
...(event.recurringEvent && {
IsRecurrence2: true,
Recurrence2PatternText: new RRule(event.recurringEvent).toString(),
}),
});
};
private salesforceDeleteEvent = async (uid: string) => {
const conn = await this.conn;
return await conn.sobject("Event").delete(uid);
};
async handleEventCreation(event: CalendarEvent, contacts: Contact[]) {
const sfEvent = await this.salesforceCreateEvent(event, contacts);
if (sfEvent.success) {
this.log.info("event:creation:ok", { sfEvent });
return {
uid: sfEvent.id,
id: sfEvent.id,
type: "salesforce_other_calendar",
password: "",
url: "",
additionalInfo: { contacts, sfEvent, calWarnings: this.calWarnings },
};
}
this.log.info("event:creation:notOk", { event, sfEvent, contacts });
return Promise.reject({
calError: "Something went wrong when creating an event in Salesforce",
});
}
async createEvent(event: CalendarEvent, contacts: Contact[]): Promise<CrmEvent | undefined> {
const skipEventCreation = this.getDoNotCreateEvent();
if (skipEventCreation) return undefined;
const sfEvent = await this.salesforceCreateEvent(event, contacts);
if (sfEvent.success) {
return {
uid: sfEvent.id,
id: sfEvent.id,
type: "salesforce_other_calendar",
password: "",
url: "",
additionalInfo: { contacts, sfEvent, calWarnings: this.calWarnings },
};
}
this.log.debug("event:creation:notOk", { event, sfEvent, contacts });
return Promise.reject("Something went wrong when creating an event in Salesforce");
}
async updateEvent(uid: string, event: CalendarEvent): Promise<CrmEvent> {
const updatedEvent = await this.salesforceUpdateEvent(uid, event);
if (updatedEvent.success) {
return {
uid: updatedEvent.id,
id: updatedEvent.id,
type: "salesforce_other_calendar",
password: "",
url: "",
additionalInfo: { calWarnings: this.calWarnings },
};
} else {
return Promise.reject({ calError: "Something went wrong when updating the event in Salesforce" });
}
}
public async deleteEvent(uid: string) {
const deletedEvent = await this.salesforceDeleteEvent(uid);
if (deletedEvent.success) {
Promise.resolve();
} else {
Promise.reject({ calError: "Something went wrong when deleting the event in Salesforce" });
}
}
async getContacts({
emails,
includeOwner,
forRoundRobinSkip,
}: {
emails: string | string[];
includeOwner?: boolean;
forRoundRobinSkip?: boolean;
}) {
const log = logger.getSubLogger({ prefix: [`[getContacts]:${emails}`] });
try {
const conn = await this.conn;
const emailArray = Array.isArray(emails) ? emails : [emails];
const appOptions = this.getAppOptions();
const recordToSearch =
(forRoundRobinSkip ? appOptions?.roundRobinSkipCheckRecordOn : appOptions?.createEventOn) ??
SalesforceRecordEnum.CONTACT;
let soql: string;
log.info(
"Getting contacts for emails",
safeStringify({
emailArray,
includeOwner,
forRoundRobinSkip,
recordToSearch,
appOptions,
})
);
// Handle Account record type
if (recordToSearch === SalesforceRecordEnum.ACCOUNT) {
// For an account let's assume that the first email is the one we should be querying against
const attendeeEmail = emailArray[0];
log.info("Searching account for email", safeStringify({ attendeeEmail }));
soql = `SELECT Id, Email, OwnerId, AccountId, Account.Owner.Email, Account.Website FROM ${SalesforceRecordEnum.CONTACT} WHERE Email = '${attendeeEmail}' AND AccountId != null`;
} else {
// Handle Contact/Lead record types
soql = `SELECT Id, Email, OwnerId, Owner.Email FROM ${recordToSearch} WHERE Email IN ('${emailArray.join(
"','"
)}')`;
}
const results = await conn.query(soql);
log.info("Query results", safeStringify({ recordCount: results.records?.length }));
let records: ContactRecord[] = [];
// If falling back to contacts, check for the contact before returning the leads or empty array
if (
appOptions.createEventOn === SalesforceRecordEnum.LEAD &&
appOptions.createEventOnLeadCheckForContact &&
!forRoundRobinSkip
) {
// Get any matching contacts
const contactSearch = await conn.query(
`SELECT Id, Email, OwnerId, Owner.Email FROM ${
SalesforceRecordEnum.CONTACT
} WHERE Email IN ('${emailArray.join("','")}')`
);
if (contactSearch?.records?.length > 0) {
records = contactSearch.records as ContactRecord[];
this.setFallbackToContact(true);
log.info(
"Found matching contacts, falling back to contact",
safeStringify({
contactCount: records.length,
})
);
}
}
if (!records.length && results?.records?.length) {
records = results.records as ContactRecord[];
}
if (recordToSearch === SalesforceRecordEnum.ACCOUNT && forRoundRobinSkip && !results.records.length) {
const attendeeEmail = emailArray[0];
// If we can't find the exact contact, then we need to search for an account where the contacts share the same email domain
const account = await this.getAccountBasedOnEmailDomainOfContacts(attendeeEmail);
if (account) {
records = [account];
}
}
if (!records.length) {
log.info("No records found");
return [];
}
const includeOwnerData =
(includeOwner || forRoundRobinSkip) &&
!(await this.shouldSkipAttendeeIfFreeEmailDomain(emailArray[0]));
const includeAccountRecordType = forRoundRobinSkip && recordToSearch === SalesforceRecordEnum.ACCOUNT;
return records.map((record) => {
return {
id: includeAccountRecordType ? record?.AccountId : record?.Id || "",
email: record?.Email || "",
recordType: includeAccountRecordType ? SalesforceRecordEnum.ACCOUNT : record?.attributes?.type,
...(includeOwnerData && {
ownerId: record?.OwnerId,
// Handle if Account is nested
ownerEmail:
recordToSearch === SalesforceRecordEnum.ACCOUNT &&
record?.attributes?.type !== SalesforceRecordEnum.ACCOUNT
? record?.Account?.Owner?.Email
: record?.Owner?.Email,
}),
};
});
} catch (error) {
log.error("Error in getContacts", safeStringify({ error }));
return [];
}
}
async createContacts(
contactsToCreate: Attendee[],
organizerEmail?: string,
calEventResponses?: CalEventResponses | null
) {
const log = logger.getSubLogger({ prefix: [`[getContacts]`] });
const conn = await this.conn;
const appOptions = this.getAppOptions();
const createEventOn = appOptions.createEventOn ?? SalesforceRecordEnum.CONTACT;
// See if the organizer exists in the CRM
const organizerId = organizerEmail ? await this.getSalesforceUserIdFromEmail(organizerEmail) : undefined;
const createdContacts: { id: string; email: string }[] = [];
log.info("createContacts", safeStringify({ createEventOn, organizerId, contactsToCreate }));
if (createEventOn === SalesforceRecordEnum.CONTACT) {
await Promise.all(
contactsToCreate.map(async (attendee) => {
return await this.createAttendeeRecord({
attendee,
recordType: SalesforceRecordEnum.CONTACT,
organizerId,
}).then((result) => {
createdContacts.push(...result);
});
})
);
}
if (!contactsToCreate[0]?.email) {
this.log.warn(`createContact: no attendee email found `, contactsToCreate);
return [];
}
if (createEventOn === SalesforceRecordEnum.LEAD) {
// Base this off of the first contact
const attendee = contactsToCreate[0];
if (appOptions.createNewContactUnderAccount) {
// Check for an account
const accountId = await this.getAccountIdBasedOnEmailDomainOfContacts(attendee.email);
if (accountId) {
const createdAccountContacts = await this.createNewContactUnderAnAccount({
attendee,
accountId,
organizerId,
});
if (createdAccountContacts.length > 0) {
createdContacts.push(...createdAccountContacts);
}
} else {
log.info(
"createEventOn=LEAD, No account found for attendee, not creating a contact",
safeStringify({ attendeeEmail: attendee.email })
);
}
} else {
await this.createAttendeeRecord({
attendee,
recordType: SalesforceRecordEnum.LEAD,
organizerId,
calEventResponses,
}).then((result) => {
createdContacts.push(...result);
});
}
}
if (createEventOn === SalesforceRecordEnum.ACCOUNT) {
if (!appOptions.createNewContactUnderAccount && !appOptions.createLeadIfAccountNull) {
this.setDoNotCreateEvent(true);
return [{ id: "Do not create event", email: "placeholder" }];
}
// Base this off of the first contact
const attendee = contactsToCreate[0];
const accountId = await this.getAccountIdBasedOnEmailDomainOfContacts(attendee.email);
let contactCreated = false;
if (accountId && appOptions.createNewContactUnderAccount) {
const createdAccountContacts = await this.createNewContactUnderAnAccount({
attendee,
accountId,
organizerId,
});
if (createdAccountContacts.length > 0) {
createdContacts.push(...createdAccountContacts);
contactCreated = true;
}
}
if (!accountId && appOptions.createLeadIfAccountNull && !contactCreated) {
// Check to see if the lead exists already
const leadQuery = await conn.query(
`SELECT Id, Email FROM Lead WHERE Email = '${attendee.email}' LIMIT 1`
);
if (leadQuery.records.length > 0) {
const contact = leadQuery.records[0] as { Id: string; Email: string };
return [{ id: contact.Id, email: contact.Email }];
}
for (const attendee of contactsToCreate) {
try {
const createBody = await this.generateCreateRecordBody({
attendee,
recordType: SalesforceRecordEnum.LEAD,
organizerId,
calEventResponses,
});
const result = await conn.sobject(SalesforceRecordEnum.LEAD).create(createBody);
if (result.success) {
createdContacts.push({ id: result.id, email: attendee.email });
}
} catch (error: any) {
if (error.name === "DUPLICATES_DETECTED") {
const existingId = this.getExistingIdFromDuplicateError(error);
if (existingId) {
console.log("Using existing record:", existingId);
createdContacts.push({ id: existingId, email: attendee.email });
}
} else {
console.error("Error creating lead:", error);
}
}
}
}
}
return createdContacts;
}
async handleAttendeeNoShow(bookingUid: string, attendees: { email: string; noShow: boolean }[]) {
const appOptions = this.getAppOptions();
const { sendNoShowAttendeeData = false, sendNoShowAttendeeDataField = {} } = appOptions;
const conn = await this.conn;
// Check that no show is enabled
if (!sendNoShowAttendeeData && !sendNoShowAttendeeDataField) {
this.log.warn(`No show settings not set for bookingUid ${bookingUid}`);
return;
}
// Get all Salesforce events associated with the booking
const salesforceEvents = await prisma.bookingReference.findMany({
where: {
type: appMeta.type,
booking: {
uid: bookingUid,
},
},
});
const salesforceEntity = await conn.describe("Event");
const fields = salesforceEntity.fields;
const noShowField = fields.find((field) => field.name === sendNoShowAttendeeDataField);
if (!noShowField || (noShowField.type as unknown as string) !== "boolean") {
this.log.warn(
`No show field on Salesforce doesn't exist or is not of type boolean for bookingUid ${bookingUid}`
);
return;
}
for (const event of salesforceEvents) {
const salesforceEvent = (await conn.query(`SELECT WhoId FROM Event WHERE Id = '${event.uid}'`)) as {
records: { WhoId: string }[];
};
let salesforceAttendeeEmail: string | undefined = undefined;
// Figure out if the attendee is a contact or lead
const contactQuery = (await conn.query(
`SELECT Email FROM Contact WHERE Id = '${salesforceEvent.records[0].WhoId}'`
)) as { records: { Email: string }[] };
const leadQuery = (await conn.query(
`SELECT Email FROM Lead WHERE Id = '${salesforceEvent.records[0].WhoId}'`
)) as { records: { Email: string }[] };
// Prioritize contacts over leads
if (contactQuery.records.length > 0) {
salesforceAttendeeEmail = contactQuery.records[0].Email;
} else if (leadQuery.records.length > 0) {
salesforceAttendeeEmail = leadQuery.records[0].Email;
} else {
this.log.warn(
`Could not find attendee for bookingUid ${bookingUid} and salesforce event id ${event.uid}`
);
}
if (salesforceAttendeeEmail) {
// Find the attendee no show data
const noShowData = attendees.find((attendee) => attendee.email === salesforceAttendeeEmail);
if (!noShowData) {
this.log.warn(
`No show data could not be found for ${salesforceAttendeeEmail} and bookingUid ${bookingUid}`
);
} else {
// Update the event with the no show data
await conn.sobject("Event").update({
Id: event.uid,
[sendNoShowAttendeeDataField]: noShowData.noShow,
});
}
}
}
}
private getExistingIdFromDuplicateError(error: any): string | null {
if (error.duplicateResult && error.duplicateResult.matchResults) {
for (const matchResult of error.duplicateResult.matchResults) {
if (matchResult.matchRecords && matchResult.matchRecords.length > 0) {
return matchResult.matchRecords[0].record.Id;
}
}
}
return null;
}
private setDoNotCreateEvent(boolean: boolean) {
this.doNotCreateEvent = boolean;
}
private getDoNotCreateEvent() {
return this.doNotCreateEvent;
}
private getDominantAccountId(contacts: { AccountId: string }[]) {
const log = logger.getSubLogger({ prefix: [`[getDominantAccountId]:${contacts}`] });
// To get the dominant AccountId we only need to iterate through half the array
const iterateLength = Math.ceil(contacts.length / 2);
// Store AccountId frequencies
const accountIdCounts: { [accountId: string]: number } = {};
for (const contact of contacts) {
const accountId = contact.AccountId;
accountIdCounts[accountId] = (accountIdCounts[accountId] || 0) + 1;
// If the number of AccountIds makes up 50% of the array length then return early
if (accountIdCounts[accountId] > iterateLength) return accountId;
}
// Else figure out which AccountId occurs the most
let dominantAccountId;
let highestCount = 0;
for (const accountId in accountIdCounts) {
if (accountIdCounts[accountId] > highestCount) {
highestCount = accountIdCounts[accountId];
dominantAccountId = accountId;
}
}
log.info("Dominant AccountId", safeStringify({ dominantAccountId }));
return dominantAccountId;
}
private async createAttendeeRecord({
attendee,
recordType,
organizerId,
accountId,
calEventResponses,
}: {
attendee: Attendee;
recordType: SalesforceRecordEnum;
organizerId?: string;
accountId?: string;
calEventResponses?: CalEventResponses | null;
}) {
const log = logger.getSubLogger({ prefix: [`[createAttendeeRecord]:${attendee.email}`] });
log.info("createAttendeeRecord", safeStringify({ attendee, recordType, organizerId, accountId }));
const conn = await this.conn;
const createBody = await this.generateCreateRecordBody({
attendee,
recordType: recordType,
organizerId,
calEventResponses,
});
return await conn
.sobject(recordType)
.create({
...createBody,
AccountId: accountId,
})
.then((result) => {
if (result.success) {
return [{ id: result.id, email: attendee.email }];
} else {
return [];
}
})
.catch((error) => {
this.log.error(`Error creating Salesforce contact for ${attendee.email} with error ${error}`);
return [];
});
}
private async generateCreateRecordBody({
attendee,
recordType,
organizerId,
calEventResponses,
}: {
attendee: { email: string; name: string };
recordType: SalesforceRecordEnum;
organizerId?: string;
/**Only Leads have the default company field */
calEventResponses?: CalEventResponses | null;
}) {
const [FirstName, LastName] = attendee.name ? attendee.name.split(" ") : [attendee.email, ""];
// Assume that the first part of the email domain is the company title
const company =
(await this.getCompanyNameFromBookingResponse(calEventResponses)) ??
attendee.email.split("@")[1].split(".")[0];
return {
LastName: LastName || "-",
FirstName,
Email: attendee.email,
...(organizerId && { OwnerId: organizerId }),
...(recordType === SalesforceRecordEnum.LEAD && { Company: company }),
};
}
private async ensureFieldsExistOnObject(fieldsToTest: string[], sobject: string) {
const conn = await this.conn;
const fieldSet = new Set(fieldsToTest);
const foundFields: Field[] = [];
try {
const salesforceEntity = await conn.describe(sobject);
const fields = salesforceEntity.fields;
for (const field of fields) {
if (foundFields.length === fieldSet.size) break;
if (fieldSet.has(field.name)) {
foundFields.push(field);
}
}
return foundFields;
} catch (e) {
console.error(e);
return [];
}
}
private async checkRecordOwnerNameFromRecordId(id: string, newOwnerId: string) {
const conn = await this.conn;
const appOptions = this.getAppOptions();
this.log.info(`Changing owner for record ${id}`);
const recordType = this.determineRecordTypeById(id);
if (!appOptions?.onBookingChangeRecordOwnerName) {
this.log.warn(
`No appOptions.onBookingChangeRecordOwnerName found for ${this.integrationName} on checkRecordOwnerNameFromRecordId`
);
return;
}
// Get the associated record that the event was created on
const recordQuery = (await conn.query(
`SELECT OwnerId, Owner.Name FROM ${recordType} WHERE Id = '${id}'`
)) as { records: { OwnerId: string; Owner: { Name: string } }[] };
if (!recordQuery || !recordQuery.records.length) {
this.log.warn(`Could not find record for id ${id} and type ${recordType}`);
}
const owner = recordQuery.records[0].Owner;
if (!appOptions.onBookingChangeRecordOwnerName.includes(owner?.Name)) {
this.log.warn(
`Current owner name ${owner?.Name} for record ${id} does not match the option ${appOptions.onBookingChangeRecordOwnerName}`
);
}
await conn
.sobject(recordType)
.update({
// First field is there WHERE statement
Id: id,
OwnerId: newOwnerId,
})
.catch((error) => {
this.log.warn(
`Error changing record ${id} of type ${recordType} owner to ${newOwnerId} with error ${JSON.stringify(
error
)}`
);
});
}
private async getAccountIdBasedOnEmailDomainOfContacts(email: string) {
const conn = await this.conn;
const emailDomain = email.split("@")[1];
const log = logger.getSubLogger({ prefix: [`[getAccountIdBasedOnEmailDomainOfContacts]:${email}`] });
log.info("getAccountIdBasedOnEmailDomainOfContacts", safeStringify({ email, emailDomain }));
// First check if an account has the same website as the email domain of the attendee
const accountQuery = await conn.query(
`SELECT Id, Website FROM Account WHERE Website LIKE '%${emailDomain}%' LIMIT 1`
);
if (accountQuery.records.length > 0) {
const account = accountQuery.records[0] as { Id: string };
return account.Id;
}
// Fallback to querying which account the majority of contacts are under
const response = await conn.query(
`SELECT Id, Email, AccountId FROM Contact WHERE Email LIKE '%@${emailDomain}' AND AccountId != null`
);
return this.getDominantAccountId(response.records as { AccountId: string }[]);
}
private async getAccountBasedOnEmailDomainOfContacts(email: string) {
const conn = await this.conn;
const emailDomain = email.split("@")[1];
// First check if an account has the same website as the email domain of the attendee
const accountQuery = await conn.query(
`SELECT Id, OwnerId, Owner.Email FROM Account WHERE Website LIKE '%${emailDomain}%' LIMIT 1`
);
if (accountQuery.records.length > 0) {
return {
...(accountQuery.records[0] as { Id?: string; OwnerId?: string; Owner?: { Email?: string } }),
Email: undefined,
};
}
// Fallback to querying which account the majority of contacts are under
const contactQuery = await conn.query(
`SELECT Id, Email, AccountId, Account.OwnerId, Account.Owner.Email FROM Contact WHERE Email LIKE '%@${emailDomain}' AND AccountId != null`
);
const contacts = contactQuery?.records as {
AccountId: string;
Account: { OwnerId?: string; Owner: { Email: string } };
}[];
if (!contacts) return;
const dominantAccountId = this.getDominantAccountId(contacts);
const contactUnderAccount = contacts.find((contact) => contact.AccountId === dominantAccountId);
return {
Id: dominantAccountId,
Email: undefined,
OwnerId: contactUnderAccount?.Account?.OwnerId,
Owner: {
Email: contactUnderAccount?.Account?.Owner?.Email,
},
attributes: {
type: SalesforceRecordEnum.ACCOUNT,
},
};
}
private setFallbackToContact(boolean: boolean) {
this.fallbackToContact = boolean;
}
private getFallbackToContact() {
return this.fallbackToContact;
}
private async writeToPersonRecord(
contactId: string,
startTime: string,
organizerEmail?: string,
calEventResponses?: CalEventResponses | null,
bookingUid?: string | null
) {
const conn = await this.conn;
const { onBookingWriteToRecordFields = {} } = this.getAppOptions();
// Determine record type (Contact or Lead)
const personRecordType = this.determineRecordTypeById(contactId);
// 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);
if (!existingFields.length) {
this.log.warn(`No fields found for record type ${personRecordType}`);
return;
}
const personRecord = await this.fetchPersonRecord(contactId, existingFields, personRecordType);
if (!personRecord) {
this.log.warn(`No personRecord found for contactId ${contactId}`);
return;
}
this.log.info(`Writing to recordId ${contactId} on fields ${fieldsToWriteOn}`);
const writeOnRecordBody = await this.buildRecordUpdatePayload({
existingFields,
personRecord,
onBookingWriteToRecordFields,
startTime,
bookingUid,
organizerEmail,
calEventResponses,
});
this.log.info(
`Final writeOnRecordBody contains fields ${Object.keys(writeOnRecordBody)} for record ${contactId}`
);
// Update the person record
await conn
.sobject(personRecordType)
.update({
Id: contactId,
...writeOnRecordBody,
})
.catch((e) => {
this.log.error(`Error updating person record for contactId ${contactId}`, e);
});
}
private async buildRecordUpdatePayload({
existingFields,
personRecord,
onBookingWriteToRecordFields,
startTime,
bookingUid,
organizerEmail,
calEventResponses,
}: {
existingFields: Field[];
personRecord: Record<string, any>;
onBookingWriteToRecordFields: Record<string, any>;
startTime?: string;
bookingUid?: string | null;
organizerEmail?: string;
calEventResponses?: CalEventResponses | null;
}): Promise<Record<string, any>> {
const writeOnRecordBody: Record<string, any> = {};
for (const field of existingFields) {
const fieldConfig = onBookingWriteToRecordFields[field.name];
// Skip if field should only be written when empty and already has a value
if (fieldConfig.whenToWrite === WhenToWriteToRecord.FIELD_EMPTY && personRecord[field.name]) {
this.log.info(
`Field ${field.name} on contactId ${personRecord?.Id} already exists with value ${
personRecord[field.name]
}`
);
continue;
}
if (fieldConfig.fieldType === SalesforceFieldType.CUSTOM) {
const extractedValue = await this.getTextFieldValue({
fieldValue: fieldConfig.value,
fieldLength: field.length,
calEventResponses,
bookingUid,
});
if (extractedValue) {
writeOnRecordBody[field.name] = extractedValue;
continue;
}
}
// Handle different field types
if (fieldConfig.fieldType === field.type) {
if (field.type === SalesforceFieldType.TEXT || field.type === SalesforceFieldType.PHONE) {
const extractedText = await this.getTextFieldValue({
fieldValue: fieldConfig.value,
fieldLength: field.length,
calEventResponses,
bookingUid,
});
if (extractedText) {
writeOnRecordBody[field.name] = extractedText;
}
} else if (field.type === SalesforceFieldType.DATE && startTime && organizerEmail) {
const dateValue = await this.getDateFieldValue(
fieldConfig.value,
startTime,
bookingUid,
organizerEmail
);
if (dateValue) {
writeOnRecordBody[field.name] = dateValue;
}
}
}
}
return writeOnRecordBody;
}
private async generateWriteToEventBody(event: CalendarEvent) {
const appOptions = this.getAppOptions();
const customFieldInputsEnabled =
appOptions?.onBookingWriteToEventObject && appOptions?.onBookingWriteToEventObjectMap;
if (!customFieldInputsEnabled) return {};
const customFieldInputs = customFieldInputsEnabled
? await this.ensureFieldsExistOnObject(Object.keys(appOptions?.onBookingWriteToEventObjectMap), "Event")
: [];
const confirmedCustomFieldInputs: {
[key: string]: any;
} = {};
for (const field of customFieldInputs) {
confirmedCustomFieldInputs[field.name] = await this.getTextFieldValue({
fieldValue: appOptions.onBookingWriteToEventObjectMap[field.name],
fieldLength: field.length,
calEventResponses: event.responses,
bookingUid: event?.uid,
});
}
return confirmedCustomFieldInputs;
}
private async getTextFieldValue({
fieldValue,
fieldLength,
calEventResponses,
bookingUid,
}: {
fieldValue: string;
fieldLength?: number;
calEventResponses?: CalEventResponses | null;
bookingUid?: string | null;
}) {
// If no {} then indicates we're passing a static value
if (!fieldValue.startsWith("{") && !fieldValue.endsWith("}")) return fieldValue;
let valueToWrite = fieldValue;
if (fieldValue.startsWith("{form:")) {
// Get routing from response
if (!bookingUid) return;
valueToWrite = await this.getTextValueFromRoutingFormResponse(fieldValue, bookingUid);
} else {
// Get the value from the booking response
if (!calEventResponses) return;
valueToWrite = this.getTextValueFromBookingResponse(fieldValue, calEventResponses);
}
// If a value wasn't found in the responses. Don't return the field name
if (valueToWrite === fieldValue) return;
// Trim incase the replacement values increased the length
return fieldLength ? valueToWrite.substring(0, fieldLength) : valueToWrite;
}
private async getTextValueFromRoutingFormResponse(fieldValue: string, bookingUid: string) {
// Get the form response
const routingFormResponse = await prisma.app_RoutingForms_FormResponse.findFirst({
where: {
routedToBookingUid: bookingUid,
},
select: {
response: true,
},
});
if (!routingFormResponse) return fieldValue;
const response = routingFormResponse.response as FormResponse;
const regex = /\{form:(.*?)\}/;
const regexMatch = fieldValue.match(regex);
if (!regexMatch) return fieldValue;
const identifierField = regexMatch?.[1];
if (!identifierField) return fieldValue;
// Search for fieldValue, only handle raw text return for now
for (const fieldId of Object.keys(response)) {
const field = response[fieldId];
if (field?.identifier === identifierField) {
return field.value.toString();
}
}
return fieldValue;
}
private getTextValueFromBookingResponse(fieldValue: string, calEventResponses: CalEventResponses) {
const regexValueToReplace = /\{(.*?)\}/g;
return fieldValue.replace(regexValueToReplace, (match, captured) => {
return calEventResponses[captured]?.value ? calEventResponses[captured].value.toString() : match;
});
}
private async getDateFieldValue(
fieldValue: string,
startTime: string,
bookingUid?: string | null,
organizerEmail?: string
): Promise<string | null> {
if (fieldValue === DateFieldTypeData.BOOKING_START_DATE) {
return new Date(startTime).toISOString();
}
if (fieldValue === DateFieldTypeData.BOOKING_CREATED_DATE && bookingUid) {
if (!organizerEmail) {
this.log.warn(`No organizer email found for bookingUid ${bookingUid}`);
}
const booking = await prisma.booking.findFirst({
where: { uid: bookingUid },
select: { createdAt: true },
});
if (!booking) {
this.log.warn(`No booking found for ${bookingUid}`);
return null;
}
return new Date(booking.createdAt).toISOString();
}
if (!bookingUid) {
this.log.warn(`No uid for booking with organizer ${organizerEmail}`);
}
return null;
}
private async fetchPersonRecord(
contactId: string,
existingFields: Field[],
personRecordType: SalesforceRecordEnum
): Promise<Record<string, any> | null> {
const conn = await this.conn;
const existingFieldNames = existingFields.map((field) => field.name);
const query = await conn.query(
`SELECT Id, ${existingFieldNames.join(", ")} FROM ${personRecordType} WHERE Id = '${contactId}'`
);
if (!query.records.length) {
this.log.warn(`Could not find person record with id ${contactId}`);
return null;
}
return query.records[0] as Record<string, any>;
}
private async createNewContactUnderAnAccount({
attendee,
accountId,
organizerId,
}: {
attendee: Attendee;
accountId: string;
organizerId?: string;
}) {
const log = logger.getSubLogger({ prefix: [`[createNewContactUnderAnAccount]:${attendee.email}`] });
log.info("createNewContactUnderAnAccount", safeStringify({ attendee, accountId, organizerId }));
const conn = await this.conn;
// First see if the contact already exists and connect it to the account
const userQuery = await conn.query(
`SELECT Id, Email FROM Contact WHERE Email = '${attendee.email}' LIMIT 1`
);
if (userQuery.records.length > 0) {
const contact = userQuery.records[0] as { Id: string; Email: string };
await conn.sobject(SalesforceRecordEnum.CONTACT).update({
// The first argument is the WHERE clause
Id: contact.Id,
AccountId: accountId,
});
return [{ id: contact.Id, email: contact.Email }];
}
return await this.createAttendeeRecord({
attendee,
recordType: SalesforceRecordEnum.CONTACT,
accountId,
organizerId,
});
}
async findUserEmailFromLookupField(
attendeeEmail: string,
fieldName: string,
salesforceObject: SalesforceRecordEnum
) {
const conn = await this.conn;
// Ensure the field exists on the record
const existingFields = await this.ensureFieldsExistOnObject([fieldName], salesforceObject);
if (!existingFields.length) return;
const lookupField = existingFields[0];
if (salesforceObject === SalesforceRecordEnum.ACCOUNT) {
const accountId = await this.getAccountIdBasedOnEmailDomainOfContacts(attendeeEmail);
if (!accountId) return;
const accountQuery = (await conn.query(
`SELECT ${lookupField.name} FROM ${SalesforceRecordEnum.ACCOUNT} WHERE Id = '${accountId}'`
)) as {
records: { [key: string]: any };
};
if (!accountQuery.records.length) return;
const lookupFieldUserId = accountQuery.records[0][lookupField.name];
if (!lookupFieldUserId) return;
const userQuery = await this.getSalesforceUserFromUserId(lookupFieldUserId);
if (!userQuery.records.length) return;
const user = userQuery.records[0] as { Email: string };
return { email: user.Email, recordType: RoutingReasons.ACCOUNT_LOOKUP_FIELD };
}
}
/** Search the booking questions for the Company field value rather than relying on the email domain */
private async getCompanyNameFromBookingResponse(calEventResponses?: CalEventResponses | null) {
const appOptions = this.getAppOptions();
const companyFieldName = "Company";
const defaultTextValueLength = 225;
const { onBookingWriteToRecordFields = undefined } = appOptions;
if (!onBookingWriteToRecordFields || !calEventResponses) return;
// Check that we're writing to the Company field
if (!(companyFieldName in onBookingWriteToRecordFields)) return;
const companyValue = await this.getTextFieldValue({
fieldValue: onBookingWriteToRecordFields[companyFieldName].value,
fieldLength: defaultTextValueLength,
calEventResponses,
});
if (companyValue === onBookingWriteToRecordFields[companyFieldName]) return;
return companyValue;
}
private async shouldSkipAttendeeIfFreeEmailDomain(attendeeEmail: string) {
const appOptions = this.getAppOptions();
if (!appOptions.ifFreeEmailDomainSkipOwnerCheck) return false;
const response = await checkIfFreeEmailDomain(attendeeEmail);
return response;
}
async incompleteBookingWriteToRecord(
email: string,
writeToRecordObject: z.infer<typeof writeToRecordDataSchema>
) {
const conn = await this.conn;
// Prioritize contacts over leads
const personRecord = await this.findProspectByEmail(email);
if (!personRecord) {
this.log.info(`No contact or lead found for email ${email}`);
// No salesforce entity to update, skip and report success (unrecoverable)
return;
}
const recordType = this.determineRecordTypeById(personRecord.Id);
// Ensure the fields exist on the record
const existingFields = await this.ensureFieldsExistOnObject(Object.keys(writeToRecordObject), recordType);
const writeOnRecordBody = await this.buildRecordUpdatePayload({
existingFields,
personRecord,
onBookingWriteToRecordFields: writeToRecordObject,
});
await conn
.sobject(recordType)
.update({
Id: personRecord.Id,
...writeOnRecordBody,
})
.catch((e) => {
const contactId = personRecord?.Id || "unknown";
// catch the error and throw a new one with a more descriptive message
const errorMessage = `Error updating person record for contactId '${contactId}': ${
e instanceof Error ? e.message : String(e)
}`;
throw new Error(errorMessage);
});
}
/** All salesforce ids have a 3 character prefix associated with the record type
* https://help.salesforce.com/s/articleView?id=000385203&type=1
*/
private determineRecordTypeById(id: string) {
switch (id.substring(0, 3)) {
case "003":
return SalesforceRecordEnum.CONTACT;
case "001":
return SalesforceRecordEnum.ACCOUNT;
case "00Q":
return SalesforceRecordEnum.LEAD;
default:
this.log.warn(`Unhandled record id type ${id}`);
return SalesforceRecordEnum.CONTACT;
}
}
/** Prioritizes contacts over leads */
private async findProspectByEmail(email: string) {
const contact = await this.findContactByEmail(email);
if (contact) return contact;
const lead = await this.findLeadByEmail(email);
if (lead) return lead;
return null;
}
private async findContactByEmail(email: string) {
const conn = await this.conn;
const contactsQuery = await conn.query(
`SELECT Id, Email FROM ${SalesforceRecordEnum.CONTACT} WHERE Email = '${email}' LIMIT 1`
);
if (contactsQuery.records.length > 0) {
return contactsQuery.records[0] as { Id: string; Email: string };
}
}
private async findLeadByEmail(email: string) {
const conn = await this.conn;
const leadsQuery = await conn.query(
`SELECT Id, Email FROM ${SalesforceRecordEnum.LEAD} WHERE Email = '${email}' LIMIT 1`
);
if (leadsQuery.records.length > 0) {
return leadsQuery.records[0] as { Id: string; Email: string };
}
}
}