github-reporadar 0.1.10 → 0.2.0

package/README.md

@@ -101,10 +101,20 @@ npx github-reporadar brief --org example-company --days 7 --private
 ### 一日中開いておく(受信箱)
 
 ```bash
-npx github-reporadar --org example-company --watch 5m
+npx github-reporadar --org example-company --watch 1m
 ```
 
-`--watch`を付けると、開いたまま5分ごとに同期し直します。同期のたびに前回との差分から「自分に起きたこと」を`events.json`(データdir)に足していきます。
+`--watch`を付けると、開いたままその間隔でopen issue/PRを取り直します。同期のたびに前回との差分から「自分に起きたこと」を`events.json`(データdir)に足していきます。
+
+毎回はopen issue/PRとレビュー状態だけを取り、コミットは30分ごとにまとめて取ります。GitHubのAPIは認証済みで5000回/時なので、実測にもとづく目安はこうです。
+
+| 間隔 | 1時間の消費(完全同期を含む) | 上限に対して |
+|---|---|---|
+| 30s | 4,430 | 89%。`gh`コマンドを併用する余裕が少ない |
+| 1m | 2,390 | 48%。おすすめ |
+| 5m | 700 | 14% |
+
+実測値は1回あたり、軽い同期がREST 34回で6秒、完全同期がREST 175回で13秒(42 repo、うち組織5)。repo数が増えると完全同期の側が伸びます。30秒未満は受け付けません。
 
 | 出来事 | 条件 |
 |---|---|
@@ -115,11 +125,84 @@ npx github-reporadar --org example-company --watch 5m
 
 初回の同期では何も出しません。溜まっていた分を一斉に出すと、新しく起きたことが埋もれるためです。画面のバッジと通知は次の版で入ります。
 
+### 平日の勤務時間だけ動かす(macOS)
+
+launchdで平日11:00に起動し、19:00に停止します。土日は動きません。
+
+```bash
+git clone https://github.com/BoxPistols/github-reporadar.git
+cd github-reporadar
+mkdir -p ~/.config/github-reporadar
+cat > ~/.config/github-reporadar/workday.env <<'ENV'
+RR_ORGS="example-company"
+RR_WATCH=20m
+RR_PORT=5177
+ENV
+./ops/install.sh
+```
+
+設定ファイルはリポジトリの外(`~/.config/github-reporadar/workday.env`)に置きます。組織名を含むので、リポジトリには入れません。
+
+| コマンド | 中身 |
+|---|---|
+| `./ops/install.sh` | launchdに登録。平日11:00起動 / 19:00停止 |
+| `./ops/install.sh uninstall` | 登録を解除 |
+| `./ops/reporadar-workday.sh start` / `stop` / `status` | 手で起動・停止・確認 |
+
+ログは`~/.local/state/github-reporadar/workday.log`です。二重起動はしません。`gh`にログインしていなければ起動せず、理由をログに残します。
+
+20分間隔なら、1時間あたりのGitHub APIの消費は約313回で上限の6%です(軽い同期が約1.5回、完全同期が約1.5回)。8時間動かしても上限には触れません。
+
+launchdは対話シェルの`PATH`を継がないので、`install.sh`が実行時の`PATH`をplistに焼き込みます。`node`や`gh`の場所を変えたら登録し直してください。
+
+### 毎日の運用
+
+登録したあとは、こちらから何もしなくても動きます。
+
+| 時刻 | 起きること |
+|---|---|
+| 平日11:00 | 起動して完全同期を1回。以後20分ごとにopen issue/PRを取り直す |
+| 20分ごと | 受信箱に差分が溜まる。ブラウザを開いていれば通知が出る |
+| 30分ごと | コミットも含めた完全同期 |
+| 平日19:00 | 停止 |
+| 土日 | 動かない |
+
+自分でやることはこれだけです。
+
+1. 朝、http://127.0.0.1:5177/ を開く。ブックマークしておく
+2. フィルターバーの札で今日やることを決める(レビュー待ちの自分のPR、自分がレビューするPR、Draft、手を付けていないissue)
+3. 受信箱に未読が付いたら開く。番号を押すとGitHubへ飛ぶ。読み終えたら「すべて既読」
+4. 迷ったら壁打ちで「今日の作業順を決めたい」と聞く
+
+初回だけ、受信箱の「通知を許可」を1回押してください。ブラウザを閉じている間の出来事も`events.json`に溜まるので、翌朝に開けば読めます。
+
+### 様子がおかしいとき
+
+| 症状 | 見るところ |
+|---|---|
+| 画面が開かない | `./ops/reporadar-workday.sh status`。動いていなければ`start` |
+| 数字が古い | ログの末尾。`tail -20 ~/.local/state/github-reporadar/workday.log` |
+| 受信箱が空のまま | 差分は前回の同期との比較で出る。初回同期の直後は必ず空。1回目の20分を待つ |
+| 「gh にログインしていません」 | `gh auth login`。組織がSSOなら`gh auth refresh -h github.com -s read:org`も |
+| 組織のrepoが出ない | 設定の`RR_ORGS`。`cat ~/.config/github-reporadar/workday.env` |
+| 通知が来ない | ブラウザの通知許可。受信箱を開いて「通知を許可」が出ていないか |
+| 起動しなくなった | `node`や`gh`の場所が変わった可能性。`./ops/install.sh`で登録し直す |
+
+### 更新とやめかた
+
+```bash
+./ops/reporadar-workday.sh restart   # 新しい版に入れ替える(npxが@latestを取り直す)
+./ops/install.sh uninstall           # 自動起動をやめる
+./ops/reporadar-workday.sh stop      # いま動いているものを止める
+```
+
+新しい版は次の11:00の起動から自動で使われます。すぐ入れ替えたいときだけ`restart`します。
+
 ### 運用の方針
 
 | 方針 | 理由 |
 |---|---|
