Add endpoint for listing jobs

Author: augustuswm

rfd-api-spec.json

@@ -715,6 +715,44 @@
         }
       }
     },
+    "/job": {
+      "get": {
+        "summary": "List all jobs for a RFD",
+        "operationId": "list_jobs",
+        "parameters": [
+          {
+            "in": "query",
+            "name": "rfd",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "Array_of_Job",
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/Job"
+                  }
+                }
+              }
+            }
+          },
+          "4XX": {
+            "$ref": "#/components/responses/Error"
+          },
+          "5XX": {
+            "$ref": "#/components/responses/Error"
+          }
+        }
+      }
+    },
     "/login/magic/{channel}/exchange": {
       "post": {
         "summary": "Exchange a magic link access code for an access token",
@@ -3165,6 +3203,66 @@
           "key"
         ]
       },
+      "Job": {
+        "type": "object",
+        "properties": {
+          "branch": {
+            "type": "string"
+          },
+          "committed_at": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "created_at": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "id": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "owner": {
+            "type": "string"
+          },
+          "processed": {
+            "type": "boolean"
+          },
+          "repository": {
+            "type": "string"
+          },
+          "rfd": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "sha": {
+            "$ref": "#/components/schemas/CommitSha"
+          },
+          "started_at": {
+            "nullable": true,
+            "type": "string",
+            "format": "date-time"
+          },
+          "webhook_delivery_id": {
+            "nullable": true,
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/TypedUuidForWebhookDeliveryId"
+              }
+            ]
+          }
+        },
+        "required": [
+          "branch",
+          "committed_at",
+          "created_at",
+          "id",
+          "owner",
+          "processed",
+          "repository",
+          "rfd",
+          "sha"
+        ]
+      },
       "Jwk": {
         "type": "object",
         "properties": {
@@ -4847,6 +4945,10 @@
         "type": "string",
         "format": "uuid"
       },
+      "TypedUuidForWebhookDeliveryId": {
+        "type": "string",
+        "format": "uuid"
+      },
       "Visibility": {
         "type": "string",
         "enum": [

rfd-api/src/context.rs

@@ -17,7 +17,7 @@ use rfd_data::{
 use rfd_github::{GitHubError, GitHubNewRfdNumber, GitHubRfdRepo};
 use rfd_model::{
     schema_ext::{ContentFormat, Visibility},
-    storage::{JobStore, RfdFilter, RfdMetaStore, RfdPdfsStore, RfdStorage, RfdStore},
+    storage::{JobFilter, JobStore, RfdFilter, RfdMetaStore, RfdPdfsStore, RfdStorage, RfdStore},
     CommitSha, FileSha, Job, NewJob, Rfd, RfdId, RfdMeta, RfdPdf, RfdPdfs, RfdRevision,
     RfdRevisionId,
 };
@@ -814,6 +814,32 @@ impl RfdContext {
         }
     }
 
+    // Job Operations
+    pub async fn list_jobs(
+        &self,
+        caller: &Caller<RfdPermission>,
+        filter: Option<JobFilter>,
+    ) -> ResourceResult<Vec<Job>, StoreError> {
+        let mut jobs = JobStore::list(
+            &*self.storage,
+            filter.map(|filter| vec![filter]).unwrap_or_default(),
+            &ListPagination::default().limit(UNLIMITED),
+        )
+        .await
+        .tap_err(|err| tracing::error!(?err, "Failed to lookup jobs"))
+        .to_resource_result()?;
+
+        // Filter the list of jobs down to only those that the caller is allowed to access
+        jobs.retain_mut(|job| {
+            caller.can(&RfdPermission::GetRfdsAll) || caller.can(&RfdPermission::GetRfd(job.rfd))
+        });
+
+        // Finally sort the jobs list by create time
+        jobs.sort_by(|a, b| b.created_at.cmp(&a.created_at));
+
+        Ok(jobs)
+    }
+
     // Webhook Operations
 
     pub async fn register_job(&self, new_job: NewJob) -> Result<Job, StoreError> {

rfd-api/src/endpoints/job.rs

@@ -0,0 +1,58 @@
+// Read Endpoints
+
+use dropshot::{endpoint, ClientErrorStatusCode, HttpError, HttpResponseOk, Query, RequestContext};
+use rfd_model::{storage::JobFilter, Job};
+use schemars::JsonSchema;
+use serde::Deserialize;
+use trace_request::trace_request;
+use tracing::instrument;
+use v_api::{response::client_error, ApiContext};
+use v_model::permissions::Caller;
+
+use crate::{context::RfdContext, permissions::RfdPermission};
+
+#[derive(Debug, Deserialize, JsonSchema)]
+struct ListJobsQuery {
+    rfd: String,
+}
+
+/// List all jobs for a RFD
+#[trace_request]
+#[endpoint {
+    method = GET,
+    path = "/job",
+}]
+#[instrument(skip(rqctx), fields(request_id = rqctx.request_id), err(Debug))]
+pub async fn list_jobs(
+    rqctx: RequestContext<RfdContext>,
+    query: Query<ListJobsQuery>,
+) -> Result<HttpResponseOk<Vec<Job>>, HttpError> {
+    let ctx = rqctx.context();
+    let caller = ctx.v_ctx().get_caller(&rqctx).await?;
+    let query = query.into_inner();
+    list_jobs_op(ctx, &caller, query).await
+}
+
+// Read operation
+
+#[instrument(skip(ctx, caller), fields(caller = ?caller.id), err(Debug))]
+async fn list_jobs_op(
+    ctx: &RfdContext,
+    caller: &Caller<RfdPermission>,
+    query: ListJobsQuery,
+) -> Result<HttpResponseOk<Vec<Job>>, HttpError> {
+    if let Ok(rfd_number) = query.rfd.parse::<i32>() {
+        let jobs = ctx
+            .list_jobs(
+                caller,
+                Some(JobFilter::default().rfd(Some(vec![rfd_number]))),
+            )
+            .await?;
+        Ok(HttpResponseOk(jobs))
+    } else {
+        Err(client_error(
+            ClientErrorStatusCode::BAD_REQUEST,
+            "Malformed RFD number",
+        ))
+    }
+}

rfd-api/src/endpoints/mod.rs

@@ -2,5 +2,6 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
+pub mod job;
 pub mod rfd;
 pub mod webhook;

rfd-api/src/server.rs

@@ -15,6 +15,7 @@ use v_api::{inject_endpoints, v_system_endpoints};
 use crate::{
     context::RfdContext,
     endpoints::{
+        job::list_jobs,
         rfd::{
             discuss_rfd, list_rfds, publish_rfd, reserve_rfd, search_rfds, set_rfd_attr,
             set_rfd_content, set_rfd_document, update_rfd_visibility, view_rfd, view_rfd_attr,
@@ -118,6 +119,9 @@ pub fn server(
     api.register(update_rfd_visibility)
         .expect("Failed to register endpoint");
 
+    api.register(list_jobs)
+        .expect("Failed to register endpoint");
+
     // Webhooks
     api.register(github_webhook)
         .expect("Failed to register endpoint");

rfd-cli/src/generated/cli.rs

@@ -34,6 +34,7 @@ impl<T: CliConfig> Cli<T> {
             CliCommand::CreateGroup => Self::cli_create_group(),
             CliCommand::UpdateGroup => Self::cli_update_group(),
             CliCommand::DeleteGroup => Self::cli_delete_group(),
+            CliCommand::ListJobs => Self::cli_list_jobs(),
             CliCommand::MagicLinkExchange => Self::cli_magic_link_exchange(),
             CliCommand::MagicLinkSend => Self::cli_magic_link_send(),
             CliCommand::AuthzCodeRedirect => Self::cli_authz_code_redirect(),
@@ -274,7 +275,9 @@ impl<T: CliConfig> Cli<T> {
             .arg(
                 ::clap::Arg::new("expires-at")
                     .long("expires-at")
-                    .value_parser(::clap::value_parser!(chrono::DateTime<chrono::offset::Utc>))
+                    .value_parser(::clap::value_parser!(
+                        ::chrono::DateTime<::chrono::offset::Utc>
+                    ))
                     .required_unless_present("json-body"),
             )
             .arg(
@@ -460,6 +463,17 @@ impl<T: CliConfig> Cli<T> {
             .about("Delete a group")
     }
 
+    pub fn cli_list_jobs() -> ::clap::Command {
+        ::clap::Command::new("")
+            .arg(
+                ::clap::Arg::new("rfd")
+                    .long("rfd")
+                    .value_parser(::clap::value_parser!(::std::string::String))
+                    .required(true),
+            )
+            .about("List all jobs for a RFD")
+    }
+
     pub fn cli_magic_link_exchange() -> ::clap::Command {
         ::clap::Command::new("")
             .arg(
@@ -746,7 +760,9 @@ impl<T: CliConfig> Cli<T> {
             .arg(
                 ::clap::Arg::new("expires-at")
                     .long("expires-at")
-                    .value_parser(::clap::value_parser!(chrono::DateTime<chrono::offset::Utc>))
+                    .value_parser(::clap::value_parser!(
+                        ::chrono::DateTime<::chrono::offset::Utc>
+                    ))
                     .required(false),
             )
             .arg(
@@ -1520,6 +1536,7 @@ impl<T: CliConfig> Cli<T> {
             CliCommand::CreateGroup => self.execute_create_group(matches).await,
             CliCommand::UpdateGroup => self.execute_update_group(matches).await,
             CliCommand::DeleteGroup => self.execute_delete_group(matches).await,
+            CliCommand::ListJobs => self.execute_list_jobs(matches).await,
             CliCommand::MagicLinkExchange => self.execute_magic_link_exchange(matches).await,
             CliCommand::MagicLinkSend => self.execute_magic_link_send(matches).await,
             CliCommand::AuthzCodeRedirect => self.execute_authz_code_redirect(matches).await,
@@ -1856,7 +1873,8 @@ impl<T: CliConfig> Cli<T> {
         matches: &::clap::ArgMatches,
     ) -> anyhow::Result<()> {
         let mut request = self.client.create_api_user_token();
-        if let Some(value) = matches.get_one::<chrono::DateTime<chrono::offset::Utc>>("expires-at")
+        if let Some(value) =
+            matches.get_one::<::chrono::DateTime<::chrono::offset::Utc>>("expires-at")
         {
             request = request.body_map(|body| body.expires_at(value.clone()))
         }
@@ -2101,6 +2119,26 @@ impl<T: CliConfig> Cli<T> {
         }
     }
 
+    pub async fn execute_list_jobs(&self, matches: &::clap::ArgMatches) -> anyhow::Result<()> {
+        let mut request = self.client.list_jobs();
+        if let Some(value) = matches.get_one::<::std::string::String>("rfd") {
+            request = request.rfd(value.clone());
+        }
+
+        self.config.execute_list_jobs(matches, &mut request)?;
+        let result = request.send().await;
+        match result {
+            Ok(r) => {
+                self.config.success_item(&r);
+                Ok(())
+            }
+            Err(r) => {
+                self.config.error(&r);
+                Err(anyhow::Error::new(r))
+            }
+        }
+    }
+
     pub async fn execute_magic_link_exchange(
         &self,
         matches: &::clap::ArgMatches,
@@ -2364,7 +2402,8 @@ impl<T: CliConfig> Cli<T> {
             request = request.body_map(|body| body.device_code(value.clone()))
         }
 
-        if let Some(value) = matches.get_one::<chrono::DateTime<chrono::offset::Utc>>("expires-at")
+        if let Some(value) =
+            matches.get_one::<::chrono::DateTime<::chrono::offset::Utc>>("expires-at")
         {
             request = request.body_map(|body| body.expires_at(value.clone()))
         }
@@ -3540,6 +3579,14 @@ pub trait CliConfig {
         Ok(())
     }
 
+    fn execute_list_jobs(
+        &self,
+        matches: &::clap::ArgMatches,
+        request: &mut builder::ListJobs,
+    ) -> anyhow::Result<()> {
+        Ok(())
+    }
+
     fn execute_magic_link_exchange(
         &self,
         matches: &::clap::ArgMatches,
@@ -3914,6 +3961,7 @@ pub enum CliCommand {
     CreateGroup,
     UpdateGroup,
     DeleteGroup,
+    ListJobs,
     MagicLinkExchange,
     MagicLinkSend,
     AuthzCodeRedirect,
@@ -3982,6 +4030,7 @@ impl CliCommand {
             CliCommand::CreateGroup,
             CliCommand::UpdateGroup,
             CliCommand::DeleteGroup,
+            CliCommand::ListJobs,
             CliCommand::MagicLinkExchange,
             CliCommand::MagicLinkSend,
             CliCommand::AuthzCodeRedirect,