Getting started with Background Jobs on SashiDo
SashiDo has been on the market for few months and during this time we had the opportunity to get to know more about our clients and what they need in order to receive fully complete experience with the service.
After launching Advanced Cloud Code the top asked question was “Are Background jobs in the roadmap?” So we did it - now you can run scheduled tasks on your app.
Why do I need Background Jobs?
Because they give you the comfort to write a function once and set it up to run as often as you want. Background Jobs allow you to build long running tasks by writing code similar to Cloud Functions.
Let’s say you have an app game with free and paid users accounts. The second group has access to more features and you want to make regular check if a user has an active paid account.
Of course it will be very hard to do this check every couple of hours and as developers we always think of a logic solution to a problem. This is a good time to use background jobs - we can write a simple function that checks twice a day all the users if they have inactive payment their plan changes to “free”.
You do it once, schedule it and update it anytime you want to change its functionality.
How to use Background Jobs on SashiDo?
First we’ll need some users that we want to check for payment status. Enter SashiDo’s dashboard and choose an app you want to work on. Create a new Class named User and add two Objects.
Add parameters “plan” and “payment”. Set payment with different values in order to check later if our function is working correctly.
Go to your private GitHub repository where your Cloud Code is stored and clone it if you haven’t done it yet. Go to the cloud directory in the cloned project: cd appfolder/cloud And make a new javascript file in it with name checkUserStatus.js. Now let’s write the function that does the check:
Function checkUserStatus(); checks all instances of Class User with a loop and if the payment status of the user. If it’s inactive the plan changes to free.
Now go to your appfolder/cloud/main.js file in the same repo and include the file we’ve just created:
It’s time to commit and push the changes. They will automatically deploy to your app so you don’t have to do it additionally. Enter SashiDo’s Dashboard and open Core > Cloud Code. You’ll see a button saying that the Cloud Code is building at the moment - wait until it says the process is finished.
Next you have to go to Scheduled Jobs (Your app > Core > Jobs). Here you can manage your Background Jobs, create, edit and delete. Click the button to create a new Cloud Job and name it, then add JSON parameters (in our case it’s the new status of the user):
You can choose if and how often the jobs will repeat. We’ll choose twice a day. After the setup is finished we can start the function immediately in order to see if it’s working. We can see the result in Jobs Status - go there and refresh the page. You can also see input and result of the function in your Logs (Your app > Core > Logs).
Looks like our function is working, let’s more importantly see if it’s do the job. Go in the Browser and check class User:
Voilà, our first Background jobs is working!
Now you can build your own jobs according to your needs, it’s easy and fun.
Background Jobs use cases
You can use Background Jobs whenever you want to run a process without user intervention like logging, user notification, monitoring etc., when you need to automate a process that needs to be running repeatedly in your app.
This is the basic setup of SashiDo’s Background Jobs.
Now you can start building Cloud functions which saves you time and efforts.
Happy coding!