def do_configure(d): # Export function set bb.build.exec_func('npm_do_configure', d) do_configure(d) def npm_do_configure(d): """ Step one: configure the npm cache and the main npm package Every dependencies have been fetched and patched in the source directory. They have to be packed (this remove unneeded files) and added to the npm cache to be available for the next step. The main package and its associated manifest file and shrinkwrap file have to be configured to take into account these cached dependencies. """ import base64 import copy import json import re import shlex import stat import tempfile from bb.fetch2.npm import NpmEnvironment from bb.fetch2.npm import npm_unpack from bb.fetch2.npm import npm_package from bb.fetch2.npmsw import foreach_dependencies from bb.progress import OutOfProgressHandler from oe.npm_registry import NpmRegistry bb.utils.remove(d.getVar("NPM_CACHE"), recurse=True) bb.utils.remove(d.getVar("NPM_PACKAGE"), recurse=True) env = NpmEnvironment(d, configs=npm_global_configs(d)) registry = NpmRegistry(d.getVar('NPM_REGISTRY'), d.getVar('NPM_CACHE')) def _npm_cache_add(tarball, pkg): """Add tarball to local registry and register it in the cache""" registry.add_pkg(tarball, pkg) def _npm_integrity(tarball): """Return the npm integrity of a specified tarball""" sha512 = bb.utils.sha512_file(tarball) return "sha512-" + base64.b64encode(bytes.fromhex(sha512)).decode() # Manage the manifest file and shrinkwrap files orig_manifest_file = d.expand("${S}/package.json") orig_shrinkwrap_file = d.expand("${S}/npm-shrinkwrap.json") cached_manifest_file = d.expand("${NPM_PACKAGE}/package.json") cached_shrinkwrap_file = d.expand("${NPM_PACKAGE}/npm-shrinkwrap.json") with open(orig_manifest_file, "r") as f: orig_manifest = json.load(f) cached_manifest = copy.deepcopy(orig_manifest) cached_manifest.pop("dependencies", None) cached_manifest.pop("devDependencies", None) has_shrinkwrap_file = True try: with open(orig_shrinkwrap_file, "r") as f: orig_shrinkwrap = json.load(f) except IOError: has_shrinkwrap_file = False if has_shrinkwrap_file: cached_shrinkwrap = copy.deepcopy(orig_shrinkwrap) for package in orig_shrinkwrap["packages"]: if package != "": cached_shrinkwrap["packages"].pop(package, None) cached_shrinkwrap["packages"][""].pop("dependencies", None) cached_shrinkwrap["packages"][""].pop("devDependencies", None) cached_shrinkwrap["packages"][""].pop("peerDependencies", None) # Manage the dependencies progress = OutOfProgressHandler(d, r"^(\d+)/(\d+)$") progress_total = 1 # also count the main package progress_done = 0 def _count_dependency(name, params, destsuffix): nonlocal progress_total progress_total += 1 def _cache_dependency(name, params, destsuffix): with tempfile.TemporaryDirectory() as tmpdir: # Add the dependency to the npm cache destdir = os.path.join(d.getVar("S"), destsuffix) (tarball, pkg) = npm_pack(env, destdir, tmpdir) _npm_cache_add(tarball, pkg) # Add its signature to the cached shrinkwrap dep = params dep["version"] = pkg['version'] dep["integrity"] = _npm_integrity(tarball) if params.get("dev", False): dep["dev"] = True if "devDependencies" not in cached_shrinkwrap["packages"][""]: cached_shrinkwrap["packages"][""]["devDependencies"] = {} cached_shrinkwrap["packages"][""]["devDependencies"][name] = pkg['version'] else: if "dependencies" not in cached_shrinkwrap["packages"][""]: cached_shrinkwrap["packages"][""]["dependencies"] = {} cached_shrinkwrap["packages"][""]["dependencies"][name] = pkg['version'] cached_shrinkwrap["packages"][destsuffix] = dep # Display progress nonlocal progress_done progress_done += 1 progress.write("%d/%d" % (progress_done, progress_total)) dev = bb.utils.to_boolean(d.getVar("NPM_INSTALL_DEV"), False) if has_shrinkwrap_file: foreach_dependencies(orig_shrinkwrap, _count_dependency, dev) foreach_dependencies(orig_shrinkwrap, _cache_dependency, dev) # Manage Peer Dependencies if has_shrinkwrap_file: packages = orig_shrinkwrap.get("packages", {}) peer_deps = packages.get("", {}).get("peerDependencies", {}) package_runtime_dependencies = d.getVar("RDEPENDS:%s" % d.getVar("PN")) for peer_dep in peer_deps: peer_dep_yocto_name = npm_package(peer_dep) if peer_dep_yocto_name not in package_runtime_dependencies: bb.warn(peer_dep + " is a peer dependencie that is not in RDEPENDS variable. " + "Please add this peer dependencie to the RDEPENDS variable as %s and generate its recipe with devtool" % peer_dep_yocto_name) # Configure the main package with tempfile.TemporaryDirectory() as tmpdir: (tarball, _) = npm_pack(env, d.getVar("S"), tmpdir) npm_unpack(tarball, d.getVar("NPM_PACKAGE"), d) # Configure the cached manifest file and cached shrinkwrap file def _update_manifest(depkey): for name in orig_manifest.get(depkey, {}): version = cached_shrinkwrap["packages"][""][depkey][name] if depkey not in cached_manifest: cached_manifest[depkey] = {} cached_manifest[depkey][name] = version if has_shrinkwrap_file: _update_manifest("dependencies") if dev: if has_shrinkwrap_file: _update_manifest("devDependencies") os.chmod(cached_manifest_file, os.stat(cached_manifest_file).st_mode | stat.S_IWUSR) with open(cached_manifest_file, "w") as f: json.dump(cached_manifest, f, indent=2) if has_shrinkwrap_file: with open(cached_shrinkwrap_file, "w") as f: json.dump(cached_shrinkwrap, f, indent=2) def npm_pack(env, srcdir, workdir): """Emulate 'npm pack' on a specified directory""" import subprocess import os import json src = os.path.join(srcdir, 'package.json') with open(src) as f: j = json.load(f) # base does not really matter and is for documentation purposes # only. But the 'version' part must exist because other parts of # the bbclass rely on it. base = j['name'].split('/')[-1] tarball = os.path.join(workdir, "%s-%s.tgz" % (base, j['version'])); # TODO: real 'npm pack' does not include directories while 'tar' # does. But this does not seem to matter... subprocess.run(['tar', 'czf', tarball, '--exclude', './node-modules', '--exclude-vcs', '--transform', r's,^\./,package/,', '--mtime', '1985-10-26T08:15:00.000Z', '.'], check = True, cwd = srcdir) return (tarball, j) def npm_global_configs(d): """Get the npm global configuration""" configs = [] # Ensure no network access is done configs.append(("offline", "true")) configs.append(("proxy", "http://invalid")) configs.append(("fund", False)) configs.append(("audit", False)) # Configure the cache directory configs.append(("cache", d.getVar("NPM_CACHE"))) return configs ## 'npm pack' runs 'prepare' and 'prepack' scripts. Support for ## 'ignore-scripts' which prevents this behavior has been removed ## from nodejs 16. Use simple 'tar' instead of.