Replace console.log with structured logging

[LewisBroadhurst]

Closes #399

Winston logger has been used to replace the console.log() node logging in the git-proxy application. Logs generated from git-proxy use now have a format of [timestamp] [log level]: [log message], and can be found in the files git-proxy.log and error.log under the src/logging directory.

Before merging, I wanted to confirm that the old console.log() lines should be removed also. Maybe they are useful in some cases?

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: LewisBroadhurst / name: Lewis Broadhurst (af52a50, 059e76f, 9c161c9, 6e44a7c, 7bfae3a, df48552, 9bdaec1, 4e443f8, 1a20bf1, b1c2381, 3548464, f85483a, dccdc78, 03fbbc7, a3b6b67, e6a0e51, d9d26fb, b0eb1b4, 3bf39a9, 20637b0, ef3cf62, d8b538c, f1d2f4d, 09f5a9e, fcf61a8, dca1ed4, fc6a6f2, c707785, a885b1b, 4ab7b53, d7a0c32, 3dbf6fa, 3f1698c, 8b03c6c, 3b44195, 94499b5, dc2672f, eecb957, 7ffe660, 3869f4e)
• ✅ login: JamieSlome / name: Jamie Slome (c955e73, 520c5a5)

[netlify]

✅ Deploy Preview for endearing-brigadeiros-63f9d0 canceled.

Name	Link
🔨 Latest commit	059e76f
🔍 Latest deploy log	https://app.netlify.com/sites/endearing-brigadeiros-63f9d0/deploys/660851c7e8761b000853721f

[netlify]

✅ Deploy Preview for endearing-brigadeiros-63f9d0 ready!

Name	Link
🔨 Latest commit	520c5a5
🔍 Latest deploy log	https://app.netlify.com/sites/endearing-brigadeiros-63f9d0/deploys/663e1b7bbcf9d2000838228d
😎 Deploy Preview	https://deploy-preview-508--endearing-brigadeiros-63f9d0.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[JamieSlome]

@LewisBroadhurst - thanks for the pull request - you're a star ⭐

In terms of keeping the old console.log calls, is there anything this would provide us that the usage of winston does not?

[JamieSlome]

Looking good! 🍰

Can we think about whether we should use winston logging in log() in Step.js:

log(message) {
    const m = `${this.stepName} - ${message}`;
    this.logs.push(m);
    console.info(m);
}

[codecov]

Codecov Report

Attention: Patch coverage is 56.52174% with 20 lines in your changes are missing coverage. Please review.

Project coverage is 57.97%. Comparing base (e6eec8e) to head (c955e73).

❗ Current head c955e73 differs from pull request most recent head 520c5a5. Consider uploading reports for the commit 520c5a5 to get more accurate results

Files	Patch %	Lines
src/proxy/routes/index.js	14.28%	6 Missing ⚠️
src/config/index.js	25.00%	3 Missing ⚠️
packages/git-proxy-notify-hello/index.js	0.00%	2 Missing ⚠️
src/db/index.js	50.00%	2 Missing ⚠️
src/plugin.js	33.33%	2 Missing ⚠️
src/proxy/chain.js	33.33%	2 Missing ⚠️
src/proxy/processors/push-action/getDiff.js	0.00%	1 Missing ⚠️
src/service/routes/auth.js	66.66%	1 Missing ⚠️
src/service/routes/users.js	50.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #508      +/-   ##
==========================================
+ Coverage   56.96%   57.97%   +1.01%     
==========================================
  Files          46       40       -6     
  Lines        1566     1078     -488     
==========================================
- Hits          892      625     -267     
+ Misses        674      453     -221     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[LewisBroadhurst]

Looking good! 🍰

Can we think about whether we should use winston logging in log() in Step.js:

log(message) {
    const m = `${this.stepName} - ${message}`;
    this.logs.push(m);
    console.info(m);
}

I think this is an example of keeping the console.log I mentioned initially, as having the values logged to console will be a much better UX? (and an npx installer wouldn't have log access?)

For this would the best solution be adding the winston logging in to the step, as well as keeping the console.log? Then we get the UX positives and logging.

Can remove the double logging from checkRepoInAuthorisedList.js with this too 😄

step.log(`repo ${action.repo} is not in the authorisedList, ending`);
- logger.info('setting error');

step.setError(`Rejecting repo ${action.repo} not in the authorisedList`);
- logger.error(`Rejecting repo ${action.repo} not in the authorisedList`);

+ log(message, isError = false) {
     const m = `${this.stepName} - ${message}`;
     this.logs.push(m);
+   if (!isError) {
+     console.info(m);
+     logger.info(m);
+   } else {
+     console.error(m);
+     logger.error(m);
+   }

[coopernetes]

Small suggestion on winston setup.

[coopernetes]

@LewisBroadhurst are you able to address the conflicts?