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 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
|
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */
// Note to run this test similar to try server, you need to run:
// ./mach package
// ./mach mochitest --appname dist <path to test>
// Slow on asan builds.
requestLongerTimeout(5);
var isDevtools = SimpleTest.harnessParameters.subsuite == "devtools";
// This list should contain only path prefixes. It is meant to stop the test
// from reporting things that *are* referenced, but for which the test can't
// find any reference because the URIs are constructed programatically.
// If you need to allowlist specific files, please use the 'allowlist' object.
var gExceptionPaths = [
"resource://app/defaults/settings/blocklists/",
"resource://app/defaults/settings/security-state/",
"resource://app/defaults/settings/main/",
"resource://app/defaults/preferences/",
"resource://gre/modules/commonjs/",
"resource://gre/defaults/pref/",
// These chrome resources are referenced using relative paths from JS files.
"chrome://global/content/certviewer/components/",
// https://github.com/mozilla/activity-stream/issues/3053
"chrome://activity-stream/content/data/content/tippytop/images/",
"chrome://activity-stream/content/data/content/tippytop/favicons/",
// These resources are referenced by messages delivered through Remote Settings
"chrome://activity-stream/content/data/content/assets/mobile-download-qr-new-user-cn.svg",
"chrome://activity-stream/content/data/content/assets/mobile-download-qr-existing-user-cn.svg",
"chrome://activity-stream/content/data/content/assets/mr-amo-collection.svg",
"chrome://activity-stream/content/data/content/assets/person-typing.svg",
"chrome://activity-stream/content/data/content/assets/tabs-side-zap-transparent.svg",
"chrome://activity-stream/content/data/content/assets/tabs-top-zap-transparent.svg",
"chrome://activity-stream/content/data/content/assets/nuo-taborientation.svg",
"chrome://activity-stream/content/data/content/assets/euo-tab-orientation.svg",
"chrome://activity-stream/content/data/content/assets/euo-chatbot.svg",
"chrome://browser/content/assets/moz-vpn.svg",
"chrome://browser/content/assets/vpn-logo.svg",
"chrome://browser/content/assets/focus-promo.png",
"chrome://browser/content/assets/klar-qr-code.svg",
"chrome://browser/content/asrouter/assets/fox-with-box-on-cloud.svg",
"chrome://browser/content/asrouter/assets/fox-with-devices.svg",
"chrome://browser/content/asrouter/assets/fox-with-locked-box.svg",
"chrome://browser/content/asrouter/assets/fox-with-mobile.svg",
// toolkit/components/pdfjs/content/build/pdf.js
"resource://pdf.js/web/images/",
// This file is only loaded in using a dynamic import in pdf.js in case wasm
// is not available.
"resource://pdf.js/web/wasm/openjpeg_nowasm_fallback.js",
// Exclude the form autofill path that has been moved out of the extensions to
// toolkit, see bug 1691821.
"resource://gre-resources/autofill/",
// Localization file added programatically in FormAutofillUtils.sys.mjs
"resource://gre/localization/en-US/toolkit/formautofill",
// Exclude all search-extensions because they aren't referenced by filename
"resource://search-extensions/",
// Exclude all services-automation because they are used through webdriver
"resource://gre/modules/services-automation/",
// Paths from this folder are constructed in NetErrorParent.sys.mjs based on
// the type of cert or net error the user is encountering.
"chrome://global/content/neterror/supportpages/",
// Points to theme preview images, which are defined in browser/ but only used
// in toolkit/mozapps/extensions/content/aboutaddons.js.
"resource://usercontext-content/builtin-themes/",
// Page data schemas are referenced programmatically.
"chrome://browser/content/pagedata/schemas/",
// Nimbus schemas are referenced programmatically.
"resource://nimbus/schemas/",
// Normandy schemas are referenced programmatically.
"resource://normandy/schemas/",
// ASRouter schemas are referenced programmatically.
"chrome://browser/content/asrouter/schemas/",
// Localization file added programatically in FeatureCallout.sys.mjs
"resource://app/localization/en-US/browser/featureCallout.ftl",
// Localization file added programatically in ContentAnalysis.sys.mjs
"resource://gre/localization/en-US/toolkit/contentanalysis/",
// CSS files are referenced inside JS in an html template
"chrome://browser/content/aboutlogins/components/",
// Strip on Share parameter lists
"chrome://global/content/antitracking/",
// CSS file is referenced inside JS in login-form.mjs
"chrome://global/content/megalist/LoginFormComponent/",
// The ONNX runtime picks files to run programmaticaly
"chrome://global/content/ml/",
// The profile avatars are directly referenced.
"chrome://browser/content/profiles/assets/",
// The picture-in-picture add-on.
"resource://builtin-addons/pictureinpicture/",
// The formautofill add-on.
"resource://builtin-addons/formautofill/",
// The webcompat add-on.
"resource://builtin-addons/webcompat/",
// The newtab add-on
"resource://builtin-addons/newtab/",
"resource://newtab/",
"chrome://newtab/",
];
// These are not part of the omni.ja file, so we find them only when running
// the test on a non-packaged build.
if (AppConstants.platform == "macosx") {
gExceptionPaths.push("resource://gre/res/cursors/");
gExceptionPaths.push("resource://gre/res/touchbar/");
}
if (AppConstants.MOZ_BACKGROUNDTASKS) {
// These preferences are active only when we're in background task mode.
gExceptionPaths.push("resource://gre/defaults/backgroundtasks/");
gExceptionPaths.push("resource://app/defaults/backgroundtasks/");
// `BackgroundTask_*.sys.mjs` are loaded at runtime by `app --backgroundtask id ...`.
gExceptionPaths.push("resource://gre/modules/backgroundtasks/");
gExceptionPaths.push("resource://app/modules/backgroundtasks/");
}
// Each allowlist entry should have a comment indicating which file is
// referencing the listed file in a way that the test can't detect, or a
// bug number to remove or use the file if it is indeed currently unreferenced.
var allowlist = [
// security/manager/pki/resources/content/device_manager.js
{ file: "chrome://pippki/content/load_device.xhtml" },
// Intentionally unreferenced, see bug 1941134
{ file: "resource://gre/res/designmode.css" },
{ file: "resource://gre/res/EditorOverride.css" },
// The l10n build system can't package string files only for some platforms.
// See bug 1339424 for why this is hard to fix.
{
file: "chrome://global/locale/fallbackMenubar.properties",
platforms: ["linux", "win"],
},
{
file: "resource://gre/localization/en-US/toolkit/printing/printDialogs.ftl",
platforms: ["linux", "macosx"],
},
// This file is referenced by the build system to generate the
// Firefox .desktop entry. See bug 1824327 (and perhaps bug 1526672)
{
file: "resource://app/localization/en-US/browser/linuxDesktopEntry.ftl",
},
// devtools/client/inspector/bin/dev-server.js
{
file: "chrome://devtools/content/inspector/markup/markup.xhtml",
isFromDevTools: true,
},
// used by devtools/client/memory/index.xhtml
{ file: "chrome://global/content/third_party/d3/d3.js" },
// SpiderMonkey parser API, currently unused in browser/ and toolkit/
{ file: "resource://gre/modules/reflect.sys.mjs" },
// extensions/pref/autoconfig/src/nsReadConfig.cpp
{ file: "resource://gre/defaults/autoconfig/prefcalls.js" },
// browser/components/preferences/moreFromMozilla.js
// These files URLs are constructed programatically at run time.
{
file: "chrome://browser/content/preferences/more-from-mozilla-qr-code-simple.svg",
},
{
file: "chrome://browser/content/preferences/more-from-mozilla-qr-code-simple-cn.svg",
},
{ file: "resource://gre/greprefs.js" },
// layout/mathml/nsMathMLChar.cpp
{ file: "resource://gre/res/fonts/mathfontSTIXGeneral.properties" },
{ file: "resource://gre/res/fonts/mathfontUnicode.properties" },
// toolkit/mozapps/extensions/AddonContentPolicy.cpp
{ file: "resource://gre/localization/en-US/toolkit/global/cspErrors.ftl" },
// toolkit/components/antitracking/bouncetrackingprotection/BounceTrackingProtection.cpp
{ file: "resource://gre/localization/en-US/toolkit/global/antiTracking.ftl" },
// The l10n build system can't package string files only for some platforms.
{
file: "resource://gre/chrome/en-US/locale/en-US/global-platform/mac/accessible.properties",
platforms: ["linux", "win"],
},
{
file: "resource://gre/chrome/en-US/locale/en-US/global-platform/mac/intl.properties",
platforms: ["linux", "win"],
},
{
file: "resource://gre/chrome/en-US/locale/en-US/global-platform/mac/platformKeys.properties",
platforms: ["linux", "win"],
},
{
file: "resource://gre/chrome/en-US/locale/en-US/global-platform/unix/accessible.properties",
platforms: ["macosx", "win"],
},
{
file: "resource://gre/chrome/en-US/locale/en-US/global-platform/unix/intl.properties",
platforms: ["macosx", "win"],
},
{
file: "resource://gre/chrome/en-US/locale/en-US/global-platform/unix/platformKeys.properties",
platforms: ["macosx", "win"],
},
{
file: "resource://gre/chrome/en-US/locale/en-US/global-platform/win/accessible.properties",
platforms: ["linux", "macosx"],
},
{
file: "resource://gre/chrome/en-US/locale/en-US/global-platform/win/intl.properties",
platforms: ["linux", "macosx"],
},
{
file: "resource://gre/chrome/en-US/locale/en-US/global-platform/win/platformKeys.properties",
platforms: ["linux", "macosx"],
},
// Files from upstream library
{ file: "resource://pdf.js/web/debugger.mjs" },
{ file: "resource://pdf.js/web/debugger.css" },
// Starting from here, files in the allowlist are bugs that need fixing.
// Bug 1339424 (wontfix?)
{
file: "chrome://browser/locale/taskbar.properties",
platforms: ["linux", "macosx"],
},
// Bug 1344267
{ file: "chrome://remote/content/marionette/test_dialog.properties" },
{ file: "chrome://remote/content/marionette/test_dialog.xhtml" },
{ file: "chrome://remote/content/marionette/test_xul.xhtml" },
{ file: "chrome://remote/content/marionette/test.xhtml" },
// Bug 1348559
{ file: "chrome://pippki/content/resetpassword.xhtml" },
// Bug 1337345
{ file: "resource://gre/modules/Manifest.sys.mjs" },
// Bug 1494170
// (The references to these files are dynamically generated, so the test can't
// find the references)
{
file: "chrome://devtools/skin/images/aboutdebugging-firefox-aurora.svg",
isFromDevTools: true,
},
{
file: "chrome://devtools/skin/images/aboutdebugging-firefox-beta.svg",
isFromDevTools: true,
},
{
file: "chrome://devtools/skin/images/aboutdebugging-firefox-release.svg",
isFromDevTools: true,
},
{ file: "chrome://devtools/skin/images/next.svg", isFromDevTools: true },
// Bug 1526672
{
file: "resource://app/localization/en-US/browser/touchbar/touchbar.ftl",
platforms: ["linux", "win"],
},
// dom/media/mediacontrol/MediaControlService.cpp
{ file: "resource://gre/localization/en-US/dom/media.ftl" },
// dom/xml/nsXMLPrettyPrinter.cpp
{ file: "resource://gre/localization/en-US/dom/XMLPrettyPrint.ftl" },
// tookit/mozapps/update/BackgroundUpdate.sys.mjs
{
file: "resource://gre/localization/en-US/toolkit/updates/backgroundupdate.ftl",
},
// Bug 1713242 - referenced by aboutThirdParty.html which is only for Windows
{
file: "resource://gre/localization/en-US/toolkit/about/aboutThirdParty.ftl",
platforms: ["linux", "macosx"],
},
// Bug 1854618 - referenced by aboutWebauthn.html which is only for Linux and Mac
{
file: "resource://gre/localization/en-US/toolkit/about/aboutWebauthn.ftl",
platforms: ["win", "android"],
},
// Bug 1973834 - referenced by aboutWindowsMessages.html which is only for Windows
{
file: "resource://gre/localization/en-US/toolkit/about/aboutWindowsMessages.ftl",
platforms: ["linux", "macosx"],
},
// Bug 1721741:
// (The references to these files are dynamically generated, so the test can't
// find the references)
{ file: "chrome://browser/content/screenshots/copied-notification.svg" },
// toolkit/xre/MacRunFromDmgUtils.mm
{ file: "resource://gre/localization/en-US/toolkit/global/run-from-dmg.ftl" },
// Referenced programmatically
{ file: "chrome://browser/content/backup/BackupManifest.1.schema.json" },
{ file: "chrome://browser/content/backup/ArchiveJSONBlock.1.schema.json" },
// Bug 1733498 - Migrate necko errors l10n strings from .properties to Fluent
{
file: "resource://gre/localization/en-US/netwerk/necko.ftl",
},
// dom/xslt/xslt/txMozillaXSLTProcessor.cpp
{ file: "resource://gre/localization/en-US/dom/xslt.ftl" },
// A QA and dev debug tool.
{ file: "chrome://browser/content/places/interactionsViewer.html" },
];
if (AppConstants.NIGHTLY_BUILD) {
allowlist.push(
// A debug tool that is only available in Nightly builds, and is accessed
// directly by developers via the chrome URI (bug 1888491)
{ file: "chrome://browser/content/backup/debug.html" }
);
}
if (AppConstants.platform != "win") {
// toolkit/mozapps/defaultagent/Notification.cpp
// toolkit/mozapps/defaultagent/ScheduledTask.cpp
// toolkit/mozapps/defaultagent/BackgroundTask_defaultagent.sys.mjs
// Bug 1854425 - referenced by default browser agent which is not detected
allowlist.push({
file: "resource://app/localization/en-US/browser/backgroundtasks/defaultagent.ftl",
});
if (AppConstants.NIGHTLY_BUILD) {
// This path is refereneced in nsFxrCommandLineHandler.cpp, which is only
// compiled in Windows. This path is allowed so that non-Windows builds
// can access the FxR UI via --chrome rather than --fxr (which includes VR-
// specific functionality)
allowlist.push({ file: "chrome://fxr/content/fxrui.html" });
}
}
if (AppConstants.platform == "android") {
// The l10n build system can't package string files only for some platforms.
// Referenced by aboutGlean.html
allowlist.push({
file: "resource://gre/localization/en-US/toolkit/about/aboutGlean.ftl",
});
}
if (AppConstants.MOZ_UPDATE_AGENT && !AppConstants.MOZ_BACKGROUNDTASKS) {
// Task scheduling is only used for background updates right now.
allowlist.push({
file: "resource://gre/modules/TaskScheduler.sys.mjs",
});
}
allowlist = new Set(
allowlist
.filter(
item =>
"isFromDevTools" in item == isDevtools &&
(!item.skipUnofficial || !AppConstants.MOZILLA_OFFICIAL) &&
(!item.platforms || item.platforms.includes(AppConstants.platform))
)
.map(item => item.file)
);
const ignorableAllowlist = new Set([
// The following files are outside of the omni.ja file, so we only catch them
// when testing on a non-packaged build.
// dom/media/gmp/GMPParent.cpp
"resource://gre/gmp-clearkey/0.1/manifest.json",
]);
for (let entry of ignorableAllowlist) {
allowlist.add(entry);
}
if (!isDevtools) {
// services/sync/modules/service.sys.mjs
for (let module of [
"addons.sys.mjs",
"bookmarks.sys.mjs",
"forms.sys.mjs",
"history.sys.mjs",
"passwords.sys.mjs",
"prefs.sys.mjs",
"tabs.sys.mjs",
"extension-storage.sys.mjs",
]) {
allowlist.add("resource://services-sync/engines/" + module);
}
// resource://devtools/shared/worker/loader.js,
// resource://devtools/shared/loader/builtin-modules.js
if (!AppConstants.ENABLE_WEBDRIVER) {
allowlist.add("resource://gre/modules/jsdebugger.sys.mjs");
}
}
if (AppConstants.MOZ_CODE_COVERAGE) {
allowlist.add(
"chrome://remote/content/marionette/PerTestCoverageUtils.sys.mjs"
);
}
const gInterestingCategories = new Set([
"addon-provider-module",
"webextension-modules",
"webextension-scripts",
"webextension-schemas",
"webextension-scripts-addon",
"webextension-scripts-content",
"webextension-scripts-devtools",
]);
var gChromeReg = Cc["@mozilla.org/chrome/chrome-registry;1"].getService(
Ci.nsIChromeRegistry
);
var gChromeMap = new Map();
var gOverrideMap = new Map();
// In this map when the value is a Set of URLs, the file is referenced if any
// of the files in the Set is referenced.
// When the value is null, the file is referenced unconditionally.
// When the value is a string, "allowlist-direct" means that we have not found
// any reference in the code, but have a matching allowlist entry for this file.
// "allowlist" means that the file is indirectly allowlisted, ie. a allowlisted
// file causes this file to be referenced.
var gReferencesFromCode = new Map();
var resHandler = Services.io
.getProtocolHandler("resource")
.QueryInterface(Ci.nsIResProtocolHandler);
var gResourceMap = [];
function trackResourcePrefix(prefix) {
let uri = Services.io.newURI("resource://" + prefix + "/");
gResourceMap.unshift([prefix, resHandler.resolveURI(uri)]);
}
trackResourcePrefix("gre");
trackResourcePrefix("app");
function getBaseUriForChromeUri(chromeUri) {
let chromeFile = chromeUri + "nonexistentfile.reallynothere";
let uri = Services.io.newURI(chromeFile);
let fileUri = gChromeReg.convertChromeURL(uri);
return fileUri.resolve(".");
}
function trackChromeUri(uri) {
gChromeMap.set(getBaseUriForChromeUri(uri), uri);
}
// formautofill registers resource://formautofill/ and
// chrome://formautofill/content/ dynamically at runtime.
// Bug 1480276 is about addressing this without this hard-coding.
trackResourcePrefix("autofill");
trackChromeUri("chrome://formautofill/content/");
function parseManifest(manifestUri) {
return fetchFile(manifestUri.spec).then(data => {
for (let line of data.split("\n")) {
let [type, ...argv] = line.split(/\s+/);
if (type == "content" || type == "skin" || type == "locale") {
let chromeUri = `chrome://${argv[0]}/${type}/`;
trackChromeUri(chromeUri);
} else if (type == "override" || type == "overlay") {
// Overlays aren't really overrides, but behave the same in
// that the overlay is only referenced if the original xul
// file is referenced somewhere.
let os = "os=" + Services.appinfo.OS;
if (!argv.some(s => s.startsWith("os=") && s != os)) {
gOverrideMap.set(
Services.io.newURI(argv[1]).specIgnoringRef,
Services.io.newURI(argv[0]).specIgnoringRef
);
}
} else if (type == "category") {
if (gInterestingCategories.has(argv[0])) {
gReferencesFromCode.set(argv[2], null);
} else if (
argv[1].startsWith("resource://") ||
argv[1].startsWith("moz-src://")
) {
// Assume that any resource paths immediately after the category name
// are for use with BrowserUtils.callModulesFromCategory (rather than
// having to hardcode a list of categories in this test).
gReferencesFromCode.set(argv[1], null);
}
} else if (type == "resource") {
trackResourcePrefix(argv[0]);
}
}
});
}
// If the given URI is a webextension manifest, extract files used by
// any of its APIs (scripts, icons, style sheets, theme images).
// Returns the passed in URI if the manifest is not a webextension
// manifest, null otherwise.
async function parseJsonManifest(uri) {
uri = Services.io.newURI(convertToCodeURI(uri.spec));
let raw = await fetchFile(uri.spec);
let data;
try {
data = JSON.parse(raw);
} catch (ex) {
return uri;
}
// Simplistic test for whether this is a webextension manifest:
if (data.manifest_version !== 2) {
return uri;
}
if (data.background?.scripts) {
for (let bgscript of data.background.scripts) {
gReferencesFromCode.set(uri.resolve(bgscript), null);
}
}
if (data.icons) {
for (let icon of Object.values(data.icons)) {
gReferencesFromCode.set(uri.resolve(icon), null);
}
}
if (data.experiment_apis) {
for (let api of Object.values(data.experiment_apis)) {
if (api.parent && api.parent.script) {
let script = uri.resolve(api.parent.script);
gReferencesFromCode.set(script, null);
}
if (api.schema) {
gReferencesFromCode.set(uri.resolve(api.schema), null);
}
}
}
if (data.theme_experiment && data.theme_experiment.stylesheet) {
let stylesheet = uri.resolve(data.theme_experiment.stylesheet);
gReferencesFromCode.set(stylesheet, null);
}
for (let themeKey of ["theme", "dark_theme"]) {
if (data?.[themeKey]?.images?.additional_backgrounds) {
for (let background of data[themeKey].images.additional_backgrounds) {
gReferencesFromCode.set(uri.resolve(background), null);
}
}
}
return null;
}
function addCodeReference(url, fromURI) {
let from = convertToCodeURI(fromURI.spec);
// Ignore self references.
if (url == from) {
return;
}
let ref;
if (gReferencesFromCode.has(url)) {
ref = gReferencesFromCode.get(url);
if (ref === null) {
return;
}
} else {
ref = new Set();
gReferencesFromCode.set(url, ref);
}
ref.add(from);
}
function listCodeReferences(refs) {
let refList = [];
if (refs) {
for (let ref of refs) {
refList.push(ref);
}
}
return refList.join(",");
}
function parseCSSFile(fileUri) {
return fetchFile(fileUri.spec).then(data => {
for (let line of data.split("\n")) {
let urls = line.match(/url\([^()]+\)/g);
if (!urls) {
// @import rules can take a string instead of a url.
let importMatch = line.match(/@import ['"]?([^'"]*)['"]?/);
if (importMatch && importMatch[1]) {
let url = Services.io.newURI(importMatch[1], null, fileUri).spec;
addCodeReference(convertToCodeURI(url), fileUri);
}
continue;
}
for (let url of urls) {
// Remove the url(" prefix and the ") suffix.
url = url
.replace(/url\(([^)]*)\)/, "$1")
.replace(/^"(.*)"$/, "$1")
.replace(/^'(.*)'$/, "$1");
if (url.startsWith("data:")) {
continue;
}
try {
url = Services.io.newURI(url, null, fileUri).specIgnoringRef;
addCodeReference(convertToCodeURI(url), fileUri);
} catch (e) {
ok(false, "unexpected error while resolving this URI: " + url);
}
}
}
});
}
function parseCodeFile(fileUri) {
return fetchFile(fileUri.spec).then(data => {
let baseUri;
for (let line of data.split("\n")) {
let urls = line.match(
/["'`]chrome:\/\/[a-zA-Z0-9-]+\/(content|skin|locale)\/[^"'` ]*["'`]/g
);
if (!urls) {
urls = line.match(/["']moz-src:\/\/\/[^"']+["']/g);
}
if (!urls) {
urls = line.match(/["']resource:\/\/[^"']+["']/g);
if (
urls &&
isDevtools &&
/baseURI: "resource:\/\/devtools\//.test(line)
) {
baseUri = Services.io.newURI(urls[0].slice(1, -1));
continue;
}
}
if (!urls) {
urls = line.match(/[a-z0-9_\/-]+\.ftl/i);
if (urls) {
urls = urls[0];
let grePrefix = Services.io.newURI(
"resource://gre/localization/en-US/"
);
let appPrefix = Services.io.newURI(
"resource://app/localization/en-US/"
);
let grePrefixUrl = Services.io.newURI(urls, null, grePrefix).spec;
let appPrefixUrl = Services.io.newURI(urls, null, appPrefix).spec;
addCodeReference(grePrefixUrl, fileUri);
addCodeReference(appPrefixUrl, fileUri);
continue;
}
}
if (!urls) {
// If there's no absolute chrome URL, look for relative ones in
// src and href attributes.
let match = line.match("(?:src|href)=[\"']([^$&\"']+)");
if (match && match[1]) {
let url = Services.io.newURI(match[1], null, fileUri).spec;
addCodeReference(convertToCodeURI(url), fileUri);
}
// This handles `import` lines which may be multi-line.
// We have an ESLint rule, `import/no-unassigned-import` which prevents
// using bare `import "foo.js"`, so we don't need to handle that case
// here.
match = line.match(/from\W*['"](.*?)['"]/);
if (match?.[1]) {
let url = match[1];
url = Services.io.newURI(url, null, baseUri || fileUri).spec;
url = convertToCodeURI(url);
addCodeReference(url, fileUri);
}
if (isDevtools) {
let rules = [
["devtools/client/locales", "chrome://devtools/locale"],
["devtools/shared/locales", "chrome://devtools-shared/locale"],
[
"devtools/shared/platform",
"resource://devtools/shared/platform/chrome",
],
["devtools", "resource://devtools"],
];
match = line.match(/["']((?:devtools)\/[^\\#"']+)["']/);
if (match && match[1]) {
let path = match[1];
for (let rule of rules) {
if (path.startsWith(rule[0] + "/")) {
path = path.replace(rule[0], rule[1]);
if (!/\.(properties|js|jsm|mjs|json|css)$/.test(path)) {
path += ".js";
}
addCodeReference(path, fileUri);
break;
}
}
}
match = line.match(/require\(['"](\.[^'"]+)['"]\)/);
if (match && match[1]) {
let url = match[1];
url = Services.io.newURI(url, null, baseUri || fileUri).spec;
url = convertToCodeURI(url);
if (!/\.(properties|js|jsm|mjs|json|css)$/.test(url)) {
url += ".js";
}
if (
url.startsWith("resource://") ||
url.startsWith("moz-src:///")
) {
addCodeReference(url, fileUri);
} else {
// if we end up with a chrome:// url here, it's likely because
// a baseURI to a resource:// path has been defined in another
// .js file that is loaded in the same scope, we can't detect it.
}
}
}
continue;
}
for (let url of urls) {
// Remove quotes.
url = url.slice(1, -1);
// Remove ? or \ trailing characters.
if (url.endsWith("\\")) {
url = url.slice(0, -1);
}
let pos = url.indexOf("?");
if (pos != -1) {
url = url.slice(0, pos);
}
// Make urls like chrome://browser/skin/ point to an actual file,
// and remove the ref if any.
try {
url = Services.io.newURI(url).specIgnoringRef;
} catch (e) {
continue;
}
if (
isDevtools &&
line.includes("require(") &&
!/\.(properties|js|jsm|mjs|json|css)$/.test(url)
) {
url += ".js";
}
addCodeReference(url, fileUri);
}
}
});
}
function convertToCodeURI(fileUri) {
let baseUri = fileUri;
let path = "";
while (baseUri) {
let slashPos = baseUri.lastIndexOf("/", baseUri.length - 2);
if (slashPos <= 0) {
// File not accessible from chrome protocol, try resource://
for (let res of gResourceMap) {
if (fileUri.startsWith(res[1])) {
let resourceUriString = fileUri.replace(
res[1],
`resource://${res[0]}/`
);
// If inside moz-src, treat as moz-src url.
resourceUriString = resourceUriString.replace(
/^resource:\/\/gre\/moz-src\//,
"moz-src:///"
);
return resourceUriString;
}
}
// Give up and return the original URL.
return fileUri;
}
path = baseUri.slice(slashPos + 1) + path;
baseUri = baseUri.slice(0, slashPos + 1);
if (gChromeMap.has(baseUri)) {
return gChromeMap.get(baseUri) + path;
}
}
throw new Error(`Unparsable URI: ${fileUri}`);
}
async function chromeFileExists(aURI) {
try {
return await PerfTestHelpers.checkURIExists(aURI);
} catch (e) {
todo(false, `Failed to check if ${aURI} exists: ${e}`);
return false;
}
}
function findChromeUrlsFromArray(array, prefix) {
// Find the first character of the prefix...
for (
let index = 0;
(index = array.indexOf(prefix.charCodeAt(0), index)) != -1;
++index
) {
// Then ensure we actually have the whole prefix.
let found = true;
for (let i = 1; i < prefix.length; ++i) {
if (array[index + i] != prefix.charCodeAt(i)) {
found = false;
break;
}
}
if (!found) {
continue;
}
// C strings are null terminated, but " also terminates urls
// (nsIndexedToHTML.cpp contains an HTML fragment with several chrome urls)
// Let's also terminate the string on the # character to skip references.
let end = Math.min(
array.indexOf(0, index),
array.indexOf('"'.charCodeAt(0), index),
array.indexOf(")".charCodeAt(0), index),
array.indexOf("#".charCodeAt(0), index)
);
let string = "";
for (; index < end; ++index) {
string += String.fromCharCode(array[index]);
}
// Only keep strings that look like real chrome or resource urls.
if (
/chrome:\/\/[a-zA-Z09-]+\/(content|skin|locale)\//.test(string) ||
/moz-src:\/\/\/\w+/.test(string) ||
/resource:\/\/[a-zA-Z09-]*\/.*\.[a-z]+/.test(string)
) {
gReferencesFromCode.set(string, null);
}
}
}
add_task(async function checkAllTheFiles() {
TestUtils.assertPackagedBuild();
const libxul = await IOUtils.read(PathUtils.xulLibraryPath);
findChromeUrlsFromArray(libxul, "chrome://");
findChromeUrlsFromArray(libxul, "resource://");
findChromeUrlsFromArray(libxul, "moz-src:///");
// Handle NS_LITERAL_STRING.
let uint16 = new Uint16Array(libxul.buffer);
findChromeUrlsFromArray(uint16, "chrome://");
findChromeUrlsFromArray(uint16, "resource://");
findChromeUrlsFromArray(uint16, "moz-src:///");
const kCodeExtensions = [
".xml",
".xsl",
".mjs",
".js",
".jsm",
".json",
".html",
".xhtml",
];
let appDir = Services.dirsvc.get("GreD", Ci.nsIFile);
// This asynchronously produces a list of URLs (sadly, mostly sync on our
// test infrastructure because it runs against jarfiles there, and
// our zipreader APIs are all sync)
let uris = await generateURIsFromDirTree(
appDir,
[
".css",
".manifest",
".jpg",
".png",
".gif",
".svg",
".ftl",
".dtd",
".properties",
].concat(kCodeExtensions)
);
// Parse and remove all manifests from the list.
// NOTE that this must be done before filtering out devtools paths
// so that all chrome paths can be recorded.
let manifestURIs = [];
let jsonManifests = [];
uris = uris.filter(uri => {
let path = uri.pathQueryRef;
if (path.endsWith(".manifest")) {
manifestURIs.push(uri);
return false;
} else if (path.endsWith("/manifest.json")) {
jsonManifests.push(uri);
return false;
}
return true;
});
// Wait for all manifest to be parsed
await PerfTestHelpers.throttledMapPromises(manifestURIs, parseManifest);
for (let esModule of Components.manager.getComponentESModules()) {
gReferencesFromCode.set(esModule, null);
}
// manifest.json is a common name, it is used for WebExtension manifests
// but also for other things. To tell them apart, we have to actually
// read the contents. This will populate gExtensionRoots with all
// embedded extension APIs, and return any manifest.json files that aren't
// webextensions.
let nonWebextManifests = (
await Promise.all(jsonManifests.map(parseJsonManifest))
).filter(uri => !!uri);
uris.push(...nonWebextManifests);
// We build a list of promises that get resolved when their respective
// files have loaded and produced no errors.
let allPromises = [];
for (let uri of uris) {
let path = uri.pathQueryRef;
if (path.endsWith(".css")) {
allPromises.push([parseCSSFile, uri]);
} else if (kCodeExtensions.some(ext => path.endsWith(ext))) {
allPromises.push([parseCodeFile, uri]);
}
}
// Wait for all the files to have actually loaded:
await PerfTestHelpers.throttledMapPromises(allPromises, ([task, uri]) =>
task(uri)
);
// Keep only chrome:// files, and filter out either the devtools paths or
// the non-devtools paths:
let devtoolsPrefixes = [
"chrome://devtools",
"moz-src:///devtools/",
"resource://devtools/",
"resource://devtools-shared-images/",
"resource://devtools-highlighter-styles/",
"resource://app/modules/devtools",
"resource://gre/modules/devtools",
"resource://app/localization/en-US/startup/aboutDevTools.ftl",
"resource://app/localization/en-US/devtools/",
];
let hasDevtoolsPrefix = uri =>
devtoolsPrefixes.some(prefix => uri.startsWith(prefix));
let chromeFiles = [];
for (let uri of uris) {
uri = convertToCodeURI(uri.spec);
if (
(uri.startsWith("chrome://") ||
uri.startsWith("resource://") ||
uri.startsWith("moz-src:///")) &&
isDevtools == hasDevtoolsPrefix(uri)
) {
chromeFiles.push(uri);
}
}
if (isDevtools) {
// chrome://devtools/skin/devtools-browser.css is included from browser.xhtml
gReferencesFromCode.set(AppConstants.BROWSER_CHROME_URL, null);
// devtools' css is currently included from browser.css, see bug 1204810.
gReferencesFromCode.set("chrome://browser/skin/browser.css", null);
}
let isUnreferenced = file => {
if (gExceptionPaths.some(e => file.startsWith(e))) {
return false;
}
if (gReferencesFromCode.has(file)) {
let refs = gReferencesFromCode.get(file);
if (refs === null) {
return false;
}
for (let ref of refs) {
if (isDevtools) {
if (
ref.startsWith("resource://app/components/") ||
(file.startsWith("chrome://") && ref.startsWith("resource://"))
) {
return false;
}
}
if (gReferencesFromCode.has(ref)) {
let refType = gReferencesFromCode.get(ref);
if (
refType === null || // unconditionally referenced
refType == "allowlist" ||
refType == "allowlist-direct"
) {
return false;
}
}
}
}
return !gOverrideMap.has(file) || isUnreferenced(gOverrideMap.get(file));
};
let unreferencedFiles = chromeFiles;
let removeReferenced = useAllowlist => {
let foundReference = false;
unreferencedFiles = unreferencedFiles.filter(f => {
let rv = isUnreferenced(f);
if (rv && f.startsWith("resource://app/")) {
rv = isUnreferenced(f.replace("resource://app/", "resource:///"));
}
if (!rv) {
foundReference = true;
if (useAllowlist) {
info(
"indirectly allowlisted file: " +
f +
" used from " +
listCodeReferences(gReferencesFromCode.get(f))
);
}
gReferencesFromCode.set(f, useAllowlist ? "allowlist" : null);
}
return rv;
});
return foundReference;
};
// First filter out the files that are referenced.
while (removeReferenced(false)) {
// As long as removeReferenced returns true, some files have been marked
// as referenced, so we need to run it again.
}
// Marked as referenced the files that have been explicitly allowed.
unreferencedFiles = unreferencedFiles.filter(file => {
if (allowlist.has(file)) {
allowlist.delete(file);
gReferencesFromCode.set(file, "allowlist-direct");
return false;
}
return true;
});
// Run the process again, this time when more files are marked as referenced,
// it's a consequence of the allowlist.
while (removeReferenced(true)) {
// As long as removeReferenced returns true, we need to run it again.
}
unreferencedFiles.sort();
if (isDevtools) {
// Bug 1351878 - handle devtools resource files
unreferencedFiles = unreferencedFiles.filter(file => {
if (file.startsWith("resource://")) {
info("unreferenced devtools resource file: " + file);
return false;
}
return true;
});
}
is(unreferencedFiles.length, 0, "there should be no unreferenced files");
for (let file of unreferencedFiles) {
let refs = gReferencesFromCode.get(file);
if (refs === undefined) {
ok(false, "unreferenced file: " + file);
} else {
let refList = listCodeReferences(refs);
let msg = "file only referenced from unreferenced files: " + file;
if (refList) {
msg += " referenced from " + refList;
}
ok(false, msg);
}
}
for (let file of allowlist) {
if (ignorableAllowlist.has(file)) {
info("ignored unused allowlist entry: " + file);
} else {
ok(false, "unused allowlist entry: " + file);
}
}
for (let [file, refs] of gReferencesFromCode) {
if (
isDevtools != devtoolsPrefixes.some(prefix => file.startsWith(prefix))
) {
continue;
}
if (
(file.startsWith("chrome://") ||
file.startsWith("resource://") ||
file.startsWith("moz-src:///")) &&
!(await chromeFileExists(file))
) {
// Ignore chrome prefixes that have been automatically expanded.
let pathParts =
file.match("chrome://([^/]+)/content/([^/.]+).xul") ||
file.match("chrome://([^/]+)/skin/([^/.]+).css");
if (pathParts && pathParts[1] == pathParts[2]) {
continue;
}
// TODO: bug 1349010 - add a allowlist and make this reliable enough
// that we could make the test fail when this catches something new.
let refList = listCodeReferences(refs);
let msg = "missing file: " + file;
if (refList) {
msg += " referenced from " + refList;
}
info(msg);
}
}
});
|