chore: update screen preset event name (#5)

awslabs · Jun 11, 2024 · 24fd914 · 24fd914
1 parent 89c6201
commit 24fd914
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 19 deletions.
diff --git a/src/provider/ClickstreamProvider.ts b/src/provider/ClickstreamProvider.ts
@@ -395,15 +395,11 @@ export class ClickstreamProvider {
 
  const pages = getCurrentPages();
  const currentPage = pages.length > 0 ? pages[pages.length - 1] : null;
- const previousPage = pages.length > 1 ? pages[pages.length - 2] : null;
  const screenAttributes: ClickstreamAttributes = {
- [ReservedAttribute.SCREEN_ID]: currentPage ? currentPage.getPageId() : '',
- [ReservedAttribute.SCREEN_ROUTE]: this.getPageRoute(currentPage),
- [ReservedAttribute.PREVIOUS_SCREEN_ID]: previousPage
- ? previousPage.getPageId()
+ [ReservedAttribute.SCREEN_UNIQUE_ID]: currentPage
+ ? currentPage.getPageId()
  : '',
- [ReservedAttribute.PREVIOUS_SCREEN_ROUTE]:
- this.getPageRoute(previousPage),
+ [ReservedAttribute.SCREEN_ID]: this.getPageRoute(currentPage),
  };
 
  return {

diff --git a/src/provider/Event.ts b/src/provider/Event.ts
@@ -59,11 +59,11 @@ export const ReservedAttribute = {
  SESSION_NUMBER: '_session_number',
 
  // Page
+ SCREEN_UNIQUE_ID: '_screen_unique_id',
  SCREEN_ID: '_screen_id',
- SCREEN_ROUTE: '_screen_route',
  SCREEN_NAME: '_screen_name',
+ PREVIOUS_SCREEN_UNIQUE_ID: '_previous_screen_unique_id',
  PREVIOUS_SCREEN_ID: '_previous_screen_id',
- PREVIOUS_SCREEN_ROUTE: '_previous_screen_route',
  PREVIOUS_SCREEN_NAME: '_previous_screen_name',
 
  // Other

diff --git a/src/tracker/AppTracker.ts b/src/tracker/AppTracker.ts
@@ -118,13 +118,13 @@ export class AppTracker extends BaseTracker {
  this.provider.eventRecorder.sendEvent({
  name: PresetEvent.USER_ENGAGEMENT,
  attributes: {
- [ReservedAttribute.SCREEN_ID]: lastPage.id,
- [ReservedAttribute.SCREEN_ROUTE]: lastPage.route,
+ [ReservedAttribute.SCREEN_UNIQUE_ID]: lastPage.id,
+ [ReservedAttribute.SCREEN_ID]: lastPage.route,
  [ReservedAttribute.SCREEN_NAME]: lastPage.name,
  [ReservedAttribute.ENGAGEMENT_TIMESTAMP]:
  new Date().getTime() - lastPage.timestamp,
+ [ReservedAttribute.PREVIOUS_SCREEN_UNIQUE_ID]: undefined,
  [ReservedAttribute.PREVIOUS_SCREEN_ID]: undefined,
- [ReservedAttribute.PREVIOUS_SCREEN_ROUTE]: undefined,
  [ReservedAttribute.PREVIOUS_SCREEN_NAME]: undefined,
  },
  });

diff --git a/src/tracker/PageTracker.ts b/src/tracker/PageTracker.ts
@@ -114,11 +114,11 @@ export class PageTracker extends BaseTracker {
  this.provider.eventRecorder.sendEvent({
  name: PresetEvent.SCREEN_VIEW,
  attributes: {
- [ReservedAttribute.SCREEN_ID]: pageId,
- [ReservedAttribute.SCREEN_ROUTE]: pageRoute,
+ [ReservedAttribute.SCREEN_UNIQUE_ID]: pageId,
+ [ReservedAttribute.SCREEN_ID]: pageRoute,
  [ReservedAttribute.SCREEN_NAME]: pageTitle,
- [ReservedAttribute.PREVIOUS_SCREEN_ID]: lastPage.id,
- [ReservedAttribute.PREVIOUS_SCREEN_ROUTE]: lastPage.route,
+ [ReservedAttribute.PREVIOUS_SCREEN_UNIQUE_ID]: lastPage.id,
+ [ReservedAttribute.PREVIOUS_SCREEN_ID]: lastPage.route,
  [ReservedAttribute.PREVIOUS_SCREEN_NAME]: lastPage.name,
  [ReservedAttribute.ENGAGEMENT_TIMESTAMP]:
  lastPage.timestamp > 0
@@ -134,13 +134,13 @@ export class PageTracker extends BaseTracker {
  this.provider.eventRecorder.sendEvent({
  name: PresetEvent.USER_ENGAGEMENT,
  attributes: {
- [ReservedAttribute.SCREEN_ID]: lastPage.id,
- [ReservedAttribute.SCREEN_ROUTE]: lastPage.route,
+ [ReservedAttribute.SCREEN_UNIQUE_ID]: lastPage.id,
+ [ReservedAttribute.SCREEN_ID]: lastPage.route,
  [ReservedAttribute.SCREEN_NAME]: lastPage.name,
  [ReservedAttribute.ENGAGEMENT_TIMESTAMP]:
  new Date().getTime() - lastPage.timestamp,
+ [ReservedAttribute.PREVIOUS_SCREEN_UNIQUE_ID]: undefined,
  [ReservedAttribute.PREVIOUS_SCREEN_ID]: undefined,
- [ReservedAttribute.PREVIOUS_SCREEN_ROUTE]: undefined,
  [ReservedAttribute.PREVIOUS_SCREEN_NAME]: undefined,
  },
  });