feat: glee authentication v1

[oviecodes]

Description
This PR continues the discussion on the glee authentication issue #377

We have moved on from the middleware approach proposed in PR #439 and have started exploring the possibilities of using lifecycle events for authentication. This PR details the progress that has been made using Lifecycle events.

Progress:

1. Creation of an entirely new lifecycle event (onAuth)
2. Successful emission of auth event from websocket server

Challenges:

1. websocket proceeds to connect even when auth file has not finished running due to the nature of node.js events.

We're currently experimenting with potential fixes for this challenge.

Related issue(s)
Discuses issue #377

@Souvikns @KhudaDad414

[Souvikns]

We should have a separate place for Authentication

We could have a separate place for authentication, instead of lifecycle events and config. We can have both server auth and client auth in the same place.

/** auth/serverName.ts **/

export function serverAuth({headers, done}) {
  // write logic for authentication 
  done()
}

export function clientAuth() {
  return {
    username: '',
    password: ''
  }
}

• With this, we can remove the auth from the config.
• Server and client auth stays together and the user does not have to change multiple things.
• Since this follows the file system like functions we can find out which server the authentication file belongs to and thus figure out if it is http or websocket and call the functions accordingly.

@KhudaDad414, @oviecodes what do you think?

[oviecodes]

We should have a separate place for Authentication

We could have a separate place for authentication, instead of lifecycle events and config. We can have both servers auth and client auth in the same place.

@KhudaDad414, @oviecodes what do you think?

@Souvikns That's a good approach, we'll have to create a separate folder for authentication alone, since the logic in the auth file has grown past being housed in lifecycle files. Also, we'll have to change how and where the client gets its authentication parameters in the client.ts files of the respective adapters.

One thing on my mind is:
Should this change affect other adapters or should it be for just the WS and HTTP adapters?

[KhudaDad414]

We could have a separate place for authentication, instead of lifecycle events and config. We can have both server auth and client auth in the same place.

@Souvikns that's a great idea. it would solve lots of issues and makes a lot of sense.

Should this change affect other adapters or should it be for just the WS and HTTP adapters?

@oviecodes For now lets focus on HTTP and WS. that's our goal for GSoC. we can extend it if the need arise.

[KhudaDad414]

@oviecodes thanks to @Souvikns the formatting issue should be fixed with #469 the formatting issue seems to be solved. let's move your changes to a new PR so we can discuss it further. 😀

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
12 Code Smells

No Coverage information
0.6% Duplication