Significant Events Endpoint for Article as a Living Document experiment

config.apps.yaml

@@ -86,6 +86,14 @@ services:
           user-agent: '{{user-agent}}'
           accept-language: '{{accept-language}}'
         body: '{{ default(request.query, {}) }}'
+      # the template used for contacting MW Rest API
+      mwrestapi_req:
+        method: '{{request.method}}'
+        uri: https://{{domain}}/w/rest.php/v1/{+path}
+        query: '{{ default(request.query, {}) }}'
+        headers: '{{request.headers}}'
+        body: '{{request.body}}'
+        timeout: 60000 # 60 * 1000
       # the template used for requesting ResourceLoader module content from load.php
       mw_resource_loader_req:
         method: post

config.dev.yaml

@@ -87,6 +87,14 @@ services:
           user-agent: '{{user-agent}}'
           accept-language: '{{accept-language}}'
         body: '{{ default(request.query, {}) }}'
+      # the template used for contacting MW Rest API
+      mwrestapi_req:
+        method: '{{request.method}}'
+        uri: https://{{domain}}/w/rest.php/v1/{+path}
+        query: '{{ default(request.query, {}) }}'
+        headers: '{{request.headers}}'
+        body: '{{request.body}}'
+        timeout: 60000 # 60 * 1000
       # the template used for requesting ResourceLoader module content from load.php
       mw_resource_loader_req:
         method: post

config.labs.yaml

@@ -86,6 +86,14 @@ services:
           user-agent: '{{user-agent}}'
           accept-language: '{{accept-language}}'
         body: '{{ default(request.query, {}) }}'
+      # the template used for contacting MW Rest API
+      mwrestapi_req:
+        method: '{{request.method}}'
+        uri: https://{{domain}}/w/rest.php/v1/{+path}
+        query: '{{ default(request.query, {}) }}'
+        headers: '{{request.headers}}'
+        body: '{{request.body}}'
+        timeout: 60000 # 60 * 1000
       # the template used for requesting ResourceLoader module content from load.php
       mw_resource_loader_req:
         method: post

config.prod.yaml

@@ -99,6 +99,14 @@ services:
           user-agent: '{{user-agent}}'
           accept-language: '{{accept-language}}'
         body: '{{ default(request.query, {}) }}'
+      # the template used for contacting MW Rest API
+      mwrestapi_req:
+        method: '{{request.method}}'
+        uri: https://{{domain}}/w/rest.php/v1/{+path}
+        query: '{{ default(request.query, {}) }}'
+        headers: '{{request.headers}}'
+        body: '{{request.body}}'
+        timeout: 60000 # 60 * 1000
       # the template used for requesting ResourceLoader module content from load.php
       mw_resource_loader_req:
         method: post

dist/config.yaml

@@ -68,6 +68,13 @@ services:
         headers:
           user-agent: '{{user-agent}}'
         body: '{{ default(request.query, {}) }}'
+      # the template used for contacting MW Rest API
+      mwrestapi_req:
+        method: '{{request.method}}'
+        uri: https://{{domain}}/w/rest.php/v1/{+path}
+        query: '{{ default(request.query, {}) }}'
+        headers: '{{request.headers}}'
+        body: '{{request.body}}'
       # the template used for contacting RESTBase
       restbase_req:
         method: '{{request.method}}'

lib/api-util.js

@@ -14,6 +14,46 @@ function prettyMwApiReq(request) {
     return `${request.uri}?${querystring.stringify(request.body)}`;
 }
 
