Skip to content

Commit 8c37348

Browse files
jc21jc21
committed
Properly wrap debug calls
1 parent 2b3e9d7 commit 8c37348

File tree

18 files changed

+103
-94
lines changed

18 files changed

+103
-94
lines changed

‎backend/app.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import fileUpload from "express-fileupload";
55
import { isDebugMode } from "./lib/config.js";
66
import cors from "./lib/express/cors.js";
77
import jwt from "./lib/express/jwt.js";
8-
import { express as logger } from "./logger.js";
8+
import { debug, express as logger } from "./logger.js";
99
import mainRoutes from "./routes/main.js";
1010

1111
/**
@@ -80,7 +80,7 @@ app.use((err, req, res, _) => {
8080

8181
// Not every error is worth logging - but this is good for now until it gets annoying.
8282
if (typeof err.stack !== "undefined" && err.stack) {
83-
logger.debug(err.stack);
83+
debug(logger, err.stack);
8484
if (typeof err.public === "undefined" || !err.public) {
8585
logger.warn(err.message);
8686
}

‎backend/internal/certificate.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import { installPlugin } from "../lib/certbot.js";
1010
import { useLetsencryptServer, useLetsencryptStaging } from "../lib/config.js";
1111
import error from "../lib/error.js";
1212
import utils from "../lib/utils.js";
13-
import { ssl as logger } from "../logger.js";
13+
import { debug, ssl as logger } from "../logger.js";
1414
import certificateModel from "../models/certificate.js";
1515
import tokenModel from "../models/token.js";
1616
import userModel from "../models/user.js";
@@ -355,7 +355,7 @@ const internalCertificate = {
355355
const opName = `/tmp/${downloadName}`;
356356

357357
await internalCertificate.zipFiles(certFiles, opName);
358-
logger.debug("zip completed : ", opName);
358+
debug(logger, "zip completed : ", opName);
359359
return {
360360
fileName: opName,
361361
};
@@ -375,7 +375,7 @@ const internalCertificate = {
375375
return new Promise((resolve, reject) => {
376376
source.map((fl) => {
377377
const fileName = path.basename(fl);
378-
logger.debug(fl, "added to certificate zip");
378+
debug(logger, fl, "added to certificate zip");
379379
archive.file(fl, { name: fileName });
380380
return true;
381381
});

‎backend/internal/nginx.js‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { fileURLToPath } from "node:url";
44
import _ from "lodash";
55
import errs from "../lib/error.js";
66
import utils from "../lib/utils.js";
7-
import { nginx as logger } from "../logger.js";
7+
import { debug, nginx as logger } from "../logger.js";
88

99
const __filename = fileURLToPath(import.meta.url);
1010
const __dirname = dirname(__filename);
@@ -68,7 +68,7 @@ const internalNginx = {
6868
return true;
6969
});
7070

71-
logger.debug("Nginx test failed:", valid_lines.join("\n"));
71+
debug(logger, "Nginx test failed:", valid_lines.join("\n"));
7272

7373
// config is bad, update meta and delete config
7474
combined_meta = _.assign({}, host.meta, {
@@ -102,7 +102,7 @@ const internalNginx = {
102102
* @returns {Promise}
103103
*/
104104
test: () => {
105-
logger.debug("Testing Nginx configuration");
105+
debug(logger, "Testing Nginx configuration");
106106
return utils.execFile("/usr/sbin/nginx", ["-t", "-g", "error_log off;"]);
107107
},
108108

