Exclude version_downloads from the database dumps.

The current implementation of the database dumps does not work for the partioned
version_downloads table. This change excludes the version_downloads table and all its
partitions from the dumps.

Author: smarnach

src/tasks/dump_db/dump-db.toml

@@ -2,47 +2,66 @@
 # database table, we set which columns are included in the dump, and optionally
 # how to filter the rows.
 #
-# <table_name>.columns - a TOML dictionary determining what columns to include.
-#     possible values are "private" (not included) and "public" (included).
+# tables.<table_name>.columns - a TOML dictionary determining what columns to
+#     include. possible values are "private" (not included) and "public"
+#     (included).
 #
-# <table_name>.filter - a string that is a valid SQL expression, which is used
-#     in a WHERE clause to filter the rows of the table.
+# tables.<table_name>.filter - a string that is a valid SQL expression, which
+#     is used in a WHERE clause to filter the rows of the table.
 #
-# <table_name>.dependencies - an array of table names, used to determine the
-#     order of the tables in the generated import script. All tables referred
-#     to by public columns in the current table should be listed, to make sure
-#     they are imported before this table.
+# tables.<table_name>.dependencies - an array of table names, used to determine
+#     the order of the tables in the generated import script. All tables
+#     referred to by public columns in the current table should be listed, to
+#     make sure they are imported before this table.
 #
-# <table_name>.columns_defaults - a TOML dictionary mapping column names to a
-#     raw SQL expression that is used as the default value for the column on
-#     import. This is useful for private columns that are not nullable and do
-#     not have a default.
-
-[api_tokens.columns]
-id = "private"
-user_id = "private"
-token = "private"
-name = "private"
-created_at = "private"
-last_used_at = "private"
-revoked = "private"
-
-[background_jobs.columns]
-id = "private"
-job_type = "private"
-data = "private"
-retries = "private"
-last_retry = "private"
-created_at = "private"
-
-[badges]
+# tables.<table_name>.columns_defaults - a TOML dictionary mapping column names
+#     to a raw SQL expression that is used as the default value for the column
+#     on import. This is useful for private columns that are not nullable and
+#     do not have a default.
+#
+# private_table - an array of tables to consider as completely private. This is
+#     a shortcut for marking all columns of a table as private.
+
+private_tables = [
+    "__diesel_schema_migrations",
+    "api_tokens",
+    "background_jobs",
+    "crate_owner_invitations",
+    "emails",
+    "follows",
+    "publish_limit_buckets",
+    "publish_rate_overrides",
+    "readme_renderings",
+    "version_owner_actions",
+    "versions_published_by",
+    "version_downloads",
+    "version_downloads_default",
+    "version_downloads_archive",
+    "version_downloads_pre_2017",
+    "version_downloads_2017",
+    "version_downloads_2018_q1",
+    "version_downloads_2018_q2",
+    "version_downloads_2018_q3",
+    "version_downloads_2018_q4",
+    "version_downloads_2019_q1",
+    "version_downloads_2019_q2",
+    "version_downloads_2019_q3",
+    "version_downloads_2019_q4",
+    "version_downloads_2020_q1",
+    "version_downloads_2020_q2",
+    "version_downloads_2020_q3",
+    "version_downloads_2020_q4",
+    "version_downloads_2021_q1",
+]
+
+[tables.badges]
 dependencies = ["crates"]
-[badges.columns]
+[tables.badges.columns]
 crate_id = "public"
 badge_type = "public"
 attributes = "public"
 
-[categories.columns]
+[tables.categories.columns]
 id = "public"
 category = "public"
 slug = "public"
@@ -51,18 +70,10 @@ crates_cnt = "public"
 created_at = "public"
 path = "public"
 
-[crate_owner_invitations.columns]
-invited_user_id = "private"
-invited_by_user_id = "private"
-crate_id = "private"
-created_at = "private"
-token = "private"
-token_generated_at = "private"
-
-[crate_owners]
+[tables.crate_owners]
 dependencies = ["crates", "users"]
 filter = "NOT deleted"
-[crate_owners.columns]
+[tables.crate_owners.columns]
 crate_id = "public"
 owner_id = "public"
 created_at = "public"
