annotate test/test_init.py @ 7853:03c1b7ae3a68

issue2551328/issue2551264 unneeded next link and total_count incorrect Fix: issue2551328 - REST results show next link if number of results is a multiple of page size. (Found by members of team 3 in the UMass-Boston CS682 Spring 2024 class.) issue2551264 - REST X-Total-Count header and @total_size count incorrect when paginated These issues arose because we retrieved the exact number of rows from the database as requested by the user using the @page_size parameter. With this changeset, we retrieve up to 10 million + 1 rows from the database. If the total number of rows exceeds 10 million, we set the total_count indicators to -1 as an invalid size. (The max number of requested rows (default 10 million +1) can be modified by the admin through interfaces.py.) By retrieving more data than necessary, we can calculate the total count by adding @page_index*@page_size to the number of rows returned by the query. Furthermore, since we return more than @page_size rows, we can determine the existence of a row at @page_size+1 and use that information to determine if a next link should be provided. Previously, a next link was returned if @page_size rows were retrieved. This change does not guarantee that the user will get @page_size rows returned. Access policy filtering occurs after the rows are returned, and discards rows inaccessible by the user. Using the current @page_index/@page_size it would be difficult to have the roundup code refetch data and make sure that a full @page_size set of rows is returned. E.G. @page_size=100 and 5 of them are dropped due to access restrictions. We then fetch 10 items and add items 1-4 and 6 (5 is inaccessible). There is no way to calculate the new database offset at: @page_index*@page_size + 6 from the URL. We would need to add an @page_offset=6 or something. This could work since the client isn't adding 1 to @page_index to get the next page. Thanks to HATEOAS, the client just uses the 'next' url. But I am not going to cross that bridge without a concrete use case. This can also be handled client side by merging a short response with the next response and re-paginating client side. Also added extra index markers to the docs to highlight use of interfaces.py.
author John Rouillard <rouilj@ieee.org>
date Mon, 01 Apr 2024 09:57:16 -0400
parents 198b6e810c67
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5248
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5037
diff changeset
1 #-*- encoding: utf-8 -*-
4816
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
2
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
3 import unittest, os, pprint, difflib, textwrap
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
4
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
5 from roundup.init import loadTemplateInfo
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
6
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
7
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
8 class TemplateInfoTestCase(unittest.TestCase):
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
9 def testLoadTemplateInfo(self):
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
10 path = os.path.join(os.path.dirname(__file__),
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
11 '../share/roundup/templates/classic')
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
12 self.maxDiff = None
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
13 self.assertEqual(
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
14 loadTemplateInfo(path),
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
15 {
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
16 'description': textwrap.dedent('''\
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
17 This is a generic issue tracker that may be used to track bugs,
4818
edb171528a7d init.loadTemplateInfo: replace rfc822 with email.parser (Python 3 compatible)
anatoly techtonik <techtonik@gmail.com>
parents: 4816
diff changeset
18 feature requests, project issues or any number of other types
edb171528a7d init.loadTemplateInfo: replace rfc822 with email.parser (Python 3 compatible)
anatoly techtonik <techtonik@gmail.com>
parents: 4816
diff changeset
19 of issues. Most users of Roundup will find that this template
edb171528a7d init.loadTemplateInfo: replace rfc822 with email.parser (Python 3 compatible)
anatoly techtonik <techtonik@gmail.com>
parents: 4816
diff changeset
20 suits them, with perhaps a few customisations.'''),
4816
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
21 'intended-for': 'All first-time Roundup users',
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
22 'name': 'classic',
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
23 'path': path
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
24 }
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
25 )
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
26
9b3e09a50d85 init.loadTemplateInfo: Add test
anatoly techtonik <techtonik@gmail.com>
parents:
diff changeset
27 # vim: set et sts=4 sw=4 :

Roundup Issue Tracker: http://roundup-tracker.org/