@@ -190,7 +190,7 @@ const internalNginx = {
190190
const host = JSON.parse(JSON.stringify(host_row));
191191
const nice_host_type = internalNginx.getFileFriendlyHostType(host_type);
192192

193-
logger.debug(`Generating ${nice_host_type} Config:`, JSON.stringify(host, null, 2));
193+
debug(logger, `Generating ${nice_host_type} Config:`, JSON.stringify(host, null, 2));
194194

195195
const renderEngine = utils.getRenderEngine();
196196

@@ -241,15 +241,15 @@ const internalNginx = {
241241
.parseAndRender(template, host)
242242
.then((config_text) => {
243243
fs.writeFileSync(filename, config_text, { encoding: "utf8" });
244-
logger.debug("Wrote config:", filename, config_text);
244+
debug(logger, "Wrote config:", filename, config_text);
245245

246246
// Restore locations array
247247
host.locations = origLocations;
248248

249249
resolve(true);
250250
})
251251
.catch((err) => {
252-
logger.debug(`Could not write ${filename}:`, err.message);
252+
debug(logger, `Could not write ${filename}:`, err.message);
253253
reject(new errs.ConfigurationError(err.message));
254254
});
255255
});
@@ -265,7 +265,7 @@ const internalNginx = {
265265
* @returns {Promise}
266266
*/
267267
generateLetsEncryptRequestConfig: (certificate) => {
268-
logger.debug("Generating LetsEncrypt Request Config:", certificate);
268+
debug(logger, "Generating LetsEncrypt Request Config:", certificate);
269269
const renderEngine = utils.getRenderEngine();
270270

271271
return new Promise((resolve, reject) => {
@@ -285,11 +285,11 @@ const internalNginx = {
285285
.parseAndRender(template, certificate)
286286
.then((config_text) => {
287287
fs.writeFileSync(filename, config_text, { encoding: "utf8" });
288-
logger.debug("Wrote config:", filename, config_text);
288+
debug(logger, "Wrote config:", filename, config_text);
289289
resolve(true);
290290
})
291291
.catch((err) => {
292-
logger.debug(`Could not write ${filename}:`, err.message);
292+
debug(logger, `Could not write ${filename}:`, err.message);
293293
reject(new errs.ConfigurationError(err.message));
294294
});
295295
});
@@ -305,10 +305,10 @@ const internalNginx = {
305305
return;
306306
}
307307
try {
308-
logger.debug(`Deleting file: ${filename}`);
308+
debug(logger, `Deleting file: ${filename}`);
309309
fs.unlinkSync(filename);
310310
} catch (err) {
311-
logger.debug("Could not delete file:", JSON.stringify(err, null, 2));
311+
debug(logger, "Could not delete file:", JSON.stringify(err, null, 2));
312312
}
313313
},
314314

‎backend/lib/config.js‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,9 @@ const configure = () => {
9696

9797
const getKeys = () => {
9898
// Get keys from file
99-
logger.debug("Cheecking for keys file:", keysFile);
99+
if (isDebugMode()) {
100+
logger.debug("Checking for keys file:", keysFile);
101+
}
100102
if (!fs.existsSync(keysFile)) {
101103
generateKeys();
102104
} else if (process.env.DEBUG) {

‎backend/lib/utils.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ import { dirname } from "node:path";
33
import { fileURLToPath } from "node:url";
44
import { Liquid } from "liquidjs";
55
import _ from "lodash";
6-
import { global as logger } from "../logger.js";
6+
import { debug, global as logger } from "../logger.js";
77
import errs from "./error.js";
88

99
const __filename = fileURLToPath(import.meta.url);
1010
const __dirname = dirname(__filename);
1111

1212
const exec = async (cmd, options = {}) => {
13-
logger.debug("CMD:", cmd);
13+
debug(logger, "CMD:", cmd);
1414
const { stdout, stderr } = await new Promise((resolve, reject) => {
1515
const child = nodeExec(cmd, options, (isError, stdout, stderr) => {
1616
if (isError) {
@@ -34,7 +34,7 @@ const exec = async (cmd, options = {}) => {
3434
* @returns {Promise}
3535
*/
3636
const execFile = (cmd, args, options) => {
37-
logger.debug(`CMD: ${cmd} ${args ? args.join(" ") : ""}`);
37+
debug(logger, `CMD: ${cmd} ${args ? args.join(" ") : ""}`);
3838
const opts = options || {};
3939

4040
return new Promise((resolve, reject) => {

‎backend/logger.js‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import signale from "signale";
2+
import { isDebugMode } from "./lib/config.js";
23

34
const opts = {
45
logLevel: "info",
@@ -15,4 +16,10 @@ const importer = new signale.Signale({ scope: "Importer ", ...opts });
1516
const setup = new signale.Signale({ scope: "Setup ", ...opts });
1617
const ipRanges = new signale.Signale({ scope: "IP Ranges", ...opts });
1718

18-
export { global, migrate, express, access, nginx, ssl, certbot, importer, setup, ipRanges };
19+
const debug = (logger, ...args) => {
20+
if (isDebugMode()) {
21+
logger.debug(...args);
22+
}
23+
};
24+
25+
export { debug, global, migrate, express, access, nginx, ssl, certbot, importer, setup, ipRanges };

‎backend/routes/audit-log.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import express from "express";
22
import internalAuditLog from "../internal/audit-log.js";
33
import jwtdecode from "../lib/express/jwt-decode.js";
44
import validator from "../lib/validator/index.js";
5-
import { express as logger } from "../logger.js";
5+
import { debug, express as logger } from "../logger.js";
66

77
const router = express.Router({
88
caseSensitive: true,
@@ -47,7 +47,7 @@ router
4747
const rows = await internalAuditLog.getAll(res.locals.access, data.expand, data.query);
4848
res.status(200).send(rows);
4949
} catch (err) {
50-
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
50+
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
5151
next(err);
5252
}
5353
});
@@ -99,7 +99,7 @@ router
9999
});
100100
res.status(200).send(item);
101101
} catch (err) {
102-
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
102+
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
103103
next(err);
104104
}
105105
});

‎backend/routes/nginx/access_lists.js‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import internalAccessList from "../../internal/access-list.js";
33
import jwtdecode from "../../lib/express/jwt-decode.js";
44
import apiValidator from "../../lib/validator/api.js";
55
import validator from "../../lib/validator/index.js";
6-
import { express as logger } from "../../logger.js";
6+
import { debug, express as logger } from "../../logger.js";
77
import { getValidationSchema } from "../../schema/index.js";
88

99
const router = express.Router({
@@ -49,7 +49,7 @@ router
4949
const rows = await internalAccessList.getAll(res.locals.access, data.expand, data.query);
5050
res.status(200).send(rows);
5151
} catch (err) {
52-
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
52+
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
5353
next(err);
5454
}
5555
})
@@ -65,7 +65,7 @@ router
6565
const result = await internalAccessList.create(res.locals.access, payload);
6666
res.status(201).send(result);
6767
} catch (err) {
68-
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
68+
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
6969
next(err);
7070
}
7171
});
@@ -113,7 +113,7 @@ router
113113
});
114114
res.status(200).send(row);
115115
} catch (err) {
116-
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
116+
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
117117
next(err);
118118
}
119119
})
@@ -130,7 +130,7 @@ router
130130
const result = await internalAccessList.update(res.locals.access, payload);
131131
res.status(200).send(result);
132132
} catch (err) {
133-
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
133+
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
134134
next(err);
135135
}
136136
})
@@ -147,7 +147,7 @@ router
147147
});
148148
res.status(200).send(result);
149149
} catch (err) {
150-
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
150+
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
151151
next(err);
152152
}
153153
});

