@comunica/actor-optimize-query-operation-group-sources 4.2.0 → 4.4.0

package/components/ActorOptimizeQueryOperationGroupSources.jsonld

@@ -155,6 +155,10 @@
         {
           "@id": "caoqogs:components/ActorOptimizeQueryOperationGroupSources.jsonld#ActorOptimizeQueryOperationGroupSources__member_moveSourceAnnotationUpwardsIfPossible",
           "memberFieldName": "moveSourceAnnotationUpwardsIfPossible"
+        },
+        {
+          "@id": "caoqogs:components/ActorOptimizeQueryOperationGroupSources.jsonld#ActorOptimizeQueryOperationGroupSources__member_isPossibleToMoveSourceAnnotationUpwards",
+          "memberFieldName": "isPossibleToMoveSourceAnnotationUpwards"
         }
       ],
       "constructorArguments": [

package/lib/ActorOptimizeQueryOperationGroupSources.d.ts

@@ -1,7 +1,7 @@
 import type { IActionOptimizeQueryOperation, IActorOptimizeQueryOperationOutput, IActorOptimizeQueryOperationArgs } from '@comunica/bus-optimize-query-operation';
 import { ActorOptimizeQueryOperation } from '@comunica/bus-optimize-query-operation';
 import type { IActorTest, TestResult } from '@comunica/core';
-import type { IActionContext, IQuerySourceWrapper } from '@comunica/types';
+import type { FragmentSelectorShape, IActionContext, IQuerySourceWrapper } from '@comunica/types';
 import { Algebra } from 'sparqlalgebrajs';
 /**
  * A comunica Group Sources Optimize Query Operation Actor.
@@ -34,4 +34,15 @@ export declare class ActorOptimizeQueryOperationGroupSources extends ActorOptimi
      * @param context The action context.
      */
     moveSourceAnnotationUpwardsIfPossible<O extends Algebra.Operation>(operation: O, inputs: Algebra.Operation[], source: IQuerySourceWrapper | undefined, context: IActionContext): Promise<O>;
+    /**
+     * Checks if it's possible to move the source annotation upwards using the following rules:
+     * - If the shape doesn't accept the operation, then it's not possible.
+     * - If it does and the operation does not contain extension functions or
+     *   comunica doesn't support them, then it's possible.
+     * - If comunica does support them, then it's possible only if the shape accepts the extension function expressions.
+     * @param operation A grouped operation consisting of all given input operations.
+     * @param shape The common source's shape.
+     * @param context The action context.
+     */
+    isPossibleToMoveSourceAnnotationUpwards<O extends Algebra.Operation>(operation: O, shape: FragmentSelectorShape, context: IActionContext): boolean;
 }

package/lib/ActorOptimizeQueryOperationGroupSources.js

@@ -41,11 +41,7 @@ class ActorOptimizeQueryOperationGroupSources extends bus_optimize_query_operati
             const groupedInput = await this.groupOperation(operation.input, context);
             if (groupedInput.metadata?.scopedSource) {
                 const source = (0, utils_query_operation_1.getOperationSource)(groupedInput);
-                if ((0, utils_query_operation_1.doesShapeAcceptOperation)(await source.source.getSelectorShape(context), operation)) {
-                    this.logDebug(context, `Hoist 1 source-specific operation into a single ${operation.type} operation for ${source.source.toString()}`);
-                    (0, utils_query_operation_1.removeOperationSource)(groupedInput);
-                    operation = (0, utils_query_operation_1.assignOperationSource)(operation, source);
-                }
+                operation = await this.moveSourceAnnotationUpwardsIfPossible(operation, [groupedInput], source, context);
             }
             return { ...operation, input: groupedInput };
         }
