Add option to disable weekly updates from Crowdin

T`{"weekly_update_from_crowdin": false}` in `factorio-mods-localization.json`

Author: dima74

README.md

@@ -14,7 +14,7 @@ We provide service for simplifying [Factorio](https://www.factorio.com/) mods tr
 * Every week our [FactorioBot](https://github.com/factorio-mods-helper) will fetch translation updates from Crowdin and commit them to your repository
 
 ## Motivation
-There are a lot of Factorio mods hosted on GitHub. Most of them are translated using pull requests. I think it is not very convenient (because it is unclear which strings are untranslated yet and translators have to know how to use git). So, I created a helper tool for configuring the translation process on Crowdin, a powerful localization platform.
+There are a lot of Factorio mods hosted on GitHub. Most of them are translated using pull requests. It is not very convenient (because it is unclear which strings are untranslated yet and translators have to know how to use git). So, I created a helper tool for configuring the translation process on Crowdin, a powerful localization platform.
 
 ## Installation
 1. Go to our [GitHub app page][1]
@@ -40,19 +40,29 @@ Then Crowdin translation interface will be opened where you can translate string
 ## Notes
 
 * To correctly upload your existing translations to Crowdin, files in any localization folder (such as `/locale/de`) **must have the same names as files in `/locale/en` folder**.
-* If a repository has branch protection rules, then our helper will create a pull request (instead of pushing to the main branch directly).
+* If a repository has branch protection rules, our helper will create a pull request (instead of pushing to the main branch directly).
 * Please ask any questions or report bugs by creating a new [issue](https://github.com/dima74/factorio-mods-localization/issues).
 
 ## Multimods
-It is possible to have multiple Factorio mods in a single GitHub repository. In this case please add file `factorio-mods-localization.json` with the list of mods to the root of the repository. See [`Omnimods/Omnimods` repository](https://github.com/Omnimods/Omnimods/commit/1e689afcf202776ffa0f675f73353f1fd67d2039) as an example.
+It is possible to have multiple Factorio mods in a single GitHub repository. In this case please add file `factorio-mods-localization.json` with the list of mods to the root of the repository:
 ```
-├── factorio-mods-localization.json  // ["Mod1", "Mod2"]
+├── factorio-mods-localization.json  // {"mods": ["Mod1", "Mod2"]}
 ├── Mod1
 │   ├── locale/en
 ├── Mod2
 │   ├── locale/en
 ```
 
+## Disable weekly updates from Crowdin
+It is possible to disable automatic weekly updates from Crowdin and perform updates manually when you need it. To do so, create file `factorio-mods-localization.json` in the root of your repository with content:
+```json
+{"weekly_update_from_crowdin": false}
+```
+Now you can perform an update manually using the following URL:
+```
+https://factorio-mods-localization.fly.dev/api/triggerUpdate?repo=OWNER/REPO
+```
+
 ## Detailed description of how it works
 0. Mod author has a mod repository on GitHub
 1. Mod author installs GitHub app (for mod repository)

examples/on_repository_added.rs

@@ -5,6 +5,6 @@ use fml::github_mod_name::GithubModName;
 async fn main() {
     fml::init_with_crowdin().await;
     let installation_id = github::get_installation_id_for_user("dima74").await;
-    let mod_ = GithubModName::new("dima74/factorio-mod-example", None);
+    let mod_ = GithubModName::new("dima74/factorio-mod-example", None, None);
     webhooks::on_repository_added("dima74/factorio-mod-example", vec![mod_], installation_id).await;
 }

src/github.rs

@@ -79,7 +79,7 @@ pub async fn extract_mods_from_repository(installation_api: &Octocrab, full_name
         let locale_en_items = list_files_in_directory(installation_api, full_name, "locale/en").await;
         match locale_en_items {
             Ok(locale_en_items) if !locale_en_items.is_empty() => {
-                vec![GithubModName::new(full_name, None)]
+                vec![GithubModName::new(full_name, None, None)]
             }
             _ => vec![],
         }
@@ -309,13 +309,13 @@ mod tests {
         let api = as_installation_for_user("dima74").await;
         assert_eq!(
             extract_mods_from_repository(&api, "dima74/factorio-mod-example").await,
-            vec![GithubModName::new("dima74/factorio-mod-example", None)],
+            vec![GithubModName::new("dima74/factorio-mod-example", None, None)],
         );
         assert_eq!(
             extract_mods_from_repository(&api, "dima74/factorio-multimod-example").await,
             vec![
-                GithubModName::new("dima74/factorio-multimod-example", Some("Mod1".to_owned())),
-                GithubModName::new("dima74/factorio-multimod-example", Some("Mod2".to_owned())),
+                GithubModName::new("dima74/factorio-multimod-example", Some("Mod1".to_owned()), None),
+                GithubModName::new("dima74/factorio-multimod-example", Some("Mod2".to_owned()), None),
             ],
         );
         assert_eq!(

src/github_mod_name.rs

@@ -1,12 +1,14 @@
 use std::fmt;
 
+use serde::Deserialize;
+
 /// # Single mod in github repository
 /// .
 /// ├── locale/en
 ///
 /// # Multiple mods in github repository
 /// .
-/// ├── factorio-mods-localization.json  // ["Mod1", "Mod2"]
+/// ├── factorio-mods-localization.json  // {"mods": ["Mod1", "Mod2"]}
 /// ├── Mod1
 /// │   ├── locale/en
 /// ├── Mod2
@@ -17,6 +19,9 @@ pub struct GithubModName {
     pub owner: String,
     pub repo: String,
     pub subpath: Option<String>,
+    // This is not good design of data structure. Instead this should be something like this:
+    // struct GithubRepoInfo { mods: Vec<...>, weekly_update_from_crowdin: bool }
+    pub weekly_update_from_crowdin: bool,
 }
 
 impl fmt::Display for GithubModName {
@@ -29,24 +34,141 @@ impl fmt::Display for GithubModName {
 }
 
 impl GithubModName {
-    pub fn new(full_name: &str, subpath: Option<String>) -> Self {
+    pub fn new(full_name: &str, subpath: Option<String>, weekly_update_from_crowdin: Option<bool>) -> Self {
         let (owner, repo) = full_name.split_once('/').unwrap();
         Self {
             owner: owner.to_owned(),
             repo: repo.to_owned(),
             subpath,
+            weekly_update_from_crowdin: weekly_update_from_crowdin.unwrap_or(true),
         }
     }
 }
 
+/// # Format of factorio-mods-localization.json
+/// Old format:
+/// ```json
+/// ["mod1", "mod2"]
+/// ```
+///
+/// New format:
+/// ```json
+/// {
+///   "mods": ["mod1", "mod2"],
+///   "weekly_update_from_crowdin": false
+/// }
+/// ```
 pub fn parse_github_mod_names_json(full_name: &str, json: &str) -> Vec<GithubModName> {
-    let names: Vec<String> = serde_json::from_str(&json).unwrap();
-    names
-        .into_iter()
-        .map(|name| {
-            // only direct subdirectories are supported
-            assert!(name != "" && !name.starts_with(".") && !name.contains('/'));
-            GithubModName::new(full_name, Some(name))
-        })
-        .collect()
+    #[derive(Deserialize)]
+    struct Data {
+        mods: Option<Vec<String>>,
+        weekly_update_from_crowdin: Option<bool>,
+    }
+    let (mods, weekly_update_from_crowdin) = match serde_json::from_str::<Data>(&json) {
+        Ok(data) => {
+            (data.mods, data.weekly_update_from_crowdin)
+        }
+        Err(_) => {
+            let mods: Vec<String> = serde_json::from_str(&json).unwrap();
+            (Some(mods), None)
+        }
+    };
+    match mods {
+        None => {
+            // { "weekly_update_from_crowdin": false }
+            vec![GithubModName::new(full_name, None, weekly_update_from_crowdin)]
+        }
+        Some(mods) => {
+            mods
+                .into_iter()
+                .map(|name| {
+                    // only direct subdirectories are supported
+                    assert!(name != "" && !name.starts_with(".") && !name.contains('/'));
+                    GithubModName::new(full_name, Some(name), weekly_update_from_crowdin)
+                })
+                .collect()
+        }
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_parse_github_mod_names_json() {
+        assert_eq!(
+            parse_github_mod_names_json("owner/repo", r#"["mod1", "mod2"]"#),
+            vec![
+                GithubModName {
+                    owner: "owner".to_owned(),
+                    repo: "repo".to_owned(),
+                    subpath: Some("mod1".to_owned()),
+                    weekly_update_from_crowdin: true
+                },
+                GithubModName {
+                    owner: "owner".to_owned(),
+                    repo: "repo".to_owned(),
+                    subpath: Some("mod2".to_owned()),
+                    weekly_update_from_crowdin: true
+                },
+            ]
+        );
+        assert_eq!(
+            parse_github_mod_names_json("owner/repo", r#"{"mods": ["mod1", "mod2"]}"#),
+            vec![
+                GithubModName {
+                    owner: "owner".to_owned(),
+                    repo: "repo".to_owned(),
+                    subpath: Some("mod1".to_owned()),
+                    weekly_update_from_crowdin: true
+                },
+                GithubModName {
+                    owner: "owner".to_owned(),
+                    repo: "repo".to_owned(),
+                    subpath: Some("mod2".to_owned()),
+                    weekly_update_from_crowdin: true
+                },
+            ]
+        );
+        assert_eq!(
+            parse_github_mod_names_json("owner/repo", r#"{"mods": ["mod1", "mod2"], "weekly_update_from_crowdin": false}"#),
+            vec![
+                GithubModName {
+                    owner: "owner".to_owned(),
+                    repo: "repo".to_owned(),
+                    subpath: Some("mod1".to_owned()),
+                    weekly_update_from_crowdin: false
+                },
+                GithubModName {
+                    owner: "owner".to_owned(),
+                    repo: "repo".to_owned(),
+                    subpath: Some("mod2".to_owned()),
+                    weekly_update_from_crowdin: false
+                },
+            ]
+        );
+        assert_eq!(
+            parse_github_mod_names_json("owner/repo", r#"{"weekly_update_from_crowdin": false}"#),
+            vec![
+                GithubModName {
+                    owner: "owner".to_owned(),
+                    repo: "repo".to_owned(),
+                    subpath: None,
+                    weekly_update_from_crowdin: false
+                },
+            ]
+        );
+        assert_eq!(
+            parse_github_mod_names_json("owner/repo", r#"{"weekly_update_from_crowdin": true}"#),
+            vec![
+                GithubModName {
+                    owner: "owner".to_owned(),
+                    repo: "repo".to_owned(),
+                    subpath: None,
+                    weekly_update_from_crowdin: true
+                },
+            ]
+        );
+    }
 }

src/mod_directory.rs

@@ -37,7 +37,7 @@ pub fn get_mods_impl(full_name: &str, root: &Path) -> Vec<GithubModName> {
         parse_github_mod_names_json(full_name, &json)
     } else {
         // Usual case - single mod at root of the github repository
-        vec![GithubModName::new(full_name, None)]
+        vec![GithubModName::new(full_name, None, None)]
     }
 }
 

src/server/trigger_update.rs

@@ -80,7 +80,7 @@ pub async fn get_installation_id_and_mods(
     };
 
     let mods = if subpath.is_some() {
-        vec![GithubModName::new(&repo, subpath)]
+        vec![GithubModName::new(&repo, subpath, None)]
     } else {
         let api = github::as_installation(installation_id);
         extract_mods_from_repository(&api, &repo).await
@@ -96,10 +96,26 @@ async fn trigger_update_all_repositories() {
     info!("\n[update-github-from-crowdin] [*] starting...");
     let mut api = github::as_app();
     let repositories = github::get_all_repositories(&mut api).await;
+    let repositories = filter_repositories_for_update_all(repositories);
     push_crowdin_changes_to_repositories(repositories).await;
     info!("[update-github-from-crowdin] [*] success");
 }
 
+fn filter_repositories_for_update_all(
+    repositories: Vec<(String, Vec<GithubModName>, InstallationId)>
+) -> Vec<(String, Vec<GithubModName>, InstallationId)> {
+    repositories
+        .into_iter()
+        .filter(|(full_name, mods, _)| {
+            let weekly_update_from_crowdin = mods.iter().all(|it| it.weekly_update_from_crowdin);
+            if !weekly_update_from_crowdin {
+                info!("[update-github-from-crowdin] [{}] skipping update because weekly_update_from_crowdin=false", full_name);
+            }
+            weekly_update_from_crowdin
+        })
+        .collect()
+}
+
 async fn push_crowdin_changes_to_repositories(repositories: Vec<(String, Vec<GithubModName>, InstallationId)>) {
     let repositories = crowdin::filter_repositories(repositories).await;
     if repositories.is_empty() { return; }