Files
probo/pkg/accessreview/drivers/hubspot.go
Cursor Agent a7639be86b Handle archived HubSpot users
Parse HubSpot archived and deactivated status signals when building
access-review account records. This preserves inactive users as
explicit records instead of dropping them when status fields differ
from the current payload assumptions.

Also accept roleIds payloads and keep records that only expose an
external ID, which is common for archived users with empty email
fields. Add a focused unit test to lock in archived-user handling.

Signed-off-by: Cursor Agent <cursoragent@cursor.com>

Co-authored-by: Bryan FRIMIN <bryan@frimin.fr>
2026-05-27 19:10:37 +00:00

244 lines
6.0 KiB
Go

// Copyright (c) 2026 Probo Inc <hello@getprobo.com>.
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
package drivers
import (
"context"
"encoding/json"
"fmt"
"net/http"
"strings"
"go.probo.inc/probo/pkg/coredata"
)
// HubSpotDriver fetches account users from HubSpot via OAuth2-authenticated
// REST requests.
type HubSpotDriver struct {
httpClient *http.Client
}
var _ Driver = (*HubSpotDriver)(nil)
type (
hubspotRolesResponse struct {
Results []struct {
ID string `json:"id"`
Name string `json:"name"`
} `json:"results"`
}
hubspotUser struct {
ID string `json:"id"`
Email string `json:"email"`
FirstName string `json:"firstName"`
LastName string `json:"lastName"`
RoleID string `json:"roleId"`
RoleIDs []string `json:"roleIds"`
PrimaryTeamID string `json:"primaryTeamId"`
SuperAdmin bool `json:"superAdmin"`
Archived *bool `json:"archived"`
Deactivated *bool `json:"deactivated"`
IsActive *bool `json:"isActive"`
Active *bool `json:"active"`
HSDeactivated *bool `json:"hs_deactivated"`
}
hubspotUsersResponse struct {
Results []hubspotUser `json:"results"`
Paging *struct {
Next *struct {
After string `json:"after"`
} `json:"next"`
} `json:"paging"`
}
)
const (
hubspotUsersEndpoint = "https://api.hubapi.com/settings/v3/users"
hubspotRolesEndpoint = "https://api.hubapi.com/settings/v3/users/roles"
)
func NewHubSpotDriver(httpClient *http.Client) *HubSpotDriver {
return &HubSpotDriver{
httpClient: httpClient,
}
}
func (d *HubSpotDriver) ListAccounts(ctx context.Context) ([]AccountRecord, error) {
roleMap, _ := d.fetchRoles(ctx)
var (
records []AccountRecord
after string
)
for range maxPaginationPages {
resp, err := d.fetchUsers(ctx, after)
if err != nil {
return nil, err
}
for _, u := range resp.Results {
role := "User"
roleID := hubspotRoleID(u)
if roleMap != nil && roleID != "" {
if name, ok := roleMap[roleID]; ok {
role = name
} else if u.SuperAdmin {
role = "Super Admin"
}
} else if u.SuperAdmin {
role = "Super Admin"
}
fullName := strings.TrimSpace(u.FirstName + " " + u.LastName)
record := AccountRecord{
Email: u.Email,
FullName: fullName,
Role: role,
Active: hubspotUserActive(u),
IsAdmin: u.SuperAdmin,
ExternalID: u.ID,
MFAStatus: coredata.MFAStatusUnknown,
AuthMethod: coredata.AccessEntryAuthMethodUnknown,
AccountType: coredata.AccessEntryAccountTypeUser,
}
if record.Email != "" || record.ExternalID != "" {
records = append(records, record)
}
}
if resp.Paging == nil || resp.Paging.Next == nil || resp.Paging.Next.After == "" {
return records, nil
}
after = resp.Paging.Next.After
}
return nil, fmt.Errorf("cannot list all hubspot accounts: %w", ErrPaginationLimitReached)
}
func (d *HubSpotDriver) fetchUsers(ctx context.Context, after string) (*hubspotUsersResponse, error) {
req, err := http.NewRequestWithContext(ctx, http.MethodGet, hubspotUsersEndpoint, nil)
if err != nil {
return nil, fmt.Errorf("cannot create hubspot users request: %w", err)
}
q := req.URL.Query()
q.Set("limit", "100")
if after != "" {
q.Set("after", after)
}
req.URL.RawQuery = q.Encode()
req.Header.Set("Accept", "application/json")
httpResp, err := d.httpClient.Do(req)
if err != nil {
return nil, fmt.Errorf("cannot execute hubspot users request: %w", err)
}
defer func() {
_ = httpResp.Body.Close()
}()
if httpResp.StatusCode < 200 || httpResp.StatusCode >= 300 {
return nil, fmt.Errorf("cannot fetch hubspot users: unexpected status %d", httpResp.StatusCode)
}
var resp hubspotUsersResponse
if err := json.NewDecoder(httpResp.Body).Decode(&resp); err != nil {
return nil, fmt.Errorf("cannot decode hubspot users response: %w", err)
}
return &resp, nil
}
func (d *HubSpotDriver) fetchRoles(ctx context.Context) (map[string]string, error) {
req, err := http.NewRequestWithContext(ctx, http.MethodGet, hubspotRolesEndpoint, nil)
if err != nil {
return nil, fmt.Errorf("cannot create hubspot roles request: %w", err)
}
req.Header.Set("Accept", "application/json")
httpResp, err := d.httpClient.Do(req)
if err != nil {
return nil, fmt.Errorf("cannot execute hubspot roles request: %w", err)
}
defer func() {
_ = httpResp.Body.Close()
}()
if httpResp.StatusCode < 200 || httpResp.StatusCode >= 300 {
return nil, fmt.Errorf("cannot fetch hubspot roles: unexpected status %d", httpResp.StatusCode)
}
var resp hubspotRolesResponse
if err := json.NewDecoder(httpResp.Body).Decode(&resp); err != nil {
return nil, fmt.Errorf("cannot decode hubspot roles response: %w", err)
}
roleMap := make(map[string]string, len(resp.Results))
for _, r := range resp.Results {
roleMap[r.ID] = r.Name
}
return roleMap, nil
}
func hubspotRoleID(user hubspotUser) string {
if user.RoleID != "" {
return user.RoleID
}
if len(user.RoleIDs) > 0 {
return user.RoleIDs[0]
}
return ""
}
func hubspotUserActive(user hubspotUser) *bool {
if user.IsActive != nil {
return new(*user.IsActive)
}
if user.Active != nil {
return new(*user.Active)
}
if user.Deactivated != nil {
return new(!*user.Deactivated)
}
if user.HSDeactivated != nil {
return new(!*user.HSDeactivated)
}
if user.Archived != nil {
return new(!*user.Archived)
}
return nil
}