fix: Logs page histogram api duplicate call #3998

bjp232004 · 2024-07-17T11:49:42Z

Summary by CodeRabbit

Bug Fixes
- Improved reliability of histogram data loading by refining conditional logic.
- Ensured loadLogsData() only runs when necessary, enhancing performance and preventing unnecessary calls.
New Features
- Enhanced control flow to check for query result hits before proceeding with certain operations.
Tests
- Introduced a delay in the UI test to improve the reliability of visibility checks for error messages after refresh actions.

coderabbitai · 2024-07-17T11:49:51Z

Walkthrough

The updates enhance the control flow in the useLogs function in useLogs.ts and the Index.vue component. Key changes include new checks to ensure data fetching and operations occur only under appropriate conditions, preventing unnecessary actions. These improvements increase the efficiency and reliability of the application by validating the presence of query results and managing loading states more effectively.

Changes

File	Summary
`web/src/composables/useLogs.ts`	Modified conditional logic to fetch histogram data only when query results (`hits`) are present.
`web/src/plugins/logs/Index.vue`	Added checks for `searchObj.loading` before invoking `loadLogsData()`; adjusted loading state management.
`tests/ui-testing/playwright-tests/logsquickmode.spec.js`	Introduced a 2-second delay before checking error message visibility to enhance test reliability after refresh actions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant VueComponent
    participant useLogsFunction
    participant DataSource

    User->>VueComponent: Interacts with UI
    VueComponent->>useLogsFunction: Call useLogs()
    useLogsFunction->>useLogsFunction: Check if query results `hits` are present
    alt hits are present
        useLogsFunction->>DataSource: Fetch histogram query data
        DataSource-->>useLogsFunction: Return data
    end
    VueComponent->>VueComponent: Check if `searchObj.loading` is false
    alt `searchObj.loading` is false
        VueComponent->>VueComponent: Call loadLogsData()
    end
    VueComponent->>VueComponent: Verify if `config.isCloud` is true
    alt `config.isCloud` is true
        VueComponent->>VueComponent: Call getOrganizationThreshold(store)
    end

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>.
- 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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 as 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 resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e02d476 and 9c150e8.

Files selected for processing (2)

web/src/composables/useLogs.ts (2 hunks)
web/src/plugins/logs/Index.vue (2 hunks)

Additional comments not posted (4)

web/src/plugins/logs/Index.vue (2)

528-530: Optimize loading logic by reducing duplicate calls.

The added condition if(searchObj.loading==false) before calling loadLogsData() is a good practice to prevent unnecessary API calls when data is already being loaded. This aligns with the PR objective to optimize API calls and improve performance.

530-530: Ensure cloud-specific configurations are handled appropriately.

The condition checking config.isCloud == "true" before executing MainLayoutCloudMixin.setup().getOrganizationThreshold(store) ensures that cloud-specific configurations are only applied when necessary. This is a good practice to prevent the execution of cloud-specific code in environments where it's not applicable.

web/src/composables/useLogs.ts (2)

1628-1630: Conditional Logic to Fetch Histogram Data Based on Query Hits

The added conditional logic ensures that histogram data is fetched only if there are hits from the query. This is a good optimization as it prevents unnecessary data fetching and processing when there are no relevant results to display.

1646-1646: Conditional Logic for Pagination and Multi-Stream Handling

This condition checks if the current page is the first one and there are query hits before proceeding to get the page count. Additionally, it handles conditions for multi-stream searches by setting up an appropriate error message. This is a crucial addition for performance optimization and correct data handling in scenarios involving multiple data streams.

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9c150e8 and 62bc92f.

Files selected for processing (1)

web/src/composables/useLogs.ts (2 hunks)

Files skipped from review as they are similar to previous changes (1)

web/src/composables/useLogs.ts

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 62bc92f and e842cea.

Files selected for processing (1)

web/src/composables/useLogs.ts (2 hunks)

Files skipped from review as they are similar to previous changes (1)

web/src/composables/useLogs.ts

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e842cea and 631b251.

Files selected for processing (2)

web/src/composables/useLogs.ts (2 hunks)
web/src/plugins/logs/Index.vue (2 hunks)

Files skipped from review as they are similar to previous changes (2)

