New release is coming soon! If you want to try out the latest features, simply run npm i -s moleculer@next. The docs for the latest version are available here.

Console Interativo (REPL)

moleculer repl npm

O moleculer-repl é um console interativo de desenvolvedor para Moleculer.

Instalação

npm i moleculer-repl

Utilização

Alternar broker para modo REPL

const broker = new ServiceBroker();

broker.start().then(() => {
// Switch to REPL mode
broker.repl();
});

Comandos REPL

Commands:
actions [options] Lista de ações
bench [options] <action> [jsonParams] [meta] Teste de carga da ação de um serviço
broadcast <eventName> Transmitir um evento
broadcastLocal <eventName> Transmitir um evento localmente
cache Administrar o cache
call [options] <actionName> [jsonParams] [meta] Chamar uma ação
dcall [options] <nodeID> <actionName> [jsonParams] [meta] Chamar uma ação diretamente
clear [pattern] Limpar entradas do cache
cls Limpar o console
destroy <serviceName> Destruir um serviço local
emit <eventName> Emitir um evento
env Listar as variáveis de ambiente
events [options] Listar os eventos
info Informações do broker
listener Adicionar ou remover eventos
load <servicePath> Carregar um serviço de um arquivo
loadFolder <serviceFolder> [fileMask] Carregar todos os serviços de um diretório
metrics [options] Listar métricas
nodes [options] Listar nós
exit|q Saída da aplicação
services [options] Lista de serviços
help [command] exibir a ajuda para o comando

Listar nós

mol $ nodes

Opções

-a, --all             lista todos os nós (offline)
-d, --details lista detalhada
-f, --filter <match> filtra nós (ex.: 'node-*')
--raw converte o registro de serviço em JSON
--save [filename] salva o registro de serviço para um arquivo JSON

Saída image

Saída detalhada image

Listar serviços

mol $ services

Opções

-a, --all             lista todos os serviços (offline)
-d, --details exibe endpoints
-f, --filter <match> filtra serviços (ex.: 'user*')
-i, --skipinternal ignora serviços internos
-l, --local só serviços locais

Saída image

Saída detalhada image

Listar ações

mol $ actions

Opções

-a, --all             listar todas as ações (offline)
-d, --details exibir endpoints
-f, --filter <match> filtrar ações (ex.: 'users.*')
-i, --skipinternal ignorar ações internas
-l, --local só ações locais

Saída image

Saída detalhada image

Listar eventos

mol $ events

Opções

-a, --all             listar todos os ouvintes de eventos (offline)
-d, --details exibir endpoints
-f, --filter <match> filtrar ouvintes de eventos (ex.: 'user.*')
-i, --skipinternal ignorar ouvintes de eventos internos
-l, --local só ouvintes de eventos locais

Saída image

Saída detalhada image

Mostrar informações comuns

mol $ info

Saída image

Listar variáveis de ambiente

mol $ env

Executar uma ação

mol $ call "test.hello"

Saída image

Opções

--help               mostra informações de utilização
--load [filename] Carrega parâmetros do arquivo
--stream [filename] Envia um arquivo como stream
--save [filename] Salva a resposta em arquivo

Executa uma ação com parâmetros

mol $ call "math.add" --a 5 --b Bob --c --no-d --e.f "hello"

Parâmetros serão { a: 5, b: 'Bob', c: true, d: false, e: { f: 'hello' } }

Chamar uma ação com params, meta & options

mol $ call "math.add" --a 5 --#b Bob --$timeout 1

Os parâmetros serão { a: 5 }, meta será { b: 'Bob' } e as opções serão { timeout: 1 }.

Executar com uma string JSON como parâmetro

mol $ call "math.add" '{"a": 5, "b": "Bob", "c": true, "d": false, "e": { "f": "hello" } }'

Parâmetros serão { a: 5, b: 'Bob', c: true, d: false, e: { f: 'hello' } }

