mynth-logger 1.0.2

package/.github/workflows/CI.yaml

@@ -0,0 +1,67 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.16.1
+
+      - name: Update npm
+        run: npm install -g npm@9.7.2
+
+      - name: Install dependencies
+        run: npm ci --include dev
+
+      - name: Run tests
+        run: npm run test
+
+  lint:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.16.1
+
+      - name: Install dependencies
+        run: npm install --include dev
+
+      - name: Lint
+        run: npm run lint
+
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.16.1
+
+      - name: Install dependencies
+        run: npm install --include dev
+
+      - name: Validate TypeScript
+        run: npm run build

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,36 @@
+name: Publish to npm
+
+on:
+  pull_request:
+    types:
+      - closed
+    branches:
+      - main
+
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.head_ref }}
+          fetch-depth: 0
+          token: ${{ secrets.PAT }}
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18.16.1
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm run build
+      - name: Git configuration
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+      - run: npm version --commit-hooks true patch
+      - name: Git commit and push
+        env:
+          GITHUB_TOKEN: ${{ secrets.PAT }}
+        run: git push origin
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

package/.prettierignore

@@ -0,0 +1,2 @@
+*.md
+dist

package/.prettierrc

@@ -0,0 +1,8 @@
+{
+  "printWidth": 80,
+  "tabWidth": 2,
+  "singleQuote": false,
+  "trailingComma": "es5",
+  "semi": true,
+  "useTabs": false
+}

package/README.md

@@ -0,0 +1,13 @@
+# mynth-logger
+
+This repository stores configuration options for handling logs in Mynth
+microservices. The `setupLogging` function is publicly exposed and can
+be called in entrypoint scripts. This function overrides `console.log`
+statements.
+
+For local development, install pino-pretty via `npm install --save-dev
+pino-pretty`. After calling `setupLogging()`, `console.log` calls will
+output colorful statements to the terminal.
+
+For production builds, logs are output to stdout in JSON format that can
+be parsed and processed by Datadog.

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "mynth-logger",
+  "version": "1.0.2",
+  "description": "Package to format logs for mynth microservices.",
+  "main": "./src/index.ts",
+  "scripts": {
+    "test": "npx ava",
+    "build": "tsc",
+    "prettier": "npx prettier -w '**/*.{js,jsx,ts,tsx,json,yml.j2,yml,yaml,.*}'",
+    "lint": "concurrently \"npx prettier --check '**/*.{js,jsx,ts,tsx,json,yml.j2,yml,yaml,.*}'\" \"npx eslint --max-warnings=0\""
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@github.com-mynth:MynthAI/mynth-logger.git"
+  },
+  "dependencies": {
+    "ava": "^5.3.1",
+    "json5": "^2.2.3",
+    "pino": "^8.15.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.5.0",
+    "concurrently": "^8.2.0",
+    "eslint": "^8.47.0",
+    "eslint-plugin-ava": "^14.0.0",
+    "pino-pretty": "^10.2.0",
+    "prettier": "^3.0.2",
+    "tsx": "^3.12.7",
+    "typescript": "^5.1.6"
+  },
+  "ava": {
+    "files": [
+      "tests/**/*.test.ts"
+    ],
+    "extensions": {
+      "ts": "module"
+    },
+    "nodeArguments": [
+      "--loader=tsx"
+    ]
+  }
+}

package/src/index.ts

@@ -0,0 +1,74 @@
+import JSON5 from "json5";
+import pino, { LoggerOptions } from "pino";
+
+const isPinoPrettyInstalled = () => {
+  try {
+    pino({ transport: { target: "pino-pretty" } });
+    return true;
+  } catch {
+    return false;
+  }
+};
+
+const pinoSettings: LoggerOptions = {
+  base: undefined,
+  timestamp: false,
+  level: "debug",
+  formatters: {
+    level(level) {
+      return { level };
+    },
+  },
+};
+
+if (isPinoPrettyInstalled() && process.env.NODE_ENV != "test") {
+  pinoSettings["transport"] = {
+    target: "pino-pretty",
+    options: {
+      colorize: true,
+    },
+  };
+}
+
+const logger = pino(pinoSettings);
+
+const formatItem = (item: any): string => {
+  // Remove colors from strings
+  if (typeof item === "string") {
+    return item.replace(/\x1b\[[0-9;]*m/g, "");
+  }
+
+  return JSON5.stringify(item).replace(/^\'|\'$/g, "");
+};
+
+const format = (items: any[]): string => {
+  return Array.from(items)
+    .map((item) => formatItem(item))
+    .join(" ");
+};
+
+const setupLogging = () => {
+  if (typeof window !== "undefined") return;
+
+  console.log = function () {
+    logger.info(format(Array.from(arguments)));
+  };
+
+  console.info = function () {
+    logger.info(format(Array.from(arguments)));
+  };
+
+  console.warn = function () {
+    logger.warn(format(Array.from(arguments)));
+  };
+
+  console.error = function () {
+    logger.error(format(Array.from(arguments)));
+  };
+
+  console.debug = function () {
+    logger.debug(format(Array.from(arguments)));
+  };
+};
+
+export { setupLogging };

package/tests/index.test.ts

@@ -0,0 +1,8 @@
+import test from "ava";
+import { setupLogging } from "../src/index";
+
+test("setupLogging can be called", (t) => {
+  setupLogging();
+  console.debug("Hello ava");
+  t.pass();
+});

package/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "target": "es5",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "strict": false,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "jsx": "react",
+    "paths": {
+      "src": ["./src"]
+    }
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "build"],
+  "ts-node": {
+    "transpileOnly": true,
+    "swc": true
+  }
+}