From bc5282a799d50736e453b13b5a5c620a65d338b6 Mon Sep 17 00:00:00 2001 From: Peter Johnson <738069+missinglink@users.noreply.github.com> Date: Wed, 3 Dec 2025 10:47:37 +0100 Subject: [PATCH] refactor: remove stackTraceLine debugging --- controller/predicates/hasRequestErrors.js | 4 +--- controller/predicates/hasRequestParameter.js | 4 +--- controller/predicates/hasResponseData.js | 4 +--- controller/predicates/hasResultsAtLayers.js | 4 +--- controller/predicates/isAdminOnlyAnalysis.js | 4 +--- controller/predicates/isCoarseReverse.js | 4 +--- controller/predicates/isOnlyNonAdminLayers.js | 4 +--- controller/predicates/isPeliasParse.js | 12 ++--------- .../isRequestLayersAnyAddressRelated.js | 4 +--- .../isRequestSourcesIncludesWhosOnFirst.js | 4 +--- .../isRequestSourcesOnlyWhosOnFirst.js | 4 +--- .../predicates/isRequestSourcesUndefined.js | 4 +--- helper/stackTraceLine.js | 11 ---------- test/unit/helper/stackTraceLine.js | 20 ------------------- test/unit/run.js | 1 - 15 files changed, 13 insertions(+), 75 deletions(-) delete mode 100644 helper/stackTraceLine.js delete mode 100644 test/unit/helper/stackTraceLine.js diff --git a/controller/predicates/hasRequestErrors.js b/controller/predicates/hasRequestErrors.js index da9b40b4c..409ee0e05 100644 --- a/controller/predicates/hasRequestErrors.js +++ b/controller/predicates/hasRequestErrors.js @@ -1,13 +1,11 @@ const _ = require('lodash'); const Debug = require('../../helper/debug'); const debugLog = new Debug('controller:predicates:has_request_errors'); -const stackTraceLine = require('../../helper/stackTraceLine'); module.exports = (req, res) => { const has_request_errors = _.get(req, 'errors', []).length > 0; debugLog.push(req, () => ({ - reply: has_request_errors, - stack_trace: stackTraceLine() + reply: has_request_errors })); return has_request_errors; }; diff --git a/controller/predicates/hasRequestParameter.js b/controller/predicates/hasRequestParameter.js index cb4c44bd2..ad9cdeca4 100644 --- a/controller/predicates/hasRequestParameter.js +++ b/controller/predicates/hasRequestParameter.js @@ -1,7 +1,6 @@ const _ = require('lodash'); const Debug = require('../../helper/debug'); const debugLog = new Debug('controller:predicates:has_request_parameter'); -const stackTraceLine = require('../../helper/stackTraceLine'); // returns true IFF req.clean has a key with the supplied name AND a non-empty value module.exports = (parameter) => (req, res) => { @@ -9,8 +8,7 @@ module.exports = (parameter) => (req, res) => { const has_request_parameter = _.isNumber(value) || !_.isEmpty(value); debugLog.push(req, () => ({ - reply: {[parameter]: has_request_parameter}, - stack_trace: stackTraceLine() + reply: {[parameter]: has_request_parameter} })); return has_request_parameter; diff --git a/controller/predicates/hasResponseData.js b/controller/predicates/hasResponseData.js index bc8708636..05ff40300 100644 --- a/controller/predicates/hasResponseData.js +++ b/controller/predicates/hasResponseData.js @@ -1,13 +1,11 @@ const _ = require('lodash'); const Debug = require('../../helper/debug'); const debugLog = new Debug('controller:predicates:has_response_data'); -const stackTraceLine = require('../../helper/stackTraceLine'); module.exports = (request, response) => { const has_response_data = _.get(response, 'data', []).length > 0; debugLog.push(request, () => ({ - reply: has_response_data, - stack_trace: stackTraceLine() + reply: has_response_data })); return has_response_data; }; diff --git a/controller/predicates/hasResultsAtLayers.js b/controller/predicates/hasResultsAtLayers.js index e7a389d0b..af24df896 100644 --- a/controller/predicates/hasResultsAtLayers.js +++ b/controller/predicates/hasResultsAtLayers.js @@ -1,7 +1,6 @@ const _ = require('lodash'); const Debug = require('../../helper/debug'); const debugLog = new Debug('controller:predicates:has_results_at_layers'); -const stackTraceLine = require('../../helper/stackTraceLine'); // returns a function that returns true if any result.layer is in any of the // supplied layers using array intersection @@ -18,8 +17,7 @@ module.exports = (layers) => { )); debugLog.push(request, () => ({ - reply: {[layers]: has_results_at_layers}, - stack_trace: stackTraceLine() + reply: {[layers]: has_results_at_layers} })); return has_results_at_layers; }; diff --git a/controller/predicates/isAdminOnlyAnalysis.js b/controller/predicates/isAdminOnlyAnalysis.js index 5d582cbfb..2411dbf87 100644 --- a/controller/predicates/isAdminOnlyAnalysis.js +++ b/controller/predicates/isAdminOnlyAnalysis.js @@ -1,7 +1,6 @@ const _ = require('lodash'); const Debug = require('../../helper/debug'); const debugLog = new Debug('controller:predicates:is_admin_only_analysis'); -const stackTraceLine = require('../../helper/stackTraceLine'); module.exports = (request, response) => { if (!request.clean.hasOwnProperty('parsed_text')) { @@ -15,8 +14,7 @@ module.exports = (request, response) => { }); debugLog.push(request, () => ({ - reply: is_admin_only_analysis, - stack_trace: stackTraceLine() + reply: is_admin_only_analysis })); return is_admin_only_analysis; }; diff --git a/controller/predicates/isCoarseReverse.js b/controller/predicates/isCoarseReverse.js index f96679a29..22f1f8674 100644 --- a/controller/predicates/isCoarseReverse.js +++ b/controller/predicates/isCoarseReverse.js @@ -2,15 +2,13 @@ const _ = require('lodash'); const Debug = require('../../helper/debug'); const debugLog = new Debug('controller:predicates:is_coarse_reverse'); const non_coarse_layers = ['address', 'street', 'venue']; -const stackTraceLine = require('../../helper/stackTraceLine'); module.exports = (req, res) => { // returns true if layers is undefined, empty, or contains 'address', 'street', or 'venue' const is_coarse_reverse = !_.isEmpty(req.clean.layers) && _.isEmpty(_.intersection(req.clean.layers, non_coarse_layers)); debugLog.push(req, () => ({ - reply: is_coarse_reverse, - stack_trace: stackTraceLine() + reply: is_coarse_reverse })); return is_coarse_reverse; }; diff --git a/controller/predicates/isOnlyNonAdminLayers.js b/controller/predicates/isOnlyNonAdminLayers.js index eed765c80..9796fd176 100644 --- a/controller/predicates/isOnlyNonAdminLayers.js +++ b/controller/predicates/isOnlyNonAdminLayers.js @@ -1,7 +1,6 @@ const _ = require('lodash'); const Debug = require('../../helper/debug'); const debugLog = new Debug('controller:predicates:is_only_non_admin_layers'); -const stackTraceLine = require('../../helper/stackTraceLine'); // return true IFF req.clean.layers is empty OR there are non-venue/address/street layers module.exports = (req, res) => { @@ -9,8 +8,7 @@ module.exports = (req, res) => { _.isEmpty(_.difference(req.clean.layers, ['venue', 'address', 'street'])); debugLog.push(req, () => ({ - reply: is_only_non_admin_layers, - stack_trace: stackTraceLine() + reply: is_only_non_admin_layers })); return is_only_non_admin_layers; }; diff --git a/controller/predicates/isPeliasParse.js b/controller/predicates/isPeliasParse.js index 79a6149ad..3ab00de0d 100644 --- a/controller/predicates/isPeliasParse.js +++ b/controller/predicates/isPeliasParse.js @@ -1,14 +1,6 @@ const _ = require('lodash'); -const Debug = require('../../helper/debug'); -const debugLog = new Debug('controller:predicates:is_pelias_parse'); -const stackTraceLine = require('../../helper/stackTraceLine'); // returns true IFF req.clean.parser is pelias -module.exports = (req, res) => { - const is_pelias_parse = _.get(req, 'clean.parser') === 'pelias'; - debugLog.push(req, () => ({ - reply: is_pelias_parse, - stack_trace: stackTraceLine() - })); - return is_pelias_parse; +module.exports = (req) => { + return _.get(req, 'clean.parser') === 'pelias'; }; diff --git a/controller/predicates/isRequestLayersAnyAddressRelated.js b/controller/predicates/isRequestLayersAnyAddressRelated.js index f30b56342..5755fb029 100644 --- a/controller/predicates/isRequestLayersAnyAddressRelated.js +++ b/controller/predicates/isRequestLayersAnyAddressRelated.js @@ -1,7 +1,6 @@ const _ = require('lodash'); const Debug = require('../../helper/debug'); const debugLog = new Debug('controller:predicates:is_request_layers_any_address_related'); -const stackTraceLine = require('../../helper/stackTraceLine'); // return true if any layers allowed by the query are related to an address query // this includes address and street but NOT venue, postalcode, admin, and custom layers @@ -20,8 +19,7 @@ module.exports = (req, res) => { } debugLog.push(req, () => ({ - reply: result, - stack_trace: stackTraceLine() + reply: result })); return result; diff --git a/controller/predicates/isRequestSourcesIncludesWhosOnFirst.js b/controller/predicates/isRequestSourcesIncludesWhosOnFirst.js index fe3fcd8bb..546f7c5d7 100644 --- a/controller/predicates/isRequestSourcesIncludesWhosOnFirst.js +++ b/controller/predicates/isRequestSourcesIncludesWhosOnFirst.js @@ -1,7 +1,6 @@ const _ = require('lodash'); const Debug = require('../../helper/debug'); const debugLog = new Debug('controller:predicates:is_request_sources_includes_whosonfirst'); -const stackTraceLine = require('../../helper/stackTraceLine'); // returns true IFF 'whosonfirst' is included in the requested sources module.exports = (req, res) => { @@ -9,8 +8,7 @@ module.exports = (req, res) => { 'whosonfirst' ); debugLog.push(req, () => ({ - reply: is_request_sources_includes_whosonfirst, - stack_trace: stackTraceLine() + reply: is_request_sources_includes_whosonfirst })); return is_request_sources_includes_whosonfirst; }; diff --git a/controller/predicates/isRequestSourcesOnlyWhosOnFirst.js b/controller/predicates/isRequestSourcesOnlyWhosOnFirst.js index 8554e0c21..728f18f11 100644 --- a/controller/predicates/isRequestSourcesOnlyWhosOnFirst.js +++ b/controller/predicates/isRequestSourcesOnlyWhosOnFirst.js @@ -1,7 +1,6 @@ const _ = require('lodash'); const Debug = require('../../helper/debug'); const debugLog = new Debug('controller:predicates:is_request_sources_only_whosonfirst'); -const stackTraceLine = require('../../helper/stackTraceLine'); // returns true IFF 'whosonfirst' is the only requested source module.exports = (req, res) => { @@ -10,8 +9,7 @@ module.exports = (req, res) => { ['whosonfirst'] ); debugLog.push(req, () => ({ - reply: is_request_sources_only_whosonfirst, - stack_trace: stackTraceLine() + reply: is_request_sources_only_whosonfirst })); return is_request_sources_only_whosonfirst; }; diff --git a/controller/predicates/isRequestSourcesUndefined.js b/controller/predicates/isRequestSourcesUndefined.js index 77e8afea6..40bfcabe3 100644 --- a/controller/predicates/isRequestSourcesUndefined.js +++ b/controller/predicates/isRequestSourcesUndefined.js @@ -1,7 +1,6 @@ const _ = require('lodash'); const Debug = require('../../helper/debug'); const debugLog = new Debug('controller:predicates:is_request_sources_undefined'); -const stackTraceLine = require('../../helper/stackTraceLine'); // returns true IFF there are no requested sources module.exports = (req, res) => { @@ -9,8 +8,7 @@ module.exports = (req, res) => { _.get(req, 'clean.sources') ); debugLog.push(req, () => ({ - reply: is_request_sources_undefined, - stack_trace: stackTraceLine() + reply: is_request_sources_undefined })); return is_request_sources_undefined; }; diff --git a/helper/stackTraceLine.js b/helper/stackTraceLine.js deleted file mode 100644 index e1312ae6e..000000000 --- a/helper/stackTraceLine.js +++ /dev/null @@ -1,11 +0,0 @@ -module.exports = () => { - const stack = new Error().stack.split('\n'); - let targetLine; - - stack.forEach((line) => { - if(line.indexOf('at controller') !== -1) { - targetLine = line.trim(); - } - }); - return targetLine; -}; diff --git a/test/unit/helper/stackTraceLine.js b/test/unit/helper/stackTraceLine.js deleted file mode 100644 index 379b26647..000000000 --- a/test/unit/helper/stackTraceLine.js +++ /dev/null @@ -1,20 +0,0 @@ -const stackTraceLine = require('../../../helper/stackTraceLine'); - -module.exports.tests = {}; -module.exports.tests.stackTrace = (test, common) => { - test('No exceptions thrown when function is called', (t) => { - t.doesNotThrow(stackTraceLine, 'No exceptions thrown'); - t.end(); - }); -}; - -module.exports.all = function (tape, common) { - - function test(name, testFunction) { - return tape('[helper] stackTraceLine: ' + name, testFunction); - } - - for( var testCase in module.exports.tests ){ - module.exports.tests[testCase](test, common); - } -}; diff --git a/test/unit/run.js b/test/unit/run.js index 66d512ded..3bd6db299 100644 --- a/test/unit/run.js +++ b/test/unit/run.js @@ -42,7 +42,6 @@ var tests = [ require('./helper/logging'), require('./helper/TypeMapping'), require('./helper/type_mapping'), - require('./helper/stackTraceLine'), require('./helper/unicode'), require('./middleware/access_log'), require('./middleware/accuracy'),