feat(gateway): add app logger

Author: guiseek

CONTRIBUTING.md

@@ -7,11 +7,11 @@ Adoraríamos que você contribuísse com o projeto e ajudasse a torná-la ainda
 - [Issues and Bugs](#issue)
 - [Feature Requests](#feature)
 - [Regras de codificação](#rules)
+
 ## <a name="coc"></a> Código de Conduta
 
 Ajude-nos a manter a comunidade Speek aberta e inclusiva. Por favor, leia e siga nosso [Código de Conduta](CODE_OF_CONDUCT.md).
 
-
 ## <a name="question"></a> Tem alguma dúvida ou problema?
 
 Não abra issues para questões gerais de suporte relacionadas a tecnologia WebRTC, pois queremos manter as issues do GitHub para relatórios de bugs. Em vez disso você pode [iniciar uma discussão](https://github.com/guiseek/speek.video/discussions/new) com a comunidade speek.video. Caso não funcione, recomendamos o uso do [Stack Overflow](https://stackoverflow.com/questions/tagged/speek.video) para fazer perguntas relacionadas ao suporte. Ao criar uma nova pergunta no Stack Overflow, certifique-se de adicionar a `speek.video` tag.
@@ -194,6 +194,7 @@ A mensagem do commit deve ser estruturada da seguinte forma:
 
 [rodapé opcional]
 ```
+
 ---
 
 O commit contém os seguintes elementos estruturais, para comunicar a intenção ao utilizador da sua biblioteca:
@@ -252,7 +253,6 @@ closes issue #12
 
 As palavras-chaves "DEVE" ("MUST"), "NÃO DEVE" ("MUST NOT"), "OBRIGATÓRIO" ("REQUIRED"), "DEVERÁ" ("SHALL"), "NÃO DEVERÁ" ("SHALL NOT"), "PODEM" ("SHOULD"), "NÃO PODEM" ("SHOULD NOT"), "RECOMENDADO" ("RECOMMENDED"), "PODE" ("MAY") e "OPCIONAL" ("OPTIONAL"), nesse documento, devem ser interpretados como descrito na [RFC 2119](http://tools.ietf.org/html/rfc2119).
 
-
 1. A mensagem de commit DEVE ser prefixado com um tipo, que consiste em um substantivo, `feat`, `fix`, etc., seguido por um escopo OPCIONAL, e OBRIGATÓRIO terminar com dois-pontos e um espaço.
 
 1. O tipo `feat` DEVE ser usado quando um commit adiciona um novo recurso ao seu aplicativo ou biblioteca.
@@ -277,7 +277,6 @@ As palavras-chaves "DEVE" ("MUST"), "NÃO DEVE" ("MUST NOT"), "OBRIGATÓRIO" ("R
 
 1. Um `!` PODE ser acrescentado antes do `:` no prefixo tipo/escopo, para chamar a atenção para modificações que quebram a compatibilidade. `BREAKING CHANGE: description` também DEVE ser incluído no corpo ou no rodapé, junto com o `!` no prefixo.
 
-
 #### Porque utilizar Conventional Commits
 
 - Criação automatizada de CHANGELOGs.
@@ -286,10 +285,8 @@ As palavras-chaves "DEVE" ("MUST"), "NÃO DEVE" ("MUST NOT"), "OBRIGATÓRIO" ("R
 - Disparar processos de build e deploy.
 - Facilitar a contribuição de outras pessoas em seus projetos, permitindo que eles explorem um histórico de commits mais estruturado.
 
-
 ---
 
-
 ## Nossa stack
 
 <div style="display:flex; align-items: center">
@@ -341,12 +338,6 @@ As palavras-chaves "DEVE" ("MUST"), "NÃO DEVE" ("MUST NOT"), "OBRIGATÓRIO" ("R
   </div>
 </div>
 
-
-
-
-
-
-
 <!-- # Todo
 
 > ### **_Luiz_**
@@ -369,4 +360,3 @@ As palavras-chaves "DEVE" ("MUST"), "NÃO DEVE" ("MUST NOT"), "OBRIGATÓRIO" ("R
 
 Poderia ser algo amigável como "Entre na nossa reunião do Peek por este link: ..."
 R: Mas sim, isso faz sentido tbm..
-

ROADMAP.md

@@ -1,4 +1,5 @@
 # ROADMAP
+
 ### @ToDo
 
 Algumas tarefas no roadmap de curto prazo
@@ -59,4 +60,4 @@ Algumas tarefas no roadmap de curto prazo
   - [ ] SIP ([asterisk](https://wiki.asterisk.org/wiki/display/AST/Configuring+Asterisk+for+WebRTC+Clients))
 
 - [ ] Chat em grupo
-  <br>_até 10 peers (limitação de banda user)_ -->
+      <br>_até 10 peers (limitação de banda user)_ -->

apps/gateway/src/app.logger.spec.ts

@@ -0,0 +1,7 @@
+import { App } from './app.logger'
+
+describe('App', () => {
+  it('should create an instance', () => {
+    expect(new App()).toBeTruthy()
+  })
+})

apps/gateway/src/app.logger.ts

@@ -0,0 +1,28 @@
+import { environment } from './environments/environment'
+import { LoggerService, Logger } from '@nestjs/common'
+
+export class AppLogger extends Logger implements LoggerService {
+  context: string
+
+  setContext(context: string) {
+    this.context = context
+  }
+
+  log(message: any, context?: string) {
+    super.log(message, context ? context : this.context)
+  }
+  error(message: any, trace?: string, context?: string) {
+    super.error(message, context ? context : this.context)
+  }
+  warn(message: any, context?: string) {
+    super.warn(message, context ? context : this.context)
+  }
+  debug(message: any, context?: string) {
+    if (!environment.production) {
+      super.debug(message, context ? context : this.context)
+    }
+  }
+  verbose(message: any, context?: string) {
+    super.verbose(message, context ? context : this.context)
+  }
+}

apps/gateway/src/app.module.ts

@@ -1,10 +1,11 @@
 import { SignalingModule } from './signaling/signaling.module'
 import { AuthModule } from './auth/auth.module'
 import { Module } from '@nestjs/common'
+import { AppLogger } from './app.logger'
 
 @Module({
   imports: [SignalingModule, AuthModule],
   controllers: [],
-  providers: [],
+  providers: [AppLogger],
 })
 export class AppModule {}

apps/gateway/src/main.ts

@@ -6,6 +6,7 @@
 import { Logger } from '@nestjs/common'
 import { NestFactory } from '@nestjs/core'
 import { readFileSync } from 'fs'
+import { AppLogger } from './app.logger'
 
 import { AppModule } from './app.module'
 // import { environment } from './environments/environment'
@@ -17,7 +18,9 @@ import { AppModule } from './app.module'
 
 async function bootstrap() {
   // const httpsOptions = environment.certificate ? certificates : {}
-  const app = await NestFactory.create(AppModule)
+  const app = await NestFactory.create(AppModule, {
+    logger: new AppLogger(),
+  })
   const globalPrefix = 'gateway'
   app.setGlobalPrefix(globalPrefix)
   const port = process.env.PORT || 3333

apps/gateway/src/signaling/signaling.gateway.ts

@@ -11,6 +11,7 @@ import { SpeekAction, SpeekPayload } from '@speek/core/entity'
 import { Server, Socket } from 'socket.io'
 import { UseGuards } from '@nestjs/common'
 import { SignalingGuard } from './signaling.guard'
+import { AppLogger } from '../app.logger'
 
 @WebSocketGateway()
 export class SignalingGateway
@@ -20,14 +21,17 @@ export class SignalingGateway
 
   users = new Map<string, string>()
 
+  constructor(readonly logger: AppLogger) {
+    logger.setContext('Signaling')
+  }
+
   @UseGuards(SignalingGuard)
   @SubscribeMessage(SpeekAction.KnockKnock)
   knockKnock(
     @ConnectedSocket() contact: Socket,
     @MessageBody() payload: SpeekPayload
   ) {
-    console.log(payload)
-
+    this.logger.debug(payload, SpeekAction.KnockKnock)
     const room = this._room(payload)
     if (room.length >= 0 && room.length < 2) {
       contact.emit(SpeekAction.Available, true)
@@ -42,7 +46,7 @@ export class SignalingGateway
     @ConnectedSocket() contact: Socket,
     @MessageBody() payload: SpeekPayload
   ) {
-    console.log(payload)
+    this.logger.debug(payload, SpeekAction.CreateOrJoin)
     if (!this.users.has(contact.id)) {
       this.users.set(contact.id, payload.sender)
     }
@@ -64,6 +68,7 @@ export class SignalingGateway
     @ConnectedSocket() contact: Socket,
     @MessageBody() payload: SpeekPayload
   ) {
+    this.logger.debug(payload, SpeekAction.Offer)
     const room = contact.to(payload.code)
     room.broadcast.emit(SpeekAction.Offer, payload)
   }
@@ -74,6 +79,7 @@ export class SignalingGateway
     @ConnectedSocket() contact: Socket,
     @MessageBody() payload: SpeekPayload
   ) {
+    this.logger.debug(payload, SpeekAction.Screen)
     const room = contact.to(payload.code)
     room.broadcast.emit(SpeekAction.Screen, payload)
   }

apps/gateway/src/signaling/signaling.module.ts

@@ -1,7 +1,8 @@
 import { Module } from '@nestjs/common'
+import { AppLogger } from '../app.logger'
 import { SignalingGateway } from './signaling.gateway'
 
 @Module({
-  providers: [SignalingGateway],
+  providers: [AppLogger, SignalingGateway],
 })
 export class SignalingModule {}

apps/webapp/src/index.html

@@ -16,10 +16,7 @@
     <!-- Open Graph / Facebook -->
     <meta property="og:type" content="website" />
     <meta property="og:url" content="https://speek.video/" />
-    <meta
-      property="og:title"
-      content="Speek - Simples e seguro"
-    />
+    <meta property="og:title" content="Speek - Simples e seguro" />
     <meta
       property="og:description"
       content="Crie um link para conversar e pronto. Sua ligação funciona pessoa pra pessoa, sem servidores, sem persistência, direto ao ponto."
@@ -29,18 +26,15 @@
     <!-- Twitter -->
     <meta property="twitter:card" content="summary_large_image" />
     <meta property="twitter:url" content="https://speek.video/" />
-    <meta
-      property="twitter:title"
-      content="Speek - Simples e seguro"
-    />
+    <meta property="twitter:title" content="Speek - Simples e seguro" />
     <meta
       property="twitter:description"
       content="Crie um link para conversar e pronto. Sua ligação funciona pessoa pra pessoa, sem servidores, sem persistência, direto ao ponto."
     />
     <meta property="twitter:image" content="/assets/images/speek.svg" />
 
     <link rel="icon" type="image/x-icon" href="/assets/icons/speek-7.png" />
-    <link rel="apple-touch-icon" href="/assets/icons/speek-2.png">
+    <link rel="apple-touch-icon" href="/assets/icons/speek-2.png" />
 
     <link rel="preconnect" href="https://fonts.gstatic.com" />
     <link

apps/webapp/src/main.ts

@@ -9,9 +9,10 @@ const p: WithContext<WebApplication> = {
   '@type': 'WebApplication',
   name: 'Speek - Simples e seguro',
   about: 'Crie um link para conversar e pronto.',
-  description: 'Sua ligação funciona pessoa pra pessoa, sem servidores, sem persistência, direto ao ponto.',
+  description:
+    'Sua ligação funciona pessoa pra pessoa, sem servidores, sem persistência, direto ao ponto.',
   additionalType: 'Liberdade em áudio e vídeo',
-  url: 'https://speek.video'
+  url: 'https://speek.video',
 }
 
 if (environment.production) {