musora-content-services 1.3.7 → 1.3.9

package/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [1.3.9](https://github.com/railroadmedia/musora-content-services/compare/v1.3.8...v1.3.9) (2025-02-22)
+
+### [1.3.8](https://github.com/railroadmedia/musora-content-services/compare/v1.3.7...v1.3.8) (2025-02-21)
+
 ### [1.3.7](https://github.com/railroadmedia/musora-content-services/compare/v1.3.6...v1.3.7) (2025-02-20)
 
 ### [1.3.6](https://github.com/railroadmedia/musora-content-services/compare/v1.3.5...v1.3.6) (2025-02-18)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "musora-content-services",
-  "version": "1.3.7",
+  "version": "1.3.9",
   "description": "A package for Musoras content services ",
   "main": "src/index.js",
   "type": "module",

package/src/filterBuilder.js

@@ -56,6 +56,15 @@ export class FilterBuilder {
     return filter
   }
 
+  _getRoundedTime(){
+    // We need to set the published on filter date to be a round time so that it doesn't bypass the query cache
+    // with every request by changing the filter date every second. I've set it to one minute past the current hour
+    // because publishing usually publishes content on the hour exactly which means it should still skip the cache
+    // when the new content is available.
+    const now = new Date();
+    return new Date(now.getFullYear(), now.getMonth(), now.getDate(), now.getHours(), 1);
+  }
+
   _applyContentStatuses() {
     // This must be run before _applyPublishDateRestrictions()
     if (this.bypassStatuses) return this
@@ -89,7 +98,7 @@ export class FilterBuilder {
     ) {
       // we must pull in future content here, otherwise we'll restrict on content this is published in the past and remove any scheduled content
       this.pullFutureContent = true
-      const now = new Date().toISOString()
+      const now = this._getRoundedTime().toISOString();
       let statuses = [...this.availableContentStatuses]
       statuses.splice(statuses.indexOf(this.STATUS_SCHEDULED), 1)
       this._andWhere(
@@ -121,16 +130,7 @@ export class FilterBuilder {
 
   _applyPublishingDateRestrictions() {
     if (this.bypassPublishedDateRestriction) return this
-    let now = new Date()
-
-    // We need to set the published on filter date to be a round time so that it doesn't bypass the query cache
-    // with every request by changing the filter date every second. I've set it to one minute past the current hour
-    // because publishing usually publishes content on the hour exactly which means it should still skip the cache
-    // when the new content is available.
-    // Round to the start of the current hour
-    const roundedDate = new Date(now.getFullYear(), now.getMonth(), now.getDate(), now.getHours())
-
-    now = roundedDate.toISOString()
+    const now = this._getRoundedTime().toISOString();
 
     if (this.getFutureContentOnly) {
       this._andWhere(`${this.prefix}published_on >= '${now}'`)

package/src/index.d.ts

@@ -27,6 +27,10 @@ import {
 	recordWatchSession
 } from './services/contentProgress.js';
 
+import {
+	verifyLocalDataContext
+} from './services/dataContext.js';
+
 import {
 	setLastUpdatedTime,
 	wasLastUpdateOlderThanXSeconds
@@ -258,6 +262,7 @@ declare module 'musora-content-services' {
 		unpinPlaylist,
 		updatePlaylist,
 		updatePlaylistItem,
+		verifyLocalDataContext,
 		wasLastUpdateOlderThanXSeconds,
 	}
 }

package/src/index.js

@@ -27,6 +27,10 @@ import {
 	recordWatchSession
 } from './services/contentProgress.js';
 
+import {
+	verifyLocalDataContext
+} from './services/dataContext.js';
+
 import {
 	setLastUpdatedTime,
 	wasLastUpdateOlderThanXSeconds
@@ -257,5 +261,6 @@ export {
 	unpinPlaylist,
 	updatePlaylist,
 	updatePlaylistItem,
+	verifyLocalDataContext,
 	wasLastUpdateOlderThanXSeconds,
 };

package/src/services/dataContext.js

@@ -13,6 +13,23 @@ export const ContentProgressVersionKey = 1
 
 let cache = null
 
+/**
+ * Verify current cached data is on the correct version
+ *
+ * @param {int} dataVersionKey - Data version key from the back end
+ * @param {int} currentVersion - Current version of the data on the back end
+ * */
+export async function verifyLocalDataContext(dataVersionKey, currentVersion) {
+  const tempContext = new DataContext(dataVersionKey, null)
+  await tempContext.ensureLocalContextLoaded()
+
+  if (currentVersion !== tempContext.version()) {
+    tempContext.clearCache()
+  } else {
+    tempContext.setLastUpdatedTime()
+  }
+}
+
 export class DataContext {
   context = null
   dataPromise = null
@@ -33,7 +50,7 @@ export class DataContext {
 
   async getDataPromise() {
     await this.ensureLocalContextLoaded()
-    const shouldVerify = await this.shouldVerifyServerVerions()
+    const shouldVerify = await this.shouldVerifyServerVersions()
 
     if (!this.context || shouldVerify) {
       let version = this.version()
@@ -42,7 +59,7 @@ export class DataContext {
         this.context = data
         cache.setItem(this.localStorageKey, JSON.stringify(data))
       }
-      cache.setItem(this.localStorageLastUpdatedKey, new Date().getTime()?.toString())
+      this.setLastUpdatedTime()
     }
     this.dataPromise = null
     return this.context.data
@@ -73,11 +90,11 @@ export class DataContext {
     }
   }
 
-  async shouldVerifyServerVerions() {
+  async shouldVerifyServerVersions() {
     let lastUpdated = globalConfig.isMA
       ? await cache.getItem(this.localStorageLastUpdatedKey)
       : cache.getItem(this.localStorageLastUpdatedKey)
-    if (!lastUpdated) return false
+    if (!lastUpdated) return true
     const verifyServerTime = 10000 //10 s
     return new Date().getTime() - lastUpdated > verifyServerTime
   }
@@ -92,6 +109,10 @@ export class DataContext {
     this.context = null
   }
 
+  setLastUpdatedTime() {
+    cache.setItem(this.localStorageLastUpdatedKey, new Date().getTime().toString())
+  }
+
   async update(localUpdateFunction, serverUpdateFunction) {
     await this.ensureLocalContextLoaded()
     if (this.context) {
@@ -99,7 +120,7 @@ export class DataContext {
       if (this.context) this.context.version++
       let data = JSON.stringify(this.context)
       cache.setItem(this.localStorageKey, data)
-      cache.setItem(this.localStorageLastUpdatedKey, new Date().getTime().toString())
+      this.setLastUpdatedTime()
     }
     const updatePromise = serverUpdateFunction()
     updatePromise.then((response) => {

package/test/dataContext.test.js

@@ -0,0 +1,38 @@
+import { initializeTestService } from './initializeTests'
+import { DataContext, verifyLocalDataContext } from '../src/services/dataContext.js'
+
+describe('dataContext', function () {
+  let mock = null
+  let testVersion = 1
+  const dataVersionKey = 1
+  const dataContext = new DataContext(dataVersionKey, null)
+
+  beforeEach(() => {
+    initializeTestService()
+    mock = jest.spyOn(dataContext, 'fetchData')
+    mock.mockImplementation(() =>
+      JSON.parse(`{"version":${testVersion},"data":[308516,308515,308514,308518]}`)
+    )
+  })
+
+  test('verifyLocalData', async () => {
+    //force load data into context and verify version 1 loaded
+    await dataContext.getData()
+    expect(dataContext.version()).toBe(1)
+
+    //increment source version and verify data context still uses old version
+    testVersion++
+    await dataContext.getData()
+    expect(dataContext.version()).toBe(1)
+
+    //verifyLocalData with old source version and verify context still uses old version
+    await verifyLocalDataContext(1, 1)
+    await dataContext.getData()
+    expect(dataContext.version()).toBe(1)
+
+    //verifyLocalData with new source version and verify context loads new version
+    await verifyLocalDataContext(1, 2)
+    await dataContext.getData()
+    expect(dataContext.version()).toBe(2)
+  })
+})