Laravel 5: Background processes checklist

Laravel 5: Background processes checklist.


Laravel project involves a bit more than PHP code.
Here is the list, what you need to remember, when setting your app.


Checklist: Windows Environment Variable Path

Some software must (should) be added to Windows environment Variable Path.

Read more here.

Also, see this sample of ‘variable value’ in this text file.

Checklist 1: cron

Setup Cron, or for Windows (e.g. for dev) equivalent pseudo-Cron using task scheduler.
More here.

Difference is in: “Go to TAB: Actions, and click ‘New’ button” #2.

Each Laravel project needs separate cron setup in Windows task.
E.g. in example (link here above) I have: U:\www\la4\artisan.
Above path will make cron run only for project located in /la4 folder.
So, each folder/project needs own cron to work.

Above does not apply to Redis.
Explanation above apply to Windows dev setup.

Also see screenshots with how to setup Windows task: zip-file

 


Checklist 2: Redis

You need to install and start Redis server – if you are using it.
And since Redis can help in queues, cache, broadcasting and as database – it is worthwhile to install it.

For Linux, see here.

For Windows, see here and scroll down to: “setup Windows task”.
It uses same methodology as Cron. Anyway, all links are there.

Dependencies:

  • ioredis
  • predis

Also see screenshots with how to setup Windows task: zip-file

 


Checklist 3: Queues

If you are using queues other than ‘sync’, e.g. QUEUE_DRIVER=redis, then you need php artisan queue:listen command running. Eventually, you may use something like php artisan queue:work –sleep=3 –tries=3 .

For quick testing, you can run it in your console/command prompt, but to have it run all the time – also for dev, it is better to have daemon on Linux/Unix (OSX), or Task on Windows.

Linux setup – see here.

Windows setup – see here.

There is some difference thou to “Windows setup” description above:

Difference is in: “Go to TAB: Actions, and click ‘New’ button” #2.

Each Laravel project needs separate cron setup in Windows task.
E.g. in example (link here above) I have: U:\www\la4\artisan.
Above path will make cron run only for project located in /la4 folder.
So, each folder/project needs own cron to work.

Above does not apply to Redis.
Explanation above apply to Windows dev setup.

NOTE:
Queues daemon should be run and overseen by supervisor script.

Also see screenshots with how to setup Windows task: zip-file

 


Checklist 4: Sockets

Nice read is here. Thanks Gergely.

Also read here.

Dependencies:

  • socket.io
  • express (possibly)
  • node.js
way 1:
Note:
Use this way for development purposes, e.g. when you develop in Windows and you want to have it on constantly.
For production on Linux server use Supervisor.
This way will not react to any process dropped. Supervisor will reinstate such process.

Put inside of method schedule() of :

… this code:

Here is socket.js script:

Cron must be on for this to work.

way 2:

First we need Forever script.
It is somewhat like Supervisor, just for node scripts only:

Now again we use schedule, so cron must be up:

If you do not like Forever, but do not want to go for Supervisor, try PM2.

 

way 3:

Use Supervisor.
It will work on Linux server, not on Windows.
For windows, see above.

It is a script written in Python. It allows to control also other processes than node.js.
More here.

Sample Supervisor config might look like this (it should be placed at /etc/supervisor/conf.d/myapi.conf):

Checklist 5: config and .env

Make sure all settings in .env file are taken care of, like:

  • APP_DEBUG
  • APP_LOG_LEVEL
  • and the rest
Checklist 6: JS, CSS, NPM dependencies, SASS etc
Up to Laravel 5.3 … you need gulp
Laravel 5.4 – Laravel mix (webpack)

Run:

and

Also read this.

Laravel 5.4
.env constant

.env constant be set properly:

Dusk has different test directory.
Dusk does not come in a package and has to be installed
step 1: console composer

step 2: service provider

Register the provider within the register() method of your app\Providers\AppServiceProvider, like this:

install dusk

Next, run the dusk:install Artisan command:

More about Dusk – try Laravel docs and articles on this page.

Laravel 5.0 – 5.3

Up to Laravel 5.4 browser testing was done using Integrated Package.
Use link just above for detailed info.

Videos:

