[Antavo ] New Antavo Destination

[bbantavo]

Added new Antavo Destination

Testing

• Added unit tests for new functionality
• Tested end-to-end using the local server

[seg-atlantis-prod]

Atlantis commands can't be run on fork pull requests. To enable, set --allow-fork-prs or, to disable this message, set --silence-fork-pr-errors

[seg-atlantis-prod]

Error parsing command: EOF found when expecting closing quote

[joe-ayoub-segment]

Hi @bbantavo thanks for raising this PR for a new Integration.

The code looks pretty straightforward.

Instead of pointing out all the issues I'm going to ask you some broad questions, and based on your answers I might end up making some code changes myself before merging and deploying.

1. Do you want to capture user events and user profile data for 'anonymous' users, as well as 'known' users? Or do you just want to capture data for 'known' users. A 'known' user is a user who has a userId which has been assigned to them by the customer.
2. Do you want the event and profile Mappings to be automatically enabled when the Customer creates an instance of the Destination on the Segment platform (and provides auth credentials)?
3. Segment has recommended patterns for collecting user profile data. Customers tend to adhere to these patterns. Would you like me to update your code so that the 'Customer properties' field automatically maps to where the user profile data is likely to be?
4. Segment has a specification for ecommerce events which customers tend to adhere to. Does your platform have something similar? If so, it might be worth updating your code so that things like 'purchase amount', 'price', 'quantity' are automatically mapped?

Finally - would you please run the yarn types command, and commit the result? This should stop the 'Validate' CI check from failing.

Thank you!
Joe

[bbantavo]

Hi @joe-ayoub-segment !

Here are our answers:

1. We only want to capture events for known users
2. Mappings should be added manually, in order to set the field mapping properly
3. We'd like that, thanks
4. Our customer have their own naming conventions for events. They can create custom events or redefine the built-in events, so we would like to keep the code as it is

We've also ran and pushed the results of the yarn types command

[joe-ayoub-segment]

Hi @bbantavo is there a request you can make here to validate that the api_key is valid?

[joe-ayoub-segment]

Hi @bbantavo
Please remove the onDelete code if you don't intend to use it.

[joe-ayoub-segment]

hi @bbantavo please indicate where the customer can get this value from.

[joe-ayoub-segment]

hi @bbantavo please indicate where the customer can get this value from.

[joe-ayoub-segment]

Adding a default mapping so that userId is automatically mapped.

Suggested change

	customer: {
	label: 'Customer ID',
	description: 'User ID, selected in Antavo as customer identifier',
	type: 'string',
	required: true
	},
	customer: {
	label: 'Customer ID',
	description: 'User ID, selected in Antavo as customer identifier',
	type: 'string',
	required: true,
	default: {
	'@path': '$.userId'
	}
	},

[joe-ayoub-segment]

Adding default mappings as per Segment identify spec https://segment.com/docs/connections/spec/identify/

Suggested change

	default: {
	first_name: '',
	last_name: '',
	email: '',
	birth_date: '',
	gender: '',
	language: '',
	phone: '',
	mobile_phone: '',
	}
	default: {
	first_name: {
	'@path': '$.traits.first_name'
	},
	last_name: {
	'@path': '$.traits.last_name'
	},
	email: {
	'@path': '$.traits.email'
	},
	birth_date: {
	'@path': '$.traits.birthday'
	},
	gender: {
	'@path': '$.traits.gender'
	},
	language: {
	'@path': '$.traits.language'
	},
	phone: {
	'@path': '$.traits.phone'
	},
	mobile_phone: {
	'@path': '$.traits.mobile_phone'
	}
	}

[joe-ayoub-segment]

Suggested change

	required: true
	required: true,
	default: {
	'@path': '$.userId'
	}

[joe-ayoub-segment]

usually event data would be contained in this location in a Segment track() event. Up to you if you want to collect and send it.

default: {
'@path': '$.properties'
}

[joe-ayoub-segment]

hi @bbantavo I added some more comments - mostly default mappings for fields in your 2 Actions.
Please also take a look at the testAuthencication() function and let me know if you can implement it or not.
Finally, would you be able to write a couple of unit tests to validate that the payloads being sent to your platform are as expected please (for each Action)?