posthog icon indicating copy to clipboard operation
posthog copied to clipboard

fix(insights): Make async query execution use the same cache as sync

Open Twixes opened this issue 1 year ago • 5 comments

Problem

When a query is executed async (via /query/), we aren't able to reuse its results in sync execution (/insights/ or /dashboards/), because we treat LimitContext.QUERY and LimitContext.QUERY_ASYNC as different in the cache key. This doesn't make sense, because the queries are the same, max query duration is the only difference.

Changes

This works as a follow-up to #22151. Now, async queries have the same cache key as sync. Also, if cached results are available, we immediately return the QueryStatus with results – no polling needed.

How did you test this code?

Added test_insight_refreshing_query_async.

Twixes avatar May 09 '24 21:05 Twixes

Size Change: +1.86 kB (+0.18%)

Total Size: 1.05 MB

Filename Size Change
frontend/dist/toolbar.js 1.05 MB +1.86 kB (+0.18%)

compressed-size-action

github-actions[bot] avatar May 09 '24 22:05 github-actions[bot]

@coderabbitai review

Twixes avatar May 19 '24 10:05 Twixes

Actions Performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai[bot] avatar May 19 '24 10:05 coderabbitai[bot]

Walkthrough

The recent updates enhance the handling of asynchronous queries across multiple files. Changes include refining logic in executeQuery, updating the query_async property in schema definitions, modifying parameter names in API methods, and adjusting caching mechanisms. These improvements ensure more accurate async query processing, better documentation, and refined caching behavior.

Changes

Files Change Summary
frontend/src/queries/query.ts Refined logic for handling asynchronous queries in executeQuery.
frontend/src/queries/schema.json Added const and description fields to query_async property.
frontend/src/queries/schema.ts Updated query_async property in QueryStatus type to true with additional documentation.
posthog/api/query.py, posthog/clickhouse/client/execute_async.py Modified parameter names from team_id and user_id to team and user respectively.
posthog/api/test/test_insight.py, posthog/clickhouse/client/test/... Added new test methods and updated parameter usage in various tests.
posthog/caching/calculate_results.py Updated logic for handling CacheMissResponse in calculate_for_query_based_insight function.
posthog/hogql_queries/query_runner.py Added _limit_context_aliased_for_cache property and modified run method to use self.get_cache_key().
posthog/hogql_queries/test/test_query_runner.py Updated cache_key values in various test methods.
posthog/schema.py Changed query_async property in QueryStatus class to Literal[True] with a default value and description.

In the realm of code, async queries dance, With refined logic, they now enhance. Parameters renamed, tests anew, Caches updated, changes grew. A rabbit hops with joy and cheer, For queries now run smooth and clear. 🐇✨


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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

CodeRabbit Configration 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[bot] avatar May 19 '24 10:05 coderabbitai[bot]

These comments are pretty dumb honestly

Twixes avatar May 19 '24 11:05 Twixes

Suspect Issues

This pull request was deployed and Sentry observed the following issues:

  • ‼️ CHQueryErrorNoCommonType: DB::Exception: There is no supertype for types UInt8, UInt8, Array(String) because some of them a... posthog.tasks.tasks.process_query_task View Issue
  • ‼️ CHQueryErrorQueryWasCancelled: DB::Exception: Query was cancelled. Stack trace: /api/projects/{parent_lookup_team_id}/insights/... View Issue
  • ‼️ CHQueryErrorTimeoutExceeded: DB::Exception: Timeout exceeded: elapsed 61.579040291 seconds, maximum: 60. Stack trace: /api/projects/{parent_lookup_team_id}/insights/... View Issue
  • ‼️ ValidationError: 2 validation errors for CachedWebOverviewQueryResponse /api/projects/{parent_lookup_team_id}/query/ View Issue
  • ‼️ ValidationError: 2 validation errors for CachedWebOverviewQueryResponse posthog.tasks.tasks.process_query_task View Issue

Did you find this useful? React with a 👍 or 👎

sentry[bot] avatar May 21 '24 19:05 sentry[bot]