@comunica/actor-http-fetch 2.0.1-alpha.5.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 Fetch HTTP Actor
+
+[![npm version](https://badge.fury.io/js/%40comunica%2Factor-http-fetch.svg)](https://www.npmjs.com/package/@comunica/actor-http-fetch)
+
+An [HTTP](https://github.com/comunica/comunica/tree/master/packages/bus-http) actor that
+uses [cross-fetch](https://www.npmjs.com/package/cross-fetch) to perform HTTP requests.
+
+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/).
+
+When this actor is used, a custom fetch implementation may be provided via the context (`fetch`).
+If none is provided, the default fallback fetch implementation will be used (`node-fetch` in Node.js, and the browser's `fetch` in browser environments).
+
+[Click here if you just want to query with Comunica](https://comunica.dev/docs/query/).
+
+## Install
+
+```bash
+$ yarn add @comunica/actor-http-fetch
+```
+
+## Configure
+
+After installing, this package can be added to your engine's configuration as follows:
+```text
+{
+  "@context": [
+    ...
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-http-fetch/^2.0.0/components/context.jsonld"  
+  ],
+  "actors": [
+    ...
+    {
+      "@id": "urn:comunica:default:http/actors#fetch",
+      "@type": "ActorHttpFetch"
+    }
+  ]
+}
+```
+
+### Config Parameters
+
+* `agentOptions`: The agent JSON options for the HTTP agent. _(optional)_

package/components/ActorHttpFetch.jsonld

@@ -0,0 +1,196 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-http-fetch/^2.0.0/components/context.jsonld",
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/bus-http/^2.0.0/components/context.jsonld",
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/core/^2.0.0/components/context.jsonld"
+  ],
+  "@id": "npmd:@comunica/actor-http-fetch",
+  "components": [
+    {
+      "@id": "cahf:components/ActorHttpFetch.jsonld#ActorHttpFetch",
+      "@type": "Class",
+      "requireElement": "ActorHttpFetch",
+      "extends": [
+        "cbh:components/ActorHttp.jsonld#ActorHttp"
+      ],
+      "comment": "A node-fetch actor that listens on the 'init' bus.  It will call `fetch` with either action.input or action.url.",
+      "parameters": [
+        {
+          "@id": "cahf:components/ActorHttpFetch.jsonld#ActorHttpFetch_args_agentOptions",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              "rdf:JSON",
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "default": {
+            "@type": "@json",
+            "@value": {
+              "keepAlive": true,
+              "maxSockets": 5
+            }
+          },
+          "comment": "The agent options for the HTTP agent"
+        },
+        {
+          "@id": "cahf:components/ActorHttpFetch.jsonld#ActorHttpFetch_args_name",
+          "range": "xsd:string",
+          "default": {
+            "@id": "rdf:subject"
+          },
+          "comment": "The name for this actor."
+        },
+        {
+          "@id": "cahf:components/ActorHttpFetch.jsonld#ActorHttpFetch_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/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+                  },
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+                  },
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+                  }
+                ]
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+              }
+            ]
+          },
+          "default": {
+            "@id": "cbh:components/ActorHttp.jsonld#ActorHttp_default_bus",
+            "@type": "cc:components/Bus.jsonld#Bus"
+          },
+          "comment": "The bus this actor subscribes to."
+        },
+        {
+          "@id": "cahf:components/ActorHttpFetch.jsonld#ActorHttpFetch_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/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+                    },
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+                    },
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+                    }
+                  ]
+                }
+              },
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "comment": "Actor that must be registered in the bus before this actor."
+        }
+      ],
+      "memberFields": [
+        {
+          "@id": "cahf:components/ActorHttpFetch.jsonld#ActorHttpFetch__member_userAgent",
+          "memberFieldName": "userAgent"
+        },
+        {
+          "@id": "cahf:components/ActorHttpFetch.jsonld#ActorHttpFetch__member_fetchInitPreprocessor",
+          "memberFieldName": "fetchInitPreprocessor"
+        },
+        {
+          "@id": "cahf:components/ActorHttpFetch.jsonld#ActorHttpFetch__member_constructor",
+          "memberFieldName": "constructor"
+        },
+        {
+          "@id": "cahf:components/ActorHttpFetch.jsonld#ActorHttpFetch__member_createUserAgent",
+          "memberFieldName": "createUserAgent"
+        },
+        {
+          "@id": "cahf:components/ActorHttpFetch.jsonld#ActorHttpFetch__member_test",
+          "memberFieldName": "test"
+        },
+        {
+          "@id": "cahf:components/ActorHttpFetch.jsonld#ActorHttpFetch__member_run",
+          "memberFieldName": "run"
+        }
+      ],
+      "constructorArguments": [
+        {
+          "@id": "cahf:components/ActorHttpFetch.jsonld#ActorHttpFetch_args__constructorArgument",
+          "fields": [
+            {
+              "keyRaw": "agentOptions",
+              "value": {
+                "@id": "cahf:components/ActorHttpFetch.jsonld#ActorHttpFetch_args_agentOptions"
+              }
+            },
+            {
+              "keyRaw": "name",
+              "value": {
+                "@id": "cahf:components/ActorHttpFetch.jsonld#ActorHttpFetch_args_name"
+              }
+            },
+            {
+              "keyRaw": "bus",
+              "value": {
+                "@id": "cahf:components/ActorHttpFetch.jsonld#ActorHttpFetch_args_bus"
+              }
+            },
+            {
+              "keyRaw": "beforeActors",
+              "value": {
+                "@id": "cahf:components/ActorHttpFetch.jsonld#ActorHttpFetch_args_beforeActors"
+              }
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "@id": "cahf:components/ActorHttpFetch.jsonld#IActorHttpFetchArgs",
+      "@type": "AbstractClass",
+      "requireElement": "IActorHttpFetchArgs",
+      "parameters": [],
+      "memberFields": [
+        {
+          "@id": "cahf:components/ActorHttpFetch.jsonld#IActorHttpFetchArgs__member_agentOptions",
+          "memberFieldName": "agentOptions"
+        }
+      ],
+      "constructorArguments": []
+    }
+  ]
+}

package/components/components.jsonld

@@ -0,0 +1,11 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-http-fetch/^2.0.0/components/context.jsonld"
+  ],
+  "@id": "npmd:@comunica/actor-http-fetch",
+  "@type": "Module",
+  "requireName": "@comunica/actor-http-fetch",
+  "import": [
+    "cahf:components/ActorHttpFetch.jsonld"
+  ]
+}

