[WIP] Atualização geral do projeto #22

andersoncontreira · 2021-07-23T22:47:21Z

Proposed changes

Describe your changes briefly and objectively.

Atualização de README para incluir mais informações sobre o projeto (mesmo sendo um exemplo, fica como guia para quem for usar)
Inclusão de Swagger;
Separação de projetos em testes de unidade, componente, integração e e2e;

Checklist

Have you written tests for your changes?
Have you successfully ran tests with your changes locally?
Have you lint your code locally prior to submission?

Adição de suporte a swagger

Adição de response intecerptor para transformar a saída no padrão RESTful (em progresso) além de adicionar custom headers: custom-arch-version: v1 custom-service-version: 1.0.0

docker - Melhorias para a instalação e execução do projeto; docs - Inclusão de exemplos de imagens com informações relevantes do projeto; samples - Pasta para exemplos rápidos do projeto; CHANGELOG.md - Arquivo de alterações do projeto; Atualização do Nest para a versão 8

…ivos relatórios

sonarcloud · 2021-07-24T00:42:27Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
3 Code Smells

No Coverage information
0.0% Duplication

GuilhermeMLS · 2021-07-26T10:46:32Z

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Anderson Contreira


Shouldn't we replace "Anderson Contreira" with "MadeiraMadeira"?

Nossa, é verdade kkk, copie e colei e nem vi, Valeu!

GuilhermeMLS · 2021-07-26T10:49:13Z

README.md

-
+
+## Service Architecture
+This service make part of the project <project name>.


There's a typo in here: this service is part* not "make part".

GuilhermeMLS · 2021-07-26T10:52:11Z

README.md

+![Swagger OpenApi](docs/service-arch.png)
+> Obs: image to describe the service architecture or project architecture.
+
+## General Kong Routes Architecture


What this section actually is?

GuilhermeMLS · 2021-07-26T10:58:37Z

