Completely remove log4js from the server package (#4)

Author: the21st

packages/server/package.json

@@ -45,7 +45,6 @@
     "@types/yargs": "^17.0.8",
     "cardinal": "^2.1.1",
     "jest": "^26.0.1",
-    "log4js": "^6.2.1",
     "mysql2": "^2.3.0",
     "node-ssh-forward": "^0.6.3",
     "pg": "^8.9.0",

packages/server/src/SettingStore.ts

@@ -1,9 +1,9 @@
 import * as fs from 'fs'
 import * as path from 'path'
 import EventEmitter from 'events'
-import log4js from 'log4js'
+import { stubLogger } from './logger'
 
-const logger = log4js.getLogger()
+const logger = stubLogger()
 
 export type SSHConfig = {
   remoteHost: string

packages/server/src/cache.ts

@@ -1,8 +1,8 @@
 import { Diagnostic as SQLintDiagnostic } from 'sqlint'
-import log4js from 'log4js'
 import { Diagnostic, Range } from 'vscode-languageserver'
+import { stubLogger } from './logger'
 
-const logger = log4js.getLogger()
+const logger = stubLogger()
 
 export type LintCache = { lint: SQLintDiagnostic; diagnostic: Diagnostic }
 class Cache {

packages/server/src/complete/AstUtils.ts

@@ -4,11 +4,11 @@ import {
   SelectStatement,
   NodeRange,
 } from '@joe-re/sql-parser'
-import log4js from 'log4js'
 import { Table } from '../database_libs/AbstractClient'
+import { stubLogger } from '../logger'
 import { Pos } from './complete'
 
-const logger = log4js.getLogger()
+const logger = stubLogger()
 
 function isNotEmpty<T>(value: T | null | undefined): value is T {
   return value === null || value === undefined ? false : true

packages/server/src/complete/complete.ts

@@ -14,6 +14,7 @@ import {
 } from '@joe-re/sql-parser'
 import { CompletionItem } from 'vscode-languageserver-types'
 import { Schema, Table } from '../database_libs/AbstractClient'
+import { stubLogger } from '../logger'
 import { getRidOfAfterPosString } from './StringUtils'
 import { getLastToken } from './utils/getLastToken'
 import {
@@ -40,15 +41,7 @@ import { ICONS, toCompletionItemForKeyword } from './CompletionItemUtils'
 
 export type Pos = { line: number; column: number }
 
-// stubbing logger to make the lib work in browser
-const logger = {
-  isDebugEnabled: function () {
-    return false
-  },
-  debug: function (_: unknown) {
-    return undefined
-  },
-}
+const logger = stubLogger()
 
 function getFromNodesFromClause(sql: string): FromClauseParserResult | null {
   try {

packages/server/src/createConnection.ts

@@ -6,9 +6,10 @@ import {
   IPCMessageReader,
   IPCMessageWriter,
 } from 'vscode-jsonrpc/lib/node/main'
-import log4js from 'log4js'
 import { ConnectionMethod } from './createServer'
-const logger = log4js.getLogger()
+import { stubLogger } from './logger'
+
+const logger = stubLogger()
 
 export default function createConnection(method: ConnectionMethod): Connection {
   logger.debug(`createConnection: method {${method}}`)

packages/server/src/createDiagnostics.ts

@@ -1,11 +1,11 @@
 import { parse, ParseError } from '@joe-re/sql-parser'
-import log4js from 'log4js'
 import { PublishDiagnosticsParams, Diagnostic } from 'vscode-languageserver'
 import { DiagnosticSeverity } from 'vscode-languageserver-types'
 import { lint, ErrorLevel, LintResult, RawConfig } from 'sqlint'
 import cache, { LintCache } from './cache'
+import { stubLogger } from './logger'
 
-const logger = log4js.getLogger()
+const logger = stubLogger()
 
 function doLint(
   uri: string,

packages/server/src/createServer.ts

@@ -18,7 +18,6 @@ import {
   CodeActionKind,
 } from 'vscode-languageserver-types'
 import { lint, LintResult } from 'sqlint'
-import log4js from 'log4js'
 import { RawConfig } from 'sqlint'
 import cache from './cache'
 import { complete } from './complete'
@@ -27,19 +26,15 @@ import createConnection from './createConnection'
 import SettingStore, { Connection as SettingConnection } from './SettingStore'
 import { Schema } from './database_libs/AbstractClient'
 import getDatabaseClient from './database_libs/getDatabaseClient'
-import initializeLogging from './initializeLogging'
 import { RequireSqlite3Error } from './database_libs/Sqlite3Client'
+import { stubLogger } from './logger'
 
 export type ConnectionMethod = 'node-ipc' | 'stdio'
 
 const TRIGGER_CHARATER = '.'
 
-export function createServerWithConnection(
-  connection: Connection,
-  debug = false
-) {
-  initializeLogging(debug)
-  const logger = log4js.getLogger()
+export function createServerWithConnection(connection: Connection) {
+  const logger = stubLogger()
   const documents = new TextDocuments(TextDocument)
   documents.listen(connection)
   let schema: Schema = { tables: [], functions: [] }
@@ -396,5 +391,5 @@ export function createServer(
   params: { method?: ConnectionMethod; debug?: boolean } = {}
 ) {
   const connection: Connection = createConnection(params.method ?? 'node-ipc')
-  return createServerWithConnection(connection, params.debug)
+  return createServerWithConnection(connection)
 }

packages/server/src/database_libs/AbstractClient.ts

@@ -1,9 +1,9 @@
 import { readFileSync } from 'fs'
-import log4js from 'log4js'
 import { SSHConnection } from 'node-ssh-forward'
 import { Connection } from '../SettingStore'
+import { stubLogger } from '../logger'
 
-const logger = log4js.getLogger()
+const logger = stubLogger()
 
 export type RawField = {
   field: string

packages/server/src/database_libs/Sqlite3Client.ts

@@ -1,9 +1,9 @@
 import { sqlite3 as SQLite3, Database } from 'sqlite3'
-import log4js from 'log4js'
 import { Connection } from '../SettingStore'
+import { stubLogger } from '../logger'
 import AbstractClient, { RawField } from './AbstractClient'
 
-const logger = log4js.getLogger()
+const logger = stubLogger()
 
 export class RequireSqlite3Error extends Error {
   constructor(message: string) {