[Proposal] POEM: provide array result for all runtime images by ningyougang · Pull Request #5244 · apache/openwhisk

ningyougang · 2022-05-24T09:10:51Z

Description

This is the POEM documentation for new feature providing support array result for all runtime images
I refer to this guide document for POEM: https://github.com/apache/openwhisk/blob/master/proposals/README.md

Related issue and scope

I opened an issue to propose and discuss this change (#????)

My changes affect the following components

Types of changes

Bug fix (generally a non-breaking change which closes an issue).
Enhancement or new feature (adds new functionality).
Breaking change (a bug fix or enhancement which changes existing behavior).

Checklist:

I signed an Apache CLA.
I reviewed the style guides and followed the recommendations (Travis CI will check :).
I added tests to cover my changes.
My changes require further changes to the documentation.
I updated the documentation where necessary.

codecov-commenter · 2022-05-24T10:58:12Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.27%. Comparing base (c507069) to head (d4899a6).
Report is 110 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5244      +/-   ##
==========================================
- Coverage   79.97%   75.27%   -4.70%     
==========================================
  Files         238      238              
  Lines       14199    14199              
  Branches      577      577              
==========================================
- Hits        11355    10689     -666     
- Misses       2844     3510     +666

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

ningyougang · 2022-07-04T00:26:10Z

Hi，guys.
Regarding prvoide array result, for common action or sequence action, i have implemented in my local, e.g. for this example: https://github.com/apache/openwhisk/blob/master/docs/actions.md#creating-action-sequences

I updated the split.js and sort.js like below and invoked successully using my local openwhisk codes

function main(msg) {
   var separator = msg.separator || /\r?\n/;
   var payload = msg.payload.toString();
   var lines = payload.split(separator);
   return lines;
}

And

function main(msg) {
   var lines = msg || [];
   console.log('sort before: ' + lines);
   lines.sort();
   return lines;
}

style95 · 2022-07-21T10:57:41Z

proposals/POEM-support-array-result.md

+-->
+# Title
+
+Currently, openwhisk supports return json object only, e.g.


Suggested change

Currently, openwhisk supports return json object only, e.g.

Currently, OpenWhisk supports returning a JSON object only, e.g.

Updated accordingly

style95 · 2022-07-21T10:58:25Z

proposals/POEM-support-array-result.md

+    "greeting": "Hello stranger!"
+}
+```
+It is necessary to support return array for common action, e.g.


Suggested change

It is necessary to support return array for common action, e.g.

It is necessary to support returning an array too as an array is also a proper JSON object, e.g.

Updated accordingly

style95 · 2022-07-21T10:59:05Z

proposals/POEM-support-array-result.md

+    "b"
+]
+```
+For sequence action, need to support as well.


Suggested change

For sequence action, need to support as well.

The sequence action should be considered as well.

Updated accordingly

style95 · 2022-07-21T10:59:22Z

proposals/POEM-support-array-result.md

+
+# Summary and Motivation
+
+This POEM proposes a new feature that allows user to write their own action which supports array result.


Suggested change

This POEM proposes a new feature that allows user to write their own action which supports array result.

This POEM proposes a new feature that allows user to write their own action which supports an array result.

Updated accordingly

style95 · 2022-07-21T11:00:28Z

proposals/POEM-support-array-result.md

+# Summary and Motivation
+
+This POEM proposes a new feature that allows user to write their own action which supports array result.
+So the result will support object and array both in future.


Suggested change

So the result will support object and array both in future.

So actions would be able to return a JSON object or an array.

Updated accordingly

style95 · 2022-07-21T11:01:17Z

proposals/POEM-support-array-result.md

+Make controller and invoker support array result both.
+
+## Runtime repos
+All runtime images should support array result. e.g.


Suggested change

All runtime images should support array result. e.g.

All runtime images should support an array result. e.g.

Updated accordingly

style95 · 2022-07-21T11:01:56Z

proposals/POEM-support-array-result.md

+
+# Proposed changes
+## Openwhisk main repo
+Make controller and invoker support array result both.


Suggested change

Make controller and invoker support array result both.

Make controller and invoker support both a JSON object and an array result.

style95 · 2022-07-21T11:03:24Z

proposals/POEM-support-array-result.md

+* ballerina
+
+## Openwhisk-cli repo
+* When use wsk to execute action, need to support parse array result.


Suggested change

* When use wsk to execute action, need to support parse array result.

* The `wsk` CLI needs to support parsing an array result when executing actions.

Updated accordingly

style95 · 2022-07-21T11:03:48Z

proposals/POEM-support-array-result.md

+
+## Openwhisk-cli repo
+* When use wsk to execute action, need to support parse array result.
+* When use wsk to get activation, need to support parse array result as well.


Suggested change

* When use wsk to get activation, need to support parse array result as well.

* The `wsk` CLI needs to support parsing an array result when getting activations.

Updated accordingly

ningyougang · 2022-07-28T00:36:58Z

Have any more comment?

ningyougang force-pushed the poem-support-array-result branch from dd68177 to 07f4d98 Compare May 24, 2022 09:12

ningyougang mentioned this pull request Jul 21, 2022

Support array result for common action and sequence action #5290

Merged

22 tasks

ningyougang force-pushed the poem-support-array-result branch from 07f4d98 to ec27073 Compare July 21, 2022 07:28

style95 reviewed Jul 21, 2022

View reviewed changes

ningyougang force-pushed the poem-support-array-result branch from ec27073 to 7166b6f Compare July 26, 2022 05:25

style95 approved these changes Jul 26, 2022

View reviewed changes

ningyougang closed this Jul 27, 2022

ningyougang reopened this Jul 27, 2022

ningyougang added 3 commits July 27, 2022 10:00

POEM support array result

9af9719

Add missing runtime

589bf03

Apply review comment

d4899a6

ningyougang force-pushed the poem-support-array-result branch from 7166b6f to d4899a6 Compare July 27, 2022 02:00

ningyougang merged commit 3014b87 into apache:master Jul 28, 2022

	Currently, openwhisk supports return json object only, e.g.
	Currently, OpenWhisk supports returning a JSON object only, e.g.

	It is necessary to support return array for common action, e.g.
	It is necessary to support returning an array too as an array is also a proper JSON object, e.g.

	For sequence action, need to support as well.
	The sequence action should be considered as well.


		# Summary and Motivation

		This POEM proposes a new feature that allows user to write their own action which supports array result.

	So the result will support object and array both in future.
	So actions would be able to return a JSON object or an array.

	All runtime images should support array result. e.g.
	All runtime images should support an array result. e.g.

	Make controller and invoker support array result both.
	Make controller and invoker support both a JSON object and an array result.

	* When use wsk to execute action, need to support parse array result.
	* The `wsk` CLI needs to support parsing an array result when executing actions.

	* When use wsk to get activation, need to support parse array result as well.
	* The `wsk` CLI needs to support parsing an array result when getting activations.

Conversation

ningyougang commented May 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related issue and scope

My changes affect the following components

Types of changes

Checklist:

Uh oh!

codecov-commenter commented May 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

ningyougang commented Jul 4, 2022

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!

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!

ningyougang commented Jul 28, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ningyougang commented May 24, 2022 •

edited

Loading

codecov-commenter commented May 24, 2022 •

edited

Loading