@modern-js/server 1.4.0 → 1.4.1

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @modern-js/server
 
+## 1.4.1
+
+### Patch Changes
+
+- 2cfc4235: support cssPath/jsPath/mediaPath in production mode
+- 8d55e234: fix: catch api error
+- Updated dependencies [53aca274]
+- Updated dependencies [78279953]
+- Updated dependencies [e116ace5]
+- Updated dependencies [4d72edea]
+  - @modern-js/core@1.4.1
+  - @modern-js/utils@1.3.1
+
 ## 1.4.0
 
 ### Minor Changes

package/dist/js/modern/libs/render/reader.js

@@ -14,7 +14,7 @@ const createCacheItem = async (filepath, mtime) => {
   };
 };
 
-class LruReader {
+export class LruReader {
   // private timer?: NodeJS.Timeout;
   constructor() {
     this.cache = void 0;
@@ -96,7 +96,6 @@ class LruReader {
 
 
 }
-
 const reader = new LruReader();
 export const readFile = async filepath => {
   const file = await reader.read(filepath);

package/dist/js/modern/server/modern-server.js

@@ -21,7 +21,7 @@ import clone from 'lodash.clone';
 import { RouteMatchManager } from "../libs/route";
 import { createRenderHandler } from "../libs/render";
 import { createStaticFileHandler } from "../libs/serve-file";
-import { createErrorDocument, createMiddlewareCollecter, mergeExtension, noop } from "../utils";
+import { createErrorDocument, createMiddlewareCollecter, getStaticReg, mergeExtension, noop } from "../utils";
 import * as reader from "../libs/render/reader";
 import { createProxyHandler } from "../libs/proxy";
 import { createContext } from "../libs/context";
@@ -126,15 +126,10 @@ export class ModernServer {
       this.warmupSSRBundle();
     }
 
-    await this.prepareFrameHandler();
-    const {
-      favicon,
-      faviconByEntries
-    } = this.conf.output || {};
-    const favicons = this.prepareFavicons(favicon, faviconByEntries); // Only work when without setting `assetPrefix`.
+    await this.prepareFrameHandler(); // Only work when without setting `assetPrefix`.
     // Setting `assetPrefix` means these resources should be uploaded to CDN.
 
-    const staticPathRegExp = new RegExp(`^/(static/|upload/|favicon.ico|icon.png${favicons.length > 0 ? `|${favicons.join('|')}` : ''})`);
+    const staticPathRegExp = getStaticReg(this.conf.output || {});
     this.staticFileHandler = createStaticFileHandler([{
       path: staticPathRegExp,
       target: distDir
@@ -374,7 +369,7 @@ export class ModernServer {
     }); // route is api service
 
     if (route.isApi) {
-      this.handleAPI(context);
+      await this.handleAPI(context);
       return;
     }
 
@@ -585,25 +580,5 @@ export class ModernServer {
     res.end(createErrorDocument(status, text));
   }
 
-  prepareFavicons(favicon, faviconByEntries) {
-    const faviconNames = [];
-
-    if (favicon) {
-      faviconNames.push(favicon.substring(favicon.lastIndexOf('/') + 1));
-    }
-
-    if (faviconByEntries) {
-      Object.keys(faviconByEntries).forEach(f => {
-        const curFavicon = faviconByEntries[f];
-
-        if (curFavicon) {
-          faviconNames.push(curFavicon.substring(curFavicon.lastIndexOf('/') + 1));
-        }
-      });
-    }
-
-    return faviconNames;
-  }
-
 }
 /* eslint-enable max-lines */

package/dist/js/modern/utils.js

@@ -77,4 +77,36 @@ export const toPath = (reg, params) => {
     encode: encodeURIComponent
   });
   return fn(params);
+};
+export const getStaticReg = (output = {}) => {
+  const {
+    favicon,
+    faviconByEntries,
+    cssPath,
+    jsPath,
+    mediaPath
+  } = output;
+  const favicons = prepareFavicons(favicon, faviconByEntries);
+  const staticFiles = [cssPath, jsPath, mediaPath].filter(v => Boolean(v));
+  const staticPathRegExp = new RegExp(`^/(static/|upload/|favicon.ico|icon.png${favicons.length > 0 ? `|${favicons.join('|')}` : ''}|${staticFiles.join('|')})`);
+  return staticPathRegExp;
+};
+export const prepareFavicons = (favicon, faviconByEntries) => {
+  const faviconNames = [];
+
+  if (favicon) {
+    faviconNames.push(favicon.substring(favicon.lastIndexOf('/') + 1));
+  }
+
+  if (faviconByEntries) {
+    Object.keys(faviconByEntries).forEach(f => {
+      const curFavicon = faviconByEntries[f];
+
+      if (curFavicon) {
+        faviconNames.push(curFavicon.substring(curFavicon.lastIndexOf('/') + 1));
+      }
+    });
+  }
+
+  return faviconNames;
 };

package/dist/js/node/libs/render/reader.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.updateFile = exports.readFile = exports.init = exports.close = void 0;
+exports.updateFile = exports.readFile = exports.init = exports.close = exports.LruReader = void 0;
 
 var _utils = require("@modern-js/utils");
 
@@ -110,6 +110,7 @@ class LruReader {
 
 }
 
+exports.LruReader = LruReader;
 const reader = new LruReader();
 
 const readFile = async filepath => {

package/dist/js/node/server/modern-server.js

@@ -156,15 +156,10 @@ class ModernServer {
       this.warmupSSRBundle();
     }
 
-    await this.prepareFrameHandler();
-    const {
-      favicon,
-      faviconByEntries
-    } = this.conf.output || {};
-    const favicons = this.prepareFavicons(favicon, faviconByEntries); // Only work when without setting `assetPrefix`.
+    await this.prepareFrameHandler(); // Only work when without setting `assetPrefix`.
     // Setting `assetPrefix` means these resources should be uploaded to CDN.
 
-    const staticPathRegExp = new RegExp(`^/(static/|upload/|favicon.ico|icon.png${favicons.length > 0 ? `|${favicons.join('|')}` : ''})`);
+    const staticPathRegExp = (0, _utils2.getStaticReg)(this.conf.output || {});
     this.staticFileHandler = (0, _serveFile.createStaticFileHandler)([{
       path: staticPathRegExp,
       target: distDir
@@ -409,7 +404,7 @@ class ModernServer {
     }); // route is api service
 
     if (route.isApi) {
-      this.handleAPI(context);
+      await this.handleAPI(context);
       return;
     }
 
@@ -620,26 +615,6 @@ class ModernServer {
     res.end((0, _utils2.createErrorDocument)(status, text));
   }
 
-  prepareFavicons(favicon, faviconByEntries) {
-    const faviconNames = [];
-
-    if (favicon) {
-      faviconNames.push(favicon.substring(favicon.lastIndexOf('/') + 1));
-    }
-
-    if (faviconByEntries) {
-      Object.keys(faviconByEntries).forEach(f => {
-        const curFavicon = faviconByEntries[f];
-
-        if (curFavicon) {
-          faviconNames.push(curFavicon.substring(curFavicon.lastIndexOf('/') + 1));
-        }
-      });
-    }
-
-    return faviconNames;
-  }
-
 }
 /* eslint-enable max-lines */
 

package/dist/js/node/utils.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.toPath = exports.toMessage = exports.noop = exports.mergeExtension = exports.createMiddlewareCollecter = exports.createErrorDocument = void 0;
+exports.toPath = exports.toMessage = exports.prepareFavicons = exports.noop = exports.mergeExtension = exports.getStaticReg = exports.createMiddlewareCollecter = exports.createErrorDocument = void 0;
 
 var _pathToRegexp = require("path-to-regexp");
 
@@ -102,4 +102,42 @@ const toPath = (reg, params) => {
   return fn(params);
 };
 
-exports.toPath = toPath;
+exports.toPath = toPath;
+
+const getStaticReg = (output = {}) => {
+  const {
+    favicon,
+    faviconByEntries,
+    cssPath,
+    jsPath,
+    mediaPath
+  } = output;
+  const favicons = prepareFavicons(favicon, faviconByEntries);
+  const staticFiles = [cssPath, jsPath, mediaPath].filter(v => Boolean(v));
+  const staticPathRegExp = new RegExp(`^/(static/|upload/|favicon.ico|icon.png${favicons.length > 0 ? `|${favicons.join('|')}` : ''}|${staticFiles.join('|')})`);
+  return staticPathRegExp;
+};
+
+exports.getStaticReg = getStaticReg;
+
+const prepareFavicons = (favicon, faviconByEntries) => {
+  const faviconNames = [];
+
+  if (favicon) {
+    faviconNames.push(favicon.substring(favicon.lastIndexOf('/') + 1));
+  }
+
+  if (faviconByEntries) {
+    Object.keys(faviconByEntries).forEach(f => {
+      const curFavicon = faviconByEntries[f];
+
+      if (curFavicon) {
+        faviconNames.push(curFavicon.substring(curFavicon.lastIndexOf('/') + 1));
+      }
+    });
+  }
+
+  return faviconNames;
+};
+
+exports.prepareFavicons = prepareFavicons;

package/dist/types/libs/render/reader.d.ts

@@ -1,4 +1,17 @@
 /// <reference types="node" />
+export declare class LruReader {
+  private readonly cache;
+  constructor();
+  init(): void;
+  close(): void;
+  read(filepath: string): Promise<{
+    content: Buffer;
+    mtime: Date;
+  } | {
+    content: Buffer;
+  } | null>;
+  update(): void;
+}
 export declare const readFile: (filepath: string) => Promise<Buffer | undefined>;
 export declare const updateFile: () => void;
 export declare const init: () => void;

package/dist/types/server/modern-server.d.ts

@@ -68,6 +68,5 @@ export declare class ModernServer {
   private requestHandler;
   private onError;
   private renderErrorPage;
-  private prepareFavicons;
 }
 export {};

package/dist/types/utils.d.ts

@@ -1,3 +1,4 @@
+import type { NormalizedConfig } from '@modern-js/core';
 export declare const mergeExtension: (users: any[]) => {
   middleware: any[];
 };
@@ -13,4 +14,6 @@ export declare const createMiddlewareCollecter: () => {
   addWebMiddleware: (input: any) => void;
   addAPIMiddleware: (input: any) => void;
 };
-export declare const toPath: (reg: string, params: Record<string, any>) => string;
+export declare const toPath: (reg: string, params: Record<string, any>) => string;
+export declare const getStaticReg: (output?: NormalizedConfig['output']) => RegExp;
+export declare const prepareFavicons: (favicon: string | undefined, faviconByEntries?: Record<string, string | undefined> | undefined) => string[];

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.4.0",
+  "version": "1.4.1",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/js/node/index.js",
@@ -34,12 +34,12 @@
     "@babel/preset-typescript": "^7.15.0",
     "@babel/register": "^7.15.3",
     "@babel/runtime": "^7",
-    "@modern-js/core": "^1.4.0",
+    "@modern-js/core": "^1.4.1",
     "@modern-js/hmr-client": "^1.2.1",
     "@modern-js/server-core": "^1.2.2",
     "@modern-js/server-utils": "^1.2.1",
     "@modern-js/bff-utils": "^1.2.2",
-    "@modern-js/utils": "^1.3.0",
+    "@modern-js/utils": "^1.3.1",
     "axios": "^0.24.0",
     "babel-plugin-module-resolver": "^4.1.0",
     "chokidar": "^3.5.2",
@@ -65,7 +65,7 @@
   },
   "devDependencies": {
     "@scripts/build": "0.0.0",
-    "@modern-js/types": "^1.3.0",
+    "@modern-js/types": "^1.3.1",
     "@types/jest": "^26",
     "@types/lru-cache": "^5.1.1",
     "@types/mime-types": "^2.1.0",
@@ -100,8 +100,7 @@
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
-    "access": "public",
-    "types": "./dist/types/index.d.ts"
+    "access": "public"
   },
   "scripts": {
     "new": "modern new",

package/tests/fixtures/reader/index.ts

@@ -0,0 +1,3 @@
+export default {
+  name: 'modern',
+};

package/tests/fixtures/static-dir/bar.html

@@ -0,0 +1,11 @@
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>bar</title>
+</head>
+<body>
+
+</body>
+</html>

package/tests/fixtures/static-dir/baz/index.html

@@ -0,0 +1,11 @@
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>baz</title>
+</head>
+<body>
+
+</body>
+</html>

package/tests/fixtures/static-dir/foo/index.html

@@ -0,0 +1,11 @@
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>foo</title>
+</head>
+<body>
+
+</body>
+</html>

package/tests/render.test.ts

@@ -0,0 +1,102 @@
+import path from 'path';
+import { render } from '../src/libs/render/ssr';
+import { handleDirectory } from '../src/libs/render/static';
+import { LruReader } from '../src/libs/render/reader';
+
+describe('test render function', () => {
+  test('should return content correctly ', async () => {
+    const renderResult = await render(
+      {
+        params: {},
+        pathname: '/foo',
+        host: 'localhost:8080',
+        query: {},
+        url: 'localhost:8080/foo',
+        cookieMap: {},
+        headers: {},
+      } as any,
+      {
+        urlPath: '/foo',
+        bundle: 'bundle.js',
+        distDir: path.join(__dirname, 'fixtures', 'ssr'),
+        template: 'tpl.html',
+        entryName: 'foo',
+        staticGenerate: false,
+      } as any,
+      {
+        extendSSRContext: () => {
+          // empty
+        },
+      } as any,
+    );
+
+    expect(renderResult.content).toMatch('Modern.js');
+    expect(renderResult.contentType).toMatch('text/html; charset=utf-8');
+  });
+
+  test('should handle directory for .html correctly', async () => {
+    const entryPath = path.join(__dirname, 'fixtures', 'static-dir');
+
+    const res1 = await handleDirectory(
+      {
+        path: '/modern/bar',
+      } as any,
+      entryPath,
+      '/modern',
+    );
+
+    expect(res1?.content.toString()).toMatch('bar');
+  });
+
+  test('should handle directory for index.html correctly', async () => {
+    const entryPath = path.join(__dirname, 'fixtures', 'static-dir');
+
+    const res1 = await handleDirectory(
+      {
+        path: '/modern/foo',
+      } as any,
+      entryPath,
+      '/modern',
+    );
+
+    expect(res1?.content.toString()).toMatch('foo');
+  });
+
+  test('should handle directory for /index.html correctly', async () => {
+    const entryPath = path.join(__dirname, 'fixtures', 'static-dir');
+
+    const res1 = await handleDirectory(
+      {
+        path: '/modern/baz/',
+      } as any,
+      entryPath,
+      '/modern',
+    );
+
+    expect(res1?.content.toString()).toMatch('baz');
+  });
+
+  test('should reader work correctly', async () => {
+    const reader = new LruReader();
+    const dir = path.join(__dirname, 'fixtures', 'reader');
+
+    const nullRes = await reader.read(path.join(dir, 'foo.ts'));
+    expect(nullRes).toBeNull();
+
+    const dirRes = await reader.read(path.join(dir, 'test-dir'));
+    expect(dirRes).toBeNull();
+
+    const res = await reader.read(path.join(dir, 'index.ts'));
+    expect(res).not.toBeNull();
+    expect(res?.content.toString()).toMatch('modern');
+
+    const res1 = await reader.read(path.join(dir, 'index.ts'));
+    expect(res1).not.toBeNull();
+    expect(res1?.content.toString()).toMatch('modern');
+
+    reader.update();
+    const res2 = await reader.read(path.join(dir, 'index.ts'));
+    expect(res2).not.toBeNull();
+    expect(res2?.content.toString()).toMatch('modern');
+  });
+});

package/tests/utils.test.ts

@@ -5,6 +5,7 @@ import {
   toMessage,
   createErrorDocument,
   createMiddlewareCollecter,
+  getStaticReg,
 } from '../src/utils';
 
 describe('test server utils', () => {
@@ -74,4 +75,32 @@ describe('test server utils', () => {
     const fn = compile('/home/:id', { encode: encodeURIComponent });
     expect(fn({ id: 2 })).toBe('/home/2');
   });
+
+  describe('test create static reg', () => {
+    test('should test static path correctly', () => {
+      const reg = getStaticReg();
+      expect(reg.test('/static')).toBeTruthy();
+      expect(reg.test('/upload')).toBeTruthy();
+    });
+
+    test('should test custom static path correctly', () => {
+      const reg = getStaticReg({
+        cssPath: 'static-css',
+      });
+      expect(reg.test('/static-css')).toBeTruthy();
+    });
+
+    test('should test favicon path correctly', () => {
+      const reg = getStaticReg({
+        favicon: 'index.icon',
+        faviconByEntries: {
+          foo: 'foo.icon',
+          baz: 'baz.icon',
+        },
+      });
+      expect(reg.test('/index.icon')).toBeTruthy();
+      expect(reg.test('/foo.icon')).toBeTruthy();
+      expect(reg.test('/baz.icon')).toBeTruthy();
+    });
+  });
 });

package/tests/ssr.test.ts

@@ -1,34 +0,0 @@
-import path from 'path';
-import { render } from '../src/libs/render/ssr';
-
-describe('test ssr render function', () => {
-  test('should return content correctly ', async () => {
-    const renderResult = await render(
-      {
-        params: {},
-        pathname: '/foo',
-        host: 'localhost:8080',
-        query: {},
-        url: 'localhost:8080/foo',
-        cookieMap: {},
-        headers: {},
-      } as any,
-      {
-        urlPath: '/foo',
-        bundle: 'bundle.js',
-        distDir: path.join(__dirname, 'fixtures', 'ssr'),
-        template: 'tpl.html',
-        entryName: 'foo',
-        staticGenerate: false,
-      } as any,
-      {
-        extendSSRContext: () => {
-          // empty
-        },
-      } as any,
-    );
-
-    expect(renderResult.content).toMatch('Modern.js');
-    expect(renderResult.contentType).toMatch('text/html; charset=utf-8');
-  });
-});