Add PHP 7.1 as a kind #2415

akrabat · 2017-06-22T19:49:31Z

This adds a new php:7.1 kind to allow PHP actions like this:

<?php
function main(array $args) : array
{
    $name = $args["name"] ?? "stranger";
    $greeting = "Hello $name!";
    return ["greeting" => $greeting];
}

The PHP runtime is based on the official php:7.1-alpine one with the following extensions added:

opcache
mysqli
pdo_mysql
pdo_pgsql
intl
bcmath
zip
gd
soap

Two Composer packages are also included:

guzzlehttp/guzzle - A very popular HTTP client
ramsey/uuid - The de facto UUID generator

Suggestions welcome on what should be included in these lists (and of course on the code itself!)

How to test

We need a working local installation. The easiest way to do this is with Vagrant, so that's what this set of steps uses.

Check out the source code

 $ git clone https://github.com/apache/incubator-openwhisk.git
 $ cd incubator-openwhisk

Now change to my branch

 $ git remote add akrabat https://github.com/akrabat/openwhisk.git
 $ git fetch akrabat
 $ git checkout php-kind

Run up the Vagrant box

 $ cd tools/vagrant
 $ vagrant up

This takes a while!

I'm not sure what Vagrant is required, but I'm using Vagrant 1.9.1 with VirtualBox 5.1.18. I'm not aware of any other requirements.

You should see output at the end like:

 ==> default: ++ wsk action invoke /whisk.system/utils/echo -p message hello --result
 ==> default: {
 ==> default:     "message": "hello"
 ==> default: }
 ==> default: +++ date
 ==> default: ++ echo 'Sun Jul 23 14:28:31 UTC 2017: build-deploy-end'

Build the PHP Docker container

 $ vagrant ssh
 $ cd openwhisk
 $ ./gradlew :core:php7.1Action:distDocker -PdockerImagePrefix=openwhisk

This takes a little while while it compiles various PHP bits and bobs.

Testing a PHP action

The vagrant box has a compatible wsk in it, so we can use it:

 $ cd ~
 $ cat << 'EOF' >> hello.php
 <?php
 function main(array $args) : array
 {
     echo "Some output to the invocation log";
     $name = $args["name"] ?? "stranger";
     $greeting = "Hello $name!";
     return ["greeting" => $greeting];
 }
 EOF
 $ wsk -i action update hello hello.php --kind php:7.1
 ok: updated action hello
 $ wsk -i action invoke hello -r -p name World

If you see:

 {
     "greeting": "Hello World!"
 }

Then it worked.

markusthoemmes · 2017-06-22T20:57:21Z

Without an in depth review: Looks awesomely executed! Thanks for this!

akrabat · 2017-06-23T12:06:05Z

Travis is reporting [WARNING]: Unable to find '/home/travis/build/apache/incubator-openwhisk/ansible/db_local.ini' in expected paths..

Not sure how to fix?

csantanapr · 2017-06-23T12:54:57Z

@akrabat This is an awesome contribution !!!
I will give it a try when I have chance.

csantanapr · 2017-06-23T12:56:47Z

@akrabat the problem is nothing to do with ansible/db_local.ini
The problem is that the /tools/travis/build.sh failed on scancode

  [./tests/src/test/scala/actionContainers/Php71ActionContainerTests.scala]:
       1: file does not include required license header.

csantanapr · 2017-06-23T12:58:36Z

tests/src/test/scala/actionContainers/Php71ActionContainerTests.scala