@@ -146,7 +142,7 @@ class ActorOptimizeQueryOperationGroupSources extends bus_optimize_query_operati
      * @param context The action context.
      */
     async moveSourceAnnotationUpwardsIfPossible(operation, inputs, source, context) {
-        if (source && (0, utils_query_operation_1.doesShapeAcceptOperation)(await source.source.getSelectorShape(context), operation)) {
+        if (source && this.isPossibleToMoveSourceAnnotationUpwards(operation, await source.source.getSelectorShape(context), context)) {
             this.logDebug(context, `Hoist ${inputs.length} source-specific operations into a single ${operation.type} operation for ${source.source.toString()}`);
             operation = (0, utils_query_operation_1.assignOperationSource)(operation, source);
             for (const input of inputs) {
@@ -155,6 +151,27 @@ class ActorOptimizeQueryOperationGroupSources extends bus_optimize_query_operati
         }
         return operation;
     }
+    /**
+     * Checks if it's possible to move the source annotation upwards using the following rules:
+     * - If the shape doesn't accept the operation, then it's not possible.
+     * - If it does and the operation does not contain extension functions or
+     *   comunica doesn't support them, then it's possible.
+     * - If comunica does support them, then it's possible only if the shape accepts the extension function expressions.
+     * @param operation A grouped operation consisting of all given input operations.
+     * @param shape The common source's shape.
+     * @param context The action context.
+     */
+    isPossibleToMoveSourceAnnotationUpwards(operation, shape, context) {
+        if ((0, utils_query_operation_1.doesShapeAcceptOperation)(shape, operation)) {
+            const extensionFunctions = context.get(context_entries_1.KeysInitQuery.extensionFunctions);
+            const expression = operation.expression;
+            if (!extensionFunctions || expression?.expressionType !== sparqlalgebrajs_1.Algebra.expressionTypes.NAMED ||
+                !(expression?.name.value in extensionFunctions) || (0, utils_query_operation_1.doesShapeAcceptOperation)(shape, expression)) {
+                return true;
+            }
+        }
+        return false;
+    }
 }
 exports.ActorOptimizeQueryOperationGroupSources = ActorOptimizeQueryOperationGroupSources;
 //# sourceMappingURL=ActorOptimizeQueryOperationGroupSources.js.map

package/lib/ActorOptimizeQueryOperationGroupSources.js.map

@@ -1 +1 @@
-{"version":3,"file":"ActorOptimizeQueryOperationGroupSources.js","sourceRoot":"","sources":["ActorOptimizeQueryOperationGroupSources.ts"],"names":[],"mappings":";;;AAKA,yFAAqF;AACrF,+DAA0D;AAE1D,yCAAwD;AAExD,2EAKyC;AACzC,qDAAmD;AAEnD;;GAEG;AACH,MAAa,uCAAwC,SAAQ,0DAA2B;IACtF,YAAmB,IAAsC;QACvD,KAAK,CAAC,IAAI,CAAC,CAAC;IACd,CAAC;IAEM,KAAK,CAAC,IAAI,CAAC,MAAqC;QACrD,IAAI,IAAA,0CAAkB,EAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YACzC,OAAO,IAAA,eAAQ,EAAC,SAAS,IAAI,CAAC,IAAI,kDAAkD,CAAC,CAAC;QACxF,CAAC;QACD,OAAO,IAAA,mBAAY,GAAE,CAAC;IACxB,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,MAAqC;QACpD,OAAO,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;IAC7G,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,cAAc,CAAC,SAA4B,EAAE,OAAuB;QAC/E,MAAM,WAAW,GAAwB,OAAO,CAAC,OAAO,CAAC,+BAAa,CAAC,WAAW,CAAC,CAAC;QACpF,MAAM,cAAc,GAAG,IAAI,yBAAO,CAAC,WAAW,CAAC,CAAC;QAEhD,4GAA4G;QAC5G,IAAI,IAAA,0CAAkB,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,OAAO,IAAI,SAAS,CAAC,EAAE,CAAC;YAC7D,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,+FAA+F;QAC/F,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YACpC,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YACzE,IAAI,YAAY,CAAC,QAAQ,EAAE,YAAY,EAAE,CAAC;gBACxC,MAAM,MAAM,GAA8C,IAAA,0CAAkB,EAAC,YAAY,CAAC,CAAC;gBAC3F,IAAI,IAAA,gDAAwB,EAAC,MAAM,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,EAAE,CAAC;oBACvF,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,mDAAmD,SAAS,CAAC,IAAI,kBAAkB,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;oBACtI,IAAA,6CAAqB,EAAC,YAAY,CAAC,CAAC;oBACpC,SAAS,GAAG,IAAA,6CAAqB,EAAC,SAAS,EAAE,MAAM,CAAC,CAAC;gBACvD,CAAC;YACH,CAAC;YACD,OAA2B,EAAE,GAAG,SAAS,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC;QACnE,CAAC;QAED,gEAAgE;QAChE,MAAM,MAAM,GAAwB,MAAM,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK;aAClE,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;QAC5D,MAAM,QAAQ,GAAG,IAAI,CAAC,iCAAiC,CAAC,MAAM,CAAC,CAAC;QAEhE,uEAAuE;QACvE,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC1B,MAAM,SAAS,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;YAC9B,MAAM,MAAM,GAAG,IAAA,0CAAkB,EAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC;YACnD,OAA2B;gBACzB,GAAG,MAAM,IAAI,CAAC,qCAAqC,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC;gBAC1F,KAAK,EAAE,SAAS;aACjB,CAAC;QACJ,CAAC;QAED,mFAAmF;QACnF,IAAI,QAAQ,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC;YACtC,OAA2B,EAAE,GAAG,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QAC7D,CAAC;QAED,gEAAgE;QAChE,IAAI,kBAA0F,CAAC;QAC/F,QAAQ,SAAS,CAAC,IAAI,EAAE,CAAC;YACvB,KAAK,yBAAO,CAAC,KAAK,CAAC,IAAI;gBACrB,kBAAkB,GAAG,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBACpE,MAAM;YACR,KAAK,yBAAO,CAAC,KAAK,CAAC,KAAK;gBACtB,kBAAkB,GAAG,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBACrE,MAAM;YACR,KAAK,yBAAO,CAAC,KAAK,CAAC,GAAG;gBACpB,kBAAkB,GAAS,cAAc,CAAC,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBACzE,MAAM;YACR,KAAK,yBAAO,CAAC,KAAK,CAAC,GAAG;gBACpB,kBAAkB,GAAS,cAAc,CAAC,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBACzE,MAAM;YACR;gBACE,sDAAsD;gBACtD,yDAAyD;gBACzD,wEAAwE;gBACxE,8DAA8D;gBAE9D,4BAA4B;gBAC5B,MAAM,IAAI,KAAK,CAAC,0BAA0B,SAAS,CAAC,IAAI,mCAAmC,CAAC,CAAC;QACjG,CAAC;QACD,OAAO,MAAM,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE,kBAAkB,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAES,KAAK,CAAC,mBAAmB,CACjC,QAA+B,EAC/B,aAAqF,EACrF,OAAuB;QAEvB,IAAI,OAAO,GAAG,IAAI,CAAC;QACnB,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAC,OAAO,EAAE,EAAE;YACnE,MAAM,MAAM,GAAG,IAAA,0CAAkB,EAAC,OAAO,CAAC,CAAC,CAAC,CAAE,CAAC;YAC/C,MAAM,MAAM,GAAG,MAAM,IAAI;iBACtB,qCAAqC,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;YACjG,IAAI,IAAA,0CAAkB,EAAC,MAAM,CAAC,EAAE,CAAC;gBAC/B,OAAO,GAAG,KAAK,CAAC;YAClB,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC,CAAC;QACJ,OAAO,aAAa,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IAED;;;OAGG;IACI,iCAAiC,CAAC,YAAiC;QACxE,oDAAoD;QACpD,MAAM,gBAAgB,GAAkD,IAAI,GAAG,EAAE,CAAC;QAClF,MAAM,oBAAoB,GAAwB,EAAE,CAAC;QAErD,oBAAoB;QACpB,KAAK,MAAM,SAAS,IAAI,YAAY,EAAE,CAAC;YACrC,MAAM,MAAM,GAAG,IAAA,0CAAkB,EAAC,SAAS,CAAC,CAAC;YAC7C,IAAI,MAAM,EAAE,CAAC;gBACX,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;oBAClC,gBAAgB,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;gBACnC,CAAC;gBACD,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAChD,CAAC;iBAAM,CAAC;gBACN,oBAAoB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACvC,CAAC;QACH,CAAC;QAED,kBAAkB;QAClB,MAAM,QAAQ,GAA0B,EAAE,CAAC;QAC3C,IAAI,oBAAoB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpC,QAAQ,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QACtC,CAAC;QACD,KAAK,MAAM,CAAE,MAAM,EAAE,UAAU,CAAE,IAAI,gBAAgB,CAAC,OAAO,EAAE,EAAE,CAAC;YAChE,QAAQ,CAAC,IAAI,CAAC,UAAU;iBACrB,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,IAAA,6CAAqB,EAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;QACjE,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,qCAAqC,CAChD,SAAY,EACZ,MAA2B,EAC3B,MAAuC,EACvC,OAAuB;QAEvB,IAAI,MAAM,IAAI,IAAA,gDAAwB,EAAC,MAAM,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,EAAE,CAAC;YACjG,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,CAAC,MAAM,6CAA6C,SAAS,CAAC,IAAI,kBAAkB,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YACtJ,SAAS,GAAG,IAAA,6CAAqB,EAAC,SAAS,EAAE,MAAM,CAAC,CAAC;YACrD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;gBAC3B,IAAA,6CAAqB,EAAC,KAAK,CAAC,CAAC;YAC/B,CAAC;QACH,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAzKD,0FAyKC","sourcesContent":["import type {\n  IActionOptimizeQueryOperation,\n  IActorOptimizeQueryOperationOutput,\n  IActorOptimizeQueryOperationArgs,\n} from '@comunica/bus-optimize-query-operation';\nimport { ActorOptimizeQueryOperation } from '@comunica/bus-optimize-query-operation';\nimport { KeysInitQuery } from '@comunica/context-entries';\nimport type { IActorTest, TestResult } from '@comunica/core';\nimport { failTest, passTestVoid } from '@comunica/core';\nimport type { ComunicaDataFactory, IActionContext, IQuerySourceWrapper } from '@comunica/types';\nimport {\n  assignOperationSource,\n  doesShapeAcceptOperation,\n  getOperationSource,\n  removeOperationSource,\n} from '@comunica/utils-query-operation';\nimport { Algebra, Factory } from 'sparqlalgebrajs';\n\n/**\n * A comunica Group Sources Optimize Query Operation Actor.\n */\nexport class ActorOptimizeQueryOperationGroupSources extends ActorOptimizeQueryOperation {\n  public constructor(args: IActorOptimizeQueryOperationArgs) {\n    super(args);\n  }\n\n  public async test(action: IActionOptimizeQueryOperation): Promise<TestResult<IActorTest>> {\n    if (getOperationSource(action.operation)) {\n      return failTest(`Actor ${this.name} does not work with top-level operation sources.`);\n    }\n    return passTestVoid();\n  }\n\n  public async run(action: IActionOptimizeQueryOperation): Promise<IActorOptimizeQueryOperationOutput> {\n    return { operation: await this.groupOperation(action.operation, action.context), context: action.context };\n  }\n\n  /**\n   * Group operations belonging to the same source together, only if that source accepts the grouped operations.\n   * This grouping will be done recursively for the whole operation tree.\n   * Operations annotated with sources are considered leaves in the tree.\n   * @param operation An operation to group.\n   * @param context The action context.\n   */\n  public async groupOperation(operation: Algebra.Operation, context: IActionContext): Promise<Algebra.Operation> {\n    const dataFactory: ComunicaDataFactory = context.getSafe(KeysInitQuery.dataFactory);\n    const algebraFactory = new Factory(dataFactory);\n\n    // Return operation as-is if the operation already has a single source, or if the operation has no children.\n    if (getOperationSource(operation) ?? !('input' in operation)) {\n      return operation;\n    }\n\n    // If operation has a single input, move source annotation upwards if the source can handle it.\n    if (!Array.isArray(operation.input)) {\n      const groupedInput = await this.groupOperation(operation.input, context);\n      if (groupedInput.metadata?.scopedSource) {\n        const source: IQuerySourceWrapper = <IQuerySourceWrapper> getOperationSource(groupedInput);\n        if (doesShapeAcceptOperation(await source.source.getSelectorShape(context), operation)) {\n          this.logDebug(context, `Hoist 1 source-specific operation into a single ${operation.type} operation for ${source.source.toString()}`);\n          removeOperationSource(groupedInput);\n          operation = assignOperationSource(operation, source);\n        }\n      }\n      return <Algebra.Operation> { ...operation, input: groupedInput };\n    }\n\n    // If operation has multiple inputs, cluster source annotations.\n    const inputs: Algebra.Operation[] = await Promise.all(operation.input\n      .map(subInput => this.groupOperation(subInput, context)));\n    const clusters = this.clusterOperationsWithEqualSources(inputs);\n\n    // If we just have a single cluster, move the source annotation upwards\n    if (clusters.length === 1) {\n      const newInputs = clusters[0];\n      const source = getOperationSource(clusters[0][0])!;\n      return <Algebra.Operation> {\n        ...await this.moveSourceAnnotationUpwardsIfPossible(operation, newInputs, source, context),\n        input: newInputs,\n      };\n    }\n\n    // If the number of clusters is equal to the number of original inputs, do nothing.\n    if (clusters.length === inputs.length) {\n      return <Algebra.Operation> { ...operation, input: inputs };\n    }\n\n    // If we have multiple clusters, created nested multi-operations\n    let multiFactoryMethod: (children: Algebra.Operation[], flatten: boolean) => Algebra.Operation;\n    switch (operation.type) {\n      case Algebra.types.JOIN:\n        multiFactoryMethod = algebraFactory.createJoin.bind(algebraFactory);\n        break;\n      case Algebra.types.UNION:\n        multiFactoryMethod = algebraFactory.createUnion.bind(algebraFactory);\n        break;\n      case Algebra.types.ALT:\n        multiFactoryMethod = <any> algebraFactory.createAlt.bind(algebraFactory);\n        break;\n      case Algebra.types.SEQ:\n        multiFactoryMethod = <any> algebraFactory.createSeq.bind(algebraFactory);\n        break;\n      default:\n        // While LeftJoin and Minus are also multi-operations,\n        // these can never occur because they only have 2 inputs,\n        // so these cases will always be captured by one of the 2 if-cases above\n        // (clusters.length === 1 or clusters.length === input.length)\n\n        // In all other cases, error\n        throw new Error(`Unsupported operation '${operation.type}' detected while grouping sources`);\n    }\n    return await this.groupOperationMulti(clusters, multiFactoryMethod, context);\n  }\n\n  protected async groupOperationMulti(\n    clusters: Algebra.Operation[][],\n    factoryMethod: (children: Algebra.Operation[], flatten: boolean) => Algebra.Operation,\n    context: IActionContext,\n  ): Promise<Algebra.Operation> {\n    let flatten = true;\n    const nestedMerges = await Promise.all(clusters.map(async(cluster) => {\n      const source = getOperationSource(cluster[0])!;\n      const merged = await this\n        .moveSourceAnnotationUpwardsIfPossible(factoryMethod(cluster, true), cluster, source, context);\n      if (getOperationSource(merged)) {\n        flatten = false;\n      }\n      return merged;\n    }));\n    return factoryMethod(nestedMerges, flatten);\n  }\n\n  /**\n   * Cluster the given operations by equal source annotations.\n   * @param operationsIn An array of operations to cluster.\n   */\n  public clusterOperationsWithEqualSources(operationsIn: Algebra.Operation[]): Algebra.Operation[][] {\n    // Operations can have a source, or no source at all\n    const sourceOperations: Map<IQuerySourceWrapper, Algebra.Operation[]> = new Map();\n    const sourcelessOperations: Algebra.Operation[] = [];\n\n    // Cluster by source\n    for (const operation of operationsIn) {\n      const source = getOperationSource(operation);\n      if (source) {\n        if (!sourceOperations.has(source)) {\n          sourceOperations.set(source, []);\n        }\n        sourceOperations.get(source)!.push(operation);\n      } else {\n        sourcelessOperations.push(operation);\n      }\n    }\n\n    // Return clusters\n    const clusters: Algebra.Operation[][] = [];\n    if (sourcelessOperations.length > 0) {\n      clusters.push(sourcelessOperations);\n    }\n    for (const [ source, operations ] of sourceOperations.entries()) {\n      clusters.push(operations\n        .map(operation => assignOperationSource(operation, source)));\n    }\n    return clusters;\n  }\n\n  /**\n   * If the given source accepts the grouped operation, annotate the grouped operation with the source,\n   * and remove the source annotation from the seperate input operations.\n   * Otherwise, return the grouped operation unchanged.\n   * @param operation A grouped operation consisting of all given input operations.\n   * @param inputs An array of operations that share the same source annotation.\n   * @param source The common source.\n   * @param context The action context.\n   */\n  public async moveSourceAnnotationUpwardsIfPossible<O extends Algebra.Operation>(\n    operation: O,\n    inputs: Algebra.Operation[],\n    source: IQuerySourceWrapper | undefined,\n    context: IActionContext,\n  ): Promise<O> {\n    if (source && doesShapeAcceptOperation(await source.source.getSelectorShape(context), operation)) {\n      this.logDebug(context, `Hoist ${inputs.length} source-specific operations into a single ${operation.type} operation for ${source.source.toString()}`);\n      operation = assignOperationSource(operation, source);\n      for (const input of inputs) {\n        removeOperationSource(input);\n      }\n    }\n    return operation;\n  }\n}\n"]}
+{"version":3,"file":"ActorOptimizeQueryOperationGroupSources.js","sourceRoot":"","sources":["ActorOptimizeQueryOperationGroupSources.ts"],"names":[],"mappings":";;;AAKA,yFAAqF;AACrF,+DAA0D;AAE1D,yCAAwD;AAExD,2EAKyC;AACzC,qDAAmD;AAEnD;;GAEG;AACH,MAAa,uCAAwC,SAAQ,0DAA2B;IACtF,YAAmB,IAAsC;QACvD,KAAK,CAAC,IAAI,CAAC,CAAC;IACd,CAAC;IAEM,KAAK,CAAC,IAAI,CAAC,MAAqC;QACrD,IAAI,IAAA,0CAAkB,EAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YACzC,OAAO,IAAA,eAAQ,EAAC,SAAS,IAAI,CAAC,IAAI,kDAAkD,CAAC,CAAC;QACxF,CAAC;QACD,OAAO,IAAA,mBAAY,GAAE,CAAC;IACxB,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,MAAqC;QACpD,OAAO,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;IAC7G,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,cAAc,CAAC,SAA4B,EAAE,OAAuB;QAC/E,MAAM,WAAW,GAAwB,OAAO,CAAC,OAAO,CAAC,+BAAa,CAAC,WAAW,CAAC,CAAC;QACpF,MAAM,cAAc,GAAG,IAAI,yBAAO,CAAC,WAAW,CAAC,CAAC;QAEhD,4GAA4G;QAC5G,IAAI,IAAA,0CAAkB,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,OAAO,IAAI,SAAS,CAAC,EAAE,CAAC;YAC7D,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,+FAA+F;QAC/F,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YACpC,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YACzE,IAAI,YAAY,CAAC,QAAQ,EAAE,YAAY,EAAE,CAAC;gBACxC,MAAM,MAAM,GAA8C,IAAA,0CAAkB,EAAC,YAAY,CAAC,CAAC;gBAC3F,SAAS,GAAG,MAAM,IAAI,CAAC,qCAAqC,CAAC,SAAS,EAAE,CAAE,YAAY,CAAE,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;YAC7G,CAAC;YACD,OAA2B,EAAE,GAAG,SAAS,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC;QACnE,CAAC;QAED,gEAAgE;QAChE,MAAM,MAAM,GAAwB,MAAM,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK;aAClE,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;QAC5D,MAAM,QAAQ,GAAG,IAAI,CAAC,iCAAiC,CAAC,MAAM,CAAC,CAAC;QAEhE,uEAAuE;QACvE,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC1B,MAAM,SAAS,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;YAC9B,MAAM,MAAM,GAAG,IAAA,0CAAkB,EAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC;YACnD,OAA2B;gBACzB,GAAG,MAAM,IAAI,CAAC,qCAAqC,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC;gBAC1F,KAAK,EAAE,SAAS;aACjB,CAAC;QACJ,CAAC;QAED,mFAAmF;QACnF,IAAI,QAAQ,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC;YACtC,OAA2B,EAAE,GAAG,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QAC7D,CAAC;QAED,gEAAgE;QAChE,IAAI,kBAA0F,CAAC;QAC/F,QAAQ,SAAS,CAAC,IAAI,EAAE,CAAC;YACvB,KAAK,yBAAO,CAAC,KAAK,CAAC,IAAI;gBACrB,kBAAkB,GAAG,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBACpE,MAAM;YACR,KAAK,yBAAO,CAAC,KAAK,CAAC,KAAK;gBACtB,kBAAkB,GAAG,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBACrE,MAAM;YACR,KAAK,yBAAO,CAAC,KAAK,CAAC,GAAG;gBACpB,kBAAkB,GAAS,cAAc,CAAC,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBACzE,MAAM;YACR,KAAK,yBAAO,CAAC,KAAK,CAAC,GAAG;gBACpB,kBAAkB,GAAS,cAAc,CAAC,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBACzE,MAAM;YACR;gBACE,sDAAsD;gBACtD,yDAAyD;gBACzD,wEAAwE;gBACxE,8DAA8D;gBAE9D,4BAA4B;gBAC5B,MAAM,IAAI,KAAK,CAAC,0BAA0B,SAAS,CAAC,IAAI,mCAAmC,CAAC,CAAC;QACjG,CAAC;QACD,OAAO,MAAM,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE,kBAAkB,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAES,KAAK,CAAC,mBAAmB,CACjC,QAA+B,EAC/B,aAAqF,EACrF,OAAuB;QAEvB,IAAI,OAAO,GAAG,IAAI,CAAC;QACnB,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAC,OAAO,EAAE,EAAE;YACnE,MAAM,MAAM,GAAG,IAAA,0CAAkB,EAAC,OAAO,CAAC,CAAC,CAAC,CAAE,CAAC;YAC/C,MAAM,MAAM,GAAG,MAAM,IAAI;iBACtB,qCAAqC,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;YACjG,IAAI,IAAA,0CAAkB,EAAC,MAAM,CAAC,EAAE,CAAC;gBAC/B,OAAO,GAAG,KAAK,CAAC;YAClB,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC,CAAC;QACJ,OAAO,aAAa,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IAED;;;OAGG;IACI,iCAAiC,CAAC,YAAiC;QACxE,oDAAoD;QACpD,MAAM,gBAAgB,GAAkD,IAAI,GAAG,EAAE,CAAC;QAClF,MAAM,oBAAoB,GAAwB,EAAE,CAAC;QAErD,oBAAoB;QACpB,KAAK,MAAM,SAAS,IAAI,YAAY,EAAE,CAAC;YACrC,MAAM,MAAM,GAAG,IAAA,0CAAkB,EAAC,SAAS,CAAC,CAAC;YAC7C,IAAI,MAAM,EAAE,CAAC;gBACX,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;oBAClC,gBAAgB,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;gBACnC,CAAC;gBACD,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAChD,CAAC;iBAAM,CAAC;gBACN,oBAAoB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACvC,CAAC;QACH,CAAC;QAED,kBAAkB;QAClB,MAAM,QAAQ,GAA0B,EAAE,CAAC;QAC3C,IAAI,oBAAoB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpC,QAAQ,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QACtC,CAAC;QACD,KAAK,MAAM,CAAE,MAAM,EAAE,UAAU,CAAE,IAAI,gBAAgB,CAAC,OAAO,EAAE,EAAE,CAAC;YAChE,QAAQ,CAAC,IAAI,CAAC,UAAU;iBACrB,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,IAAA,6CAAqB,EAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;QACjE,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,qCAAqC,CAChD,SAAY,EACZ,MAA2B,EAC3B,MAAuC,EACvC,OAAuB;QAEvB,IAAI,MAAM,IAAI,IAAI,CAAC,uCAAuC,CACxD,SAAS,EACT,MAAM,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAC7C,OAAO,CACR,EAAE,CAAC;YACF,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,CAAC,MAAM,6CAA6C,SAAS,CAAC,IAAI,kBAAkB,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YACtJ,SAAS,GAAG,IAAA,6CAAqB,EAAC,SAAS,EAAE,MAAM,CAAC,CAAC;YACrD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;gBAC3B,IAAA,6CAAqB,EAAC,KAAK,CAAC,CAAC;YAC/B,CAAC;QACH,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;;;;;OASG;IACI,uCAAuC,CAC5C,SAAY,EACZ,KAA4B,EAC5B,OAAuB;QAEvB,IAAI,IAAA,gDAAwB,EAAC,KAAK,EAAE,SAAS,CAAC,EAAE,CAAC;YAC/C,MAAM,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC,+BAAa,CAAC,kBAAkB,CAAC,CAAC;YACzE,MAAM,UAAU,GAAmC,SAAS,CAAC,UAAU,CAAC;YACxE,IAAI,CAAC,kBAAkB,IAAI,UAAU,EAAE,cAAc,KAAK,yBAAO,CAAC,eAAe,CAAC,KAAK;gBACrF,CAAC,CAAC,UAAU,EAAE,IAAI,CAAC,KAAK,IAAI,kBAAkB,CAAC,IAAI,IAAA,gDAAwB,EAAC,KAAK,EAAE,UAAU,CAAC,EAAE,CAAC;gBACjG,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAnMD,0FAmMC","sourcesContent":["import type {\n  IActionOptimizeQueryOperation,\n  IActorOptimizeQueryOperationOutput,\n  IActorOptimizeQueryOperationArgs,\n} from '@comunica/bus-optimize-query-operation';\nimport { ActorOptimizeQueryOperation } from '@comunica/bus-optimize-query-operation';\nimport { KeysInitQuery } from '@comunica/context-entries';\nimport type { IActorTest, TestResult } from '@comunica/core';\nimport { failTest, passTestVoid } from '@comunica/core';\nimport type { ComunicaDataFactory, FragmentSelectorShape, IActionContext, IQuerySourceWrapper } from '@comunica/types';\nimport {\n  assignOperationSource,\n  doesShapeAcceptOperation,\n  getOperationSource,\n  removeOperationSource,\n} from '@comunica/utils-query-operation';\nimport { Algebra, Factory } from 'sparqlalgebrajs';\n\n/**\n * A comunica Group Sources Optimize Query Operation Actor.\n */\nexport class ActorOptimizeQueryOperationGroupSources extends ActorOptimizeQueryOperation {\n  public constructor(args: IActorOptimizeQueryOperationArgs) {\n    super(args);\n  }\n\n  public async test(action: IActionOptimizeQueryOperation): Promise<TestResult<IActorTest>> {\n    if (getOperationSource(action.operation)) {\n      return failTest(`Actor ${this.name} does not work with top-level operation sources.`);\n    }\n    return passTestVoid();\n  }\n\n  public async run(action: IActionOptimizeQueryOperation): Promise<IActorOptimizeQueryOperationOutput> {\n    return { operation: await this.groupOperation(action.operation, action.context), context: action.context };\n  }\n\n  /**\n   * Group operations belonging to the same source together, only if that source accepts the grouped operations.\n   * This grouping will be done recursively for the whole operation tree.\n   * Operations annotated with sources are considered leaves in the tree.\n   * @param operation An operation to group.\n   * @param context The action context.\n   */\n  public async groupOperation(operation: Algebra.Operation, context: IActionContext): Promise<Algebra.Operation> {\n    const dataFactory: ComunicaDataFactory = context.getSafe(KeysInitQuery.dataFactory);\n    const algebraFactory = new Factory(dataFactory);\n\n    // Return operation as-is if the operation already has a single source, or if the operation has no children.\n    if (getOperationSource(operation) ?? !('input' in operation)) {\n      return operation;\n    }\n\n    // If operation has a single input, move source annotation upwards if the source can handle it.\n    if (!Array.isArray(operation.input)) {\n      const groupedInput = await this.groupOperation(operation.input, context);\n      if (groupedInput.metadata?.scopedSource) {\n        const source: IQuerySourceWrapper = <IQuerySourceWrapper> getOperationSource(groupedInput);\n        operation = await this.moveSourceAnnotationUpwardsIfPossible(operation, [ groupedInput ], source, context);\n      }\n      return <Algebra.Operation> { ...operation, input: groupedInput };\n    }\n\n    // If operation has multiple inputs, cluster source annotations.\n    const inputs: Algebra.Operation[] = await Promise.all(operation.input\n      .map(subInput => this.groupOperation(subInput, context)));\n    const clusters = this.clusterOperationsWithEqualSources(inputs);\n\n    // If we just have a single cluster, move the source annotation upwards\n    if (clusters.length === 1) {\n      const newInputs = clusters[0];\n      const source = getOperationSource(clusters[0][0])!;\n      return <Algebra.Operation> {\n        ...await this.moveSourceAnnotationUpwardsIfPossible(operation, newInputs, source, context),\n        input: newInputs,\n      };\n    }\n\n    // If the number of clusters is equal to the number of original inputs, do nothing.\n    if (clusters.length === inputs.length) {\n      return <Algebra.Operation> { ...operation, input: inputs };\n    }\n\n    // If we have multiple clusters, created nested multi-operations\n    let multiFactoryMethod: (children: Algebra.Operation[], flatten: boolean) => Algebra.Operation;\n    switch (operation.type) {\n      case Algebra.types.JOIN:\n        multiFactoryMethod = algebraFactory.createJoin.bind(algebraFactory);\n        break;\n      case Algebra.types.UNION:\n        multiFactoryMethod = algebraFactory.createUnion.bind(algebraFactory);\n        break;\n      case Algebra.types.ALT:\n        multiFactoryMethod = <any> algebraFactory.createAlt.bind(algebraFactory);\n        break;\n      case Algebra.types.SEQ:\n        multiFactoryMethod = <any> algebraFactory.createSeq.bind(algebraFactory);\n        break;\n      default:\n        // While LeftJoin and Minus are also multi-operations,\n        // these can never occur because they only have 2 inputs,\n        // so these cases will always be captured by one of the 2 if-cases above\n        // (clusters.length === 1 or clusters.length === input.length)\n\n        // In all other cases, error\n        throw new Error(`Unsupported operation '${operation.type}' detected while grouping sources`);\n    }\n    return await this.groupOperationMulti(clusters, multiFactoryMethod, context);\n  }\n\n  protected async groupOperationMulti(\n    clusters: Algebra.Operation[][],\n    factoryMethod: (children: Algebra.Operation[], flatten: boolean) => Algebra.Operation,\n    context: IActionContext,\n  ): Promise<Algebra.Operation> {\n    let flatten = true;\n    const nestedMerges = await Promise.all(clusters.map(async(cluster) => {\n      const source = getOperationSource(cluster[0])!;\n      const merged = await this\n        .moveSourceAnnotationUpwardsIfPossible(factoryMethod(cluster, true), cluster, source, context);\n      if (getOperationSource(merged)) {\n        flatten = false;\n      }\n      return merged;\n    }));\n    return factoryMethod(nestedMerges, flatten);\n  }\n\n  /**\n   * Cluster the given operations by equal source annotations.\n   * @param operationsIn An array of operations to cluster.\n   */\n  public clusterOperationsWithEqualSources(operationsIn: Algebra.Operation[]): Algebra.Operation[][] {\n    // Operations can have a source, or no source at all\n    const sourceOperations: Map<IQuerySourceWrapper, Algebra.Operation[]> = new Map();\n    const sourcelessOperations: Algebra.Operation[] = [];\n\n    // Cluster by source\n    for (const operation of operationsIn) {\n      const source = getOperationSource(operation);\n      if (source) {\n        if (!sourceOperations.has(source)) {\n          sourceOperations.set(source, []);\n        }\n        sourceOperations.get(source)!.push(operation);\n      } else {\n        sourcelessOperations.push(operation);\n      }\n    }\n\n    // Return clusters\n    const clusters: Algebra.Operation[][] = [];\n    if (sourcelessOperations.length > 0) {\n      clusters.push(sourcelessOperations);\n    }\n    for (const [ source, operations ] of sourceOperations.entries()) {\n      clusters.push(operations\n        .map(operation => assignOperationSource(operation, source)));\n    }\n    return clusters;\n  }\n\n  /**\n   * If the given source accepts the grouped operation, annotate the grouped operation with the source,\n   * and remove the source annotation from the seperate input operations.\n   * Otherwise, return the grouped operation unchanged.\n   * @param operation A grouped operation consisting of all given input operations.\n   * @param inputs An array of operations that share the same source annotation.\n   * @param source The common source.\n   * @param context The action context.\n   */\n  public async moveSourceAnnotationUpwardsIfPossible<O extends Algebra.Operation>(\n    operation: O,\n    inputs: Algebra.Operation[],\n    source: IQuerySourceWrapper | undefined,\n    context: IActionContext,\n  ): Promise<O> {\n    if (source && this.isPossibleToMoveSourceAnnotationUpwards(\n      operation,\n      await source.source.getSelectorShape(context),\n      context,\n    )) {\n      this.logDebug(context, `Hoist ${inputs.length} source-specific operations into a single ${operation.type} operation for ${source.source.toString()}`);\n      operation = assignOperationSource(operation, source);\n      for (const input of inputs) {\n        removeOperationSource(input);\n      }\n    }\n    return operation;\n  }\n\n  /**\n   * Checks if it's possible to move the source annotation upwards using the following rules:\n   * - If the shape doesn't accept the operation, then it's not possible.\n   * - If it does and the operation does not contain extension functions or\n   *   comunica doesn't support them, then it's possible.\n   * - If comunica does support them, then it's possible only if the shape accepts the extension function expressions.\n   * @param operation A grouped operation consisting of all given input operations.\n   * @param shape The common source's shape.\n   * @param context The action context.\n   */\n  public isPossibleToMoveSourceAnnotationUpwards<O extends Algebra.Operation>(\n    operation: O,\n    shape: FragmentSelectorShape,\n    context: IActionContext,\n  ): boolean {\n    if (doesShapeAcceptOperation(shape, operation)) {\n      const extensionFunctions = context.get(KeysInitQuery.extensionFunctions);\n      const expression: Algebra.Expression | undefined = operation.expression;\n      if (!extensionFunctions || expression?.expressionType !== Algebra.expressionTypes.NAMED ||\n        !(expression?.name.value in extensionFunctions) || doesShapeAcceptOperation(shape, expression)) {\n        return true;\n      }\n    }\n    return false;\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@comunica/actor-optimize-query-operation-group-sources",
-  "version": "4.2.0",
+  "version": "4.4.0",
   "description": "A group-sources optimize-query-operation actor",
   "lsd:module": true,
   "license": "MIT",
@@ -41,12 +41,12 @@
     "build:components": "componentsjs-generator"
   },
   "dependencies": {
-    "@comunica/bus-optimize-query-operation": "^4.2.0",
-    "@comunica/context-entries": "^4.2.0",
-    "@comunica/core": "^4.2.0",
-    "@comunica/types": "^4.2.0",
-    "@comunica/utils-query-operation": "^4.2.0",
+    "@comunica/bus-optimize-query-operation": "^4.4.0",
+    "@comunica/context-entries": "^4.4.0",
+    "@comunica/core": "^4.4.0",
+    "@comunica/types": "^4.4.0",
+    "@comunica/utils-query-operation": "^4.4.0",
     "sparqlalgebrajs": "^4.3.8"
   },
-  "gitHead": "94e1eacab069551590cc250074b36bce08720c4c"
+  "gitHead": "27acde56dfe0c1ff1162c1f46818ad752296ca88"
 }