Auto merge of #1924 - hbina:add_cache_control_for_readmes, r=smarnach

Added cache control to readme files

Related issue:  #1915

`extra_headers` parameter is no longer wrapped in `Option<T>`

Author: bors

src/bin/render-readmes.rs

@@ -21,9 +21,10 @@ use chrono::{TimeZone, Utc};
 use diesel::{dsl::any, prelude::*};
 use docopt::Docopt;
 use flate2::read::GzDecoder;
-use reqwest::Client;
+use reqwest::{header, Client};
 use tar::{self, Archive};
 
+const CACHE_CONTROL_README: &str = "public,max-age=604800";
 const DEFAULT_PAGE_SIZE: usize = 25;
 const USAGE: &str = "
 Usage: render-readmes [options]
@@ -129,6 +130,8 @@ fn main() {
                 let content_length = readme.len() as u64;
                 let content = std::io::Cursor::new(readme);
                 let readme_path = format!("readmes/{0}/{0}-{1}.html", krate_name, version.num);
+                let mut extra_headers = header::HeaderMap::new();
+                extra_headers.insert(header::CACHE_CONTROL, CACHE_CONTROL_README.parse().unwrap());
                 config
                     .uploader
                     .upload(
@@ -137,7 +140,7 @@ fn main() {
                         content,
                         content_length,
                         "text/html",
-                        None,
+                        extra_headers,
                     )
                     .unwrap_or_else(|_| {
                         panic!(

src/s3/lib.rs

@@ -45,7 +45,7 @@ impl Bucket {
         content: R,
         content_length: u64,
         content_type: &str,
-        extra_headers: Option<header::HeaderMap>,
+        extra_headers: header::HeaderMap,
     ) -> reqwest::Result<reqwest::Response> {
         let path = if path.starts_with('/') {
             &path[1..]
@@ -61,7 +61,7 @@ impl Bucket {
             .header(header::AUTHORIZATION, auth)
             .header(header::CONTENT_TYPE, content_type)
             .header(header::DATE, date)
-            .headers(extra_headers.unwrap_or_else(header::HeaderMap::new))
+            .headers(extra_headers)
             .body(reqwest::Body::sized(content, content_length))
             .send()?
             .error_for_status()

src/tasks/dump_db.rs

@@ -4,7 +4,7 @@ use std::{
 };
 
 use crate::{background_jobs::Environment, uploaders::Uploader, util::errors::std_error_no_send};
-
+use reqwest::header;
 use swirl::PerformError;
 
 /// Create CSV dumps of the public information in the database, wrap them in a
@@ -157,7 +157,7 @@ impl DumpTarball {
                 tarfile,
                 content_length,
                 "application/gzip",
-                None,
+                header::HeaderMap::new(),
             )
             .map_err(std_error_no_send)?;
         Ok(())

src/uploaders.rs

@@ -14,7 +14,8 @@ use std::sync::Arc;
 use crate::middleware::app::RequestApp;
 use crate::models::Crate;
 
-pub const CACHE_CONTROL_IMMUTABLE: &str = "public,max-age=31536000,immutable";
+const CACHE_CONTROL_IMMUTABLE: &str = "public,max-age=31536000,immutable";
+const CACHE_CONTROL_README: &str = "public,max-age=604800";
 
 #[derive(Clone, Debug)]
 pub enum Uploader {
@@ -94,7 +95,7 @@ impl Uploader {
         mut content: R,
         content_length: u64,
         content_type: &str,
-        extra_headers: Option<header::HeaderMap>,
+        extra_headers: header::HeaderMap,
     ) -> CargoResult<Option<String>> {
         match *self {
             Uploader::S3 { ref bucket, .. } => {
@@ -138,17 +139,14 @@ impl Uploader {
         let content_length = body.len() as u64;
         let content = Cursor::new(body);
         let mut extra_headers = header::HeaderMap::new();
-        extra_headers.insert(
-            header::CACHE_CONTROL,
-            CACHE_CONTROL_IMMUTABLE.parse().unwrap(),
-        );
+        extra_headers.insert(header::CACHE_CONTROL, CACHE_CONTROL_README.parse().unwrap());
         self.upload(
             app.http_client(),
             &path,
             content,
             content_length,
             "application/x-tar",
-            Some(extra_headers),
+            extra_headers,
         )?;
         Ok(checksum)
     }
@@ -163,13 +161,18 @@ impl Uploader {
         let path = Uploader::readme_path(crate_name, vers);
         let content_length = readme.len() as u64;
         let content = Cursor::new(readme);
+        let mut extra_headers = header::HeaderMap::new();
+        extra_headers.insert(
+            header::CACHE_CONTROL,
+            CACHE_CONTROL_IMMUTABLE.parse().unwrap(),
+        );
         self.upload(
             http_client,
             &path,
             content,
             content_length,
             "text/html",
-            None,
+            extra_headers,
         )?;
         Ok(())
     }