From 22a9bc4112e77c266eb9b511abdaec15c28cc033 Mon Sep 17 00:00:00 2001 From: Alexandro Castro <10711649+AlexcastroDev@users.noreply.github.com> Date: Tue, 3 Oct 2023 15:50:52 +0100 Subject: [PATCH] chore: retries improvements (#230) * chore: retries improvements * chore: improvements on retries * chore: improvements on retries * chore: add unit test * chore: format * chore: format * chore: format * fix: remove console --- .gitignore | 3 +- deps.ts | 12 +- src/.DS_Store | Bin 6148 -> 0 bytes src/Helpers/Retry.ts | 20 +- src/Services/GithubApiService.ts | 60 +- src/Services/__mocks__/notFoundUserMock.json | 20 + src/Services/__mocks__/rateLimitMock.json | 18 + .../__mocks__/successGithubResponse.json | 1541 +++++++++++++++++ .../__tests__/githubApiService.test.ts | 145 ++ src/Services/request.ts | 62 + src/Types/Request.ts | 12 +- src/Types/ServiceError.ts | 1 + 12 files changed, 1843 insertions(+), 51 deletions(-) delete mode 100644 src/.DS_Store create mode 100644 src/Services/__mocks__/notFoundUserMock.json create mode 100644 src/Services/__mocks__/rateLimitMock.json create mode 100644 src/Services/__mocks__/successGithubResponse.json create mode 100644 src/Services/__tests__/githubApiService.test.ts create mode 100644 src/Services/request.ts diff --git a/.gitignore b/.gitignore index 91b922d..d59edcf 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ .vscode .env .idea -.lock +deno.lock *.sh +**/.DS_Store diff --git a/deps.ts b/deps.ts index 4b51bfc..691ef99 100644 --- a/deps.ts +++ b/deps.ts @@ -6,7 +6,9 @@ import { } from "https://deno.land/std@0.203.0/assert/mod.ts"; import { assertSpyCalls, + returnsNext, spy, + stub, } from "https://deno.land/std@0.203.0/testing/mock.ts"; import { CONSTANTS } from "./src/utils.ts"; @@ -18,4 +20,12 @@ const soxa = new ServiceProvider({ baseURL, }); -export { assertEquals, assertRejects, assertSpyCalls, soxa, spy }; +export { + assertEquals, + assertRejects, + assertSpyCalls, + returnsNext, + soxa, + spy, + stub, +}; diff --git a/src/.DS_Store b/src/.DS_Store deleted file mode 100644 index dbcdcabe06f6c0b9f79fd341be39ab7c161065a8..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 6148 zcmeH~%}T>i5QWcZ7X>$6c6ndHHwdM^fO!GMmLfYKm=w9c<-ex?^3mjfCz}d4*~x^G`ee7 zI;O^_gG-D6)CI#~ypCCd+B`t*O2<@2XqKhaEVUXjEXx^hmDiPysaX!I;lt|5RuhWF z(|LZ2bXb?FRRl!fn!s&tSKj|0=)cVW*G1ZifC&660=C%p+YMi-dh6unyw^7R6aCwm o8|hr46;q=XbK|XeeUaDvn)kcXF*V8=k8-Mh1e}XZ1pb1+7jJhOK>z>% diff --git a/src/Helpers/Retry.ts b/src/Helpers/Retry.ts index a7ce9a9..7718f78 100644 --- a/src/Helpers/Retry.ts +++ b/src/Helpers/Retry.ts @@ -1,3 +1,4 @@ +import { ServiceError } from "../Types/index.ts"; import { Logger } from "./Logger.ts"; export type RetryCallbackProps = { @@ -12,11 +13,17 @@ async function* createAsyncIterable( delay: number, ) { for (let i = 0; i < retries; i++) { + const isLastAttempt = i === retries - 1; try { const data = await callback({ attempt: i }); yield data; return; } catch (e) { + if (e instanceof ServiceError && isLastAttempt) { + yield e; + return; + } + yield null; Logger.error(e); await new Promise((resolve) => setTimeout(resolve, delay)); @@ -29,6 +36,7 @@ export class Retry { async fetch( callback: callbackType, ) { + let lastError = null; for await ( const callbackResult of createAsyncIterable( callback, @@ -36,11 +44,19 @@ export class Retry { this.retryDelay, ) ) { - if (callbackResult) { + const isError = callbackResult instanceof Error; + + if (callbackResult && !isError) { return callbackResult as T; } + + if (isError) { + lastError = callbackResult; + } } - throw new Error(`Max retries (${this.maxRetries}) exceeded.`); + throw new Error(`Max retries (${this.maxRetries}) exceeded.`, { + cause: lastError, + }); } } diff --git a/src/Services/GithubApiService.ts b/src/Services/GithubApiService.ts index 18c046e..6960de6 100644 --- a/src/Services/GithubApiService.ts +++ b/src/Services/GithubApiService.ts @@ -12,13 +12,12 @@ import { queryUserPullRequest, queryUserRepository, } from "../Schemas/index.ts"; -import { soxa } from "../../deps.ts"; import { Retry } from "../Helpers/Retry.ts"; -import { GithubError, QueryDefaultResponse } from "../Types/index.ts"; import { CONSTANTS } from "../utils.ts"; import { EServiceKindError } from "../Types/EServiceKindError.ts"; import { ServiceError } from "../Types/ServiceError.ts"; import { Logger } from "../Helpers/Logger.ts"; +import { requestGithubData } from "./request.ts"; // Need to be here - Exporting from another file makes array of null export const TOKENS = [ @@ -59,6 +58,7 @@ export class GithubApiService extends GithubRepository { async requestUserInfo(username: string): Promise { // Avoid to call others if one of them is null const repository = await this.requestUserRepository(username); + if (repository instanceof ServiceError) { Logger.error(repository); return repository; @@ -78,7 +78,7 @@ export class GithubApiService extends GithubRepository { if (status.includes("rejected")) { Logger.error(`Can not find a user with username:' ${username}'`); - return new ServiceError("not found", EServiceKindError.NOT_FOUND); + return new ServiceError("Not found", EServiceKindError.NOT_FOUND); } return new UserInfo( @@ -89,27 +89,6 @@ export class GithubApiService extends GithubRepository { ); } - private handleError(responseErrors: GithubError[]): ServiceError { - const errors = responseErrors ?? []; - - const isRateLimitExceeded = errors.some((error) => - error.type.includes(EServiceKindError.RATE_LIMIT) || - error.message.includes("rate limit") - ); - - if (isRateLimitExceeded) { - throw new ServiceError( - "Rate limit exceeded", - EServiceKindError.RATE_LIMIT, - ); - } - - throw new ServiceError( - "unknown error", - EServiceKindError.NOT_FOUND, - ); - } - async executeQuery( query: string, variables: { [key: string]: string }, @@ -120,36 +99,25 @@ export class GithubApiService extends GithubRepository { CONSTANTS.DEFAULT_GITHUB_RETRY_DELAY, ); const response = await retry.fetch>(async ({ attempt }) => { - const res = await soxa.post("", {}, { - data: { query: query, variables }, - headers: { - Authorization: `bearer ${TOKENS[attempt]}`, - }, - }); - if (res?.data?.errors) { - return this.handleError(res?.data?.errors); - } - return res; - }) as QueryDefaultResponse<{ user: T }>; + return await requestGithubData( + query, + variables, + TOKENS[attempt], + ); + }); - return response?.data?.data?.user ?? - new ServiceError("not found", EServiceKindError.NOT_FOUND); + return response; } catch (error) { - if (error instanceof ServiceError) { - Logger.error(error); - return error; + if (error.cause instanceof ServiceError) { + Logger.error(error.cause.message); + return error.cause; } - // TODO: Move this to a logger instance later if (error instanceof Error && error.cause) { Logger.error(JSON.stringify(error.cause, null, 2)); } else { Logger.error(error); } - - return new ServiceError( - "Rate limit exceeded", - EServiceKindError.RATE_LIMIT, - ); + return new ServiceError("not found", EServiceKindError.NOT_FOUND); } } } diff --git a/src/Services/__mocks__/notFoundUserMock.json b/src/Services/__mocks__/notFoundUserMock.json new file mode 100644 index 0000000..75a76f4 --- /dev/null +++ b/src/Services/__mocks__/notFoundUserMock.json @@ -0,0 +1,20 @@ +{ + "data": { + "user": null + }, + "errors": [ + { + "type": "NOT_FOUND", + "path": [ + "user" + ], + "locations": [ + { + "line": 2, + "column": 5 + } + ], + "message": "Could not resolve to a User with the login of 'alekinho'." + } + ] +} diff --git a/src/Services/__mocks__/rateLimitMock.json b/src/Services/__mocks__/rateLimitMock.json new file mode 100644 index 0000000..c49ffb2 --- /dev/null +++ b/src/Services/__mocks__/rateLimitMock.json @@ -0,0 +1,18 @@ +{ + "exceeded": { + "data": { + "documentation_url": "https://docs.github.com/en/free-pro-team@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits", + "message": "You have exceeded a secondary rate limit. Please wait a few minutes before you try again. If you reach out to GitHub Support for help, please include the request ID DBD8:FB98:31801A8:3222432:65195FDB." + } + }, + "rate_limit": { + "data": { + "errors": [ + { + "type": "RATE_LIMITED", + "message": "API rate limit exceeded for user ID 10711649." + } + ] + } + } +} diff --git a/src/Services/__mocks__/successGithubResponse.json b/src/Services/__mocks__/successGithubResponse.json new file mode 100644 index 0000000..d8198b5 --- /dev/null +++ b/src/Services/__mocks__/successGithubResponse.json @@ -0,0 +1,1541 @@ +{ + "data": { + "data": { + "user": { + "repositories": { + "totalCount": 128, + "nodes": [ + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + } + ] + }, + "stargazers": { + "totalCount": 23 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + } + ] + }, + "stargazers": { + "totalCount": 11 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + } + ] + }, + "stargazers": { + "totalCount": 9 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + } + ] + }, + "stargazers": { + "totalCount": 6 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + } + ] + }, + "stargazers": { + "totalCount": 6 + } + }, + { + "languages": { + "nodes": [ + { + "name": "Java" + } + ] + }, + "stargazers": { + "totalCount": 5 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + } + ] + }, + "stargazers": { + "totalCount": 5 + } + }, + { + "languages": { + "nodes": [ + { + "name": "Jupyter Notebook" + } + ] + }, + "stargazers": { + "totalCount": 5 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + } + ] + }, + "stargazers": { + "totalCount": 4 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + } + ] + }, + "stargazers": { + "totalCount": 3 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + } + ] + }, + "stargazers": { + "totalCount": 2 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + } + ] + }, + "stargazers": { + "totalCount": 2 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + } + ] + }, + "stargazers": { + "totalCount": 2 + } + }, + { + "languages": { + "nodes": [] + }, + "stargazers": { + "totalCount": 1 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + } + ] + }, + "stargazers": { + "totalCount": 1 + } + }, + { + "languages": { + "nodes": [ + { + "name": "PHP" + }, + { + "name": "Go" + }, + { + "name": "HTML" + } + ] + }, + "stargazers": { + "totalCount": 1 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + }, + { + "name": "JavaScript" + }, + { + "name": "CSS" + } + ] + }, + "stargazers": { + "totalCount": 1 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + } + ] + }, + "stargazers": { + "totalCount": 1 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + }, + { + "name": "JavaScript" + }, + { + "name": "Dockerfile" + } + ] + }, + "stargazers": { + "totalCount": 1 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + }, + { + "name": "JavaScript" + }, + { + "name": "Dockerfile" + } + ] + }, + "stargazers": { + "totalCount": 1 + } + }, + { + "languages": { + "nodes": [ + { + "name": "Dart" + }, + { + "name": "Swift" + }, + { + "name": "Kotlin" + } + ] + }, + "stargazers": { + "totalCount": 1 + } + }, + { + "languages": { + "nodes": [ + { + "name": "HTML" + }, + { + "name": "CSS" + } + ] + }, + "stargazers": { + "totalCount": 1 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + }, + { + "name": "Vue" + }, + { + "name": "HTML" + } + ] + }, + "stargazers": { + "totalCount": 1 + } + }, + { + "languages": { + "nodes": [ + { + "name": "Jupyter Notebook" + }, + { + "name": "Python" + } + ] + }, + "stargazers": { + "totalCount": 1 + } + }, + { + "languages": { + "nodes": [ + { + "name": "Dart" + }, + { + "name": "HTML" + }, + { + "name": "Swift" + } + ] + }, + "stargazers": { + "totalCount": 1 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + }, + { + "name": "Vue" + }, + { + "name": "HTML" + } + ] + }, + "stargazers": { + "totalCount": 1 + } + }, + { + "languages": { + "nodes": [ + { + "name": "PHP" + } + ] + }, + "stargazers": { + "totalCount": 1 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + }, + { + "name": "CSS" + }, + { + "name": "JavaScript" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + }, + { + "name": "HTML" + }, + { + "name": "JavaScript" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + }, + { + "name": "CSS" + }, + { + "name": "JavaScript" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + }, + { + "name": "Shell" + }, + { + "name": "Dockerfile" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "CSS" + }, + { + "name": "TypeScript" + }, + { + "name": "JavaScript" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + }, + { + "name": "JavaScript" + }, + { + "name": "Dockerfile" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + }, + { + "name": "TypeScript" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + }, + { + "name": "CSS" + }, + { + "name": "JavaScript" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + }, + { + "name": "HTML" + }, + { + "name": "C#" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + }, + { + "name": "HTML" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + }, + { + "name": "JavaScript" + }, + { + "name": "CSS" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "PHP" + }, + { + "name": "Vue" + }, + { + "name": "Blade" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "CSS" + }, + { + "name": "TypeScript" + }, + { + "name": "JavaScript" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "C" + }, + { + "name": "C++" + }, + { + "name": "HTML" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "C++" + }, + { + "name": "Makefile" + }, + { + "name": "CMake" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + }, + { + "name": "JavaScript" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "C++" + }, + { + "name": "Makefile" + }, + { + "name": "CMake" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + }, + { + "name": "TypeScript" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + }, + { + "name": "CSS" + }, + { + "name": "HTML" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + }, + { + "name": "TypeScript" + }, + { + "name": "CSS" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + }, + { + "name": "JavaScript" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "Vue" + }, + { + "name": "TypeScript" + }, + { + "name": "CSS" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + }, + { + "name": "CSS" + }, + { + "name": "HTML" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + }, + { + "name": "HTML" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "PHP" + }, + { + "name": "JavaScript" + }, + { + "name": "Blade" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + }, + { + "name": "Rust" + }, + { + "name": "HTML" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + }, + { + "name": "Svelte" + }, + { + "name": "HTML" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "CSS" + }, + { + "name": "HTML" + }, + { + "name": "JavaScript" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + }, + { + "name": "Dockerfile" + }, + { + "name": "JavaScript" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "Rust" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + }, + { + "name": "Dockerfile" + }, + { + "name": "Shell" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + }, + { + "name": "Shell" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + }, + { + "name": "JavaScript" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "HTML" + }, + { + "name": "JavaScript" + }, + { + "name": "CSS" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + }, + { + "name": "CSS" + }, + { + "name": "HTML" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "Dart" + }, + { + "name": "HTML" + }, + { + "name": "Swift" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "Dart" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "Rust" + }, + { + "name": "JavaScript" + }, + { + "name": "HTML" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + }, + { + "name": "CSS" + }, + { + "name": "Swift" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + }, + { + "name": "JavaScript" + }, + { + "name": "SCSS" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + }, + { + "name": "Shell" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + }, + { + "name": "JavaScript" + }, + { + "name": "SCSS" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + }, + { + "name": "HTML" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + }, + { + "name": "JavaScript" + }, + { + "name": "HTML" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + }, + { + "name": "CSS" + }, + { + "name": "HTML" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + }, + { + "name": "JavaScript" + }, + { + "name": "CSS" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + }, + { + "name": "JavaScript" + }, + { + "name": "HTML" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + }, + { + "name": "JavaScript" + }, + { + "name": "HTML" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + }, + { + "name": "JavaScript" + }, + { + "name": "HTML" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + }, + { + "name": "SCSS" + }, + { + "name": "JavaScript" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + }, + { + "name": "JavaScript" + }, + { + "name": "SCSS" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + }, + { + "name": "HTML" + }, + { + "name": "CSS" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + }, + { + "name": "HTML" + }, + { + "name": "CSS" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "JavaScript" + }, + { + "name": "HTML" + }, + { + "name": "SCSS" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "Swift" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + }, + { + "name": "HTML" + }, + { + "name": "CSS" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + }, + { + "languages": { + "nodes": [ + { + "name": "TypeScript" + }, + { + "name": "HTML" + }, + { + "name": "CSS" + } + ] + }, + "stargazers": { + "totalCount": 0 + } + } + ] + } + } + } + } +} diff --git a/src/Services/__tests__/githubApiService.test.ts b/src/Services/__tests__/githubApiService.test.ts new file mode 100644 index 0000000..99c5935 --- /dev/null +++ b/src/Services/__tests__/githubApiService.test.ts @@ -0,0 +1,145 @@ +import { GithubApiService } from "../GithubApiService.ts"; +import { assertEquals, returnsNext, soxa, stub } from "../../../deps.ts"; +import { GitHubUserRepository } from "../../user_info.ts"; + +const rateLimitMock = await import("../__mocks__/rateLimitMock.json", { + assert: { type: "json" }, +}); + +const successGithubResponseMock = await import( + "../__mocks__/successGithubResponse.json", + { assert: { type: "json" } } +); + +const notFoundGithubResponseMock = await import( + "../__mocks__/notFoundUserMock.json", + { assert: { type: "json" } } +); + +import { ServiceError } from "../../Types/index.ts"; + +// Unfortunatelly, The spy is a global instance +// We can't reset mock as Jest does. +stub( + soxa, + "post", + returnsNext([ + // Should get data in first try + new Promise((resolve) => { + resolve(successGithubResponseMock.default); + }), + // // Should get data in second Retry + new Promise((resolve) => { + resolve(rateLimitMock.default.rate_limit); + }), + new Promise((resolve) => { + resolve(successGithubResponseMock.default); + }), + // Should throw NOT FOUND + new Promise((resolve) => { + resolve(notFoundGithubResponseMock.default); + }), + new Promise((resolve) => { + resolve(notFoundGithubResponseMock.default); + }), + // Should throw NOT FOUND even if request the user only + new Promise((resolve) => { + resolve(notFoundGithubResponseMock.default); + }), + new Promise((resolve) => { + resolve(notFoundGithubResponseMock.default); + }), + // Should throw RATE LIMIT + new Promise((resolve) => { + resolve(rateLimitMock.default.rate_limit); + }), + new Promise((resolve) => { + resolve(rateLimitMock.default.rate_limit); + }), + // Should throw RATE LIMIT Exceed + new Promise((resolve) => { + resolve(rateLimitMock.default.rate_limit); + }), + new Promise((resolve) => { + resolve(rateLimitMock.default.exceeded); + }), + ]), +); + +Deno.test("Should get data in first try", async () => { + const provider = new GithubApiService(); + + const data = await provider.requestUserRepository( + "test", + ) as GitHubUserRepository; + + assertEquals(data.repositories.totalCount, 128); +}); + +Deno.test("Should get data in second Retry", async () => { + const provider = new GithubApiService(); + + const data = await provider.requestUserRepository( + "test", + ) as GitHubUserRepository; + + assertEquals(data.repositories.totalCount, 128); +}); + +Deno.test("Should throw NOT FOUND", async () => { + const provider = new GithubApiService(); + let error = null; + + try { + error = await provider.requestUserInfo("test"); + } catch (e) { + error = e; + } + + assertEquals(error.code, 404); + assertEquals(error instanceof ServiceError, true); +}); +Deno.test("Should throw NOT FOUND even if request the user only", async () => { + const provider = new GithubApiService(); + let error = null; + + try { + error = await provider.requestUserRepository("test"); + } catch (e) { + error = e; + } + + assertEquals(error.code, 404); + assertEquals(error instanceof ServiceError, true); +}); + +// The assertRejects() assertion is a little more complicated +// mainly because it deals with Promises. +// https://docs.deno.com/runtime/manual/basics/testing/assertions#throws +Deno.test("Should throw RATE LIMIT", async () => { + const provider = new GithubApiService(); + let error = null; + + try { + error = await provider.requestUserRepository("test"); + } catch (e) { + error = e; + } + + assertEquals(error.code, 419); + assertEquals(error instanceof ServiceError, true); +}); + +Deno.test("Should throw RATE LIMIT Exceed", async () => { + const provider = new GithubApiService(); + let error = null; + + try { + error = await provider.requestUserRepository("test"); + } catch (e) { + error = e; + } + + assertEquals(error.code, 419); + assertEquals(error instanceof ServiceError, true); +}); diff --git a/src/Services/request.ts b/src/Services/request.ts new file mode 100644 index 0000000..8aff36f --- /dev/null +++ b/src/Services/request.ts @@ -0,0 +1,62 @@ +import { soxa } from "../../deps.ts"; +import { + EServiceKindError, + GithubErrorResponse, + GithubExceedError, + QueryDefaultResponse, + ServiceError, +} from "../Types/index.ts"; + +export async function requestGithubData( + query: string, + variables: { [key: string]: string }, + token = "", +) { + const response = await soxa.post("", {}, { + data: { query, variables }, + headers: { + Authorization: `bearer ${token}`, + }, + }) as QueryDefaultResponse<{ user: T }>; + const responseData = response.data; + + if (responseData?.data?.user) { + return responseData.data.user; + } + + throw handleError( + responseData as unknown as GithubErrorResponse | GithubExceedError, + ); +} + +function handleError( + reponseErrors: GithubErrorResponse | GithubExceedError, +): ServiceError { + let isRateLimitExceeded = false; + const arrayErrors = (reponseErrors as GithubErrorResponse)?.errors || []; + const objectError = (reponseErrors as GithubExceedError) || {}; + + if (Array.isArray(arrayErrors)) { + isRateLimitExceeded = arrayErrors.some((error) => + error.type.includes(EServiceKindError.RATE_LIMIT) + ); + } + + if (objectError?.message) { + isRateLimitExceeded = objectError?.message.includes( + "rate limit", + ); + } + + if (isRateLimitExceeded) { + throw new ServiceError( + "Rate limit exceeded", + EServiceKindError.RATE_LIMIT, + ); + } + + throw new ServiceError( + "unknown error", + EServiceKindError.NOT_FOUND, + ); +} diff --git a/src/Types/Request.ts b/src/Types/Request.ts index 85f1362..e0c97ad 100644 --- a/src/Types/Request.ts +++ b/src/Types/Request.ts @@ -3,9 +3,19 @@ export type GithubError = { type: string; }; +export type GithubErrorResponse = { + errors: GithubError[]; +}; + +export type GithubExceedError = { + documentation_url: string; + message: string; +}; + export type QueryDefaultResponse = { data: { data: T; - errors: GithubError[]; + errors?: GithubErrorResponse; + message?: string; }; }; diff --git a/src/Types/ServiceError.ts b/src/Types/ServiceError.ts index 8a0db07..cd0ec7a 100644 --- a/src/Types/ServiceError.ts +++ b/src/Types/ServiceError.ts @@ -3,6 +3,7 @@ import { EServiceKindError } from "./EServiceKindError.ts"; export class ServiceError extends Error { constructor(message: string, kind: EServiceKindError) { super(message); + this.message = message; this.name = "ServiceError"; this.cause = kind; }