feat(api)!: remove /api/v1 and add /api/v2

Closes #244

Co-authored-by: Jeremy Fleischman <jeremyfleischman@gmail.com>

Author: mightyiam

crates/api/src/lib.rs

@@ -62,9 +62,15 @@ impl<'a> FromRequest<'a> for DbConnection {
 
 struct Api;
 
-#[OpenApi(prefix_path = "/v1")]
+#[OpenApi]
 impl Api {
-    #[oai(path = "/:pr", method = "get")]
+    #[allow(clippy::unused_async)]
+    #[oai(path = "/v1/:_", method = "get")]
+    async fn v1(&self) -> V1Response {
+        V1Response::NotSupported(payload::PlainText("API v1 not supported"))
+    }
+
+    #[oai(path = "/v2/landings/:pr", method = "get")]
     async fn landed(
         &self,
         param::Path(pr): param::Path<i32>,
@@ -80,7 +86,7 @@ impl Api {
         Ok(payload::Json(LandedIn { branches }))
     }
 
-    #[oai(path = "/healthcheck", method = "get")]
+    #[oai(path = "/v2/healthcheck", method = "get")]
     #[allow(clippy::unused_async)]
     async fn health_check(
         &self,
@@ -90,6 +96,12 @@ impl Api {
     }
 }
 
+#[derive(ApiResponse)]
+enum V1Response {
+    #[oai(status = 404)]
+    NotSupported(payload::PlainText<&'static str>),
+}
+
 #[derive(Serialize, Deserialize, Debug, PartialEq, Eq, poem_openapi::NewType)]
 pub struct Branch(pub String);
 

crates/api/tests/healthcheck.rs

@@ -7,12 +7,12 @@ use poem::http::StatusCode;
 use test_util::TestContext;
 
 test![healthcheck_ok, |ctx: TestContext| async move {
-    let response = ctx.client().get("/api/v1/healthcheck").send().await;
+    let response = ctx.client().get("/api/v2/healthcheck").send().await;
     response.assert_status_is_ok();
 }];
 
 test![healthcheck_not_ok, |mut ctx: TestContext| async move {
     ctx.db_mut().kill_db().unwrap();
-    let response = ctx.client().get("/api/v1/healthcheck").send().await;
+    let response = ctx.client().get("/api/v2/healthcheck").send().await;
     response.assert_status(StatusCode::SERVICE_UNAVAILABLE);
 }];

crates/api/tests/landings.rs

@@ -7,7 +7,7 @@ use poem::http::StatusCode;
 use test_util::TestContext;
 
 test![negative_pr_number, |ctx: TestContext| async move {
-    let response = ctx.client().get("/api/v1/-1").send().await;
+    let response = ctx.client().get("/api/v2/landings/-1").send().await;
     response.assert_status(StatusCode::BAD_REQUEST);
     response
         .assert_text("Pull request number non-positive.")
@@ -28,13 +28,13 @@ test![negative_pr_number, |ctx: TestContext| async move {
 //
 // test![internal_landed_error, |mut ctx: TestContext| async move {
 //     bork_db(ctx.db_mut()).await;
-//     let response = ctx.client().get("/api/v1/1").send().await;
+//     let response = ctx.client().get("/api/v2/landings/1").send().await;
 //     response.assert_status(StatusCode::SERVICE_UNAVAILABLE);
 //     response.assert_text("Error. Sorry.").await;
 // }];
 
 test![pr_not_found, |ctx: TestContext| async move {
-    let response = ctx.client().get("/api/v1/2134").send().await;
+    let response = ctx.client().get("/api/v2/landings/2134").send().await;
     response.assert_status(StatusCode::NO_CONTENT);
     response.assert_text("Pull request not found.").await;
 }];
@@ -50,7 +50,7 @@ test![pr_not_landed, |ctx: TestContext| async move {
     .await
     .unwrap();
 
-    let response = ctx.client().get("/api/v1/123").send().await;
+    let response = ctx.client().get("/api/v2/landings/123").send().await;
     response.assert_status_is_ok();
     response
         .assert_json(pr_tracker_api::LandedIn { branches: vec![] })
@@ -77,7 +77,7 @@ test![pr_landed, |ctx: TestContext| async move {
 
     landing.upsert(connection).await.unwrap();
 
-    let response = ctx.client().get("/api/v1/2134").send().await;
+    let response = ctx.client().get("/api/v2/landings/2134").send().await;
     response.assert_status_is_ok();
 
     response

crates/api/tests/v1.rs

@@ -0,0 +1,17 @@
+#[path = "../test-util.rs"]
+#[macro_use]
+mod test_util;
+
+use futures::FutureExt;
+use poem::http::StatusCode;
+use test_util::TestContext;
+
+test![v1_api_not_found, |ctx: TestContext| async move {
+    let response = ctx.client().get("/api/v1/healthcheck").send().await;
+    response.assert_status(StatusCode::NOT_FOUND);
+    response.assert_text("API v1 not supported").await;
+
+    let response = ctx.client().get("/api/v1/42").send().await;
+    response.assert_status(StatusCode::NOT_FOUND);
+    response.assert_text("API v1 not supported").await;
+}];

modules/integration-tests/api/default.nix

@@ -12,7 +12,7 @@
           testScript = ''
             pr_tracker_api.start()
             pr_tracker_api.wait_for_unit("pr-tracker-api.service")
-            pr_tracker_api.succeed("curl --fail http://localhost:7000/api/v1/healthcheck")
+            pr_tracker_api.succeed("curl --fail http://localhost:7000/api/v2/healthcheck")
           '';
         };
     };

modules/integration-tests/create-locally.nix

@@ -51,7 +51,7 @@ in
         testScript = ''
           pr_tracker.start()
           pr_tracker.wait_for_unit("pr-tracker-api.service")
-          pr_tracker.succeed("curl --fail http://localhost:${toString apiPort}/api/v1/healthcheck")
+          pr_tracker.succeed("curl --fail http://localhost:${toString apiPort}/api/v2/healthcheck")
           pr_tracker.wait_until_succeeds("journalctl -u pr-tracker-fetcher.service --grep 'error sending request for url'", timeout=60)
         '';
       };