fix: fix the issue of saved view overriding query for logs and traces

[ahmadshaheer]

Summary

• Added isDefaultQuery function to determine if the current query matches the default query.
• Integrated isDefaultQuery into ExplorerOptions to conditionally handle applying the recently used saved view based on the query type.
• Updated types to include IsDefaultQueryProps for better type safety.

This enhancement improves the query handling logic, ensuring that only default queries are processed for recently used saved view.

Related Issues / PR's

close https://signoz-team.slack.com/archives/C02TJ466H8U/p1734874203586999
close https://github.com/SigNoz/engineering-pod/issues/2067

Previous PR: #6612

Screenshots

Before:

2024-12-11.11-26-02.mov

After:

2024-12-11.11-27-29.mov

Affected Areas

• Logs explorer
• Traces explorer

Manually Tested Areas

• Visiting logs explorer from service details page (View logs) -> should respect the query and avoid applying the recently used saved view
• Visiting traces explorer from service details page (View traces) -> should respect the query and avoid applying the recently used saved view
• Visiting logs explorer from timeline table of alert history page (View logs) -> should respect the query and avoid applying the recently used saved view
• Visiting logs explorer from other pages -> should apply the recently used saved view
• Visiting traces explorer from other pages -> should apply the recently used saved view

---

Important

Introduces isDefaultQuery function to conditionally apply saved views in ExplorerOptions based on query type, with updated types for safety.

• Behavior:
  • Added isDefaultQuery function in QueryBuilder.tsx to check if a query is default.
  • Integrated isDefaultQuery in ExplorerOptions.tsx to conditionally apply saved views based on query type.
• Types:
  • Updated types in queryBuilder.ts to include IsDefaultQueryProps for type safety.

^{This description was created by for 7670b93. It will automatically update as commits are pushed.}

[ellipsis-dev]

👍 Looks good to me! Reviewed everything up to c8d349c in 2 minutes and 24 seconds

More details

• Looked at 200 lines of code in 3 files
• Skipped 0 files when reviewing.
• Skipped posting 2 drafted comments based on config settings.

1. frontend/src/container/ExplorerOptions/ExplorerOptions.tsx:483

• Draft comment:
  The useEffect hook is missing onMenuItemSelectHandler in its dependency array. This could lead to stale closures if onMenuItemSelectHandler changes.
• Reason this comment was not posted:
  Comment was on unchanged code.

2. frontend/src/container/ExplorerOptions/ExplorerOptions.tsx:489

• Draft comment:
  Consider adding a try-catch block around JSON.parse to handle potential JSON parsing errors gracefully. This is also applicable at lines 232 and 283.
• Reason this comment was not posted:
  Comment was on unchanged code.

Workflow ID: wflow_r5YGZHZVsFJO1V2Z

---

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

[ellipsis-dev]

👍 Looks good to me! Incremental review on 7670b93 in 47 seconds

More details

• Looked at 25 lines of code in 2 files
• Skipped 0 files when reviewing.
• Skipped posting 3 drafted comments based on config settings.

1. frontend/src/pages/LogsExplorer/__tests__/LogsExplorer.test.tsx:158

• Draft comment:
  The isDefaultQuery function is mocked to always return false. Consider testing scenarios where it returns true to ensure comprehensive test coverage. This applies to TracesExplorer/__test__/testUtils.ts as well.
• Reason this comment was not posted:
  Decided after close inspection that this draft comment was likely wrong and/or not actionable:
  The comment suggests adding more test coverage, which could be valid. However, it's making assumptions about what needs to be tested without understanding the full context. We don't know if isDefaultQuery=true is an important case that needs testing. The comment also references another file (TracesExplorer) which violates the cross-file issues rule.
  I might be too harsh - test coverage suggestions can be valuable. The suggestion to test both true/false cases is a common testing best practice.
  While test coverage is important, we don't have enough context to know if isDefaultQuery=true is a meaningful case that needs testing. The comment also violates the rule about cross-file issues.
  Delete the comment. While suggesting test coverage is good, we don't have enough context to know if this specific case needs testing, and the comment references other files which violates our rules.

2. frontend/src/pages/LogsExplorer/__tests__/LogsExplorer.test.tsx:155

• Draft comment:
  Avoid using inline styles in React components. Use external stylesheets, CSS classes, or styled components instead. This is also applicable in other parts of the code where inline styles are used.
• Reason this comment was not posted:
  Comment was not on a valid diff hunk.

3. frontend/src/pages/TracesExplorer/__test__/testUtils.ts:198

• Draft comment:
  Avoid using inline styles in React components. Use external stylesheets, CSS classes, or styled components instead. This is also applicable in other parts of the code where inline styles are used.
• Reason this comment was not posted:
  Marked as duplicate.

Workflow ID: wflow_a2dzBwuZrB9pL3pB

---

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.