Skip to content

Extension should notify users when their QL libraries are out of date #495

Open
@aeisenberg

Description

@aeisenberg

Background

Most users consume QL through the vscode-codeql-starter workspace. Some cli and ide features not work unless you have up to date QL libraries. Most users aren't aware of this and there is no mechanism to notify users that updates need to happen. The only situation where users are notified is when they add a new database built from a later version of the QL libraries. However, this is not sufficient.

Proposed solution

The extension should periodically check to see if there are new QL libraries available and warn the user if there are. Optionally, the extension could try to install the changes automatically. Otherwise, clear manual instructions should be given.

Caveats and questions

  1. This will only work for the vscode-codeql-starter workspace.
  2. What is considered a new version? We probably don't want to assume any change in master is new. Likely, we want to parse tags and look for new version numbers. Or we can do this through branches.
  3. We can attempt to automatically upgrade. This is just going to be pulling the submodules, which probably won't do any harm unless a user has made changes or commits to the core queries.

It might look like this:

  1. On restart or periodically, fetch the tags for submodules
  2. Check to see if any new tagged version exists.
  3. If so prompt the user to update their libraries
  4. Ensure there is clear instuctions on how to do this.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions