Files
cal.diy/packages/app-store/salesforce/lib/CrmService.test.ts
T
2025-03-27 16:08:09 +00:00

591 lines
17 KiB
TypeScript

import { setupAndTeardown } from "@calcom/web/test/utils/bookingScenario/setupAndTeardown";
import { describe, expect, it, beforeEach, vi } from "vitest";
import type { z } from "zod";
import type { CredentialPayload } from "@calcom/types/Credential";
import type { appDataSchema } from "../zod";
import SalesforceCRMService from "./CrmService";
import { SalesforceRecordEnum } from "./enums";
type AppOptions = z.infer<typeof appDataSchema>;
const contactQueryResponse = {
records: [
{
Id: "001",
Email: "[email protected]",
OwnerId: "owner001",
attributes: { type: "Contact" },
Owner: {
Email: "[email protected]",
},
},
],
};
const contactUnderAccountQueryResponse = {
records: [
{
Id: "001",
Email: "[email protected]",
OwnerId: "owner001",
AccountId: "acc001",
attributes: { type: "Contact" },
Account: {
attributes: { type: "Account" },
Owner: {
Email: "[email protected]",
},
},
},
],
};
const leadQueryResponse = {
records: [
{
Id: "001",
Email: "[email protected]",
OwnerId: "owner001",
attributes: { type: "Lead" },
Owner: {
Email: "[email protected]",
},
},
],
};
const ownerQueryResponse = {
records: [
{
Id: "owner001",
Email: "[email protected]",
Name: "Test Owner",
},
],
};
const accountQueryResponse = {
records: [
{
Id: "acc001",
OwnerId: "owner001",
Email: "[email protected]",
attributes: { type: "Account" },
},
],
};
describe("SalesforceCRMService", () => {
let service: SalesforceCRMService;
let mockConnection: { query: any; sobject: any };
setupAndTeardown();
beforeEach(() => {
mockConnection = {
query: vi.fn(),
sobject: vi.fn(),
};
const mockCredential: CredentialPayload = {
id: 1,
type: "salesforce_crm",
key: {
access_token: "mock_token",
refresh_token: "mock_refresh",
instance_url: "https://mock.salesforce.com",
},
userId: 1,
appId: "salesforce",
teamId: null,
invalid: false,
user: {
email: "[email protected]",
},
};
service = new SalesforceCRMService(mockCredential, {}, true);
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
service.conn = Promise.resolve(mockConnection);
});
const mockAppOptions = (appOptions: AppOptions) => {
const appOptionsSpy = vi.spyOn(service, "getAppOptions");
appOptionsSpy.mockReturnValue(appOptions);
};
describe("getContacts", () => {
it("should return empty array when no records found", async () => {
// Setup mock response
mockConnection.query.mockResolvedValueOnce({ records: [] });
const result = await service.getContacts({ emails: "[email protected]" });
expect(result).toEqual([]);
expect(mockConnection.query).toHaveBeenCalledWith(
"SELECT Id, Email, OwnerId, Owner.Email FROM Contact WHERE Email IN ('[email protected]')"
);
});
it("should handle single email string input", async () => {
// Setup mock response with descriptive name
const contactQueryResponse = {
records: [
{
Id: "001",
Email: "[email protected]",
OwnerId: "owner001",
attributes: { type: "Contact" },
},
],
};
// Setup query spy
const querySpy = vi.spyOn(mockConnection, "query");
querySpy.mockResolvedValueOnce(contactQueryResponse);
const result = await service.getContacts({ emails: "[email protected]" });
expect(result).toEqual([
{
id: "001",
email: "[email protected]",
recordType: "Contact",
},
]);
// Verify the exact query made
expect(querySpy).toHaveBeenCalledWith(
"SELECT Id, Email, OwnerId, Owner.Email FROM Contact WHERE Email IN ('[email protected]')"
);
});
it("should handle array of emails input", async () => {
const contactsQueryResponse = {
records: [
{
Id: "001",
Email: "[email protected]",
OwnerId: "owner001",
attributes: { type: "Contact" },
},
{
Id: "002",
Email: "[email protected]",
OwnerId: "owner002",
attributes: { type: "Contact" },
},
],
};
const querySpy = vi.spyOn(mockConnection, "query");
querySpy.mockResolvedValueOnce(contactsQueryResponse);
const result = await service.getContacts({
emails: ["[email protected]", "[email protected]"],
});
expect(result).toEqual([
{
id: "001",
email: "[email protected]",
recordType: "Contact",
},
{
id: "002",
email: "[email protected]",
recordType: "Contact",
},
]);
expect(querySpy).toHaveBeenCalledWith(
"SELECT Id, Email, OwnerId, Owner.Email FROM Contact WHERE Email IN ('[email protected]','[email protected]')"
);
});
it("should return contacts when includeOwner is true but no owner is found", async () => {
mockAppOptions({
roundRobinSkipCheckRecordOn: SalesforceRecordEnum.CONTACT,
createEventOn: SalesforceRecordEnum.CONTACT,
});
const contactQueryResponse = {
records: [
{
Id: "001",
Email: "[email protected]",
// OwnerId: "owner001",
attributes: { type: "Contact" },
Owner: {
Email: "[email protected]",
},
},
],
};
// Setup query spy with specific responses
const querySpy = vi.spyOn(mockConnection, "query");
querySpy.mockResolvedValueOnce(contactQueryResponse); // Contact query
const result = await service.getContacts({
emails: "[email protected]",
includeOwner: true,
});
expect(result).toEqual([
{
id: "001",
email: "[email protected]",
ownerId: undefined,
ownerEmail: "[email protected]",
recordType: "Contact",
},
]);
expect(querySpy).toHaveBeenNthCalledWith(
1,
"SELECT Id, Email, OwnerId, Owner.Email FROM Contact WHERE Email IN ('[email protected]')"
);
});
describe("no additional params are passed", () => {
it("when createEventOn is contact", async () => {
mockAppOptions({
createEventOn: SalesforceRecordEnum.CONTACT,
});
const querySpy = vi.spyOn(mockConnection, "query");
querySpy.mockResolvedValueOnce(contactQueryResponse);
const result = await service.getContacts({
emails: "[email protected]",
});
expect(result).toEqual([
{
id: "001",
email: "[email protected]",
recordType: "Contact",
},
]);
expect(querySpy).toHaveBeenNthCalledWith(
1,
"SELECT Id, Email, OwnerId, Owner.Email FROM Contact WHERE Email IN ('[email protected]')"
);
});
it("when createEventOn is lead", async () => {
mockAppOptions({
createEventOn: SalesforceRecordEnum.LEAD,
});
const querySpy = vi.spyOn(mockConnection, "query");
querySpy.mockResolvedValueOnce(leadQueryResponse);
const result = await service.getContacts({
emails: "[email protected]",
});
expect(result).toEqual([
{
id: "001",
email: "[email protected]",
recordType: "Lead",
},
]);
expect(querySpy).toHaveBeenNthCalledWith(
1,
"SELECT Id, Email, OwnerId, Owner.Email FROM Lead WHERE Email IN ('[email protected]')"
);
});
it("when createEventOn is contact under an account", async () => {
mockAppOptions({
createEventOn: SalesforceRecordEnum.ACCOUNT,
});
const querySpy = vi.spyOn(mockConnection, "query");
querySpy.mockResolvedValueOnce(contactUnderAccountQueryResponse);
const result = await service.getContacts({
emails: "[email protected]",
});
expect(result).toEqual([
{
id: "001",
email: "[email protected]",
recordType: "Contact",
},
]);
expect(querySpy).toHaveBeenNthCalledWith(
1,
"SELECT Id, Email, OwnerId, AccountId, Account.Owner.Email, Account.Website FROM Contact WHERE Email = '[email protected]' AND AccountId != null"
);
});
});
describe("includeOwner param is passed", () => {
it("when createEventOn is contact", async () => {
mockAppOptions({
createEventOn: SalesforceRecordEnum.CONTACT,
});
// Setup query spy with specific responses
const querySpy = vi.spyOn(mockConnection, "query");
querySpy.mockResolvedValueOnce(contactQueryResponse); // Contact query
const result = await service.getContacts({
emails: "[email protected]",
includeOwner: true,
});
expect(result).toEqual([
{
id: "001",
email: "[email protected]",
ownerId: "owner001",
ownerEmail: "[email protected]",
recordType: "Contact",
},
]);
expect(querySpy).toHaveBeenNthCalledWith(
1,
"SELECT Id, Email, OwnerId, Owner.Email FROM Contact WHERE Email IN ('[email protected]')"
);
});
it("when createEventOn is lead", async () => {
mockAppOptions({
createEventOn: SalesforceRecordEnum.LEAD,
});
// Setup query spy with specific responses
const querySpy = vi.spyOn(mockConnection, "query");
querySpy.mockResolvedValueOnce(leadQueryResponse);
const result = await service.getContacts({
emails: "[email protected]",
includeOwner: true,
});
expect(result).toEqual([
{
id: "001",
email: "[email protected]",
ownerId: "owner001",
ownerEmail: "[email protected]",
recordType: "Lead",
},
]);
expect(querySpy).toHaveBeenNthCalledWith(
1,
"SELECT Id, Email, OwnerId, Owner.Email FROM Lead WHERE Email IN ('[email protected]')"
);
});
it("when createEventOn is contact under an account", async () => {
mockAppOptions({
createEventOn: SalesforceRecordEnum.ACCOUNT,
});
// Setup query spy with specific responses
const querySpy = vi.spyOn(mockConnection, "query");
querySpy.mockResolvedValueOnce(contactUnderAccountQueryResponse);
const result = await service.getContacts({
emails: "[email protected]",
includeOwner: true,
});
expect(result).toEqual([
{
id: "001",
email: "[email protected]",
ownerId: "owner001",
ownerEmail: "[email protected]",
recordType: "Contact",
},
]);
expect(querySpy).toHaveBeenNthCalledWith(
1,
"SELECT Id, Email, OwnerId, AccountId, Account.Owner.Email, Account.Website FROM Contact WHERE Email = '[email protected]' AND AccountId != null"
);
});
});
describe("forRoundRobinSkip param is passed", () => {
it("checking against contacts", async () => {
mockAppOptions({
roundRobinSkipCheckRecordOn: SalesforceRecordEnum.CONTACT,
createEventOn: SalesforceRecordEnum.CONTACT,
});
// Setup query spy with specific responses
const querySpy = vi.spyOn(mockConnection, "query");
querySpy.mockResolvedValueOnce(contactQueryResponse); // Contact query
const result = await service.getContacts({
emails: "[email protected]",
forRoundRobinSkip: true,
});
expect(result).toEqual([
{
id: "001",
email: "[email protected]",
ownerId: "owner001",
ownerEmail: "[email protected]",
recordType: "Contact",
},
]);
expect(querySpy).toHaveBeenNthCalledWith(
1,
"SELECT Id, Email, OwnerId, Owner.Email FROM Contact WHERE Email IN ('[email protected]')"
);
});
it("checking against leads", async () => {
mockAppOptions({
roundRobinSkipCheckRecordOn: SalesforceRecordEnum.LEAD,
});
// Setup query spy with specific responses
const querySpy = vi.spyOn(mockConnection, "query");
querySpy.mockResolvedValueOnce(leadQueryResponse);
const result = await service.getContacts({
emails: "[email protected]",
forRoundRobinSkip: true,
});
expect(result).toEqual([
{
id: "001",
email: "[email protected]",
ownerId: "owner001",
ownerEmail: "[email protected]",
recordType: "Lead",
},
]);
expect(querySpy).toHaveBeenNthCalledWith(
1,
"SELECT Id, Email, OwnerId, Owner.Email FROM Lead WHERE Email IN ('[email protected]')"
);
});
it("checking against contacts under an account", async () => {
mockAppOptions({
roundRobinSkipCheckRecordOn: SalesforceRecordEnum.ACCOUNT,
});
const querySpy = vi.spyOn(mockConnection, "query");
querySpy
.mockResolvedValueOnce(contactUnderAccountQueryResponse)
.mockResolvedValueOnce(accountQueryResponse)
.mockResolvedValueOnce(ownerQueryResponse);
const result = await service.getContacts({
emails: "[email protected]",
forRoundRobinSkip: true,
});
expect(result).toEqual([
{
id: "acc001",
email: "[email protected]",
ownerId: "owner001",
ownerEmail: "[email protected]",
recordType: "Account",
},
]);
expect(querySpy).toHaveBeenNthCalledWith(
1,
"SELECT Id, Email, OwnerId, AccountId, Account.Owner.Email, Account.Website FROM Contact WHERE Email = '[email protected]' AND AccountId != null"
);
});
});
});
describe("createContacts", () => {
describe("createEventOn lead", () => {
describe("createNewContactUnderAccount enabled", () => {
it("when attendee has an account", async () => {
mockAppOptions({
createNewContactUnderAccount: true,
createEventOn: SalesforceRecordEnum.LEAD,
});
const querySpy = vi.spyOn(mockConnection, "query");
querySpy.mockResolvedValueOnce(accountQueryResponse);
querySpy.mockResolvedValueOnce({ records: [] });
mockConnection.sobject.mockReturnValue({
create: vi.fn().mockResolvedValue({
success: true,
id: "newContactId",
name: "New Contact",
email: "[email protected]",
}),
});
const result = await service.createContacts([{ name: "New Contact", email: "[email protected]" }]);
expect(result).toEqual([{ id: "newContactId", email: "[email protected]" }]);
});
it("attendee has no account", async () => {
mockAppOptions({
createNewContactUnderAccount: true,
createEventOn: SalesforceRecordEnum.LEAD,
});
const querySpy = vi.spyOn(mockConnection, "query");
querySpy.mockResolvedValueOnce({ records: [] });
querySpy.mockResolvedValueOnce({ records: [] });
mockConnection.sobject.mockReturnValue({
create: vi.fn().mockResolvedValue({
success: true,
id: "newLeadId",
name: "New Lead",
email: "[email protected]",
}),
});
const result = await service.createContacts([{ name: "New Lead", email: "[email protected]" }]);
expect(result).toEqual([{ id: "newLeadId", email: "[email protected]" }]);
});
});
});
});
describe("getAllPossibleAccountWebsiteFromEmailDomain", () => {
it("should return all possible account websites from email domain", () => {
const result = service.getAllPossibleAccountWebsiteFromEmailDomain("example.com");
expect(result).toEqual(
"'example.com', 'www.example.com', 'http://www.example.com', 'http://example.com', 'https://www.example.com', 'https://example.com'"
);
});
});
describe("getAccountBasedOnEmailDomainOfContacts", () => {
it("should return the account ID based on email domain", async () => {
const querySpy = vi.spyOn(mockConnection, "query");
querySpy.mockResolvedValueOnce(accountQueryResponse);
await service.getAccountBasedOnEmailDomainOfContacts("[email protected]");
expect(querySpy).toHaveBeenNthCalledWith(
1,
`SELECT Id, OwnerId, Owner.Email, Website FROM Account WHERE Website IN (${service.getAllPossibleAccountWebsiteFromEmailDomain(
"example.com"
)}) LIMIT 1`
);
});
});
});