sgapps-server v0.0.28

SGApps Server - very fast NodeJS WebServer

A network solution for web applications.

Since this application is fully compatible with nodejs-mvc, I decided to replace nodejs-mvc with this new approach. SGApps Server is completely new solution, that will be improved continuously thats why I will work on this project instead of nodejs-mvc

by Sergiu Gordienco < sergiu.gordienco@sgapps.io >

Features

• 🚀 Much Faster with common used Interface
• 💻 Pretty Logger Integrated
• 🏗️ AccessLogs ( Combined )
  • 📈 GoAccess Statistics Support ( v1.5.6 )
  • 📈 AWSTats Statistics Support
• 📑 TypeScript Typings ( Intellisense Support )
• 📚 support with MVC Framework

Authors

• Gordienco Sergiu < sergiu.gordienco@sgapps.io >

License

the license is Apache-2.0, so one of the requirements is to include reference to this project

Samples

Simple Integration ( Similar to ExpressJS )

const { SGAppsServer } = require('sgapps-server');
const app = new SGAppsServer();

app.get('/', function (request, response) {
  response.send('hello world')
});

app.server().listen(8080, () => {
  app.logger.log('Server is running on port 8080');
});

Example of Integration with SessionSupport 🍦

// ========================================
//   Start your 🚀 Web-Server app Extended
// ========================================

const { SGAppsServer } = require('sgapps-server');
const app = new SGAppsServer();

app.get('/', function (request, response) {
    response.send('hello world session#' + request.session.id);
})

app.whenReady.then(() => {
    app.SessionManager.cookie = 'ssid';
    app.SessionManager.SESSION_LIFE = 120; // seconds

    app.server().listen(8080, () => {
        app.logger.log('Server is running on port 8080');
    });
}, app.logger.error);

Example of Integration with AccessLogs for AWStats or GoAccess

const { SGAppsServer } = require('sgapps-server');
const app = new SGAppsServer({
    decorators: [
        require('sgapps-server/decorators/access-logger')
    ]
});

app.AccessLoggerPaths['default'] = {
    isEnabled: true,
    path: configuration.database.filesystem.logs + 'default/{year}/{month}/data-{worker-id}.log'
};

app.whenReady.then(() => {
    app.server().listen(8080, () => {
        app.logger.log('Server is running on port 8080');
    });
}, app.logger.error);

Example Advanced of Integration with AccessLogs for AWStats or GoAccess

const { SGAppsServer } = require('sgapps-server');
const app = new SGAppsServer({
    decorators: [
        require('sgapps-server/decorators/access-logger')
    ]
});

app.AccessLoggerPaths['default'] = {
    isEnabled: true,
    // modify the row
    waitAllHandlers: true,
    path: configuration.database.filesystem.logs + 'default/{year}/{month}/data-{worker-id}.log',
    handle: function (data) {
        // used for updating of filtering data
        console.info("LOGGER Data", data);
        return data.match(/\.txt\"/) ? null : data;
    }
};

app.get(/^\/api\//, function () {
    // log all request from api path into separate file
    request.AccessLoggerPaths['api'] = {
        isEnabled: true,
        path: 'api/access.log'
    }
})

app.whenReady.then(() => {
    app.server().listen(8080, () => {
        app.logger.log('Server is running on port 8080');
    });
}, app.logger.error);

Full API documentation can be found on

API

Table of Contents

• SGAppsServerRequestSession
  • _created
  • _ip
  • _confirmed
  • _id
  • _options
  • data
  • destroy
• TemplateManager
  • _options
  • _viewer
  • _env
  • templateExists
  • remove
  • add
  • addList
  • get
  • render
• SGAppsServerRequest
  • request
  • _postDataBuffer
  • getMountUpdatedUrl
  • urlInfo
  • query
  • mountPath
  • body
  • bodyItems
  • cookies
  • MAX_POST_SIZE
  • files
  • fileItems
  • _destroy
  • params
  • _flags
  • _parseDeepFieldName
  • session
  • postData
  • RequestParams
• routeMatch
• SGAppsServerResponse
  • response
  • pipeFile
  • send
  • sendError
  • _destroy
  • redirect
  • _flags
  • pipeFileStaticCallback
  • pipeFileStatic
  • sendStatusCode
