README

This package provides a Watermelon DB backend sync implementation for Laravel. Watermelon DB is a robust local database synchronization tool to help develop offline-first application. One of the biggest hurdles is implementing the logic on your server to handle the synchronization process.

That's where this package comes in to provide a quick synchronization route you can get up and running in minutes.

This project is still in active development and does not support schema versions or migrations yet. Both of these are major parts of the Watermelon DB spec. Please expect large changes at least until those features are implemented.

Installation

Before getting started you'll need to install the package and publish the config file.

composer require nathanheffley/laravel-watermelon

php artisan vendor:publish --tag="watermelon-config"

Usage

Once you've installed the package, you need to specify which models will be available through the synchronization endpoint. Open up the config/watermelon.php file and update the models array. The key needs to be the name of table used locally in your application, and the value must be classname of the related model.

You can also change the route to be something other than /sync by editing the config file or setting the WATERMELON_ROUTE environment variable. You will have to ensure your application makes synchronization requests to whatever route you specify.

By default, only your global middleware will be applied to the synchronization endpoint. This means that unless you changed the default global middleware in your Laravel project the synchronization endpoint will be unauthenticated. If you want to have access to the currently authenticated user you will need to add the web middleware to the config file's middleware array. If you want to restrict access to the synchronization endpoint to authenticated users only, you can add the auth middleware in addition to the web middleware. Of course, you can add any middleware you would like as long as it's registered in your project.

<?php

use App\Models\Project;
use App\Models\Task;

return [

    'route' => env('WATERMELON_ROUTE', '/watermelon'),
    
    'middleware' => [
        'web',
        'auth',
    ],

    'models' => [
         'projects' => Project::class,
         'tasks' => Task::class,
    ],

];

Once you've specified which models should be available through the synchronization endpoint, you'll need to implement some functionality in the models to support being served as Watermelon change objects.

You will need to add a database column to all of your models to keep track of what the Watermelon ID is, called watermelon_id. The default IDs generated by Watermelon are alphanumeric strings, although you can change the type of the column if you don't use the default IDs autogenerated by Watermelon. A unique index on the column is recommended, and I like placing it directly after the id column.

<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

class AddWatermelonIdToTasksTable extends Migration
{
    public function up()
    {
        Schema::table('tasks', function (Blueprint $table) {
            $table->string('watermelon_id')->after('id')->unique();
        });
    }

    public function down()
    {
        Schema::table('tasks', function (Blueprint $table) {
            $table->dropColumn('watermelon_id');
        });
    }
}

If you did not originally include the created_at, updated_at, and deleted_at timestamp columns, you will also need to add those columns. Please refer to the Laravel documentation for implementing the timestamps and soft deleting functionality.

The only thing you must change in your model class is to use the Watermelon trait.

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;
use NathanHeffley\LaravelWatermelon\Traits\Watermelon;

class Task extends Model
{
    use SoftDeletes, Watermelon;
}

The attributes returned through the synchronization endpoint are whitelisted by default. Out of the box, only the watermelon_id will be returned (although it will be passed through the endpoint as just id, this is intentional). To include more attributes, you will need to add a watermelonAttributes property to your class. These attributes will be included alongside the Watermelon ID and can be updated by change objects posted to the synchronization endpoint.

class Task extends Model
{
    use SoftDeletes, Watermelon;

    protected array $watermelonAttributes = [
        'content',
        'is_completed',
    ];
}

If you need more control over the attributes returned you can override the entire toWatermelonArray function.

Authorization

By default, all models will be accessible and able to be updated through the synchronization endpoint. This is obviously not ideal in most projects where you need control to authorize which models users can see and what they can update.

Scoping entire records

You can implement a query scope on your models by overriding the scopeWatermelon function. This scope will be applied before returning data to pull requests. This can be used, for example, to restrict records to only be retrievable by users authorized to see them (to have access to the Auth::user() like in this example, don't forget to add the web and auth middlewares as shown in the config example at the start of the Usage section).

use Illuminate\Support\Facades\Auth;

class Task extends Model
{
    // ...

    public function scopeWatermelon($query)
    {
        return $query->where('user_id', Auth::user()->id);
    }
}

Package Development

If you have PHP and Composer installed on your local machine you should be able to easily run the PHPUnit test suite.

./vendor/bin/phpunit

If you prefer to run the tests within a Docker container, this project includes Laravel Sail.

To install the dependencies:

docker run --rm \
    -u "$(id -u):$(id -g)" \
    -v $(pwd):/opt \
    -w /opt \
    laravelsail/php80-composer:latest \
    composer install --ignore-platform-reqs

docker-compose up -d

sail exec laravel.test ./vendor/bin/phpunit

nathanheffley / laravel-watermelon

Maintainers

Details