@comunica/actor-optimize-query-operation-prune-empty-source-operations 3.0.1-alpha.43.0

package/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright © 2017–now Ruben Taelman, Joachim Van Herwegen
+Comunica Association and Ghent University – imec, Belgium
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,43 @@
+# Comunica Prune Empty Source Operations Optimize Query Operation Actor
+
+[![npm version](https://badge.fury.io/js/%40comunica%2Factor-optimize-query-operation-prune-empty-source-operations.svg)](https://www.npmjs.com/package/@comunica/actor-optimize-query-operation-prune-empty-source-operations)
+
+An [Optimize Query Operation](https://github.com/comunica/comunica/tree/master/packages/bus-optimize-query-operation) actor
+that removes operations from the query plan that are guaranteed to produce empty results.
+This actor relies on source-based cardinality metadata,
+or may optionally make use of ASK queries if the source supports it.
+
+This module is part of the [Comunica framework](https://github.com/comunica/comunica),
+and should only be used by [developers that want to build their own query engine](https://comunica.dev/docs/modify/).
+
+[Click here if you just want to query with Comunica](https://comunica.dev/docs/query/).
+
+## Install
+
+```bash
+$ yarn add @comunica/actor-optimize-query-operation-prune-empty-source-operations
+```
+
+## Configure
+
+After installing, this package can be added to your engine's configuration as follows:
+```text
+{
+  "@context": [
+    ...
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-optimize-query-operation-prune-empty-source-operations/^1.0.0/components/context.jsonld"  
+  ],
+  "actors": [
+    ...
+    {
+      "@id": "urn:comunica:default:optimize-query-operation/actors#prune-empty-source-operations",
+      "@type": "ActorOptimizeQueryOperationPruneEmptySourceOperations",
+      "useAskIfSupported": false
+    }
+  ]
+}
+```
+
+### Config Parameters
+
+* `useAskIfSupported`: If true, ASK queries will be sent to the source instead of COUNT queries to check emptiness for patterns. This will only be done for sources that accept ASK queries. _(defaults to `false`)_

package/components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld

@@ -0,0 +1,186 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-optimize-query-operation-prune-empty-source-operations/^3.0.0/components/context.jsonld",
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/bus-optimize-query-operation/^3.0.0/components/context.jsonld",
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/core/^3.0.0/components/context.jsonld"
+  ],
+  "@id": "npmd:@comunica/actor-optimize-query-operation-prune-empty-source-operations",
+  "components": [
+    {
+      "@id": "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld#ActorOptimizeQueryOperationPruneEmptySourceOperations",
+      "@type": "Class",
+      "requireElement": "ActorOptimizeQueryOperationPruneEmptySourceOperations",
+      "extends": [
+        "cboqo:components/ActorOptimizeQueryOperation.jsonld#ActorOptimizeQueryOperation"
+      ],
+      "comment": "A comunica Prune Empty Source Operations Optimize Query Operation Actor.",
+      "parameters": [
+        {
+          "@id": "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld#ActorOptimizeQueryOperationPruneEmptySourceOperations_args_useAskIfSupported",
+          "range": "xsd:boolean",
+          "default": "false",
+          "comment": "If true, ASK queries will be sent to the source instead of COUNT queries to check emptiness for patterns. This will only be done for sources that accept ASK queries."
+        },
+        {
+          "@id": "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld#ActorOptimizeQueryOperationPruneEmptySourceOperations_args_name",
+          "range": "xsd:string",
+          "default": {
+            "@id": "rdf:subject"
+          },
+          "comment": "The name for this actor."
+        },
+        {
+          "@id": "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld#ActorOptimizeQueryOperationPruneEmptySourceOperations_args_bus",
+          "range": {
+            "@type": "ParameterRangeGenericComponent",
+            "component": "cc:components/Bus.jsonld#Bus",
+            "genericTypeInstances": [
+              {
+                "@type": "ParameterRangeGenericComponent",
+                "component": "cc:components/Actor.jsonld#Actor",
+                "genericTypeInstances": [
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^3.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+                  },
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^3.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+                  },
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^3.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+                  }
+                ]
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^3.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^3.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^3.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+              }
+            ]
+          },
+          "default": {
+            "@id": "cboqo:components/ActorOptimizeQueryOperation.jsonld#ActorOptimizeQueryOperation_default_bus",
+            "@type": "cc:components/Bus.jsonld#Bus"
+          },
+          "comment": "The bus this actor subscribes to."
+        },
+        {
+          "@id": "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld#ActorOptimizeQueryOperationPruneEmptySourceOperations_args_beforeActors",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              {
+                "@type": "ParameterRangeArray",
+                "parameterRangeValue": {
+                  "@type": "ParameterRangeGenericComponent",
+                  "component": "cc:components/Actor.jsonld#Actor",
+                  "genericTypeInstances": [
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^3.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+                    },
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^3.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+                    },
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^3.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+                    }
+                  ]
+                }
+              },
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "comment": "Actor that must be registered in the bus before this actor."
+        }
+      ],
+      "memberFields": [
+        {
+          "@id": "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld#ActorOptimizeQueryOperationPruneEmptySourceOperations__member_useAskIfSupported",
+          "memberFieldName": "useAskIfSupported"
+        },
+        {
+          "@id": "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld#ActorOptimizeQueryOperationPruneEmptySourceOperations__member_constructor",
+          "memberFieldName": "constructor"
+        },
+        {
+          "@id": "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld#ActorOptimizeQueryOperationPruneEmptySourceOperations__member_test",
+          "memberFieldName": "test"
+        },
+        {
+          "@id": "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld#ActorOptimizeQueryOperationPruneEmptySourceOperations__member_run",
+          "memberFieldName": "run"
+        },
+        {
+          "@id": "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld#ActorOptimizeQueryOperationPruneEmptySourceOperations__member_collectMultiOperationInputs",
+          "memberFieldName": "collectMultiOperationInputs"
+        },
+        {
+          "@id": "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld#ActorOptimizeQueryOperationPruneEmptySourceOperations__member_mapMultiOperation",
+          "memberFieldName": "mapMultiOperation"
+        },
+        {
+          "@id": "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld#ActorOptimizeQueryOperationPruneEmptySourceOperations__member_hasSourceResults",
+          "memberFieldName": "hasSourceResults"
+        }
+      ],
+      "constructorArguments": [
+        {
+          "@id": "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld#ActorOptimizeQueryOperationPruneEmptySourceOperations_args__constructorArgument",
+          "fields": [
+            {
+              "keyRaw": "useAskIfSupported",
+              "value": {
+                "@id": "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld#ActorOptimizeQueryOperationPruneEmptySourceOperations_args_useAskIfSupported"
+              }
+            },
+            {
+              "keyRaw": "name",
+              "value": {
+                "@id": "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld#ActorOptimizeQueryOperationPruneEmptySourceOperations_args_name"
+              }
+            },
+            {
+              "keyRaw": "bus",
+              "value": {
+                "@id": "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld#ActorOptimizeQueryOperationPruneEmptySourceOperations_args_bus"
+              }
+            },
+            {
+              "keyRaw": "beforeActors",
+              "value": {
+                "@id": "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld#ActorOptimizeQueryOperationPruneEmptySourceOperations_args_beforeActors"
+              }
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "@id": "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld#IActorOptimizeQueryOperationPruneEmptySourceOperationsArgs",
+      "@type": "AbstractClass",
+      "requireElement": "IActorOptimizeQueryOperationPruneEmptySourceOperationsArgs",
+      "parameters": [],
+      "memberFields": [
+        {
+          "@id": "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld#IActorOptimizeQueryOperationPruneEmptySourceOperationsArgs__member_useAskIfSupported",
+          "memberFieldName": "useAskIfSupported"
+        }
+      ],
+      "constructorArguments": []
+    }
+  ]
+}

package/components/components.jsonld

@@ -0,0 +1,11 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-optimize-query-operation-prune-empty-source-operations/^3.0.0/components/context.jsonld"
+  ],
+  "@id": "npmd:@comunica/actor-optimize-query-operation-prune-empty-source-operations",
+  "@type": "Module",
+  "requireName": "@comunica/actor-optimize-query-operation-prune-empty-source-operations",
+  "import": [
+    "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld"
+  ]
+}

