upgrade pino (#881)

* upgrade pino
* build tweaks and package updates

.github/workflows/scala-format.yml

@@ -33,5 +33,5 @@ jobs:
         uses: jrouly/scalafmt-native-action@v3
         with:
           # NOTE: make sure this version matches the version in .scalafmt.conf
-          version: '3.7.3'
+          version: '3.7.17'
           arguments: '--list --mode diff-ref=origin/main'

.scalafmt.conf

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 # NOTE: make sure this version matches the version in scala-format.yml
-version = "3.7.3"
+version = "3.7.17"
 maxColumn = 120
 rewrite.rules = [SortImports, RedundantBraces]
 runner.dialect = scala213

package.json

@@ -23,23 +23,22 @@
     "package-no-sbt": "yarn workspace @omega-edit/server package-no-sbt && yarn workspace @omega-edit/client package"
   },
   "devDependencies": {
-    "@types/chai": "^4.3.11",
+    "@types/chai": "^4.3.12",
     "@types/mocha": "^10.0.6",
     "@types/node": "^20.11.24",
     "chai": "^4.3.10",
     "copy-webpack-plugin": "^11.0.0",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.1.3",
-    "mocha": "^10.0.0",
+    "mocha": "^10.2.0",
     "prettier": "^3.2.4",
     "run-script-os": "^1.1.6",
     "ts-loader": "^9.5.1",
-    "ts-node": "^10.9.2",
-    "typedoc": "^0.25.9",
+    "typedoc": "^0.25.10",
     "typescript": "^5.3.3",
     "unzip-stream": "^0.3.1",
-    "webpack": "^5.90.1",
+    "webpack": "^5.90.3",
     "webpack-cli": "^5.1.4"
   },
   "prettier": {

packages/client/package.json

@@ -3,8 +3,9 @@
   "version": "0.9.78",
   "description": "OmegaEdit gRPC Client",
   "publisher": "ctc-oss",
-  "main": "out/index.js",
-  "types": "out/index.d.ts",
+  "exports": "./out/main.js",
+  "main": "./out/main.js",
+  "types": "./out/index.d.ts",
   "repository": {
     "url": "https://github.com/ctc-oss/omega-edit",
     "type": "git"
@@ -21,24 +22,29 @@
     "compile-src:windows": "./compile-proto.bat",
     "docgen": "typedoc",
     "prepackage": "yarn compile-src && yarn build",
-    "package": "yarn --cwd out cache clean && yarn --cwd out pack --install-if-needed -f omega-edit-node-client-v$npm_package_version.tgz",
-    "install-client-local": "yarn add file://$INIT_CWD/omega-edit-node-client-v$npm_package_version.tgz",
+    "package": "yarn --cwd out cache clean && yarn --cwd out pack --install-if-needed -f omega-edit-node-client-v${npm_package_version}.tgz",
+    "install-client-local": "yarn add file://$INIT_CWD/omega-edit-node-client-v${npm_package_version}.tgz",
     "pretest": "yarn package && yarn install-client-local",
-    "test": "mocha --exit --timeout 50000 --slow 10000 --require ts-node/register --require tests/fixtures.ts --exclude ./tests/specs/server.spec.ts ./tests/specs/*.spec.ts && mocha --exit --timeout 10000 --slow 1000 --require ts-node/register ./tests/specs/server.spec.ts || (yarn posttest && exit 1)",
+    "test:client": "mocha --exit --timeout 100000 --slow 50000 --require ts-node/register --require tests/fixtures.ts --exclude ./tests/specs/server.spec.ts ./tests/specs/*.spec.ts",
+    "test:lifecycle": "mocha --exit --timeout 100000 --slow 50000 --require ts-node/register ./tests/specs/server.spec.ts",
+    "test": "(yarn test:client && yarn test:lifecycle) || (yarn posttest && exit 1)",
     "posttest": "yarn remove @omega-edit/client",
     "lint": "prettier --check package.json webpack.config.js src tests && eslint .",
     "lint:fix": "prettier --write package.json webpack.config.js src tests && eslint --fix ."
   },
   "devDependencies": {
     "grpc-tools": "^1.12.4",
-    "grpc_tools_node_protoc_ts": "^5.3.3"
+    "grpc_tools_node_protoc_ts": "^5.3.3",
+    "pino-webpack-plugin": "^2.0.0",
+    "ts-node": "^10.9.2"
   },
   "dependencies": {
     "@grpc/grpc-js": "1.10.1",
     "@omega-edit/server": "0.9.78",
     "@types/google-protobuf": "3.15.12",
     "google-protobuf": "3.21.2",
-    "pino": "8.16.2",
+    "pid-port": "0.2.0",
+    "pino": "8.19.0",
     "wait-port": "1.1.0"
   }
 }

