@applicaster/zapp-react-native-utils 16.0.0-rc.9 → 16.0.0-rc.90

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (201) hide show
  1. package/actionsExecutor/ActionExecutor.ts +57 -12
  2. package/actionsExecutor/ActionExecutorContext.tsx +113 -314
  3. package/actionsExecutor/__tests__/ActionExecutor.test.ts +71 -0
  4. package/actionsExecutor/__tests__/feedDecorator.test.ts +61 -0
  5. package/actionsExecutor/actions/__tests__/dismissBottomSheet.test.ts +25 -0
  6. package/actionsExecutor/actions/__tests__/goBack.test.ts +62 -0
  7. package/actionsExecutor/actions/__tests__/goHome.test.ts +19 -0
  8. package/actionsExecutor/actions/__tests__/loadItemsFromSource.test.ts +88 -0
  9. package/actionsExecutor/actions/__tests__/navigateToScreen.test.ts +133 -0
  10. package/actionsExecutor/actions/__tests__/openBottomSheet.customContent.test.ts +76 -0
  11. package/actionsExecutor/actions/__tests__/openBottomSheet.inlineItems.test.ts +212 -0
  12. package/actionsExecutor/actions/__tests__/presentScreen.test.ts +127 -0
  13. package/actionsExecutor/actions/__tests__/showAlert.test.ts +49 -0
  14. package/actionsExecutor/actions/__tests__/showToast.test.ts +88 -0
  15. package/actionsExecutor/actions/appRestart.ts +24 -0
  16. package/actionsExecutor/actions/confirmDialog.ts +53 -0
  17. package/actionsExecutor/actions/dismissBottomSheet.ts +23 -0
  18. package/actionsExecutor/actions/goBack.ts +60 -0
  19. package/actionsExecutor/actions/goHome.ts +31 -0
  20. package/actionsExecutor/actions/index.ts +42 -0
  21. package/actionsExecutor/actions/localStorageRemove.ts +27 -0
  22. package/actionsExecutor/actions/localStorageSet.ts +28 -0
  23. package/actionsExecutor/actions/localStorageToggleFlag.ts +28 -0
  24. package/actionsExecutor/actions/navigateToScreen.ts +137 -0
  25. package/actionsExecutor/actions/openBottomSheet.ts +329 -0
  26. package/actionsExecutor/actions/presentScreen.ts +78 -0
  27. package/actionsExecutor/actions/refreshComponent.ts +85 -0
  28. package/actionsExecutor/actions/screenSetVariable.ts +35 -0
  29. package/actionsExecutor/actions/screenToggleFlag.ts +38 -0
  30. package/actionsExecutor/actions/sendCloudEvent.ts +93 -0
  31. package/actionsExecutor/actions/sessionStorageRemove.ts +19 -0
  32. package/actionsExecutor/actions/sessionStorageSet.ts +20 -0
  33. package/actionsExecutor/actions/sessionStorageToggleFlag.ts +15 -0
  34. package/actionsExecutor/actions/showAlert.ts +51 -0
  35. package/actionsExecutor/actions/showToast.ts +87 -0
  36. package/actionsExecutor/actions/switchLayout.ts +40 -0
  37. package/actionsExecutor/consts.ts +27 -0
  38. package/actionsExecutor/feedDecorator.ts +6 -6
  39. package/actionsExecutor/types.ts +59 -0
  40. package/analyticsUtils/AnalyticsEvents/sendMenuClickEvent.ts +2 -2
  41. package/analyticsUtils/PlayerAnalyticsManager.ts +12 -2
  42. package/analyticsUtils/__tests__/analyticsMapper.test.ts +35 -0
  43. package/analyticsUtils/__tests__/fixtures/analytics_mapper_testACP_events.json +1 -1
  44. package/analyticsUtils/__tests__/fixtures/analytics_mapper_testBlockUnlistedParams_rules.json +1 -1
  45. package/analyticsUtils/__tests__/fixtures/analytics_mapper_testEmptyRenameKeepsName_events.json +4 -0
  46. package/analyticsUtils/__tests__/fixtures/analytics_mapper_testEmptyRenameKeepsName_rules.json +6 -0
  47. package/analyticsUtils/__tests__/fixtures/analytics_mapper_testEventRegex_events.json +3 -9
  48. package/analyticsUtils/__tests__/fixtures/analytics_mapper_testIgnoreOrdering_events.json +18 -0
  49. package/analyticsUtils/__tests__/fixtures/analytics_mapper_testIgnoreOrdering_rules.json +16 -0
  50. package/analyticsUtils/__tests__/fixtures/analytics_mapper_testRegexEventNoFallback_events.json +4 -0
  51. package/analyticsUtils/__tests__/fixtures/analytics_mapper_testRegexEventNoFallback_rules.json +6 -0
  52. package/analyticsUtils/__tests__/fixtures/analytics_mapper_testRegexMultiGroupRename_events.json +4 -0
  53. package/analyticsUtils/__tests__/fixtures/analytics_mapper_testRegexMultiGroupRename_rules.json +6 -0
  54. package/analyticsUtils/__tests__/fixtures/analytics_mapper_testRegexNonNamedFullMatch_events.json +4 -0
  55. package/analyticsUtils/__tests__/fixtures/analytics_mapper_testRegexNonNamedFullMatch_rules.json +6 -0
  56. package/analyticsUtils/__tests__/fixtures/index.js +20 -0
  57. package/analyticsUtils/analyticsMapper.ts +4 -1
  58. package/analyticsUtils/playerAnalyticsTracker.ts +26 -3
  59. package/appUtils/HooksManager/index.ts +12 -8
  60. package/appUtils/contextKeysManager/__tests__/getKey/failure.test.ts +1 -1
  61. package/appUtils/contextKeysManager/__tests__/removeKey/failure.test.ts +1 -1
  62. package/appUtils/contextKeysManager/__tests__/setKey/failure/invalidKey.test.ts +4 -4
  63. package/appUtils/contextKeysManager/index.ts +1 -1
  64. package/appUtils/contextKeysManager/utils/index.ts +38 -25
  65. package/appUtils/playerManager/OverlayObserver/OverlaysObserver.ts +143 -53
  66. package/appUtils/playerManager/OverlayObserver/__tests__/liveContent.test.ts +205 -0
  67. package/appUtils/playerManager/OverlayObserver/__tests__/utils.test.ts +49 -0
  68. package/appUtils/playerManager/OverlayObserver/getUpcomingQueue.android.tv.ts +4 -0
  69. package/appUtils/playerManager/OverlayObserver/getUpcomingQueue.ios.tv.ts +4 -0
  70. package/appUtils/playerManager/OverlayObserver/getUpcomingQueue.ts +11 -0
  71. package/appUtils/playerManager/OverlayObserver/getUpcomingQueue.web.ts +4 -0
  72. package/appUtils/playerManager/OverlayObserver/utils.ts +54 -20
  73. package/appUtils/playerManager/__tests__/playerContent.test.ts +403 -0
  74. package/appUtils/playerManager/__tests__/playerFactory.test.ts +1 -1
  75. package/appUtils/playerManager/__tests__/playerNative.test.ts +38 -0
  76. package/appUtils/playerManager/__tests__/usePlayerContent.test.tsx +64 -0
  77. package/appUtils/playerManager/{conts.ts → const.ts} +20 -0
  78. package/appUtils/playerManager/index.ts +1 -1
  79. package/appUtils/playerManager/player.ts +115 -3
  80. package/appUtils/playerManager/playerFactory.ts +1 -1
  81. package/appUtils/playerManager/playerNative.ts +6 -4
  82. package/appUtils/playerManager/usePlayerContent.tsx +43 -0
  83. package/appUtils/playerManager/usePlayerControllerSetup.tsx +1 -1
  84. package/appUtils/playerManager/userLanguagePreference.ts +1 -1
  85. package/arrayUtils/__tests__/{anyThruthy.test.ts → anyTruthy.test.ts} +8 -0
  86. package/arrayUtils/__tests__/arrayUtils.test.ts +165 -108
  87. package/arrayUtils/__tests__/isEmptyArray.test.ts +11 -0
  88. package/arrayUtils/__tests__/isFilledArray.test.ts +12 -0
  89. package/arrayUtils/__tests__/isFirst.test.ts +17 -0
  90. package/arrayUtils/__tests__/isIndexInRange.test.ts +14 -0
  91. package/arrayUtils/__tests__/isLast.test.ts +31 -0
  92. package/arrayUtils/__tests__/makeListOf.test.ts +31 -0
  93. package/arrayUtils/__tests__/makeListOfIndexes.test.ts +20 -0
  94. package/arrayUtils/__tests__/reorderByIds.test.ts +50 -0
  95. package/arrayUtils/__tests__/sample.test.ts +61 -0
  96. package/arrayUtils/index.ts +136 -20
  97. package/bottomSheet/__tests__/scrollContext.test.tsx +35 -0
  98. package/bottomSheet/index.ts +17 -0
  99. package/cellUtils/index.ts +33 -8
  100. package/colorUtils/__tests__/isTransparentColor.test.ts +76 -0
  101. package/colorUtils/__tests__/isValidColor.test.ts +70 -0
  102. package/colorUtils/index.ts +50 -0
  103. package/configurationUtils/__tests__/manifestKeyParser.test.ts +21 -0
  104. package/configurationUtils/__tests__/modalBlocksParser.test.ts +260 -0
  105. package/configurationUtils/manifestKeyParser.ts +50 -10
  106. package/configurationUtils/modalBlocksParser.ts +296 -0
  107. package/entryActions/__tests__/buildEntryActions.test.ts +195 -0
  108. package/entryActions/aliasPresentation.ts +124 -0
  109. package/entryActions/buildEntryActions.ts +167 -0
  110. package/entryActions/index.ts +17 -0
  111. package/entryActions/types.ts +39 -0
  112. package/manifestUtils/__tests__/player.audioControls.test.js +158 -0
  113. package/manifestUtils/_internals/index.js +14 -3
  114. package/manifestUtils/defaultManifestConfigurations/generalContent.js +41 -0
  115. package/manifestUtils/defaultManifestConfigurations/player.js +349 -20
  116. package/manifestUtils/fieldUtils/__tests__/fieldUtils.test.js +84 -0
  117. package/manifestUtils/fieldUtils/index.js +125 -0
  118. package/manifestUtils/index.js +3 -0
  119. package/manifestUtils/keys.js +9 -0
  120. package/manifestUtils/mobileAction/button/index.js +16 -0
  121. package/manifestUtils/mobileAction/container/index.js +3 -1
  122. package/manifestUtils/mobileAction/groups/defaults.js +3 -1
  123. package/manifestUtils/modalBlocks.js +304 -0
  124. package/manifestUtils/platformIsTV.js +1 -0
  125. package/modalState/ContentViewModel.ts +113 -0
  126. package/modalState/EditableCollection.ts +17 -0
  127. package/modalState/EditableCollectionRegistry.ts +51 -0
  128. package/modalState/ModalOrchestrator.ts +211 -0
  129. package/modalState/RemoteEditableCollection.ts +235 -0
  130. package/modalState/__tests__/ContentViewModel.editable.test.ts +69 -0
  131. package/modalState/__tests__/ContentViewModel.test.ts +165 -0
  132. package/modalState/__tests__/EditableCollectionRegistry.test.ts +112 -0
  133. package/modalState/__tests__/ModalOrchestrator.phase3.test.ts +47 -0
  134. package/modalState/__tests__/RemoteEditableCollection.test.ts +415 -0
  135. package/modalState/__tests__/index.test.ts +30 -1
  136. package/modalState/__tests__/useBottomSheetContent.test.ts +349 -0
  137. package/modalState/__tests__/useModalStoreState.test.ts +142 -0
  138. package/modalState/index.ts +35 -83
  139. package/modalState/store.ts +109 -0
  140. package/modalState/types.ts +160 -0
  141. package/modalState/useBottomSheetContent.ts +109 -0
  142. package/numberUtils/__tests__/isMinusZero.test.ts +20 -0
  143. package/numberUtils/__tests__/isZero.test.ts +27 -0
  144. package/numberUtils/__tests__/requireNumber.test.ts +50 -0
  145. package/numberUtils/__tests__/toNumber.test.ts +27 -0
  146. package/numberUtils/__tests__/toNumberWithDefault.test.ts +64 -0
  147. package/numberUtils/__tests__/toNumberWithDefaultZero.test.ts +48 -0
  148. package/numberUtils/index.ts +27 -8
  149. package/package.json +2 -2
  150. package/pipesUtils/__tests__/buildUrlWithQuery.test.ts +33 -0
  151. package/pipesUtils/__tests__/withPipesEndpoint.test.tsx +56 -0
  152. package/pipesUtils/index.ts +1 -0
  153. package/pipesUtils/withPipesEndpoint.tsx +54 -0
  154. package/playerUtils/__tests__/contentDataKeys.test.ts +297 -0
  155. package/playerUtils/__tests__/resolvePlayerActions.test.ts +138 -0
  156. package/playerUtils/__tests__/resolvePlayerTitleSubtitle.test.ts +180 -0
  157. package/playerUtils/contentDataKeys.ts +134 -0
  158. package/playerUtils/index.ts +41 -18
  159. package/playerUtils/isAudioItem.ts +26 -0
  160. package/playerUtils/resolvePlayerActions.ts +71 -0
  161. package/playerUtils/resolvePlayerTitleSubtitle.ts +76 -0
  162. package/reactHooks/actions/index.ts +117 -2
  163. package/reactHooks/cell-click/__tests__/index.test.js +64 -0
  164. package/reactHooks/cell-click/index.ts +39 -24
  165. package/reactHooks/feed/__mocks__/useMarkPipesDataStale.ts +4 -0
  166. package/reactHooks/feed/__tests__/useInflatedUrl.test.tsx +25 -0
  167. package/reactHooks/feed/index.ts +5 -1
  168. package/reactHooks/feed/useBatchLoading.ts +9 -1
  169. package/reactHooks/feed/{usePipesCacheReset.ts → useMarkPipesDataStale.ts} +12 -4
  170. package/reactHooks/index.ts +2 -0
  171. package/reactHooks/layout/index.ts +1 -1
  172. package/reactHooks/navigation/__mocks__/index.ts +4 -0
  173. package/reactHooks/navigation/__tests__/index.test.tsx +176 -1
  174. package/reactHooks/navigation/__tests__/useIsScreenActive.test.ts +42 -0
  175. package/reactHooks/navigation/__tests__/usePresentScreen.test.ts +154 -0
  176. package/reactHooks/navigation/index.ts +3 -1
  177. package/reactHooks/navigation/useIsScreenActive.ts +29 -8
  178. package/reactHooks/navigation/usePresentScreen.ts +157 -0
  179. package/reactHooks/navigation/useRoute.ts +22 -5
  180. package/reactHooks/state/useComponentScreenState.ts +1 -1
  181. package/reactHooks/usePluginConfiguration.ts +4 -1
  182. package/reactHooks/utils/__tests__/index.test.js +22 -2
  183. package/reactHooks/utils/index.ts +13 -2
  184. package/reactHooks/videoModal/hooks/useVideoModalScreenData.tsx +22 -4
  185. package/riverComponetsMeasurementProvider/index.tsx +12 -8
  186. package/stringUtils/__tests__/stringUtils.test.js +42 -0
  187. package/stringUtils/index.ts +2 -2
  188. package/uiActionsRegistrator/__tests__/resolveActionIdentifiers.test.ts +93 -0
  189. package/uiActionsRegistrator/__tests__/subscribe.test.ts +107 -0
  190. package/uiActionsRegistrator/__tests__/usableActionItems.test.ts +52 -0
  191. package/uiActionsRegistrator/index.ts +25 -0
  192. package/uiActionsRegistrator/registry.ts +335 -0
  193. package/uiActionsRegistrator/resolveActionIdentifiers.ts +100 -0
  194. package/uiActionsRegistrator/usableActionItems.ts +66 -0
  195. package/zappFrameworkUtils/__tests__/localStorageHelper.test.ts +146 -0
  196. package/zappFrameworkUtils/localStorageHelper.ts +19 -15
  197. package/appUtils/playerManager/usePlayerTitleSummaryOverlay.tsx +0 -56
  198. package/playerUtils/__tests__/getPlayerActionButtons.test.ts +0 -54
  199. package/playerUtils/getPlayerActionButtons.ts +0 -17
  200. package/reactHooks/feed/__mocks__/usePipesCacheReset.ts +0 -1
  201. /package/reactHooks/actions/__tests__/{index.test.js → index.test.tsx} +0 -0