package/components/context.jsonld

@@ -0,0 +1,46 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^5.0.0/components/context.jsonld",
+    {
+      "npmd": "https://linkedsoftwaredependencies.org/bundles/npm/",
+      "caoqopeso": "npmd:@comunica/actor-optimize-query-operation-prune-empty-source-operations/^3.0.0/",
+      "ActorOptimizeQueryOperationPruneEmptySourceOperations": {
+        "@id": "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld#ActorOptimizeQueryOperationPruneEmptySourceOperations",
+        "@prefix": true,
+        "@context": {
+          "args_useAskIfSupported": {
+            "@id": "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld#ActorOptimizeQueryOperationPruneEmptySourceOperations_args_useAskIfSupported"
+          },
+          "args_name": {
+            "@id": "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld#ActorOptimizeQueryOperationPruneEmptySourceOperations_args_name"
+          },
+          "args_bus": {
+            "@id": "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld#ActorOptimizeQueryOperationPruneEmptySourceOperations_args_bus"
+          },
+          "args_beforeActors": {
+            "@id": "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld#ActorOptimizeQueryOperationPruneEmptySourceOperations_args_beforeActors",
+            "@container": "@list"
+          },
+          "useAskIfSupported": {
+            "@id": "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld#ActorOptimizeQueryOperationPruneEmptySourceOperations_args_useAskIfSupported"
+          },
+          "name": {
+            "@id": "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld#ActorOptimizeQueryOperationPruneEmptySourceOperations_args_name"
+          },
+          "bus": {
+            "@id": "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld#ActorOptimizeQueryOperationPruneEmptySourceOperations_args_bus"
+          },
+          "beforeActors": {
+            "@id": "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld#ActorOptimizeQueryOperationPruneEmptySourceOperations_args_beforeActors",
+            "@container": "@list"
+          }
+        }
+      },
+      "IActorOptimizeQueryOperationPruneEmptySourceOperationsArgs": {
+        "@id": "caoqopeso:components/ActorOptimizeQueryOperationPruneEmptySourceOperations.jsonld#IActorOptimizeQueryOperationPruneEmptySourceOperationsArgs",
+        "@prefix": true,
+        "@context": {}
+      }
+    }
+  ]
+}

