@magpie-community/opencode-workbuddy-auth 0.1.48 → 0.2.1

package/README.md

@@ -61,6 +61,19 @@ as WorkBuddy's own client sends them; without them WorkBuddy answers as the
 personal account, with the personal plan's models. A browser sign-in made
 before 0.1.13 has no enterprise id kept: sign in again.
 
+Which account a browser sign-in gives is chosen on WorkBuddy's own sign-in
+page. After a phone sign-in it lists the person's accounts (personal, a
+team, 「WorkBuddy 教育公益版」…) and binds the one picked to the sign-in, so
+to add an education or team account, pick it there. Its account is named
+with the enterprise too (`nickname · enterprise name`, or the end of the
+enterprise id when WorkBuddy names none): one person's personal and
+enterprise accounts share the uid and the nickname, and magpie keeps one
+account per name and uid, so before 0.2.1 signing in to the enterprise
+account replaced the personal one. An enterprise account signed in before
+0.2.1 keeps its old name until its Sign in again, which renames it in
+place; its free-model window, read from usage rows kept under the old
+name, starts again from the new one.
+
 Desktop's sign-in is refreshed only when the app hasn't refreshed it
 itself, and the new token is kept in memory, never written back, as magpie's
 built-in WorkBuddy does.
@@ -397,11 +410,30 @@ entry. An already signed-in browser can simply renew another saved account.
 
 ## Not here
 
-magpie's built-in WorkBuddy does more than this package:
-- the daily check-in;
-- the credits meter (`/billing/meter/get-user-resource-summary`);
-- several accounts under one provider.
+magpie's built-in WorkBuddy does more than this package: several accounts
+under one provider.
 
 OpenCode's plugin API has no place for these.
 
 Credit multipliers accept the international catalog's `x0.34 credits` text as well as `x0.34`. An empty credits value (for example Auto) stays unknown, never free.
