A platform for community discussion. Free, open, simple.
# frozen_string_literal: true
RSpec.describe DiscourseDataExplorer::QueryRunner do
fab!(:admin)
fab!(:query) { Fabricate(:query, sql: "SELECT 1 AS value", user: admin) }
fab!(:query_with_params) do
Fabricate(
:query,
sql: "-- [params]\n-- int :limit = 10\n\nSELECT 1 AS value LIMIT :limit",
user: admin,
)
end
fab!(:query_with_internal_params) do
Fabricate(
:query,
sql: "-- [params]\n-- current_user_id :me\n\nSELECT id FROM users WHERE id = :me",
user: admin,
)
end
after do
described_class.invalidate(query.id)
described_class.invalidate(query_with_params.id)
described_class.invalidate(query_with_internal_params.id)
end
describe ".run caching behavior" do
it "runs the query and returns results" do
result = described_class.run(query, nil, current_user: admin)
expect(result[:success]).to eq(true)
expect(result[:columns]).to include("value")
expect(result[:rows]).to be_present
end
it "caches the result after execution" do
described_class.run(query, nil, current_user: admin)
cached = described_class.cached_result(query, nil, current_user: admin)
expect(cached).to be_present
expect(cached[:success]).to eq(true)
end
it "does not cache when explain is true" do
described_class.run(query, nil, current_user: admin, explain: true)
expect(described_class.cached_result(query, nil, current_user: admin)).to be_nil
end
it "does not cache queries with internal params" do
described_class.run(query_with_internal_params, nil, current_user: admin)
expect(
described_class.cached_result(query_with_internal_params, nil, current_user: admin),
).to be_nil
end
it "returns error info when query fails" do
bad_query = Fabricate(:query, sql: "SELECT * FROM nonexistent_table_xyz")
result = described_class.run(bad_query, nil, current_user: admin)
expect(result[:error]).to be_present
end
end
describe ".cached_result" do
context "when the cached JSON contains null" do
subject(:cached_result) { described_class.cached_result(query, nil, current_user: admin) }
let(:cache_key) { DiscourseDataExplorer::QueryResultCache.cache_key(query.id, admin, {}) }
before { Discourse.redis.set(cache_key, "null") }
it "returns a cache miss" do
expect(cached_result).to be_nil
end
end
it "returns nil when no cache exists" do
expect(described_class.cached_result(query, nil, current_user: admin)).to be_nil
end
it "returns cached result after execute" do
described_class.run(query, nil, current_user: admin)
cached = described_class.cached_result(query, nil, current_user: admin)
expect(cached[:cached_at]).to be_present
expect(cached[:rows]).to be_present
end
it "returns nil for queries with internal params" do
expect(
described_class.cached_result(query_with_internal_params, nil, current_user: admin),
).to be_nil
end
it "resolves URL params when present" do
described_class.run(query_with_params, '{"limit":"5"}', current_user: admin)
cached =
described_class.cached_result(query_with_params, '{"limit":"5"}', current_user: admin)
expect(cached).to be_present
cached_default = described_class.cached_result(query_with_params, nil, current_user: admin)
expect(cached_default).to be_nil
end
it "falls back to default params when no URL params" do
described_class.run(query_with_params, '{"limit":"10"}', current_user: admin)
cached = described_class.cached_result(query_with_params, nil, current_user: admin)
expect(cached).to be_present
end
it "returns cached result when run was called with null params" do
described_class.run(query_with_params, "null", current_user: admin)
cached = described_class.cached_result(query_with_params, nil, current_user: admin)
expect(cached).to be_present
end
it "handles malformed JSON params gracefully" do
expect(described_class.cached_result(query, "not-json", current_user: admin)).to be_nil
end
end
describe ".run limit handling" do
it "does not cache when a non-default limit is used" do
described_class.run(query, nil, current_user: admin, limit: 1)
expect(described_class.cached_result(query, nil, current_user: admin)).to be_nil
end
it "caches when using the default limit" do
described_class.run(
query,
nil,
current_user: admin,
limit: SiteSetting.data_explorer_query_result_limit,
)
expect(described_class.cached_result(query, nil, current_user: admin)).to be_present
end
end
describe "per-user caching" do
fab!(:moderator)
fab!(:pm, :private_message_topic)
fab!(:pm_query) { Fabricate(:query, sql: "SELECT #{pm.id} AS topic_id", user: admin) }
it "does not serve relations resolved under another user's guardian" do
described_class.run(pm_query, nil, current_user: admin)
admin_cached = described_class.cached_result(pm_query, nil, current_user: admin)
expect(admin_cached[:relations][:topic]).to include(include(id: pm.id))
expect(described_class.cached_result(pm_query, nil, current_user: moderator)).to be_nil
end
it "does not share entries between admins when secured categories are suppressed" do
SiteSetting.suppress_secured_categories_from_admin = true
described_class.run(query, nil, current_user: admin)
expect(described_class.cached_result(query, nil, current_user: Fabricate(:admin))).to be_nil
end
end
describe ".invalidate" do
it "removes all cached results for a query" do
described_class.run(query, nil, current_user: admin)
expect(described_class.cached_result(query, nil, current_user: admin)).to be_present
described_class.invalidate(query.id)
expect(described_class.cached_result(query, nil, current_user: admin)).to be_nil
end
end
end