[Feat]: Simplification of the client API?

Aberta
#517 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 2 dias

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
65/100
Tipo de issue
Refatoração
Clareza
Claramente especificada
Status de atividade
Estagnada
Stack de tecnologia
java
Domínio
api

Direção de pesquisa

Examine a API do cliente no módulo spec, concentrando-se nos métodos que usam objetos XXXParams, como TaskIdParams. Examine o método sendMessage existente como referência para o padrão. Identifique todos os métodos que poderiam ser simplificados e, em seguida, crie versões sobrecarregadas que aceitem parâmetros primitivos e deleguem às implementações existentes. Garanta a compatibilidade retroativa e teste as alterações.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

Is your feature request related to a problem? Please describe.

The client API is a thin wrapper around the domain objects in the spec module.

I wonder if we could not make the API a bit simpler while retaining all the capabilities it exposes.

Describe the solution you'd like

For example, a lot of calls wrap their parameters in XXXParams object:

public Task cancelTask(TaskIdParams request)

but TaskIdParams is composed of a taskId and a metadata map.
Could the call simply be:

public Task cancelTask(String taskId, Map<String, Object> metadata) {
  return clientTransport.cancelTask(new TaskIdParams(taskId, metadata), request, context);
}

and a default method:

public default Task cancelTask(String taskId) {
    return cancelTask(taskId, emptyMap();
}

This way, the TaskIdParams does not leak to the Client API (making it bigger than it needs to be.

The API is already to that for its sendMessage methods that hides the internal MessageSendParams.
This is a pattern that should be applied to other methods as well

Describe alternatives you've considered

No response

Additional context

No response

Code of Conduct
  • I agree to follow this project's Code of Conduct
Linguagem predominante
Java
Estrelas
507
Forks
192
Merge médio
4d 2h
PRs com merge (30d)
30

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de a2aproject/a2a-java

Todas as issues de a2aproject/a2a-java

Issues semelhantes

Mais issues de Java

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.