+
+## Daily check-in
+
+The account's daily credits are claimed through the billing meter. magpie
+can run it once a day per account when its WorkBuddy check-in switch is on;
+Settings → Usage → Plugins has that switch and a *Check in now* button.
+The activity status is read first: inactive is `inactive`, a day already
+checked in is `done`, and only an active unchecked day is claimed. A claim
+that WorkBuddy answers 1001, 1002 or 1003 is `done`, `ineligible` or
+`inactive`. A claim turned away 401 while the account's credits still read
+is `ineligible`: that check-in takes WorkBuddy's own app. A transient
+billing failure is retried twice before the card shows the failure.
+Only WorkBuddy (China) checks in: the AI build has no claim endpoint, and
+its plugin carries no check-in hook.
+A request that gets no answer at all leaves the hook as a thrown error, so
+magpie retries it on its 1-minute offline backoff rather than the 30-minute
+one it gives a failed answer (#149).
+
+An `inactive` answer is kept for the whole Beijing day: the plugin host
+gives it no recheck, and a manual refresh reads the kept one (tracked in
+[yetone/magpie#2696](https://github.com/yetone/magpie/issues/2696)).

package/index.mjs

@@ -415,16 +415,26 @@ function enterpriseHeaders(a) {
   return id ? { "X-Enterprise-Id": id, "X-Tenant-Id": id } : {}
 }
 
-// enterpriseOf is the enterprise the account a sign-in gave belongs to:
-// the one /login/account names, else, for an account that isn't personal,
-// the one WorkBuddy's account list has for it — the same choice WorkBuddy's
-// own client makes (mergeCurrentAccountDetails): the uid's only entry of that
-// type, or the only one it last signed in to. None found is personal.
+// enterpriseOf is the enterprise the account a sign-in gave belongs to,
+// { id, name }: the one /login/account names, else, for an account that
+// isn't personal, the one WorkBuddy's account list has for it — the same
+// choice WorkBuddy's own client makes (mergeCurrentAccountDetails): the
+// uid's only entry of that type, or the only one it last signed in to. None
+// found is personal ({ id: "" }).
+//
+// Which account that is was chosen on WorkBuddy's sign-in page: after a
+// phone sign-in it lists the person's accounts (personal, a team,
+// 「WorkBuddy 教育公益版」…) and binds the one picked to the sign-in's state
+// (POST /console/login/enterprise/<id>?state=…), so the token and
+// /login/account this plugin reads by that state are the chosen account's.
 async function enterpriseOf(site, a, who) {
+  const name = (x) => (typeof x?.enterpriseName === "string" ? x.enterpriseName.trim() : "")
   const own = typeof who?.enterpriseId === "string" ? who.enterpriseId.trim() : ""
-  if (own) return own
   const type = String(who?.type ?? "").trim().toLowerCase()
-  if (!type || type === "personal") return ""
+  if (!own && (!type || type === "personal")) return { id: "", name: "" }
+  // a name /login/account leaves out is the account list's, as the
+  // client merges the two
+  if (own && name(who)) return { id: own, name: name(who) }
   let list
   try {
     list = await call(site, "GET", "/v2/plugin/accounts", {
@@ -432,13 +442,29 @@ async function enterpriseOf(site, a, who) {
       "X-Domain": domainOf(site, a),
     })
   } catch {
-    return ""
+    return { id: own, name: "" }
   }
   const mine = (list?.accounts ?? []).filter((x) => x?.uid === who.uid && typeof x.enterpriseId === "string" && x.enterpriseId.trim())
+  if (own) return { id: own, name: name(mine.find((x) => x.enterpriseId.trim() === own)) }
   const same = mine.filter((x) => String(x.type ?? "").trim().toLowerCase() === type)
   const last = mine.filter((x) => x.lastLogin)
   const pick = same.length === 1 ? same[0] : last.length === 1 ? last[0] : mine.length === 1 ? mine[0] : undefined
-  return pick ? pick.enterpriseId.trim() : ""
+  return pick ? { id: pick.enterpriseId.trim(), name: name(pick) } : { id: "", name: "" }
+}
+
+// accountName is what magpie lists an account a sign-in gave as: the
+// person's name, and for an enterprise (team, education) account the
+// enterprise's too. One person's personal account and their enterprise one
+// share the uid and the nickname, and magpie's plugin host keeps one
+// account per name and uid (settle in host.js): named alike, signing in to
+// 「WorkBuddy 教育公益版」 took the place of the same person's personal
+// account, and the two could never be in one pool. An enterprise WorkBuddy
+// names no name for is told by the end of its id.
+function accountName(who, ent) {
+  const person = who?.nickname || who?.phoneNumber || who?.uid || ""
+  if (!ent?.id) return person
+  const team = ent.name || `enterprise ${ent.id.slice(-6)}`
+  return person ? `${person} · ${team}` : team
 }
 
 // WorkBuddy's own client names each chat to its gateway four ways: the
@@ -1541,8 +1567,9 @@ async function browserSignIn(site) {
           "X-No-Enterprise-Id": "true",
         }, [12151], deadline)
         a.uid = who.uid ?? ""
-        a.enterpriseId = await enterpriseOf(site, a, who)
-        return success(site, a, who.nickname || who.phoneNumber || who.uid)
+        const ent = await enterpriseOf(site, a, who)
+        a.enterpriseId = ent.id
+        return success(site, a, accountName(who, ent))
       } catch (e) {
         return { type: "failed", error: e.message }
       }
@@ -1868,23 +1895,99 @@ function signedOut(site, a, why, expired, note) {
 // the same: WorkBuddy's message, else its code, else the HTTP status.
 async function meter(site, a, path, body = {}) {
   const res = await meterAsked(site, a, path, body)
+  const raw = await res.text()
   let env = {}
+  let parsed = true
   try {
-    env = JSON.parse(await res.text()) ?? {}
-  } catch {}
+    env = JSON.parse(raw) ?? {}
+  } catch {
+    parsed = false
+  }
+  if (res.ok && !parsed) {
+    const unreadable = raw.trim().slice(0, 120) || "(empty)"
+    throw Object.assign(new Error(`unreadable reply ${unreadable}`), { status: res.status, code: 0, unreadable: true })
+  }
   const code = Number.parseInt(env.code, 10) || 0
+  // the status, the code and whether the token itself was refused go with
+  // it, for usage's one renewal on a 401 (reissued) and check-in's outcomes
+  const said = { status: res.status, code }
+  if (!res.ok) said.invalidToken = invalidToken(res)
+  const err = (message) => Object.assign(new Error(message), said)
   if (!res.ok) {
-    // the status and whether the token itself was refused go with it, for
-    // usage's one renewal on a 401 (reissued)
-    const said = { status: res.status, invalidToken: invalidToken(res) }
-    if (code) throw Object.assign(new Error(env.msg || `error ${code}`), said)
-    if (env.msg) throw Object.assign(new Error(env.msg), said)
-    throw Object.assign(new Error(statusText(res.status)), said)
-  }
-  if (code) throw new Error(env.msg || `error ${code}`)
+    if (code) throw err(env.msg || `error ${code}`)
+    if (env.msg) throw err(env.msg)
+    throw err(statusText(res.status))
+  }
+  if (code) throw err(env.msg || `error ${code}`)
   return env.data ?? null
 }
 
+// checkinOf claims the account's daily credits. China has the /v2 meter;
+// after the activity status names an active, unchecked day. Transient
+// upstream failures are asked again twice (the bounded retry quota-hub
+// observed on the billing endpoint; callers may shorten the waits for a
+// test).
+async function checkinOf(site, a, { waits = [0, 0] } = {}) {
+  let status
+  try {
+    status = await meter(site, a, "/v2/billing/meter/checkin-activity-status")
+  } catch (e) {
+    if (e?.code === 1001) return { outcome: "done" }
+    // a reply WorkBuddy sent is the day's failed answer; only a request
+    // that got no answer leaves as a throw, for magpie's offline backoff
+    if (e?.status !== undefined || e?.code !== undefined) return { outcome: "failed", message: e.message }
+    throw e
+  }
+  if (!status?.active) return { outcome: "inactive" }
+  if (status.today_checked_in ?? status.todayCheckedIn) {
+    // today_credit is what today actually gave, the built-in's word for a
+    // day already in; daily_credit is the day's grant
+    const credit = Number(status.today_credit ?? status.daily_credit)
+    return { outcome: "done", ...(Number.isFinite(credit) && credit > 0 ? { credit } : {}) }
+  }
+  const paths = ["/v2/billing/meter/daily-checkin"]
+  for (let attempt = 0; ; attempt++) {
+    let i = 0
+    while (i < paths.length) {
+      try {
+        const got = await meter(site, a, paths[i++])
+        // the claim's own answer, as the built-in hands it on: the credit
+        // and streak it granted and what it said, for the card
+        const credit = Number(got?.credit)
+        const streak = Number(got?.streak_days)
+        return {
+          outcome: "claimed",
+          ...(Number.isFinite(credit) && credit > 0 ? { credit } : {}),
+          ...(Number.isFinite(streak) && streak > 0 ? { streak } : {}),
+          ...(got?.message ? { message: String(got.message) } : {}),
+        }
+      } catch (e) {
+        if (e?.code === 1001) return { outcome: "done" }
+        if (e?.code === 1002) return { outcome: "ineligible", message: e.message }
+        if (e?.code === 1003) return { outcome: "inactive", message: e.message }
+        if (e?.status === 401) {
+          try {
+            await meter(site, a, "/billing/meter/get-user-resource-summary")
+          } catch {
+            throw e
+          }
+          return { outcome: "ineligible", message: "WorkBuddy's check-in takes WorkBuddy's own app" }
+        }
+        if (e?.unreadable) return { outcome: "failed", message: `check-in: ${e.message}` }
+        const transient = e?.status >= 500 || e?.code === 10000
+        if (transient && attempt < waits.length) {
+          await new Promise((r) => setTimeout(r, waits[attempt]))
+          break
+        }
+        // a reply WorkBuddy sent is the day's failed answer; only a request
+        // that got no answer leaves as a throw, for magpie's offline backoff
+        if (e?.status !== undefined || e?.code !== undefined) return { outcome: "failed", message: e.message }
+        throw e
+      }
+    }
+  }
+}
+
 // capacity is a capacity the billing API sends, as a string ("438.88")
 // or now and then a number; empty is 0.
 function capacity(v) {
@@ -3036,6 +3139,25 @@ function makePlugin(site) {
       // and is renewed as before.
       refreshLead: LEAD_MS,
       refresh: (auth) => refreshed(site, auth),
+      // the account's daily check-in: magpie can run it once a day per
+      // account, when its WorkBuddy check-in switch is on; the button in
+      // Settings asks right away. China's meter only: the AI build has no
+      // check-in (#47), so the hook stays off its plugin. Errors leave as
+      // throws, not as failed answers: host.js answers a throwing hook to
+      // magpie as an error, whose wbCheckinFailed keeps the offline words
+      // and magpie's 1-minute backoff, where a returned failed waits the
+      // full 30 minutes (magpie-community/plugins#149). checkinOf returns
+      // an outcome only for answers it read and classified.
+      ...(site.ai ? {} : {
+        async checkin(getAuth) {
+          const auth = await getAuth()
+          // an API key reads no credits (see usage), so it has no day to claim
+          if (auth?.type === "api") return { outcome: "ineligible", message: "check-in needs a signed-in account, not an API key" }
+          if (auth?.type !== "oauth" || !(auth.access || auth.source)) return { outcome: "failed", message: "not signed in" }
+          const a = await current(site, client, auth)
+          return await checkinOf(site, a, { waits: [2000, 4000] })
+        },
+      }),
       options: [
         {
           key: FREE_ONLY,
@@ -3409,4 +3531,4 @@ export const WorkBuddyAuthPlugin = makePlugin(SITES.workbuddy)
 export const WorkBuddyAIAuthPlugin = makePlugin(SITES["workbuddy-ai"])
 
 // for tests
-export const _internal = { idFor, replyAfterToolsOn, withDefaultEffort, defaultEffortOf, gzipped, FREE_ONLY, PRICE_TTL, keyAccount, remoteConfig, cycleOf, typeUnions, systemAsUser, systemKey, DEFAULT_SYSTEM, EDGE_READS, fitShape, replyAfterTools, AFTER_TOOLS_REFUSED, enterpriseUsageOf, notDesktop, textOnly, runsOutOf, packagesOf, endOf, enterpriseHeaders, enterpriseOf, liveModels, browserSignIn, withSystem, asReasoning, normalizeToolChoice, fitTools, fitted, renamed, unflagged, usageOf, desktopHeld, explained, REFUSED_HINT, RESTRICTED_HINT, EXHAUSTED_HINT, freeCredits, creditsOf, priceOf, fresh, SITES, renewing, renewed, SESSION, attend, scopeOf, turnKey, conversationKey, signatureOf, isMessages, withoutUnsigned, withoutSignedThinking, prepared, answeredBefore, nativeOf, modelOf, configModels, freeWindowOf, tokensShort, freeWindowRows, freeWindowLedger, readLedgerTail, pinned, rowTime, rowAccount, ofAccount, windowOffset, windowReset, FREE_WINDOW_MODELS, FREE_WINDOW_SPAN, FREE_WINDOW_GAP, FREE_WINDOW_LEAD, API_MESSAGES: NPM_MESSAGES, API_CHAT: NPM }
+export const _internal = { idFor, replyAfterToolsOn, withDefaultEffort, defaultEffortOf, gzipped, FREE_ONLY, PRICE_TTL, keyAccount, remoteConfig, cycleOf, typeUnions, systemAsUser, systemKey, DEFAULT_SYSTEM, EDGE_READS, fitShape, replyAfterTools, AFTER_TOOLS_REFUSED, enterpriseUsageOf, accountName, notDesktop, textOnly, runsOutOf, packagesOf, endOf, enterpriseHeaders, enterpriseOf, liveModels, browserSignIn, withSystem, asReasoning, normalizeToolChoice, fitTools, fitted, renamed, unflagged, usageOf, desktopHeld, explained, REFUSED_HINT, RESTRICTED_HINT, EXHAUSTED_HINT, freeCredits, creditsOf, priceOf, fresh, SITES, renewing, renewed, SESSION, attend, scopeOf, turnKey, conversationKey, signatureOf, isMessages, withoutUnsigned, withoutSignedThinking, prepared, answeredBefore, nativeOf, modelOf, configModels, freeWindowOf, tokensShort, freeWindowRows, freeWindowLedger, readLedgerTail, pinned, rowTime, rowAccount, ofAccount, windowOffset, windowReset, FREE_WINDOW_MODELS, FREE_WINDOW_SPAN, FREE_WINDOW_GAP, FREE_WINDOW_LEAD, checkinOf, API_MESSAGES: NPM_MESSAGES, API_CHAT: NPM }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magpie-community/opencode-workbuddy-auth",
-  "version": "0.1.48",
+  "version": "0.2.1",
   "description": "OpenCode provider plugins for WorkBuddy's plans: WorkBuddy (CodeBuddy, copilot.tencent.com) and WorkBuddy AI (www.workbuddy.ai)",
   "type": "module",
   "main": "./index.mjs",