fest(Segment): add all new endpoints to segment #1459

rubyjohn93 · 2023-08-01T07:36:50Z

We have added 3 new endpoints to talon-integration. This PR aims at adding these 3 endpoints to segment.

The new endpoints mainly support a new query param skipNonExistingAttributes compared to their previous versions.

This flag indicates whether to skip non-existing attributes.
If true, the non-existing attributes are skipped and a 400 error is not returned.
If false, a 400 error is returned in case of non-existing attributes.

Testing

Include any additional information about the testing you have completed to
ensure your changes behave as expected. For a speedy review, please check
any of the tasks you completed below during your testing.

Added unit tests for new functionality
Tested end-to-end using the local server
Please find the attached screenshots for the same. I have added screenshots of Action Tester with and without the skipNonExistingAttributes query param and the talon-ui after the API succeeds.
Track Events Endpoint:

Update Customer Profile Endpoint:

Update Customer Session Endpoint:

[Segmenters] Tested in the staging environment

…th-customer

…s-to-work-with-customer feat(Segment) add destination endpoints to work with customer profiles

joe-ayoub-segment · 2023-08-03T15:16:31Z

Hi @rubyjohn93 thanks for raising this PR. I'll schedule for review.

joe-ayoub-segment · 2023-08-08T12:26:19Z

Thanks for raising this PR @rubyjohn93 ,

I'd like to have a little more context about these changes so I can be more informed when reviewing the PR.
I'm also interested in doing some testing so we can be more certain that the new Actions behave as expected. Since this Destination is already publicly available we won't be able to test these new Actions in Production prior to customers getting access to them.

Would you be OK scheduling a call with me via this Calendly link please?
http://calendly.com/joe_ayoub/integration-workshop

Best regads,
Joe

joe-ayoub-segment · 2023-08-09T13:44:51Z

hi @rubyjohn93 , Alex and Kristina,

Thanks for taking the time to catch up just now.
During the call we discussed the following:

Adding new versions of Actions is not the most desirable way to migrate to a new API. However after looking at the code in the new Actions it seems like we've no choice. It would not be possible to upgrade the existing Actions to new API versions without making the customer experience more complicated.
We discussed adding Presets. However since the existing Actions don't have defaultSubscriptions configured, adding Presets at this time might confuse customers. For example: Multiple Actions in the Talon One Destination could map to Segment track() events. Because of this we decided against using Presets.
We agreed that we should somehow inform customers that certain Actions are 'deprecated'. We agreed to do this by adding the work [Deprecated] to the start of the Action Description, and we'd also explain which Action to use instead.
We agreed that we'd add a new paragraph to the Segment docs to explain which Actions are deprecated, and which ones should be used going forward.
Finally, it would be great if you could include some more evidence of testing in the PR. Maybe some screenshots of payloads being sent to the "Action Tester" tool, and then the resulting impact in the Talon One UI.

Thanks again for your time,
Joe

joe-ayoub-segment · 2023-08-14T11:47:40Z

Hi @rubyjohn93 , Alex and Krishna,

Please let me know once you've updated the PR based on our discussion, and that you are happy for me to rereview.

Best regards,
Joe

rubyjohn93 · 2023-08-14T15:27:46Z

Hi @rubyjohn93 , Alex and Krishna,

Please let me know once you've updated the PR based on our discussion, and that you are happy for me to rereview.

Best regards, Joe

Hi @joe-ayoub-segment
We will make these changes and get back to you.
Sorry about the delay.

packages/destination-actions/src/destinations/talon-one/updateCustomerSession/index.ts

kkupreeva

LGTM 👍

vignesh-giridharan

Just some minor tweaks to the phrasing....

packages/destination-actions/src/destinations/talon-one/trackEvent/index.ts

packages/destination-actions/src/destinations/talon-one/updateCustomerProfile/index.ts

packages/destination-actions/src/destinations/talon-one/updateCustomerProfileV2/index.ts

