Merge pull request #11 from udzuki/feat-10-lrs-api

feat: 機関ごとのLRSをLearning LockerのREST APIから取得

Author: savvan0h

README.adoc

@@ -2,8 +2,8 @@
 :lang: ja
 :source-highlighter: rouge
 :author: 国立情報学研究所
-:revdate: 2022年1月20日
-:revnumber: 3.0.0版
+:revdate: 2022年1月31日
+:revnumber: 3.1-SNAPSHOT版
 :doctype: book
 :version-label:
 :chapter-label:
@@ -150,14 +150,12 @@ image::learninglocker/new-xapi-store-client.png[align=center]
 ----
 const config = {
 …
-  LRS:{
+  LRS: {
     ...
-    clients:{
-      // LRS client
-      'default':{
-        user:'<xapi-store-client-key>', // <1>
-        pass:'<xapi-store-client-secret>' // <1>
-      },
+    client: {
+      key: '<xapi-store-client-key>', // <1>
+      secret: '<xapi-store-client-secret>' // <1>
+    },
 …
 ----
 <1> <<learninglocker_client_settings>>で確認したLRSのクライアント情報を設定

moodle_video_logs/README.adoc

@@ -3,7 +3,7 @@
 :source-highlighter: rouge
 :author: 国立情報学研究所
 :revdate: 2021年7月29日
-:revnumber: 3.0.0版
+:revnumber: 3.1-SNAPSHOT版
 :doctype: book
 :version-label:
 :chapter-label:

moodle_video_logs/STATEMENT_SPEC.adoc

@@ -3,7 +3,7 @@
 :source-highlighter: rouge
 :author: 国立情報学研究所
 :revdate: 2021年7月29日
-:revnumber: 3.0.0版
+:revnumber: 3.1-SNAPSHOT版
 :doctype: book
 :version-label:
 :chapter-label:

xapi_stmt_gen/Dockerfile

@@ -1,6 +1,6 @@
 FROM node:12.22.0
 
-LABEL version="2.6.0"
+LABEL version="2.7.0"
 
 WORKDIR /usr/local/src
 RUN mkdir xapi_stmt_gen

xapi_stmt_gen/xapi_stmt_gen/config/app.js

@@ -1,64 +1,48 @@
 const config = {
+  url: 'http://learninglocker',
   limit: 500,
   chunkSize: 100,
-  db:{
+  db: {
     // LMS database connection settings
-    lms:{
-      host:'moodle-docker_db_1',
-      port:5432,
-      database:'moodle',
-      username:'moodleuser',
-      password:'m@0dl3ing',
-      prefix:'mdl_'
+    lms: {
+      host: 'moodle-docker_db_1',
+      port: 5432,
+      database: 'moodle',
+      username: 'moodleuser',
+      password: 'm@0dl3ing',
+      prefix: 'mdl_'
     },
-    la:{
-      host:'learning_analytics_db',
-      port:5432,
-      database:'learning_analytics',
-      username:'learning_analytics',
-      password:'learning_analytics',
+    la: {
+      host: 'learning_analytics_db',
+      port: 5432,
+      database: 'learning_analytics',
+      username: 'learning_analytics',
+      password: 'learning_analytics',
     }
   },
-  LRS:{
-    url:'http://learninglocker:8081/data/xAPI/',
-    clients:{
-      // LRS client
-      'default':{
-        user:'031eb8dccd9729d6a8a16d245b4d1dddf1e2ded7',
-        pass:'a94fd8e44662fe7cd50cd53812dad84a4a81ab9b'
-      },
-      /**
-       * This 'scoped' setting can be used to send
-       * statements to separated LRSes based on ePPN in GakuNin.
-       */
-      //'scoped':[
-      //  {
-      //    scope:'foo.co.jp',
-      //    user:'dc052567a686bb93a7e2fb9547ed6f6974171e8b',
-      //    pass:'b0a3f0e04294c258cb3ce8bdbb55d24c6bad15f8'
-      //  },
-      //  {
-      //    scope:'bar.ac.jp',
-      //    user:'74abe7278e28aef9b5548d90700ee423e36c1fbb',
-      //    pass:'8a34c7f8433d51ede87f533afe672d6e357c8d37'
-      //  }
-      //]
-    }
+  LRS: {
+    // LRS client with 'Overall Scopes: API All' checked
+    client: {
+      key: '',
+      secret: ''
+    },
+    // Store statements in each LRS with title matching actor's ePPN scope
+    ePPNScoped: false,
   },
-  category:{
-    id:'http://moodle.org',
-    definition:{
-      type:'http://id.tincanapi.com/activitytype/source',
-      name:'Moodle',
+  category: {
+    id: 'http://moodle.org',
+    definition: {
+      type: 'http://id.tincanapi.com/activitytype/source',
+      name: 'Moodle',
       description:
         'Moodle is a open source learning platform designed to ' +
         'provide educators, administrators and learners with ' +
         'a single robust, secure and integrated system to create ' +
         'personalized learning environments.'
     }
   },
-  platform:'Moodle',
-  language:'en',
+  platform: 'Moodle',
+  language: 'en',
   homepage: 'http://localhost:8000'
 };
 module.exports = config;

xapi_stmt_gen/xapi_stmt_gen/generator.js

@@ -1007,7 +1007,7 @@ axios.defaults.httpAgent = new http.Agent({
 async function sendStatements(statements, lrs) {
   return axios({
     'method': 'POST',
-    'url': lrs.url + 'statements',
+    'url': `${config.url}:8081/data/xAPI/statements`,
     'auth': lrs.auth,
     'headers': {
       'Content-Type': 'application/json',
@@ -1017,42 +1017,48 @@ async function sendStatements(statements, lrs) {
   });
 }
 
-/**
- * Checks if LRSes are scoped.
- */
-function isScoped() {
-  if ('scoped' in config.LRS.clients) {
-    return true;
-  }
-  return false;
-}
+let LRS_CLIENTS;
 
 /**
- * Returns LRS settings found by scope.
+ * Returns LRS clients.
  */
-function getLRS(scope) {
-  let lrses = {};
-  if ('default' in config.LRS.clients) {
-    lrses['default'] = {
-      'url':config.LRS.url,
-      'auth':{
-        'username':config.LRS.clients.default.user,
-        'password':config.LRS.clients.default.pass
-      },
-    };
-  }
-  if ('scoped' in config.LRS.clients) {
-    config.LRS.clients.scoped.forEach(client => {
-      lrses[client.scope] = {
-        'url':config.LRS.url,
-        'auth':{
-          'username':client.user,
-          'password':client.pass
-        },
-      };
-    });
+async function getLRSClients() {
+  if (!(config.LRS.client.key && config.LRS.client.secret)) {
+    process.exitCode = 1;
+    throw new Error('Specify LRS client in config/app.js');
   }
-  return lrses[scope];
+  const clientResponse = await axios.get(`${config.url}:3000/api/v2/client`, {
+    'auth': {
+      'username':config.LRS.client.key,
+      'password':config.LRS.client.secret
+    }
+  }).catch(err => {
+    process.exitCode = 1;
+    throw new Error(`Failed to get LRS clients - ${err}`);
+  });
+  const lrsResponse = await axios.get(`${config.url}:3000/api/v2/lrs`, {
+    'auth': {
+      'username':config.LRS.client.key,
+      'password':config.LRS.client.secret
+    }
+  }).catch(err => {
+    process.exitCode = 1;
+    throw new Error(`Failed to get LRSes - ${err}`);
+  });
+  let clients = {}
+  lrsResponse.data.forEach((lrs) => {
+    const client = clientResponse.data.find(c => c.lrs_id === lrs._id)
+    const key = client.api.basic_key
+    const secret = client.api.basic_secret
+    const scope = (key === config.LRS.client.key && secret === config.LRS.client.secret) ? 'default' : lrs.title
+    clients[scope] = {
+      'auth': {
+        'username': key,
+        'password': secret
+      }
+    };
+  });
+  return clients;
 }
 
 /**
@@ -1069,11 +1075,10 @@ async function routeStatements(objecttable, xapis){
     const statements = xapis[scope].map((value, index, array) => {
       return value.statement;
     });
-    const lrs = getLRS(scope);
+    const lrs = LRS_CLIENTS[scope];
     const seq = objectids[0];
     logger.info(
-      `[SEQ:${seq}][SCOPE:${scope}] Sending ${statements.length} statements ` +
-      `to ${config.LRS.url}statements...`
+      `[SEQ:${seq}][SCOPE:${scope}] Sending ${statements.length} statements...`
     );
     const promise = sendStatements(statements, lrs).then(() => {
       logger.info(`[SEQ:${seq}][SCOPE:${scope}] ${statements.length} statements added.`);
@@ -1112,15 +1117,15 @@ function getScopeFromEppn(username) {
  */
 function getLRSScope(userAttrs, userid) {
   let scope = 'default';
-  if (isScoped()) {
+  if (config.LRS.ePPNScoped) {
     scope = userid in userAttrs ? userAttrs[userid].scope : null;
     if (!scope) {
       logger.trace(
         `The user(id:${userid}) doesn't have ` +
         'an ePPN scope, sending the statement to the default LRS.'
       );
       scope = 'default';
-    } else if (!getLRS(scope)) {
+    } else if (!LRS_CLIENTS[scope]) {
       logger.trace(
         `LRS for ${scope} not found, ` +
         'sending the statement to the default LRS.'
@@ -3420,6 +3425,7 @@ async function translateStandardLogs(logs, userAttrs, courseNames){ // eslint-di
         );
         continue;
     }
+
     const scope = getLRSScope(userAttrs, log.userid);
     if (!(scope in xapis)) {
       xapis[scope] = [];
@@ -3686,10 +3692,7 @@ const waitForInterval = () => {
  * Processes logs until no more data exists.
  */
 module.exports = async function main() { // eslint-disable-line max-statements
-  if (!('default' in config.LRS.clients) && !('scoped' in config.LRS.clients)) {
-    process.exitCode = 1;
-    throw new Error('Specify LRS clients in config/app.js');
-  }
+  LRS_CLIENTS = await getLRSClients();
 
   // Retrieve all users
   const users = await USER.findAll({