annotate roundup/anypy/random_.py @ 5710:0b79bfcb3312

Add support for making an idempotent POST. This allows retrying a POST that was interrupted. It involves creating a post once only (poe) url /rest/data/<class>/@poe/<random_token>. This url acts the same as a post to /rest/data/<class>. However once the @poe url is used, it can't be used for a second POST. To make these changes: 1) Take the body of post_collection into a new post_collection_inner function. Have post_collection call post_collection_inner. 2) Add a handler for POST to rest/data/class/@poe. This will return a unique POE url. By default the url expires after 30 minutes. The POE random token is only good for a specific user and is stored in the session db. 3) Add a handler for POST to rest/data/<class>/@poe/<random token>. The random token generated in 2 is validated for proper class (if token is not generic) and proper user and must not have expired. If everything is valid, call post_collection_inner to process the input and generate the new entry. To make recognition of 2 stable (so it's not confused with rest/data/<:class_name>/<:item_id>), removed @ from Routing::url_to_regex. The current Routing.execute method stops on the first regular expression to match the URL. Since item_id doesn't accept a POST, I was getting 405 bad method sometimes. My guess is the order of the regular expressions is not stable, so sometime I would get the right regexp for /data/<class>/@poe and sometime I would get the one for /data/<class>/<item_id>. By removing the @ from the url_to_regexp, there was no way for the item_id case to match @poe. There are alternate fixes we may need to look at. If a regexp matches but the method does not, return to the regexp matching loop in execute() looking for another match. Only once every possible match has failed should the code return a 405 method failure. Another fix is to implement a more sophisticated mechanism so that @Routing.route("/data/<:class_name>/<:item_id>/<:attr_name>", 'PATCH') has different regexps for matching <:class_name> <:item_id> and <:attr_name>. Currently the regexp specified by url_to_regex is used for every component. Other fixes: Made failure to find any props in props_from_args return an empty dict rather than throwing an unhandled error. Make __init__ for SimulateFieldStorageFromJson handle an empty json doc. Useful for POSTing to rest/data/class/@poe with an empty document. Testing: added testPostPOE to test/rest_common.py that I think covers all the code that was added. Documentation: Add doc to rest.txt in the "Client API" section titled: Safely Re-sending POST". Move existing section "Adding new rest endpoints" in "Client API" to a new second level section called "Programming the REST API". Also a minor change to the simple rest client moving the header setting to continuation lines rather than showing one long line.
author John Rouillard <rouilj@ieee.org>
date Sun, 14 Apr 2019 21:07:11 -0400
parents 52cb53eedf77
children adf54478cdaf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5488
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
1 try:
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
2 from secrets import choice, randbelow, token_bytes
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
3 def seed(v = None):
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
4 pass
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
5
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
6 is_weak = False
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
7 except ImportError:
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
8 import os as _os
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
9 import random as _random
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
10
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
11 # prefer to use SystemRandom if it is available
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
12 if hasattr(_random, 'SystemRandom'):
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
13 def seed(v = None):
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
14 pass
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
15
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
16 _r = _random.SystemRandom()
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
17 is_weak = False
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
18 else:
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
19 # don't completely throw away the existing state, but add some
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
20 # more random state to the existing state
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
21 def seed(v = None):
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
22 import os, time
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
23 _r.seed((_r.getstate(),
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
24 v,
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
25 hasattr(os, 'getpid') and os.getpid(),
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
26 time.time()))
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
27
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
28 # create our own instance so we don't mess with the global
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
29 # random number generator
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
30 _r = _random.Random()
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
31 seed()
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
32 is_weak = True
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
33
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
34 choice = _r.choice
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
35
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
36 def randbelow(i):
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
37 return _r.randint(0, i - 1)
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
38
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
39 if hasattr(_os, 'urandom'):
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
40 def token_bytes(l):
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
41 return _os.urandom(l)
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
42 else:
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
43 def token_bytes(l):
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
44 _bchr = chr if str == bytes else lambda x: bytes((x,))
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents:
diff changeset
45 return b''.join([_bchr(_r.getrandbits(8)) for i in range(l)])

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