search

microsoft / AL

Home of the Dynamics 365 Business Central AL Language extension for Visual Studio Code. Used to track issues regarding the latest version of the AL compiler and developer tools available in the Visual Studio Code Marketplace or as part of the AL Developer Preview builds for Dynamics 365 Business Central.
MIT License
748 stars 245 forks source link

AL languages internal cache is not always correctly refreshed #7891

Open Thomas-Torggler-EOS opened 3 weeks ago

Thomas-Torggler-EOS commented 3 weeks ago

1. Describe the bug The AL language editor host executable has an internal cache where it holds things like referenced symbols and project symbols and so on. I assume for performance reasons. This cache however is not always refreshed correctly and requires the user to run a "Reload Window" or reload the entire project workspace to refresh it.

I have a few scenarios where this happens and is a problem for me:

  1. When I externally download symbols they are not detected by AL language.
  2. Modifying the app.json triggers a cache refresh, but only when done so from inside VS Code. If app.json is modified externally, AL language does not detect a change to it and thus does not refresh anything.
  3. Switching branches in git causes the cache of the AL language to become stale. The symbols in it's cache still refer to the old version of my objects. This until I either reload the project (as described above) or I open the object in question. This however refreshes the cache for this object only.

2. To Reproduce Steps to reproduce the behavior:

Scenario 1:

  1. Download a symbol package manually from somewhere and place it in the .alpackages folder.
  2. The new symbol package is not detected.

Scenario 2:

  1. Use a project with a dependency to an app that you already have in your .alpackages folder.
  2. Update the minimum version to something higher that is not available.
  3. You correctly get an error stating that symbols are missing.
  4. Externally modify app.json and reset the version to what it was before.
  5. The symbol is still missing according to AL language.

Scenario 3:

  1. Work on a feature branch where you removed a method from an object.
  2. Close the editor for that object.
  3. Switch back to a different branch where the method from 1 still exists.
  4. Go to a different object and reference this method.
  5. AL language argues that this method does not exist, but it does.

3. Expected behavior Option 1: detect file changes even when made from outside the project. There are numerous tools around now that interface with AL projects, tying it's caching mechanism to only what happens under AL languages watch is very limiting. You could, for example, bind this to the app.json file only. Anyone who wants to cause a cache refresh from outside VS Code then just has to touch that file and you would not have to watch all project files for changes. Option 2: give us a command that let's us explicitly cause a cache refresh without having to reload the entire editor. This command would then also be required to be callable from other extensions, pretty please.

4. Actual behavior The cache often becomes stale and requires me to reload my editor, causing lots of reload times.

5. Versions:

BazookaMusic commented 2 weeks ago

I'll accept this since I think it's worth investing into this. However, the issue is not caching. The problem is that the extension and VSCode are not processing external changes properly.

We'll definitely work on improving the GitHub branch change scenario. For the symbols, it is possible that this is a larger investment which might take more time.

Thomas-Torggler-EOS commented 2 weeks ago

As far as symbols go, I do think it is (somewhat) a caching problem:

If we had a command in VSCode that would replicate this, at least the symbols could be manually refreshed.

As far as the source files go, I did not investigate and that is surely a different kind of behaviour / issue.

kalberes commented 2 weeks ago

Agree with @BazookaMusic . We will try to make github branch changes not to blow up the language server and the diagnostics service. Exposing the command is a bit more complicated. There are more then just what you wrote. There are coupling to other subsystems like the project system, diagnostics service, tracking compilation. It makes things a bit more complicated to be treated as a simple bug.