README.md

 ## Stack

 - [NestJS](https://github.com/nestjs/nest): a progressive Node.js + TypeScript framework based on dependency injection;
 - [gRPC](https://grpc.io): a Remote Procedure Call framework that provides high performance communication between microservices.
+- [Swagger + OpenAPI](https://swagger.io/specification/): an OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases. 


This text contains unusual English expressions. I would replace it with this:

"an OpenAPI definition can be used by document generation tools -- such as Swagger -- to automatically generate API docs. It can also be used by code generation tools to create servers, clients, tests, and so on."

GuilhermeMLS · 2021-07-26T11:01:43Z

README.md

+- [Swagger + OpenAPI](https://swagger.io/specification/): an OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases. 
+
+## Swagger Docs
+The current documentation of the project can be found on url `/docs`.


I think something like this would sound more natural:

"The API documentation can be found at this URL: {host}/docs."

GuilhermeMLS · 2021-07-26T11:12:03Z

README.md

+```
+
+## Samples
+See the project samples in this folder [here](samples).


To sound more natural:

"Check out the project samples at the samples directory"

GuilhermeMLS · 2021-07-26T11:15:39Z

README.md

+to get some information about ReportOptions look [here](https://use-form.netlify.app/interfaces/_node_modules__types_istanbul_reports_index_d_.reportoptions.html). 
+
+## Running test
+To run the unit tests of the project you can execute the follow command:


GuilhermeMLS · 2021-07-26T11:19:11Z

README.md

-$ mv nest-service-template-production {your_project_name}
-$ git init
-$ git remote add origin https://github.com/{user}/{repo}.git
+mv skeleton-nest-microservice-api {your_project_name}


I would call the project nestjs-service-template. It is simple and pretty accurate.

GuilhermeMLS · 2021-07-26T11:22:14Z

src/app/app.controller.ts

@@ -0,0 +1,9 @@
+import { APP_NAME, APP_VERSION } from '../main';
+import { Controller, Get, Header } from '@nestjs/common';


be aware of unused imports like Header

GuilhermeMLS · 2021-07-26T11:27:07Z

src/main.ts

-    '🍻️ Core APIs Nest Service Template gRPC layer listening on port ' +
-      grpcPort,
-  );
+  logger.log(`🍻️ ${APP_NAME} API layer listening on port ${restPort}`);


I would return this to "REST layer" as it was before. Technically, the gRPC layer has an API too.

GuilhermeMLS

Nice work!

Please notice:

I think the best name for this project is nestjs-service-template because its simple;
the default PR and commit message language is English;
we follow commit message standards, as you can see in the commit history, that could also be used to automatically generate changelogs. You can ask someone from Core APIs to get to know our commit message standards;
this PR is too large, has lots of different contexts, and could be separated into small PRs to facilitate the code review;
I wasn't able to hit GET /, GET /alive nor GET /health:

ERROR [ExceptionsHandler] rxjs_1.lastValueFrom is not a function
TypeError: rxjs_1.lastValueFrom is not a function

Note: I've run the application with ./bin/runenv.sh --build.

GuilhermeMLS · 2021-07-26T11:37:33Z

README.md

+        - `GET /`        
+        - `GET /alive`
+        - `GET /docs`
+        - `GET /v1/product`


Does GET /v1/product should actually be here?

ran-j · 2021-07-26T12:07:07Z

src/app/request.interceptor.ts

+@Injectable()
+export class RequestInterceptor implements NestInterceptor {
+  intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
+    console.log('Before...');


You should avoid use console.log

ran-j · 2021-07-26T12:17:20Z

docker-compose.yml

+    networks:
+      - default
+#  localstack:


https://kentcdodds.com/blog/please-dont-commit-commented-out-code

ran-j · 2021-07-26T12:18:19Z

docker/node/Dockerfile

+COPY package-lock.json ./
+
+# python and g++ are mandatory due to Shards-Dashboard
+RUN apk --no-cache --virtual build-dependencies add \


Why added build-dependencies and heavy stuff to this simple template ?

ran-j · 2021-07-26T12:19:26Z

src/app/request.interceptor.ts

+    return next
+      .handle()
+      .pipe(
+        tap(() => console.log(`After... ${Date.now() - now}ms`)),


ran-j · 2021-07-26T12:21:28Z

src/health/health.controller.ts


 @Controller('health')
 export class HealthController {
  constructor(private healthService: HealthService) {}

  @Get()
+  @ApiResponse({
+    status: 201,


Why use 201 and not 200 for health check ?

The right code is 200, was a typing mistake here

GuilhermeMLS · 2021-07-26T12:35:38Z

bin/runenv.sh

@@ -0,0 +1 @@
+docker-compose up $1 $2 $3


why wrapping docker-compose inside a .sh script? Also, is runenv.sh a descriptive name for what it actually does?

Please use kebab-case for file names, as the other project files.

andersoncontreira · 2021-07-27T03:08:58Z

Thank you guys, for the commentaries here, maybe tomorrow I gonna adjust some points and clarify others, I didn't finish yet this package of improvements, the missed routes I will implement to let a simple RESTful example on this project based on the diagram (store -> products/categories).

sonarcloud · 2022-04-09T00:49:51Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
12 Code Smells

No Coverage information
0.0% Duplication

andersoncontreira added 6 commits July 23, 2021 15:42

Pequenos ajustes estruturais

c430200

Adição de suporte a swagger

Adição de CORS

3ec0289

Adição de response intecerptor para transformar a saída no padrão RESTful (em progresso) além de adicionar custom headers: custom-arch-version: v1 custom-service-version: 1.0.0

movido arquivos do app para o modulo app

d56d937

Implementação de suporte a diferentes níveis de testes e seus respect…

928c75a

…ivos relatórios

pequeno ajuste estrutural

b309cc4

GuilhermeMLS reviewed Jul 26, 2021

View reviewed changes

GuilhermeMLS suggested changes Jul 26, 2021

View reviewed changes

README.md

- `GET /`

- `GET /alive`

- `GET /docs`

- `GET /v1/product`

Copy link

Contributor

GuilhermeMLS Jul 26, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does GET /v1/product should actually be here?

ran-j suggested changes Jul 26, 2021

View reviewed changes

GuilhermeMLS reviewed Jul 26, 2021

View reviewed changes

andersoncontreira changed the title ~~Atualização geral do projeto~~ [WIP] Atualização geral do projeto Jul 27, 2021

andersoncontreira marked this pull request as draft July 27, 2021 13:38

andersoncontreira added 3 commits April 8, 2022 20:29

Adição de arquivos de guidelines para testes de git actions

fbddd2b

Merge branch 'production' into project_structure_upgrade

e0cdcb3

ajustes locais para compatibilidade com prod

68941f6

andersoncontreira had a problem deploying to unit_test April 8, 2022 23:40 Failure

ci: atualizacao de scripts de guideline

ea26730

andersoncontreira had a problem deploying to unit_test April 9, 2022 00:42 Failure

ci: hotfix script FINAL_RESULT flag

15afadc

andersoncontreira had a problem deploying to unit_test April 9, 2022 00:51 Failure

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Atualização geral do projeto #22

[WIP] Atualização geral do projeto #22

andersoncontreira commented Jul 23, 2021

sonarcloud bot commented Jul 24, 2021

GuilhermeMLS Jul 26, 2021

andersoncontreira Jul 27, 2021

GuilhermeMLS Jul 26, 2021 •

edited

Loading

GuilhermeMLS Jul 26, 2021

GuilhermeMLS Jul 26, 2021

GuilhermeMLS Jul 26, 2021

GuilhermeMLS Jul 26, 2021

GuilhermeMLS Jul 26, 2021

GuilhermeMLS Jul 26, 2021

GuilhermeMLS Jul 26, 2021

GuilhermeMLS Jul 26, 2021 •

edited

Loading

GuilhermeMLS left a comment •

edited

Loading

GuilhermeMLS Jul 26, 2021

ran-j Jul 26, 2021

ran-j Jul 26, 2021

ran-j Jul 26, 2021

ran-j Jul 26, 2021

ran-j Jul 26, 2021

andersoncontreira Jul 27, 2021

GuilhermeMLS Jul 26, 2021

GuilhermeMLS Jul 26, 2021

andersoncontreira commented Jul 27, 2021

sonarcloud bot commented Apr 9, 2022

		@@ -0,0 +1,21 @@
		MIT License

		Copyright (c) 2021 Anderson Contreira



		## Service Architecture
		This service make part of the project <project name>.

		@@ -0,0 +1,9 @@
		import { APP_NAME, APP_VERSION } from '../main';
		import { Controller, Get, Header } from '@nestjs/common';

[WIP] Atualização geral do projeto #22

Are you sure you want to change the base?

[WIP] Atualização geral do projeto #22

Conversation

andersoncontreira commented Jul 23, 2021

Proposed changes

Checklist

sonarcloud bot commented Jul 24, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GuilhermeMLS Jul 26, 2021 • edited Loading

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

GuilhermeMLS Jul 26, 2021 • edited Loading

Choose a reason for hiding this comment

GuilhermeMLS left a comment • edited Loading

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

andersoncontreira commented Jul 27, 2021

sonarcloud bot commented Apr 9, 2022

GuilhermeMLS Jul 26, 2021 •

edited

Loading

GuilhermeMLS Jul 26, 2021 •

edited

Loading

GuilhermeMLS left a comment •

edited

Loading