A platform for community discussion. Free, open, simple.
# frozen_string_literal: true
require_relative "support"
RSpec.describe "a document with a sparse fieldset" do
include_context "with a listing of topics"
let(:params) { { sort: { createdAt: :asc }, page: { size: 1 }, fields: { topics: [:title] } } }
it "renders the field of the primary type it asks for" do
expect(document).to eq(
data: [topic_object(oldest, fields: %w[title])],
included: [],
links: links_of(next: page_url(after: cursor_of_record(oldest, sort: { created_at: :asc }))),
)
end
context "when the request has no fieldset" do
let(:params) { { sort: { createdAt: :asc }, page: { size: 1 } } }
it "renders every field the resource declares" do
expect(document).to eq(
data: [topic_object(oldest)],
included: [],
links:
links_of(next: page_url(after: cursor_of_record(oldest, sort: { created_at: :asc }))),
)
end
end
context "when the fieldset holds an unknown field" do
let(:params) do
{ sort: { createdAt: :asc }, page: { size: 1 }, fields: { topics: [:secrets] } }
end
it "renders no attribute" do
expect(document).to eq(
data: [topic_object(oldest, fields: [])],
included: [],
links:
links_of(next: page_url(after: cursor_of_record(oldest, sort: { created_at: :asc }))),
)
end
end
context "when the fieldset is on a related type" do
let(:params) do
{
sort: {
createdAt: :asc,
},
page: {
size: 1,
},
include: %w[user],
fields: {
users: [:username],
},
}
end
it "renders the related record with that field" do
expect(document).to eq(
data: [
topic_object(
oldest,
relationships: {
"user" =>
relationship_object(
"topics",
oldest,
"user",
data: identifier_of("users", oldest.user),
),
},
),
],
included: [user_object(oldest.user)],
links:
links_of(next: page_url(after: cursor_of_record(oldest, sort: { created_at: :asc }))),
)
end
end
context "when the fieldset is on a relationship to many records" do
fab!(:first_post) { Fabricate(:post, topic: oldest, post_number: 1) }
let(:params) do
{
sort: {
createdAt: :asc,
},
page: {
size: 1,
},
include: %w[posts],
fields: {
posts: [:postNumber],
},
}
end
it "renders every related record with that field" do
expect(document[:included]).to eq([post_object(first_post, fields: %w[postNumber])])
end
end
context "when the fieldset of a related type is empty" do
let(:params) do
{ sort: { createdAt: :asc }, page: { size: 1 }, include: %w[user], fields: { users: [] } }
end
it "renders the related record with its type and its id" do
expect(document).to eq(
data: [
topic_object(
oldest,
relationships: {
"user" =>
relationship_object(
"topics",
oldest,
"user",
data: identifier_of("users", oldest.user),
),
},
),
],
included: [user_object(oldest.user, fields: [])],
links:
links_of(next: page_url(after: cursor_of_record(oldest, sort: { created_at: :asc }))),
)
end
end
context "when the fieldset leaves a relationship out" do
let(:params) do
{
sort: {
createdAt: :asc,
},
page: {
size: 1,
},
include: %w[user],
fields: {
topics: [:title],
},
}
end
it "renders no relationship and no related record" do
expect(document).to eq(
data: [topic_object(oldest, fields: %w[title])],
included: [],
links:
links_of(next: page_url(after: cursor_of_record(oldest, sort: { created_at: :asc }))),
)
end
end
context "when the fieldset holds a relationship only" do
let(:params) { { include: %w[user], fields: { topics: %w[user] }, page: { size: 1 } } }
let(:query) { { "include" => "user", "fields" => { "topics" => "user" } } }
it "renders the relationship and reads the key behind it" do
expect(document[:data].sole[:relationships].keys).to eq(%w[user])
end
end
describe "the columns a narrow fieldset reads" do
subject(:columns) do
track_sql_queries { document }
.grep(/FROM "topics"/)
.flat_map { it[/\ASELECT (.+?) FROM/, 1].to_s.scan(/"topics"\."(\w+)"/) }
.flatten
.uniq
end
let(:params) { { sort: { title: :asc }, page: { size: 1 }, fields: { topics: [:title] } } }
it "reads the column it renders and the primary key" do
expect(columns).to contain_exactly("id", "title")
end
end
end