Skip to content

Commit 800c9e0

Browse files
committed
Remove deprecated comments
Also, change interpolation of result count. For Remote queries, this value will be empty. For local queries, use the label `X results`, where `X` is the number of results for this query.
1 parent f1c4fef commit 800c9e0

4 files changed

Lines changed: 11 additions & 12 deletions

File tree

extensions/ql-vscode/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@
225225
},
226226
"codeQL.queryHistory.format": {
227227
"type": "string",
228-
"default": "%q on %d - %s, %r result count [%t]",
228+
"default": "%q on %d - %s, %r [%t]",
229229
"markdownDescription": "Default string for how to label query history items.\n* %t is the time of the query\n* %q is the human-readable query name\n* %f is the query file name\n* %d is the database name\n* %r is the number of results\n* %s is a status string"
230230
},
231231
"codeQL.queryHistory.ttl": {

extensions/ql-vscode/src/history-item-label-provider.ts

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
import { env } from 'vscode';
2+
import * as path from 'path';
23
import { QueryHistoryConfig } from './config';
34
import { LocalQueryInfo, QueryHistoryInfo } from './query-results';
45
import { RemoteQueryHistoryItem } from './remote-queries/remote-query-history-item';
56

67
interface InterpolateReplacements {
78
t: string; // Start time
89
q: string; // Query name
9-
d: string; // Database/List name
10-
r: string; // Result count
10+
d: string; // Database/Controller repo name
11+
r: string; // Result count/Empty
1112
s: string; // Status
12-
f: string; // Query file path
13+
f: string; // Query file name
1314
'%': '%'; // Percent sign
1415
}
1516

@@ -56,7 +57,7 @@ export class HistoryItemLabelProvider {
5657
t: item.startTime,
5758
q: item.getQueryName(),
5859
d: item.initialInfo.databaseInfo.name,
59-
r: resultCount.toString(),
60+
r: `${resultCount} results`,
6061
s: statusString,
6162
f: item.getQueryFileName(),
6263
'%': '%',
@@ -74,7 +75,7 @@ export class HistoryItemLabelProvider {
7475
// There is no synchronous way to get the results count.
7576
r: '',
7677
s: item.status,
77-
f: item.remoteQuery.queryFilePath,
78+
f: path.basename(item.remoteQuery.queryFilePath),
7879
'%': '%'
7980
};
8081
}

extensions/ql-vscode/src/query-history.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -652,13 +652,11 @@ export class QueryHistoryManager extends DisposableObject {
652652
): Promise<void> {
653653
const { finalSingleItem, finalMultiSelect } = this.determineSelection(singleItem, multiSelect);
654654

655-
// TODO will support remote queries
656655
if (!this.assertSingleQuery(finalMultiSelect)) {
657656
return;
658657
}
659658

660659
const response = await window.showInputBox({
661-
// prompt: 'Label:',
662660
placeHolder: `(use default: ${this.queryHistoryConfigListener.format})`,
663661
value: finalSingleItem.userSpecifiedLabel ?? '',
664662
title: 'Set query label',

extensions/ql-vscode/src/vscode-tests/no-workspace/history-item-label-provider.test.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ describe('HistoryItemLabelProvider', () => {
2727
expect(labelProvider.getLabel(fqi)).to.eq('xxx');
2828

2929
fqi.userSpecifiedLabel = '%t %q %d %s %f %r %%';
30-
expect(labelProvider.getLabel(fqi)).to.eq(`${dateStr} query-name db-name in progress query-file.ql 456 %`);
30+
expect(labelProvider.getLabel(fqi)).to.eq(`${dateStr} query-name db-name in progress query-file.ql 456 results %`);
3131

3232
fqi.userSpecifiedLabel = '%t %q %d %s %f %r %%::%t %q %d %s %f %r %%';
33-
expect(labelProvider.getLabel(fqi)).to.eq(`${dateStr} query-name db-name in progress query-file.ql 456 %::${dateStr} query-name db-name in progress query-file.ql 456 %`);
33+
expect(labelProvider.getLabel(fqi)).to.eq(`${dateStr} query-name db-name in progress query-file.ql 456 results %::${dateStr} query-name db-name in progress query-file.ql 456 results %`);
3434
});
3535

3636
it('should interpolate query when not user specified', () => {
@@ -40,10 +40,10 @@ describe('HistoryItemLabelProvider', () => {
4040

4141

4242
config.format = '%t %q %d %s %f %r %%';
43-
expect(labelProvider.getLabel(fqi)).to.eq(`${dateStr} query-name db-name in progress query-file.ql 456 %`);
43+
expect(labelProvider.getLabel(fqi)).to.eq(`${dateStr} query-name db-name in progress query-file.ql 456 results %`);
4444

4545
config.format = '%t %q %d %s %f %r %%::%t %q %d %s %f %r %%';
46-
expect(labelProvider.getLabel(fqi)).to.eq(`${dateStr} query-name db-name in progress query-file.ql 456 %::${dateStr} query-name db-name in progress query-file.ql 456 %`);
46+
expect(labelProvider.getLabel(fqi)).to.eq(`${dateStr} query-name db-name in progress query-file.ql 456 results %::${dateStr} query-name db-name in progress query-file.ql 456 results %`);
4747
});
4848

4949
it('should get query short label', () => {

0 commit comments

Comments
 (0)