packages/destination-actions/src/destinations/talon-one/updateCustomerSession/index.ts

packages/destination-actions/src/destinations/talon-one/updateCustomerSessionV2/index.ts

packages/destination-actions/src/destinations/talon-one/updateCustomerProfileV2/index.ts

packages/destination-actions/src/destinations/talon-one/updateCustomerProfile/index.ts

packages/destination-actions/src/destinations/talon-one/trackEvent/index.ts

packages/destination-actions/src/destinations/talon-one/trackEventV2/index.ts

packages/destination-actions/src/destinations/talon-one/updateCustomerSession/index.ts

joe-ayoub-segment · 2023-08-18T10:40:57Z

Hi @vignesh-giridharan and @rubyjohn93 , I can see that you're still working on this so I'll hold off on approving it. Please message me directly here to let me know when you are done :)

rubyjohn93 · 2023-08-18T11:09:15Z

Hi @vignesh-giridharan and @rubyjohn93 , I can see that you're still working on this so I'll hold off on approving it. Please message me directly here to let me know when you are done :)

@joe-ayoub-segment Yes, @vignesh-giridharan is from our docs team and we are working on making the mappings name in segment and our docs the same, so that the customers can easily relate both. I'll make the proposed changes and once everything is finalised I'll ping you here.

vignesh-giridharan

Thank you for the changes, @rubyjohn93! Also, hi, Joe! 👋🏽

rubyjohn93 · 2023-08-21T09:19:34Z

@joe-ayoub-segment
A small update on this PR.

I have completed the changes you proposed, in the scope of this repo. I incorporated a few suggestion from our docs team as well.
But regarding your other comment for docs repo

We agreed that we'd add a new paragraph to the Segment docs to explain which Actions are deprecated, and which ones should be used going forward.

This change will be picked up by our docs team later in their pipeline and hopefully they will raise a PR by next week.

I would like to request you to wait till then so that we can make avail both PRs ready for your review.
Thank you!
cc: @vignesh-giridharan @kkupreeva @gotgelf

joe-ayoub-segment

Hi @rubyjohn93 , few more minor changes.

joe-ayoub-segment · 2023-08-21T12:52:29Z

packages/destination-actions/src/destinations/talon-one/trackEvent/index.ts

+  description: `This records a custom event in Talon.One.
+
+  **Important:** This endpoint is deprecated. Use the current **Track event** endpoint instead.`,


Suggested change

description: `This records a custom event in Talon.One.

**Important:** This endpoint is deprecated. Use the current **Track event** endpoint instead.`,

description: `This records a custom event in Talon.One. **Important:** This Action is deprecated. Use the **Track event** Action instead.`,

joe-ayoub-segment · 2023-08-21T12:53:23Z

packages/destination-actions/src/destinations/talon-one/updateCustomerProfile/index.ts

+  description: `This updates attributes and audiences for a single customer profile.
+
+  **Important:** This endpoint is deprecated. Use the current **Update customer profile** endpoint instead.`,


Suggested change

description: `This updates attributes and audiences for a single customer profile.

**Important:** This endpoint is deprecated. Use the current **Update customer profile** endpoint instead.`,

description: `This updates attributes and audiences for a single customer profile. **Important:** This Action is deprecated. Use the **Update customer profile** Action instead.`,

joe-ayoub-segment · 2023-08-21T14:00:51Z

packages/destination-actions/src/destinations/talon-one/updateCustomerProfileV2/index.ts

+  description: `You do not have to create attributes or audiences before using this endpoint.
+
+  **Important:** This endpoint is deprecated. Use the current **Update customer profile** endpoint instead.`,


Suggested change

description: `You do not have to create attributes or audiences before using this endpoint.

**Important:** This endpoint is deprecated. Use the current **Update customer profile** endpoint instead.`,

description: `You do not have to create attributes or audiences before using this Action. **Important:** This Action is deprecated. Use the **Update customer profile** Action instead.`,