Laracast videos (Intermediate series: “2015-03-23-Intuitive Integration Testing“) are here:

  • video: Introduction and General Usage
  • video: Laravel and Integrated
  • video: Database Transactions
  • video: Example Workflow and Custom Methods
  • video: Selenium
  • video: Testing APIs
Installation:

More about installation etc. – here.

Usage Notes:
in windows you may do: vendor\bin\phpunit
note how slashes go!
command prompt expects backslash, not forward slash (like in most
tutorials done on Linux, or Apple, or VM (like HomeStead)

 

Socket.Io – Working Chat and General Stuff

Socket.Io – Working Chat and General Stuff


Socket.io allows for PHP based system to have server pushing data to client without request from client.

Most of that stuff below needs node.js installed on your server.

If you work on Windows just get Windows installer and add node to your Environment Variable path, to make it global.

Similar operation describing registering Composer with EV path is described here.


Socket.Io
Checking version

Same way you can check all stuff installed via np, like: express, ioredis etc.

Installation

Socket.io can be downloaded from here.

It can be installed using node.js npm, like this:

It is good to use ‘–save’ flag to add socket.io to dependencies list in your project package.json file, to keep it up to date with other stuff you are using, or you are about to use.

Usual socket project structure

Socket client

You need a socket.io client, which your project will pull into user’s browser
Something like:

If you do not want to use socket.io CDN (content delivery network) hosted client script, you can download version from here and serve it from your own server, or some other CDN.

Socket server worker

This is usually an index.js file, which is being activated via console command:

This file is a place where you bootstrap and fire all needed elements, like:

  • express framework
  • socket.io and all its channels, connections and broadcasting
  • html/template file (called, when accessing defined port)
  • define a port app is going to be listened on
  • etc.

When bootstrap is neatly tied, you can listen to your app in browser, by listening to defined port like this:

 

Sample Chat

Socket.io home page have chat demo here.

Unfortunately demo does not work.

In downloadable package below, you will find fixed version of that chat.
Of course, full credit goes to creators – I just fixed  few little things.

Edit 2018-03-18: demo works now and they added nice whiteboard.

zip

In archive you will find a drop-in package.
What it means is that all you have to do is:

  1. unzip
  2. drop content of folder /b8 (in archive) to your localhosted location
  3. change ‘b8’ in index.html file to your own localhosted location/domain, e.g. /mychat
  4. you need internet access (dependencies: botstrap, socket client, jquery)
  5. node dependencies: socket.io and express are already in zipped package
  6. open command prompt (windows) or console and go inside of your ‘mychat’ directory (or some other you are using)
  7. type is: node index.js – keep console open
  8. navigate in your browser to: mychat:3000

… and you have working chat open.

Now you can open another window with chat (or two) and see how posted stuff gets passed via sockets between browser windows. Same it would work between people in remote locations.

Here, you can find some nice socket.io cheat-sheet. Thanks Alex.
Just is case, it is also accessible here: socket-cheatsheet

 


Redis

If you wish to store some data, you can use Laravel’s Swiss army knife: Redis (queues, broadcasting, cache, data storage etc.)
More about Redis – here.

 


Redis.Js

There is also Redis API (client) called Redis.Js, that is a great way to work with Redis from within Socket.Io code.
You can find it here.

When installing, it is good to add it as dependency to your package.json like this (note –save):

This will update your package.json.

You need to have Redis installed on your system to use above wrapper (API)!
Other Redis clients

Find the all here.

Also, you may look at ioredis instead of redis.js

 


Express JS Framework

You will need this JS framework to work with sockets.

You can install it like this:

Again, ‘–save’ will add it to package.json as dependency.

 

Check number of queries run

Check how many queries Laravel runs.

Sometimes you mat want to see how many queries Laravel has just run.

It may come handy, when using ‘eager loaded’ relations.

Just to make sure, if you are really ‘eager loading’ stuff.

Also, it is handy to see query as it was passed to SQL server in raw SQL code.

Of course, we have helper function toSql(), but in some cases this method is better:

And this is a result you will get on the screen:

Above example shows, that we have run 2 queries.


Of course you can accomplish this in many different ways, including systemic.
But I prefer surgical placement of testing tool, where I need it.


You can also read more here: