Merge pull request #52 from vemonet/fix-response-parser-to-handle-construct2

Fix the display of CONSTRUCT/DESCRIBE results in the YASR table

Author: ludovicm67

packages/yasqe/src/sparql.ts

@@ -19,12 +19,12 @@ function getRequestConfigSettings(yasqe: Yasqe, conf?: Partial<Config["requestCo
 // type callback = AjaxConfig.callbacks['complete'];
 export function getAjaxConfig(
   yasqe: Yasqe,
-  _config: Partial<Config["requestConfig"]> = {}
+  _config: Partial<Config["requestConfig"]> = {},
 ): PopulatedAjaxConfig | undefined {
   const config: RequestConfig<Yasqe> = merge(
     {},
     getRequestConfigSettings(yasqe, yasqe.config.requestConfig),
-    getRequestConfigSettings(yasqe, _config)
+    getRequestConfigSettings(yasqe, _config),
   );
   if (!config.endpoint || config.endpoint.length == 0) return; // nothing to query!
 
@@ -94,18 +94,21 @@ export async function executeQuery(yasqe: Yasqe, config?: YasqeAjaxConfig): Prom
     const request = new Request(populatedConfig.url, fetchOptions);
     yasqe.emit("query", request, abortController);
     const response = await fetch(request);
-    let result = await response.text();
-    try {
-      result = JSON.parse(result);
-    } catch (e) {
-      // ignore
-    }
     if (!response.ok) {
-      throw new Error(result || response.statusText);
+      throw new Error((await response.text()) || response.statusText);
     }
-    yasqe.emit("queryResponse", result, Date.now() - queryStart);
-    yasqe.emit("queryResults", result, Date.now() - queryStart);
-    return result;
+    // Await the response content and merge with the `Response` object
+    const queryResponse = {
+      ok: response.ok,
+      status: response.status,
+      statusText: response.statusText,
+      headers: response.headers,
+      type: response.type,
+      content: await response.text(),
+    };
+    yasqe.emit("queryResponse", queryResponse, Date.now() - queryStart);
+    yasqe.emit("queryResults", queryResponse.content, Date.now() - queryStart);
+    return queryResponse;
   } catch (e) {
     if (e instanceof Error && e.message === "Aborted") {
       // The query was aborted. We should not do or draw anything
@@ -153,7 +156,7 @@ export function getUrlArguments(yasqe: Yasqe, _config: Config["requestConfig"]):
       args.reduce((argsObject: { [key: string]: string[] }, arg) => {
         argsObject[arg.name] ? argsObject[arg.name].push(arg.value) : (argsObject[arg.name] = [arg.value]);
         return argsObject;
-      }, {})
+      }, {}),
     );
 
   return data;

packages/yasr/src/parsers/index.ts

@@ -55,25 +55,50 @@ const applyMustacheToLiterals: Parser.PostProcessBinding = (binding: Parser.Bind
   }
   return binding;
 };
+
+/**
+ * Response object from a fetch request with an additional `.content` property containing the awaited response content
+ */
+type QueryResponse = Response & {
+  content: string;
+};
+
+/**
+ * Parser class for handling query responses from various formats.
+ *
+ * This class processes responses from SPARQL endpoints and converts them into standardized formats for further processing.
+ * It can handle JSON, XML, CSV, TSV, and Turtle responses, detecting the format either from content-type headers
+ * or by attempting to parse the content.
+ *
+ * The parser can process:
+ * - Direct `QueryResponse` objects (regular fetch response with additional content property with the awaited response content)
+ * - ResponseSummary objects
+ * - Error objects
+ * - Raw response data
+ *
+ * It provides methods to access parsed data in standardized formats, error information,
+ * and utilities to convert the data for storage or export.
+ */
 class Parser {
-  private res: Response | undefined;
+  private res: QueryResponse | undefined;
   private summary: Parser.ResponseSummary | undefined;
   private errorSummary: Parser.ErrorSummary | undefined;
   private error: Error | undefined;
   private type: "json" | "xml" | "csv" | "tsv" | "ttl" | undefined;
   private executionTime: number | undefined;
-  constructor(responseOrObject: Parser.ResponseSummary | Response | Error | any, executionTime?: number) {
+
+  constructor(responseOrObject: Parser.ResponseSummary | QueryResponse | Error | any, executionTime?: number) {
     if (responseOrObject.executionTime) this.executionTime = responseOrObject.executionTime;
     if (executionTime) this.executionTime = executionTime; // Parameter has priority
     if (responseOrObject instanceof Error) {
       this.error = responseOrObject;
-    } else if ((<any>responseOrObject).xhr) {
-      this.setResponse(<Response>responseOrObject);
+    } else if ((<any>responseOrObject).content) {
+      this.setResponse(<QueryResponse>responseOrObject);
     } else {
       this.setSummary(<Parser.ResponseSummary>responseOrObject);
     }
   }
-  public setResponse(res: Response) {
+  public setResponse(res: QueryResponse) {
     this.res = res;
   }
   public setSummary(summary: Parser.ResponseSummary | any) {
@@ -130,6 +155,7 @@ class Parser {
   }
   private getData(): any {
     if (this.res) {
+      if (this.res.content) return this.res.content;
       if (this.res.body) return this.res.body;
       if (this.res.text) return this.res.text; //probably a construct or something
     }
@@ -236,10 +262,6 @@ class Parser {
     return data;
   }
 
-  getOriginalResponse() {
-    return this.res?.body;
-  }
-
   getType() {
     if (!this.type) this.getAsJson(); //detects type as well
     return this.type;