0
0
mirror of https://github.com/mongodb/mongo.git synced 2024-11-27 23:27:11 +01:00
mongodb/jstests/libs/log.js
Sophia Tan 2713bbe201 SERVER-93442: fix the misuse of findMatchingLogLines and refactor it for prevent misuse (#26096)
GitOrigin-RevId: 30476c6c9c5bc87caa6da7b8b5f3b79418beae55
2024-08-14 20:07:28 +00:00

86 lines
3.3 KiB
JavaScript

/**
* Iterates log lines that match the given filter.
* Yields every logline that contains the specified fields. The regex escape function used here is
* drawn from the following:
* https://stackoverflow.com/questions/3561493/is-there-a-regexp-escape-function-in-javascript
* https://github.com/ljharb/regexp.escape
*
* @param {Array} logLines - An array of log lines.
* @param {Object} fields - The fields to match log lines.
* @param {Object} ignoreFields - The fields to ignore log lines.
* @returns {Iterator} A iterator function that yields matching log lines.
*/
export function* iterateMatchingLogLines(logLines, fields, ignoreFields) {
ignoreFields = ignoreFields || [];
function escapeRegex(input) {
return (typeof input === "string" ? input.replace(/[\^\$\\\.\*\+\?\(\)\[\]\{\}]/g, '\\$&')
: input);
}
function lineMatches(line, fields, ignoreFields) {
const fieldNames =
Object.keys(fields).filter((fieldName) => !ignoreFields.includes(fieldName));
return fieldNames.every((fieldName) => {
const fieldValue = fields[fieldName];
let regex;
const booleanFields = [
'cursorExhausted',
'upsert',
'hasSortStage',
'usedDisk',
'cursorExhausted',
'cursorExhausted'
];
// Command is a special case since it is the first arg of the message, not a
// separate field
if (fieldName === "command") {
let commandName = fieldValue;
// These commands can be sent camelCase or lower case but shell sends them lower
// case
if (fieldValue === "findAndModify" || fieldValue === "mapReduce") {
commandName = fieldValue.toLowerCase();
}
regex = `"command":{"${commandName}`;
} else if (fieldName === "insert" && fieldValue.indexOf("|") != -1) {
// Match new and legacy insert
regex = `("insert","ns":"(${fieldValue})"|("insert":"(${fieldValue})"))`;
} else if (booleanFields.find(f => f === fieldName) && fieldValue == 1) {
regex = `"${fieldName}":true`;
} else {
regex = "\"" + escapeRegex(fieldName) + "\":(" +
escapeRegex(checkLog.formatAsJsonLogLine(fieldValue)) + "|" +
escapeRegex(checkLog.formatAsJsonLogLine(fieldValue, true)) + ")";
}
const match = line.match(regex);
return match && match[0];
});
}
for (const line of logLines) {
if (lineMatches(line, fields, ignoreFields)) {
yield line;
}
}
}
// Finds and returns a logline containing all the specified fields, or null if no such logline
// was found.
export function findMatchingLogLine(logLines, fields, ignoreFields) {
for (const line of iterateMatchingLogLines(logLines, fields, ignoreFields)) {
return line;
}
return null;
}
export function getMatchingLoglinesCount(logLines, fields, ignoreFields) {
let count = 0;
for (const _line of iterateMatchingLogLines(logLines, fields, ignoreFields)) {
count++;
}
return count;
}