CRUD API with Sequelize and Joi Validation by dipali-23 · Pull Request #1 · dipali-23/backend-practice

dipali-23 · 2025-01-31T06:49:44Z

No description provided.

…tand to make it reusable

akshaykher243 · 2025-01-31T07:05:28Z

config/db.js

+export default {
+  development: {
+    host: process.env.DB_HOST,
+    username: process.env.DB_USER,
+    password: process.env.DB_PASSWORD,
+    database: process.env.DB_NAME,
+    dialect: process.env.DB_DIALECT,
+  },


const {DB_HOST,DB_USER,DB_PASSWORD,DB_NAME,DB_DIALECT} = process.env
then use it like this way :

`export default {
development: {
host: DB_HOST,
username: DB_USER,
password: DB_PASSWORD,
database: DB_NAME,
dialect:DB_DIALECT,
},

akshaykher243 · 2025-01-31T07:06:43Z

config/sequelize.js

+
+sequelize.authenticate()
+  .then(() => {
+    console.log('Database connected successfully');


if possible then please used the Pino logger rather than console log : https://www.npmjs.com/package/pino

@dipali-23
Replace all console.log statements with the pino logger wherever they're used

vrajpatelTH · 2025-02-02T10:21:21Z

.gitignore

@@ -0,0 +1,5 @@
+# Node.js dependencies


Suggested change

# Node.js dependencies

# dependencies

vrajpatelTH · 2025-02-02T10:21:35Z

.gitignore

+# Node.js dependencies
+node_modules/
+
+# Environment variables (sensitive information)


Suggested change

# Environment variables (sensitive information)

# env variables

vrajpatelTH · 2025-02-02T10:23:35Z

config/db.js

+import { config } from 'dotenv';
+config();
+
+export default {
+  development: {
+    host: process.env.DB_HOST,
+    username: process.env.DB_USER,
+    password: process.env.DB_PASSWORD,
+    database: process.env.DB_NAME,
+    dialect: process.env.DB_DIALECT,
+  },


Suggested change

import { config } from 'dotenv';

config();

export default {

development: {

host: process.env.DB_HOST,

username: process.env.DB_USER,

password: process.env.DB_PASSWORD,

database: process.env.DB_NAME,

dialect: process.env.DB_DIALECT,

},

import { config } from 'dotenv';

config();

const { DB_HOST, DB_USER, DB_PASSWORD, DB_NAME, DB_DIALECT } = process.env;

const DBclient = {

host: DB_HOST,

username: DB_USER,

password: DB_PASSWORD,

database: DB_NAME,

dialect: DB_DIALECT

}

export default DBclient;

vrajpatelTH · 2025-02-02T10:25:08Z

config/sequelize.js

+
+sequelize.authenticate()
+  .then(() => {
+    console.log('Database connected successfully');


@dipali-23
Replace all console.log statements with the pino logger wherever they're used

vrajpatelTH · 2025-02-02T10:28:16Z

controllers/student.js

+import studentValidationSchema from '../utils/studentValidation.js';
+import { HTTP_STATUS_CODES } from '../utils/statusCodes.js';  // Import status codes


Suggested change

import studentValidationSchema from '../utils/studentValidation.js';

import { HTTP_STATUS_CODES } from '../utils/statusCodes.js'; // Import status codes

import studentValidationSchema from '../utils/validators/student.js';

import { HTTP_STATUS_CODES } from '../utils/constants/common.js';

Try to follow file naming conventions in a snake case status-code.js rather than statusCodes.js

Grouping files with the generic folder name.

For Example :

Without Grouping

utils/studentValidation.js ❌

utils/subjectValidation.js ❌

utils/professorValidation.js ❌

Grouping of all validators

utils/validators/student.js ✅

utils/validators/subject.js ✅

utils/validators/professor.js ✅

vrajpatelTH · 2025-02-02T10:50:12Z

services/student.js

+    const student = await Student.findByPk(id);
+    return student;
+  } catch (error) {
+    throw new Error('Error fetching student: ' + error.message);


Suggested change

throw new Error('Error fetching student: ' + error.message);

throw new Error('An error occurred while fetching student (service): ' + error.message);

vrajpatelTH · 2025-02-02T10:50:25Z

services/student.js

+    await student.update(data);
+    return student;
+  } catch (error) {
+    throw new Error('Error updating student: ' + error.message);


Suggested change

throw new Error('Error updating student: ' + error.message);

throw new Error('An error occurred while updating student (service): ' + error.message);

vrajpatelTH · 2025-02-02T10:50:44Z

services/student.js

+    await student.destroy();
+    return { message: 'Student deleted successfully' };
+  } catch (error) {
+    throw new Error('Error deleting student: ' + error.message);


Suggested change

throw new Error('Error deleting student: ' + error.message);

throw new Error('An error occurred while deleting student (service) : ' + error.message);

vrajpatelTH · 2025-02-02T10:53:05Z

utils/response.js

+// Success Response Helper
+export const sendResponse = (res, statusCode, message, data = null) => {
+  return res.status(statusCode).json({
+    success: statusCode >= 200 && statusCode < 300, 
+    message: message,
+    data: data,
+  });
+};
+
+// Error Response Helper
+export const sendErrorResponse = (res, error, statusCode = 500) => {
+  return res.status(statusCode).json({
+    success: false,
+    message: error || "something went wrong",
+  });
+};


Suggested change

// Success Response Helper

export const sendResponse = (res, statusCode, message, data = null) => {

return res.status(statusCode).json({

success: statusCode >= 200 && statusCode < 300,

message: message,

data: data,

});

};

// Error Response Helper

export const sendErrorResponse = (res, error, statusCode = 500) => {

return res.status(statusCode).json({

success: false,

message: error || "something went wrong",

});

};

export const sendResponse = (

res: MedusaResponse,

success: boolean,

message: string,

statusCode: TStatusCode,

status: TStatus,

data?: any // server error message or data : {}

): void => {

res.status(statusCode).json({

success,

message,

status,

...(data ? { data } : {}),

})

}

We can make it single generic function to send the success and error responses both.

vrajpatelTH · 2025-02-02T10:57:32Z

utils/statusCodes.js

+export const HTTP_STATUS_CODES = {
+    OK: 200,
+    CREATED: 201,
+    BAD_REQUEST: 400,
+    NOT_FOUND: 404,
+    INTERNAL_SERVER_ERROR: 500,
+  };


Suggested change

export const HTTP_STATUS_CODES = {

OK: 200,

CREATED: 201,

BAD_REQUEST: 400,

NOT_FOUND: 404,

INTERNAL_SERVER_ERROR: 500,

};

We can use the http-status code npm package : https://www.npmjs.com/package/http-status-codes (I am preferring this)

And even if you'll need to manage this yourself. First, create constants and then export them for use.

const SUCCESS = 200 const CREATED = 201 const BAD_REQUEST = 400 const UNAUTHORIZED = 401 const FORBIDDEN = 403 const NOT_FOUND = 404 const CONFLICT = 409 const INTERNAL_SERVER_ERROR = 500 const SERVICE_UNAVAILABLE = 503 const SUCCESS_STATUS = "SUCCESS" const CREATED_STATUS = "CREATED" const BAD_REQUEST_STATUS = "BAD_REQUEST" const UNAUTHORIZED_STATUS = "UNAUTHORIZED" const FORBIDDEN_STATUS = "FORBIDDEN" const NOT_FOUND_STATUS = "NOT_FOUND" const CONFLICT_STATUS = "CONFLICT" const INTERNAL_SERVER_ERROR_STATUS = "INTERNAL_SERVER_ERROR" const SERVICE_UNAVAILABLE_STATUS = "SERVICE_UNAVAILABLE" export const STATUS_CODE = { SUCCESS, CREATED, BAD_REQUEST, UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT, INTERNAL_SERVER_ERROR, SERVICE_UNAVAILABLE, } export const STATUS = { SUCCESS_STATUS, CREATED_STATUS, BAD_REQUEST_STATUS, UNAUTHORIZED_STATUS, FORBIDDEN_STATUS, NOT_FOUND_STATUS, CONFLICT_STATUS, INTERNAL_SERVER_ERROR_STATUS, SERVICE_UNAVAILABLE_STATUS, }

dipali-23 added 3 commits January 30, 2025 17:39

crud operation using node+express and orm-sequelize

8cfc378

add validation

abd0db1

add validation and done some modification in structure also make cons…

37def62

…tand to make it reusable

akshaykher243 suggested changes Jan 31, 2025

View reviewed changes

vrajpatelTH suggested changes Feb 2, 2025

View reviewed changes

dipali-23 added 2 commits February 4, 2025 17:04

added authentication,mapping etc.

a73b97e

added authentication,mapping etc.

f3fecb1

dipali-23 force-pushed the backend branch from 2f77c4c to f3fecb1 Compare February 4, 2025 11:45

	# Environment variables (sensitive information)
	# env variables

		import studentValidationSchema from '../utils/studentValidation.js';
		import { HTTP_STATUS_CODES } from '../utils/statusCodes.js'; // Import status codes

	throw new Error('Error fetching student: ' + error.message);
	throw new Error('An error occurred while fetching student (service): ' + error.message);

	throw new Error('Error updating student: ' + error.message);
	throw new Error('An error occurred while updating student (service): ' + error.message);

	throw new Error('Error deleting student: ' + error.message);
	throw new Error('An error occurred while deleting student (service) : ' + error.message);

Conversation

dipali-23 commented Jan 31, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vrajpatelTH Feb 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

For Example :

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vrajpatelTH Feb 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

vrajpatelTH Feb 2, 2025 •

edited

Loading

vrajpatelTH Feb 2, 2025 •

edited

Loading