{
+ setParsingErrorHttpProxies(false);
+ setFormData((prevFormData) => ({
+ ...prevFormData,
+ 'httpProxiesCheck': !formData.httpProxiesCheck,
+ }));
+ }
+ }
+ />} label="Http proxies" />
+
+ {formData.httpProxiesCheck &&
+
+ handleJSONparsing(e, setParsingErrorHttpProxies)}
+ onChange={(e) => handleJSONparsing(e, setParsingErrorHttpProxies)}
+ sx={{ marginBottom: '16px' }}
+ />
+
+ }
+
diff --git a/main/src/comunicaEngineWrapper/comunicaEngineWrapper.js b/main/src/comunicaEngineWrapper/comunicaEngineWrapper.js
index 7a6fa6f5..dacedffa 100644
--- a/main/src/comunicaEngineWrapper/comunicaEngineWrapper.js
+++ b/main/src/comunicaEngineWrapper/comunicaEngineWrapper.js
@@ -4,6 +4,9 @@ import {
getDefaultSession,
fetch as authFetch,
} from "@inrupt/solid-client-authn-browser";
+import { translateUrlToProxiedUrl } from '../lib/utils';
+
+// LOG let wrappedFetchFunctionCounter = 0;
/**
* A class wrapping the Comunica engines we need, used for all but login actions.
@@ -58,12 +61,13 @@ class ComunicaEngineWrapper {
*
* @param {string} queryText - the SPARQL query text
* @param {object} context - the context to provide to the Comunica engine
- * @param {object} callbacks - an object contains the callback functions you specify
+ * @param {array} httpProxies - array of httpProxy definitions
+ * @param {object} callbacks - an object containing the callback functions you specify
* @returns {void} when the query has finished
*/
- async query(queryText, context, callbacks) {
+ async query(queryText, context, httpProxies, callbacks) {
try {
- this._prepareQuery(context);
+ this._prepareQuery(context, httpProxies);
let result = await this._engine.query(queryText, context);
switch (result.resultType) {
case 'bindings':
@@ -118,15 +122,16 @@ class ComunicaEngineWrapper {
* Supports the following options.
* - engine:
* - "default": use the default Comunica engine (this is the default anyway)
- * - "datasources": use a Comunica query engine configured to discover datasources recursively
+ * - "link-traversal": use a Comunica query engine configured to discover datasources recursively
*
* @param {string} queryText - the SPARQL SELECT query text
* @param {object} context - the context to provide to the Comunica engine
+ * @param {array} httpProxies - array of httpProxy definitions
* @param {string} options.engine - "default": use the default Comunica engine (this is the default anyway)
* - "link-traversal": use a Comunica query engine with link-traversal feature
* @returns {Promise } Promise to the bindings stream
*/
- async queryBindings(queryText, context, options = {}) {
+ async queryBindings(queryText, context, httpProxies, options = {}) {
let engine;
switch (options.engine) {
case "default":
@@ -140,7 +145,7 @@ class ComunicaEngineWrapper {
throw new Error("Unsupported engine requested");
}
try {
- this._prepareQuery(context);
+ this._prepareQuery(context, httpProxies);
return engine.queryBindings(queryText, context);
} catch (error) {
await this.reset();
@@ -152,8 +157,9 @@ class ComunicaEngineWrapper {
* Prepares a call to any engine's query function
*
* @param {object} context - the context that will be used
+ * @param {array} httpProxies - array of httpProxy definitions
*/
- _prepareQuery(context) {
+ _prepareQuery(context, httpProxies) {
// avoid faulty fetch status for sources cached in Comunica
for (const source of context.sources) {
this._fetchSuccess[source] = true;
@@ -162,29 +168,37 @@ class ComunicaEngineWrapper {
if (getDefaultSession().info.isLoggedIn) {
this._underlyingFetchFunction = authFetch;
}
- context.fetch = ComunicaEngineWrapper._getWrappedFetchFunction(this._underlyingFetchFunction, this);
+ context.fetch = ComunicaEngineWrapper._getWrappedFetchFunction(this._underlyingFetchFunction, httpProxies, this);
}
/**
* Returns a function that wraps the underlying fetch function and sets the fetch success information in member variables of _this.
*
- * @param underlyingFetchFunction - the underlying fetch functin
+ * @param underlyingFetchFunction - the underlying fetch function
+ * @param {array} httpProxies - array of httpProxy definitions
* @param {ComunicaEngineWrapper} _this - the calling ComunicaEngineWrapper object
* @returns {Function} that function.
*/
- static _getWrappedFetchFunction(underlyingFetchFunction, _this) {
+ static _getWrappedFetchFunction(underlyingFetchFunction, httpProxies, _this) {
const wrappedFetchFunction = async (arg) => {
try {
- const response = await underlyingFetchFunction(arg, {
+ let actualUrl = translateUrlToProxiedUrl(arg, httpProxies);
+ const response = await underlyingFetchFunction(actualUrl, {
headers: {
Accept: "application/n-quads,application/trig;q=0.9,text/turtle;q=0.8,application/n-triples;q=0.7,*/*;q=0.1"
}
});
_this._fetchSuccess[arg] = response.ok;
_this._fetchStatusNumber[arg] = response.status;
+ // LOG console.log(`--- wrappedFetchFunction #${++wrappedFetchFunctionCounter}`);
+ // LOG console.log(`arg: ${arg}`);
+ // LOG console.log(`actualUrl: ${actualUrl}`);
+ // LOG console.log(`response status: ${response.status}`);
return response;
}
catch (error) {
+ // LOG console.log(`--- wrappedFetchFunction #${++wrappedFetchFunctionCounter}`);
+ // LOG console.log(error);
_this._fetchSuccess[arg] = false;
throw error;
}
diff --git a/main/src/dataProvider/SparqlDataProvider.js b/main/src/dataProvider/SparqlDataProvider.js
index 272cec16..857e8553 100644
--- a/main/src/dataProvider/SparqlDataProvider.js
+++ b/main/src/dataProvider/SparqlDataProvider.js
@@ -1,4 +1,3 @@
-import { ProxyHandlerStatic } from "@comunica/actor-http-proxy";
import { Generator, Parser } from "sparqljs";
import NotImplementedError from "../NotImplementedError";
import { Term } from "sparqljs";
@@ -8,24 +7,6 @@ import comunicaEngineWrapper from "../comunicaEngineWrapper/comunicaEngineWrappe
let config = configManager.getConfig();
-let proxyHandler;
-
-const setProxyHandler = () => {
- if (config.httpProxy) {
- proxyHandler = new ProxyHandlerStatic(config.httpProxy);
- } else {
- proxyHandler = undefined;
- }
-};
-setProxyHandler();
-
-const onConfigChanged = (newConfig) => {
- config = newConfig;
- setProxyHandler();
-};
-
-configManager.on('configChanged', onConfigChanged);
-
// simple cache to save time while scrolling through pages of a list
// results = the result of executeQuery, totalItems
const listCache = {
@@ -57,7 +38,7 @@ export default {
handleComunicaContextCreation(query);
if (query.sourcesIndex) {
- const additionalSources = await getSourcesFromSourcesIndex(query.sourcesIndex, query.comunicaContext.useProxy);
+ const additionalSources = await getSourcesFromSourcesIndex(query.sourcesIndex, query.httpProxies);
query.comunicaContext.sources = [...new Set([...query.comunicaContext.sources, ...additionalSources])];
}
@@ -257,6 +238,7 @@ async function executeQuery(query) {
await comunicaEngineWrapper.query(query.queryText,
// WEIRD: we need to make a copy of the context here (a shallow copy is fine); concurrent calls ???
{ ...query.comunicaContext },
+ query.httpProxies && [ ...query.httpProxies ],
{ "variables": callbackVariables, "bindings": callbackBindings, "quads": callbackQuads, "boolean": callbackBoolean });
return results;
} catch (error) {
@@ -268,10 +250,10 @@ async function executeQuery(query) {
* Gets sources from a sources index
*
* @param {object} sourcesIndex - the sourcesIndex object as found in the configuration
- * @param {boolean} useProxy - true if the main query needs a proxy (in which case we implicitly use it to access the sources index too)
+ * @param {array} httpProxies - array of httpProxy definitions
* @returns {array} array of sources found
*/
-async function getSourcesFromSourcesIndex(sourcesIndex, useProxy) {
+async function getSourcesFromSourcesIndex(sourcesIndex, httpProxies) {
const sourcesList = [];
try {
let queryStringIndexSource;
@@ -283,7 +265,7 @@ async function getSourcesFromSourcesIndex(sourcesIndex, useProxy) {
}
const bindingsStream = await comunicaEngineWrapper.queryBindings(queryStringIndexSource,
- { lenient: true, sources: [sourcesIndex.url], httpProxyHandler: (useProxy ? proxyHandler : undefined) }, { engine: "link-traversal" });
+ { lenient: true, sources: [sourcesIndex.url] }, httpProxies, { engine: "link-traversal" });
await new Promise((resolve, reject) => {
bindingsStream.on('data', (bindings) => {
for (const term of bindings.values()) { // check for 1st value
@@ -329,9 +311,6 @@ function handleComunicaContextCreation(query) {
if (!query.comunicaContext.sources) {
query.comunicaContext.sources = [];
}
- if (query.comunicaContext.useProxy) {
- query.comunicaContext.httpProxyHandler = proxyHandler;
- }
}
}
@@ -343,7 +322,7 @@ async function getVariableOptions(query) {
handleComunicaContextCreation(query);
if (query.sourcesIndex) {
- const additionalSources = await getSourcesFromSourcesIndex(query.sourcesIndex, query.comunicaContext.useProxy);
+ const additionalSources = await getSourcesFromSourcesIndex(query.sourcesIndex, query.httpProxies);
query.comunicaContext.sources = [...new Set([...query.comunicaContext.sources, ...additionalSources])];
}
// END duplicated chunk of code
@@ -386,7 +365,7 @@ async function getVariableOptions(query) {
try {
for (const queryString of queryStringList) {
const bindingsStream = await comunicaEngineWrapper.queryBindings(queryString,
- { sources: query.comunicaContext.sources, httpProxyHandler: (query.comunicaContext.useProxy ? proxyHandler : undefined) });
+ { sources: query.comunicaContext.sources }, query.httpProxies);
await new Promise((resolve, reject) => {
bindingsStream.on('data', (bindings) => {
// see https://comunica.dev/docs/query/advanced/bindings/
diff --git a/main/src/lib/utils.js b/main/src/lib/utils.js
new file mode 100644
index 00000000..523d8594
--- /dev/null
+++ b/main/src/lib/utils.js
@@ -0,0 +1,19 @@
+/**
+ * Translate a url into the url to use with a given proxy, if applicable.
+ *
+ * Parameter httpProxies may specify a http proxy for urls starting with a given string.
+ *
+ * @param {string} url - the url
+ * @param {array} httpProxies - array of httpProxy definitions
+ * @returns {string}
+ */
+export function translateUrlToProxiedUrl(url, httpProxies) {
+ if (httpProxies) {
+ for (const entry of httpProxies) {
+ if (url.startsWith(entry.urlStart)) {
+ return `${entry.httpProxy}${url}`;
+ }
+ }
+ }
+ return url;
+}
\ No newline at end of file
diff --git a/test/cypress/e2e/custom-query-editor.cy.js b/test/cypress/e2e/custom-query-editor.cy.js
index a27f4cb1..898d5d02 100644
--- a/test/cypress/e2e/custom-query-editor.cy.js
+++ b/test/cypress/e2e/custom-query-editor.cy.js
@@ -63,11 +63,85 @@ ORDER BY ?componentName
cy.contains("https://www.example.com/data/component-c01").should('exist');
});
+ it("Create a new query, here an ASK query", () => {
+
+ cy.visit("/#/customQuery");
+
+ cy.get('input[name="name"]').type("Is there an artist etc...");
+ cy.get('textarea[name="description"]').type("Test an ASK query");
+
+ cy.get('textarea[name="queryString"]').clear();
+ cy.get('textarea[name="queryString"]').type(`PREFIX foaf:
+PREFIX dbo:
+PREFIX dbp:
+ASK WHERE {
+ ?person a dbo:Artist.
+ ?person foaf:name ?name.
+ ?person dbo:influencedBy dbp:Pablo_Picasso.
+}`);
+ cy.get('input[name="source"]').type("http://localhost:8080/example/artists");
+
+ cy.get('input[name="askQueryCheck"]').click()
+
+ cy.get('textarea[name="askQuery"]').clear()
+ cy.get('textarea[name="askQuery"]').type('"trueText":"Yes, there is at least one artist influenced by Picasso!","falseText":"No, there is not a single artist influenced by Picasso."}', { parseSpecialCharSequences: false })
+
+ cy.get('button[type="submit"]').click();
+
+ // Check faulty input error
+ cy.contains("Invalid Query. Check the JSON-Syntax");
+
+ cy.get('textarea[name="askQuery"]').clear()
+ cy.get('textarea[name="askQuery"]').type('{"trueText":"Yes, there is at least one artist influenced by Picasso!","falseText":"No, there is not a single artist influenced by Picasso."}', { parseSpecialCharSequences: false })
+
+ cy.get('button[type="submit"]').click();
+
+ // Check if the query works
+ cy.contains("Yes, there is at least one artist influenced by Picasso!")
+ });
+
+ it("Create a new query, here with http proxies", () => {
+
+ cy.visit("/#/customQuery");
+
+ cy.get('input[name="name"]').type("My idols custom...");
+ cy.get('textarea[name="description"]').type("Test a query wit http proxies");
+
+ cy.get('textarea[name="queryString"]').clear();
+ cy.get('textarea[name="queryString"]').type(`PREFIX schema:
+SELECT ?name ?birthDate_int WHERE {
+ ?list schema:name ?listTitle;
+ schema:itemListElement [
+ schema:name ?name;
+ schema:birthDate ?birthDate_int;
+ ].
+}`);
+ cy.get('input[name="source"]').type("http://localhost:8001/example/idols");
+
+ cy.get('input[name="httpProxiesCheck"]').click()
+
+ cy.get('textarea[name="httpProxies"]').clear()
+ cy.get('textarea[name="httpProxies"]').type('{"urlStart":"http://localhost:8001","httpProxy":"http://localhost:8000/"}, {"urlStart":"http://localhost:8002","httpProxy":"http://localhost:9000/"}]', { parseSpecialCharSequences: false })
+
+ cy.get('button[type="submit"]').click();
+
+ // Check faulty input error
+ cy.contains("Invalid Query. Check the JSON-Syntax");
+
+ cy.get('textarea[name="httpProxies"]').clear()
+ cy.get('textarea[name="httpProxies"]').type('[{"urlStart":"http://localhost:8001","httpProxy":"http://localhost:8000/"}, {"urlStart":"http://localhost:8002","httpProxy":"http://localhost:9000/"}]', { parseSpecialCharSequences: false })
+
+ cy.get('button[type="submit"]').click();
+
+ // Check if the query works
+ cy.contains("1-2 of 2");
+ });
+
it("Check if all possible parameters are filled in with parameterized URL", () => {
//templatedQueryCheck
// Navigate to the URL of a saved query with completely filled-in form
- cy.visit("/#/customQuery?name=Query+Name&description=Query+Description&queryString=Sparql+query+text&comunicaContextCheck=on&source=The+Comunica+Source&comunicaContext=%7B%22Advanced+Comunica+Context%22%3Atrue%7D&sourceIndexCheck=on&indexSourceUrl=Index+Source&indexSourceQuery=Index+Query+&askQueryCheck=on&askQuery=%7B%22trueText%22%3A%22+filled+in%22%2C%22falseText%22%3A%22not+filled+in%22%7D&directVariablesCheck=on&variables=%7B%22firstvariables%22%3A%5B%22only+one%22%5D%7D")
+ cy.visit("/#/customQuery?name=Query+Name&description=Query+Description&queryString=Sparql+query+text&comunicaContextCheck=on&source=The+Comunica+Source&comunicaContext=%7B%22Advanced+Comunica+Context%22%3Atrue%7D&sourceIndexCheck=on&indexSourceUrl=Index+Source&indexSourceQuery=Index+Query+&askQueryCheck=on&askQuery=%7B%22trueText%22%3A%22+filled+in%22%2C%22falseText%22%3A%22not+filled+in%22%7D&directVariablesCheck=on&variables=%7B%22firstvariables%22%3A%5B%22only+one%22%5D%7D&httpProxiesCheck=on&httpProxies=%5B%7B%22urlStart%22%3A%22http%3A%2F%2Flocalhost%3A8001%22%2C%22httpProxy%22%3A%22http%3A%2F%2Flocalhost%3A8000%2F%22%7D%5D")
// Verify that every field is correctly filled-in
cy.get('input[name="name"]').should('have.value', 'Query Name');
@@ -82,6 +156,8 @@ ORDER BY ?componentName
cy.get('textarea[name="askQuery"]').should('have.value', `{"trueText":" filled in","falseText":"not filled in"}`);
+ cy.get('textarea[name="httpProxies"]').should('have.value', `[{"urlStart":"http://localhost:8001","httpProxy":"http://localhost:8000/"}]`);
+
cy.get('textarea[name="variables"]').should('have.value', `{"firstvariables":["only one"]}`);
})
diff --git a/test/cypress/e2e/customize-existing-query.cy.js b/test/cypress/e2e/customize-existing-query.cy.js
index e806d9b6..d95543a0 100644
--- a/test/cypress/e2e/customize-existing-query.cy.js
+++ b/test/cypress/e2e/customize-existing-query.cy.js
@@ -159,6 +159,29 @@ SELECT DISTINCT ?source WHERE {
})
+ it("ASK query", () => {
+ cy.visit("/");
+ cy.contains("Example queries").click();
+ cy.contains("Is there an artist influenced by Picasso?").click();
+
+ cy.get('button').contains("Clone as custom query").click({ force: true }); // Button is out of FoV so we gotta force the click
+
+ cy.url().should('include', 'customQuery');
+
+ cy.get('textarea[name="askQuery"]').should('have.value', `{"trueText":"Yes, there is at least one artist influenced by Picasso!","falseText":"No, there is not a single artist influenced by Picasso."}`);
+ })
+
+ it("http proxies", () => {
+ cy.visit("/");
+ cy.contains("Example queries").click();
+ cy.contains("My idols").click();
+
+ cy.get('button').contains("Clone as custom query").click({ force: true }); // Button is out of FoV so we gotta force the click
+
+ cy.url().should('include', 'customQuery');
+
+ cy.get('textarea[name="httpProxies"]').should('have.value', `[{"urlStart":"http://localhost:8001","httpProxy":"http://localhost:8000/"}]`);
+ })
})
diff --git a/test/cypress/e2e/http-proxies.cy.js b/test/cypress/e2e/http-proxies.cy.js
new file mode 100644
index 00000000..8d28865a
--- /dev/null
+++ b/test/cypress/e2e/http-proxies.cy.js
@@ -0,0 +1,34 @@
+describe("Http proxies", () => {
+ it("With indirect sources and with source verification", () => {
+ cy.visit("/");
+
+ cy.contains("For testing only").click();
+ cy.contains("Http proxy test combined with indirect sources and source verification").click();
+
+ cy.get('[aria-label="Sources info"]').click();
+
+ cy.contains("1-3 of 3");
+
+ cy.contains("http://localhost:8080/verifiable-example/components-vc").parent('tr').within(() => {
+ cy.get('[aria-label="No authentication required"]').should("exist");
+ cy.get('[aria-label="Fetch was successful"]').should("exist");
+ cy.get('[aria-label="Verify source"]').click();
+ cy.get('[aria-label="Verification succeeded"]').should("exist");
+ });
+
+ cy.contains("http://localhost:8080/verifiable-example/components-vc-incorrect-proof").parent('tr').within(() => {
+ cy.get('[aria-label="No authentication required"]').should("exist");
+ cy.get('[aria-label="Fetch was successful"]').should("exist");
+ cy.get('[aria-label="Verify source"]').click();
+ cy.get('[aria-label="Verification failed"]').should("exist");
+ });
+
+ cy.contains("http://localhost:8080/example/components").parent('tr').within(() => {
+ cy.get('[aria-label="No authentication required"]').should("exist");
+ cy.get('[aria-label="Fetch was successful"]').should("exist");
+ cy.get('[aria-label="Verify source"]').click();
+ cy.get('[aria-label="No credential found to verify"]').should("exist");
+ });
+
+ });
+});
\ No newline at end of file
diff --git a/test/initial-pod-data/index-example-for-proxy-test-only$.ttl b/test/initial-pod-data/index-example-for-proxy-test-only$.ttl
new file mode 100644
index 00000000..691ec5bb
--- /dev/null
+++ b/test/initial-pod-data/index-example-for-proxy-test-only$.ttl
@@ -0,0 +1,7 @@
+@prefix rdfs: .
+
+<#index-example> rdfs:seeAlso
+ ,
+ ,
+
+.
diff --git a/test/initial-pod-data/index-example-for-proxy-test-only.acl b/test/initial-pod-data/index-example-for-proxy-test-only.acl
new file mode 100644
index 00000000..4696a32c
--- /dev/null
+++ b/test/initial-pod-data/index-example-for-proxy-test-only.acl
@@ -0,0 +1,15 @@
+@prefix acl: .
+@prefix foaf: .
+
+<#public>
+ a acl:Authorization;
+ acl:agentClass foaf:Agent;
+ acl:accessTo <./index-example-for-proxy-test-only>;
+ acl:mode acl:Read.
+
+<#owner>
+ a acl:Authorization;
+ acl:accessTo <./index-example-for-proxy-test-only>;
+ acl:agent ;
+ acl:mode acl:Read, acl:Write, acl:Control.
+