forked from pmeenan/cf-workers
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathoptimization-pack.js
987 lines (905 loc) · 33.2 KB
/
optimization-pack.js
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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
// Enabled optimization features
ENABLE_PROXY_THIRD_PARTY = true;
ENABLE_GOOGLE_FONTS = true;
ENABLE_EDGE_CACHE = true;
// API settings if KV isn't being used for EDGE_CACHE (otherwise the EDGE_CACHE variable needs to be bound to a KV namespace for this worker)
const CLOUDFLARE_API = {
email: "", // From https://dash.cloudflare.com/profile
key: "", // Global API Key from https://dash.cloudflare.com/profile
zone: "" // "Zone ID" from the API section of the dashboard overview page https://dash.cloudflare.com/
};
/******************************************************************************
* Main control flow
*****************************************************************************/
/**
* Main worker entry point. Looks for font requests that are being proxied and
* requests for HTML content. All major browsers explicitly send an accept: text/html
* for navigational requests and the fallback is to just pass the request through
* unmodified (safe).
*/
addEventListener("fetch", event => {
// Fail-safe in case of an unhandled exception
event.passThroughOnException();
const url = new URL(event.request.url);
const bypass = url.searchParams.get('cf-worker') === 'bypass';
if (!bypass) {
if (event.request.method === 'GET' && isProxyRequest(url)) {
// Pass the requests through to the origin server
// (through the underlying request cache and filtering headers).
event.respondWith(proxyRequest('https:/' + url.pathname + url.search,
event.request));
} else if (event.request.method === 'GET' &&
url.pathname.startsWith('/fonts.googleapis.com/')) {
// Proxy the Google fonts stylesheet for pages using CSP
// (Separate because it rewrites the font URLs).
event.respondWith(proxyStylesheet('https:/' + url.pathname + url.search,
event.request));
} else {
event.respondWith(processRequest(event.request, event));
}
}
});
/******************************************************************************
* Application logic
*****************************************************************************/
// Third-party script URL prefixes to proxy and cache-extend
const SCRIPT_URLS = [
// Hosted libraries (usually CDN's for open source).
'/ajax.aspnetcdn.com/',
'/ajax.cloudflare.com/',
'/ajax.googleapis.com/',
'/cdn.jsdelivr.net/',
'/cdnjs.com/',
'/cdnjs.cloudflare.com/',
'/code.jquery.com/',
'/maxcdn.bootstrapcdn.com/',
'/netdna.bootstrapcdn.com/',
'/oss.maxcdn.com/',
'/stackpath.bootstrapcdn.com/',
// Popular scripts (can be site-specific)
'/a.optmnstr.com/app/js/',
'/cdn.onesignal.com/sdks/',
'/cdn.optimizely.com/',
'/cdn.polyfill.io/',
'/cdn.shopify.com/s/',
'/css3-mediaqueries-js.googlecode.com/svn/',
'/d2wy8f7a9ursnm.cloudfront.net/',
'/html5shim.googlecode.com/svn/',
'/html5shiv.googlecode.com/svn/',
'/maps.google.com/maps/api/js',
'/maps.googleapis.com/maps/api/js',
'/pagead2.googlesyndication.com/pagead/js/',
'/platform.twitter.com/widgets.js',
'/platform-api.sharethis.com/js/',
'/s7.addthis.com/js/',
'/stats.wp.com/',
'/ws.sharethis.com/button/',
'/www.google.com/recaptcha/api.js',
'/www.google-analytics.com/analytics.js',
'/www.googletagmanager.com/gtag/js',
'/www.googletagmanager.com/gtm.js',
'/www.googletagservices.com/tag/js/gpt.js'
];
/**
* Process chunks of HTML as they stream through
*
* @param {*} content - Text chunk from the streaming HTML (or accumulated head)
* @param {*} request - Original request object for downstream use.
* @param {*} event - Worker event object
* @param {bool} cspRules - Content-Security-Policy rules
*/
async function modifyHtmlResponse(content, request, event, cspRules) {
// Call out to the individual optimizations
if (ENABLE_GOOGLE_FONTS)
content = await optimizeGoogleFonts(content, request, event, cspRules);
if (ENABLE_PROXY_THIRD_PARTY)
content = await proxyScripts(content, request);
return content;
}
/**
* See if the requested resource is a proxy request to an overwritten origin
* (something that starts with a prefix in one of our lists).
*
* @param {*} url - Requested URL
* @param {*} request - Original Request
* @returns {*} - true if the URL matches one of the proxy paths
*/
function isProxyRequest(url) {
let needsProxy = false;
if (ENABLE_GOOGLE_FONTS && url.pathname.startsWith('/fonts.gstatic.com/')) {
needsProxy = true;
} else if (ENABLE_PROXY_THIRD_PARTY) {
const path = url.pathname + url.search;
for (let prefix of SCRIPT_URLS) {
if (path.startsWith(prefix)) {
needsProxy = true;
break;
}
}
}
return needsProxy;
}
/**
* Handle all non-proxied requests. Send HTML or CSS on for further processing
* and pass everything else through unmodified.
* @param {*} request - Original request
* @param {*} event - Original worker event
*/
async function processRequest(request, event) {
let response = null;
if (isEdgeCacheEnabled(request)) {
response = await edgeCacheFetch(request, event);
} else {
response = await fetch(request);
}
if (response && response.status === 200) {
const contentType = response.headers.get("content-type");
if ((ENABLE_GOOGLE_FONTS || ENABLE_PROXY_THIRD_PARTY) && contentType && contentType.indexOf("text/html") !== -1) {
return await processHtmlResponse(response, event.request, event);
} else if (ENABLE_GOOGLE_FONTS && contentType && contentType.indexOf("text/css") !== -1) {
return await processStylesheetResponse(response, event.request, event);
}
}
return response;
}
/******************************************************************************
* HTML Edge Cache
*****************************************************************************/
/**
* See if the edge cache is enabled and should be used
* @param {Request} request - Original request
* @returns {bool} true if edge caching is enabled
*/
function isEdgeCacheEnabled(request) {
let enabled = ENABLE_EDGE_CACHE;
// Disable if there is a cache in front of us
if (request.headers.get('x-HTML-Edge-Cache') !== null) {
return false;
}
// Disable if KV isn't enabled or if the API key isn't configured
if (typeof EDGE_CACHE !== 'undefined') {
return enabled;
}
if (CLOUDFLARE_API.email.length && CLOUDFLARE_API.key.length && CLOUDFLARE_API.zone.length) {
return enabled;
}
return false;
}
/**
* Fetch from the edge cache if available. If not, fetch from the origin and cache if requested.
* @param {Request} originalRequest - Original request
* @param {Event} event - original event
*/
async function edgeCacheFetch(originalRequest, event) {
let {response, cacheVer, status, bypassCache} = await getEdgeCachedResponse(originalRequest);
if (response === null) {
// Clone the request, add the edge-cache header and send it through.
let request = new Request(originalRequest);
request.headers.set('x-HTML-Edge-Cache', 'supports=cache|purgeall|bypass-cookies');
response = await fetch(request);
if (response) {
const options = getEdgeCacheResponseOptions(response);
if (options.purge) {
await purgeEdgeCache(cacheVer, event);
status += ', Purged';
}
if (options.cache && !bypassCache) {
status += await cacheEdgeResponse(cacheVer, originalRequest, response, event);
}
}
}
const accept = originalRequest.headers.get('Accept');
if (response && status !== null && originalRequest.method === 'GET' && response.status === 200 && accept && accept.indexOf('text/html') >= 0) {
response = new Response(response.body, response);
response.headers.set('x-HTML-Edge-Cache-Status', status);
if (cacheVer !== null) {
response.headers.set('x-HTML-Edge-Cache-Version', cacheVer.toString());
}
}
return response;
}
const CACHE_HEADERS = ['Cache-Control', 'Expires', 'Pragma'];
/**
* Check for cached HTML GET requests.
*
* @param {Request} request - Original request
*/
async function getEdgeCachedResponse(request) {
let response = null;
let cacheVer = null;
let bypassCache = false;
let status = 'Miss';
// Only check for HTML GET requests (saves on reading from KV unnecessarily)
// and not when there are cache-control headers on the request (refresh)
const accept = request.headers.get('Accept');
const cacheControl = request.headers.get('Cache-Control');
if (cacheControl === null && request.method === 'GET' && accept && accept.indexOf('text/html') >= 0) {
// Build the versioned URL for checking the cache
cacheVer = await GetCurrentEdgeCacheVersion(cacheVer);
const cacheKeyRequest = GenerateEdgeCacheRequest(request, cacheVer);
// See if there is a request match in the cache
try {
let cache = caches.default;
let cachedResponse = await cache.match(cacheKeyRequest);
if (cachedResponse) {
// Copy Response object so that we can edit headers.
cachedResponse = new Response(cachedResponse.body, cachedResponse);
// Check to see if the response needs to be skipped for a login cookie.
const options = getEdgeCacheResponseOptions(cachedResponse);
const cookieHeader = request.headers.get('cookie');
if (cookieHeader && cookieHeader.length && options.bypassCookies.length) {
const cookies = cookieHeader.split(';');
for (let cookie of cookies) {
// See if the cookie starts with any of the logged-in user prefixes
for (let prefix of options.bypassCookies) {
if (cookie.trim().startsWith(prefix)) {
bypassCache = true;
break;
}
}
if (bypassCache) {
break;
}
}
}
// Copy the original cache headers back and clean up any control headers
if (bypassCache) {
status = 'Bypass Cookie';
} else {
status = 'Hit';
response = cachedResponse;
response.headers.delete('x-HTML-Edge-Cache');
response.headers.delete('Cache-Control');
for (header of CACHE_HEADERS) {
let value = response.headers.get('x-HTML-Edge-Cache-' + header);
if (value) {
response.headers.delete('x-HTML-Edge-Cache-' + header);
response.headers.set(header, value);
}
}
}
} else {
status = 'Miss';
}
} catch (err) {
// Send the exception back in the response header for debugging
status = "Cache Read Exception: " + err.message;
}
}
return {response, cacheVer, status, bypassCache};
}
/**
* Asynchronously purge the HTML cache.
* @param {Int} cacheVer - Current cache version (if retrieved)
* @param {Event} event - Original event
*/
async function purgeEdgeCache(cacheVer, event) {
if (typeof EDGE_CACHE !== 'undefined') {
// Purge the KV cache by bumping the version number
cacheVer = await GetCurrentEdgeCacheVersion(cacheVer);
cacheVer++;
event.waitUntil(EDGE_CACHE.put('html_cache_version', cacheVer.toString()));
} else {
// Purge everything using the API
const url = "https://api.cloudflare.com/client/v4/zones/" + CLOUDFLARE_API.zone + "/purge_cache";
event.waitUntil(fetch(url,{
method: 'POST',
headers: {'X-Auth-Email': CLOUDFLARE_API.email,
'X-Auth-Key': CLOUDFLARE_API.key,
'Content-Type': 'application/json'},
body: JSON.stringify({purge_everything: true})
}));
}
}
/**
* Cache the returned content (but only if it was a successful GET request)
*
* @param {Int} cacheVer - Current cache version (if already retrieved)
* @param {Request} request - Original Request
* @param {Response} originalResponse - Response to (maybe) cache
* @param {Event} event - Original event
* @returns {bool} true if the response was cached
*/
async function cacheEdgeResponse(cacheVer, request, originalResponse, event) {
let status = "";
const accept = request.headers.get('Accept');
if (request.method === 'GET' && originalResponse.status === 200 && accept && accept.indexOf('text/html') >= 0) {
cacheVer = await GetCurrentEdgeCacheVersion(cacheVer);
const cacheKeyRequest = GenerateEdgeCacheRequest(request, cacheVer);
try {
// Move the cache headers out of the way so the response can actually be cached.
// First clone the response so there is a parallel body stream and then
// create a new response object based on the clone that we can edit.
let cache = caches.default;
let clonedResponse = originalResponse.clone();
let response = new Response(clonedResponse.body, clonedResponse);
for (header of CACHE_HEADERS) {
let value = response.headers.get(header);
if (value) {
response.headers.delete(header);
response.headers.set('x-HTML-Edge-Cache-' + header, value);
}
}
response.headers.delete('Set-Cookie');
response.headers.set('Cache-Control', 'public; max-age=315360000');
event.waitUntil(cache.put(cacheKeyRequest, response));
status = ", Cached";
} catch (err) {
// Send the exception back in the response header for debugging
status = ", Cache Write Exception: " + err.message;
}
}
return status;
}
/**
* Parse the commands from the x-HTML-Edge-Cache response header.
* @param {Response} response - HTTP response from the origin.
* @returns {*} Parsed commands
*/
function getEdgeCacheResponseOptions(response) {
let options = {
purge: false,
cache: false,
bypassCookies: []
};
let header = response.headers.get('x-HTML-Edge-Cache');
if (header) {
let commands = header.split(',');
for (let command of commands) {
if (command.trim() === 'purgeall') {
options.purge = true;
} else if (command.trim() === 'cache') {
options.cache = true;
} else if (command.trim().startsWith('bypass-cookies')) {
let separator = command.indexOf('=');
if (separator >= 0) {
let cookies = command.substr(separator + 1).split('|');
for (let cookie of cookies) {
cookie = cookie.trim();
if (cookie.length) {
options.bypassCookies.push(cookie);
}
}
}
}
}
}
return options;
}
/**
* Retrieve the current cache version from KV
* @param {Int} cacheVer - Current cache version value if set.
* @returns {Int} The current cache version.
*/
async function GetCurrentEdgeCacheVersion(cacheVer) {
if (cacheVer === null) {
if (typeof EDGE_CACHE !== 'undefined') {
cacheVer = await EDGE_CACHE.get('html_cache_version');
if (cacheVer === null) {
// Uninitialized - first time through, initialize KV with a value
// Blocking but should only happen immediately after worker activation.
cacheVer = 0;
await EDGE_CACHE.put('html_cache_version', cacheVer.toString());
} else {
cacheVer = parseInt(cacheVer);
}
} else {
cacheVer = -1;
}
}
return cacheVer;
}
/**
* Generate the versioned Request object to use for cache operations.
* @param {Request} request - Base request
* @param {Int} cacheVer - Current Cache version (must be set)
* @returns {Request} Versioned request object
*/
function GenerateEdgeCacheRequest(request, cacheVer) {
let cacheUrl = request.url;
if (cacheUrl.indexOf('?') >= 0) {
cacheUrl += '&';
} else {
cacheUrl += '?';
}
cacheUrl += 'cf_edge_cache_ver=' + cacheVer;
return new Request(cacheUrl);
}
/******************************************************************************
* Proxy static 3rd-party scripts
*****************************************************************************/
/**
* Change proxy well-known 3rd-party scripts through our origin
* @param {*} content - Text chunk from the streaming HTML
* @param {*} request - Original request object for downstream use.
*/
async function proxyScripts(content, request) {
// Regex patterns for matching script tags
const SCRIPT_PRE = '<\\s*script[^>]+src\\s*=\\s*[\'"]\\s*((https?:)?/';
const PATTERN_POST = '[^\'" ]+)\\s*["\'][^>]*>';
// build the list of url patterns we are going to look for.
let patterns = [];
for (let scriptUrl of SCRIPT_URLS) {
let regex = new RegExp(SCRIPT_PRE + scriptUrl + PATTERN_POST, 'gi');
patterns.push(regex);
}
// Rewrite the script URLs
const pageUrl = new URL(request.url);
for (let pattern of patterns) {
let match = pattern.exec(content);
while (match !== null) {
const originalUrl = match[1];
let fetchUrl = originalUrl;
if (fetchUrl.startsWith('//')) {
fetchUrl = pageUrl.protocol + fetchUrl;
}
const proxyUrl = await hashContent(originalUrl, fetchUrl, request);
if (proxyUrl !== null) {
content = content.split(originalUrl).join(proxyUrl);
}
match = pattern.exec(content);
}
}
return content;
}
/**
* Generate the proxy URL given the content hash and base URL
* @param {*} originalUrl - Original URL
* @param {*} hash - Hash of content
* @returns {*} - URL with content hash appended
*/
function constructProxyUrl(originalUrl, hash) {
let proxyUrl = null;
let pathStart = originalUrl.indexOf('//');
if (pathStart >= 0) {
proxyUrl = originalUrl.substring(pathStart + 1);
if (proxyUrl.indexOf('?') >= 0) {
proxyUrl += '&';
} else {
proxyUrl += '?';
}
proxyUrl += 'cf_hash=' + hash;
}
return proxyUrl;
}
/**
* Fetch the original content and return a hash of the result (for detecting changes).
* Use a local cache because some scripts use cache-control: private to prevent
* proxies from caching.
*
* @param {*} originalUrl - Unmodified URL
* @param {*} url - URL for the third-party request
* @param {*} request - Original request for the page HTML so the user-agent can be passed through
* @param {*} event - Worker event object.
*/
async function hashContent(originalUrl, url, request) {
let proxyUrl = null;
let hash = null;
const userAgent = request.headers.get('user-agent');
const clientAddr = request.headers.get('cf-connecting-ip');
const hashCacheKey = new Request(url + "cf-hash-key");
let cache = null;
let foundInCache = false;
// Try pulling it from the cache API (wrap it in case it's not implemented)
try {
cache = caches.default;
let response = await cache.match(hashCacheKey);
if (response) {
hash = await response.text();
proxyUrl = constructProxyUrl(originalUrl, hash);
foundInCache = true;
}
} catch(e) {
// Ignore the exception
}
if (!foundInCache) {
try {
let headers = {'Referer': request.url,
'User-Agent': userAgent};
if (clientAddr) {
headers['X-Forwarded-For'] = clientAddr;
}
const response = await fetch(url, {headers: headers});
let content = await response.arrayBuffer();
if (content) {
const hashBuffer = await crypto.subtle.digest('SHA-1', content);
hash = hex(hashBuffer);
proxyUrl = constructProxyUrl(originalUrl, hash);
// Add the hash to the local cache
try {
if (cache) {
let ttl = 60;
const cacheControl = response.headers.get('cache-control');
const maxAgeRegex = /max-age\s*=\s*(\d+)/i;
const match = maxAgeRegex.exec(cacheControl);
if (match) {
ttl = parseInt(match[1], 10);
}
const hashCacheResponse = new Response(hash, {ttl: ttl});
cache.put(hashCacheKey, hashCacheResponse);
}
} catch(e) {
// Ignore the exception
}
}
} catch(e) {
// Ignore the exception
}
}
return proxyUrl;
}
/**
* Convert a buffer into a hex string (for hashes).
* From: https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/digest
* @param {*} buffer - Binary buffer
* @returns {*} - Hex string of the binary buffer
*/
function hex(buffer) {
var hexCodes = [];
var view = new DataView(buffer);
for (var i = 0; i < view.byteLength; i += 4) {
var value = view.getUint32(i);
var stringValue = value.toString(16);
var padding = '00000000';
var paddedValue = (padding + stringValue).slice(-padding.length);
hexCodes.push(paddedValue);
}
return hexCodes.join("");
}
/******************************************************************************
* Optimizing Google Fonts
*****************************************************************************/
/**
* Identify any <link> tags that pull ing Google font css and inline the css file.
*
* @param {*} content - Text chunk from the streaming HTML (or accumulated head)
* @param {*} request - Original request object for downstream use.
* @param {*} event - Worker event object
* @param {bool} cspRules - Content-Security-Policy rules
*/
async function optimizeGoogleFonts(content, request, event, cspRules) {
if (!('style' in cspRules) || cspRules['style'].indexOf("'self'") >= 0) {
// Fully tokenizing and parsing the HTML is expensive. This regex is much faster and should be reasonably safe.
// It looks for Stylesheet links for the Google fonts css and extracts the URL as match #1. It shouldn't match
// in-text content because the < > brackets would be escaped in the HTML. There is some potential risk of
// matching it in an inline script (unlikely but possible).
const fontCSSRegex = /<link\s+[^>]*href\s*=\s*['"]((https?:)?\/\/fonts.googleapis.com\/css[^'"]+)[^>]*>/mgi;
let match = fontCSSRegex.exec(content);
while (match !== null) {
const matchString = match[0];
if (matchString.indexOf('stylesheet') >= 0) {
if (!('style' in cspRules)) {
const fontCSS = await fetchGoogleFontsCSS(match[1], request, event);
if (fontCSS.length) {
// See if there is a media type on the link tag
let mediaStr = '';
const mediaMatch = matchString.match(/media\s*=\s*['"][^'"]*['"]/mig);
if (mediaMatch) {
mediaStr = ' ' + mediaMatch[0];
}
// Replace the actual css
let cssString = "<style" + mediaStr + ">\n";
cssString += fontCSS;
cssString += "\n</style>\n";
content = content.split(matchString).join(cssString);
}
} else {
// Rewrite the URL to proxy it through the origin
let originalUrl = match[1];
let startPos = originalUrl.indexOf('/fonts.googleapis.com');
let newUrl = originalUrl.substr(startPos);
let newString = matchString.split(originalUrl).join(newUrl);
content = content.split(matchString).join(newString);
}
match = fontCSSRegex.exec(content);
}
}
}
return content;
}
/**
* Handle the processing of stylesheets (that might have a @import)
*
* @param {*} response - The stylesheet response
* @param {*} request - The original request
* @param {*} event - The original worker event
*/
async function processStylesheetResponse(response, request, event) {
let body = response.body;
try {
body = await response.text();
const fontCSSRegex = /@import\s*(url\s*)?[\('"\s]+((https?:)?\/\/fonts.googleapis.com\/css[^'"\)]+)[\s'"\)]+\s*;/mgi;
let match = fontCSSRegex.exec(body);
while (match !== null) {
const matchString = match[0];
const fontCSS = await fetchGoogleFontsCSS(match[2], request, event);
if (fontCSS.length) {
body = body.split(matchString).join(fontCSS);
}
match = fontCSSRegex.exec(body);
}
} catch (e) {
// Ignore the exception, the original body will be passed through.
}
// Return a cloned response with the (possibly modified) body.
// We can't just return the original response since we already
// consumed the body.
const newResponse = new Response(body, response);
return newResponse;
}
/**
* Handle a proxied stylesheet request.
*
* @param {*} url The URL to proxy
* @param {*} request The original request (to copy parameters from)
*/
async function proxyStylesheet(url, request) {
let css = await fetchGoogleFontsCSS(url, request)
if (css) {
const responseInit = {headers: {
"Content-Type": "text/css; charset=utf-8",
"Cache-Control": "private, max-age=86400, stale-while-revalidate=604800"
}};
const newResponse = new Response(css, responseInit);
return newResponse;
} else {
// Do a straight-through proxy as fallback
return proxyRequest(url, request);
}
}
/**
* Fetch the font css from Google using the same browser user-agent string to make sure the
* correct CSS is returned and rewrite the font URLs to proxy them through the worker (on
* the same origin to avoid a new connection).
*
* @param {*} url - URL for the Google font css.
* @param {*} request - Original request for the page HTML so the user-agent can be passed through
* and the origin can be used for rewriting the font paths.
* @param {*} event - Worker event object
*/
async function fetchGoogleFontsCSS(url, request) {
let fontCSS = "";
if (url.startsWith('/'))
url = 'https:' + url;
const userAgent = request.headers.get('user-agent');
const clientAddr = request.headers.get('cf-connecting-ip');
const browser = getCacheKey(userAgent);
const cacheKey = browser ? url + '&' + browser : url;
const cacheKeyRequest = new Request(cacheKey);
let cache = null;
let foundInCache = false;
// Try pulling it from the cache API (wrap it in case it's not implemented)
try {
cache = caches.default;
let response = await cache.match(cacheKeyRequest);
if (response) {
fontCSS = response.text();
foundInCache = true;
}
} catch(e) {
// Ignore the exception
}
if (!foundInCache) {
let headers = {'Referer': request.url};
if (browser) {
headers['User-Agent'] = userAgent;
} else {
headers['User-Agent'] = "Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.0; Trident/4.0)";
}
if (clientAddr) {
headers['X-Forwarded-For'] = clientAddr;
}
try {
const response = await fetch(url, {headers: headers});
if (response && response.status === 200) {
fontCSS = await response.text();
// Rewrite all of the font URLs to come through the worker
fontCSS = fontCSS.replace(/(https?:)?\/\/fonts\.gstatic\.com\//mgi, '/fonts.gstatic.com/');
// Add the css info to the font cache
try {
if (cache) {
const cacheResponse = new Response(fontCSS, {ttl: 86400});
event.waitUntil(cache.put(cacheKeyRequest, cacheResponse));
}
} catch(e) {
// Ignore the exception
}
}
} catch(e) {
// Ignore the exception
}
}
return fontCSS;
}
/**
* Identify the common browsers (and versions) for using browser-specific css.
* Others will use a common fallback css fetched without a user agent string (ttf).
*
* @param {*} userAgent - Browser user agent string
* @returns {*} A browser-version-specific string like Chrome61
*/
function getCacheKey(userAgent) {
let os = '';
const osRegex = /^[^(]*\(\s*(\w+)/mgi;
let match = osRegex.exec(userAgent);
if (match) {
os = match[1];
}
let mobile = '';
if (userAgent.match(/Mobile/mgi)) {
mobile = 'Mobile';
}
// Detect Edge first since it includes Chrome and Safari
const edgeRegex = /\s+Edge\/(\d+)/mgi;
match = edgeRegex.exec(userAgent);
if (match) {
return 'Edge' + match[1] + os + mobile;
}
// Detect Chrome next (and browsers using the Chrome UA/engine)
const chromeRegex = /\s+Chrome\/(\d+)/mgi;
match = chromeRegex.exec(userAgent);
if (match) {
return 'Chrome' + match[1] + os + mobile;
}
// Detect Safari and Webview next
const webkitRegex = /\s+AppleWebKit\/(\d+)/mgi;
match = webkitRegex.exec(userAgent.match);
if (match) {
return 'WebKit' + match[1] + os + mobile;
}
// Detect Firefox
const firefoxRegex = /\s+Firefox\/(\d+)/mgi;
match = firefoxRegex.exec(userAgent);
if (match) {
return 'Firefox' + match[1] + os + mobile;
}
return null;
}
/******************************************************************************
* Support routines and general streaming parse plumbing.
*****************************************************************************/
// Workers can only decode utf-8 so keep a list of character encodings that can be decoded.
const VALID_CHARSETS = ['utf-8', 'utf8', 'iso-8859-1', 'us-ascii'];
/**
* Generate a new request based on the original. Filter the request
* headers to prevent leaking user data (cookies, etc) and filter
* the response headers to prevent the origin setting policy on
* our origin.
*
* @param {*} url The URL to proxy
* @param {*} request The original request (to copy parameters from)
*/
async function proxyRequest(url, request) {
let init = {
method: request.method,
headers: {}
};
// see if it is a cache-extended hashed URL
let extendCache = false;
const hashOffset = url.indexOf('cf_hash=');
if (hashOffset >= 2) {
url = url.substring(0, hashOffset - 1);
extendCache = true;
}
// Only pass through a subset of headers
const proxyHeaders = ["Accept",
"Accept-Encoding",
"Accept-Language",
"Referer",
"User-Agent"];
for (let name of proxyHeaders) {
let value = request.headers.get(name);
if (value) {
init.headers[name] = value;
}
}
// Add an X-Forwarded-For with the client IP
const clientAddr = request.headers.get('cf-connecting-ip');
if (clientAddr) {
init.headers['X-Forwarded-For'] = clientAddr;
}
const response = await fetch(url, init);
if (response) {
const responseHeaders = ["Content-Type",
"Cache-Control",
"Expires",
"Accept-Ranges",
"Date",
"Last-Modified",
"ETag"];
// Only include a strict subset of response headers
let responseInit = {status: response.status,
statusText: response.statusText,
headers: {}};
for (let name of responseHeaders) {
let value = response.headers.get(name);
if (value) {
responseInit.headers[name] = value;
}
}
if (response.status === 200 && extendCache) {
responseInit.headers['Cache-Control'] = 'private; max-age=315360000';
}
// Add a little bit of protection to the proxied content type
responseInit.headers['X-Content-Type-Options'] = "nosniff";
const newResponse = new Response(response.body, responseInit);
return newResponse;
}
return response;
}
/**
* Handle all of the processing for a (likely) HTML request.
* - Pass through the request to the origin and inspect the response.
* - If the response is HTML set up a streaming transform and pass it on to modifyHtmlStream for processing
*
* Extra care needs to be taken to make sure the character encoding from the original
* HTML is extracted and converted to utf-8 and that the downstream response is identified
* as utf-8.
*
* @param {*} response The original response
* @param {*} request The original request
* @param {*} event worker event object
*/
async function processHtmlResponse(response, request, event) {
// Workers can only decode utf-8. If it is anything else, pass the
// response through unmodified
const contentType = response.headers.get("content-type");
const charsetRegex = /charset\s*=\s*([^\s;]+)/mgi;
const match = charsetRegex.exec(contentType);
if (match !== null) {
let charset = match[1].toLowerCase();
if (!VALID_CHARSETS.includes(charset)) {
return response;
}
}
// See if the stylesheet should be embedded or proxied.
// CSP blocks embedded CSS by default so fall back to proxying
// the stylesheet through the origin.
//
// Note: only 'self' and 'unsafe-inline' CSP rules for style-src
// are recognized. If explicit URLs are used instead then the
// HTML will not be modified.
let cspRules = {};
let csp = response.headers.get("Content-Security-Policy");
if (csp) {
// Get the style policy that will be applied to the document
let cspRule = null;
const styleRegex = /style-src[^;]*/gmi;
let match = styleRegex.exec(csp);
if (match !== null) {
cspRule = match[0];
} else {
const defaultRegex = /default-src[^;]*/gmi;
let match = defaultRegex.exec(csp);
if (match !== null) {
cspRule = match[0];
}
}
if (cspRule !== null) {
if (cspRule.indexOf("'unsafe-inline'") >= 0) {
// Do nothing. This is the same as not using CSP for styles.
} else if (cspRule.indexOf("'self'") >= 0) {
cspRules['style'] = cspRule;
} else {
cspRules['style'] = cspRule;
}
}
}
let contentArray = await response.arrayBuffer();
let content = null;
try {
let decoder = new TextDecoder("utf-8", {fatal: true});
content = decoder.decode(contentArray);
content = await modifyHtmlResponse(content, request, event, cspRules);
} catch (e) {
// Ignore the exception
}
if (content !== null) {
// Send back the modified response
const newResponse = new Response(content, response);
return newResponse;
}
// Pass the original response unmodified (decode error)
const newResponse = new Response(contentArray, response);
return newResponse;
}