forked from vercel/next.js
-
Notifications
You must be signed in to change notification settings - Fork 0
321 lines (310 loc) · 9.6 KB
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
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
diff --git a/lib/RawSource.js b/lib/RawSource.js
index 71f1341c43dd45dc82b633eabe0a1cfe99bbe25d..b56ea1a17ba81295826dc1c820d462cca8643bc1 100644
--- a/lib/RawSource.js
+++ b/lib/RawSource.js
@@ -6,76 +6,91 @@
"use strict";
const streamChunksOfRawSource = require("./helpers/streamChunksOfRawSource");
+const {
+ internString,
+ isDualStringBufferCachingEnabled,
+} = require("./helpers/stringBufferUtils");
const Source = require("./Source");
class RawSource extends Source {
- constructor(value, convertToString = false) {
- super();
- const isBuffer = Buffer.isBuffer(value);
- if (!isBuffer && typeof value !== "string") {
- throw new TypeError("argument 'value' must be either string of Buffer");
- }
- this._valueIsBuffer = !convertToString && isBuffer;
- this._value = convertToString && isBuffer ? undefined : value;
- this._valueAsBuffer = isBuffer ? value : undefined;
- this._valueAsString = isBuffer ? undefined : value;
- }
+ constructor(value, convertToString = false) {
+ super();
+ const isBuffer = Buffer.isBuffer(value);
+ if (!isBuffer && typeof value !== "string") {
+ throw new TypeError("argument 'value' must be either string or Buffer");
+ }
+ this._valueIsBuffer = !convertToString && isBuffer;
+ const internedString =
+ typeof value === "string" ? internString(value) : undefined;
+ this._value =
+ convertToString && isBuffer
+ ? undefined
+ : typeof value === "string"
+ ? internedString
+ : value;
+ this._valueAsBuffer = isBuffer ? value : undefined;
+ this._valueAsString = isBuffer ? undefined : internedString;
+ }
- isBuffer() {
- return this._valueIsBuffer;
- }
+ isBuffer() {
+ return this._valueIsBuffer;
+ }
- source() {
- if (this._value === undefined) {
- this._value = this._valueAsBuffer.toString("utf-8");
- }
- return this._value;
- }
+ source() {
+ if (this._value === undefined) {
+ const value = this._valueAsBuffer.toString("utf-8");
+ if (isDualStringBufferCachingEnabled()) {
+ this._value = internString(value);
+ }
+ return value;
+ }
+ return this._value;
+ }
- buffer() {
- if (this._valueAsBuffer === undefined) {
- this._valueAsBuffer = Buffer.from(this._value, "utf-8");
- }
- return this._valueAsBuffer;
- }
+ buffer() {
+ if (this._valueAsBuffer === undefined) {
+ const value = Buffer.from(this._value, "utf-8");
+ if (isDualStringBufferCachingEnabled()) {
+ this._valueAsBuffer = value;
+ }
+ return value;
+ }
+ return this._valueAsBuffer;
+ }
- map(options) {
- return null;
- }
+ map(options) {
+ return null;
+ }
- /**
- * @param {object} options options
- * @param {function(string, number, number, number, number, number, number): void} onChunk called for each chunk of code
- * @param {function(number, string, string)} onSource called for each source
- * @param {function(number, string)} onName called for each name
- * @returns {void}
- */
- streamChunks(options, onChunk, onSource, onName) {
- if (this._value === undefined) {
- this._value = Buffer.from(this._valueAsBuffer, "utf-8");
- }
- if (this._valueAsString === undefined) {
- this._valueAsString =
- typeof this._value === "string"
- ? this._value
- : this._value.toString("utf-8");
- }
- return streamChunksOfRawSource(
- this._valueAsString,
- onChunk,
- onSource,
- onName,
- !!(options && options.finalSource)
- );
- }
+ /**
+ * @param {object} options options
+ * @param {function(string, number, number, number, number, number, number): void} onChunk called for each chunk of code
+ * @param {function(number, string, string)} onSource called for each source
+ * @param {function(number, string)} onName called for each name
+ * @returns {void}
+ */
+ streamChunks(options, onChunk, onSource, onName) {
+ let strValue = this._valueAsString;
+ if (strValue === undefined) {
+ const value = this.source();
+ strValue = typeof value === "string" ? value : value.toString("utf-8");
+ if (isDualStringBufferCachingEnabled()) {
+ this._valueAsString = internString(strValue);
+ }
+ }
+ return streamChunksOfRawSource(
+ strValue,
+ onChunk,
+ onSource,
+ onName,
+ !!(options && options.finalSource)
+ );
+ }
- updateHash(hash) {
- if (this._valueAsBuffer === undefined) {
- this._valueAsBuffer = Buffer.from(this._value, "utf-8");
- }
- hash.update("RawSource");
- hash.update(this._valueAsBuffer);
- }
+ updateHash(hash) {
+ hash.update("RawSource");
+ hash.update(this.buffer());
+ }
}
module.exports = RawSource;
diff --git a/lib/helpers/stringBufferUtils.js b/lib/helpers/stringBufferUtils.js
new file mode 100644
index 0000000000000000000000000000000000000000..3d8b85e61643412796e12e2aac6905c5e3a8d5b9
--- /dev/null
+++ b/lib/helpers/stringBufferUtils.js
@@ -0,0 +1,120 @@
+/*
+ MIT License http://www.opensource.org/licenses/mit-license.php
+ Author Mark Knichel @mknichel
+*/
+
+"use strict";
+
+let dualStringBufferCaching = true;
+
+/**
+ * @returns {boolean} Whether the optimization to cache copies of both the
+ * string and buffer version of source content is enabled. This is enabled by
+ * default to improve performance but can consume more memory since values are
+ * stored twice.
+ */
+function isDualStringBufferCachingEnabled() {
+ return dualStringBufferCaching;
+}
+
+/**
+ * Enables an optimization to save both string and buffer in memory to avoid
+ * repeat conversions between the two formats when they are requested. This
+ * is enabled by default. This option can improve performance but can consume
+ * additional memory since values are stored twice.
+ *
+ * @returns {void}
+ */
+function enableDualStringBufferCaching() {
+ dualStringBufferCaching = true;
+}
+
+/**
+ * Disables the optimization to save both string and buffer in memory. This
+ * may increase performance but should reduce memory usage in the Webpack
+ * compiler.
+ *
+ * @returns {void}
+ */
+function disableDualStringBufferCaching() {
+ dualStringBufferCaching = false;
+}
+
+const interningStringMap = new Map();
+
+/**
+ * Saves the string in a map to ensure that only one copy of the string exists
+ * in memory at a given time. This is controlled by {@link enableStringInterning}
+ * and {@link disableStringInterning}. Callers are expect to manage the memory
+ * of the interned strings by calling {@link disableStringInterning} after the
+ * compiler no longer needs to save the interned memory.
+ *
+ * @param {string} str A string to be interned.
+ * @returns {string} The original string or a reference to an existing string
+ * of the same value if it has already been interned.
+ */
+function internString(str) {
+ if (
+ !isStringInterningEnabled() ||
+ !str ||
+ str.length < 128 ||
+ typeof str !== "string"
+ ) {
+ return str;
+ }
+ let internedString = interningStringMap.get(str);
+ if (internedString === undefined) {
+ internedString = str;
+ interningStringMap.set(str, internedString);
+ }
+ return internedString;
+}
+
+let enableStringInterningRefCount = 0;
+
+function isStringInterningEnabled() {
+ return enableStringInterningRefCount > 0;
+}
+
+/**
+ * Starts a memory optimization to avoid repeat copies of the same string in
+ * memory by caching a single reference to the string. This can reduce memory
+ * usage if the same string is repeated many times in the compiler, such as
+ * when Webpack layers are used with the same files.
+ *
+ * {@link exitStringInterningRange} should be called when string interning is
+ * no longer necessary to free up the memory used by the interned strings. If
+ * {@link enterStringInterningRange} has been called multiple times, then
+ * this method may not immediately free all the memory until
+ * {@link exitStringInterningRange} has been called to end all string
+ * interning ranges.
+ *
+ * @returns {void}
+ */
+function enterStringInterningRange() {
+ enableStringInterningRefCount++;
+}
+
+/**
+ * Stops the current string interning range. Once all string interning ranges
+ * have been exited, this method will free all the memory used by the interned
+ * strings. This method should be called once for each time that
+ * {@link enterStringInterningRange} was called.
+ *
+ * @returns {void}
+ */
+function exitStringInterningRange() {
+ if (--enableStringInterningRefCount <= 0) {
+ interningStringMap.clear();
+ enableStringInterningRefCount = 0;
+ }
+}
+
+module.exports = {
+ disableDualStringBufferCaching,
+ enableDualStringBufferCaching,
+ internString,
+ isDualStringBufferCachingEnabled,
+ enterStringInterningRange,
+ exitStringInterningRange,
+};
diff --git a/lib/index.js b/lib/index.js
index 0c11c2f4cf5387e249cf12fa0fcb746dfcfec539..9ca1b100d8250d4f3c41e5931f710efbbca21611 100644
--- a/lib/index.js
+++ b/lib/index.js
@@ -4,17 +4,17 @@
*/
const defineExport = (name, fn) => {
- let value;
- Object.defineProperty(exports, name, {
- get: () => {
- if (fn !== undefined) {
- value = fn();
- fn = undefined;
- }
- return value;
- },
- configurable: true
- });
+ let value;
+ Object.defineProperty(exports, name, {
+ get: () => {
+ if (fn !== undefined) {
+ value = fn();
+ fn = undefined;
+ }
+ return value;
+ },
+ configurable: true,
+ });
};
defineExport("Source", () => require("./Source"));
@@ -28,3 +28,4 @@ defineExport("ReplaceSource", () => require("./ReplaceSource"));
defineExport("PrefixSource", () => require("./PrefixSource"));
defineExport("SizeOnlySource", () => require("./SizeOnlySource"));
defineExport("CompatSource", () => require("./CompatSource"));
+defineExport("stringBufferUtils", () => require("./helpers/stringBufferUtils"));