joe-ayoub-segment · 2023-08-21T14:02:01Z

packages/destination-actions/src/destinations/talon-one/updateCustomerSession/index.ts

+  description: `This updates a customer session.
+
+  **Important:** This endpoint is deprecated. Use the current **Update customer session** endpoint instead.`,


Suggested change

description: `This updates a customer session.

**Important:** This endpoint is deprecated. Use the current **Update customer session** endpoint instead.`,

description: `This updates a customer session. **Important:** This Action is deprecated. Use the **Update customer session** Action instead.`,

joe-ayoub-segment · 2023-08-21T14:14:56Z

packages/destination-actions/src/destinations/talon-one/updateCustomerProfileV3/index.ts

+const action: ActionDefinition<Settings, Payload> = {
+  title: 'Update customer profile',
+  description:
+    'This updates attributes and audiences for a single customer profile. Create all the required attributes and audiences before using this endpoint.',


Suggested change

'This updates attributes and audiences for a single customer profile. Create all the required attributes and audiences before using this endpoint.',

'This updates attributes and audiences for a single customer profile. Create all the required attributes and audiences before using this Action.',

joe-ayoub-segment · 2023-08-21T14:15:08Z

packages/destination-actions/src/destinations/talon-one/updateCustomerSessionV2/index.ts

+
+const action: ActionDefinition<Settings, Payload> = {
+  title: 'Update customer session',
+  description: 'This updates a customer session. Create all the required attributes before using this endpoint.',


Suggested change

description: 'This updates a customer session. Create all the required attributes before using this endpoint.',

description: 'This updates a customer session. Create all the required attributes before using this Action.',

joe-ayoub-segment · 2023-08-21T14:22:50Z

Internal note:
I verified that it's OK to rename the title and description of an Action. There was a suspicion that it might cause issues in Production. Test images from Staging attached.

rubyjohn93 · 2023-08-22T07:52:20Z

Hi @rubyjohn93 , few more minor changes.

Hi @joe-ayoub-segment,

Thank you for the review. Made these changes.
Now all the descriptions are in single line and changed endpoint to Action.

joe-ayoub-segment · 2023-08-22T08:58:23Z

hi @rubyjohn93 thanks for making the changes. I've approved the PR. Waiting on CI checks to pass. If they do, we plan to deploy Thursday 24th August.

rubyjohn93 · 2023-08-22T11:15:50Z

Hi @joe-ayoub-segment
Thank you!
Seems like one test failed due to some authentication issue. Can you please check when you have time.

joe-ayoub-segment · 2023-08-22T16:01:28Z

hi @rubyjohn93 , nope we're good. The Synk test fails unless it's an internal PR. We're good to deploy Thursday.

rubyjohn93 · 2023-08-22T16:14:36Z

hi @rubyjohn93 , nope we're good. The Synk test fails unless it's an internal PR. We're good to deploy Thursday.

Thank you 👍
As I mentioned earlier, the docs PR will be raised by next week.
Thanks again for your support throughout the process 🙇‍♀️

joe-ayoub-segment · 2023-08-24T14:29:25Z

Hi @rubyjohn93 this PR has been deployed.

@jinapark202

* add create audience action * try enable CI * try fix * return ci how it was * add updateAudience, deleteAudience, trackEvent * check workflow * fix tests * fix tests * fix description * improve test * fix labels and descriptions * generate types * return workflows how it was before * change destination name Talon One -> Talon.One * review * new files * added 3 endpoints * added generated files * implemented 3 endppoints * tests * fixed tests, added right json tags * updated models * updated test models * update models * updated models * tests generated * updated models * tests generated * Revert "Merge pull request #2 from talon-one/sc-7503-add-destination-endpoints-to-work-with-customer" This reverts commit d391a8e, reversing changes made to 6871863. * Revert "Revert "Merge pull request #2 from talon-one/sc-7503-add-destination-endpoints-to-work-with-customer"" This reverts commit b7e7d31. * added more endpoints and fixed some minor things * deleted an unnecessarily added file * updated snapshots, thank you @jinapark202 * add updateCustomerProfileV2 action * add default mapping * integrationId -> integration ID * new update customer session destination for talon.one * fixed tests, review * added choices for attributesInfo * reused attributesInfo constant from t1-properties.ts * updated test by cardItems array * updated test by cardItems array * generated types * fixed unit tests * fixed a typo * review * deleted destination to update multiple attributes fro multiple customer profiles * Add new talon-integration endpoints to segment * Mark old endpoints as deprecated in title and description * Fix PR comments from docs team * Fix casing * Fix PR comments --------- Co-authored-by: kkupreeva <kupreeva@talon.one> Co-authored-by: Mikhail Gunkov <painter@3lines.club> Co-authored-by: Michael Gunkoff <54396113+kaatinga@users.noreply.github.com> Co-authored-by: Kristina Kupreeva <86834674+kkupreeva@users.noreply.github.com> Co-authored-by: Kristina Kupreeva <kristine.kupreeva@gmail.com>

kkupreeva and others added 30 commits March 1, 2022 13:50

add create audience action

e272fa0

try enable CI

c684925

try fix

612c74b

return ci how it was

682ab31

add updateAudience, deleteAudience, trackEvent

2ba19f2

check workflow

cc0eecc

fix tests

e26685a

fix tests

36af31d

fix description

7e1c10c

improve test

e8652c5

fix labels and descriptions

336d84b

generate types

e6562b3

return workflows how it was before

3abb5c7

change destination name Talon One -> Talon.One

33e6d2d

review

b7e48e6

new files

295b63d

added 3 endpoints

0df88fb

added generated files

4b47f87

implemented 3 endppoints

d95fad1

tests

c83e0aa

fixed tests, added right json tags

cd7960f

Merge branch 'main' into sc-7503-add-destination-endpoints-to-work-wi…

ab7c139

…th-customer

updated models

6671232

updated test models

6d0bd80

update models

cc20a80

updated models

7edca72

tests generated

a47c146

updated models

5e3a7ed

tests generated

cd1022f

Merge pull request #2 from talon-one/sc-7503-add-destination-endpoint…

d391a8e

…s-to-work-with-customer feat(Segment) add destination endpoints to work with customer profiles

joe-ayoub-segment self-assigned this Aug 3, 2023

joe-ayoub-segment added the partner-eng-review (cloud) label Aug 3, 2023

Mark old endpoints as deprecated in title and description

bcbe966

kkupreeva reviewed Aug 17, 2023

View reviewed changes

packages/destination-actions/src/destinations/talon-one/updateCustomerSession/index.ts Outdated Show resolved Hide resolved

kkupreeva approved these changes Aug 17, 2023

View reviewed changes

vignesh-giridharan reviewed Aug 18, 2023

View reviewed changes

rubyjohn93 added 2 commits August 18, 2023 13:44

Fix PR comments from docs team

2420124

Fix casing

086c894

vignesh-giridharan approved these changes Aug 18, 2023

View reviewed changes

joe-ayoub-segment requested changes Aug 21, 2023

View reviewed changes

Fix PR comments

b5e26e9

rubyjohn93 requested a review from joe-ayoub-segment August 22, 2023 07:52

joe-ayoub-segment approved these changes Aug 22, 2023

View reviewed changes

joe-ayoub-segment merged commit 7dd10cf into segmentio:main Aug 24, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fest(Segment): add all new endpoints to segment #1459

fest(Segment): add all new endpoints to segment #1459

rubyjohn93 commented Aug 1, 2023 •

edited

Loading

joe-ayoub-segment commented Aug 3, 2023

joe-ayoub-segment commented Aug 8, 2023 •

edited

Loading

joe-ayoub-segment commented Aug 9, 2023

joe-ayoub-segment commented Aug 14, 2023

rubyjohn93 commented Aug 14, 2023

kkupreeva left a comment

vignesh-giridharan left a comment

joe-ayoub-segment commented Aug 18, 2023

rubyjohn93 commented Aug 18, 2023

vignesh-giridharan left a comment

rubyjohn93 commented Aug 21, 2023

joe-ayoub-segment left a comment

joe-ayoub-segment Aug 21, 2023

joe-ayoub-segment Aug 21, 2023

joe-ayoub-segment Aug 21, 2023

joe-ayoub-segment Aug 21, 2023

joe-ayoub-segment Aug 21, 2023

joe-ayoub-segment Aug 21, 2023

joe-ayoub-segment commented Aug 21, 2023

rubyjohn93 commented Aug 22, 2023

joe-ayoub-segment commented Aug 22, 2023

rubyjohn93 commented Aug 22, 2023

joe-ayoub-segment commented Aug 22, 2023

rubyjohn93 commented Aug 22, 2023

joe-ayoub-segment commented Aug 24, 2023

		description: `This records a custom event in Talon.One.

		Important: This endpoint is deprecated. Use the current Track event endpoint instead.`,

		description: `This updates attributes and audiences for a single customer profile.

		Important: This endpoint is deprecated. Use the current Update customer profile endpoint instead.`,

		description: `You do not have to create attributes or audiences before using this endpoint.

		Important: This endpoint is deprecated. Use the current Update customer profile endpoint instead.`,

		description: `This updates a customer session.

		Important: This endpoint is deprecated. Use the current Update customer session endpoint instead.`,

	'This updates attributes and audiences for a single customer profile. Create all the required attributes and audiences before using this endpoint.',
	'This updates attributes and audiences for a single customer profile. Create all the required attributes and audiences before using this Action.',

	description: 'This updates a customer session. Create all the required attributes before using this endpoint.',
	description: 'This updates a customer session. Create all the required attributes before using this Action.',

fest(Segment): add all new endpoints to segment #1459

fest(Segment): add all new endpoints to segment #1459

Conversation

rubyjohn93 commented Aug 1, 2023 • edited Loading

Testing

joe-ayoub-segment commented Aug 3, 2023

joe-ayoub-segment commented Aug 8, 2023 • edited Loading

joe-ayoub-segment commented Aug 9, 2023

joe-ayoub-segment commented Aug 14, 2023

rubyjohn93 commented Aug 14, 2023

kkupreeva left a comment

Choose a reason for hiding this comment

vignesh-giridharan left a comment

Choose a reason for hiding this comment

joe-ayoub-segment commented Aug 18, 2023

rubyjohn93 commented Aug 18, 2023

vignesh-giridharan left a comment

Choose a reason for hiding this comment

rubyjohn93 commented Aug 21, 2023

joe-ayoub-segment left a comment

Choose a reason for hiding this comment

joe-ayoub-segment Aug 21, 2023

Choose a reason for hiding this comment

joe-ayoub-segment Aug 21, 2023

Choose a reason for hiding this comment

joe-ayoub-segment Aug 21, 2023

Choose a reason for hiding this comment

joe-ayoub-segment Aug 21, 2023

Choose a reason for hiding this comment

joe-ayoub-segment Aug 21, 2023

Choose a reason for hiding this comment

joe-ayoub-segment Aug 21, 2023

Choose a reason for hiding this comment

joe-ayoub-segment commented Aug 21, 2023

rubyjohn93 commented Aug 22, 2023

joe-ayoub-segment commented Aug 22, 2023

rubyjohn93 commented Aug 22, 2023

joe-ayoub-segment commented Aug 22, 2023

rubyjohn93 commented Aug 22, 2023

joe-ayoub-segment commented Aug 24, 2023

rubyjohn93 commented Aug 1, 2023 •

edited

Loading

joe-ayoub-segment commented Aug 8, 2023 •

edited

Loading