package/lib/ActorOptimizeQueryOperationPruneEmptySourceOperations.d.ts

@@ -0,0 +1,34 @@
+import type { IActionOptimizeQueryOperation, IActorOptimizeQueryOperationOutput, IActorOptimizeQueryOperationArgs } from '@comunica/bus-optimize-query-operation';
+import { ActorOptimizeQueryOperation } from '@comunica/bus-optimize-query-operation';
+import type { IActorTest } from '@comunica/core';
+import type { IActionContext, IQuerySourceWrapper } from '@comunica/types';
+import { Algebra } from 'sparqlalgebrajs';
+/**
+ * A comunica Prune Empty Source Operations Optimize Query Operation Actor.
+ */
+export declare class ActorOptimizeQueryOperationPruneEmptySourceOperations extends ActorOptimizeQueryOperation {
+    private readonly useAskIfSupported;
+    constructor(args: IActorOptimizeQueryOperationPruneEmptySourceOperationsArgs);
+    test(action: IActionOptimizeQueryOperation): Promise<IActorTest>;
+    run(action: IActionOptimizeQueryOperation): Promise<IActorOptimizeQueryOperationOutput>;
+    protected collectMultiOperationInputs(inputs: Algebra.Operation[], collectedOperations: (Algebra.Pattern | Algebra.Link)[], inputType: (Algebra.Pattern | Algebra.Link)['type']): void;
+    protected mapMultiOperation<O extends Algebra.Union | Algebra.Alt>(operation: O, emptyOperations: Set<Algebra.Operation>, multiOperationFactory: (input: O['input']) => Algebra.Operation): {
+        result: Algebra.Operation;
+        recurse: boolean;
+    };
+    /**
+     * Check if the given query operation will produce at least one result in the given source.
+     * @param source A query source.
+     * @param input A query operation.
+     * @param context The query context.
+     */
+    hasSourceResults(source: IQuerySourceWrapper, input: Algebra.Operation, context: IActionContext): Promise<boolean>;
+}
+export interface IActorOptimizeQueryOperationPruneEmptySourceOperationsArgs extends IActorOptimizeQueryOperationArgs {
+    /**
+     * If true, ASK queries will be sent to the source instead of COUNT queries to check emptiness for patterns.
+     * This will only be done for sources that accept ASK queries.
+     * @default {false}
+     */
+    useAskIfSupported: boolean;
+}

