search

dlang / dub

Package and build management system for D
MIT License
673 stars 230 forks source link

Package in local-packages not picked up after moving package into new directory structure #2691

Closed jaapgeurts closed 8 months ago

jaapgeurts commented 1 year ago

System information

Bug Description

Dub issues a warning that the current package is at the wrong path. After moving the package to the suggested directory, dub doesn't see the package anymore. Example: Warning Package at path '/home/alice/src/dlang-packages/ddbus/' should be under '/home/alice/src/dlang-packages/foo/$VERSION/foo'

After move the package into the suggested directory, dub doesn't see the package anymore.

How to reproduce?

  1. Add a local package directory dub add-path <path>
  2. Check the $HOME/.dub/packages/local-packages.json and make sure the path is listed.
  3. Add a package into the directory. (using the old structure without the version numbers)
  4. Issue dub list
  5. Notice that the package is listed and that dub issues a warning: Package at path <path>/foo should be under <path>/$VERSION/foo
  6. Move the package to the suggested directory(under a version number),
  7. Issue dub list
  8. Notice that the warning is gone but the package is not listed.

When trying to build a project it will not pick up the dependency.

Expected Behavior

Dub does see the package after moving it into the suggested directory.

s-ludwig commented 1 year ago

This is a bogus warning introduced by #2610. It should really only apply to the package cache path(s) (e.g. ~/.dub/packages/) - dub add-path should not be affected in any way. The logic there needs to be changed to first make the isManagedPath check and then perform the legacy package search with that warning. For unmanaged paths it should just search directly, with no warning.

Geod24 commented 8 months ago

@s-ludwig : Actually, it's not a bogus warning, but it is a bug introduced in #2610 . The idea is to move towards storing the version outside the recipe file, both for performance and to avoid modifying the downloaded zip as we currently do. However, the condition excludes non managed paths. I get that his could be considered as making dub add-path harder to use, but it actually makes the expectations much clearer and aligned with managed paths, which IMO makes it easier to use. For example, what happens if you currently have packages in custom paths that have no version field ?

Geod24 commented 8 months ago

Fix: https://github.com/dlang/dub/pull/2780

s-ludwig commented 7 months ago

@s-ludwig : Actually, it's not a bogus warning, but it is a bug introduced in #2610 . The idea is to move towards storing the version outside the recipe file, both for performance and to avoid modifying the downloaded zip as we currently do. However, the condition excludes non managed paths. I get that his could be considered as making dub add-path harder to use, but it actually makes the expectations much clearer and aligned with managed paths, which IMO makes it easier to use. For example, what happens if you currently have packages in custom paths that have no version field ?

Just to also mention it here. This makes absolutely no sense. The main use case for dub add-path is to add your "dev" folder where you have the working copies of the packages you develop. Nobody in their right mind would organize those with such a scheme. Performance improvements simply must be achieved in a different way.