Fix answering questions (#2822)

- Fix answering questions, which was not working.
- Flatten the body to PATCH questions.
- Add the missing Agama::HTTP::Base#patch method.

---------

Co-authored-by: José Iván López <[email protected]>

Author: imobachgs

rust/agama-lib/src/questions/http_client.rs

@@ -24,7 +24,7 @@ use agama_utils::api::{
     config::Patch,
     question::{
         Answer, AnswerRule, Config as QuestionsConfig, Policy, Question, QuestionSpec,
-        UpdateOperation,
+        UpdateQuestion,
     },
     Config,
 };
@@ -128,7 +128,7 @@ impl HTTPClient {
     }
 
     pub async fn delete_question(&self, id: u32) -> Result<(), QuestionsHTTPClientError> {
-        let update = UpdateOperation::Delete { id };
+        let update = UpdateQuestion::Delete { id };
         self.client.patch_void("/v2/questions", &update).await?;
         Ok(())
     }

rust/agama-server/src/server/web.rs

@@ -26,7 +26,7 @@ use agama_utils::{
     actor::Handler,
     api::{
         config, event,
-        question::{Question, QuestionSpec, UpdateOperation},
+        question::{Question, QuestionSpec, UpdateQuestion},
         Action, Config, IssueMap, Status, SystemInfo,
     },
     question,
@@ -287,24 +287,24 @@ async fn ask_question(
     patch,
     path = "/questions",
     context_path = "/api/v2",
-    request_body = UpdateOperation,
+    request_body = UpdateQuestion,
     responses(
         (status = 200, description = "The question was answered or deleted"),
         (status = 400, description = "It was not possible to update the question")
     )
 )]
 async fn update_question(
     State(state): State<ServerState>,
-    Json(operation): Json<UpdateOperation>,
+    Json(operation): Json<UpdateQuestion>,
 ) -> ServerResult<()> {
     match operation {
-        UpdateOperation::Answer { id, answer } => {
+        UpdateQuestion::Answer { id, answer } => {
             state
                 .questions
                 .call(question::message::Answer { id, answer })
                 .await?;
         }
-        UpdateOperation::Delete { id } => {
+        UpdateQuestion::Delete { id } => {
             state
                 .questions
                 .call(question::message::Delete { id })

rust/agama-server/src/web/docs/config.rs

@@ -180,7 +180,7 @@ impl ApiDocBuilder for ConfigApiDocBuilder {
             .schema_from::<agama_utils::api::question::QuestionField>()
             .schema_from::<agama_utils::api::question::QuestionSpec>()
             .schema_from::<agama_utils::api::question::SelectionOption>()
-            .schema_from::<agama_utils::api::question::UpdateOperation>()
+            .schema_from::<agama_utils::api::question::UpdateQuestion>()
             .schema_from::<agama_utils::api::status::State>()
             .schema_from::<crate::software::web::SoftwareProposal>()
             .build()

rust/agama-utils/src/api/question.rs

@@ -319,9 +319,14 @@ pub struct Answer {
 ///
 /// It is used by the HTTP layer only.
 #[derive(Serialize, Deserialize, utoipa::ToSchema)]
-pub enum UpdateOperation {
+#[serde(rename_all = "camelCase")]
+pub enum UpdateQuestion {
     /// Answer the question with the given answer.
-    Answer { id: u32, answer: Answer },
+    Answer {
+        id: u32,
+        #[serde(flatten)]
+        answer: Answer,
+    },
     /// Remove the question.
     Delete { id: u32 },
 }

service/lib/agama/http/clients/base.rb

@@ -34,8 +34,8 @@ def initialize(logger)
         end
 
         # send POST request with given data and path.
-        # @param path[String] path relatived to `api`` endpoint.
-        # @param data[#to_json] data to send in request
+        # @param path [String] path relatived to `api`` endpoint.
+        # @param data [#to_json] data to send in request
         def post(path, data)
           response = Net::HTTP.post(uri(path), data.to_json, headers)
           return response unless response.is_a?(Net::HTTPClientError)
@@ -44,7 +44,7 @@ def post(path, data)
         end
 
         # send GET request with given path.
-        # @param path[String] path relatived to `api`` endpoint.
+        # @param path [String] path relatived to `api`` endpoint.
         # @return [Net::HTTPResponse, nil] Net::HTTPResponse if it is not an Net::HTTPClientError
         def get(path)
           response = Net::HTTP.get(uri(path), headers)
@@ -54,15 +54,27 @@ def get(path)
         end
 
         # send PUT request with given data and path.
-        # @param path[String] path relatived to `api`` endpoint.
-        # @param data[#to_json] data to send in request
+        # @param path [String] path relatived to `api`` endpoint.
+        # @param data [#to_json] data to send in request
         def put(path, data)
           response = Net::HTTP.put(uri(path), data.to_json, headers)
           return unless response.is_a?(Net::HTTPClientError)
 
           @logger.warn "server returned #{response.code} with body: #{response.body}"
         end
 
+        # send PATCH request with given data and path.
+        # @param path [String] path relatived to `api`` endpoint.
+        # @param data [#to_json] data to send in request
+        def patch(path, data)
+          url = uri(path)
+          http = Net::HTTP.start(url.hostname, url.port, use_ssl: url.scheme == "https")
+          response = http.patch(url, data.to_json, headers)
+          return response unless response.is_a?(Net::HTTPClientError)
+
+          @logger.warn "server returned #{response.code} with body: #{response.body}"
+        end
+
       protected
 
         def uri(path)

service/lib/agama/http/clients/questions.rb

@@ -27,6 +27,8 @@ module HTTP
     module Clients
       # HTTP client to interact with the files API.
       class Questions < Base
+        class CouldNotAddQuestion < StandardError; end
+
         # Adds a question
         #
         # @param question [Agama::Question]
@@ -46,7 +48,7 @@ def questions
         # @return [void]
         def delete(id)
           payload = { "delete" => { "id" => id } }
-          patch("/v2/questions", payload)
+          patch("v2/questions", payload)
         end
 
         # Waits until specified question is answered
@@ -79,13 +81,18 @@ def wait_answer(id)
         # @return [Agama::Answer] The question answer, or the result of the block in case a block
         #   is given.
         def ask(question)
-          question_id = add(question)
-          answer = wait_answer(question_id)
+          added_question = add(question)
+          if added_question.nil?
+            @logger.error "Could not add a question with data: {question.inspect}"
+            raise CouldNotAddQuestion
+          end
+
+          answer = wait_answer(added_question.id)
 
-          logger.info("#{question.text} #{answer}")
+          @logger.info("#{added_question.text} #{answer}")
 
           result = block_given? ? yield(answer) : answer
-          delete(question_id)
+          delete(added_question.id)
 
           result
         end

web/src/api/questions.ts

@@ -34,8 +34,11 @@ const fetchQuestions = async (): Promise<Question[]> => await get("/api/v2/quest
  * The answer is part of the Question object.
  */
 const updateAnswer = async (question: Question): Promise<void> => {
-  const { id, answer } = question;
-  await patch(`/api/v2/questions`, { id, answer });
+  const {
+    id,
+    answer: { action, value },
+  } = question;
+  await patch(`/api/v2/questions`, { answer: { id, action, value } });
 };
 
 export { fetchQuestions, updateAnswer };