[pinpoint-apm#117] Support logger, authentication adaptor pattern

typescript tools support for .d.ts
    * https://nodejs.org/api/modules.html#enabling
    * fix license convention by https://docs.npmjs.com/cli/v8/configuring-npm/package-json#license

Logger Adaptor pattern
   * The Logger must implements pinpoint.json config loading status and a  log level. 
    * support integration test
    * if adaptor doesn't have adaptor outer method, Agent outs logs to console

lib/client/grpc-data-sender.js

@@ -10,7 +10,7 @@ const grpc = require('@grpc/grpc-js')
 const log = require('../utils/logger')
 const services = require('../data/v1/Service_grpc_pb')
 const dataConvertor = require('../data/grpc-data-convertor')
-const pingIdGenerator = require('../context/sequence-generator').pingIdGenerator
+const pingIdGenerator = require('../context/sequence-generators').pingIdGenerator
 const GrpcBidirectionalStream = require('./grpc-bidirectional-stream')
 const GrpcClientSideStream = require('./grpc-client-side-stream')
 const GrpcUnaryRPC = require('./grpc-unary-rpc')

lib/config.js

@@ -247,10 +247,15 @@ function hasDockerCGroup() {
  }
 }
 
+function needsLoadConfig() {
+ return !agentConfig
+}
+
 module.exports = {
  getConfig,
  clear,
  readConfigJson,
  readRootConfigFile,
- getMainModulePath
+ getMainModulePath,
+ needsLoadConfig
 }

lib/context/api-meta-service.js

@@ -6,7 +6,7 @@
 
 'use strict'
 
-const apiMetaCacheKeyGenerator = require('../context/sequence-generator').apiMetaCacheKeyGenerator
+const apiMetaCacheKeyGenerator = require('../context/sequence-generators').apiMetaCacheKeyGenerator
 const SimpleCache = require('../utils/simple-cache')
 const GeneralMethodDescriptor = require('../constant/method-descriptor').GeneralMethodDescriptor
 const ApiMetaInfo = require('../data/dto/api-meta-info')

lib/context/disable-span-event-recorder.js

@@ -7,7 +7,7 @@
 'use strict'
 
 const AsyncId = require('./async-id')
-const asyncIdGenerator = require('./sequence-generator').asyncIdGenerator
+const asyncIdGenerator = require('./sequence-generators').asyncIdGenerator
 
 class DisableSpanEventRecorder {
  constructor() {

lib/context/sequence-generator.js

@@ -26,12 +26,4 @@ class SequenceGenerator{
  }
 }
 
-module.exports = {
- SequenceGenerator,
- transactionIdGenerator: new SequenceGenerator(),
- asyncIdGenerator: new SequenceGenerator(1),
- stringMetaCacheKeyGenerator: new SequenceGenerator(1),
- apiMetaCacheKeyGenerator: new SequenceGenerator(1),
- pingIdGenerator: new SequenceGenerator(),
- dummyIdGenerator: new SequenceGenerator(),
-}
+module.exports = SequenceGenerator

lib/context/sequence-generators.js

@@ -0,0 +1,11 @@
+const SequenceGenerator = require('./sequence-generator')
+
+module.exports = {
+ transactionIdGenerator: new SequenceGenerator(),
+ asyncIdGenerator: new SequenceGenerator(1),
+ stringMetaCacheKeyGenerator: new SequenceGenerator(1),
+ apiMetaCacheKeyGenerator: new SequenceGenerator(1),
+ pingIdGenerator: new SequenceGenerator(),
+ dummyIdGenerator: new SequenceGenerator(),
+ }
+

lib/context/span-event-recorder.js

@@ -10,8 +10,8 @@ const Annotation = require('./annotation')
 const DefaultAnnotationKey = require('../constant/annotation-key').DefaultAnnotationKey
 const StringMetaService = require('./string-meta-service')
 const AsyncId = require('./async-id')
-const asyncIdGenerator = require('./sequence-generator').asyncIdGenerator
-const dummyIdGenerator = require('./sequence-generator').dummyIdGenerator
+const asyncIdGenerator = require('./sequence-generators').asyncIdGenerator
+const dummyIdGenerator = require('./sequence-generators').dummyIdGenerator
 const AnnotationKeyUtils = require('./annotation-key-utils')
 
 // https://github.com/pinpoint-apm/pinpoint/blob/master/bootstraps/bootstrap-core/src/main/java/com/navercorp/pinpoint/bootstrap/context/SpanEventRecorder.java

lib/context/trace-context.js

@@ -22,6 +22,14 @@ class TraceContext {
  this.dataSender = null
  }
 
+ /**
+ * trace context singleton instance
+ * @param {string} options 
+ * @param {string} dataSender 
+ * @param {string} config 
+ * @returns {TraceContext}
+ * @constructor
+ */
  static init (options, dataSender, config) {
  if (!options.agentId || !options.applicationName) {
  throw new Error('Fail to initialize pinpoint context')
@@ -132,7 +140,4 @@ class TraceContext {
  }
 }
 
-module.exports = {
- init: TraceContext.init
-}
-
+module.exports = TraceContext

lib/context/transaction-id.js

@@ -6,7 +6,7 @@
 
 'use strict'
 
-const transactionIdGenerator = require('./sequence-generator').transactionIdGenerator
+const transactionIdGenerator = require('./sequence-generators').transactionIdGenerator
 
 const DELIMETER = '^'
 

lib/instrumentation/module/mysql2.js

@@ -104,3 +104,4 @@ module.exports = function (agent, version, mysql2) {
  }
  }
  }
+}

lib/supports.js

@@ -0,0 +1,45 @@
+/**
+ * Pinpoint Node.js Agent
+ * Copyright 2022-present NAVER Corp.
+ * Apache License v2.0
+ */
+
+'use strict'
+
+const Logger = require('./utils/log/logger2')
+const { getConfig, needsLoadConfig } = require('./config')
+
+const noneConfigurationLog = new Logger.NoneBuilder({
+ output: console,
+ debug: function (message) {
+ this.output.debug(message)
+ },
+ info: function (message) {
+ this.output.info(message)
+ },
+ warn: function (message) {
+ this.output.warn(message)
+ },
+ error: function (message) {
+ this.output.error(message)
+ }
+}).build()
+
+let log = undefined
+module.exports = {
+ getLog: function () {
+ if (log) {
+ return log
+ }
+
+ if (needsLoadConfig()) {
+ return noneConfigurationLog
+ }
+
+ const config = getConfig()
+ if (!log) {
+ log = Logger.makeBuilder(config.logLevel, {}).build()
+ }
+ return log
+ }
+}

lib/utils/log/logger-output-adaptor.js

@@ -0,0 +1,63 @@
+/**
+ * Pinpoint Node.js Agent
+ * Copyright 2022-present NAVER Corp.
+ * Apache License v2.0
+ */
+
+'use strict'
+
+class LoggerOutputAdaptor {
+ constructor(output) {
+ this.output = output
+ }
+
+ get console() {
+ return console
+ }
+
+ debug(message) {
+ if (!this.output || typeof this.output.debug != 'function') {
+ if (typeof this.output.error === 'function') {
+ this.output.error("The Adaptor doesn't has the debug function.")
+ } else {
+ this.console.error("The Adaptor doesn't has the debug function.")
+ }
+ return
+ }
+ this.output.debug(message)
+ }
+
+ info(message) {
+ if (!this.output || typeof this.output.info != 'function') {
+ if (typeof this.output.error === 'function') {
+ this.output.error("The Adaptor doesn't has the info function.")
+ } else {
+ this.console.error("The Adaptor doesn't has the info function.")
+ }
+ return
+ }
+ this.output.info(message)
+ }
+
+ warn(message) {
+ if (!this.output || typeof this.output.warn != 'function') {
+ if (typeof this.output.error === 'function') {
+ this.output.error("The Adaptor doesn't has the warn function.")
+ } else {
+ this.console.error("The Adaptor doesn't has the warn function.")
+ }
+ return
+ }
+ this.output.warn(message)
+ }
+
+ error(message) {
+ if (!this.output || typeof this.output.error != 'function') {
+ this.console.error("The Adaptor doesn't has the error function.")
+ return
+ }
+ this.output.error(message)
+ }
+}
+
+module.exports = LoggerOutputAdaptor

