githubdw 0.2.0

Local SQLite data warehouse for GitHub repositories: sync PRs, reviews, and issues; query, metrics, fulltext search, and MCP server
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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
//! Fluent QueryBuilder: chainable filters compiled into parameterized SQL.

use chrono::NaiveDate;
use rusqlite::Connection;
use rusqlite::types::Value as SqlValue;
use serde::Serialize;

use crate::error::{Error, Result};
use crate::period::Period;

/// Pull-request state filter.
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum PrState {
    Open,
    Merged,
    Closed,
}

impl PrState {
    fn as_sql(&self) -> &'static str {
        match self {
            PrState::Open => "OPEN",
            PrState::Merged => "MERGED",
            PrState::Closed => "CLOSED",
        }
    }
}

/// One pull-request result row.
#[derive(Debug, Clone, Serialize)]
pub struct PullRequestSummary {
    pub pr_key: String,
    pub number: i64,
    pub repo_key: String,
    pub author: String,
    pub state: String,
    pub title: Option<String>,
    pub created_at: String,
    pub merged_at: Option<String>,
    pub comment_count: i64,
    pub review_count: i64,
    pub additions: i64,
    pub deletions: i64,
}

/// Normalize a login to an entity key; leave prefixed keys untouched.
pub fn normalize_login(login: &str) -> String {
    let login = login.to_lowercase();
    if login.contains(':') {
        login
    } else {
        format!("user:{login}")
    }
}

/// Chainable query over the warehouse.
pub struct QueryBuilder<'a> {
    connection: &'a Connection,
    authors: Vec<String>,
    reviewers: Vec<String>,
    repos: Vec<String>,
    orgs: Vec<String>,
    states: Vec<String>,
    labels: Vec<String>,
    since: Option<NaiveDate>,
    until: Option<NaiveDate>,
    period: Option<String>,
    limit: Option<u32>,
    offset: Option<u32>,
}

impl<'a> QueryBuilder<'a> {
    pub fn new(connection: &'a Connection) -> Self {
        Self {
            connection,
            authors: Vec::new(),
            reviewers: Vec::new(),
            repos: Vec::new(),
            orgs: Vec::new(),
            states: Vec::new(),
            labels: Vec::new(),
            since: None,
            until: None,
            period: None,
            limit: None,
            offset: None,
        }
    }

    pub fn author(mut self, login: &str) -> Self {
        self.authors.push(normalize_login(login));
        self
    }

    pub fn authors(mut self, logins: &[String]) -> Self {
        self.authors
            .extend(logins.iter().map(|login| normalize_login(login)));
        self
    }

    pub fn reviewer(mut self, login: &str) -> Self {
        self.reviewers.push(normalize_login(login));
        self
    }

    pub fn repo(mut self, name: &str) -> Self {
        self.repos.push(name.to_lowercase());
        self
    }

    pub fn repos(mut self, names: &[String]) -> Self {
        self.repos.extend(names.iter().map(|n| n.to_lowercase()));
        self
    }

    pub fn org(mut self, owner: &str) -> Self {
        self.orgs.push(owner.to_lowercase());
        self
    }

    pub fn state(mut self, state: PrState) -> Self {
        self.states.push(state.as_sql().to_string());
        self
    }

    pub fn merged(self) -> Self {
        self.state(PrState::Merged)
    }

    pub fn open(self) -> Self {
        self.state(PrState::Open)
    }

    pub fn closed(self) -> Self {
        self.state(PrState::Closed)
    }

    pub fn label(mut self, name: &str) -> Self {
        self.labels.push(name.to_string());
        self
    }

    pub fn since(mut self, date: NaiveDate) -> Self {
        self.since = Some(date);
        self
    }

    pub fn until(mut self, date: NaiveDate) -> Self {
        self.until = Some(date);
        self
    }

    pub fn between(self, start: NaiveDate, end: NaiveDate) -> Self {
        self.since(start).until(end)
    }

    pub fn period(mut self, period: Period) -> Self {
        self.period = Some(period.to_key());
        self
    }

    pub fn period_str(mut self, key: &str) -> Self {
        self.period = Some(key.to_string());
        self
    }

