mirror of
https://github.com/larksuite/cli.git
synced 2026-07-06 00:06:28 +08:00
2bbab4d851
* refactor: extract FetchTAT sharing the TAT-rejection classifier doResolveTAT minted the tenant access token inline. Extract the HTTP call into FetchTAT(ctx, httpClient, brand, appID, appSecret) so callers that already hold plaintext credentials — notably the post-config-init probe — can validate them without a second keychain round-trip. FetchTAT routes a non-zero TAT body code through the same classifyTATResponseCode the credential layer already uses, so a rejection is the canonical CategoryConfig / SubtypeInvalidClient (10003 / 10014) typed error — identical to what every token-resolving command returns. Transport, HTTP-status and JSON-parse failures stay raw (untyped) so callers can use errs.IsTyped to separate a deterministic credential rejection from upstream noise. doResolveTAT now delegates to FetchTAT; observable behavior unchanged. * feat: validate credentials after config init After config init saves the App ID / App Secret, fire a best-effort probe: mint a tenant access token with the just-saved credentials, then POST the application probe endpoint. When the credentials are deterministically rejected, FetchTAT returns a typed errs.* error and runProbe propagates it, so config init exits non-zero with the canonical ConfigError / invalid_client envelope (the same one every other command shows for the same bad creds) instead of letting the user discover the mistake on a later request. Ambiguous failures (transport, HTTP non-200, JSON parse, timeout, http-client init) come back untyped and are swallowed (errs.IsTyped is the discriminator), so a valid configuration is never blocked by upstream noise. The probe is wired into all four init paths and skipped when the user reused an existing secret. The saved config is not rolled back on rejection: stdout still records what was saved, stderr carries the typed error envelope.
92 lines
3.3 KiB
Go
92 lines
3.3 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package config
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"fmt"
|
|
"io"
|
|
"net/http"
|
|
"time"
|
|
|
|
"github.com/larksuite/cli/errs"
|
|
"github.com/larksuite/cli/internal/build"
|
|
"github.com/larksuite/cli/internal/cmdutil"
|
|
"github.com/larksuite/cli/internal/core"
|
|
"github.com/larksuite/cli/internal/credential"
|
|
)
|
|
|
|
// probeTimeout is the total wall-clock budget for the credential probe step
|
|
// (covering both TAT acquisition and the subsequent probe request).
|
|
const probeTimeout = 3 * time.Second
|
|
|
|
// runProbe runs a best-effort credential validation after config init has
|
|
// persisted the App ID and App Secret. It returns a non-nil error only for a
|
|
// deterministic credential-rejection signal; every other outcome returns nil
|
|
// so that valid configurations and transient/upstream noise never block the
|
|
// command.
|
|
//
|
|
// The function performs up to two HTTP calls in series, bounded by
|
|
// probeTimeout:
|
|
//
|
|
// 1. A TAT request using the just-saved credentials. credential.FetchTAT
|
|
// returns a typed errs.* error (via the shared classifyTATResponseCode)
|
|
// only when the server deterministically rejected the credentials — a
|
|
// non-zero TAT body code, classified as CategoryConfig / SubtypeInvalidClient
|
|
// (10003 / 10014) or whatever codemeta maps. That typed error is propagated
|
|
// so the root dispatcher renders the canonical envelope and `config init`
|
|
// exits non-zero — identical to how every other token-resolving command
|
|
// reports the same bad credentials. Ambiguous failures (transport errors,
|
|
// HTTP non-200, JSON parse errors, timeouts) come back as raw untyped
|
|
// errors and are swallowed (return nil), so valid configurations are never
|
|
// disturbed by upstream noise. errs.IsTyped is the discriminator.
|
|
//
|
|
// 2. If TAT succeeded, a POST to the probe endpoint is fired. The outcome of
|
|
// that call (success, server error, timeout, parse failure) is always
|
|
// ignored — return nil regardless.
|
|
func runProbe(parent context.Context, factory *cmdutil.Factory, appID, appSecret string, brand core.LarkBrand) error {
|
|
if factory == nil {
|
|
return nil
|
|
}
|
|
httpClient, err := factory.HttpClient()
|
|
if err != nil {
|
|
return nil
|
|
}
|
|
|
|
ctx, cancel := context.WithTimeout(parent, probeTimeout)
|
|
defer cancel()
|
|
|
|
token, err := credential.FetchTAT(ctx, httpClient, brand, appID, appSecret)
|
|
if err != nil {
|
|
// A typed error from FetchTAT is a deterministic credential rejection
|
|
// (classifyTATResponseCode). Propagate it so config init exits with the
|
|
// same envelope the rest of the CLI uses for bad credentials. Untyped
|
|
// errors are ambiguous (transport / HTTP / parse / timeout) — stay
|
|
// silent and let the command succeed.
|
|
if errs.IsTyped(err) {
|
|
return err
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// TAT succeeded — fire the probe call. Any outcome is ignored.
|
|
url := core.ResolveEndpoints(brand).Open + "/open-apis/application/v6/larksuite_cli_app/probe"
|
|
body := []byte(fmt.Sprintf(`{"from":"lark-cli/%s"}`, build.Version))
|
|
req, err := http.NewRequestWithContext(ctx, http.MethodPost, url, bytes.NewReader(body))
|
|
if err != nil {
|
|
return nil
|
|
}
|
|
req.Header.Set("Authorization", "Bearer "+token)
|
|
req.Header.Set("Content-Type", "application/json")
|
|
|
|
resp, err := httpClient.Do(req)
|
|
if err != nil {
|
|
return nil
|
|
}
|
|
defer resp.Body.Close()
|
|
_, _ = io.Copy(io.Discard, resp.Body)
|
|
return nil
|
|
}
|