add simple "deployment pending" marker 20 minutes after a build

Author: syphar

src/cdn.rs

@@ -4,6 +4,7 @@ use aws_sdk_cloudfront::{
     model::{InvalidationBatch, Paths},
     Client, RetryConfig,
 };
+use chrono::{DateTime, Utc};
 use std::sync::{Arc, Mutex};
 use strum::EnumString;
 use tokio::runtime::Runtime;
@@ -129,15 +130,38 @@ pub(crate) fn invalidate_crate(config: &Config, cdn: &CdnBackend, name: &str) ->
     Ok(())
 }
 
+/// Return if we count the deploy as pending based on the build-time.
+/// CloudFront invalidations can take up to 15 minutes. Until we have
+/// live queries of the invalidation status we just assume it's fine
+/// latest 20 minutes after the build.
+/// TODO: should be replaced be keeping track or querying the active invalidation from CloudFront
+pub(crate) fn crate_invalidation_pending(build_time: &DateTime<Utc>) -> bool {
+    Utc::now().signed_duration_since(*build_time) <= chrono::Duration::minutes(20)
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;
     use crate::test::wrapper;
+    use chrono::Duration;
+    use test_case::test_case;
 
     use aws_sdk_cloudfront::{Client, Config, Credentials, Region};
     use aws_smithy_client::{erase::DynConnector, test_connection::TestConnection};
     use aws_smithy_http::body::SdkBody;
 
+    #[test_case(10, true)]
+    #[test_case(19, true)]
+    #[test_case(21, false)]
+    #[test_case(9999, false)]
+    fn get_invalidation_pending(minutes: i64, expected: bool) {
+        let now = Utc::now();
+        assert_eq!(
+            crate_invalidation_pending(&(now - Duration::minutes(minutes))),
+            expected
+        );
+    }
+
     #[test]
     fn create_cloudfront() {
         wrapper(|env| {

src/web/releases.rs

@@ -2,6 +2,7 @@
 
 use crate::{
     build_queue::QueuedCrate,
+    cdn::crate_invalidation_pending,
     db::{Pool, PoolClient},
     impl_webpage,
     utils::report_error,
@@ -38,6 +39,7 @@ pub struct Release {
     description: Option<String>,
     target_name: Option<String>,
     rustdoc_status: bool,
+    deployment_pending: bool,
     pub(crate) build_time: DateTime<Utc>,
     stars: i32,
 }
@@ -109,6 +111,7 @@ pub(crate) fn get_releases(
             target_name: row.get(3),
             rustdoc_status: row.get(4),
             build_time: row.get(5),
+            deployment_pending: crate_invalidation_pending(&row.get(5)),
             stars: row.get::<_, Option<i32>>(6).unwrap_or(0),
         })
         .collect()
@@ -222,6 +225,7 @@ fn get_search_results(
                     version: row.get("version"),
                     description: row.get("description"),
                     build_time: row.get("build_time"),
+                    deployment_pending: crate_invalidation_pending(&row.get("build_time")),
                     target_name: row.get("target_name"),
                     rustdoc_status: row.get("rustdoc_status"),
                     stars: stars.unwrap_or(0),

templates/core/home.html

@@ -47,7 +47,7 @@ <h1 class="brand">{{ "cubes" | fas(fw=true) }} Docs.rs</h1>
                                 <div class="pure-u-1 pure-u-sm-6-24 pure-u-md-5-24 name">
                                     {{ release.name }}-{{ release.version }}
                                 </div>
-                                <div class="pure-u-1 pure-u-sm-14-24 pure-u-md-16-24 description">
+                                <div class="pure-u-1 pure-u-sm-13-24 pure-u-md-15-24 description">
                                     {{ release.description }}
                                 </div>
 
@@ -62,6 +62,17 @@ <h1 class="brand">{{ "cubes" | fas(fw=true) }} Docs.rs</h1>
                                         {{ release.build_time | timeformat(relative=true) }}
                                     </div>
                                 {%- endif -%}
+                                {% if release.deployment_pending -%}
+                                    <div class="pure-u-1 pure-u-sm-1-24 pure-u-md-1-24 deploymentstatus"
+                                        title="deployment pending, some pages might be outdated">
+                                        {{ "spinner" | fas }}
+                                    </div>
+                                {%- else -%}
+                                    <div class="pure-u-1 pure-u-sm-1-24 pure-u-md-1-24 deploymentstatus"
+                                        title="deployment finished">
+                                        {{ "check" | fas }}
+                                    </div>
+                                {%- endif -%}
                             </div>
                         </a>
                     </li>

templates/releases/releases.html

@@ -34,7 +34,7 @@
                                     {{ release.name }}-{{ release.version }}
                                 </div>
 
-                                <div class="pure-u-1 pure-u-sm-14-24 pure-u-md-16-24 description">
+                                <div class="pure-u-1 pure-u-sm-13-24 pure-u-md-15-24 description">
                                     {{ release.description }}
                                 </div>
 
@@ -50,6 +50,17 @@
                                         {{ release.build_time | timeformat(relative=true) }}
                                     </div>
                                 {%- endif %}
+                                {% if release.deployment_pending -%}
+                                    <div class="pure-u-1 pure-u-sm-1-24 pure-u-md-1-24 deploymentstatus"
+                                        title="deployment pending, some pages might be outdated">
+                                        {{ "spinner" | fas }}
+                                    </div>
+                                {%- else -%}
+                                    <div class="pure-u-1 pure-u-sm-1-24 pure-u-md-1-24 deploymentstatus"
+                                        title="deployment finished">
+                                        {{ "check" | fas }}
+                                    </div>
+                                {%- endif -%}
                             </div>
                         </a>
                     </li>

templates/style/style.scss

@@ -364,6 +364,14 @@ div.recent-releases-container {
         }
     }
 
+    .deploymentstatus {
+        font-weight: normal;
+
+        @media #{$media-sm} {
+            text-align: right;
+        }
+    }
+
     div.pagination {
         text-align: center;
         margin: 1em;