wasm: clarify how configuration is passed #10782

kyessenov · 2020-04-15T00:27:45Z

Signed-off-by: Kuat Yessenov kuat@google.com

Description: clarify how configuration is passed
Risk Level:
Testing:
Docs Changes: only
Release Notes:
Fixes #10781

Signed-off-by: Kuat Yessenov <kuat@google.com>

repokitteh-read-only · 2020-04-15T00:27:50Z

CC @envoyproxy/api-shepherds: Your approval is needed for changes made to api/.

🐱

Caused by: #10782 was opened by kyessenov.

see: more, trace.

yskopets · 2020-04-15T09:08:18Z

api/envoy/extensions/wasm/v3/wasm.proto

@@ -37,6 +37,8 @@ message VmConfig {
  config.core.v3.AsyncDataSource code = 3;

  // The Wasm configuration used in initialization of a new VM (proxy_on_start).
+  // `google.protobuf.Struct` and `google.protobuf.Value` are serialized as JSON before passing them


Please see my comment in #10781

Are there any follow ups here? Do we want to specialize further types or just leave it at this for now?

/wait-any

mattklein123 · 2020-04-15T22:53:25Z

I'm fine with this approach but let's wait for the discussion to finish on the linked issue.

/wait-any

yskopets · 2020-04-16T06:59:46Z

I would like to see in the description the finite list of supported types and expected Envoy behaviour in that case.

kyessenov · 2020-04-16T08:07:11Z

@yskopets Value is just a dynamic value in protobuf (see https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto). It has a list of options that could be directly serialized as string, number, JSON.

yskopets · 2020-04-16T08:13:52Z

Yes, but google.protobuf.StringValue and google.protobuf.BytesValue are not covered by google.protobuf.Value.

Will google.protobuf.StringValue and google.protobuf.BytesValue be supported ?

yskopets · 2020-04-16T08:18:48Z

The difference is that google.protobuf.Value requires serialization into JSON before passing that value to a Wasm extension, while a value inside google.protobuf.StringValue and google.protobuf.BytesValue should be passed "as is".

kyessenov · 2020-04-16T19:38:36Z

I see your point about BytesValue. JSON doesn't have an easy way to wrap a byte array, and we don't want to force the use of protobuf for byte arrays. TBH this isn't implemented yet, so we're free to add other wrapper types and customize how they're passed to modules.

…sion

Signed-off-by: Kuat Yessenov <kuat@google.com>

mattklein123

LGTM but will defer to @htuch @lizan @yskopets to review. Thank you!

yskopets

@htuch Should we also keep updating v2 docs?

yskopets · 2020-04-21T22:26:05Z

api/envoy/extensions/wasm/v3/wasm.proto

@@ -36,7 +36,10 @@ message VmConfig {
  // The Wasm code that Envoy will execute.
  config.core.v3.AsyncDataSource code = 3;

-  // The Wasm configuration used in initialization of a new VM (proxy_on_start).
+  // The Wasm configuration used in initialization of a new VM
+  // (proxy_on_start). `google.protobuf.Struct` is serialized as JSON before


Let's use name proxy_on_vm_start instead of proxy_on_start for consistency with https://github.com/proxy-wasm/spec/tree/master/abi-versions/vNEXT

Can we leave the naming for later? It's guaranteed to churn endlessly and will only freeze when the code lands.

yskopets · 2020-04-21T22:27:19Z

api/envoy/extensions/wasm/v3/wasm.proto

@@ -70,6 +73,9 @@ message PluginConfig {

  // Filter/service configuration used to configure or reconfigure a plugin
  // (proxy_on_configuration).


Let's use name proxy_on_configure instead of proxy_on_configuration for consistency with https://github.com/proxy-wasm/spec/tree/master/abi-versions/vNEXT

mattklein123 · 2020-04-21T22:46:23Z

@htuch Should we also keep updating v2 docs?

Yeah good call we should do that, thanks.

kyessenov · 2020-04-21T22:48:03Z

Why do we need to update v2? This is not even implemented, and when it does, they should just use v3.

mattklein123 · 2020-04-21T23:17:38Z

Why do we need to update v2? This is not even implemented, and when it does, they should just use v3.

I'm fine either way, but generally for fields that exist already in v2 we have been updating the docs there also.

kyessenov · 2020-04-21T23:19:55Z

Should we just delete v2 version then? I think it was desired to ship before v3 split, but now that v3 is separated, there is no need to maintain v2.

mattklein123 · 2020-04-21T23:20:42Z

Should we just delete v2 version then? I think it was desired to ship before v3 split, but now that v3 is separated, there is no need to maintain v2.

Sure that would be great.

Signed-off-by: Kuat Yessenov <kuat@google.com>

mattklein123

Thanks!

yskopets · 2020-04-22T06:04:12Z

docs/root/api-v2/config/wasm/wasm.rst

@@ -4,5 +4,3 @@ WASM
 .. toctree::
  :glob:
  :maxdepth: 2
-


Let's remove the entire file then

Ah yes, +1, thanks.

/wait

I think this file still needs deleting?

/wait

Signed-off-by: Kuat Yessenov <kuat@google.com>

mattklein123

Thanks!

htuch

LGTM FWIW, I missed this one originally.

Signed-off-by: Spencer Lewis <slewis@squareup.com> * master: (46 commits) allow specifying the API version of bootstrap from the command line (envoyproxy#10803) config: adding connect matcher (unused) (envoyproxy#10894) Add missing dependency on `assert.h` (envoyproxy#10918) Lower heap and disk space used by kafka tests (envoyproxy#10915) [tools] handle commits merged without PR in deprecated script (envoyproxy#10723) tools: including working tree in modified_since_last_github_commit.sh diff. (envoyproxy#10911) rocketmq_proxy: implement rocketmq proxy [docs] PR template to include commit message (envoyproxy#10900) docs: breaking long word to stop content overflow. (envoyproxy#10880) Delete legacy connection pool code. (envoyproxy#10881) wasm: clarify how configuration is passed (envoyproxy#10782) issue template: clarify security/crash reporting (envoyproxy#10885) api/faq: add entry on incremental xDS. (envoyproxy#10876) router: retry overloaded requests (envoyproxy#10847) Remove inclusion of pthread.h, not needed for linux compilation (envoyproxy#10895) request_id: Add option to always set request id in response (envoyproxy#10808) xray: Use correct types for segment document output (envoyproxy#10834) router: fixing a watermark bug for streaming retries (envoyproxy#10866) http: auditing Path() calls for safety with Pathless CONNECT (envoyproxy#10851) Remove hardcoded type urls Part.2 (envoyproxy#10848) ...

add api clarification

f5c07eb

Signed-off-by: Kuat Yessenov <kuat@google.com>

repokitteh-read-only bot added the api label Apr 15, 2020

yskopets mentioned this pull request Apr 15, 2020

wasm: allow non-proto configuration #10781

Closed

yskopets reviewed Apr 15, 2020

View reviewed changes

mattklein123 self-assigned this Apr 15, 2020

repokitteh-read-only bot added the waiting:any label Apr 15, 2020

repokitteh-read-only bot removed the waiting:any label Apr 16, 2020

repokitteh-read-only bot added the waiting:any label Apr 16, 2020

kyessenov added 2 commits April 21, 2020 11:41

Merge remote-tracking branch 'upstream/master' into update_wasm_exten…

27d0595

…sion

mention bytes and string value

0a54834

Signed-off-by: Kuat Yessenov <kuat@google.com>

repokitteh-read-only bot removed the waiting:any label Apr 21, 2020

typo

d29834a

Signed-off-by: Kuat Yessenov <kuat@google.com>

mattklein123 previously approved these changes Apr 21, 2020

View reviewed changes

repokitteh-read-only bot removed the api label Apr 21, 2020

yskopets previously approved these changes Apr 21, 2020

View reviewed changes

mattklein123 added the waiting label Apr 21, 2020

kyessenov added 2 commits April 21, 2020 16:24

delete wasm v2alpha

2f5a784

Signed-off-by: Kuat Yessenov <kuat@google.com>

nuke v2alpha

10f7c94

Signed-off-by: Kuat Yessenov <kuat@google.com>

kyessenov dismissed stale reviews from yskopets and mattklein123 via 10f7c94 April 21, 2020 23:34

repokitteh-read-only bot added api and removed waiting labels Apr 21, 2020

no v3 for extensions yet

bc0c2ad

Signed-off-by: Kuat Yessenov <kuat@google.com>

mattklein123 previously approved these changes Apr 22, 2020

View reviewed changes

repokitteh-read-only bot removed the api label Apr 22, 2020

yskopets previously approved these changes Apr 22, 2020

View reviewed changes

repokitteh-read-only bot added the waiting label Apr 22, 2020

remove wasm dir

5aaef09

Signed-off-by: Kuat Yessenov <kuat@google.com>

kyessenov dismissed stale reviews from yskopets and mattklein123 via 5aaef09 April 22, 2020 16:41

repokitteh-read-only bot added api waiting and removed waiting labels Apr 22, 2020

oops

283d608

Signed-off-by: Kuat Yessenov <kuat@google.com>

repokitteh-read-only bot removed the waiting label Apr 22, 2020

mattklein123 approved these changes Apr 22, 2020

View reviewed changes

repokitteh-read-only bot removed the api label Apr 22, 2020

yskopets approved these changes Apr 22, 2020

View reviewed changes

mattklein123 merged commit 239620e into envoyproxy:master Apr 22, 2020

htuch reviewed Apr 23, 2020

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

wasm: clarify how configuration is passed #10782

wasm: clarify how configuration is passed #10782

kyessenov commented Apr 15, 2020

repokitteh-read-only bot commented Apr 15, 2020

yskopets Apr 15, 2020

mattklein123 Apr 16, 2020

mattklein123 commented Apr 15, 2020

yskopets commented Apr 16, 2020

kyessenov commented Apr 16, 2020

yskopets commented Apr 16, 2020

yskopets commented Apr 16, 2020

kyessenov commented Apr 16, 2020

mattklein123 left a comment

yskopets left a comment

yskopets Apr 21, 2020

kyessenov Apr 21, 2020

yskopets Apr 22, 2020

yskopets Apr 21, 2020

mattklein123 commented Apr 21, 2020

kyessenov commented Apr 21, 2020

mattklein123 commented Apr 21, 2020

kyessenov commented Apr 21, 2020

mattklein123 commented Apr 21, 2020

mattklein123 left a comment

yskopets Apr 22, 2020

mattklein123 Apr 22, 2020

mattklein123 Apr 22, 2020

mattklein123 left a comment

htuch left a comment

		@@ -70,6 +73,9 @@ message PluginConfig {

		// Filter/service configuration used to configure or reconfigure a plugin
		// (proxy_on_configuration).

wasm: clarify how configuration is passed #10782

wasm: clarify how configuration is passed #10782

Conversation

kyessenov commented Apr 15, 2020

repokitteh-read-only bot commented Apr 15, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mattklein123 commented Apr 15, 2020

yskopets commented Apr 16, 2020

kyessenov commented Apr 16, 2020

yskopets commented Apr 16, 2020

yskopets commented Apr 16, 2020

kyessenov commented Apr 16, 2020

mattklein123 left a comment

Choose a reason for hiding this comment

yskopets left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mattklein123 commented Apr 21, 2020

kyessenov commented Apr 21, 2020

mattklein123 commented Apr 21, 2020

kyessenov commented Apr 21, 2020

mattklein123 commented Apr 21, 2020

mattklein123 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mattklein123 left a comment

Choose a reason for hiding this comment

htuch left a comment

Choose a reason for hiding this comment