libzotero

<!doctype html> <html lang="en"> <head> <title>Code coverage report for src/Writer.js</title> <meta charset="utf-8" /> <link rel="stylesheet" href="../prettify.css" /> <link rel="stylesheet" href="../base.css" /> <meta name="viewport" content="width=device-width, initial-scale=1"> <style type='text/css'> .coverage-summary .sorter { background-image: url(../sort-arrow-sprite.png); } </style> </head> <body> <div class='wrapper'> <div class='pad1'> <h1> <a href="../index.html">all files</a> / <a href="index.html">src/</a> Writer.js </h1> <div class='clearfix'> <div class='fl pad1y space-right2'> 9.89% Statements 9/91 </div> <div class='fl pad1y space-right2'> 0% Branches 0/26 </div> <div class='fl pad1y space-right2'> 0% Functions 0/11 </div> <div class='fl pad1y space-right2'> 9.89% Lines 9/91 </div> </div> </div> <div class='status-line low'></div> <pre><table class="coverage"> <tr><td class="line-count quiet">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173</td><td class="line-coverage quiet">    1×   1×           1×                                                                                 1×             1×                                                                   1×                     1×                                                 1×                                                                                       1×</td><td class="text"><pre class="prettyprint lang-js">'use strict';   var log = require('./Log.js').Logger('libZotero:Writer');   var Writer = function(libraryType, libraryID, apiKey){ this.libraryType = libraryType; this.libraryID = libraryID; this.apiKey = apiKey; };   Writer.prototype.writeObjects = function(objectsArray, target){ let libraryType = this.libraryType; let libraryID = this.libraryID; let rc = new Zotero.RequestConfig().LibraryType(libraryType).LibraryID(libraryID); rc.Key(this.apiKey); rc.Target(target); let writeChunks = chunkObjectsArray(objectsArray); let rawChunkObjects = rawChunks(writeChunks); //update object with server response if successful var writeSuccessCallback = function(response){ log.debug('write successCallback', 3); updateObjectsFromWriteResponse(this.writeChunk, response); response.returnObjects = this.writeChunk; return response; }; var requestObjects = []; writeChunks.forEach((writeChunk, i)=>{ var successContext = {writeChunk}; var requestData = JSON.stringify(rawChunkObjects[i]); requestObjects.push({ url: rc.config, type: 'POST', data: requestData, processData: false, success: writeSuccessCallback.bind(successContext) }); }); return Zotero.net.queueRequest(requestObjects) .then(function(responses){ log.debug('Done with writeObjects sequentialRequests promise', 3); return responses; }); };   //accept an array of 'Zotero.Item's Writer.prototype.writeItems = function(itemsArray){ let writeItems = atomizeItems(itemsArray); return this.writeObjects(writeItems, 'items'); };   //take an array of items and extract children into their own items //for writing var atomizeItems = function(itemsArray){ //process the array of items, pulling out child notes/attachments to write //separately with correct parentItem set and assign generated itemKeys to //new items var writeItems = []; var item; for(var i = 0; i < itemsArray.length; i++){ item = itemsArray[i]; //generate an itemKey if the item does not already have one var itemKey = item.get('key'); if(itemKey === '' || itemKey === null) { var newItemKey = Zotero.utils.getKey(); item.set('key', newItemKey); item.set('version', 0); } //items that already have item key always in first pass, as are their children writeItems.push(item); if(item.hasOwnProperty('notes') && item.notes.length > 0){ for(var j = 0; j < item.notes.length; j++){ item.notes[j].set('parentItem', item.get('key')); } writeItems = writeItems.concat(item.notes); } if(item.hasOwnProperty('attachments') && item.attachments.length > 0){ for(var k = 0; k < item.attachments.length; k++){ item.attachments[k].set('parentItem', item.get('key')); } writeItems = writeItems.concat(item.attachments); } } return writeItems; };   //split an array of objects into chunks to write over multiple api requests var chunkObjectsArray = function(objectsArray){ var chunkSize = 50; var writeChunks = []; for(var i = 0; i < objectsArray.length; i = i + chunkSize){ writeChunks.push(objectsArray.slice(i, i+chunkSize)); } return writeChunks; };   var rawChunks = function(chunks){ var rawChunkObjects = []; for(var i = 0; i < chunks.length; i++){ rawChunkObjects[i] = []; for(var j = 0; j < chunks[i].length; j++){ rawChunkObjects[i].push(chunks[i][j].writeApiObj()); } } return rawChunkObjects; };   //update items appropriately based on response to multi-write request //for success: // update objectKey if item doesn't have one yet (newly created item) // update itemVersion to response's Last-Modified-Version header // mark as synced //for unchanged: // don't need to do anything? itemVersion should remain the same? // mark as synced if not already? //for failed: // add the failure to the object under writeFailure // don't mark as synced // calling code should check for writeFailure after the written objects // are returned var updateObjectsFromWriteResponse = function(objectsArray, response){ log.debug('updateObjectsFromWriteResponse', 3); log.debug('statusCode: ' + response.status, 3); var data = response.data; if(response.status == 200){ log.debug('newLastModifiedVersion: ' + response.lastModifiedVersion, 3); //make sure writes were actually successful and //update the itemKey for the parent if(data.hasOwnProperty('success')){ //update each successfully written item, possibly with new itemKeys Object.keys(data.success).forEach(function(ind){ var i = parseInt(ind, 10); var key = data.success[ind]; var object = objectsArray[i]; //throw error if objectKey mismatch if(object.key !== '' && object.key !== key){ throw new Error('object key mismatch in multi-write response'); } if(object.key === ''){ object.updateObjectKey(key); } object.set('version', response.lastModifiedVersion); object.synced = true; object.writeFailure = false; }); } if(data.hasOwnProperty('failed')){ log.debug('updating objects with failed writes', 3); Object.keys(data.failed).forEach(function(ind){ var failure = data.failed[ind]; log.error('failed write ' + ind + ' - ' + failure); var i = parseInt(ind, 10); var object = objectsArray[i]; object.writeFailure = failure; }); } } else if(response.status == 204){ //single item put response, this probably should never go to this function objectsArray[0].synced = true; } };     module.exports = Writer;</pre></td></tr> </table></pre> <div class='push'></div> </div> <div class='footer quiet pad2 space-top1 center small'> Code coverage generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Wed Apr 12 2017 14:32:53 GMT+0100 (BST) </div> </div> <script src="../prettify.js"></script> <script> window.onload = function () { if (typeof prettyPrint === 'function') { prettyPrint(); } }; </script> <script src="../sorter.js"></script> </body> </html>