apollo-datasource-http - npm Package Compare versions

Comparing version 0.8.1 to 0.9.0

dist/src/http-data-source.d.ts

@@ -0,4 +1,7 @@
+/// <reference types="node" />
 import { DataSource, DataSourceConfig } from 'apollo-datasource';
-import { Client, Pool } from 'undici';
-import { DispatchOptions, ResponseData } from 'undici/types/dispatcher';
+import { Pool } from 'undici';
+import { ResponseData, RequestOptions as UndiciRequestOptions } from 'undici/types/dispatcher';
+import { EventEmitter, Readable } from 'stream';
+declare type AbortSignal = unknown;
 export declare type CacheTTLOptions = {
@@ -10,4 +13,13 @@ requestCache?: {
 };
-export declare type ClientRequestOptions = Omit<DispatchOptions, 'origin' | 'path' | 'method'> & CacheTTLOptions;
-export declare type RequestOptions = DispatchOptions & CacheTTLOptions;
+interface Dictionary<T> {
+    [Key: string]: T;
+}
+export declare type RequestOptions = {
+    body?: string | Buffer | Uint8Array | Readable | null;
+    headers?: Dictionary<string>;
+    signal?: AbortSignal | EventEmitter | null;
+} & CacheTTLOptions;
+export declare type Request = UndiciRequestOptions & CacheTTLOptions & {
+    headers: Dictionary<string>;
+};
 export declare type Response<TResult> = {
@@ -22,4 +34,4 @@ body: TResult;
     pool?: Pool;
-    requestOptions?: ClientRequestOptions;
-    clientOptions?: Client.Options;
+    requestOptions?: RequestOptions;
+    clientOptions?: Pool.Options;
     lru?: Partial<LRUOptions>;
@@ -32,22 +44,21 @@ }
     private storageAdapter;
-    private readonly pool;
-    private readonly globalRequestOptions?;
-    private readonly abortController;
+    private pool;
+    private globalRequestOptions?;
     private readonly memoizedResults;
     constructor(baseURL: string, options?: HTTPDataSourceOptions | undefined);
     initialize(config: DataSourceConfig<TContext>): void;
-    abort(): void;
     protected isResponseOk(statusCode: number): boolean;
-    protected isResponseCacheable<TResult = unknown>(requestOptions: RequestOptions, response: Response<TResult>): boolean;
-    protected onCacheKeyCalculation(requestOptions: RequestOptions): string;
-    protected onRequest?(requestOptions: RequestOptions): void;
-    protected onResponse<TResult = unknown>(_requestOptions: RequestOptions, response: Response<TResult>): Response<TResult>;
-    protected onError?(_error: Error, requestOptions: RequestOptions): void;
-    protected get<TResult = unknown>(path: string, requestOptions?: ClientRequestOptions): Promise<Response<TResult>>;
-    protected post<TResult = unknown>(path: string, requestOptions?: ClientRequestOptions): Promise<Response<TResult>>;
-    protected delete<TResult = unknown>(path: string, requestOptions?: ClientRequestOptions): Promise<Response<TResult>>;
-    protected put<TResult = unknown>(path: string, requestOptions?: ClientRequestOptions): Promise<Response<TResult>>;
+    protected isResponseCacheable<TResult = unknown>(request: Request, response: Response<TResult>): boolean;
+    protected onCacheKeyCalculation(request: Request): string;
+    protected onRequest?(request: Request): void;
+    protected onResponse<TResult = unknown>(_request: Request, response: Response<TResult>): Response<TResult>;
+    protected onError?(_error: Error, requestOptions: Request): void;
+    protected get<TResult = unknown>(path: string, requestOptions?: RequestOptions): Promise<Response<TResult>>;
+    protected post<TResult = unknown>(path: string, requestOptions?: RequestOptions): Promise<Response<TResult>>;
+    protected delete<TResult = unknown>(path: string, requestOptions?: RequestOptions): Promise<Response<TResult>>;
+    protected put<TResult = unknown>(path: string, requestOptions?: RequestOptions): Promise<Response<TResult>>;
     private performRequest;
     private request;
 }
+export {};
 //# sourceMappingURL=http-data-source.d.ts.map

dist/src/http-data-source.js

@@ -12,3 +12,2 @@ "use strict";
 const secure_json_parse_1 = __importDefault(require("secure-json-parse"));
-const abort_controller_1 = __importDefault(require("abort-controller"));
 const keyv_1 = __importDefault(require("keyv"));
@@ -49,3 +48,2 @@ const apollo_server_errors_1 = require("apollo-server-errors");
         this.globalRequestOptions = options?.requestOptions;
-        this.abortController = new abort_controller_1.default();
     }
@@ -58,15 +56,12 @@ initialize(config) {
     }
-    abort() {
-        this.abortController.abort();
-    }
     isResponseOk(statusCode) {
         return (statusCode >= 200 && statusCode <= 399) || statusCode === 304;
     }