    pub fn limit(mut self, n: u32) -> Self {
        self.limit = Some(n);
        self
    }

    pub fn offset(mut self, n: u32) -> Self {
        self.offset = Some(n);
        self
    }

    /// Assemble joins/conditions/parameters shared by all terminals.
    fn assemble(&self) -> (String, Vec<String>, Vec<SqlValue>) {
        let mut joins: Vec<String> = Vec::new();
        let mut conditions: Vec<String> = Vec::new();
        let mut parameters: Vec<SqlValue> = Vec::new();

        let add_in_clause = |column: &str,
                             values: &[String],
                             conditions: &mut Vec<String>,
                             parameters: &mut Vec<SqlValue>| {
            if values.is_empty() {
                return;
            }
            let placeholders = vec!["?"; values.len()].join(", ");
            conditions.push(format!("{column} IN ({placeholders})"));
            parameters.extend(values.iter().map(|v| SqlValue::Text(v.clone())));
        };

        add_in_clause(
            "p.author_key",
            &self.authors,
            &mut conditions,
            &mut parameters,
        );
        add_in_clause("p.repo_key", &self.repos, &mut conditions, &mut parameters);
        add_in_clause("p.state", &self.states, &mut conditions, &mut parameters);

        if !self.orgs.is_empty() {
            joins.push("JOIN dim_repositories dr ON dr.repo_key = p.repo_key".into());
            add_in_clause("dr.owner", &self.orgs, &mut conditions, &mut parameters);
        }
        if !self.reviewers.is_empty() {
            joins.push("JOIN fact_reviews qr ON qr.pr_key = p.pr_key".into());
            add_in_clause(
                "qr.reviewer_key",
                &self.reviewers,
                &mut conditions,
                &mut parameters,
            );
        }
        if !self.labels.is_empty() {
            joins.push(
                "JOIN pr_labels pl ON pl.pr_key = p.pr_key \
                 JOIN labels lbl ON lbl.id = pl.label_id"
                    .into(),
            );
            add_in_clause("lbl.name", &self.labels, &mut conditions, &mut parameters);
        }
        if let Some(period_key) = self.period.as_deref() {
            let column = Period::column_for_key(period_key);
            joins.push("JOIN dim_date dd ON dd.date_key = p.created_date_key".into());
            conditions.push(format!("dd.{column} = ?"));
            parameters.push(SqlValue::Text(period_key.to_string()));
        }
        if let Some(since) = self.since {
            conditions.push("p.created_date_key >= ?".into());
            parameters.push(SqlValue::Text(since.format("%Y-%m-%d").to_string()));
        }
        if let Some(until) = self.until {
            conditions.push("p.created_date_key <= ?".into());
            parameters.push(SqlValue::Text(until.format("%Y-%m-%d").to_string()));
        }

        let join_clause = joins.join(" ");
        (join_clause, conditions, parameters)
    }

    fn where_clause(conditions: &[String]) -> String {
        if conditions.is_empty() {
            String::new()
        } else {
            format!("WHERE {}", conditions.join(" AND "))
        }
    }

    fn pagination_clause(&self) -> String {
        let mut clause = String::new();
        if let Some(limit) = self.limit {
            clause.push_str(&format!(" LIMIT {limit}"));
            if let Some(offset) = self.offset {
                clause.push_str(&format!(" OFFSET {offset}"));
            }
        } else if let Some(offset) = self.offset {
            clause.push_str(&format!(" LIMIT -1 OFFSET {offset}"));
        }
        clause
    }

    /// The generated SQL for debugging.
    pub fn to_sql(&self) -> String {
        let (joins, conditions, parameters) = self.assemble();
        format!(
            "SELECT ... FROM fact_pull_requests p {joins} {} -- params: {parameters:?}",
            Self::where_clause(&conditions)
        )
    }

