fix: create log dir in serverless environment (#935)

midwayjs · Mar 22, 2021 · 8a15f69 · 8a15f69
1 parent ae9ed26
commit 8a15f69
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 3 deletions.
diff --git a/packages-serverless/express-layer/index.js b/packages-serverless/express-layer/index.js
@@ -4,6 +4,9 @@ const fs = require('fs');
 const request = require('request');
 
 const socketPath = join(os.tmpdir(), `server-${Date.now()}.sock`);
+const logDir = join(os.tmpdir(), `app-${Date.now()}`);
+
+process.env.MIDWAY_LOGGER_WRITEABLE_DIR = logDir;
 
 module.exports = engine => {
   engine.addRuntimeExtension({

diff --git a/packages-serverless/koa-layer/index.js b/packages-serverless/koa-layer/index.js
@@ -4,6 +4,9 @@ const fs = require('fs');
 const request = require('request');
 
 const socketPath = join(os.tmpdir(), `server-${Date.now()}.sock`);
+const logDir = join(os.tmpdir(), `app-${Date.now()}`);
+
+process.env.MIDWAY_LOGGER_WRITEABLE_DIR = logDir;
 
 module.exports = engine => {
   engine.addRuntimeExtension({

diff --git a/packages/core/src/interface.ts b/packages/core/src/interface.ts
@@ -386,3 +386,5 @@ export interface IMidwayFramework<APP extends IMidwayApplication, T extends ICon
   getProjectName(): string;
   getDefaultContextLoggerClass(): any;
 }
+
+export const MIDWAY_LOGGER_WRITEABLE_DIR = 'MIDWAY_LOGGER_WRITEABLE_DIR';
diff --git a/packages/core/src/logger.ts b/packages/core/src/logger.ts
@@ -1,5 +1,5 @@
 import { createLogger, LoggerOptions } from '@midwayjs/logger';
-import { IMidwayFramework } from './interface';
+import { IMidwayFramework, MIDWAY_LOGGER_WRITEABLE_DIR } from './interface';
 import { isDevelopmentEnvironment, getUserHome } from './util';
 import { join } from 'path';
 
@@ -17,5 +17,12 @@ export const createMidwayLogger = (
       : join(getUserHome(), 'logs', framework.getProjectName()),
     level: isDevelopmentEnv ? 'info' : 'warn',
   };
+  if (process.env[MIDWAY_LOGGER_WRITEABLE_DIR]) {
+    loggerOptions.dir = join(
+      process.env[MIDWAY_LOGGER_WRITEABLE_DIR],
+      'logs',
+      framework.getProjectName()
+    );
+  }
   return createLogger(name, Object.assign({}, loggerOptions, options));
 };
diff --git a/packages/core/test/baseFramework.test.ts b/packages/core/test/baseFramework.test.ts
@@ -15,10 +15,10 @@ import {
   IMidwayApplication,
   IMidwayBootstrapOptions,
   MidwayRequestContainer,
+  LightFramework,
 } from '../src';
 import * as mm from 'mm';
 import { LifeCycleTest, LifeCycleTest1, TestBinding } from './fixtures/lifecycle';
-import { LightFramework } from '../src/util/emptyFramework';
 import sinon = require('sinon');
 
 @Provide()

diff --git a/packages/core/test/logger.test.ts b/packages/core/test/logger.test.ts
@@ -1,6 +1,9 @@
-import { createMidwayLogger, EmptyFramework } from '../src';
+import { createMidwayLogger, EmptyFramework, LightFramework } from '../src';
 import { MidwayContextLogger } from '@midwayjs/logger';
 import { join } from 'path';
+import * as mm from 'mm';
+import { tmpdir } from 'os';
+import { existsSync } from 'fs';
 
 describe('/test/logger.test.ts', () => {
   it('should create context logger', async () => {
@@ -25,4 +28,23 @@ describe('/test/logger.test.ts', () => {
     contextLogger.log('hello world');
     contextLogger.log('info', 'hello world');
   });
+
+  it('should create log in serverless environment', async () => {
+    const tmpLogsDir = join(tmpdir(), Date.now() + '-' + (Math.random() * 100000).toString().slice(-5));
+    mm(process.env, 'MIDWAY_LOGGER_WRITEABLE_DIR', tmpLogsDir);
+    const framework = new LightFramework();
+    await framework.initialize({
+      baseDir: join(
+        __dirname,
+        './fixtures/base-app/src'
+      ),
+    });
+    const logger = framework.getCoreLogger();
+    logger.info('hello world');
+    logger.debug('hello world');
+    logger.warn('hello world');
+    logger.error('hello world');
+    expect(existsSync(join(tmpLogsDir, 'logs'))).toBeTruthy();
+    mm.restore();
+  });
 });