-| 「リアルタイム」はポーリング(`--watch`)で作る | GitHubのWebhookは受け口のサーバーが要り、ローカル完結と矛盾する。5分間隔なら1日で300回弱の同期で、レート制限(認証済み5000回/時)に十分収まる。60秒未満は受け付けない |
+| 「リアルタイム」はポーリング(`--watch`)で作る | GitHubのWebhookは受け口のサーバーが要り、ローカル完結と矛盾する。毎回の同期をopen issue/PRだけに絞ってREST 34回にしたので、1分間隔でも上限の半分で収まる(実測)。コミットは30分ごと |
 | 出来事は前回との差分から作る | GitHubの通知APIは組織の全件が混ざり、自分のPRに関することだけを取り出しにくい。前回の`issues.json`と比べるだけなら追加のAPIも権限も要らない |
 | 組織はローカルだけ | 上の「前提と境界」のとおり。公開版に足すなら組織管理者への説明と明示同意の画面が先 |
 | 通知はブラウザのNotification API(次の版) | ページを開いている間に出る。OSの通知センターまで欲しい場合はCLI側から出す案があるが、まずはブラウザで足りるかを見る |

package/dist-cli/cli.js

@@ -366,6 +366,33 @@ async function listOpenIssues(token, repo, login) {
   }
   return items;
 }
