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.

Sign up for GitHub

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

Jump to bottom

feat: improve error message for duplicated loaders #4619

Merged
merged 1 commit into from
Jun 26, 2023
Merged

feat: improve error message for duplicated loaders #4619

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
37 changes: 35 additions & 2 deletions packages/qwik-city/buildtime/vite/dev-server.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@ import type { ViteDevServer, Connect } from 'vite';
import type { ServerResponse } from 'node:http';
import type { BuildContext, BuildRoute } from '../types';
import type {
ActionInternal,
ContentMenu,
LoadedRoute,
LoaderInternal,
MenuData,
MenuModule,
MenuModuleLoader,
Expand All @@ -24,7 +26,10 @@ import { updateBuildContext } from '../build';
import { getExtension, normalizePath } from '../../utils/fs';
import { getMenuLoader, getPathParams } from '../../runtime/src/routing';
import { fromNodeHttp, getUrl } from '../../middleware/node/http';
import { resolveRequestHandlers } from '../../middleware/request-handler/resolve-request-handlers';
import {
checkBrand,
resolveRequestHandlers,
} from '../../middleware/request-handler/resolve-request-handlers';
import { formatError } from './format-error';

export function ssrDevMiddleware(ctx: BuildContext, server: ViteDevServer) {
Expand Down Expand Up @@ -81,12 +86,13 @@ export function ssrDevMiddleware(ctx: BuildContext, server: ViteDevServer) {
const qwikSerializer = { _deserializeData, _serializeData, _verifySerializable };

// use vite to dynamically load each layout/page module in this route's hierarchy

const loaderMap = new Map<string, string>();
const serverPlugins: RouteModule[] = [];
for (const file of ctx.serverPlugins) {
const layoutModule = await server.ssrLoadModule(file.filePath);
serverPlugins.push(layoutModule);
routeModulePaths.set(layoutModule, file.filePath);
checkModule(loaderMap, layoutModule, file.filePath);
}

const matchPathname = getRouteMatchPathname(url.pathname, ctx.opts.trailingSlash);
Expand All @@ -103,10 +109,12 @@ export function ssrDevMiddleware(ctx: BuildContext, server: ViteDevServer) {
const layoutModule = await server.ssrLoadModule(layout.filePath);
routeModules.push(layoutModule);
routeModulePaths.set(layoutModule, layout.filePath);
checkModule(loaderMap, layoutModule, layout.filePath);
}
const endpointModule = await server.ssrLoadModule(route.filePath);
routeModules.push(endpointModule);
routeModulePaths.set(endpointModule, route.filePath);
checkModule(loaderMap, endpointModule, route.filePath);
}

const renderFn = async (requestEv: RequestEvent) => {
Expand Down Expand Up @@ -261,6 +269,31 @@ export function ssrDevMiddleware(ctx: BuildContext, server: ViteDevServer) {
};
}

const checkModule = (loaderMap: Map<string, string>, routeModule: any, filePath: string) => {
for (const loader of Object.values(routeModule)) {
if (checkBrand(loader, 'server_action') || checkBrand(loader, 'server_loader')) {
checkUniqueLoader(loaderMap, loader as any, filePath);
}
}
};

const checkUniqueLoader = (
loaderMap: Map<string, string>,
loader: LoaderInternal | ActionInternal,
filePath: string
) => {
const prev = loaderMap.get(loader.__id);
if (prev) {
const type = loader.__brand === 'server_loader' ? 'routeLoader$' : 'routeAction$';
throw new Error(
`The same ${type} (${loader.__qrl.getSymbol()}) was exported in multiple modules:
- ${prev}
- ${filePath}`
);
}
loaderMap.set(loader.__id, filePath);
};

export function getUnmatchedRouteHtml(url: URL, ctx: BuildContext): string {
const blue = '#006ce9';
const routesAndDistance = sortRoutesByDistance(ctx.routes, url);
Expand Down
13 changes: 3 additions & 10 deletions packages/qwik-city/middleware/request-handler/resolve-request-handlers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ export const resolveRequestHandlers = (
method
);
if (isPageRoute) {
if (routeLoaders.length + actionsMiddleware.length > 0) {
if (routeLoaders.length + routeActions.length > 0) {
requestHandlers.push(actionsMiddleware(routeLoaders, routeActions) as any);
}
requestHandlers.push(renderHandler);
Expand Down Expand Up @@ -138,12 +138,12 @@ const _resolveRequestHandlers = (
if (collectActions) {
const loaders = Object.values(routeModule).filter((e) =>
checkBrand(e, 'server_loader')
) as any[];
) as LoaderInternal[];
routeLoaders.push(...loaders);

const actions = Object.values(routeModule).filter((e) =>
checkBrand(e, 'server_action')
) as any[];
) as ActionInternal[];
routeActions.push(...actions);
}
}
Expand Down Expand Up @@ -207,13 +207,6 @@ export function actionsMiddleware(routeLoaders: LoaderInternal[], routeActions:
await Promise.all(
routeLoaders.map((loader) => {
const loaderId = loader.__id;
if (isDev) {
if (loaders[loaderId]) {
throw new Error(
`Duplicate loader id "${loaderId}" detected. Please ensure that all loader ids are unique.`
);
}
}
return (loaders[loaderId] = runValidators(
requestEv,
loader.__validators,
Expand Down