package/lib/ActorOptimizeQueryOperationPruneEmptySourceOperations.js

@@ -0,0 +1,117 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActorOptimizeQueryOperationPruneEmptySourceOperations = void 0;
+const bus_optimize_query_operation_1 = require("@comunica/bus-optimize-query-operation");
+const bus_query_operation_1 = require("@comunica/bus-query-operation");
+const rdf_data_factory_1 = require("rdf-data-factory");
+const sparqlalgebrajs_1 = require("sparqlalgebrajs");
+const AF = new sparqlalgebrajs_1.Factory();
+const DF = new rdf_data_factory_1.DataFactory();
+/**
+ * A comunica Prune Empty Source Operations Optimize Query Operation Actor.
+ */
+class ActorOptimizeQueryOperationPruneEmptySourceOperations extends bus_optimize_query_operation_1.ActorOptimizeQueryOperation {
+    constructor(args) {
+        super(args);
+    }
+    async test(action) {
+        if (bus_query_operation_1.ActorQueryOperation.getOperationSource(action.operation)) {
+            throw new Error(`Actor ${this.name} does not work with top-level operation sources.`);
+        }
+        return true;
+    }
+    async run(action) {
+        let operation = action.operation;
+        // Collect all operations with source types
+        // Only consider unions of patterns or alts of links, since these are created during exhaustive source assignment.
+        const collectedOperations = [];
+        // eslint-disable-next-line @typescript-eslint/no-this-alias,consistent-this
+        const self = this;
+        sparqlalgebrajs_1.Util.recurseOperation(operation, {
+            [sparqlalgebrajs_1.Algebra.types.UNION](subOperation) {
+                self.collectMultiOperationInputs(subOperation.input, collectedOperations, sparqlalgebrajs_1.Algebra.types.PATTERN);
+                return true;
+            },
+            [sparqlalgebrajs_1.Algebra.types.ALT](subOperation) {
+                self.collectMultiOperationInputs(subOperation.input, collectedOperations, sparqlalgebrajs_1.Algebra.types.LINK);
+                return false;
+            },
+            [sparqlalgebrajs_1.Algebra.types.SERVICE](subOperation) {
+                return false;
+            },
+        });
+        // Determine in an async manner whether or not these sources return non-empty results
+        const emptyOperations = new Set();
+        await Promise.all(collectedOperations.map(async (collectedOperation) => {
+            const checkOperation = collectedOperation.type === 'link' ?
+                AF.createPattern(DF.variable('?s'), collectedOperation.iri, DF.variable('?o')) :
+                collectedOperation;
+            if (!await this.hasSourceResults(bus_query_operation_1.ActorQueryOperation.getOperationSource(collectedOperation), checkOperation, action.context)) {
+                emptyOperations.add(collectedOperation);
+            }
+        }));
+        // Only perform next mapping if we have at least one empty operation
+        this.logDebug(action.context, `Pruning ${emptyOperations.size} source-specific operations`);
+        if (emptyOperations.size > 0) {
+            // Rewrite operations by removing the empty children
+            operation = sparqlalgebrajs_1.Util.mapOperation(operation, {
+                [sparqlalgebrajs_1.Algebra.types.UNION](subOperation, factory) {
+                    return self.mapMultiOperation(subOperation, emptyOperations, children => factory.createUnion(children));
+                },
+                [sparqlalgebrajs_1.Algebra.types.ALT](subOperation, factory) {
+                    return self.mapMultiOperation(subOperation, emptyOperations, children => factory.createAlt(children));
+                },
+            });
+        }
+        return { operation, context: action.context };
+    }
+    collectMultiOperationInputs(inputs, collectedOperations, inputType) {
+        for (const input of inputs) {
+            if (bus_query_operation_1.ActorQueryOperation.getOperationSource(input) && input.type === inputType) {
+                collectedOperations.push(input);
+            }
+        }
+    }
+    mapMultiOperation(operation, emptyOperations, multiOperationFactory) {
+        // Determine which operations return non-empty results
+        const nonEmptyInputs = operation.input.filter(input => !emptyOperations.has(input));
+        // Remove empty operations
+        if (nonEmptyInputs.length === operation.input.length) {
+            return { result: operation, recurse: true };
+        }
+        if (nonEmptyInputs.length === 0) {
+            return { result: multiOperationFactory([]), recurse: false };
+        }
+        if (nonEmptyInputs.length === 1) {
+            return { result: nonEmptyInputs[0], recurse: true };
+        }
+        return { result: multiOperationFactory(nonEmptyInputs), recurse: true };
+    }
+    /**
+     * Check if the given query operation will produce at least one result in the given source.
+     * @param source A query source.
+     * @param input A query operation.
+     * @param context The query context.
+     */
+    async hasSourceResults(source, input, context) {
+        // Send an ASK query
+        if (this.useAskIfSupported) {
+            const askOperation = AF.createAsk(input);
+            if (bus_query_operation_1.ActorQueryOperation
+                .doesShapeAcceptOperation(await source.source.getSelectorShape(context), askOperation)) {
+                return source.source.queryBoolean(askOperation, context);
+            }
+        }
+        // Send the operation as-is and check the response cardinality
+        const bindingsStream = source.source.queryBindings(input, context);
+        return new Promise((resolve, reject) => {
+            bindingsStream.on('error', reject);
+            bindingsStream.getProperty('metadata', (metadata) => {
+                bindingsStream.destroy();
+                resolve(metadata.cardinality.value > 0);
+            });
+        });
+    }
+}
+exports.ActorOptimizeQueryOperationPruneEmptySourceOperations = ActorOptimizeQueryOperationPruneEmptySourceOperations;
+//# sourceMappingURL=ActorOptimizeQueryOperationPruneEmptySourceOperations.js.map

