dev: remove unecessary packages and create base controllers and initiate server

This commit is contained in:
pablohashescobar 2023-12-07 16:35:35 +05:30
parent 5233c60da8
commit affbe62f21
12 changed files with 1500 additions and 5 deletions

3
.gitignore vendored
View File

@ -80,3 +80,6 @@ tmp/
## packages ## packages
dist dist
.temp/ .temp/
# Log files
*.log

View File

@ -16,10 +16,8 @@
"@sentry/tracing": "^7.73.0", "@sentry/tracing": "^7.73.0",
"cors": "^2.8.5", "cors": "^2.8.5",
"dotenv": "^16.3.1", "dotenv": "^16.3.1",
"drizzle-orm": "^0.28.6",
"express": "^4.18.2", "express": "^4.18.2",
"postgres": "^3.4.1", "postgres": "^3.4.1",
"stripe": "^14.1.0",
"winston": "^3.10.0", "winston": "^3.10.0",
"zod": "^3.22.4" "zod": "^3.22.4"
}, },
@ -29,7 +27,6 @@
"@types/node": "^20.8.3", "@types/node": "^20.8.3",
"@types/pg": "^8.10.7", "@types/pg": "^8.10.7",
"concurrently": "^8.2.1", "concurrently": "^8.2.1",
"drizzle-kit": "^0.19.13",
"nodemon": "^3.0.1", "nodemon": "^3.0.1",
"typescript": "^5.2.2" "typescript": "^5.2.2"
} }

View File

@ -0,0 +1,10 @@
import { Request, Response } from "express";
import { Controller, Get } from "@overnightjs/core";
@Controller("/api/github")
export class GithubController {
/**
* This controller houses all routes for the Github Importer/Integration
*/
}

View File

@ -0,0 +1,3 @@
export * from "./jira.controller";
export * from "./slack.controller"
export * from "./github.controller"

View File

@ -0,0 +1,10 @@
import { Request, Response } from "express";
import { Controller, Get } from "@overnightjs/core";
@Controller("/api/jira")
export class JiraController {
/**
* This controller houses all routes for the Jira Importer
*/
}

View File

@ -0,0 +1,10 @@
import { Request, Response } from "express";
import { Controller, Get } from "@overnightjs/core";
@Controller("/api/slack")
export class SlackController {
/**
* This controller houses all routes for the Slack Integration
*/
}

View File

@ -0,0 +1,8 @@
import { RequestHandler } from "express";
import { logger } from "../utils/logger";
const loggerMiddleware: RequestHandler = (req, res, next) => {
logger.info(`${req.method}: ${req.path}`);
next();
};
export default loggerMiddleware;

View File

@ -0,0 +1,112 @@
import dotenv from "dotenv";
import path from "path";
import express from "express";
import { Server } from "@overnightjs/core";
import cors from "cors";
import * as Sentry from "@sentry/node";
import * as Tracing from "@sentry/tracing";
// controllers
import * as controllers from "./controllers";
// middlewares
import loggerMiddleware from "./middlewares/logger.middleware";
// utils
import { logger } from "./utils/logger";
class ApiServer extends Server {
private readonly SERVER_STARTED = "Api server started on port: ";
SERVER_PORT: number;
constructor() {
super(true);
// disabling overnight logs
this.showLogs = false;
// enabling env variable from .env file
dotenv.config();
// assigning port
this.SERVER_PORT = process.env.SERVER_PORT
? parseInt(process.env.SERVER_PORT, 10)
: 8080;
// logger
this.app.use(loggerMiddleware);
// exposing public folder for static files.
this.app.use(express.static("public"));
// body parser
this.app.use(express.json());
this.app.use(express.urlencoded({ extended: true }));
// views engine
this.app.set("views", path.join(__dirname, "views"));
this.app.set("view engine", "hbs");
// cors
this.app.use(cors());
// sentry setup
if (
process.env.APP_ENV === "staging" ||
process.env.APP_ENV === "production"
) {
// setting up error logging and tracing.
this.setupSentryInit();
}
// setting up controllers
this.setupControllers();
// setting up sentry error handling
this.sentryErrorHandling();
}
public getAppInstance() {
return this.app;
}
private setupControllers(): void {
const controllerInstances = [];
for (const name in controllers) {
if (Object.prototype.hasOwnProperty.call(controllers, name)) {
const Controller = (controllers as any)[name];
controllerInstances.push(new Controller());
}
}
super.addControllers(controllerInstances);
}
private setupSentryInit() {
Sentry.init({
dsn: "",
integrations: [
// enable HTTP calls tracing
new Sentry.Integrations.Http({ tracing: true }),
// enable Express.js middleware tracing
new Tracing.Integrations.Express({ app: this.app }),
],
// Set tracesSampleRate to 1.0 to capture 100%
// of transactions for performance monitoring.
// We recommend adjusting this value in production
tracesSampleRate: 1.0,
});
// RequestHandler creates a separate execution context using domains, so that every
// transaction/span/breadcrumb is attached to its own Hub instance
this.app.use(Sentry.Handlers.requestHandler());
// TracingHandler creates a trace for every incoming request
this.app.use(Sentry.Handlers.tracingHandler());
}
private sentryErrorHandling() {
// The error handler must be before any other error middleware and after all controllers
this.app.use(Sentry.Handlers.errorHandler());
this.app.use(function onError(req, res: any) {
// The error id is attached to `res.sentry` to be returned
// and optionally displayed to the user for support.
res.statusCode = 500;
res.end(res.sentry + "\n");
});
}
public start(port: number): void {
this.app.listen(port, () => {
logger.info(this.SERVER_STARTED + port);
});
}
}
export default ApiServer;

View File

@ -0,0 +1,5 @@
import ApiServer from "./server";
const apiServer = new ApiServer();
// starting server
apiServer.start(apiServer.SERVER_PORT);

View File

@ -0,0 +1,8 @@
import winston from "winston";
export const logger = winston.createLogger({
transports: [
new winston.transports.Console(),
new winston.transports.File({ filename: "combined.log" }),
],
});

View File

@ -1,8 +1,9 @@
{ {
"extends": "tsconfig/express.json", "extends": "tsconfig/express.json",
"include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", "additional.d.ts"], "include": ["src/**/*.ts"],
"exclude": ["node_modules"], "exclude": ["node_modules"],
"compilerOptions": { "compilerOptions": {
"baseUrl": "src/" "baseUrl": "src/",
"outDir": "./dist",
} }
} }

1328
segway/yarn.lock Normal file

File diff suppressed because it is too large Load Diff