🐛 BUG: Relative imports path do not work in windows

[hinogi]

In windows the import paths do not get resolved but get taken as is.

so somehing like

imports:
 - '../something/something.glossary.yml'

is turned into something like C:\Users\something\project\../something/something.glossary.yml

[hinogi]

If you would have only wrote this thing not in fs but in node :D

[chrissimon-au]

Hi @hinogi , although the logs will show the mixed paths, from my testing this should still work - there is a sample in the test fixtures that imports from a relative path and from what I can tell it is working on windows - can you confirm that it's definitely not loading the imported glossary?

See https://github.com/dev-cycles/contextive/tree/main/src/vscode/contextive/test/single-root/fixtures/simple_workspace/ECommerce/ShippingDemo/antiCorruptionLayer

Due to the bug you've found on #97 can you double check by reloading after setting up the imports configuration?

[chrissimon-au]

Also, I've just checked, and if you're on windows, you should be able to use:

imports:
 - ..\something\something.glossary.yml

although pls note that if you use double quotes you'll need to escape the backslashes:

imports:
 - "..\\something\\something.glossary.yml"

although that will probably not work if you have colleagues on mac or linux.

For that reason, the forward slash path is suggested for the repository, and it should still work on windows as noted above - can you confirm if it is or isn't working for you?

[hinogi]

nope tried that alread

[hinogi]

Error loading glossary file: Glossary file not found

[chrissimon-au]

What does it show in the lines above that - i.e. Loading contextive from... ?

On a test I just did, I got:

[Info - 12:02:03 AM] Starting Contextive.LanguageServer v1.16.1+6fadfc98ec81476175676f167ec162c1860a26b2...
Loading contextive from z:\contextive-community\src\vscode\contextive\test\single-root\fixtures\simple_workspace\ECommerce\ShippingDemo/shipping.glossary.yml...
Loading contextive from z:\contextive-community\src\vscode\contextive\test\single-root\fixtures\simple_workspace\ECommerce\ShippingDemo/antiCorruptionLayer/import-payments.glossary.yml...
Loading contextive from z:\contextive-community\src\vscode\contextive\test\single-root\fixtures\simple_workspace\ECommerce\PaymentsDemo/payments.glossary.yml...
Loading contextive from z:\contextive-community\src\vscode\contextive\test\single-root\fixtures\simple_workspace\ECommerce\.contextive\definitions.yml...
No glossary file configured, and default file not found.
Successfully loaded.
Loading contextive from z:\contextive-community\src\vscode\contextive\test\single-root\fixtures\simple_workspace\ECommerce\ShippingDemo\antiCorruptionLayer\..\..\PaymentsDemo\payments.glossary.yml...
Successfully loaded.
Successfully loaded.
Successfully loaded.

The No glossary file configured, and default file not found is because of the attempt to look for the old default file .contextive\definitions.yml, but the rest of the files, including the imported relative paths file are successfully loaded...

Could you try checking out the repo and opening the src\vscode\contextive\test\single-root\fixtures\simple_workspace\ECommerce folder and pasting the whole contextive log?

The log above is running on windows, after loading that folder and changing ShippingDemo\antiCorruptionLayer\import-payments.glossary.yml to use backslashes instead of forward slashes and reloading.

[hinogi]

[Info - 1:59:51 PM] Starting Contextive.LanguageServer v1.16.1+6fadfc98ec81476175676f167ec162c1860a26b2...
Loading contextive from c:\Users\<user>\<project>\apps/backend/backend.glossary.yml...
Loading contextive from c:\Users\<user>\<project>\apps/frontend/frontend.glossary.yml...
Loading contextive from c:\Users\<user>\<project>\node_modules/.pnpm/node_modules/<project>/backend/backend.glossary.yml...
Loading contextive from c:\Users\<user>\<project>\node_modules/.pnpm/node_modules/<project>/frontend.glossary.yml...
Loading contextive from c:\Users\<user>\<project>\.contextive\definitions.yml...
No glossary file configured, and default file not found.
Successfully loaded.
Successfully loaded.
Successfully loaded.
Successfully loaded.
Loading contextive from c:\Users\<user>\<project>\apps\frontend\..\backend\backend.glossary.yml...
Loading contextive from c:\Users\<user>\<project>\node_modules\.pnpm\node_modules\<project>\..\backend\backend.glossary.yml...
[Error - 2:00:04 PM] Error loading glossary file: Glossary file not found.
Successfully loaded.

[chrissimon-au]

Ah! That is interesting - it seems that you are using a pnpm workspace?

It is loading c:\Users\<user>\<project>\apps/frontend/frontend.glossary.yml

but also, it is loading c:\Users\<user>\<project>\node_modules/.pnpm/node_modules/<project>/frontend.glossary.yml

If we look at the logs, we can see an attempt to load the bakend glossary from a relative path in two locations. One is successful (the one in the primary workspace folder) and the other is not (from the node_modules folder).

Loading contextive from c:\Users\<user>\<project>\apps\frontend\..\backend\backend.glossary.yml...
Loading contextive from c:\Users\<user>\<project>\node_modules\.pnpm\node_modules\<project>\..\backend\backend.glossary.yml...
[Error - 2:00:04 PM] Error loading glossary file: Glossary file not found.
Successfully loaded.

I believe this is because the links in the node_modules folder are not in the same relative positions in the folder hierarchy.

This is very helpful, thank you - I will try and recreate locally with a pnpm workspaces configuration and see what I can do.

I think perhaps the simplest would be to ignore node_modules - we should really only be loading the primary files as that is where users will be looking to work out how to configure relative files.

One further thing - since at least some of the files are loading, I'm surprised that the hover tooltip isn't working when hovering over terminology in frontend.glossary.yml or any files adjacent to it in the hierarchy...

[hinogi]

Actually I do not use pnpm workspaces I use nx

[chrissimon-au]

OK, thanks for confirming. Let me see if I can replicate and will update you.

[chrissimon-au]

Hi @hinogi, v1.17.7 now respects the .gitignore file when searching for glossary files which means it shouldn't load the glossary copies from the node_modules folder which should mean the relative paths are respected.

Would you mind updating and trying again and seeing if it resolves your issue?