graphdb
Version:
Javascript client library supporting GraphDB and RDF4J REST API.
204 lines (196 loc) • 10 kB
JavaScript
;
function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
function _possibleConstructorReturn(t, e) { if (e && ("object" == _typeof(e) || "function" == typeof e)) return e; if (void 0 !== e) throw new TypeError("Derived constructors may only return object or undefined"); return _assertThisInitialized(t); }
function _assertThisInitialized(e) { if (void 0 === e) throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); return e; }
function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
function _getPrototypeOf(t) { return _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function (t) { return t.__proto__ || Object.getPrototypeOf(t); }, _getPrototypeOf(t); }
function _inherits(t, e) { if ("function" != typeof e && null !== e) throw new TypeError("Super expression must either be null or a function"); t.prototype = Object.create(e && e.prototype, { constructor: { value: t, writable: !0, configurable: !0 } }), Object.defineProperty(t, "prototype", { writable: !1 }), e && _setPrototypeOf(t, e); }
function _setPrototypeOf(t, e) { return _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function (t, e) { return t.__proto__ = e, t; }, _setPrototypeOf(t, e); }
var Service = require('./service');
var HttpRequestBuilder = require('../http/http-request-builder');
var ServiceRequest = require('./service-request');
var PATH_STATEMENTS = require('./service-paths').PATH_STATEMENTS;
var LoggingUtils = require('../logging/logging-utils');
var QueryContentType = require('../http/query-content-type');
var GetQueryPayload = require('../query/get-query-payload');
var HttpUtils = require('../util/http-utils');
// Imports used by TypeScript type generation
var UpdateQueryPayload = require('../query/update-query-payload');
/**
* Service for executing queries via {@link GetQueryPayload} or
* {@link UpdateQueryPayload}.
*
* @author Mihail Radkov
* @author Svilen Velikov
*/
var QueryService = /*#__PURE__*/function (_Service) {
/**
* Instantiates the query service.
*
* @param {Function} httpRequestExecutor used to execute HTTP requests
* @param {Function} parseExecutor function that will parse provided data
*/
function QueryService(httpRequestExecutor, parseExecutor) {
var _this;
_classCallCheck(this, QueryService);
_this = _callSuper(this, QueryService, [httpRequestExecutor]);
_this.parseExecutor = parseExecutor;
return _this;
}
/**
* Executes request to query a repository.
*
* Only POST request with a valid QueryPayload is supported.
*
* @param {GetQueryPayload} payload is an object holding request parameters
* required by the query POST endpoint.
*
* @return {ServiceRequest} a service request that will resolve to a readable
* stream to which the client can subscribe and consume
* the emitted strings or Quads depending on the provided response type as
* soon as they are available.
*
* @throws {Error} if the payload is misconfigured
*/
_inherits(QueryService, _Service);
return _createClass(QueryService, [{
key: "query",
value: function query(payload) {
var _this2 = this;
payload.validatePayload();
var requestBuilder = HttpRequestBuilder.httpPost('').setResponseType('stream').addAcceptHeader(payload.getResponseType()).addContentTypeHeader(payload.getContentType());
this.setPostRequestPayload(requestBuilder, payload);
return new ServiceRequest(requestBuilder, function () {
return _this2.executeQuery(payload, requestBuilder);
});
}
/**
* Populates parameters and body data in the <code>httpRequestBuilder</code>
* to comply with the SPARQL specification
* {@link https://www.w3.org/TR/sparql11-protocol/}.
*
* For POST requests, there are two scenarios:
* - When the content type is "application/x-www-form-urlencoded",
* all parameters are sent as body content. The SPARQL query is added to
* the parameters: if the query is a SELECT (or similar read query),
* the parameter name is "query", otherwise, for updates,
* the parameter name is "update".
* - When the content type is "application/sparql-update" or
* "application/sparql-query", all parameters are sent as URL parameters,
* and the SPARQL query is sent as the raw body content without
* URL encoding.
*
* For more information about "application/sparql-update"
* see {@link https://www.w3.org/TR/sparql11-protocol/#update-operation},
* and for "application/sparql-query"
* see {@link https://www.w3.org/TR/sparql11-protocol/#query-operation}.
*
* @private
*
* @param {HttpRequestBuilder} httpRequestBuilder - The HTTP request builder
* that holds all necessary information for a {@link HttpClient}.
* @param {QueryPayload} payload - An object holding request parameters
* required by the query endpoint.
*/
}, {
key: "setPostRequestPayload",
value: function setPostRequestPayload(httpRequestBuilder, payload) {
var params = Object.assign({}, payload.getParams());
var query = payload.getQuery();
if (payload.getContentType() === QueryContentType.X_WWW_FORM_URLENCODED) {
if (payload instanceof GetQueryPayload) {
params.query = query;
} else {
params.update = query;
}
httpRequestBuilder.setData(HttpUtils.serialize(params));
} else {
httpRequestBuilder.setData(query);
if (params && Object.keys(params).length > 0) {
httpRequestBuilder.setParams(params);
}
}
}
/**
* Executes a query request with the supplied payload and request builder.
*
* @private
*
* @param {GetQueryPayload} payload an object holding request parameters
* required by the query POST endpoint.
* @param {HttpRequestBuilder} requestBuilder builder containing the request
* parameters and data
*
* @return {Promise} promise resolving to parsed query response
*
* @throws {Error} if the payload is misconfigured
*/
}, {
key: "executeQuery",
value: function executeQuery(payload, requestBuilder) {
var _this3 = this;
return this.httpRequestExecutor(requestBuilder).then(function (response) {
var logPayload = LoggingUtils.getLogPayload(response, {
query: payload.getQuery(),
queryType: payload.getQueryType()
});
_this3.logger.debug(logPayload, 'Queried data');
var parserConfig = {
queryType: payload.getQueryType()
};
return _this3.parseExecutor(response.getData(), payload.getResponseType(), parserConfig);
});
}
/**
* Executes a request with a sparql query against <code>/statements</code>
* endpoint to update repository data.
*
* If <code>contentType</code> is set to
* <code>application/x-www-form-urlencoded</code> then query and request
* parameters from the payload are encoded as query string and sent as request
* body.
*
* If <code>contentType</code> is set to
* <code>application/sparql-update</code> then the query is sent unencoded as
* request body.
*
* @param {UpdateQueryPayload} payload
*
* @return {ServiceRequest} service request that will be resolved if the
* update is successful or rejected in case of failure
*
* @throws {Error} if the payload is misconfigured
*/
}, {
key: "update",
value: function update(payload) {
var _this4 = this;
payload.validatePayload();
var requestBuilder = HttpRequestBuilder.httpPost(PATH_STATEMENTS).addContentTypeHeader(payload.getContentType());
this.setPostRequestPayload(requestBuilder, payload);
return new ServiceRequest(requestBuilder, function () {
return _this4.httpRequestExecutor(requestBuilder).then(function (response) {
var logPayload = LoggingUtils.getLogPayload(response, {
query: payload.getQuery()
});
_this4.logger.debug(logPayload, 'Performed update');
});
});
}
/**
* @inheritDoc
*/
}, {
key: "getServiceName",
value: function getServiceName() {
return 'StatementsService';
}
}]);
}(Service);
module.exports = QueryService;