musora-content-services 1.0.171 → 1.0.173

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.0.173](https://github.com/railroadmedia/musora-content-services/compare/v1.0.172...v1.0.173) (2024-11-14)
+
+### [1.0.172](https://github.com/railroadmedia/musora-content-services/compare/v1.0.171...v1.0.172) (2024-11-13)
+
 ### [1.0.171](https://github.com/railroadmedia/musora-content-services/compare/v1.0.170...v1.0.171) (2024-11-12)
 
 ### [1.0.170](https://github.com/railroadmedia/musora-content-services/compare/v1.0.169...v1.0.170) (2024-11-12)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "musora-content-services",
-  "version": "1.0.171",
+  "version": "1.0.173",
   "description": "A package for Musoras content services ",
   "main": "src/index.js",
   "scripts": {

package/src/index.d.ts

@@ -12,6 +12,8 @@ import {
 } from './services/contentLikes.js';
 
 import {
+	assignmentStatusCompleted,
+	assignmentStatusReset,
 	contentStatusCompleted,
 	contentStatusReset,
 	getAllCompleted,
@@ -77,6 +79,7 @@ import {
 	fetchAllSongs,
 	fetchArtistLessons,
 	fetchArtists,
+	fetchAssignments,
 	fetchByRailContentId,
 	fetchByRailContentIds,
 	fetchByReference,
@@ -129,6 +132,8 @@ import {
 declare module 'musora-content-services' {
 	export {
 		addItemToPlaylist,
+		assignmentStatusCompleted,
+		assignmentStatusReset,
 		contentStatusCompleted,
 		contentStatusReset,
 		countAssignmentsAndLessons,
@@ -144,6 +149,7 @@ declare module 'musora-content-services' {
 		fetchAllSongs,
 		fetchArtistLessons,
 		fetchArtists,
+		fetchAssignments,
 		fetchByRailContentId,
 		fetchByRailContentIds,
 		fetchByReference,

package/src/index.js

@@ -12,6 +12,8 @@ import {
 } from './services/contentLikes.js';
 
 import {
+	assignmentStatusCompleted,
+	assignmentStatusReset,
 	contentStatusCompleted,
 	contentStatusReset,
 	getAllCompleted,
@@ -77,6 +79,7 @@ import {
 	fetchAllSongs,
 	fetchArtistLessons,
 	fetchArtists,
+	fetchAssignments,
 	fetchByRailContentId,
 	fetchByRailContentIds,
 	fetchByReference,
@@ -128,6 +131,8 @@ import {
 
 export {
 	addItemToPlaylist,
+	assignmentStatusCompleted,
+	assignmentStatusReset,
 	contentStatusCompleted,
 	contentStatusReset,
 	countAssignmentsAndLessons,
@@ -143,6 +148,7 @@ export {
 	fetchAllSongs,
 	fetchArtistLessons,
 	fetchArtists,
+	fetchAssignments,
 	fetchByRailContentId,
 	fetchByRailContentIds,
 	fetchByReference,

package/src/services/contentProgress.js

@@ -5,7 +5,7 @@ import {
     postRecordWatchSession
 } from "./railcontent";
 import {DataContext, ContentProgressVersionKey} from "./dataContext";
-import {fetchHierarchy} from "./sanity";
+import {fetchAssignments, fetchHierarchy} from "./sanity";
 
 const STATE_STARTED = 'started';
 const STATE_COMPLETED = 'completed';
@@ -86,44 +86,105 @@ export async function getResumeTimeSeconds(contentId) {
     return data[contentId]?.[DATA_KEY_RESUME_TIME] ?? 0;
 }
 
+export async function assignmentStatusCompleted(assignmentId, parentContentId) {
+    await dataContext.update(
+        async function (localContext) {
+            let hierarchy = await fetchHierarchy(parentContentId);
+            completeStatusInLocalContext(localContext, assignmentId, hierarchy);
+        },
+        async function () {
+            return postContentCompleted(assignmentId);
+        });
+}
+
 export async function contentStatusCompleted(contentId) {
     await dataContext.update(
         async function (localContext) {
             let hierarchy = await fetchHierarchy(contentId);
-            completeStatusInLocalContext(contentId, localContext, hierarchy);
+            completeStatusInLocalContext(localContext, contentId, hierarchy);
         },
         async function () {
             return postContentCompleted(contentId);
         });
 }
 
-function completeStatusInLocalContext(contentId, localContext, hierarchy) {
+
+function saveContentProgress(localContext, contentId, progress, currentSeconds, hierarchy) {
+    if (progress === 100) {
+        completeStatusInLocalContext(localContext, contentId, hierarchy);
+        return;
+    }
+
+    let data = localContext.data[contentId] ?? {};
+    data[DATA_KEY_PROGRESS] = progress;
+    data[DATA_KEY_STATUS] = STATE_STARTED;
+    data[DATA_KEY_RESUME_TIME] = currentSeconds;
+    data[DATA_KEY_LAST_UPDATED_TIME] = Math.round(new Date().getTime() / 1000);
+    localContext.data[contentId] = data;
+
+    bubbleProgress(hierarchy, contentId, localContext);
+}
+
+function completeStatusInLocalContext(localContext, contentId, hierarchy) {
     let data = localContext.data[contentId] ?? {};
-    data[DATA_KEY_STATUS] = STATE_COMPLETED;
     data[DATA_KEY_PROGRESS] = 100;
+    data[DATA_KEY_STATUS] = STATE_COMPLETED;
     data[DATA_KEY_LAST_UPDATED_TIME] = Math.round(new Date().getTime() / 1000);
     localContext.data[contentId] = data;
 
+    if (!hierarchy) return;
     let children = hierarchy.children[contentId] ?? [];
     for (let i = 0; i < children.length; i++) {
         let childId = children[i];
-        completeStatusInLocalContext(childId, localContext, hierarchy);
+        completeStatusInLocalContext(localContext, childId, hierarchy);
     }
+    bubbleProgress(hierarchy, contentId, localContext);
+}
+
+function getChildrenToDepth(parentId, hierarchy, depth = 1) {
+    let childIds = hierarchy.children[parentId] ?? [];
+    let allChildrenIds = childIds;
+    childIds.forEach(id => {
+        allChildrenIds = allChildrenIds.concat(getChildrenToDepth(id, hierarchy, depth - 1));
+    })
+    return allChildrenIds;
+}
+
+
+export async function assignmentStatusReset(assignmentId, contentId) {
+    await dataContext.update(
+        async function (localContext) {
+            let hierarchy = await fetchHierarchy(contentId);
+            resetStatusInLocalContext(localContext, assignmentId, hierarchy);
+        },
+        async function () {
+            return postContentReset(contentId);
+        });
 }
 
 export async function contentStatusReset(contentId) {
     await dataContext.update(
-        function (localContext) {
-            const index = Object.keys(localContext.data).indexOf(contentId.toString());
-            if (index > -1) { // only splice array when item is found
-                delete localContext.data[contentId];
-            }
+        async function (localContext) {
+            let hierarchy = await fetchHierarchy(contentId);
+            resetStatusInLocalContext(localContext, contentId, hierarchy);
         },
         async function () {
             return postContentReset(contentId);
         });
 }
 
+function resetStatusInLocalContext(localContext, contentId, hierarchy) {
+    let allChildIds = getChildrenToDepth(contentId, hierarchy, 5);
+    allChildIds.push(contentId);
+    allChildIds.forEach(id => {
+        const index = Object.keys(localContext.data).indexOf(id.toString());
+        if (index > -1) { // only splice array when item is found
+            delete localContext.data[id];
+        }
+    });
+    bubbleProgress(hierarchy, contentId, localContext);
+}
+
 /**
  * Record watch session
  * @return {string} sessionId - provide in future calls to update progress
@@ -144,23 +205,12 @@ export async function recordWatchSession(contentId, mediaType, mediaCategory, me
     await dataContext.update(
         async function (localContext) {
             if (contentId && updateLocalProgress) {
-                let data = localContext.data[contentId] ?? {};
-                let progress = data?.[DATA_KEY_PROGRESS] ?? 0;
-                let status = data?.[DATA_KEY_STATUS] ?? 0;
-
-                if (status !== STATE_COMPLETED && progress !== 100) {
-                    status = STATE_STARTED;
-                    progress = Math.min(99, Math.round(currentSeconds ?? 0 / Math.max(1, mediaLengthSeconds ?? 0) * 100));
+                if (mediaLengthSeconds <= 0) {
+                    return;
                 }
-
-                data[DATA_KEY_PROGRESS] = progress;
-                data[DATA_KEY_STATUS] = status;
-                data[DATA_KEY_RESUME_TIME] = currentSeconds;
-                data[DATA_KEY_LAST_UPDATED_TIME] = Math.round(new Date().getTime() / 1000);
-                localContext.data[contentId] = data;
-
+                let progress = Math.min(99, Math.round(currentSeconds ?? 0 / Math.max(1, mediaLengthSeconds ?? 0) * 100));
                 let hierarchy = await fetchHierarchy(contentId);
-                bubbleProgress(hierarchy, contentId, localContext);
+                saveContentProgress(localContext, contentId, progress, currentSeconds, hierarchy);
             }
         },
         async function () {
@@ -196,16 +246,13 @@ function bubbleProgress(hierarchy, contentId, localContext) {
     let parentId = hierarchy.parents[contentId];
     if (!parentId) return;
     let data = localContext.data[parentId] ?? {};
-    let progress = data[DATA_KEY_PROGRESS];
-    let status = data[DATA_KEY_STATUS];
-    if (status !== STATE_COMPLETED && progress !== 100) {
-        let childProgress = hierarchy.children[parentId].map(function (childId) {
-            return localContext.data[childId]?.[DATA_KEY_PROGRESS] ?? 0;
-        });
-        progress = Math.round(childProgress.reduce((a, b) => a + b, 0) / childProgress.length);
-        data[DATA_KEY_PROGRESS] = progress;
-        localContext.data[parentId] = data;
-    }
+    let childProgress = hierarchy.children[parentId].map(function (childId) {
+        return localContext.data[childId]?.[DATA_KEY_PROGRESS] ?? 0;
+    });
+    let progress = Math.round(childProgress.reduce((a, b) => a + b, 0) / childProgress.length);
+    data[DATA_KEY_PROGRESS] = progress;
+    data[DATA_KEY_STATUS] = progress === 100 ? STATE_COMPLETED : STATE_STARTED;
+    localContext.data[parentId] = data;
     bubbleProgress(hierarchy, parentId, localContext);
 }
 

package/src/services/dataContext.js

@@ -46,7 +46,7 @@ export class DataContext {
     async ensureLocalContextLoaded() {
         if (this.context) return;
         this.verifyConfig();
-        let localData = globalConfig.isMA ? await cache.getItem(this.localStorageKey): cache.getItem(this.localStorageKey) ;
+        let localData = globalConfig.isMA ? await cache.getItem(this.localStorageKey) : cache.getItem(this.localStorageKey);
         if (localData) {
             this.context = JSON.parse(localData);
         }
@@ -85,10 +85,13 @@ export class DataContext {
             cache.setItem(this.localStorageKey, data);
             cache.setItem(this.localStorageLastUpdatedKey, new Date().getTime().toString());
         }
-        let response = await serverUpdateFunction();
-        if (response?.version !== this.version()) {
-            this.clearCache();
-        }
+        const updatePromise = serverUpdateFunction();
+        updatePromise.then((response) => {
+            if (response?.version !== this.version()) {
+                this.clearCache();
+            }
+        });
+        return updatePromise;
     }
 
     version() {

package/src/services/sanity.js

@@ -1399,18 +1399,22 @@ export async function fetchHierarchy(railcontentId) {
     let topLevelId = await fetchTopLevelParentId(railcontentId);
     const query = `*[railcontent_id == ${topLevelId}]{
       railcontent_id,
+      'assignments': assignment[]{railcontent_id},
       'children': child[]->{
         railcontent_id,
+        'assignments': assignment[]{railcontent_id},
         'children': child[]->{
             railcontent_id,
+            'assignments': assignment[]{railcontent_id},
             'children': child[]->{
                railcontent_id,
+               'assignments': assignment[]{railcontent_id},
                'children': child[]->{
-                  railcontent_id,               
+                  railcontent_id,                
             } 
           }
         }
-      }
+      },
     }`;
     let response = await fetchSanity(query, false, {processNeedAccess: false});
     if (!response) return null;
@@ -1422,9 +1426,11 @@ export async function fetchHierarchy(railcontentId) {
     return data;
 }
 
+
 function populateHierarchyLookups(currentLevel, data, parentId) {
     let contentId = currentLevel['railcontent_id'];
     let children = currentLevel['children'];
+
     data.parents[contentId] = parentId;
     if (children) {
         data.children[contentId] = children.map(child => child['railcontent_id']);
@@ -1434,6 +1440,36 @@ function populateHierarchyLookups(currentLevel, data, parentId) {
     } else {
         data.children[contentId] = [];
     }
+
+    let assignments = currentLevel['assignments'];
+    if (assignments) {
+        let assignmentIds = assignments.map(assignment => assignment['railcontent_id']);
+        data.children[contentId] = (data.children[contentId] ?? []).concat(assignmentIds);
+        assignmentIds.forEach(assignmentId => {
+            data.parents[assignmentId] = contentId;
+        });
+    }
+
+}
+
+/**
+ * Fetch assignments for content
+ *
+ * @param {integer} contentId - List of ids get data for
+ * @returns {Promise<array|null>} - A promise that resolves to an array containing the data
+ */
+export async function fetchAssignments(contentId) {
+    const fields = `"id": railcontent_id,"assignments":assignment[]{"id": railcontent_id}`;
+    const query = await buildQuery(`railcontent_id == ${contentId}`,
+        {bypassPermissions: true},
+        fields,
+        {end: 100});
+    let data = await fetchSanity(query, false);
+    let mapped = [];
+    data.assignments.forEach(function (content) {
+        mapped.push(content.id);
+    });
+    return mapped;
 }
 
 /**
@@ -1448,7 +1484,7 @@ export async function fetchCommentModContentData(ids) {
     const query = await buildQuery(`railcontent_id in [${idsString}]`,
         {bypassPermissions: true},
         fields,
-        {end:50});
+        {end: 50});
     let data = await fetchSanity(query, true);
     let mapped = {};
     data.forEach(function (content) {

package/test/contentProgress.test.js

@@ -7,7 +7,7 @@ import {
     getProgressStateByIds,
     getAllStarted,
     getAllCompleted,
-    contentStatusCompleted
+    contentStatusCompleted, assignmentStatusCompleted, contentStatusReset, assignmentStatusReset
 } from "../src/services/contentProgress";
 import {initializeTestService} from "./initializeTests";
 import {postContentCompleted} from "../src";
@@ -17,12 +17,23 @@ const railContentModule = require('../src/services/railcontent.js')
 describe('contentProgressDataContext', function () {
     let mock = null;
     const testVersion = 1;
+    let serverVersion = 2;
 
     beforeEach(() => {
         initializeTestService();
         mock = jest.spyOn(dataContext, 'fetchData');
         var json = JSON.parse(`{"version":${testVersion},"config":{"key":1,"enabled":1,"checkInterval":1,"refreshInterval":2},"data":{"234191":{"s":"started","p":6,"t":20,"u":1731108082},"233955":{"s":"started","p":1,"u":1731108083},"259426":{"s":"completed","p":100,"u":1731108085}}}`);
-        mock.mockImplementation(() => json);
+        mock.mockImplementation(() =>
+            json);
+
+        let mock2 = jest.spyOn(railContentModule, 'postRecordWatchSession');
+        mock2.mockImplementation(() => JSON.parse(`{"version": ${serverVersion}}`));
+
+        let mock3 = jest.spyOn(railContentModule, 'postContentCompleted');
+        mock3.mockImplementation(() => JSON.parse(`{"version": ${serverVersion}}`));
+
+        let mock4 = jest.spyOn(railContentModule, 'postContentReset');
+        mock4.mockImplementation(() => JSON.parse(`{"version": ${serverVersion}}`));
     });
 
     test('getProgressPercentage', async () => {
@@ -72,11 +83,6 @@ describe('contentProgressDataContext', function () {
     //     expect(result2).toStrictEqual([111111, 233955, 234191]);
     // });
 
-    test('getAllCompleted', async () => {
-        let result = await getAllCompleted();
-        expect(result).toStrictEqual([259426]);
-    });
-
     // test('getAllCompletedWithUpdate', async () => {
     //     let mock2 = jest.spyOn(railContentModule, 'postContentCompleted');
     //     let serverVersion = 2;
@@ -90,9 +96,7 @@ describe('contentProgressDataContext', function () {
     // });
 
     test('progressBubbling', async () => {
-        let mock2 = jest.spyOn(railContentModule, 'postRecordWatchSession');
-        let serverVersion = 2;
-        mock2.mockImplementation(() => JSON.parse(`{"version": ${serverVersion}}`));
+
         let progress = await getProgressPercentage(241250); //force load context
 
         await recordWatchSession(241250, "video", "vimeo", 100, 50, 50);
@@ -117,4 +121,91 @@ describe('contentProgressDataContext', function () {
 
     });
 
+    test('assignmentCompleteBubbling', async () => {
+        let assignmentId = 286048;
+        let contentId = 286047;
+
+        let state = await getProgressState(contentId);
+        expect(state).toBe("");
+        let result = await assignmentStatusCompleted(assignmentId, contentId);
+
+        state = await getProgressState(assignmentId);
+        expect(state).toBe("completed");
+        state = await getProgressState(contentId); //assignment
+        expect(state).toBe("started");
+    });
+
+    // test('assignmentCompleteBubblingToCompleted', async () => {
+    //     let assignmentId = 241685;
+    //     let contentId = 241257;
+    //
+    //     let state = await getProgressState(contentId);
+    //     expect(state).toBe("");
+    //     let result = await assignmentStatusCompleted(assignmentId, contentId);
+    //
+    //     state = await getProgressState(assignmentId);
+    //     expect(state).toBe("completed");
+    //     state = await getProgressState(contentId); //assignment
+    //     expect(state).toBe("completed");
+    // });
+    //
+    // test('assignmentCompleteResetBubblingMultiple', async () => {
+    //     let contentId = 281709;
+    //
+    //     let state = await getProgressState(contentId);
+    //     expect(state).toBe("");
+    //
+    //     let assignmentIds = [281710, 281711, 281712, 281713, 281714, 281715];
+    //     for (const assignmentId of assignmentIds) {
+    //         await assignmentStatusCompleted(assignmentId, contentId);
+    //         state = await getProgressState(assignmentId);
+    //         expect(state).toBe("completed");
+    //     }
+    //
+    //     state = await getProgressState(contentId);
+    //     expect(state).toBe("completed");
+    //
+    //     await assignmentStatusReset(assignmentIds[0], contentId);
+    //     state = await getProgressState(assignmentIds[0]);
+    //     expect(state).toBe("");
+    //     state = await getProgressState(contentId);
+    //     expect(state).toBe("started");
+    //     let percentage = await getProgressPercentage(contentId);
+    //     expect(percentage).toBe(83);
+    // });
+
+
+    //
+    // test('completeBubbling', async () => {
+    //     let state = await getProgressState(276698);
+    //     expect(state).toBe("");
+    //     let result = await contentStatusCompleted(276698);
+    //
+    //     state = await getProgressState(276698);
+    //     expect(state).toBe("completed");
+    //     state = await getProgressState(276699); //assignment
+    //     expect(state).toBe("completed");
+    // });
+    //
+    // test('resetBubbling', async () => {
+    //     let assignmentId = 241686;
+    //     let contentId = 241258;
+    //
+    //     let state = await getProgressState(contentId);
+    //     expect(state).toBe("");
+    //     let result = await contentStatusCompleted(contentId);
+    //     state = await getProgressState(contentId);
+    //     expect(state).toBe("completed");
+    //     state = await getProgressState(assignmentId); //assignment
+    //     expect(state).toBe("completed");
+    //
+    //     result = await contentStatusReset(contentId);
+    //     state = await getProgressState(contentId);
+    //     expect(state).toBe("");
+    //     state = await getProgressState(assignmentId); //assignment
+    //     expect(state).toBe("");
+    //
+    // });
+
+
 });

package/test/live/contentProgressLive.test.js

@@ -2,7 +2,7 @@ import {
     recordWatchSession,
     getProgressPercentage,
     dataContext,
-    getProgressState, contentStatusCompleted, contentStatusReset
+    getProgressState, contentStatusCompleted, contentStatusReset, assignmentStatusCompleted
 } from "../../src/services/contentProgress";
 import {initializeTestService} from "../initializeTests";
 
@@ -38,6 +38,7 @@ describe('contentProgressDataContextLocal', function () {
         result = await getProgressState(contentId);
         expect(result).toBe("started");
         dataContext.clearCache();
+        await new Promise(resolve => setTimeout(resolve, 3000)); // 3 sec
 
         result = await getProgressState(contentId);
         expect(result).toBe("started");
@@ -79,6 +80,35 @@ describe('contentProgressDataContextLocal', function () {
         expect(result).toBe("");
     }, 100000);
 
+    test('assignmentCompleteBubblingToCompletedMultiple', async () => {
+        let contentId = 281709;
+        await contentStatusReset(contentId);
+
+        let state = await getProgressState(contentId);
+        expect(state).toBe("");
+
+        let assignmentIds = [281710, 281711, 281712, 281713, 281714, 281715];
+        for (const assignmentId of assignmentIds) {
+            await assignmentStatusCompleted(assignmentId, contentId);
+            state = await getProgressState(assignmentId);
+            expect(state).toBe("completed");
+        }
+
+        state = await getProgressState(contentId); //assignment
+        expect(state).toBe("completed");
+
+        dataContext.clearCache();
+
+        state = await getProgressState(contentId); //assignment
+        expect(state).toBe("completed");
+
+        for (const assignmentId of assignmentIds) {
+            state = await getProgressState(assignmentId);
+            expect(state).toBe("completed");
+        }
+
+    }, 100000);
+
 
     //
     // test('progressBubbling', async () => {

package/test/sanityQueryService.test.js

@@ -1,5 +1,5 @@
 import {getFieldsForContentType} from "../src/contentTypeConfig";
-import {fetchCommentModContentData, fetchSanity} from "../src/services/sanity";
+import {fetchAssignments, fetchCommentModContentData, fetchSanity} from "../src/services/sanity";
 import {log} from './log.js';
 import {initializeTestService} from "./initializeTests";
 
@@ -568,7 +568,7 @@ describe('Sanity Queries', function () {
         expect(hierarchy.parents[241250]).toBe(241249);
         expect(hierarchy.parents[241249]).toBe(241248);
         expect(hierarchy.parents[241248]).toBe(241247);
-        expect(hierarchy.children[241250]).toStrictEqual([]);
+        expect(hierarchy.children[241250]).toStrictEqual([241676]);
         expect(hierarchy.children[243085]).toStrictEqual([243170, 243171, 243172, 243174, 243176]);
     });
 
@@ -581,6 +581,11 @@ describe('Sanity Queries', function () {
         expect(data[241252].title).toBe("Setting Up Your Pedals & Throne");
     });
 
+    test('fetchAssignments', async()=>{
+        let data = await fetchAssignments(241250);
+        expect(data).toContain(241676);
+    });
+
 });
 
 describe('Filter Builder', function () {