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
|
import type { Logger } from '../core/logger/core.js';
import type { AstroConfig } from '../types/public/config.js';
import type {
AdapterSupportsKind,
AstroAdapterFeatureMap,
AstroAdapterFeatures,
AstroAssetsFeature,
} from '../types/public/integrations.js';
const STABLE = 'stable';
const DEPRECATED = 'deprecated';
const UNSUPPORTED = 'unsupported';
const EXPERIMENTAL = 'experimental';
const UNSUPPORTED_ASSETS_FEATURE: AstroAssetsFeature = {
supportKind: UNSUPPORTED,
isSquooshCompatible: false,
isSharpCompatible: false,
};
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,
config: AstroConfig,
adapterFeatures: AstroAdapterFeatures | undefined,
logger: Logger,
): ValidationResult {
const {
assets = UNSUPPORTED_ASSETS_FEATURE,
serverOutput = UNSUPPORTED,
staticOutput = UNSUPPORTED,
hybridOutput = UNSUPPORTED,
i18nDomains = UNSUPPORTED,
envGetSecret = UNSUPPORTED,
} = featureMap;
const validationResult: ValidationResult = {};
validationResult.staticOutput = validateSupportKind(
staticOutput,
adapterName,
logger,
'staticOutput',
() => config?.output === 'static',
);
validationResult.hybridOutput = validateSupportKind(
hybridOutput,
adapterName,
logger,
'hybridOutput',
() => config?.output === 'hybrid',
);
validationResult.serverOutput = validateSupportKind(
serverOutput,
adapterName,
logger,
'serverOutput',
() => config?.output === 'server',
);
validationResult.assets = validateAssetsFeature(assets, adapterName, config, logger);
if (config.i18n?.domains) {
validationResult.i18nDomains = validateSupportKind(
i18nDomains,
adapterName,
logger,
'i18nDomains',
() => {
return config?.output === 'server' && !config?.site;
},
);
}
validationResult.envGetSecret = validateSupportKind(
envGetSecret,
adapterName,
logger,
'astro:env getSecret',
() => config?.experimental?.env !== undefined,
);
return validationResult;
}
function validateSupportKind(
supportKind: AdapterSupportsKind,
adapterName: string,
logger: Logger,
featureName: string,
hasCorrectConfig: () => boolean,
): boolean {
if (supportKind === STABLE) {
return true;
} else if (supportKind === DEPRECATED) {
featureIsDeprecated(adapterName, logger, featureName);
} else if (supportKind === EXPERIMENTAL) {
featureIsExperimental(adapterName, logger, featureName);
}
if (hasCorrectConfig() && supportKind === UNSUPPORTED) {
featureIsUnsupported(adapterName, logger, featureName);
return false;
} else {
return true;
}
}
function featureIsUnsupported(adapterName: string, logger: Logger, featureName: string) {
logger.error(
'config',
`The adapter ${adapterName} doesn't currently support the feature "${featureName}".`,
);
}
function featureIsExperimental(adapterName: string, logger: Logger, featureName: string) {
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.`,
);
}
function featureIsDeprecated(adapterName: string, logger: Logger, featureName: string) {
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.`,
);
}
const SHARP_SERVICE = 'astro/assets/services/sharp';
const SQUOOSH_SERVICE = 'astro/assets/services/squoosh';
function validateAssetsFeature(
assets: AstroAssetsFeature,
adapterName: string,
config: AstroConfig,
logger: Logger,
): boolean {
const {
supportKind = UNSUPPORTED,
isSharpCompatible = false,
isSquooshCompatible = false,
} = assets;
if (config?.image?.service?.entrypoint === SHARP_SERVICE && !isSharpCompatible) {
logger.warn(
null,
`The currently selected adapter \`${adapterName}\` is not compatible with the image service "Sharp".`,
);
return false;
}
if (config?.image?.service?.entrypoint === SQUOOSH_SERVICE && !isSquooshCompatible) {
logger.warn(
null,
`The currently selected adapter \`${adapterName}\` is not compatible with the image service "Squoosh".`,
);
return false;
}
return validateSupportKind(supportKind, adapterName, logger, 'assets', () => true);
}
|
