Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(query): Restart log queries when case-sensitivity or regex button is toggled. #130

Merged
merged 12 commits into from
Dec 9, 2024
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import {

import DescriptionOutlinedIcon from "@mui/icons-material/DescriptionOutlined";

import {QueryResultsType} from "../../../../../typings/worker";
import {QueryResultsType} from "../../../../../typings/query";
import Result from "./Result";

import "./ResultsGroup.css";
Expand Down
Henry8192 marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,15 @@ import UnfoldLessIcon from "@mui/icons-material/UnfoldLess";
import UnfoldMoreIcon from "@mui/icons-material/UnfoldMore";

import {StateContext} from "../../../../../contexts/StateContextProvider";
import {
QUERY_PROGRESS_VALUE_MAX,
QueryArgs,
} from "../../../../../typings/query";
import {UI_ELEMENT} from "../../../../../typings/states";
import {
TAB_DISPLAY_NAMES,
TAB_NAME,
} from "../../../../../typings/tab";
import {QUERY_PROGRESS_DONE} from "../../../../../typings/worker";
import {isDisabled} from "../../../../../utils/states";
import CustomTabPanel from "../CustomTabPanel";
import PanelTitleButton from "../PanelTitleButton";
Expand All @@ -35,6 +38,24 @@ enum QUERY_OPTION {
IS_REGEX = "isRegex"
}

/**
* Determines if the query is case-sensitive based on the provided query options.
*
* @param queryOptions
* @return True if the query is case-sensitive.
*/
const getIsCaseSensitive =
(queryOptions: QUERY_OPTION[]) => queryOptions.includes(QUERY_OPTION.IS_CASE_SENSITIVE);

/**
* Determines if the query is a regular expression based on the provided query options.
*
* @param queryOptions
* @return True if the query is a regular expression.
*/
const getIsRegex =
(queryOptions: QUERY_OPTION[]) => queryOptions.includes(QUERY_OPTION.IS_REGEX);

/**
* Displays a panel for submitting queries and viewing query results.
*
Expand All @@ -44,17 +65,31 @@ const SearchTabPanel = () => {
const {queryProgress, queryResults, startQuery, uiState} = useContext(StateContext);
const [isAllExpanded, setIsAllExpanded] = useState<boolean>(true);
const [queryOptions, setQueryOptions] = useState<QUERY_OPTION[]>([]);
const [queryString, setQueryString] = useState<string>("");

const handleQuerySubmit = (newArgs: Partial<QueryArgs>) => {
startQuery({
isCaseSensitive: getIsCaseSensitive(queryOptions),
isRegex: getIsRegex(queryOptions),
queryString: queryString,
...newArgs,
});
};

const handleQueryInputChange = (ev: React.ChangeEvent<HTMLTextAreaElement>) => {
const isCaseSensitive = queryOptions.includes(QUERY_OPTION.IS_CASE_SENSITIVE);
const isRegex = queryOptions.includes(QUERY_OPTION.IS_REGEX);
startQuery(ev.target.value, isRegex, isCaseSensitive);
setQueryString(ev.target.value);
handleQuerySubmit({queryString: ev.target.value});
};

const handleQueryOptionsChange = (
_: React.MouseEvent<HTMLElement>,
newOptions: QUERY_OPTION[]
) => {
setQueryOptions(newOptions);
handleQuerySubmit({
isCaseSensitive: getIsCaseSensitive(newOptions),
isRegex: getIsRegex(newOptions),
});
};

return (
Expand Down Expand Up @@ -109,7 +144,7 @@ const SearchTabPanel = () => {
determinate={true}
thickness={4}
value={queryProgress * 100}
color={QUERY_PROGRESS_DONE === queryProgress ?
color={QUERY_PROGRESS_VALUE_MAX === queryProgress ?
"success" :
"primary"}/>
</div>
Expand Down
25 changes: 10 additions & 15 deletions src/contexts/StateContextProvider.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@ import {
DEFAULT_AUTO_DISMISS_TIMEOUT_MILLIS,
LONG_AUTO_DISMISS_TIMEOUT_MILLIS,
} from "../typings/notifications";
import {
QUERY_PROGRESS_VALUE_MIN,
QueryArgs,
QueryResults,
} from "../typings/query";
import {UI_STATE} from "../typings/states";
import {SEARCH_PARAM_NAMES} from "../typings/url";
import {
Expand All @@ -33,8 +38,6 @@ import {
EVENT_POSITION_ON_PAGE,
FileSrcType,
MainWorkerRespMessage,
QUERY_PROGRESS_INIT,
QueryResults,
WORKER_REQ_CODE,
WORKER_RESP_CODE,
WorkerReq,
Expand Down Expand Up @@ -81,7 +84,7 @@ interface StateContextType {
loadFile: (fileSrc: FileSrcType, cursor: CursorType) => void,
loadPageByAction: (navAction: NavigationAction) => void,
setIsSettingsModalOpen: (isOpen: boolean) => void,
startQuery: (queryString: string, isRegex: boolean, isCaseSensitive: boolean) => void,
startQuery: (queryArgs: QueryArgs) => void,
}
const StateContext = createContext<StateContextType>({} as StateContextType);

Expand All @@ -98,7 +101,7 @@ const STATE_DEFAULT: Readonly<StateContextType> = Object.freeze({
numPages: 0,
onDiskFileSizeInBytes: 0,
pageNum: 0,
queryProgress: QUERY_PROGRESS_INIT,
queryProgress: QUERY_PROGRESS_VALUE_MIN,
queryResults: new Map(),
uiState: UI_STATE.UNOPENED,

Expand Down Expand Up @@ -339,7 +342,7 @@ const StateContextProvider = ({children}: StateContextProviderProps) => {
}
case WORKER_RESP_CODE.QUERY_RESULT:
setQueryProgress(args.progress);
if (QUERY_PROGRESS_INIT === args.progress) {
if (QUERY_PROGRESS_VALUE_MIN === args.progress) {
setQueryResults(STATE_DEFAULT.queryResults);
} else {
setQueryResults((v) => {
Expand All @@ -361,22 +364,14 @@ const StateContextProvider = ({children}: StateContextProviderProps) => {
}
}, [postPopUp]);

const startQuery = useCallback((
queryString: string,
isRegex: boolean,
isCaseSensitive: boolean
) => {
const startQuery = useCallback((queryArgs: QueryArgs) => {
setQueryResults(STATE_DEFAULT.queryResults);
if (null === mainWorkerRef.current) {
console.error("Unexpected null mainWorkerRef.current");

return;
}
workerPostReq(mainWorkerRef.current, WORKER_REQ_CODE.START_QUERY, {
queryString: queryString,
isRegex: isRegex,
isCaseSensitive: isCaseSensitive,
});
workerPostReq(mainWorkerRef.current, WORKER_REQ_CODE.START_QUERY, queryArgs);
}, []);

const exportLogs = useCallback(() => {
Expand Down
14 changes: 9 additions & 5 deletions src/services/LogFileManager/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,17 @@ import {
} from "../../typings/decoders";
import {MAX_V8_STRING_LENGTH} from "../../typings/js";
import {LogLevelFilter} from "../../typings/logs";
import {
QueryArgs,
QueryResults,
} from "../../typings/query";
import {
BeginLineNumToLogEventNumMap,
CURSOR_CODE,
CursorData,
CursorType,
EMPTY_PAGE_RESP,
FileSrcType,
QueryResults,
WORKER_RESP_CODE,
WorkerResp,
} from "../../typings/worker";
Expand Down Expand Up @@ -286,11 +289,12 @@ class LogFileManager {
* Creates a RegExp object based on the given query string and options, and starts querying the
* first log chunk.
*
* @param queryString
* @param isRegex
* @param isCaseSensitive
* @param queryArgs
* @param queryArgs.queryString
* @param queryArgs.isRegex
* @param queryArgs.isCaseSensitive
*/
startQuery (queryString: string, isRegex: boolean, isCaseSensitive: boolean): void {
startQuery ({queryString, isRegex, isCaseSensitive}: QueryArgs): void {
Henry8192 marked this conversation as resolved.
Show resolved Hide resolved
this.#queryId++;
this.#queryCount = 0;

Expand Down
15 changes: 2 additions & 13 deletions src/services/MainWorker.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ import dayjsTimezone from "dayjs/plugin/timezone";
import dayjsUtc from "dayjs/plugin/utc";

import {LOG_LEVEL} from "../typings/logs";
import {QueryResults} from "../typings/query";
import {
MainWorkerReqMessage,
QueryResults,
WORKER_REQ_CODE,
WORKER_RESP_CODE,
WorkerResp,
Expand Down Expand Up @@ -124,18 +124,7 @@ onmessage = async (ev: MessageEvent<MainWorkerReqMessage>) => {
if (null === LOG_FILE_MANAGER) {
throw new Error("Log file manager hasn't been initialized");
}
if (
"string" !== typeof args.queryString ||
"boolean" !== typeof args.isRegex ||
"boolean" !== typeof args.isCaseSensitive
) {
throw new Error("Invalid arguments for QUERY_LOG");
}
LOG_FILE_MANAGER.startQuery(
args.queryString,
args.isRegex,
args.isCaseSensitive
);
LOG_FILE_MANAGER.startQuery(args);
break;
default:
console.error(`Unexpected ev.data: ${JSON.stringify(ev.data)}`);
Expand Down
28 changes: 28 additions & 0 deletions src/typings/query.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
const QUERY_PROGRESS_VALUE_MIN = 0;
const QUERY_PROGRESS_VALUE_MAX = 1;

interface QueryArgs {
Henry8192 marked this conversation as resolved.
Show resolved Hide resolved
queryString: string;
isCaseSensitive: boolean;
isRegex: boolean;
}

type TextRange = [number, number];

interface QueryResultsType {
logEventNum: number;
message: string;
matchRange: TextRange;
}

type QueryResults = Map<number, QueryResultsType[]>;

Henry8192 marked this conversation as resolved.
Show resolved Hide resolved
export {
QUERY_PROGRESS_VALUE_MAX,
QUERY_PROGRESS_VALUE_MIN,
};
export type {
QueryArgs,
QueryResults,
QueryResultsType,
};
Henry8192 marked this conversation as resolved.
Show resolved Hide resolved
18 changes: 1 addition & 17 deletions src/typings/worker.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {
LOG_LEVEL,
LogLevelFilter,
} from "./logs";
import {QueryResults} from "./query";


/**
Expand Down Expand Up @@ -106,19 +107,6 @@ type WorkerReqMap = {
},
};

type TextRange = [number, number];

interface QueryResultsType {
logEventNum: number;
message: string;
matchRange: TextRange;
}

type QueryResults = Map<number, QueryResultsType[]>;

const QUERY_PROGRESS_INIT = 0;
const QUERY_PROGRESS_DONE = 1;

type WorkerRespMap = {
[WORKER_RESP_CODE.CHUNK_DATA]: {
logs: string
Expand Down Expand Up @@ -180,8 +168,6 @@ export {
CURSOR_CODE,
EMPTY_PAGE_RESP,
EVENT_POSITION_ON_PAGE,
QUERY_PROGRESS_DONE,
QUERY_PROGRESS_INIT,
WORKER_REQ_CODE,
WORKER_RESP_CODE,
};
Expand All @@ -192,8 +178,6 @@ export type {
FileSrcType,
MainWorkerReqMessage,
MainWorkerRespMessage,
QueryResults,
QueryResultsType,
WorkerReq,
WorkerResp,
};
Loading