Extension does not properly start when no CodeQL CLI is found
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 38/100
- issue の種類
- バグ
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- typescript, vscode
- 領域
- devtools
調査の方向性
拡張機能の起動フロー、CodeQL CLI の実行可能ファイルパスの処理、および再現手順で説明されている更新チェックの経路から始めます。無効な CLI パスの場合とダウンロードフォルダーを削除した場合に再現し、その後ログと「CodeQL: Quick query」コマンドの動作を確認します。完了の条件は、起動時に CLI が見つからないことを報告し、設定されたパスを尊重し、設定を変更しなくてもインストール操作が機能することです。
索引モデルが issue の本文から書いたものです。
説明
Describe the bug
It looks like when no CodeQL CLI is found on start up the extension does not start properly. This is noticable as:
- No "CodeQL" / "CodeQL CLI v ..." is shown in the bottom right corner
- CodeQL CLI is not downloaded automatically? See #900
- Once an extension config change is made, the extension seems to start properly, downloading CodeQL CLI; even if the config change was specifying a custom CodeQL CLI executable path
Edit: Might only occur when update check was performed recently and the following was logged:
Didn't perform CodeQL CLI update check since a check was already performed within the previous 86400 seconds.
Version
Extension:
CodeQL extension version: 1.5.1
CodeQL CLI version: 2.5.7
Platform: win32 x64
VSCode:
Version: 1.57.1 (user setup)
Commit: 507ce72a4466fbb27b715c3722558bb15afa9f48
Date: 2021-06-17T13:28:07.755Z
Electron: 12.0.7
Chrome: 89.0.4389.128
Node.js: 14.16.0
V8: 8.9.255.25-electron.0
OS: Windows_NT x64 10.0.19041
To reproduce
Prerequisites:
Extension is already installed and the default CodeQL CLI has been downloaded by the extension already.
- Open the CodeQL extension settings (
@ext:github.vscode-codeql) - Change "CodeQL > CLI: Executable Path" to an invalid path
- Restart VSCode
- Trigger loading of extensions, e.g. by clicking on CodeQL icon on the left sidebar
❌ Notice how neither an error dialog is shown, nor does the "CodeQL" info text in the bottom right corner appear.
The logs show that the extension failed finding the CodeQL CLI.
ℹ️ Only in case you had not downloaded CodeQL CLI yet and the executable path is empty it shows the error "The CodeQL CLI could not be found." - Run an extension command such as "CodeQL: Quick query"; on the error message click "Install CodeQL CLI"
❌ Nothing happens - Stop VSCode
- Open the CodeQL CLI download folder; on Windows
%appdata%\Code\User\globalStorage\github.vscode-codeql - Delete or rename the distribution folder
- Start VSCode again
- Open the CodeQL extension settings (
@ext:github.vscode-codeql) - Change "CodeQL > CLI: Executable Path" to any non-empty path
❌ Instead of checking whether the CodeQL CLI exists at the specified path, the extension starts downloading the default CodeQL CLI
Expected behavior
The extension should properly start even without CodeQL CLI; all the incorrect behavior described above (marked with ❌) should not happen.
- 主要言語
- TypeScript
- スター
- 539
- フォーク
- 240
- 平均マージ
- 2日 18時間
- マージ済み PR(30日)
- 37
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
github/vscode-codeql のほかの issue
-
bug VSCode
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
github/vscode-codeql#4471 · コメント 1 件 ·
-
bug enhancement VSCode
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
github/vscode-codeql#592 · コメント 2 件 ·
-
enhancement VSCode
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
github/vscode-codeql#4432 · コメント 1 件 ·
-
bug VSCode
難易度 3/5 1〜2日 初心者へのやさしさ 52/100
github/vscode-codeql#4356 ·
-
bug VSCode
難易度 3/5 1〜2日 初心者へのやさしさ 64/100
github/vscode-codeql#4339 · コメント 1 件 ·
github/vscode-codeql の issue をすべて見る
似ている issue
-
blocklist removal
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
MetaMask/eth-phishing-detect#296544 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
pastelsky/bundlephobia#1122 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
-
category/development priority/P2 scope/file-operations scope/testing type/enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
Enatega Customer and Rider app: Add-ons price is not visible to customer after order is placed. オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100