Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove fetch as a dependency + fix bug with error reporting #5

Merged
merged 2 commits into from
Sep 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
"devDependencies": {
"@jest/globals": "^29.4.1",
"@types/json-server": "^0.14.4",
"@types/node-fetch": "^2.6.2",
"@types/signal-exit": "^3.0.1",
"@types/superagent": "^4.1.16",
"@types/uuid": "^9.0.1",
Expand All @@ -44,7 +43,6 @@
"got": "^12.5.3",
"jest": "^29.2.1",
"json-server": "^0.17.0",
"node-fetch": "2",
"openai": "^4.10.0",
"postgres": "^3.3.4",
"prettier": "^2.8.1",
Expand Down
34 changes: 13 additions & 21 deletions src/api.ts
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
import { HeaderOptionType, EventRequestType, ErrorPayloadType } from './types';
import { errors } from './constants';
import { post } from './utils';

const postError = async (
errorSinkUrl: string,
errorPayload: ErrorPayloadType,
options: HeaderOptionType
) => {
try {
const response = await fetch(errorSinkUrl, {
method: 'POST',
body: JSON.stringify(errorPayload),
headers: options.headers
});
const data = await response.json();
return data;
const response = await post(
errorSinkUrl,
errorPayload,
options.headers.Authorization
);
return response;
} catch (e) {
console.warn(`Failed to report error to ${errorSinkUrl}`);
return null;
Expand All @@ -25,20 +24,13 @@ const postEvents = async (
data: Array<EventRequestType>,
options: HeaderOptionType
) => {
const response = await fetch(eventSinkUrl, {
method: 'POST',
body: JSON.stringify(data),
headers: options.headers
});
const responseData = await response.json();
const response = await post(
eventSinkUrl,
data,
options.headers.Authorization
);

if (response.status === 401) {
throw new Error(errors.UNAUTHORIZED);
}
if (!response.ok) {
throw new Error(errors.POSTING_EVENTS);
}
return responseData;
return response;
};

export { postError, postEvents };
2 changes: 1 addition & 1 deletion src/constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ const errors = {
'No Client Secret Provided, set SUPERGOOD_CLIENT_SECRET or pass it as an argument'
};

const TestErrorPath = '/supergood-test-error';
const TestErrorPath = '/api/supergood-test-error';
const LocalClientId = 'local-client-id';
const LocalClientSecret = 'local-client-secret';

Expand Down
6 changes: 3 additions & 3 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,9 @@ const Supergood = () => {
stdTTL: 0
});

errorSinkUrl = `${baseUrl}${supergoodConfig.errorSinkEndpoint}`;
eventSinkUrl = `${baseUrl}${supergoodConfig.eventSinkEndpoint}`;

headerOptions = getHeaderOptions(clientId, clientSecret);
log = logger({ errorSinkUrl, headerOptions });

Expand Down Expand Up @@ -149,9 +152,6 @@ const Supergood = () => {
}
});

errorSinkUrl = `${baseUrl}${supergoodConfig.errorSinkEndpoint}`;
eventSinkUrl = `${baseUrl}${supergoodConfig.eventSinkEndpoint}`;

// Flushes the cache every <flushInterval> milliseconds
interval = setInterval(flushCache, supergoodConfig.flushInterval);
interval.unref();
Expand Down
60 changes: 58 additions & 2 deletions src/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,14 @@ import {
RequestType,
ResponseType,
EventRequestType,
ConfigType
ConfigType,
ErrorPayloadType
} from './types';
import crypto from 'crypto';
import { postError } from './api';
import { name, version } from '../package.json';
import https from 'https';
import { errors } from './constants';

