Skip to content

Firebase ML Modify Operation Handling Code to match rpc codes not html codes #390

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.

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
merged 3 commits into from
Jan 23, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
26 changes: 24 additions & 2 deletions firebase_admin/_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,25 @@
503: exceptions.UNAVAILABLE,
}

# See https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
_RPC_CODE_TO_ERROR_CODE = {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: May be mention https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto in a comment so we know where these mappings come from.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

1: exceptions.CANCELLED,
2: exceptions.UNKNOWN,
3: exceptions.INVALID_ARGUMENT,
4: exceptions.DEADLINE_EXCEEDED,
5: exceptions.NOT_FOUND,
6: exceptions.ALREADY_EXISTS,
7: exceptions.PERMISSION_DENIED,
8: exceptions.RESOURCE_EXHAUSTED,
9: exceptions.FAILED_PRECONDITION,
10: exceptions.ABORTED,
11: exceptions.OUT_OF_RANGE,
13: exceptions.INTERNAL,
14: exceptions.UNAVAILABLE,
15: exceptions.DATA_LOSS,
16: exceptions.UNAUTHENTICATED,
}


def _get_initialized_app(app):
if app is None:
Expand Down Expand Up @@ -120,9 +139,9 @@ def handle_operation_error(error):
message='Unknown error while making a remote service call: {0}'.format(error),
cause=error)

status_code = error.get('code')
rpc_code = error.get('code')
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't this response contain a status field? That's how we map errors sent by other OnePlatform APIs. See _handle_func_requests function in this module.

https://cloud.google.com/apis/design/errors#http_mapping

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does for non-operations responses. But for Operation errors it does not. Just message and code (details optional and not applicable in this case)

message = error.get('message')
error_code = _http_status_to_error_code(status_code)
error_code = _rpc_code_to_error_code(rpc_code)
err_type = _error_code_to_exception_type(error_code)
return err_type(message=message)

Expand Down Expand Up @@ -283,6 +302,9 @@ def _http_status_to_error_code(status):
"""Maps an HTTP status to a platform error code."""
return _HTTP_STATUS_TO_ERROR_CODE.get(status, exceptions.UNKNOWN)

def _rpc_code_to_error_code(rpc_code):
"""Maps an RPC code to a platform error code."""
return _RPC_CODE_TO_ERROR_CODE.get(rpc_code, exceptions.UNKNOWN)

def _error_code_to_exception_type(code):
"""Maps a platform error code to an exception type."""
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pytest-cov >= 2.4.0
pytest-localserver >= 0.4.1
tox >= 3.6.0

cachecontrol >= 0.12.4
cachecontrol >= 0.12.6
google-api-core[grpc] >= 1.7.0, < 2.0.0dev; platform.python_implementation != 'PyPy'
google-api-python-client >= 1.7.8
google-cloud-firestore >= 0.31.0; platform.python_implementation != 'PyPy'
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
long_description = ('The Firebase Admin Python SDK enables server-side (backend) Python developers '
'to integrate Firebase into their services and applications.')
install_requires = [
'cachecontrol>=0.12.4',
'cachecontrol>=0.12.6',
'google-api-core[grpc] >= 1.7.0, < 2.0.0dev; platform.python_implementation != "PyPy"',
'google-api-python-client >= 1.7.8',
'google-cloud-firestore>=0.31.0; platform.python_implementation != "PyPy"',
Expand Down
2 changes: 1 addition & 1 deletion tests/test_db.py
Original file line number Diff line number Diff line change
Expand Up @@ -819,7 +819,7 @@ def test_http_timeout(self):
assert ref._client.timeout == 60
assert ref.get() == {}
assert len(recorder) == 1
assert recorder[0]._extra_kwargs['timeout'] == 60
assert recorder[0]._extra_kwargs['timeout'] == pytest.approx(60, 0.001)

def test_app_delete(self):
app = firebase_admin.initialize_app(
Expand Down
4 changes: 2 additions & 2 deletions tests/test_messaging.py
Original file line number Diff line number Diff line change
Expand Up @@ -1254,7 +1254,7 @@ def test_send(self):
msg = messaging.Message(topic='foo')
messaging.send(msg)
assert len(self.recorder) == 1
assert self.recorder[0]._extra_kwargs['timeout'] == 4
assert self.recorder[0]._extra_kwargs['timeout'] == pytest.approx(4, 0.001)

def test_topic_management_timeout(self):
self.fcm_service._client.session.mount(
Expand All @@ -1266,7 +1266,7 @@ def test_topic_management_timeout(self):
)
messaging.subscribe_to_topic(['1'], 'a')
assert len(self.recorder) == 1
assert self.recorder[0]._extra_kwargs['timeout'] == 4
assert self.recorder[0]._extra_kwargs['timeout'] == pytest.approx(4, 0.001)


class TestSend(object):
Expand Down
2 changes: 1 addition & 1 deletion tests/test_ml.py
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@
# Name is required if the operation is not done.
'done': False
}
OPERATION_ERROR_CODE = 400
OPERATION_ERROR_CODE = 3
OPERATION_ERROR_MSG = "Invalid argument"
OPERATION_ERROR_EXPECTED_STATUS = 'INVALID_ARGUMENT'
OPERATION_ERROR_JSON_1 = {
Expand Down