package/components/context.jsonld

@@ -0,0 +1,46 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^4.0.0/components/context.jsonld",
+    {
+      "npmd": "https://linkedsoftwaredependencies.org/bundles/npm/",
+      "cahf": "npmd:@comunica/actor-http-fetch/^2.0.0/",
+      "ActorHttpFetch": {
+        "@id": "cahf:components/ActorHttpFetch.jsonld#ActorHttpFetch",
+        "@prefix": true,
+        "@context": {
+          "args_agentOptions": {
+            "@id": "cahf:components/ActorHttpFetch.jsonld#ActorHttpFetch_args_agentOptions"
+          },
+          "args_name": {
+            "@id": "cahf:components/ActorHttpFetch.jsonld#ActorHttpFetch_args_name"
+          },
+          "args_bus": {
+            "@id": "cahf:components/ActorHttpFetch.jsonld#ActorHttpFetch_args_bus"
+          },
+          "args_beforeActors": {
+            "@id": "cahf:components/ActorHttpFetch.jsonld#ActorHttpFetch_args_beforeActors",
+            "@container": "@list"
+          },
+          "agentOptions": {
+            "@id": "cahf:components/ActorHttpFetch.jsonld#ActorHttpFetch_args_agentOptions"
+          },
+          "name": {
+            "@id": "cahf:components/ActorHttpFetch.jsonld#ActorHttpFetch_args_name"
+          },
+          "bus": {
+            "@id": "cahf:components/ActorHttpFetch.jsonld#ActorHttpFetch_args_bus"
+          },
+          "beforeActors": {
+            "@id": "cahf:components/ActorHttpFetch.jsonld#ActorHttpFetch_args_beforeActors",
+            "@container": "@list"
+          }
+        }
+      },
+      "IActorHttpFetchArgs": {
+        "@id": "cahf:components/ActorHttpFetch.jsonld#IActorHttpFetchArgs",
+        "@prefix": true,
+        "@context": {}
+      }
+    }
+  ]
+}

package/lib/ActorHttpFetch.d.ts

