Skip to content

Commit c6f9d78

Browse files
PierreDemaillyPierreDemailly
committed
chore: improve logs
1 parent 6ba5b71 commit c6f9d78

File tree

11 files changed

+47
-39
lines changed

11 files changed

+47
-39
lines changed

‎public/core/search-nav.js

-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,6 @@ function addRemoveButton(pkgElement, options) {
8282
removeButton.textContent = "x";
8383
removeButton.addEventListener("click", (event) => {
8484
event.stopPropagation();
85-
// we remove the x button from textContent
8685
const pkgToRemove = pkgElement.dataset.name;
8786
window.socket.send(JSON.stringify({ action: "REMOVE", pkg: pkgToRemove }));
8887

‎public/main.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ async function init(options = { navigateToNetworkView: false }) {
149149
const searchNavElement = document.getElementById("search-nav");
150150
const pkgs = searchNavElement.querySelectorAll(".package");
151151
for (const pkg of pkgs) {
152-
if (pkg.textContent.startsWith(window.activePackage)) {
152+
if (pkg.dataset.name.startsWith(window.activePackage)) {
153153
pkg.classList.add("active");
154154
}
155155
else {

‎src/http-server/cache.js

+5-5
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ class _AppCache {
4242
return JSON.parse(fs.readFileSync(path.join(kPayloadsPath, pkg.replaceAll("/", "-")), "utf-8"));
4343
}
4444
catch (err) {
45-
logger.error(`[CACHE | GET_PAYLOAD](pkg: ${pkg}|cache: not found)`);
45+
logger.error(`[cache|get](pkg: ${pkg}|cache: not found)`);
4646

4747
throw err;
4848
}
@@ -68,7 +68,7 @@ class _AppCache {
6868
return JSON.parse(data.toString());
6969
}
7070
catch (err) {
71-
logger.error(`[CACHE | PAYLOADS_LIST](cache: not found)`);
71+
logger.error(`[cache|get](cache: not found)`);
7272

7373
throw err;
7474
}
@@ -87,8 +87,8 @@ class _AppCache {
8787
},
8888
root: formatted
8989
};
90-
// eslint-disable-next-line @stylistic/max-len
91-
logger.info(`[CACHE | INIT_PAYLOADS_LIST](dep: ${formatted}|version: ${version}|rootDependencyName: ${payload.rootDependencyName})`);
90+
91+
logger.info(`[cache|init](dep: ${formatted}|version: ${version}|rootDependencyName: ${payload.rootDependencyName})`);
9292
await cacache.put(CACHE_PATH, kPayloadsCache, JSON.stringify(payloadsList));
9393
this.updatePayload(formatted.replaceAll("/", "-"), payload);
9494
}
@@ -102,7 +102,7 @@ class _AppCache {
102102
}
103103

104104
const list = packagesInFolder.map(({ name }) => name);
105-
logger.info(`[CACHE | INIT_PAYLOADS_LIST](list: ${list})`);
105+
logger.info(`[cache|init](list: ${list})`);
106106

107107
await cacache.put(CACHE_PATH, kPayloadsCache, JSON.stringify({ list, current: list[0] }));
108108
}

‎src/http-server/config.js

+13-6
Original file line numberDiff line numberDiff line change
@@ -12,30 +12,37 @@ export async function get() {
1212
try {
1313
const config = await appCache.getConfig();
1414

15-
logger.info(`[CONFIG | GET](config: ${config})`);
15+
const {
16+
defaultPackageMenu,
17+
ignore: {
18+
flags,
19+
warnings
20+
}
21+
} = config;
22+
logger.info(`[config|get](defaultPackageMenu: ${defaultPackageMenu}|ignore-flag: ${flags}|ignore-warnings: ${warnings})`);
1623

1724
return config;
1825
}
1926
catch (err) {
20-
logger.error(`[CONFIG | GET](error: ${err.message})`);
27+
logger.error(`[config|get](error: ${err.message})`);
2128

2229
await appCache.updateConfig(kDefaultConfig);
2330

24-
logger.info(`[CONFIG | GET](fallback to default: ${JSON.stringify(kDefaultConfig)})`);
31+
logger.info(`[config|get](fallback to default: ${JSON.stringify(kDefaultConfig)})`);
2532

2633
return kDefaultConfig;
2734
}
2835
}
2936

3037
export async function set(newValue) {
31-
logger.info(`[CONFIG | SET](config: ${newValue})`);
38+
logger.info(`[config|set](config: ${newValue})`);
3239
try {
3340
await appCache.updateConfig(newValue);
3441

35-
logger.info(`[CONFIG | SET](sucess)`);
42+
logger.info(`[config|set](sucess)`);
3643
}
3744
catch (err) {
38-
logger.error(`[CONFIG | SET](error: ${err.message})`);
45+
logger.error(`[config|set](error: ${err.message})`);
3946

4047
throw err;
4148
}

‎src/http-server/endpoints/data.js

+5-5
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ const kDefaultPayloadPath = path.join(process.cwd(), "nsecure-result.json");
1515
export async function get(req, res) {
1616
try {
1717
const { current, lru } = await appCache.payloadsList();
18-
logger.info(`[DATA | GET](current: ${current})`);
19-
logger.debug(`[DATA | GET](lru: ${lru})`);
18+
logger.info(`[data|get](current: ${current})`);
19+
logger.debug(`[data|get](lru: ${lru})`);
2020

2121
const formatted = current.replaceAll("/", "-");
2222
send(res, 200, await appCache.getPayload(formatted));
2323
}
2424
catch {
25-
logger.error(`[DATA | GET](No cache yet. Creating one...)`);
25+
logger.error(`[data|get](No cache yet. Creating one...)`);
2626

2727
const payload = JSON.parse(fs.readFileSync(kDefaultPayloadPath, "utf-8"));
2828
const version = Object.keys(payload.dependencies[payload.rootDependencyName].versions)[0];
@@ -36,11 +36,11 @@ export async function get(req, res) {
3636
},
3737
root: formatted
3838
};
39-
logger.info(`[DATA | GET](dep: ${formatted}|version: ${version}|rootDependencyName: ${payload.rootDependencyName})`);
39+
logger.info(`[data|get](dep: ${formatted}|version: ${version}|rootDependencyName: ${payload.rootDependencyName})`);
4040

4141
await appCache.updatePayloadsList(payloadsList);
4242
appCache.updatePayload(formatted.replaceAll("/", "-"), payload);
43-
logger.info(`[DATA | GET](cache: created|payloadsList: ${payloadsList.lru})`);
43+
logger.info(`[data|get](cache: created|payloadsList: ${payloadsList.lru})`);
4444

4545
send(res, 200, payload);
4646
}

‎src/http-server/endpoints/search.js

+5-5
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ import { logger } from "../logger.js";
77

88
export async function get(req, res) {
99
const { packageName } = req.params;
10-
logger.info(`[SEARCH: GET](packageName: ${packageName}|formatted: ${decodeURIComponent(packageName)})`);
10+
logger.info(`[search|get](packageName: ${packageName}|formatted: ${decodeURIComponent(packageName)})`);
1111

1212
const { objects, total } = await npm.search({
1313
text: decodeURIComponent(packageName)
1414
});
15-
logger.debug(`[SEARCH: GET](npmSearchResult: ${JSON.stringify(objects.map((pkg) => pkg.package.name))})`);
15+
logger.debug(`[search|get](npmSearchResult: ${JSON.stringify(objects.map((pkg) => pkg.package.name))})`);
1616

1717
send(res, 200, {
1818
count: total,
@@ -29,13 +29,13 @@ export async function get(req, res) {
2929
export async function versions(req, res) {
3030
const { packageName } = req.params;
3131

32-
logger.info(`[SEARCH: VERSIONS](packageName: ${packageName}|formatted: ${decodeURIComponent(packageName)})`);
32+
logger.info(`[search|versions](packageName: ${packageName}|formatted: ${decodeURIComponent(packageName)})`);
3333

3434
const packument = await npm.packument(decodeURIComponent(packageName));
3535
const versions = Object.keys(packument.versions);
3636

37-
logger.info(`[SEARCH: VERSIONS](packageName: ${packageName}|versions: ${versions})`);
38-
logger.debug(`[SEARCH: VERSIONS](packument: ${packument})`);
37+
logger.info(`[search|versions](packageName: ${packageName}|versions: ${versions})`);
38+
logger.debug(`[search|versions](packument: ${packument})`);
3939

4040
send(res, 200, versions);
4141
}

‎src/http-server/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ export function buildServer(dataFilePath, options = {}) {
6767
websocket.on("connection", async(socket) => {
6868
socket.on("message", async(rawMessage) => {
6969
const message = JSON.parse(rawMessage);
70-
logger.info(`[WEBSOCKET](message: ${JSON.stringify(message)})`);
70+
logger.info(`[ws](message: ${JSON.stringify(message)})`);
7171

7272
if (message.action === "SEARCH") {
7373
wsHandlers.search(socket, message.pkg);

‎src/http-server/logger.js

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
// Import Third-party Dependencies
22
import pino from "pino";
33

4+
// CONSTANTS
5+
const kDefaultLogLevel = "info";
6+
47
const logger = pino({
5-
// TODO: info
6-
level: "debug",
8+
level: process.env.LOG_LEVEL ?? kDefaultLogLevel,
79
transport: {
810
target: "pino-pretty"
911
}

‎src/http-server/websocket/init.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { logger } from "../logger.js";
55
export async function init(socket, lock = false) {
66
try {
77
const { current, lru, older, root } = await appCache.payloadsList();
8-
logger.info(`[WEBSOCKET | INIT](lru: ${lru}|older: ${older}|current: ${current}|root: ${root})`);
8+
logger.info(`[ws|init](lru: ${lru}|older: ${older}|current: ${current}|root: ${root})`);
99

1010
if (lru === void 0 || current === void 0) {
1111
throw new Error("Payloads list not found in cache.");
@@ -20,7 +20,7 @@ export async function init(socket, lock = false) {
2020
}));
2121
}
2222
catch {
23-
logger.error(`[WEBSOCKET | INIT](No cache yet. Creating one...)`);
23+
logger.error(`[ws|init](No cache yet. Creating one...)`);
2424

2525
if (lock) {
2626
return;

‎src/http-server/websocket/remove.js

+5-5
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ import { logger } from "../logger.js";
44

55
export async function remove(ws, pkg) {
66
const formattedPkg = pkg.replace("/", "-");
7-
logger.info(`[WEBSOCKET | REMOVE](pkg: ${pkg}|formatted: ${formattedPkg})`);
7+
logger.info(`[ws|remove](pkg: ${pkg}|formatted: ${formattedPkg})`);
88

99
try {
1010
const { lru, older, current, lastUsed, root } = await appCache.payloadsList();
11-
logger.debug(`[WEBSOCKET | REMOVE](lru: ${lru}|current: ${current})`);
11+
logger.debug(`[ws|remove](lru: ${lru}|current: ${current})`);
1212

1313
if (lru.length === 1 && older.length === 0) {
1414
throw new Error("Cannot remove the last package.");
@@ -22,7 +22,7 @@ export async function remove(ws, pkg) {
2222
}
2323

2424
if (lruIndex > -1) {
25-
logger.info(`[WEBSOCKET | REMOVE](remove from lru)`);
25+
logger.info(`[ws|remove](remove from lru)`);
2626
const updatedLru = lru.filter((pkgName) => pkgName !== pkg);
2727
if (older.length > 0) {
2828
// We need to move the first older package to the lru list
@@ -54,7 +54,7 @@ export async function remove(ws, pkg) {
5454
}));
5555
}
5656
else {
57-
logger.info(`[WEBSOCKET | REMOVE](remove from older)`);
57+
logger.info(`[ws|remove](remove from older)`);
5858
const updatedOlder = older.filter((pkgName) => pkgName !== pkg);
5959
const updatedList = {
6060
lru,
@@ -77,7 +77,7 @@ export async function remove(ws, pkg) {
7777
appCache.removePayload(formattedPkg.replaceAll("/", "-"));
7878
}
7979
catch (error) {
80-
logger.error(`[WEBSOCKET | REMOVE](error: ${error.message})`);
80+
logger.error(`[ws|remove](error: ${error.message})`);
8181
logger.debug(error);
8282

8383
throw error;

‎src/http-server/websocket/search.js

+6-6
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ import { logger } from "../logger.js";
66
import { appCache } from "../cache.js";
77

88
export async function search(ws, pkg) {
9-
logger.info(`[WEBSOCKET | SEARCH](pkg: ${pkg})`);
9+
logger.info(`[ws|search](pkg: ${pkg})`);
1010

1111
const cache = await appCache.getPayloadOrNull(pkg);
1212
if (cache) {
13-
logger.info(`[WEBSOCKET | SEARCH](payload: ${pkg} found in cache)`);
13+
logger.info(`[ws|search](payload: ${pkg} found in cache)`);
1414
const cacheList = await appCache.payloadsList();
1515
if (cacheList.lru.includes(pkg)) {
16-
logger.info(`[WEBSOCKET | SEARCH](payload: ${pkg} is already in the LRU)`);
16+
logger.info(`[ws|search](payload: ${pkg} is already in the LRU)`);
1717
const updatedList = {
1818
...cacheList,
1919
current: pkg,
@@ -44,7 +44,7 @@ export async function search(ws, pkg) {
4444
}
4545

4646
// at this point we don't have the payload in cache so we have to scan it.
47-
logger.info(`[WEBSOCKET | SEARCH](scan ${pkg})`);
47+
logger.info(`[ws|search](scan ${pkg} in progress)`);
4848
ws.send(JSON.stringify({ status: "SCAN", pkg }));
4949

5050
const payload = await Scanner.from(pkg, { maxDepth: 4 });
@@ -54,7 +54,7 @@ export async function search(ws, pkg) {
5454
{
5555
// save the payload in cache
5656
const pkg = `${name}@${version}`;
57-
logger.info(`[WEBSOCKET | SEARCH](scan <${pkg}> done|cache: updated|pkg: ${pkg})`);
57+
logger.info(`[ws|search](scan ${pkg} done|cache: updated)`);
5858

5959
// update the payloads list
6060
const { lru, older, lastUsed, root } = await appCache.removeLastLRU();
@@ -75,6 +75,6 @@ export async function search(ws, pkg) {
7575
...updatedList
7676
}));
7777

78-
logger.info(`[WEBSOCKET | SEARCH](payloadsList updated|payload sent to client)`);
78+
logger.info(`[ws|search](data sent to client|cache: updated)`);
7979
}
8080
}

0 commit comments

Comments
 (0)