No vídeo anterior, nós concluímos a configuração do TypeORM: já temos a classe de configuração para nos conectar ao banco, a postgres.config.service.ts, e também já configuramos o app.module.ts.
Mas, agora temos um detalhe referente às boas práticas. Estamos colocando informações sensíveis no meio do código: o nome de usuário (username) e a senha (password) do banco de dados.
Não é interessante que essas informações fiquem expostas no código, porque, por exemplo, subiremos esse repositório no GitHub - um local público. Ou seja: outra pessoa pode abrir esse repositório, ver o nome de usuário, senha e até o host, caso estivéssemos com o banco na nuvem, e acessá-lo.
O ideal, nesse caso, é trabalhar com variáveis de ambiente para não deixar informações sensíveis soltar no meio do código. É isso que faremos nesse vídeo!
Para isso, precisamos instalar uma biblioteca: @nestjs/config, um módulo do NestJS.
Instalando e configurando a biblioteca
Acionamos o terminal novamente, dentro do projeto "loja", e rodamos o seguinte comando:
npm install @nestjs/config
Ao terminar a instalação, fechamos o terminal. Realizaremos a configuração no arquivo app.module.ts novamente, o mesmo arquivo que colocamos o TypeOrmModule, que servirá para inicializar o módulo de configuração.
Podemos criar uma linha depois de ProdutoModule e chamar a função que será ConfigModule.forRoot({}). Dentro das chaves, colocamos o isGlobal: true para setar o ConfigModule como global. Também devemos importar o ConfigModule, a biblioteca que instalamos anteriormente.
Nosso arquivo ficará assim:
import { Module } from '@nestjs/common';
import { ProdutoModule } from './produto/produto.module';
import { UsuarioModule } from './usuario/usuario.module';
import { TypeOrmModule } from '@nestjs/typeorm';
import { ConfigModule } from '@nestjs/config';
import { PostgresConfigService } from './config/postgres.config.service';
@Module({
imports: [
UsuarioModule,
ProdutoModule,
ConfigModule.forRoot({
isGlobal: true,
}),
TypeOrmModule.forRootAsync({
useClass: PostgresConfigService,
inject: [PostgresConfigService],
}),
],
})
export class AppModule {}
A configuração está, basicamente, preparada, e já a temos a nível global, então salvamos o arquivo com "Ctrl + S".
O que precisamos agora é que o nosso arquivo de configuração do Postgres consiga utilizar essa configuração para podermos remover isso do arquivo de configuração do Postgres.
Construtor
No menu Explorador, clicamos em "src > config > postgres.config.service.ts".
Para conseguirmos utilizar o módulo nesse arquivo, utilizamos um construtor na nossa classe. Criamos uma linha abaixo da exportação da classe e digitamos constructor().
A ideia do construtor é ter uma execução assim que a nossa classe for importada no app.module. Em outras palavras, quando ela for importada, queremos que o que estiver no construtor seja executado.
Dentro desse construtor, criaremos uma variável com private, chamada configService. Sua tipagem será ConfigService, cuja importação vem da biblioteca @nestjs/config que instalamos anteriormente. Depois, abrimos e fechamos chaves para que o erro do construtor suma:
postgres.config.service.ts
import { Injectable } from '@nestjs/common';
import { ConfigService } from '@nestjs/config';
import { TypeOrmModuleOptions, TypeOrmOptionsFactory } from '@nestjs/typeorm';
@Injectable()
export class PostgresConfigService implements TypeOrmOptionsFactory {
constructor(private configService: ConfigService) {}
// código omitido
A partir disso, já conseguimos utilizar as configurações do próprio ConfigService.
Atualizando as configurações do banco
Então, podemos utilizar essas configurações no host da seguinte maneira: digitamos this.configService.get<string>(''), pois queremos pegar um valor do tipo string. Passaremos como parâmetro a referência para pegar esse valor. Então:
host: this.configService.get<string>('')
Faremos isso com todos os outros campos. Podemos copiar essa linha e colar para todos os parâmetros, apenas mudando o tipo string para number na porta, porque o valor desse campo é numérico, resultando em:
postgres.config.service.ts
createTypeOrmOptions(): TypeOrmModuleOptions {
return {
type: 'postgres',
host: this.configService.get<string>(''),
port: this.configService.get<number>(''),
username: this.configService.get<string>(''),
password: this.configService.get<string>(''),
database: this.configService.get<string>(''),
entities: [''],
synchronize: true,
};
}
}
Fizemos 50% da configuração. Agora, precisamos referenciar os valores que queremos buscar.
Para isso, voltamos ao Explorador e clicamos com o botão direito na pasta "loja" (fora de "src") e, em seguida, em "Novo Arquivo...". Vamos nomear esse novo arquivo como .env (pronunciado "dot env" ou "ponto env"), e será nele que nossas configurações ficarão.
Então, por exemplo: no arquivo postgres.config.service, tínhamos o host definido como 127.0.0.1. Essa informação não vai ficar mais nesse arquivo, mas no .env. Esse arquivo, por boas práticas, não é enviado para o GitHub. Ou seja, a informação só existe localmente na máquina.
Então, criaremos as referências nele. Como:
.env
Agora, para referenciá-lo, basta voltar no arquivo postgres.config.service e colocar a referência como string entre os parênteses:
postgres.config.service.ts
host: this.configService.get<string>('DB_HOST')
Ou seja: queremos que o configService leia o arquivo .env, um arquivo padrão, onde temos o DB_HOST, chave cujo valor é 127.0.0.1, agora não mais fixo no código.
Agora, só precisamos seguir a mesma lógica para os outros valores:
.env
DB_HOST=127.0.0.1
DB_PORT=5432
DB_USER=root
DB_PASSWORD=root
DB_NAME=loja
Usamos todas as informações de antes, criando as chaves com nomes comumente utilizados por boa prática. Porém, podemos definir outros nomes caso seja necessário.
O importante é que o nome definido seja o mesmo referenciado no arquivo de configuração do banco.
Agora, inserimos as referências:
postgres.config.service.ts
createTypeOrmOptions(): TypeOrmModuleOptions {
return {
type: 'postgres',
host: this.configService.get<string>('DB_HOST'),
port: this.configService.get<number>('DB_PORT'),
username: this.configService.get<string>('DB_USERNAME'),
password: this.configService.get<string>('DB_PASSWORD'),
database: this.configService.get<string>('DB_NAME'),
entities: [],
synchronize: true,
};
}
Um último detalhe interessante: vamos verificar se o arquivo .env consta em .gitignore. Se pressionarmos "Ctrl + F" e digitarmos ".env" na barra de busca, não teremos nenhum resultado.
Precisamos adicioná-lo, porque esse arquivo não vai para o GitHub por uma questão de segurança. Estando no arquivo .gitignore, ele será ignorado no upload para o repositório público. No fim do arquivo, então, digitamos:
.gitignore
Próximos passos
Para finalizar, vamos executar o projeto e entender os erros atuais para traçar nossos próximos passos. Para tanto, abrimos novamente o terminal e rodamos o seguinte comando dentro da pasta "loja":
Automaticamente, receberemos algumas reclamações. Por exemplo:
Postgres package has not been found installed.
Ou seja, o pacote do Postgres não está instalado. A sugestão dada é rodar o seguinte comando:
O pg é o módulo do Postgres. No nosso arquivo postgres.config.service.ts, estamos usando utilizando o postgres como tipo do banco. Para isso, é necessário que o nosso projeto conheça o Postgres. Por isso o erro foi apontado e foi pedida a instalação - e isso aconteceria com qualquer outro banco.
Então, vamos rodar o comando acima para finalizar essa configuração. É um pacote bem enxuto e de instalação rápida. Ao finalizar, podemos tentar executar nosso projeto novamente com npm start.
O próximo erro apontado é:
Password authentication failed for user "root".
Já prevíamos esse erro, que acontece porque não temos o servidor do Postgres. A partir dos próximos vídeos, veremos um pouco mais sobre ORM e começaremos a realizar a correção desse problema criando, de fato, um banco de dados.
Até lá!