Differential D8911 Diff 32280 swh/graphql/tests/functional/test_pagination.py

Changeset View

Standalone View

swh/graphql/tests/functional/test_pagination.py

# Copyright (C) 2022 The Software Heritage developers		# Copyright (C) 2022 The Software Heritage developers
# See the AUTHORS file at the top-level directory of this distribution		# See the AUTHORS file at the top-level directory of this distribution
# License: GNU General Public License version 3, or any later version		# License: GNU General Public License version 3, or any later version
# See top-level LICENSE file for more information		# See top-level LICENSE file for more information

from . import utils		from . import utils
from ..data import get_origins		from ..data import get_directories, get_origins


# Using Origin object to run functional tests for pagination		# Using Origin object to run functional tests for pagination
def get_origin_nodes(client, first, after=""):		def get_origin_nodes(client, first, after=""):
query_str = """		query_str = """
query getOrigins($first: Int!, $after: String) {		query getOrigins($first: Int!, $after: String) {
origins(first: $first, after: $after) {		origins(first: $first, after: $after) {
nodes {		nodes {
▲ Show 20 Lines • Show All 57 Lines • ▼ Show 20 Lines	def test_invalid_after_arg(client):
assert data["origins"] is None		assert data["origins"] is None
assert (len(errors)) == 2		assert (len(errors)) == 2
assert (		assert (
errors[0]["message"] == "Pagination error: Invalid value for argument 'after'"		errors[0]["message"] == "Pagination error: Invalid value for argument 'after'"
)		)


def test_edge_cursor(client):		def test_edge_cursor(client):
origins = get_origin_nodes(client, first=1)[0]["origins"]		# Use DirectoryEntry connection to test connection edges
# end cursor here must be the item cursor for the second item		# The same code is used in all the other connections, hence a single test
end_cursor = origins["pageInfo"]["endCursor"]		directory = get_directories()[1]

query_str = """		query_str = """
query getOrigins($first: Int!, $after: String) {		query getDirectory($swhid: SWHID!, $entries_first: Int!, $entries_after: String) {
origins(first: $first, after: $after) {		directory(swhid: $swhid) {
		entries(first: $entries_first, after: $entries_after) {
edges {		edges {
cursor		cursor
node {		node {
id		name {
		text
		}
}		}
}		}
		pageInfo {
		endCursor
		hasNextPage
		}
nodes {		nodes {
id		name {
		text
		}
		}
}		}
}		}
}		}
"""		"""
data, _ = utils.get_query_response(client, query_str, first=1, after=end_cursor)		data, _ = utils.get_query_response(
origins = data["origins"]		client, query_str, swhid=str(directory.swhid()), entries_first=1
assert [edge["node"] for edge in origins["edges"]] == origins["nodes"]		)
assert origins["edges"][0]["cursor"] == end_cursor		entries = data["directory"]["entries"]
		# Make sure the first node object in edges and nodes is the same
		assert entries["edges"][0]["node"] == entries["nodes"][0]
		assert entries["edges"][0]["node"] == {
		"name": {"text": directory.entries[1].name.decode()}
		}
		assert entries["pageInfo"]["hasNextPage"] is True
		# FIXME, Following behaviour is not in compliance with the relay spec.
		# last-item-cursor and endcursor should be the same as per relay.
		# This test will fail once the pagination becomes fully relay complaint.
		assert entries["pageInfo"]["endCursor"] != entries["edges"][-1]["cursor"]
		# Make another query with the after argument, after argument is the first item
		# cursor here, result will be the same as the last one
		new_data, _ = utils.get_query_response(
		client,
		query_str,
		swhid=str(directory.swhid()),
		entries_first=1,
		entries_after=entries["edges"][0]["cursor"],
		)
		assert new_data == data
		# Make another query with the end cursor from the first query
		final_data, _ = utils.get_query_response(
		client,
		query_str,
		swhid=str(directory.swhid()),
		entries_first=2,
		entries_after=entries["pageInfo"]["endCursor"],
		)
		final_result_entries = final_data["directory"]["entries"]
		# endcursor from the first query will be the first item cursor here
		# FIXME, this behaviour is not in compliance with the relay spec.
		# With relay spec, items after the given cursor ($after) will be returned
		assert (
		final_result_entries["edges"][0]["cursor"] == entries["pageInfo"]["endCursor"]
		)
		assert final_result_entries["nodes"] == [
		{"name": {"text": directory.entries[0].name.decode()}},
		{"name": {"text": directory.entries[2].name.decode()}},
		]