@segment/action-destinations 3.478.0 → 3.479.0

package/dist/destinations/salesforce-marketing-cloud/_tests_/contactDataExtensionV2.test.js

@@ -0,0 +1,650 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const nock_1 = __importDefault(require("nock"));
+const actions_core_1 = require("@segment/actions-core");
+const index_1 = __importDefault(require("../index"));
+const testDestination = (0, actions_core_1.createTestIntegration)(index_1.default);
+const timestamp = '2025-10-13T4:00:00.449Z';
+const settings = {
+    subdomain: 'test123',
+    client_id: 'test123',
+    client_secret: 'test123',
+    account_id: 'test123'
+};
+const dataExtensionId = '1234567890';
+const event = (0, actions_core_1.createTestEvent)({
+    timestamp: timestamp,
+    type: 'identify',
+    userId: 'harryStyles1',
+    traits: {
+        firstName: 'Harry',
+        lastName: 'Styles'
+    }
+});
+const payload = {
+    keys: {
+        contactKey: 'harryStyles1',
+        id: 'HS1'
+    },
+    values: {
+        firstName: 'Harry',
+        lastName: 'Styles'
+    },
+    onMappingSave: {
+        inputs: {},
+        outputs: {
+            id: dataExtensionId
+        }
+    }
+};
+const retlPayload = {
+    keys: {
+        contactKey: 'harryStyles1',
+        id: 'HS1'
+    },
+    values: {
+        firstName: 'Harry',
+        lastName: 'Styles'
+    },
+    retlOnMappingSave: {
+        inputs: {},
+        outputs: {
+            id: dataExtensionId
+        }
+    }
+};
+describe('Salesforce Marketing Cloud', () => {
+    describe('Contact Data Extension V2', () => {
+        beforeEach(() => {
+            nock_1.default.cleanAll();
+        });
+        afterEach(() => {
+            nock_1.default.cleanAll();
+        });
+        describe('perform', () => {
+            it('should send contact data to the data extension endpoint using dataExtensionId', async () => {
+                (0, nock_1.default)(`https://${settings.subdomain}.rest.marketingcloudapis.com`)
+                    .post(`/hub/v1/dataevents/${dataExtensionId}/rowset`, [
+                    {
+                        keys: { contactKey: 'harryStyles1', id: 'HS1' },
+                        values: { firstName: 'Harry', lastName: 'Styles' }
+                    }
+                ])
+                    .reply(200, [
+                    {
+                        message: 'Contact created successfully'
+                    }
+                ]);
+                const responses = await testDestination.testAction('contactDataExtensionV2', {
+                    event,
+                    settings,
+                    mapping: payload
+                });
+                expect(responses.length).toBe(1);
+                expect(responses[0].status).toBe(200);
+                expect(responses[0].data).toEqual([
+                    {
+                        message: 'Contact created successfully'
+                    }
+                ]);
+            });
+            it('should use default contactKey mapping from userId', async () => {
+                (0, nock_1.default)(`https://${settings.subdomain}.rest.marketingcloudapis.com`)
+                    .post(`/hub/v1/dataevents/${dataExtensionId}/rowset`, [
+                    {
+                        keys: { contactKey: 'harryStyles1' },
+                        values: { firstName: 'Harry', lastName: 'Styles' }
+                    }
+                ])
+                    .reply(200, [
+                    {
+                        message: 'Contact created successfully'
+                    }
+                ]);
+                const responses = await testDestination.testAction('contactDataExtensionV2', {
+                    event,
+                    settings,
+                    useDefaultMappings: true,
+                    mapping: {
+                        values: {
+                            firstName: { '@path': '$.traits.firstName' },
+                            lastName: { '@path': '$.traits.lastName' }
+                        },
+                        onMappingSave: {
+                            inputs: {},
+                            outputs: {
+                                id: dataExtensionId
+                            }
+                        }
+                    }
+                });
+                expect(responses.length).toBe(1);
+                expect(responses[0].status).toBe(200);
+            });
+            it('should work with retlOnMappingSave hook outputs', async () => {
+                (0, nock_1.default)(`https://${settings.subdomain}.rest.marketingcloudapis.com`)
+                    .post(`/hub/v1/dataevents/${dataExtensionId}/rowset`)
+                    .reply(200, [
+                    {
+                        message: 'Contact created successfully'
+                    }
+                ]);
+                const responses = await testDestination.testAction('contactDataExtensionV2', {
+                    event,
+                    settings,
+                    mapping: retlPayload
+                });
+                expect(responses.length).toBe(1);
+                expect(responses[0].status).toBe(200);
+            });
+            it('should throw an error if no data extension is connected', async () => {
+                await expect(testDestination.testAction('contactDataExtensionV2', {
+                    event,
+                    settings,
+                    mapping: {
+                        keys: {
+                            contactKey: 'harryStyles1',
+                            id: 'HS1'
+                        },
+                        values: {
+                            firstName: 'Harry',
+                            lastName: 'Styles'
+                        }
+                    }
+                })).rejects.toThrowError('No Data Extension Connected');
+            });
+            it('should handle API error', async () => {
+                (0, nock_1.default)(`https://${settings.subdomain}.rest.marketingcloudapis.com`)
+                    .post(`/hub/v1/dataevents/${dataExtensionId}/rowset`)
+                    .reply(400, {
+                    message: 'Bad Request - Invalid contactKey',
+                    errorcode: 12345
+                });
+                await expect(testDestination.testAction('contactDataExtensionV2', {
+                    event,
+                    settings,
+                    mapping: payload
+                })).rejects.toThrow('Bad Request');
+            });
+            it('should handle 500 server error', async () => {
+                (0, nock_1.default)(`https://${settings.subdomain}.rest.marketingcloudapis.com`)
+                    .post(`/hub/v1/dataevents/${dataExtensionId}/rowset`)
+                    .reply(500, {
+                    message: 'Internal Server Error'
+                });
+                await expect(testDestination.testAction('contactDataExtensionV2', {
+                    event,
+                    settings,
+                    mapping: payload
+                })).rejects.toThrow('Internal Server Error');
+            });
+        });
+        describe('performBatch', () => {
+            it('should send batched contact data to the data extension endpoint', async () => {
+                (0, nock_1.default)(`https://${settings.subdomain}.rest.marketingcloudapis.com`)
+                    .post(`/hub/v1/dataevents/${dataExtensionId}/rowset`)
+                    .reply(200, [{ message: 'Success 1' }, { message: 'Success 2' }, { message: 'Success 3' }]);
+                const events = [
+                    (0, actions_core_1.createTestEvent)({
+                        type: 'identify',
+                        userId: 'user1',
+                        traits: {
+                            keys: { contactKey: 'user1', id: 'U1' },
+                            values: { firstName: 'User', lastName: 'One' }
+                        }
+                    }),
+                    (0, actions_core_1.createTestEvent)({
+                        type: 'identify',
+                        userId: 'user2',
+                        traits: {
+                            keys: { contactKey: 'user2', id: 'U2' },
+                            values: { firstName: 'User', lastName: 'Two' }
+                        }
+                    }),
+                    (0, actions_core_1.createTestEvent)({
+                        type: 'identify',
+                        userId: 'user3',
+                        traits: {
+                            keys: { contactKey: 'user3', id: 'U3' },
+                            values: { firstName: 'User', lastName: 'Three' }
+                        }
+                    })
+                ];
+                const mapping = {
+                    keys: { '@path': '$.traits.keys' },
+                    values: { '@path': '$.traits.values' },
+                    onMappingSave: {
+                        inputs: {},
+                        outputs: {
+                            id: dataExtensionId
+                        }
+                    }
+                };
+                const responses = await testDestination.executeBatch('contactDataExtensionV2', {
+                    events,
+                    settings,
+                    mapping
+                });
+                expect(responses.length).toBe(3);
+                expect(responses[0].status).toBe(200);
+                expect(responses[0].body).toEqual({ message: 'Success 1' });
+                expect(responses[1].status).toBe(200);
+                expect(responses[2].status).toBe(200);
+            });
+            it('should send multiple contacts in batch mode', async () => {
+                (0, nock_1.default)(`https://${settings.subdomain}.rest.marketingcloudapis.com`)
+                    .post(`/hub/v1/dataevents/${dataExtensionId}/rowset`)
+                    .reply(200, [{ message: 'Success 1' }, { message: 'Success 2' }]);
+                const events = [
+                    (0, actions_core_1.createTestEvent)({
+                        type: 'identify',
+                        userId: 'user1',
+                        traits: {
+                            keys: { contactKey: 'user1' },
+                            values: { firstName: 'User', lastName: 'One' }
+                        }
+                    }),
+                    (0, actions_core_1.createTestEvent)({
+                        type: 'identify',
+                        userId: 'user2',
+                        traits: {
+                            keys: { contactKey: 'user2' },
+                            values: { firstName: 'User', lastName: 'Two' }
+                        }
+                    })
+                ];
+                const mapping = {
+                    keys: { '@path': '$.traits.keys' },
+                    values: { '@path': '$.traits.values' },
+                    onMappingSave: {
+                        inputs: {},
+                        outputs: {
+                            id: dataExtensionId
+                        }
+                    }
+                };
+                const responses = await testDestination.executeBatch('contactDataExtensionV2', {
+                    events,
+                    settings,
+                    mapping
+                });
+                expect(responses.length).toBe(2);
+                expect(responses[0].status).toBe(200);
+                expect(responses[1].status).toBe(200);
+            });
+            it('should throw an error if no data extension is connected in batch mode', async () => {
+                const events = [
+                    (0, actions_core_1.createTestEvent)({
+                        type: 'identify',
+                        userId: 'user1',
+                        traits: {
+                            keys: { contactKey: 'user1', id: 'U1' },
+                            values: { firstName: 'User', lastName: 'One' }
+                        }
+                    })
+                ];
+                const mapping = {
+                    keys: { '@path': '$.traits.keys' },
+                    values: { '@path': '$.traits.values' }
+                };
+                await expect(testDestination.executeBatch('contactDataExtensionV2', {
+                    events,
+                    settings,
+                    mapping
+                })).rejects.toThrowError('No Data Extension Connected');
+            });
+            it('should work with retlOnMappingSave hook outputs in batch mode', async () => {
+                (0, nock_1.default)(`https://${settings.subdomain}.rest.marketingcloudapis.com`)
+                    .post(`/hub/v1/dataevents/${dataExtensionId}/rowset`)
+                    .reply(200, [{ message: 'Success' }]);
+                const events = [
+                    (0, actions_core_1.createTestEvent)({
+                        type: 'identify',
+                        userId: 'user1',
+                        traits: {
+                            keys: { contactKey: 'user1', id: 'U1' },
+                            values: { firstName: 'User', lastName: 'One' }
+                        }
+                    })
+                ];
+                const mapping = {
+                    keys: { '@path': '$.traits.keys' },
+                    values: { '@path': '$.traits.values' },
+                    retlOnMappingSave: {
+                        inputs: {},
+                        outputs: {
+                            id: dataExtensionId
+                        }
+                    }
+                };
+                const responses = await testDestination.executeBatch('contactDataExtensionV2', {
+                    events,
+                    settings,
+                    mapping
+                });
+                expect(responses.length).toBe(1);
+                expect(responses[0].status).toBe(200);
+            });
+            it('should handle API error in batch mode', async () => {
+                (0, nock_1.default)(`https://${settings.subdomain}.rest.marketingcloudapis.com`)
+                    .post(`/hub/v1/dataevents/${dataExtensionId}/rowset`)
+                    .reply(400, {
+                    message: 'Bad Request in batch',
+                    errorcode: 12345,
+                    additionalErrors: [
+                        {
+                            message: 'Invalid contact key format'
+                        }
+                    ]
+                });
+                const events = [
+                    (0, actions_core_1.createTestEvent)({
+                        type: 'identify',
+                        userId: 'user1',
+                        traits: {
+                            keys: { contactKey: 'user1', id: 'U1' },
+                            values: { firstName: 'User', lastName: 'One' }
+                        }
+                    })
+                ];
+                const mapping = {
+                    keys: { '@path': '$.traits.keys' },
+                    values: { '@path': '$.traits.values' },
+                    onMappingSave: {
+                        inputs: {},
+                        outputs: {
+                            id: dataExtensionId
+                        }
+                    }
+                };
+                const responses = await testDestination.executeBatch('contactDataExtensionV2', {
+                    events,
+                    settings,
+                    mapping
+                });
+                expect(responses.length).toBe(1);
+                expect(responses[0]).toMatchObject({
+                    status: 400,
+                    errortype: 'BAD_REQUEST',
+                    errormessage: 'Invalid contact key format'
+                });
+            });
+            it('should handle 500 server error in batch mode', async () => {
+                (0, nock_1.default)(`https://${settings.subdomain}.rest.marketingcloudapis.com`)
+                    .post(`/hub/v1/dataevents/${dataExtensionId}/rowset`)
+                    .reply(500, {
+                    message: 'Internal Server Error in batch'
+                });
+                const events = [
+                    (0, actions_core_1.createTestEvent)({
+                        type: 'identify',
+                        userId: 'user1',
+                        traits: {
+                            keys: { contactKey: 'user1', id: 'U1' },
+                            values: { firstName: 'User', lastName: 'One' }
+                        }
+                    })
+                ];
+                const mapping = {
+                    keys: { '@path': '$.traits.keys' },
+                    values: { '@path': '$.traits.values' },
+                    onMappingSave: {
+                        inputs: {},
+                        outputs: {
+                            id: dataExtensionId
+                        }
+                    }
+                };
+                const responses = await testDestination.executeBatch('contactDataExtensionV2', {
+                    events,
+                    settings,
+                    mapping
+                });
+                expect(responses.length).toBe(1);
+                expect(responses[0]).toMatchObject({
+                    status: 500
+                });
+                expect(responses[0]).toHaveProperty('errormessage');
+                expect(responses[0].errormessage).toContain('Internal Server Error');
+            });
+            it('should handle retryable error (error code 10006) in batch mode', async () => {
+                (0, nock_1.default)(`https://${settings.subdomain}.rest.marketingcloudapis.com`)
+                    .post(`/hub/v1/dataevents/${dataExtensionId}/rowset`)
+                    .reply(400, {
+                    message: 'Unable to save rows for data extension ID',
+                    errorcode: 10006
+                });
+                const events = [
+                    (0, actions_core_1.createTestEvent)({
+                        type: 'identify',
+                        userId: 'user1',
+                        traits: {
+                            keys: { contactKey: 'user1', id: 'U1' },
+                            values: { firstName: 'User', lastName: 'One' }
+                        }
+                    })
+                ];
+                const mapping = {
+                    keys: { '@path': '$.traits.keys' },
+                    values: { '@path': '$.traits.values' },
+                    onMappingSave: {
+                        inputs: {},
+                        outputs: {
+                            id: dataExtensionId
+                        }
+                    }
+                };
+                const responses = await testDestination.executeBatch('contactDataExtensionV2', {
+                    events,
+                    settings,
+                    mapping
+                });
+                expect(responses.length).toBe(1);
+                expect(responses[0]).toMatchObject({
+                    status: 500,
+                    errortype: 'INTERNAL_SERVER_ERROR'
+                });
+            });
+            it('should handle multistatus responses with partial failures', async () => {
+                (0, nock_1.default)(`https://${settings.subdomain}.rest.marketingcloudapis.com`)
+                    .post(`/hub/v1/dataevents/${dataExtensionId}/rowset`)
+                    .reply(400, {
+                    message: 'Partial failure',
+                    additionalErrors: [
+                        {
+                            message: 'Contact key already exists'
+                        }
+                    ]
+                });
+                const events = [
+                    (0, actions_core_1.createTestEvent)({
+                        type: 'identify',
+                        userId: 'user1',
+                        traits: {
+                            keys: { contactKey: 'user1', id: 'U1' },
+                            values: { firstName: 'User', lastName: 'One' }
+                        }
+                    }),
+                    (0, actions_core_1.createTestEvent)({
+                        type: 'identify',
+                        userId: 'user2',
+                        traits: {
+                            keys: { contactKey: 'user2', id: 'U2' },
+                            values: { firstName: 'User', lastName: 'Two' }
+                        }
+                    })
+                ];
+                const mapping = {
+                    keys: { '@path': '$.traits.keys' },
+                    values: { '@path': '$.traits.values' },
+                    onMappingSave: {
+                        inputs: {},
+                        outputs: {
+                            id: dataExtensionId
+                        }
+                    }
+                };
+                const responses = await testDestination.executeBatch('contactDataExtensionV2', {
+                    events,
+                    settings,
+                    mapping
+                });
+                expect(responses.length).toBe(2);
+                expect(responses[0]).toMatchObject({
+                    status: 400,
+                    errormessage: 'Contact key already exists'
+                });
+                expect(responses[1]).toMatchObject({
+                    status: 400,
+                    errormessage: 'Contact key already exists'
+                });
+            });
+        });
+        describe('Dynamic Fields', () => {
+            it('should return primary key fields for keys.__keys__', async () => {
+                (0, nock_1.default)(`https://${settings.subdomain}.auth.marketingcloudapis.com`).post('/v2/token').reply(200, {
+                    access_token: 'test-access-token',
+                    token_type: 'Bearer',
+                    expires_in: 3600
+                });
+                (0, nock_1.default)(`https://${settings.subdomain}.rest.marketingcloudapis.com`)
+                    .get(`/data/v1/customobjects/${dataExtensionId}/fields`)
+                    .reply(200, {
+                    fields: [
+                        { name: 'contactKey', isPrimaryKey: true },
+                        { name: 'id', isPrimaryKey: true },
+                        { name: 'email', isPrimaryKey: false },
+                        { name: 'firstName', isPrimaryKey: false }
+                    ]
+                });
+                const response = (await testDestination.testDynamicField('contactDataExtensionV2', 'keys.__keys__', {
+                    settings,
+                    payload: {
+                        onMappingSave: {
+                            outputs: {
+                                id: dataExtensionId
+                            }
+                        }
+                    }
+                }));
+                expect(response.choices).toHaveLength(2);
+                expect(response.choices).toEqual(expect.arrayContaining([
+                    { value: 'contactKey', label: 'contactKey' },
+                    { value: 'id', label: 'id' }
+                ]));
+            });
+            it('should return non-primary key fields for values.__keys__', async () => {
+                (0, nock_1.default)(`https://${settings.subdomain}.auth.marketingcloudapis.com`).post('/v2/token').reply(200, {
+                    access_token: 'test-access-token',
+                    token_type: 'Bearer',
+                    expires_in: 3600
+                });
+                (0, nock_1.default)(`https://${settings.subdomain}.rest.marketingcloudapis.com`)
+                    .get(`/data/v1/customobjects/${dataExtensionId}/fields`)
+                    .reply(200, {
+                    fields: [
+                        { name: 'contactKey', isPrimaryKey: true },
+                        { name: 'email', isPrimaryKey: false },
+                        { name: 'firstName', isPrimaryKey: false },
+                        { name: 'lastName', isPrimaryKey: false }
+                    ]
+                });
+                const response = (await testDestination.testDynamicField('contactDataExtensionV2', 'values.__keys__', {
+                    settings,
+                    payload: {
+                        onMappingSave: {
+                            outputs: {
+                                id: dataExtensionId
+                            }
+                        }
+                    }
+                }));
+                expect(response.choices).toHaveLength(3);
+                expect(response.choices).toEqual(expect.arrayContaining([
+                    { value: 'email', label: 'email' },
+                    { value: 'firstName', label: 'firstName' },
+                    { value: 'lastName', label: 'lastName' }
+                ]));
+            });
+            it('should return error when no data extension ID is provided', async () => {
+                const response = (await testDestination.testDynamicField('contactDataExtensionV2', 'keys.__keys__', {
+                    settings,
+                    payload: {}
+                }));
+                expect(response.choices).toHaveLength(0);
+                expect(response.error).toEqual({
+                    message: 'No Data Extension ID provided',
+                    code: 'BAD_REQUEST'
+                });
+            });
+            it('should work with retlOnMappingSave for keys.__keys__', async () => {
+                (0, nock_1.default)(`https://${settings.subdomain}.auth.marketingcloudapis.com`).post('/v2/token').reply(200, {
+                    access_token: 'test-access-token',
+                    token_type: 'Bearer',
+                    expires_in: 3600
+                });
+                (0, nock_1.default)(`https://${settings.subdomain}.rest.marketingcloudapis.com`)
+                    .get(`/data/v1/customobjects/${dataExtensionId}/fields`)
+                    .reply(200, {
+                    fields: [
+                        { name: 'contactKey', isPrimaryKey: true },
+                        { name: 'subscriber_key', isPrimaryKey: true },
+                        { name: 'first_name', isPrimaryKey: false }
+                    ]
+                });
+                const response = (await testDestination.testDynamicField('contactDataExtensionV2', 'keys.__keys__', {
+                    settings,
+                    payload: {
+                        retlOnMappingSave: {
+                            outputs: {
+                                id: dataExtensionId
+                            }
+                        }
+                    }
+                }));
+                expect(response.choices).toHaveLength(2);
+                expect(response.choices).toEqual(expect.arrayContaining([
+                    { value: 'contactKey', label: 'contactKey' },
+                    { value: 'subscriber_key', label: 'subscriber_key' }
+                ]));
+            });
+            it('should work with retlOnMappingSave for values.__keys__', async () => {
+                (0, nock_1.default)(`https://${settings.subdomain}.auth.marketingcloudapis.com`).post('/v2/token').reply(200, {
+                    access_token: 'test-access-token',
+                    token_type: 'Bearer',
+                    expires_in: 3600
+                });
+                (0, nock_1.default)(`https://${settings.subdomain}.rest.marketingcloudapis.com`)
+                    .get(`/data/v1/customobjects/${dataExtensionId}/fields`)
+                    .reply(200, {
+                    fields: [
+                        { name: 'contactKey', isPrimaryKey: true },
+                        { name: 'email', isPrimaryKey: false },
+                        { name: 'first_name', isPrimaryKey: false },
+                        { name: 'last_name', isPrimaryKey: false }
+                    ]
+                });
+                const response = (await testDestination.testDynamicField('contactDataExtensionV2', 'values.__keys__', {
+                    settings,
+                    payload: {
+                        retlOnMappingSave: {
+                            outputs: {
+                                id: dataExtensionId
+                            }
+                        }
+                    }
+                }));
+                expect(response.choices).toHaveLength(3);
+                expect(response.choices).toEqual(expect.arrayContaining([
+                    { value: 'email', label: 'email' },
+                    { value: 'first_name', label: 'first_name' },
+                    { value: 'last_name', label: 'last_name' }
+                ]));
+            });
+        });
+    });
+});
+//# sourceMappingURL=contactDataExtensionV2.test.js.map