papers 0.1.1

A library to allow creation and updates of Wikidata items for scientific publications, authors, and related info
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244

use std::{io, io::prelude::*, sync::Arc, time::Duration};

use futures::prelude::*;
use papers::{
    author_name_string::AuthorNameString, identifiers::GenericWorkIdentifier,
    sourcemd_bot::SourceMDbot, sourcemd_config::SourceMD, wikidata_papers::WikidataPapers, *,
};
use pico_args::Arguments;
use rand::seq::SliceRandom;
use tokio::sync::RwLock;
use wikibase::mediawiki::api::Api;

use crate::{sourcemd_command::SourceMDcommand, wikidata_string_cache::WikidataStringCache};

const INI_FILE: &str = "bot.ini";

async fn command_authors(ini_file: &str) {
    let smd = Arc::new(RwLock::new(SourceMD::new(ini_file).await.unwrap()));
    let mw_api = smd.read().await.mw_api();
    let cache = Arc::new(WikidataStringCache::new(mw_api.clone()));
    let stdin = io::stdin();
    for line in stdin.lock().lines() {
        let line = match line {
            Ok(l) => l.trim().to_string(),
            Err(_) => break,
        };
        if line.is_empty() {
            continue;
        }
        println!("Processing {}", line);
        author_from_id(&line, cache.clone(), smd.clone()).await;
    }
}

async fn author_from_id(id: &str, cache: Arc<WikidataStringCache>, smd: Arc<RwLock<SourceMD>>) {
    let mut command = SourceMDcommand::new_dummy(id);
    let bot = SourceMDbot::new(smd.clone(), cache.clone(), 0).await.unwrap();
    bot.process_author_metadata(&mut command).await.unwrap();
}

async fn command_ans(ini_file: &str) {
    const MAX_AUTHORS_IN_PARALLEL: usize = 5;
    let smd = Arc::new(RwLock::new(SourceMD::new(ini_file).await.unwrap()));
    let mw_api = smd.read().await.mw_api();
    let cache = Arc::new(WikidataStringCache::new(mw_api.clone()));
    let ans = AuthorNameString::new(2, std::sync::Arc::new(papers::http_client::HttpJsonFetcher::default()));

    let mut futures: Vec<_> = io::stdin()
        .lock()
        .lines()
        // trunk-ignore(clippy/lines_filter_map_ok)
        .map_while(Result::ok)
        .map(|line| line.trim().to_string())
        .filter(|line| !line.is_empty())
        .map(|line| ans.process_author_q(line, &mw_api, &cache))
        .collect();
    futures.shuffle(&mut rand::rng());

    let stream = futures::stream::iter(futures).buffer_unordered(MAX_AUTHORS_IN_PARALLEL);
    stream.collect::<Vec<_>>().await;
}

async fn command_papers(ini_file: &str) {
    let mw_api = Arc::new(RwLock::new(SourceMD::create_mw_api(ini_file).await.unwrap()));
    let stdin = io::stdin();
    for line in stdin.lock().lines() {
        let line = match line {
            Ok(l) => l.trim().to_string(),
            Err(_) => break,
        };
        if line.is_empty() {
            continue;
        }
        // println!("Processing {}", &line);
        paper_from_id(&line, mw_api.clone()).await;
    }
}

async fn paper_from_id(id: &str, mw_api: Arc<RwLock<Api>>) {
    let cache = Arc::new(WikidataStringCache::new(mw_api.clone()));
    let mut wdp = WikidataPapers::with_default_adapters(cache.clone());

    if papers::identifiers::is_qid(id) {
        save_item_changes(&mut wdp, mw_api.clone(), id).await;
        return;
    }

    let mut ids = GenericWorkIdentifier::parse_ids_from_str(id);

    // Paranoia
    ids.retain(|id| !id.id().is_empty());

    if ids.is_empty() {
        println!("Can't find a valid ID in '{}'", id);
        return;
    }
    // println!("IDs: {:?}", &ids);
    ids = wdp.update_from_paper_ids(&ids).await;

    match wdp.create_or_update_item_from_ids(mw_api, &ids).await {
        Ok(Some(er)) => {
            if er.edited() {
                println!("Created or updated https://www.wikidata.org/wiki/{}", er.q())
            } else {
                println!("Exists as https://www.wikidata.org/wiki/{}, no changes ", er.q())
            }
        },
        Ok(None) => println!("No item ID for '{}'!", id),
        Err(e) => eprintln!("Error processing '{}': {:#}", id, e),
    }
}

async fn save_item_changes(wdp: &mut WikidataPapers, mw_api: Arc<RwLock<Api>>, q: &str) {
    match wdp.create_or_update_item_from_q(mw_api, q).await {
        Ok(Some(er)) => {
            if er.edited() {
                println!("Created or updated https://www.wikidata.org/wiki/{}", er.q())
            } else {
                println!("https://www.wikidata.org/wiki/{}, no changes ", er.q())
            }
        },
        Ok(None) => println!("No item ID!"),
        Err(e) => eprintln!("Error saving {}: {:#}", q, e),
    }
}