@@ -0,0 +1,25 @@
+import type { IActionHttp, IActorHttpOutput, IActorHttpArgs } from '@comunica/bus-http';
+import { ActorHttp } from '@comunica/bus-http';
+import type { IMediatorTypeTime } from '@comunica/mediatortype-time';
+import 'cross-fetch/polyfill';
+/**
+ * A node-fetch actor that listens on the 'init' bus.
+ *
+ * It will call `fetch` with either action.input or action.url.
+ */
+export declare class ActorHttpFetch extends ActorHttp {
+    private readonly userAgent;
+    private readonly fetchInitPreprocessor;
+    constructor(args: IActorHttpFetchArgs);
+    static createUserAgent(): string;
+    test(action: IActionHttp): Promise<IMediatorTypeTime>;
+    run(action: IActionHttp): Promise<IActorHttpOutput>;
+}
+export interface IActorHttpFetchArgs extends IActorHttpArgs {
+    /**
+     * The agent options for the HTTP agent
+     * @range {json}
+     * @default {{ "keepAlive": true, "maxSockets": 5 }}
+     */
+    agentOptions?: Record<string, any>;
+}

package/lib/ActorHttpFetch.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActorHttpFetch = void 0;
+const bus_http_1 = require("@comunica/bus-http");
+const context_entries_1 = require("@comunica/context-entries");
+require("cross-fetch/polyfill");
+const FetchInitPreprocessor_1 = require("./FetchInitPreprocessor");
+/**
+ * A node-fetch actor that listens on the 'init' bus.
+ *
+ * It will call `fetch` with either action.input or action.url.
+ */
+class ActorHttpFetch extends bus_http_1.ActorHttp {
+    constructor(args) {
+        super(args);
+        this.userAgent = ActorHttpFetch.createUserAgent();
+        this.fetchInitPreprocessor = new FetchInitPreprocessor_1.FetchInitPreprocessor(args.agentOptions);
+    }
+    static createUserAgent() {
+        return `Comunica/actor-http-fetch (${typeof global.navigator === 'undefined' ?
+            `Node.js ${process.version}; ${process.platform}` :
+            `Browser-${global.navigator.userAgent}`})`;
+    }
+    async test(action) {
+        return { time: Number.POSITIVE_INFINITY };
+    }
+    run(action) {
+        // Prepare headers
+        const initHeaders = action.init ? action.init.headers || {} : {};
+        action.init = action.init ? action.init : {};
+        action.init.headers = new Headers(initHeaders);
+        if (!action.init.headers.has('user-agent')) {
+            action.init.headers.append('user-agent', this.userAgent);
+        }
+        const authString = action.context.get(context_entries_1.KeysHttp.auth);
+        if (authString) {
+            action.init.headers.append('Authorization', `Basic ${Buffer.from(authString).toString('base64')}`);
+        }
+        // Log request
+        this.logInfo(action.context, `Requesting ${typeof action.input === 'string' ?
+            action.input :
+            action.input.url}`, () => ({
+            headers: bus_http_1.ActorHttp.headersToHash(new Headers(action.init.headers)),
+            method: action.init.method || 'GET',
+        }));
+        // TODO: remove this workaround once this has a fix: https://github.com/inrupt/solid-client-authn-js/issues/1708
+        if (action.init && action.init.headers && 'append' in action.init.headers && action.context.has(context_entries_1.KeysHttp.fetch)) {
+            action.init.headers = bus_http_1.ActorHttp.headersToHash(action.init.headers);
+        }
+        // Perform request
+        const customFetch = action
+            .context?.get(context_entries_1.KeysHttp.fetch);
+        return (customFetch || fetch)(action.input, this.fetchInitPreprocessor.handle({
+            ...action.init,
+            ...action.context && action.context.get(context_entries_1.KeysHttp.includeCredentials) ? { credentials: 'include' } : {},
+        })).then(response => {
+            // Node-fetch does not support body.cancel, while it is mandatory according to the fetch and readablestream api.
+            // If it doesn't exist, we monkey-patch it.
+            if (response.body && !response.body.cancel) {
+                response.body.cancel = async (error) => response.body.destroy(error);
+            }
+            return response;
+        });
+    }
+}
+exports.ActorHttpFetch = ActorHttpFetch;
+//# sourceMappingURL=ActorHttpFetch.js.map

package/lib/FetchInitPreprocessor-browser.d.ts

