Skip to content

issue: [2717] coverage calculation improvments #2731

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.

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

Closed
Closed
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
474f7f4
coverage calculation improvments
May 23, 2024
1562c2c
updated changeset
DanteUkraine May 24, 2024
7cf40bf
Upgrade pnpm, bump Node engine and Yoga to version 5 (#2719)
TuvalSimha May 16, 2024
ecb9cfe
chore(release): update monorepo packages versions (#2727)
github-actions[bot] May 16, 2024
ea6785e
Test release: fix the release for config and loaders (#2733)
TuvalSimha May 26, 2024
a76766b
chore(release): update monorepo packages versions (#2734)
github-actions[bot] May 26, 2024
b32d5c2
Fix package version number (#2736)
TuvalSimha May 26, 2024
a7de909
chore(release): update monorepo packages versions (#2737)
github-actions[bot] May 26, 2024
e55d14d
Fix packages version for loaders + config (#2738)
TuvalSimha May 26, 2024
9a373d3
chore(release): update monorepo packages versions (#2739)
github-actions[bot] May 26, 2024
3abe4de
Fix loaders package version (#2740)
TuvalSimha May 26, 2024
8c3e1d9
chore(release): update monorepo packages versions (#2741)
github-actions[bot] May 26, 2024
ccc216a
chore(deps): update dependency typescript to v5.4.5 (#2726)
renovate[bot] May 26, 2024
43fe1dd
chore(deps): update dependency node to v20 (#2729)
renovate[bot] May 26, 2024
300046f
fix(deps): update graphql-tools (#2742)
renovate[bot] May 26, 2024
4949ea5
fix(deps): update dependency probot to v12.3.3 [security] (#2675)
renovate[bot] May 26, 2024
a3d0377
chore(deps): update dependency @changesets/cli to v2.27.3 (#2670)
renovate[bot] May 26, 2024
5844640
chore(deps): update dependency @types/body-parser to v1.19.5 (#2665)
renovate[bot] May 26, 2024
0009df8
chore(deps): update dependency @theguild/tailwind-config to v0.4.2 (#…
renovate[bot] May 26, 2024
38ded1d
chore(deps): update dependency @types/express to v4.17.21 (#2668)
renovate[bot] May 26, 2024
bb3f79e
Update all packages dependencies versions (#2747)
TuvalSimha May 26, 2024
e679de1
Docker: fix release flow (#2750)
TuvalSimha May 26, 2024
af66d3e
Fix Docker file release (#2751)
TuvalSimha May 26, 2024
5abf3ac
chore(release): update monorepo packages versions (#2743)
github-actions[bot] May 26, 2024
fabdab9
chore(deps): update dependency eslint to v8.57.0 (#2752)
renovate[bot] May 26, 2024
b22be15
chore(deps): update react monorepo (#2753)
renovate[bot] May 26, 2024
af3afa2
chore(deps): update dependency @types/react to v18.3.3 (#2754)
renovate[bot] May 27, 2024
703a381
fix: formatted with prettier
DanteUkraine May 27, 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
5 changes: 5 additions & 0 deletions .changeset/dry-cougars-hunt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@graphql-inspector/coverage-command': major
---

Extended operations coverage calculations
12 changes: 12 additions & 0 deletions packages/commands/coverage/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -192,14 +192,26 @@ 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
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
47 changes: 33 additions & 14 deletions packages/core/src/coverage/index.ts
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 @@ -103,11 +109,24 @@ export function coverage(schema: GraphQLSchema, sources: Source[]): SchemaCovera
fieldDef.name !== '__typename' &&
fieldDef.name !== '__schema'
) {

const sourceName = source.name;
const typeCoverage = coverage.types[parent.name];
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 +165,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