From ae007e1e0ad6ed96d3a9c5a77272e844da308c97 Mon Sep 17 00:00:00 2001
From: Jack Allnutt <jack@allnutt.eu>
Date: Sat, 19 Jul 2014 12:50:27 +0100
Subject: [PATCH] Use promises at startup

Refactored the js code in index.html.tmpl and app.js to use promises
instead of the custom JobManager object.
---
 client/assets/libs/promise.min.js |   5 +
 client/src/app.js                 |  69 ++++-----
 client/src/index.html.tmpl        | 233 ++++++++++++------------------
 3 files changed, 126 insertions(+), 181 deletions(-)
 create mode 100644 client/assets/libs/promise.min.js

diff --git a/client/assets/libs/promise.min.js b/client/assets/libs/promise.min.js
new file mode 100644
index 0000000..a6ed593
--- /dev/null
+++ b/client/assets/libs/promise.min.js
@@ -0,0 +1,5 @@
+/*
+    (c) Yehuda Katz, Tom Dale, Stefan Penner and contributors
+    License: https://github.com/jakearchibald/es6-promise/blob/1.0.0/LICENSE
+*/
+!function(){var a,b,c,d;!function(){var e={},f={};a=function(a,b,c){e[a]={deps:b,callback:c}},d=c=b=function(a){function c(b){if("."!==b.charAt(0))return b;for(var c=b.split("/"),d=a.split("/").slice(0,-1),e=0,f=c.length;f>e;e++){var g=c[e];if(".."===g)d.pop();else{if("."===g)continue;d.push(g)}}return d.join("/")}if(d._eak_seen=e,f[a])return f[a];if(f[a]={},!e[a])throw new Error("Could not find module "+a);for(var g,h=e[a],i=h.deps,j=h.callback,k=[],l=0,m=i.length;m>l;l++)"exports"===i[l]?k.push(g={}):k.push(b(c(i[l])));var n=j.apply(this,k);return f[a]=g||n}}(),a("promise/all",["./utils","exports"],function(a,b){"use strict";function c(a){var b=this;if(!d(a))throw new TypeError("You must pass an array to all.");return new b(function(b,c){function d(a){return function(b){f(a,b)}}function f(a,c){h[a]=c,0===--i&&b(h)}var g,h=[],i=a.length;0===i&&b([]);for(var j=0;j<a.length;j++)g=a[j],g&&e(g.then)?g.then(d(j),c):f(j,g)})}var d=a.isArray,e=a.isFunction;b.all=c}),a("promise/asap",["exports"],function(a){"use strict";function b(){return function(){process.nextTick(e)}}function c(){var a=0,b=new i(e),c=document.createTextNode("");return b.observe(c,{characterData:!0}),function(){c.data=a=++a%2}}function d(){return function(){j.setTimeout(e,1)}}function e(){for(var a=0;a<k.length;a++){var b=k[a],c=b[0],d=b[1];c(d)}k=[]}function f(a,b){var c=k.push([a,b]);1===c&&g()}var g,h="undefined"!=typeof window?window:{},i=h.MutationObserver||h.WebKitMutationObserver,j="undefined"!=typeof global?global:void 0===this?window:this,k=[];g="undefined"!=typeof process&&"[object process]"==={}.toString.call(process)?b():i?c():d(),a.asap=f}),a("promise/config",["exports"],function(a){"use strict";function b(a,b){return 2!==arguments.length?c[a]:(c[a]=b,void 0)}var c={instrument:!1};a.config=c,a.configure=b}),a("promise/polyfill",["./promise","./utils","exports"],function(a,b,c){"use strict";function d(){var a;a="undefined"!=typeof global?global:"undefined"!=typeof window&&window.document?window:self;var b="Promise"in a&&"resolve"in a.Promise&&"reject"in a.Promise&&"all"in a.Promise&&"race"in a.Promise&&function(){var b;return new a.Promise(function(a){b=a}),f(b)}();b||(a.Promise=e)}var e=a.Promise,f=b.isFunction;c.polyfill=d}),a("promise/promise",["./config","./utils","./all","./race","./resolve","./reject","./asap","exports"],function(a,b,c,d,e,f,g,h){"use strict";function i(a){if(!v(a))throw new TypeError("You must pass a resolver function as the first argument to the promise constructor");if(!(this instanceof i))throw new TypeError("Failed to construct 'Promise': Please use the 'new' operator, this object constructor cannot be called as a function.");this._subscribers=[],j(a,this)}function j(a,b){function c(a){o(b,a)}function d(a){q(b,a)}try{a(c,d)}catch(e){d(e)}}function k(a,b,c,d){var e,f,g,h,i=v(c);if(i)try{e=c(d),g=!0}catch(j){h=!0,f=j}else e=d,g=!0;n(b,e)||(i&&g?o(b,e):h?q(b,f):a===D?o(b,e):a===E&&q(b,e))}function l(a,b,c,d){var e=a._subscribers,f=e.length;e[f]=b,e[f+D]=c,e[f+E]=d}function m(a,b){for(var c,d,e=a._subscribers,f=a._detail,g=0;g<e.length;g+=3)c=e[g],d=e[g+b],k(b,c,d,f);a._subscribers=null}function n(a,b){var c,d=null;try{if(a===b)throw new TypeError("A promises callback cannot return that same promise.");if(u(b)&&(d=b.then,v(d)))return d.call(b,function(d){return c?!0:(c=!0,b!==d?o(a,d):p(a,d),void 0)},function(b){return c?!0:(c=!0,q(a,b),void 0)}),!0}catch(e){return c?!0:(q(a,e),!0)}return!1}function o(a,b){a===b?p(a,b):n(a,b)||p(a,b)}function p(a,b){a._state===B&&(a._state=C,a._detail=b,t.async(r,a))}function q(a,b){a._state===B&&(a._state=C,a._detail=b,t.async(s,a))}function r(a){m(a,a._state=D)}function s(a){m(a,a._state=E)}var t=a.config,u=(a.configure,b.objectOrFunction),v=b.isFunction,w=(b.now,c.all),x=d.race,y=e.resolve,z=f.reject,A=g.asap;t.async=A;var B=void 0,C=0,D=1,E=2;i.prototype={constructor:i,_state:void 0,_detail:void 0,_subscribers:void 0,then:function(a,b){var c=this,d=new this.constructor(function(){});if(this._state){var e=arguments;t.async(function(){k(c._state,d,e[c._state-1],c._detail)})}else l(this,d,a,b);return d},"catch":function(a){return this.then(null,a)}},i.all=w,i.race=x,i.resolve=y,i.reject=z,h.Promise=i}),a("promise/race",["./utils","exports"],function(a,b){"use strict";function c(a){var b=this;if(!d(a))throw new TypeError("You must pass an array to race.");return new b(function(b,c){for(var d,e=0;e<a.length;e++)d=a[e],d&&"function"==typeof d.then?d.then(b,c):b(d)})}var d=a.isArray;b.race=c}),a("promise/reject",["exports"],function(a){"use strict";function b(a){var b=this;return new b(function(b,c){c(a)})}a.reject=b}),a("promise/resolve",["exports"],function(a){"use strict";function b(a){if(a&&"object"==typeof a&&a.constructor===this)return a;var b=this;return new b(function(b){b(a)})}a.resolve=b}),a("promise/utils",["exports"],function(a){"use strict";function b(a){return c(a)||"object"==typeof a&&null!==a}function c(a){return"function"==typeof a}function d(a){return"[object Array]"===Object.prototype.toString.call(a)}var e=Date.now||function(){return(new Date).getTime()};a.objectOrFunction=b,a.isFunction=c,a.isArray=d,a.now=e}),b("promise/polyfill").polyfill()}();
\ No newline at end of file
diff --git a/client/src/app.js b/client/src/app.js
index e7d643d..2c740ae 100644
--- a/client/src/app.js
+++ b/client/src/app.js
@@ -184,13 +184,41 @@ _kiwi.global = {
 
     // Entry point to start the kiwi application
     init: function (opts, callback) {
-        var jobs, locale, localeLoaded, textThemeLoaded, text_theme;
+        var localePromise, themePromise,
+            that = this;
         opts = opts || {};
 
         this.initUtils();
 
-        jobs = new JobManager();
-        jobs.onFinish(function(locale, s, xhr) {
+        // Set up the settings datastore
+        _kiwi.global.settings = _kiwi.model.DataStore.instance('kiwi.settings');
+        _kiwi.global.settings.load();
+
+        // Set the window title
+        window.document.title = opts.server_settings.client.window_title || 'Kiwi IRC';
+
+        localePromise = new Promise(function (resolve) {
+            var locale = _kiwi.global.settings.get('locale') || 'magic';
+            $.getJSON(opts.base_path + '/assets/locales/' + locale + '.json', function (locale) {
+                if (locale) {
+                    that.i18n = new Jed(locale);
+                } else {
+                    that.i18n = new Jed();
+                }
+                resolve();
+            });
+        });
+
+        themePromise = new Promise(function (resolve) {
+            var text_theme = opts.server_settings.client.settings.text_theme || 'default';
+            $.getJSON(opts.base_path + '/assets/text_themes/' + text_theme + '.json', function(text_theme) {
+                opts.text_theme = text_theme;
+                resolve();
+            });
+        });
+
+
+        Promise.all([localePromise, themePromise]).then(function () {
             _kiwi.app = new _kiwi.model.Application(opts);
 
             // Start the client up
@@ -204,41 +232,6 @@ _kiwi.global = {
 
             callback();
         });
-
-        textThemeLoaded = function(text_theme, s, xhr) {
-            opts.text_theme = text_theme;
-
-            jobs.finishJob('load_text_theme');
-        };
-
-        localeLoaded = function(locale, s, xhr) {
-            if (locale) {
-                _kiwi.global.i18n = new Jed(locale);
-            } else {
-                _kiwi.global.i18n = new Jed();
-            }
-
-            jobs.finishJob('load_locale');
-        };
-
-        // Set up the settings datastore
-        _kiwi.global.settings = _kiwi.model.DataStore.instance('kiwi.settings');
-        _kiwi.global.settings.load();
-
-        // Set the window title
-        window.document.title = opts.server_settings.client.window_title || 'Kiwi IRC';
-
-        jobs.registerJob('load_locale');
-        locale = _kiwi.global.settings.get('locale');
-        if (!locale) {
-            $.getJSON(opts.base_path + '/assets/locales/magic.json', localeLoaded);
-        } else {
-            $.getJSON(opts.base_path + '/assets/locales/' + locale + '.json', localeLoaded);
-        }
-
-        jobs.registerJob('load_text_theme');
-        text_theme = opts.server_settings.client.settings.text_theme || 'default';
-        $.getJSON(opts.base_path + '/assets/text_themes/' + text_theme + '.json', textThemeLoaded);
     },
 
     start: function() {
diff --git a/client/src/index.html.tmpl b/client/src/index.html.tmpl
index 1d796fc..d6694f3 100644
--- a/client/src/index.html.tmpl
+++ b/client/src/index.html.tmpl
@@ -412,7 +412,9 @@
                 console[method] = noop;
             }
         }
-    };
+    }
+
+    normalizeConsole();
 
     function getQueryVariable(variable) {
         var query = window.location.search.substring(1);
@@ -425,81 +427,108 @@
         }
     }
 
