Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lblod/mu-auth-sudo
NPM Library providing a SPARQL client to execute queries that overrule the access rights
https://github.com/lblod/mu-auth-sudo
Last synced: 23 days ago
JSON representation
NPM Library providing a SPARQL client to execute queries that overrule the access rights
- Host: GitHub
- URL: https://github.com/lblod/mu-auth-sudo
- Owner: lblod
- License: mit
- Created: 2019-02-15T10:43:00.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-26T15:11:06.000Z (about 1 month ago)
- Last Synced: 2024-11-26T16:22:58.331Z (about 1 month ago)
- Language: JavaScript
- Homepage:
- Size: 611 KB
- Stars: 0
- Watchers: 8
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# mu-auth-sudo
NPM package for a SPARQL client for mu.semte.ch that overrules access rights in queries through a mu-auth-sudo header.
## Usage
```
npm install @lblod/mu-auth-sudo
```
Include the following in your code
```
import { querySudo as query, updateSudo as update } from '@lblod/mu-auth-sudo';
//Examples
// To run a regular query
const queryString = `SELECT * FROM { GRAPH ?g { ?s ?p ?o. } } LIMIT 1`;
await query(queryString);
// To pass extra headers
const updateString = `INSERT DATA { GRAPH { . } }`;
const extraHeaders = { 'mu-call-scope-id': 'http://foo/bar', 'other-info'; 'hello' };
await update(updateString, extraHeaders);
// With custom connection options (this should be exceptional, make sure you know what you're doing)
const connectionOptions = { sparqlEndpoint: 'http://the.custom.endpoint/sparql', mayRetry: true };
await update(updateString, extraHeaders, connectionOptions);
```
## Logging
The verbosity of logging can be configured as in the [javascript template](https://github.com/mu-semtech/mu-javascript-template/blob/6ff43eaf51856783c6946e82344e31a3348ce4a3/README.md#logging) through following environment variables:
- `LOG_SPARQL_ALL`: Logging of all executed SPARQL queries, read as well as update (default `true`)
- `LOG_SPARQL_QUERIES`: Logging of executed SPARQL read queries (default: `undefined`). Overrules `LOG_SPARQL_ALL`.
- `LOG_SPARQL_UPDATES`: Logging of executed SPARQL update queries (default `undefined`). Overrules `LOG_SPARQL_ALL`.
- `DEBUG_AUTH_HEADERS`: Debugging of [mu-authorization](https://github.com/mu-semtech/mu-authorization) access-control related headers (default `true`)
Following values are considered true: [`"true"`, `"TRUE"`, `"1"`].
## Retrying
You can tweak system-wide retry parameters. These should be considered internal, but tweaking them may help in extreme scenarios. Use with extreme caution.
- `SUDO_QUERY_RETRY`: System-wide configuration to enable the retry-mechanism (default `'false'`).
Warning: this overules eventual source-code specifications (i.e. `connectionOptions = { mayRetry: false }`), so make sure you know what you're doing.
- `SUDO_QUERY_RETRY_MAX_ATTEMPTS`: Specfiy the number of max retry attempts (default: 5)
- `SUDO_QUERY_RETRY_FOR_HTTP_STATUS_CODES`: Specify what returned HTTP status from the database are allowed for retry. (default: `''`). Overriding this list should be considered case by case.
- `SUDO_QUERY_RETRY_FOR_CONNECTION_ERRORS`: Specify what connection errors are allowed for retry. (default: `'ECONNRESET,ETIMEDOUT,EAI_AGAIN'`)
- `SUDO_QUERY_RETRY_TIMEOUT_INCREMENT_FACTOR`: Specify the factor applied to the timeout before the next attempt. Check implementation to see how it is calculated. (default: `'0.3'`)