iframe-proxy

busunkim96 · 2021-11-02T16:04:07Z

Fixes #1014 and unblocks #1043.

NOTE: Some real world APIs expect the first request to pass a config (example) so the generated samples will not work out of the box. This will be addressed when the new sample config language is sorted out.

busunkim96 · 2021-11-02T16:20:02Z

-        client_streaming_forms = {
-            types.CallingForm.RequestStreamingClient,
-            types.CallingForm.RequestStreamingBidi,
-        }
-
-        if len(base_param_to_attrs) > 1 and calling_form in client_streaming_forms:
-            raise types.InvalidRequestSetup(
-                "Too many base parameters for client side streaming form"
-            )
-


@software-dov 👋 I'm having trouble understanding this error, would you remember what this was written to prevent?

Some streaming method request messages have 2+ required fields (pubsub), so the current snippetgen logic adds two fields to the dictionary. That causes this error to be raised. Are fields expected to be set differently for streaming?

# Request passed to `validate_and_transform_request` [ { "field":"subscription", "value":"projects/{project}/subscriptions/{subscription}" }, { "field":"stream_ack_deadline_seconds", "value":2813 } ]

I see two unit tests that raise this error, but I don't see any pre-existing tests showing a valid sample config for a client streaming method.

gapic-generator-python/tests/unit/samplegen/test_samplegen.py

Lines 1353 to 1402 in a8d2b3a

def test_single_request_client_streaming(dummy_api_schema,

calling_form=types.CallingForm.RequestStreamingClient):

# Each API client method really only takes one parameter:

# either a single protobuf message or an iterable of protobuf messages.

# With unary request methods, python lets us describe attributes as positional

# and keyword parameters, which simplifies request construction.

# The 'base' in the transformed request refers to an attribute, and the

# 'field's refer to sub-attributes.

# Client streaming and bidirectional streaming methods can't use this notation,

# and generate an exception if there is more than one 'base'.

input_type = DummyMessage(

fields={

"cephalopod": DummyField(

message=DummyMessage(

fields={

"order": DummyField(

message=DummyMessage(type="ORDER_TYPE")

)

},

type="CEPHALOPOD_TYPE"

)

),

"gastropod": DummyField(

message=DummyMessage(

fields={

"order": DummyField(

message=DummyMessage(type="ORDER_TYPE")

)

},

type="GASTROPOD_TYPE"

)

)

},

type="MOLLUSC_TYPE"

)

v = samplegen.Validator(DummyMethod(input=input_type), dummy_api_schema)

with pytest.raises(types.InvalidRequestSetup):

v.validate_and_transform_request(

types.CallingForm.RequestStreamingClient,

[

{"field": "cephalopod.order", "value": "cephalopoda"},

{"field": "gastropod.order", "value": "pulmonata"},

],

)

def test_single_request_bidi_streaming():

test_single_request_client_streaming(

types.CallingForm.RequestStreamingBidi)

I really don't remember what was going on here. My guess is that I was mildly incorrect about the actual python method signature convention and I was trying to imply that we only wanted a single request to be put into a list...?

TL;DR: It's probably a bug or at least a misreading of the spec on my part.

busunkim96 · 2021-11-05T21:22:05Z

This is ready for review, PTAL @software-dov @parthea.

busunkim96 · 2021-11-05T21:31:41Z

+    # 'logging_v2.TailLogEntriesRequest' objects
+    # Here we create a generator that yields a single `request` for
+    # demonstrative purposes.
+    requests = [request]


One simpler alternative is:

requests = iter([requests])

I chose the generator over iter() to nudge folks towards generating requests on demand.

Opinions/suggestions on the best way to present client streaming welcome!

busunkim96 added 2 commits November 1, 2021 23:48

fix(snippetgen) fix streaming samples

8d602bb

test: fix tests

b6c56aa

google-cla Bot added the cla: yes This human has signed the Contributor License Agreement. label Nov 2, 2021

product-auto-label Bot added the samples Issues that are directly related to samples. label Nov 2, 2021

