qlue-ls 2.6.0

A language server for SPARQL
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
use crate::server::Server;
use crate::server::configuration::RequestMethod;
use crate::server::lsp::CanceledError;
use crate::server::lsp::ExecuteUpdateResponseResult;
use crate::server::lsp::PartialSparqlResultNotification;
use crate::server::lsp::SparqlEngine;
use crate::server::sparql_operations::ConnectionError;
use crate::server::sparql_operations::SparqlRequestError;
use crate::sparql::results::RDFTerm;
use crate::sparql::results::SparqlResult;
use futures::lock::Mutex;
use js_sys::JsString;
use lazy_sparql_result_reader::parser::PartialResult;
use lazy_sparql_result_reader::sparql::Head;
use lazy_sparql_result_reader::sparql::Header;
use std::collections::HashMap;
use std::rc::Rc;
use std::str::FromStr;
use urlencoding::encode;
use wasm_bindgen::JsCast;
use wasm_bindgen::JsValue;
use wasm_bindgen_futures::JsFuture;
use web_sys::AbortController;
use web_sys::{Request, RequestInit, Response, WorkerGlobalScope};

pub(crate) async fn execute_construct_query(
    server_rc: Rc<Mutex<Server>>,
    url: &str,
    query: &str,
    query_id: Option<&str>,
    engine: Option<SparqlEngine>,
    lazy: bool,
) -> Result<Option<SparqlResult>, SparqlRequestError> {
    let opts = RequestInit::new();

    let request = match engine {
        Some(SparqlEngine::QLever) => {
            opts.set_method("POST");
            let body = format!("send=100&query={}", js_sys::encode_uri_component(query));
            opts.set_body(&JsString::from_str(&body).unwrap());
            let request = Request::new_with_str_and_init(url, &opts).unwrap();
            request
                .headers()
                .set("Content-Type", "application/x-www-form-urlencoded")
                .unwrap();
            if let Some(id) = query_id {
                request.headers().set("Query-Id", id).unwrap();
            }
            request
        }
        _ => {
            opts.set_method("POST");
            opts.set_body(&JsString::from_str(query).unwrap());
            let request = Request::new_with_str_and_init(url, &opts).unwrap();
            request
                .headers()
                .set("Content-Type", "application/sparql-query")
                .unwrap();
            request
        }
    };
    request
        .headers()
        .set("Accept", "application/n-triples")
        .unwrap();

    // Get global worker scope
    let worker_global: WorkerGlobalScope = js_sys::global().unchecked_into();

    // Perform the fetch request and await the response
    let resp_value = JsFuture::from(worker_global.fetch_with_request(&request))
        .await
        .map_err(|err| {
            log::error!("error: {err:?}");
            SparqlRequestError::Connection(ConnectionError {
                status_text: format!("{err:?}"),
                query: query.to_string(),
            })
        })?;

    // Cast the response value to a Response object
    let resp: Response = resp_value.dyn_into().unwrap();

    // Check if the response status is OK (200-299)
    if !resp.ok() {
        return match resp.json() {
            Ok(json) => match JsFuture::from(json).await {
                Ok(js_value) => match serde_wasm_bindgen::from_value(js_value) {
                    Ok(err) => Err(SparqlRequestError::QLeverException(err)),
                    Err(err) => Err(SparqlRequestError::Deserialization(format!(
                        "Could not deserialize error message: {}",
                        err
                    ))),
                },
                Err(err) => Err(SparqlRequestError::Deserialization(format!(
                    "Query failed! Response did not provide a json body but this could not be cast to rust JsValue.\n{:?}",
                    err
                ))),
            },
            Err(err) => Err(SparqlRequestError::Deserialization(format!(
                "Query failed! Response did not provide a json body.\n{err:?}"
            ))),
        };
    }
    // Get the response body as text and await it
    let text = JsFuture::from(resp.text().map_err(|err| {
        SparqlRequestError::Response(format!("Response has no text:\n{:?}", err))
    })?)
    .await
    .map_err(|err| {
        SparqlRequestError::Response(format!("Could not read Response text:\n{:?}", err))
    })?
    .as_string()
    .unwrap();
    // Return the text as a JsValue
    let (triples, _errors) = ntriples_parser::parse(text.as_bytes()).map_err(|_e| {
        SparqlRequestError::Deserialization("Could not read n-triples response".to_string())
    })?;

    let result = SparqlResult::new(
        ["subject", "predicate", "object"]
            .into_iter()
            .map(|var| var.to_string())
            .collect(),
        triples
            .into_iter()
            .map(|triple| {
                HashMap::from_iter([
                    (
                        "subject".to_string(),
                        RDFTerm::Literal {
                            value: String::from_utf8(triple.0.to_vec())
                                .expect("Should be valid utf8"),
                            lang: None,
                            datatype: None,
                        },
                    ),
                    (
                        "predicate".to_string(),
                        RDFTerm::Literal {
                            value: String::from_utf8(triple.1.to_vec())
                                .expect("Should be valid utf8"),
                            lang: None,
                            datatype: None,
                        },
                    ),
                    (
                        "object".to_string(),
                        RDFTerm::Literal {
                            value: String::from_utf8(triple.2.to_vec())
                                .expect("Should be valid utf8"),
                            lang: None,
                            datatype: None,
                        },
                    ),
                ])
            })
            .collect(),
    );
    if lazy {
        let server = server_rc.lock().await;
        let SparqlResult {
            head,
            results,
            prefixes: _prefixes,
        } = result;
        server
            .send_message(PartialSparqlResultNotification::new(PartialResult::Header(
                Header {
                    head: Head { vars: head.vars },
                },
            )))
            .expect("Response should be sendable");
        server
            .send_message(PartialSparqlResultNotification::new(
                PartialResult::Bindings(
                    results
                        .bindings
                        .into_iter()
                        .map(|binding| {
                            lazy_sparql_result_reader::sparql::Binding(HashMap::from_iter(
                                binding.into_iter().map(|(key, value)| (key, value.into())),
                            ))
                        })
                        .collect(),
                ),
            ))
            .expect("Response should be sendable");
        Ok(None)
    } else {
        Ok(Some(result))
    }
}

