Refining Route Management in SmartWaiter

Managing application state in a restaurant management project like SmartWaiter requires a clean separation of concerns. Recently, I focused on refactoring the tables.routes.js file to ensure that our API surface remains predictable as the system scales.

In early-stage development, it is common for route files to become catch-all locations for business logic, database queries, and request handling. This approach, while fast initially, creates friction as the project grows.

The Problem with Bloated Routes

When routes in a JavaScript application directly handle persistence logic—such as interacting with SQLite—you lose the ability to easily test individual components. If your route definition is tightly coupled to the database layer, changing your storage strategy requires touching multiple files, increasing the risk of regression.

Refactoring for Clarity

By decoupling the route definitions from the implementation, we improve maintainability. Instead of embedding database operations, we delegate tasks to specialized controller functions.

// routes/tables.routes.js
const express = require('express');
const router = express.Router();
const tableController = require('../controllers/tableController');

// Clean routing definition
router.get('/status/:id', tableController.getTableStatus);
router.post('/occupy/:id', tableController.occupyTable);

module.exports = router;

This structure ensures that the tables.routes.js file acts strictly as a traffic controller, directing incoming requests to the appropriate logic handlers. By abstracting the SQLite calls into the controller or a separate service layer, we make the codebase easier to navigate.

The Takeaway

Treat your route files like a switchboard. If you find yourself writing database queries or complex conditional logic inside your route definitions, it is time to move that code into a service or controller layer. Start by migrating one route at a time; your future self will appreciate the cleaner, more modular architecture.

Generated with Gitvlg.com