Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: should get server routes from route.json in serve command #6627

Merged
merged 4 commits into from
Dec 11, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/server/core/src/adapters/node/plugins/resource.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import type {
ServerManifest,
ServerPlugin,
} from '../../../types';
import { uniqueKeyByRoute } from '../../../utils';

export async function getHtmlTemplates(pwd: string, routes: ServerRoute[]) {
const htmls = await Promise.all(
Expand All @@ -27,7 +28,7 @@ export async function getHtmlTemplates(pwd: string, routes: ServerRoute[]) {
} catch (e) {
// ignore error
}
return [route.entryName!, html];
return [uniqueKeyByRoute(route), html];
}) || [],
);

Expand Down
4 changes: 2 additions & 2 deletions packages/server/core/src/plugins/render/render.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import type {
} from '../../types';
import type { Render } from '../../types';
import type { Params } from '../../types/requestHandler';
import { uniqueKeyByRoute } from '../../utils';
import {
ErrorDigest,
createErrorHtml,
Expand Down Expand Up @@ -139,8 +140,7 @@ export async function createRender({
});
}

const html = templates[routeInfo.entryName!];

const html = templates[uniqueKeyByRoute(routeInfo)];
if (!html) {
return new Response(createErrorHtml(404), {
status: 404,
Expand Down
5 changes: 5 additions & 0 deletions packages/server/core/src/utils/entry.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,8 @@ import type { ServerRoute } from '@modern-js/types';
export const sortRoutes = (route1: ServerRoute, route2: ServerRoute) => {
return route2.urlPath.length - route1.urlPath.length;
};

// Because the same entryName may have different urlPath(ssg), so we need to add urlPath as key
export const uniqueKeyByRoute = (route: ServerRoute) => {
return `${route.entryName!}-${route.urlPath}`;
};
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import fs from 'fs';
import path from 'path';
import type { IAppContext } from '@modern-js/core';
import type { Entrypoint, ServerRoute } from '@modern-js/types';
import {
fs,
ROUTE_SPEC_FILE,
SERVER_BUNDLE_DIRECTORY,
SERVER_WORKER_BUNDLE_DIRECTORY,
getEntryOptions,
Expand Down Expand Up @@ -252,3 +252,15 @@ export const getServerRoutes = (

const toPosix = (pathStr: string) =>
pathStr.split(path.sep).join(path.posix.sep);

export const getProdServerRoutes = (distDirectory: string) => {
const routeJSON = path.join(distDirectory, ROUTE_SPEC_FILE);
try {
const { routes } = fs.readJSONSync(routeJSON);
return routes;
} catch (e) {
throw new Error(
`Failed to read routes from ${routeJSON}, please check if the file exists.`,
);
}
};
38 changes: 29 additions & 9 deletions packages/solutions/app-tools/src/plugins/analyze/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import * as path from 'path';
import type { ServerRoute } from '@modern-js/types';
import {
fs,
createDebugger,
Expand All @@ -18,7 +19,7 @@ import { emitResolvedConfig } from '../../utils/config';
import { getSelectedEntries } from '../../utils/getSelectedEntries';
import { printInstructions } from '../../utils/printInstructions';
import { generateRoutes } from '../../utils/routes';
import { checkIsBuildCommands } from './utils';
import { checkIsBuildCommands, checkIsServeCommand } from './utils';

const debug = createDebugger('plugin-analyze');

Expand Down Expand Up @@ -54,8 +55,21 @@ export default ({
);
await hooks.addRuntimeExports.call();

const [{ getProdServerRoutes }] = await Promise.all([
import('./getServerRoutes.js'),
]);

if (apiOnly) {
const { routes } = await hooks.modifyServerRoutes.call({ routes: [] });
const routes: ServerRoute[] = [];
if (checkIsServeCommand()) {
routes.push(...getProdServerRoutes(appContext.distDirectory));
} else {
const { routes: modifiedRoutes } =
await hooks.modifyServerRoutes.call({
routes: [],
});
routes.push(...modifiedRoutes);
}

debug(`server routes: %o`, routes);

Expand All @@ -80,14 +94,20 @@ export default ({

debug(`entrypoints: %o`, entrypoints);

const initialRoutes = getServerRoutes(entrypoints, {
appContext,
config: resolvedConfig,
});
const routes: ServerRoute[] = [];
if (checkIsServeCommand()) {
routes.push(...getProdServerRoutes(appContext.distDirectory));
} else {
const initialRoutes = getServerRoutes(entrypoints, {
appContext,
config: resolvedConfig,
});

const { routes } = await hooks.modifyServerRoutes.call({
routes: initialRoutes,
});
const { routes: modifiedRoutes } = await hooks.modifyServerRoutes.call({
routes: initialRoutes,
});
routes.push(...modifiedRoutes);
}

debug(`server routes: %o`, routes);

Expand Down
6 changes: 6 additions & 0 deletions packages/solutions/app-tools/src/plugins/analyze/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,12 @@ export const checkIsBuildCommands = () => {
return buildCommands.includes(command);
};

export const checkIsServeCommand = () => {
const command = getCommand();

return command === 'serve';
};

export const isSubDirOrEqual = (parent: string, child: string): boolean => {
if (parent === child) {
return true;
Expand Down
3 changes: 2 additions & 1 deletion tests/integration/ssg/fixtures/nested-routes/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
"name": "ssg-fixtures-nested-routes",
"version": "2.9.0",
"scripts": {
"build": "modern build"
"build": "modern build",
"serve": "modern serve"
},
"dependencies": {
"@modern-js/app-tools": "workspace:*",
Expand Down
48 changes: 44 additions & 4 deletions tests/integration/ssg/tests/nested-routes.test.ts
Original file line number Diff line number Diff line change
@@ -1,17 +1,22 @@
import path, { join } from 'path';
import { fs } from '@modern-js/utils';
import { killApp, modernBuild } from '../../../utils/modernTestUtils';
import puppeteer from 'puppeteer';
import {
getPort,
killApp,
launchOptions,
modernBuild,
modernServe,
} from '../../../utils/modernTestUtils';

const fixtureDir = path.resolve(__dirname, '../fixtures');

const appDir = join(fixtureDir, 'nested-routes');
jest.setTimeout(1000 * 60 * 3);

describe('ssg', () => {
let app: any;
let appDir: string;
let distDir: string;
beforeAll(async () => {
appDir = join(fixtureDir, 'nested-routes');
distDir = join(appDir, './dist');
await modernBuild(appDir);
});
Expand All @@ -31,3 +36,38 @@ describe('ssg', () => {
expect(html.includes('Hello, User')).toBe(true);
});
});

describe('test ssg request', () => {
let buildRes: { code: number };
let app: any;
let port: any;
beforeAll(async () => {
port = await getPort();

buildRes = await modernBuild(appDir);
app = await modernServe(appDir, port, {
cwd: appDir,
});
});

afterAll(async () => {
await killApp(app);
});

test('should support enableInlineScripts', async () => {
const host = `http://localhost`;
expect(buildRes.code === 0).toBe(true);
const browser = await puppeteer.launch(launchOptions as any);
const page = await browser.newPage();
await page.goto(`${host}:${port}/user`);

const description = await page.$('#data');
const targetText = await page.evaluate(el => el?.textContent, description);
try {
expect(targetText?.trim()).toEqual('Hello, User');
} finally {
await page.close();
await browser.close();
}
});
});
Loading