fn usage(prog: &str) {
    println!("USAGE: {} [--config <file>] <subcommand>", prog);
    println!("Subcommands: papers, authors, bot, ans");
    println!("  --config <file>  Configuration file (default: {})", INI_FILE);
    println!("                   For the `bot` subcommand the file must also");
    println!("                   contain a [client] section with `user` and");
    println!("                   `password` for the SourceMD MySQL DB.");
}

/// Outcome of one tick of the bot driver.
enum BotTick {
    /// A batch was found and processed; loop should poll again soon.
    Worked,
    /// No batch was found; loop should sleep on the "idle" cadence.
    Idle,
    /// The DB query for the next batch failed. The error is carried out
    /// so the outer loop can rate-limit the logging — a sustained outage
    /// produces a tick every 5 s, and we don't want one error line per
    /// tick. See `papers::rate_limit_log::ConsecutiveErrorLog`.
    DbError(anyhow::Error),
}

async fn run_bot(config: Arc<RwLock<SourceMD>>, cache: Arc<WikidataStringCache>) -> BotTick {
    let batch_id = match config.read().await.get_next_batch().await {
        Ok(Some(n)) => n,
        Ok(None) => return BotTick::Idle,
        // P0-5: a DB failure used to be indistinguishable from "no work".
        // Now we propagate the error; the outer loop logs it (rate-limited)
        // and backs off.
        Err(e) => return BotTick::DbError(e),
    };

    tracing::info!(batch_id, "starting batch");
    let bot = match SourceMDbot::new(config.clone(), cache.clone(), batch_id).await {
        Ok(bot) => bot,
        Err(error) => {
            tracing::error!(batch_id, error = %error, "failed to start bot for batch");
            config.read().await.set_batch_failed(batch_id).await;
            return BotTick::Idle;
        },
    };

    tracing::info!(batch_id, "batch spawned");
    loop {
        match bot.run().await {
            Ok(true) => continue,
            Ok(false) => break, // No more commands for this batch.
            Err(e) => {
                tracing::error!(batch_id, error = %e, "bot run failed; ending batch tick");
                break;
            },
        }
    }
    BotTick::Worked
}

async fn command_bot(ini_file: &str) {
    tracing::info!("starting bot mode");
    let mut smd = SourceMD::new(ini_file).await.unwrap();
    if let Err(e) = smd.init(ini_file).await {
        tracing::error!(error = %e, "SourceMD::init failed; aborting bot");
        std::process::exit(1);
    }
    let smd = Arc::new(RwLock::new(smd));
    let mw_api = Arc::new(RwLock::new(SourceMD::create_mw_api(ini_file).await.unwrap()));
    let cache = Arc::new(WikidataStringCache::new(mw_api));
    // Cross-tick state for rate-limiting DB-outage error logs: log on the
    // 1st, 2nd, 4th, 8th, … consecutive failure, plus an info! on recovery.
    let mut db_log =
        papers::rate_limit_log::ConsecutiveErrorLog::new("get_next_batch failed; backing off");
    loop {
        let delay = match run_bot(smd.clone(), cache.clone()).await {
            BotTick::Worked => {
                db_log.note_success();
                Duration::from_millis(1000)
            },
            BotTick::Idle => {
                db_log.note_success();
                Duration::from_millis(5000)
            },
            BotTick::DbError(e) => {
                db_log.note_error(&e);
                Duration::from_millis(5000)
            },
        };
        tokio::time::sleep(delay).await;
    }
}

// For local testing:
// ssh magnus@tools-login.wmflabs.org -L 3307:tools-db:3306 -N &

fn init_tracing() {
    use tracing_subscriber::EnvFilter;
    // Honour RUST_LOG if set; otherwise default to INFO for our crate.
    let filter = EnvFilter::try_from_default_env().unwrap_or_else(|_| EnvFilter::new("info"));
    let _ = tracing_subscriber::fmt().with_env_filter(filter).try_init();
}

#[tokio::main]
async fn main() {
    init_tracing();
    let prog = std::env::args().next().unwrap_or_else(|| "papers".to_string());
    let mut pargs = Arguments::from_env();

    let config: String = pargs
        .opt_value_from_str("--config")
        .unwrap_or(None)
        .unwrap_or_else(|| INI_FILE.to_string());

    match pargs.subcommand().unwrap_or_default().as_deref() {
        Some("papers") => command_papers(&config).await,
        Some("authors") => command_authors(&config).await,
        Some("bot") => command_bot(&config).await,
        Some("ans") => command_ans(&config).await,
        _ => usage(&prog),
    }
}