import set from 'lodash.set';
import get from 'lodash.get';
Expand All @@ -35,6 +38,7 @@ const logger = ({
JSON.stringify(payload, null, 2),
error
);
console.log({ reportOut, errorSinkUrl });
if (reportOut && errorSinkUrl) {
postError(
errorSinkUrl,
Expand Down Expand Up @@ -166,6 +170,57 @@ const shouldCachePayload = (
return true;
};

function post(
url: string,
data: Array<EventRequestType> | ErrorPayloadType,
authorization: string
): Promise<string> {
const dataString = JSON.stringify(data);

const options = {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Content-Length': dataString.length,
Authorization: authorization
},
timeout: 5000 // in ms
};

return new Promise((resolve, reject) => {
const req = https.request(url, options, (res) => {
if (res && res.statusCode) {
if (res.statusCode === 401) {
return reject(new Error(errors.UNAUTHORIZED));
}

if (res.statusCode < 200 || res.statusCode > 299) {
return reject(new Error(`HTTP status code ${res.statusCode}`));
}
}

const body = [] as Buffer[];
res.on('data', (chunk) => body.push(chunk));
res.on('end', () => {
const resString = Buffer.concat(body).toString();
resolve(resString);
});
});

req.on('error', (err) => {
reject(err);
});

req.on('timeout', () => {
req.destroy();
reject(new Error('Request time out'));
});

req.write(dataString);
req.end();
});
}

const sleep = (ms: number) => {
return new Promise((resolve) => setTimeout(resolve, ms));
};
Expand All @@ -178,5 +233,6 @@ export {
safeParseJson,
prepareData,
shouldCachePayload,
sleep
sleep,
post
};
19 changes: 1 addition & 18 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -827,14 +827,6 @@
resolved "https://registry.npmjs.org/@types/node-cleanup/-/node-cleanup-2.1.2.tgz"
integrity sha512-HTksao/sZs9nqxKD/vWOR3WxSrQsyJlBPEFFCgq9lMmhRsuQF+2p6hy+7FaCYn6lOeiDc3ywI8jDQ2bz5y6m8w==

"@types/node-fetch@^2.6.2":
version "2.6.2"
resolved "https://registry.npmjs.org/@types/node-fetch/-/node-fetch-2.6.2.tgz"
integrity sha512-DHqhlq5jeESLy19TYhLakJ07kNumXWjcDdxXsLUMJZ6ue8VZJj4kLPQVE/2mdHh3xZziNF1xppu5lwmS53HR+A==
dependencies:
"@types/node" "*"
form-data "^3.0.0"

"@types/node-fetch@^2.6.4":
version "2.6.6"
resolved "https://registry.yarnpkg.com/@types/node-fetch/-/node-fetch-2.6.6.tgz#b72f3f4bc0c0afee1c0bc9cff68e041d01e3e779"
Expand Down Expand Up @@ -2359,15 +2351,6 @@ form-data-encoder@^2.1.2:
resolved "https://registry.npmjs.org/form-data-encoder/-/form-data-encoder-2.1.4.tgz"
integrity sha512-yDYSgNMraqvnxiEXO4hi88+YZxaHC6QKzb5N84iRCTDeRO7ZALpir/lVmf/uXUhnwUr2O4HU8s/n6x+yNjQkHw==

form-data@^3.0.0:
version "3.0.1"
resolved "https://registry.npmjs.org/form-data/-/form-data-3.0.1.tgz"
integrity sha512-RHkBKtLWUVwd7SqRIvCZMEvAMoGUp0XU+seQiZejj0COz3RI3hWP4sCv3gZWWLjJTd7rGwcsF5eKZGii0r/hbg==
dependencies:
asynckit "^0.4.0"
combined-stream "^1.0.8"
mime-types "^2.1.12"

form-data@^4.0.0:
version "4.0.0"
resolved "https://registry.npmjs.org/form-data/-/form-data-4.0.0.tgz"
Expand Down Expand Up @@ -3821,7 +3804,7 @@ [email protected]:
resolved "https://registry.yarnpkg.com/node-domexception/-/node-domexception-1.0.0.tgz#6888db46a1f71c0b76b3f7555016b63fe64766e5"
integrity sha512-/jKZoMpw0F8GRwl4/eLROPA3cfcXtLApP0QzLmUT/HuPCZWyB7IY9ZrMeKw2O/nFIqPQB3PVM9aYm0F312AXDQ==

node-fetch@2, node-fetch@^2.6.7:
node-fetch@^2.6.7:
version "2.7.0"
resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.7.0.tgz#d0f0fa6e3e2dc1d27efcd8ad99d550bda94d187d"
integrity sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==
Expand Down