-
Notifications
You must be signed in to change notification settings - Fork 8
/
withFlipper.ios.ts
281 lines (238 loc) · 8.64 KB
/
withFlipper.ios.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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
/*
exports the following config file changes for iOS Apps
withFlipper
(1) Inside use_react_native, after :fabric_enabled => flags[:fabric_enabled],
:flipper_configuration => FlipperConfiguration.enabled,
:flipper_configuration => FlipperConfiguration.disabled,
Depending on the ENV variable
withProductionEnv
(1) BEFORE target line
production = ENV["PRODUCTION"] == "1"
(2) Inside use_react_native, after :path => config[:reactNativePath],
:production => production,
*/
import { withDangerousMod } from "expo/config-plugins";
import {
mergeContents,
removeContents,
type MergeResults,
} from "@expo/config-plugins/build/utils/generateCode";
import {
EXPO_FLIPPER_TAG,
IOS_HAS_BUILD_PROPERTIES_SUPPORT,
IOS_HAS_FLIPPER_ARG,
IOS_HAS_PRODUCTION_ARG,
IOS_URN_ARG_ANCHOR,
IOS_USE_FRAMEWORKS_STATEMENT,
} from "./constants";
import path from "path";
import fs from "fs";
import dedent from "ts-dedent";
import { type FlipperConfig } from "./types";
import { type ExpoConfig } from "expo/config";
/** Create a namepaced tag */
const tag = (s: string) => `${EXPO_FLIPPER_TAG}-${s}`;
/** Return the flipper enabling line for use inside of use_react_native */
const createFlipperArgument = (version?: string) => {
// support NO_FLIPPER
if (process.env.NO_FLIPPER === "1") {
return `:flipper_configuration => FlipperConfiguration.disabled`;
}
const active = version
? `FlipperConfiguration.enabled(["Debug", "Release"], { 'Flipper' => '${version}' }),`
: `FlipperConfiguration.enabled(["Debug", "Release"]),`;
return `:flipper_configuration => ${active}`;
};
/** Removes content by its tag */
const removeTaggedContent = (contents: string, ns: string) => {
return removeContents({ src: contents, tag: tag(ns) });
};
/** Grab the last merge results operation */
const last = (arr: MergeResults[]): MergeResults => {
const l = arr[arr.length - 1];
if (typeof l === "undefined") {
throw new Error(
"No prior results. This is a bug in expo-community-flipper and should be reported"
);
}
return l;
};
/** Indent code, making generated podfile changes a bit more readable */
const indent = (block: string | string[], size: number) => {
return (typeof block === "string" ? block.split("\n") : block)
.map((s) => `${" ".repeat(size)}${s}`)
.join("\n");
};
/** Check for Expo SDK 48 with build-properties-plugin support */
function blockIfBuildPropertiesSupport(podfile: string) {
if (IOS_HAS_BUILD_PROPERTIES_SUPPORT.test(podfile)) {
throw new Error(
"This project is on Expo SDK48 and can use the build-properties plugin. Please see: https://docs.expo.dev/versions/latest/sdk/build-properties/"
);
}
}
/** Add the production arg to the use_react_native block */
function withEnvProductionPodfile(config: ExpoConfig) {
config = withDangerousMod(config, [
"ios",
async (c) => {
const filePath = path.join(c.modRequest.platformProjectRoot, "Podfile");
const contents = fs.readFileSync(filePath, "utf-8");
blockIfBuildPropertiesSupport(contents);
const updatedContents = updatePodfileContentsWithProductionFlag(contents);
fs.writeFileSync(filePath, updatedContents);
return c;
},
]);
return config;
}
/** Add flipper to the podfile, behind an ENV flag */
function withFlipperPodfile(config: ExpoConfig, cfg: FlipperConfig) {
config = withDangerousMod(config, [
"ios",
async (c) => {
const filePath = path.join(c.modRequest.platformProjectRoot, "Podfile");
const contents = fs.readFileSync(filePath, "utf-8");
blockIfBuildPropertiesSupport(contents);
const updatedContents = updatePodfileContentsWithFlipper(contents, cfg);
fs.writeFileSync(filePath, updatedContents);
return c;
},
]);
return config;
}
/** Add the production arg to the use_react_native block */
function withoutUseFrameworks(config: ExpoConfig) {
config = withDangerousMod(config, [
"ios",
async (c) => {
const TAG_HEADER = "ufwhead";
const TAG_FOOTER = "ufwfoot";
const filePath = path.join(c.modRequest.platformProjectRoot, "Podfile");
const contents = fs.readFileSync(filePath, "utf-8");
blockIfBuildPropertiesSupport(contents);
// #3 We cannot tell if a merge failed because of a malformed podfile or it was a noop
// so instead, remove the content first, then attempt the insert
const results: MergeResults[] = [];
results.push(removeTaggedContent(contents, TAG_HEADER));
results.push(removeTaggedContent(last(results).contents, TAG_FOOTER));
const preexisting = IOS_USE_FRAMEWORKS_STATEMENT.test(
last(results).contents
);
if (!preexisting) {
// no work to do
return c;
}
results.push(
mergeContents({
tag: tag(TAG_HEADER),
src: last(results).contents,
// block comments must be left-aligned to work in ruby
newSrc: dedent`
=begin
expo-community-flipper stripUseFrameworks=true
`,
anchor: IOS_USE_FRAMEWORKS_STATEMENT,
offset: 0,
comment: "#",
})
);
results.push(
mergeContents({
tag: tag(TAG_FOOTER),
src: last(results).contents,
// block comments must be left-aligned to work in ruby
newSrc: dedent`
=end
`,
anchor: IOS_USE_FRAMEWORKS_STATEMENT,
offset: 1,
comment: "#",
})
);
// couldn't remove and couldn't add. Treat the operation as failed
if (!last(results).didMerge) {
throw new Error(
"Cannot remove use_frameworks in the project's ios/Podfile. Please report this with a copy of your project Podfile. You can generate this with the `expo prebuild` command."
);
}
fs.writeFileSync(filePath, last(results).contents);
return c;
},
]);
return config;
}
/** Given Podfile contents, edit the file via regexes to insert the production flag for hermes if required */
export function updatePodfileContentsWithProductionFlag(contents: string) {
// #3 We cannot tell if a merge failed because of a malformed podfile or it was a noop
// so instead, remove the content first, then attempt the insert
const results: MergeResults[] = [];
results.push(removeTaggedContent(contents, "isprod"));
// Hermes/Flipper used to care about ENV.PRODUCTION
// Before we add the arg, we check to see if the keyed argument
// is already passed into use_react_native
const preexisting = IOS_HAS_PRODUCTION_ARG.test(last(results).contents);
if (!preexisting) {
results.push(
mergeContents({
tag: tag("isprod"),
src: last(results).contents,
newSrc: indent(
[
"# ENV value added to support Hermes",
':production => ENV["PRODUCTION"] == "1" ? true : false,',
],
4
),
anchor: IOS_URN_ARG_ANCHOR,
offset: -1,
comment: "#",
})
);
}
// couldn't remove and couldn't add. Treat the operation as failed
if (!last(results).didMerge) {
throw new Error(
"Cannot add use_flipper to the project's ios/Podfile. Please report this with a copy of your project Podfile. You can generate this with the `expo prebuild` command."
);
}
return last(results).contents;
}
/** Given Podfile contents, edit the file via regexes to insert the flipper arguments */
export function updatePodfileContentsWithFlipper(
contents: string,
cfg: FlipperConfig
) {
// #3 We cannot tell if a merge failed because of a malformed podfile or it was a noop
// so instead, remove the content first, then attempt the insert
const results: MergeResults[] = [];
results.push(removeTaggedContent(contents, "urn"));
const preexisting = IOS_HAS_FLIPPER_ARG.test(last(results).contents);
if (!preexisting) {
results.push(
mergeContents({
tag: tag("urn"),
src: last(results).contents,
newSrc: indent([createFlipperArgument(cfg.version)], 4),
anchor: IOS_URN_ARG_ANCHOR,
offset: 1,
comment: "#",
})
);
}
// couldn't remove and couldn't add. Treat the operation as failed
if (!last(results).didMerge) {
throw new Error(
"Cannot add flipper arguments to the project's ios/Podfile. Please report this with a copy of your project Podfile. You can generate this with the `expo prebuild` command."
);
}
return last(results).contents;
}
export function withFlipperIOS(config: ExpoConfig, cfg: FlipperConfig) {
config = withEnvProductionPodfile(config);
config = withFlipperPodfile(config, cfg);
if (cfg.ios.stripUseFrameworks === true) {
config = withoutUseFrameworks(config);
}
return config;
}