packages/client/src/change.ts

@@ -542,6 +542,7 @@ export async function clear(
         }
         log.error({
           fn: 'clear',
+          rqst: request.toObject(),
           err: {
             msg: err.message,
             details: err.details,

packages/client/src/client.ts

@@ -56,7 +56,7 @@ export function waitForReady(
     client.waitForReady(deadline, (err: Error | undefined) => {
       if (err) {
         log.error({
-          cmd: 'waitForReady',
+          fn: 'waitForReady',
           state: 'not ready',
           err: {
             name: err.name,
@@ -66,7 +66,7 @@ export function waitForReady(
         })
         return reject(err)
       }
-      log.debug({ cmd: 'waitForReady', state: 'ready' })
+      log.debug({ fn: 'waitForReady', state: 'ready' })
       return resolve()
     })
   })
@@ -110,7 +110,7 @@ export async function getClient(
       if (err instanceof Error) {
         // Ensure that we caught an Error object
         log.error({
-          cmd: 'getClient',
+          fn: 'getClient',
           host: host,
           port: port,
           state: 'not ready',
@@ -123,7 +123,7 @@ export async function getClient(
       } else {
         // handle non-Error type, and log the error as a string.
         log.error({
-          cmd: 'getClient',
+          fn: 'getClient',
           host: host,
           port: port,
           state: 'not ready',

packages/client/src/logger.ts

@@ -31,30 +31,33 @@ let logger_: Logger
 
 /**
  * Builds a logger
- * @param transports array of transports to log to
+ * @param stream destination stream
  * @param level log level
  * @returns logger
  */
 function buildLogger(
-  transports: any[],
+  stream: pino.DestinationStream,
   level: string = process.env.OMEGA_EDIT_CLIENT_LOG_LEVEL || 'info'
 ): Logger {
-  const logger = pino({
-    level: level,
-    formatters: {
-      level: (label) => {
-        return { level: label.toUpperCase() }
+  const logger = pino(
+    {
+      level: level,
+      formatters: {
+        level: (label) => {
+          return { level: label.toUpperCase() }
+        },
       },
+      timestamp: pino.stdTimeFunctions.isoTime,
     },
-    timestamp: pino.stdTimeFunctions.isoTime,
-    transports: transports,
-  })
+    stream
+  )
+
   logger.debug({
     fn: 'buildLogger',
     msg: 'logger built',
     level: level,
-    transports: transports,
   })
+
   return logger
 }
 
@@ -89,12 +92,16 @@ export function createSimpleFileLogger(
 export function getLogger(): Logger {
   if (!logger_) {
     setLogger(
-      buildLogger([
-        {
-          target: 'pino/file',
-          options: { destination: 2 }, // use 1 for stdout and 2 for stderr
-        },
-      ])
+      buildLogger(
+        pino.transport({
+          targets: [
+            {
+              target: 'pino/file',
+              options: { destination: 2 }, // use 1 for stdout and 2 for stderr
+            },
+          ],
+        })
+      )
     )
     getLogger().debug({ fn: 'getLogger', msg: 'logger initialized' })
   }
@@ -107,5 +114,5 @@ export function getLogger(): Logger {
  */
 export function setLogger(logger: Logger) {
   logger_ = logger
-  getLogger().info({ fn: 'setLogger', msg: 'logger set' })
+  getLogger().debug({ fn: 'setLogger', msg: 'logger set' })
 }