pub(crate) async fn execute_update(
    server_rc: Rc<Mutex<Server>>,
    url: &str,
    query: &str,
    query_id: Option<&str>,
    access_token: Option<&str>,
) -> Result<Vec<ExecuteUpdateResponseResult>, SparqlRequestError> {
    use js_sys::JsString;
    use std::str::FromStr;
    use wasm_bindgen::JsCast;
    use wasm_bindgen_futures::JsFuture;
    use web_sys::{AbortController, Request, RequestInit, Response, WorkerGlobalScope};

    let opts = RequestInit::new();
    if let Some(query_id) = query_id {
        let controller = AbortController::new().expect("AbortController should be creatable");

        opts.set_signal(Some(&controller.signal()));
        server_rc.lock().await.state.add_running_request(
            query_id.to_string(),
            Box::new(move || {
                controller.abort_with_reason(&JsValue::from_str("Query was canceled"));
            }),
        );
    }
    opts.set_method("POST");
    let body = format!("update={}", js_sys::encode_uri_component(query));
    opts.set_body(&JsString::from_str(&body).unwrap());
    let request = Request::new_with_str_and_init(url, &opts).unwrap();
    request
        .headers()
        .set("Content-Type", "application/x-www-form-urlencoded")
        .unwrap();
    if let Some(access_token) = access_token {
        request
            .headers()
            .set("Authorization", &format!("Bearer {access_token}"))
            .unwrap();
    }
    request
        .headers()
        .set("Accept", "application/sparql-results+json")
        .unwrap();

    let worker_global: WorkerGlobalScope = js_sys::global().unchecked_into();

    // Perform the fetch request and await the response
    let resp_value = JsFuture::from(worker_global.fetch_with_request(&request))
        .await
        .map_err(|err| {
            let was_canceled = err
                .dyn_ref::<web_sys::DomException>()
                .map(|e| e.name() == "AbortError")
                .unwrap_or(false);
            if was_canceled {
                SparqlRequestError::_Canceled(CanceledError {
                    query: query.to_string(),
                })
            } else {
                SparqlRequestError::Connection(ConnectionError {
                    status_text: format!("{err:?}"),
                    query: query.to_string(),
                })
            }
        })?;

    // Cast the response value to a Response object
    let resp: Response = resp_value.dyn_into().unwrap();

    // Check if the response status is OK (200-299)
    if !resp.ok() {
        return match resp.json() {
            Ok(json) => match JsFuture::from(json).await {
                Ok(js_value) => match serde_wasm_bindgen::from_value(js_value) {
                    Ok(err) => Err(SparqlRequestError::QLeverException(err)),
                    Err(err) => Err(SparqlRequestError::Deserialization(format!(
                        "Could not deserialize error message: {}",
                        err
                    ))),
                },
                Err(err) => Err(SparqlRequestError::Deserialization(format!(
                    "Query failed! Response did not provide a json body but this could not be cast to rust JsValue.\n{:?}",
                    err
                ))),
            },
            Err(err) => Err(SparqlRequestError::Deserialization(format!(
                "Query failed! Response did not provide a json body.\n{err:?}"
            ))),
        };
    }

    let text = read_reponse_body_as_text(resp).await?;

    Ok(serde_json::from_str(&text)
        .map_err(|err| SparqlRequestError::Deserialization(err.to_string()))?)
}

