[Feature] NodeJS Helper Library

[TanmoySG]

NodeJS Helper Library/Class for logsmith monitor. May publish a JS counterpart of logsmith - logsmithJS, as a logging library with support for monitor.

[Checkpoints]

• [x] Add Basic Console Logging
• [x] Add File Logging
• [x] Add monitor support
• [x] Add listener pickup from Env Variable

[Additional Details]

• listeners are Address/Logsmith Monitor instances that listens to the logs

[TanmoySG]

Using this Guide - https://www.digitalocean.com/community/tutorials/how-to-create-a-node-js-module

For Coloring the terminal logs using - https://www.npmjs.com/package/chalk

Some guide on Classes in JS - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes

[TanmoySG]

"git - How to use actions/checkout@master to get sources into specified folder? - Stack Overflow" https://stackoverflow.com/questions/57914734/how-to-use-actions-checkoutmaster-to-get-sources-into-specified-folder

Can use this to checkout only the helper library and Publish it as a GH Package.

[TanmoySG]

How to Publish to NPM Registry

Login to npm

npm adduser

A prompt comes up, fill the details.

npm publish

Voila!

[TanmoySG]

How to go ahead with NodeJS Helper Library Publishing?

• Will use NPM Registry rather than GH Registry
• Will be using this repo for initial development.
• With a initial feature ready build, will move the code to a separate repo - logsmith.js
• Will Develop logsmith.js as a standalone logging library with support for monitor
• Will publish/release on separate GH Repo

[TanmoySG]

[Publishing to GH Registry] https://gist.github.com/silentHoo/8402d470ef48ef8979b8ecd3e5f206e3

[TanmoySG]

• Published to GH Registry - has some issues if I try to install it locally

• Needs to set proxy and all that. Which is an added step just to get the package.

Will publish to NPM Registry - less steps to follow for end user.

[TanmoySG]

https://www.npmjs.com/package/log

[TanmoySG]

Templating in JS

Using string-template for Templating. Link

Usage

Installing string-template

npm i string-template

Defining Templates can be done by putting the variable/placeholder name within { }

const template = "{level} : {log}"

Formatting the templates

import format from 'string-template';

const template = "[{level}] {body}"
log() {
        const logStatement = format(
            template,
             { 
                level:"test",
                body:  "testval"
              }
         )
        return logLevels.INFO(logStatement);
    }

Examples

Refer to these examples

[TanmoySG]

"Doing a cleanup action just before Node.js exits - Stack Overflow" https://stackoverflow.com/questions/14031763/doing-a-cleanup-action-just-before-node-js-exits

Save logs in file on exit only. Read Logs and write logs to Program Variables and not to file.

[TanmoySG]

https://headlessui.dev/react/tabs

[TanmoySG]

Minimal Monitor Configuration

This is the minimum config the user needs to set for monitor, rest is handled by the lib. if not provided.

{
       MONITOR: {
            port: "8080",
            server: "localhost",
            publisher: {
                publisher: "test"
            },
            context: {
                context: "testcon"
            }
        }
    }
}

[TanmoySG]

If exists Fallback

While publishing log

• First it sends the log to monitor
• Monitor responds back
  • If Publisher or Context doesn't exist
  • The lib sends request to create new pub. or context.
  • Then send the log publisher request again.

[TanmoySG]

Might Help - https://www.youtube.com/watch?v=cuEtnrL9-H0&ab_channel=WebDevSimplified

[TanmoySG]

const EndpointConfigurations = {
    Publisher: {
        method : "POST",
        header : "GET"
    },
    Context : {
        new: "POST",
        existing : "GET"
    },
    Log: {
        new: "POST"
    }
}

[TanmoySG]

https://stackabuse.com/making-http-requests-in-node-js-with-node-fetch/ Might Help

[TanmoySG]

Useful Resources

• https://instagram-engineering.com/python-at-scale-strict-modules-c0bb9245c834
• https://github.com/rcoh/angle-grinder

[TanmoySG]

Published!!!

https://www.npmjs.com/package/logsmithjs