adding xAPI version to cts/player

adlnet · May 21, 2024 · afb781a · afb781a
1 parent 8baba1a
commit afb781a
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 2 deletions.
diff --git a/cts/docker-compose.yml b/cts/docker-compose.yml
@@ -70,6 +70,7 @@ services:
       - LRS_ENDPOINT
       - LRS_USERNAME
       - LRS_PASSWORD
+      - LRS_XAPI_VERSION
     networks:
       - public  
 

diff --git a/cts/service/index.js b/cts/service/index.js
@@ -117,7 +117,7 @@ const provision = async () => {
         (req) => ({
             baseUrl: LRS_ENDPOINT.endsWith("/") ? LRS_ENDPOINT : LRS_ENDPOINT + "/",
             headers: {
-                "X-Experience-API-Version": "1.0.3",
+                "X-Experience-API-Version": (process.env.LRS_XAPI_VERSION ||  "1.0.3"),
                 Authorization: `Basic ${Buffer.from(`${LRS_USERNAME}:${LRS_PASSWORD}`).toString("base64")}`
             },
             json: true

diff --git a/cts/service/plugins/routes/v1/sessions.js b/cts/service/plugins/routes/v1/sessions.js
@@ -496,6 +496,13 @@ module.exports = {
                                 options.headers["x-forwarded-host"] = options.headers["x-forwarded-host"] || req.info.host;
                             }
 
+                            // The cmi5 JS stuff won't know what the configured LRS's xAPI version is
+                            // between 1.0.3 and 2.0, so replace that here if it was specified.
+                            //
+                            let configuredXAPIVersion = process.env.LRS_XAPI_VERSION;
+                            if (configuredXAPIVersion != undefined)
+                                options.headers["x-experience-api-version"] = configuredXAPIVersion;
+
                             // Concurrency check required or xAPI 2.0
                             //
                             if (req.method == "post" || req.method == "put") {

diff --git a/player/docker-compose.yml b/player/docker-compose.yml
@@ -35,6 +35,7 @@ services:
       - LRS_ENDPOINT
       - LRS_USERNAME
       - LRS_PASSWORD
+      - LRS_XAPI_VERSIONs
       - DATABASE_USER=catapult
       - DATABASE_USER_PASSWORD=quartz
       - DATABASE_NAME=catapult_player

diff --git a/player/service/plugins/routes/lrs.js b/player/service/plugins/routes/lrs.js
@@ -736,7 +736,13 @@ module.exports = {
                             options.headers["x-forwarded-host"] = options.headers["x-forwarded-host"] || req.info.host;
                         }
 
-                        // console.error(uri, options);
+
+                        // The cmi5 JS stuff won't know what the configured LRS's xAPI version is
+                        // between 1.0.3 and 2.0, so replace that here if it was specified.
+                        //
+                        let configuredXAPIVersion = process.env.LRS_XAPI_VERSION;
+                        if (configuredXAPIVersion != undefined)
+                            options.headers["x-experience-api-version"] = configuredXAPIVersion;
 
                         let lrsResourcePath = req.params.resource;