feat(timer,time-log): 起錶配上停錶,並補登議題建立之前的時間
碼錶只在領取工作包時起動,所以工時報表上規劃與分析永遠是零。久了會讓人以為 規劃不花時間,而那正是估算失準最常見的來源。 timer 加上 --stop,而且**只停 --index 指的那一顆**。每個階段停掉自己起的那一支, 錶就不會跨階段跑——跑完就去開會而錶跑一整天,報表當場失真。反過來,別顆議題上的錶 一律不碰:Gitea 在別顆議題上起新錶會靜默地停掉並記錄前一顆,那種靜默結算正是領取鎖 那條規則當初要擋的,不能在這裡反過來製造它。錶本來就沒在跑不算失敗,這一步多半排在 回報之前,報成失敗只會讓人以為前面那件事沒做成而重跑一次。 time-log 補登議題建立之前那一段——讀齊輸入、逐項詢問、組出議題內容,往往是整個 plan 最耗時的部分,而那時候議題還不存在,沒有標的可起錶。長度由腳本自己算(議題的建立時間 減掉 --since),交給 agent 做減法等於讓兩邊的時鐘各算一次,而算錯了報表上看不出來。 **不設時間上限、照實補登**:中途去開會的兩小時會一起算進去,換來這個流程不必為此 多長一題出來問使用者。 補登不是冪等的動作,所以兩種情況跳過不補:錶已經跑在這顆議題上(補登排在起錶之前, 錶在跑就代表這一段補過了),以及這顆議題上已經有工時(整個流程跑完過一次)。工時記 重複比記不到更難在報表上被發現,所以判斷偏向不補。 時間追蹤在現有環境下可能是關著的,真實路徑跑不起來;兩支都靠 --dry-run 與 stub server 測,共 27 條。 議題 #57 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,125 @@
|
|||||||
|
#!/usr/bin/env node
|
||||||
|
/**
|
||||||
|
* 補登一段沒有錶記到的工時。
|
||||||
|
*
|
||||||
|
* 規劃階段最耗時的那一段——讀齊輸入、逐項詢問、組出議題內容——發生在議題建立**之前**,
|
||||||
|
* 那時候沒有標的可起錶(議題還不存在)。這段時間只能事後補登,否則報表上的規劃永遠是零,
|
||||||
|
* 久了會讓人以為規劃不花時間,而那正是估算失準最常見的來源。
|
||||||
|
*
|
||||||
|
* **長度由這支腳本自己算**:議題的建立時間減掉 `--since`。交給 agent 做減法,等於讓
|
||||||
|
* 兩邊的時鐘與時區各算一次,而算錯了報表上看不出來。
|
||||||
|
*
|
||||||
|
* **不設時間上限,照實補登。** 中途去開會的那兩個小時會一起被算進去——換來這個流程
|
||||||
|
* 不必為此多長一題出來問使用者。時間記多了看得出來,記不到就永遠找不回來。
|
||||||
|
*
|
||||||
|
* 兩種情況跳過不補,因為補登一旦記兩遍,報表看不出來哪一筆是重複的:
|
||||||
|
* - 自己的錶已經跑在這顆議題上:補登排在起錶之前,錶在跑就代表這一步做過了。
|
||||||
|
* - 這顆議題上已經有自己的工時:整個流程跑完過一次了。
|
||||||
|
*
|
||||||
|
* 只寫工時,不動任何錶——別顆議題上有錶在跑也照補,那兩件事互不相干。
|
||||||
|
*
|
||||||
|
* 用法:
|
||||||
|
* node scripts/time-log.js --repo owner/name --index 42 --since <ISO 8601 時間>
|
||||||
|
* [--host <網址>] [--dry-run]
|
||||||
|
*/
|
||||||
|
import {
|
||||||
|
ScriptError,
|
||||||
|
expectOk,
|
||||||
|
fetchIssue,
|
||||||
|
giteaRequest,
|
||||||
|
listIssueTimes,
|
||||||
|
listStopwatches,
|
||||||
|
main,
|
||||||
|
parseFlags,
|
||||||
|
parseIndex,
|
||||||
|
parseRepo,
|
||||||
|
preflight,
|
||||||
|
resolveLogin,
|
||||||
|
stopwatchOnIssue,
|
||||||
|
} from './lib.js';
|
||||||
|
|
||||||
|
main(async () => {
|
||||||
|
const flags = parseFlags(process.argv.slice(2), {
|
||||||
|
required: ['repo', 'index', 'since'],
|
||||||
|
optional: ['host'],
|
||||||
|
booleans: ['dry-run'],
|
||||||
|
});
|
||||||
|
const repo = parseRepo(flags.repo);
|
||||||
|
const index = parseIndex(flags.index);
|
||||||
|
const since = parseSince(flags.since);
|
||||||
|
const dryRun = flags['dry-run'] === true;
|
||||||
|
const timesPath = `/repos/${repo}/issues/${index}/times`;
|
||||||
|
|
||||||
|
const login = resolveLogin({ host: flags.host });
|
||||||
|
// 試跑照樣讀現況:手寫一份固定的清單會跟實作走鐘,也說不出「這一段已經補過了」
|
||||||
|
if (!dryRun) await preflight(login, repo);
|
||||||
|
const issue = await fetchIssue(login, repo, index);
|
||||||
|
|
||||||
|
const 建立時間 = Date.parse(issue.created_at);
|
||||||
|
if (Number.isNaN(建立時間)) {
|
||||||
|
throw new ScriptError(
|
||||||
|
'NO_CREATED_AT',
|
||||||
|
`${repo} 的議題 ${index} 沒有可解讀的建立時間,補登的長度算不出來`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const 秒數 = Math.round((建立時間 - since) / 1000);
|
||||||
|
const 略過 = await skipReason(login, repo, index, 秒數);
|
||||||
|
const planned = 略過 === null ? [{ method: 'POST', path: timesPath, body: { time: 秒數 } }] : [];
|
||||||
|
const 報告 = {
|
||||||
|
repo,
|
||||||
|
index: issue.number,
|
||||||
|
title: issue.title,
|
||||||
|
url: issue.html_url,
|
||||||
|
since: new Date(since).toISOString(),
|
||||||
|
議題建立時間: issue.created_at,
|
||||||
|
秒數,
|
||||||
|
補登: 略過 === null,
|
||||||
|
...(略過 ? { note: 略過 } : {}),
|
||||||
|
};
|
||||||
|
|
||||||
|
if (dryRun) {
|
||||||
|
return { dryRun: true, ...報告, requests: planned };
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const { method, path, body } of planned) {
|
||||||
|
expectOk(await giteaRequest(login, method, path, { body }), `${method} ${path}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
return 報告;
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 不該補的理由,沒有就回 null。
|
||||||
|
*
|
||||||
|
* 三個理由都是「補了會比不補更錯」:長度非正的那一段根本不存在,另外兩個代表這一步
|
||||||
|
* 已經做過,再補一次就是把同一段時間記兩遍。
|
||||||
|
*/
|
||||||
|
async function skipReason(login, repo, index, 秒數) {
|
||||||
|
if (秒數 <= 0) {
|
||||||
|
return '指令開始時間不早於議題建立時間,沒有可補登的區間;兩邊時鐘差幾秒是常事,這不算失敗。';
|
||||||
|
}
|
||||||
|
if (stopwatchOnIssue(await listStopwatches(login), repo, index)) {
|
||||||
|
return '碼錶已經跑在這顆議題上。補登排在起錶之前,錶在跑就代表這一段補過了,不再記第二遍。';
|
||||||
|
}
|
||||||
|
if ((await listIssueTimes(login, repo, index)).length > 0) {
|
||||||
|
return '這顆議題上已經有自己的工時紀錄,代表整個流程跑完過一次,不再補一次。';
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 解析 `--since`。擋在打 Gitea 之前:值打錯是最常見的輸入錯誤,
|
||||||
|
* 而它在補登之前唯一的症狀就是長度不對,事後從報表上看不出來。
|
||||||
|
* @returns {number} epoch 毫秒
|
||||||
|
*/
|
||||||
|
function parseSince(value) {
|
||||||
|
const at = Date.parse(value);
|
||||||
|
if (Number.isNaN(at)) {
|
||||||
|
throw new ScriptError(
|
||||||
|
'BAD_SINCE',
|
||||||
|
`--since 需為可解析的 ISO 8601 時間(例如 2026-09-17T10:05:00Z),收到的是 ${value}`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return at;
|
||||||
|
}
|
||||||
+44
-19
@@ -1,18 +1,28 @@
|
|||||||
#!/usr/bin/env node
|
#!/usr/bin/env node
|
||||||
/**
|
/**
|
||||||
* 起錶。
|
* 起錶與停錶。
|
||||||
*
|
*
|
||||||
* 錶與領取鎖是兩件事:鎖用 assignee 加標籤(見 claim.js),錶只管工時。分開的理由是
|
* 錶與領取鎖是兩件事:鎖用 assignee 加標籤(見 claim.js),錶只管工時。
|
||||||
* 時機不同——鎖要在開工之前就上好,錶則要等到**工作樹真的建好之後**才起。工作樹建立
|
*
|
||||||
* 失敗會中止整個領取,錶要是先起了,使用者就被計了一段什麼都沒做的時間,
|
* **領取工作包時**(sdlc-feat)兩者的時機不同:鎖要在開工之前就上好,錶則要等到
|
||||||
* 而工時要準正是工時報表的立足點。
|
* **工作樹真的建好之後**才起。工作樹建立失敗會中止整個領取,錶要是先起了,使用者就被
|
||||||
|
* 計了一段什麼都沒做的時間,而工時要準正是工時報表的立足點。規劃與分析沒有工作樹,
|
||||||
|
* 那條規則對它們不適用——它們的標的是需求議題本身,議題存在就起得了錶。
|
||||||
*
|
*
|
||||||
* 自己的錶跑在別顆議題上時擋下,不代勞停錶:那一段時間該記在哪顆議題上只有人知道,
|
* 自己的錶跑在別顆議題上時擋下,不代勞停錶:那一段時間該記在哪顆議題上只有人知道,
|
||||||
* 腳本自作主張會把工時記錯地方。錶已經跑在本議題上則什麼都不做——重新起錶會把已經
|
* 腳本自作主張會把工時記錯地方。錶已經跑在本議題上則什麼都不做——重新起錶會把已經
|
||||||
* 累積的時間切成兩段,而中斷後重跑正是這支腳本最常見的處境。
|
* 累積的時間切成兩段,而中斷後重跑正是這支腳本最常見的處境。
|
||||||
*
|
*
|
||||||
|
* `--stop` 停錶,而且**只停 `--index` 指的那一顆**。每個階段停掉自己起的那支錶,
|
||||||
|
* 錶就不會跨階段跑——跑完就去開會而錶跑一整天,報表當場失真。反過來,別顆議題上的錶
|
||||||
|
* 一律不碰:Gitea 在別顆議題上起新錶會靜默地停掉並記錄前一顆,那種靜默結算正是
|
||||||
|
* 領取鎖那條規則當初要擋的,這裡不能反過來製造它。
|
||||||
|
*
|
||||||
|
* 停錶時錶本來就沒在跑不算失敗:這一步多半排在別的事情做完之後(開完 PR、回報之前),
|
||||||
|
* 把「本來就沒在跑」報成失敗,只會讓人以為前面那件事沒做成而重跑一次。
|
||||||
|
*
|
||||||
* 用法:
|
* 用法:
|
||||||
* node scripts/timer.js --repo owner/name --index 40 [--host <網址>] [--dry-run]
|
* node scripts/timer.js --repo owner/name --index 40 [--stop] [--host <網址>] [--dry-run]
|
||||||
*/
|
*/
|
||||||
import {
|
import {
|
||||||
expectOk,
|
expectOk,
|
||||||
@@ -25,6 +35,7 @@ import {
|
|||||||
parseRepo,
|
parseRepo,
|
||||||
preflight,
|
preflight,
|
||||||
resolveLogin,
|
resolveLogin,
|
||||||
|
stopStopwatch,
|
||||||
stopwatchElsewhere,
|
stopwatchElsewhere,
|
||||||
stopwatchOnIssue,
|
stopwatchOnIssue,
|
||||||
} from './lib.js';
|
} from './lib.js';
|
||||||
@@ -33,12 +44,13 @@ main(async () => {
|
|||||||
const flags = parseFlags(process.argv.slice(2), {
|
const flags = parseFlags(process.argv.slice(2), {
|
||||||
required: ['repo', 'index'],
|
required: ['repo', 'index'],
|
||||||
optional: ['host'],
|
optional: ['host'],
|
||||||
booleans: ['dry-run'],
|
booleans: ['stop', 'dry-run'],
|
||||||
});
|
});
|
||||||
const repo = parseRepo(flags.repo);
|
const repo = parseRepo(flags.repo);
|
||||||
const index = parseIndex(flags.index);
|
const index = parseIndex(flags.index);
|
||||||
const issuePath = `/repos/${repo}/issues/${index}`;
|
const issuePath = `/repos/${repo}/issues/${index}`;
|
||||||
const dryRun = flags['dry-run'] === true;
|
const dryRun = flags['dry-run'] === true;
|
||||||
|
const 要停錶 = flags.stop === true;
|
||||||
|
|
||||||
const login = resolveLogin({ host: flags.host });
|
const login = resolveLogin({ host: flags.host });
|
||||||
// 試跑照樣讀現況:手寫一份固定的清單會跟實作走鐘,也說不出「這顆已經在計時了」
|
// 試跑照樣讀現況:手寫一份固定的清單會跟實作走鐘,也說不出「這顆已經在計時了」
|
||||||
@@ -47,25 +59,38 @@ main(async () => {
|
|||||||
|
|
||||||
const watches = await listStopwatches(login);
|
const watches = await listStopwatches(login);
|
||||||
const 已在計時 = stopwatchOnIssue(watches, repo, index) !== null;
|
const 已在計時 = stopwatchOnIssue(watches, repo, index) !== null;
|
||||||
if (!已在計時 && watches.length > 0) throw stopwatchElsewhere(watches[0], '起錶');
|
// 起錶才要擋:別顆議題上的錶會讓工時記錯地方。停錶只動這一顆,擋不擋都影響不到它
|
||||||
|
if (!要停錶 && !已在計時 && watches.length > 0) throw stopwatchElsewhere(watches[0], '起錶');
|
||||||
|
|
||||||
// 已經在跑就不重起:重新起錶會把已經累積的時間切成兩段
|
// 起錶:已經在跑就不重起,重新起錶會把已經累積的時間切成兩段
|
||||||
const planned = 已在計時 ? [] : [{ method: 'POST', path: `${issuePath}/stopwatch/start`, body: {} }];
|
// 停錶:沒在這顆上跑就沒得停,別顆議題上的錶不碰
|
||||||
|
const 動作 = 要停錶
|
||||||
|
? { 端點: 'stop', 要發請求: 已在計時 }
|
||||||
|
: { 端點: 'start', 要發請求: !已在計時 };
|
||||||
|
const planned = 動作.要發請求
|
||||||
|
? [{ method: 'POST', path: `${issuePath}/stopwatch/${動作.端點}`, body: {} }]
|
||||||
|
: [];
|
||||||
|
|
||||||
|
const 報告 = { repo, index: issue.number, title: issue.title, url: issue.html_url };
|
||||||
|
|
||||||
if (dryRun) {
|
if (dryRun) {
|
||||||
return { dryRun: true, repo, index, title: issue.title, requests: planned, 已在計時 };
|
return { dryRun: true, ...報告, requests: planned, 已在計時 };
|
||||||
|
}
|
||||||
|
|
||||||
|
if (要停錶) {
|
||||||
|
// 端點回「沒有錶在跑」的狀態碼隨站台版本而異,所以停錶走 lib 那條容錯路徑;
|
||||||
|
// 讀到的現況與實際狀態差一步(錶剛被別處停掉)也不該把整件事報成失敗
|
||||||
|
const stopped = planned.length > 0 && (await stopStopwatch(login, repo, index));
|
||||||
|
return {
|
||||||
|
...報告,
|
||||||
|
碼錶已停: stopped,
|
||||||
|
...(stopped ? {} : { note: '碼錶本來就沒在這顆議題上運轉,這一步略過;別顆議題上的錶不由這裡代停。' }),
|
||||||
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
for (const { method, path, body } of planned) {
|
for (const { method, path, body } of planned) {
|
||||||
expectOk(await giteaRequest(login, method, path, { body }), `${method} ${path}`);
|
expectOk(await giteaRequest(login, method, path, { body }), `${method} ${path}`);
|
||||||
}
|
}
|
||||||
|
|
||||||
return {
|
return { ...報告, 碼錶中: true, 已在計時 };
|
||||||
repo,
|
|
||||||
index: issue.number,
|
|
||||||
title: issue.title,
|
|
||||||
url: issue.html_url,
|
|
||||||
碼錶中: true,
|
|
||||||
已在計時,
|
|
||||||
};
|
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -0,0 +1,193 @@
|
|||||||
|
/**
|
||||||
|
* 補登工時。
|
||||||
|
*
|
||||||
|
* 規劃階段最耗時的那一段發生在議題建立之前——那時候沒有標的可起錶,時間只能事後補登。
|
||||||
|
* 這一支的價值全在「補多少」與「什麼時候不該補」:長度由議題的建立時間減掉指令開始
|
||||||
|
* 時間算出來,不由 agent 自己做減法;已經補過的不再補一次,否則重跑會把同一段時間
|
||||||
|
* 記兩遍,而報表看不出來那是重複的。
|
||||||
|
*/
|
||||||
|
import test from 'node:test';
|
||||||
|
import assert from 'node:assert/strict';
|
||||||
|
import { runScript } from './helpers/run-script.js';
|
||||||
|
import { healthyRoutes, stubEnv as envFor, withStubGitea } from './helpers/stub-gitea.js';
|
||||||
|
|
||||||
|
const REPO = 'plugins/tea-sdlc';
|
||||||
|
const INDEX = 42;
|
||||||
|
|
||||||
|
/** 議題建立於此刻;每支測試的 --since 都相對它往前推 */
|
||||||
|
const CREATED = '2026-09-17T10:30:00Z';
|
||||||
|
|
||||||
|
/** CREATED 往前推 n 秒的 ISO 時間 */
|
||||||
|
const 早於建立 = (seconds) => new Date(Date.parse(CREATED) - seconds * 1000).toISOString();
|
||||||
|
|
||||||
|
/** 議題上跑著的碼錶長什麼樣 */
|
||||||
|
const stopwatchOn = (index, repo = REPO) => ({
|
||||||
|
issue_index: index,
|
||||||
|
repo_owner_name: repo.split('/')[0],
|
||||||
|
repo_name: repo.split('/')[1],
|
||||||
|
});
|
||||||
|
|
||||||
|
function routes(overrides = {}, { stopwatches = [], times = [] } = {}) {
|
||||||
|
return healthyRoutes(REPO, {
|
||||||
|
[`GET /api/v1/repos/${REPO}/issues/${INDEX}`]: {
|
||||||
|
status: 200,
|
||||||
|
body: {
|
||||||
|
number: INDEX,
|
||||||
|
title: '為規劃與分析階段計時並補登規劃時間',
|
||||||
|
created_at: CREATED,
|
||||||
|
html_url: `https://gitea.jsc.idv.tw/${REPO}/issues/${INDEX}`,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
'GET /api/v1/user/stopwatches': { status: 200, body: stopwatches },
|
||||||
|
[`GET /api/v1/repos/${REPO}/issues/${INDEX}/times`]: { status: 200, body: times },
|
||||||
|
[`POST /api/v1/repos/${REPO}/issues/${INDEX}/times`]: { status: 200, body: { id: 1 } },
|
||||||
|
...overrides,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
const withStub = (t, overrides = {}, options) => withStubGitea(t, routes(overrides, options));
|
||||||
|
|
||||||
|
const run = (since, args, stub) =>
|
||||||
|
runScript('time-log.js', ['--repo', REPO, '--index', String(INDEX), '--since', since, ...args], {
|
||||||
|
env: envFor(stub),
|
||||||
|
});
|
||||||
|
|
||||||
|
/** 會改動 Gitea 的請求;前置檢查打在 issues/0 的探針不算(見 lib 的 checkIssueWrite) */
|
||||||
|
const writes = (stub) =>
|
||||||
|
stub.requests.filter((r) => r.method !== 'GET').filter((r) => !r.path.endsWith('/issues/0'));
|
||||||
|
|
||||||
|
test('補登時長等於指令開始到議題建立的差值', async (t) => {
|
||||||
|
const stub = await withStub(t);
|
||||||
|
|
||||||
|
const { code, json } = await run(早於建立(25 * 60), [], stub);
|
||||||
|
|
||||||
|
assert.equal(code, 0, json.error?.message);
|
||||||
|
assert.equal(json.data.補登, true);
|
||||||
|
assert.equal(json.data.秒數, 25 * 60);
|
||||||
|
const [write] = writes(stub);
|
||||||
|
assert.equal(write.path, `/api/v1/repos/${REPO}/issues/${INDEX}/times`);
|
||||||
|
assert.deepEqual(write.body, { time: 25 * 60 });
|
||||||
|
});
|
||||||
|
|
||||||
|
test('長度由腳本自己算:議題的建立時間減掉 --since,agent 不必做減法', async (t) => {
|
||||||
|
const stub = await withStub(t);
|
||||||
|
|
||||||
|
const { json } = await run(早於建立(90), [], stub);
|
||||||
|
|
||||||
|
assert.equal(json.data.秒數, 90);
|
||||||
|
assert.equal(json.data.議題建立時間, CREATED);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('不設時間上限:中間去開會的那幾個小時照實補登,不改口問使用者', async (t) => {
|
||||||
|
const stub = await withStub(t);
|
||||||
|
const 十小時 = 10 * 60 * 60;
|
||||||
|
|
||||||
|
const { code, json } = await run(早於建立(十小時), [], stub);
|
||||||
|
|
||||||
|
assert.equal(code, 0, '時間長不是失敗;記多了看得出來,記不到就永遠找不回來');
|
||||||
|
assert.equal(json.data.秒數, 十小時);
|
||||||
|
assert.deepEqual(writes(stub).at(0).body, { time: 十小時 });
|
||||||
|
});
|
||||||
|
|
||||||
|
test('錶已經跑在這顆議題上時跳過:補登排在起錶之前,代表這一步做過了', async (t) => {
|
||||||
|
const stub = await withStub(t, {}, { stopwatches: [stopwatchOn(INDEX)] });
|
||||||
|
|
||||||
|
const { code, json } = await run(早於建立(600), [], stub);
|
||||||
|
|
||||||
|
assert.equal(code, 0, json.error?.message);
|
||||||
|
assert.equal(json.data.補登, false);
|
||||||
|
assert.match(json.data.note, /起錶/);
|
||||||
|
assert.deepEqual(writes(stub), [], '重跑不該把同一段時間記第二遍');
|
||||||
|
});
|
||||||
|
|
||||||
|
test('這顆議題上已經有自己的工時時跳過,重跑不會愈補愈多', async (t) => {
|
||||||
|
const stub = await withStub(t, {}, { times: [{ id: 3, time: 1500 }] });
|
||||||
|
|
||||||
|
const { code, json } = await run(早於建立(600), [], stub);
|
||||||
|
|
||||||
|
assert.equal(code, 0, json.error?.message);
|
||||||
|
assert.equal(json.data.補登, false);
|
||||||
|
assert.match(json.data.note, /工時/);
|
||||||
|
assert.deepEqual(writes(stub), []);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('錶跑在別顆議題上不影響補登:補登只寫工時,不動任何錶', async (t) => {
|
||||||
|
const stub = await withStub(t, {}, { stopwatches: [stopwatchOn(7)] });
|
||||||
|
|
||||||
|
const { code, json } = await run(早於建立(600), [], stub);
|
||||||
|
|
||||||
|
assert.equal(code, 0, json.error?.message);
|
||||||
|
assert.equal(json.data.補登, true);
|
||||||
|
assert.deepEqual(
|
||||||
|
writes(stub).map((r) => r.path),
|
||||||
|
[`/api/v1/repos/${REPO}/issues/${INDEX}/times`],
|
||||||
|
'不得順手停掉別顆議題上的錶',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('指令開始時間不早於議題建立時間時什麼都不補,也不算失敗', async (t) => {
|
||||||
|
const stub = await withStub(t);
|
||||||
|
|
||||||
|
const { code, json } = await run(new Date(Date.parse(CREATED) + 1000).toISOString(), [], stub);
|
||||||
|
|
||||||
|
assert.equal(code, 0, '兩邊時鐘差幾秒是常事,不該讓整個流程停在這裡');
|
||||||
|
assert.equal(json.data.補登, false);
|
||||||
|
assert.deepEqual(writes(stub), []);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('--since 不是可解析的時間時擋在打 Gitea 之前', async (t) => {
|
||||||
|
const stub = await withStub(t);
|
||||||
|
|
||||||
|
const { code, json } = await run('剛剛', [], stub);
|
||||||
|
|
||||||
|
assert.equal(code, 1);
|
||||||
|
assert.equal(json.error.code, 'BAD_SINCE');
|
||||||
|
assert.equal(stub.requests.length, 0);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('議題不存在時回可區分的錯誤碼', async (t) => {
|
||||||
|
const stub = await withStub(t, {
|
||||||
|
[`GET /api/v1/repos/${REPO}/issues/${INDEX}`]: { status: 404, body: { message: 'not found' } },
|
||||||
|
});
|
||||||
|
|
||||||
|
const { json } = await run(早於建立(600), [], stub);
|
||||||
|
|
||||||
|
assert.equal(json.error.code, 'ISSUE_NOT_FOUND');
|
||||||
|
assert.deepEqual(writes(stub), []);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('repo 的時間追蹤關著時,訊息與前置檢查第四層說的是同一件事', async (t) => {
|
||||||
|
// 議題讀得到卻在 times 上 404,代表時間追蹤關著;試跑不跑前置檢查,這句話得由這裡說
|
||||||
|
const stub = await withStub(t, {
|
||||||
|
[`GET /api/v1/repos/${REPO}/issues/${INDEX}/times`]: { status: 404, body: { message: 'not found' } },
|
||||||
|
});
|
||||||
|
|
||||||
|
const { code, json } = await run(早於建立(600), ['--dry-run'], stub);
|
||||||
|
|
||||||
|
assert.equal(code, 1);
|
||||||
|
assert.equal(json.error.code, 'TIME_TRACKER_OFF');
|
||||||
|
assert.match(json.error.message, /Enable Time Tracker/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('--dry-run 印出將發出的補登,但一個字都不寫進去', async (t) => {
|
||||||
|
const stub = await withStub(t);
|
||||||
|
|
||||||
|
const { code, json } = await run(早於建立(1800), ['--dry-run'], stub);
|
||||||
|
|
||||||
|
assert.equal(code, 0);
|
||||||
|
assert.equal(json.data.dryRun, true);
|
||||||
|
assert.equal(json.data.秒數, 1800);
|
||||||
|
assert.deepEqual(json.data.requests, [
|
||||||
|
{ method: 'POST', path: `/repos/${REPO}/issues/${INDEX}/times`, body: { time: 1800 } },
|
||||||
|
]);
|
||||||
|
assert.deepEqual(writes(stub), [], '預覽不得真的寫入');
|
||||||
|
});
|
||||||
|
|
||||||
|
test('--dry-run 會先讀現況:已經補過的預覽出來就是什麼都不做', async (t) => {
|
||||||
|
const stub = await withStub(t, {}, { times: [{ id: 3, time: 1500 }] });
|
||||||
|
|
||||||
|
const { json } = await run(早於建立(1800), ['--dry-run'], stub);
|
||||||
|
|
||||||
|
assert.deepEqual(json.data.requests, [], '手寫一份固定的清單會跟實作走鐘');
|
||||||
|
assert.equal(json.data.補登, false);
|
||||||
|
});
|
||||||
+98
-3
@@ -1,9 +1,13 @@
|
|||||||
/**
|
/**
|
||||||
* 起錶。
|
* 起錶與停錶。
|
||||||
*
|
*
|
||||||
* 錶是工時報表的唯一來源,所以這一支的價值全在「什麼時候不該起」:工作樹還沒建好
|
* 錶是工時報表的唯一來源,所以起錶那一半的價值全在「什麼時候不該起」:工作樹還沒建好
|
||||||
* 不該起(那由流程的順序保證),自己的錶已經跑在別顆議題上更不該起——那會把兩顆
|
* 不該起(那由流程的順序保證),自己的錶已經跑在別顆議題上更不該起——那會把兩顆
|
||||||
* 工作包的時間攪在一起。停錶一律由使用者自己來,這裡不提供。
|
* 工作包的時間攪在一起。
|
||||||
|
*
|
||||||
|
* `--stop` 只停 `--index` 指的那一顆。每個階段停掉自己起的那支錶,錶就不會跨階段跑;
|
||||||
|
* 但別顆議題上的錶一律不碰——那一段時間該記在哪顆議題上只有人知道,而靜默替人結算
|
||||||
|
* 正是領取鎖那條規則當初要擋的事。
|
||||||
*/
|
*/
|
||||||
import test from 'node:test';
|
import test from 'node:test';
|
||||||
import assert from 'node:assert/strict';
|
import assert from 'node:assert/strict';
|
||||||
@@ -32,6 +36,7 @@ function routes(overrides = {}, { stopwatches = [] } = {}) {
|
|||||||
},
|
},
|
||||||
'GET /api/v1/user/stopwatches': { status: 200, body: stopwatches },
|
'GET /api/v1/user/stopwatches': { status: 200, body: stopwatches },
|
||||||
[`POST /api/v1/repos/${REPO}/issues/${INDEX}/stopwatch/start`]: { status: 201, body: {} },
|
[`POST /api/v1/repos/${REPO}/issues/${INDEX}/stopwatch/start`]: { status: 201, body: {} },
|
||||||
|
[`POST /api/v1/repos/${REPO}/issues/${INDEX}/stopwatch/stop`]: { status: 200, body: {} },
|
||||||
...overrides,
|
...overrides,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
@@ -147,3 +152,93 @@ test('--dry-run 會先讀現況:已經在計時時預覽出來就是什麼都
|
|||||||
assert.deepEqual(json.data.requests, [], '手寫一份固定的清單會跟實作走鐘');
|
assert.deepEqual(json.data.requests, [], '手寫一份固定的清單會跟實作走鐘');
|
||||||
assert.equal(json.data.已在計時, true);
|
assert.equal(json.data.已在計時, true);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// ── 停錶 ───────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
test('--stop 停掉跑在這顆議題上的錶', async (t) => {
|
||||||
|
const stub = await withStub(t, {}, { stopwatches: [stopwatchOn(INDEX)] });
|
||||||
|
|
||||||
|
const { code, json } = await run(['--stop'], stub);
|
||||||
|
|
||||||
|
assert.equal(code, 0, json.error?.message);
|
||||||
|
assert.equal(json.data.碼錶已停, true);
|
||||||
|
assert.deepEqual(
|
||||||
|
writes(stub).map((r) => `${r.method} ${r.path}`),
|
||||||
|
[`POST /api/v1/repos/${REPO}/issues/${INDEX}/stopwatch/stop`],
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('--stop 在錶本來就沒在跑時不算失敗,並說明這一步略過了', async (t) => {
|
||||||
|
const stub = await withStub(t);
|
||||||
|
|
||||||
|
const { code, json } = await run(['--stop'], stub);
|
||||||
|
|
||||||
|
assert.equal(code, 0, '這一步多半排在回報之前,報成失敗會讓人以為前面那件事沒做成');
|
||||||
|
assert.equal(json.data.碼錶已停, false);
|
||||||
|
assert.match(json.data.note, /沒在/);
|
||||||
|
assert.deepEqual(writes(stub), []);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('--stop 不碰別顆議題上的錶:錶在別顆時什麼都不停', async (t) => {
|
||||||
|
const stub = await withStub(t, {}, { stopwatches: [stopwatchOn(7)] });
|
||||||
|
|
||||||
|
const { code, json } = await run(['--stop'], stub);
|
||||||
|
|
||||||
|
assert.equal(code, 0);
|
||||||
|
assert.equal(json.data.碼錶已停, false);
|
||||||
|
assert.deepEqual(writes(stub), [], '靜默替人結算別顆議題,正是領取鎖那條規則要擋的事');
|
||||||
|
});
|
||||||
|
|
||||||
|
test('--stop 的 --dry-run 印出將發出的停錶,且不真的停', async (t) => {
|
||||||
|
const stub = await withStub(t, {}, { stopwatches: [stopwatchOn(INDEX)] });
|
||||||
|
|
||||||
|
const { code, json } = await run(['--stop', '--dry-run'], stub);
|
||||||
|
|
||||||
|
assert.equal(code, 0);
|
||||||
|
assert.equal(json.data.dryRun, true);
|
||||||
|
assert.deepEqual(
|
||||||
|
json.data.requests.map((r) => `${r.method} ${r.path}`),
|
||||||
|
[`POST /repos/${REPO}/issues/${INDEX}/stopwatch/stop`],
|
||||||
|
);
|
||||||
|
assert.deepEqual(writes(stub), []);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('--stop 認得站台把「沒有錶在跑」回成 409 或 500 的兩種寫法', async (t) => {
|
||||||
|
for (const status of [409, 500]) {
|
||||||
|
const stub = await withStubGitea(
|
||||||
|
t,
|
||||||
|
routes(
|
||||||
|
{
|
||||||
|
[`POST /api/v1/repos/${REPO}/issues/${INDEX}/stopwatch/stop`]: {
|
||||||
|
status,
|
||||||
|
body: { message: 'cannot stop non existent stopwatch' },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{ stopwatches: [stopwatchOn(INDEX)] },
|
||||||
|
),
|
||||||
|
);
|
||||||
|
|
||||||
|
const { code, json } = await run(['--stop'], stub);
|
||||||
|
|
||||||
|
assert.equal(code, 0, `${status} 若說的是碼錶,就不是真的伺服器錯誤`);
|
||||||
|
assert.equal(json.data.碼錶已停, false);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test('--stop 遇到真的伺服器錯誤時照樣失敗,不吞掉', async (t) => {
|
||||||
|
const stub = await withStub(
|
||||||
|
t,
|
||||||
|
{
|
||||||
|
[`POST /api/v1/repos/${REPO}/issues/${INDEX}/stopwatch/stop`]: {
|
||||||
|
status: 500,
|
||||||
|
body: { message: 'database is on fire' },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{ stopwatches: [stopwatchOn(INDEX)] },
|
||||||
|
);
|
||||||
|
|
||||||
|
const { code, json } = await run(['--stop'], stub);
|
||||||
|
|
||||||
|
assert.equal(code, 1);
|
||||||
|
assert.equal(json.error.code, 'HTTP_ERROR');
|
||||||
|
});
|
||||||
|
|||||||
Reference in New Issue
Block a user