@@ -3,8 +3,8 @@ import { distinctUntilChanged } from "rxjs/operators";
3
3
  import { Player } from "../player";
4
4
  import { createLogger, utilsLogger } from "../../../logger";
5
5
  import { appStore } from "@applicaster/zapp-react-native-redux/AppStore";
6
+ import { findPluginByIdentifier } from "../../../pluginUtils";
6
7
  import {
7
- findPluginByIdentifier,
8
8
  loadFeedEntry,
9
9
  loadFeedAndPrefetchThumbnailImage,
10
10
  parseTimeToSeconds,
@@ -19,6 +19,12 @@ export const { log_verbose, log_debug, log_info, log_error } = createLogger({
19
19
  parent: utilsLogger,
20
20
  });
21
21
 
22
+ /**
23
+ * Mirrors `initial_value` for `audio_live_player_update_interval` in
24
+ * `defaultManifestConfigurations/player.js`.
25
+ */
26
+ const DEFAULT_LIVE_CONTENT_UPDATE_INTERVAL_SECONDS = 60;
27
+
22
28
  type ChapterMarkerOriginal = {
23
29
  id: string;
24
30
  title: string;
@@ -40,11 +46,6 @@ export type LiveMetadataConfig = {
40
46
  updateInterval: number;
41
47
  };
42
48
 
43
- export type TitleSummaryEvent = {
44
- title: string | number;
45
- summary: string | number;
46
- };
47
-
48
49
  type ChapterMarkersObserverProps = {
49
50
  player: Player;
50
51
  };
@@ -59,24 +60,23 @@ type PlayNextConfig = {
59
60
  export type PlayNextState = PlayNextConfig & {
60
61
  triggerTime: number;
61
62
  handleUserCancelPlayNext: () => void;
63
+ hidePlayNext: () => void;
62
64
  };
63
65
 
64
66
  export class OverlaysObserver {
65
67
  readonly chapterSubject: BehaviorSubject<ChapterMarkerEvent>;
66
68
  private playNextSubject: BehaviorSubject<PlayNextState>;
67
69
  private liveMetadataSubject: BehaviorSubject<LiveMetadataEvent>;
68
- private titleSummarySubject: BehaviorSubject<TitleSummaryEvent>;
69
- private feedUrl: string;
70
- private reloadData: () => void;
71
- private updateTitleAndDescription: (data: any) => void;
72
- private feedDataInterval: any;
70
+ private liveContentInterval: any;
71
+ private liveContentGeneration = 0;
72
+ private _liveEntry: ZappEntry | null = null;
73
73
  private liveMetadataUpdateInterval: any;
74
74
  private releasePlayerObserver?: () => void;
75
75
  readonly entry: ZappEntry;
76
76
  private chapterMarkerEvents: ChapterMarkerEvent[];
77
77
  readonly player: Player;
78
78
  private playNextConfig?: PlayNextConfig;
79
- private isCanceledByUser = false;
79
+ private isPlayNextSuppressed = false;
80
80
 
81
81
  constructor({ player }: ChapterMarkersObserverProps) {
82
82
  this.chapterSubject = new BehaviorSubject(null);
@@ -85,41 +85,140 @@ export class OverlaysObserver {
85
85
  this.player = player;
86
86
  this.entry = player.getEntry();
87
87
 
88
- this.titleSummarySubject = new BehaviorSubject<TitleSummaryEvent>({
89
- title: this.entry?.title || "",
90
- summary: this.entry?.summary || "",
91
- });
92
-
93
88
  this.liveMetadataSubject = new BehaviorSubject<LiveMetadataEvent>(
94
89
  this.entry?.extensions?.liveMetadata || null
95
90
  );
96
91
 
97
92
  this.chapterMarkerEvents = this.prepareChapterMarkers();
98
93
  this.releasePlayerObserver = this.subscribeToPlayerEvents();
99
- this.feedUrl = "";
100
- this.reloadData = () => {};
101
- this.updateTitleAndDescription = () => {};
102
- this.feedDataInterval = null;
94
+ this.liveContentInterval = null;
103
95
  this.liveMetadataUpdateInterval = null;
104
96
  void this.preparePlayNext();
105
97
  void this.prepareLiveMetadata();
106
98
  }
107
99
 
108
- private setupFeedDataInterval(interval: number) {
109
- if (this.feedUrl && this.reloadData && this.updateTitleAndDescription) {
110
- this.feedDataInterval = setInterval(() => {
111
- this.reloadData();
112
- }, interval * 1000);
100
+ /**
101
+ * Polls the live feed and pushes each loaded entry into the player, which
102
+ * re-resolves its Title/Subtitle and publishes on its content channel.
103
+ *
104
+ * Runs entirely outside React: `loadFeedEntry` builds its request through
105
+ * `RequestBuilder.setUrl`, which inflates URL macros with the entry and
106
+ * screen contexts, so no `useInflatedUrl` is needed. `prepareLiveMetadata`
107
+ * below already polls this way.
108
+ */
109
+ public startLiveContentUpdates() {
110
+ this.stopLiveContentUpdates();
111
+
112
+ if (!this.player?.isLive?.()) {
113
+ log_debug("startLiveContentUpdates: Player is not live. Skipping...");
114
+
115
+ return;
116
+ }
117
+
118
+ const feedUrl = this.getLiveContentFeedUrl();
119
+
120
+ if (!feedUrl) {
121
+ log_debug(
122
+ "startLiveContentUpdates: Entry carries no live channel feed. Skipping..."
123
+ );
124
+
125
+ return;
113
126
  }
127
+
128
+ const intervalSeconds = this.getLiveContentUpdateInterval();
129
+
130
+ // Clearing the interval cannot cancel a request already in flight, so each
131
+ // run carries the generation it started in. A response that arrives after
132
+ // a stop or a restart belongs to a channel that is no longer playing and
133
+ // is dropped, rather than publishing the previous programme's title over
134
+ // the current one.
135
+ const generation = ++this.liveContentGeneration;
136
+
137
+ const load = async () => {
138
+ try {
139
+ const entry = await loadFeedEntry(feedUrl, this.entry);
140
+
141
+ if (generation !== this.liveContentGeneration) {
142
+ return;
143
+ }
144
+
145
+ this._liveEntry = entry;
146
+ this.player.publishContent();
147
+ } catch {
148
+ // `loadFeedEntry` already logs the failure. Keep whatever content is
149
+ // currently published rather than blanking the title on a transient
150
+ // network error.
151
+ }
152
+ };
153
+
154
+ void load();
155
+
156
+ this.liveContentInterval = setInterval(load, intervalSeconds * 1000);
114
157
  }
115
158
 
116
- public clearFeedDataInterval() {
117
- if (this.feedDataInterval) {
118
- clearInterval(this.feedDataInterval);
119
- this.feedDataInterval = null;
159
+ public stopLiveContentUpdates() {
160
+ // Invalidates any in-flight request as well as the interval.
161
+ this.liveContentGeneration += 1;
162
+
163
+ if (this.liveContentInterval) {
164
+ clearInterval(this.liveContentInterval);
165
+ this.liveContentInterval = null;
120
166
  }
121
167
  }
122
168
 
169
+ /**
170
+ * The programme feed for the channel currently playing. Derived here rather
171
+ * than by the caller so no UI component needs to know where a live channel
172
+ * keeps its feed, or that the URL has to be rewritten to reach the
173
+ * programme ("livePage") view of it.
174
+ */
175
+ private getLiveContentFeedUrl(): string {
176
+ const channelSrc =
177
+ this.player.getEntry()?.extensions?.live?.channel_src ?? "";
178
+
179
+ return channelSrc.replace(new RegExp("subClass", "g"), "livePage");
180
+ }
181
+
182
+ /**
183
+ * Falls back to the manifest's own `initial_value` when the app ships no
184
+ * value: `intervalSeconds * 1000` would otherwise be `NaN`, and
185
+ * `setInterval` treats `NaN` as `0` - a tight loop hammering the feed.
186
+ */
187
+ private getLiveContentUpdateInterval(): number {
188
+ const configured =
189
+ this.player.getPluginConfiguration()?.audio_live_player_update_interval;
190
+
191
+ const seconds = Number(configured);
192
+
193
+ return Number.isFinite(seconds) && seconds > 0
194
+ ? seconds
195
+ : DEFAULT_LIVE_CONTENT_UPDATE_INTERVAL_SECONDS;
196
+ }
197
+
198
+ /**
199
+ * The entry most recently loaded from the live channel feed - the programme
200
+ * currently on air, as opposed to `player.entry`, which is the channel and
201
+ * stays put for the whole listening session.
202
+ *
203
+ * Read by `Player.getContent()`, which prefers it over the player's own
204
+ * entry. It lives here rather than on `Player` because it is live-feed
205
+ * state, like `liveMetadata` and play-next: a VOD or cast player never has
206
+ * an observer at all, so it never carries this either.
207
+ */
208
+ public get liveEntry(): ZappEntry | null {
209
+ return this._liveEntry;
210
+ }
211
+
212
+ /**
213
+ * Called by `Player`'s `entry` setter. The live entry is an overlay on the
214
+ * current entry, so its lifetime is scoped to that entry: without this, a
215
+ * programme from a previous channel would shadow the new one forever - the
216
+ * content would change but the title would not.
217
+ */
218
+ public clearLiveEntry() {
219
+ this._liveEntry = null;
220
+ }
221
+
123
222
  public clearLiveMetadataUpdateInterval() {
124
223
  if (this.liveMetadataUpdateInterval) {
125
224
  clearInterval(this.liveMetadataUpdateInterval);
@@ -127,25 +226,13 @@ export class OverlaysObserver {
127
226
  }
128
227
  }
129
228
 
130
- public setFeedDataHandlers(
131
- feedUrl: string,
132
- reloadData: () => void,
133
- interval: number,
134
- updateTitleAndDescription: (data: any) => void
135
- ) {
136
- this.feedUrl = feedUrl;
137
- this.reloadData = reloadData;
138
- this.updateTitleAndDescription = updateTitleAndDescription;
139
- this.setupFeedDataInterval(interval);
140
- }
141
-
142
- public getTitleSummaryObservable(): Observable<TitleSummaryEvent> {
143
- return this.titleSummarySubject.asObservable().pipe(distinctUntilChanged());
144
- }
229
+ hidePlayNext = () => {
230
+ this.isPlayNextSuppressed = true;
231
+ this.playNextSubject.next(null);
232
+ };
145
233
 
146
234
  handleUserCancelPlayNext = () => {
147
- this.isCanceledByUser = true;
148
- this.playNextSubject.next(null);
235
+ this.hidePlayNext();
149
236
  };
150
237
 
151
238
  preparePlayNext = async () => {
@@ -165,7 +252,10 @@ export class OverlaysObserver {
165
252
  return;
166
253
  }
167
254
 
168
- const playNextFeedUrl: string = retrieveFeedUrl(this.entry);
255
+ const playNextFeedUrl: string = await retrieveFeedUrl(
256
+ this.entry,
257
+ plugins
258
+ );
169
259
 
170
260
  if (!playNextFeedUrl || typeof playNextFeedUrl !== "string") {
171
261
  log_debug(
@@ -270,7 +360,7 @@ export class OverlaysObserver {
270
360
 
271
361
  // TODO: Hack for video end, will be replaced with playlist prev/next in the future
272
362
  getPlayNextEntry = () =>
273
- !this.isCanceledByUser ? this.playNextConfig?.entry : null;
363
+ !this.isPlayNextSuppressed ? this.playNextConfig?.entry : null;
274
364
 
275
365
  prepareChapterMarkers = () => {
276
366
  const chapterMarkers: ChapterMarkerOriginal[] =
@@ -353,7 +443,7 @@ export class OverlaysObserver {
353
443
  const shouldPlayNextBeVisible = currentTime > triggerTime;
354
444
 
355
445
  if (shouldPlayNextBeVisible) {
356
- if (this.isCanceledByUser) {
446
+ if (this.isPlayNextSuppressed) {
357
447
  return;
358
448
  }
359
449
 
@@ -361,10 +451,11 @@ export class OverlaysObserver {
361
451
  ...this.playNextConfig,
362
452
  triggerTime,
363
453
  handleUserCancelPlayNext: this.handleUserCancelPlayNext,
454
+ hidePlayNext: this.hidePlayNext,
364
455
  });
365
456
  } else {
366
457
  this.playNextSubject.next(null);
367
- this.isCanceledByUser = false;
458
+ this.isPlayNextSuppressed = false;
368
459
  }
369
460
  };
370
461
 
@@ -389,9 +480,8 @@ export class OverlaysObserver {
389
480
  this.chapterSubject.complete();
390
481
  this.playNextSubject.complete();
391
482
  this.liveMetadataSubject.complete();
392
- this.titleSummarySubject.complete();
393
483
  this.releasePlayerObserver?.();
394
- this.clearFeedDataInterval();
484
+ this.stopLiveContentUpdates();
395
485
  this.clearLiveMetadataUpdateInterval();
396
486
  this.releasePlayerObserver = null;
397
487
  };
@@ -0,0 +1,205 @@
1
+ import { OverlaysObserver } from "../OverlaysObserver";
2
+ import { loadFeedEntry } from "../utils";
3
+
4
+ jest.mock("../utils", () => ({
5
+ ...jest.requireActual("../utils"),
6
+ loadFeedEntry: jest.fn(),
7
+ }));
8
+
9
+ const FEED_ENTRY = { title: "Programme One" } as unknown as ZappEntry;
10
+
11
+ const CHANNEL_ENTRY = {
12
+ title: "Channel",
13
+ extensions: { live: { channel_src: "https://feed.test/subClass/audio" } },
14
+ } as unknown as ZappEntry;
15
+
16
+ const makePlayer = ({
17
+ isLive = true,
18
+ entry = CHANNEL_ENTRY,
19
+ configuration = { audio_live_player_update_interval: 30 },
20
+ }: {
21
+ isLive?: boolean;
22
+ entry?: ZappEntry;
23
+ configuration?: Record<string, any>;
24
+ } = {}) => ({
25
+ isLive: () => isLive,
26
+ getEntry: () => entry,
27
+ getPluginConfiguration: () => configuration,
28
+ publishContent: jest.fn(),
29
+ addListener: jest.fn(() => () => {}),
30
+ removeListener: jest.fn(),
31
+ });
32
+
33
+ describe("OverlaysObserver live content", () => {
34
+ beforeEach(() => {
35
+ jest.useFakeTimers();
36
+ (loadFeedEntry as jest.Mock).mockReset();
37
+ (loadFeedEntry as jest.Mock).mockResolvedValue(FEED_ENTRY);
38
+ });
39
+
40
+ afterEach(() => {
41
+ jest.useRealTimers();
42
+ });
43
+
44
+ it("stores the loaded programme and asks the player to republish", async () => {
45
+ const player = makePlayer();
46
+ const observer = new OverlaysObserver({ player } as any);
47
+
48
+ observer.startLiveContentUpdates();
49
+
50
+ await Promise.resolve();
51
+ await Promise.resolve();
52
+
53
+ expect(observer.liveEntry).toBe(FEED_ENTRY);
54
+ expect(player.publishContent).toHaveBeenCalled();
55
+
56
+ observer.stopLiveContentUpdates();
57
+ });
58
+
59
+ it("clears the stored programme on clearLiveEntry", async () => {
60
+ const player = makePlayer();
61
+ const observer = new OverlaysObserver({ player } as any);
62
+
63
+ observer.startLiveContentUpdates();
64
+
65
+ await Promise.resolve();
66
+ await Promise.resolve();
67
+
68
+ observer.clearLiveEntry();
69
+
70
+ expect(observer.liveEntry).toBeNull();
71
+
72
+ observer.stopLiveContentUpdates();
73
+ });
74
+
75
+ it("reloads on the configured interval", async () => {
76
+ const player = makePlayer();
77
+ const observer = new OverlaysObserver({ player } as any);
78
+
79
+ observer.startLiveContentUpdates();
80
+
81
+ await Promise.resolve();
82
+
83
+ (loadFeedEntry as jest.Mock).mockClear();
84
+
85
+ jest.advanceTimersByTime(30_000);
86
+
87
+ expect(loadFeedEntry).toHaveBeenCalledTimes(1);
88
+
89
+ observer.stopLiveContentUpdates();
90
+ });
91
+
92
+ it("stops polling after stopLiveContentUpdates", async () => {
93
+ const player = makePlayer();
94
+ const observer = new OverlaysObserver({ player } as any);
95
+
96
+ observer.startLiveContentUpdates();
97
+
98
+ await Promise.resolve();
99
+
100
+ observer.stopLiveContentUpdates();
101
+
102
+ (loadFeedEntry as jest.Mock).mockClear();
103
+
104
+ jest.advanceTimersByTime(90_000);
105
+
106
+ expect(loadFeedEntry).not.toHaveBeenCalled();
107
+ });
108
+
109
+ it("keeps the previous content when a poll fails", async () => {
110
+ const player = makePlayer();
111
+ const observer = new OverlaysObserver({ player } as any);
112
+
113
+ (loadFeedEntry as jest.Mock).mockRejectedValue(new Error("network"));
114
+
115
+ observer.startLiveContentUpdates();
116
+
117
+ await Promise.resolve();
118
+ await Promise.resolve();
119
+
120
+ expect(observer.liveEntry).toBeNull();
121
+ expect(player.publishContent).not.toHaveBeenCalled();
122
+
123
+ observer.stopLiveContentUpdates();
124
+ });
125
+
126
+ it("drops a response that arrives after polling was stopped", async () => {
127
+ const player = makePlayer();
128
+ const observer = new OverlaysObserver({ player } as any);
129
+
130
+ let resolveLoad: (entry: ZappEntry) => void;
131
+
132
+ (loadFeedEntry as jest.Mock).mockReturnValue(
133
+ new Promise<ZappEntry>((resolve) => {
134
+ resolveLoad = resolve;
135
+ })
136
+ );
137
+
138
+ observer.startLiveContentUpdates();
139
+ observer.stopLiveContentUpdates();
140
+
141
+ // The request was already in flight when polling stopped: clearing the
142
+ // interval cannot cancel it, so its result must be ignored rather than
143
+ // published over whatever is playing now.
144
+ resolveLoad(FEED_ENTRY);
145
+
146
+ await Promise.resolve();
147
+ await Promise.resolve();
148
+
149
+ expect(observer.liveEntry).toBeNull();
150
+ expect(player.publishContent).not.toHaveBeenCalled();
151
+ });
152
+
153
+ it("does not start polling when the entry carries no live channel feed", () => {
154
+ const player = makePlayer({ entry: { title: "No Feed" } as ZappEntry });
155
+ const observer = new OverlaysObserver({ player } as any);
156
+
157
+ observer.startLiveContentUpdates();
158
+
159
+ expect(loadFeedEntry).not.toHaveBeenCalled();
160
+ });
161
+
162
+ it("does not start polling for on-demand content", () => {
163
+ const player = makePlayer({ isLive: false });
164
+ const observer = new OverlaysObserver({ player } as any);
165
+
166
+ observer.startLiveContentUpdates();
167
+
168
+ expect(loadFeedEntry).not.toHaveBeenCalled();
169
+ });
170
+
171
+ it("rewrites the channel url to reach the programme feed", () => {
172
+ const player = makePlayer();
173
+ const observer = new OverlaysObserver({ player } as any);
174
+
175
+ observer.startLiveContentUpdates();
176
+
177
+ expect(loadFeedEntry).toHaveBeenCalledWith(
178
+ "https://feed.test/livePage/audio",
179
+ expect.anything()
180
+ );
181
+
182
+ observer.stopLiveContentUpdates();
183
+ });
184
+
185
+ it("falls back to the manifest default interval when none is configured", async () => {
186
+ // An unset value would make `intervalSeconds * 1000` NaN, and setInterval
187
+ // treats NaN as 0 - a tight loop hammering the feed.
188
+ const player = makePlayer({ configuration: {} });
189
+ const observer = new OverlaysObserver({ player } as any);
190
+
191
+ observer.startLiveContentUpdates();
192
+
193
+ await Promise.resolve();
194
+
195
+ (loadFeedEntry as jest.Mock).mockClear();
196
+
197
+ jest.advanceTimersByTime(59_000);
198
+ expect(loadFeedEntry).not.toHaveBeenCalled();
199
+
200
+ jest.advanceTimersByTime(1_000);
201
+ expect(loadFeedEntry).toHaveBeenCalledTimes(1);
202
+
203
+ observer.stopLiveContentUpdates();
204
+ });
205
+ });
@@ -0,0 +1,49 @@
1
+ import { retrieveFeedUrl, retrievePlayPreviousFeedUrl } from "../utils";
2
+
3
+ const entryWith = (extensions: Record<string, unknown>): ZappEntry =>
4
+ ({ id: "1", type: { value: "video" }, extensions }) as ZappEntry;
5
+
6
+ describe("playlist feed url accessors", () => {
7
+ it("returns the next feed url when present", async () => {
8
+ const entry = entryWith({ play_next_feed_url: "https://feeds/next.json" });
9
+
10
+ await expect(retrieveFeedUrl(entry, [])).resolves.toBe(
11
+ "https://feeds/next.json"
12
+ );
13
+ });
14
+
15
+ it("resolves to null for a missing entry", async () => {
16
+ await expect(
17
+ retrieveFeedUrl(undefined as unknown as ZappEntry, [])
18
+ ).resolves.toBeNull();
19
+ });
20
+
21
+ it("returns the previous feed url when present", () => {
22
+ const entry = entryWith({
23
+ play_previous_feed_url: "https://feeds/prev.json",
24
+ });
25
+
26
+ expect(retrievePlayPreviousFeedUrl(entry)).toBe("https://feeds/prev.json");
27
+ });
28
+
29
+ it("returns undefined when only the next url is present", () => {
30
+ const entry = entryWith({ play_next_feed_url: "https://feeds/next.json" });
31
+
32
+ expect(retrievePlayPreviousFeedUrl(entry)).toBeUndefined();
33
+ });
34
+
35
+ it("returns undefined for an entry with no extensions", () => {
36
+ expect(
37
+ retrievePlayPreviousFeedUrl({
38
+ id: "1",
39
+ type: { value: "video" },
40
+ } as ZappEntry)
41
+ ).toBeUndefined();
42
+ });
43
+
44
+ it("returns undefined for a missing entry", () => {
45
+ expect(
46
+ retrievePlayPreviousFeedUrl(undefined as unknown as ZappEntry)
47
+ ).toBeUndefined();
48
+ });
49
+ });
@@ -0,0 +1,4 @@
1
+ /** `queue-action` is not supported on this platform. See getUpcomingQueue.ts */
2
+ export const getUpcomingQueue = async (
3
+ _plugin?: QuickBrickPlugin | ZappPlugin
4
+ ): Promise<unknown[] | null> => null;
@@ -0,0 +1,4 @@
1
+ /** `queue-action` is not supported on this platform. See getUpcomingQueue.ts */
2
+ export const getUpcomingQueue = async (
3
+ _plugin?: QuickBrickPlugin | ZappPlugin
4
+ ): Promise<unknown[] | null> => null;
@@ -0,0 +1,11 @@
1
+ export const getUpcomingQueue = async (
2
+ plugin?: QuickBrickPlugin | ZappPlugin
3
+ ): Promise<unknown[] | null> => {
4
+ const QueueManager = (plugin as any)?.module?.QueueManager;
5
+
6
+ if (!QueueManager?.instance) {
7
+ return null;
8
+ }
9
+
10
+ return QueueManager.instance.getUpcomingQueue();
11
+ };
@@ -0,0 +1,4 @@
1
+ /** `queue-action` is not supported on this platform. See getUpcomingQueue.ts */
2
+ export const getUpcomingQueue = async (
3
+ _plugin?: QuickBrickPlugin | ZappPlugin
4
+ ): Promise<unknown[] | null> => null;
@@ -3,10 +3,13 @@ import {
3
3
  PipesClientResponseHelper,
4
4
  RequestBuilder,
5
5
  } from "@applicaster/zapp-pipes-v2-client";
6
+ import { appStore } from "@applicaster/zapp-react-native-redux/AppStore";
6
7
  import { log_error, log_info } from "./OverlaysObserver";
7
- import * as R from "ramda";
8
8
  import { toNumber, toNumberWithDefault } from "../../../numberUtils";
9
9
 
10
+ import { findPluginByIdentifier } from "../../../pluginUtils";
11
+ import { getUpcomingQueue } from "./getUpcomingQueue";
12
+
10
13
  export const parseTimeToSeconds = (timeStr: string): number => {
11
14
  const validationError = new Error("Invalid time format");
12
15
 
@@ -40,11 +43,58 @@ export const parseTimeToSeconds = (timeStr: string): number => {
40
43
  }
41
44
  };
42
45
 
43
- export const retrieveFeedUrl = (entry: ZappEntry) =>
44
- entry?.extensions?.play_next_feed_url;
46
+ /**
47
+ * HACK / TEMPORARY WORKAROUND:
48
+ * Resolves the play_next_feed_url dynamically for OverlaysObserver.
49
+ *
50
+ * WHY THIS IS HACKED HERE:
51
+ * OverlaysObserver was originally designed as a Recommendation Overlay engine (fetching static
52
+ * play_next_feed_url for overlay UI visuals). However, for dynamic queue & continuous audio playback,
53
+ * modifying feeds via `decorateFeed` at load time doesn't work (due to feed caching and mid-playback queue mutations).
54
+ * To avoid mutating feed payloads across the app, we temporarily intercept play_next_feed_url here
55
+ * at runtime to check if QueueManager has active/upcoming queue items.
56
+ *
57
+ * FUTURE ARCHITECTURE / TODO:
58
+ * Move queue/playlist resolution into a dedicated Player/Queue Provider module (or Handler Chain)
59
+ * on playerManager, decoupling Queue playback logic entirely from OverlaysObserver (which should
60
+ * strictly focus on recommendation visuals and chapter markers).
61
+ */
62
+ export const retrieveFeedUrl = async (
63
+ entry: ZappEntry,
64
+ plugins?: ZappPlugin[]
65
+ ): Promise<string> => {
66
+ if (!entry) return null;
67
+
68
+ const availablePlugins = plugins || appStore.get("plugins");
69
+
70
+ const queuePlugin = findPluginByIdentifier(
71
+ "queue-action",
72
+ availablePlugins,
73
+ true
74
+ );
75
+
76
+ if (queuePlugin) {
77
+ try {
78
+ const upcomingQueue = await getUpcomingQueue(queuePlugin);
79
+
80
+ if (upcomingQueue && upcomingQueue.length > 0) {
81
+ const queueItemId = entry?.extensions?.queueItemId || entry?.id;
82
+
83
+ return `pipesv2://queue-action/play-next?queueItemId=${queueItemId}`;
84
+ }
85
+ } catch (e) {
86
+ log_error("retrieveFeedUrl: Failed to resolve QueueManager", e);
87
+ }
88
+ }
89
+
90
+ return entry?.extensions?.play_next_feed_url;
91
+ };
92
+
93
+ export const retrievePlayPreviousFeedUrl = (entry: ZappEntry) =>
94
+ entry?.extensions?.play_previous_feed_url;
45
95
 
46
96
  export const retrieveOverlayDuration = (plugin) =>
47
- toNumberWithDefault(plugin?.configuration?.overlay_duration, 15);
97
+ toNumberWithDefault(15, plugin?.configuration?.overlay_duration);
48
98
 
49
99
  export const retrieveOverlayTriggerOffset = (item: ZappEntry) => {
50
100
  return item && item.extensions && item.extensions.overlay_timestamp
@@ -150,19 +200,3 @@ export const loadFeedAndPrefetchThumbnailImage = async (
150
200
 
151
201
  return playNextEntry;
152
202
  };
153
-
154
- export const findPluginByIdentifier = (
155
- identifier: string,
156
- plugins: ZappPlugin[]
157
- ): ZappPlugin => {
158
- if (!identifier) {
159
- return undefined;
160
- }
161
-
162
- const plugin = R.compose(
163
- R.find(R.propEq("identifier", identifier)),
164
- R.values
165
- )(plugins);
166
-
167
- return plugin;
168
- };