JS Rule - Error trying to 'require' the Axios-library


I am quite new in writing JS-rules. In general my JS-rules are working. But I would like to create a new rule using the Axios-library. The library was installed successfully (I guess).
But when I am trying to “require” the axios library with: const axios = require('axios'); I am getting the error message below.
I am using Openhabian and my openhab version is 3.4.4

Can anyone give me a hint how to solve it?

Error message:

org.graalvm.polyglot.PolyglotException: SyntaxError: /etc/openhab/automation/js/node_modules/axios/index.js:1:94 Expected an operand but found import
(function (exports, require, module, __filename, __dirname) {require=__wraprequire__(require);import axios from './lib/axios.js';
/etc/openhab/automation/js/node_modules/axios/index.js:24:0 Expected an operand but found export
export {
/etc/openhab/automation/js/node_modules/axios/index.js:25:8 Expected ; but found as
  axios as default,
/etc/openhab/automation/js/node_modules/axios/index.js:43:0 Expected ) but found }
/etc/openhab/automation/js/node_modules/axios/index.js:43:1 Expected ; but found )

OH provides a NodeJS like environment but not a fully compatible environment. And certain underlying constructs like require are actually implemented by the underlying Java, not the GraalVM JS environment. So there will definitely be many third party node modules that won’t work. I’m not surprised it has problems with export.

Everything Rich wrote is correct.
JavaScript Scripting is only a NodeJS-like environment that supports much stuff, but it has limitations compared to real NodeJS.

It seems like Axios is using ES Module Loading which is not supported by JavaScript Scripting. Even if it was supported, Axios still wouldn‘t work because the native NodeJS APIs such as node:http aren‘t available in GraalJS (at least in the mode we have to run it).
And Promise-based stuff is also not supported.

If you want to perform HTTP operations, you can use the HTTP actions (actions - Documentation).

Thanks a lot for your replies!

What I want to do is requesting the distance and required time from Google Maps between two locations like in this example:

var config = {
  method: 'get',
  url: 'https://maps.googleapis.com/maps/api/distancematrix/json?origins=40.6655101%2C-73.89188969999998&destinations=40.659569%2C-73.933783%7C40.729029%2C-73.851524%7C40.6860072%2C-73.6334271%7C40.598566%2C-73.7527626&key=YOUR_API_KEY',
  headers: { }

.then(function (response) {
.catch(function (error) {

In the axios how-to it is recommended to require the module package directly if problems occur:
const axios = require('axios/dist/node/axios.cjs');

But I am getting this error:

TypeError: Cannot load CommonJS module: 'axios/dist/node/axios.cjs'

maybe I have to use XMLHttpRequest instead…

I think you haven’t read my reply carefully …
As already said, Axios won’t work (no matter what the docs say) because it needs some type of NodeJS HTTP API which is not available in openHAB JavaScript Scripting.

And XmlHTTPRequest isn’t supported as well.

Use the HTTP actions:

var response = actions.HTTP.sendHttpGetRequest(String url);
var json = JSON.parse(response);

Hi Florian,

thanks a lot! That works and offers all I need.


1 Like