Skip to content

Latest commit

 

History

History
183 lines (124 loc) · 6.25 KB

README.md

File metadata and controls

183 lines (124 loc) · 6.25 KB
Raw

mediawiki-services-mobileapps Build Status

MediaWiki Services in Node.js for Mobile Apps. This service is a facade the mobile apps can use to improve runtime performance by

  • bundling multiple requests,
  • performing DOM manipulations once on the server instead of on the clients,
  • avoiding downloading of DOM elements that are not displayed in the apps and therefore not needed,
  • taking advantage of caching via RESTBase, and
  • taking advantage of streaming by being able to use WebView.loadUrl() instead of piping every page section by section over the JS bridge.

Furthermore this can also speed up development by

  • combining the DOM manipulation code for both apps into a single service,
  • simplifying DOM manipulation code by moving it to JavaScript,
  • flattening the JSON structure, and
  • simplifying code because now the apps can use WebView.loadUrl() instead of piping every page section by section over the JS bridge.

More improvements and more endpoints are possible. We could also consider using streaming on the service side. But I'll leave that as a later exercise.

More information can be found on the wiki.

Getting Started

Installation

First, clone the repository

git clone https://gerrit.wikimedia.org/r/mediawiki/services/mobileapps

Install the dependencies

cd mobileapps
npm install

Cassandra schema initialization

$ cqlsh -f scripts/schema/cassandra_schema.cql

Docker setup

It's also possible to engage in development with a docker setup, take a look at this guide on how to setup a docker-compose environment for mobileapps.

You are now ready to get to work!

  • Inspect/modify/configure app.js
  • Add routes by placing files in routes/ (look at the files there for examples)

You can also read the ServiceTemplateNode documentation.

Running the service

To start the server hosting the REST API, simply run (inside the repo's directory)

npm start

This starts an HTTP server listening on localhost:8888.

Endpoints

There are a few routes you may query (with a browser, or curl and friends). You can see more documentation at localhost:8888/?doc.

Page Content Service routes

Next generation routes for page content. See Page_Content_Service.

  • http://localhost:8888/{domain}/v1/page/summary/{title}
  • http://localhost:8888/{domain}/v1/page/metadata/{title}
  • http://localhost:8888/{domain}/v1/page/media/{title}
  • http://localhost:8888/{domain}/v1/page/mobile-html/{title}
  • http://localhost:8888/{domain}/v1/transform/html/to/mobile-html/{title} (POST to this for edit preview)
  • http://localhost:8888/{domain}/v1/page/mobile-html-offline-resources/{title}
  • http://localhost:8888/{domain}/v1/data/css/mobile/base
  • http://localhost:8888/{domain}/v1/data/css/mobile/pcs
  • http://localhost:8888/{domain}/v1/data/css/mobile/site
  • http://localhost:8888/{domain}/v1/data/javascript/mobile/pcs

Mobile Content Service routes

The first generation mobile content route (mainly for Android app):

  • http://localhost:8888/{domain}/v1/page/mobile-sections/{title}

  • Example: http://localhost:8888/en.wikipedia.org/v1/page/mobile-sections/Cat

There is also a endpoint for definitions from Wiktionary the Android app uses:

  • http://localhost:8888/{language code}.wiktionary.org/v1/page/definition/{title}

Example: http://localhost:8888/en.wiktionary.org/v1/page/definition/present

A list of language codes can be found here.

Generic routes

Swagger spec:

  • http://localhost:8888/?spec

Swagger UI:

  • http://localhost:8888/?doc

Info:

  • http://localhost:8888/_info

Quick prototyping using static files

You can quickly prototype some static responses by adding the wanted files to the static folder.

Example: static/proto/example1.json is available as http://localhost:8888/static/proto/example1.json.

Tests

There is also a set of executable tests. To fire them up, simply run:

npm test

If you haven't changed anything in the code (and you have a working Internet connection), you should see all the tests passing. As testing most of the code is an important aspect of service development, there is also a bundled tool reporting the percentage of code covered. Start it with:

npm run-script coverage

To just run the unit tests (faster), use:

npm run test:unit

HTTP Recording

This project takes advantage of HTTP request recording provided by the sepia library to make running the tests much faster.

To take advantage of HTTP response caching, either set an environment variable VCR_MODE=cache, or specify at the command line when running the tests:

VCR_MODE=cache npm test

After running for the first time with VCR_MODE=cache, HTTP interactions should be cached in the fixtures/ folder. The next time you run the tests, they should use the cached fixtures and run faster.

To skip the cached fixtures, run the tests with an unexpected VCR_MODE value (e.g., VCR_MODE=off) or just remove the fixtures folder and re-run.

See sepia for more documentation.

Generate JSDoc documentation

To generate JSDoc documentation locally, run this command from the root folder:

npm run build-app-docs

It will generate static html files in /docs/jsdoc directory that can be opened using file:// protocol. Also, a folder named js-pcs-notated will be created with the dev version of pcs bundle. A list of all modules and classes can be found in /docs/jsdoc/index.html.

Troubleshooting

In a lot of cases when there is an issue with node it helps to recreate the node_modules directory:

rm -r node_modules
npm install

This is highly recommended whenever dependencies change.

Go apps!

Thanks

Big thank you to our services team for providing an awesome template for this and for supporting us along the way!