busunkim96 commented Nov 2, 2021

View reviewed changes

busunkim96 and others added 3 commits November 5, 2021 20:38

test: delete obsolete tests, ignore snippetgen goldens for autopep8

06407c7

chore: update .github

80d33cb

Merge branch 'master' into fix-streaming-samples

4c6adb4

busunkim96 marked this pull request as ready for review November 5, 2021 21:17

busunkim96 requested review from a team November 5, 2021 21:17

busunkim96 commented Nov 5, 2021

View reviewed changes

Merge branch 'master' into fix-streaming-samples

4dc4db9

parthea approved these changes Nov 6, 2021

View reviewed changes

Merge branch 'master' into fix-streaming-samples

4c7710b

busunkim96 merged commit 64b9ad6 into master Nov 8, 2021

busunkim96 deleted the fix-streaming-samples branch November 8, 2021 17:57

This was referenced Jan 18, 2022

chore(master): release reverted #1133

Merged

chore(master): release 0.40.0 #1138

Closed

chore(master): release 0.39.1 #1146

Closed

This was referenced Jan 26, 2022

chore(main): release 0.39.1 #1160

Closed

chore(main): release 0.39.1 #1162

Closed

chore(main): release 0.61.0 #1163

Merged

Sunbelt Computer Software

PL/B Language Development and Support

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(snippetgen): fix client streaming samples#1061

fix(snippetgen): fix client streaming samples#1061
busunkim96 merged 7 commits into
masterfrom
fix-streaming-samples

busunkim96 commented Nov 2, 2021 •

edited

Loading

Uh oh!

busunkim96 Nov 2, 2021

Uh oh!

software-dov Nov 5, 2021

Uh oh!

busunkim96 commented Nov 5, 2021

Uh oh!

busunkim96 Nov 5, 2021 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	def test_single_request_client_streaming(dummy_api_schema,
	calling_form=types.CallingForm.RequestStreamingClient):
	# Each API client method really only takes one parameter:
	# either a single protobuf message or an iterable of protobuf messages.
	# With unary request methods, python lets us describe attributes as positional
	# and keyword parameters, which simplifies request construction.
	# The 'base' in the transformed request refers to an attribute, and the
	# 'field's refer to sub-attributes.
	# Client streaming and bidirectional streaming methods can't use this notation,
	# and generate an exception if there is more than one 'base'.
	input_type = DummyMessage(
	fields={
	"cephalopod": DummyField(
	message=DummyMessage(
	fields={
	"order": DummyField(
	message=DummyMessage(type="ORDER_TYPE")
	)
	},
	type="CEPHALOPOD_TYPE"
	)
	),
	"gastropod": DummyField(
	message=DummyMessage(
	fields={
	"order": DummyField(
	message=DummyMessage(type="ORDER_TYPE")
	)
	},
	type="GASTROPOD_TYPE"
	)
	)
	},
	type="MOLLUSC_TYPE"
	)
	v = samplegen.Validator(DummyMethod(input=input_type), dummy_api_schema)
	with pytest.raises(types.InvalidRequestSetup):
	v.validate_and_transform_request(
	types.CallingForm.RequestStreamingClient,
	[
	{"field": "cephalopod.order", "value": "cephalopoda"},
	{"field": "gastropod.order", "value": "pulmonata"},
	],
	)


	def test_single_request_bidi_streaming():
	test_single_request_client_streaming(
	types.CallingForm.RequestStreamingBidi)

Sunbelt Computer Software

PL/B Language Development and Support

Uh oh!

Conversation

busunkim96 commented Nov 2, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

busunkim96 Nov 2, 2021

Choose a reason for hiding this comment

Uh oh!

software-dov Nov 5, 2021

Choose a reason for hiding this comment

Uh oh!

busunkim96 commented Nov 5, 2021

Uh oh!

busunkim96 Nov 5, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

busunkim96 commented Nov 2, 2021 •

edited

Loading

busunkim96 Nov 5, 2021 •

edited

Loading