Skip to content

Support 3rd party modules using both ESM and CommonJS #2946

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
buxxi wants to merge 3 commits into from
Closed

Support 3rd party modules using both ESM and CommonJS #2946

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b620175
Support having the node_helpers being ESM modules
buxxi Oct 16, 2022
46446e0
revert some changes to make the minimal amount needed
buxxi Oct 16, 2022
9e6ef3a
Use a different loader method for commonjs and esm
buxxi Oct 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 57 additions & 29 deletions js/app.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,38 +113,30 @@ function App() {
moduleFolder = `${__dirname}/../modules/default/${module}`;
}

const helperPath = `${moduleFolder}/node_helper.js`;

let loadHelper = true;
try {
fs.accessSync(helperPath, fs.R_OK);
} catch (e) {
loadHelper = false;
Log.log(`No helper found for module: ${moduleName}.`);
}

if (loadHelper) {
const Module = require(helperPath);
let m = new Module();

if (m.requiresVersion) {
Log.log(`Check MagicMirror² version for node helper '${moduleName}' - Minimum version: ${m.requiresVersion} - Current version: ${global.version}`);
if (cmpVersions(global.version, m.requiresVersion) >= 0) {
Log.log("Version is ok!");
} else {
Log.warn(`Version is incorrect. Skip module: '${moduleName}'`);
return;
resolveHelperLoader(moduleFolder)
.then(function (ModuleHelper) {
let m = new ModuleHelper();

if (m.requiresVersion) {
Log.log(`Check MagicMirror² version for node helper '${moduleName}' - Minimum version: ${m.requiresVersion} - Current version: ${global.version}`);
if (cmpVersions(global.version, m.requiresVersion) >= 0) {
Log.log("Version is ok!");
} else {
Log.warn(`Version is incorrect. Skip module: '${moduleName}'`);
return;
}
}
}

m.setName(moduleName);
m.setPath(path.resolve(moduleFolder));
nodeHelpers.push(m);
m.setName(moduleName);
m.setPath(path.resolve(moduleFolder));
nodeHelpers.push(m);

m.loaded(callback);
} else {
callback();
}
m.loaded(callback);
})
.catch(function (err) {
Log.log(`No helper found for module: ${moduleName}.`);
callback();
});
}

/**
Expand Down Expand Up @@ -200,6 +192,42 @@ function App() {
return segmentsA.length - segmentsB.length;
}

/**
* Resolves a loader for the node_helper using either CommonJS or ESM depending on the file extension
*
* @param {string} moduleFolder the folder that should contain the node_helper
* @returns {Promise} a promise that contains the loaded module
*/
function resolveHelperLoader(moduleFolder) {
const loaders = {
js: commonJSHelperLoader,
mjs: ESMHelperLoader
};

for (const extension in loaders) {
const helperPath = `${moduleFolder}/node_helper.${extension}`;

try {
fs.accessSync(helperPath, fs.R_OK);

return loaders[extension](helperPath);
} catch (e) {
// The current extension may not have been found, try the next instead
}
}

return Promise.reject();
}

async function commonJSHelperLoader(helperPath) {
return require(helperPath);
}

async function ESMHelperLoader(helperPath) {
let module = await import(helperPath);
return module.default;
}

/**
* Start the core app.
*
Expand Down