Skip to content

Commit 988df04

Browse files
authored
Change internal name for variant analysis SortKey values (#2380)
Follow-up to #2373
1 parent af75fa9 commit 988df04

File tree

7 files changed

+35
-35
lines changed

7 files changed

+35
-35
lines changed

extensions/ql-vscode/src/pure/variant-analysis-filter-sort.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ export enum FilterKey {
1111
}
1212

1313
export enum SortKey {
14-
Name = "name",
15-
Stars = "stars",
16-
LastUpdated = "lastUpdated",
17-
ResultsCount = "resultsCount",
14+
Alphabetically = "alphabetically",
15+
Popularity = "popularity",
16+
MostRecentCommit = "mostRecentCommit",
17+
NumberOfResults = "numberOfResults",
1818
}
1919

2020
export type RepositoriesFilterSortState = {
@@ -30,7 +30,7 @@ export type RepositoriesFilterSortStateWithIds = RepositoriesFilterSortState & {
3030
export const defaultFilterSortState: RepositoriesFilterSortState = {
3131
searchValue: "",
3232
filterKey: FilterKey.All,
33-
sortKey: SortKey.Name,
33+
sortKey: SortKey.Alphabetically,
3434
};
3535

3636
export function matchesFilter(
@@ -76,7 +76,7 @@ export function compareRepository(
7676
): (left: SortableRepository, right: SortableRepository) => number {
7777
return (left: SortableRepository, right: SortableRepository) => {
7878
// Highest to lowest
79-
if (filterSortState?.sortKey === SortKey.Stars) {
79+
if (filterSortState?.sortKey === SortKey.Popularity) {
8080
const stargazersCount =
8181
(right.stargazersCount ?? 0) - (left.stargazersCount ?? 0);
8282
if (stargazersCount !== 0) {
@@ -85,7 +85,7 @@ export function compareRepository(
8585
}
8686

8787
// Newest to oldest
88-
if (filterSortState?.sortKey === SortKey.LastUpdated) {
88+
if (filterSortState?.sortKey === SortKey.MostRecentCommit) {
8989
const lastUpdated =
9090
(parseDate(right.updatedAt)?.getTime() ?? 0) -
9191
(parseDate(left.updatedAt)?.getTime() ?? 0);
@@ -118,7 +118,7 @@ export function compareWithResults(
118118

119119
return (left: FilterAndSortableResult, right: FilterAndSortableResult) => {
120120
// Highest to lowest
121-
if (filterSortState?.sortKey === SortKey.ResultsCount) {
121+
if (filterSortState?.sortKey === SortKey.NumberOfResults) {
122122
const resultCount = (right.resultCount ?? 0) - (left.resultCount ?? 0);
123123
if (resultCount !== 0) {
124124
return resultCount;

extensions/ql-vscode/src/stories/variant-analysis/RepositoriesSort.stories.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ export default {
1919
} as ComponentMeta<typeof RepositoriesSortComponent>;
2020

2121
export const RepositoriesSort = () => {
22-
const [value, setValue] = useState(SortKey.Name);
22+
const [value, setValue] = useState(SortKey.Alphabetically);
2323

2424
return <RepositoriesSortComponent value={value} onChange={setValue} />;
2525
};

extensions/ql-vscode/src/view/variant-analysis/RepositoriesSort.tsx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ export const RepositoriesSort = ({ value, onChange, className }: Props) => {
2929
return (
3030
<Dropdown value={value} onInput={handleInput} className={className}>
3131
<Codicon name="sort-precedence" label="Sort..." slot="indicator" />
32-
<VSCodeOption value={SortKey.Name}>Alphabetically</VSCodeOption>
33-
<VSCodeOption value={SortKey.ResultsCount}>
32+
<VSCodeOption value={SortKey.Alphabetically}>Alphabetically</VSCodeOption>
33+
<VSCodeOption value={SortKey.NumberOfResults}>
3434
Number of results
3535
</VSCodeOption>
36-
<VSCodeOption value={SortKey.Stars}>Popularity</VSCodeOption>
37-
<VSCodeOption value={SortKey.LastUpdated}>
36+
<VSCodeOption value={SortKey.Popularity}>Popularity</VSCodeOption>
37+
<VSCodeOption value={SortKey.MostRecentCommit}>
3838
Most recent commit
3939
</VSCodeOption>
4040
</Dropdown>

extensions/ql-vscode/src/view/variant-analysis/__tests__/VariantAnalysisAnalyzedRepos.spec.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ describe(VariantAnalysisAnalyzedRepos.name, () => {
191191
render({
192192
filterSortState: {
193193
...defaultFilterSortState,
194-
sortKey: SortKey.Stars,
194+
sortKey: SortKey.Popularity,
195195
},
196196
});
197197

@@ -210,7 +210,7 @@ describe(VariantAnalysisAnalyzedRepos.name, () => {
210210
render({
211211
filterSortState: {
212212
...defaultFilterSortState,
213-
sortKey: SortKey.ResultsCount,
213+
sortKey: SortKey.NumberOfResults,
214214
},
215215
});
216216

extensions/ql-vscode/src/view/variant-analysis/__tests__/VariantAnalysisSkippedRepositoriesTab.spec.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ describe(VariantAnalysisSkippedRepositoriesTab.name, () => {
178178
},
179179
filterSortState: {
180180
...defaultFilterSortState,
181-
sortKey: SortKey.Stars,
181+
sortKey: SortKey.Popularity,
182182
},
183183
});
184184

@@ -190,7 +190,7 @@ describe(VariantAnalysisSkippedRepositoriesTab.name, () => {
190190
expect(rows[2]).toHaveTextContent("octodemo/hello-galaxy");
191191
});
192192

193-
it("does not use the result count sort key", async () => {
193+
it("does not use the 'number of results' sort key", async () => {
194194
render({
195195
alertTitle: "No database",
196196
alertMessage:
@@ -211,7 +211,7 @@ describe(VariantAnalysisSkippedRepositoriesTab.name, () => {
211211
},
212212
filterSortState: {
213213
...defaultFilterSortState,
214-
sortKey: SortKey.ResultsCount,
214+
sortKey: SortKey.NumberOfResults,
215215
},
216216
});
217217

extensions/ql-vscode/test/unit-tests/variant-analysis-filter-sort.test.ts

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ describe(compareRepository.name, () => {
130130
describe("when sort key is 'Alphabetically'", () => {
131131
const sorter = compareRepository({
132132
...defaultFilterSortState,
133-
sortKey: SortKey.Name,
133+
sortKey: SortKey.Alphabetically,
134134
});
135135

136136
const left = {
@@ -156,7 +156,7 @@ describe(compareRepository.name, () => {
156156
describe("when sort key is 'Popularity'", () => {
157157
const sorter = compareRepository({
158158
...defaultFilterSortState,
159-
sortKey: SortKey.Stars,
159+
sortKey: SortKey.Popularity,
160160
});
161161

162162
const left = {
@@ -202,7 +202,7 @@ describe(compareRepository.name, () => {
202202
describe("when sort key is 'Most recent commit'", () => {
203203
const sorter = compareRepository({
204204
...defaultFilterSortState,
205-
sortKey: SortKey.LastUpdated,
205+
sortKey: SortKey.MostRecentCommit,
206206
});
207207

208208
const left = {
@@ -274,7 +274,7 @@ describe(compareWithResults.name, () => {
274274
describe("when sort key is 'Popularity'", () => {
275275
const sorter = compareWithResults({
276276
...defaultFilterSortState,
277-
sortKey: SortKey.Stars,
277+
sortKey: SortKey.Popularity,
278278
});
279279

280280
const left = {
@@ -300,7 +300,7 @@ describe(compareWithResults.name, () => {
300300
describe("when sort key is 'Most recent commit'", () => {
301301
const sorter = compareWithResults({
302302
...defaultFilterSortState,
303-
sortKey: SortKey.LastUpdated,
303+
sortKey: SortKey.MostRecentCommit,
304304
});
305305

306306
const left = {
@@ -326,7 +326,7 @@ describe(compareWithResults.name, () => {
326326
describe("when sort key is results count", () => {
327327
const sorter = compareWithResults({
328328
...defaultFilterSortState,
329-
sortKey: SortKey.ResultsCount,
329+
sortKey: SortKey.NumberOfResults,
330330
});
331331

332332
const left = {
@@ -416,7 +416,7 @@ describe(filterAndSortRepositoriesWithResultsByName.name, () => {
416416
expect(
417417
filterAndSortRepositoriesWithResultsByName(repositories, {
418418
...defaultFilterSortState,
419-
sortKey: SortKey.ResultsCount,
419+
sortKey: SortKey.NumberOfResults,
420420
}),
421421
).toEqual([
422422
repositories[3],
@@ -432,7 +432,7 @@ describe(filterAndSortRepositoriesWithResultsByName.name, () => {
432432
expect(
433433
filterAndSortRepositoriesWithResultsByName(repositories, {
434434
...defaultFilterSortState,
435-
sortKey: SortKey.ResultsCount,
435+
sortKey: SortKey.NumberOfResults,
436436
searchValue: "la",
437437
}),
438438
).toEqual([repositories[2], repositories[0]]);
@@ -444,7 +444,7 @@ describe(filterAndSortRepositoriesWithResultsByName.name, () => {
444444
expect(
445445
filterAndSortRepositoriesWithResultsByName(repositories, {
446446
...defaultFilterSortState,
447-
sortKey: SortKey.ResultsCount,
447+
sortKey: SortKey.NumberOfResults,
448448
filterKey: FilterKey.WithResults,
449449
}),
450450
).toEqual([repositories[3], repositories[2], repositories[0]]);
@@ -455,7 +455,7 @@ describe(filterAndSortRepositoriesWithResultsByName.name, () => {
455455
it("returns the correct results", () => {
456456
expect(
457457
filterAndSortRepositoriesWithResultsByName(repositories, {
458-
sortKey: SortKey.ResultsCount,
458+
sortKey: SortKey.NumberOfResults,
459459
filterKey: FilterKey.WithResults,
460460
searchValue: "r",
461461
}),
@@ -501,7 +501,7 @@ describe(filterAndSortRepositoriesWithResults.name, () => {
501501
expect(
502502
filterAndSortRepositoriesWithResults(repositories, {
503503
...defaultFilterSortState,
504-
sortKey: SortKey.ResultsCount,
504+
sortKey: SortKey.NumberOfResults,
505505
}),
506506
).toEqual([
507507
repositories[3],
@@ -517,7 +517,7 @@ describe(filterAndSortRepositoriesWithResults.name, () => {
517517
expect(
518518
filterAndSortRepositoriesWithResults(repositories, {
519519
...defaultFilterSortState,
520-
sortKey: SortKey.ResultsCount,
520+
sortKey: SortKey.NumberOfResults,
521521
searchValue: "la",
522522
}),
523523
).toEqual([repositories[2], repositories[0]]);
@@ -529,7 +529,7 @@ describe(filterAndSortRepositoriesWithResults.name, () => {
529529
expect(
530530
filterAndSortRepositoriesWithResults(repositories, {
531531
...defaultFilterSortState,
532-
sortKey: SortKey.ResultsCount,
532+
sortKey: SortKey.NumberOfResults,
533533
filterKey: FilterKey.WithResults,
534534
}),
535535
).toEqual([repositories[3], repositories[2], repositories[0]]);
@@ -541,7 +541,7 @@ describe(filterAndSortRepositoriesWithResults.name, () => {
541541
expect(
542542
filterAndSortRepositoriesWithResults(repositories, {
543543
...defaultFilterSortState,
544-
sortKey: SortKey.ResultsCount,
544+
sortKey: SortKey.NumberOfResults,
545545
filterKey: FilterKey.WithResults,
546546
}),
547547
).toEqual([repositories[3], repositories[2], repositories[0]]);
@@ -553,7 +553,7 @@ describe(filterAndSortRepositoriesWithResults.name, () => {
553553
expect(
554554
filterAndSortRepositoriesWithResults(repositories, {
555555
...defaultFilterSortState,
556-
sortKey: SortKey.ResultsCount,
556+
sortKey: SortKey.NumberOfResults,
557557
filterKey: FilterKey.WithResults,
558558
searchValue: "r",
559559
}),
@@ -565,7 +565,7 @@ describe(filterAndSortRepositoriesWithResults.name, () => {
565565
it("returns the correct results", () => {
566566
expect(
567567
filterAndSortRepositoriesWithResults(repositories, {
568-
sortKey: SortKey.ResultsCount,
568+
sortKey: SortKey.NumberOfResults,
569569
filterKey: FilterKey.WithResults,
570570
searchValue: "la",
571571
repositoryIds: [

extensions/ql-vscode/test/vscode-tests/activated-extension/variant-analysis/variant-analysis-manager.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -750,7 +750,7 @@ describe("Variant Analysis Manager", () => {
750750
variantAnalysis.id,
751751
{
752752
...defaultFilterSortState,
753-
sortKey: SortKey.ResultsCount,
753+
sortKey: SortKey.NumberOfResults,
754754
},
755755
);
756756

0 commit comments

Comments
 (0)