@@ -0,0 +1,470 @@
+/**


I think it needs to be single /* to pass the scan

csantanapr · 2017-06-23T12:58:58Z

tests/src/test/scala/actionContainers/Php71ActionContainerTests.scala

+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package actionContainers


add space after the license, just in case

akrabat · 2017-06-23T13:06:26Z

That'll teach me to read the text in bright red/pink!

csantanapr

adjust for dynamic invoker images

csantanapr · 2017-06-27T20:37:53Z

ansible/group_vars/all

@@ -72,6 +72,11 @@ runtimesManifest:
      image:
        name: "java8action"
      default: true
+    php:


add deprecated: false

csantanapr · 2017-06-27T20:38:20Z

ansible/roles/invoker/tasks/deploy.yml

@@ -13,6 +13,7 @@
    - '{{ docker_image_prefix }}/python3action'
    - '{{ docker_image_prefix }}/swift3action'
    - '{{ docker_image_prefix }}/java8action'
+    - '{{ docker_image_prefix }}/action-php-v7.1'


No longer need it, now the list is not hard coded

akrabat · 2017-06-29T08:02:45Z

@csantanapr Rebased to master & addressed comments.

csantanapr · 2017-06-30T23:11:33Z

@akrabat this is a significant contribution adding a new language support.
What do you think if you could socialize/post it to the dev list?

People can try and maybe comment on this PR with any feedback

csantanapr · 2017-06-30T23:12:30Z

Also I think you need to rebase/merge to upstream/master

akrabat · 2017-07-02T16:56:04Z

Rebased.

darrenmothersele · 2017-07-04T10:46:18Z

This is an exciting development.

Do you think it could be possible to support dynamic composer dependencies?
Perhaps something like http://melody.sensiolabs.org/

akrabat · 2017-07-04T11:37:53Z

My current view is that you should provide a zip file with your vendor folder in it as it's too slow to fetch dependencies dynamically. This is how it works for NodeJS actions. Regards, Rob...

…

On 4 Jul 2017, at 11:46, Darren Mothersele ***@***.***> wrote: This is an exciting development. Do you think it could be possible to support dynamic composer dependencies? Perhaps something like http://melody.sensiolabs.org/ — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

akrabat · 2017-07-12T06:47:03Z

Ping @lornajane for code review & thoughts on list of PHP extensions and Composer modules to include.

darrenmothersele · 2017-07-12T06:52:32Z

+1 for zip file with vendor folder, if pulling dependencies from composer file is not viable.

-1 for including a default set of composer packages.

akrabat · 2017-07-12T06:59:03Z

Every other OpenWhisk action container ships with some default components - the most obvious ones being easy abilities to invoke other actions. e.g. Swift ships with Kitura-nat, SwiftyJSON and swift-watson-sdk.

I think the expectation is that the PHP action should follow suit, so included Guzzle and Uuid. I'm open to arguments on this though.

We are completely in agreement that if the user ships their own vendor folder, then it should "win" though :)

darrenmothersele · 2017-07-12T07:00:34Z

Re: extensions, this set would be good:

mysqli
xml
gd
openssl
json
curl
mbstring
PDO
pdo_mysql
pdo_sqlite
tokenizer
ctype
bcmath
intl
mcrypt

Sources:
https://www.drupal.org/docs/7/system-requirements/php#extensions
http://symfony.com/doc/current/reference/requirements.html
https://laravel.com/docs/5.4/installation#server-requirements

rabbah · 2017-07-12T10:03:25Z

The built in packages are convenient - less zip files for the initial ramp up. But it creates a maintenance issue: when do you pick up updates to the packages (minor/patch level only?) and not break existing actions using the "kind". That is: is the kind itself semantically verionsed?

@csantanapr, @bjustin-ibm FYI.

akrabat · 2017-07-13T15:53:28Z

@darrenmothersele Everything on your list except mcrypt is included.

I have not included mcrypt it is deprecated in PHP 7.1 as it has been unmaintained since 2007 and abandoned since 2011.

It is completely removed from PHP 7.2 and I don't see any point in including it.

darrenmothersele · 2017-07-13T15:59:38Z

@akrabat cool that sounds good!

Build the Docker container from php:7.1-alpine and implement the HTTP server using PHP's built in server. Note that when using a zip file, the router requires that the `main` function is stored in `index.php`.

The runner sets the exit code to 1 if it has set the last line of stdout to a string suitable for presentation to the user. Therefore, if the exit code is not one, then display a generic message.

* Add PHP_VERSION for consistency with other kinds. * Add WHISK_INPUT for consistency with Swift kind.

Make it clearer what the router outputs by ensuring all the code that does this at the top. Also, clarify that the body sent back to the client is always JSON and add per-function documentation.

Also remove the duplicated last line if we've sent it to the client.

If there's a runtime error in the action (i.e. not spotted by linter), then looking for the main() function will find it. Render the error to the logs so that the user knows what's happened.

If the PHP vendor file has a vendor directory, then this directory needs to be used rather than the one supplied in the action container. To do this, we require src/vendor/autoload.php which will exist if the zip file contains it. For the cases where zip file does not contain a vendor folder and when running a non-binary code action, we move the container's vendor folder into src/.

akrabat · 2017-07-16T20:25:05Z

Rebased to pick up #2437

* Implement PHP 7.1 kind * Add tests for PHP 7.1 action * Add PHP action documentation Build the Docker container from php:7.1-alpine and implement the HTTP server using PHP's built in server. Note that when using a zip file, the router requires that the `main` function is stored in `index.php`. Note about the runner: The runner sets the exit code to 1 if it has set the last line of stdout to a string suitable for presentation to the user. Therefore, if the exit code is not one, then display a generic message. If there's a runtime error in the action (i.e. not spotted by linter), then looking for the main() function will find it. Render the error to the logs so that the user knows what's happened. Note about vendor folder in a PHP zip: If the PHP vendor file has a vendor directory, then this directory needs to be used rather than the one supplied in the action container. To do this, we require src/vendor/autoload.php which will exist if the zip file contains it. For the two cases where (1) zip file does not contain a vendor folder, or (2) when running a non-binary code action, we move the container's vendor folder into src/.

akrabat force-pushed the php-kind branch from 4012db3 to f00e1a8 Compare June 22, 2017 21:01

csantanapr reviewed Jun 23, 2017

View reviewed changes

akrabat force-pushed the php-kind branch 3 times, most recently from cd57afa to ecd706a Compare June 24, 2017 08:20

rabbah added review Review for this PR has been requested and yet needs to be done. runtime labels Jun 27, 2017

rabbah assigned csantanapr Jun 27, 2017

csantanapr requested changes Jun 27, 2017

View reviewed changes

akrabat force-pushed the php-kind branch from a4ab772 to 53ab7e7 Compare June 29, 2017 07:57

akrabat force-pushed the php-kind branch from eee751a to 76ecb72 Compare July 2, 2017 16:55

akrabat added 13 commits July 16, 2017 21:22

Implement PHP 7.1 kind

d956df1

Build the Docker container from php:7.1-alpine and implement the HTTP server using PHP's built in server. Note that when using a zip file, the router requires that the `main` function is stored in `index.php`.

Add tests for PHP 7.1 action

5e82459

Add PHP action documentation

9ace2bf

Additional comments

9859218

Fix typos in PHP docs

d51d590

Output runner text if exit code is 1

0247e7e

The runner sets the exit code to 1 if it has set the last line of stdout to a string suitable for presentation to the user. Therefore, if the exit code is not one, then display a generic message.

Update PHP action environment

11257d2

* Add PHP_VERSION for consistency with other kinds. * Add WHISK_INPUT for consistency with Swift kind.

Update licenses

374e723

Consolidate output of router to top

69e7ac7

Make it clearer what the router outputs by ensuring all the code that does this at the top. Also, clarify that the body sent back to the client is always JSON and add per-function documentation.

Tidy up log out to remove blank lines

b3d92b9

Also remove the duplicated last line if we've sent it to the client.

Output stderr & stdout when checking for main()

84595a7

If there's a runtime error in the action (i.e. not spotted by linter), then looking for the main() function will find it. Render the error to the logs so that the user knows what's happened.

Set deprecated to false for php:7.1

ed8dca4

akrabat force-pushed the php-kind branch from 1d835c6 to d1baf9d Compare July 16, 2017 20:22

csantanapr approved these changes Jul 23, 2017

View reviewed changes

rabbah merged commit 9401f8b into apache:master Jul 24, 2017

remore mentioned this pull request Jun 6, 2018

Add Ruby2.5 runtime support #3725

Merged

20 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add PHP 7.1 as a kind #2415

Add PHP 7.1 as a kind #2415

akrabat commented Jun 22, 2017 •

edited

Loading

markusthoemmes commented Jun 22, 2017

akrabat commented Jun 23, 2017 •

edited

Loading

csantanapr commented Jun 23, 2017

csantanapr commented Jun 23, 2017

csantanapr Jun 23, 2017

csantanapr Jun 23, 2017

akrabat commented Jun 23, 2017

csantanapr left a comment

csantanapr Jun 27, 2017

csantanapr Jun 27, 2017

akrabat commented Jun 29, 2017 •

edited

Loading

csantanapr commented Jun 30, 2017

csantanapr commented Jun 30, 2017

akrabat commented Jul 2, 2017

darrenmothersele commented Jul 4, 2017

akrabat commented Jul 4, 2017 via email

akrabat commented Jul 12, 2017

darrenmothersele commented Jul 12, 2017

akrabat commented Jul 12, 2017 •

edited

Loading

darrenmothersele commented Jul 12, 2017

rabbah commented Jul 12, 2017

akrabat commented Jul 13, 2017 •

edited

Loading

darrenmothersele commented Jul 13, 2017

akrabat commented Jul 16, 2017

Add PHP 7.1 as a kind #2415

Add PHP 7.1 as a kind #2415

Conversation

akrabat commented Jun 22, 2017 • edited Loading

How to test

markusthoemmes commented Jun 22, 2017

akrabat commented Jun 23, 2017 • edited Loading

csantanapr commented Jun 23, 2017

csantanapr commented Jun 23, 2017

csantanapr Jun 23, 2017

Choose a reason for hiding this comment

csantanapr Jun 23, 2017

Choose a reason for hiding this comment

akrabat commented Jun 23, 2017

csantanapr left a comment

Choose a reason for hiding this comment

csantanapr Jun 27, 2017

Choose a reason for hiding this comment

csantanapr Jun 27, 2017

Choose a reason for hiding this comment

akrabat commented Jun 29, 2017 • edited Loading

csantanapr commented Jun 30, 2017

csantanapr commented Jun 30, 2017

akrabat commented Jul 2, 2017

darrenmothersele commented Jul 4, 2017

akrabat commented Jul 4, 2017 via email

akrabat commented Jul 12, 2017

darrenmothersele commented Jul 12, 2017

akrabat commented Jul 12, 2017 • edited Loading

darrenmothersele commented Jul 12, 2017

rabbah commented Jul 12, 2017

akrabat commented Jul 13, 2017 • edited Loading

darrenmothersele commented Jul 13, 2017

akrabat commented Jul 16, 2017

akrabat commented Jun 22, 2017 •

edited

Loading

akrabat commented Jun 23, 2017 •

edited

Loading

akrabat commented Jun 29, 2017 •

edited

Loading

akrabat commented Jul 12, 2017 •

edited

Loading

akrabat commented Jul 13, 2017 •

edited

Loading