forked from y-scope/yscope-log-viewer
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathStateContextProvider.tsx
491 lines (438 loc) · 15.3 KB
/
StateContextProvider.tsx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
/* eslint max-lines: ["error", 500] */
import React, {
createContext,
useCallback,
useContext,
useEffect,
useRef,
useState,
} from "react";
import LogExportManager, {EXPORT_LOG_PROGRESS_VALUE_MIN} from "../services/LogExportManager";
import {Nullable} from "../typings/common";
import {CONFIG_KEY} from "../typings/config";
import {LogLevelFilter} from "../typings/logs";
import {SEARCH_PARAM_NAMES} from "../typings/url";
import {
BeginLineNumToLogEventNumMap,
CURSOR_CODE,
CursorType,
EVENT_POSITION_ON_PAGE,
FileSrcType,
MainWorkerRespMessage,
QueryResults,
WORKER_REQ_CODE,
WORKER_RESP_CODE,
WorkerReq,
} from "../typings/worker";
import {
ACTION_NAME,
NavigationAction,
} from "../utils/actions";
import {
EXPORT_LOGS_CHUNK_SIZE,
getConfig,
} from "../utils/config";
import {
findNearestLessThanOrEqualElement,
isWithinBounds,
} from "../utils/data";
import {clamp} from "../utils/math";
import {
updateWindowUrlHashParams,
updateWindowUrlSearchParams,
URL_HASH_PARAMS_DEFAULT,
URL_SEARCH_PARAMS_DEFAULT,
UrlContext,
} from "./UrlContextProvider";
interface StateContextType {
beginLineNumToLogEventNum: BeginLineNumToLogEventNumMap,
fileName: string,
exportProgress: Nullable<number>,
logData: string,
numEvents: number,
numPages: number,
onDiskFileSizeInBytes: number,
pageNum: number,
queryResults: QueryResults,
exportLogs: () => void,
loadFile: (fileSrc: FileSrcType, cursor: CursorType) => void,
loadPageByAction: (navAction: NavigationAction) => void,
setLogLevelFilter: (newLogLevelFilter: LogLevelFilter) => void,
startQuery: (queryString: string, isRegex: boolean, isCaseSensitive: boolean) => void,
}
const StateContext = createContext<StateContextType>({} as StateContextType);
/**
* Default values of the state object.
*/
const STATE_DEFAULT: Readonly<StateContextType> = Object.freeze({
beginLineNumToLogEventNum: new Map<number, number>(),
exportProgress: null,
fileName: "",
logData: "No file is open.",
numEvents: 0,
numPages: 0,
onDiskFileSizeInBytes: 0,
pageNum: 0,
queryResults: new Map(),
exportLogs: () => null,
loadFile: () => null,
loadPageByAction: () => null,
setLogLevelFilter: () => null,
startQuery: () => null,
});
interface StateContextProviderProps {
children: React.ReactNode
}
/**
* Sends a post message to a worker with the given code and arguments. This wrapper around
* `worker.postMessage()` ensures type safety for both the request code and its corresponding
* arguments.
*
* @param worker
* @param code
* @param args
*/
const workerPostReq = <T extends WORKER_REQ_CODE>(
worker: Worker,
code: T,
args: WorkerReq<T>
) => {
worker.postMessage({code, args});
};
/**
* Returns a `PAGE_NUM` cursor based on a navigation action.
*
* @param navAction Action to navigate to a new page.
* @param currentPageNum
* @param numPages
* @return `PAGE_NUM` cursor.
*/
const getPageNumCursor = (
navAction: NavigationAction,
currentPageNum: number,
numPages: number
): Nullable<CursorType> => {
if (STATE_DEFAULT.pageNum === currentPageNum) {
// eslint-disable-next-line no-warning-comments
// TODO: This shouldn't be possible, but currently, the page nav buttons remain enabled
// even when a file hasn't been loaded.
console.error("Page actions cannot be executed if the current page is not set.");
return null;
}
let newPageNum: number;
let position: EVENT_POSITION_ON_PAGE;
switch (navAction.code) {
case ACTION_NAME.SPECIFIC_PAGE:
position = EVENT_POSITION_ON_PAGE.TOP;
// Clamp is to prevent someone from requesting non-existent page.
newPageNum = clamp(navAction.args.pageNum, 1, numPages);
break;
case ACTION_NAME.FIRST_PAGE:
position = EVENT_POSITION_ON_PAGE.TOP;
newPageNum = 1;
break;
case ACTION_NAME.PREV_PAGE:
position = EVENT_POSITION_ON_PAGE.BOTTOM;
newPageNum = clamp(currentPageNum - 1, 1, numPages);
break;
case ACTION_NAME.NEXT_PAGE:
position = EVENT_POSITION_ON_PAGE.TOP;
newPageNum = clamp(currentPageNum + 1, 1, numPages);
break;
case ACTION_NAME.LAST_PAGE:
position = EVENT_POSITION_ON_PAGE.BOTTOM;
newPageNum = numPages;
break;
default:
return null;
}
return {
code: CURSOR_CODE.PAGE_NUM,
args: {pageNum: newPageNum, eventPositionOnPage: position},
};
};
/**
* Submits a `LOAD_PAGE` request to a worker.
*
* @param worker
* @param cursor
*/
const loadPageByCursor = (
worker: Worker,
cursor: CursorType,
) => {
workerPostReq(worker, WORKER_REQ_CODE.LOAD_PAGE, {
cursor: cursor,
});
};
/**
* Updates the log event number in the URL to `logEventNum` if it's within the bounds of
* `logEventNumsOnPage`.
*
* @param logEventNum
* @param logEventNumsOnPage
* @return Whether `logEventNum` is within the bounds of `logEventNumsOnPage`.
*/
const updateUrlIfEventOnPage = (
logEventNum: number,
logEventNumsOnPage: number[]
): boolean => {
if (false === isWithinBounds(logEventNumsOnPage, logEventNum)) {
return false;
}
const nearestIdx = findNearestLessThanOrEqualElement(
logEventNumsOnPage,
logEventNum
);
// Since `isWithinBounds` returned `true`, then:
// - `logEventNumsOnPage` must bound `logEventNum`.
// - `logEventNumsOnPage` cannot be empty.
// - `nearestIdx` cannot be `null`.
//
// Therefore, we can safely cast:
// - `nearestIdx` from `Nullable<number>` to `number`.
// - `logEventNumsOnPage[nearestIdx]` from `number | undefined` to `number`.
const nearestLogEventNum = logEventNumsOnPage[nearestIdx as number] as number;
updateWindowUrlHashParams({
logEventNum: nearestLogEventNum,
});
return true;
};
/**
* Provides state management for the application. This provider must be wrapped by
* UrlContextProvider to function correctly.
*
* @param props
* @param props.children
* @return
*/
// eslint-disable-next-line max-lines-per-function, max-statements
const StateContextProvider = ({children}: StateContextProviderProps) => {
const {filePath, logEventNum} = useContext(UrlContext);
// States
const [exportProgress, setExportProgress] =
useState<Nullable<number>>(STATE_DEFAULT.exportProgress);
const [fileName, setFileName] = useState<string>(STATE_DEFAULT.fileName);
const [logData, setLogData] = useState<string>(STATE_DEFAULT.logData);
const [numEvents, setNumEvents] = useState<number>(STATE_DEFAULT.numEvents);
const [numPages, setNumPages] = useState<number>(STATE_DEFAULT.numPages);
const [onDiskFileSizeInBytes, setOnDiskFileSizeInBytes] =
useState(STATE_DEFAULT.onDiskFileSizeInBytes);
const [pageNum, setPageNum] = useState<number>(STATE_DEFAULT.pageNum);
const [queryResults, setQueryResults] = useState<QueryResults>(STATE_DEFAULT.queryResults);
const beginLineNumToLogEventNumRef =
useRef<BeginLineNumToLogEventNumMap>(STATE_DEFAULT.beginLineNumToLogEventNum);
// Refs
const logEventNumRef = useRef(logEventNum);
const numPagesRef = useRef<number>(numPages);
const pageNumRef = useRef<number>(pageNum);
const logExportManagerRef = useRef<null|LogExportManager>(null);
const mainWorkerRef = useRef<null|Worker>(null);
const handleMainWorkerResp = useCallback((ev: MessageEvent<MainWorkerRespMessage>) => {
const {code, args} = ev.data;
console.log(`[MainWorker -> Renderer] code=${code}`);
switch (code) {
case WORKER_RESP_CODE.CHUNK_DATA:
if (null !== logExportManagerRef.current) {
const progress = logExportManagerRef.current.appendChunk(args.logs);
setExportProgress(progress);
}
break;
case WORKER_RESP_CODE.LOG_FILE_INFO:
setFileName(args.fileName);
setNumEvents(args.numEvents);
setOnDiskFileSizeInBytes(args.onDiskFileSizeInBytes);
break;
case WORKER_RESP_CODE.NOTIFICATION:
// eslint-disable-next-line no-warning-comments
// TODO: notifications should be shown in the UI when the NotificationProvider
// is added
console.error(args.logLevel, args.message);
break;
case WORKER_RESP_CODE.PAGE_DATA: {
setLogData(args.logs);
setNumPages(args.numPages);
setPageNum(args.pageNum);
beginLineNumToLogEventNumRef.current = args.beginLineNumToLogEventNum;
updateWindowUrlHashParams({
logEventNum: args.logEventNum,
});
break;
}
case WORKER_RESP_CODE.QUERY_RESULT:
setQueryResults((v) => {
args.results.forEach((resultsPerPage, queryPageNum) => {
if (false === v.has(queryPageNum)) {
v.set(queryPageNum, []);
}
v.get(queryPageNum)?.push(...resultsPerPage);
});
return v;
});
break;
default:
console.error(`Unexpected ev.data: ${JSON.stringify(ev.data)}`);
break;
}
}, []);
const startQuery = useCallback((
queryString: string,
isRegex: boolean,
isCaseSensitive: boolean
) => {
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,
});
}, []);
const exportLogs = useCallback(() => {
if (null === mainWorkerRef.current) {
console.error("Unexpected null mainWorkerRef.current");
return;
}
if (STATE_DEFAULT.numEvents === numEvents && STATE_DEFAULT.fileName === fileName) {
console.error("numEvents and fileName not initialized yet");
return;
}
setExportProgress(EXPORT_LOG_PROGRESS_VALUE_MIN);
logExportManagerRef.current = new LogExportManager(
Math.ceil(numEvents / EXPORT_LOGS_CHUNK_SIZE),
fileName
);
workerPostReq(
mainWorkerRef.current,
WORKER_REQ_CODE.EXPORT_LOG,
null
);
}, [
numEvents,
fileName,
]);
const loadFile = useCallback((fileSrc: FileSrcType, cursor: CursorType) => {
if ("string" !== typeof fileSrc) {
updateWindowUrlSearchParams({[SEARCH_PARAM_NAMES.FILE_PATH]: null});
}
if (null !== mainWorkerRef.current) {
mainWorkerRef.current.terminate();
}
mainWorkerRef.current = new Worker(
new URL("../services/MainWorker.ts", import.meta.url)
);
mainWorkerRef.current.onmessage = handleMainWorkerResp;
workerPostReq(mainWorkerRef.current, WORKER_REQ_CODE.LOAD_FILE, {
fileSrc: fileSrc,
pageSize: getConfig(CONFIG_KEY.PAGE_SIZE),
cursor: cursor,
decoderOptions: getConfig(CONFIG_KEY.DECODER_OPTIONS),
});
setFileName("Loading...");
setLogData("Loading...");
setOnDiskFileSizeInBytes(STATE_DEFAULT.onDiskFileSizeInBytes);
setExportProgress(STATE_DEFAULT.exportProgress);
}, [
handleMainWorkerResp,
]);
const loadPageByAction = useCallback((navAction: NavigationAction) => {
if (null === mainWorkerRef.current) {
console.error("Unexpected null mainWorkerRef.current");
return;
}
const cursor = getPageNumCursor(navAction, pageNumRef.current, numPagesRef.current);
if (null === cursor) {
console.error(`Error with nav action ${navAction.code}.`);
return;
}
loadPageByCursor(mainWorkerRef.current, cursor);
}, []);
const setLogLevelFilter = useCallback((newLogLevelFilter: LogLevelFilter) => {
if (null === mainWorkerRef.current) {
return;
}
workerPostReq(mainWorkerRef.current, WORKER_REQ_CODE.SET_FILTER, {
cursor: {code: CURSOR_CODE.EVENT_NUM, args: {eventNum: logEventNumRef.current ?? 1}},
logLevelFilter: newLogLevelFilter,
});
}, []);
// Synchronize `logEventNumRef` with `logEventNum`.
useEffect(() => {
logEventNumRef.current = logEventNum;
}, [logEventNum]);
// Synchronize `pageNumRef` with `numPages`.
useEffect(() => {
pageNumRef.current = pageNum;
}, [pageNum]);
// Synchronize `numPagesRef` with `numPages`.
useEffect(() => {
numPagesRef.current = numPages;
}, [numPages]);
// On `logEventNum` update, clamp it then switch page if necessary or simply update the URL.
useEffect(() => {
if (null === mainWorkerRef.current) {
return;
}
if (URL_HASH_PARAMS_DEFAULT.logEventNum === logEventNum) {
return;
}
const logEventNumsOnPage: number [] =
Array.from(beginLineNumToLogEventNumRef.current.values());
const clampedLogEventNum = clamp(logEventNum, 1, numEvents);
if (updateUrlIfEventOnPage(clampedLogEventNum, logEventNumsOnPage)) {
// No need to request a new page since the log event is on the current page.
return;
}
const cursor: CursorType = {
code: CURSOR_CODE.EVENT_NUM,
args: {eventNum: logEventNum},
};
loadPageByCursor(mainWorkerRef.current, cursor);
}, [
numEvents,
logEventNum,
]);
// On `filePath` update, load file.
useEffect(() => {
if (URL_SEARCH_PARAMS_DEFAULT.filePath === filePath) {
return;
}
let cursor: CursorType = {code: CURSOR_CODE.LAST_EVENT, args: null};
if (URL_HASH_PARAMS_DEFAULT.logEventNum !== logEventNumRef.current) {
cursor = {
code: CURSOR_CODE.EVENT_NUM,
args: {eventNum: logEventNumRef.current},
};
}
loadFile(filePath, cursor);
}, [
filePath,
loadFile,
]);
return (
<StateContext.Provider
value={{
beginLineNumToLogEventNum: beginLineNumToLogEventNumRef.current,
exportProgress: exportProgress,
fileName: fileName,
logData: logData,
numEvents: numEvents,
numPages: numPages,
onDiskFileSizeInBytes: onDiskFileSizeInBytes,
pageNum: pageNum,
queryResults: queryResults,
exportLogs: exportLogs,
loadFile: loadFile,
loadPageByAction: loadPageByAction,
setLogLevelFilter: setLogLevelFilter,
startQuery: startQuery,
}}
>
{children}
</StateContext.Provider>
);
};
export default StateContextProvider;
export {StateContext};