catlab-remote-client 5.0.0 → 5.0.2

package/dist/scripts/webworker.js

@@ -1,128 +1,21 @@
 /**
- * webworker.js — Entry point for the PlayerPool WebWorker.
+ * webworker.js — Entry point for the PlayerPool dedicated-Worker host.
  *
- * This file is loaded by new Worker('scripts/webworker.js') from the dist/ folder.
- * It loads polyfills, configures RequireJS, loads the built webcontrol bundle
- * (which contains all AMD modules), then boots the PlayerPoolWorker.
+ * This file is loaded by new Worker('scripts/webworker.js') from the dist/
+ * folder. It loads RequireJS, the WorkerPolyfills stubs, and worker-env.js
+ * (the environment shim shared with the iframe host, see
+ * iframe-host.html), then boots through it: configure RequireJS, stub
+ * jquery, wire up RequireJS error reporting, and boot the pool worker on
+ * the 'webcontrol' bundle.
  */
 
-// Load RequireJS (dist/vendor/requirejs/require.js)
-importScripts("../vendor/requirejs/require.js");
+importScripts('../vendor/requirejs/require.js');
+importScripts('WorkerPolyfills.js');
+importScripts('worker-env.js');
 
-// Load polyfills for browser APIs not available in workers
-importScripts("WorkerPolyfills.js");
-
-// Configure RequireJS paths for vendor dependencies
-requirejs.config({
-	baseUrl: './',
-	waitSeconds: 0,
-	paths: {
-		'jquery': 'empty:',
-
-		'viewport-units-buggyfill': '../vendor/viewport-units-buggyfill/viewport-units-buggyfill',
-		'viewport-units-buggyfill.hacks': '../vendor/viewport-units-buggyfill/viewport-units-buggyfill.hacks',
-
-		'easelbone': '../vendor/easelbone/dist/scripts/easelbone',
-		'easelhacks': '../vendor/easelhacks/dist/scripts/easelhacks',
-
-		'easeljs': '../vendor/easeljs/lib/easeljs',
-		'preloadjs': '../vendor/preloadjs/lib/preloadjs',
-		'tweenjs': '../vendor/tweenjs/lib/tweenjs',
-
-		'underscore': '../vendor/underscore/underscore',
-		'backbone': '../vendor/backbone/backbone',
-
-		'sprintf': '../vendor/sprintf-js/dist/sprintf.min',
-		'rivets': '../vendor/rivets/dist/rivets.min',
-		'sightglass': '../vendor/sightglass/index',
-
-		'emojione': '../vendor/emojione/lib/js/emojione',
-		'screenfull': '../vendor/screenfull/dist/screenfull',
-		'socket.io-client': '../vendor/socket.io-client/dist/socket.io',
-
-		'simple-keyboard': '../vendor/simple-keyboard/build/index',
-		'SimpleKeyboard': '../vendor/simple-keyboard/build/index',
-
-		'qrious': '../vendor/qrious/dist/qrious.min'
-	},
-
-	shim: {
-		easeljs: {
-			deps: ['tweenjs'],
-			exports: 'createjs'
-		},
-		preloadjs: {
-			deps: ['easeljs'],
-			exports: 'createjs'
-		},
-		emojione: {
-			exports: 'emojione'
-		},
-		screenfull: {
-			exports: 'screenfull'
-		}
-	}
-});
-
-// Stub out jquery for worker context
-define('jquery', function () {
-	return {};
-});
-
-// Capture requirejs errors
-requirejs.onError = function (err) {
-	var msg = '[worker] RequireJS error: ' + (err.requireType || 'unknown') + ': ' + err.message;
-	if (err.requireModules) {
-		msg += ' | modules: ' + err.requireModules.join(', ');
-	}
-	console.error(msg);
-	if (err.originalError) {
-		console.error('[worker] Caused by:', err.originalError.message || err.originalError);
-	}
-	self.postMessage({
-		e: 'worker:error',
-		data: {
-			type: err.requireType || 'unknown',
-			message: err.message,
-			modules: err.requireModules || []
-		}
-	});
-};
-
-// Load the built webcontrol bundle (contains all AMD module definitions),
-// then wait for an 'init' message from the main thread before booting.
-require(
-	['webcontrol'],
-	function () {
-		require(
-			['CatLab/Webremote/PlayerPool/PlayerPoolWorker'],
-			function (PlayerPoolWorker) {
-				// Single boot entry point: posts worker:modules-ready and boots
-				// on worker:init. No createGameLogic here — the library's own
-				// demo runs on the base GameLogic defaults.
-				PlayerPoolWorker.bootWorker({});
-			},
-			function (err) {
-				console.error('[worker] Failed to load PlayerPoolWorker:', err.message);
-				self.postMessage({
-					e: 'worker:fatal',
-					data: {
-						message: err.message,
-						modules: err.requireModules || []
-					}
-				});
-			}
-		);
-	},
-	function (err) {
-		console.error('[worker] Failed to load webcontrol bundle:', err.message);
-		self.postMessage({
-			e: 'worker:fatal',
-			data: {
-				message: err.message,
-				modules: err.requireModules || []
-			}
-		});
-	}
-);
+var __post = function (m) { self.postMessage(m); };
 
