@24i/bigscreen-sdk 1.0.41 → 1.0.42-alpha.2710

package/README.md

@@ -6,9 +6,8 @@ sidebar_label: README
 ---
 
 # SmartApps BIGscreen SDK
-
-[![Build Status](https://travis-ci.com/24i/smartapps-bigscreen-sdk.svg?token=TvpGGSB2Z1L12QwPagEp&branch=development)](https://travis-ci.com/24i/smartapps-bigscreen-sdk)
-[![Coverage Status](https://coveralls.io/repos/github/24i/smartapps-bigscreen-sdk/badge.svg?branch=development&t=8n9LTd&kill_cache=1)](https://coveralls.io/github/24i/smartapps-bigscreen-sdk?branch=development)
+[![Build Status](https://github.com/24i/smartapps-bigscreen-sdk/actions/workflows/pull-request.yml/badge.svg)](https://github.com/24i/smartapps-bigscreen-sdk/actions/workflows/pull-request.yml)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=24i_smartapps-bigscreen-sdk&metric=coverage&token=3d35c42d12a876ed9fde3dd5adba282b14656069)](https://sonarcloud.io/summary/new_code?id=24i_smartapps-bigscreen-sdk)
 
 * [GitHub](https://github.com/24i/smartapps-bigscreen-sdk)
 * [Confluence](https://24imedia.atlassian.net/wiki/spaces/PRDNGBIGSCR/overview)

package/ci/is_ci_job_skippable.sh

@@ -0,0 +1,153 @@
+#!/usr/bin/env bash
+
+: '
+Resolves whether CI job can be skipped or not.
+
+It requires to be executed with "source", as the script exports result as a variable
+which needs to be processed outside the script.
+
+- EXPORTS:
+Exports numeric variable IS_CI_JOB_SKIPPABLE,
+where 0 represents not skippable build and 1 represent skippable build.
+
+- PARAMETERS:
+File paths or glob patterns with paths to files which are not relevant for the CI job.
+Each glob pattern has to be wrapped into double quotes.
+
+- USAGE:
+source <path/to/script.sh> "filePathOrGlob1" "filePathOrGlob2" ... "filePathOrGlobN"
+
+- EXAMPLE:
+source path/to/script.sh "docs/**/*" ".eslintrc.json"
+if [[ "$IS_CI_JOB_SKIPPABLE" -eq 1 ]]; then
+  # job is skippable, do something here
+fi
+'
+
+# Includes filenames beginning with a ‘.’ in the results of filename expansion.
+# The filenames ‘.’ and ‘..’ must always be matched explicitly, even if dotglob is set.
+shopt -s dotglob
+
+# Patterns which fail to match filenames during filename expansion will not result in an expansion error.
+shopt -u failglob
+
+# The pattern ‘**’ used in a filename expansion context will match all files and zero or more directories and subdirectories.
+shopt -s globstar
+
+# Bash allows filename patterns which match no files to expand to a null string, rather than themselves.
+shopt -s nullglob
+
+function printFormattedArrayItems () {
+  FUNCTION_INPUT_ARRAY=("$@")
+  for i in "${FUNCTION_INPUT_ARRAY[@]}"; do
+    echo "  - $i"
+  done
+}
+
+# Exported numeric variable with the result.
+# 0 represents not skippable build, 1 represent skippable build.
+IS_CI_JOB_SKIPPABLE=0
+
+# Printed when build is skippable.
+RESULT_TRUE_STRING="It's possible to skip the CI job!"
+
+# Printed when build is not skippable.
+RESULT_FALSE_STRING="It's NOT possible to skip the CI job!"
+
+# Variable for providing details about the result.
+RESULT_REASON_STRING="N/A"
+
+# The range of commits that were included in the push or pull request.
+# Example "SHA1...SHA2".
+COMMIT_RANGE=""
+
+echo ""
+echo "==========================================================================================="
+echo "RESOLVING THE POSSIBILITY TO SKIP THE CI JOB..."
+
+# GitHub Actions CI
+if [[ "$GITHUB_EVENT_NAME" == "pull_request" ]]; then
+  # This is a Pull Request event
+  if [[ -z "$GITHUB_BASE_REF" ]]; then
+    RESULT_REASON_STRING="GITHUB_BASE_REF is empty for this CI build."
+  elif [[ -z "$GITHUB_HEAD_REF" ]]; then
+    RESULT_REASON_STRING="GITHUB_HEAD_REF is empty for this CI build."
+  else
+    COMMIT_RANGE="origin/${GITHUB_BASE_REF}...origin/${GITHUB_HEAD_REF}"
+    echo "set COMMIT_RANGE for PR (GA) to \"${COMMIT_RANGE}\""
+  fi
+else
+  # This is not Pull Request event (it is for example push)
+  if [[ "$GA_EVENT_BEFORE" == "0000000000000000000000000000000000000000" ]]; then
+    # variable it is set to zeros for the initial commit of a new branch
+    RESULT_REASON_STRING="GA_EVENT_BEFORE is zeros for this CI build."
+  elif [[ -z "$GA_EVENT_BEFORE" ]]; then
+    RESULT_REASON_STRING="GA_EVENT_BEFORE is empty for this CI build."
+  elif [[ -z "$GA_EVENT_AFTER" ]]; then
+    RESULT_REASON_STRING="GA_EVENT_AFTER is empty for this CI build."
+  else
+    COMMIT_RANGE="${GA_EVENT_BEFORE}...${GA_EVENT_AFTER}"
+    echo "set COMMIT_RANGE for \"${GITHUB_EVENT_NAME}\" (GA) to \"${COMMIT_RANGE}\""
+  fi
+fi
+
+if [[ ! -z "$COMMIT_RANGE" ]]; then
+  CHANGED_FILES_ARRAY=()
+  while IFS= read -r line; do
+      CHANGED_FILES_ARRAY+=("${line}")
+  done < <(git diff --name-only "$COMMIT_RANGE")
+
+  IRRELEVANT_FILES_INPUT_ARRAY=($@) # array with all params
+
+  RESOLVED_RELEVANT_FILES=()
+  RESOLVED_IRRELEVANT_FILES=()
+  for i in "${CHANGED_FILES_ARRAY[@]}"; do
+    if [[ "${IRRELEVANT_FILES_INPUT_ARRAY[*]}" =~ $i ]]; then
+      RESOLVED_IRRELEVANT_FILES+=("$i")
+    else
+      RESOLVED_RELEVANT_FILES+=("$i")
+    fi
+  done
+
+  echo ""
+  echo "Provided filter for irrelevant files ($#):"
+  printFormattedArrayItems "$@"
+
+  echo ""
+  echo "Resolved provided filter for irrelevant files (${#IRRELEVANT_FILES_INPUT_ARRAY[@]}):"
+  printFormattedArrayItems "${IRRELEVANT_FILES_INPUT_ARRAY[@]}"
+
+  echo ""
+  echo "Detected changed files from GIT (${#CHANGED_FILES_ARRAY[@]}):"
+  printFormattedArrayItems "${CHANGED_FILES_ARRAY[@]}"
+
+  echo ""
+  echo "Changed files resolved as relevant for the CI job (${#RESOLVED_RELEVANT_FILES[@]}):"
+  printFormattedArrayItems "${RESOLVED_RELEVANT_FILES[@]}"
+
+  echo ""
+  echo "Changed files resolved as irrelevant for the CI job: (${#RESOLVED_IRRELEVANT_FILES[@]}):"
+  printFormattedArrayItems "${RESOLVED_IRRELEVANT_FILES[@]}"
+
+  if [[ ${#RESOLVED_RELEVANT_FILES[@]} -eq 0 ]]; then
+      IS_CI_JOB_SKIPPABLE=1
+      RESULT_REASON_STRING="With given filter, all changed files are irrelevant for this CI job."
+    else
+      RESULT_REASON_STRING="With given filter, there are changes which have to be processed in this CI job."
+    fi
+fi
+
+echo ""
+echo "The result:"
+if [[ "$IS_CI_JOB_SKIPPABLE" -eq 1 ]]; then
+  echo "  $RESULT_TRUE_STRING"
+else
+  echo "  $RESULT_FALSE_STRING"
+fi
+echo ""
+echo "The reason of the result:"
+echo "  $RESULT_REASON_STRING"
+echo "==========================================================================================="
+echo ""
+
+export IS_CI_JOB_SKIPPABLE

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@24i/bigscreen-sdk",
-    "version": "1.0.41",
+    "version": "1.0.42-alpha.2710",
     "description": "SmartApps BIGscreen SDK monorepo",
     "main": "index.js",
     "scripts": {
@@ -38,7 +38,7 @@
     },
     "homepage": "https://github.com/24i/smartapps-bigscreen-sdk#readme",
     "dependencies": {
-        "@24i/appstage-shared-analytics": "1.0.20-alpha.72",
+        "@24i/appstage-shared-analytics": "1.0.22",
         "@24i/appstage-shared-events-manager": "1.0.11",
         "@24i/appstage-shared-perf-utils": "1.0.11",
         "@24i/bigscreen-players-engine-base": "4.0.10",

package/packages/analytics/src/clients/TealiumAnalytics/TealiumAnalytics.ts

@@ -103,7 +103,7 @@ export class TealiumAnalytics implements AnalyticsClient {
             platform_type: platformType ?? BIGSCREEN_PLATFORM_TYPE,
             app_type: appType ?? BIGSCREEN_APP_TYPE,
             ott_type: BIGSCREEN_OTT_TYPE,
-            app_id: `${entity} ${language}:${this.appVersion}`,
+            app_id: `${entity} ${appType ?? BIGSCREEN_APP_TYPE} : ${this.appVersion}`,
         };
     }
 
@@ -157,9 +157,18 @@ export class TealiumAnalytics implements AnalyticsClient {
                     }
                     const eventBody = {
                         ...this.constantPayload,
-                        ...mappingFunction(triggerName, payload as Payload),
+                        ...mappingFunction(triggerName, payload as Payload, this.config),
                     };
-                    if (eventBody) await this.sendEvent(eventBody);
+                    const filteredEventBody: TeaResult = Object.entries(eventBody).reduce(
+                        (acc: any, [key, value]) => {
+                            if (value != null && value !== '') {
+                                acc[key] = value;
+                            }
+                            return acc;
+                        },
+                        {} as TeaResult,
+                    );
+                    if (eventBody) await this.sendEvent(filteredEventBody);
                 } catch (e) {
                     console.warn(`[${this.name}] Error onEvent: `, e);
                 }

package/packages/analytics/src/clients/TealiumAnalytics/constants.ts

@@ -10,6 +10,7 @@ export const BIGSCREEN_PLATFORM_TYPE = 'ott';
 
 export const TEALIUM_TRIGGERS = [
     // App
+    AnalyticsTriggers.APP_OPEN,
     AnalyticsTriggers.APP_CLOSE,
     AnalyticsTriggers.APP_ERROR,
 
@@ -42,6 +43,7 @@ export const TEALIUM_TRIGGERS = [
 ];
 
 export const AppEvents = {
+    [AnalyticsTriggers.APP_OPEN]: '',
     [AnalyticsTriggers.SCENE_VIEW]: '',
     [AnalyticsTriggers.PLAYBACK_10]: 'media_milestone_10_video',
     [AnalyticsTriggers.PLAYBACK_50]: 'media_milestone_50_video',
@@ -50,7 +52,7 @@ export const AppEvents = {
     [AnalyticsTriggers.PLAYBACK_PAUSE]: 'video_pause',
     [AnalyticsTriggers.PLAYBACK_UNPAUSE]: 'video_resume',
     [AnalyticsTriggers.PLAYBACK_START]: 'video_play',
-    [AnalyticsTriggers.PLAYER_OPEN]: 'player_x',
+    [AnalyticsTriggers.PLAYER_OPEN]: 'player_open',
     [AnalyticsTriggers.PLAYER_CLOSE]: 'player_x',
     [AnalyticsTriggers.FAVORITE_ADD]: 'subscribe_to_fav',
     [AnalyticsTriggers.FAVORITE_REMOVE]: 'subscribe_to_fav',
@@ -61,6 +63,7 @@ export const AppEvents = {
 } as const;
 
 export enum EVENTS {
+    APP_OPEN = 'app_open',
     SCENE_VIEW = 'scene_view',
     VIDEO_PROGRESS = 'video_progress',
     VIDEO_START = 'video_start',
@@ -82,6 +85,7 @@ export enum TrackEventType {
 }
 
 export const TRIGGER_NAME_TO_TEALIUM_EVENTS: { [K in AnalyticsTriggers]?: EVENTS[]; } = {
+    [AnalyticsTriggers.APP_OPEN]: [EVENTS.APP_OPEN],
     [AnalyticsTriggers.SCENE_VIEW]: [EVENTS.SCENE_VIEW],
     [AnalyticsTriggers.PLAYBACK_10]: [EVENTS.VIDEO_PROGRESS],
     [AnalyticsTriggers.PLAYBACK_50]: [EVENTS.VIDEO_PROGRESS],

package/packages/analytics/src/clients/TealiumAnalytics/interface.ts

@@ -13,10 +13,12 @@ import { mapFavoriteRemove } from './mappers/mapFavoriteRemove';
 import { mapVideoResume } from './mappers/mapVideoResume';
 import { mapSearchSuccess } from './mappers/mapSearchSuccess';
 import { mapSearchFailed } from './mappers/mapSearchFailed';
-import { EventMappingFunction } from './types';
 import { mapAppError } from './mappers/mapAppError';
+import { mapAppOpen } from './mappers/mapAppOpen';
+import { EventMappingFunction } from './types';
 
 export const EVENTS_MAPPING: Record<EVENTS, EventMappingFunction> = {
+    [EVENTS.APP_OPEN]: mapAppOpen,
     [EVENTS.SCENE_VIEW]: mapSceneView,
     [EVENTS.PLAYER_OPEN]: mapPlayerOpen,
     [EVENTS.PLAYER_CLOSE]: mapPlayerClose,

package/packages/analytics/src/clients/TealiumAnalytics/mappers/__mocks__/mediaPayload.ts

@@ -6,15 +6,14 @@ export const MEDIA_PAYLOAD: Payload = {
     title: 'Test Video',
     url: 'https://example.com/video',
     contentType: 'video/mp4',
-    externalId: '',
     percent: 2,
     provider: 'provider',
     assetId: '12345',
     app_id: 'app_id',
     app_type: 'html5',
-    sceneName: '',
-    sceneId: '',
-    sceneType: '',
+    sceneName: 'pageName',
+    sceneId: 'categories',
+    sceneType: 'vod',
     sessionId: 1,
     sessionNumber: 1,
     userId: '10',
@@ -25,18 +24,20 @@ export const MEDIA_PAYLOAD: Payload = {
     deviceType: 'smarttv',
     searchTerm: '',
     itemId: '',
+    pubDate: '2012/02/12',
     message: 'error message',
     section: 'BROWSE',
-    subcontentType: '',
+    subcontentType: 'section',
+    seriesTitle: 'section',
 };
 
 export const TEALIUM_PAGEINFO_PAYLOAD = {
-    categories: '',
+    categories: 'categories',
     content_type: 'video',
-    page_name: '',
-    page_title: '',
-    section: '',
-    subcontent_type: '',
+    page_name: 'pageName',
+    page_title: 'pageName',
+    section: 'section',
+    subcontent_type: 'section',
 };
 
 export const TEALIUM_STATIC_CORE_PAYLOAD = {
@@ -44,7 +45,7 @@ export const TEALIUM_STATIC_CORE_PAYLOAD = {
     tealium_profile: 'main',
     tealium_environment: 'dev',
     tealium_datasource: 'abc',
-    app_id: 'auto english:v1.0-test',
+    app_id: 'auto html5 : v1.0-test',
     app_type: 'html5',
     entity: 'auto',
     language: 'english',
@@ -61,10 +62,9 @@ export const TEALIUM_MEDIA_PAYLOAD = {
     byline: 'N/A',
     canonical_url: 'https://example.com/video',
     media_type: 'video/mp4',
-    pub_date: '',
-    tags: '',
+    pub_date: '2012/02/12',
     video_length: 120,
     video_name: 'Test Video',
     video_position: 60,
-    video_series_title: '',
+    video_series_title: 'section',
 };

package/packages/analytics/src/clients/TealiumAnalytics/mappers/mapAppOpen.ts

@@ -0,0 +1,13 @@
+import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
+import { TeaSceneViewResult } from '../types';
+import { TrackEventType } from '../constants';
+
+export const mapAppOpen = (): Omit<TeaSceneViewResult, 'categories'> => ({
+    event_trigger: AnalyticsTriggers.SCENE_VIEW,
+    track_event_type: TrackEventType.VIEW,
+    page_title: 'app open',
+    page_name: 'app open',
+    content_type: 'onboarding',
+    section: 'onboarding',
+    subcontent_type: 'welcomeScreen',
+});

package/packages/analytics/src/clients/TealiumAnalytics/mappers/mapSceneView.ts

@@ -3,7 +3,7 @@ import { Payload, TeaSceneViewResult } from '../types';
 import { TrackEventType } from '../constants';
 
 export const mapSceneView = (
-    triggerName: AnalyticsTriggers,
+    _: AnalyticsTriggers,
     payload: Payload,
 ): TeaSceneViewResult => ({
     app_events: '',

package/packages/analytics/src/clients/TealiumAnalytics/types.ts

@@ -83,7 +83,8 @@ ErrorInfo;
 
 export type EventMappingFunction = (
     triggerName: AnalyticsTriggers,
-    payload: Payload
+    payload: Payload,
+    config?: TealiumAnalyticsConfiguration,
 ) => TeaResult;
 
 export type TeaStaticCoreResult = {

package/packages/analytics/src/clients/TwentyFourIQ/TwentyFourIQClient.ts

@@ -14,25 +14,18 @@ import { CorePayload, DeviceInfo, EventBody, Payload, SessionInfo } from './type
 // eslint-disable-next-line no-magic-numbers
 const SESSION_TIMEOUT = 30 * MINUTE_IN_MS;
 
-const TWENYFOURIQ_SESSION_COUNTER = '24iQ_session_counter';
+const TWENTY_FOUR_IQ_SESSION_COUNTER = '24iQ_session_counter';
 
 export class TwentyFourIQClient implements AnalyticsClient {
     name = '24iQ';
 
-    deviceInfo = {
-        manufacturer: '',
-        platform: '',
-        platformVersion: '',
-        deviceId: '',
-        appVersion: '',
-        applicationId: '',
-        deviceType: '',
-    };
-
     constantPayload: CorePayload & SessionInfo & DeviceInfo = {
         sessionNumber: 0,
         sessionId: 0,
-        ...this.deviceInfo,
+        appVersion: '',
+        deviceId: '',
+        manufacturer: '',
+        platform: '',
     };
 
     sessionTimeout = createTimeout();
@@ -46,24 +39,20 @@ export class TwentyFourIQClient implements AnalyticsClient {
     }
 
     async init() {
-        this.deviceInfo.manufacturer = await device.getManufacturerName();
-        this.deviceInfo.platform = await device.getPlatformName();
-        this.deviceInfo.platformVersion = await device.getPlatformVersion();
-        this.deviceInfo.deviceId = await device.getUuid();
+        this.constantPayload.deviceId = await device.getUuid();
+        this.constantPayload.manufacturer = await device.getManufacturerName();
+        this.constantPayload.platform = await device.getPlatformName();
+        this.constantPayload.appVersion = this.appVersion;
         await this.startSession();
     }
 
     async startSession() {
         const sessionNumber = parseInt(
-            await Storage.getItem(TWENYFOURIQ_SESSION_COUNTER) ?? '0', 10,
+            await Storage.getItem(TWENTY_FOUR_IQ_SESSION_COUNTER) ?? '0', 10,
         ) + 1;
         this.constantPayload.sessionNumber = sessionNumber;
         this.constantPayload.sessionId = generateSessionId();
-        this.constantPayload.manufacturer = this.deviceInfo.manufacturer;
-        this.constantPayload.platform = this.deviceInfo.platform;
-        this.constantPayload.platformVersion = this.deviceInfo.platformVersion;
-        this.constantPayload.appVersion = this.appVersion;
-        await Storage.setItem(TWENYFOURIQ_SESSION_COUNTER, sessionNumber.toString());
+        await Storage.setItem(TWENTY_FOUR_IQ_SESSION_COUNTER, sessionNumber.toString());
         this.isSessionActive = true;
         this.setSessionTimeout();
     }

package/packages/analytics/src/clients/TwentyFourIQ/constants.ts

@@ -92,6 +92,7 @@ export const TRIGGER_NAME_TO_24IQ_EVENTS: { [K in AnalyticsTriggers]?: EVENTS[];
     [AnalyticsTriggers.SCROLL_75]: [EVENTS.SCROLL],
     [AnalyticsTriggers.SCROLL_90]: [EVENTS.SCROLL],
     [AnalyticsTriggers.APP_CLOSE]: [EVENTS.VIDEO_STOP, EVENTS.PLAYER_CLOSE],
+    // VERSION 2 ?
     [AnalyticsTriggers.AD_LOADED]: [EVENTS.AD_LOADED],
     [AnalyticsTriggers.AD_SKIPPED]: [EVENTS.AD_SKIPPED],
 };

package/packages/analytics/src/clients/TwentyFourIQ/mappers/mapBase.ts

@@ -4,14 +4,15 @@ import { formatDateTime, getTimezoneOffsetString } from '../helper';
 
 export const mapBase = (payload: Payload): BaseResult => {
     const timestampDate = time.getCurrentTime();
-    const formatedTimestamp = getTimezoneOffsetString();
+    const formattedTimestamp = getTimezoneOffsetString();
     return {
         session_id: payload.sessionId.toString(),
         timestamp_initiated: formatDateTime(timestampDate),
         device_id: payload.deviceId,
-        device_type: payload.deviceType,
+        device_type: 'SmartTV',
         device_platform: payload.platform || '',
-        device_timezone: formatedTimestamp,
+        device_manufacturer: payload.manufacturer || '',
+        device_timezone: formattedTimestamp,
         service_id: payload.serviceId || '',
         user_id: payload.userId || '',
         user_profile_id: payload.userProfileId,

package/packages/analytics/src/clients/TwentyFourIQ/types.ts

@@ -27,7 +27,6 @@ export interface DeviceInfo {
     appVersion: string,
     manufacturer: string,
     platform: string,
-    platformVersion: string,
     deviceId: string,
 }
 
@@ -37,7 +36,7 @@ export interface SceneInfo {
     sceneType?: string,
 }
 
-export type Payload = CorePayload & SceneInfo & SessionInfo & UserInfo & AppInfo;
+export type Payload = CorePayload & SceneInfo & SessionInfo & UserInfo & DeviceInfo & AppInfo;
 
 export type EventBody = AnyPayload;
 
@@ -52,6 +51,7 @@ export type BaseResult = {
     device_id: string;
     device_type: string;
     device_platform: string;
+    device_manufacturer: string;
     device_timezone: string;
     service_id: string;
     user_id?: string;