Mercurial > p > roundup > code
view test/test_mailsplit.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 | 55f09ca366c4 |
| children |
line wrap: on
line source
# # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/) # This module is free software, and you may redistribute it and/or modify # under the same terms as Python, so long as this copyright message and # disclaimer are retained in their original form. # # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE # POSSIBILITY OF SUCH DAMAGE. # # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE, # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. import unittest from roundup.mailgw import parseContent class MailsplitTestCase(unittest.TestCase): def testPreComment(self): s = ''' blah blah blah blah... blah blah? blah blah blah blah blah. blah blah blah blah blah blah blah blah blah blah blah blah blah blah! issue_tracker@foo.com wrote: > blah blah blah blahblah blahblah blahblah blah blah blah blah blah blah > blah blah blah blah blah blah blah blah blah? blah blah blah blah blah > blah blah blah blah blah blah blah... blah blah blah blah. blah blah > blah blah blah blah? blah blah blah blah blah blah! blah blah! > > ------- > nosy: userfoo, userken > _________________________________________________ > Roundup issue tracker > issue_tracker@foo.com > http://foo.com/cgi-bin/roundup.cgi/issue_tracker/ -- blah blah blah signature userfoo@foo.com ''' summary, content = parseContent(s, 0, 0) self.assertEqual(summary, 'blah blah blah blah... blah blah? blah blah blah blah blah. blah blah blah') self.assertEqual(content, 'blah blah blah blah... blah blah? blah blah blah blah blah. blah blah blah\nblah blah blah blah blah blah blah blah blah blah blah!') def testPostComment(self): s = ''' issue_tracker@foo.com wrote: > blah blah blah blahblah blahblah blahblah blah blah blah blah blah > blah > blah blah blah blah blah blah blah blah blah? blah blah blah blah > blah > blah blah blah blah blah blah blah... blah blah blah blah. blah > blah > blah blah blah blah? blah blah blah blah blah blah! blah blah! > > ------- > nosy: userfoo, userken > _________________________________________________ > Roundup issue tracker > issue_tracker@foo.com > http://foo.com/cgi-bin/roundup.cgi/issue_tracker/ blah blah blah blah... blah blah? blah blah blah blah blah. blah blah blah blah blah blah blah blah blah blah blah blah blah blah! -- blah blah blah signature userfoo@foo.com ''' summary, content = parseContent(s, 0, 0) self.assertEqual(summary, 'blah blah blah blah... blah blah? blah blah blah blah blah. blah blah blah') self.assertEqual(content, 'blah blah blah blah... blah blah? blah blah blah blah blah. blah blah blah\nblah blah blah blah blah blah blah blah blah blah blah!') def testKeepCitation(self): s = ''' blah blah blah blah... blah blah? blah blah blah blah blah. blah blah blah blah blah blah blah blah blah blah blah blah blah blah! issue_tracker@foo.com wrote: > blah blah blah blahblah blahblah blahblah blah blah blah blah blah blah > blah blah blah blah blah blah blah blah blah? blah blah blah blah blah > blah blah blah blah blah blah blah... blah blah blah blah. blah blah > blah blah blah blah? blah blah blah blah blah blah! blah blah! > > ------- > nosy: userfoo, userken > _________________________________________________ > Roundup issue tracker > issue_tracker@foo.com > http://foo.com/cgi-bin/roundup.cgi/issue_tracker/ -- blah blah blah signature userfoo@foo.com ''' summary, content = parseContent(s, 1, 0) self.assertEqual(summary, 'blah blah blah blah... blah blah? blah blah blah blah blah. blah blah blah') self.assertEqual(content, '''\ blah blah blah blah... blah blah? blah blah blah blah blah. blah blah blah blah blah blah blah blah blah blah blah blah blah blah! issue_tracker@foo.com wrote: > blah blah blah blahblah blahblah blahblah blah blah blah blah blah blah > blah blah blah blah blah blah blah blah blah? blah blah blah blah blah > blah blah blah blah blah blah blah... blah blah blah blah. blah blah > blah blah blah blah? blah blah blah blah blah blah! blah blah! > > ------- > nosy: userfoo, userken > _________________________________________________ > Roundup issue tracker > issue_tracker@foo.com > http://foo.com/cgi-bin/roundup.cgi/issue_tracker/''') def testKeepBody(self): s = ''' blah blah blah blah... blah blah? blah blah blah blah blah. blah blah blah blah blah blah blah blah blah blah blah blah blah blah! issue_tracker@foo.com wrote: > blah blah blah blahblah blahblah blahblah blah blah blah blah blah blah > blah blah blah blah blah blah blah blah blah? blah blah blah blah blah > blah blah blah blah blah blah blah... blah blah blah blah. blah blah > blah blah blah blah? blah blah blah blah blah blah! blah blah! > > ------- > nosy: userfoo, userken > _________________________________________________ > Roundup issue tracker > issue_tracker@foo.com > http://foo.com/cgi-bin/roundup.cgi/issue_tracker/ -- blah blah blah signature userfoo@foo.com ''' summary, content = parseContent(s, 0, 1) self.assertEqual(summary, 'blah blah blah blah... blah blah? blah blah blah blah blah. blah blah blah') self.assertEqual(content, ''' blah blah blah blah... blah blah? blah blah blah blah blah. blah blah blah blah blah blah blah blah blah blah blah blah blah blah! issue_tracker@foo.com wrote: > blah blah blah blahblah blahblah blahblah blah blah blah blah blah blah > blah blah blah blah blah blah blah blah blah? blah blah blah blah blah > blah blah blah blah blah blah blah... blah blah blah blah. blah blah > blah blah blah blah? blah blah blah blah blah blah! blah blah! > > ------- > nosy: userfoo, userken > _________________________________________________ > Roundup issue tracker > issue_tracker@foo.com > http://foo.com/cgi-bin/roundup.cgi/issue_tracker/ -- blah blah blah signature userfoo@foo.com ''') def testAllQuoted(self): s = '\nissue_tracker@foo.com wrote:\n> testing\n' summary, content = parseContent(s, 0, 1) self.assertEqual(summary, '') self.assertEqual(content, s) def testSimple(self): s = '''testing''' summary, content = parseContent(s, 0, 0) self.assertEqual(summary, 'testing') self.assertEqual(content, 'testing') def testParagraphs(self): s = '''testing\n\ntesting\n\ntesting''' summary, content = parseContent(s, 0, 0) self.assertEqual(summary, 'testing') self.assertEqual(content, 'testing\n\ntesting\n\ntesting') def testSimpleFollowup(self): s = '''>hello\ntesting''' summary, content = parseContent(s, 0, 0) self.assertEqual(summary, 'testing') self.assertEqual(content, 'testing') def testSimpleFollowupParas(self): s = '''>hello\ntesting\n\ntesting\n\ntesting''' summary, content = parseContent(s, 0, 0) self.assertEqual(summary, 'testing') self.assertEqual(content, 'testing\n\ntesting\n\ntesting') def testEmpty(self): s = '' summary, content = parseContent(s, 0, 0) self.assertEqual(summary, '') self.assertEqual(content, '') def testIndentationSummary(self): s = ' Four space indent.\n\n Four space indent.\nNo indent.' summary, content = parseContent(s, 0, 0) self.assertEqual(summary, ' Four space indent.') def testIndentationContent(self): s = ' Four space indent.\n\n Four space indent.\nNo indent.' summary, content = parseContent(s, 0, 0) self.assertEqual(content, s) def testMultilineSummary(self): s = 'This is a long sentence that would normally\nbe split. More words.' summary, content = parseContent(s, 0, 0) self.assertEqual(summary, 'This is a long sentence that would ' 'normally\nbe split.') def testKeepMultipleHyphens(self): body = '''Testing, testing. ---- Testing, testing.''' summary, content = parseContent(body, 1, 0) self.assertEqual(body, content) # vim: set filetype=python ts=4 sw=4 et si