Improve `new glee` command #683

KhudaDad414 · 2023-07-14T09:11:41Z

asked ChatGPT to make the issue a little bit more fun to read. 😆

Reason/Context

Alright, so when you're rolling with the asyncapi new glee command to create a fresh Glee app, what you get is a pretty neat and basic app. Good starting point, right? However, you, the user, gotta roll up your sleeves and get your hands dirty with the nitty-gritty:

Shuffling your asyncapi.yaml file across.
Tackling necessary Glee fields, the likes of operationId.
Crafting those essential functions.
Keeping your eyes peeled to make sure your function names are grooving with the operationId.
Delving deep into your AsyncAPI file to get the lowdown on the payload structure and get to your properties.

Description

Look, we get it - a lot of frameworks are out there handing out templates like candy at Halloween to help you get going. We could do that, too - some nifty templates for different protocols, all set and ready for action. You could grab one, tweak it to your heart's content, and boom, it's all you. But we're thinking big here - we're looking at something way better, especially if you're sitting there with an AsyncAPI spec file in your back pocket.

Picture this: you've got your AsyncAPI spec file and you're ready to hit the ground running with your app. You're firing off asyncapi new glee asyncapi.yaml and here's what the CLI's doing for you:

It's doing a once-over on your file, making sure it's Glee-ready. Got operationId? Any other Glee-essentials? Check and check.
It's dissecting the payload schema and running modelina to churn out the types.
It's teaming up those operationIds with the fresh types to cook up an empty function. This puppy's just there to nod and confirm the message receipt. And with all that in place, you're now getting type suggestions popping up in your functions.
Finally, it's decoding the server's security object and cranking out some bare-bones auth functions to match. (after feat: glee auth v2 glee#474 is merged)

With all that heavy lifting out of the way, you're all set to just dive right in and start cooking up your functions. No setup, no fuss - just you and your code.

cc: @peter-rr @Souvikns @fmvilas anything from your side?

The text was updated successfully, but these errors were encountered:

Souvikns · 2023-07-17T09:19:03Z

@KhudaDad414 Ultimately should our CLI look something like nestjs cli

oviecodes · 2023-07-19T07:35:42Z

Cool, how soon do we need this done? it looks interesting

derberg · 2023-07-19T11:56:43Z

Look, we get it - a lot of frameworks are out there handing out templates like candy at Halloween to help you get going

🤣

just for validation if all required parts are there, like operationId we need to make sure it is not something we add as code, but enable some kind of config file maybe?

peter-rr · 2023-07-20T13:01:49Z

I have some ideas for next iterations of asyncapi new glee command, mostly related to operationId as well. Let me show you some of them (no ChatGPT fun this time, sorry 😅 ):

In case the user has an specific asyncapi file to use, we could retrieve all the operationId's from it to create the corresponding functions (.js files) with just some minimal content (skeleton), leaving to the user the space needed to add the business logic required for those functions. For this scenario, it would be necessary to leave the functions folder empty first, and also replacing the asyncapi.yaml file from the Glee template with the spec file provided by the user.
If TTY in use, we may ask to the user whether he/she wants to create an spec file or not. Once created, we could get all the operationId's just like before, but also ask the user for all the channels whose publish component is missing an operationId so they can choose the name for it in that case. After all that process, then we could create the corresponding functions.
Also we could get all the servers components from the asyncapi file in order to include them in the .env file.

Any thoughts on this? @KhudaDad414 @Souvikns @fmvilas

Once we have agreed on something, I'd like to start working on a PR proposal 💪

KhudaDad414 · 2023-07-20T14:00:51Z

@KhudaDad414 Ultimately should our CLI look something like nestjs cli

I am not exactly sure. I mean nestjs cli is used for generating templates for specific components in nestjs right? I mean at the end since we have the AsyncAPI spec file then we should be able to get a working project from the file itself.

KhudaDad414 · 2023-07-20T14:01:04Z

Cool, how soon do we need this done? it looks interesting

Up for discussion. but I think before releasing glee 1.0 we should have this in place for CLI.

KhudaDad414 · 2023-07-20T14:05:50Z

@peter-rr

we could retrieve all the operationId's from it to create the corresponding functions (.js files)

why not Typescript file? glee supports typescript and this way we can add type safety and type generation for message payload using Modelina as well. 🤔 or at least giving the option for user to select between Typescript and Javascript.

KhudaDad414 · 2023-07-20T14:17:21Z

just for validation if all required parts are there, like operationId we need to make sure it is not something we add as code, but enable some kind of config file maybe?

@derberg sorry, I don't understand how we can do it without code. the best way that I can think of is creating a JSON Schema to enforce things like having operationId in publish. 🤔
any other idea?

peter-rr · 2023-07-20T14:24:59Z

why not Typescript file? glee supports typescript and this way we can add type safety and type generation for message payload using Modelina as well. 🤔 or at least giving the option for user to select between Typescript and Javascript.

@KhudaDad414 Yeah, I was just following the conventions established so far for Glee functions but I think it's a good idea opting for Typescript or giving the chance to select between both languages if that's possible 👍

derberg · 2023-07-25T10:47:35Z

@KhudaDad414 Spectral is the answer imho. We already use it in parser. It is common for governance of json documents. So you can use spectral config to specify what and where should be in a given document. Last time I checked you provide a simple json file

ayushnau · 2023-10-25T06:05:30Z

@derberg @peter-rr i would like to work on this. could you suggest me how should i do this.

KhudaDad414 · 2023-10-26T10:01:10Z

@ayushnau hey man I would suggest the following steps:

familiarize yourself with glee. (use the v3 of the spec to write something, maybe a chatbot, maybe a bot that listens to slack messages, anything that comes to your mind.)
you don't have to know how glee works internally, you just have to use it as a user. if you need some help please reach out.
familiarize yourself with cli and how it generate a new glee project.
good luck.

Note: you don't need to think about the validation with spectral too much, v3 of the spec solves lots of the issues.

AyushNautiyalDeveloper · 2023-10-26T11:57:09Z

ok @KhudaDad414 will try to do that.

peter-rr · 2023-10-26T13:39:41Z

@ayushnau Once you get familiarized yourself with the Glee project, I think it could be a nice starting point for you trying to work on:

retrieving the operationId from the asyncapi file to create the corresponding functions.
the interaction between the user and the terminal (TTY).

Don't hesitate to ask for any questions or concerns about it 😄

AyushNautiyalDeveloper · 2023-10-26T17:02:46Z

ok sure @peter-rr will do that.

AyushNautiyalDeveloper · 2023-11-01T17:47:15Z

@peter-rr i am able to get the operationId now. and made a file with that name of it. I am halting work on this for now.

peter-rr · 2023-11-02T13:16:39Z

@AyushNautiyalDeveloper Nice! Could you open a PR about it so we can review the progress of that work? Thanks 😄

ayushnau · 2023-11-04T09:44:53Z

#876 @peter-rr
The respective function for the operationId is getting created but i have considered only the operationId of the publish. Yet i need to add it for all the operationId in the spec.

KhudaDad414 · 2023-11-06T12:01:32Z

@ayushnau glee will only support the spec v3 from now on, so there is no publish. and operationId is always there by spec definitions. so you have to create the function from the receive operations.

ayushnau · 2023-11-06T12:40:05Z

ok @KhudaDad414 will work on that.

ayushnau · 2023-11-06T17:04:17Z

@peter-rr @KhudaDad414 when can i start working on this again.

aeworxet · 2023-11-06T22:14:29Z

@ayushnau

when can i start working on this again.

This issue has been selected for participation in the Bounty Program's calendar round 2023-Q4, so you can start working on this issue as soon as the repository maintainer assigns it to you.

aeworxet · 2023-11-07T07:39:43Z

Bounty Issue's End Of Life (EOL): 2024-02-29 23:59:59 UTC-12:00

ankur0904 · 2023-11-07T19:14:10Z

@aeworxet @KhudaDad414 @derberg
I want to work on this issue under the Bounty Program.
My previous Contributions:
asyncapi/conference-website#197
asyncapi/website#2149
asyncapi/EDAVisualiser#47
asyncapi/conference-website#195

Thanks
Ankur

ayushnau · 2023-11-09T05:24:59Z

@KhudaDad414 please assign this issue to me as i have already started working on this.

KhudaDad414 · 2023-11-09T09:35:48Z

congratulations @ayushnau. I see you have multiple merged PRs and experience with CLI.

@Souvikns can you assign this issue to @ayushnau ?

aeworxet · 2023-11-09T12:07:59Z

Bounty Issue's Timeline

Complexity Level	Assignment date (by GitHub)	Start date (by BP rules)	End date (by BP rules)	Draft PR submission	Final PR submission	Final PR merge
Medium	2023-11-09	2023-11-13	2023-12-22	2023-11-24	2023-12-08	2023-12-22

Please note that the dates given represent deadlines, not specific dates, so if the goal is reached sooner, it's better.

AyushNautiyalDeveloper · 2023-11-09T15:52:16Z

Bounty Issue's Timeline

Complexity Level Assignment date (by GitHub) Start date (by BP rules) End date (by BP rules) Draft PR submission Final PR submission Final PR merge
Medium 2023-11-09 2023-11-13 2023-12-22 2023-11-24 2023-12-08 2023-12-22

Please note that the dates given represent deadlines, not specific dates, so if the goal is reached sooner, it's better.

ok will try to complete as soon as possible.

ayushnau · 2023-11-09T16:40:17Z

@Souvikns i am creating Delieverables list here. please let me know if there are any other that needs to be added here.

All the operationId should be fetched and the respective function (.js) file for those function should be created.
The AsyncApi file should be replaced with the one that is provided by the user.
Get all the servers components from the asyncapi file.
Based on the payload Schema determine the types of the payload using Modelina.

ayushnau · 2023-11-09T16:50:10Z

What I am Doing currently.

Understanding the asyncapi spec v3. may will try to create something out of it.

ayushnau · 2023-11-09T19:23:54Z

@ayushnau hey man I would suggest the following steps:

1. familiarize yourself with [glee](https://github.com/asyncapi/glee). (use the v3 of the spec to write something, maybe a chatbot, maybe a bot that listens to slack messages, anything that comes to your mind.)
   you don't have to know how glee works internally, you just have to use it as a user. if you need some help please reach out.

2. familiarize yourself with cli and how it generate a new glee project.
   good luck.

Note: you don't need to think about the validation with spectral too much, v3 of the spec solves lots of the issues.

@KhudaDad414 actually i was trying to use glee with v3 but I couldnt, getting error no support for v3. can you bit clearify how can i test v3 in glee.

KhudaDad414 · 2023-11-15T11:58:40Z

@ayushnau I just check and it seems to work fine for me.
here is what is did:

created a glee project with: asyncapi new glee
updated the glee version in package.json to 0.28.2
run npm i
updated the asyncapi.yaml file to v3 of spec using studio.
connected to it using websocat

and it works fine for me.

ayushnau · 2023-11-16T18:05:30Z

@ayushnau I just check and it seems to work fine for me. here is what is did:
1. created a glee project with: `asyncapi new glee`

2. updated the glee version in `package.json` to `0.28.2`

3. run `npm i`

4. updated the `asyncapi.yaml` file to v3 of spec using studio.

5. connected to it using `websocat`
and it works fine for me.

ok I have it is resolved now.

ayushnau · 2023-11-18T09:58:18Z

#876 here is the pr.

ayushnau · 2023-11-18T10:39:42Z

@KhudaDad414 @Souvikns once i fetch the server components what should i create the respective function for that.

asyncapi: 3.0.0
info:
  title: 'Hello, Glee!'
  version: 0.1.0
servers:
  websockets:
    host: 'localhost:3000'
    protocol: ws
channels:
  check:
    address: check
    messages:
      atHello:
        $ref: '#/components/messages/hello'
      goodBye:
        $ref: '#/components/messages/hello'
operations:
  atHello:
    action: receive
    channel:
      $ref: '#/channels/check'
    messages:
      - $ref: '#/components/messages/hello'
  goodBye:
    action: send
    channel:
      $ref: '#/channels/check'
    messages:
      - $ref: '#/components/messages/hello'
components:
  messages:
    hello:
      payload:
        type: string

let suppose this is the code how should the server component should look like.

KhudaDad414 · 2023-11-20T09:46:23Z

@ayushnau From this AsyncAPI document I would extract the following info:

generate the message type with modelina(eg. hello)
create a atHello.ts file in the functions directory.
the function should be something like:

const atHello: AtHelloFunction = ({ payload }) => {
  // the logic here...
  // the payload type is generated by Modelina from the message schema.
  // The current function definitation is:

  // type GleeFunction = (
  //   event: GleeFunctionEvent
  // ) => Promise<GleeFunctionReturn>
  // can be imported from src/lib/index.d.ts
}

export default atHello

you can create the AtHelloFunction type by manipulating the GleeFunction type and setting the payload type to your message type.
3) set GLEE_SERVER_NAMES=websockets in the .env file.

there is no authentication here so we skip that part.

aeworxet · 2023-11-27T09:07:59Z

@ayushnau Please provide the Draft PR.

ayushnau · 2023-11-29T17:43:33Z

@aeworxet here is the draft pr. #890

aeworxet · 2023-12-13T03:29:26Z

Due to the online absence of the AsyncAPI Maintainer (@KhudaDad414) in Slack for a period of more than three working days in a row, all target dates of the Bounty Issue's Timeline have been increased by two calendar weeks.

Bounty Issue's Timeline Extended

Complexity Level	Assignment date (by GitHub)	Start date (by BP rules)	End date (by BP rules)	Draft PR submission	Final PR submission	Final PR merge
Medium	2023-11-09	2023-11-13	2024-01-05	2023-12-08	2023-12-22	2024-01-05

Please note that the dates given represent deadlines, not specific dates, so if the goal is reached sooner, it's better.

aeworxet · 2023-12-19T21:31:41Z

@asyncapi/bounty_team

aeworxet · 2023-12-20T05:23:17Z

Because the requirements for this issue have changed drastically, AsyncAPI Maintainer (@KhudaDad414) has requested that this Bounty Issue be reclassified as Advanced and the Timeline for it extended.

Bounty Issue is Reclassified and its Timeline Extended

Complexity Level	Assignment date (by GitHub)	Start date (by BP rules)	End date (by BP rules)	Draft PR submission	Final PR submission	Final PR merge
Advanced	2023-11-09	2023-11-13	2024-02-02	2023-12-29	2024-01-19	2024-02-02

Please note that the dates given represent deadlines, not specific dates, so if the goal is reached sooner, it's better.

ayushnau · 2023-12-22T07:53:15Z

@KhudaDad414 Currently, when a new project is created, it does not appear under a project folder. Will this remain final, or will it change? We have a flag for the folder name in the glee command.

KhudaDad414 · 2023-12-22T08:07:52Z

@ayushnau generator supports specifying the output folder. I think it's ''--output", but you can check its docs.

ayushnau · 2023-12-26T16:17:14Z

@KhudaDad414 Added the template in the cli glee command. can you check.

KhudaDad414 · 2024-01-23T11:41:21Z

@aeworxet, the issue has been resolved and @ayushnau's PR is ready to be merged.

Souvikns · 2024-02-01T15:51:42Z

With the merging of #890 this issue has been solved and the features is working as expected, all thanks to @ayushnau

aeworxet · 2024-02-01T16:14:34Z

Bounty Issue Completed 🎉

@ayushnau, please go to the AsyncAPI page on Open Collective and submit an invoice for USD 400.00 with the expense title Bounty cli#683, tag bounty, and full URL of this Bounty Issue in the description.

ayushnau · 2024-02-01T19:23:28Z

Bounty Issue Completed 🎉

@ayushnau, please go to the AsyncAPI page on Open Collective and submit an invoice for USD 400.00 with the expense title Bounty cli#683, tag bounty, and full URL of this Bounty Issue in the description.

@aeworxet i have raised the invoice. please check.

KhudaDad414 added the enhancement New feature or request label Jul 14, 2023

KhudaDad414 mentioned this issue Jul 14, 2023

Glee V1.0.0 planning asyncapi/glee#477

Closed

10 tasks

fmvilas added this to Glee Sep 4, 2023

aeworxet added bounty AsyncAPI Bounty program related label level/medium AsyncAPI Bounty program related label bounty/2023-Q4 AsyncAPI Bounty program related label labels Nov 6, 2023

Souvikns assigned ayushnau Nov 9, 2023

ayushnau mentioned this issue Dec 1, 2023

feat: improve glee command #890

Merged

4 tasks

asyncapi-bot closed this as completed in #890 Feb 1, 2024

github-project-automation bot moved this to Done in Glee Feb 1, 2024

aeworxet added this to Bounty Program Feb 14, 2024

aeworxet moved this to Completed in Bounty Program Feb 14, 2024

Improve new glee command #683

Improve new glee command #683

Comments

KhudaDad414 commented Jul 14, 2023 • edited Loading

Reason/Context

Description

Souvikns commented Jul 17, 2023

oviecodes commented Jul 19, 2023 • edited Loading

derberg commented Jul 19, 2023

peter-rr commented Jul 20, 2023 • edited Loading

KhudaDad414 commented Jul 20, 2023

KhudaDad414 commented Jul 20, 2023

KhudaDad414 commented Jul 20, 2023

KhudaDad414 commented Jul 20, 2023

peter-rr commented Jul 20, 2023

derberg commented Jul 25, 2023

ayushnau commented Oct 25, 2023

KhudaDad414 commented Oct 26, 2023

AyushNautiyalDeveloper commented Oct 26, 2023

peter-rr commented Oct 26, 2023

AyushNautiyalDeveloper commented Oct 26, 2023

AyushNautiyalDeveloper commented Nov 1, 2023 • edited Loading

peter-rr commented Nov 2, 2023

ayushnau commented Nov 4, 2023 • edited Loading

KhudaDad414 commented Nov 6, 2023 • edited Loading

ayushnau commented Nov 6, 2023

ayushnau commented Nov 6, 2023

aeworxet commented Nov 6, 2023

aeworxet commented Nov 7, 2023

ankur0904 commented Nov 7, 2023

ayushnau commented Nov 9, 2023

KhudaDad414 commented Nov 9, 2023

aeworxet commented Nov 9, 2023

Bounty Issue's Timeline

Please note that the dates given represent deadlines, not specific dates, so if the goal is reached sooner, it's better.

AyushNautiyalDeveloper commented Nov 9, 2023 • edited Loading

Bounty Issue's Timeline

Please note that the dates given represent deadlines, not specific dates, so if the goal is reached sooner, it's better.

ayushnau commented Nov 9, 2023 • edited Loading

ayushnau commented Nov 9, 2023 • edited Loading

ayushnau commented Nov 9, 2023 • edited Loading

KhudaDad414 commented Nov 15, 2023

ayushnau commented Nov 16, 2023

ayushnau commented Nov 18, 2023 • edited Loading

ayushnau commented Nov 18, 2023

KhudaDad414 commented Nov 20, 2023

aeworxet commented Nov 27, 2023

ayushnau commented Nov 29, 2023 • edited Loading

aeworxet commented Dec 13, 2023

Bounty Issue's Timeline Extended

Please note that the dates given represent deadlines, not specific dates, so if the goal is reached sooner, it's better.

aeworxet commented Dec 19, 2023

aeworxet commented Dec 20, 2023

Bounty Issue is Reclassified and its Timeline Extended

Please note that the dates given represent deadlines, not specific dates, so if the goal is reached sooner, it's better.

ayushnau commented Dec 22, 2023

KhudaDad414 commented Dec 22, 2023

ayushnau commented Dec 26, 2023

KhudaDad414 commented Jan 23, 2024

Souvikns commented Feb 1, 2024

aeworxet commented Feb 1, 2024

Bounty Issue Completed 🎉

ayushnau commented Feb 1, 2024

Bounty Issue Completed 🎉

Improve `new glee` command #683

Improve `new glee` command #683

KhudaDad414 commented Jul 14, 2023 •

edited

Loading

oviecodes commented Jul 19, 2023 •

edited

Loading

peter-rr commented Jul 20, 2023 •

edited

Loading

AyushNautiyalDeveloper commented Nov 1, 2023 •

edited

Loading

ayushnau commented Nov 4, 2023 •

edited

Loading

KhudaDad414 commented Nov 6, 2023 •

edited

Loading

AyushNautiyalDeveloper commented Nov 9, 2023 •

edited

Loading

ayushnau commented Nov 9, 2023 •

edited

Loading

ayushnau commented Nov 9, 2023 •

edited

Loading

ayushnau commented Nov 9, 2023 •

edited

Loading

ayushnau commented Nov 18, 2023 •

edited

Loading

ayushnau commented Nov 29, 2023 •

edited

Loading