    /// Matching PRs ordered by created_at DESC. Honors limit/offset.
    pub fn pull_requests(self) -> Result<Vec<PullRequestSummary>> {
        let (joins, conditions, parameters) = self.assemble();
        let sql = format!(
            "SELECT DISTINCT p.pr_key, p.number, p.repo_key, p.author_key, p.state, p.title,
                    p.created_at, p.merged_at, p.comment_count, p.review_count,
                    p.additions, p.deletions
             FROM fact_pull_requests p {joins} {}
             ORDER BY p.created_at DESC{}",
            Self::where_clause(&conditions),
            self.pagination_clause(),
        );
        let mut statement = self.connection.prepare(&sql)?;
        let rows = statement.query_map(rusqlite::params_from_iter(parameters), |row| {
            Ok(PullRequestSummary {
                pr_key: row.get(0)?,
                number: row.get(1)?,
                repo_key: row.get(2)?,
                author: row.get(3)?,
                state: row.get(4)?,
                title: row.get(5)?,
                created_at: row.get(6)?,
                merged_at: row.get(7)?,
                comment_count: row.get(8)?,
                review_count: row.get(9)?,
                additions: row.get(10)?,
                deletions: row.get(11)?,
            })
        })?;
        let mut results = Vec::new();
        for row in rows {
            results.push(row?);
        }
        Ok(results)
    }

    /// `COUNT(DISTINCT pr_key)` — ignores limit/offset.
    pub fn count(self) -> Result<u64> {
        let (joins, conditions, parameters) = self.assemble();
        let sql = format!(
            "SELECT COUNT(DISTINCT p.pr_key) FROM fact_pull_requests p {joins} {}",
            Self::where_clause(&conditions)
        );
        let count: i64 =
            self.connection
                .query_row(&sql, rusqlite::params_from_iter(parameters), |row| {
                    row.get(0)
                })?;
        Ok(count as u64)
    }

    /// `(SUM(additions), SUM(deletions))`.
    pub fn lines_changed(self) -> Result<(u64, u64)> {
        let (joins, conditions, parameters) = self.assemble();
        let sql = format!(
            "SELECT COALESCE(SUM(additions), 0), COALESCE(SUM(deletions), 0) FROM (
                SELECT DISTINCT p.pr_key, p.additions, p.deletions
                FROM fact_pull_requests p {joins} {}
             )",
            Self::where_clause(&conditions)
        );
        let (added, removed): (i64, i64) =
            self.connection
                .query_row(&sql, rusqlite::params_from_iter(parameters), |row| {
                    Ok((row.get(0)?, row.get(1)?))
                })?;
        Ok((added as u64, removed as u64))
    }

    fn count_grouped(self, group_expression: &str) -> Result<Vec<(String, u64)>> {
        let (joins, conditions, parameters) = self.assemble();
        let needs_date_join = group_expression.starts_with("dd.") && !joins.contains("dim_date");
        let date_join = if needs_date_join {
            " JOIN dim_date dd ON dd.date_key = p.created_date_key"
        } else {
            ""
        };
        let sql = format!(
            "SELECT {group_expression} AS grp, COUNT(DISTINCT p.pr_key) AS cnt
             FROM fact_pull_requests p {joins}{date_join} {}
             GROUP BY grp ORDER BY cnt DESC, grp",
            Self::where_clause(&conditions)
        );
        let mut statement = self.connection.prepare(&sql)?;
        let rows = statement.query_map(rusqlite::params_from_iter(parameters), |row| {
            Ok((row.get::<_, String>(0)?, row.get::<_, i64>(1)? as u64))
        })?;
        let mut results = Vec::new();
        for row in rows {
            results.push(row?);
        }
        Ok(results)
    }

    pub fn count_by_author(self) -> Result<Vec<(String, u64)>> {
        self.count_grouped("p.author_key")
    }

    pub fn count_by_repo(self) -> Result<Vec<(String, u64)>> {
        self.count_grouped("p.repo_key")
    }

    pub fn count_by_state(self) -> Result<Vec<(String, u64)>> {
        self.count_grouped("p.state")
    }

    pub fn count_by_period(self) -> Result<Vec<(String, u64)>> {
        self.count_grouped("dd.month_key")
    }

    /// CSV of the row output (fixed header).
    pub fn to_csv(self) -> Result<String> {
        let rows = self.pull_requests()?;
        let mut output = String::from(
            "pr_key,number,repo,author,state,title,created_at,merged_at,comments,reviews,additions,deletions\n",
        );
        for row in rows {
            output.push_str(&format!(
                "{},{},{},{},{},{},{},{},{},{},{},{}\n",
                row.pr_key,
                row.number,
                row.repo_key,
                row.author,
                row.state,
                csv_escape(row.title.as_deref().unwrap_or("")),
                row.created_at,
                row.merged_at.as_deref().unwrap_or(""),
                row.comment_count,
                row.review_count,
                row.additions,
                row.deletions,
            ));
        }
        Ok(output)
    }

    /// Pretty JSON of the row output.
    pub fn to_json(self) -> Result<String> {
        let rows = self.pull_requests()?;
        Ok(serde_json::to_string_pretty(&rows)?)
    }
}

