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: lazy import preload, then update include.type to include.as #4589

Merged
merged 1 commit into from
Sep 6, 2023
Merged
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
7 changes: 7 additions & 0 deletions .changeset/blue-pears-allow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
'@modern-js/prod-server': patch
'@modern-js/server-core': patch
---

fix: lazy import preload, then update include.type to include.as
fix: 动态加载 preload 功能, 对齐规范将 include.type 属性更新为 include.as
5 changes: 2 additions & 3 deletions packages/server/core/src/types/config/server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,8 @@ type Route =
};
export type Routes = Record<string, Route>;

type PreloadInclude = Array<
string | { url: string; type?: string; rel?: string }
>;
type PreloadLink = { url: string; as?: string; rel?: string };
type PreloadInclude = Array<string | PreloadLink>;
interface PreloadAttributes {
script?: Record<string, boolean | string>;
style?: Record<string, boolean | string>;
Expand Down
35 changes: 0 additions & 35 deletions packages/server/prod-server/src/libs/preload/flushServerHeader.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,41 +4,6 @@ import { ModernServerContext } from '@modern-js/types';
import { parseLinks } from './parseLinks';
import { transformLinks2String } from './transformLinks2String';

export function transformToRegExp(input: string | RegExp): RegExp {
if (typeof input === 'string') {
return new RegExp(input);
}
return input;
}

export function shouldFlushServerHeader(
serverConf: ServerOptions['server'],
userAgent?: string,
disablePreload?: boolean,
) {
const { ssr: ssrConf } = serverConf || {};

if (disablePreload) {
return false;
}

if (typeof ssrConf === 'object' && ssrConf.preload) {
// ssr.preload: 'object'
if (typeof ssrConf.preload === 'object') {
const { userAgentFilter } = ssrConf.preload;
if (userAgentFilter && userAgent) {
return !transformToRegExp(userAgentFilter).test(userAgent);
}
return true;
}
// ssr.preload: true;
return true;
}

// ssr: false or ssr: true
return false;
}

export interface FlushServerHeaderOptions {
ctx: ModernServerContext;
distDir: string;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
import type { ServerOptions } from '@modern-js/server-core';

export function transformToRegExp(input: string | RegExp): RegExp {
if (typeof input === 'string') {
return new RegExp(input);
}
return input;
}

export function shouldFlushServerHeader(
serverConf: ServerOptions['server'],
userAgent?: string,
disablePreload?: boolean,
) {
const { ssr: ssrConf } = serverConf || {};

if (disablePreload) {
return false;
}

if (typeof ssrConf === 'object' && ssrConf.preload) {
// ssr.preload: 'object'
if (typeof ssrConf.preload === 'object') {
const { userAgentFilter } = ssrConf.preload;
if (userAgentFilter && userAgent) {
return !transformToRegExp(userAgentFilter).test(userAgent);
}
return true;
}
// ssr.preload: true;
return true;
}

// ssr: false or ssr: true
return false;
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { SSRPreload } from '@modern-js/server-core';
import { Link } from './parseLinks';
import { transformToRegExp } from './flushServerHeader';
import { transformToRegExp } from './shouldFlushServerHeader';

export function transformLinks2String(
links: Link[],
Expand Down Expand Up @@ -62,7 +62,7 @@ function addInclude(links: Link[], include?: SSRPreload['include']) {
})();
return { uri: item, as: type };
}
return { uri: item.url, as: item.type, rel: item.rel };
return { uri: item.url, as: item.as, rel: item.rel };
}) || [];

return links.concat(includes);
Expand Down
4 changes: 3 additions & 1 deletion packages/server/prod-server/src/libs/render/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { ServerOptions } from '@modern-js/server-core';
import { RenderResult, ServerHookRunner } from '../../type';
import { ModernRoute } from '../route';
import { ERROR_DIGEST } from '../../constants';
import { flushServerHeader, shouldFlushServerHeader } from '../preload';
import { shouldFlushServerHeader } from '../preload/shouldFlushServerHeader';
import { handleDirectory } from './static';
import { readFile } from './reader';
import * as ssr from './ssr';
Expand Down Expand Up @@ -84,7 +84,9 @@ export const createRenderHandler: CreateRenderHandler = ({
const disablePreload = Boolean(
ctx.headers[`x-${cutNameByHyphen(metaName)}-disable-preload`],
);

if (shouldFlushServerHeader(conf.server, userAgent, disablePreload)) {
const { flushServerHeader } = await import('../preload');
flushServerHeader({
serverConf: conf.server,
ctx,
Expand Down
8 changes: 4 additions & 4 deletions packages/server/prod-server/tests/preload.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ import type { ServerOptions } from '@modern-js/server-core';
import { fs } from '@modern-js/utils';
import {
flushServerHeader,
shouldFlushServerHeader,
parseLinks,
FlushServerHeaderOptions,
parseLinks,
} from '../src/libs/preload';
import { shouldFlushServerHeader } from '../src/libs/preload/shouldFlushServerHeader';

describe('test preload', () => {
const distDir = path.join(__dirname, 'fixtures', 'preload');
Expand Down Expand Up @@ -121,8 +121,8 @@ describe('test preload', () => {
ssr: {
preload: {
include: [
{ url: 'http://example.com', type: 'script' },
{ url: 'http://example.com', type: 'script' },
{ url: 'http://example.com', as: 'script' },
{ url: 'http://example.com', as: 'script' },
{
url: 'http://example3.com',
rel: 'dns-prefetch',
Expand Down
9 changes: 8 additions & 1 deletion tests/integration/ssr/fixtures/preload/modern.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,14 @@ import { appTools, defineConfig } from '@modern-js/app-tools';
export default defineConfig({
server: {
ssr: {
preload: true,
preload: {
include: [
{
url: 'https://lf3-static.bytednsdoc.com/obj/eden-cn/nuvshpqnulg/eden-x-logo.png',
as: 'image',
},
],
},
},
},
runtime: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ exports[`SSR preload should add Links to response headers 1`] = `
"</static/js/lib-react.js>; rel=preload; as=script",
"</static/js/lib-router.js>; rel=preload; as=script",
"</static/js/main.js>; rel=preload; as=script",
"<https://lf3-static.bytednsdoc.com/obj/eden-cn/nuvshpqnulg/eden-x-logo.png>; rel=preload; as=image",
]
`;