-    /**
-     * Get alerted when a group of jobs have been completed.
-     * Eg. .registerJob('job1'); .registerJob('job2');
-     *     .onFinish(function(){ alert('Jobs finished!'); });
-     *     .finishJob('job1');
-     *     .finishJob('job2');
-     */
-    function JobManager() {
-        var completed_jobs = {  };
-
-        // Functions to call once all jobs have completed
-        var completed_callbacks = [];
-
+    (function afterPromiseAvailable() {
+        var base_path = '<%base_path%>', // Entry path for the kiwi application
+            scripts = [],
+            opts = {
+                container: $('body'),
+                base_path: base_path,
+                settings_path: base_path + '/assets/settings.json'
+            },
+            script_promise, script_promise_resolve,
+            onload_promise,
+            settings_promise;
+
+        // If the browser doesn't natively support promises load up the polyfill and try again.
+        if (!window.Promise) {
+            $script(base_path + "/assets/libs/promise.min.js", afterPromiseAvailable);
+            return;
+        }
 
-        function callCompletedFunctions(fn) {
-            $.each(completed_callbacks, function(idx, fn) {
-                fn();
+        function loadScripts(scripts) {
+            return new Promise(function (resolve, reject) {
+                var to_load, idx,
+                    base = base_path + '/';
+                if (typeof scripts === 'string') {
+                    to_load = base + scripts;
+                } else {
+                    to_load = [];
+                    for (idx in scripts) {
+                        to_load.push(base + scripts[idx]);
+                    }
+                }
+                $script(to_load, resolve, reject);
             });
+        }
 
-            completed_callbacks = [];
-        };
-
+        onload_promise = new Promise(function (resolve) {
+            window.onload = resolve;
+        });
 
-        this.finishJob = function(job_name) {
-            if (typeof completed_jobs[job_name] === 'undefined') {
-                return;
+        script_promise = new Promise(function (resolve) {
+            script_promise_resolve = resolve;
+        });
+        script_promise = script_promise.then(function () {
+            var idx;
+            for (idx = 0; idx < scripts.length; idx++) {
+                (function (idx) {
+                    script_promise = script_promise.then(function () {
+                        return loadScripts(scripts[idx]);
+                    });
+                })(idx);
             }
+        });
 
-            completed_jobs[job_name] = true;
-
-            // Check if all our jobs have completed
-            var all_jobs_completed = true;
-            $.each(completed_jobs, function(idx, completed) {
-                if (!completed) {
-                    all_jobs_completed = false;
-                    return false;
-                }
-            });
-
-            if (all_jobs_completed) {
-                callCompletedFunctions();
-            }
-        };
+        if (!getQueryVariable('debug')) {
+            scripts.push(['assets/libs/lodash.min.js?t=<%build_time%>']);
+            scripts.push([
+                'assets/libs/backbone.min.js?t=<%build_time%>',
+                'assets/libs/jed.js?t=<%build_time%>'
+            ]);
+            scripts.push([
+                'assets/kiwi.min.js?t=<%build_time%>',
+                'assets/libs/engine.io.bundle.min.js?t=<%build_time%>'
+            ]);
 
+            script_promise_resolve();
+        }
 
-        this.onFinish = function(fn) {
-            completed_callbacks.push(fn);
-        };
+        settings_promise = new Promise(function (resolve) {
+            $.getJSON(opts.settings_path, function (data) {
+                opts.server_settings = data.server_settings;
+                opts.client_plugins = data.client_plugins;
+                opts.translations = data.translations;
+                opts.locale = data.locale;
+                opts.themes = data.themes;
 
+                if (typeof data.kiwi_server !== 'undefined') {
+                    opts.kiwi_server = data.kiwi_server;
+                }
 
-        this.registerJob = function(job_name) {
-            completed_jobs[job_name] = false;
-        };
-    }
+                resolve();
 
-    (function () {
-        var base_path = '<%base_path%>', // Entry path for the kiwi application
-            scripts = [],
-            opts = {
-                container: $('body'),
-                base_path: base_path,
-                settings_path: base_path + '/assets/settings.json'
-            };
+                // If debugging, grab the debug scripts and load them
+                if (getQueryVariable('debug')) {
+                    scripts = scripts.concat(data.scripts);
+                    script_promise_resolve();
+                }
 
-        normalizeConsole();
+                // Load themes
+                if (opts.themes) {
+                    $.each(opts.themes, function (theme_idx, theme) {
+                        var disabled = (opts.server_settings.client.settings.theme.toLowerCase() !== theme.name.toLowerCase()),
+                            rel = (disabled?'alternate ':'') + 'stylesheet';
 
-        /**
-         * Job bootup manager
-         * Once all jobs have completed, call any registered completed functions
-         */
-        var jobs = new JobManager();
+                        var link = $.parseHTML('<link rel="' + rel + '" type="text/css" data-theme href="'+ opts.base_path + '/assets/themes/' + theme.name.toLowerCase() + '/style.css" title="' + theme.name.toLowerCase() + '" ' + (disabled?'disabled':'') + '/>');
+                        link.disabled = disabled;
 
+                        $(link).appendTo($('head'));
+                    });
+                }
+            });
+        });
 
-        // Run after all dependancies have been loaded
-        jobs.onFinish(function startApp() {
+        Promise.all([onload_promise, settings_promise]).then(function(){return script_promise}).then(function startApp() {
             // Kiwi IRC version this is built from
             kiwi.build_version = '<%build_version%>';
 
@@ -523,88 +552,6 @@
                 }
             });
         });
-
-
-        // Load each script
-        jobs.registerJob('load_scripts');
-        var cur_script = 0;
-        function loadNextScript () {
-            var to_load,
-                base = base_path + '/';
-
-            // Start the kiwi app if all scripts have been loaded
-            if (cur_script === scripts.length) {
-                jobs.finishJob('load_scripts');
-                return;
-            }
-
-            if (typeof scripts[cur_script] === 'string') {
-                to_load = base + scripts[cur_script];
-            } else {
-                to_load = [];
-                for(var idx in scripts[cur_script]) {
-                    to_load.push(base + scripts[cur_script][idx]);
-                }
-            }
-
-            $script(to_load, loadNextScript);
-
-            cur_script++;
-        }
-
-        // If we're not interested in debug libs, start loading production files
-        if (!getQueryVariable('debug')) {
-            scripts.push(['assets/libs/lodash.min.js?t=<%build_time%>']);
-            scripts.push([
-                'assets/libs/backbone.min.js?t=<%build_time%>',
-                'assets/libs/jed.js?t=<%build_time%>'
-            ]);
-            scripts.push([
-                'assets/kiwi.min.js?t=<%build_time%>',
-                'assets/libs/engine.io.bundle.min.js?t=<%build_time%>'
-            ]);
-
-            loadNextScript();
-        }
-
-        // Load application settings
-        jobs.registerJob('load_settings');
-        $.getJSON(opts.settings_path, function (data) {
-            opts.server_settings = data.server_settings;
-            opts.client_plugins = data.client_plugins;
-            opts.translations = data.translations;
-            opts.locale = data.locale;
-            opts.themes = data.themes;
-
-            if (typeof data.kiwi_server !== 'undefined')
-                opts.kiwi_server = data.kiwi_server;
-
-            jobs.finishJob('load_settings');
-
-            // If debugging, grab the debug scripts and load them
-            if (getQueryVariable('debug')) {
-                scripts = scripts.concat(data.scripts);
-                loadNextScript();
-            }
-
-            // Load themes
-            if (opts.themes) {
-                $.each(opts.themes, function (theme_idx, theme) {
-                    var disabled = (opts.server_settings.client.settings.theme.toLowerCase() !== theme.name.toLowerCase()),
-                        rel = (disabled?'alternate ':'') + 'stylesheet' /*+ (disabled?' prefetch':'')*/;
-
-                    var link = $.parseHTML('<link rel="' + rel + '" type="text/css" data-theme href="'+ opts.base_path + '/assets/themes/' + theme.name.toLowerCase() + '/style.css" title="' + theme.name.toLowerCase() + '" ' + (disabled?'disabled':'') + '/>');
-                    link.disabled = disabled;
-
-                    $(link).appendTo($('head'));
-                });
-            }
-        });
-
-        jobs.registerJob('window_load');
-        window.onload = function() {
-            jobs.finishJob('window_load');
-        };
     })();
 </script>
 </body>
-- 
2.25.1