feat(URL): Add support to query timestamp by URL #152

Henry8192 · 2024-12-09T23:35:50Z

Description

Validation performed

…igint

coderabbitai · 2024-12-09T23:36:00Z

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Experiment)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

…esult timestamp

junhaoliao

overall structure looks really good

junhaoliao · 2024-12-18T20:32:52Z

src/services/decoders/JsonlDecoder/index.ts

+            const mid = Math.floor((low + high) / 2);
+
+            // @ts-expect-error TS2532: Object is possibly 'undefined'.
+            const midTimestamp = this.#logEvents[mid].timestamp.valueOf();


Since @ts-expect-error disables type-checking for the whole following line, can we extract a const midLogEvent = this.#logEvents[mid]; and only disable type-checking for that?

junhaoliao · 2024-12-18T20:34:03Z

src/services/MainWorker.ts

@@ -137,6 +137,14 @@ onmessage = async (ev: MessageEvent<MainWorkerReqMessage>) => {
                    args.isCaseSensitive
                );
                break;
+


Do we still need this?

junhaoliao · 2024-12-18T20:39:39Z

src/contexts/UrlContextProvider.tsx

+    const checkAndSetHashParam = (hashParamName: keyof UrlHashParams) => {
+        const hashParam = hashParams.get(hashParamName);
+        if (null !== hashParam) {
+            const parsed = Number(hashParam);
+            urlHashParams[hashParamName] = Number.isNaN(parsed) ?
+                null :
+                parsed;
+        }
+    };
+
+    checkAndSetHashParam(HASH_PARAM_NAMES.LOG_EVENT_NUM);
+    checkAndSetHashParam(HASH_PARAM_NAMES.TIMESTAMP);


Would this be more concise and avoid the nested function declaration? (haven't tested

Suggested change

const checkAndSetHashParam = (hashParamName: keyof UrlHashParams) => {

const hashParam = hashParams.get(hashParamName);

if (null !== hashParam) {

const parsed = Number(hashParam);

urlHashParams[hashParamName] = Number.isNaN(parsed) ?

null :

parsed;

}

};

checkAndSetHashParam(HASH_PARAM_NAMES.LOG_EVENT_NUM);

checkAndSetHashParam(HASH_PARAM_NAMES.TIMESTAMP);

const numberHashParamNames = [HASH_PARAM_NAMES.LOG_EVENT_NUM, HASH_PARAM_NAMES.TIMESTAMP];

for (const paramName of numberHashParamNames) {

const hashParam = hashParams.get(paramName);

if (hashParam !== null) {

const parsed = Number(hashParam);

urlHashParams[paramName] = Number.isNaN(parsed) ? null : parsed;

}

}

src/contexts/StateContextProvider.tsx

junhaoliao · 2024-12-18T20:46:21Z

src/typings/decoders.ts

+    /**
+     * Retrieves the last index of the log event that matches the given timestamp.
+     * If no such log event exists, returns -1.
+     *
+     * @param timestamp
+     * @return
+     */


Suggested change

/**

* Retrieves the last index of the log event that matches the given timestamp.

* If no such log event exists, returns -1.

*

* @param timestamp

* @return

*/

/**

* Finds the index of the last log event that matches the specified timestamp.

*

* @param timestamp

* @return The index of the matching log event, or -1 if no match is found.

*/

junhaoliao · 2024-12-18T20:46:37Z

src/typings/decoders.ts

+     * @param timestamp
+     * @return
+     */
+    getLogEventIdxByTimestamp(timestamp: number): number;


Shall we return null no such event is found?

junhaoliao · 2024-12-18T20:48:34Z

src/services/decoders/JsonlDecoder/index.ts

+    getLogEventIdxByTimestamp (timestamp: number): number {
+        let low = 0;
+        let high = this.#logEvents.length - 1;
+        let result = -1;


let's see if the suggestion at https://github.com/y-scope/yscope-log-viewer/pull/152/files#r1890816021 makes sense. If not (i.e., we want to keep the return type as number rather than Nullable<number>), let's create a const for -1 so we can avoid magic numbers.

Henry8192 added 4 commits December 5, 2024 14:36

snapshot

5477d0a

draft without implementing getLogEventIdxByTimestamp

4a8aeb7

patch

7f5cc7f

implementing JSONL getLogEventIdxByTimestamp, fix timestamp type to b…

54ef03c

…igint

Henry8192 changed the title ~~WIP: feat(URL): Add support to query timestamp by URL~~ feat(URL): Add support to query timestamp by URL Dec 9, 2024

Henry8192 added 2 commits December 11, 2024 16:36

fix JSONL getEventIdxByTimestamp + timestamp hash param not cleared

6c2b45a

revert timestamp type back to Number; Only keeping bigint for DecodeR…

255f3e3

…esult timestamp

junhaoliao self-requested a review December 18, 2024 20:29

junhaoliao requested changes Dec 18, 2024

View reviewed changes

junhaoliao reviewed Dec 18, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(URL): Add support to query timestamp by URL #152

feat(URL): Add support to query timestamp by URL #152

Henry8192 commented Dec 9, 2024

coderabbitai bot commented Dec 9, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

junhaoliao left a comment

junhaoliao Dec 18, 2024

junhaoliao Dec 18, 2024

junhaoliao Dec 18, 2024

junhaoliao Dec 18, 2024

junhaoliao Dec 18, 2024

junhaoliao Dec 18, 2024

feat(URL): Add support to query timestamp by URL #152

Are you sure you want to change the base?

feat(URL): Add support to query timestamp by URL #152

Conversation

Henry8192 commented Dec 9, 2024

Description

Validation performed

coderabbitai bot commented Dec 9, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

junhaoliao left a comment

Choose a reason for hiding this comment

junhaoliao Dec 18, 2024

Choose a reason for hiding this comment

junhaoliao Dec 18, 2024

Choose a reason for hiding this comment

junhaoliao Dec 18, 2024

Choose a reason for hiding this comment

junhaoliao Dec 18, 2024

Choose a reason for hiding this comment

junhaoliao Dec 18, 2024

Choose a reason for hiding this comment

junhaoliao Dec 18, 2024

Choose a reason for hiding this comment

CodeRabbit Configuration File (`.coderabbit.yaml`)