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

Adding an option to disable HTTP streaming #3777

Merged
merged 18 commits into from
Jul 1, 2022
Merged

Adding an option to disable HTTP streaming #3777

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
9207549
Adding a flag to disable HTTP streaming
Jun 30, 2022
18b3a8b
refactor: adding support for SSG builds
Jun 30, 2022
884fab8
handling string responses in the server runtime, adding tests
Jun 30, 2022
c043ff1
removing streaming CLI flag
Jun 30, 2022
76ce1dd
removing import.meta.env.STREAMING
Jun 30, 2022
93ff1b7
Merge branch 'main' into fix/cloudflare-polyfill
Jun 30, 2022
1869202
include Content-Length header when streaming is disabled
Jun 30, 2022
6dde2f9
Verifying content-length header in dev
Jun 30, 2022
5af3d7d
fix: default streaming to enabled in the base App server
Jun 30, 2022
939d048
TEMP: disabling the production test to investigate the test-adapter
Jun 30, 2022
bae78c4
re-enabling the test with an adapter option to disable streaming for …
Jun 30, 2022
188c86b
fix: use the existing TextEncoder to get the body's byte length
Jun 30, 2022
693adf2
moving config to build.streaming, ignoring it in `dev`
Jun 30, 2022
dc10d4d
fixing dev test to expect response streaming
Jun 30, 2022
bb85482
chore: add changsets
Jun 30, 2022
05e3e4a
removing the new config option all together :tada:
Jun 30, 2022
c9f5d50
remove temp debug log
Jun 30, 2022
14952ca
Updating astro changeset now that streaming isn't a config option
Jun 30, 2022
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
Next Next commit
Adding a flag to disable HTTP streaming
  • Loading branch information
Tony Sullivan committed Jun 30, 2022
commit 92075491918b80d8450d00858ae0d7d3315e7140
1 change: 1 addition & 0 deletions packages/astro/src/@types/astro.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ export interface CLIFlags {
experimentalSsr?: boolean;
experimentalIntegrations?: boolean;
drafts?: boolean;
streaming?: boolean;
tony-sull marked this conversation as resolved.
Show resolved Hide resolved
}

