Update custom "callsite-record" module

DevExpress · Mar 30, 2017 · 846e125 · 846e125
1 parent d21548c
commit 846e125
Show file tree

Hide file tree

Showing 57 changed files with 87 additions and 77 deletions.
diff --git a/modules/callsite-record/index.js b/modules/callsite-record/index.js
@@ -5,7 +5,6 @@ var stackParser = require('error-stack-parser');
 var padStart    = require('lodash').padStart;
 var defaults    = require('lodash').defaults;
 var highlight   = require('highlight-es');
-var wrapCallSite = require('source-map-support').wrapCallSite;
 
 var renderers = {
     default: require('./renderers/default'),
@@ -283,21 +282,23 @@ CallsiteRecord.fromError = function (error, isCallsiteFrame) {
 };
 
 // API
-module.exports = function createCallsiteRecord (/* err, isCallsiteFrame || fnName, typeName */) {
-    if (arguments[0] instanceof Error)
-        return CallsiteRecord.fromError(arguments[0], arguments[1]);
+module.exports = function createCallsiteRecord (options) { /*{ forError, isCallsiteFrame, byFunctionName, typeName, processFrameFn }*/
+    if (options.forError)
+        return CallsiteRecord.fromError(options.forError, options.isCallsiteFrame);
 
-    else if (typeof arguments[0] === 'string') {
+    else if (options.byFunctionName) {
         var stackFrames = callsite();
 
-        stackFrames = stackFrames.map(function (frame) {
-            return wrapCallSite(frame)
-        });
+        if (options.processFrameFn) {
+            stackFrames = stackFrames.map(function (frame) {
+                return options.processFrameFn(frame);
+            });
+        }
 
         // NOTE: remove API call
         stackFrames.shift();
 
-        return CallsiteRecord.fromStackFrames(stackFrames, arguments[0], arguments[1]);
+        return CallsiteRecord.fromStackFrames(stackFrames, options.byFunctionName, options.typeName);
     }
 
     return null;

diff --git a/src/api/test-controller/index.js b/src/api/test-controller/index.js
@@ -1,7 +1,7 @@
 import Promise from 'pinkie';
 import { identity, assign, isNil as isNullOrUndefined } from 'lodash';
 import { MissingAwaitError } from '../../errors/test-run';
-import getCallsite from '../../errors/get-callsite';
+import { getCallsiteForMethod } from '../../errors/get-callsite';
 import ClientFunctionBuilder from '../../client-functions/client-function-builder';
 import Assertion from './assertion';
 import { getDelegatedAPIList, delegateAPI } from '../../utils/delegated-api';
@@ -82,7 +82,7 @@ export default class TestController {
     _enqueueTask (apiMethodName, createTaskExecutor) {
         this._checkForMissingAwait();
 
-        var callsite = getCallsite(apiMethodName);
+        var callsite = getCallsiteForMethod(apiMethodName);
         var executor = createTaskExecutor(callsite);
 
         this.executionChain       = this.executionChain.then(executor);
@@ -242,7 +242,7 @@ export default class TestController {
     }
 
     _getNativeDialogHistory$ () {
-        var callsite = getCallsite('getNativeDialogHistory');
+        var callsite = getCallsiteForMethod('getNativeDialogHistory');
 
         return this.testRun.executeCommand(new GetNativeDialogHistoryCommand(), callsite);
     }

diff --git a/src/client-functions/client-function-builder.js b/src/client-functions/client-function-builder.js
@@ -7,7 +7,7 @@ import compileClientFunction from '../compiler/es-next/compile-client-function';
 import { APIError, ClientFunctionAPIError } from '../errors/runtime';
 import { assertType, is } from '../errors/runtime/type-assertions';
 import MESSAGE from '../errors/runtime/message';
-import getCallsite from '../errors/get-callsite';
+import { getCallsiteForMethod } from '../errors/get-callsite';
 import ClientFunctionResultPromise from './result-promise';
 import testRunMarker from '../test-run/marker-symbol';
 
@@ -64,7 +64,7 @@ export default class ClientFunctionBuilder {
 
         var clientFn = function __$$clientFunction$$ () {
             var testRun  = builder.getBoundTestRun() || testRunTracker.resolveContextTestRun();
-            var callsite = getCallsite(builder.callsiteNames.execution);
+            var callsite = getCallsiteForMethod(builder.callsiteNames.execution);
             var args     = [];
 
             // OPTIMIZATION: don't leak `arguments` object.

diff --git a/src/client-functions/selectors/add-api.js b/src/client-functions/selectors/add-api.js
@@ -2,7 +2,7 @@ import { assign } from 'lodash';
 import clientFunctionBuilderSymbol from '../builder-symbol';
 import { ELEMENT_SNAPSHOT_PROPERTIES, NODE_SNAPSHOT_PROPERTIES } from './snapshot-properties';
 import { CantObtainInfoForElementSpecifiedBySelectorError } from '../../errors/test-run';
-import getCallsite from '../../errors/get-callsite';
+import { getCallsiteForMethod } from '../../errors/get-callsite';
 import ClientFunctionBuilder from '../client-function-builder';
 import ClientFunctionResultPromise from '../result-promise';
 import { assertType, is } from '../../errors/runtime/type-assertions';
@@ -106,7 +106,7 @@ function addSnapshotProperties (obj, getSelector, properties) {
     properties.forEach(prop => {
         Object.defineProperty(obj, prop, {
             get: () => {
-                var callsite = getCallsite('get');
+                var callsite = getCallsiteForMethod('get');
 
                 return ClientFunctionResultPromise.fromFn(async () => {
                     var snapshot = await getSnapshot(getSelector, callsite);
@@ -149,7 +149,7 @@ function addSnapshotPropertyShorthands (obj, getSelector, customDOMProperties, c
     addCustomMethods(obj, getSelector, customMethods);
 
     obj.getStyleProperty = prop => {
-        var callsite = getCallsite('getStyleProperty');
+        var callsite = getCallsiteForMethod('getStyleProperty');
 
         return ClientFunctionResultPromise.fromFn(async () => {
             var snapshot = await getSnapshot(getSelector, callsite);
@@ -159,7 +159,7 @@ function addSnapshotPropertyShorthands (obj, getSelector, customDOMProperties, c
     };
 
     obj.getAttribute = attrName => {
-        var callsite = getCallsite('getAttribute');
+        var callsite = getCallsiteForMethod('getAttribute');
 
         return ClientFunctionResultPromise.fromFn(async () => {
             var snapshot = await getSnapshot(getSelector, callsite);
@@ -169,7 +169,7 @@ function addSnapshotPropertyShorthands (obj, getSelector, customDOMProperties, c
     };
 
     obj.getBoundingClientRectProperty = prop => {
-        var callsite = getCallsite('getBoundingClientRectProperty');
+        var callsite = getCallsiteForMethod('getBoundingClientRectProperty');
 
         return ClientFunctionResultPromise.fromFn(async () => {
             var snapshot = await getSnapshot(getSelector, callsite);
@@ -179,7 +179,7 @@ function addSnapshotPropertyShorthands (obj, getSelector, customDOMProperties, c
     };
 
     obj.hasClass = name => {
-        var callsite = getCallsite('hasClass');
+        var callsite = getCallsiteForMethod('hasClass');
 
         return ClientFunctionResultPromise.fromFn(async () => {
             var snapshot = await getSnapshot(getSelector, callsite);
@@ -192,7 +192,7 @@ function addSnapshotPropertyShorthands (obj, getSelector, customDOMProperties, c
 function createCounter (getSelector, SelectorBuilder) {
     var builder  = new SelectorBuilder(getSelector(), { counterMode: true }, { instantiation: 'Selector' });
     var counter  = builder.getFunction();
-    var callsite = getCallsite('get');
+    var callsite = getCallsiteForMethod('get');
 
     return async () => {
         try {

diff --git a/src/errors/get-callsite.js b/src/errors/get-callsite.js
@@ -1,19 +1,28 @@
 import createCallsiteRecord from '../../modules/callsite-record';
 import stackCleaningHook from './stack-cleaning-hook';
+import { wrapCallSite } from 'source-map-support';
 
 const STACK_TRACE_LIMIT = 2000;
 
-export default function getCallsite (methodName, typeName) {
+function getCallsite (options) {
     var originalStackCleaningEnabled = stackCleaningHook.enabled;
     var originalStackTraceLimit      = Error.stackTraceLimit;
 
     stackCleaningHook.enabled = false;
     Error.stackTraceLimit     = STACK_TRACE_LIMIT;
 
-    var callsiteRecord = createCallsiteRecord(methodName, typeName);
+    var callsiteRecord = createCallsiteRecord(options);
 
     Error.stackTraceLimit     = originalStackTraceLimit;
     stackCleaningHook.enabled = originalStackCleaningEnabled;
 
     return callsiteRecord;
 }
+
+export function getCallsiteForMethod (methodName, typeName) {
+    return getCallsite({ byFunctionName: methodName, typeName, processFrameFn: wrapCallSite });
+}
+
+export function getCallsiteForError (error, isCallsiteFrame) {
+    return getCallsite({ forError: error, isCallsiteFrame });
+}
diff --git a/src/errors/process-test-fn-error.js b/src/errors/process-test-fn-error.js
@@ -1,5 +1,5 @@
 import { sep } from 'path';
-import getCallsite from './get-callsite';
+import { getCallsiteForError } from './get-callsite';
 import { APIError } from './runtime';
 
 import {
@@ -34,7 +34,7 @@ export default function processTestFnError (err) {
 
         // NOTE: assertion libraries can add their source files to the error stack frames.
         // We should skip them to create a correct callsite for the assertion error.
-        var callsite = isAssertionError ? getCallsite(err, isAssertionErrorCallsiteFrame) : getCallsite(err);
+        var callsite = isAssertionError ? getCallsiteForError(err, isAssertionErrorCallsiteFrame) : getCallsiteForError(err);
 
         return isAssertionError ?
                new ExternalAssertionLibraryError(err, callsite) :

diff --git a/src/errors/runtime/index.js b/src/errors/runtime/index.js
@@ -1,7 +1,7 @@
 import { renderers } from 'callsite-record';
 import MESSAGE from './message';
 import createStackFilter from '../create-stack-filter';
-import getCallsite from '../get-callsite';
+import { getCallsiteForMethod } from '../get-callsite';
 import renderTemplate from '../../utils/render-template';
 
 // Errors
@@ -34,7 +34,7 @@ export class APIError extends Error {
 
         // NOTE: `rawMessage` is used in error substitution if it occurs in test run.
         this.rawMessage  = rawMessage;
-        this.callsite    = getCallsite(methodName);
+        this.callsite    = getCallsiteForMethod(methodName);
         this.constructor = APIError;
 
         // HACK: prototype properties don't work with built-in subclasses

diff --git a/test/server/data/expected-test-run-errors/action-additional-element-is-invisible-error b/test/server/data/expected-test-run-errors/action-additional-element-is-invisible-error
@@ -4,7 +4,7 @@ Browser: Chrome 15.0.874 / Mac OS X 10.8.1
 Screenshot: /unix/path/with/<tag>
 
    18 |function func1 () {
-   19 |    record = createCallsiteRecord('func1');
+   19 |    record = createCallsiteRecord({ byFunctionName: 'func1' });
    20 |}
    21 |
    22 |(function func2 () {

diff --git a/test/server/data/expected-test-run-errors/action-additional-element-not-found-error b/test/server/data/expected-test-run-errors/action-additional-element-not-found-error
@@ -4,7 +4,7 @@ Browser: Chrome 15.0.874 / Mac OS X 10.8.1
 Screenshot: /unix/path/with/<tag>
 
    18 |function func1 () {
-   19 |    record = createCallsiteRecord('func1');
+   19 |    record = createCallsiteRecord({ byFunctionName: 'func1' });
    20 |}
    21 |
    22 |(function func2 () {

diff --git a/...er/data/expected-test-run-errors/action-additional-selector-matches-wrong-node-type-error b/...er/data/expected-test-run-errors/action-additional-selector-matches-wrong-node-type-error
@@ -5,7 +5,7 @@ Browser: Chrome 15.0.874 / Mac OS X 10.8.1
 Screenshot: /unix/path/with/<tag>
 
    18 |function func1 () {
-   19 |    record = createCallsiteRecord('func1');
+   19 |    record = createCallsiteRecord({ byFunctionName: 'func1' });
    20 |}
    21 |
    22 |(function func2 () {

diff --git a/test/server/data/expected-test-run-errors/action-boolean-option-error b/test/server/data/expected-test-run-errors/action-boolean-option-error
@@ -5,7 +5,7 @@ Browser: Chrome 15.0.874 / Mac OS X 10.8.1
 Screenshot: /unix/path/with/<tag>
 
    18 |function func1 () {
-   19 |    record = createCallsiteRecord('func1');
+   19 |    record = createCallsiteRecord({ byFunctionName: 'func1' });
    20 |}
    21 |
    22 |(function func2 () {

diff --git a/test/server/data/expected-test-run-errors/action-can-not-find-file-to-upload-error b/test/server/data/expected-test-run-errors/action-can-not-find-file-to-upload-error
@@ -6,7 +6,7 @@ Browser: Chrome 15.0.874 / Mac OS X 10.8.1
 Screenshot: /unix/path/with/<tag>
 
    18 |function func1 () {
-   19 |    record = createCallsiteRecord('func1');
+   19 |    record = createCallsiteRecord({ byFunctionName: 'func1' });
    20 |}
    21 |
    22 |(function func2 () {

diff --git a/test/server/data/expected-test-run-errors/action-element-is-invisible-error b/test/server/data/expected-test-run-errors/action-element-is-invisible-error
@@ -4,7 +4,7 @@ Browser: Chrome 15.0.874 / Mac OS X 10.8.1
 Screenshot: /unix/path/with/<tag>
 
    18 |function func1 () {
-   19 |    record = createCallsiteRecord('func1');
+   19 |    record = createCallsiteRecord({ byFunctionName: 'func1' });
    20 |}
    21 |
    22 |(function func2 () {

diff --git a/test/server/data/expected-test-run-errors/action-element-is-not-file-input-error b/test/server/data/expected-test-run-errors/action-element-is-not-file-input-error
@@ -4,7 +4,7 @@ Browser: Chrome 15.0.874 / Mac OS X 10.8.1
 Screenshot: /unix/path/with/<tag>
 
    18 |function func1 () {
-   19 |    record = createCallsiteRecord('func1');
+   19 |    record = createCallsiteRecord({ byFunctionName: 'func1' });
    20 |}
    21 |
    22 |(function func2 () {

diff --git a/test/server/data/expected-test-run-errors/action-element-non-content-editable-error b/test/server/data/expected-test-run-errors/action-element-non-content-editable-error
@@ -6,7 +6,7 @@ Browser: Chrome 15.0.874 / Mac OS X 10.8.1
 Screenshot: /unix/path/with/<tag>
 
    18 |function func1 () {
-   19 |    record = createCallsiteRecord('func1');
+   19 |    record = createCallsiteRecord({ byFunctionName: 'func1' });
    20 |}
    21 |
    22 |(function func2 () {

diff --git a/test/server/data/expected-test-run-errors/action-element-non-editable-error b/test/server/data/expected-test-run-errors/action-element-non-editable-error
@@ -5,7 +5,7 @@ Browser: Chrome 15.0.874 / Mac OS X 10.8.1
 Screenshot: /unix/path/with/<tag>
 
    18 |function func1 () {
-   19 |    record = createCallsiteRecord('func1');
+   19 |    record = createCallsiteRecord({ byFunctionName: 'func1' });
    20 |}
    21 |
    22 |(function func2 () {

diff --git a/test/server/data/expected-test-run-errors/action-element-not-found-error b/test/server/data/expected-test-run-errors/action-element-not-found-error
@@ -4,7 +4,7 @@ Browser: Chrome 15.0.874 / Mac OS X 10.8.1
 Screenshot: /unix/path/with/<tag>
 
    18 |function func1 () {
-   19 |    record = createCallsiteRecord('func1');
+   19 |    record = createCallsiteRecord({ byFunctionName: 'func1' });
    20 |}
    21 |
    22 |(function func2 () {

diff --git a/test/server/data/expected-test-run-errors/action-element-not-iframe-error b/test/server/data/expected-test-run-errors/action-element-not-iframe-error
@@ -4,7 +4,7 @@ Browser: Chrome 15.0.874 / Mac OS X 10.8.1
 Screenshot: /unix/path/with/<tag>
 
    18 |function func1 () {
-   19 |    record = createCallsiteRecord('func1');
+   19 |    record = createCallsiteRecord({ byFunctionName: 'func1' });
    20 |}
    21 |
    22 |(function func2 () {

diff --git a/test/server/data/expected-test-run-errors/action-element-not-text-area-error b/test/server/data/expected-test-run-errors/action-element-not-text-area-error
@@ -4,7 +4,7 @@ Browser: Chrome 15.0.874 / Mac OS X 10.8.1
 Screenshot: /unix/path/with/<tag>
 
    18 |function func1 () {
-   19 |    record = createCallsiteRecord('func1');
+   19 |    record = createCallsiteRecord({ byFunctionName: 'func1' });
    20 |}
    21 |
    22 |(function func2 () {

diff --git a/test/server/data/expected-test-run-errors/action-iframe-is-not-loaded-error b/test/server/data/expected-test-run-errors/action-iframe-is-not-loaded-error
@@ -4,7 +4,7 @@ Browser: Chrome 15.0.874 / Mac OS X 10.8.1
 Screenshot: /unix/path/with/<tag>
 
    18 |function func1 () {
-   19 |    record = createCallsiteRecord('func1');
+   19 |    record = createCallsiteRecord({ byFunctionName: 'func1' });
    20 |}
    21 |
    22 |(function func2 () {

diff --git a/test/server/data/expected-test-run-errors/action-incorrect-keys-error b/test/server/data/expected-test-run-errors/action-incorrect-keys-error
@@ -4,7 +4,7 @@ Browser: Chrome 15.0.874 / Mac OS X 10.8.1
 Screenshot: /unix/path/with/<tag>
 
    18 |function func1 () {
-   19 |    record = createCallsiteRecord('func1');
+   19 |    record = createCallsiteRecord({ byFunctionName: 'func1' });
    20 |}
    21 |
    22 |(function func2 () {

diff --git a/test/server/data/expected-test-run-errors/action-integer-argument-error b/test/server/data/expected-test-run-errors/action-integer-argument-error
@@ -4,7 +4,7 @@ Browser: Chrome 15.0.874 / Mac OS X 10.8.1
 Screenshot: /unix/path/with/<tag>
 
    18 |function func1 () {
-   19 |    record = createCallsiteRecord('func1');
+   19 |    record = createCallsiteRecord({ byFunctionName: 'func1' });
    20 |}
    21 |
    22 |(function func2 () {

diff --git a/test/server/data/expected-test-run-errors/action-integer-option-error b/test/server/data/expected-test-run-errors/action-integer-option-error
@@ -4,7 +4,7 @@ Browser: Chrome 15.0.874 / Mac OS X 10.8.1
 Screenshot: /unix/path/with/<tag>
 
    18 |function func1 () {
-   19 |    record = createCallsiteRecord('func1');
+   19 |    record = createCallsiteRecord({ byFunctionName: 'func1' });
    20 |}
    21 |
    22 |(function func2 () {

diff --git a/test/server/data/expected-test-run-errors/action-non-empty-string-array-argument-error b/test/server/data/expected-test-run-errors/action-non-empty-string-array-argument-error
@@ -5,7 +5,7 @@ Browser: Chrome 15.0.874 / Mac OS X 10.8.1
 Screenshot: /unix/path/with/<tag>
 
    18 |function func1 () {
-   19 |    record = createCallsiteRecord('func1');
+   19 |    record = createCallsiteRecord({ byFunctionName: 'func1' });
    20 |}
    21 |
    22 |(function func2 () {

diff --git a/test/server/data/expected-test-run-errors/action-options-type-error b/test/server/data/expected-test-run-errors/action-options-type-error
@@ -5,7 +5,7 @@ Browser: Chrome 15.0.874 / Mac OS X 10.8.1
 Screenshot: /unix/path/with/<tag>
 
    18 |function func1 () {
-   19 |    record = createCallsiteRecord('func1');
+   19 |    record = createCallsiteRecord({ byFunctionName: 'func1' });
    20 |}
    21 |
    22 |(function func2 () {

diff --git a/test/server/data/expected-test-run-errors/action-positive-integer-argument-error b/test/server/data/expected-test-run-errors/action-positive-integer-argument-error
@@ -4,7 +4,7 @@ Browser: Chrome 15.0.874 / Mac OS X 10.8.1
 Screenshot: /unix/path/with/<tag>
 
    18 |function func1 () {
-   19 |    record = createCallsiteRecord('func1');
+   19 |    record = createCallsiteRecord({ byFunctionName: 'func1' });
    20 |}
    21 |
    22 |(function func2 () {

diff --git a/test/server/data/expected-test-run-errors/action-positive-integer-option-error b/test/server/data/expected-test-run-errors/action-positive-integer-option-error
@@ -4,7 +4,7 @@ Browser: Chrome 15.0.874 / Mac OS X 10.8.1
 Screenshot: /unix/path/with/<tag>
 
    18 |function func1 () {
-   19 |    record = createCallsiteRecord('func1');
+   19 |    record = createCallsiteRecord({ byFunctionName: 'func1' });
    20 |}
    21 |
    22 |(function func2 () {