feat(builtin): generate @npm//foo__all_files filegroup that includes all files in the npm package

[gregmagolan]

Including files with spaces & unicode characters & files that have been filtered out by the included_files attribute. This filegroup cannot be used in runfiles because of Bazel issue bazelbuild/bazel#4327, but it can be used for other purposes such as the srcs input to a pkg_tar for generating a tar of an npm package pulled down with yarn_install or npm_install.

Needed for angular/angular#33927 where pkg_tar is used to make a tar.gz of node_modules/puppeteer and on OSX the downloaded Chrome libs have spaces in their names:

def npm_package_archives():
    """Function to generate pkg_tar definitions for WORKSPACE yarn_install manual_build_file_contents"""
    npm_packages_to_archive = NPM_PACKAGE_ARCHIVES
    result = """load("@bazel_tools//tools/build_defs/pkg:pkg.bzl", "pkg_tar")
"""
    for name in npm_packages_to_archive:
        label_name = _npm_package_archive_label(name)
        last_segment_name = name if name.find("/") == -1 else name.split("/")[-1]
        result += """pkg_tar(
    name = "{label_name}",
    # use //{name}:{last_segment_name}__all_files as this includes **all** of the npm package
    # files including files with spaces and unicode chars which are not valid in Bazel runfiles.
    srcs = ["//{name}:{last_segment_name}__all_files"],
    extension = "tar.gz",
    strip_prefix = "./node_modules/{name}",
    # should not be build unless it is a dependency of another rule
    tags = ["manual"],
)
""".format(name = name, label_name = label_name, last_segment_name = last_segment_name)
    return result

See angular/angular#33927 (comment) for more details.

PR Checklist

Please check if your PR fulfills the following requirements:

• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

• Bugfix
• Feature (please, look at the "Scope of the project" section in the README.md file)
• Code style update (formatting, local variables)
• Refactoring (no functional changes, no api changes)
• Build related changes
• CI related changes
• Documentation content changes
• Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

• Yes
• No

Other information

[buildsize]

File name	Previous Size	New Size	Change
release.tar.gz	963.05 KB	963.94 KB	912 bytes (0%)

[alexeagle]

I guess it's technically a breaking change if users referred to one of these target directly?

[gregmagolan]

Nope. No breaking change here. This is just testing that the include_files works are intended and that any files that aren't included still end up the __all_files target.

[alexeagle]

so many changes in this file - I'm assuming it's just a refactoring moving lines around, and not this many lines edited?

[gregmagolan]

Yup. Some refactoring here.