Right way to save timestamps to database in laravel?

Question

As part of a standard laravel application with a vuejs and axios front-end, when I try to save an ISO8601 value to the action_at field, I get an exception.

class Thing extends Model {
    protected $table = 'things';
    // timestamp columns in postgres
    protected $dates = ['action_at', 'created_at', 'updated_at'];
    protected $fillable = ['action_at'];
}

class ThingController extends Controller {
    public function store(Request $request) {
        $data = $request->validate([
            'action_at' => 'nullable',
        ]);
        // throws \Carbon\Exceptions\InvalidFormatException(code: 0): Unexpected data found.
        $thing = Thing::create($data);
    }
}

My primary requirement is that the database saves exactly what time the client thinks it saved. If another process decides to act on the "action_at" column, it should not be a few hours off because of timezones.

I can change the laravel code or I can pick a different time format to send to Laravel. What's the correct laravel way to solve this?

score 0 · Answer 1 · answered Apr 15 '22 at 15:48

0

The default created_at and updated_at should work fine.

You should always set your timezone in your config/app.php to UTC
Add a timezone column or whichever you prefer in your users table
Do the time-offsets in your frontend or api response

Here's a sample code to do the time offset in backend

$foo = new Foo;

$foo->created_at->setTimezone('America/Los_Angeles');

or frontend using momentjs

moment(1650037709).utcOffset(60).format('YYYY-MM-DD HH:mm')

or using moment-timezone
moment(1650037709).tz('America/Los_Angeles').format('YYYY-MM-DD HH:mm')

answered Apr 15 '22 at 15:48

Potato Science

602
4
13

"The default created_at and updated_at should work fine." They do seem to work fine, but I wasn't asking about them. – Michola Ultra Apr 15 '22 at 16:06
the same applies to the date `action_at` you've mention just store them using UTC, then apply the offsets according to the user viewing the dates – Potato Science Apr 15 '22 at 16:18

score 0 · Accepted Answer · answered Apr 28 '22 at 13:36

class Thing extends Model {
    protected $table = 'things';
    // timestamp columns in postgres
    protected $dates = ['action_at', 'created_at', 'updated_at'];
    protected $fillable = ['action_at'];
}

class ThingController extends Controller {
    public function store(Request $request) {
        $data = $request->validate([
            'action_at' => 'nullable',
        ]);
        // convert ISO8601 value, if not null
        if ($data['action_at'] ?? null && is_string($data['action_at'])) {
            // note that if the user passes something not in IS08601
            // it is possible that Carbon will accept it
            // but it might not be what the user expected.
            $action_at = \Carbon\Carbon::parse($data['action_at'])
                // default value from config files: 'UTC'
                ->setTimezone(config('app.timezone'));
            // Postgres timestamp column format
            $data['action_at'] = $action_at->format('Y-m-d H:i:s');
        }

        $thing = Thing::create($data);
    }
}

Other tips: don't use the postgres timestamptz column if you want to use it with protected $dates, laravel doesn't know how to give it to carbon the way postgres returns the extra timezone data.

See the carbon docs for other things you can do with the $action_at instance of \Carbon\Carbon, such as making sure the date is not too far in the future or too far in the past. https://carbon.nesbot.com/docs/

Right way to save timestamps to database in laravel?

2 Answers2