Project sidebar loading optimisation

[KaiTheRedNinja]

Description

TL;DR, I optimised the project navigator code so that dispatch sources (AKA watchers, the thing that listens for changes within folders) are only applied to visible folders, greatly reducing the number of watchers that need to be created. This reduces the chance of bumping into the macOS file opening limit (eg. 2559 on my system).

More details: When a folder is compressed, the watcher still stays activated. This is to avoid repeatedly creating and cancelling watchers, using up a lot of RAM. In the (now rare) case that there are no more open calls left (meaning more than 2559 items have been opened), the icon goes from folder or folder.fill to questionmark.folder to indicate that it is not being watched.

• CodeEditModules/Modules/WorkspaceClient/src/Live.swift
  • Moved file watching function to FileItem
  • Removed functionality of startListeningToDirectory
• CodeEditModules/Modules/WorkspaceClient/src/Model/FileItem.swift
  • Moved file watching function from WorkspaceClient
  • Added functionality to add a watcher if the image property is accessed, meaning that the fileItem is being displayed in the sidebar.

Related Issue

• 🐞 Open folder crash #677
• ✨ Project Navigator #351

Checklist

• Clean up code
• Test on large project
• I read and understood the contributing guide as well as the code of conduct
• My changes generate no new warnings
• My code builds and runs on my machine
• I documented my code
• Review requested

Screenshots

example of a NextJS project (with node modules) successfully opened in CodeEdit, with enough open calls left to open a few tabs. Only the 13 folders visible here have watchers attached to them, making about 29 watchers in total (CodeEdit itself requires about 16 files open for miscellaneous purposes), well below the 2559 item file limit of my system.

[KaiTheRedNinja]

In CodeEditModules/Modules/WorkspaceClient/src/Model/FileItem.swift, I have updated the image property again so that in the rare case that CodeEdit runs into the file limit, the default file icon is replaced by questionmark.folder to indicate that it is not being watched.

[KaiTheRedNinja]

for those interested, the number in this mock-up represents the file id of that file. When any of the folders are expanded, their child files will take the IDs of 20, 21, etc.

14 and 15 have a lower number than 16 despite being a layer lower because the watcher function relies on the order in which the FileItems are rendered in the OutlineView, and 13 was already expanded the last time I opened the workspace. These numbers are given out again when CodeEdit restarts, from top to bottom.

[Matejkob]

I'm on it

[Matejkob]

I have to say that your solution to fix this issue impressed me. Watching only visible items is pretty clever! 🚀