• TemplateManagerRenderOptions
• TemplateManagerViewer
  • _facebox
  • _debug
  • _env
  • renderCode
  • render
• TemplateManagerTemplate
• SGAppsServerEmail
  • send
  • options
  • encodedBody
  • msg
  • valid
  • Config
  • from
  • isValidAddress
  • timeout
  • Callback
• SGAppsSessionManagerOptions
• SGAppsServerRequestSessionCache
• MountUpdatedURL
• FaceboxTemplate
  • _debug
  • _env
  • _cachedFiles
  • INCLUDE_LEVEL
  • render
  • renderFile
  • renderCode
• SGAppsServerRequestCookie
  • get
  • set
• SGAppsServerDecoratorsLibrary
• SGAppsServerErrorCallBack
• SGAppsServerErrorOnlyCallback
• FSLibrary
• SGAppsServerShared
• SGAppsServerRequestFile
• SGAppsServerRequestPostDataItem
• SGAppsServerDecorator
• SGAppsServer
  • CookiesManager
  • _server
  • _decorators
  • TemplateManager
  • _options
  • STATUS_CODES
  • shared
  • logger
  • Email
  • mountPath
  • SessionManager
  • _fs
  • _path
  • EXTENSIONS
  • _requestListeners
  • MAX_POST_SIZE
  • whenReady
  • handleRequest
  • handleErrorRequest
  • handleStaticRequest
  • handle
  • server
  • use
  • post
  • get
  • head
  • put
  • trace
  • delete
  • options
  • connect
  • patch
  • all
  • finalHandler
  • handlePostData
• LoggerBuilder
  • _format
  • _debug
  • _headerFormatters
  • prettyCli
  • log
  • info
  • warn
  • error
  • prompt
  • decorateGlobalLogger
  • headerFormatterInfo
  • headerFormatter
• RequestPathStructureMap
• SGAppsServerDictionary
  • _paths
  • _dictionary
  • generatePathKey
  • push
  • run
• RequestPathStructure
• RequestHandler
• SGAppsServerOptions
• SGAppsSessionManager
  • _options
  • _enabled
  • _sessions
  • removeExpiredSessions
  • handleRequest
• RequestSessionDecorator
• SGAppsServerDictionaryRunCallBack
• request
• request
• LoggerBuilderPrompt
• SGAppsServerHandlerPostData

SGAppsServerRequestSession

Type: function (request, options)

• request SGAppsServerRequest
• options SGAppsSessionManagerOptions

_created

Type: number

_ip

Type: string

_confirmed

Session was received from previously saved cookie

Type: boolean

_id

Type: string

_options

Type: SGAppsSessionManagerOptions

data

Type: object

destroy

Type: function ()

TemplateManager

Type: function (options)

• options object
  • options._fs FSLibrary

_options

Type: object

• _fs FSLibrary

_viewer

Type: TemplateManagerViewer

_env

Type: Object<string, any>

templateExists

Type: function (templateName): boolean

• templateName string

remove

Type: function (templateName)

• templateName string

add

Type: function (templateName, filePath)

• templateName string
• filePath string

addList

Type: function (templates)

• templates Object<string, string>

get

Type: function (templateName): TemplateManagerTemplate

• templateName string

render

Type: function (response, templateName, vars)

• response SGAppsServerResponse
• templateName string
• vars Object<string, any>?

SGAppsServerRequest

Type: function (request, server)

• request IncomingMessage
• server SGAppsServer

request

Type: IncomingMessage

_postDataBuffer

post data buffer cache

Type: Buffer

getMountUpdatedUrl

Type: function (url): MountUpdatedURL

• url string

urlInfo

Type: object

• original string
• origin string
• domain string full domain of url
• domain_short string domain without "www."
• pathname string url's pathname
• reqQuery string url's query from '?'
• protocol string url.split('://')0
• url string
• url_p string
• isIp string domain or Ip

query

Type: object

mountPath

Type: string

body

Type: object

bodyItems

Type: Array<SGAppsServerRequestPostDataItem>

cookies

Type: SGAppsServerRequestCookie

MAX_POST_SIZE

Type: number

Examples:

// changing max post size to 4Mb
request.MAX_POST_SIZE = 4 * 1024 * 1024;

