build: fix missing dist-info dir in installer

The installer currently doesn't include the dist-info directory of the
`streamlink` package. This causes issues with `importlib.metadata` when
it tries to find the package's metadata.

This results in the following error when `--loglevel=debug` is set,
as it lists the versions of Streamlink and its dependencies:
> importlib.metadata.PackageNotFoundError:
> No package metadata was found for streamlink

While Streamlink's dependencies are defined as wheels in pynsist's
build config and thus include their own dist-info directories that are
then copied to the pkgs directory of the installer, the `streamlink`
and `streamlink_cli` package names have to be explicitly defined, which
means that Streamlink's dist-info directory won't be copied by pynsist.

The only workaround for this seems to be adding the dist-info directory
to the list of custom files of the installer.

Changes:

- Don't install streamlink in current venv and use a temp dir instead,
  similar to the portable build config
- Remove unneeded and non-deterministic metadata from the dist-info dir
- Set `PYTHONPATH` for loading streamlink from the temp dir
- Add dist-info dir to custom files list in the installer build config

Author: bastimeyer

CHANGELOG.md

@@ -3,6 +3,7 @@ Changelog - streamlink/windows-builds
 
 ## master
 
+- Fixed missing dist-info directory in installer, causing an error when `--loglevel=debug` was set due to missing metadata of the streamlink package
 - Updated FFmpeg to 5.1
 - Added `requirements.txt` for easier build dependency specification
 

build-installer.sh

@@ -83,6 +83,7 @@ TEMP=$(mktemp -d) && trap "rm -rf '${TEMP}'" EXIT || exit 255
 DIR_REPO="${TEMP}/source.git"
 DIR_BUILD="${TEMP}/build"
 DIR_ASSETS="${TEMP}/assets"
+DIR_PKGS="${TEMP}/pkgs"
 DIR_WHEELS="${TEMP}/wheels"
 
 mkdir -p \
@@ -141,10 +142,22 @@ build_app() {
   pip install \
     "${PIP_ARGS[@]}" \
     --no-cache-dir \
+    --platform="${platform}" \
+    --python-version="${pythonversion}" \
+    --implementation="${implementation}" \
     --no-deps \
+    --target="${DIR_PKGS}" \
+    --no-compile \
     --upgrade \
     "${DIR_REPO}"
 
+  log "Removing unneeded dist files"
+  ( set -x; rm -r "${DIR_PKGS}/bin" "${DIR_PKGS}"/*.dist-info/direct_url.json; )
+  sed -i -E \
+    -e '/^.+\.dist-info\/direct_url\.json,sha256=/d' \
+    -e '/^\.\.\/\.\.\//d' \
+    "${DIR_PKGS}"/*.dist-info/RECORD
+
   log "Creating icon"
   for size in 16 32 48 256; do
     # --without-gui and --export-png have been deprecated since Inkscape 1.0.0
@@ -232,9 +245,10 @@ prepare_installer() {
   log "Reading version string"
   local versionstring versionplain versionmeta vi_version installerversion
 
-  versionstring="$(python -c "from importlib.metadata import version;print(version('${appname}'))")"
+  versionstring="$(PYTHONPATH="${DIR_PKGS}" python -c "from importlib.metadata import version;print(version('${appname}'))")"
   versionplain="${versionstring%%+*}"
   versionmeta="${versionstring##*+}"
+  distinfo="${DIR_PKGS}/${appname}-${versionstring}.dist-info"
 
   # Not a custom git reference (assume that only tagged releases are used as source)
   # Use plain version string with app release number and no abbreviated commit ID
@@ -269,18 +283,20 @@ prepare_installer() {
   env -i \
     DIR_BUILD="${DIR_BUILD}" \
     DIR_WHEELS="${DIR_WHEELS}" \
+    DIR_DISTINFO="${distinfo}" \
     VERSION="${installerversion}" \
     PYTHONVERSION="${pythonversionfull}" \
     BITNESS="$([[ "${platform}" == "win_amd64" ]] && echo 64 || echo 32)" \
     INSTALLER_NAME="${DIR_DIST}/${appname}-${installerversion}-${BUILDNAME}.exe" \
     NSI_TEMPLATE="installer.nsi" \
-    envsubst '$DIR_BUILD $DIR_WHEELS $VERSION $ENTRYPOINT $PYTHONVERSION $BITNESS $INSTALLER_NAME $NSI_TEMPLATE' \
+    envsubst '$DIR_BUILD $DIR_DISTINFO $DIR_WHEELS $VERSION $ENTRYPOINT $PYTHONVERSION $BITNESS $INSTALLER_NAME $NSI_TEMPLATE' \
     < "${ROOT}/installer.cfg" \
     > "${DIR_BUILD}/installer.cfg"
 }
 
 build_installer() {
-  PYNSIST_CACHE_DIR="${DIR_BUILD}" pynsist "${DIR_BUILD}/installer.cfg"
+  log "Building installer"
+  PYTHONPATH="${DIR_PKGS}" PYNSIST_CACHE_DIR="${DIR_BUILD}" pynsist "${DIR_BUILD}/installer.cfg"
 }
 
 

installer.cfg

@@ -13,6 +13,7 @@ include_msvcrt=false
 [Include]
 packages=streamlink
          streamlink_cli
+files=${DIR_DISTINFO} > $INSTDIR/pkgs/
 local_wheels=${DIR_WHEELS}/*.whl
 
 [Command streamlink]