BaseMax / BaseMax/GooglePlayWebServiceAPI
Consistency in return values
- Lenguaje dominante
- PHP
- Estrellas
- 42
- Forks
- 9
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
During my recent implementations and rewrites, I've introduced some "error reporting" to make it easier for the caller to figure if and what might have gone wrong. On error, several methods now return an array like
```php
[success:0, message:"reason"]
```
But not all of them – for example, most of the search/browse methods supposed to return a simple array of package names don't have this. There would be two options to reach (a sort of) consistency:
* returning `[success:0, message:reason]` instead (and if so, include `success:1` with a "good result) also for those methods that currently do not, moving the "real results" into a "sub-array" (which then, on error, could be empty or just not present at all)
* simply returning an empty array, and have a `getLastError()` method for obtaining the reason ***for all search/browse methods*** while keeping the current behavior for the others.
I'd prefer the first approach (so it's completely consistent) with the "empty real result". This combines the best of two worlds, e.g.
```php
$apps = $google->parseWhatever();
if ( empty($apps['data']) ) { // this could simply mean nothing found matching the criteria
if ( $apps['success'] ) { log('nothing found'); }
else { log ('ERROR occured: '.$apps['message']); }
} else { // do something with the data
```
I'd even go as far as to always include the `message` key, just leaving its value empty on success. That would make things most consistent.
What's your stance? If you agree, I'd go over the entire class another time and make it consistent:
* `success:0` only on *errors* – not generally on "no results" for a user-specified search (I vaguely remember I accidentally made it such in one case). `message` then holds the reason (e.g. the HTTP response, or parse error when an expected pattern didn't match, etc)
* `success:1` on success. `message` then is present but usually empty, but might eg hold a hint on why the result set is empty (like "no hits").
If we want to fix it, we want to do that as early as possible – before there are users whose code would otherwise break on some update.
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Línea de trabajo
Revisa toda la clase, especialmente los métodos de búsqueda y exploración, y compara sus valores de retorno actuales con los métodos de informe de errores descritos en el issue. Primero, llega a un acuerdo sobre un único contrato de respuesta; se considerará terminado cuando todos los métodos afectados sigan ese contrato de forma coherente, sin dejar sin resolver la decisión de compatibilidad.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- php
- Área
- api, backend-api-design
- Tipo de issue
- Refactorización
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 20/100