// reset max post size to global value
request.MAX_POST_SIZE = -1;

files

Type: Object<string, Array<SGAppsServerRequestFile>>

fileItems

Type: Array<SGAppsServerRequestFile>

_destroy

Array of functions to be called on response end

Type: Array<function>

params

Array of functions to be called on response end

Type: SGAppsServerRequest.RequestParams

_flags

Array of functions to be called on response end

Type: object

• complete boolean The message.complete property will be true if a complete HTTP message has been received and successfully parsed.
• aborted boolean The message.aborted property will be true if the request has been aborted.
• closed boolean Indicates that the underlying connection was closed.
• _DEBUG_MAX_HANDLER_EXECUTION_TIME number? define a bigger request timeout

_parseDeepFieldName

Automatically used procedure for parsing formData field name if option server._options._REQUEST_FORM_PARAMS_DEEP_PARSE = true. it's by default enabled but can be disabled when needed

Type: function (container, fieldName, fieldData, options)

• container object
• fieldName string
• fieldData any
• options object?
  • options.transform2ArrayOnDuplicate boolean (optional, default false)

Examples:

paramsContainer = {};
request._parseDeepFieldName(paramsContainer, 'test[arr][data]', 2);
request._parseDeepFieldName(paramsContainer, 'test[arr][]', new Date());
request._parseDeepFieldName(paramsContainer, 'test[arr][]', 2);
request._parseDeepFieldName(paramsContainer, 'test[data]', 2);
// if _debug enabled warns will be emitted
// [Warn] [Request._parseDeepFieldName] Writing Array field "test[arr][]" into a object
// [Warn] [Request._parseDeepFieldName] Overwriting field "test[data]" value
console.log(paramsContainer)
{
    "test": {
        "arr": {
            "1": "2021-02-12T21:23:01.913Z",
            "2": 2,
            "data": 2
        },
        "data": 2
    }
}

paramsContainer = {};
request._parseDeepFieldName(paramsContainer, 'test[arr][]', new Date());
request._parseDeepFieldName(paramsContainer, 'test[arr][]', 2);
request._parseDeepFieldName(paramsContainer, 'test[arr][data]', 2);
request._parseDeepFieldName(paramsContainer, 'test[data]', 2);
// if _debug enabled warns will be emitted
// [Warn] [Request._parseDeepFieldName] Converting array to object due incorrect field "test[arr][data]" name 
console.log(paramsContainer)
{
    "test": {
        "arr": {
            "0": "2021-02-12T21:34:47.359Z",
            "1": 2,
            "data": 2
        },
        "data": 2
    }
}

paramsContainer = {};
request._parseDeepFieldName(paramsContainer, 'test[arr][]', new Date());
request._parseDeepFieldName(paramsContainer, 'test[arr][]', 2);
request._parseDeepFieldName(paramsContainer, 'test[data]', 2);
console.log(paramsContainer)
{
    "test": {
        "arr": [
            "2021-02-12T21:26:43.766Z",
            2
        ],
        "data": 2
    }
}

session

Type: SGAppsServerRequestSession

postData

request's post received data

Type: Promise<Buffer>

RequestParams

Type: (Object<(string | number), string> | Array<string>)

routeMatch

Type: function (route, url, strictRouting, _cache)

• route RequestPathStructure
• url string
• strictRouting boolean
• _cache object

SGAppsServerResponse

Type: function (response, server)

• response ServerResponse
• server SGAppsServer

response

Type: ServerResponse

pipeFile

Type: function (filePath, callback)

• filePath string
• callback SGAppsServerErrorOnlyCallback represents a Function(Error)

send

Type: function (data, options)

• data (string | Buffer | object | Array<any>)
• options object?
  • options.statusCode number (optional, default 200)
  • options.headers Object<string, (string | Array<string>)>?

sendError

Type: function (error, options)

• error Error
• options object?
  • options.statusCode number (optional, default 500)

_destroy

Array of functions to be called on response end

Type: Array<function>

redirect

if it returns false than the action was not possible

Type: function (url, options)

• url string
• options object?
  • options.statusCode number (optional, default 302)
  • options.headers Object<string, (string | Array<string>)>?

_flags

Array of functions to be called on response end

Type: object

• finished boolean will be true if response.end() has been called.
• sent boolean Is true if all data has been flushed to the underlying system, immediately before the 'finish' event is emitted.
• closed boolean Indicates that the the response is completed, or its underlying connection was terminated prematurely (before the response completion).

pipeFileStaticCallback

Type: Function

• error Error

pipeFileStatic

Type: function (filePath, fileName, callback, options)

• filePath string
• fileName string
• callback SGAppsServerResponse.pipeFileStaticCallback
• options object?
  • options.timeout number (optional, default 0)
  • options.filePath string? originap path is autoIndex was applied
  • options.autoIndex Array<string>? list of auto-index files, ex: 'index.html', 'index.htm', 'default.html'

sendStatusCode

Type: function (statusCode)

• statusCode number

TemplateManagerRenderOptions

Type: object

TemplateManagerViewer

Type: function (options)

• options object
  • options._fs FSLibrary

_facebox

Type: FaceboxTemplate

_debug

Type: boolean

_env

Type: Object<string, any>

renderCode

Type: function (code, vars, virtualFilePath, callback)

• code string
• vars Object<string, any>
• virtualFilePath string
• callback function

render

Type: function (response, view, vars)

• response SGAppsServerResponse
• view TemplateManagerTemplate
• vars Object<string, any>

TemplateManagerTemplate

Type: object

• name string
• path string
• code string?

SGAppsServerEmail

Type: function (config)

• config SGAppsServerEmail.Config optional configuration object

Example:

Example:
   var Email = require('path/to/email').Email
   var myMsg = new Email(
   { from: 'me@example.com'
   , to:   'you@example.com'
   , subject: 'Knock knock...'
   , body: "Who's there?"
   })
   myMsg.send(function(err){
     ...
   })

send

Send email

Type: function (callback)

• callback SGAppsServerEmail.Callback

options

get message options

Type: object

• timeout number

encodedBody

getter generate encoded body

Type: string

msg

getter generate all email structure

Type: string

valid

check if email is valid

Type: function (callback)

• callback SGAppsServerEmail.Callback

Config

Email : Sends email using the sendmail command.

Note: sendmail must be installed: see http://www.sendmail.org/

Type: object

• to (Array<string> | string) Email address(es) to which this msg will be sent
• debug boolean?
• from string? Email address from which this msg is sent. If not set defaults to the exports.from global setting.
• replyTo string? Email address to which replies will be sent. If not set defaults to from
• cc (string | Array<string>)? Email address(es) who receive a copy
• bcc (string | Array<string>)? Email address(es) who receive a blind copy
• subject string The subject of the email
• body string The message of the email
• bodyType string? Content type of body. Only valid option is 'html' (for now). Defaults to text/plain.
• altText string? If bodyType is set to 'html', this will be sent as the alternative text.
• timeout number? Duration in milliseconds to wait before killing the process. If not set, defaults to exports.timeout global setting.
• path string? Optional path to the sendmail executable.

from

Email address from which messages are sent. Used when from was not set on a message.

Type: function (email): string

• email string

isValidAddress

Type: function (email): boolean

• email string

timeout

Duration in milliseconds to wait before killing the process. Defaults to 3000. Used when timeout is not set on a message.

Type: function (milliseconds): number

• milliseconds number

Callback

Type: Function

• err Error

SGAppsSessionManagerOptions

Type: object

• SESSION_LIFE number?
• cookie string?

SGAppsServerRequestSessionCache

Type: object

• expire number
• data object

MountUpdatedURL

Type: string

FaceboxTemplate

Type: function (options)

• options object
  • options._fs FSLibrary

_debug

Type: boolean

_env

Type: Object<string, any>

_cachedFiles

Type: Object<string, string>

INCLUDE_LEVEL

Type: number

render

Type: function (text, vars, env)

• text string
• vars Object<string, any>
• env Object<string, any>

renderFile

Type: function (filePath, vars, callback)

• filePath string
• vars Object<string, any>
• callback function

renderCode

Type: function (code, vars, callback, virtualFilePath)

• code string
• vars Object<string, any>
• callback function
• virtualFilePath string

SGAppsServerRequestCookie

Type: function ()

get

