Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 89 additions & 0 deletions .github/workflows/sdk-drift-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
name: SDK Drift Check

on:
pull_request:
branches: [main]
paths:
- 'components/ambient-sdk/generator/**'
- 'components/ambient-sdk/go-sdk/**'
- 'components/ambient-sdk/python-sdk/**'
- 'components/ambient-sdk/ts-sdk/**'
- 'components/ambient-api-server/openapi/**'
- '.github/workflows/sdk-drift-check.yml'

push:
branches: [main]
paths:
- 'components/ambient-sdk/generator/**'
- 'components/ambient-sdk/go-sdk/**'
- 'components/ambient-sdk/python-sdk/**'
- 'components/ambient-sdk/ts-sdk/**'
- 'components/ambient-api-server/openapi/**'
- '.github/workflows/sdk-drift-check.yml'

workflow_dispatch:

concurrency:
group: sdk-drift-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true

jobs:
check-drift:
name: SDK Generator Drift
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v6

- name: Set up Go
uses: actions/setup-go@v5
with:
go-version-file: components/ambient-sdk/generator/go.mod
cache-dependency-path: components/ambient-sdk/generator/go.sum

- name: Regenerate SDK from OpenAPI spec
working-directory: components/ambient-sdk/generator
run: |
go run . \
-spec ../../ambient-api-server/openapi/openapi.yaml \
-go-out ../go-sdk \
-python-out ../python-sdk/ambient_platform \
-ts-out ../ts-sdk

- name: Run gofmt on generated Go code
working-directory: components/ambient-sdk/go-sdk
run: go fmt ./...

- name: Fix trailing newlines (match pre-commit end-of-file-fixer)
run: |
find components/ambient-sdk/go-sdk components/ambient-sdk/python-sdk components/ambient-sdk/ts-sdk \
-type f \( -name '*.go' -o -name '*.py' -o -name '*.ts' \) \
-exec sed -i -e :a -e '/^\n*$/{$d;N;ba' -e '}' {} +

- name: Check for drift
run: |
# Ignore timestamp and hash lines (they change every run)
# Patterns cover both // (Go/TS) and # (Python) comment styles
DRIFT=$(git diff \
--ignore-matching-lines='Spec SHA256:' \
--ignore-matching-lines='Generated:' \
-- components/ambient-sdk/go-sdk/ \
components/ambient-sdk/python-sdk/ \
components/ambient-sdk/ts-sdk/)

if [ -n "$DRIFT" ]; then
echo "❌ SDK drift detected — regenerated code differs from committed code."
echo ""
echo "This means either:"
echo " 1. A generator template was updated but the SDK was not regenerated"
echo " 2. The OpenAPI spec changed but the SDK was not regenerated"
echo " 3. Generated files were hand-edited (update the templates instead)"
echo ""
echo "Fix: cd components/ambient-sdk && make generate-sdk"
echo ""
echo "Diff:"
echo "$DRIFT"
exit 1
fi

echo "✅ No SDK drift detected"
31 changes: 31 additions & 0 deletions components/ambient-api-server/openapi/openapi.sessions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,37 @@ paths:
application/json:
schema:
$ref: 'openapi.yaml#/components/schemas/Error'
delete:
summary: Delete a session by id
security:
- Bearer: []
responses:
'204':
description: Session deleted successfully
'401':
description: Auth token is invalid
content:
application/json:
schema:
$ref: 'openapi.yaml#/components/schemas/Error'
'403':
description: Unauthorized to perform operation
content:
application/json:
schema:
$ref: 'openapi.yaml#/components/schemas/Error'
'404':
description: No session with specified id exists
content:
application/json:
schema:
$ref: 'openapi.yaml#/components/schemas/Error'
'500':
description: Unexpected error deleting session
content:
application/json:
schema:
$ref: 'openapi.yaml#/components/schemas/Error'
parameters:
- $ref: '#/components/parameters/id'
/api/ambient/v1/sessions/{id}/status:
Expand Down
10 changes: 6 additions & 4 deletions components/ambient-sdk/generator/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -341,13 +341,15 @@ func loadTemplate(path string) (*template.Template, error) {
}