pub(crate) async fn execute_query(
    server_rc: Rc<Mutex<Server>>,
    url: String,
    query: String,
    query_id: Option<&str>,
    engine: Option<SparqlEngine>,
    timeout_ms: Option<u32>,
    method: RequestMethod,
    limit: Option<usize>,
    offset: usize,
    lazy: bool,
) -> Result<Option<SparqlResult>, SparqlRequestError> {
    use js_sys::JsString;
    use std::str::FromStr;
    use wasm_bindgen::JsCast;
    use wasm_bindgen_futures::JsFuture;
    use web_sys::{AbortSignal, Request, RequestInit, Response, WorkerGlobalScope};

    use lazy_sparql_result_reader::parser::PartialResult;

    let opts = RequestInit::new();
    if let Some(timeout_ms) = timeout_ms {
        opts.set_signal(Some(&AbortSignal::timeout_with_u32(timeout_ms)));
    } else if let Some(query_id) = query_id {
        let controller = AbortController::new().expect("AbortController should be creatable");

        opts.set_signal(Some(&controller.signal()));
        server_rc.lock().await.state.add_running_request(
            query_id.to_string(),
            Box::new(move || {
                controller.abort_with_reason(&JsValue::from_str("Query was canceled"));
            }),
        );
    }

    let request = match (&method, engine) {
        (RequestMethod::GET, _) => {
            opts.set_method("GET");
            Request::new_with_str_and_init(&format!("{url}?query={}", encode(&query)), &opts)
                .unwrap()
        }
        (RequestMethod::POST, Some(SparqlEngine::QLever)) => {
            opts.set_method("POST");
            // FIXME: Here the send limit is hardcoded to 10000
            // this is due to the internal batching of QLever
            // A lower send limit causes QLever not imediatly sending the result.
            let body = format!("send=10000&query={}", js_sys::encode_uri_component(&query));
            opts.set_body(&JsString::from_str(&body).unwrap());
            let request = Request::new_with_str_and_init(&url, &opts).unwrap();
            request
                .headers()
                .set("Content-Type", "application/x-www-form-urlencoded")
                .unwrap();
            if let Some(id) = query_id {
                request.headers().set("Query-Id", id).unwrap();
            }
            request
        }
        (RequestMethod::POST, _) => {
            opts.set_method("POST");
            opts.set_body(&JsString::from_str(&query).unwrap());
            let request = Request::new_with_str_and_init(&url, &opts).unwrap();
            request
                .headers()
                .set("Content-Type", "application/sparql-query")
                .unwrap();
            request
        }
    };
    request
        .headers()
        .set("Accept", "application/sparql-results+json")
        .unwrap();

    // Currently blocked by CORS...
    // request.headers().set("User-Agent", "qlue-ls/1.0").unwrap();

    // Get global worker scope
    let worker_global: WorkerGlobalScope = js_sys::global().unchecked_into();

    // Perform the fetch request and await the response
    let resp_value = JsFuture::from(worker_global.fetch_with_request(&request))
        .await
        .map_err(|err| {
            let was_canceled = err
                .dyn_ref::<web_sys::DomException>()
                .map(|e| e.name() == "AbortError")
                .unwrap_or(false);
            if was_canceled {
                SparqlRequestError::_Canceled(CanceledError {
                    query: query.to_string(),
                })
            } else {
                SparqlRequestError::Connection(ConnectionError {
                    status_text: format!("{err:?}"),
                    query: query.to_string(),
                })
            }
        })?;

    // Cast the response value to a Response object
    let resp: Response = resp_value.dyn_into().unwrap();

    // Check if the response status is OK (200-299)
    if !resp.ok() {
        return match resp.json() {
            Ok(json) => match JsFuture::from(json).await {
                Ok(js_value) => match serde_wasm_bindgen::from_value(js_value) {
                    Ok(err) => Err(SparqlRequestError::QLeverException(err)),
                    Err(err) => Err(SparqlRequestError::Deserialization(format!(
                        "Could not deserialize error message: {}",
                        err
                    ))),
                },
                Err(err) => Err(SparqlRequestError::Deserialization(format!(
                    "Query failed! Response did not provide a json body but this could not be cast to rust JsValue.\n{:?}",
                    err
                ))),
            },
            Err(err) => Err(SparqlRequestError::Deserialization(format!(
                "Query failed! Response did not provide a json body.\n{err:?}"
            ))),
        };
    }
    if lazy {
        if let Err(err) = lazy_sparql_result_reader::read(
            resp.body().unwrap(),
            1000,
            limit,
            offset,
            async |mut partial_result: PartialResult| {
                let server = server_rc.lock().await;
                compress_result_uris(&*server, &mut partial_result);
                if let Err(err) =
                    server.send_message(PartialSparqlResultNotification::new(partial_result))
                {
                    log::error!(
                        "Could not send Partial-Sparql-Result-Notification:\n{:?}",
                        err
                    );
                }
            },
        )
        .await
        {
            match err {
                lazy_sparql_result_reader::SparqlResultReaderError::CorruptStream
                | lazy_sparql_result_reader::SparqlResultReaderError::JsonParseError(_) => {
                    Err(SparqlRequestError::Deserialization(format!("{err:?}")))
                }
                lazy_sparql_result_reader::SparqlResultReaderError::Canceled => {
                    Err(SparqlRequestError::_Canceled(CanceledError {
                        query: query.to_string(),
                    }))
                }
            }
        } else {
            Ok(None)
        }
    } else {
        // Get the response body as text and await it
        let text = read_reponse_body_as_text(resp).await?;
        // Return the text as a JsValue
        let result = serde_json::from_str(&text)
            .map_err(|err| SparqlRequestError::Deserialization(err.to_string()))?;
        Ok(Some(result))
    }
}

async fn read_reponse_body_as_text(response: Response) -> Result<String, SparqlRequestError> {
    JsFuture::from(
        response.text().map_err(|err| {
            SparqlRequestError::Response(format!("Response has no text:\n{:?}", err))
        })?,
    )
    .await
    .map_err(|err| {
        SparqlRequestError::Response(format!("Could not read Response text:\n{:?}", err))
    })?
    .as_string()
    .ok_or(SparqlRequestError::Response(
        "Could not read response body as utf-8 string".to_string(),
    ))
}

fn compress_result_uris(server: &Server, partial_result: &mut PartialResult) {
    use lazy_sparql_result_reader::sparql::RDFValue;
    if let PartialResult::Bindings(bindings) = partial_result {
        for binding in bindings.iter_mut() {
            for (_, rdf_term) in binding.0.iter_mut() {
                if let RDFValue::Uri { value, curie } = rdf_term {
                    *curie = server
                        .state
                        .get_default_converter()
                        .and_then(|converer| converer.compress(value).ok());
                }
            }
        }
    }
}

pub(crate) async fn check_server_availability(url: &str) -> bool {
    use wasm_bindgen::JsCast;
    use wasm_bindgen_futures::JsFuture;
    use web_sys::{Request, RequestInit, RequestMode, Response, WorkerGlobalScope};

    let worker_global: WorkerGlobalScope = js_sys::global().unchecked_into();
    let opts = RequestInit::new();
    opts.set_method("GET");
    opts.set_mode(RequestMode::Cors);
    let request = Request::new_with_str_and_init(url, &opts).expect("Failed to create request");
    let resp_value = match JsFuture::from(worker_global.fetch_with_request(&request)).await {
        Ok(resp) => resp,
        Err(_) => return false,
    };
    let resp: Response = resp_value.dyn_into().unwrap();
    resp.ok()
}