Type: function (name, options): string

• name string
• options object?
  • options.secure boolean (optional, default false)

set

Type: function (name, value, options, skipErrors): string

• name string
• value string
• options object?
  • options.secure boolean (optional, default false)
  • options.secureProxy boolean?
  • options.signed boolean?
  • options.path string (optional, default "/")
  • options.expires Date?
  • options.domain string?
  • options.httpOnly boolean (optional, default true)
  • options.sameSite boolean (optional, default false)
  • options.secure boolean (optional, default false)
  • options.overwrite boolean (optional, default false)
• skipErrors boolean (optional, default false)

SGAppsServerDecoratorsLibrary

Type: function ()

SGAppsServerErrorCallBack

Type: Function

• err Error
• request SGAppsServerRequest
• response SGAppsServerResponse
• server SGAppsServer

SGAppsServerErrorOnlyCallback

Type: Function

• err Error

FSLibrary

Type: function ()

SGAppsServerShared

Type: function ()

SGAppsServerRequestFile

Type: object

• fieldName string field's name
• data object
  • data.fileName string file's name [duplicate]
  • data.encoding string file's encoding
  • data.fileStream Readable () => fileStream
  • data.fileData Buffer
  • data.fileSize number size in bytes
  • data.contentType string file's mimeType
  • data.loaded boolean indicate if file is fully loaded into fileData

SGAppsServerRequestPostDataItem

Type: object

• fieldName string field's name
• data object
  • data.value string
  • data.encoding string file's encoding
  • data.valTruncated string
  • data.fieldNameTruncated Buffer
  • data.mimeType string file's mimeType

SGAppsServerDecorator

Type: Function

• request SGAppsServerRequest
• response SGAppsServerResponse
• server SGAppsServer
• callback function

SGAppsServer

HTTP Server for high performance results

Type: function (options)

• options object?
  • options.server Server?
  • options.strictRouting boolean (optional, default true)
  • options.debug boolean (optional, default true)
  • options._DEBUG_MAX_HANDLER_EXECUTION_TIME object console shows an warn if handler is executed more than ( works in debug mode ) (optional, default 500)
  • options._DEBUG_REQUEST_HANDLERS_STATS object console shows an warn if handler is executed more than ( works in debug mode ) (optional, default false)
  • options._REQUEST_FORM_PARAMS_DEEP_PARSE boolean parse formData field names to create deep object request.body (optional, default true)
  • options.decorators Array<SGAppsServerDecorator>?

Examples:

// ================================
//   Start your 🚀 Web-Server app
// ================================

const { SGAppsServer } = require('@sgapps.io/server');
const app = new SGAppsServer();

app.get('/', function (req, res) {
  res.send('hello world')
})

app.server().listen(8080, () => {
  app.logger.log('Server is running on port 8080');
})

// ========================================
//   Start your 🚀 Web-Server app Extended
// ========================================

const { SGAppsServer } = require('@sgapps.io/server');
const app = new SGAppsServer();

app.get('/', function (req, res) {
  res.send('hello world')
})

app.whenReady.then(() => {
  app.SessionManager.cookie = 'ssid';
  app.SessionManager.SESSION_LIFE = 120; // seconds

  app.server().listen(8080, () => {
    app.logger.log('Server is running on port 8080');
  })
}, app.logger.error);

CookiesManager

Type: object

• COOKIES_KEY string
• _enabled boolean? if is changed to false server will not decorate requests with cookie manager
• handle function (SGAppsServerRequest, SGAppsServerResponse): object

_server

Type: Server

_decorators

Type: Array<SGAppsServerDecorator>

TemplateManager

Type: TemplateManager

_options

Type: SGAppsServerOptions

STATUS_CODES

Type: Object<number, string>

shared

Type: SGAppsServerShared

logger

Type: LoggerBuilder

Email

Type: function (config): SGAppsServerEmail

• config SGAppsServerEmail.Config

mountPath

Type: string

SessionManager

Type: SGAppsSessionManager

_fs

Type: object

_path

Type: object

EXTENSIONS

Type: ResourcesExtensions

_requestListeners

Type: Object<string, SGAppsServerDictionary>

MAX_POST_SIZE

default value is 16 Kb » 16 * 1024

Type: [num