Executar com parâmetros de arquivo

mol $ call "math.add" --load

Ele tenta carregar o arquivo <current_dir>/math.add.params.json para a variável params.

mol $ call "math.add" --load my-params.json

Tenta carregar o arquivo my-params.json para a variável params.

Executa com stream de arquivo

mol $ call "math.add" --stream my-picture.jpg

Carrega o arquivo my-picture.png e envia para a ação math.add como um Stream.

Executar e salvar a resposta em arquivo

mol $ call "math.add" --save

Salva a resposta no arquivo <current_dir>/posts.find.response.json. A extensão é .json quando a resposta for object. Caso contrário é .txt.

mol $ call "math.add" --save my-response.json

Salva a resposta para o arquivo my-response.json.

Chamada direta

Obter informações de saúde do nó node-12

mol $ dcall "node-12" "$node.health"

Passagem de parâmetros é semelhante ao comando call.

Emitir um evento

mol $ emit "user.created"

Emitir um evento com parâmetros

mol $ emit "user.created" --a 5 --b Bob --c --no-d --e.f "hello"

Parâmetros serão { a: 5, b: 'Bob', c: true, d: false, e: { f: 'hello' } }

Emitir um evento com parâmetros & metadados

mol $ emit "user.created" --a 5 --#b Bob --$groups acb

Os parâmetros serão { a: 5 }, meta será { b: 'Bob' } e as opções serão { groups: acb }.

Performance de um serviço

O módulo Moleculer REPL possui um novo comando para medir a performance de seus serviços.

# Executa um serviço até 5 segundos (padrão)
mol $ bench math.add

# Execute um serviço 5000 vezes
mol $ bench --num 5000 math.add

# Executa um serviço até 30 segundos
mol $ bench --time 30 math.add

Opções

--num <number>     Número de iterações
--time <seconds> Tempo de teste
--nodeID <nodeID> NodeID (chamada direta)

Saída image

Parâmetros

Por favor, note que os parâmetros podem ser passados apenas como string JSON.

mol $ bench math.add '{ "a": 50, "b": 32 }'

Carregar um serviço de um arquivo

mol $ load "./math.service.js"

Carregar todos os serviços de uma pasta

mol $ load "./services"

Listar métricas

mol $ metrics

Opções

-f, --filter <match>  filtra métricas (ex.: 'moleculer.**')

Saída image

Chaves de cache

Você pode listar as chaves de entradas de cache com

mol $ cache keys

Opções

-f, --filter <match>  filtra as chaves

Limpar cache

Você limpa o cache com:

mol $ cache clear

isto por padrão remove todas as entradas. Se você quiser remover um subconjunto de entradas, deverá adicionar um padrão:

Limpar com padrão

mol $ cache clear greeter.*

Eventos

REPL pode assinar e ouvir eventos. Para assinar utilize:

mol $ listener add user.created

Inscrever-se com a opção de grupo

mol $ listener add user.created --group abcd

Para cancelar a assinatura, use:

mol $ listener remove user.created

Para listar todos os eventos que REPL está ouvindo usar

mol $ listener list

Comandos personalizados

Os comandos personalizados do REPL podem ser definidos nas opções do broker para estender os comandos Moleculer REPL.

// moleculer.config.js
module.exports = {
replCommands: [
{
command: "hello <name>",
description: "Call the greeter.hello service with name",
alias: "hi",
options: [
{ option: "-u, --uppercase", description: "Uppercase the name" }
],
types: {
string: ["name"],
boolean: ["u", "uppercase"]
},
//parse(command, args) {},
//validate(args) {},
//help(args) {},
allowUnknownOptions: true,
action(broker, args/*, helpers*/) {
const name = args.options.uppercase ? args.name.toUpperCase() : args.name;
return broker.call("greeter.hello", { name }).then(console.log);
}
}
]
};
mol $ hello -u John
Hello JOHN