Add timestamps to all console logs

Author: grubersjoe

package.json

@@ -1,7 +1,7 @@
 {
   "name": "github-contribution-api",
   "description": "Scrape contribution data of a Github user",
-  "version": "4.7.2",
+  "version": "4.7.3",
   "author": "Jonathan Gruber <gruberjonathan@gmail.com>",
   "license": "MIT",
   "private": true,
@@ -36,6 +36,7 @@
   "dependencies": {
     "cheerio": "^1.0.0",
     "compression": "^1.7.4",
+    "console-stamp": "^3.1.2",
     "cors": "^2.8.4",
     "domhandler": "^5.0.3",
     "express": "^4.21.1",

pnpm-lock.yaml

@@ -1,8 +1,7 @@
+import compression from 'compression'
+import cors from 'cors'
 import express, { ErrorRequestHandler } from 'express'
 import cache from 'memory-cache'
-import cors from 'cors'
-import compression from 'compression'
-
 import {
   NestedResponse as ApiNestedResponse,
   Response as ApiResponse,
@@ -88,7 +87,7 @@ app.get('/v4/:username', async (req: Request, res, next) => {
 
     next(
       new Error(
-        `Error scraping contribution data of '${username}': ${
+        `Failed scraping contribution data of '${username}': ${
           error instanceof Error ? error.message : 'Unknown error.'
         }`,
       ),

src/index.ts renamed to src/app.ts

@@ -1,7 +1,7 @@
 import { fromURL } from 'cheerio'
 
 import { Element, isText } from 'domhandler'
-import { ParsedQuery } from '.'
+import { ParsedQuery } from './app'
 
 type Level = 0 | 1 | 2 | 3 | 4
 type Year = number | 'lastYear'

src/scrape.ts

@@ -1,4 +1,8 @@
-import app from './index'
+import consoleStamp from 'console-stamp'
+import app from './app'
+
+// Globally wrap the console to add timestamps to every call.
+consoleStamp(console, { format: ':date(isoDateTime)' })
 
 const server = app.listen(process.env.PORT ?? 8080, () =>
   console.log(

src/server.ts

@@ -1,7 +1,7 @@
 import { Server } from 'http'
 import cache from 'memory-cache'
 import request from 'supertest'
-import app from '../src'
+import app from '../src/app'
 import * as fetchService from '../src/scrape'
 import testDataMultipleYears from './fixtures/grubersjoe-2017-2018.json'
 import testDataNested from './fixtures/grubersjoe-2018-nested.json'
@@ -114,7 +114,7 @@ describe('The :username endpoint', () => {
       .expect(500)
       .expect((res) =>
         expect(res.body).toStrictEqual({
-          error: `Error scraping contribution data of '${username}': unexpected error`,
+          error: `Failed scraping contribution data of '${username}': unexpected error`,
         }),
       )
   })