+/**
+ * Calls the MW REST API with the supplied domain, path and request parameters
+ * @param {!Object} req the incoming request object
+ * @param {?string} path the REST API path to contact without the leading slash
+ * @param {?Object} [restReq={}] the object containing the REST request details
+ * @param {?string} [restReq.method=get] the request method
+ * @param {?Object} [restReq.query={}] the query string to send, if any
+ * @param {?Object} [restReq.headers={}] the request headers to send
+ * @param {?Object} [restReq.body=null] the body of the request, if any
+ * @return {!Promise} a promise resolving as the response object from the REST API
+ *
+ */
+function mwRestApiGet(req, path, restReq) {
+
+    const app = req.app;
+    if (path.constructor === Object) {
+        restReq = path;
+        path = undefined;
+    }
+    restReq = restReq || {};
+    restReq.method = restReq.method || 'get';
+    restReq.query = restReq.query || {};
+    restReq.headers = restReq.headers || {};
+    restReq.params = restReq.params || {};
+    restReq.params.path = path || restReq.params.path;
+    restReq.params.domain = restReq.params.domain || req.params.domain;
+    if (!restReq.params.path || !restReq.params.domain) {
+        return BBPromise.reject(new HTTPError({
+            status: 500,
+            type: 'internal_error',
+            title: 'Invalid internal call',
+            detail: 'domain and path need to be defined for the REST API call'
+        }));
+    }
+    restReq.params.path = restReq.params.path[0] === '/' ?
+        restReq.params.path.slice(1) : restReq.params.path;
+
+    return req.issueRequest(app.mwrestapi_tbl.expand({ request: restReq }));
+}
+
 /**
  * Make a request for ResourceLoader modules to MediaWiki's load.php entry point.
  *
@@ -229,6 +269,7 @@ function setupApiTemplates(app) {
         };
     }
     app.restbase_tpl = new Template(app.conf.restbase_req);
+    app.mwrestapi_tbl = new Template(app.conf.mwrestapi_req);
 
     // set up the MediaWiki page request template
     if (!app.conf.mw_resource_loader_req) {
@@ -240,7 +281,6 @@ function setupApiTemplates(app) {
         };
     }
     app.mw_resource_loader_tpl = new Template(app.conf.mw_resource_loader_req);
-
 }
 
 /**
@@ -277,6 +317,7 @@ function getCommonsDomain(domain) {
 module.exports = {
     // Shared with service-template-node
     mwApiGet,
+    mwRestApiGet,
     restApiGet,
     setupApiTemplates,
 

lib/mobile-util.js

@@ -26,6 +26,7 @@ mUtil.CONTENT_TYPES = {
         type: 'application/json'
     },
     talk: { name: 'Talk', version: '0.1.1', type: 'application/json' },
+    significantChanges: { name: 'SignificantChanges', version: '0.0.1', type: 'application/json' },
     mediaList: { name: 'MediaList', version: '1.1.0', type: 'application/json' },
     i18n: { name: 'i18n', version: '0.0.1', type: 'application/json' }
 };

lib/mwapi.js

@@ -127,6 +127,53 @@ mwapi.getSiteInfo = function(req) {
     return siteInfoCache[rp.domain];
 };
 
+mwapi.queryForRevisions = function(req, title, pageSize, rvStart, rvEnd) {
+    const query = apiParams({
+        action: 'query',
+        prop: 'revisions',
+        titles: title || req.params.title,
+        rvslots: 'main',
+        rvprop: 'ids|timestamp|user|userid|size|parsedcomment|comment|tags|flags|size',
+        rvdir: 'older',
+        format: 'json',
+        rvlimit: pageSize || '20'
+    });
+
+    // to get around "parameters rvstartid & rvstart cannot be used together" error
+    if (rvStart && rvEnd) {
+        query.rvstart = rvStart;
+        query.rvend = rvEnd;
+    } else if (rvEnd) {
+        query.rvend = rvEnd;
+    } else {
+        query.rvstartid = req.query.rvstartid;
+    }
+
+    return api.mwApiGet(req, query);
+};
+
+mwapi.queryForUsers = function(req, userids) {
+
+    var useridstring = '';
+    for (let i = 0; i < userids.length; i++) {
+        const userid = userids[i];
+        if (i === 0) {
+            useridstring += userid;
+        } else {
+            useridstring += `|${userid}`;
+        }
+    }
+
+    const query = apiParams({
+        action: 'query',
+        list: 'users',
+        ususerids: useridstring,
+        usprop: 'groups|editcount',
+    });
+
+    return api.mwApiGet(req, query);
+};
+
 /**
  * Given protection status for an article simplify it to allow easy reference
  *

lib/mwrestapi.js

@@ -0,0 +1,10 @@
+const api = require('./api-util');
+const mwrestapi = {};
+
+mwrestapi.queryForDiff = function(req, fromRevID, toRevID) {
+    const path = `revision/${fromRevID}/compare/${toRevID}`;
+
+    return api.mwRestApiGet(req, path);
+};
+
+module.exports = mwrestapi;