opendev/gerrit
Code Issues Proposed changes

Refactor RestApi to minimize encoding errors

Browse Source 
Try to make it harder to forget to encode path components in the
client code by making the RestApi handle this for us. Callers that
need to embed dynamic data into a path should use .id(String) to
make dynamically modify the URL before setting query parameters.
Callers that need to embed a constant projection or view name
should use .view(String) as this avoids the URL encoding step.

Encoding is performed with encodeQueryString() to match what
the server uses. Space is encoded as '+' and not as '%20'.

See 925d36c782 for more details
when dashboard encodings were finally fixed.

Change-Id: I04e4b60bc0af09756d7db06974238e8ba4de004a
This commit is contained in:
Shawn Pearce
2013-01-28 17:50:24 -08:00
parent f2fa3a3160
commit e46a0dd83c
6 changed files with 70 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
gerrit-gwtui/src/main/java/com/google/gerrit/client/dashboards/DashboardList.java
View File

@@ -24,38 +24,31 @@ import com.google.gwt.user.client.rpc.AsyncCallback;
public class DashboardList extends NativeList<DashboardInfo> {
public static void all(Project.NameKey project,
AsyncCallback<NativeList<DashboardList>> callback) {
new RestApi(base(project))
.addParameterTrue("inherited")
.get(callback);
base(project).addParameterTrue("inherited").get(callback);
}
public static void getDefault(Project.NameKey project,
AsyncCallback<DashboardInfo> callback) {
new RestApi(base(project) + "default")
.addParameterTrue("inherited")
.get(callback);
base(project).view("default").addParameterTrue("inherited").get(callback);
}
public static void get(Project.NameKey project, String dashboardId,
public static void get(Project.NameKey project, String id,
AsyncCallback<DashboardInfo> callback) {
new RestApi(base(project) + encodeDashboardId(dashboardId))
.get(callback);
base(project).idRaw(encodeDashboardId(id)).get(callback);
}
private static String base(Project.NameKey project) {
String name = URL.encodePathSegment(project.get());
return "/projects/" + name + "/dashboards/";
private static RestApi base(Project.NameKey project) {
return new RestApi("/projects/").id(project.get()).view("dashboards");
}
private static String encodeDashboardId(String dashboardId) {
int c = dashboardId.indexOf(":");
private static String encodeDashboardId(String id) {
int c = id.indexOf(':');
if (0 <= c) {
final String ref = URL.encodeQueryString(dashboardId.substring(0, c));
final String path = URL.encodeQueryString(dashboardId.substring(c + 1));
return ref + ":" + path;
} else {
return URL.encodeQueryString(dashboardId);
String ref = URL.encodeQueryString(id.substring(0, c));
String path = URL.encodeQueryString(id.substring(c + 1));
return ref + ':' + path;
}
return URL.encodeQueryString(id);
}
protected DashboardList() {