feat: adapter features, deprecate astro configs by ematipico · Pull Request #7839 · withastro/astro

ematipico · 2023-07-27T13:59:51Z

Changes

This PR deprecates build.split and build.excludeMiddleware.

After an internal discussion, we realised that these two config values should not live inside Astro, because they are only usable only with an adapter that can understand it

Because of that, we introduced the concept of adapterFeatures. These features are toggles that signal Astro to change the output of the build, and then the adapter needs to do something with those.

Testing

I updated the current test to use the new configuration. The tests should pass.

Docs

/cc @withastro/maintainers-docs for feedback!

changeset-bot · 2023-07-27T13:59:56Z

🦋 Changeset detected

Latest commit: af251d9

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

bluwy

Thanks for making the changes! This looks great to me.

Should we also validate if the deprecated configs are used in runtime, somewhere around here?

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

Lines 65 to 77 in 73eb4df

    
           let legacyConfigKey: string | undefined; 
        
           for (const key of Object.keys(userConfig)) { 
        
           	if (LEGACY_ASTRO_CONFIG_KEYS.has(key)) { 
        
           		legacyConfigKey = key; 
        
           		break; 
        
           	} 
        
           } 
        
           if (legacyConfigKey) { 
        
           	throw new AstroError({ 
        
           		...AstroErrorData.ConfigLegacyKey, 
        
           		message: AstroErrorData.ConfigLegacyKey.message(legacyConfigKey), 
        
           	}); 
        
           }

Also, the docs team were also interested in the API discussion for this, so might be good to run by them if this new syntax is better. cc @withastro/maintainers-docs

.changeset/fair-emus-divide.md

ematipico · 2023-07-28T08:30:36Z

@bluwy

Should we also validate if the deprecated configs are used in runtime, somewhere around here?

Two reasons why we can't do that:

these keys throw an error, which means it won't be a deprecation;
the code reads only the first level of keys, which doesn't fit our case because both keys are inside build

TheOtterlord

Not core docs, but I found a few typos

TheOtterlord · 2023-07-28T09:56:43Z

packages/astro/src/@types/astro.ts


+export interface AstroAdapterFeatures {
+	/**
+	 * Creates and edge function that will communiate with the Astro middleware


Suggested change

* Creates and edge function that will communiate with the Astro middleware

* Creates an edge function that will communicate with the Astro middleware

TheOtterlord · 2023-07-28T09:57:30Z

packages/astro/src/core/build/plugins/plugin-pages.ts

 						// The middleware should not be imported by the pages
-						if (!opts.settings.config.build.excludeMiddleware) {
+						if (
+							// TODO: remover in Astro 4.0


typo?

Suggested change

// TODO: remover in Astro 4.0

// TODO: remove in Astro 4.0

bluwy · 2023-07-28T12:19:55Z

Two reasons why we can't do that:

these keys throw an error, which means it won't be a deprecation;

the code reads only the first level of keys, which doesn't fit our case because both keys are inside build

I mean we can to the warning deprecations, and validate build.* around that area of the code, not necessarily error-ing like it. But it would be a nice to have for me and not something needed.

ematipico requested a review from a team as a code owner July 27, 2023 13:59

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

bluwy approved these changes Jul 27, 2023

View reviewed changes

.changeset/fair-emus-divide.md Show resolved Hide resolved

matthewp approved these changes Jul 27, 2023

View reviewed changes

ematipico added 2 commits July 28, 2023 09:24

feat: adapter features, deprecate astro configs

a7fd717

fix changeset

baffd37

ematipico force-pushed the feat/adapter-features-plt-733 branch from 38d243f to baffd37 Compare July 28, 2023 08:31

chore: rebase

af251d9

ematipico merged commit 4232be5 into next Jul 28, 2023

ematipico deleted the feat/adapter-features-plt-733 branch July 28, 2023 09:11

TheOtterlord reviewed Jul 28, 2023

View reviewed changes

ematipico mentioned this pull request Jul 28, 2023

feat: document adapter features withastro/docs#3917

Merged

ematipico added a commit that referenced this pull request Jul 31, 2023

feat: adapter features, deprecate astro configs (#7839)

c06a034

ematipico added a commit that referenced this pull request Aug 1, 2023

feat: adapter features, deprecate astro configs (#7839)

460fe00

ematipico added a commit that referenced this pull request Aug 1, 2023

feat: adapter features, deprecate astro configs (#7839)

c17e265

ematipico added a commit that referenced this pull request Aug 3, 2023

feat: adapter features, deprecate astro configs (#7839)

3fdf509

alexanderniebuhr mentioned this pull request Aug 4, 2023

[astrojs/cloudflare] port build.split deprecation to cloudflare #7948

Closed

ematipico added a commit that referenced this pull request Aug 8, 2023

feat: adapter features, deprecate astro configs (#7839)

80f1494

alexanderniebuhr mentioned this pull request Aug 14, 2023

feature(@astrojs/cloudflare): port functionPerRoute #8078

Merged

ematipico added a commit that referenced this pull request Feb 6, 2025

feat: adapter features, deprecate astro configs (#7839)

d7fe86f

ematipico added a commit that referenced this pull request Feb 6, 2025

feat: adapter features, deprecate astro configs (#7839)

469345a

ArmandPhilippot mentioned this pull request Nov 5, 2025

refactor(adapter-reference): improve adapter API docs withastro/docs#12673

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: adapter features, deprecate astro configs#7839

feat: adapter features, deprecate astro configs#7839
ematipico merged 3 commits intonextfrom
feat/adapter-features-plt-733

ematipico commented Jul 27, 2023

Uh oh!

changeset-bot bot commented Jul 27, 2023 •

edited

Loading

Uh oh!

bluwy left a comment

Uh oh!

Uh oh!

ematipico commented Jul 28, 2023

Uh oh!

TheOtterlord left a comment

Uh oh!

TheOtterlord Jul 28, 2023

Uh oh!

TheOtterlord Jul 28, 2023

Uh oh!

bluwy commented Jul 28, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	let legacyConfigKey: string \| undefined;
	for (const key of Object.keys(userConfig)) {
	if (LEGACY_ASTRO_CONFIG_KEYS.has(key)) {
	legacyConfigKey = key;
	break;
	}
	}
	if (legacyConfigKey) {
	throw new AstroError({
	...AstroErrorData.ConfigLegacyKey,
	message: AstroErrorData.ConfigLegacyKey.message(legacyConfigKey),
	});
	}

	* Creates and edge function that will communiate with the Astro middleware
	* Creates an edge function that will communicate with the Astro middleware

Uh oh!

Conversation

ematipico commented Jul 27, 2023

Changes

Testing

Docs

Uh oh!

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

Uh oh!

🦋 Changeset detected

Uh oh!

bluwy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ematipico commented Jul 28, 2023

Uh oh!

TheOtterlord left a comment

Choose a reason for hiding this comment

Uh oh!

TheOtterlord Jul 28, 2023

Choose a reason for hiding this comment

Uh oh!

TheOtterlord Jul 28, 2023

Choose a reason for hiding this comment

Uh oh!

bluwy commented Jul 28, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

changeset-bot bot commented Jul 27, 2023 •

edited

Loading