v6: groups/UserType spells db_env_user as db_end_user, and is an unreferenced duplicate

Aperta
#623 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
55/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
java
Ambito
api, authorization

Direzione di ricerca

Inizia da io/weaviate/client6/v1/api/rbac/groups/UserType.java e confrontalo con rbac/users/UserType. Usa il grep indicato su src/ per verificare se il groups enum è referenziato, quindi conferma che la correzione o eliminazione selezionata corrisponda all’API pubblica e al valore del server db_env_user. Il lavoro è completato quando il comportamento del duplicato e del wire-value è stato risolto in modo coerente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Summary

rbac/groups/UserType spells one of its wire values db_end_user. The server's value is db_env_userenv, not end. So DB_ENV_USER can never be produced by a read, and writing it would emit a value the server rejects.

It is also unreferenced, which is almost certainly why the typo survived: nothing in src/main, src/test or src/it uses this enum. That makes it a latent defect rather than a live one, and it may be that the right fix is deletion rather than a correction — see below.

Where it comes from

io/weaviate/client6/v1/api/rbac/groups/UserType.java (6.3.1) — the whole file:

public enum UserType {
  @SerializedName("db_user")
  DB_USER,
  @SerializedName("db_end_user")   // <-- server value is db_env_user
  DB_ENV_USER,
  @SerializedName("oidc")
  OIDC
}

The server's enumeration, entities/models/d_b_user_info.go:142:

if err := json.Unmarshal([]byte(`["db_user","db_env_user"]`), &res); err != nil {

The constant is named DB_ENV_USER, so the intent was clearly db_env_user; only the string is wrong.

It is a duplicate, not the live one

There are two public UserType enums in sibling packages:

used by db_env_user
rbac/users/UserType UserAssignment, GetAssignedRolesRequest, DbUsersClient, NamespacedUsersClient, RbacITest via @SerializedName(value = "db", alternate = "db_env_user")
rbac/groups/UserType nothing db_end_user — wrong

grep -rn "UserType" src/ returns the users copy everywhere and the groups copy nowhere. (GroupType, in the same package, is used — this is not a case of the whole package being dead.)

Suggested fix

Two options, and I do not want to presume which you want:

  1. Delete rbac/groups/UserType. It is an unreferenced duplicate of a type that already exists and already handles this value correctly. The typo is evidence that nothing has ever exercised it. This removes a trap for whoever wires up the groups client next — they would reach for the enum in their own package and get the broken one. It is a public type, so removing it is a breaking change on paper, even though nothing inside the client can be broken by it.

  2. Correct the string to db_env_user. Safe and non-breaking, but leaves two divergent copies of the same concept in the tree, which is how this happened.

The attached PR does (2), as the lower-risk default. Say the word and I will switch it to (1).

Version

  • java-client 6.3.1
  • Weaviate 1.39.0
Lingua principale
Java
Stelle
34
Fork
30
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di weaviate/java-client

Tutte le issue di weaviate/java-client

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.