export interface BuildConfig {
Expand Down
8 changes: 8 additions & 0 deletions packages/astro/src/core/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ const ASTRO_CONFIG_DEFAULTS: AstroUserConfig & any = {
server: {
host: false,
port: 3000,
streaming: true,
tony-sull marked this conversation as resolved.
Show resolved Hide resolved
},
style: { postcss: { options: {}, plugins: [] } },
integrations: [],
Expand Down Expand Up @@ -154,6 +155,7 @@ export const AstroConfigSchema = z.object({
.optional()
.default(ASTRO_CONFIG_DEFAULTS.server.host),
port: z.number().optional().default(ASTRO_CONFIG_DEFAULTS.server.port),
streaming: z.boolean().optional().default(true),
})
.optional()
.default({})
Expand Down Expand Up @@ -315,6 +317,7 @@ export async function validateConfig(
.optional()
.default(ASTRO_CONFIG_DEFAULTS.server.host),
port: z.number().optional().default(ASTRO_CONFIG_DEFAULTS.server.port),
streaming: z.boolean().optional().default(true),
})
.optional()
.default({})
Expand Down Expand Up @@ -404,6 +407,11 @@ function mergeCLIFlags(astroConfig: AstroUserConfig, flags: CLIFlags, cmd: strin
if (typeof flags.experimentalIntegrations === 'boolean')
astroConfig.experimental.integrations = flags.experimentalIntegrations;
if (typeof flags.drafts === 'boolean') astroConfig.markdown.drafts = flags.drafts;
if (typeof flags.streaming === 'boolean') {
tony-sull marked this conversation as resolved.
Show resolved Hide resolved
// @ts-expect-error astroConfig.server may be a function, but TS doesn't like attaching properties to a function.
// TODO: Come back here and refactor to remove this expected error.
astroConfig.server.streaming = flags.streaming;
}
if (typeof flags.port === 'number') {
// @ts-expect-error astroConfig.server may be a function, but TS doesn't like attaching properties to a function.
// TODO: Come back here and refactor to remove this expected error.
Expand Down
6 changes: 5 additions & 1 deletion packages/astro/src/core/render/result.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,11 @@ export function createResult(args: CreateResultArgs): SSRResult {
const url = new URL(request.url);
const canonicalURL = createCanonicalURL('.' + pathname, site ?? url.origin, paginated);
const headers = new Headers();
headers.set('Transfer-Encoding', 'chunked');
if (import.meta.env.STREAMING) {
headers.set('Transfer-Encoding', 'chunked');
} else {
headers.set('Content-Type', 'text/html');
}
const response: ResponseInit = {
status: 200,
statusText: 'OK',
Expand Down
48 changes: 32 additions & 16 deletions packages/astro/src/runtime/server/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -698,27 +698,43 @@ export async function renderPage(

if (isAstroComponent(factoryReturnValue)) {
let iterable = renderAstroComponent(factoryReturnValue);
let stream = new ReadableStream({
start(controller) {
async function read() {
let i = 0;
for await (const chunk of iterable) {
let html = chunk.toString();
if (i === 0) {
if (!/<!doctype html/i.test(html)) {
controller.enqueue(encoder.encode('<!DOCTYPE html>\n'));
let body: BodyInit;
if (import.meta.env.STREAMING) {
body = new ReadableStream({
start(controller) {
async function read() {
let i = 0;
for await (const chunk of iterable) {
let html = chunk.toString();
if (i === 0) {
if (!/<!doctype html/i.test(html)) {
controller.enqueue(encoder.encode('<!DOCTYPE html>\n'));
}
}
controller.enqueue(encoder.encode(html));
i++;
}
controller.enqueue(encoder.encode(html));
i++;
controller.close();
}
read();
},
});
} else {
body = '';
let i = 0;
for await (const chunk of iterable) {
let html = chunk.toString();
if (i === 0) {
if (!/<!doctype html/i.test(html)) {
body += '<!DOCTYPE html>\n';
}
controller.close();
}
read();
},
});
body += chunk;
i++;
}
}
let init = result.response;
let response = createResponse(stream, init);
let response = createResponse(body, init);
return response;
} else {
return factoryReturnValue;
Expand Down
2 changes: 2 additions & 0 deletions packages/astro/src/vite-plugin-env/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ export default function envVitePlugin({
if (privateEnv) {
privateEnv.SITE = astroConfig.site ? `'${astroConfig.site}'` : 'undefined';
privateEnv.SSR = JSON.stringify(true);
privateEnv.STREAMING = JSON.stringify(astroConfig.server.streaming);
tony-sull marked this conversation as resolved.
Show resolved Hide resolved
const entries = Object.entries(privateEnv).map(([key, value]) => [
`import.meta.env.${key}`,
value,
Expand All @@ -88,6 +89,7 @@ export default function envVitePlugin({
replacements = Object.assign(replacements, {
'import.meta.env.SITE': astroConfig.site ? `'${astroConfig.site}'` : 'undefined',
'import.meta.env.SSR': JSON.stringify(true),
'import.meta.env.STREAMING': JSON.stringify(astroConfig.server.streaming),
// This catches destructed `import.meta.env` calls,
// BUT we only want to inject private keys referenced in the file.
// We overwrite this value on a per-file basis.
Expand Down
7 changes: 7 additions & 0 deletions packages/integrations/cloudflare/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,13 @@ export default function createIntegration(): AstroIntegration {
return {
name: '@astrojs/cloudflare',
hooks: {
'astro:config:setup': ({ updateConfig }) => {
updateConfig({
server: {
streaming: false
}
});
},
'astro:config:done': ({ setAdapter, config }) => {
setAdapter(getAdapter());
_config = config;
Expand Down