mirror of
https://github.com/MichMich/MagicMirror.git
synced 2026-06-03 18:00:33 +00:00
d4a5ebe273
With these changes a few browser-side core files now use native ES modules. `Loader`, `MMSocket`, `Module` and `MM` can be imported directly instead of being read off `window`. `main.js` and `loader.js` are no longer wrapped in IIFEs - they're just normal modules now. `Module`, `MM` and `MMSocket` are still exposed as globals, so third-party modules that use the old API keep working. The changes are mostly structural, behavior should stay the same. A few internal helpers in `main.js` got an underscore prefix because their names clashed with public `MM` methods. ## Why The old setup relied a lot on script order: a file could use `Loader` or `MMSocket` only because another script happened to put it on `window` first. Imports make that explicit. The bigger goal is to move away from the legacy script-loading patterns - making it easier to understand and easier to test - in other words: easier to maintain. More of the core could be "cleaned up" the same way, but that would blow up this PR. For reviewing, I recommend to hide the whitespace changes.
50 lines
1.3 KiB
JavaScript
50 lines
1.3 KiB
JavaScript
/* global io */
|
|
|
|
export const MMSocket = function (moduleName) {
|
|
if (typeof moduleName !== "string") {
|
|
throw new Error("Please set the module name for the MMSocket.");
|
|
}
|
|
|
|
this.moduleName = moduleName;
|
|
|
|
// Private Methods
|
|
let base = "/";
|
|
if (typeof config !== "undefined" && typeof config.basePath !== "undefined") {
|
|
base = config.basePath;
|
|
}
|
|
this.socket = io(`/${this.moduleName}`, {
|
|
path: `${base}socket.io`,
|
|
pingInterval: 120000, // send pings every 2 mins
|
|
pingTimeout: 120000 // wait up to 2 mins for a pong
|
|
});
|
|
|
|
let notificationCallback = function () {};
|
|
|
|
const onevent = this.socket.onevent;
|
|
this.socket.onevent = (packet) => {
|
|
const args = packet.data || [];
|
|
onevent.call(this.socket, packet); // original call
|
|
packet.data = ["*"].concat(args);
|
|
onevent.call(this.socket, packet); // additional call to catch-all
|
|
};
|
|
|
|
// register catch all.
|
|
this.socket.on("*", (notification, payload) => {
|
|
if (notification !== "*") {
|
|
notificationCallback(notification, payload);
|
|
}
|
|
});
|
|
|
|
// Public Methods
|
|
this.setNotificationCallback = (callback) => {
|
|
notificationCallback = callback;
|
|
};
|
|
|
|
this.sendNotification = (notification, payload = {}) => {
|
|
this.socket.emit(notification, payload);
|
|
};
|
|
};
|
|
|
|
// Legacy global bridge for third-party modules that reference MMSocket directly.
|
|
if (!globalThis.MMSocket) globalThis.MMSocket = MMSocket;
|