‎backend/routes/nginx/certificates.js‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import errs from "../../lib/error.js";
55
import jwtdecode from "../../lib/express/jwt-decode.js";
66
import apiValidator from "../../lib/validator/api.js";
77
import validator from "../../lib/validator/index.js";
8-
import { express as logger } from "../../logger.js";
8+
import { debug, express as logger } from "../../logger.js";
99
import { getValidationSchema } from "../../schema/index.js";
1010

1111
const router = express.Router({
@@ -58,7 +58,7 @@ router
5858
);
5959
res.status(200).send(rows);
6060
} catch (err) {
61-
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
61+
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
6262
next(err);
6363
}
6464
})
@@ -81,7 +81,7 @@ router
8181
);
8282
res.status(201).send(result);
8383
} catch (err) {
84-
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
84+
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
8585
next(err);
8686
}
8787
});
@@ -115,7 +115,7 @@ router
115115
clean.sort((a, b) => a.name.localeCompare(b.name));
116116
res.status(200).send(clean);
117117
} catch (err) {
118-
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
118+
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
119119
next(err);
120120
}
121121
});
@@ -151,7 +151,7 @@ router
151151
);
152152
res.status(200).send(result);
153153
} catch (err) {
154-
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
154+
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
155155
next(err);
156156
}
157157
});
@@ -185,7 +185,7 @@ router
185185
});
186186
res.status(200).send(result);
187187
} catch (err) {
188-
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
188+
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
189189
next(err);
190190
}
191191
});
@@ -236,7 +236,7 @@ router
236236
});
237237
res.status(200).send(row);
238238
} catch (err) {
239-
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
239+
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
240240
next(err);
241241
}
242242
})
@@ -253,7 +253,7 @@ router
253253
});
254254
res.status(200).send(result);
255255
} catch (err) {
256-
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
256+
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
257257
next(err);
258258
}
259259
});
@@ -288,7 +288,7 @@ router
288288
});
289289
res.status(200).send(result);
290290
} catch (err) {
291-
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
291+
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
292292
next(err);
293293
}
294294
});
@@ -318,7 +318,7 @@ router
318318
});
319319
res.status(200).send(result);
320320
} catch (err) {
321-
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
321+
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
322322
next(err);
323323
}
324324
});
@@ -347,7 +347,7 @@ router
347347
});
348348
res.status(200).download(result.fileName);
349349
} catch (err) {
350-
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
350+
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
351351
next(err);
352352
}
353353
});

0 commit comments

Comments
 (0)