Merge pull request #42 from contentstack/feat/DX-3457-improve-error-msgs

Updated error messages

Author: harshithad0703

app.js

@@ -4,14 +4,16 @@ const logger = require('morgan')
 const rateLimit = require('express-rate-limit')
 const app = express()
 const nunjucks = require('nunjucks')
-const helmet = require('helmet');
+const helmet = require('helmet')
+const path = require('path')
+const messages = require(path.join(__dirname, 'config', 'messages'))
 
 app.use(helmet());
 
 const limiter = rateLimit({
   windowMs: 15 * 60 * 1000,
   max: 100,
-  message: 'Too many requests from this IP, please try again after 15 minutes',
+  message: messages.errors.rateLimitExceeded,
   standardHeaders: true,
   legacyHeaders: false,
 })

bin/www

@@ -10,6 +10,7 @@ var path = require('path')
 var app = require('../app')
 var env = process.env.NODE_ENV || 'development'
 var config = require(path.join('..', 'config', env))
+var messages = require(path.join('..', 'config', 'messages'))
 
 /**
  * Get port from environment and store in Express.
@@ -68,11 +69,11 @@ function onError (error) {
   // handle specific listen errors with friendly messages
   switch (error.code) {
   case 'EACCES':
-    console.error(bind + ' requires elevated privileges')
+    console.error(messages.errors.portElevatedPrivileges(bind))
     process.exit(1)
     break
   case 'EADDRINUSE':
-    console.error(bind + ' is already in use');
+    console.error(messages.errors.portInUse(bind))
     process.exit(1)
     break
   default:

config/messages.js

@@ -0,0 +1,32 @@
+/**
+ * Centralized messages for the application
+ * Includes error messages, success messages, and informational messages
+ */
+
+module.exports = {
+  // Success Messages
+  success: {
+    contentstackConnected: 'Contentstack connection established.',
+  },
+
+  // Error Messages
+  errors: {
+    // Server errors
+    portElevatedPrivileges: (bind) => `Error: ${bind} requires elevated privileges. Try running with sudo or use a port above 1024.`,
+    portInUse: (bind) => `Error: ${bind} is already in use. Please stop the other process or use a different port.`,
+    
+    // Rate limiting
+    rateLimitExceeded: 'Too many requests from this IP, please try again after 15 minutes.',
+    
+    // Generic errors
+    notFound: 'The requested resource was not found.',
+    internalServerError: 'An internal server error occurred.',
+  },
+
+  // Informational Messages
+  info: {
+    serverStarting: (port) => `Server starting on port ${port}`,
+    serverListening: (bind) => `Listening on ${bind}`,
+  }
+}
+

models/contentstack.js

@@ -1,12 +1,13 @@
 var path = require('path')
 var env = process.env.NODE_ENV || 'development'
 var config = require(path.join('..', 'config', env))
+var messages = require(path.join('..', 'config', 'messages'))
 const Contentstack = require(config.sdk).Contentstack
 
 const Stack = Contentstack.Stack(config)
 
 Stack.connect(config.contentStore).then(() => {
-  console.log("Connected")
+  console.log(messages.success.contentstackConnected)
 }).catch(console.error)
 
 

package-lock.json

@@ -16,7 +16,7 @@
     "express": "^4.21.2",
     "express-rate-limit": "^7.1.5",
     "http-errors": "~2.0.0",
-    "morgan": "~1.10.0",
+    "morgan": "~1.10.1",
     "nunjucks": "^3.2.4",
     "path": "^0.12.7"
   },