Skip to content

feat(librarian/swift): use discovery config #6604

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
coryan merged 2 commits into from
Jul 1, 2026
Merged

feat(librarian/swift): use discovery config #6604

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
957a73f
feat(librarian/swift): use discovery config
coryan Jun 30, 2026
d998b14
Address review comments
coryan Jul 1, 2026
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
25 changes: 20 additions & 5 deletions internal/librarian/swift/generate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import (
"github.com/googleapis/librarian/internal/command"
"github.com/googleapis/librarian/internal/config"
"github.com/googleapis/librarian/internal/serviceconfig"
"github.com/googleapis/librarian/internal/sidekick/api"
"github.com/googleapis/librarian/internal/sidekick/parser"
sidekickswift "github.com/googleapis/librarian/internal/sidekick/swift"
"github.com/googleapis/librarian/internal/sources"
Expand Down Expand Up @@ -74,8 +75,8 @@ func camelLibraryName(api string) string {
return name.String()
}

func libraryToModelConfig(library *config.Library, api *config.API, src *sources.Sources) (*parser.ModelConfig, error) {
svcConfig, err := serviceconfig.Find(src.Googleapis, api.Path, config.LanguageSwift)
func libraryToModelConfig(library *config.Library, apiCfg *config.API, src *sources.Sources) (*parser.ModelConfig, error) {
svcConfig, err := serviceconfig.Find(src.Googleapis, apiCfg.Path, config.LanguageSwift)
if err != nil {
return nil, err
}
Expand All @@ -89,15 +90,29 @@ func libraryToModelConfig(library *config.Library, api *config.API, src *sources
specFormat = library.SpecificationFormat
}

return &parser.ModelConfig{
modelCfg := &parser.ModelConfig{
Language: config.LanguageSwift,
SpecificationFormat: specFormat,
ServiceConfig: svcConfig.ServiceConfig,
SpecificationSource: api.Path,
SpecificationSource: apiCfg.Path,
Source: sourceConfig,
Codec: map[string]string{
"copyright-year": library.CopyrightYear,
"version": library.Version,
},
}, nil
}
if library.Swift != nil && library.Swift.Discovery != nil {
pollers := make([]*api.Poller, len(library.Swift.Discovery.Pollers))
for i, poller := range library.Swift.Discovery.Pollers {
pollers[i] = &api.Poller{
Prefix: poller.Prefix,
MethodID: poller.MethodID,
}
}
modelCfg.Discovery = &api.Discovery{
OperationID: library.Swift.Discovery.OperationID,
Pollers: pollers,
}
}
return modelCfg, nil
}
44 changes: 44 additions & 0 deletions internal/librarian/swift/generate_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import (

"github.com/google/go-cmp/cmp"
"github.com/googleapis/librarian/internal/config"
"github.com/googleapis/librarian/internal/sidekick/api"
"github.com/googleapis/librarian/internal/sidekick/parser"
"github.com/googleapis/librarian/internal/sources"
"github.com/googleapis/librarian/internal/testhelper"
Expand Down Expand Up @@ -207,6 +208,49 @@ func TestLibraryToModelConfig(t *testing.T) {
},
},
},
{
name: "discovery config with LRO",
library: &config.Library{
Name: "google-cloud-compute-v1",
CopyrightYear: "2038",
Version: "1.2.3",
Roots: []string{"discovery", "googleapis"},
SpecificationFormat: config.SpecDiscovery,
Swift: &config.SwiftPackage{
Discovery: &config.SwiftDiscovery{
OperationID: ".google.cloud.compute.v1.",
Pollers: []config.SwiftPoller{
{
Prefix: "compute/v1/projects/{project}/zones/{zone}",
MethodID: ".google.cloud.compute.v1.zoneOperations.get",
},
},
},
},
},
api: &config.API{
Path: "discoveries/compute.v1.json",
},
want: &parser.ModelConfig{
Language: config.LanguageSwift,
SpecificationFormat: config.SpecDiscovery,
SpecificationSource: "discoveries/compute.v1.json",
ServiceConfig: "google/cloud/compute/v1/compute_v1.yaml",
Codec: map[string]string{"copyright-year": "2038", "version": "1.2.3"},
Source: &sources.SourceConfig{
ActiveRoots: []string{"discovery", "googleapis"},
},
Discovery: &api.Discovery{
OperationID: ".google.cloud.compute.v1.",
Pollers: []*api.Poller{
{
Prefix: "compute/v1/projects/{project}/zones/{zone}",
MethodID: ".google.cloud.compute.v1.zoneOperations.get",
},
},
},
},
},
} {
t.Run(test.name, func(t *testing.T) {
srcs := &sources.Sources{
Expand Down
12 changes: 5 additions & 7 deletions internal/sidekick/api/xref.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -361,11 +361,11 @@ func sortOneOfFieldForExamples(f1, f2 *Field) int {
}

func enrichMethodSamples(m *Method) {
m.IsSimple = m.Pagination == nil &&
!m.ClientSideStreaming && !m.ServerSideStreaming &&
m.OperationInfo == nil && m.DiscoveryLro == nil

m.IsLRO = m.OperationInfo != nil
// Methods with AIP-151 LRO annotations *OR* discovery LRO annotations are LROs.
m.IsLRO = m.OperationInfo != nil || m.DiscoveryLro != nil
Comment thread
coryan marked this conversation as resolved.
m.IsStreaming = m.ClientSideStreaming || m.ServerSideStreaming
// A simple method is not paginated, not streaming and not an LRO.
m.IsSimple = m.Pagination == nil && !m.IsStreaming && !m.IsLRO

if m.SourceServiceID == ".google.longrunning.Operations" &&
m.Name == "GetOperation" &&
Expand All @@ -381,8 +381,6 @@ func enrichMethodSamples(m *Method) {

m.IsList = m.OutputType != nil && m.OutputType.Pagination != nil

m.IsStreaming = m.ClientSideStreaming || m.ServerSideStreaming

if m.SampleInfo = aipStandardGetInfo(m); m.SampleInfo != nil {
m.IsAIPStandardGet = true
} else if m.SampleInfo = aipStandardDeleteInfo(m); m.SampleInfo != nil {
Expand Down
18 changes: 11 additions & 7 deletions internal/sidekick/api/xref_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -672,7 +672,7 @@ func TestIsSimpleMethod(t *testing.T) {
}

func TestIsLRO(t *testing.T) {
testCases := []struct {
for _, test := range []struct {
name string
method *Method
want bool
Expand All @@ -687,12 +687,16 @@ func TestIsLRO(t *testing.T) {
method: &Method{OperationInfo: &OperationInfo{}},
want: true,
},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
enrichMethodSamples(tc.method)
if got := tc.method.IsLRO; got != tc.want {
t.Errorf("IsLRO() = %v, want %v", got, tc.want)
{
name: "LRO method is discovery LRO",
method: &Method{DiscoveryLro: &DiscoveryLro{}},
want: true,
},
} {
t.Run(test.name, func(t *testing.T) {
enrichMethodSamples(test.method)
if got := test.method.IsLRO; got != test.want {
t.Errorf("IsLRO() = %v, want %v", got, test.want)
}
})
}
Expand Down
Loading