feat: initial commit (#1)

Author: metcoder95

.github/workflows/ci.yml

@@ -6,7 +6,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [14.x, 16.x, 17.x]
+        node: [14.x, 16.x, 18.x]
     name: Node ${{ matrix.node }}
     steps:
       - uses: actions/checkout@v1
@@ -15,6 +15,4 @@ jobs:
         with:
           node-version: ${{ matrix.node }}
       - run: npm install
-      - run: npm run lint:ci
       - run: npm run test:ci
-      - run: npm run typescript

.gitignore

@@ -102,3 +102,6 @@ dist
 
 # TernJS port file
 .tern-port
+
+# As is a package, the lockfile is not needed
+package-lock.json

README.md

@@ -1,2 +1,2 @@
-# lib_template
-Template repository for bootstrap new libraries faster
+# Cloud Pine
+Pino Transport abstraction for Google Cloud Logging.

index.js

@@ -1 +1,16 @@
 'use strict'
+const split = require('split2')
+const { CloudLogging } = require('./lib/cloud-logging')
+
+async function CloudPine (options) {
+  const { logName = 'Cloud_Pine', cloudLoggingOptions } = options
+  const logging = new CloudLogging(logName, cloudLoggingOptions)
+
+  await logging.init()
+
+  const stream = split(logging.parseLine.bind(logging), { autoDestroy: true })
+
+  return stream
+}
+
+module.exports = CloudPine

lib/cloud-logging.js

@@ -0,0 +1,102 @@
+const { Logging } = require('@google-cloud/logging')
+
+class CloudLogging {
+  constructor (logName, options = {}) {
+    this.name = logName
+    this.logging = new Logging(options.googleCloudOptions)
+    this._resource = Object.assign({ type: 'global' }, options.resourceSettings)
+    this._defaultLabels = Object.assign(
+      {},
+      { logger: 'pino' },
+      options.defaultLabels
+    )
+    this._log = null
+    this._logOptions = options.logOptions
+  }
+
+  mapSeverity (logLevel) {
+    return (
+      CloudLogging.SEVERITY_MAP[logLevel] || CloudLogging.SEVERITY_MAP['30']
+    )
+  }
+
+  get resource () {
+    return this._resource
+  }
+
+  async init () {
+    await this.logging.setProjectId()
+    await this.logging.setDetectedResource()
+
+    const labels = Object.assign(
+      {},
+      this._resource.labels,
+      this.logging.detectedResource.labels
+    )
+
+    this._resource = Object.assign(
+      this._resource,
+      this.logging.detectedResource
+    )
+
+    this._resource.labels = labels
+
+    this._log = this.logging.log(this.name)
+    return this._log
+  }
+
+  parseLine (line) {
+    let log
+
+    try {
+      log = JSON.parse(line)
+    } catch (error) {
+      const meta = {
+        severity: CloudLogging.SEVERITY_MAP['50'],
+        resource: this._resource,
+        labels: this._defaultLabels
+      }
+      const entry = this._log.entry(meta, {
+        error,
+        message: 'Malformed log entry'
+      })
+
+      this._log.write(entry)
+
+      // We do nothing else as the log was malformed
+      return
+    }
+
+    const meta = Object.assign(
+      { severity: this.mapSeverity(log.level) },
+      log.meta // Custom property to add more meta to the LogEntry
+    )
+
+    meta.resource = Object.assign({}, this._resource, meta.resource)
+    meta.labels = Object.assign({}, this._defaultLabels, meta.labels)
+
+    if (log.httpRequest) {
+      meta.httpRequest = log.httpRequest
+      delete log.httpRequest
+    }
+
+    log.message = log.message ?? log.msg
+    delete log.msg
+
+    const entry = this._log.entry(meta, log)
+    this._log.write(entry)
+  }
+}
+
+CloudLogging.SEVERITY_MAP = {
+  10: 'DEBUG',
+  20: 'DEBUG',
+  30: 'INFO',
+  40: 'WARNING',
+  50: 'ERROR',
+  60: 'CRITICAL'
+}
+
+module.exports = {
+  CloudLogging
+}

lib/index.js

@@ -1,39 +1,55 @@
 {
-  "name": "<lib_name>",
+  "name": "cloud-pine",
   "version": "0.0.0",
-  "description": "<description>",
+  "description": "Pino Transport abstraction for Google Cloud Logging.",
   "main": "index.js",
+  "bin": {
+    "cloud-pine": "./cli.js"
+  },
   "types": "index.d.ts",
   "scripts": {
-    "test": "tap --cov test/*.test.js && npm run typescript",
-    "test:ci": "tap --cov test/*.test.js && npm run typescript && npm run lint",
+    "test": "tap --cov test/**/*.test.js && npm run test:ts && npm run lint",
+    "test:ci": "tap --cov test/**/*.test.js && npm run test:ts && npm run lint:ci",
     "test:only": "tap --only",
     "test:unit": "tap test/*.test.js",
+    "test:ts": "tsd",
     "lint": "standard | snazzy",
-    "lint:ci": "standard",
-    "typescript": "tsd"
+    "lint:ci": "standard"
   },
-  "keywords": [],
+  "keywords": [
+    "pino",
+    "pine",
+    "gcp",
+    "google-cloud",
+    "google-cloud-platform",
+    "cloud",
+    "cloud-pine",
+    "logging",
+    "cloud-logging"
+  ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/metcoder95/<lib_name>.git"
+    "url": "git+https://github.com/metcoder95/cloud-pine.git"
   },
-  "readme": "https://github.com/metcoder95/<lib_name>/blob/main/README.md",
+  "readme": "https://github.com/metcoder95/cloud-pine/blob/main/README.md",
   "bugs": {
-    "url": "https://github.com/metcoder95/<lib_name>/issues"
+    "url": "https://github.com/metcoder95/cloud-pine/issues"
   },
   "author": "metcoder95 <[email protected]>",
   "license": "MIT",
   "devDependencies": {
     "@types/node": "^14.17.6",
     "husky": "^7.0.2",
+    "pino": "^8.2.0",
     "snazzy": "^9.0.0",
     "standard": "^16.0.3",
     "tap": "^15.0.10",
     "tsd": "^0.17.0",
     "typescript": "^4.4"
   },
   "dependencies": {
+    "@google-cloud/logging": "^10.1.1",
+    "split2": "^4.1.0"
   },
   "tsd": {
     "directory": "test"