@@ -0,0 +1,7 @@
+import type { IFetchInitPreprocessor } from './IFetchInitPreprocessor';
+/**
+ * Does nothing in browsers
+ */
+export declare class FetchInitPreprocessor implements IFetchInitPreprocessor {
+    handle(init: RequestInit): RequestInit;
+}

package/lib/FetchInitPreprocessor-browser.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FetchInitPreprocessor = void 0;
+/**
+ * Does nothing in browsers
+ */
+class FetchInitPreprocessor {
+    handle(init) {
+        // Remove overridden user-agent header within browsers to avoid CORS issues
+        if (init.headers) {
+            const headers = new Headers(init.headers);
+            if (headers.has('user-agent')) {
+                headers.delete('user-agent');
+            }
+            init.headers = headers;
+        }
+        return { keepalive: true, ...init };
+    }
+}
+exports.FetchInitPreprocessor = FetchInitPreprocessor;
+//# sourceMappingURL=FetchInitPreprocessor-browser.js.map

package/lib/FetchInitPreprocessor.d.ts

@@ -0,0 +1,9 @@
+import type { IFetchInitPreprocessor } from './IFetchInitPreprocessor';
+/**
+ * Overrides the HTTP agent to perform better in Node.js.
+ */
+export declare class FetchInitPreprocessor implements IFetchInitPreprocessor {
+    private readonly agent;
+    constructor(agentOptions: any);
+    handle(init: RequestInit): RequestInit;
+}

package/lib/FetchInitPreprocessor.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FetchInitPreprocessor = void 0;
+const http_1 = require("http");
+const https_1 = require("https");
+const bus_http_1 = require("@comunica/bus-http");
+/**
+ * Overrides the HTTP agent to perform better in Node.js.
+ */
+class FetchInitPreprocessor {
+    constructor(agentOptions) {
+        const httpAgent = new http_1.Agent(agentOptions);
+        const httpsAgent = new https_1.Agent(agentOptions);
+        this.agent = (_parsedURL) => _parsedURL.protocol === 'http:' ? httpAgent : httpsAgent;
+    }
+    handle(init) {
+        // Convert body Web stream to Node stream, as node-fetch does not support Web streams
+        if (init.body && 'getReader' in init.body) {
+            init.body = bus_http_1.ActorHttp.toNodeReadable(init.body);
+        }
+        return { ...init, agent: this.agent };
+    }
+}
+exports.FetchInitPreprocessor = FetchInitPreprocessor;
+//# sourceMappingURL=FetchInitPreprocessor.js.map

package/lib/IFetchInitPreprocessor.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Can modify a fetch init object.
+ */
+export interface IFetchInitPreprocessor {
+    handle: (init: RequestInit) => RequestInit;
+}

package/lib/IFetchInitPreprocessor.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IFetchInitPreprocessor.js.map

package/lib/index.d.ts

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

package/lib/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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("./ActorHttpFetch"), exports);
+//# sourceMappingURL=index.js.map

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@comunica/actor-http-fetch",
+  "version": "2.0.1-alpha.5.0",
+  "description": "A node-fetch http actor",
+  "lsd:module": true,
+  "main": "lib/index.js",
+  "typings": "lib/index",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/comunica/comunica.git",
+    "directory": "packages/actor-http-fetch"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "comunica",
+    "runner"
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/comunica/comunica/issues"
+  },
+  "homepage": "https://comunica.dev/",
+  "files": [
+    "components",
+    "lib/**/*.d.ts",
+    "lib/**/*.js"
+  ],
+  "dependencies": {
+    "@comunica/bus-http": "2.0.1-alpha.5.0",
+    "@comunica/context-entries": "2.0.1-alpha.5.0",
+    "@comunica/core": "2.0.1-alpha.5.0",
+    "@comunica/mediatortype-time": "2.0.1-alpha.5.0",
+    "cross-fetch": "^3.0.5"
+  },
+  "scripts": {
+    "build": "npm run build:ts && npm run build:components",
+    "build:ts": "node \"../../node_modules/typescript/bin/tsc\"",
+    "build:components": "componentsjs-generator"
+  },
+  "browser": {
+    "./lib/FetchInitPreprocessor.js": "./lib/FetchInitPreprocessor-browser.js"
+  },
+  "gitHead": "e2ae2e9e924bf0656df60cc99774f7e560d47695"
+}