Files
probo/pkg/accessreview/access_source_provider_config.go
Aurélien Sibiril 60628645ae Add Google Analytics, Dotfile, Segment and Square access-review connectors
Two OAuth2 and two API-key connectors:

- Google Analytics (GA4): OAuth2 with both analytics.readonly and
  analytics.manage.users.readonly (readonly alone 403s on the accounts
  list); v1alpha accessBindings enumerated at account and property level
  and merged by email; manual account picker (Pattern 1) with a
  per-connection probe and name resolver; distinct from Google Workspace.
- Dotfile: API key in the X-DOTFILE-API-KEY header (Pattern 3); GET
  /v1/users (owner/admin, suspended_at) with a static probe.
- Segment (Twilio): Public API token as Bearer with a required Region
  setting (US or EU) mapped to the regional host; GET /users plus per-user
  GET /users/{id} for roles and /invites for pending members; per-connection
  BuildProbeURL.
- Square: OAuth2 (EMPLOYEES_READ) or a personal access token (Pattern 3);
  POST /v2/team-members/search returns email/status/is_owner directly, so no
  role resolution; custom probe and name resolver.

Google Analytics and Square are confidential OAuth clients, wired into the
bootstrap OAuth provider list and .env.example. Segment carries a required
extra setting, so the console add-source dialog maps region onto its
segmentRegion API-key input; without that mapping the value is silently
dropped and the create is rejected.

Cassette-backed driver tests plus unit tests for the Segment probe URL and
the bootstrap OAuth provider list.

Signed-off-by: Aurélien Sibiril <81782+aureliensibiril@users.noreply.github.com>
2026-07-26 09:22:04 +02:00

166 lines
6.1 KiB
Go

// Copyright (c) 2026 Probo Inc <hello@probo.com>.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
package accessreview
import (
"context"
"net/http"
"go.probo.inc/probo/pkg/accessreview/drivers"
"go.probo.inc/probo/pkg/coredata"
)
// providerOrgConfig binds a connector provider to its picker-UI behavior.
//
// ListOrgs returns the orgs/workspaces/teams the authenticated user can
// scope the connector to (nil for Pattern 2-auto providers like
// PagerDuty and Vercel where the value is captured during OAuth).
//
// SelectedSlug returns the currently-configured org identifier for the
// connector (empty string if none).
//
// NeedsPicker reports whether the picker mutation should surface in the
// UI; false for 2-auto providers.
type providerOrgConfig struct {
ListOrgs func(ctx context.Context, httpClient *http.Client) ([]drivers.Organization, error)
SelectedSlug func(c *coredata.Connector) string
NeedsPicker bool
}
// providerOrgConfigs is the single source of truth that the access-source
// picker paths dispatch through: the console/MCP picker resolvers
// (ProviderOrganizations, SelectedOrganization, NeedsConfiguration) and the
// AutoSelectDefaultOrganization defaulting run on create/update. Adding a
// provider takes one entry here.
var providerOrgConfigs = map[coredata.ConnectorProvider]providerOrgConfig{
coredata.ConnectorProviderGitHub: {
ListOrgs: drivers.ListGitHubOrganizations,
SelectedSlug: func(c *coredata.Connector) string {
s, _ := coredata.ConnectorSettings[coredata.GitHubConnectorSettings](c)
return s.Organization
},
NeedsPicker: true,
},
coredata.ConnectorProviderSentry: {
ListOrgs: drivers.ListSentryOrganizations,
SelectedSlug: func(c *coredata.Connector) string {
s, _ := coredata.ConnectorSettings[coredata.SentryConnectorSettings](c)
return s.OrganizationSlug
},
NeedsPicker: true,
},
coredata.ConnectorProviderGoogleAnalytics: {
ListOrgs: drivers.ListGoogleAnalyticsOrganizations,
SelectedSlug: func(c *coredata.Connector) string {
s, _ := coredata.ConnectorSettings[coredata.GoogleAnalyticsConnectorSettings](c)
return s.AccountID
},
NeedsPicker: true,
},
coredata.ConnectorProviderGitLab: {
ListOrgs: drivers.ListGitLabOrganizations,
SelectedSlug: func(c *coredata.Connector) string {
s, _ := coredata.ConnectorSettings[coredata.GitLabConnectorSettings](c)
return s.GroupID
},
NeedsPicker: true,
},
coredata.ConnectorProviderBitbucket: {
ListOrgs: drivers.ListBitbucketOrganizations,
SelectedSlug: func(c *coredata.Connector) string {
s, _ := coredata.ConnectorSettings[coredata.BitbucketConnectorSettings](c)
return s.Workspace
},
NeedsPicker: true,
},
coredata.ConnectorProviderHeroku: {
ListOrgs: drivers.ListHerokuOrganizations,
SelectedSlug: func(c *coredata.Connector) string {
s, _ := coredata.ConnectorSettings[coredata.HerokuConnectorSettings](c)
return s.TeamID
},
NeedsPicker: true,
},
coredata.ConnectorProviderAsana: {
ListOrgs: drivers.ListAsanaOrganizations,
SelectedSlug: func(c *coredata.Connector) string {
s, _ := coredata.ConnectorSettings[coredata.AsanaConnectorSettings](c)
return s.WorkspaceGID
},
NeedsPicker: true,
},
coredata.ConnectorProviderNetlify: {
ListOrgs: drivers.ListNetlifyOrganizations,
SelectedSlug: func(c *coredata.Connector) string {
s, _ := coredata.ConnectorSettings[coredata.NetlifyConnectorSettings](c)
return s.AccountSlug
},
NeedsPicker: true,
},
coredata.ConnectorProviderClickUp: {
ListOrgs: drivers.ListClickUpOrganizations,
SelectedSlug: func(c *coredata.Connector) string {
s, _ := coredata.ConnectorSettings[coredata.ClickUpConnectorSettings](c)
return s.TeamID
},
NeedsPicker: true,
},
coredata.ConnectorProviderDocuSign: {
ListOrgs: drivers.ListDocuSignOrganizations,
SelectedSlug: func(c *coredata.Connector) string {
s, _ := coredata.ConnectorSettings[coredata.DocuSignConnectorSettings](c)
return s.AccountID
},
NeedsPicker: true,
},
// Pattern 2-auto: identifier is captured during the OAuth callback
// (subdomain for PagerDuty, teamId or fallback /v2/user.id for
// Vercel). No picker UI; NeedsPicker = false.
coredata.ConnectorProviderPagerDuty: {
SelectedSlug: func(c *coredata.Connector) string {
s, _ := coredata.ConnectorSettings[coredata.PagerDutyConnectorSettings](c)
return s.Subdomain
},
},
coredata.ConnectorProviderVercel: {
SelectedSlug: func(c *coredata.Connector) string {
s, _ := coredata.ConnectorSettings[coredata.VercelConnectorSettings](c)
return s.TeamID
},
},
// Pattern 2-auto: the API domain is captured during the OAuth
// callback from Datadog's `domain` parameter; no picker UI.
coredata.ConnectorProviderDatadog: {
SelectedSlug: func(c *coredata.Connector) string {
s, _ := coredata.ConnectorSettings[coredata.DatadogConnectorSettings](c)
return s.Domain
},
},
// Pattern 2-auto: the subdomain is collected at initiate and persisted
// from the signed OAuth state on the callback; no picker UI.
coredata.ConnectorProviderZendesk: {
SelectedSlug: func(c *coredata.Connector) string {
s, _ := coredata.ConnectorSettings[coredata.ZendeskConnectorSettings](c)
return s.Subdomain
},
},
}