backeer-opencode 0.1.5 → 0.2.1

package/src/config.js

@@ -7,6 +7,50 @@ import { enabled } from "./utilities.js"
 
 const DEFAULT_ORIGIN = "https://external-gateway.backeer.com"
 
+function integer(value, fallback, { minimum = 0, maximum = 86_400 } = {}) {
+  if (value === undefined || value === null || value === "") return fallback
+  const parsed = Number(value)
+  if (!Number.isInteger(parsed) || parsed < minimum || parsed > maximum) {
+    throw new Error(`Expected an integer between ${minimum} and ${maximum}`)
+  }
+  return parsed
+}
+
+function loadLifecycleConfig(option) {
+  const values = option && typeof option === "object" ? option : {}
+  const masterValue = typeof option === "boolean"
+    ? option
+    : values.enabled ?? process.env.BACKEER_NOTIFY_LIFECYCLE
+  const masterEnabled = enabled(masterValue)
+
+  return {
+    enabled: masterEnabled,
+    completed: masterEnabled && enabled(
+      values.completed ?? process.env.BACKEER_NOTIFY_SESSION_COMPLETED,
+    ),
+    errors: masterEnabled && enabled(
+      values.errors ?? process.env.BACKEER_NOTIFY_SESSION_ERRORS,
+    ),
+    retries: masterEnabled && enabled(
+      values.retries ?? process.env.BACKEER_NOTIFY_SESSION_RETRIES,
+    ),
+    updates: masterEnabled && enabled(
+      values.updates ?? process.env.BACKEER_NOTIFY_OPENCODE_UPDATES,
+    ),
+    completionMinSeconds: integer(
+      values.completionMinSeconds ??
+        process.env.BACKEER_SESSION_COMPLETION_MIN_SECONDS,
+      0,
+    ),
+    retryAttemptThreshold: integer(
+      values.retryAttemptThreshold ??
+        process.env.BACKEER_RETRY_ATTEMPT_THRESHOLD,
+      3,
+      { minimum: 1, maximum: 100 },
+    ),
+  }
+}
+
 function defaultConfigDirectory() {
   const base = process.env.XDG_CONFIG_HOME?.trim()
   return base ? join(base, "opencode") : join(homedir(), ".config", "opencode")
@@ -41,6 +85,7 @@ export function loadConfig(options = {}) {
   return {
     origin,
     eventsEndpoint: new URL("/v1/events", origin),
+    sourceHealthEndpoint: new URL("/v1/source/health", origin),
     commandStreamEndpoint: new URL("/v1/commands/stream", origin),
     token: loadedToken.token,
     tokenSource: loadedToken.source,
@@ -52,6 +97,7 @@ export function loadConfig(options = {}) {
       options.questions ?? process.env.BACKEER_NOTIFY_QUESTIONS,
     ),
     todos: enabled(options.todos ?? process.env.BACKEER_NOTIFY_TODOS),
+    lifecycle: loadLifecycleConfig(options.lifecycle),
     logLevel: normalizeLogLevel(
       options.logLevel ?? process.env.BACKEER_LOG_LEVEL,
     ),

package/src/diagnostics.js

@@ -0,0 +1,148 @@
+import { randomUUID } from "node:crypto"
+import { statSync } from "node:fs"
+
+import { HttpError, postJsonWithRetry } from "./http.js"
+import { PLUGIN_VERSION } from "./updates.js"
+import { limit } from "./utilities.js"
+
+const PASS = "✓"
+const FAIL = "×"
+const INFO = "•"
+
+function tokenFileCheck(config) {
+  if (config.tokenSource === "environment") {
+    return { ok: true, text: "Token loaded from the environment; token file not required" }
+  }
+  try {
+    const stats = statSync(config.tokenFile)
+    const mode = stats.mode & 0o777
+    if (!stats.isFile()) return { ok: false, text: "Token path is not a regular file" }
+    if ((mode & 0o077) !== 0) {
+      return {
+        ok: false,
+        text: `Token file mode ${(mode).toString(8).padStart(3, "0")} is too permissive; expected 600`,
+      }
+    }
+    return {
+      ok: true,
+      text: `Token file is protected (mode ${mode.toString(8).padStart(3, "0")})`,
+    }
+  } catch {
+    return { ok: false, text: "Token file is missing or unreadable" }
+  }
+}
+
+async function probeSource(config, fetchImplementation = globalThis.fetch) {
+  const controller = new AbortController()
+  const timeout = setTimeout(() => controller.abort(), 5000)
+  try {
+    const response = await fetchImplementation(config.sourceHealthEndpoint, {
+      method: "GET",
+      headers: { Authorization: `Bearer ${config.token}` },
+      signal: controller.signal,
+    })
+    const responseBody = limit(await response.text(), 2000)
+    if (!response.ok) {
+      throw new HttpError(
+        `Gateway source check failed with status ${response.status}`,
+        response.status,
+        responseBody,
+      )
+    }
+    try {
+      return JSON.parse(responseBody)
+    } catch {
+      throw new Error("Gateway source check returned malformed JSON")
+    }
+  } finally {
+    clearTimeout(timeout)
+  }
+}
+
+export async function buildDoctorReport(
+  config,
+  { fetchImplementation = globalThis.fetch } = {},
+) {
+  const checks = []
+  checks.push({ ok: true, text: `Plugin version ${PLUGIN_VERSION}` })
+  checks.push({
+    ok: config.origin.protocol === "https:",
+    text: `Gateway uses ${config.origin.protocol === "https:" ? "HTTPS" : "an insecure protocol"}: ${config.origin.origin}`,
+  })
+  checks.push({
+    ok: Boolean(config.token),
+    text: config.token
+      ? `Source token loaded from ${config.tokenSource}`
+      : "Source token is missing",
+  })
+  checks.push(tokenFileCheck(config))
+
+  let source
+  if (config.token) {
+    try {
+      const result = await probeSource(config, fetchImplementation)
+      source = result?.source
+      checks.push({
+        ok: result?.ok === true && typeof source?.id === "string",
+        text: source?.id
+          ? `Source authentication accepted: ${source.name || source.id} (${source.id})`
+          : "Gateway did not return a source identity",
+      })
+      checks.push({
+        ok: result?.capabilities?.events === true &&
+          result?.capabilities?.commands === true,
+        text: result?.capabilities?.events === true &&
+          result?.capabilities?.commands === true
+          ? "Event ingest and command stream are available"
+          : "Event ingest or command stream is unavailable",
+      })
+      checks.push({
+        ok: result?.capabilities?.apns === true,
+        text: result?.capabilities?.apns === true
+          ? "Gateway APNs delivery is enabled"
+          : "Gateway APNs delivery is disabled",
+      })
+    } catch (error) {
+      const detail = error instanceof HttpError && error.status === 401
+        ? "Source authentication rejected (HTTP 401)"
+        : error?.name === "AbortError"
+          ? "Gateway source check timed out"
+          : `Gateway source check failed: ${limit(error?.message || error, 300)}`
+      checks.push({ ok: false, text: detail })
+    }
+  }
+
+  const healthy = checks.every((check) => check.ok)
+  return [
+    "## Backeer doctor",
+    "",
+    ...checks.map((check) => `${check.ok ? PASS : FAIL} ${check.text}`),
+    "",
+    healthy
+      ? `${PASS} Result: healthy. Use \`/backeer test\` to verify phone delivery.`
+      : `${FAIL} Result: issues found. Resolve failed checks and run \`/backeer doctor\` again.`,
+    "",
+    `${INFO} No event was created and the token value was not displayed.`,
+  ].join("\n")
+}
+
+export async function publishTestNotification(config, reporter) {
+  if (!config.token) throw new Error("Backeer source token is missing")
+  const testID = randomUUID()
+  const result = await postJsonWithRetry(config, config.eventsEndpoint, {
+    type: "application",
+    severity: "info",
+    title: "Backeer test notification",
+    body: "OpenCode integration is connected and push delivery is working.",
+    payload: [
+      { key: "Plugin version", value: PLUGIN_VERSION },
+      { key: "Test ID", value: testID },
+    ],
+    externalId: `opencode:test:${testID}`,
+    timestamp: new Date().toISOString(),
+    notify: true,
+    direction: "in",
+  })
+  reporter.success("Test notification sent", `HTTP ${result.status}`)
+  return testID
+}

package/src/lifecycle-controller.js

@@ -0,0 +1,205 @@
+import {
+  errorCorrelation,
+  publishOpenCodeUpdate,
+  publishSessionCompleted,
+  publishSessionError,
+  publishSessionRetry,
+} from "./lifecycle-publishers.js"
+import { limit, rememberBounded, stableHash } from "./utilities.js"
+
+const QUESTION_EVENTS = new Set(["question.asked", "question.v2.asked"])
+const QUESTION_REPLY_EVENTS = new Set([
+  "question.replied",
+  "question.v2.replied",
+  "question.answered",
+  "question.v2.answered",
+])
+
+export function createLifecycleController({
+  config,
+  reporter,
+  client,
+  directory,
+  now = () => Date.now(),
+  publishers = {},
+}) {
+  const sendCompleted = publishers.completed ?? publishSessionCompleted
+  const sendError = publishers.error ?? publishSessionError
+  const sendRetry = publishers.retry ?? publishSessionRetry
+  const sendUpdate = publishers.update ?? publishOpenCodeUpdate
+  const sessions = new Map()
+  const publishedUpdates = new Map()
+
+  function sessionState(sessionID) {
+    let state = sessions.get(sessionID)
+    if (!state) {
+      state = {
+        busy: false,
+        busySince: 0,
+        failed: false,
+        retryNotified: false,
+        waiting: false,
+        lastAssistant: undefined,
+        completedMessageID: "",
+      }
+      rememberBounded(sessions, sessionID, state)
+    }
+    return state
+  }
+
+  function dispatch(label, operation) {
+    void Promise.resolve(operation).catch((error) => reporter.error(label, error))
+  }
+
+  function beginCycle(state) {
+    if (state.busy) return
+    state.busy = true
+    state.busySince = now()
+    state.failed = false
+    state.retryNotified = false
+    state.waiting = false
+    state.lastAssistant = undefined
+  }
+
+  function finishCycle(sessionID, state) {
+    if (!state.busy) return
+    state.busy = false
+    const assistant = state.lastAssistant
+    const durationMs = Math.max(0, now() - state.busySince)
+    const qualifies = assistant?.id && assistant.completed && !assistant.error &&
+      !state.failed && !state.waiting &&
+      durationMs >= config.lifecycle.completionMinSeconds * 1000 &&
+      state.completedMessageID !== assistant.id
+    if (!qualifies || !config.lifecycle.completed) return
+
+    state.completedMessageID = assistant.id
+    dispatch(
+      "Task completion could not be sent",
+      sendCompleted({
+        config,
+        reporter,
+        client,
+        directory,
+        sessionID,
+        messageID: limit(assistant.id, 200),
+        durationMs,
+      }),
+    )
+  }
+
+  function handleMessage(event) {
+    const info = event.properties?.info
+    if (info?.role !== "assistant" || typeof info.sessionID !== "string") return
+    const state = sessionState(info.sessionID)
+    state.lastAssistant = {
+      id: typeof info.id === "string" ? info.id : "",
+      completed: Number.isFinite(info.time?.completed),
+      error: Boolean(info.error),
+    }
+    if (info.error) state.failed = true
+  }
+
+  function handleStatus(event) {
+    const sessionID = event.properties?.sessionID
+    const status = event.properties?.status
+    if (typeof sessionID !== "string" || typeof status?.type !== "string") return
+    const state = sessionState(sessionID)
+
+    if (status.type === "busy") {
+      beginCycle(state)
+      return
+    }
+    if (status.type === "idle") {
+      finishCycle(sessionID, state)
+      return
+    }
+    if (status.type !== "retry") return
+
+    beginCycle(state)
+    if (!config.lifecycle.retries || state.retryNotified) return
+    if (!Number.isInteger(status.attempt) ||
+        status.attempt < config.lifecycle.retryAttemptThreshold) return
+
+    state.retryNotified = true
+    const correlation = state.lastAssistant?.id || stableHash(
+      `${status.attempt}:${Number.isFinite(status.next) ? status.next : "unknown"}`,
+    )
+    dispatch(
+      "Retry warning could not be sent",
+      sendRetry({
+        config,
+        reporter,
+        client,
+        directory,
+        sessionID,
+        correlation: limit(correlation, 200),
+        attempt: status.attempt,
+        next: status.next,
+      }),
+    )
+  }
+
+  function handleError(event) {
+    const sessionID = typeof event.properties?.sessionID === "string"
+      ? event.properties.sessionID
+      : ""
+    const state = sessionID ? sessionState(sessionID) : undefined
+    if (state) state.failed = true
+    if (!config.lifecycle.errors) return
+
+    dispatch(
+      "Task failure could not be sent",
+      sendError({
+        config,
+        reporter,
+        client,
+        directory,
+        sessionID,
+        correlation: errorCorrelation(event, state),
+        error: event.properties?.error,
+      }),
+    )
+  }
+
+  function handleWaiting(event, waiting) {
+    const sessionID = event.properties?.sessionID
+    if (typeof sessionID !== "string") return
+    sessionState(sessionID).waiting = waiting
+  }
+
+  return {
+    handle(event) {
+      if (!config.lifecycle.enabled || !event?.type) return
+
+      if (event.type === "message.updated") {
+        handleMessage(event)
+      } else if (event.type === "session.status") {
+        handleStatus(event)
+      } else if (event.type === "session.idle") {
+        const sessionID = event.properties?.sessionID
+        if (typeof sessionID === "string") finishCycle(sessionID, sessionState(sessionID))
+      } else if (event.type === "session.error") {
+        handleError(event)
+      } else if (event.type === "permission.asked" || QUESTION_EVENTS.has(event.type)) {
+        handleWaiting(event, true)
+      } else if (event.type === "permission.replied" || QUESTION_REPLY_EVENTS.has(event.type)) {
+        handleWaiting(event, false)
+      } else if (event.type === "installation.update-available" &&
+          config.lifecycle.updates) {
+        const version = event.properties?.version
+        if (typeof version !== "string" || !version.trim()) return
+        if (publishedUpdates.has(version)) return
+        rememberBounded(publishedUpdates, version, true)
+        dispatch(
+          "OpenCode update could not be sent",
+          sendUpdate({ config, reporter, version: version.trim() }),
+        )
+      }
+    },
+
+    dispose() {
+      sessions.clear()
+      publishedUpdates.clear()
+    },
+  }
+}

package/src/lifecycle-publishers.js

@@ -0,0 +1,187 @@
+import { postJsonWithRetry } from "./http.js"
+import { limit, stableHash } from "./utilities.js"
+
+const CONTROL_CHARACTERS = /[\u0000-\u0008\u000b\u000c\u000e-\u001f\u007f]/g
+const SECRET_ASSIGNMENT = /\b(token|secret|password|api[-_ ]?key)\s*[:=]\s*[^\s,;]+/gi
+const BEARER_TOKEN = /\bBearer\s+[^\s,;]+/gi
+const URL_WITH_QUERY = /\bhttps?:\/\/[^\s?#]+(?:\?[^\s#]*)?(?:#[^\s]*)?/gi
+const WINDOWS_PATH = /\b[A-Za-z]:\\(?:[^\\\s]+\\)+[^\s]*/g
+const POSIX_PATH = /(^|\s)\/(?:[^/\s]+\/)+[^\s]*/g
+
+export function sanitizeErrorMessage(value) {
+  return limit(value, 2000)
+    .replace(CONTROL_CHARACTERS, " ")
+    .replace(BEARER_TOKEN, "Bearer [redacted]")
+    .replace(SECRET_ASSIGNMENT, "$1=[redacted]")
+    .replace(URL_WITH_QUERY, (value) => {
+      try {
+        const url = new URL(value)
+        return `${url.origin}${url.pathname}`
+      } catch {
+        return "[url redacted]"
+      }
+    })
+    .replace(WINDOWS_PATH, "[path redacted]")
+    .replace(POSIX_PATH, "$1[path redacted]")
+    .replace(/\s+/g, " ")
+    .trim()
+    .slice(0, 500)
+}
+
+export function safeErrorDetails(error) {
+  const name = limit(error?.name || "OpenCodeError", 100)
+  const message = sanitizeErrorMessage(error?.data?.message ?? error?.message)
+  const statusCode = Number.isInteger(error?.data?.statusCode)
+    ? String(error.data.statusCode)
+    : ""
+  return { name, message, statusCode }
+}
+
+async function resolveSessionTitle(client, directory, sessionID, reporter) {
+  if (!sessionID || typeof client?.session?.get !== "function") return ""
+
+  try {
+    const result = await client.session.get({
+      path: { id: sessionID },
+      query: { directory },
+      throwOnError: true,
+    })
+    return limit((result?.data ?? result)?.title)
+  } catch (error) {
+    reporter.debug("Session title unavailable", error)
+    return ""
+  }
+}
+
+async function publish(config, reporter, event, feedback) {
+  const result = await postJsonWithRetry(config, config.eventsEndpoint, {
+    type: "application",
+    timestamp: new Date().toISOString(),
+    notify: true,
+    direction: "in",
+    ...event,
+  })
+  reporter.success(feedback, `HTTP ${result.status}`)
+}
+
+function secondsLabel(durationMs) {
+  const seconds = Math.max(0, Math.round(durationMs / 1000))
+  if (seconds < 60) return `${seconds}s`
+  const minutes = Math.floor(seconds / 60)
+  const remainder = seconds % 60
+  return remainder ? `${minutes}m ${remainder}s` : `${minutes}m`
+}
+
+export async function publishSessionCompleted({
+  config,
+  reporter,
+  client,
+  directory,
+  sessionID,
+  messageID,
+  durationMs,
+}) {
+  const sessionTitle = await resolveSessionTitle(
+    client,
+    directory,
+    sessionID,
+    reporter,
+  )
+  const duration = secondsLabel(durationMs)
+  const location = sessionTitle ? ` “${sessionTitle}”` : ""
+  await publish(config, reporter, {
+    severity: "info",
+    title: "OpenCode task completed",
+    body: `OpenCode finished${location} in ${duration}.`,
+    payload: [
+      { key: "OpenCode session", value: sessionTitle },
+      { key: "Outcome", value: "Completed" },
+      { key: "Duration", value: duration },
+    ].filter((item) => item.value),
+    externalId: `opencode:lifecycle:completed:${sessionID}:${messageID}`,
+  }, "Task completion sent")
+}
+
+export async function publishSessionRetry({
+  config,
+  reporter,
+  client,
+  directory,
+  sessionID,
+  correlation,
+  attempt,
+  next,
+}) {
+  const sessionTitle = await resolveSessionTitle(
+    client,
+    directory,
+    sessionID,
+    reporter,
+  )
+  const retryAt = Number.isFinite(next) ? new Date(next).toISOString() : ""
+  await publish(config, reporter, {
+    severity: "warning",
+    title: "OpenCode is retrying",
+    body: `OpenCode reached retry attempt ${attempt}. The operation is still running.`,
+    payload: [
+      { key: "OpenCode session", value: sessionTitle },
+      { key: "Retry attempt", value: String(attempt) },
+      { key: "Next retry", value: retryAt },
+    ].filter((item) => item.value),
+    externalId: `opencode:lifecycle:retry:${sessionID}:${correlation}`,
+  }, "Retry warning sent")
+}
+
+export async function publishSessionError({
+  config,
+  reporter,
+  client,
+  directory,
+  sessionID,
+  correlation,
+  error,
+}) {
+  const sessionTitle = await resolveSessionTitle(
+    client,
+    directory,
+    sessionID,
+    reporter,
+  )
+  const details = safeErrorDetails(error)
+  const location = sessionTitle ? ` in “${sessionTitle}”` : ""
+  const body = details.message
+    ? `OpenCode failed${location}: ${details.message}`
+    : `OpenCode failed${location}.`
+  await publish(config, reporter, {
+    // Backeer/iOS currently support info, warning and critical severities.
+    severity: "critical",
+    title: "OpenCode task failed",
+    body: limit(body, 1000),
+    payload: [
+      { key: "OpenCode session", value: sessionTitle },
+      { key: "Outcome", value: "Failed" },
+      { key: "Error type", value: details.name },
+      { key: "HTTP status", value: details.statusCode },
+      { key: "Error", value: details.message },
+    ].filter((item) => item.value),
+    externalId: `opencode:lifecycle:error:${sessionID || "global"}:${correlation}`,
+  }, "Task failure sent")
+}
+
+export async function publishOpenCodeUpdate({ config, reporter, version }) {
+  const safeVersion = limit(version, 100)
+  await publish(config, reporter, {
+    severity: "info",
+    title: "OpenCode update available",
+    body: `OpenCode ${safeVersion} is available.`,
+    payload: [{ key: "Available version", value: safeVersion }],
+    externalId: `opencode:lifecycle:update:${safeVersion}`,
+  }, "OpenCode update sent")
+}
+
+export function errorCorrelation(event, sessionState) {
+  if (typeof event?.id === "string" && event.id) return limit(event.id, 200)
+  if (sessionState?.lastAssistant?.id) return limit(sessionState.lastAssistant.id, 200)
+  const details = safeErrorDetails(event?.properties?.error)
+  return stableHash(`${details.name}:${details.statusCode}:${details.message}`)
+}

package/src/management.js

@@ -8,13 +8,14 @@ import {
 } from "node:fs"
 import { dirname, resolve } from "node:path"
 
+import { buildDoctorReport, publishTestNotification } from "./diagnostics.js"
 import {
   formatAgentUpdateInstruction,
   PLUGIN_VERSION,
 } from "./updates.js"
 
 const COMMAND_DESCRIPTION =
-  "Show Backeer status, update it, or manage its token: /backeer [status|update-check|update|token|token-file PATH]"
+  "Check, test, update, or manage Backeer: /backeer [status|doctor|test|update-check|update|token|token-file PATH]"
 
 function tokenFileState(path) {
   try {
@@ -111,6 +112,11 @@ async function buildStatus(config, permissionController, updateChecker) {
     `- Permission notifications: ${config.permissions ? "enabled" : "disabled"}`,
     `- Question notifications: ${config.questions ? "enabled" : "disabled"}`,
     `- Todo notifications: ${config.todos ? "enabled" : "disabled"}`,
+    `- Lifecycle notifications: ${config.lifecycle.enabled ? "enabled" : "disabled"}`,
+    `  - Completed sessions: ${config.lifecycle.completed ? "enabled" : "disabled"} (minimum ${config.lifecycle.completionMinSeconds}s)`,
+    `  - Session errors: ${config.lifecycle.errors ? "enabled" : "disabled"}`,
+    `  - Retry warnings: ${config.lifecycle.retries ? "enabled" : "disabled"} (attempt ${config.lifecycle.retryAttemptThreshold}+)`,
+    `  - OpenCode updates: ${config.lifecycle.updates ? "enabled" : "disabled"}`,
     `- Command stream: ${permissionStatus.stream}`,
     `- Pending permissions: ${permissionStatus.pending}`,
     `- Log level: ${config.logLevel}`,
@@ -124,6 +130,8 @@ function helpMessage() {
     "## Backeer commands",
     "",
     "- `/backeer` or `/backeer status` — show integration status",
+    "- `/backeer doctor` — diagnose config, credentials, gateway, and APNs without creating an event",
+    "- `/backeer test` — send a real test notification to the Backeer application",
     "- `/backeer update-check` — check NPM for a newer version",
     "- `/backeer update` — ask the OpenCode agent to install and verify it",
     "- `/backeer token` — show secure token-change instructions",
@@ -193,6 +201,17 @@ export function createBackeerCommandHandler({
     try {
       if (!subcommand || subcommand === "status") {
         message = await buildStatus(config, permissionController, updateChecker)
+      } else if (subcommand === "doctor") {
+        message = await buildDoctorReport(config)
+      } else if (subcommand === "test") {
+        const testID = await publishTestNotification(config, reporter)
+        message = [
+          "## Backeer test notification",
+          "",
+          "✓ The gateway accepted the test event.",
+          `- Test ID: ${testID}`,
+          "- Check the Backeer application for the notification.",
+        ].join("\n")
       } else if (subcommand === "update-check") {
         const update = await updateChecker.check({ force: true })
         message = [
@@ -233,7 +252,7 @@ export function createBackeerCommandHandler({
         message = helpMessage()
       }
     } catch (error) {
-      reporter.error("Access token could not be updated", error)
+      reporter.error("Backeer command failed", error)
       message = [
         "## Backeer command failed",
         "",