Files
gerrit/polygerrit-ui/app/elements/shared/gr-js-api-interface/gr-plugin-rest-api.js
David Ostrovsky a4ac1abec0 PolyGerrit: Expose error function in plugin rest API
If user optionally pass error handling function to the send method of
rest API, request error can be processed in custom elements, e.g.:

  const errFn = response => {
    this.fire('page-error', {response});
  };
  return this.plugin.restApi().send(method, endpoint, body, errFn)
      .then(r => {
          Gerrit.Nav.navigateToRelativeUrl('/admin/repos');
      });

Considered alternative is to handle errors in plugin requests by
providing generic function that does the same: fire page-error event,
but having a way to provide custom error function is more flexible
approach.

Change-Id: Idd7e86dd0c40d53f4327c013fa0bb469ee8a6fff
2018-08-29 21:07:21 +02:00

127 lines
3.8 KiB
JavaScript

/**
* @license
* Copyright (C) 2017 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
(function(window) {
'use strict';
let restApi;
function getRestApi() {
if (!restApi) {
restApi = document.createElement('gr-rest-api-interface');
}
return restApi;
}
function GrPluginRestApi(opt_prefix) {
this.opt_prefix = opt_prefix || '';
}
GrPluginRestApi.prototype.getLoggedIn = function() {
return getRestApi().getLoggedIn();
};
GrPluginRestApi.prototype.getVersion = function() {
return getRestApi().getVersion();
};
/**
* Fetch and return native browser REST API Response.
* @param {string} method HTTP Method (GET, POST, etc)
* @param {string} url URL without base path or plugin prefix
* @param {Object=} payload Respected for POST and PUT only.
* @param {?function(?Response, string=)=} opt_errFn
* passed as null sometimes.
* @return {!Promise}
*/
GrPluginRestApi.prototype.fetch = function(method, url, opt_payload,
opt_errFn) {
return getRestApi().send(method, this.opt_prefix + url, opt_payload,
opt_errFn);
};
/**
* Fetch and parse REST API response, if request succeeds.
* @param {string} method HTTP Method (GET, POST, etc)
* @param {string} url URL without base path or plugin prefix
* @param {Object=} payload Respected for POST and PUT only.
* @param {?function(?Response, string=)=} opt_errFn
* passed as null sometimes.
* @return {!Promise} resolves on success, rejects on error.
*/
GrPluginRestApi.prototype.send = function(method, url, opt_payload,
opt_errFn) {
return this.fetch(method, url, opt_payload, opt_errFn).then(response => {
if (response.status < 200 || response.status >= 300) {
return response.text().then(text => {
if (text) {
return Promise.reject(text);
} else {
return Promise.reject(response.status);
}
});
} else {
return getRestApi().getResponseObject(response);
}
});
};
/**
* @param {string} url URL without base path or plugin prefix
* @return {!Promise} resolves on success, rejects on error.
*/
GrPluginRestApi.prototype.get = function(url) {
return this.send('GET', url);
};
/**
* @param {string} url URL without base path or plugin prefix
* @return {!Promise} resolves on success, rejects on error.
*/
GrPluginRestApi.prototype.post = function(url, opt_payload) {
return this.send('POST', url, opt_payload);
};
/**
* @param {string} url URL without base path or plugin prefix
* @return {!Promise} resolves on success, rejects on error.
*/
GrPluginRestApi.prototype.put = function(url, opt_payload) {
return this.send('PUT', url, opt_payload);
};
/**
* @param {string} url URL without base path or plugin prefix
* @return {!Promise} resolves on 204, rejects on error.
*/
GrPluginRestApi.prototype.delete = function(url) {
return this.fetch('DELETE', url).then(response => {
if (response.status !== 204) {
return response.text().then(text => {
if (text) {
return Promise.reject(text);
} else {
return Promise.reject(response.status);
}
});
}
return response;
});
};
window.GrPluginRestApi = GrPluginRestApi;
})(window);