@lde/sparql-qlever 0.16.3 → 0.18.0

package/dist/createQlever.d.ts

@@ -36,12 +36,22 @@ export type QleverOptions = {
     containerName: string;
 } | {
     mode: 'native';
+} | {
+    /**
+     * Run QLever in another container of the same pod, such as a sidecar
+     * with its own memory limit, through the task agent of
+     * `@lde/task-runner-http`. Both containers mount `dataDir` at the same
+     * path.
+     */
+    mode: 'remote';
+    /** Absolute, and the same path in both containers. */
+    dataDir: string;
 });
 /**
  * Create a paired QLever {@link Importer} and {@link Server} that share a
  * single {@link TaskRunner}. In pipeline setups the importer and server must
- * use the same runner (and therefore the same Docker container or working
- * directory) so that the server can serve the index the importer built.
+ * use the same runner (and therefore the same Docker container, sidecar or
+ * working directory) so that the server can serve the index the importer built.
  */
 export declare function createQlever(options: QleverOptions): {
     importer: Importer;

package/dist/createQlever.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createQlever.d.ts","sourceRoot":"","sources":["../src/createQlever.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,UAAU,EAEX,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAC7D,OAAO,EAAE,mBAAmB,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAE1D,MAAM,MAAM,aAAa,GAAG;IAC1B,wDAAwD;IACxD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oBAAoB;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,6FAA6F;IAC7F,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,mDAAmD;IACnD,YAAY,CAAC,EAAE,kBAAkB,CAAC;IAClC,sDAAsD;IACtD,aAAa,CAAC,EAAE,mBAAmB,CAAC;CACrC,GAAG,CACA;IACE,IAAI,EAAE,QAAQ,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,KAAK,CAAC;CACjB,GACD;IACE,IAAI,EAAE,QAAQ,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd;;;;;;;;OAQG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB,yEAAyE;IACzE,aAAa,EAAE,MAAM,CAAC;CACvB,GACD;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CACrB,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,aAAa;;;EAoClD"}
+{"version":3,"file":"createQlever.d.ts","sourceRoot":"","sources":["../src/createQlever.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,UAAU,EAEX,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAC7D,OAAO,EAAE,mBAAmB,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAE1D,MAAM,MAAM,aAAa,GAAG;IAC1B,wDAAwD;IACxD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oBAAoB;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,6FAA6F;IAC7F,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,mDAAmD;IACnD,YAAY,CAAC,EAAE,kBAAkB,CAAC;IAClC,sDAAsD;IACtD,aAAa,CAAC,EAAE,mBAAmB,CAAC;CACrC,GAAG,CACA;IACE,IAAI,EAAE,QAAQ,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,KAAK,CAAC;CACjB,GACD;IACE,IAAI,EAAE,QAAQ,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd;;;;;;;;OAQG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB,yEAAyE;IACzE,aAAa,EAAE,MAAM,CAAC;CACvB,GACD;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,GAClB;IACE;;;;;OAKG;IACH,IAAI,EAAE,QAAQ,CAAC;IACf,sDAAsD;IACtD,OAAO,EAAE,MAAM,CAAC;CACjB,CACJ,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,aAAa;;;EAsClD"}

package/dist/createQlever.js

@@ -1,4 +1,5 @@
 import { DockerTaskRunner } from '@lde/task-runner-docker';
+import { HttpTaskRunner } from '@lde/task-runner-http';
 import { NativeTaskRunner } from '@lde/task-runner-native';
 import { LastModifiedDownloader, } from '@lde/distribution-downloader';
 import { Importer } from './importer.js';
@@ -6,8 +7,8 @@ import { Server } from './server.js';
 /**
  * Create a paired QLever {@link Importer} and {@link Server} that share a
  * single {@link TaskRunner}. In pipeline setups the importer and server must
- * use the same runner (and therefore the same Docker container or working
- * directory) so that the server can serve the index the importer built.
+ * use the same runner (and therefore the same Docker container, sidecar or
+ * working directory) so that the server can serve the index the importer built.
  */
 export function createQlever(options) {
     const port = options.port ?? 7001;
@@ -24,7 +25,9 @@ export function createQlever(options) {
             network: options.network,
             port: hostname ? undefined : port,
         })
-        : new NativeTaskRunner({ cwd: options.dataDir });
+        : options.mode === 'remote'
+            ? new HttpTaskRunner({ cwd: options.dataDir })
+            : new NativeTaskRunner({ cwd: options.dataDir });
     return {
         importer: new Importer({
             taskRunner,

package/dist/importer.d.ts

@@ -23,13 +23,16 @@ export declare class Importer implements ImporterInterface {
     import(distributions: Distribution[]): Promise<NotSupported | ImportSuccessful | ImportFailed>;
     private doImport;
     private parseTripleCount;
+    /** The QLever that built the index, from the `git-hash` in its metadata:
+     *  QLever has no releases, so the commit is its version. */
+    private parseEngine;
     private cacheInfoPath;
     /**
      * Check whether the cached index is still up to date.
      */
     private isIndexUpToDate;
-    /** Read the triple count from QLever's metadata file. */
-    private readTripleCount;
+    /** Read QLever's metadata file, or an empty string when there is none. */
+    private readMetadata;
     private writeCacheInfo;
     private index;
 }

package/dist/importer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"importer.d.ts","sourceRoot":"","sources":["../src/importer.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,IAAI,iBAAiB,EAC7B,eAAe,EACf,YAAY,EACZ,gBAAgB,EAChB,YAAY,EACb,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAyB,YAAY,EAAE,MAAM,cAAc,CAAC;AAOnE,MAAM,WAAW,kBAAkB;IACjC,oBAAoB;IACpB,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,yBAAyB;IACzB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,uEAAuE;IACvE,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oBAAoB;IACpB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,yJAAyJ;IACzJ,+BAA+B,CAAC,EAAE,OAAO,CAAC;CAC3C;AAED,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC5D,sBAAsB;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,kBAAkB,CAAC;CACpC;AAWD,qBAAa,QAAS,YAAW,iBAAiB;IAChD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAkB;gBAE9B,OAAO,EAAE,qBAAqB;IAa7B,MAAM,CACjB,aAAa,EAAE,YAAY,EAAE,GAC5B,OAAO,CAAC,YAAY,GAAG,gBAAgB,GAAG,YAAY,CAAC;YAqC5C,QAAQ;IA6DtB,OAAO,CAAC,gBAAgB;IAQxB,OAAO,CAAC,aAAa;IAIrB;;OAEG;YACW,eAAe;IA0B7B,yDAAyD;YAC3C,eAAe;YAaf,cAAc;YAKd,KAAK;CA8CpB"}
+{"version":3,"file":"importer.d.ts","sourceRoot":"","sources":["../src/importer.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,QAAQ,IAAI,iBAAiB,EAC7B,eAAe,EACf,YAAY,EACZ,gBAAgB,EAChB,YAAY,EACb,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAyB,YAAY,EAAE,MAAM,cAAc,CAAC;AAOnE,MAAM,WAAW,kBAAkB;IACjC,oBAAoB;IACpB,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,yBAAyB;IACzB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,uEAAuE;IACvE,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oBAAoB;IACpB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,yJAAyJ;IACzJ,+BAA+B,CAAC,EAAE,OAAO,CAAC;CAC3C;AAED,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC5D,sBAAsB;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,kBAAkB,CAAC;CACpC;AAWD,qBAAa,QAAS,YAAW,iBAAiB;IAChD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAkB;gBAE9B,OAAO,EAAE,qBAAqB;IAa7B,MAAM,CACjB,aAAa,EAAE,YAAY,EAAE,GAC5B,OAAO,CAAC,YAAY,GAAG,gBAAgB,GAAG,YAAY,CAAC;YAqC5C,QAAQ;IA0EtB,OAAO,CAAC,gBAAgB;IAQxB;gEAC4D;IAC5D,OAAO,CAAC,WAAW;IAKnB,OAAO,CAAC,aAAa;IAIrB;;OAEG;YACW,eAAe;IA0B7B,0EAA0E;YAC5D,YAAY;YAYZ,cAAc;YAKd,KAAK;CA8CpB"}

package/dist/importer.js

@@ -52,11 +52,12 @@ export class Importer {
     async doImport(distribution) {
         const { path: localFile, headers } = await this.options.downloader.download(distribution);
         if (await this.isIndexUpToDate(localFile)) {
-            const tripleCount = await this.readTripleCount(localFile);
+            const metadata = await this.readMetadata(localFile);
+            const tripleCount = this.parseTripleCount(metadata);
             if (tripleCount === 0) {
                 return new ImportFailed(distribution, 'Index is cached but contains 0 triples');
             }
-            return new ImportSuccessful(distribution, undefined, tripleCount);
+            return new ImportSuccessful(distribution, undefined, tripleCount, [], this.parseEngine(metadata));
         }
         let indexFile = localFile;
         let format;
@@ -91,7 +92,7 @@ export class Importer {
             return new ImportFailed(distribution, 'Indexed 0 triples from distribution');
         }
         await this.writeCacheInfo(localFile);
-        return new ImportSuccessful(distribution, undefined, tripleCount, warnings);
+        return new ImportSuccessful(distribution, undefined, tripleCount, warnings, this.parseEngine(logs));
     }
     parseTripleCount(logs) {
         // Extract num-triples.normal from the metadata JSON that the index
@@ -100,6 +101,12 @@ export class Importer {
         const match = logs.match(/"num-triples":\{[^}]*"normal":(\d+)/);
         return match ? Number(match[1]) : undefined;
     }
+    /** The QLever that built the index, from the `git-hash` in its metadata:
+     *  QLever has no releases, so the commit is its version. */
+    parseEngine(metadata) {
+        const match = metadata.match(/"git-hash"\s*:\s*"([0-9a-f]+)"/);
+        return match ? { name: 'QLever', version: match[1] } : undefined;
+    }
     cacheInfoPath(dataFile) {
         return join(dirname(dataFile), `${this.options.indexName}.cache-info.json`);
     }
@@ -129,15 +136,14 @@ export class Importer {
         }
         return true;
     }
-    /** Read the triple count from QLever's metadata file. */
-    async readTripleCount(dataFile) {
+    /** Read QLever's metadata file, or an empty string when there is none. */
+    async readMetadata(dataFile) {
         try {
             const metadataPath = join(dirname(dataFile), `${this.options.indexName}.meta-data.json`);
-            const raw = await readFile(metadataPath, 'utf-8');
-            return this.parseTripleCount(raw);
+            return await readFile(metadataPath, 'utf-8');
         }
         catch {
-            return undefined;
+            return '';
         }
     }
     async writeCacheInfo(dataFile) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lde/sparql-qlever",
-  "version": "0.16.3",
+  "version": "0.18.0",
   "repository": {
     "url": "git+https://github.com/ldelements/lde.git",
     "directory": "packages/sparql-qlever"
@@ -24,14 +24,15 @@
     "!**/*.tsbuildinfo"
   ],
   "dependencies": {
-    "@lde/dataset": "^0.7.10",
-    "@lde/distribution-downloader": "^0.6.10",
-    "@lde/sparql-importer": "^0.6.13",
-    "@lde/sparql-server": "^0.4.14",
-    "@lde/task-runner": "^0.2.16",
-    "@lde/task-runner-docker": "^0.3.2",
-    "@lde/task-runner-native": "^0.2.20",
-    "@lde/wait-for-sparql": "^0.2.18",
+    "@lde/dataset": "^0.8.0",
+    "@lde/distribution-downloader": "^0.7.0",
+    "@lde/sparql-importer": "^0.8.0",
+    "@lde/sparql-server": "^0.5.0",
+    "@lde/task-runner": "^0.3.0",
+    "@lde/task-runner-docker": "^0.4.0",
+    "@lde/task-runner-http": "^0.1.0",
+    "@lde/task-runner-native": "^0.3.0",
+    "@lde/wait-for-sparql": "^0.3.0",
     "rdf-parse": "^5.0.0",
     "rdf-serialize": "^5.1.0",
     "tslib": "^2.3.0",
@@ -40,5 +41,20 @@
   "devDependencies": {
     "@rdfjs/types": "^2.0.0",
     "@types/yauzl": "^3.4.0"
+  },
+  "nx": {
+    "targets": {
+      "test": {
+        "dependsOn": [
+          "^build",
+          {
+            "projects": [
+              "@lde/task-runner-http"
+            ],
+            "target": "docker:build"
+          }
+        ]
+      }
+    }
   }
 }