How to add a custom helper ?

[iamvarshith]

Hey 🤗 , I have been trying to hide some part of URL request in the report, Especially the API keys, I wanted to add an helper function to a custom template. I have done something like this. By copying the default template.

<script>
    Handlebars.registerHelper('no-api', function (url) {
        if (url.includes('apikey')) {
            return url.split('apikey=')[0];
        } else {
            return url;
        }
    })

</script>

and in the HTML part something Like this
<span><i class="fas fa-info-circle"></i></span><strong> Request URL:</strong> <a href="{{no-api request.url}}" target="_blank">{{no-api request.url}}</a><br>

But I am having this error,

/usr/local/lib/node_modules/newman-reporter-htmlextra/node_modules/handlebars/dist/cjs/handlebars/helpers/helper-missing.js:19
      throw new _exception2['default']('Missing helper: "' + arguments[arguments.length - 1].name + '"');
      ^
Error: Missing helper: "no-api"
    at Object.<anonymous> (/usr/local/lib/node_modules/newman-reporter-htmlextra/node_modules/handlebars/dist/cjs/handlebars/helpers/helper-missing.js:19:13)
    at Object.wrapper (/usr/local/lib/node_modules/newman-reporter-htmlextra/node_modules/handlebars/dist/cjs/handlebars/internal/wrapHelper.js:15:19)
    at eval (eval at createFunctionContext (/usr/local/lib/node_modules/newman-reporter-htmlextra/node_modules/handlebars/dist/cjs/handlebars/compiler/javascript-compiler.js:262:23), <anonymous>:43:102)
    at Object.prog [as fn] (/usr/local/lib/node_modules/newman-reporter-htmlextra/node_modules/handlebars/dist/cjs/handlebars/runtime.js:268:12)
    at Object.<anonymous> (/usr/local/lib/node_modules/newman-reporter-htmlextra/lib/index.js:158:24)
    at Object.wrapper (/usr/local/lib/node_modules/newman-reporter-htmlextra/node_modules/handlebars/dist/cjs/handlebars/internal/wrapHelper.js:15:19)
    at eval (eval at createFunctionContext (/usr/local/lib/node_modules/newman-reporter-htmlextra/node_modules/handlebars/dist/cjs/handlebars/compiler/javascript-compiler.js:262:23), <anonymous>:10:134)
    at prog (/usr/local/lib/node_modules/newman-reporter-htmlextra/node_modules/handlebars/dist/cjs/handlebars/runtime.js:268:12)
    at execIteration (/usr/local/lib/node_modules/newman-reporter-htmlextra/node_modules/handlebars/dist/cjs/handlebars/helpers/each.js:51:19)
    at Object.<anonymous> (/usr/local/lib/node_modules/newman-reporter-htmlextra/node_modules/handlebars/dist/cjs/handlebars/helpers/each.js:61:13)
    at Object.wrapper (/usr/local/lib/node_modules/newman-reporter-htmlextra/node_modules/handlebars/dist/cjs/handlebars/internal/wrapHelper.js:15:19)
    at eval (eval at createFunctionContext (/usr/local/lib/node_modules/newman-reporter-htmlextra/node_modules/handlebars/dist/cjs/handlebars/compiler/javascript-compiler.js:262:23), <anonymous>:11:49)
    at Object.prog [as fn] (/usr/local/lib/node_modules/newman-reporter-htmlextra/node_modules/handlebars/dist/cjs/handlebars/runtime.js:268:12)
    at Object.<anonymous> (/usr/local/lib/node_modules/newman-reporter-htmlextra/lib/index.js:158:24)
    at Object.wrapper (/usr/local/lib/node_modules/newman-reporter-htmlextra/node_modules/handlebars/dist/cjs/handlebars/internal/wrapHelper.js:15:19)
    at eval (eval at createFunctionContext (/usr/local/lib/node_modules/newman-reporter-htmlextra/node_modules/handlebars/dist/cjs/handlebars/compiler/javascript-compiler.js:262:23), <anonymous>:10:134)

  

Please help me, I am very new to this 💁🏻‍♂️ ! Thanks in anticipation 🙇🏻‍♂️

I have added every thing in the template.hbs file and ran this command newman run collection.json -r htmlextra --reporter-htmlextra-template template.hbs based on few stack-overflow suggestions ! 😭

[DannyDainton]

That's unfortunately not the way helpers are added to the report. They are placed inside the actual reporter code.

https://github.com/DannyDainton/newman-reporter-htmlextra/blob/main/lib/index.js#L68

The report is compiled just before the end of the Collection run where it fills in all the handlebar placeholders, it's trying to di that for your helper. As you can see in the error.

The template script you added would likely be throwing console errors, if you removed the placeholder and let the report be created. It wouldn't know what Handlebars is in that context.

[iamvarshith]

Thanks a ton @DannyDainton . Just to get it clear, I have to append my snippet in this file https://github.com/DannyDainton/newman-reporter-htmlextra/blob/main/lib/index.js#L68 And this work is ?. Or Am I still missing something.

[DannyDainton]

You could do that on your locally installed version but it wouldn't be a permanent solution as it would be overwritten with an new version.

You could create a PR to change the reporter code but I would probably want something a little more generic in there.

You could also take a look through handlebars helpers, which are included in the report to see if you could use any of those to achieve the same thing in the template.

[DannyDainton]

Maybe this one could help?

https://github.com/Budibase/handlebars-helpers/tree/fork-merge#contains

That can be used directly in the template without any additional code changes.

[iamvarshith]

Thanks a ton ! @DannyDainton I think this #393 (reply in thread) Could help me in this case.

[iamvarshith]

I also found a way to solve this from newman ! Instead of passing API Key as parameter, I could pass t as x-api-key from which I can hide the REQUEST HEADERS in the report for that header.