feat(headless): creation of the new headless insight user actions controller

[mmitiche]

SFINT-5613

Overview about the user actions feature:

The user actions feature allows the agent using the Insight Panel to check all the actions that have beed made by a user who created a case, these knowledge about the actions performed by the user should help the agent to understand the context of the case and issue the user is facing and help him solve the case more quickly.

From a UI perspective, that's what this feature look like:

From where we get the user actions data:

We get the user action data from the the following machine learning API: /rest/organizations/{organizationId}/machinelearning/user/actions

Example request:

curl -X 'POST' \
  'https://platform.cloud.coveo.com/rest/organizations/MyOrgId/machinelearning/user/actions' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer XXXXXXX' \
  -H 'Content-Type: application/json' \
  -d '{
  "objectId": "MyUserId"
}'

Example response:

{
   "executionTime":0.011054937,
   "modelSubType":"userActionHistory",
   "modelType":"Profile",
   "responseTime":1721136841424,
   "value":[
      {
         "name":"SEARCH",
         "value":"{\"cause\":\"userActionLoad\",\"origin_level_1\":\"coveoLightningInsightPanel\",\"origin_level_2\":\"default\"}",
         "time":"1721012966908"
      },
      {
         "name":"CUSTOM",
         "value":"{\"event_type\":\"User Actions\",\"event_value\":\"openUserActions\",\"origin_level_1\":\"coveoLightningInsightPanel\",\"origin_level_2\":\"default\"}",
         "time":"1721012966186"
      },
     ....
   ]

What is being done in the Headless library:

In this first iteration(this PR):

• Created the Headless user actions controller.
• Created the Headless user actions dispatchable actions.
• Created the Headless user actions slice.
• Created the Headless user actions state.
• Updated the the insight API client to target the correct user actions endpoint.
• Unit tests created.

In a future iteration(a following PR):

• Will add the logic that preprocess the data returned by the API, this logic will organize and filter the data to make it ready to display by the future UI components: https://coveord.atlassian.net/browse/SFINT-5639
• Expose the Headless user actions controller.
• Add the and expose the headless user action actions loader.
• Add more unit tests.

[developer-experience-bot]

Pull Request Report

PR Title

✅ Title follows the conventional commit spec.

Live demo links

• Storybook

• Playwright report

Bundle Size

File	Old (kb)	New (kb)	Change (%)
case-assist	244.9	245.1	0.1
commerce	341.4	341.6	0.1
search	413.5	413.7	0
insight	392.3	392.5	0.1
product-listing	306.9	307.1	0.1
product-recommendation	211.2	211.4	0.1
recommendation	258	258.2	0.1
ssr	404.8	405	0

SSR Progress

Use case	SSR (#)	CSR (#)	Progress (%)
search	39	44	89
recommendation	0	4	0
product-recommendation	0	10	0
product-listing	0	13	0
case-assist	0	6	0
insight	0	27	0
commerce	0	15	0

Detailed logs

search : buildInteractiveResult
search : buildInteractiveInstantResult
search : buildInteractiveRecentResult
search : buildInteractiveCitation
search : buildGeneratedAnswer
recommendation : missing SSR support
product-recommendation : missing SSR support
product-listing : missing SSR support
case-assist : missing SSR support
insight : missing SSR support
commerce : missing SSR support

[olamothe]

Code looks 👍 , but I have some doubts about the userId parameter.

[alexprudhomme]

lgtm

[SimonMilord]

GG!