feat: hybrid output by MoustaphaDev · Pull Request #6991 · withastro/astro

MoustaphaDev · 2023-05-04T15:10:20Z

Changes

Implementation of the hybrid rendering RFC.

This introduces the hybrid output format which enables prerendering by default and allows opting out of it with export const prerender = false.

Testing

We will use the existing prerendering test fixtures, but we will make prerendering a function of a PRERENDER environment variable, doing export const prerender = import.meta.env.PRERENDER so that we can set prerendering to false or true depending on which feature we're testing.

Docs

There's an open docs issue withastro/docs#3226

changeset-bot · 2023-05-04T15:10:24Z

🦋 Changeset detected

Latest commit: eb55a43

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

…t/output-hybrid

Extract the fallback `prerender` module meta out of the `scan` function. It shouldn't be its responsibility to handle that

matthewp · 2023-05-15T17:26:05Z

packages/astro/src/core/build/static-build.ts

-	const ssr = opts.settings.config.output === 'server';
+	const ssr =
+		opts.settings.config.output === 'server' ||
+		(opts.settings.config.experimental.hybridOutput && opts.settings.config.output === 'hybrid');


This code seems to be repeated a lot in the PR. What do you think about a src/core/prerender/ folder where we can have a bunch of utility functions that do this sort of thing?

Sounds like a good idea, I'll refactor this

matthewp · 2023-05-15T17:26:34Z

packages/astro/src/core/config/config.ts

