Support subservices by hectorcast-db · Pull Request #826 · databricks/databricks-sdk-go

hectorcast-db · 2024-02-20T14:22:11Z

Changes

Support subservices.
For a preview on generated code, see
https://github.com/databricks/databricks-sdk-go/pull/827/files

Tests

generate sdk with custom OpenAPI
make test passing
make fmt applied
[N/A] relevant integration tests applied

codecov-commenter · 2024-02-21T09:09:17Z

Codecov Report

Attention: 38 lines in your changes are missing coverage. Please review.

Comparison is base (af9e1a1) 18.59% compared to head (2392548) 18.64%.
Report is 1 commits behind head on main.

Files	Patch %	Lines
openapi/code/package.go	55.76%	22 Missing and 1 partial ⚠️
openapi/code/service.go	0.00%	10 Missing ⚠️
openapi/code/load.go	0.00%	5 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #826      +/-   ##
==========================================
+ Coverage   18.59%   18.64%   +0.05%     
==========================================
  Files         117      117              
  Lines       21769    21825      +56     
==========================================
+ Hits         4048     4070      +22     
- Misses      17470    17505      +35     
+ Partials      251      250       -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

mgyucht

Main comments:

Use PascalName or CamelName in place of Name where possible.
few nits on naming of methods and placement of methods.
Otherwise looks great!

mgyucht · 2024-02-21T10:50:51Z

openapi/code/package.go

+	return result
+}
+
+// Returns the Services sorted such has parets always come before subservices.


Suggested change

// Returns the Services sorted such has parets always come before subservices.

// Returns the Services sorted such has parents always come before subservices.

mgyucht · 2024-02-21T15:04:04Z

openapi/code/package.go

+func (pkg *Package) getTagByServiceName(name string, spec *openapi.Specification) (*openapi.Tag, error) {
+	for _, tag := range spec.Tags {
+		if tag.Service == name {
+			return &tag, nil
+		}
+	}
+	return nil, fmt.Errorf("tag %s not found", name)
+}


Should this be a method on openapi.Specification? Doesn't seem to have anything to do with package.

mgyucht · 2024-02-21T15:33:57Z

.codegen/api.go.tmpl


+	{{range .Subservices}}
+	{{.Comment "    // " 80}}
+	{{.PascalName}}() {{.Name}}Interface


mgyucht · 2024-02-21T15:34:03Z

.codegen/api.go.tmpl

 			client: client,
 		},
+		{{range .Subservices}}
+		{{.CamelName}}: New{{.Name}}(client),


mgyucht · 2024-02-21T15:34:08Z

.codegen/api.go.tmpl

+
+	{{range .Subservices}}
+	{{.Comment "    // " 80}}
+	{{.CamelName}} {{.Name}}Interface


mgyucht · 2024-02-21T15:34:13Z

.codegen/api.go.tmpl

 }

+{{range .Subservices}}
+func (a *{{.ParentService.PascalName}}API) {{.PascalName}}() {{.Name}}Interface {


mgyucht · 2024-02-21T15:35:20Z

.codegen/mock_account_client.go.tmpl


-{{range .Services}}{{if .IsAccounts}}
+{{range .Services}}{{if and (.IsAccounts) (.HasParent)}}
+func(m *MockAccountClient) GetMock{{.Name}}API() *{{ template "mock-interface-name" . }} {


mgyucht · 2024-02-21T15:35:40Z

.codegen/mock_account_client.go.tmpl

-{{range .Services}}{{if .IsAccounts}}
+{{range .Services}}{{if and (.IsAccounts) (.HasParent)}}
+func(m *MockAccountClient) GetMock{{.Name}}API() *{{ template "mock-interface-name" . }} {
+	api, ok := m.GetMock{{.ParentService.Name}}API().{{.Name}}().(*{{ template "mock-interface-name" . }})


## Changes SDK release https://github.com/databricks/databricks-sdk-go/releases/tag/v0.34.0 This incorporates two changes to the generation code: * Use explicit empty check for response types (see databricks/databricks-sdk-go#831) * Support subservices for the settings commands (see databricks/databricks-sdk-go#826) As part of the subservices support, this change also updates how methods are registered with their services. This used to be done with `init` functions and now through inline function calls. This should have a (negligible) positive impact on binary start time because we no longer have to call as many `init` functions. ## Tests tbd

hectorcast-db added 2 commits February 20, 2024 15:20

Support subservices

80aa145

Generate and tests

f90d303

hectorcast-db added the do-not-merge label Feb 20, 2024

hectorcast-db requested a review from mgyucht February 20, 2024 14:22

hectorcast-db marked this pull request as draft February 20, 2024 14:22

hectorcast-db added 6 commits February 20, 2024 16:06

Generate and tests

b74beeb

WIP

296ec75

Remove test

32361a2

Accounts mock

75c091b

Merge branch 'main' into support-subservices-gen-test

3a9916c

Generate with current spec

8c1db3e

Formatting

2392548

hectorcast-db removed the do-not-merge label Feb 21, 2024

hectorcast-db marked this pull request as ready for review February 21, 2024 09:12

hectorcast-db changed the title ~~[WIP] Support subservices~~ Support subservices Feb 21, 2024

mgyucht approved these changes Feb 21, 2024

View reviewed changes

PR comments

d44c52b

hectorcast-db added this pull request to the merge queue Feb 21, 2024

Merged via the queue into main with commit 30881c6 Feb 21, 2024

hectorcast-db deleted the support-subservices branch February 21, 2024 16:03

tanmay-db mentioned this pull request Mar 4, 2024

Release v0.34.0 #842

Merged

pietern mentioned this pull request Mar 6, 2024

Update Go SDK to v0.34.0 databricks/cli#1256

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support subservices#826

Support subservices#826
hectorcast-db merged 10 commits intomainfrom
support-subservices

hectorcast-db commented Feb 20, 2024 •

edited

Loading

Uh oh!

codecov-commenter commented Feb 21, 2024 •

edited

Loading

Uh oh!

mgyucht left a comment

Uh oh!

mgyucht Feb 21, 2024

Uh oh!

mgyucht Feb 21, 2024

Uh oh!

mgyucht Feb 21, 2024

Uh oh!

mgyucht Feb 21, 2024

Uh oh!

mgyucht Feb 21, 2024

Uh oh!

mgyucht Feb 21, 2024

Uh oh!

mgyucht Feb 21, 2024

Uh oh!

mgyucht Feb 21, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	// Returns the Services sorted such has parets always come before subservices.
	// Returns the Services sorted such has parents always come before subservices.

Conversation

hectorcast-db commented Feb 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Tests

Uh oh!

codecov-commenter commented Feb 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

mgyucht left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

hectorcast-db commented Feb 20, 2024 •

edited

Loading

codecov-commenter commented Feb 21, 2024 •

edited

Loading