[gnome-software: 5/8] gs-odrs-provider: Use a custom error domain
- From: Philip Withnall <pwithnall src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-software: 5/8] gs-odrs-provider: Use a custom error domain
- Date: Fri, 25 Feb 2022 12:33:49 +0000 (UTC)
commit 64b391f4924869eaa80df0452a6be4d2c65bd0d9
Author: Philip Withnall <pwithnall endlessos org>
Date: Tue Feb 22 16:56:03 2022 +0000
gs-odrs-provider: Use a custom error domain
Rather than reusing vaguely-appropriate errors from `GsPluginError`.
This is another step towards decoupling more of gnome-software from the
`GsPlugin`/`GsPluginLoader` monolith.
This commit gives a 1:1 mapping between the old and new error codes. In
future, though, the use of a custom error domain will allow
finer-grained error codes to be returned from `GsOdrsProvider` if
needed. For example, to provide more information about error codes
returned by the server in response to an ODRS submission.
Signed-off-by: Philip Withnall <pwithnall endlessos org>
Helps: #1472
lib/gs-odrs-provider.c | 98 ++++++++++++++++++++++++++++----------------------
lib/gs-odrs-provider.h | 21 +++++++++++
lib/gs-utils.c | 32 -----------------
lib/gs-utils.h | 1 -
4 files changed, 77 insertions(+), 75 deletions(-)
---
diff --git a/lib/gs-odrs-provider.c b/lib/gs-odrs-provider.c
index 82e1914cc..138e7ed3e 100644
--- a/lib/gs-odrs-provider.c
+++ b/lib/gs-odrs-provider.c
@@ -41,6 +41,8 @@
#include <math.h>
#include <string.h>
+G_DEFINE_QUARK (gs-odrs-provider-error-quark, gs_odrs_provider_error)
+
/* Element in self->ratings, all allocated in one big block and sorted
* alphabetically to reduce the number of allocations and fragmentation. */
typedef struct {
@@ -121,29 +123,33 @@ gs_odrs_provider_load_ratings (GsOdrsProvider *self,
JsonObjectIter iter;
g_autoptr(GArray) new_ratings = NULL;
g_autoptr(GMutexLocker) locker = NULL;
+ g_autoptr(GError) local_error = NULL;
/* parse the data and find the success */
json_parser = json_parser_new_immutable ();
#if JSON_CHECK_VERSION(1, 6, 0)
- if (!json_parser_load_from_mapped_file (json_parser, filename, error)) {
+ if (!json_parser_load_from_mapped_file (json_parser, filename, &local_error)) {
#else
- if (!json_parser_load_from_file (json_parser, filename, error)) {
+ if (!json_parser_load_from_file (json_parser, filename, &local_error)) {
#endif
- gs_utils_error_convert_json_glib (error);
+ g_set_error (error,
+ GS_ODRS_PROVIDER_ERROR,
+ GS_ODRS_PROVIDER_ERROR_PARSING_DATA,
+ "Error parsing ODRS data: %s", local_error->message);
return FALSE;
}
json_root = json_parser_get_root (json_parser);
if (json_root == NULL) {
g_set_error_literal (error,
- GS_PLUGIN_ERROR,
- GS_PLUGIN_ERROR_INVALID_FORMAT,
+ GS_ODRS_PROVIDER_ERROR,
+ GS_ODRS_PROVIDER_ERROR_PARSING_DATA,
"no ratings root");
return FALSE;
}
if (json_node_get_node_type (json_root) != JSON_NODE_OBJECT) {
g_set_error_literal (error,
- GS_PLUGIN_ERROR,
- GS_PLUGIN_ERROR_INVALID_FORMAT,
+ GS_ODRS_PROVIDER_ERROR,
+ GS_ODRS_PROVIDER_ERROR_PARSING_DATA,
"no ratings array");
return FALSE;
}
@@ -261,40 +267,44 @@ gs_odrs_provider_parse_reviews (GsOdrsProvider *self,
g_autoptr(JsonParser) json_parser = NULL;
g_autoptr(GHashTable) reviewer_ids = NULL;
g_autoptr(GPtrArray) reviews = NULL;
+ g_autoptr(GError) local_error = NULL;
/* nothing */
if (data == NULL) {
if (!g_network_monitor_get_network_available (g_network_monitor_get_default ()))
g_set_error_literal (error,
- GS_PLUGIN_ERROR,
- GS_PLUGIN_ERROR_NO_NETWORK,
+ GS_ODRS_PROVIDER_ERROR,
+ GS_ODRS_PROVIDER_ERROR_NO_NETWORK,
"server couldn't be reached");
else
g_set_error_literal (error,
- GS_PLUGIN_ERROR,
- GS_PLUGIN_ERROR_INVALID_FORMAT,
+ GS_ODRS_PROVIDER_ERROR,
+ GS_ODRS_PROVIDER_ERROR_PARSING_DATA,
"server returned no data");
return NULL;
}
/* parse the data and find the array or ratings */
json_parser = json_parser_new_immutable ();
- if (!json_parser_load_from_data (json_parser, data, data_len, error)) {
- gs_utils_error_convert_json_glib (error);
+ if (!json_parser_load_from_data (json_parser, data, data_len, &local_error)) {
+ g_set_error (error,
+ GS_ODRS_PROVIDER_ERROR,
+ GS_ODRS_PROVIDER_ERROR_PARSING_DATA,
+ "Error parsing ODRS data: %s", local_error->message);
return NULL;
}
json_root = json_parser_get_root (json_parser);
if (json_root == NULL) {
g_set_error_literal (error,
- GS_PLUGIN_ERROR,
- GS_PLUGIN_ERROR_INVALID_FORMAT,
+ GS_ODRS_PROVIDER_ERROR,
+ GS_ODRS_PROVIDER_ERROR_PARSING_DATA,
"no root");
return NULL;
}
if (json_node_get_node_type (json_root) != JSON_NODE_ARRAY) {
g_set_error_literal (error,
- GS_PLUGIN_ERROR,
- GS_PLUGIN_ERROR_INVALID_FORMAT,
+ GS_ODRS_PROVIDER_ERROR,
+ GS_ODRS_PROVIDER_ERROR_PARSING_DATA,
"no array");
return NULL;
}
@@ -313,16 +323,16 @@ gs_odrs_provider_parse_reviews (GsOdrsProvider *self,
json_review = json_array_get_element (json_reviews, i);
if (json_node_get_node_type (json_review) != JSON_NODE_OBJECT) {
g_set_error_literal (error,
- GS_PLUGIN_ERROR,
- GS_PLUGIN_ERROR_INVALID_FORMAT,
+ GS_ODRS_PROVIDER_ERROR,
+ GS_ODRS_PROVIDER_ERROR_PARSING_DATA,
"no object type");
return NULL;
}
json_item = json_node_get_object (json_review);
if (json_item == NULL) {
g_set_error_literal (error,
- GS_PLUGIN_ERROR,
- GS_PLUGIN_ERROR_INVALID_FORMAT,
+ GS_ODRS_PROVIDER_ERROR,
+ GS_ODRS_PROVIDER_ERROR_PARSING_DATA,
"no object");
return NULL;
}
@@ -354,48 +364,52 @@ gs_odrs_provider_parse_success (const gchar *data,
JsonObject *json_item;
const gchar *msg = NULL;
g_autoptr(JsonParser) json_parser = NULL;
+ g_autoptr(GError) local_error = NULL;
/* nothing */
if (data == NULL) {
if (!g_network_monitor_get_network_available (g_network_monitor_get_default ()))
g_set_error_literal (error,
- GS_PLUGIN_ERROR,
- GS_PLUGIN_ERROR_NO_NETWORK,
+ GS_ODRS_PROVIDER_ERROR,
+ GS_ODRS_PROVIDER_ERROR_NO_NETWORK,
"server couldn't be reached");
else
g_set_error_literal (error,
- GS_PLUGIN_ERROR,
- GS_PLUGIN_ERROR_INVALID_FORMAT,
+ GS_ODRS_PROVIDER_ERROR,
+ GS_ODRS_PROVIDER_ERROR_PARSING_DATA,
"server returned no data");
return FALSE;
}
/* parse the data and find the success */
json_parser = json_parser_new_immutable ();
- if (!json_parser_load_from_data (json_parser, data, data_len, error)) {
- gs_utils_error_convert_json_glib (error);
+ if (!json_parser_load_from_data (json_parser, data, data_len, &local_error)) {
+ g_set_error (error,
+ GS_ODRS_PROVIDER_ERROR,
+ GS_ODRS_PROVIDER_ERROR_PARSING_DATA,
+ "Error parsing ODRS data: %s", local_error->message);
return FALSE;
}
json_root = json_parser_get_root (json_parser);
if (json_root == NULL) {
g_set_error_literal (error,
- GS_PLUGIN_ERROR,
- GS_PLUGIN_ERROR_INVALID_FORMAT,
+ GS_ODRS_PROVIDER_ERROR,
+ GS_ODRS_PROVIDER_ERROR_PARSING_DATA,
"no error root");
return FALSE;
}
if (json_node_get_node_type (json_root) != JSON_NODE_OBJECT) {
g_set_error_literal (error,
- GS_PLUGIN_ERROR,
- GS_PLUGIN_ERROR_INVALID_FORMAT,
+ GS_ODRS_PROVIDER_ERROR,
+ GS_ODRS_PROVIDER_ERROR_PARSING_DATA,
"no error object");
return FALSE;
}
json_item = json_node_get_object (json_root);
if (json_item == NULL) {
g_set_error_literal (error,
- GS_PLUGIN_ERROR,
- GS_PLUGIN_ERROR_INVALID_FORMAT,
+ GS_ODRS_PROVIDER_ERROR,
+ GS_ODRS_PROVIDER_ERROR_PARSING_DATA,
"no error object");
return FALSE;
}
@@ -405,8 +419,8 @@ gs_odrs_provider_parse_success (const gchar *data,
msg = json_object_get_string_member (json_item, "msg");
if (!json_object_get_boolean_member (json_item, "success")) {
g_set_error_literal (error,
- GS_PLUGIN_ERROR,
- GS_PLUGIN_ERROR_INVALID_FORMAT,
+ GS_ODRS_PROVIDER_ERROR,
+ GS_ODRS_PROVIDER_ERROR_PARSING_DATA,
msg != NULL ? msg : "unknown failure");
return FALSE;
}
@@ -528,8 +542,8 @@ gs_odrs_provider_json_post (SoupSession *session,
g_warning ("Failed to set rating on ODRS: %s",
soup_status_get_phrase (status_code));
g_set_error (error,
- GS_PLUGIN_ERROR,
- GS_PLUGIN_ERROR_FAILED,
+ GS_ODRS_PROVIDER_ERROR,
+ GS_ODRS_PROVIDER_ERROR_SERVER_ERROR,
"Failed to submit review to ODRS: %s", soup_status_get_phrase (status_code));
return FALSE;
}
@@ -790,8 +804,8 @@ gs_odrs_provider_fetch_for_app (GsOdrsProvider *self,
return NULL;
/* not sure what to do here */
g_set_error_literal (error,
- GS_PLUGIN_ERROR,
- GS_PLUGIN_ERROR_DOWNLOAD_FAILED,
+ GS_ODRS_PROVIDER_ERROR,
+ GS_ODRS_PROVIDER_ERROR_DOWNLOADING,
"status code invalid");
gs_utils_error_add_origin_id (error, self->cached_origin);
return NULL;
@@ -1358,7 +1372,7 @@ gs_odrs_provider_refine (GsOdrsProvider *self,
GsApp *app = gs_app_list_index (list, i);
g_autoptr(GError) local_error = NULL;
if (!refine_app (self, app, flags, cancellable, &local_error)) {
- if (g_error_matches (local_error, GS_PLUGIN_ERROR, GS_PLUGIN_ERROR_NO_NETWORK)) {
+ if (g_error_matches (local_error, GS_ODRS_PROVIDER_ERROR,
GS_ODRS_PROVIDER_ERROR_NO_NETWORK)) {
g_debug ("failed to refine app %s: %s",
gs_app_get_unique_id (app), local_error->message);
} else {
@@ -1642,8 +1656,8 @@ gs_odrs_provider_add_unvoted_reviews (GsOdrsProvider *self,
return FALSE;
/* not sure what to do here */
g_set_error_literal (error,
- GS_PLUGIN_ERROR,
- GS_PLUGIN_ERROR_DOWNLOAD_FAILED,
+ GS_ODRS_PROVIDER_ERROR,
+ GS_ODRS_PROVIDER_ERROR_DOWNLOADING,
"status code invalid");
gs_utils_error_add_origin_id (error, self->cached_origin);
return FALSE;
diff --git a/lib/gs-odrs-provider.h b/lib/gs-odrs-provider.h
index 64059355c..90cc51b3d 100644
--- a/lib/gs-odrs-provider.h
+++ b/lib/gs-odrs-provider.h
@@ -18,6 +18,27 @@
G_BEGIN_DECLS
+/**
+ * GsOdrsProviderError:
+ * @GS_ODRS_PROVIDER_ERROR_DOWNLOADING: Error while downloading ODRS data.
+ * @GS_ODRS_PROVIDER_ERROR_PARSING_DATA: Problem parsing downloaded ODRS data.
+ * @GS_ODRS_PROVIDER_ERROR_NO_NETWORK: Offline or network unavailable.
+ * @GS_ODRS_PROVIDER_ERROR_SERVER_ERROR: Server rejected ODRS submission or returned an error.
+ *
+ * Error codes for #GsOdrsProvider.
+ *
+ * Since: 42
+ */
+typedef enum {
+ GS_ODRS_PROVIDER_ERROR_DOWNLOADING,
+ GS_ODRS_PROVIDER_ERROR_PARSING_DATA,
+ GS_ODRS_PROVIDER_ERROR_NO_NETWORK,
+ GS_ODRS_PROVIDER_ERROR_SERVER_ERROR,
+} GsOdrsProviderError;
+
+#define GS_ODRS_PROVIDER_ERROR gs_odrs_provider_error_quark ()
+GQuark gs_odrs_provider_error_quark (void);
+
#define GS_TYPE_ODRS_PROVIDER (gs_odrs_provider_get_type ())
G_DECLARE_FINAL_TYPE (GsOdrsProvider, gs_odrs_provider, GS, ODRS_PROVIDER, GObject)
diff --git a/lib/gs-utils.c b/lib/gs-utils.c
index 2afe77d87..89349b1fe 100644
--- a/lib/gs-utils.c
+++ b/lib/gs-utils.c
@@ -976,38 +976,6 @@ gs_utils_error_convert_gdk_pixbuf (GError **perror)
return TRUE;
}
-/**
- * gs_utils_error_convert_json_glib:
- * @perror: a pointer to a #GError, or %NULL
- *
- * Converts the #JsonParserError to an error with a GsPluginError domain.
- *
- * Returns: %TRUE if the error was converted, or already correct
- **/
-gboolean
-gs_utils_error_convert_json_glib (GError **perror)
-{
- GError *error = perror != NULL ? *perror : NULL;
-
- /* not set */
- if (error == NULL)
- return FALSE;
- if (error->domain == GS_PLUGIN_ERROR)
- return TRUE;
- if (error->domain != JSON_PARSER_ERROR)
- return FALSE;
- switch (error->code) {
- case JSON_PARSER_ERROR_UNKNOWN:
- error->code = GS_PLUGIN_ERROR_FAILED;
- break;
- default:
- error->code = GS_PLUGIN_ERROR_INVALID_FORMAT;
- break;
- }
- error->domain = GS_PLUGIN_ERROR;
- return TRUE;
-}
-
/**
* gs_utils_error_convert_appstream:
* @perror: a pointer to a #GError, or %NULL
diff --git a/lib/gs-utils.h b/lib/gs-utils.h
index 6b7de2acf..50135ce77 100644
--- a/lib/gs-utils.h
+++ b/lib/gs-utils.h
@@ -83,7 +83,6 @@ gboolean gs_utils_error_convert_gio (GError **perror);
gboolean gs_utils_error_convert_gresolver (GError **perror);
gboolean gs_utils_error_convert_gdbus (GError **perror);
gboolean gs_utils_error_convert_gdk_pixbuf(GError **perror);
-gboolean gs_utils_error_convert_json_glib (GError **perror);
gboolean gs_utils_error_convert_appstream (GError **perror);
gchar *gs_utils_get_url_scheme (const gchar *url);
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
