Skip to content

feat: router rewrite #7218

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all 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
1 change: 1 addition & 0 deletions packages/server/core/src/plugins/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,4 @@ export {
} from './default';
export { compatPlugin, handleSetupResult } from './compat';
export { injectConfigMiddlewarePlugin } from './middlewares';
export { routerRewritePlugin } from './rewrite';
40 changes: 40 additions & 0 deletions packages/server/core/src/plugins/rewrite.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
import type { ServerPluginLegacy } from '../types';

declare module 'Hono' {
interface Context {
rewriteByEntry: (entry: string) => void;
rewrite: (entry: string) => void;
}
}

export const routerRewritePlugin = (): ServerPluginLegacy => ({
name: '@Modern-js/plugin-router-rewrite-plugin',
setup(api) {
return {
prepare() {
const { middlewares, routes } = api.useAppContext();
if (!routes) {
return;
}

middlewares.push({
name: 'router-rewrite',
order: 'pre',
handler: async (c, next) => {
c.rewriteByEntry = (entry: string) => {
const rewriteRoute = routes
.filter(route => !route.isApi)
.find(route => route.entryName === entry);

if (rewriteRoute) {
c.set('matchPathname', rewriteRoute.urlPath);
c.set('matchEntryName', entry);
}
};
await next();
},
});
},
};
},
});
2 changes: 2 additions & 0 deletions packages/server/prod-server/src/apply.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {
injectConfigMiddlewarePlugin,
onError,
renderPlugin,
routerRewritePlugin,
} from '@modern-js/server-core';
import {
injectNodeSeverPlugin,
Expand Down Expand Up @@ -59,6 +60,7 @@ export async function applyPlugins(
const { middlewares, renderMiddlewares } = options.serverConfig || {};

const plugins = [
routerRewritePlugin(),
...(nodeServer ? [injectNodeSeverPlugin({ nodeServer })] : []),
...createDefaultPlugins({
cacheConfig,
Expand Down
33 changes: 31 additions & 2 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions tests/integration/routes/modern.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ export default defineConfig({
loaderFailureMode: 'clientRender',
},
four: false,
rewrite: false,
},
},
});
5 changes: 4 additions & 1 deletion tests/integration/routes/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@
"@types/node": "^14",
"@types/react": "^18.3.11",
"@types/react-dom": "^18.3.1",
"typescript": "^5"
"typescript": "~5.0.4",
"@modern-js/server-runtime": "workspace:*",
"ts-node": "^10.9.1",
"tsconfig-paths": "~3.14.1"
}
}
18 changes: 18 additions & 0 deletions tests/integration/routes/server/.eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
module.exports = {
root: true,
plugins: ['prettier'],
rules: {
// eslint-disable-next-line
'prettier/prettier': 'error',
},
overrides: [
{
files: ['*.js', '*.jsx'],
extends: '@byted/eslint-config-standard',
},
{
files: ['*.ts', '*.tsx'],
extends: '@byted/eslint-config-standard-ts',
},
],
};
21 changes: 21 additions & 0 deletions tests/integration/routes/server/modern.server.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import {
type MiddlewareHandler,
defineServerConfig,
} from '@modern-js/server-runtime';

const renderTiming: MiddlewareHandler = async (c, next) => {
if (c.req.path === '/rewrite') {
c.rewriteByEntry('one');
}

await next();
};

export default defineServerConfig({
renderMiddlewares: [
{
name: 'render-timing',
handler: renderTiming,
},
],
});
Empty file.
5 changes: 5 additions & 0 deletions tests/integration/routes/src/rewrite/App.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import './App.css';

const App = () => <p className="description">rewrite page</p>;

export default App;
2 changes: 1 addition & 1 deletion tests/integration/routes/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@
"@shared/*": ["./shared/*"]
}
},
"include": ["src", "shared", "config"]
"include": ["src", "shared", "config", "server"]
}
Loading