Skip to content

Strip base64 padding characters in Datastore's (to|from)_legacy_urlsafe #3560

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dhermes merged 5 commits into from
Jun 28, 2017
Merged

Strip base64 padding characters in Datastore's (to|from)_legacy_urlsafe #3560

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1196a36
strip padding characters from urlsafe
Jun 28, 2017
97237f7
Update key.py
Jun 28, 2017
337aeb9
Remove unnecessary comment in from_legacy_urlsafe.
Jun 28, 2017
d7918f7
move padding to below the _to_bytes
Jun 28, 2017
782edda
Adding some tests to exercise padding code in (to|from)_legacy_urlsaf…
dhermes Jun 28, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions datastore/google/cloud/datastore/key.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,8 @@ def to_legacy_urlsafe(self):
This is intended to work with the "legacy" representation of a
datastore "Key" used within Google App Engine (a so-called
"Reference"). The returned string can be used as the ``urlsafe``
argument to ``ndb.Key(urlsafe=...)``.
argument to ``ndb.Key(urlsafe=...)``. The base64 encoded values
will have padding removed.

:rtype: bytes
:returns: A bytestring containing the key encoded as URL-safe base64.
Expand All @@ -315,7 +316,7 @@ def to_legacy_urlsafe(self):
name_space=self.namespace,
)
raw_bytes = reference.SerializeToString()
return base64.urlsafe_b64encode(raw_bytes)
return base64.urlsafe_b64encode(raw_bytes).strip(b'=')

@classmethod
def from_legacy_urlsafe(cls, urlsafe):
Expand All @@ -334,6 +335,8 @@ def from_legacy_urlsafe(cls, urlsafe):
:returns: The key corresponding to ``urlsafe``.
"""
urlsafe = _to_bytes(urlsafe, encoding='ascii')
padding = b'=' * (-len(urlsafe) % 4)
urlsafe += padding
raw_bytes = base64.urlsafe_b64decode(urlsafe)

reference = _app_engine_key_pb2.Reference()
Expand Down
47 changes: 35 additions & 12 deletions datastore/tests/unit/test_key.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,15 @@ class TestKey(unittest.TestCase):
# 'Parent', 59, 'Child', 'Feather',
# namespace='space', app='s~sample-app')
# urlsafe = key.urlsafe()
_URLSAFE_EXAMPLE = (
_URLSAFE_EXAMPLE1 = (
b'agxzfnNhbXBsZS1hcHByHgsSBlBhcmVudBg7DAsSBUNoaWxkIgdGZ'
b'WF0aGVyDKIBBXNwYWNl')
_URLSAFE_APP = 's~sample-app'
_URLSAFE_NAMESPACE = 'space'
_URLSAFE_FLAT_PATH = ('Parent', 59, 'Child', 'Feather')
_URLSAFE_APP1 = 's~sample-app'
_URLSAFE_NAMESPACE1 = 'space'
_URLSAFE_FLAT_PATH1 = ('Parent', 59, 'Child', 'Feather')
_URLSAFE_EXAMPLE2 = b'agZzfmZpcmVyDwsSBEtpbmQiBVRoaW5nDA'
_URLSAFE_APP2 = 's~fire'
_URLSAFE_FLAT_PATH2 = ('Kind', 'Thing')

@staticmethod
def _get_target_class():
Expand Down Expand Up @@ -388,25 +391,45 @@ def test_to_protobuf_w_no_kind(self):

def test_to_legacy_urlsafe(self):
key = self._make_one(
*self._URLSAFE_FLAT_PATH,
project=self._URLSAFE_APP,
namespace=self._URLSAFE_NAMESPACE)
*self._URLSAFE_FLAT_PATH1,
project=self._URLSAFE_APP1,
namespace=self._URLSAFE_NAMESPACE1)
# NOTE: ``key.project`` is somewhat "invalid" but that is OK.
urlsafe = key.to_legacy_urlsafe()
self.assertEqual(urlsafe, self._URLSAFE_EXAMPLE)
self.assertEqual(urlsafe, self._URLSAFE_EXAMPLE1)

def test_to_legacy_urlsafe_strip_padding(self):
key = self._make_one(
*self._URLSAFE_FLAT_PATH2,
project=self._URLSAFE_APP2)
# NOTE: ``key.project`` is somewhat "invalid" but that is OK.
urlsafe = key.to_legacy_urlsafe()
self.assertEqual(urlsafe, self._URLSAFE_EXAMPLE2)
# Make sure it started with base64 padding.
self.assertNotEqual(len(self._URLSAFE_EXAMPLE2) % 4, 0)

def test_from_legacy_urlsafe(self):
klass = self._get_target_class()
key = klass.from_legacy_urlsafe(self._URLSAFE_EXAMPLE)
key = klass.from_legacy_urlsafe(self._URLSAFE_EXAMPLE1)

self.assertEqual('s~' + key.project, self._URLSAFE_APP)
self.assertEqual(key.namespace, self._URLSAFE_NAMESPACE)
self.assertEqual(key.flat_path, self._URLSAFE_FLAT_PATH)
self.assertEqual('s~' + key.project, self._URLSAFE_APP1)
self.assertEqual(key.namespace, self._URLSAFE_NAMESPACE1)
self.assertEqual(key.flat_path, self._URLSAFE_FLAT_PATH1)
# Also make sure we didn't accidentally set the parent.
self.assertIsNone(key._parent)
self.assertIsNotNone(key.parent)
self.assertIs(key._parent, key.parent)

def test_from_legacy_urlsafe_needs_padding(self):
klass = self._get_target_class()
# Make sure it will have base64 padding added.
self.assertNotEqual(len(self._URLSAFE_EXAMPLE2) % 4, 0)
key = klass.from_legacy_urlsafe(self._URLSAFE_EXAMPLE2)

self.assertEqual('s~' + key.project, self._URLSAFE_APP2)
self.assertIsNone(key.namespace)
self.assertEqual(key.flat_path, self._URLSAFE_FLAT_PATH2)

def test_is_partial_no_name_or_id(self):
key = self._make_one('KIND', project=self._DEFAULT_PROJECT)
self.assertTrue(key.is_partial)
Expand Down