From 2cf5a6b510b551de9d3a853cb3aba98df5feb3d9 Mon Sep 17 00:00:00 2001 From: Lawrence Forooghian Date: Tue, 30 Jan 2024 17:54:38 +0000 Subject: [PATCH] Rename types that refer to RequestCallback We removed RequestCallback in d0568d7. --- src/common/lib/client/auth.ts | 6 +++--- src/common/lib/client/paginatedresource.ts | 8 ++++---- src/common/lib/client/resource.ts | 11 +++-------- src/common/types/http.ts | 10 +++++----- src/platform/nodejs/lib/util/http.ts | 4 ++-- src/platform/web/lib/http/http.ts | 4 ++-- src/platform/web/lib/http/request/fetchrequest.ts | 12 +++--------- 7 files changed, 22 insertions(+), 33 deletions(-) diff --git a/src/common/lib/client/auth.ts b/src/common/lib/client/auth.ts index 933260049b..a211fc2ef1 100644 --- a/src/common/lib/client/auth.ts +++ b/src/common/lib/client/auth.ts @@ -2,7 +2,7 @@ import Logger from '../util/logger'; import * as Utils from '../util/utils'; import Multicaster, { MulticasterInstance } from '../util/multicaster'; import ErrorInfo, { IPartialErrorInfo } from '../types/errorinfo'; -import { RequestCallbackError, RequestParams, RequestResult } from '../../types/http'; +import { RequestResultError, RequestParams, RequestResult } from '../../types/http'; import * as API from '../../../../ably'; import BaseClient from './baseclient'; import BaseRealtime from './baserealtime'; @@ -395,7 +395,7 @@ class Auth { let tokenRequestCallback: ( data: API.TokenParams, callback: ( - error: API.ErrorInfo | RequestCallbackError | string | null, + error: API.ErrorInfo | RequestResultError | string | null, tokenRequestOrDetails: API.TokenDetails | API.TokenRequest | string | null, contentType?: string ) => void @@ -566,7 +566,7 @@ class Auth { const tokenRequest = ( signedTokenParams: Record, - tokenCb: (err: RequestCallbackError | null, tokenResponse?: API.TokenDetails | string, unpacked?: boolean) => void + tokenCb: (err: RequestResultError | null, tokenResponse?: API.TokenDetails | string, unpacked?: boolean) => void ) => { const keyName = signedTokenParams.keyName, path = '/keys/' + keyName + '/requestToken', diff --git a/src/common/lib/client/paginatedresource.ts b/src/common/lib/client/paginatedresource.ts index fb56ea0732..b36e7be21a 100644 --- a/src/common/lib/client/paginatedresource.ts +++ b/src/common/lib/client/paginatedresource.ts @@ -3,9 +3,9 @@ import Logger from '../util/logger'; import Resource, { ResourceResult } from './resource'; import { IPartialErrorInfo } from '../types/errorinfo'; import BaseClient from './baseclient'; -import { RequestBody, RequestCallbackHeaders } from 'common/types/http'; +import { RequestBody, ResponseHeaders } from 'common/types/http'; -export type BodyHandler = (body: unknown, headers: RequestCallbackHeaders, unpacked?: boolean) => Promise; +export type BodyHandler = (body: unknown, headers: ResponseHeaders, unpacked?: boolean) => Promise; function getRelParams(linkUrl: string) { const urlMatch = linkUrl.match(/^\.\/(\w+)\?(.*)$/); @@ -176,14 +176,14 @@ export class PaginatedResult { export class HttpPaginatedResponse extends PaginatedResult { statusCode: number; success: boolean; - headers: RequestCallbackHeaders; + headers: ResponseHeaders; errorCode?: number | null; errorMessage?: string | null; constructor( resource: PaginatedResource, items: T[], - headers: RequestCallbackHeaders, + headers: ResponseHeaders, statusCode: number, relParams: any, err: IPartialErrorInfo | null diff --git a/src/common/lib/client/resource.ts b/src/common/lib/client/resource.ts index 129caed95f..3ffd727603 100644 --- a/src/common/lib/client/resource.ts +++ b/src/common/lib/client/resource.ts @@ -6,16 +6,11 @@ import HttpMethods from '../../constants/HttpMethods'; import ErrorInfo, { IPartialErrorInfo, PartialErrorInfo } from '../types/errorinfo'; import BaseClient from './baseclient'; import { MsgPack } from 'common/types/msgpack'; -import { - RequestBody, - RequestCallbackHeaders, - appendingParams as urlFromPathAndParams, - paramString, -} from 'common/types/http'; +import { RequestBody, ResponseHeaders, appendingParams as urlFromPathAndParams, paramString } from 'common/types/http'; async function withAuthDetails( client: BaseClient, - headers: RequestCallbackHeaders | undefined, + headers: ResponseHeaders | undefined, params: Record, opCallback: Function ): Promise> { @@ -102,7 +97,7 @@ function logResult(result: ResourceResult, method: HttpMethods, path: stri export interface ResourceResponse { body?: T; - headers?: RequestCallbackHeaders; + headers?: ResponseHeaders; unpacked?: boolean; statusCode?: number; } diff --git a/src/common/types/http.ts b/src/common/types/http.ts index d4e6a42d7c..92cc99f1a5 100644 --- a/src/common/types/http.ts +++ b/src/common/types/http.ts @@ -8,16 +8,16 @@ import Logger from 'common/lib/util/logger'; import * as Utils from 'common/lib/util/utils'; export type PathParameter = string | ((host: string) => string); -export type RequestCallbackHeaders = Partial>; -export type RequestCallbackError = ErrnoException | IPartialErrorInfo; +export type ResponseHeaders = Partial>; +export type RequestResultError = ErrnoException | IPartialErrorInfo; /** * The `body`, `headers`, `unpacked`, and `statusCode` properties of a `RequestResult` may be populated even if its `error` property is non-null. */ export type RequestResult = { - error: RequestCallbackError | null; + error: RequestResultError | null; body?: unknown; - headers?: RequestCallbackHeaders; + headers?: ResponseHeaders; unpacked?: boolean; statusCode?: number; }; @@ -55,7 +55,7 @@ export interface IPlatformHttp { /** * @param error An error from the {@link RequestResult.error} property of a result returned by {@link doUri}. */ - shouldFallback(error: RequestCallbackError): boolean; + shouldFallback(error: RequestResultError): boolean; } export function paramString(params: Record | null) { diff --git a/src/platform/nodejs/lib/util/http.ts b/src/platform/nodejs/lib/util/http.ts index 2306d50856..9db64b7ed9 100644 --- a/src/platform/nodejs/lib/util/http.ts +++ b/src/platform/nodejs/lib/util/http.ts @@ -5,7 +5,7 @@ import { ErrnoException, RequestBody, IPlatformHttpStatic, - RequestCallbackError, + RequestResultError, RequestParams, RequestResult, } from '../../../../common/types/http'; @@ -158,7 +158,7 @@ const Http: IPlatformHttpStatic = class { return !error && (body as Buffer | string)?.toString().trim() === 'yes'; }; - shouldFallback(err: RequestCallbackError) { + shouldFallback(err: RequestResultError) { const { code, statusCode } = err as ErrnoException; return ( code === 'ENETUNREACH' || diff --git a/src/platform/web/lib/http/http.ts b/src/platform/web/lib/http/http.ts index 88d1f88fd8..d42392ebe4 100644 --- a/src/platform/web/lib/http/http.ts +++ b/src/platform/web/lib/http/http.ts @@ -1,7 +1,7 @@ import Platform from 'common/platform'; import Defaults from 'common/lib/util/defaults'; import ErrorInfo, { PartialErrorInfo } from 'common/lib/types/errorinfo'; -import { RequestBody, RequestCallbackError, RequestParams, RequestResult } from 'common/types/http'; +import { RequestBody, RequestResultError, RequestParams, RequestResult } from 'common/types/http'; import HttpMethods from 'common/constants/HttpMethods'; import BaseClient from 'common/lib/client/baseclient'; import XHRStates from 'common/constants/XHRStates'; @@ -158,7 +158,7 @@ const Http = class { supportsAuthHeaders = false; supportsLinkHeaders = false; - shouldFallback(errorInfo: RequestCallbackError) { + shouldFallback(errorInfo: RequestResultError) { const statusCode = errorInfo.statusCode as number; /* 400 + no code = a generic xhr onerror. Browser doesn't give us enough * detail to know whether it's fallback-fixable, but it may be (eg if a diff --git a/src/platform/web/lib/http/request/fetchrequest.ts b/src/platform/web/lib/http/request/fetchrequest.ts index cbe6b826b9..22cee07069 100644 --- a/src/platform/web/lib/http/request/fetchrequest.ts +++ b/src/platform/web/lib/http/request/fetchrequest.ts @@ -1,13 +1,7 @@ import HttpMethods from 'common/constants/HttpMethods'; import BaseClient from 'common/lib/client/baseclient'; import ErrorInfo, { PartialErrorInfo } from 'common/lib/types/errorinfo'; -import { - RequestBody, - RequestCallbackError, - RequestCallbackHeaders, - RequestParams, - RequestResult, -} from 'common/types/http'; +import { RequestBody, RequestResultError, ResponseHeaders, RequestParams, RequestResult } from 'common/types/http'; import Platform from 'common/platform'; import Defaults from 'common/lib/util/defaults'; import * as Utils from 'common/lib/util/utils'; @@ -23,7 +17,7 @@ function getAblyError(responseBody: unknown, headers: Headers) { } function convertHeaders(headers: Headers) { - const result: RequestCallbackHeaders = {}; + const result: ResponseHeaders = {}; headers.forEach((value, key) => { result[key] = value; @@ -100,7 +94,7 @@ export default async function fetchRequest( } } catch (error) { clearTimeout(timeout!); - return { error: error as RequestCallbackError }; + return { error: error as RequestResultError }; } })();