ash_graphql/test/paginate_test.exs
Riccardo Binetti 513c1ac68f
improvement!: port AshGraphql to Ash 3.0 (#123)
Step 1: update Ash

Step 2: mass rename Api to Domain

Step 3: Ash.Query.expr -> Ash.Expr.expr

Also change ref interpolation

Step 4: remove all warnings

Step 5: remove registries from tests

Step 6: fix filter

Step 7: private? -> !public?

Step 8: Ash.Calculation -> Ash.Resource.Calculation

Step 9: use depend_on_resources/1 -> resources/1

Step 10: add Domain to all resources

Step 11: use Ash module for all actions

Step 12: add public? true all around

Step 13: remove verbose? from options passed during Domain calls

Step 14: add simple_sat

Step 15: Ash.ErrorKind is no more, so remove code from errors

Step 16: sprinkle default_accept :* around tests

Step 17: replace Ash.Changeset.new/2 with Ash.Changeset.for_*

Step 18: calculation fixups

- Context is now a struct and arguments go under the arguments key
- Function based calculations receive a list of records
- Add a select to query-based loads
- select -> load

Step 19: pass the correct name to pass the policy in tests

Step 20: Ash.Query.new/2 is no more

Step 21: add AshGraphql.Resource.embedded? utility function

Use that instead of Ash.Type.embedded_type?(resource_or_type) since resources
are not types anymore

Step 22: handle struct + instance_of: Resource in unions

Resources are not type anymore so they need to be passed this way in unions

Step 23: ensure we only check GraphQL actions for pagination

All reads are now paginated by default, so this triggered a compilation error

Step 24: swap arguments for sort on calculations

Step 25: remove unused debug? option
2024-04-01 14:03:06 -04:00

336 lines
8.5 KiB
Elixir

defmodule AshGraphql.PaginateTest do
use ExUnit.Case, async: false
require Ash.Query
setup do
on_exit(fn ->
AshGraphql.TestHelpers.stop_ets()
end)
end
describe "keyset pagination" do
setup do
letters = ["a", "b", "c", "d", "e"]
for text <- letters do
post =
AshGraphql.Test.Post
|> Ash.Changeset.for_create(:create, text: text, published: true)
|> Ash.create!()
for text <- letters do
AshGraphql.Test.Comment
|> Ash.Changeset.for_create(:create, text: text)
|> Ash.Changeset.manage_relationship(:post, post, type: :append_and_remove)
|> Ash.create!()
end
end
:ok
end
test "default_limit records are fetched" do
doc = """
query KeysetPaginatedPosts {
keysetPaginatedPosts(sort: [{field: TEXT, order: ASC_NULLS_LAST}]) {
count
startKeyset
endKeyset
results{
text
keyset
}
}
}
"""
assert {:ok,
%{
data: %{
"keysetPaginatedPosts" => %{
"startKeyset" => start_keyset,
"endKeyset" => end_keyset,
"count" => 5,
"results" => [
%{"text" => "a", "keyset" => keyset},
%{"text" => "b"},
%{"text" => "c"},
%{"text" => "d"},
%{"text" => "e"}
]
}
}
}} = Absinthe.run(doc, AshGraphql.Test.Schema)
assert is_binary(keyset)
assert is_binary(start_keyset)
assert is_binary(end_keyset)
end
end
describe "offset pagination" do
setup do
letters = ["a", "b", "c", "d", "e"]
for text <- letters do
post =
AshGraphql.Test.Post
|> Ash.Changeset.for_create(:create, text: text, published: true)
|> Ash.create!()
for text <- letters do
AshGraphql.Test.Comment
|> Ash.Changeset.for_create(:create, text: text)
|> Ash.Changeset.manage_relationship(:post, post, type: :append_and_remove)
|> Ash.create!()
end
end
:ok
end
test "default_limit records are fetched" do
doc = """
query PaginatedPosts {
paginatedPosts(sort: [{field: TEXT}]) {
count
results{
text
}
hasNextPage
}
}
"""
assert {:ok,
%{
data: %{
"paginatedPosts" => %{
"count" => 5,
"hasNextPage" => false,
"results" => [
%{"text" => "a"},
%{"text" => "b"},
%{"text" => "c"},
%{"text" => "d"},
%{"text" => "e"}
]
}
}
}} = Absinthe.run(doc, AshGraphql.Test.Schema)
end
test "without limit all records are fetched" do
doc = """
query PaginatedPostsLimitNotRequired {
paginatedPostsLimitNotRequired(sort: [{field: TEXT}]) {
count
results{
text
}
}
}
"""
assert {:ok,
%{
data: %{
"paginatedPostsLimitNotRequired" => %{
"count" => 5,
"results" => [
%{"text" => "a"},
%{"text" => "b"},
%{"text" => "c"},
%{"text" => "d"},
%{"text" => "e"}
]
}
}
}} = Absinthe.run(doc, AshGraphql.Test.Schema)
end
test "the first can be fetched" do
doc = """
query PaginatedPosts {
paginatedPosts(limit: 1, sort: [{field: TEXT}]) {
count
results{
text
}
}
}
"""
assert {:ok,
%{
data: %{
"paginatedPosts" => %{
"count" => 5,
"results" => [
%{"text" => "a"}
]
}
}
}} = Absinthe.run(doc, AshGraphql.Test.Schema)
end
test "the count can be fetched on its own" do
doc = """
query PaginatedPosts {
paginatedPosts(limit: 1) {
count
}
}
"""
assert {:ok,
%{
data: %{
"paginatedPosts" => %{
"count" => 5
}
}
}} = Absinthe.run(doc, AshGraphql.Test.Schema)
end
test "it can be paged through" do
doc = """
query PaginatedPosts {
paginatedPosts(limit: 2, offset: 2, sort: [{field: TEXT}]) {
count
results{
text
}
}
}
"""
assert {:ok,
%{
data: %{
"paginatedPosts" => %{
"count" => 5,
"results" => [
%{"text" => "c"},
%{"text" => "d"}
]
}
}
}} = Absinthe.run(doc, AshGraphql.Test.Schema)
end
test "related items can be requested while paginating" do
doc = """
query PaginatedPosts {
paginatedPosts(limit: 2, offset: 2, sort: [{field: TEXT}]) {
count
results{
text
comments(sort:[{field: TEXT}]){
text
}
}
}
}
"""
assert {:ok,
%{
data: %{
"paginatedPosts" => %{
"count" => 5,
"results" => [
%{
"text" => "c",
"comments" => [
%{"text" => "a"},
%{"text" => "b"},
%{"text" => "c"},
%{"text" => "d"},
%{"text" => "e"}
]
},
%{
"text" => "d",
"comments" => [
%{"text" => "a"},
%{"text" => "b"},
%{"text" => "c"},
%{"text" => "d"},
%{"text" => "e"}
]
}
]
}
}
}} = Absinthe.run(doc, AshGraphql.Test.Schema)
end
test "related items can be limited and offset while paginating" do
doc = """
query PaginatedPosts {
paginatedPosts(limit: 2, offset: 2, sort: [{field: TEXT}]) {
count
results{
text
comments(limit: 2, offset: 2, sort:[{field: TEXT}]){
text
}
}
}
}
"""
assert {:ok,
%{
data: %{
"paginatedPosts" => %{
"count" => 5,
"results" => [
%{
"text" => "c",
"comments" => [
%{"text" => "c"},
%{"text" => "d"}
]
},
%{
"text" => "d",
"comments" => [
%{"text" => "c"},
%{"text" => "d"}
]
}
]
}
}
}} = Absinthe.run(doc, AshGraphql.Test.Schema)
end
end
describe "pagination errors" do
test "required limit without explicit value" do
doc = """
query PaginatedPosts {
paginatedPostsWithoutLimit(sort: [{field: TEXT}]) {
count
results{
text
}
}
}
"""
assert {:ok,
%{
errors: [
%{
locations: [%{column: 3, line: 2}],
message: "In argument \"limit\": Expected type \"Int!\", found null."
}
]
}} = Absinthe.run(doc, AshGraphql.Test.Schema)
end
end
end