Configurações da biblioteca e adição de keep-alive

[LorhanSohaky]

Motivação

Dependendo da quantidade de requisições feitas, perde-se muito tempo fazendo o handshaking e isso pode ser facilmente resolvido com o cabeçalho keep-alive. A implementação foi baseada na issue#423 do node-fetch.

Implementação

Quando estava implementando fiquei na dúvida se era uma boa escolha colocar isso como default ou uma configuração da lib, então para evitar que essa modificação cause algum problema para os demais desenvolvedores preferi passar como uma configuração. E com isso aproveitei para possibilitar que as proxies também sejam passadas como configuração aos serviços.

Por fim, agora caso queiramos passar qualquer tipo de configuração aos serviços não precisaremos mais (talvez / espero eu hahaha) modificar a interface.

Observações

• Não sabia como poderia testar se a requisição voltou com keep-alive na resposta sem afetar a interface do cep-promise
• Um dos testes falhou, mas creio que não está relacionado com as mudanças que fiz
• Fiz algumas correções de code-style
• Se forçar code-style for algo muito importante, é preciso modificar o lint-fix para algo assim:

   "lint-fix": "standard '*.js' 'src/**/*.js' 'test/**/*.js' --fix",

[coveralls]

Coverage remained the same at 100.0% when pulling e2bb712 on LorhanSohaky:feature/keep-alive into 9bca1c4 on filipedeschamps:master.

[coveralls]

Coverage decreased (-0.6%) to 99.419% when pulling 5f06013 on LorhanSohaky:feature/keep-alive into 9bca1c4 on filipedeschamps:master.

[lucianopf]

Opa manão que PR bom de revisar! Parabéns e MUITO obrigado! 🚀

Revisando o código parece tudo 100% e ainda melhorou algumas coisinhas 🔝 !!

Vou segurar o approve um pouquinho só por 1 motivo (prometo que é rápido hehehe):

• Quero pensar se a gnt consegue fazer uns testes nessa implementação (se não conseguir a gnt toca o barco assim msm)

@filipedeschamps corre aqui pra ver esse PR que massa! 😱 🤘

Se já tiver por aí aproveita e da um helpzinho nos hooks do travis? 🙏

[LorhanSohaky]

Vi agora na Newsletter do Filipe sobre o Hacktoberfest. Acham possível eleger esse PR? Assim poderei participar com este PR

[ivancorrea]

@LorhanSohaky

Aproveitaria este PR e adicionaria novas configurações, como o timeout da requisição, que já foi adicionada pelo @filipedeschamps no PR #190 e também headers, como o User-Agent (para quando rodar do lado do servidor) que eu ajustei no PR #189.

Não esquecer do valor default destas novas configurações.

Dessa forma podemos cancelar os PRs anteriores e resolver tudo neste!

[LorhanSohaky]

@ivmarcos , para fazer isso, precisamos decidir se serão passadas as mesmas configurações para todos os serviços ou cada um pode receber uma configuração diferente (vide exemplo #190). E se for um para cada provedor, qual será o formato para isso.

O que tenho em mente é fazer algo parecido com:

const config = {
  providersConfig: {
    brasilapi: {
        timeout: 1000,
        proxyURL: '...'
    }
  }
}

[ivancorrea]

@LorhanSohaky

Exatamente! Cada provider precisa receber configurações específicas, mas acredito que poderia ter uma opção pra definir geral:

const config = {
	providersConfig: {
		//specific providers
		brasilapi: {
			timeout: 1000,
			proxyURL: '...',
			headers: {
				'user-agent': 'especific ua'
			}
		},
		// for all providers
		timeout: 2000,		
		headers: {
			'user-agent': 'cep-promise'
		}
	}
}

[LorhanSohaky]

Modifiquei, agora suporta sobrescrever os headers e adicionar timeout

[LorhanSohaky]

@ivancorrea consegue fazer o review?

[lucianopf]

Mestres, só pra não deixar vcs perdidos abri uma issue com um planinho de ação pra reorganizar o repo dado a migração pra org do BrasilAPI 😬

#197

[LorhanSohaky]

@lucianopf , fera demais