Skip to content
This repository has been archived by the owner on Oct 17, 2024. It is now read-only.

Coding Requirement

scil edited this page Aug 12, 2018 · 33 revisions

global vars are not global any more

Global vars are only global in single swoole worker.

Swoole workers run in different process, vars are not shared by different workers.

Methods to share vars between workers:

  • Swoole tools like Table, Channel, ...
  • Yac, Redis, Memcached, ...

php functions useless in LaravelFly

name replacement
header Laravel API: $response->header
setcookie Laravel API: $response->cookie
http_response_code Laravel API: setStatusCode(404); or abort(404);
exit/die -----(do not use exit/die)

And, do not use flush()/ob_flush()/ob_end_flush()/ob_implicit_flush() for Laravel response.

Memory Control Requirements

Infinitely appending element into static/global variable will lead to memory leak.

This rule also works for variables in worker objects( objects or laravel services that made before any requests ).

// Some class
class Test
{
    public static $array = [];
    public static $string = '';
}

// Controller
public function test(Request $req)
{
    // Memory leak
    Test::$array[] = $req->input('param1');
    Test::$string .= $req->input('param2');
}

Consistency Requirements

  1. php configuration should keep same in any requests. Any changes of php configuration must be made before any requests (that is, made on worker ).

  2. constants should keep same in all requests.

  3. Super global vars like $_GET, $_POST should not be used.

  4. static props should keep consistent.

    1. Illuminate\Pagination\Paginator: currentPathResolver,currentPageResolver,viewFactoryResolver,defaultView,defaultSimpleView .

    2. Illuminate\Database\Eloquent\Model: globalScopes ( Global Scopes ) is an associated array, its values on the same key should always be same. For example, follwing code should not coexist in a project, because global scope 'age' means different closure.They should be merged into single closure.

    static::addGlobalScope('age', function (Builder $builder) {
            $builder->where('age', '>', 200);
    });
    
    static::addGlobalScope('age', function (Builder $builder) {
            $builder->where('age', '>', 200000000000000000000000000);
    });
    
    // The two addGlobalScope above should be merged into one, like this:
    
    static::addGlobalScope('age', function (Builder $builder) {
        if(Request::has('age'))
            $builder->where('age', '>', 200);
        else
            $builder->where('age', '>', 200000000000000000000000000);
    });
    
    1. In Mode Map, If you use Laravel Macros, an object's Macros with same name should always be same if the object is made on worker, like addGlobalScope.

Coroutine Requirements / Mode Map Requirements

Mode Map uses coroutine, so different requests can be handled by server concurrently. Suppose the server is handling a request, meet co::sleep(3) , then it goes to handle another request, later go back to the first request.

  • Coroutine can not be used with route definition in route files, as there is no coroutine refactor for 'groupStack' in fly\Router.php.
     Route::get('/', 'Controller@home');
    
     // this line is not valid, as it will be executed by Router.php which has no coroutine support for groupStack
     co::sleep(100); 
    
     Route::get('/test', function () {
        co::sleep(100); // this line is valid.
    });