1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
import type { Logger } from '../core/logger/core.js';
import type { AstroSettings } from '../types/astro.js';
import type {
AdapterSupport,
AdapterSupportsKind,
AstroAdapterFeatureMap,
} from '../types/public/integrations.js';
export const AdapterFeatureStability = {
STABLE: 'stable',
DEPRECATED: 'deprecated',
UNSUPPORTED: 'unsupported',
EXPERIMENTAL: 'experimental',
LIMITED: 'limited',
} as const;
type ValidationResult = {
[Property in keyof AstroAdapterFeatureMap]: boolean;
};
/**
* Checks whether an adapter supports certain features that are enabled via Astro configuration.
*
* If a configuration is enabled and "unlocks" a feature, but the adapter doesn't support, the function
* will throw a runtime error.
*
*/
export function validateSupportedFeatures(
adapterName: string,
featureMap: AstroAdapterFeatureMap,
settings: AstroSettings,
logger: Logger,
): ValidationResult {
const {
serverOutput = AdapterFeatureStability.UNSUPPORTED,
staticOutput = AdapterFeatureStability.UNSUPPORTED,
hybridOutput = AdapterFeatureStability.UNSUPPORTED,
i18nDomains = AdapterFeatureStability.UNSUPPORTED,
envGetSecret = AdapterFeatureStability.UNSUPPORTED,
sharpImageService = AdapterFeatureStability.UNSUPPORTED,
} = featureMap;
const validationResult: ValidationResult = {};
validationResult.staticOutput = validateSupportKind(
staticOutput,
adapterName,
logger,
'staticOutput',
() => settings.buildOutput === 'static',
);
validationResult.hybridOutput = validateSupportKind(
hybridOutput,
adapterName,
logger,
'hybridOutput',
() => settings.config.output == 'static' && settings.buildOutput === 'server',
);
validationResult.serverOutput = validateSupportKind(
serverOutput,
adapterName,
logger,
'serverOutput',
() => settings.config?.output === 'server' || settings.buildOutput === 'server',
);
if (settings.config.i18n?.domains) {
validationResult.i18nDomains = validateSupportKind(
i18nDomains,
adapterName,
logger,
'i18nDomains',
() => {
return settings.config?.output === 'server' && !settings.config?.site;
},
);
}
validationResult.envGetSecret = validateSupportKind(
envGetSecret,
adapterName,
logger,
'astro:env getSecret',
() => Object.keys(settings.config?.env?.schema ?? {}).length !== 0,
);
validationResult.sharpImageService = validateSupportKind(
sharpImageService,
adapterName,
logger,
'sharp',
() => settings.config?.image?.service?.entrypoint === 'astro/assets/services/sharp',
);
return validationResult;
}
export function unwrapSupportKind(supportKind?: AdapterSupport): AdapterSupportsKind | undefined {
if (!supportKind) {
return undefined;
}
return typeof supportKind === 'object' ? supportKind.support : supportKind;
}
export function getSupportMessage(supportKind: AdapterSupport): string | undefined {
return typeof supportKind === 'object' ? supportKind.message : undefined;
}
function validateSupportKind(
supportKind: AdapterSupport,
adapterName: string,
logger: Logger,
featureName: string,
hasCorrectConfig: () => boolean,
): boolean {
const supportValue = unwrapSupportKind(supportKind);
const message = getSupportMessage(supportKind);
if (!supportValue) {
return false;
}
if (supportValue === AdapterFeatureStability.STABLE) {
return true;
} else if (hasCorrectConfig()) {
// If the user has the relevant configuration, but the adapter doesn't support it, warn the user
logFeatureSupport(adapterName, logger, featureName, supportValue, message);
}
return false;
}
function logFeatureSupport(
adapterName: string,
logger: Logger,
featureName: string,
supportKind: AdapterSupport,
adapterMessage?: string,
) {
switch (supportKind) {
case AdapterFeatureStability.STABLE:
break;
case AdapterFeatureStability.DEPRECATED:
logger.warn(
'config',
`The adapter ${adapterName} has deprecated its support for "${featureName}", and future compatibility is not guaranteed. The adapter may completely remove support for this feature without warning.`,
);
break;
case AdapterFeatureStability.EXPERIMENTAL:
logger.warn(
'config',
`The adapter ${adapterName} provides experimental support for "${featureName}". You may experience issues or breaking changes until this feature is fully supported by the adapter.`,
);
break;
case AdapterFeatureStability.LIMITED:
logger.warn(
'config',
`The adapter ${adapterName} has limited support for "${featureName}". Certain features may not work as expected.`,
);
break;
case AdapterFeatureStability.UNSUPPORTED:
logger.error(
'config',
`The adapter ${adapterName} does not currently support the feature "${featureName}". Your project may not build correctly.`,
);
break;
}
// If the adapter specified a custom message, log it after the default message
if (adapterMessage) {
logger.warn('adapter', adapterMessage);
}
}
export function getAdapterStaticRecommendation(adapterName: string): string | undefined {
return {
'@astrojs/vercel/static':
'Update your configuration to use `@astrojs/vercel/serverless` to unlock server-side rendering capabilities.',
}[adapterName];
}
|
