Skip to content

Consider isLocalDevelopment flag, export formatAxiosError #8

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

Merged
merged 1 commit into from
Dec 2, 2024
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: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@devrev/ts-adaas",
"version": "1.0.1",
"version": "1.0.2",
"description": "Typescript library containing the ADaaS(AirDrop as a Service) control protocol.",
"type": "commonjs",
"main": "./dist/index.js",
Expand Down
4 changes: 2 additions & 2 deletions src/common/control-protocol.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export const emit = async ({
};

return new Promise<void>(async (resolve, reject) => {
console.info('Emitting event', newEvent);
console.info('Emitting event', JSON.stringify(newEvent));

try {
await axios.post(
Expand Down Expand Up @@ -63,7 +63,7 @@ export const emit = async ({
error
);
}
reject(error);
reject();
}
});
};
2 changes: 2 additions & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,5 @@ export { processTask } from './workers/process-task';
export { spawn } from './workers/spawn';

export * from './types/workers';

export { formatAxiosError } from './logger/logger';
8 changes: 8 additions & 0 deletions src/logger/logger.interfaces.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
import { AirdropEvent } from '../types/extraction';
import { WorkerAdapterOptions } from '../types/workers';

export interface LoggerFactoryInterface {
event: AirdropEvent;
options?: WorkerAdapterOptions;
}

export enum LogLevel {
INFO = 'info',
WARN = 'warn',
Expand Down
27 changes: 21 additions & 6 deletions src/logger/logger.ts
Original file line number Diff line number Diff line change
@@ -1,16 +1,26 @@
/* eslint-disable @typescript-eslint/no-explicit-any */
import log from 'lambda-log';
import { Console } from 'node:console';

import { LogLevel, PrintableArray, PrintableState } from './logger.interfaces';
import { AirdropEvent } from '../types';
import {
LoggerFactoryInterface,
LogLevel,
PrintableArray,
PrintableState,
} from './logger.interfaces';
import { isMainThread, parentPort } from 'node:worker_threads';
import { WorkerMessageSubject } from '../types/workers';
import { WorkerAdapterOptions, WorkerMessageSubject } from '../types/workers';
import { AxiosError } from 'axios';
import { AirdropEvent } from '../types/extraction';

export class Logger extends Console {
constructor(event: AirdropEvent) {
private event: AirdropEvent;
private options?: WorkerAdapterOptions;

constructor({ event, options }: LoggerFactoryInterface) {
super(process.stdout, process.stderr);
this.event = event;
this.options = options;

log.options.levelKey = null;
log.options.tagsKey = null;
log.options.messageKey = 'message';
Expand All @@ -21,7 +31,11 @@ export class Logger extends Console {

logFn(args: unknown[], level: LogLevel): void {
if (isMainThread) {
log.log(level, JSON.stringify(args));
if (this.options?.isLocalDevelopment) {
console[level](...args);
} else {
log.log(level, JSON.stringify(args));
}
} else {
parentPort?.postMessage({
subject: WorkerMessageSubject.WorkerMessageLog,
Expand Down Expand Up @@ -87,6 +101,7 @@ export function formatAxiosError(error: AxiosError): object {
method: error.config?.method,
baseURL: error.config?.baseURL,
url: error.config?.url,
payload: error.config?.data,
};
}

Expand Down
6 changes: 5 additions & 1 deletion src/types/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,11 @@ export {
} from './extraction';

// Repo
export { NormalizedItem, NormalizedAttachment } from '../repo/repo.interfaces';
export {
NormalizedItem,
NormalizedAttachment,
RepoInterface,
} from '../repo/repo.interfaces';

// State
export { AdapterState } from '../state/state.interfaces';
Expand Down
5 changes: 3 additions & 2 deletions src/types/workers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export interface WorkerAdapterInterface<ConnectorState> {
event: AirdropEvent;
adapterState: State<ConnectorState>;
parentPort: MessagePort;
options: WorkerAdapterOptions;
options?: WorkerAdapterOptions;
}

/**
Expand All @@ -46,7 +46,7 @@ export type SpawnResolve = (value: boolean | PromiseLike<boolean>) => void;
export interface SpawnInterface {
event: AirdropEvent;
worker: Worker;
options: WorkerAdapterOptions | null;
options?: WorkerAdapterOptions;
resolve: SpawnResolve;
}

Expand Down Expand Up @@ -159,4 +159,5 @@ export interface WorkerData<ConnectorState> {
export interface GetWorkerPathInterface {
event: AirdropEvent;
connectorWorkerPath?: string | null;
options?: WorkerAdapterOptions;
}
11 changes: 7 additions & 4 deletions src/workers/create-worker.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,19 @@ async function createWorker<ConnectorState>(
): Promise<Worker> {
return new Promise<Worker>((resolve, reject) => {
if (isMainThread) {
const logger = new Logger(workerData.event);
const logger = new Logger({
event: workerData.event,
options: workerData.options,
});
const workerFile = __dirname + '/worker.js';

const worker: Worker = new Worker(workerFile, {
workerData,
} as WorkerOptions);

worker.on(WorkerEvent.WorkerError, (error: Error) => {
logger.error('Worker error', error);
reject(error);
worker.on(WorkerEvent.WorkerError, () => {
logger.error('Worker error');
reject();
});
worker.on(WorkerEvent.WorkerOnline, () => {
resolve(worker);
Expand Down
2 changes: 1 addition & 1 deletion src/workers/process-task.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export function processTask<ConnectorState>({
const event = workerData.event;
const initialState = workerData.initialState as ConnectorState;
const options = workerData.options;
console = new Logger(event);
console = new Logger({ event, options });

const adapterState = await createAdapterState<ConnectorState>({
event,
Expand Down
10 changes: 6 additions & 4 deletions src/workers/spawn.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,9 @@ import { LogLevel } from '../logger/logger.interfaces';
function getWorkerPath({
event,
connectorWorkerPath,
options,
}: GetWorkerPathInterface): string | null {
const logger = new Logger(event);
const logger = new Logger({ event, options });

if (!ALLOWED_EVENT_TYPES.includes(event.payload.event_type)) {
return null;
Expand Down Expand Up @@ -79,10 +80,11 @@ export async function spawn<ConnectorState>({
}: SpawnFactoryInterface<ConnectorState>): Promise<
boolean | PromiseLike<boolean>
> {
const logger = new Logger(event);
const logger = new Logger({ event, options });
const script = getWorkerPath({
event,
connectorWorkerPath: workerPath,
options,
});

if (script) {
Expand All @@ -98,7 +100,7 @@ export async function spawn<ConnectorState>({
new Spawn({
event,
worker,
options: options || null,
options,
resolve,
});
});
Expand Down Expand Up @@ -141,7 +143,7 @@ export class Spawn {
}
}, this.lambdaTimeout);

this.logger = new Logger(event);
this.logger = new Logger({ event, options });
this.worker = worker;
worker.on(WorkerEvent.WorkerExit, async (code) => {
this.logger.info('Worker exited with exit code: ' + code + '.');
Expand Down
2 changes: 1 addition & 1 deletion src/workers/worker-adapter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export function createWorkerAdapter<ConnectorState>({
*/
export class WorkerAdapter<ConnectorState> {
readonly event: AirdropEvent;
readonly options: WorkerAdapterOptions;
readonly options?: WorkerAdapterOptions;

private adapterState: State<ConnectorState>;
private _artifacts: Artifact[];
Expand Down