@@ -72,7 +83,7 @@ updated_at = "private"
 owner_kind = "public"
 email_notifications = "private"
 
-[crates.columns]
+[tables.crates.columns]
 id = "public"
 name = "public"
 updated_at = "public"
@@ -86,21 +97,21 @@ textsearchable_index_col = "public"
 repository = "public"
 max_upload_size = "public"
 
-[crates_categories]
+[tables.crates_categories]
 dependencies = ["categories", "crates"]
-[crates_categories.columns]
+[tables.crates_categories.columns]
 crate_id = "public"
 category_id = "public"
 
-[crates_keywords]
+[tables.crates_keywords]
 dependencies = ["crates", "keywords"]
-[crates_keywords.columns]
+[tables.crates_keywords.columns]
 crate_id = "public"
 keyword_id = "public"
 
-[dependencies]
+[tables.dependencies]
 dependencies = ["crates", "versions"]
-[dependencies.columns]
+[tables.dependencies.columns]
 id = "public"
 version_id = "public"
 crate_id = "public"
@@ -111,99 +122,53 @@ features = "public"
 target = "public"
 kind = "public"
 
-[__diesel_schema_migrations.columns]
-version = "private"
-run_on = "private"
-
-[emails.columns]
-id = "private"
-user_id = "private"
-email = "private"
-verified = "private"
-token = "private"
-token_generated_at = "private"
-
-[follows.columns]
-user_id = "private"
-crate_id = "private"
-
-[keywords.columns]
+[tables.keywords.columns]
 id = "public"
 keyword = "public"
 crates_cnt = "public"
 created_at = "public"
 
-[metadata.columns]
+[tables.metadata.columns]
 total_downloads = "public"
 
-[publish_limit_buckets.columns]
-user_id = "private"
-tokens = "private"
-last_refill = "private"
-
-[publish_rate_overrides.columns]
-user_id = "private"
-burst = "private"
-
-[readme_renderings.columns]
-version_id = "private"
-rendered_at = "private"
-
-[reserved_crate_names.columns]
+[tables.reserved_crate_names.columns]
 name = "public"
 
-[teams.columns]
+[tables.teams.columns]
 id = "public"
 login = "public"
 github_id = "public"
 name = "public"
 avatar = "public"
 
-[users]
+[tables.users]
 filter = """
 id in (
     SELECT owner_id AS user_id FROM crate_owners WHERE NOT deleted AND owner_kind = 0
     UNION
     SELECT published_by as user_id FROM versions
 )"""
-[users.columns]
+[tables.users.columns]
 id = "public"
 gh_access_token = "private"
 gh_login = "public"
 name = "public"
 gh_avatar = "public"
 gh_id = "public"
-[users.column_defaults]
+[tables.users.column_defaults]
 gh_access_token = "''"
 
-[version_authors]
+[tables.version_authors]
 dependencies = ["versions"]
-[version_authors.columns]
+[tables.version_authors.columns]
 id = "public"
 version_id = "public"
 user_id = "private"
 name = "public"
 
-[version_downloads]
-dependencies = ["versions"]
-[version_downloads.columns]
-version_id = "public"
-downloads = "public"
-counted = "private"
-date = "public"
-processed = "private"
-
-[version_owner_actions.columns]
-id = "private"
-version_id = "private"
-user_id = "private"
-api_token_id = "private"
-action = "private"
-time = "private"
-
-[versions]
+[tables.versions]
 dependencies = ["crates", "users"]
-[versions.columns]
+[tables.versions.columns]
 id = "public"
 crate_id = "public"
 num = "public"
@@ -215,7 +180,3 @@ yanked = "public"
 license = "public"
 crate_size = "public"
 published_by = "public"
-
-[versions_published_by.columns]
-version_id = "private"
-email = "private"

src/tasks/dump_db/gen_scripts.rs

@@ -1,5 +1,5 @@
 use std::{
-    collections::{BTreeMap, VecDeque},
+    collections::{BTreeMap, HashSet, VecDeque},
     fs::File,
     path::Path,
 };
@@ -75,10 +75,15 @@ impl TableConfig {
     }
 }
 
