Skip to content
This repository has been archived by the owner on Dec 18, 2018. It is now read-only.

Development Patron client

Jump to bottom
Petter Goksøyr Åsen edited this page May 26, 2017 · 2 revisions

Patron Client development

Setting up IntelliJ

The project uses a strict set of linting rules that may also choke on some formatting. To ensure a common style, formatting should be performed based on a standard config.

To install:

  1. Go to Preferences > Editor > Code Style > JavaScript.
  2. Click Manage next to Scheme.
  3. Choose Import, then IntelliJ IDEA code style XML, and select Standard.xml.
  4. Press OK in the next dialog.
  5. Ensure that Standard is chosen as scheme.

The editor will give a code hint anywhere where semicolons are omitted. To fix this, click on the marking and press Alt+Enter, then disable the inspection from the meny that is displayed.

By default, IntelliJ will not use the correct language standard for Patron Client. To change this:

  1. Go to Preferences > Languages & Frameworks > JavaScript.
  2. Switch JavaScript language version to React JSX.

Patron Client non-Docker development

Patron Client can de developed without any local dependencies, but it is not efficient:

  1. Restarting node with changes requires running make rebuild_patron_client.
  2. File watching (required for Hot Module Reloading (HMR)) has proven problematic for mounted volumes.

Requirements

  • node.js
  • compass (Ruby gem)

Instructions

Essential npm scripts

  • verify: Run tests and linting.
  • lint: Run linting.
  • start: Starts the project, but KOHA_API_USER and KOHA_API_PASS must be provided.
  • test:watch: Start tests and watch for code changes. Will re-run tests on code changes.
  • es5: Compile all js to es5, useful for debugging unit tests in IntelliJ. See the Debugging tests section for more information.
  • dev: Convenience script, run npm start with port 8001 and with KOHA_API_USER and KOHA_API_PASS
  • devnode: Same as above, except it only runs node without compass. Useful when a lot of node restarts are required and no style changes are performed.
  • killcompass: Will print an error, but will kill stale compass instances (might sometimes happen on ctrl+c'ing from start or dev)
  • prodbuild: Build Patron Client for production
  • production: Run Patron Client in production mode. Must have been built for production previously.

Getting started with development outside Docker

  1. Be ready for ls.ext development.
  2. Install node.js.
  3. Install compass. Ruby is required.
  4. cd to Patron Client directory
  5. Run npm install.
  6. Ensure that the machine's host file has the hosts properly set. Add this line to /etc/hosts or /private/etc/hosts depending on OS: 127.0.0.1 services xkoha koha elasticsearch patron_client koha_mysql.
  7. You are now ready to run the npm scripts. npm run dev is usually a good start.

Debugging unit tests

Since the unit tests are written with import syntax not available in node.js, transpiling is required. IntelliJ is then set to run the tests from the transpiled (ES5) code, but thanks to source maps any breakpoint in the original code will hit.

  1. Run npm run es5 to start transpiling. This is a watcher and will update any changed files.
  2. In IntelliJ, press Run > Edit Configurations.
  3. Press the + sign and choose Mocha.
  4. In the settings for the Mocha config, change the lines according to the following screenshot:

Mocha screenshot 5. The configuration can be run via Run -> Debug.

Clone this wiki locally