fn csv_escape(field: &str) -> String {
    if field.contains(',') || field.contains('"') || field.contains('\n') {
        format!("\"{}\"", field.replace('"', "\"\""))
    } else {
        field.to_string()
    }
}

/// Run an arbitrary read-only SELECT; returns rows as JSON objects.
pub fn raw_query(
    connection: &Connection,
    sql: &str,
) -> Result<Vec<serde_json::Map<String, serde_json::Value>>> {
    validate_select_only(sql)?;
    let mut statement = connection.prepare(sql)?;
    let column_names: Vec<String> = statement
        .column_names()
        .iter()
        .map(|name| name.to_string())
        .collect();
    let mut rows_out = Vec::new();
    let mut rows = statement.query([])?;
    while let Some(row) = rows.next()? {
        let mut object = serde_json::Map::new();
        for (index, name) in column_names.iter().enumerate() {
            let value = match row.get_ref(index)? {
                rusqlite::types::ValueRef::Null => serde_json::Value::Null,
                rusqlite::types::ValueRef::Integer(i) => serde_json::Value::from(i),
                rusqlite::types::ValueRef::Real(f) => serde_json::Value::from(f),
                rusqlite::types::ValueRef::Text(t) => {
                    serde_json::Value::from(String::from_utf8_lossy(t).into_owned())
                }
                rusqlite::types::ValueRef::Blob(_) => serde_json::Value::from("<blob>"),
            };
            object.insert(name.clone(), value);
        }
        rows_out.push(object);
    }
    Ok(rows_out)
}