+self.__catlabWorkerEnv.configureRequire(requirejs);
+self.__catlabWorkerEnv.installJqueryStub(define);
+self.__catlabWorkerEnv.onRequireError(requirejs, __post);
+self.__catlabWorkerEnv.boot(require, __post);

package/dist/scripts/worker-env.js

@@ -0,0 +1,211 @@
+/**
+ * worker-env.js — Shared environment shim for the two worker-entry loaders.
+ *
+ * Plain JS (no AMD, no ES6): loaded by webworker.js in the dedicated-Worker
+ * host (its Worker-global script loader), and via a <script> tag by
+ * iframe-host.html in the iframe host. Both loaders are otherwise identical
+ * -- this file holds the parts that would else be duplicated between them.
+ *
+ * This file must not post messages to the other side itself: every
+ * caller-visible side effect goes through the `post` function the loader
+ * passes in, so the same code runs unmodified in either host.
+ *
+ * Exposes self.__catlabWorkerEnv = {
+ *   configureRequire: function (requirejs, options) {...},
+ *   installJqueryStub: function (define) {...},
+ *   onRequireError: function (requirejs, post) {...},
+ *   boot: function (require, post) {...}
+ * }
+ */
+(function (scope) {
+	"use strict";
+
+	// Vendor paths, relative to options.vendor (a trailing-slash directory).
+	// Identical set/order to the pre-split webworker.js requirejs.config.
+	var VENDOR_PATHS = {
+		'viewport-units-buggyfill': 'viewport-units-buggyfill/viewport-units-buggyfill',
+		'viewport-units-buggyfill.hacks': 'viewport-units-buggyfill/viewport-units-buggyfill.hacks',
+
+		'easelbone': 'easelbone/dist/scripts/easelbone',
+		'easelhacks': 'easelhacks/dist/scripts/easelhacks',
+
+		'easeljs': 'easeljs/lib/easeljs',
+		'preloadjs': 'preloadjs/lib/preloadjs',
+		'tweenjs': 'tweenjs/lib/tweenjs',
+
+		'underscore': 'underscore/underscore',
+		'backbone': 'backbone/backbone',
+
+		'sprintf': 'sprintf-js/dist/sprintf.min',
+		'rivets': 'rivets/dist/rivets.min',
+		'sightglass': 'sightglass/index',
+
+		'emojione': 'emojione/lib/js/emojione',
+		'screenfull': 'screenfull/dist/screenfull',
+		'socket.io-client': 'socket.io-client/dist/socket.io',
+
+		'simple-keyboard': 'simple-keyboard/build/index',
+		'SimpleKeyboard': 'simple-keyboard/build/index',
+
+		'qrious': 'qrious/dist/qrious.min'
+	};
+
+	/**
+	 * Build a fatal-boot error record from a RequireJS error (or anything
+	 * Error-shaped). This is the one deliberate raw-shaped post left in the
+	 * worker entry: the bundle owning the port failed to load, so nothing
+	 * past this point (PlayerPoolWorker, ChannelPort) is available to build
+	 * a library-shaped error with.
+	 *
+	 * @param {Error|Object} err
+	 * @returns {Object}
+	 */
+	function bootErrorRecord(err) {
+		return {
+			ch: 'control',
+			type: 'fatal',
+			error: {
+				__error: {
+					name: 'BootError',
+					message: err && err.message,
+					stack: '',
+					data: { modules: (err && err.requireModules) || [] }
+				}
+			}
+		};
+	}
+
+	scope.__catlabWorkerEnv = {
+
+		/**
+		 * Configure RequireJS paths/shim for the vendor bundle. Both loaders
+		 * call this once, before requiring 'webcontrol'.
+		 *
+		 * @param {Object} requirejs
+		 * @param {Object} [options]
+		 * @param {string} [options.baseUrl] - default './' (the Worker: the
+		 *        script runs from dist/scripts/).
+		 * @param {string} [options.vendor] - trailing-slash dir holding the
+		 *        vendor/ tree, RELATIVE TO baseUrl (that is how RequireJS
+		 *        resolves `paths`). Default '../vendor/': the Worker runs
+		 *        from dist/scripts/, so the tree is one level up. The frame
+		 *        page passes the same '../vendor/' — its own baseUrl is
+		 *        'scripts/', so 'vendor/' would resolve to
+		 *        dist/scripts/vendor/... and 404 (Ruling P2-15).
+		 */
+		configureRequire: function (requirejs, options) {
+			options = options || {};
+			var baseUrl = options.baseUrl || './';
+			var vendor = options.vendor || '../vendor/';
+
+			var paths = { 'jquery': 'empty:' };
+			for (var name in VENDOR_PATHS) {
+				if (Object.prototype.hasOwnProperty.call(VENDOR_PATHS, name)) {
+					paths[name] = vendor + VENDOR_PATHS[name];
+				}
+			}
+
+			requirejs.config({
+				baseUrl: baseUrl,
+				waitSeconds: 0,
+				paths: paths,
+				shim: {
+					easeljs: {
+						deps: ['tweenjs'],
+						exports: 'createjs'
+					},
+					preloadjs: {
+						deps: ['easeljs'],
+						exports: 'createjs'
+					},
+					emojione: {
+						exports: 'emojione'
+					},
+					screenfull: {
+						exports: 'screenfull'
+					}
+				}
+			});
+		},
+
+		/**
+		 * Stub out the 'jquery' AMD module -- neither host has (or needs) a
+		 * real jQuery; the paths config above maps it to 'empty:', but a few
+		 * modules `require(['jquery'])` directly rather than only depending
+		 * on it, so a defined-but-empty module keeps those resolvable too.
+		 *
+		 * @param {Function} define - the global AMD define()
+		 */
+		installJqueryStub: function (define) {
+			define('jquery', function () {
+				return {};
+			});
+		},
+
+		/**
+		 * Install a requirejs.onError handler that reports load failures
+		 * through `post` as a control:error record, instead of leaving
+		 * RequireJS to throw uncaught.
+		 *
+		 * @param {Object} requirejs
+		 * @param {Function} post - post(message)
+		 */
+		onRequireError: function (requirejs, post) {
+			requirejs.onError = function (err) {
+				if (typeof console !== 'undefined' && console.error) {
+					console.error('[worker-env] RequireJS error:', err && err.message);
+					if (err && err.originalError) {
+						console.error('[worker-env] Caused by:', err.originalError.message || err.originalError);
+					}
+				}
+				post({
+					ch: 'control',
+					type: 'error',
+					context: 'require',
+					error: {
+						__error: {
+							name: 'RequireError',
+							message: err && err.message,
+							stack: '',
+							data: {
+								type: err && err.requireType,
+								modules: (err && err.requireModules) || []
+							}
+						}
+					}
+				});
+			};
+		},
+
+		/**
+		 * Load the 'webcontrol' bundle, then boot the pool worker on it.
+		 * Shared by both loaders -- identical two-level require() chain,
+		 * with the same raw-fatal handling on either level failing.
+		 *
+		 * @param {Function} require
+		 * @param {Function} post - post(message)
+		 */
+		boot: function (require, post) {
+			var fatal = function (err) {
+				post(bootErrorRecord(err));
+			};
+
+			require(
+				['webcontrol'],
+				function (catlabremote) {
+					require(
+						['CatLab/Webremote/PlayerPool/PlayerPoolWorker'],
+						function (PlayerPoolWorker) {
+							PlayerPoolWorker.bootWorker({
+								port: catlabremote.Transport.WorkerPort.detect()
+							});
+						},
+						fatal
+					);
+				},
+				fatal
+			);
+		}
+	};
+
+})(typeof self !== 'undefined' ? self : typeof window !== 'undefined' ? window : this);

package/dist/vendor/requirejs/README.md

@@ -0,0 +1,9 @@
+# requirejs
+
+RequireJS for use in Node. includes:
+
+* r.js: the RequireJS optimizer, and AMD runtime for use in Node.
+* require.js: The browser-based AMD loader.
+
+More information at http://requirejs.org
+