Revert "Revert "Use canonical path for symlinked subfolders in a project.""

Also remove the assertion, which is now no longer valid when we
use canonical paths for project folders. This is required to
find the correct include path for files in symlinked folders
in a project.

This reverts commit f4ed8c7e26b808fd70e21dad4f11897f878a6de6.