feat: added new evaluate command to check the score of the asyncapi document #1413

AayushSaini101 · 2024-05-08T12:56:49Z

Resolves: #1131

Started implementing new command to evaluate the asyncapi file:
Use four parameters to describe the score of file:

 if (document?.info().hasDescription()) {
      scoreEvalate+=0.15;
    }
    if (document?.info().hasLicense()) {
      scoreEvalate+=0.25;
    }
    if (!document?.servers().isEmpty()) {
      scoreEvalate+=0.25;
    }
    if (!document?.channels().isEmpty()) {
      scoreEvalate+=0.35;
    }
    const finalScore = (scoreEvalate/1)*100;

Shurtu-gal · 2024-05-08T13:17:24Z

@AayushSaini101 do we need a new command for the linked issue ?

AayushSaini101 · 2024-05-08T15:57:04Z

#1131

I guess it would be if we add new command for this, What do you think ? @Amzani @peter-rr @Souvikns

Shurtu-gal · 2024-05-08T16:42:48Z

#1131

I guess it would be if we add new command for this, What do you think ? @Amzani @peter-rr @Souvikns

Was seeing the incorrect issue then 👍🏻

Amzani · 2024-05-13T10:09:44Z

src/commands/evaluate.ts

+    }
+    const finalScore = (scoreEvaluate/1)*100;
+
+    this.log('The score of the asyncapi document is ', +finalScore);


@AayushSaini101 check if we can use the new UI library for this (see #1214)

Amzani · 2024-05-13T10:13:18Z

@AayushSaini101 do we need a new command for the linked issue ?

This might be used under validate command, however, for a better DX and maintainability having a dedicated command looks like a better approach.

Shurtu-gal · 2024-05-13T14:40:41Z

@AayushSaini101 do we need a new command for the linked issue ?

This might be used under validate command, however, for a better DX and maintainability having a dedicated command looks like a better approach.

Agreed, how about adding it as a flag --evaluate. Any way parsing will be done for both validate and evaluate. Could think some more ideas 🤔.

peter-rr · 2024-05-13T17:19:08Z

IMO, I would opt for just adding a flag to validate command since the feature to be added should work like an extension for the validation process. Also I think --score would be semantically more clear and easier to understand than --evaluate. So the resulting command could be something like asyncapi validate --score.

WDYT? @AayushSaini101 @Amzani @Shurtu-gal

peter-rr · 2024-05-13T17:24:43Z

src/commands/evaluate.ts

+    if (!document?.channels().isEmpty()) {
+      scoreEvaluate+=0.35;
+    }
+    const finalScore = (scoreEvaluate/1)*100;


Why is it necessary to divide scoreEvaluate by 1? I guess I'm missing something 🤔

@peter-rr In the initial stage, the total weight of the coefficient is 1 that's why we need to divide the sum by 1, to get 100 Score for a valid asyncapi document.

Amzani · 2024-05-14T10:15:15Z

IMO, I would opt for just adding a flag to validate command since the feature to be added should work like an extension for the validation process. Also I think --score would be semantically more clear and easier to understand than --evaluate. So the resulting command could be something like asyncapi validate --score.

Evaluation and Validation are closely related, having asyncapi validate --score looks good to me as long as we can make the new feature easily maintainable, and users can discover it.

Shurtu-gal · 2024-05-17T14:18:23Z

/update

There are some issues with sonar-cloud as well @AayushSaini101.

AayushSaini101 · 2024-05-18T06:13:19Z

@Shurtu-gal @Amzani @Souvikns I have added score flag in the existing validate command, and added a test case to verify the score and command. Ready for review. : ) Thanks

Amzani · 2024-05-20T08:51:02Z

src/commands/validate.ts

@@ -4,6 +4,24 @@ import { validate, validationFlags, ValidateOptions, ValidationStatus } from '..
 import { load } from '../models/SpecificationFile';
 import { specWatcher } from '../globals';
 import { watchFlag } from '../flags';
+import { Parser} from '@asyncapi/parser/cjs';


Not sure if you need all this code from line 7 to line 24, why you don't just use the exported function available to you in parser.ts

import { parse } from '../parser';

Thanks, I missed that Done @Amzani

src/commands/validate.ts

Amzani · 2024-05-20T08:59:52Z

src/utils/parsingFile.ts

@@ -0,0 +1,49 @@
+import { load } from 'js-yaml';


We already have this logic in src/parser.ts no?

Reverted thanks

Amzani · 2024-05-20T09:02:50Z

src/commands/validate.ts

@@ -35,4 +61,26 @@ export default class Validate extends Command {
      process.exitCode = 1;
    }
  }
+
+  private async calculateScore(filePath:string) {


I suggest to extract the score logic and move it under models or utils for now. It will make this #1200 easy.

Moved to Utils Thanks

Shurtu-gal · 2024-05-27T15:22:02Z

src/utils/scoreCalculator.ts

+  }
+  const finalScore = (scoreEvaluate / 1) * 100;
+
+  return `The score of the asyncapi document is ${finalScore}`;


How about returning the score instead of a log string. As this makes it easier to use later in another scenarios if we want.

@Shurtu-gal In my opinion, proper logging would be better that enhanve the developer experience as well. @Amzani What do you think on this ?

Yeah, I am not suggesting to take out the log message, just return the score from this function. And put logging where this function is consumed.

This way this function can be reused if needed.

Done @Shurtu-gal thanks : )

Shurtu-gal

LGTM from my side. 🚀

Let's wait for @Amzani as well.

Amzani

Great PR! only thing missing for me is describing how score is calculated for users.

Amzani · 2024-06-05T09:10:45Z

src/commands/validate.ts

