pub2nix.generatePackageConfig: Use logical paths for pubspec.yaml

[hacker1024]

Description of changes

When using pub2nix with multiple packages that have path dependencies on each-other, linkFarm can be used to put them all in the same directory.

This confuses generatePackageConfig, though, as it resolves the parent directory of a linkFarm entry as its real parent (typically the Nix store directory) rather than the linkFarm root.

This PR changes generatePackageConfig to use realpath --logical when resolving other packages' pubspec.yaml files, in order to avoid this issue.

Things done

• Built on platform(s)
  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin
• For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
  • sandbox = relaxed
  • sandbox = true
• Tested, as applicable:
  • NixOS test(s) (look inside nixos/tests)
  • and/or package tests
  • or, for functions and "core" functionality, tests in lib/tests or pkgs/test
  • made sure NixOS tests are linked to the relevant packages
• Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
• Tested basic functionality of all binary files (usually in ./result/bin/)
• 24.05 Release Notes (or backporting 23.05 and 23.11 Release notes)
  • (Package updates) Added a release notes entry if the change is major or breaking
  • (Module updates) Added a release notes entry if the change is significant
  • (Module addition) Added a release notes entry if adding a new NixOS module
• Fits CONTRIBUTING.md.

---

Add a 👍 reaction to pull requests you find important.

@NixOS/flutter

[hacker1024]

Result of nixpkgs-review pr 310059 run on x86_64-linux 1

59 packages built:

• dart-sass
• dart-sass.pubcache
• discourse
• discourseAllPlugins
• domine
• domine.pubcache
• expidus.calculator
• expidus.calculator.debug
• expidus.calculator.pubcache
• expidus.file-manager
• expidus.file-manager.debug
• expidus.file-manager.pubcache
• firmware-updater
• firmware-updater.debug
• firmware-updater.pubcache
• flet-client-flutter
• flet-client-flutter.debug
• flet-client-flutter.pubcache
• fluffychat
• fluffychat-web
• fluffychat-web.pubcache
• fluffychat.debug
• fluffychat.pubcache
• flutter (flutter319 ,flutterPackages.stable ,flutterPackages.v3_19)
• flutter313 (flutterPackages.v3_13)
• flutter316 (flutterPackages.v3_16)
• hover
• intiface-central
• intiface-central.debug
• intiface-central.pubcache
• jekyll
• jsonnet
• jsonnet.doc
• localsend
• localsend.debug
• localsend.pubcache
• protoc-gen-dart
• protoc-gen-dart.pubcache
• python311Packages.flet
• python311Packages.flet-runtime
• python311Packages.flet-runtime.dist
• python311Packages.flet.dist
• python312Packages.flet
• python312Packages.flet-runtime
• python312Packages.flet-runtime.dist
• python312Packages.flet.dist
• quarto
• quartoMinimal
• rstudio
• rstudio-server
• rstudioServerWrapper
• rstudioWrapper
• rustdesk-flutter
• rustdesk-flutter.debug
• rustdesk-flutter.pubcache
• shopware-cli
• yubioath-flutter
• yubioath-flutter.debug
• yubioath-flutter.pubcache

[hacker1024]

Result of nixpkgs-review pr 310059 run on aarch64-linux 1

2 packages marked as broken and skipped:

• rstudio
• rstudio-server

3 packages failed to build:

• rustdesk-flutter
• rustdesk-flutter.debug
• rustdesk-flutter.pubcache

51 packages built:

• dart-sass
• dart-sass.pubcache
• discourse
• discourseAllPlugins
• domine
• domine.pubcache
• expidus.calculator
• expidus.calculator.debug
• expidus.calculator.pubcache
• expidus.file-manager
• expidus.file-manager.debug
• expidus.file-manager.pubcache
• firmware-updater
• firmware-updater.debug
• firmware-updater.pubcache
• flet-client-flutter
• flet-client-flutter.debug
• flet-client-flutter.pubcache
• fluffychat
• fluffychat-web
• fluffychat-web.pubcache
• fluffychat.debug
• fluffychat.pubcache
• flutter (flutter319 ,flutterPackages.stable ,flutterPackages.v3_19)
• flutter313 (flutterPackages.v3_13)
• flutter316 (flutterPackages.v3_16)
• intiface-central
• intiface-central.debug
• intiface-central.pubcache
• jekyll
• jsonnet
• jsonnet.doc
• localsend
• localsend.debug
• localsend.pubcache
• protoc-gen-dart
• protoc-gen-dart.pubcache
• python311Packages.flet
• python311Packages.flet-runtime
• python311Packages.flet-runtime.dist
• python311Packages.flet.dist
• python312Packages.flet
• python312Packages.flet-runtime
• python312Packages.flet-runtime.dist
• python312Packages.flet.dist
• quarto
• quartoMinimal
• shopware-cli
• yubioath-flutter
• yubioath-flutter.debug
• yubioath-flutter.pubcache

[FlafyDev]

I don't think I really understood from the description when the symlink it will resolve will have ... or when that symlink will be the result of a linkFarm. But I think I understand the problem it's fixing..