-/// Maps table names to the respective configurations. Used to load `dump_db.toml`.
+/// Representation of the configuration file dump-db.toml.
+///
+/// tables – maps table names to the respective configurations.
+/// private_tables – names of tables to treat as completely private.
 #[derive(Clone, Debug, Default, Deserialize)]
-#[serde(transparent)]
-struct VisibilityConfig(BTreeMap<String, TableConfig>);
+struct VisibilityConfig {
+    tables: BTreeMap<String, TableConfig>,
+    private_tables: HashSet<String>,
+}
 
 /// Subset of the configuration data to be passed on to the Handlbars template.
 #[derive(Debug, Serialize)]
@@ -94,7 +99,7 @@ impl VisibilityConfig {
         let mut result = Vec::new();
         let mut num_deps = BTreeMap::new();
         let mut rev_deps: BTreeMap<_, Vec<_>> = BTreeMap::new();
-        for (table, config) in self.0.iter() {
+        for (table, config) in self.tables.iter() {
             num_deps.insert(table.as_str(), config.dependencies.len());
             for dep in &config.dependencies {
                 rev_deps
@@ -118,7 +123,7 @@ impl VisibilityConfig {
             }
         }
         assert_eq!(
-            self.0.len(),
+            self.tables.len(),
             result.len(),
             "circular dependencies in database dump configuration detected",
         );
@@ -129,7 +134,7 @@ impl VisibilityConfig {
         let tables = self
             .topological_sort()
             .into_iter()
-            .filter_map(|table| self.0[table].handlebars_context(table))
+            .filter_map(|table| self.tables[table].handlebars_context(table))
             .collect();
         HandlebarsContext { tables }
     }
@@ -161,18 +166,19 @@ mod tests {
     use crate::test_util::pg_connection;
     use diesel::prelude::*;
     use std::collections::HashSet;
-    use std::iter::FromIterator;
 
     /// Test whether the visibility configuration matches the schema of the
     /// test database.
     #[test]
-    #[should_panic]
     fn check_visibility_config() {
         let conn = pg_connection();
-        let db_columns = HashSet::<Column>::from_iter(get_db_columns(&conn));
-        let vis_columns = toml::from_str::<VisibilityConfig>(include_str!("dump-db.toml"))
-            .unwrap()
-            .0
+        let config: VisibilityConfig = toml::from_str(include_str!("dump-db.toml")).unwrap();
+        let db_columns: HashSet<Column> = get_db_columns(&conn)
+            .into_iter()
+            .filter(|column| !config.private_tables.contains(&column.table_name))
+            .collect();
+        let vis_columns = config
+            .tables
             .iter()
             .flat_map(|(table, config)| {
                 config.columns.iter().map(move |(column, _)| Column {
@@ -246,19 +252,19 @@ mod tests {
     #[test]
     fn test_topological_sort() {
         let mut config = VisibilityConfig::default();
-        let tables = &mut config.0;
+        let tables = &mut config.tables;
         tables.insert("a".to_owned(), table_config_with_deps(&["b", "c"]));
         tables.insert("b".to_owned(), table_config_with_deps(&["c", "d"]));
         tables.insert("c".to_owned(), table_config_with_deps(&["d"]));
-        config.0.insert("d".to_owned(), table_config_with_deps(&[]));
+        tables.insert("d".to_owned(), table_config_with_deps(&[]));
         assert_eq!(config.topological_sort(), ["d", "c", "b", "a"]);
     }
 
     #[test]
     #[should_panic]
     fn topological_sort_panics_for_cyclic_dependency() {
         let mut config = VisibilityConfig::default();
-        let tables = &mut config.0;
+        let tables = &mut config.tables;
         tables.insert("a".to_owned(), table_config_with_deps(&["b"]));
         tables.insert("b".to_owned(), table_config_with_deps(&["a"]));
         config.topological_sort();

src/tests/dump_db.rs

@@ -5,7 +5,6 @@ use diesel::{
 };
 
 #[test]
-#[should_panic]
 fn dump_db_and_reimport_dump() {
     let database_url = crate::env("TEST_DATABASE_URL");