@@ -12,17 +13,27 @@ export default class Validate extends Command {
    help: Flags.help({ char: 'h' }),
    watch: watchFlag(),
    ...validationFlags(),
+    score: Flags.boolean({
+      description: 'Compute the score of the AsyncAPI document',


Users might might not understand how score is calculated, could we add more description and details about that ?

Done @Amzani

AayushSaini101 · 2024-06-07T08:40:20Z

@Shurtu-gal @Amzani Ready for review. Hopefull for the last review cycle :)

peter-rr · 2024-06-12T08:36:27Z

/update

peter-rr

Left a couple of small suggestions :)

peter-rr · 2024-06-12T09:08:21Z

test/integration/validate.test.ts

@@ -245,4 +245,23 @@ describe('validate', () => {
        done();
      });
  });
+  // The score of the asyncapi document is 50


I guess we can omit this comment and update line 262 with the correct value instead, since that line is already explanatory itself.

Removed thanks @peter-rr

src/core/flags/validate.flags.ts

Co-authored-by: Pedro Ramos <[email protected]>

sonarcloud · 2024-06-12T09:46:30Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

peter-rr

LGTM 🚀

Amzani

LGTM 🚀

Shurtu-gal · 2024-07-31T05:18:19Z

/u

Shurtu-gal

LGTM

sonarcloud · 2024-07-31T05:19:01Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

Shurtu-gal · 2024-07-31T05:23:42Z

/rtm

asyncapi-bot · 2024-07-31T05:30:11Z

🎉 This PR is included in version 2.2.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

AayushSaini101 requested review from Souvikns, Amzani, Shurtu-gal and asyncapi-bot-eve as code owners May 8, 2024 12:56

AayushSaini101 marked this pull request as draft May 8, 2024 12:56

AayushSaini101 marked this pull request as ready for review May 10, 2024 09:11

Amzani reviewed May 13, 2024

View reviewed changes

peter-rr reviewed May 13, 2024

View reviewed changes

Amzani requested changes May 20, 2024

View reviewed changes

AayushSaini101 requested review from peter-rr and Amzani May 27, 2024 11:17

Shurtu-gal requested changes May 27, 2024

View reviewed changes

AayushSaini101 requested a review from Shurtu-gal May 31, 2024 11:11

Shurtu-gal previously approved these changes May 31, 2024

View reviewed changes

AayushSaini101 mentioned this pull request Jun 1, 2024

Improve design of CLI commands structure #551

Closed

Amzani requested changes Jun 5, 2024

View reviewed changes

AayushSaini101 dismissed Shurtu-gal’s stale review via 3a69ed6 June 6, 2024 16:47

AayushSaini101 added 4 commits June 6, 2024 22:25

Added new evaluate command to check the score of the asyncapi document

8ed3338

Update score and log

18486ea

rename variable name

a3a28c4

Add test case

2e88027

AayushSaini101 added 3 commits June 6, 2024 22:26

Fix test case issue

c081176

update the description of the validate flag

4260d66

fix build error

0c3d245

AayushSaini101 force-pushed the featureScore branch from 12b0927 to 0c3d245 Compare June 6, 2024 17:07

AayushSaini101 added 3 commits June 7, 2024 13:41

fix error

1c6531d

remove file

f809636

Add Description of the message and resolve build failure

13f2db7

AayushSaini101 requested review from Amzani and Shurtu-gal June 7, 2024 08:40

Merge branch 'master' into featureScore

0f96811

AayushSaini101 mentioned this pull request Jun 11, 2024

Create create-template in AsyncAPI organization #337

Closed

Merge branch 'master' into featureScore

f019d72

peter-rr suggested changes Jun 12, 2024

View reviewed changes

AayushSaini101 and others added 2 commits June 12, 2024 15:15

Update src/core/flags/validate.flags.ts

fc854dc

Co-authored-by: Pedro Ramos <[email protected]>

remove comment from test case

b973de1

AayushSaini101 requested a review from peter-rr June 12, 2024 09:48

peter-rr approved these changes Jun 13, 2024

View reviewed changes

Amzani approved these changes Jul 30, 2024

View reviewed changes

Merge branch 'master' into featureScore

a629107

Shurtu-gal approved these changes Jul 31, 2024

View reviewed changes

asyncapi-bot added the ready-to-merge label Jul 31, 2024

asyncapi-bot merged commit 0368d64 into asyncapi:master Jul 31, 2024
11 checks passed

asyncapi-bot added the released label Jul 31, 2024

feat: added new evaluate command to check the score of the asyncapi document #1413

feat: added new evaluate command to check the score of the asyncapi document #1413

Conversation

AayushSaini101 commented May 8, 2024 • edited Loading

Shurtu-gal commented May 8, 2024

AayushSaini101 commented May 8, 2024

Shurtu-gal commented May 8, 2024

Choose a reason for hiding this comment

Amzani commented May 13, 2024

Shurtu-gal commented May 13, 2024

peter-rr commented May 13, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Amzani commented May 14, 2024

Shurtu-gal commented May 17, 2024

AayushSaini101 commented May 18, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Shurtu-gal left a comment

Choose a reason for hiding this comment

Amzani left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AayushSaini101 commented Jun 7, 2024

peter-rr commented Jun 12, 2024

peter-rr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarcloud bot commented Jun 12, 2024

Quality Gate passed

peter-rr left a comment

Choose a reason for hiding this comment

Amzani left a comment

Choose a reason for hiding this comment

Shurtu-gal commented Jul 31, 2024

Shurtu-gal left a comment

Choose a reason for hiding this comment

sonarcloud bot commented Jul 31, 2024

Quality Gate passed

Shurtu-gal commented Jul 31, 2024

asyncapi-bot commented Jul 31, 2024

AayushSaini101 commented May 8, 2024 •

edited

Loading