Possible issue with name capitalisation

[einglis]

Preface: this might be a PlatformIO issue at heart, but I still think it's relevant here

I've been using the me-no-dev version of this excellent library for ages. I've just come back to a project to discover it has become ESP32Async.

I'm building a toy app the has a dependency on my own library, which in turn depends on ESPAsyncWebServer. Hence my library's library.json now contains:

  "dependencies":
  {
     ...
    "ESP32Async/ESPAsyncWebServer": "*"
  },

However, when I build the toy app, it can't find the <ESPAsyncWebServer.h> header.
For a while, it said it was Ignoring ESPAsyncWebServer, (but for reasons I can't track down, it no longer does... typical!)
Anyway, I instrumented piolib.py to make it spit out its working while deciding what libraries to use. The output revealed this:

{'owner': 'ESP32Async', 'name': 'ESPAsyncWebServer'}
{'name': 'ESPAsyncWebServer', 'version': Version('3.6.0'), 'owner': 'esp32async'}

Notice that the case of the owner is different between lines. This means the library is not recognised.
If I change the dependency to:

  "esp32async/ESPAsyncWebServer": "*"

Then it matches, the header is found, and the build continues (only to fail immediately with the AsyncTCP header for the same reason)

Also, if I make the dependency:

  "ESPAsyncWebServer": "*"

that seems to work too (and fail with AsyncTCP)

Finally, if I use:

   "mathieucarbou/ESPAsyncWebServer": "*"

Everything works perfectly (including AsyncTCP).

{'owner': 'mathieucarbou', 'name': 'ESPAsyncWebServer'}
{'name': 'ESPAsyncWebServer', 'version': Version('3.6.0'), 'owner': 'mathieucarbou'}

I guess the question therefore comes down to whether it's sensible and/or appropriate to have a package prefix in Capitals, when PlatformIO appears to have issues with this? Or maybe I've made some silly mistake and this was a giant waste of everyone's time.

[mathieucarbou]

Strange!
We are not aware of any issue like that.
I myself is using the library in many projects but I always fix the version Never use * otherwise your build is not reproductible.

You tried with that ?

lib_compat_mode = strict
lib_ldf_mode = chain

I saw also that PlatformIO registry seems to put all owner names in lowercase. But this is very strange if they are case sensitive for the dependency. Seems like a bug on platformio side to me because both GitHub and platform registry can be added with both esp32async and ESP32Async. They are case insensitive.

[einglis]

always fix the version Never use * otherwise your build is not reproductible

I like to live dangerously ;) But, yeah, that's good advice.

Setting a version and/or strict/chain didn't work.

You mentioned the PlatformIO registry, which is a good point; I had overlooked that it's a separate entity to this GitHub repo, even though it ultimately ends up with the same code. In any case, I've decided to manually specify both dependencies (in lower case):

    "esp32async/ESPAsyncWebServer": "3.6.0",
    "esp32async/ESPAsyncTCP": "2.0.0"

At some point, I'll get around to posting a PlatformIO issue/discussion. Thanks for your help.

[mathieucarbou]

You are using PlatformIO registry when declaring dependencies like that in the ini file.

It will then search for your dependencies here: https://registry.platformio.org/search?q=owner%3Aesp32async

What I do not get is the lower case requirements...

Libraries are deployed with the owner name ESP32Async, but platformio seems to put everything in lower case, but whether you use uppercase or lowercase in the url or search it sends up always lower case.

And in the library descriptor, this is ESP32Async, and the folder bane should be also camelcase.

I am really clueless.

All works fine for the many projects I have, but I am on Mac, and folders are case insensitive.

Are you on Linux perhaps?

[einglis]

Yeah, Linux. I did wonder about whether the filesystem case-sensitivity could be playing a part, but didn't dig.
The PC in question is currently dead (grrrr), but when I've recovered it, I'll take a look.

[mathieucarbou]

Thanks! Yes, that would be helpful!