-    isResponseCacheable(requestOptions, response) {
-        return cacheableStatusCodes.indexOf(response.statusCode) > -1 && requestOptions.method === 'GET';
+    isResponseCacheable(request, response) {
+        return cacheableStatusCodes.indexOf(response.statusCode) > -1 && request.method === 'GET';
     }
-    onCacheKeyCalculation(requestOptions) {
-        return requestOptions.origin + requestOptions.path;
+    onCacheKeyCalculation(request) {
+        return request.origin + request.path;
     }
-    onResponse(_requestOptions, response) {
+    onResponse(_request, response) {
         if (this.isResponseOk(response.statusCode)) {
@@ -79,2 +74,3 @@ return response;
         return await this.request({
+            headers: {},
             ...requestOptions,
@@ -88,2 +84,3 @@ method: 'GET',
         return await this.request({
+            headers: {},
             ...requestOptions,
@@ -97,2 +94,3 @@ method: 'POST',
         return await this.request({
+            headers: {},
             ...requestOptions,
@@ -106,2 +104,3 @@ method: 'DELETE',
         return await this.request({
+            headers: {},
             ...requestOptions,
@@ -148,6 +147,6 @@ method: 'PUT',
     }
-    async request(requestOptions) {
-        const cacheKey = this.onCacheKeyCalculation(requestOptions);
-        const ttlCacheEnabled = requestOptions.requestCache;
-        if (requestOptions.method === 'GET' && ttlCacheEnabled) {
+    async request(request) {
+        const cacheKey = this.onCacheKeyCalculation(request);
+        const ttlCacheEnabled = request.requestCache;
+        if (request.method === 'GET' && ttlCacheEnabled) {
             const cachedResponse = await this.storageAdapter.get(cacheKey);
@@ -160,4 +159,3 @@ if (cachedResponse) {
             ...this.globalRequestOptions,
-            ...requestOptions,
-            signal: this.abortController.signal,
+            ...request,
         };
@@ -164,0 +162,0 @@ if (options.method === 'GET') {

dist/src/index.d.ts

@@ -1,2 +0,2 @@
-export { HTTPDataSource, HTTPDataSourceOptions, LRUOptions, ClientRequestOptions, Response, RequestOptions, CacheTTLOptions, } from './http-data-source';
+export { HTTPDataSource, HTTPDataSourceOptions, LRUOptions, RequestOptions, Response, Request, CacheTTLOptions, } from './http-data-source';
 //# sourceMappingURL=index.d.ts.map

package.json

 {
   "name": "apollo-datasource-http",
-  "version": "0.8.1",
+  "version": "0.9.0",
   "author": "Dustin Deus <[e-mail]>",
@@ -53,7 +53,6 @@ "license": "MIT",
     "@alloc/quick-lru": "^5.2.0",
-    "abort-controller": "^3.0.0",
     "apollo-datasource": "^0.9.0",
     "apollo-server-caching": "^0.7.0",
     "apollo-server-errors": "^2.5.0",
-    "graphql": "^15.5.0",
+    "graphql": "^15.5.1",
     "keyv": "^4.0.3",
@@ -66,2 +65,3 @@ "secure-json-parse": "^2.4.0",
     "apollo-datasource-rest": "^0.14.0",
+    "abort-controller": "^3.0.0",
     "ava": "^3.15.0",
@@ -71,8 +71,8 @@ "h2url": "^0.2.0",
     "nyc": "^15.1.0",
-    "prettier": "^2.3.1",
-    "release-it": "^14.9.0",
+    "prettier": "^2.3.2",
+    "release-it": "^14.10.0",
     "ts-node": "^10.0.0",
-    "typescript": "^4.3.2",
+    "typescript": "^4.3.4",
     "uid": "^2.0.0"
   }
 }

README.md

@@ -65,11 +65,11 @@ # Apollo HTTP Data Source
 
-  onCacheKeyCalculation(requestOptions: RequestOptions): string {
+  onCacheKeyCalculation(request: Request): string {
     // return different key based on request options
   }
 
-  onRequest(requestOptions: RequestOptions): void {
+  onRequest(request: Request): void {
     // manipulate request before it is send
   }
 
-  onResponse<TResult = unknown>(request: RequestOptions, response: Response<TResult>): void {
+  onResponse<TResult = unknown>(request: Request, response: Response<TResult>): void {
     // manipulate response or handle unsuccessful response in a different way
@@ -79,3 +79,3 @@ return super.onResponse(request, response)
 
-  onError(error: RequestError, request: RequestOptions): void {
+  onError(error: RequestError, request: Request): void {
     // log errors
@@ -82,0 +82,0 @@ }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

23521

increased by0.17%

Dependency count

8

decreased by-11.11%

Lines of code

233

increased by4.02%

Worsened metrics

Dev dependency count

12

increased by9.09%

Dependency changes

• - Removedabort-controller@^3.0.0

• - Removedabort-controller@3.0.0(transitive)

• - Removedevent-target-shim@5.0.1(transitive)

• Updatedgraphql@^15.5.1