Skip to content

Commit fcb1ef4

Browse files
koesie10koesie10
committed
Fix typings on Storybook stories
It seems like the Storybook stories were not being type-checked by CI and got out-of-sync with the required types. This fixes the types and also uses the factories to reduce the chance of this happening with future changes.
1 parent 5a2a9fc commit fcb1ef4

20 files changed

Lines changed: 350 additions & 377 deletions

‎extensions/ql-vscode/src/stories/variant-analysis/RepoRow.stories.tsx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ import {
88
VariantAnalysisScannedRepositoryDownloadStatus,
99
} from '../../remote-queries/shared/variant-analysis';
1010
import { AnalysisAlert, AnalysisRawResults } from '../../remote-queries/shared/analysis-result';
11+
import { createMockRepositoryWithMetadata } from '../../vscode-tests/factories/remote-queries/shared/repository';
1112

1213
import analysesResults from '../remote-queries/data/analysesResultsMessage.json';
1314
import rawResults from '../remote-queries/data/rawResults.json';
@@ -32,6 +33,7 @@ const Template: ComponentStory<typeof RepoRow> = (args) => (
3233
export const Pending = Template.bind({});
3334
Pending.args = {
3435
repository: {
36+
...createMockRepositoryWithMetadata(),
3537
id: 63537249,
3638
fullName: 'facebook/create-react-app',
3739
private: false,
@@ -99,6 +101,7 @@ SkippedOnlyFullName.args = {
99101
export const SkippedPublic = Template.bind({});
100102
SkippedPublic.args = {
101103
repository: {
104+
...createMockRepositoryWithMetadata(),
102105
fullName: 'octodemo/hello-globe',
103106
private: false,
104107
}
@@ -107,6 +110,7 @@ SkippedPublic.args = {
107110
export const SkippedPrivate = Template.bind({});
108111
SkippedPrivate.args = {
109112
repository: {
113+
...createMockRepositoryWithMetadata(),
110114
fullName: 'octodemo/hello-globe',
111115
private: true,
112116
}

‎extensions/ql-vscode/src/stories/variant-analysis/VariantAnalysis.stories.tsx‎

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,14 @@ import { ComponentMeta, ComponentStory } from '@storybook/react';
55
import { VariantAnalysis as VariantAnalysisComponent } from '../../view/variant-analysis/VariantAnalysis';
66
import {
77
VariantAnalysis as VariantAnalysisDomainModel,
8-
VariantAnalysisQueryLanguage,
98
VariantAnalysisRepoStatus,
109
VariantAnalysisScannedRepositoryDownloadStatus,
1110
VariantAnalysisScannedRepositoryResult,
1211
VariantAnalysisScannedRepositoryState,
1312
VariantAnalysisStatus
1413
} from '../../remote-queries/shared/variant-analysis';
14+
import { createMockVariantAnalysis } from '../../vscode-tests/factories/remote-queries/shared/variant-analysis';
15+
import { createMockRepositoryWithMetadata } from '../../vscode-tests/factories/remote-queries/shared/repository';
1516

1617
export default {
1718
title: 'Variant Analysis/Variant Analysis',
@@ -23,23 +24,19 @@ const Template: ComponentStory<typeof VariantAnalysisComponent> = (args) => (
2324
);
2425

2526
const variantAnalysis: VariantAnalysisDomainModel = {
26-
id: 1,
27+
...createMockVariantAnalysis(VariantAnalysisStatus.InProgress),
2728
controllerRepo: {
2829
id: 1,
2930
fullName: 'octodemo/variant-analysis-controller',
3031
private: false,
3132
},
3233
actionsWorkflowRunId: 789263,
33-
query: {
34-
name: 'Example query',
35-
filePath: 'example.ql',
36-
language: VariantAnalysisQueryLanguage.Javascript,
37-
},
3834
databases: {},
3935
status: VariantAnalysisStatus.InProgress,
4036
scannedRepos: [
4137
{
4238
repository: {
39+
...createMockRepositoryWithMetadata(),
4340
id: 1,
4441
fullName: 'octodemo/hello-world-1',
4542
private: false,
@@ -48,6 +45,7 @@ const variantAnalysis: VariantAnalysisDomainModel = {
4845
},
4946
{
5047
repository: {
48+
...createMockRepositoryWithMetadata(),
5149
id: 2,
5250
fullName: 'octodemo/hello-world-2',
5351
private: false,
@@ -56,6 +54,7 @@ const variantAnalysis: VariantAnalysisDomainModel = {
5654
},
5755
{
5856
repository: {
57+
...createMockRepositoryWithMetadata(),
5958
id: 3,
6059
fullName: 'octodemo/hello-world-3',
6160
private: false,
@@ -64,6 +63,7 @@ const variantAnalysis: VariantAnalysisDomainModel = {
6463
},
6564
{
6665
repository: {
66+
...createMockRepositoryWithMetadata(),
6767
id: 4,
6868
fullName: 'octodemo/hello-world-4',
6969
private: false,
@@ -72,6 +72,7 @@ const variantAnalysis: VariantAnalysisDomainModel = {
7272
},
7373
{
7474
repository: {
75+
...createMockRepositoryWithMetadata(),
7576
id: 5,
7677
fullName: 'octodemo/hello-world-5',
7778
private: false,
@@ -80,6 +81,7 @@ const variantAnalysis: VariantAnalysisDomainModel = {
8081
},
8182
{
8283
repository: {
84+
...createMockRepositoryWithMetadata(),
8385
id: 6,
8486
fullName: 'octodemo/hello-world-6',
8587
private: false,
@@ -88,6 +90,7 @@ const variantAnalysis: VariantAnalysisDomainModel = {
8890
},
8991
{
9092
repository: {
93+
...createMockRepositoryWithMetadata(),
9194
id: 7,
9295
fullName: 'octodemo/hello-world-7',
9396
private: false,
@@ -96,6 +99,7 @@ const variantAnalysis: VariantAnalysisDomainModel = {
9699
},
97100
{
98101
repository: {
102+
...createMockRepositoryWithMetadata(),
99103
id: 8,
100104
fullName: 'octodemo/hello-world-8',
101105
private: false,
@@ -104,6 +108,7 @@ const variantAnalysis: VariantAnalysisDomainModel = {
104108
},
105109
{
106110
repository: {
111+
...createMockRepositoryWithMetadata(),
107112
id: 9,
108113
fullName: 'octodemo/hello-world-9',
109114
private: false,
@@ -112,6 +117,7 @@ const variantAnalysis: VariantAnalysisDomainModel = {
112117
},
113118
{
114119
repository: {
120+
...createMockRepositoryWithMetadata(),
115121
id: 10,
116122
fullName: 'octodemo/hello-world-10',
117123
private: false,
@@ -135,18 +141,22 @@ const variantAnalysis: VariantAnalysisDomainModel = {
135141
repositoryCount: 4,
136142
repositories: [
137143
{
144+
...createMockRepositoryWithMetadata(),
138145
id: 100,
139146
fullName: 'octodemo/no-db-1'
140147
},
141148
{
149+
...createMockRepositoryWithMetadata(),
142150
id: 101,
143151
fullName: 'octodemo/no-db-2'
144152
},
145153
{
154+
...createMockRepositoryWithMetadata(),
146155
id: 102,
147156
fullName: 'octodemo/no-db-3'
148157
},
149158
{
159+
...createMockRepositoryWithMetadata(),
150160
id: 103,
151161
fullName: 'octodemo/no-db-4'
152162
}
@@ -156,6 +166,7 @@ const variantAnalysis: VariantAnalysisDomainModel = {
156166
repositoryCount: 1,
157167
repositories: [
158168
{
169+
...createMockRepositoryWithMetadata(),
159170
id: 201,
160171
fullName: 'octodemo/over-limit-1'
161172
}
@@ -165,6 +176,7 @@ const variantAnalysis: VariantAnalysisDomainModel = {
165176
repositoryCount: 1,
166177
repositories: [
167178
{
179+
...createMockRepositoryWithMetadata(),
168180
id: 205,
169181
fullName: 'octodemo/private'
170182
}

‎extensions/ql-vscode/src/stories/variant-analysis/VariantAnalysisAnalyzedRepos.stories.tsx‎

Lines changed: 54 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,12 @@ import { ComponentMeta, ComponentStory } from '@storybook/react';
55
import { VariantAnalysisContainer } from '../../view/variant-analysis/VariantAnalysisContainer';
66
import { VariantAnalysisAnalyzedRepos } from '../../view/variant-analysis/VariantAnalysisAnalyzedRepos';
77
import {
8-
VariantAnalysisQueryLanguage,
98
VariantAnalysisRepoStatus,
109
VariantAnalysisStatus
1110
} from '../../remote-queries/shared/variant-analysis';
1211
import { AnalysisAlert } from '../../remote-queries/shared/analysis-result';
12+
import { createMockVariantAnalysis } from '../../vscode-tests/factories/remote-queries/shared/variant-analysis';
13+
import { createMockRepositoryWithMetadata } from '../../vscode-tests/factories/remote-queries/shared/repository';
1314

1415
import analysesResults from '../remote-queries/data/analysesResultsMessage.json';
1516

@@ -35,73 +36,64 @@ const interpretedResultsForRepo = (nwo: string): AnalysisAlert[] | undefined =>
3536

3637
export const Example = Template.bind({});
3738
Example.args = {
38-
variantAnalysis: {
39-
id: 1,
40-
controllerRepo: {
41-
id: 1,
42-
fullName: 'octodemo/variant-analysis-controller',
43-
private: false,
44-
},
45-
query: {
46-
name: 'Query name',
47-
filePath: 'example.ql',
48-
language: VariantAnalysisQueryLanguage.Javascript,
49-
},
50-
databases: {},
51-
status: VariantAnalysisStatus.InProgress,
52-
scannedRepos: [
53-
{
54-
repository: {
55-
id: 63537249,
56-
fullName: 'facebook/create-react-app',
57-
private: false,
58-
},
59-
analysisStatus: VariantAnalysisRepoStatus.Succeeded, resultCount: 198,
39+
variantAnalysis: createMockVariantAnalysis(VariantAnalysisStatus.InProgress, [
40+
{
41+
repository: {
42+
...createMockRepositoryWithMetadata(),
43+
id: 63537249,
44+
fullName: 'facebook/create-react-app',
45+
private: false,
6046
},
61-
{
62-
repository: {
63-
id: 167174,
64-
fullName: 'jquery/jquery',
65-
private: false,
66-
},
67-
analysisStatus: VariantAnalysisRepoStatus.Succeeded,
68-
resultCount: 67,
47+
analysisStatus: VariantAnalysisRepoStatus.Succeeded, resultCount: 198,
48+
},
49+
{
50+
repository: {
51+
...createMockRepositoryWithMetadata(),
52+
id: 167174,
53+
fullName: 'jquery/jquery',
54+
private: false,
6955
},
70-
{
71-
repository: {
72-
id: 237159,
73-
fullName: 'expressjs/express',
74-
private: false,
75-
},
76-
analysisStatus: VariantAnalysisRepoStatus.Succeeded,
77-
resultCount: 26,
56+
analysisStatus: VariantAnalysisRepoStatus.Succeeded,
57+
resultCount: 67,
58+
},
59+
{
60+
repository: {
61+
...createMockRepositoryWithMetadata(),
62+
id: 237159,
63+
fullName: 'expressjs/express',
64+
private: false,
7865
},
79-
{
80-
repository: {
81-
id: 15062869,
82-
fullName: 'facebook/jest',
83-
private: false,
84-
},
85-
analysisStatus: VariantAnalysisRepoStatus.Failed,
66+
analysisStatus: VariantAnalysisRepoStatus.Succeeded,
67+
resultCount: 26,
68+
},
69+
{
70+
repository: {
71+
...createMockRepositoryWithMetadata(),
72+
id: 15062869,
73+
fullName: 'facebook/jest',
74+
private: false,
8675
},
87-
{
88-
repository: {
89-
id: 24195339,
90-
fullName: 'angular/angular',
91-
private: false,
92-
},
93-
analysisStatus: VariantAnalysisRepoStatus.InProgress,
76+
analysisStatus: VariantAnalysisRepoStatus.Failed,
77+
},
78+
{
79+
repository: {
80+
...createMockRepositoryWithMetadata(),
81+
id: 24195339,
82+
fullName: 'angular/angular',
83+
private: false,
9484
},
95-
{
96-
repository: {
97-
id: 24560307,
98-
fullName: 'babel/babel',
99-
private: false,
100-
},
101-
analysisStatus: VariantAnalysisRepoStatus.Pending,
85+
analysisStatus: VariantAnalysisRepoStatus.InProgress,
86+
},
87+
{
88+
repository: {
89+
...createMockRepositoryWithMetadata(),
90+
id: 24560307,
91+
fullName: 'babel/babel',
92+
private: false,
10293
},
103-
]
104-
},
94+
analysisStatus: VariantAnalysisRepoStatus.Pending,
95+
},
96+
]),
10597
repositoryResults: [
10698
{
10799
variantAnalysisId: 1,

0 commit comments

Comments
 (0)