if/SymphonyElectron
1
0
Fork 0
mirror of https://github.com/finos/SymphonyElectron.git synced 2025-02-25 18:55:29 -06:00
Code Issues Packages Projects Releases Wiki Activity

hide readResult method (#131)

Browse Source
This commit is contained in:
Lynn 2017-06-07 09:05:25 -07:00 committed by GitHub
parent 421f04d8e0
commit 4abe5c87d8
4 changed files with 77 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
js/preload/preloadMain.js
View File

@ -107,7 +107,7 @@ function createAPI() {
* provides api to allow user to capture portion of screen, see api * provides api to allow user to capture portion of screen, see api
* details in screenSnipper/ScreenSnippet.js * details in screenSnipper/ScreenSnippet.js
*/ */
ScreenSnippet: remote.require('./screenSnippet/ScreenSnippet.js'), ScreenSnippet: remote.require('./screenSnippet/ScreenSnippet.js').ScreenSnippet,
/** /**
* Brings window forward and gives focus. * Brings window forward and gives focus.

38
js/screenSnippet/ScreenSnippet.js
View File

@ -77,15 +77,17 @@ class ScreenSnippet {
// processs was killed, just resolve with no data. // processs was killed, just resolve with no data.
resolve(); resolve();
} else { } else {
this._readResult(outputFileName, resolve, reject, error); readResult.call(this, outputFileName, resolve, reject, error);
} }
}); });
}); });
} }
}
// private methods below here // this function was moved outside of class since class is exposed to web
// client via preload API, we do NOT want web client to be able to call this
_readResult(outputFileName, resolve, reject, childProcessErr) { // method - then they could read any file on the disk!
function readResult(outputFileName, resolve, reject, childProcessErr) {
fs.readFile(outputFileName, (readErr, data) => { fs.readFile(outputFileName, (readErr, data) => {
if (readErr) { if (readErr) {
let returnErr; let returnErr;
@ -93,10 +95,10 @@ class ScreenSnippet {
// no such file exists, user likely aborted // no such file exists, user likely aborted
// creating snippet. also include any error when // creating snippet. also include any error when
// creating child process. // creating child process.
returnErr = this._createWarn('file does not exist ' + returnErr = createWarn('file does not exist ' +
childProcessErr); childProcessErr);
} else { } else {
returnErr = this._createError(readErr + ',' + returnErr = createError(readErr + ',' +
childProcessErr); childProcessErr);
} }
@ -105,7 +107,7 @@ class ScreenSnippet {
} }
if (!data) { if (!data) {
reject(this._createWarn('no file data provided')); reject(createWarn('no file data provided'));
return; return;
} }
@ -117,7 +119,7 @@ class ScreenSnippet {
data: output data: output
}); });
} catch (error) { } catch (error) {
reject(this._createError(error)); reject(createError(error));
} }
finally { finally {
// remove tmp file (async) // remove tmp file (async)
@ -131,22 +133,24 @@ class ScreenSnippet {
}); });
} }
}); });
}
} /* eslint-disable class-methods-use-this */
function createError(msg) {
/* eslint-disable class-methods-use-this */
_createError(msg) {
var err = new Error(msg); var err = new Error(msg);
err.type = 'ERROR'; err.type = 'ERROR';
return err; return err;
} }
_createWarn(msg) { function createWarn(msg) {
var err = new Error(msg); var err = new Error(msg);
err.type = 'WARN'; err.type = 'WARN';
return err; return err;
}
/* eslint-enable class-methods-use-this */
} }
/* eslint-enable class-methods-use-this */
module.exports = ScreenSnippet; module.exports = {
ScreenSnippet: ScreenSnippet,
// note: readResult only exposed for testing purposes
readResult: readResult
}

2
package.json
View File

@ -19,7 +19,7 @@
"prebuild": "npm run lint && npm run test && npm run browserify-preload", "prebuild": "npm run lint && npm run test && npm run browserify-preload",
"rebuild": "electron-rebuild -f", "rebuild": "electron-rebuild -f",
"lint": "eslint --ext .js js/", "lint": "eslint --ext .js js/",
"test": "jest --testPathPattern test", "test": "jest --verbose --testPathPattern test",
"browserify-preload": "browserify -o js/preload/_preloadMain.js -x electron --insert-global-vars=__filename,__dirname js/preload/preloadMain.js" "browserify-preload": "browserify -o js/preload/_preloadMain.js -x electron --insert-global-vars=__filename,__dirname js/preload/preloadMain.js"
}, },
"jest": { "jest": {

10
tests/ScreenSnippet.test.js
View File

@ -1,5 +1,5 @@
const ScreenSnippet = require('../js/screenSnippet/ScreenSnippet.js'); const { ScreenSnippet, readResult } = require('../js/screenSnippet/ScreenSnippet.js');
const path = require('path'); const path = require('path');
const fs = require('fs'); const fs = require('fs');
const os = require('os'); const os = require('os');
@ -71,8 +71,7 @@ describe('Tests for ScreenSnippet', function() {
it('should remove output file after completed', function(done) { it('should remove output file after completed', function(done) {
createTestFile(function(testfileName) { createTestFile(function(testfileName) {
let s = new ScreenSnippet(); readResult(testfileName, resolve);
s._readResult(testfileName, resolve);
function resolve() { function resolve() {
// should be long enough before file // should be long enough before file
@ -88,9 +87,8 @@ describe('Tests for ScreenSnippet', function() {
}); });
it('should fail if output file does not exist', function(done) { it('should fail if output file does not exist', function(done) {
let s = new ScreenSnippet(); let nonExistentFile = 'bogus.jpeg';
let nonExistentFile = 'bogus.jpeg' readResult(nonExistentFile, resolve, reject);
s._readResult(nonExistentFile, resolve, reject);
function resolve() { function resolve() {
// shouldn't get here // shouldn't get here