Skip to content

fix: issue: [2717] coverage calculation improvements #2775

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 30, 2024
Merged

fix: issue: [2717] coverage calculation improvements #2775

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f2e0dc6
fix: issue: [2717] coverage calculation improvments
DanteUkraine May 30, 2024
f52942a
changeset
TuvalSimha May 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/eighty-dingos-end.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@graphql-inspector/coverage-command': minor
'@graphql-inspector/core': minor
---

Fix: coverage calculation improvements: Covered Queries & Covered Mutations & Covered Subscriptions
16 changes: 16 additions & 0 deletions packages/commands/coverage/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,14 +192,30 @@ function renderCoverage(coverage: SchemaCoverage) {
method: 'Total Queries',
result: String(coverage.stats.numQueries > 0 ? coverage.stats.numQueries : '0'),
},
{
method: 'Covered Queries',
result: String(coverage.stats.numCoveredQueries > 0 ? coverage.stats.numCoveredQueries : '0'),
},
{
method: 'Total Mutations',
result: String(coverage.stats.numMutations > 0 ? coverage.stats.numMutations : '0'),
},
{
method: 'Covered Mutations',
result: String(
coverage.stats.numCoveredMutations > 0 ? coverage.stats.numCoveredMutations : '0',
),
},
{
method: 'Total Subscriptions',
result: String(coverage.stats.numSubscriptions > 0 ? coverage.stats.numSubscriptions : '0'),
},
{
method: 'Covered Subscriptions',
result: String(
coverage.stats.numCoveredSubscriptions > 0 ? coverage.stats.numCoveredSubscriptions : '0',
),
},
];
Logger.table(logStatsResult);
Logger.log(``);
Expand Down
24 changes: 18 additions & 6 deletions packages/core/__tests__/coverage/coverage.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ describe('coverage', () => {

type Mutation {
submitPost(title: String!, author: String!): Post!
removePost(id: Int!): Post!
}

schema {
Expand Down Expand Up @@ -56,6 +57,10 @@ describe('coverage', () => {
id
}
}

mutation removePost {
removePost(id: 1)
}
`);

const results = coverage(schema, [new Source(print(doc))]);
Expand All @@ -78,7 +83,7 @@ describe('coverage', () => {
expect(results.types.Identifiable.children.id.hits).toEqual(1);
expect(results.types.Identifiable.children.createdAt.hits).toEqual(0);
// Mutation
expect(results.types.Mutation.hits).toEqual(1);
expect(results.types.Mutation.hits).toEqual(2);
expect(results.types.Mutation.children.submitPost.hits).toEqual(1);
expect(results.types.Mutation.children.submitPost.children.title.hits).toEqual(1);
expect(results.types.Mutation.children.submitPost.children.author.hits).toEqual(1);
Expand All @@ -87,8 +92,12 @@ describe('coverage', () => {
expect(results.stats.numTypes).toEqual(4);
expect(results.stats.numTypesCovered).toEqual(4);
expect(results.stats.numTypesCoveredFully).toEqual(1);
expect(results.stats.numFields).toEqual(14);
expect(results.stats.numFiledsCovered).toEqual(10);
expect(results.stats.numFields).toEqual(16);
expect(results.stats.numFiledsCovered).toEqual(12);
expect(results.stats.numQueries).toEqual(3);
expect(results.stats.numCoveredQueries).toEqual(2);
expect(results.stats.numMutations).toEqual(2);
expect(results.stats.numCoveredMutations).toEqual(2);
});

test('no coverage', () => {
Expand Down Expand Up @@ -121,11 +130,14 @@ describe('coverage', () => {
expect(results.stats.numTypes).toEqual(4);
expect(results.stats.numTypesCovered).toEqual(0);
expect(results.stats.numTypesCoveredFully).toEqual(0);
expect(results.stats.numFields).toEqual(14);
expect(results.stats.numFields).toEqual(16);
expect(results.stats.numFiledsCovered).toEqual(0);
expect(results.stats.numQueries).toEqual(1);
expect(results.stats.numQueries).toEqual(3);
expect(results.stats.numCoveredQueries).toEqual(0);
expect(results.stats.numSubscriptions).toEqual(0);
expect(results.stats.numMutations).toEqual(1);
expect(results.stats.numCoveredSubscriptions).toEqual(0);
expect(results.stats.numMutations).toEqual(2);
expect(results.stats.numCoveredMutations).toEqual(0);
});

test('introspection', () => {
Expand Down
46 changes: 32 additions & 14 deletions packages/core/src/coverage/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,11 @@ export interface SchemaCoverage {
numTypesCovered: number;
numFields: number;
numQueries: number;
numCoveredQueries: number;
numMutations: number;
numCoveredMutations: number;
numSubscriptions: number;
numCoveredSubscriptions: number;
numFieldsCovered: number;
numFiledsCovered: number; // @deprecated will be removed in next major version
};
Expand All @@ -85,8 +88,11 @@ export function coverage(schema: GraphQLSchema, sources: Source[]): SchemaCovera
numFieldsCovered: 0,
numFiledsCovered: 0,
numQueries: 0,
numCoveredQueries: 0,
numMutations: 0,
numCoveredMutations: 0,
numSubscriptions: 0,
numCoveredSubscriptions: 0,
},
};
const typeMap = schema.getTypeMap();
Expand All @@ -108,6 +114,18 @@ export function coverage(schema: GraphQLSchema, sources: Source[]): SchemaCovera
const fieldCoverage = typeCoverage.children[fieldDef.name];
const locations = fieldCoverage.locations[sourceName];

switch (typeCoverage.type.name) {
case 'Query':
coverage.stats.numCoveredQueries++;
break;
case 'Mutation':
coverage.stats.numCoveredMutations++;
break;
case 'Subscription':
coverage.stats.numCoveredSubscriptions++;
break;
}

typeCoverage.hits++;
fieldCoverage.hits++;

Expand Down Expand Up @@ -146,23 +164,23 @@ export function coverage(schema: GraphQLSchema, sources: Source[]): SchemaCovera
children: {},
};

if (isObjectType(type) || isInterfaceType(type)) {
switch (type.name) {
case 'Query':
coverage.stats.numQueries++;
break;
case 'Mutation':
coverage.stats.numMutations++;
break;
case 'Subscription':
coverage.stats.numSubscriptions++;
break;
}
}

const fieldMap = type.getFields();

for (const fieldname in fieldMap) {
if (isObjectType(type) || isInterfaceType(type)) {
switch (type.name) {
case 'Query':
coverage.stats.numQueries++;
break;
case 'Mutation':
coverage.stats.numMutations++;
break;
case 'Subscription':
coverage.stats.numSubscriptions++;
break;
}
}

const field = fieldMap[fieldname];

typeCoverage.children[field.name] = {
Expand Down
Loading