Summary

Support query errors in get_list

Review Request #5765 — Created May 2, 2014 and discarded May 4, 2014, 6:11 p.m.

Information

Owner

mcote

Repository

Djblets

Branch

master

Bugs

Depends On

Commit

c3017e3...

Reviewers

Groups

djblets

People

Description

Support query errors, with custom messages, in get_list.

Testing Done

All unit tests pass.

Issues

Description	From	Last Updated
Since this is a single line, it doesn't need the parens.	david	May 2, 2014, 4:38 p.m.
Mind putting this in an else: clause? It would make it more symmetric.	david	May 2, 2014, 4:38 p.m.
I wasn't terribly comfortable with this message handling, but I wasn't sure of a better way. The only alternative I …	MC mcote	May 3, 2014, 9:18 a.m.

djblets/webapi/resources.py (Diff revision 1)

The issue has been resolved. Show all issues

I wasn't terribly comfortable with this message handling, but I wasn't sure of a better way. The only alternative I could think of was some sort of new errors like PublishError/PUBLISH_ERROR that could easily take a custom message. Maybe a QueryError/QUERY_ERROR? Would that be better?

david May 2, 2014, 3:17 p.m.

This way of passing the message seems fine, but I'd like to better understand why you're making this change.

mcote May 2, 2014, 4:36 p.m.

It's all related to external user services, e.g. Bugzilla.  My other changes to Review Board have allowed extensions to shuttle user queries off to an external service; however, there's no way to report errors back to the user.  In particular, I'm concerned with a Bugzilla session expiring, which would silently cause user autocomplete to fail; in this case, I would want a helpful message to be displayed indicating that the user should log out and back in again to refresh thes session.  This change allows us to return specific failures up to the client (I have a separate patch for Review Board to display these errors, which will be posted for review soon).
Technically these errors don't really have to map to PERMISSION_DENIED, e.g. if Bugzilla is down.  That's why I was wondering if there should be a generic 500 error for query failures.  But I don't particularly care either way, since I can still return a specific error string.

david May 2, 2014, 4:42 p.m.

So where does the PermissionDenied exception come from? Are you raising that yourself?

I'm thinking maybe instead of this very generic change to WebAPIResource, we might want to add more specific errors to the resources that can have extension-provided errors.

mcote May 2, 2014, 4:49 p.m.

It comes from my backend's overridden AuthBackend.query_users() method, raised up through the web API UserResource.get_queryset().
Yeah, as I mentioned, I was thinking a QUERY_ERROR webapi.errors class (just realized we don't need a QueryError in another error class, since the error is originating from a WebAPIResource; that wasn't the case with the publish errors, which came from review model classes).

mcote May 2, 2014, 4:56 p.m.

Hm, although it wouldn't be quite as elegant since webapi.error classes aren't exceptions, so we'd have to look at the type of the object returned by WebAPIResource._get_query_set(), unless we did actually create a QueryError exception class as well.  Just thinking out loud now. :)

djblets/webapi/resources.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Since this is a single line, it doesn't need the parens.
```
djblets/webapi/resources.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Mind putting this in an else: clause? It would make it more symmetric.
```

Change Summary:

Formatting fixes.

Commit:

-	01d61c768ccfe04ac613b10f03b5d73211f8bad7
+	12d21f6b6fabe1878ae42d0d39efec1fd97bcedc

Diff:

Revision 2 (+6 -1)

Show changes

djblets/webapi/resources.py

Change Summary:

Here's another attempt. There are no generic error classes in djblets, so I added one to util. My extension's AuthBackend now raises a query error with a helpful string if it has problems talking to the external service.

Summary:

-	Support PermissionDenied errors in get_list.
+	Support query errors in get_list

Commit:

-	12d21f6b6fabe1878ae42d0d39efec1fd97bcedc
+	c3017e391fd62fb9b3230b6a2fdb4eea1e421db0

Diff:

Revision 3 (+16)

Show changes

	djblets/util/errors.py
	djblets/webapi/errors.py
	djblets/webapi/resources.py

Description:

~		Support PermissionDenied errors in get_list.
	~	Support query errors, with custom messages, in get_list.
-
-		I added handling for custom messages, since PermissionDenied is just a plain Exception.

I'm still not clear on your reasoning behind making a very generic addition to WebAPIResource instead of a specific addition to Review Board's UserResource.get_list.

mcote May 4, 2014, 1:50 p.m.

Ahh sorry I misunderstood. I'll give that a shot.

Status: Discarded

Change Summary:

Better solution posted in review 5771.