[GitHub] csantanapr opened a new pull request #3973: restore base64 json responses for webactions

[GitBox <gi...@apache.org>]

csantanapr opened a new pull request #3973: restore base64 json responses for webactions
URL: https://github.com/apache/incubator-openwhisk/pull/3973
 
 
   Reverts removal of base64 for json responses from PR #3939
   
   ## Description
   recent PR #3919 added the ability for web actions to specify a `string` type in the `body` of the response and removed the support for the legacy requirement of handing base64.
   We got feedback from users that they have webactions with this old behavior in place and their actions were not working as expected.
   ```javascript
   function main(params){
     return {
       headers: { 'Content-Type': 'application/json' },
       body: new Buffer(JSON.stringify(params)).toString('base64')
     }
   }
   ```
   This requirement was removed a year ago from code also documentation.
   
   The proposal is to restore the base64, and announce of the braking change to user to give a period for them to update their webactions and remove this extra step of doing base64 for JSON not need it.
   
   User can still return a json/dict object body a common case
   ```javascript
   function main(params){
     return {
       headers: { 'Content-Type': 'application/json' },
       body: param
     }
   }
   ```
   User can use the new string if they want to avoid to parse into a object or dict
   ```
   ```javascript
   function main(params){
     return {
       headers: { 'Content-Type': 'application/json' },
       body: '{"hello":"world"}'
     }
   }
   ```
   
   ## Related issue and scope
   <!--- Please include a link to a related issue if there is one. -->
   - [ ] I opened an issue to propose and discuss this change (#????)
   
   ## My changes affect the following components
   <!--- Select below all system components are affected by your change. -->
   <!--- Enter an `x` in all applicable boxes. -->
   - [ ] API
   - [x] Controller
   - [ ] Message Bus (e.g., Kafka)
   - [ ] Loadbalancer
   - [ ] Invoker
   - [ ] Intrinsic actions (e.g., sequences, conductors)
   - [ ] Data stores (e.g., CouchDB)
   - [x] Tests
   - [ ] Deployment
   - [ ] CLI
   - [ ] General tooling
   - [ ] Documentation
   
   ## Types of changes
   <!--- What types of changes does your code introduce? Use `x` in all the boxes that apply: -->
   - [ ] Bug fix (generally a non-breaking change which closes an issue).
   - [ ] Enhancement or new feature (adds new functionality).
   - [x] Breaking change (a bug fix or enhancement which changes existing behavior).
   
   ## Checklist:
   <!--- Please review the points below which help you make sure you've covered all aspects of the change you're making. -->
   
   - [x] I signed an [Apache CLA](https://github.com/apache/incubator-openwhisk/blob/master/CONTRIBUTING.md).
   - [x] I reviewed the [style guides](https://github.com/apache/incubator-openwhisk/wiki/Contributing:-Git-guidelines#code-readiness) and followed the recommendations (Travis CI will check :).
   - [x] I added tests to cover my changes.
   - [ ] My changes require further changes to the documentation.
   - [ ] I updated the documentation where necessary.
   
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services