Add debugging tools

www/common/cryptpad-common.js

@@ -254,8 +254,8 @@ define([
         postMessage("REMOVE_OWNED_CHANNEL", channel, cb);
     };
 
-    common.getDeletedPads = function (cb) {
+    common.getDeletedPads = function (data, cb) {
-        postMessage("GET_DELETED_PADS", null, function (obj) {
+        postMessage("GET_DELETED_PADS", data, function (obj) {
             if (obj && obj.error) { return void cb(obj.error); }
             cb(null, obj);
         });

www/common/sframe-common-history.js

@@ -48,14 +48,6 @@ define([
             });
         };
 
-        var loadFullHistory = function (config, common, cb) {
-            var realtime = createRealtime(config);
-            common.getFullHistory(realtime, function () {
-                cb(null, realtime);
-            });
-        };
-        loadFullHistory = loadFullHistory;
-
         var fillChainPad = function (realtime, messages) {
             messages.forEach(function (m) {
                 realtime.message(m);

www/common/sframe-common-outer.js

@@ -514,11 +514,22 @@ define([
                     channel: secret.channel,
                     validateKey: secret.keys.validateKey
                 }, function (encryptedMsgs) {
-                    cb(encryptedMsgs.map(function (msg) {
+                    var nt = nThen;
-                        // The 3rd parameter "true" means we're going to skip signature validation.
+                    var decryptedMsgs = [];
-                        // We don't need it since the message is already validated serverside by hk
+                    var total = encryptedMsgs.length;
-                        return crypto.decrypt(msg, true, true);
+                    encryptedMsgs.forEach(function (msg, i) {
-                    }));
+                        nt = nt(function (waitFor) {
+                            // The 3rd parameter "true" means we're going to skip signature validation.
+                            // We don't need it since the message is already validated serverside by hk
+                            decryptedMsgs.push(crypto.decrypt(msg, true, true));
+                            setTimeout(waitFor(function () {
+                                sframeChan.event('EV_FULL_HISTORY_STATUS', (i+1)/total);
+                            }), 5);
+                        }).nThen;
+                    });
+                    nt(function () {
+                        cb(decryptedMsgs);
+                    });
                 });
             });
             sframeChan.on('Q_GET_HISTORY_RANGE', function (data, cb) {
@@ -590,6 +601,13 @@ define([
                 });
             });
 
+            sframeChan.on('Q_DRIVE_GETDELETED', function (data, cb) {
+                Cryptpad.getDeletedPads(data, function (err, obj) {
+                    if (err) { return void console.error(err); }
+                    cb(obj);
+                });
+            });
+
             sframeChan.on('Q_SESSIONSTORAGE_PUT', function (data, cb) {
                 sessionStorage[data.key] = data.value;
                 cb();

www/common/sframe-common.js

@@ -302,17 +302,6 @@ define([
         });
     };
 
-    funcs.getFullHistory = function (realtime, cb) {
-        ctx.sframeChan.query('Q_GET_FULL_HISTORY', null, function (err, messages) {
-            if (err) { return void console.error(err); }
-            if (!Array.isArray(messages)) { return; }
-            messages.forEach(function (m) {
-                realtime.message(m);
-            });
-            cb();
-        });
-    };
-
     // href is optional here: if not provided, we use the href of the current tab
     funcs.getPadAttribute = function (key, cb, href) {
         ctx.sframeChan.query('Q_GET_PAD_ATTRIBUTE', {

www/debug/app-debug.less

@@ -15,10 +15,38 @@
         display: flex;
         min-height: 0;
     }
-    #cp-app-debug-content {
+    #cp-app-debug-content, #cp-app-debug-history {
         flex: 1;
         overflow: auto;
         white-space: pre-wrap;
+        display: none;
+    }
+    #cp-app-debug-content {
+        flex-flow: column;
+        align-items: center;
+        justify-content: center;
+        .cp-app-debug-content {
+            flex: 1;
+            min-height: 0;
+        }
+        .cp-app-debug-progress {
+            width: 80%;
+        }
+        .cp-loading-progress-bar {
+            position: relative;
+            border: 1px solid #eee;
+            height: 36px;
+        }
+        #cp-app-debug-progres-bar-text {
+            position: absolute;
+            width: 100%;
+            text-align: center;
+            height: 100%;
+            line-height: 36px;
+        }
+        #cp-app-debug-loading {
+            text-align: center;
+        }
     }
 }
 

www/debug/inner.html

@@ -13,6 +13,7 @@
   <div id="cp-toolbar" class="cp-toolbar-container"></div>
   <div id="cp-app-debug">
     <div id="cp-app-debug-content"></div>
+    <div id="cp-app-debug-history"></div>
   </div>
 </body>
 </html>

www/debug/inner.js

@@ -8,6 +8,7 @@ define([
     '/common/sframe-common.js',
     '/common/common-interface.js',
     '/common/common-hash.js',
+    '/common/common-constants.js',
     '/common/hyperscript.js',
     '/api/config',
     '/common/common-realtime.js',
@@ -30,6 +31,7 @@ define([
     SFCommon,
     UI,
     Hash,
+    Constants,
     h,
     ApiConfig,
     CommonRealtime,
@@ -62,13 +64,149 @@ define([
         var readOnly = true;
         var sframeChan = common.getSframeChannel();
 
-        var getGraph = function (cb) {
+        var getHrefsTable = function (chainpad, length, cb, progress) {
-            var chainpad = ChainWalk.create({
+            var priv = metadataMgr.getPrivateData();
-                userName: 'debug',
+            var edPublic = priv.edPublic;
-                initialState: '',
+
-                logLevel: 0,
+            var pads = {};
-                noPrune: true
+            var isOwned = function (data) {
+                data = data || {};
+                return data && data.owners && Array.isArray(data.owners) && data.owners.indexOf(edPublic) !== -1;
+            };
+            var parseBlock = function (block) {
+                var c = block.getContent().doc;
+                if (!c) { return void console.error(block); }
+                var p;
+                try {
+                    p = JSON.parse(c).drive || {};
+                } catch (e) {
+                    console.error(e);
+                    p = {};
+                }
+
+                // Get pads from the old storage key
+                var old = p[Constants.oldStorageKey];
+                var ids = p[Constants.storageKey];
+                var pad, parsed, chan, href;
+                if (old && Array.isArray(old)) {
+                    for (var i = 0; i<old.length; i++) {
+                        try {
+                            pad = old[i];
+                            href = pad.href || pad.roHref;
+                            if (href) {
+                                parsed = Hash.parsePadUrl(href);
+                                chan = (Hash.getSecrets(parsed.type, parsed.hash) || {}).channel;
+                                if (chan && (!pads[chan] || pads[chan].atime < pad.atime)) {
+                                    pads[chan] = {
+                                        atime: +new Date(pad.atime),
+                                        href: href,
+                                        title: pad.title,
+                                        owned: isOwned(pad),
+                                        expired: pad.expire && pad.expire < (+new Date())
+                                    };
+                                }
+                            }
+                        } catch (e) {}
+                    }
+                }
+                // Get pads from the new storage key
+                if (ids) {
+                    for (var id in ids) {
+                        try {
+                            pad = ids[id];
+                            chan = pad.channel;
+                            href = pad.href || pad.roHref;
+                            if (!chan) {
+                                if (href) {
+                                    parsed = Hash.parsePadUrl(href);
+                                    chan = (Hash.getSecrets(parsed.type, parsed.hash, pad.password) || {}).channel;
+                                }
+                            }
+                            if (chan && (!pads[chan] || pads[chan].atime < pad.atime)) {
+                                pads[chan] = {
+                                    atime: +new Date(pad.atime),
+                                    href: href,
+                                    title: pad.title,
+                                    owned: isOwned(pad),
+                                    expired: pad.expire && pad.expire < (+new Date())
+                                };
+                            }
+                        } catch (e) {}
+                    }
+                }
+            };
+
+            var nt = nThen;
+
+            // Safely get all the pads from all the states
+            var i = 0;
+            var next = function (block) {
+                nt = nt(function (waitFor) {
+                    i++;
+                    parseBlock(block);
+                    progress(Math.min(i/length, 1));
+                    setTimeout(waitFor(), 1);
+                }).nThen;
+                var c = block.getChildren();
+                c.forEach(next);
+            };
+
+            var root = chainpad.getRootBlock();
+            next(root);
+
+            // Make the table
+            var allChannels;
+            var deleted;
+            nt(function (waitFor) {
+                allChannels = Object.keys(pads);
+                sframeChan.query('Q_DRIVE_GETDELETED', {list:allChannels}, waitFor(function (err, data) {
+                    deleted = data;
+                }));
+            }).nThen(function () {
+                // Current status
+                try {
+                    var parsed = JSON.parse(chainpad.getUserDoc());
+                    var channels = Object.keys(parsed.drive[Constants.storageKey] || {}).map(function (id) {
+                        return parsed.drive[Constants.storageKey][id].channel;
+                    });
+                } catch (e) {
+                    console.error(e);
+                }
+
+                // Header
+                var rows = [h('tr', [ // XXX
+                    h('th', '#'),
+                    h('th', 'Title'),
+                    h('th', 'URL'),
+                    h('th', 'Last visited'),
+                    h('th', 'Owned'),
+                    h('th', 'CryptDrive status'),
+                    h('th', 'Server status'),
+                ])];
+                // Body
+                var body = allChannels;
+                body.sort(function (a, b) {
+                    return pads[a].atime - pads[b].atime;
+                });
+                body.forEach(function (id, i) {
+                    var p = pads[id];
+                    rows.push(h('tr', [
+                        h('td', String(i+1)),
+                        h('td', p.title),
+                        h('td', p.href),
+                        h('td', new Date(p.atime).toLocaleString()),
+                        h('td', p.owned ? 'Yes' : ''),
+                        h('td', p.expired ? 'Expired' : (channels.indexOf(id) !== -1 ? 'Stored' : 'Deleted')), // XXX
+                        h('td', deleted.indexOf(id) !== -1 ? 'Missing' : 'OK'), // XXX
+                    ]));
+                });
+                // Table
+                var t = h('table', rows);
+                cb(t);
             });
+        };
+
+        var getGraph = function (chainpad, cb) {
             var hashes = metadataMgr.getPrivateData().availableHashes;
             var hash = hashes.editHash || hashes.viewHash;
             var chan = Hash.hrefToHexChannelId('/drive/#'+hash);
@@ -102,16 +240,158 @@ define([
                 out.push('}');
                 return out.join('\n');
             };
+
+            cb(makeGraph());
+        };
+
+        var getFullChainpad = function (history, length, cb, progress) {
+            var chainpad = ChainWalk.create({
+                userName: 'debug',
+                initialState: '',
+                logLevel: 0,
+                noPrune: true
+            });
+
+            var nt = nThen;
+            history.forEach(function (msg, i) {
+                nt = nt(function (waitFor) {
+                    chainpad.message(msg);
+                    progress(Math.min(i/length, 1));
+                    setTimeout(waitFor(), 1);
+                }).nThen;
+            });
+            nt(function () {
+                cb(chainpad);
+            })
+        };
+
+        var fullHistoryCalled = false;
+        var getFullHistory = function () {
+            var priv = metadataMgr.getPrivateData();
+            if (fullHistoryCalled) { return; }
+            fullHistoryCalled = true;
+
+            // Set spinner
+            var content = h('div#cp-app-debug-loading', [
+                h('p', 'Loading history from the server...'),
+                h('span.fa.fa-circle-o-notch.fa-spin.fa-3x.fa-fw')
+            ]);
+            $('#cp-app-debug-content').html('').append(content);
+
+            // Update progress bar
+            var decrypting = false;
+            var length = 0;
+            sframeChan.on('EV_FULL_HISTORY_STATUS', function (progress) {
+                if (!decrypting) {
+                    // Add the progress bar the first time
+                    decrypting = true;
+                    var content = h('div.cp-app-debug-progress.cp-loading-progress', [
+                        h('p', 'Decrypting your history...'),
+                        h('div.cp-loading-progress-bar', [
+                            h('div.cp-loading-progress-bar-value#cp-app-debug-progress-bar'),
+                            h('span#cp-app-debug-progress-bar-text'),
+                        ])
+                    ]);
+                    $('#cp-app-debug-content').html('').append(content);
+                }
+                length++;
+                var progress = progress*100;
+                var $bar = $('#cp-app-debug-progress-bar');
+                var $barText = $('#cp-app-debug-progress-bar-text');
+                $bar.css('width', progress+'%');
+                $barText.text((Math.round(progress * 100) / 100) + '%');
+            });
+
+            // Get full history
             sframeChan.query('Q_GET_FULL_HISTORY', null, function (err, data) {
-                console.log(err, data);
+                // History is ready.
-                if (err) { return void cb(err); }
+                // Display the graph code, and if the doc is a drive, display the button to list all the pads
-                data.forEach(function (m) {
+
-                    chainpad.message(m);
+                // Graph
-                    cb(null, makeGraph());
+                var graph = h('div.cp-app-debug-content-graph');
+
+                var seeAllButton = h('button', 'Get the list');
+                var hrefs = h('div.cp-app-debug-content-hrefs', [
+                    h('h2', 'List all the pads ever stored in your CryptDrive'), // XXX
+                ]);
+
+                var parseProgress = h('span', '0%');
+                var content = h('div#cp-app-debug-loading', [
+                    h('p', 'Parsing history...'),// XXX
+                    h('span.fa.fa-circle-o-notch.fa-spin.fa-3x.fa-fw'),
+                    h('br'),
+                    parseProgress
+                ]);
+                $('#cp-app-debug-content').html('').append(content);
+
+                getFullChainpad(data, length, function (chainpad) {
+                    var content = h('div.cp-app-debug-content', [
+                        graph,
+                        priv.debugDrive ? hrefs : ''
+                    ]);
+                    $('#cp-app-debug-content').html('').append(content);
+
+                    // Table
+                    if (priv.debugDrive) {
+                        var clicked = false;
+                        $(seeAllButton).click(function () {
+                            if (clicked) { return; }
+                            clicked = true;
+                            $(seeAllButton).remove();
+                            // XXX
+                            // Make table
+                            var progress = h('span', '0%');
+                            var loading = h('div', [
+                                'Loading data...',
+                                h('br'),
+                                progress
+                            ]);
+                            hrefs.append(loading);
+                            getHrefsTable(chainpad, length, function (table) {
+                                loading.innerHTML = '';
+                                hrefs.append(table);
+                            }, function (p) {
+                                progress.innerHTML = (Math.round(p*100*100)/100) + '%'
+                            });
+                        }).appendTo(hrefs);
+                    }
+
+                    // Graph
+                    var code = h('code');
+                    getGraph(chainpad, function (graphVal) {
+                        code.innerHTML = graphVal;
+                        $(graph).append(h('h2', 'Graph')); // XXX
+                        $(graph).append(code);
+                    });
+                }, function (p) {
+                    parseProgress.innerHTML = (Math.round(p*100*100)/100) + '%'
                 });
-            }, {timeout: 180000});
+            }, {timeout: 2147483647}); // Max 32-bit integer
         };
 
+        var getContent = function () {
+            if ($('#cp-app-debug-content').is(':visible')) {
+                $('#cp-app-debug-content').hide();
+                $('#cp-app-debug-history').show();
+                $('#cp-app-debug-get-content').removeClass('cp-toolbar-button-active');
+                return;
+            }
+            $('#cp-app-debug-content').css('display', 'flex');
+            $('#cp-app-debug-history').hide();
+            $('#cp-app-debug-get-content').addClass('cp-toolbar-button-active');
+        };
+        var setInitContent = function () {
+            var button = h('button.btn.btn-primary', 'Load history');
+            $(button).click(getFullHistory);
+            var content = h('p', [
+                'To get better debugging tools, we need to load the entire history of the document. This make take some time.', // XXX
+                h('br'),
+                button
+            ]);
+            $('#cp-app-debug-content').html('').append(content);
+        };
+        setInitContent();
+
         var config = APP.config = {
             readOnly: readOnly,
             // cryptpad debug logging (default is 1)
@@ -135,7 +415,7 @@ define([
         };
 
         var displayDoc = function (doc) {
-            $('#cp-app-debug-content').text(JSON.stringify(doc, 0, 2));
+            $('#cp-app-debug-history').text(JSON.stringify(doc, 0, 2));
             console.log(doc);
         };
 
@@ -172,31 +452,14 @@ define([
             $hist.addClass('cp-hidden-if-readonly');
             toolbar.$rightside.append($hist);
 
-            var $graph = common.createButton(null, true, {
+            var $content = common.createButton(null, true, {
-                icon: 'fa-bug',
+                icon: 'fa-question',
-                title: Messages.debug_getGraph,
+                title: 'Get debugging graph', // XXX
                 name: 'graph',
-                id: 'cp-app-debug-get-graph'
+                id: 'cp-app-debug-get-content'
-            });
-            $graph.click(function () {
-                var p = h('p', [
-                    Messages.debug_getGraphWait,
-                    h('br'),
-                    h('span.fa-circle-o-notch.fa-spin.fa-3x.fa-fw.fa')
-                ]);
-                var code = h('code');
-                var content = h('div', [p, code]);
-                getGraph(function (err, data) {
-                    if (err) {
-                        p.innerHTML = err;
-                        return;
-                    }
-                    p.innerHTML = Messages.debug_getGraph;
-                    code.innerHTML = data;
-                });
-                UI.alert(content);
             });
-            toolbar.$rightside.append($graph);
+            $content.click(getContent);
+            toolbar.$rightside.append($content);
         };
 
         config.onReady = function (info) {
@@ -216,7 +479,10 @@ define([
                 displayDoc(hjson);
             }
 
+            metadataMgr.updateTitle('');
+
             initializing = false;
+            $('#cp-app-debug-history').show();
             UI.removeLoadingScreen();
         };
 

www/debug/main.js

@@ -53,15 +53,22 @@ define([
         };
         window.addEventListener('message', onMsg);
     }).nThen(function (/*waitFor*/) {
+        var hash = localStorage[Constants.userHashKey];
+        var drive = hash && ('#'+hash === window.location.hash);
         if (!window.location.hash) {
-            var hash = localStorage[Constants.userHashKey];
             if (!hash) {
                 sessionStorage.redirectTo = '/debug/';
                 window.location.href = '/login/';
                 return;
             }
+            drive = true;
             window.location.hash = hash;
         }
-        SFCommonO.start();
+        var addData = function (meta) {
+            meta.debugDrive = drive;
+        };
+        SFCommonO.start({
+            addData:addData
+        });
     });
 });

www/drive/main.js

@@ -80,12 +80,6 @@ define([
                     cb(obj);
                 });
             });
-            sframeChan.on('Q_DRIVE_GETDELETED', function (data, cb) {
-                Cryptpad.getDeletedPads(function (err, obj) {
-                    if (err) { return void console.error(err); }
-                    cb(obj);
-                });
-            });
             sframeChan.on('EV_DRIVE_SET_HASH', function (hash) {
                 // Update the hash in the address bar
                 if (!Utils.LocalStore.isLoggedIn()) { return; }