Refactoring: Use let-else for errors

Abierto
#14 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 2 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
38/100
Tipo de issue
Refactorización
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
rust
Área
backend

Línea de trabajo

Busca en la base de código de Rust el patrón de manejo de errores .or(Err(...))? e inspecciona primero device.open_device. Reemplaza los casos aplicables por let-else, instrumentación de tracing o matches en el sitio de invocación, según corresponda; el trabajo estará terminado cuando los errores se registren con el contexto relevante y se preserve el resultado de error existente.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

good first issue

Currently a lot of errors are handled in a manner similar to:

let dev = device.open_device(&hidapi)
                .or(Err(Error::Transport(TransportError::ConnectionFailed)))?;

These errors are tricky to track down. Now that we're using the tracing crate fully, it would be best to rewrite these using let-else syntax, ie.:

let Ok(dev) = device.open_device(&hidapi) else {
    error!(?hidapi, "Failed to open device");
    return Err(Error::Transport(TransportError::ConnectionFailed));
}

If the error is relevant to the message, first consider if the method being called should be instrumented to automatically log errors in their context:

use tracing::instrument;

#[instrument(skipall, err)]
pub fn open_device(&self, dev: &HidDevice) {
    ...

If this is not possible, we can instead use match statements at the point of invocation:

let dev = match device.open_device(&hidapi) {
    Ok(dev) => dev,
    Err(err) => {
        error!({ %err, ?hidapi }, "Failed to open device");
        return Err(Error::Transport(TransportError::ConnectionFailed));
    }
};
Lenguaje dominante
Rust
Estrellas
602
Forks
33
Merge medio
1 d 13 h
PR fusionados (30 d)
9

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de linux-credentials/libwebauthn

Todos los issues de linux-credentials/libwebauthn

Issues similares

Más issues de Rust

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.