fix: log error for illegal property access only once per property
This commit is contained in:
@@ -3,6 +3,7 @@ import Exception from './exception';
|
|||||||
import { registerDefaultHelpers } from './helpers';
|
import { registerDefaultHelpers } from './helpers';
|
||||||
import { registerDefaultDecorators } from './decorators';
|
import { registerDefaultDecorators } from './decorators';
|
||||||
import logger from './logger';
|
import logger from './logger';
|
||||||
|
import { resetLoggedProperties } from './internal/proto-access';
|
||||||
|
|
||||||
export const VERSION = '4.7.0';
|
export const VERSION = '4.7.0';
|
||||||
export const COMPILER_REVISION = 8;
|
export const COMPILER_REVISION = 8;
|
||||||
@@ -78,6 +79,13 @@ HandlebarsEnvironment.prototype = {
|
|||||||
},
|
},
|
||||||
unregisterDecorator: function(name) {
|
unregisterDecorator: function(name) {
|
||||||
delete this.decorators[name];
|
delete this.decorators[name];
|
||||||
|
},
|
||||||
|
/**
|
||||||
|
* Reset the memory of illegal property accesses that have already been logged.
|
||||||
|
* @deprecated should only be used in handlebars test-cases
|
||||||
|
*/
|
||||||
|
resetLoggedPropertyAccesses() {
|
||||||
|
resetLoggedProperties();
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
import { createNewLookupObject } from './create-new-lookup-object';
|
import { createNewLookupObject } from './create-new-lookup-object';
|
||||||
import * as logger from '../logger';
|
import * as logger from '../logger';
|
||||||
|
|
||||||
|
const loggedProperties = Object.create(null);
|
||||||
|
|
||||||
export function createProtoAccessControl(runtimeOptions) {
|
export function createProtoAccessControl(runtimeOptions) {
|
||||||
let defaultMethodWhiteList = Object.create(null);
|
let defaultMethodWhiteList = Object.create(null);
|
||||||
defaultMethodWhiteList['constructor'] = false;
|
defaultMethodWhiteList['constructor'] = false;
|
||||||
@@ -45,12 +47,24 @@ function checkWhiteList(protoAccessControlForType, propertyName) {
|
|||||||
if (protoAccessControlForType.defaultValue !== undefined) {
|
if (protoAccessControlForType.defaultValue !== undefined) {
|
||||||
return protoAccessControlForType.defaultValue;
|
return protoAccessControlForType.defaultValue;
|
||||||
}
|
}
|
||||||
// eslint-disable-next-line no-console
|
logUnexpecedPropertyAccessOnce(propertyName);
|
||||||
logger.log(
|
|
||||||
'error',
|
|
||||||
`Handlebars: Access has been denied to resolve the property "${propertyName}" because it is not an "own property" of its parent.\n` +
|
|
||||||
`You can add a runtime option to disable the check or this warning:\n` +
|
|
||||||
`See http://localhost:8080/api-reference/runtime-options.html#options-to-control-prototype-access for details`
|
|
||||||
);
|
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function logUnexpecedPropertyAccessOnce(propertyName) {
|
||||||
|
if (loggedProperties[propertyName] !== true) {
|
||||||
|
loggedProperties[propertyName] = true;
|
||||||
|
logger.log(
|
||||||
|
'error',
|
||||||
|
`Handlebars: Access has been denied to resolve the property "${propertyName}" because it is not an "own property" of its parent.\n` +
|
||||||
|
`You can add a runtime option to disable the check or this warning:\n` +
|
||||||
|
`See http://localhost:8080/api-reference/runtime-options.html#options-to-control-prototype-access for details`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export function resetLoggedProperties() {
|
||||||
|
Object.keys(loggedProperties).forEach(propertyName => {
|
||||||
|
delete loggedProperties[propertyName];
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|||||||
@@ -190,6 +190,10 @@ describe('security issues', function() {
|
|||||||
return 'returnValue';
|
return 'returnValue';
|
||||||
};
|
};
|
||||||
|
|
||||||
|
beforeEach(function() {
|
||||||
|
handlebarsEnv.resetLoggedPropertyAccesses();
|
||||||
|
});
|
||||||
|
|
||||||
afterEach(function() {
|
afterEach(function() {
|
||||||
sinon.restore();
|
sinon.restore();
|
||||||
});
|
});
|
||||||
@@ -214,6 +218,23 @@ describe('security issues', function() {
|
|||||||
expect(spy.args[0][0]).to.match(/Handlebars: Access has been denied/);
|
expect(spy.args[0][0]).to.match(/Handlebars: Access has been denied/);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it('should only log the warning once', function() {
|
||||||
|
var spy = sinon.spy(console, 'error');
|
||||||
|
|
||||||
|
expectTemplate('{{aMethod}}')
|
||||||
|
.withInput(new TestClass())
|
||||||
|
.withCompileOptions(compileOptions)
|
||||||
|
.toCompileTo('');
|
||||||
|
|
||||||
|
expectTemplate('{{aMethod}}')
|
||||||
|
.withInput(new TestClass())
|
||||||
|
.withCompileOptions(compileOptions)
|
||||||
|
.toCompileTo('');
|
||||||
|
|
||||||
|
expect(spy.calledOnce).to.be.true();
|
||||||
|
expect(spy.args[0][0]).to.match(/Handlebars: Access has been denied/);
|
||||||
|
});
|
||||||
|
|
||||||
it('can be allowed, which disables the warning', function() {
|
it('can be allowed, which disables the warning', function() {
|
||||||
var spy = sinon.spy(console, 'error');
|
var spy = sinon.spy(console, 'error');
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user