func executeTemplate(tmpl *template.Template, outPath string, data interface{}) error {
f, err := os.Create(outPath)
if err != nil {
var buf strings.Builder
if err := tmpl.Execute(&buf, data); err != nil {
return err
}
defer func() { _ = f.Close() }()

return tmpl.Execute(f, data)
// Ensure file ends with exactly one newline (match pre-commit end-of-file-fixer)
content := strings.TrimRight(buf.String(), "\n") + "\n"

return os.WriteFile(outPath, []byte(content), 0644)
}

func computeSpecHash(specPath string) (string, error) {
Expand Down
36 changes: 28 additions & 8 deletions components/ambient-sdk/generator/templates/go/http_client.go.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ package client
import (
"bytes"
"context"
"crypto/tls"
"encoding/json"
"fmt"
"io"
Expand All @@ -23,12 +24,13 @@ import (
)

type Client struct {
httpClient *http.Client
baseURL string
token string
project string
logger *slog.Logger
userAgent string
httpClient *http.Client
baseURL string
token string
project string
logger *slog.Logger
userAgent string
insecureSkipVerify bool
}

type ClientOption func(*Client)
Expand All @@ -39,6 +41,23 @@ func WithTimeout(timeout time.Duration) ClientOption {
}
}

func WithInsecureSkipVerify() ClientOption {
return func(c *Client) {
c.insecureSkipVerify = true
t, ok := c.httpClient.Transport.(*http.Transport)
if !ok || t == nil {
t = http.DefaultTransport.(*http.Transport).Clone()
} else {
t = t.Clone()
}
if t.TLSClientConfig == nil {
t.TLSClientConfig = &tls.Config{MinVersion: tls.VersionTLS12}
}
t.TLSClientConfig.InsecureSkipVerify = true //nolint:gosec
c.httpClient.Transport = t
}
}

func WithLogger(logger *slog.Logger) ClientOption {
return func(c *Client) {
c.logger = logger
Expand Down Expand Up @@ -226,7 +245,8 @@ func validateURL(rawURL string) error {
return nil
}

var bearerTokenPattern = regexp.MustCompile(`([Bb]earer\s+)[a-zA-Z0-9\-_~.+/=]+`)

func sanitizeLogURL(rawURL string) string {
tokenPattern := regexp.MustCompile(`([Bb]earer\s+)[a-zA-Z0-9\-_~.+/=]+`)
return tokenPattern.ReplaceAllString(rawURL, "${1}[REDACTED]")
return bearerTokenPattern.ReplaceAllString(rawURL, "${1}[REDACTED]")
}
5 changes: 1 addition & 4 deletions components/ambient-sdk/generator/templates/go/types.go.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,7 @@ func (b *{{$.Resource.Name}}Builder) {{.GoName}}(v {{.GoType}}) *{{$.Resource.Na
b.resource.{{.GoName}} = v
return b
}
{{end}}{{end}}

{{end}}{{- end}}
func (b *{{.Resource.Name}}Builder) Build() (*{{.Resource.Name}}, error) {
{{- range .Resource.Fields}}
{{- if .Required}}
Expand Down Expand Up @@ -78,7 +77,6 @@ func (b *{{$.Resource.Name}}PatchBuilder) {{.GoName}}(v {{.GoType}}) *{{$.Resour
return b
}
{{end}}

func (b *{{.Resource.Name}}PatchBuilder) Build() map[string]any {
return b.patch
}
Expand All @@ -97,7 +95,6 @@ func (b *{{$.Resource.Name}}StatusPatchBuilder) {{.GoName}}(v {{.GoType}}) *{{$.
return b
}
{{end}}

func (b *{{.Resource.Name}}StatusPatchBuilder) Build() map[string]any {
return b.patch
}
Expand Down
16 changes: 12 additions & 4 deletions components/ambient-sdk/go-sdk/client/client.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions components/ambient-sdk/go-sdk/client/iterator.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions components/ambient-sdk/go-sdk/client/project_api.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions components/ambient-sdk/go-sdk/client/project_settings_api.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 6 additions & 6 deletions components/ambient-sdk/go-sdk/client/session_api.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions components/ambient-sdk/go-sdk/client/user_api.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions components/ambient-sdk/go-sdk/types/base.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions components/ambient-sdk/go-sdk/types/list_options.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions components/ambient-sdk/go-sdk/types/project.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions components/ambient-sdk/go-sdk/types/project_settings.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions components/ambient-sdk/go-sdk/types/session.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions components/ambient-sdk/go-sdk/types/user.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading