/
Updates.ts
254 lines (227 loc) · 9.16 KB
/
Updates.ts
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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
import path from 'path';
import resolveFrom from 'resolve-from';
import { ConfigPlugin } from '../Plugin.types';
import { withAndroidManifest } from '../plugins/android-plugins';
import {
ExpoConfigUpdates,
getExpoUpdatesPackageVersion,
getRuntimeVersionNullable,
getSDKVersion,
getUpdatesCheckOnLaunch,
getUpdatesCodeSigningCertificate,
getUpdatesCodeSigningMetadataStringified,
getUpdatesEnabled,
getUpdatesTimeout,
getUpdateUrl,
} from '../utils/Updates';
import {
addMetaDataItemToMainApplication,
AndroidManifest,
findMetaDataItem,
getMainApplicationMetaDataValue,
getMainApplicationOrThrow,
removeMetaDataItemFromMainApplication,
} from './Manifest';
const CREATE_MANIFEST_ANDROID_PATH = 'expo-updates/scripts/create-manifest-android.gradle';
export enum Config {
ENABLED = 'expo.modules.updates.ENABLED',
CHECK_ON_LAUNCH = 'expo.modules.updates.EXPO_UPDATES_CHECK_ON_LAUNCH',
LAUNCH_WAIT_MS = 'expo.modules.updates.EXPO_UPDATES_LAUNCH_WAIT_MS',
SDK_VERSION = 'expo.modules.updates.EXPO_SDK_VERSION',
RUNTIME_VERSION = 'expo.modules.updates.EXPO_RUNTIME_VERSION',
UPDATE_URL = 'expo.modules.updates.EXPO_UPDATE_URL',
RELEASE_CHANNEL = 'expo.modules.updates.EXPO_RELEASE_CHANNEL',
UPDATES_CONFIGURATION_REQUEST_HEADERS_KEY = 'expo.modules.updates.UPDATES_CONFIGURATION_REQUEST_HEADERS_KEY',
CODE_SIGNING_CERTIFICATE = 'expo.modules.updates.CODE_SIGNING_CERTIFICATE',
CODE_SIGNING_METADATA = 'expo.modules.updates.CODE_SIGNING_METADATA',
}
export const withUpdates: ConfigPlugin<{ expoUsername: string | null }> = (
config,
{ expoUsername }
) => {
return withAndroidManifest(config, (config) => {
const projectRoot = config.modRequest.projectRoot;
const expoUpdatesPackageVersion = getExpoUpdatesPackageVersion(projectRoot);
config.modResults = setUpdatesConfig(
projectRoot,
config,
config.modResults,
expoUsername,
expoUpdatesPackageVersion
);
return config;
});
};
export function setUpdatesConfig(
projectRoot: string,
config: ExpoConfigUpdates,
androidManifest: AndroidManifest,
username: string | null,
expoUpdatesPackageVersion?: string | null
): AndroidManifest {
const mainApplication = getMainApplicationOrThrow(androidManifest);
addMetaDataItemToMainApplication(
mainApplication,
Config.ENABLED,
String(getUpdatesEnabled(config))
);
addMetaDataItemToMainApplication(
mainApplication,
Config.CHECK_ON_LAUNCH,
getUpdatesCheckOnLaunch(config, expoUpdatesPackageVersion)
);
addMetaDataItemToMainApplication(
mainApplication,
Config.LAUNCH_WAIT_MS,
String(getUpdatesTimeout(config))
);
const updateUrl = getUpdateUrl(config, username);
if (updateUrl) {
addMetaDataItemToMainApplication(mainApplication, Config.UPDATE_URL, updateUrl);
} else {
removeMetaDataItemFromMainApplication(mainApplication, Config.UPDATE_URL);
}
const codeSigningCertificate = getUpdatesCodeSigningCertificate(projectRoot, config);
if (codeSigningCertificate) {
addMetaDataItemToMainApplication(
mainApplication,
Config.CODE_SIGNING_CERTIFICATE,
codeSigningCertificate
);
} else {
removeMetaDataItemFromMainApplication(mainApplication, Config.CODE_SIGNING_CERTIFICATE);
}
const codeSigningMetadata = getUpdatesCodeSigningMetadataStringified(config);
if (codeSigningMetadata) {
addMetaDataItemToMainApplication(
mainApplication,
Config.CODE_SIGNING_METADATA,
codeSigningMetadata
);
} else {
removeMetaDataItemFromMainApplication(mainApplication, Config.CODE_SIGNING_METADATA);
}
return setVersionsConfig(config, androidManifest);
}
export function setVersionsConfig(
config: Pick<ExpoConfigUpdates, 'sdkVersion' | 'runtimeVersion'>,
androidManifest: AndroidManifest
): AndroidManifest {
const mainApplication = getMainApplicationOrThrow(androidManifest);
const runtimeVersion = getRuntimeVersionNullable(config, 'android');
if (!runtimeVersion && findMetaDataItem(mainApplication, Config.RUNTIME_VERSION) > -1) {
throw new Error(
'A runtime version is set in your AndroidManifest.xml, but is missing from your app.json/app.config.js. Please either set runtimeVersion in your app.json/app.config.js or remove expo.modules.updates.EXPO_RUNTIME_VERSION from your AndroidManifest.xml.'
);
}
const sdkVersion = getSDKVersion(config);
if (runtimeVersion) {
removeMetaDataItemFromMainApplication(mainApplication, Config.SDK_VERSION);
addMetaDataItemToMainApplication(mainApplication, Config.RUNTIME_VERSION, runtimeVersion);
} else if (sdkVersion) {
/**
* runtime version maybe null in projects using classic updates. In that
* case we use SDK version
*/
removeMetaDataItemFromMainApplication(mainApplication, Config.RUNTIME_VERSION);
addMetaDataItemToMainApplication(mainApplication, Config.SDK_VERSION, sdkVersion);
} else {
removeMetaDataItemFromMainApplication(mainApplication, Config.RUNTIME_VERSION);
removeMetaDataItemFromMainApplication(mainApplication, Config.SDK_VERSION);
}
return androidManifest;
}
export function ensureBuildGradleContainsConfigurationScript(
projectRoot: string,
buildGradleContents: string
): string {
if (!isBuildGradleConfigured(projectRoot, buildGradleContents)) {
let cleanedUpBuildGradleContents;
const isBuildGradleMisconfigured = buildGradleContents
.split('\n')
.some((line) => line.includes(CREATE_MANIFEST_ANDROID_PATH));
if (isBuildGradleMisconfigured) {
cleanedUpBuildGradleContents = buildGradleContents.replace(
new RegExp(`(\n// Integration with Expo updates)?\n.*${CREATE_MANIFEST_ANDROID_PATH}.*\n`),
''
);
} else {
cleanedUpBuildGradleContents = buildGradleContents;
}
const gradleScriptApply = formatApplyLineForBuildGradle(projectRoot);
return `${cleanedUpBuildGradleContents}\n// Integration with Expo updates\n${gradleScriptApply}\n`;
} else {
return buildGradleContents;
}
}
export function formatApplyLineForBuildGradle(projectRoot: string): string {
const updatesGradleScriptPath = resolveFrom.silent(projectRoot, CREATE_MANIFEST_ANDROID_PATH);
if (!updatesGradleScriptPath) {
throw new Error(
"Could not find the build script for Android. This could happen in case of outdated 'node_modules'. Run 'npm install' to make sure that it's up-to-date."
);
}
const relativePath = path.relative(
path.join(projectRoot, 'android', 'app'),
updatesGradleScriptPath
);
const posixPath = process.platform === 'win32' ? relativePath.replace(/\\/g, '/') : relativePath;
return `apply from: "${posixPath}"`;
}
export function isBuildGradleConfigured(projectRoot: string, buildGradleContents: string): boolean {
const androidBuildScript = formatApplyLineForBuildGradle(projectRoot);
return (
buildGradleContents
.replace(/\r\n/g, '\n')
.split('\n')
// Check for both single and double quotes
.some((line) => line === androidBuildScript || line === androidBuildScript.replace(/"/g, "'"))
);
}
export function isMainApplicationMetaDataSet(androidManifest: AndroidManifest): boolean {
const updateUrl = getMainApplicationMetaDataValue(androidManifest, Config.UPDATE_URL);
const runtimeVersion = getMainApplicationMetaDataValue(androidManifest, Config.RUNTIME_VERSION);
const sdkVersion = getMainApplicationMetaDataValue(androidManifest, Config.SDK_VERSION);
return Boolean(updateUrl && (sdkVersion || runtimeVersion));
}
export function isMainApplicationMetaDataSynced(
projectRoot: string,
config: ExpoConfigUpdates,
androidManifest: AndroidManifest,
username: string | null
): boolean {
return (
getUpdateUrl(config, username) ===
getMainApplicationMetaDataValue(androidManifest, Config.UPDATE_URL) &&
String(getUpdatesEnabled(config)) ===
getMainApplicationMetaDataValue(androidManifest, Config.ENABLED) &&
String(getUpdatesTimeout(config)) ===
getMainApplicationMetaDataValue(androidManifest, Config.LAUNCH_WAIT_MS) &&
getUpdatesCheckOnLaunch(config) ===
getMainApplicationMetaDataValue(androidManifest, Config.CHECK_ON_LAUNCH) &&
getUpdatesCodeSigningCertificate(projectRoot, config) ===
getMainApplicationMetaDataValue(androidManifest, Config.CODE_SIGNING_CERTIFICATE) &&
getUpdatesCodeSigningMetadataStringified(config) ===
getMainApplicationMetaDataValue(androidManifest, Config.CODE_SIGNING_METADATA) &&
areVersionsSynced(config, androidManifest)
);
}
export function areVersionsSynced(
config: Pick<ExpoConfigUpdates, 'runtimeVersion' | 'sdkVersion'>,
androidManifest: AndroidManifest
): boolean {
const expectedRuntimeVersion = getRuntimeVersionNullable(config, 'android');
const expectedSdkVersion = getSDKVersion(config);
const currentRuntimeVersion = getMainApplicationMetaDataValue(
androidManifest,
Config.RUNTIME_VERSION
);
const currentSdkVersion = getMainApplicationMetaDataValue(androidManifest, Config.SDK_VERSION);
if (expectedRuntimeVersion !== null) {
return currentRuntimeVersion === expectedRuntimeVersion && currentSdkVersion === null;
} else if (expectedSdkVersion !== null) {
return currentSdkVersion === expectedSdkVersion && currentRuntimeVersion === null;
} else {
return true;
}
}