web/src/composables/useLogs.ts
web/src/plugins/logs/Index.vue

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 631b251 and 12bdfdb.

Files selected for processing (2)

web/src/composables/useLogs.ts (2 hunks)
web/src/plugins/logs/Index.vue (3 hunks)

Files skipped from review as they are similar to previous changes (2)

web/src/composables/useLogs.ts
web/src/plugins/logs/Index.vue

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 12bdfdb and 546c45f.

Files selected for processing (1)

web/src/composables/useLogs.ts (2 hunks)

Files skipped from review as they are similar to previous changes (1)

web/src/composables/useLogs.ts

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 546c45f and 47eff30.

Files selected for processing (1)

tests/ui-testing/playwright-tests/logsquickmode.spec.js (1 hunks)

Additional context used

Path-based instructions (1)

tests/ui-testing/playwright-tests/logsquickmode.spec.js (1)

Pattern **/*.js: You are a smart javascript/typescript pull request reviewer.
You are going to review all the javascript/typescript files.
Be concise, and add a brief explanation to your suggestions

Make sure the responses are not too verbose and keep the suggestions to the point i.e. actionable.

Additional comments not posted (1)

tests/ui-testing/playwright-tests/logsquickmode.spec.js (1)

182-183: LGTM! The added delay improves test reliability.

The 2-second delay ensures that any asynchronous operations triggered by the refresh action have sufficient time to complete, reducing the likelihood of false negatives in the visibility check.

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 47eff30 and 6882c2e.

Files selected for processing (3)

tests/ui-testing/playwright-tests/logsquickmode.spec.js (1 hunks)
web/src/composables/useLogs.ts (2 hunks)
web/src/plugins/logs/Index.vue (3 hunks)

Files skipped from review as they are similar to previous changes (2)

tests/ui-testing/playwright-tests/logsquickmode.spec.js
web/src/composables/useLogs.ts

Additional comments not posted (5)

web/src/plugins/logs/Index.vue (5)

499-500: Verify the correctness of the condition.

The condition ensures loadLogsData() is called only when the organization identifier does not match and the loading state is false. This prevents redundant API calls.

Ensure that the organization identifier and loading state are correctly managed throughout the codebase.

514-514: Verify the impact of commenting out searchObj.loading = true.

Commenting out this line indicates a shift in how loading states are managed. Ensure this does not lead to any unintended side effects.

Verify that the loading state is correctly managed elsewhere in the code.

526-529: Ensure the correct sequence of operations.

The sequence of operations ensures resetSearchObj() and resetStreamData() are called only if searchObj.loading is false. This prevents unnecessary resets during loading.

Verify that this sequence does not lead to any unintended side effects.

530-530: Verify the correctness of calling loadLogsData() after resets.

Calling loadLogsData() after the resets ensures data is loaded only when necessary. This prevents redundant API calls.

Ensure that loadLogsData() is correctly managed and does not lead to any unintended side effects.

526-530: Ensure the correct sequence of operations.

The sequence of operations ensures resetSearchObj() and resetStreamData() are called only if searchObj.loading is false. This prevents unnecessary resets during loading.

Verify that this sequence does not lead to any unintended side effects.

…ub.com/openobserve/openobserve into logs-page-histogram-api-duplicate-call

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6882c2e and 3fc088e.

Files selected for processing (3)

tests/ui-testing/playwright-tests/logsquickmode.spec.js (2 hunks)
web/src/composables/useLogs.ts (3 hunks)
web/src/plugins/logs/Index.vue (3 hunks)

Files skipped from review due to trivial changes (1)

tests/ui-testing/playwright-tests/logsquickmode.spec.js

Additional comments not posted (10)

web/src/plugins/logs/Index.vue (5)

493-493: LGTM! Optimizes performance by avoiding redundant API calls.

The conditional check ensures that loadLogsData() is called only when necessary, preventing redundant API calls.

499-499: LGTM! Ensures efficient data loading.

The conditional check ensures that loadLogsData() is called only when the organization identifier has changed and searchObj.loading is false, optimizing performance.

514-514: Verify the rationale behind commenting out the loading state.

The line setting searchObj.loading to true has been commented out. Ensure this change aligns with the new loading state management strategy.

526-531: LGTM! Ensures correct data reset and loading.

The changes ensure that search and stream data are reset, URL query parameters are restored, and logs data are loaded only when searchObj.loading is false, optimizing performance.

530-530: LGTM! Ensures correct data loading sequence.

The change ensures that loadLogsData() is called after resetting search and stream data and restoring URL query parameters, preventing redundant API calls.

web/src/composables/useLogs.ts (5)

1628-1629: Ensure searchObj.data.queryResults.hits is non-empty before calling getHistogramQueryData.

This change prevents unnecessary API calls when there are no query results.

1646-1650: Refine timeout logic to check for aggregations and non-empty hits.

This change ensures that the timeout logic executes only when necessary, improving efficiency.

1650-1650: Set timeout for getPageCount if query starts from the beginning and there are hits without aggregations.

This change ensures that the page count is fetched only when necessary, optimizing performance.

1650-1650: Handle multi-stream search case by setting an error message for the histogram.

This change provides a clear error message when the histogram is not available for multi-stream searches.

Line range hint 1628-1650:
Clean up code by removing unnecessary comments and code.

This change improves readability and maintainability.

github-actions bot added the Invalid PR Title label Jul 17, 2024

bjp232004 changed the title ~~Logs page histogram api duplicate call~~ fix: Logs page histogram api duplicate call Jul 17, 2024

coderabbitai bot reviewed Jul 17, 2024

View reviewed changes

omkarK06 approved these changes Jul 17, 2024

View reviewed changes

github-actions bot added ☢️ Bug Something isn't working and removed Invalid PR Title labels Jul 18, 2024

coderabbitai bot reviewed Jul 18, 2024

View reviewed changes

bjp232004 force-pushed the logs-page-histogram-api-duplicate-call branch from e842cea to 631b251 Compare July 18, 2024 11:36

coderabbitai bot reviewed Jul 18, 2024

View reviewed changes

bjp232004 added 4 commits July 18, 2024 17:37

fix: avoid histogram and count api request in case of no records found.

edbebed

duplicate api requests on page refresh

bf0fb8d

fix: page count api restricted for aggregation query

bc3234d

Update useLogs.ts

ff96876

bjp232004 force-pushed the logs-page-histogram-api-duplicate-call branch from ff31dd6 to 12bdfdb Compare July 18, 2024 12:08

Update Index.vue

12bdfdb

coderabbitai bot reviewed Jul 18, 2024

View reviewed changes

Update useLogs.ts

546c45f

coderabbitai bot reviewed Jul 18, 2024

View reviewed changes

bjp232004 added 8 commits July 19, 2024 13:05

fix: automation test

47eff30

fix: avoid histogram and count api request in case of no records found.

389bbd4

duplicate api requests on page refresh

3cb7d3c

fix: page count api restricted for aggregation query

9324058

Update useLogs.ts

442fd59

Update Index.vue

1b88224

Update useLogs.ts

ead82ae

fix: automation test

6882c2e

bjp232004 force-pushed the logs-page-histogram-api-duplicate-call branch from 47eff30 to 6882c2e Compare July 19, 2024 07:38

coderabbitai bot reviewed Jul 19, 2024

View reviewed changes

bjp232004 added 2 commits July 19, 2024 15:21

fix automation test

f50f786

Merge branch 'logs-page-histogram-api-duplicate-call' of https://gith…

3fc088e

…ub.com/openobserve/openobserve into logs-page-histogram-api-duplicate-call

coderabbitai bot reviewed Jul 19, 2024

View reviewed changes

bjp232004 merged commit 8f1af1a into main Jul 19, 2024

bjp232004 deleted the logs-page-histogram-api-duplicate-call branch July 19, 2024 10:12

coderabbitai bot mentioned this pull request Oct 17, 2024

fix: UI freezes on enabling histogram #4813

Merged

coderabbitai bot mentioned this pull request Nov 13, 2024

fix: join & subquery related UI changes on logs page #5055

Merged

fix: Logs page histogram api duplicate call #3998

fix: Logs page histogram api duplicate call #3998

Uh oh!

Conversation

bjp232004 commented Jul 17, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jul 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

bjp232004 commented Jul 17, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 17, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)