Add files

Author: Eugene Leonovich

.env.dist

@@ -0,0 +1,5 @@
+# Default values for any environment variables referenced in the Compose file
+# https://docs.docker.com/compose/environment-variables/#setting-environment-variables-with-docker-compose-run
+
+TARANTOOL_USER_NAME=jobserver
+TARANTOOL_USER_PASSWORD=jobserver

.gitignore

@@ -0,0 +1,8 @@
+/app/config/jobserver_config.lua
+/app/config/local.php
+/var/log/
+/vendor/
+/.env
+/.php_cs
+/docker-compose.override.yml
+/phpunit.xml

.php_cs.dist

@@ -0,0 +1,24 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->in(__DIR__)
+    ->exclude('docker')
+    ->exclude('var')
+;
+
+return PhpCsFixer\Config::create()
+    ->setFinder($finder)
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@Symfony' => true,
+        '@Symfony:risky' => true,
+        'array_syntax' => ['syntax' => 'short'],
+        'no_useless_else' => true,
+        'no_useless_return' => true,
+        'ordered_imports' => true,
+        'phpdoc_order' => true,
+        'php_unit_strict' => true,
+        'strict_comparison' => true,
+    ])
+    ->setCacheFile(__DIR__.'/var/.php_cs.cache')
+;

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Eugene Leonovich
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,88 @@
+# JobServer
+
+JobServer is a skeleton repository used for creating background jobs. 
+It contains the minimal configuration files and folders you will need for quick start from scratch.
+
+
+## Setup
+
+First, create your own `docker-compose.override.yml` file by copying 
+the [docker-compose.override.yml.dist](docker-compose.override.yml.dist) file and customize to your needs.
+Do the same for all `*.dist` files located in [app/config](app/config).
+
+Then, browse to the project directory and execute this command:
+
+```bash
+docker-compose up -d
+```
+
+
+## Run cli
+
+```bash
+docker-compose exec worker ./jobserver
+```
+
+
+## Put jobs into the "default" queue
+
+```bash
+docker-compose exec worker ./jobserver queue:put default '{"payload": {"service": "greet", "args": {"name": "foobar"}}}' -H tarantool
+``` 
+
+
+## Debug cli
+
+```bash
+docker-compose exec worker bash -c 'PHP_IDE_CONFIG="serverName=jobserver.dev" ./jobserver'
+```
+
+To debug the job runner, run
+
+```bash
+docker-compose run --rm worker bash -c ' \
+    PHP_IDE_CONFIG="serverName=jobserver.dev" \
+    TNT_JOBQUEUE_PASSWORD=jobserver \
+    vendor/bin/jobqueue run default \
+    --config app/config/jobqueue.php \
+    --executors-config app/config/executors.php \
+    --log-file var/log/workers.log \
+    --user jobserver \
+    --host tarantool \
+'
+```
+
+
+## Tarantool
+
+[Admin Web Interface](http://localhost:8001/)
+
+To get into Tarantool console as admin on a running Docker container, run:
+
+```bash
+docker-compose exec tarantool tarantoolctl connect /var/run/tarantool/tarantool.sock
+```
+
+On a server:
+
+```bash
+sudo tarantoolctl enter jobserver_instance
+```
+
+On the server as a job queue user:
+
+```bash
+sudo tarantoolctl connect $TNT_JOBQUEUE_USER:$TNT_JOBQUEUE_PASSWORD@$TNT_JOBQUEUE_HOST:3301
+```
+
+
+## Run tests
+
+```bash
+docker-compose exec worker vendor/bin/phpunit
+```
+
+
+## License
+
+The library is released under the MIT License. See the bundled [LICENSE](LICENSE) file for details.

app/app.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace App;
+
+use App\Di\Container;
+
+function container(): Container
+{
+    $getSettings = require __DIR__.'/config/settings.php';
+    $container = new Container($getSettings(dirname(__DIR__)));
+
+    $container->setEnv(getenv('APP_ENV') ?: 'prod');
+    $container->setDebug(getenv('APP_DEBUG') ?: false);
+
+    $localConfigFile = __DIR__.'/config/local.php';
+    if (file_exists($localConfigFile)) {
+        $extendContainer = require $localConfigFile;
+        $container = $extendContainer($container);
+    }
+
+    return $container;
+}

app/config/commands.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace App;
+
+use App\Di\Container;
+use App\UseCase\Greet\GreetCommand;
+
+return function (Container $container): array {
+    return [
+        new GreetCommand($container->getGreetHandler()),
+    ];
+};

app/config/executors.php

@@ -0,0 +1,3 @@
+<?php
+
+return App\container()->getJobQueueExecutor();

app/config/jobqueue.php

@@ -0,0 +1,3 @@
+<?php
+
+return App\container()->getJobQueueConfigFactory();

app/config/jobserver_config.lua.dist

@@ -0,0 +1,6 @@
+local os = require('os')
+
+return {
+    user = os.getenv('TARANTOOL_USER_NAME'),
+    password = os.getenv('TARANTOOL_USER_PASSWORD')
+}

app/config/jobserver_instance.lua

@@ -0,0 +1,27 @@
+#!/usr/bin/env tarantool
+
+box.cfg {
+    listen = 3301,
+    log_level = 5
+}
+
+if jobserver ~= nil then
+    -- hot code reload using tarantoolctl or dofile()
+
+    -- unload old application
+    jobserver.stop()
+    -- clear cache for loaded modules and dependencies
+    package.loaded['jobserver'] = nil
+end
+
+local config = require('jobserver_config')
+
+-- ensure a user exists
+if not box.schema.user.exists(config.user) then
+    box.schema.user.create(config.user, {password = config.password})
+    box.schema.user.grant(config.user, 'read,write,execute', 'universe', nil)
+end
+
+-- load a new version of app and all dependencies
+jobserver = require('jobserver')
+jobserver.start(config)

app/config/local.php.dist

@@ -0,0 +1,12 @@
+<?php
+
+use App\Di\Container;
+use App\Di\Options;
+
+return function (Container $container): Container {
+    return $container
+        ->setEnv('dev')
+        ->setDebug(true)
+        ->set(Options::GREET_YELL, true)
+    ;
+};

app/config/settings.php

@@ -0,0 +1,10 @@
+<?php
+
+use App\Di\Options;
+
+return function (string $rootDir): array {
+    return [
+        Options::GREET_YELL => false,
+        Options::LOGGER_FILE => "$rootDir/var/log/workers.log",
+    ];
+};

app/jobserver.lua

@@ -0,0 +1,19 @@
+queue = require('queue')
+
+local function start(config)
+    box.once('jobserver:v1.0', function()
+        local tube = queue.create_tube('default', 'fifottl', {if_not_exists = true})
+        -- temporary disabled as seems like this method is not yet released
+        -- tube:grant(config.user)
+
+        -- tube:put({recurrence = 60, payload = {service = 'greet', args = {name = 'Foobar'}}}, {ttr = 300})
+    end)
+end
+
+local function stop()
+end
+
+return {
+    start = start,
+    stop = stop
+}

composer.json

@@ -0,0 +1,41 @@
+{
+    "name": "tarantool/jobserver",
+    "description": "A skeleton for jobqueue applications.",
+    "type": "project",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Eugene Leonovich",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "php": "^7.1",
+        "rybakit/arguments-resolver": "^0.5.1",
+        "symfony/console": "^3.3",
+        "tarantool/jobqueue": "dev-listener"
+    },
+    "require-dev": {
+        "friendsofphp/php-cs-fixer": "^2.2",
+        "phpunit/phpunit": "^6.1"
+    },
+    "autoload": {
+        "psr-4": {
+            "App\\": "src/"
+        },
+        "files": [
+            "app/app.php"
+        ]
+    },
+    "autoload-dev" : {
+        "psr-4": {
+            "App\\Tests\\": "tests/"
+        }
+    },
+    "config": {
+        "platform": {
+            "php": "7.1"
+        },
+        "sort-packages": true
+    }
+}