lib/utils/log/logger2.js

@@ -0,0 +1,128 @@
+/**
+ * Pinpoint Node.js Agent
+ * Copyright 2020-present NAVER Corp.
+ * Apache License v2.0
+ */
+
+'use strict'
+
+const LoggerOutputAdaptor = require('./logger-output-adaptor')
+
+class Logger {
+
+ constructor(type, adaptor) {
+ this.type = type
+ this.adaptor = new LoggerOutputAdaptor(adaptor)
+ }
+
+ static get DebugBuilder() {
+ return Logger.Builder(LogType.debug)
+ }
+
+ static Builder(type) {
+ return class Builder {
+ constructor(adaptor) {
+ this.type = type
+ this.adaptor = adaptor
+ }
+
+ build() {
+ return new Logger(this.type, this.adaptor)
+ }
+ }
+ }
+
+ static get InfoBuilder() {
+ return Logger.Builder(LogType.info)
+ }
+
+ static get WarnBuilder() {
+ return Logger.Builder(LogType.warn)
+ }
+
+ static get ErrorBuilder() {
+ return Logger.Builder(LogType.error)
+ }
+
+ static get NoneBuilder() {
+ return Logger.Builder(LogType.noneConfig)
+ }
+
+ static makeBuilder(name, adaptor) {
+ return new (Logger.Builder(LogType.valueOf(name)))(adaptor)
+ }
+
+ debug(message) {
+ this.adaptor.debug(message)
+ }
+
+ isDebug() {
+ return this.type.isDebug()
+ }
+
+ info(message) {
+ this.adaptor.info(message)
+ }
+
+ isInfo() {
+ return this.type.isInfo()
+ }
+
+ warn(message) {
+ this.adaptor.warn(message)
+ }
+
+ error(message) {
+ this.adaptor.error(message)
+ }
+}
+
+class LogType {
+
+ static get debug() {
+ return new LogType('DEBUG')
+ }
+
+ static get info() {
+ return new LogType('INFO')
+ }
+
+ static get warn() {
+ return new LogType('WARN')
+ }
+
+ static get error() {
+ return new LogType('ERROR')
+ }
+
+ static get noneConfig() {
+ return new LogType('NONE')
+ }
+
+ static valueOf(name) {
+ if (name.toUpperCase) {
+ name = name.toUpperCase()
+ }
+ const type = [this.debug, this.info, this.warn, this.error].find(element => element.name === name)
+ if (!type) {
+ return this.noneConfig
+ }
+
+ return type
+ }
+
+ constructor(name) {
+ this.name = name
+ }
+
+ isDebug() {
+ return this.name === LogType.debug.name
+ }
+
+ isInfo() {
+ return this.name === LogType.info.name
+ }
+}
+
+
+module.exports = Logger

package.json

@@ -2,6 +2,7 @@
  "name": "pinpoint-node-agent",
  "version": "0.9.0-next.2",
  "main": "index.js",
+ "type": "commonjs",
  "scripts": {
  "test": "tape ./test/**/*.test.js",
  "lint": "eslint -f checkstyle ./lib > checkstyle-result.xml;exit 0",
@@ -16,12 +17,6 @@
  "Yongseok Kang <feelform@gmail.com> (https://github.com/feelform)"
  ],
  "license": "Apache-2.0",
- "licenses": [
- {
- "type": "Apache-2.0",
- "url": "http://www.apache.org/licenses/LICENSE-2.0"
- }
- ],
  "bugs": {
  "url": "https://github.com/pinpoint-apm/pinpoint-node-agent/issues"
  },
@@ -85,6 +80,7 @@
  "redis-mock": "^0.49.0",
  "rimraf": "^2.6.2",
  "tape": "^4.9.1",
- "testcontainers": "^7.24.0"
+ "testcontainers": "^7.24.0",
+ "typescript": "^4.8.3"
  }
 }