/// Reject anything that is not a single SELECT statement.
pub fn validate_select_only(sql: &str) -> Result<()> {
    let trimmed = sql.trim_start();
    let first_token = trimmed
        .split_whitespace()
        .next()
        .unwrap_or_default()
        .to_uppercase();
    if first_token != "SELECT" && first_token != "WITH" {
        return Err(Error::InvalidArgument(
            "only SELECT queries are allowed".into(),
        ));
    }
    // Reject multiple statements.
    if trimmed.trim_end().trim_end_matches(';').contains(';') {
        return Err(Error::InvalidArgument(
            "multiple statements are not allowed".into(),
        ));
    }
    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::GithubDW;

    fn seed(warehouse: &GithubDW) {
        warehouse
            .connection()
            .execute_batch(
                "INSERT INTO dim_entities (entity_key, entity_type, login, is_human, is_bot, name)
                 VALUES ('user:alice', 'user', 'alice', 1, 0, 'Alice'),
                        ('user:bob', 'user', 'bob', 1, 0, 'Bob');
                 INSERT INTO dim_repositories (repo_key, owner, name)
                 VALUES ('octo/alpha', 'octo', 'alpha'), ('octo/beta', 'octo', 'beta');
                 INSERT INTO dim_date (date_key, year, quarter, month, day_of_month, day_of_week,
                     is_weekend, week_of_year, week_key, month_key, quarter_key, year_key, half_key)
                 VALUES ('2026-01-10', 2026, 1, 1, 10, 6, 1, 2, '2026-W02', '2026-01', '2026-Q1', '2026', '2026-H1'),
                        ('2026-04-10', 2026, 2, 4, 10, 5, 0, 15, '2026-W15', '2026-04', '2026-Q2', '2026', '2026-H1');
                 INSERT INTO dim_time (time_key, hour, hour_12, am_pm, time_bucket, is_core_hours)
                 VALUES ('10:00', 10, 10, 'AM', 'Morning', 1);
                 INSERT INTO fact_pull_requests (pr_key, number, repo_key, author_key, state, title,
                     created_at, created_date_key, created_time_key, additions, deletions)
                 VALUES
                   ('octo/alpha#1', 1, 'octo/alpha', 'user:alice', 'MERGED', 'First change',
                    '2026-01-10T18:00:00Z', '2026-01-10', '10:00', 100, 10),
                   ('octo/alpha#2', 2, 'octo/alpha', 'user:bob', 'OPEN', 'Second change',
                    '2026-04-10T18:00:00Z', '2026-04-10', '10:00', 50, 5),
                   ('octo/beta#1', 1, 'octo/beta', 'user:alice', 'MERGED', 'Beta feature',
                    '2026-04-10T19:00:00Z', '2026-04-10', '10:00', 20, 2);
                 INSERT INTO fact_reviews (review_key, pr_key, reviewer_key, state, submitted_at,
                     submitted_date_key, submitted_time_key)
                 VALUES ('R1', 'octo/alpha#1', 'user:bob', 'APPROVED', '2026-01-10T19:00:00Z',
                     '2026-01-10', '10:00');",
            )
            .unwrap();
    }

    #[test]
    fn filters_compose_and_execute() {
        let warehouse = GithubDW::open_in_memory().unwrap();
        seed(&warehouse);
        let conn = warehouse.connection();

        let merged_by_alice = QueryBuilder::new(conn)
            .author("Alice")
            .merged()
            .pull_requests()
            .unwrap();
        assert_eq!(merged_by_alice.len(), 2);

        let q1_count = QueryBuilder::new(conn)
            .period_str("2026-Q1")
            .count()
            .unwrap();
        assert_eq!(q1_count, 1);

        let reviewed_by_bob = QueryBuilder::new(conn).reviewer("bob").count().unwrap();
        assert_eq!(reviewed_by_bob, 1);

        let org_count = QueryBuilder::new(conn).org("octo").count().unwrap();
        assert_eq!(org_count, 3);

        let (added, removed) = QueryBuilder::new(conn)
            .author("alice")
            .lines_changed()
            .unwrap();
        assert_eq!((added, removed), (120, 12));
    }

    #[test]
    fn grouped_counts_and_outputs() {
        let warehouse = GithubDW::open_in_memory().unwrap();
        seed(&warehouse);
        let conn = warehouse.connection();

        let by_state = QueryBuilder::new(conn).count_by_state().unwrap();
        assert_eq!(by_state[0], ("MERGED".to_string(), 2));

        let by_author = QueryBuilder::new(conn).count_by_author().unwrap();
        assert_eq!(by_author[0], ("user:alice".to_string(), 2));

        let by_period = QueryBuilder::new(conn).count_by_period().unwrap();
        assert_eq!(by_period.len(), 2);

        let json = QueryBuilder::new(conn).merged().to_json().unwrap();
        let parsed: serde_json::Value = serde_json::from_str(&json).unwrap();
        assert_eq!(parsed.as_array().unwrap().len(), 2);

        let csv = QueryBuilder::new(conn).to_csv().unwrap();
        assert!(csv.starts_with("pr_key,"));
        assert_eq!(csv.lines().count(), 4);
    }

    #[test]
    fn pagination_and_ordering() {
        let warehouse = GithubDW::open_in_memory().unwrap();
        seed(&warehouse);
        let conn = warehouse.connection();
        let page = QueryBuilder::new(conn)
            .limit(1)
            .offset(1)
            .pull_requests()
            .unwrap();
        assert_eq!(page.len(), 1);
        // Ordered created_at DESC; offset 1 skips the newest (beta 19:00Z).
        assert_eq!(page[0].pr_key, "octo/alpha#2");
    }

    #[test]
    fn raw_query_is_select_only() {
        let warehouse = GithubDW::open_in_memory().unwrap();
        seed(&warehouse);
        let conn = warehouse.connection();
        let rows = raw_query(conn, "SELECT COUNT(*) AS n FROM fact_pull_requests").unwrap();
        assert_eq!(rows[0]["n"], serde_json::Value::from(3));
        assert!(raw_query(conn, "DELETE FROM fact_pull_requests").is_err());
        assert!(raw_query(conn, "SELECT 1; DROP TABLE issues").is_err());
    }
}