Necessary Pigeonholing Mechanism

    @teclone/r-server
    TypeScript icon, indicating that this package has built-in type declarations

    2.16.0 • Public • Published

    R-Server

    Build Status Coverage Status semantic-release npm version npm

    RServer is a fully integrated, Promise-based NodeJS web server, optimized for development and production needs, with inbuilt routing engine, static file server, range request support, body parser (has support for multipart and file uploads), middleware support, request-response profiler, excellent exception handling, error logging, Https easy setup and lots more.

    Note: RServer is supported starting from Node v8.12 upward

    Newly Added Features

    • Ability to set route base path that will be prepended to all route urls. here
    • Https integration and setup made easy here
    • Support for byte-range requests

    Getting Started (NPM install)

    npm install @teclone/r-server

    Create your server entry app.js or server.js file with some sample codes like below.

    const { App } = require('@teclone/r-server'); // import rserver
    const app = new App(); // create server instance
    
    //start the instance. if port is null, it defaults to process.env.PORT || 8080
    app.listen().then(() => console.log('listening'));
    
    // add some route
    app.get('/', (req, res) => {
      return res.end('Hello World');
    });

    Start the server by running npm start on the project root directory and navigate your browser to http://localhost:8080/. It is that simple.

    Why R-Server

    R-Server gives you many excellent features out of the box, saving you the stress of looking for external plugins and third party solutions. These include:

    1. Excellent Request Body Parser

    2. Excellent Routing Engine

    3. Static File Server

    4. Middleware Support

    5. Mountable Router

    6. Error Handling & Logging

    7. Response Utility Methods

    8. Custom Http Error Documents

    9. HTTPS Support

    10. Range Request Support

    Request Body Parser

    It comes with an inbuilt request body parser, that supports all forms of http request data such as urlencoded query strings, application/json data, application/x-www-form-urlencoded data and multipart/form-data.

    Parsed fields and files are made available on the request object via the query, body, data and files properties. Uploaded files are stored in a tmp folder, tmp/uploads.

    The data property is a combination of all fields in the query and body properties, with values in the body property winning the battle in case of conflicting field keys.

    Multi-value fields are supported as well. They are recognised if the field name ends with the bracket notation []. Note that the brackets are stripped out during the parsing. It uses the same principle like in PHP.

    const { App } = require('@teclone/r-server'); // import rserver
    const app = new App(); // create server instance
    
    app.put('users/{userId}/profile-picture', (req, res) => {
      const picture = req.files.picture;
      return res.json({
        status: 'success',
        message: 'got your file',
      });
    });
    
    app.listen().then(() => console.log('listening'));

    Routing Engine

    It provides an excellent routing engine, with parameter capturing and can incorporate data type enforcement on captured parameters. All http method verbs are made available in the router including get, post, put, delete, options, head and the universal any method.

    Parameter capturing sections are enclosed in curly braces {};

    It also supports chained routes through the Router#route(url) method. Route callbacks and Middlewares can be asynchronous in nature.

    It also allows you to set route base path that gets prepended to all route urls and middleware urls.

    Note that route urls can only be string patterns, and not regex objects.

    Usage Example:

    const { App, Router } = require('@teclone/r-server'); // import rserver
    const app = new App(); // create server instance
    
    /** get route */
    app.get(url, callback, options);
    
    /** post route */
    app.post(url, callback, options);
    
    /** put route */
    app.put(url, callback, options);
    
    /** head route */
    app.head(url, callback, options);
    
    /** delete route */
    app.delete(url, callback, options);
    
    /** options route */
    app.options(url, callback, options);
    
    /** all method route */
    app.all(url, callback, options);

    Data Type Enforcement on Captured Parameter:

    //no data type enforcement
    app.get('users/{userId}', (req, res, { userId }) => {
      userId = /^\d+$/.test(userId) ? Number.parseInt(userId) : 0;
      if (userId !== 0) {
        return res.status(200).json({
          data: {
            id: userId,
            name: 'User Name',
          },
        });
      } else {
        return res.status(400).json({
          errors: {
            userId: 'user id not recognised',
          },
        });
      }
    });
    
    //enforce data type
    app.get('users/{int:userId}', (req, res, { userId }) => {
      if (userId !== 0) {
        return res.status(200).json({
          data: {
            id: userId,
            name: 'User Name',
          },
        });
      } else {
        return res.status(400).json({
          errors: {
            userId: 'user id not recognised',
          },
        });
      }
    });

    Chained Routes:

    const { App } = require('@teclone/r-server'); // import rserver
    const app = new App(); // create server instance
    
    app.route('users/{int:userId}')
    
        .put((req, res, params) => {
            //update user profile
        });
    
        .delete((req, res, {userId}) => {
            //delete user
        });
    
        .get((req, res, {userId}) => {
            //retrieve user
        });

    Route Base Path

    It provides api for setting routing base path that gets prepended to all route urls and middleware urls. This is very helpful when exposing versioned api endpoints in your applications.

    NB: Route base path must be set before registering routes.

    const { App } = require('@teclone/r-server'); // import rserver
    const app = new App(); // create server instance
    
    //examples
    app.setBasePath('api/v2.0');
    
    //this route will be called when post request is made on the endpoint /api/v2.0/auth
    app.post('auth', (req, res)=> {
        return res.end('received');
    }));

    Static File Server

    It provides public static file server out of the box, responding to GET, HEAD, & OPTIONS requests made on such static files. By default, it serves files from the ./public folder. It does not serve files that starts with the dot . character or files within a folder that starts with the dot . character if the serveHiddenFiles configuration option is set to false even when they are placed in the public directory. It also supports byte range requests that is crucial when serving large files.

    The list of Default documents includes index.html, index.css, index.js. See configuring-rserver on how to configure the list of default documents and so many other options.

    It uses NodeJS inbuilt writable & readable stream API while serving files for performance gain, user experience and minimal usage of system resources.

    It provides excellent content negotiation headers (Cache-Control, ETag & Last-Modified) and would negotiate contents by checking for the presence of the if-none-match, if-modified-since, & the if-range http request headers.

    Middleware Support

    It supports the use of middlewares making it easy to run security or pluggable modules per request. One can register global/standalone middlewares or localized route based middlewares. Middlewares can be a single or an array of javascript functions. Middlewares can be asynchronous functions too, that return promises.

    const { App } = require('@teclone/r-server'); // import rserver
    const app = new App(); // create server instance
    
    //runs on all request paths, and methods
    app.use('*', (req, res, next) => {
        //check if auth token is present in the header and set the req.user property
    
        return next(); //execute next to pass control or next middleware
    });
    
    //runs on root domain and only on post requests
    app.use('/', (req, res, next) => next(), {method: 'post'};
    
    // runs on all request paths starting with users/{userId}, inclusive, and all methods
    app.use('users/{userId}/*', (req, res, next, userId) => next());
    
    //route localized middleware
    app.get('auth/login', (req, res) => {
      return res.end('login form will be served :)');
    }, (req, res, next) => {
      //redirect user to homepage if user is logged in
      if (req.user) {
          return res.redirect('/');
      }
      else {
          return next();
      }
    });
    
    // or
    app.get('auth/login', (req, res) => {
      return res.end('login form will be served :)');
    }, {
        use: [
          (req, res, next) => {
            //redirect user to homepage if user is logged in
            if (req.user) {
                return res.redirect('/');
            }
            else {
                return next();
            }
          },
    
          // ...more middlewares if you like
        ]
      }
    });

    Mountable Router

    Mountable router are standalone router instances that can be mounted on the main app. Mountable routers can inherit the main app's standalone middlewares.

    File routes/AuthRoutes.ts:

    const { Router } = require('@teclone/r-server'); // import rserver
    const authRoutes = new Router(true); // create a mountable router, inherit middleware options is set as true.
    
    //define specific middlewares for auth
    authRoutes.use('*', (req, res, next) => {
      // if user is logged in, redirect to homepage
      if (req.user) {
        return res.redirect('/');
      } else {
        return next();
      }
    });
    
    authRoutes.post('signup', (req, res) => {
      // process account creation
    });
    
    authRoutes.post('login', (req, res) => {
      //process login
    });
    
    authRoutes.post('reset-password', (req, res) => {
      // process password reset
    });
    
    export default Authroutes;

    File app.ts:

    const { App } = require('@teclone/r-server');
    const authRoutes = require('./routes/authRoutes');
    
    const app = RServer.create();
    
    app.get('/', (req, res) => {
      return res.end('Welcome');
    });
    
    app.mount('/auth', authRoutes);
    
    app.listen().then(() => console.log('listening'));

    Error Handling & Reporting

    It logs errors to a user defined error log file which defaults to logs/error.log. When running in development mode, it sends error message and traces back to the client (browsers, etc). In production mode, it hides the error message from the client, but still logs the error to the error log file.

    By design, route callbacks are made to return promises, this helps bubble up any error up to our internal error handler for the event loop.

    Response Utility Methods

    There are some extended methods made available on the Response object, that includes the following:

    /**
     * ends the response with optional response data, and optional data encoding
     */
    end(data?, encoding?: string): Promise<boolean>;
    
    /**
     * sets response header
     */
    setHeader(name: string, value: string | number | string[]): this;
    
    /**
     * sets multiple response headers
     */
    setHeaders(headers: {[p: string]: string | number | string[]}): this;
    
    /**
     * removes a single set response header at a time. function is chainable
     */
    removeHeader(name: string): this;
    
    /**
     * remove response headers that are already set. function is chainable
     */
    removeHeaders(...names: string[]): this;
    
    /**
     * sets response status code
     */
    status(code: number): this;
    
    /**
     * sends json response back to the client.
     */
    json(data: object | string): Promise<boolean>;
    
    /**
     * Redirect client to the given url
     */
    redirect(path: string, status: number = 302): Promise<boolean>;
    
    /**
     * sends a file download attachment to the client
     */
    download(filePath: string, filename?: string): Promise<boolean>;

    Custom HTTP Error Documents

    RServer allows the ability to define custom http error files that are mapped to http error codes such as 404, etc. This is achieved by defining a httpErrors entry in your config file. See Configuring RServer for details.

    Configuring RServer

    RServer uses an internal .server.ts file that defines default server configurations for your project. the full config options is as shown below:

    export const rServerConfig: RServerConfig = {
      env: 'development',
    
      errorLog: 'logs/error.log',
    
      accessLog: 'logs/access.log',
    
      profileRequest: true,
    
      tempDir: 'tmp/uploads',
    
      publicPaths: ['public'],
    
      serveHiddenFiles: true,
    
      cacheControl: 'no-cache, max-age=86400',
    
      encoding: 'latin1',
    
      maxMemory: '50mb',
    
      defaultDocuments: ['index.html', 'index.js', 'index.css'],
    
      httpErrors: {
        baseDir: '',
        404: '',
        500: '',
      },
    
      https: {
        enabled: false,
    
        /* can be overriden by setting process.env.HTTPS_PORT */
        port: 9000,
    
        /* enforce https by redirecting all http request to https */
        enforce: true,
    
        /* https credentials, use  */
        credentials: {
          key: '.cert/server.key',
          cert: '.cert/server.crt',
          //'pfx': 'relativePath',
          passphrase: 'pfx passphrase',
        },
      },
    };

    You can override these options by creating your own custom config file in your project's root directory. You can even name it differently or place it anywhere provided you supply the file's relative path when creating an instance.

    const { App } = require('@teclone/r-server');
    
    const app1 = new App({
      configFile: './server1-config.js',
    });
    
    const app2 = new App({
      config: {
        profileRequests: false,
      },
    });
    
    app1.get('/', (req, res) => {
      return res.end('This is app on port 4000');
    });
    
    app2.get('/', (req, res) => {
      return res.end('This is app2 on port 5000');
    });
    
    app1.listen(4000);
    app2.listen(5000);

    The two instances above are separate, with different config settings. As shown in the example above, the config option can be an object.

    HTTPS Support

    It is easy to setup a https server along with your default http server. Use the https config option to declare your https server configuration settings. You can use letsencrypt easily to obtain ssl certificates for your application. Point the credentials to the obtained certificates.

    https configuartion:

    export const rServerConfig: RServerConfig = {
      https: {
        enabled: true,
    
        /* can be overriden by setting process.env.HTTPS_PORT */
        port: 442,
    
        /* enforce https by redirecting all http request to https */
        enforce: true,
    
        /* https credentials*/
        credentials: {
          key: '.cert/server.key',
          cert: '.cert/server.crt',
    
          // if using pfx file,
    
          //'pfx': 'relativePath',
          // passphrase: 'pfx passphrase',
        },
      },
    };

    The server listens for both http and https requests. It will redirect all http requests to their equivalent https path, if enforce option is set to true

    Range Request Support

    RServer will automatically detect and handle any byte-range requests that hits the server. This is very important when serving large files such as video and audio files. Range requests is used for data buffering. Visit this link to read more on range requests.

    Contributing

    We welcome your own contributions, ranging from code refactoring, documentation improvements, new feature implementations, bugs/issues reporting, etc. we recommend you follow the steps below to actively contribute to this project.

    Install

    npm i @teclone/r-server

    DownloadsWeekly Downloads

    15

    Version

    2.16.0

    License

    MIT

    Unpacked Size

    47.9 MB

    Total Files

    95

    Last publish

    Collaborators

    • teclone