package/lib/ActorOptimizeQueryOperationPruneEmptySourceOperations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActorOptimizeQueryOperationPruneEmptySourceOperations.js","sourceRoot":"","sources":["ActorOptimizeQueryOperationPruneEmptySourceOperations.ts"],"names":[],"mappings":";;;AAEA,yFAAqF;AACrF,uEAAoE;AAGpE,uDAA+C;AAC/C,qDAAyD;AAEzD,MAAM,EAAE,GAAG,IAAI,yBAAO,EAAE,CAAC;AACzB,MAAM,EAAE,GAAG,IAAI,8BAAW,EAAE,CAAC;AAE7B;;GAEG;AACH,MAAa,qDAAsD,SAAQ,0DAA2B;IAGpG,YAAmB,IAAgE;QACjF,KAAK,CAAC,IAAI,CAAC,CAAC;IACd,CAAC;IAEM,KAAK,CAAC,IAAI,CAAC,MAAqC;QACrD,IAAI,yCAAmB,CAAC,kBAAkB,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE;YAC5D,MAAM,IAAI,KAAK,CAAC,SAAS,IAAI,CAAC,IAAI,kDAAkD,CAAC,CAAC;SACvF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,MAAqC;QACpD,IAAI,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QAEjC,2CAA2C;QAC3C,kHAAkH;QAClH,MAAM,mBAAmB,GAAuC,EAAE,CAAC;QACnE,4EAA4E;QAC5E,MAAM,IAAI,GAAG,IAAI,CAAC;QAClB,sBAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE;YAC/B,CAAC,yBAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,YAAY;gBAChC,IAAI,CAAC,2BAA2B,CAAC,YAAY,CAAC,KAAK,EAAE,mBAAmB,EAAE,yBAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBACjG,OAAO,IAAI,CAAC;YACd,CAAC;YACD,CAAC,yBAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,YAAY;gBAC9B,IAAI,CAAC,2BAA2B,CAAC,YAAY,CAAC,KAAK,EAAE,mBAAmB,EAAE,yBAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAC9F,OAAO,KAAK,CAAC;YACf,CAAC;YACD,CAAC,yBAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,YAAY;gBAClC,OAAO,KAAK,CAAC;YACf,CAAC;SACF,CAAC,CAAC;QAEH,qFAAqF;QACrF,MAAM,eAAe,GAA2B,IAAI,GAAG,EAAE,CAAC;QAC1D,MAAM,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,GAAG,CAAC,KAAK,EAAC,kBAAkB,EAAC,EAAE;YACnE,MAAM,cAAc,GAAG,kBAAkB,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC;gBACzD,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,kBAAkB,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBAChF,kBAAkB,CAAC;YACrB,IAAI,CAAC,MAAM,IAAI,CAAC,gBAAgB,CAC9B,yCAAmB,CAAC,kBAAkB,CAAC,kBAAkB,CAAE,EAC3D,cAAc,EACd,MAAM,CAAC,OAAO,CACf,EAAE;gBACD,eAAe,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;aACzC;QACH,CAAC,CAAC,CAAC,CAAC;QAEJ,oEAAoE;QACpE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,WAAW,eAAe,CAAC,IAAI,6BAA6B,CAAC,CAAC;QAC5F,IAAI,eAAe,CAAC,IAAI,GAAG,CAAC,EAAE;YAC5B,oDAAoD;YACpD,SAAS,GAAG,sBAAI,CAAC,YAAY,CAAC,SAAS,EAAE;gBACvC,CAAC,yBAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,YAAY,EAAE,OAAO;oBACzC,OAAO,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,eAAe,EAAE,QAAQ,CAAC,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAC1G,CAAC;gBACD,CAAC,yBAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,OAAO;oBACvC,OAAO,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,eAAe,EAAE,QAAQ,CAAC,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;gBACxG,CAAC;aACF,CAAC,CAAC;SACJ;QAED,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;IAChD,CAAC;IAES,2BAA2B,CACnC,MAA2B,EAC3B,mBAAuD,EACvD,SAAmD;QAEnD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;YAC1B,IAAI,yCAAmB,CAAC,kBAAkB,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE;gBAC7E,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACjC;SACF;IACH,CAAC;IAES,iBAAiB,CACzB,SAAY,EACZ,eAAuC,EACvC,qBAA+D;QAK/D,sDAAsD;QACtD,MAAM,cAAc,GAAG,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;QAEpF,0BAA0B;QAC1B,IAAI,cAAc,CAAC,MAAM,KAAK,SAAS,CAAC,KAAK,CAAC,MAAM,EAAE;YACpD,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;SAC7C;QACD,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE;YAC/B,OAAO,EAAE,MAAM,EAAE,qBAAqB,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;SAC9D;QACD,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE;YAC/B,OAAO,EAAE,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;SACrD;QACD,OAAO,EAAE,MAAM,EAAE,qBAAqB,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAC1E,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,gBAAgB,CAC3B,MAA2B,EAC3B,KAAwB,EACxB,OAAuB;QAEvB,oBAAoB;QACpB,IAAI,IAAI,CAAC,iBAAiB,EAAE;YAC1B,MAAM,YAAY,GAAG,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YACzC,IAAI,yCAAmB;iBACpB,wBAAwB,CAAC,MAAM,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC,EAAE;gBACxF,OAAO,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;aAC1D;SACF;QAED,8DAA8D;QAC9D,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACnE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YACnC,cAAc,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC,QAA0B,EAAE,EAAE;gBACpE,cAAc,CAAC,OAAO,EAAE,CAAC;gBACzB,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAtID,sHAsIC","sourcesContent":["import type { IActionOptimizeQueryOperation,\n  IActorOptimizeQueryOperationOutput, IActorOptimizeQueryOperationArgs } from '@comunica/bus-optimize-query-operation';\nimport { ActorOptimizeQueryOperation } from '@comunica/bus-optimize-query-operation';\nimport { ActorQueryOperation } from '@comunica/bus-query-operation';\nimport type { IActorTest } from '@comunica/core';\nimport type { IActionContext, IQuerySourceWrapper, MetadataBindings } from '@comunica/types';\nimport { DataFactory } from 'rdf-data-factory';\nimport { Algebra, Factory, Util } from 'sparqlalgebrajs';\n\nconst AF = new Factory();\nconst DF = new DataFactory();\n\n/**\n * A comunica Prune Empty Source Operations Optimize Query Operation Actor.\n */\nexport class ActorOptimizeQueryOperationPruneEmptySourceOperations extends ActorOptimizeQueryOperation {\n  private readonly useAskIfSupported: boolean;\n\n  public constructor(args: IActorOptimizeQueryOperationPruneEmptySourceOperationsArgs) {\n    super(args);\n  }\n\n  public async test(action: IActionOptimizeQueryOperation): Promise<IActorTest> {\n    if (ActorQueryOperation.getOperationSource(action.operation)) {\n      throw new Error(`Actor ${this.name} does not work with top-level operation sources.`);\n    }\n    return true;\n  }\n\n  public async run(action: IActionOptimizeQueryOperation): Promise<IActorOptimizeQueryOperationOutput> {\n    let operation = action.operation;\n\n    // Collect all operations with source types\n    // Only consider unions of patterns or alts of links, since these are created during exhaustive source assignment.\n    const collectedOperations: (Algebra.Pattern | Algebra.Link)[] = [];\n    // eslint-disable-next-line @typescript-eslint/no-this-alias,consistent-this\n    const self = this;\n    Util.recurseOperation(operation, {\n      [Algebra.types.UNION](subOperation) {\n        self.collectMultiOperationInputs(subOperation.input, collectedOperations, Algebra.types.PATTERN);\n        return true;\n      },\n      [Algebra.types.ALT](subOperation) {\n        self.collectMultiOperationInputs(subOperation.input, collectedOperations, Algebra.types.LINK);\n        return false;\n      },\n      [Algebra.types.SERVICE](subOperation) {\n        return false;\n      },\n    });\n\n    // Determine in an async manner whether or not these sources return non-empty results\n    const emptyOperations: Set<Algebra.Operation> = new Set();\n    await Promise.all(collectedOperations.map(async collectedOperation => {\n      const checkOperation = collectedOperation.type === 'link' ?\n        AF.createPattern(DF.variable('?s'), collectedOperation.iri, DF.variable('?o')) :\n        collectedOperation;\n      if (!await this.hasSourceResults(\n        ActorQueryOperation.getOperationSource(collectedOperation)!,\n        checkOperation,\n        action.context,\n      )) {\n        emptyOperations.add(collectedOperation);\n      }\n    }));\n\n    // Only perform next mapping if we have at least one empty operation\n    this.logDebug(action.context, `Pruning ${emptyOperations.size} source-specific operations`);\n    if (emptyOperations.size > 0) {\n      // Rewrite operations by removing the empty children\n      operation = Util.mapOperation(operation, {\n        [Algebra.types.UNION](subOperation, factory) {\n          return self.mapMultiOperation(subOperation, emptyOperations, children => factory.createUnion(children));\n        },\n        [Algebra.types.ALT](subOperation, factory) {\n          return self.mapMultiOperation(subOperation, emptyOperations, children => factory.createAlt(children));\n        },\n      });\n    }\n\n    return { operation, context: action.context };\n  }\n\n  protected collectMultiOperationInputs(\n    inputs: Algebra.Operation[],\n    collectedOperations: (Algebra.Pattern | Algebra.Link)[],\n    inputType: (Algebra.Pattern | Algebra.Link)['type'],\n  ): void {\n    for (const input of inputs) {\n      if (ActorQueryOperation.getOperationSource(input) && input.type === inputType) {\n        collectedOperations.push(input);\n      }\n    }\n  }\n\n  protected mapMultiOperation<O extends Algebra.Union | Algebra.Alt>(\n    operation: O,\n    emptyOperations: Set<Algebra.Operation>,\n    multiOperationFactory: (input: O['input']) => Algebra.Operation,\n  ): {\n      result: Algebra.Operation;\n      recurse: boolean;\n    } {\n    // Determine which operations return non-empty results\n    const nonEmptyInputs = operation.input.filter(input => !emptyOperations.has(input));\n\n    // Remove empty operations\n    if (nonEmptyInputs.length === operation.input.length) {\n      return { result: operation, recurse: true };\n    }\n    if (nonEmptyInputs.length === 0) {\n      return { result: multiOperationFactory([]), recurse: false };\n    }\n    if (nonEmptyInputs.length === 1) {\n      return { result: nonEmptyInputs[0], recurse: true };\n    }\n    return { result: multiOperationFactory(nonEmptyInputs), recurse: true };\n  }\n\n  /**\n   * Check if the given query operation will produce at least one result in the given source.\n   * @param source A query source.\n   * @param input A query operation.\n   * @param context The query context.\n   */\n  public async hasSourceResults(\n    source: IQuerySourceWrapper,\n    input: Algebra.Operation,\n    context: IActionContext,\n  ): Promise<boolean> {\n    // Send an ASK query\n    if (this.useAskIfSupported) {\n      const askOperation = AF.createAsk(input);\n      if (ActorQueryOperation\n        .doesShapeAcceptOperation(await source.source.getSelectorShape(context), askOperation)) {\n        return source.source.queryBoolean(askOperation, context);\n      }\n    }\n\n    // Send the operation as-is and check the response cardinality\n    const bindingsStream = source.source.queryBindings(input, context);\n    return new Promise((resolve, reject) => {\n      bindingsStream.on('error', reject);\n      bindingsStream.getProperty('metadata', (metadata: MetadataBindings) => {\n        bindingsStream.destroy();\n        resolve(metadata.cardinality.value > 0);\n      });\n    });\n  }\n}\n\nexport interface IActorOptimizeQueryOperationPruneEmptySourceOperationsArgs extends IActorOptimizeQueryOperationArgs {\n  /**\n   * If true, ASK queries will be sent to the source instead of COUNT queries to check emptiness for patterns.\n   * This will only be done for sources that accept ASK queries.\n   * @default {false}\n   */\n  useAskIfSupported: boolean;\n}\n"]}

package/lib/index.d.ts

@@ -0,0 +1 @@
+export * from './ActorOptimizeQueryOperationPruneEmptySourceOperations';

package/lib/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ActorOptimizeQueryOperationPruneEmptySourceOperations"), exports);
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0FAAwE","sourcesContent":["export * from './ActorOptimizeQueryOperationPruneEmptySourceOperations';\n"]}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@comunica/actor-optimize-query-operation-prune-empty-source-operations",
+  "version": "3.0.1-alpha.43.0",
+  "description": "A prune-empty-source-operations optimize-query-operation actor",
+  "lsd:module": true,
+  "main": "lib/index.js",
+  "typings": "lib/index",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/comunica/comunica.git",
+    "directory": "packages/actor-optimize-query-operation-prune-empty-source-operations"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "sideEffects": false,
+  "keywords": [
+    "comunica",
+    "actor",
+    "optimize-query-operation",
+    "prune-empty-source-operations"
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/comunica/comunica/issues"
+  },
+  "homepage": "https://comunica.dev/",
+  "files": [
+    "components",
+    "lib/**/*.d.ts",
+    "lib/**/*.js",
+    "lib/**/*.js.map"
+  ],
+  "dependencies": {
+    "@comunica/bus-optimize-query-operation": "3.0.1-alpha.43.0",
+    "@comunica/bus-query-operation": "3.0.1-alpha.43.0",
+    "@comunica/core": "3.0.1-alpha.43.0",
+    "@comunica/types": "3.0.1-alpha.43.0",
+    "rdf-data-factory": "^1.1.2",
+    "sparqlalgebrajs": "^4.3.3"
+  },
+  "scripts": {
+    "build": "npm run build:ts && npm run build:components",
+    "build:ts": "node \"../../node_modules/typescript/bin/tsc\"",
+    "build:components": "componentsjs-generator"
+  },
+  "gitHead": "d11e44cf07d4699f9d2c51d5851b5ed443de1997"
+}