+// TODO: remove after the experimetal phase when
+// it won't be needed to edit two config fields to enable the feature
+function isHybridMalconfigured(config: AstroConfig) {
+	return config.experimental.hybridOutput ? config.output !== 'hybrid' : config.output === 'hybrid';


This is an example of another function that might be nice to live in a prerender folder.

matthewp · 2023-05-15T17:28:04Z

Code looks really great overall. I left some comments more about code organization. But functionality looks perfect. Really appreciate how much work this was and how thorough the testing is.

matthewp · 2023-05-15T18:19:29Z

Also @MoustaphaDev can you add a changeset via pnpm changeset?

MoustaphaDev · 2023-05-15T18:54:29Z

Sure, I'll add that

github-actions · 2023-05-15T20:08:32Z

This PR is blocked because it contains a minor changeset. A reviewer will merge this at the next release if approved.

MoustaphaDev · 2023-05-15T20:17:23Z

.changeset/mighty-shoes-scream.md

+'@astrojs/cloudflare': patch
+'@astrojs/netlify': patch
+'@astrojs/vercel': patch
+'@astrojs/image': patch
+'@astrojs/deno': patch
+'@astrojs/node': patch


Marked these as 'patch' because I updated the warning we get when using these adapters with an unexpected output mode.

packages/astro/src/core/build/generate.ts

…t/output-hybrid

sarah11918

Approving the docs edits!

MoustaphaDev · 2023-05-17T12:13:20Z

Nice, thanks your reviews @sarah11918!

* update config schema * adapt default route `prerender` value * adapt error message for hybrid output * core hybrid output support * add JSDocs for hybrid output * dev server hybrid output support * defer hybrid output check * update endpoint request warning * support `output=hybrid` in integrations * put constant variable out of for loop * revert: reapply back ssr plugin in ssr mode * change `prerender` option default * apply `prerender` by default in hybrid mode * simplfy conditional * update config schema * add `isHybridOutput` helper * more readable prerender condition * set default prerender value if no export is found * only add `pagesVirtualModuleId` ro rollup input in `output=static` * don't export vite plugin * remove unneeded check * don't prerender when it shouldn't * extract fallback `prerender` meta Extract the fallback `prerender` module meta out of the `scan` function. It shouldn't be its responsibility to handle that * pass missing argument to function * test: update cloudflare integration tests * test: update tests of vercel integration * test: update tests of node integration * test: update tests of netlify func integration * test: update tests of netlify edge integration * throw when `hybrid` mode is malconfigured * update node integraiton `output` warning * test(WIP): skip node prerendering tests for now * remove non-existant import * test: bring back prerendering tests * remove outdated comments * test: refactor test to support windows paths * remove outdated comments * apply sarah review Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * docs: `experiment.hybridOutput` jsodcs * test: prevent import from being cached * refactor: extract hybrid output check to function * add `hybrid` to output warning in adapter hooks * chore: changeset * add `.js` extension to import * chore: use spaces instead of tabs for gh formating * resolve merge conflict * chore: move test to another file for consitency --------- Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> Co-authored-by: Matthew Phillips <matthew@skypack.dev>

MoustaphaDev added 14 commits April 27, 2023 21:10

update config schema

99c3bfa

adapt default route prerender value

e4c614d

adapt error message for hybrid output

1b05568

core hybrid output support

e9408cf

add JSDocs for hybrid output

ba0c6cd

dev server hybrid output support

06a8f69

defer hybrid output check

6d509b5

update endpoint request warning

2d7263e

support output=hybrid in integrations

96cffb7

put constant variable out of for loop

70c60c9

revert: reapply back ssr plugin in ssr mode

3a4541d

change prerender option default

2788683

apply prerender by default in hybrid mode

157c4e0

simplfy conditional

0fa2ded

github-actions bot added pkg: astro Related to the core `astro` package (scope) pkg: integration Related to any renderer integration (scope) labels May 4, 2023

Merge branch 'main' of https://github.com/withastro/astro into mk-fea…

459b9d3

…t/output-hybrid

matthewp mentioned this pull request May 10, 2023

Hybrid rendering withastro/docs#3226

Closed

MoustaphaDev added 11 commits May 10, 2023 19:20

update config schema

b3c6e24

add isHybridOutput helper

21f7a41

more readable prerender condition

f18245c

set default prerender value if no export is found

3496afa

Merge branch 'main' of https://github.com/withastro/astro into mk-fea…

cc4fd2d

…t/output-hybrid

only add pagesVirtualModuleId ro rollup input in output=static

b44a926

don't export vite plugin

b756753

remove unneeded check

0b14c61

don't prerender when it shouldn't

aaa9896

extract fallback prerender meta

ef2ffb1

Extract the fallback `prerender` module meta out of the `scan` function. It shouldn't be its responsibility to handle that

pass missing argument to function

7ca73e8

matthewp reviewed May 15, 2023

View reviewed changes

MoustaphaDev added 3 commits May 15, 2023 19:31

refactor: extract hybrid output check to function

a1f1558

add hybrid to output warning in adapter hooks

bada941

chore: changeset

091e9c8

github-actions bot added the semver: minor Change triggers a `minor` release label May 15, 2023

add .js extension to import

037efbc

MoustaphaDev commented May 15, 2023

View reviewed changes

packages/astro/src/core/build/generate.ts Show resolved Hide resolved

MoustaphaDev added 4 commits May 15, 2023 21:00

chore: use spaces instead of tabs for gh formating

e6bd737

Merge branch 'main' of https://github.com/withastro/astro into mk-fea…

e595d21

…t/output-hybrid

resolve merge conflict

c408482

chore: move test to another file for consitency

3f340a3

sarah11918 approved these changes May 17, 2023

View reviewed changes

Merge branch 'main' into mk-feat/output-hybrid

eb55a43

matthewp merged commit 719002c into main May 17, 2023

matthewp deleted the mk-feat/output-hybrid branch May 17, 2023 13:23

astrobot-houston mentioned this pull request May 17, 2023

[ci] release #7090

Merged

This was referenced May 31, 2023

Unflag hybrid output #7255

Merged

Unflag hybrid output #7260

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: hybrid output#6991

feat: hybrid output#6991
matthewp merged 54 commits intomainfrom
mk-feat/output-hybrid

MoustaphaDev commented May 4, 2023 •

edited

Loading

Uh oh!

changeset-bot bot commented May 4, 2023 •

edited

Loading

Uh oh!

matthewp May 15, 2023

Uh oh!

MoustaphaDev May 15, 2023 •

edited

Loading

Uh oh!

matthewp May 15, 2023

Uh oh!

matthewp commented May 15, 2023

Uh oh!

matthewp commented May 15, 2023

Uh oh!

MoustaphaDev commented May 15, 2023

Uh oh!

github-actions bot commented May 15, 2023

Uh oh!

MoustaphaDev May 15, 2023

Uh oh!

Uh oh!

sarah11918 left a comment

Uh oh!

MoustaphaDev commented May 17, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

MoustaphaDev commented May 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Testing

Docs

Uh oh!

changeset-bot bot commented May 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

matthewp May 15, 2023

Choose a reason for hiding this comment

Uh oh!

MoustaphaDev May 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

matthewp May 15, 2023

Choose a reason for hiding this comment

Uh oh!

matthewp commented May 15, 2023

Uh oh!

matthewp commented May 15, 2023

Uh oh!

MoustaphaDev commented May 15, 2023

Uh oh!

github-actions bot commented May 15, 2023

Uh oh!

MoustaphaDev May 15, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sarah11918 left a comment

Choose a reason for hiding this comment

Uh oh!

MoustaphaDev commented May 17, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

MoustaphaDev commented May 4, 2023 •

edited

Loading

changeset-bot bot commented May 4, 2023 •

edited

Loading

MoustaphaDev May 15, 2023 •

edited

Loading