+async function fetchIssuesOnly(token, fullNames, opts) {
+  const limit = createLimiter(CONCURRENCY);
+  const counts = await fetchOpenCounts(token, fullNames, limit);
+  const targets = fullNames.filter((n) => {
+    const c = counts.get(n);
+    return c != null && c.pr + c.issue > 0;
+  });
+  const lists = await Promise.all(
+    targets.map((n) => {
+      const [owner] = n.split("/");
+      const login = owner.toLowerCase() === opts.ownLogin.toLowerCase() ? null : opts.ownLogin;
+      return limit(() => listOpenIssues(token, { full_name: n }, login));
+    })
+  );
+  const flat = lists.flat();
+  const prMeta = await fetchPrMeta(
+    token,
+    flat.filter((it) => it.type === "pr").map((it) => ({ repo: it.repo, number: it.number })),
+    limit
+  );
+  const issues = flat.map((it) => {
+    if (it.type !== "pr") return it;
+    const meta = prMeta.get(`${it.repo}#${it.number}`);
+    return meta ? { ...it, ...meta } : it;
+  });
+  return { issues, counts };
+}
 function createProgress(repoTotal, issueTotal) {
   const enabled = process.stdout.isTTY === true;
   let repos = 0;
@@ -505,6 +532,16 @@ const DEFAULT_WINDOW_DAYS = 90;
 async function runSync(opts) {
   const windowDays = opts.days ?? DEFAULT_WINDOW_DAYS;
   const log = opts.log ?? ((line) => console.log(line));
+  const readJson = (name) => {
+    const path = join(opts.dataDir, name);
+    if (!existsSync(path)) return null;
+    try {
+      return JSON.parse(readFileSync(path, "utf8"));
+    } catch {
+      return null;
+    }
+  };
+  if (opts.mode === "light") return runLightSync(opts, log, readJson);
   if (!Number.isFinite(windowDays) || windowDays < 1 || windowDays > 365) {
     throw new Error(`--days は 1〜365 で指定してください: ${windowDays}`);
   }
@@ -516,15 +553,6 @@ async function runSync(opts) {
   if (orgs.length > 0) log(`組織も取得: ${orgs.join(", ")}(自分がauthorのコミットだけ数える)`);
   const { login, repos, activity, issues } = await fetchActivity(token, from, { includePrivate: true, orgs });
   mkdirSync(opts.dataDir, { recursive: true });
-  const readJson = (name) => {
-    const path = join(opts.dataDir, name);
-    if (!existsSync(path)) return null;
-    try {
-      return JSON.parse(readFileSync(path, "utf8"));
-    } catch {
-      return null;
-    }
-  };
   const prevIssues = readJson("issues.json");
   const prevRepos = readJson("repos.json");
   const fresh = diffEvents(prevIssues, issues, login, to.toISOString(), {
@@ -543,6 +571,34 @@ async function runSync(opts) {
   log(`OK: ${repos.length} repos / ${totalCommits} commits / ${issues.length} open issues+PRs → ${opts.dataDir}`);
   return { login, repos: repos.length, commits: totalCommits, issues: issues.length, events: fresh.length };
 }
+async function runLightSync(opts, log, readJson) {
+  const prevRepos = readJson("repos.json");
+  if (!prevRepos || prevRepos.length === 0) {
+    log("前回の同期が無いので完全同期します");
+    return runSync({ ...opts, mode: "full" });
+  }
+  const token = getToken();
+  const login = readJson("meta.json")?.login;
+  if (!login) return runSync({ ...opts, mode: "full" });
+  const names = prevRepos.map((r) => r.nameWithOwner);
+  const { issues, counts } = await fetchIssuesOnly(token, names, { ownLogin: login });
+  const to = /* @__PURE__ */ new Date();
+  const prevIssues = readJson("issues.json");
+  const repoSet = new Set(names);
+  const fresh = diffEvents(prevIssues, issues, login, to.toISOString(), { prevRepos: repoSet, nextRepos: repoSet });
+  const events = mergeEvents(readJson("events.json") ?? [], fresh);
+  const repos = prevRepos.map((r) => {
+    const c = counts.get(r.nameWithOwner);
+    return c ? { ...r, openPrCount: c.pr, openIssueCount: c.issue } : r;
+  });
+  const meta = readJson("meta.json");
+  writeFileSync(join(opts.dataDir, "issues.json"), JSON.stringify(issues, null, 2));
+  writeFileSync(join(opts.dataDir, "events.json"), JSON.stringify(events, null, 2));
+  writeFileSync(join(opts.dataDir, "repos.json"), JSON.stringify(repos, null, 2));
+  if (meta) writeFileSync(join(opts.dataDir, "meta.json"), JSON.stringify({ ...meta, lastSyncAt: to.toISOString() }, null, 2));
+  log(`更新: open ${issues.length}件${fresh.length > 0 ? ` / 受信箱に${fresh.length}件` : ""}`);
+  return { login, repos: repos.length, commits: 0, issues: issues.length, events: fresh.length };
+}
 const isMain = process.argv[1]?.endsWith("sync.ts") || process.argv[1]?.endsWith("sync.js");
 if (isMain) {
   const daysArg = process.argv.indexOf("--days");
@@ -615,7 +671,7 @@ function parseArgs(argv) {
         const m = v && !v.startsWith("--") ? /^(\d+)(s|m|h)$/.exec(v) : null;
         if (!m) throw new RangeError(`--watchは 5m / 90s / 1h のように指定してください(受け取った値: ${v ?? "無し"})`);
         const sec = Number(m[1]) * (m[2] === "h" ? 3600 : m[2] === "m" ? 60 : 1);
-        if (sec < 60) throw new RangeError(`--watchは60秒以上にしてください(GitHubのレート制限を守る)。受け取った値: ${v}`);
+        if (sec < 30) throw new RangeError(`--watchは30秒以上にしてください(GitHubのレート制限を守る)。受け取った値: ${v}`);
         out.watchSeconds = sec;
         break;
       }
@@ -660,7 +716,7 @@ const USAGE = [
   row("--port N", "待ち受けポート(既定5177。使用中なら次を探す)"),
   row("--no-open", "ブラウザを開かない"),
   row("--no-sync", "同期せずに手元のデータで開く"),
-  row("--watch 5m", "開いたまま、この間隔で同期し直す(60秒以上)。受信箱に自分に起きたことが溜まる"),
+  row("--watch 1m", "開いたまま、この間隔でopen issue/PRを取り直す(30秒以上)。受信箱に自分に起きたことが溜まる"),
   row("--org NAME", "組織のrepoも取得する(繰り返し可)。組織では自分がauthorのコミットと、自分が作ったか担当のissue/PRだけ数える"),
   row("--data-dir DIR", "データの置き場(既定: $XDG_CACHE_HOME か ~/.cache の github-reporadar/data)"),
   row("--sort KEY", "brief の並び: active | recent | stale"),
@@ -819,12 +875,25 @@ async function main() {
   if (args.open) openBrowser(url);
   let timer = null;
   if (args.watchSeconds) {
-    console.log(`${args.watchSeconds}秒ごとに同期します`);
+    const FULL_EVERY_MS = 30 * 60 * 1e3;
+    console.log(`${args.watchSeconds}秒ごとにopen issue/PRを取り直します(コミットは30分ごと)`);
+    if (args.watchSeconds < 60) {
+      console.log("60秒未満はGitHubの制限に対する余裕が少なくなります(1時間あたり上限の約9割)");
+    }
     let busy = false;
+    let lastFull = Date.now();
     timer = setInterval(() => {
       if (busy) return;
       busy = true;
-      runSync({ dataDir, days: args.days, orgs: args.orgs, log: (line) => console.log(`[watch] ${line}`) }).catch((err) => console.error(`[watch] 同期に失敗: ${err instanceof Error ? err.message : String(err)}`)).finally(() => {
+      const full = Date.now() - lastFull >= FULL_EVERY_MS;
+      if (full) lastFull = Date.now();
+      runSync({
+        dataDir,
+        days: args.days,
+        orgs: args.orgs,
+        mode: full ? "full" : "light",
+        log: (line) => console.log(`[watch] ${line}`)
+      }).catch((err) => console.error(`[watch] 同期に失敗: ${err instanceof Error ? err.message : String(err)}`)).finally(() => {
         busy = false;
       });
     }, args.watchSeconds * 1e3);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "github-reporadar",
-  "version": "0.1.10",
+  "version": "0.2.0",
   "description": "自分のGitHub活動を一晩ぶん眺める計器盤。npx github-reporadarでローカルに開く",
   "license": "MIT",
   "bin": {