From d1a440e7bd7f7027972383a5bbe4227351d72a89 Mon Sep 17 00:00:00 2001 From: Raccoon Date: Sat, 12 Jun 2021 15:36:46 +0800 Subject: [PATCH] refactor logger export Signed-off-by: Raccoon --- lib/app.ts | 2 +- lib/auth/email/index.ts | 2 +- lib/auth/index.ts | 2 +- lib/auth/ldap/index.ts | 2 +- lib/auth/openid/index.ts | 2 +- lib/auth/saml/index.ts | 2 +- lib/auth/utils.ts | 2 +- lib/config/index.ts | 2 +- lib/history/index.ts | 2 +- lib/homepage/index.ts | 2 +- lib/imageRouter/azure.ts | 2 +- lib/imageRouter/filesystem.ts | 2 +- lib/imageRouter/imgur.ts | 2 +- lib/imageRouter/index.ts | 2 +- lib/imageRouter/lutim.ts | 2 +- lib/imageRouter/minio.ts | 2 +- lib/imageRouter/s3.ts | 2 +- lib/logger.ts | 5 +++-- lib/middleware/checkURIValid.ts | 2 +- lib/models/index.ts | 2 +- lib/models/note.ts | 2 +- lib/models/revision.ts | 2 +- lib/models/user.ts | 2 +- lib/note/index.ts | 2 +- lib/note/noteActions.ts | 2 +- lib/realtime/realtime.ts | 2 +- lib/realtime/realtimeCleanDanglingUserJob.ts | 2 +- lib/realtime/realtimeClientConnection.ts | 2 +- lib/realtime/realtimeSaveRevisionJob.ts | 2 +- lib/realtime/realtimeUpdateDirtyNoteJob.ts | 2 +- lib/response.ts | 2 +- lib/user/index.ts | 2 +- lib/web/middleware/checkVersion.ts | 2 +- lib/workers/dmpWorker.ts | 2 +- 34 files changed, 36 insertions(+), 35 deletions(-) diff --git a/lib/app.ts b/lib/app.ts index fb264c05..2973cc0b 100644 --- a/lib/app.ts +++ b/lib/app.ts @@ -20,7 +20,7 @@ import SocketIo from 'socket.io' import {Server as WsServer} from 'ws' // core import * as config from "./config"; -import * as logger from "./logger"; +import {logger} from "./logger"; import * as response from "./response"; import * as models from "./models"; import * as csp from "./csp"; diff --git a/lib/auth/email/index.ts b/lib/auth/email/index.ts index fb6da6c4..c0f0de62 100644 --- a/lib/auth/email/index.ts +++ b/lib/auth/email/index.ts @@ -5,7 +5,7 @@ import {Strategy as LocalStrategy} from 'passport-local'; import * as config from '../../config'; import * as models from '../../models'; -import * as logger from "../../logger"; +import {logger} from "../../logger"; import {setReturnToFromReferer} from "../utils"; import {urlencodedParser} from "../../utils"; import * as response from "../../response"; diff --git a/lib/auth/index.ts b/lib/auth/index.ts index 0a93a4b3..4ba572af 100644 --- a/lib/auth/index.ts +++ b/lib/auth/index.ts @@ -2,7 +2,7 @@ import {Router} from "express"; import passport from "passport"; import * as config from "../config"; -import * as logger from "../logger"; +import {logger} from "../logger"; import * as models from "../models"; const authRouter = Router() diff --git a/lib/auth/ldap/index.ts b/lib/auth/ldap/index.ts index 42796aaf..137ab9c8 100644 --- a/lib/auth/ldap/index.ts +++ b/lib/auth/ldap/index.ts @@ -4,7 +4,7 @@ import LDAPStrategy from "passport-ldapauth"; import * as config from "../../config"; import * as models from "../../models"; -import * as logger from "../../logger"; +import {logger} from "../../logger"; import * as response from "../../response"; import {setReturnToFromReferer} from "../utils"; import {urlencodedParser} from "../../utils"; diff --git a/lib/auth/openid/index.ts b/lib/auth/openid/index.ts index 5155d16f..0bcc1270 100644 --- a/lib/auth/openid/index.ts +++ b/lib/auth/openid/index.ts @@ -4,7 +4,7 @@ import {Strategy as OpenIDStrategy} from "@passport-next/passport-openid"; import * as config from "../../config"; import * as models from "../../models"; -import * as logger from "../../logger"; +import {logger} from "../../logger"; import {urlencodedParser} from "../../utils"; import {setReturnToFromReferer} from "../utils"; diff --git a/lib/auth/saml/index.ts b/lib/auth/saml/index.ts index 66a9da31..e66cd2d6 100644 --- a/lib/auth/saml/index.ts +++ b/lib/auth/saml/index.ts @@ -5,7 +5,7 @@ import {Strategy as SamlStrategy} from "passport-saml"; import * as config from "../../config"; import * as models from "../../models"; -import * as logger from "../../logger"; +import {logger} from "../../logger"; import {urlencodedParser} from "../../utils"; const intersection = function (array1, array2) { diff --git a/lib/auth/utils.ts b/lib/auth/utils.ts index 162b4aff..fe09a6f8 100644 --- a/lib/auth/utils.ts +++ b/lib/auth/utils.ts @@ -2,7 +2,7 @@ import * as models from "../models"; import * as config from "../config"; -import * as logger from "../logger"; +import {logger} from "../logger"; export function setReturnToFromReferer(req) { if (!req.session) req.session = {} diff --git a/lib/config/index.ts b/lib/config/index.ts index cf87474d..53b3ef28 100644 --- a/lib/config/index.ts +++ b/lib/config/index.ts @@ -5,7 +5,7 @@ import {merge} from "lodash"; import deepFreeze from "deep-freeze"; import {Environment, Permission} from "./enum"; -import * as logger from "../logger"; +import {logger} from "../logger"; import {getGitCommit, getGitHubURL} from "./utils"; const appRootPath = path.resolve(__dirname, '../../') diff --git a/lib/history/index.ts b/lib/history/index.ts index 43efc5d2..90257818 100644 --- a/lib/history/index.ts +++ b/lib/history/index.ts @@ -3,7 +3,7 @@ import LZString from '@hackmd/lz-string' import * as models from '../models' -import * as logger from '../logger' +import {logger} from '../logger' import * as config from '../config' import * as response from '../response' diff --git a/lib/homepage/index.ts b/lib/homepage/index.ts index c963003b..8fe6a36d 100644 --- a/lib/homepage/index.ts +++ b/lib/homepage/index.ts @@ -4,7 +4,7 @@ import * as config from '../config' // eslint-disable-next-line @typescript-eslint/ban-ts-comment // @ts-ignore import {User} from '../models' -import * as logger from '../logger' +import {logger} from '../logger' import {Request, Response} from "express"; diff --git a/lib/imageRouter/azure.ts b/lib/imageRouter/azure.ts index 6084720f..66e8ce1e 100644 --- a/lib/imageRouter/azure.ts +++ b/lib/imageRouter/azure.ts @@ -4,7 +4,7 @@ import * as path from "path"; import azure from "azure-storage"; import * as config from "../config"; -import * as logger from "../logger"; +import {logger} from "../logger"; export function uploadImage(imagePath, callback) { if (!imagePath || typeof imagePath !== 'string') { diff --git a/lib/imageRouter/filesystem.ts b/lib/imageRouter/filesystem.ts index 4c0233d2..f7b8ebc5 100644 --- a/lib/imageRouter/filesystem.ts +++ b/lib/imageRouter/filesystem.ts @@ -6,7 +6,7 @@ import * as crypto from "crypto"; import {URL} from "url"; import * as config from "../config"; -import * as logger from "../logger"; +import {logger} from "../logger"; /** * generate a random filename for uploaded image diff --git a/lib/imageRouter/imgur.ts b/lib/imageRouter/imgur.ts index e3bcd3d8..c36902c5 100644 --- a/lib/imageRouter/imgur.ts +++ b/lib/imageRouter/imgur.ts @@ -2,7 +2,7 @@ import imgur from "@hackmd/imgur"; import * as config from "../config"; -import * as logger from "../logger"; +import {logger} from "../logger"; export function uploadImage(imagePath, callback) { if (!imagePath || typeof imagePath !== 'string') { diff --git a/lib/imageRouter/index.ts b/lib/imageRouter/index.ts index 55d173af..1896cb69 100644 --- a/lib/imageRouter/index.ts +++ b/lib/imageRouter/index.ts @@ -9,7 +9,7 @@ import imageType from "image-type"; import mime from "mime-types"; import * as config from "../config"; -import * as logger from "../logger"; +import {logger} from "../logger"; import * as response from "../response"; const imageRouter = Router() diff --git a/lib/imageRouter/lutim.ts b/lib/imageRouter/lutim.ts index dcd3216f..3c57ef29 100644 --- a/lib/imageRouter/lutim.ts +++ b/lib/imageRouter/lutim.ts @@ -1,7 +1,7 @@ import lutim from "lutim"; import * as config from "../config"; -import * as logger from "../logger"; +import {logger} from "../logger"; export function uploadImage(imagePath, callback) { diff --git a/lib/imageRouter/minio.ts b/lib/imageRouter/minio.ts index 5786b43d..6fd61a50 100644 --- a/lib/imageRouter/minio.ts +++ b/lib/imageRouter/minio.ts @@ -5,7 +5,7 @@ import Minio from "minio"; import * as config from "../config"; import {getImageMimeType} from "../utils"; -import * as logger from "../logger"; +import {logger} from "../logger"; const minioClient = new Minio.Client({ endPoint: config.minio.endPoint, diff --git a/lib/imageRouter/s3.ts b/lib/imageRouter/s3.ts index 47525550..48c1b668 100644 --- a/lib/imageRouter/s3.ts +++ b/lib/imageRouter/s3.ts @@ -6,7 +6,7 @@ import {PutObjectCommand, PutObjectInput} from "@aws-sdk/client-s3-node/commands import * as config from "../config"; import {getImageMimeType} from "../utils"; -import * as logger from "../logger"; +import {logger} from "../logger"; const credentials = { diff --git a/lib/logger.ts b/lib/logger.ts index 22e3df22..7efe0a7b 100644 --- a/lib/logger.ts +++ b/lib/logger.ts @@ -1,3 +1,4 @@ +// Do not require any relative module in this file, will caused circular dependencies. import {createLogger, format, transports, Logger} from "winston"; @@ -25,7 +26,7 @@ if (process.env.NODE_ENV === 'development' || !process.env.NODE_ENV) { ) } -const logger: CodiMDLogger = createLogger({ +export const logger: CodiMDLogger = createLogger({ format: defaultFormatter, transports: [ new transports.Console({ @@ -46,4 +47,4 @@ logger.setLevel = function (level) { logger.level = level } -export = logger +export default logger diff --git a/lib/middleware/checkURIValid.ts b/lib/middleware/checkURIValid.ts index e2dd33ea..ba743903 100644 --- a/lib/middleware/checkURIValid.ts +++ b/lib/middleware/checkURIValid.ts @@ -1,4 +1,4 @@ -import * as logger from '../logger' +import {logger} from '../logger' import * as response from "../response"; export default function (req, res, next) { diff --git a/lib/models/index.ts b/lib/models/index.ts index 1eb0adf5..46093fcb 100644 --- a/lib/models/index.ts +++ b/lib/models/index.ts @@ -6,7 +6,7 @@ import {cloneDeep} from "lodash"; // core import * as config from "../config"; -import * as logger from "../logger"; +import {logger} from "../logger"; const dbconfig = cloneDeep(config.db) dbconfig.logging = config.debug ? (data) => { diff --git a/lib/models/note.ts b/lib/models/note.ts index d2f75e0d..2ddbe066 100644 --- a/lib/models/note.ts +++ b/lib/models/note.ts @@ -14,7 +14,7 @@ import DiffMatchPatch from "@hackmd/diff-match-patch"; // core import * as config from "../config"; -import * as logger from "../logger"; +import {logger} from "../logger"; import {stripTags} from "../string"; // ot diff --git a/lib/models/revision.ts b/lib/models/revision.ts index ba105327..03855b00 100644 --- a/lib/models/revision.ts +++ b/lib/models/revision.ts @@ -9,7 +9,7 @@ import * as util from "util"; // core import * as config from "../config"; -import * as logger from "../logger"; +import {logger} from "../logger"; const Op = Sequelize.Op diff --git a/lib/models/user.ts b/lib/models/user.ts index f02106a0..356d70e5 100644 --- a/lib/models/user.ts +++ b/lib/models/user.ts @@ -4,7 +4,7 @@ import * as Sequelize from "sequelize"; import Scrypt from "scrypt-kdf"; // core -import * as logger from "../logger"; +import {logger} from "../logger"; import {generateAvatarURL} from "../letter-avatars"; export = function (sequelize, DataTypes) { diff --git a/lib/note/index.ts b/lib/note/index.ts index b426cf06..940dce56 100644 --- a/lib/note/index.ts +++ b/lib/note/index.ts @@ -1,5 +1,5 @@ import * as config from "../config"; -import * as logger from "../logger"; +import {logger} from "../logger"; // eslint-disable-next-line @typescript-eslint/ban-ts-comment // @ts-ignore diff --git a/lib/note/noteActions.ts b/lib/note/noteActions.ts index 5d8a0af0..d6f1549d 100644 --- a/lib/note/noteActions.ts +++ b/lib/note/noteActions.ts @@ -8,7 +8,7 @@ import moment from "moment"; // const { Pandoc } = require('@hackmd/pandoc.js') import * as config from "../config"; -import * as logger from "../logger"; +import {logger} from "../logger"; // eslint-disable-next-line @typescript-eslint/ban-ts-comment // @ts-ignore import {Note, Revision} from "../models"; diff --git a/lib/realtime/realtime.ts b/lib/realtime/realtime.ts index 7d306a76..e071479d 100644 --- a/lib/realtime/realtime.ts +++ b/lib/realtime/realtime.ts @@ -10,7 +10,7 @@ import {get} from "lodash"; // core import * as config from "../config"; -import * as logger from "../logger"; +import {logger} from "../logger"; import * as history from "../history"; import * as models from "../models"; diff --git a/lib/realtime/realtimeCleanDanglingUserJob.ts b/lib/realtime/realtimeCleanDanglingUserJob.ts index 5b864b30..30e30895 100644 --- a/lib/realtime/realtimeCleanDanglingUserJob.ts +++ b/lib/realtime/realtimeCleanDanglingUserJob.ts @@ -3,7 +3,7 @@ import async from "async"; import * as config from "../config"; -import * as logger from "../logger"; +import {logger} from "../logger"; /** * clean when user not in any rooms or user not in connected list diff --git a/lib/realtime/realtimeClientConnection.ts b/lib/realtime/realtimeClientConnection.ts index 4035c8b7..adb2ff7a 100644 --- a/lib/realtime/realtimeClientConnection.ts +++ b/lib/realtime/realtimeClientConnection.ts @@ -4,7 +4,7 @@ import {get} from "lodash"; import * as config from "../config"; import * as models from "../models"; -import * as logger from "../logger"; +import {logger} from "../logger"; export class RealtimeClientConnection { private socket: any; diff --git a/lib/realtime/realtimeSaveRevisionJob.ts b/lib/realtime/realtimeSaveRevisionJob.ts index 723e963d..eef22c78 100644 --- a/lib/realtime/realtimeSaveRevisionJob.ts +++ b/lib/realtime/realtimeSaveRevisionJob.ts @@ -1,7 +1,7 @@ 'use strict' import * as models from "../models"; -import * as logger from "../logger"; +import {logger} from "../logger"; /** * clean when user not in any rooms or user not in connected list diff --git a/lib/realtime/realtimeUpdateDirtyNoteJob.ts b/lib/realtime/realtimeUpdateDirtyNoteJob.ts index bc30a608..e6175ed4 100644 --- a/lib/realtime/realtimeUpdateDirtyNoteJob.ts +++ b/lib/realtime/realtimeUpdateDirtyNoteJob.ts @@ -1,7 +1,7 @@ import moment from "moment"; import * as config from "../config"; -import * as logger from "../logger"; +import {logger} from "../logger"; export class UpdateDirtyNoteJob { private realtime: any; diff --git a/lib/response.ts b/lib/response.ts index e046ffd8..285bf707 100644 --- a/lib/response.ts +++ b/lib/response.ts @@ -3,7 +3,7 @@ import * as request from "request"; // core import * as config from "./config"; -import * as logger from "./logger"; +import {logger} from "./logger"; import * as models from "./models"; import * as utils from "./utils"; import * as history from "./history"; diff --git a/lib/user/index.ts b/lib/user/index.ts index 3bcfe893..ffc14528 100644 --- a/lib/user/index.ts +++ b/lib/user/index.ts @@ -3,7 +3,7 @@ import async from 'async' import * as response from '../response' import * as config from '../config' import * as models from '../models' -import * as logger from '../logger' +import {logger} from '../logger' import { generateAvatar } from '../letter-avatars' export async function getMe (req, res) { diff --git a/lib/web/middleware/checkVersion.ts b/lib/web/middleware/checkVersion.ts index 5f7d70cd..afc722c7 100644 --- a/lib/web/middleware/checkVersion.ts +++ b/lib/web/middleware/checkVersion.ts @@ -2,7 +2,7 @@ import {promisify} from "util"; import request from "request"; -import * as logger from "../../logger"; +import {logger} from "../../logger"; import * as config from "../../config"; let lastCheckAt diff --git a/lib/workers/dmpWorker.ts b/lib/workers/dmpWorker.ts index 0e31426c..8faf97c6 100644 --- a/lib/workers/dmpWorker.ts +++ b/lib/workers/dmpWorker.ts @@ -3,7 +3,7 @@ import DiffMatchPatch from "@hackmd/diff-match-patch"; // core import * as config from "../config"; -import * as logger from "../logger"; +import {logger} from "../logger"; const dmp = new DiffMatchPatch() process.on('message', function (data) {