Wrong timezone for updated_at

[thbley]

Laravel Version

v11.44.0, v12.0.1

PHP Version

8.4.3

Database Driver & Version

No response

Description

        date_default_timezone_set('Europe/Berlin');

        $m = new class extends \Illuminate\Database\Eloquent\Model {
            protected $attributes = [
            ];
            protected $fillable = [
                'updated',
                'updated_at',
            ];
            protected $casts = [
                'updated' => 'datetime:Y-m-d H:i:s',
                'updated_at' => 'datetime:Y-m-d H:i:s',
            ];
        };

        $m->updated = '2024-03-18 09:00:07';
        $m->updated_at = '2024-03-18 09:00:07';

        dd($m->toArray()['updated'], $m->toArray()['updated_at'], (string) $m->updated, (string) $m->updated_at);

Expected output:

array:4 [
  0 => "2024-03-18 09:00:07"
  1 => "2024-03-18 09:00:07"
  2 => "2024-03-18 09:00:07"
  3 => "2024-03-18 09:00:07"
]

Actual output:

array:4 [
  0 => "2024-03-18 09:00:07"
  1 => "2024-03-18 08:00:07"
  2 => "2024-03-18 09:00:07"
  3 => "2024-03-18 09:00:07"
]

Steps To Reproduce (updated)

        date_default_timezone_set('Europe/Berlin');

        $m = new class extends \Illuminate\Database\Eloquent\Model {
            protected $attributes = [
            ];
            protected $fillable = [
                'updated',
                'updated_at',
            ];
            protected $casts = [
                'updated' => 'datetime:Y-m-d H:i:s',
                'updated_at' => 'datetime:Y-m-d H:i:s',
            ];
        };

        $m->updated = '2024-03-18 09:00:07';
        $m->updated_at = '2024-03-18 09:00:07';

        dd($m->toArray()['updated'], $m->toArray()['updated_at'], (string) $m->updated, (string) $m->updated_at);

[macropay-solutions]

Hi.

            protected $attributes = [
                'updated',
            ];

This is useless. Attributes are not a list but a map.

Then the model has default value for updated at :

    /**
     * The name of the "updated at" column.
     *
     * @var string|null
     */
    const UPDATED_AT = 'updated_at';

To pin point the issue, please try with:

    /**
     * Indicates if the model should be timestamped.
     *
     * @var bool
     */
    public $timestamps = false;

and then with

    const UPDATED_AT = 'updated';

UPDATE

    protected function addDateAttributesToArray(array $attributes)
    {
        foreach ($this->getDates() as $key) {
            if (! isset($attributes[$key])) {
                continue;
            }

            $attributes[$key] = $this->serializeDate(
                $this->asDateTime($attributes[$key])
            );
        }

        return $attributes;
    }

As the default timezone for laravel is UTC, when a date is converted in the above function, 09 hour is considered Berlin so the UTC is 08 h.

Please confirm by testing.

[thbley]

public $timestamps = false; gives the expected result, but I want to use $timestamps = true;

date_default_timezone_set('UTC'); gives the expected result, but I want to use Europe/Berlin

[thbley]

The main issue is that $m->toArray()['updated_at'] is different from (string) $m->updated_at .

[macropay-solutions]

@thbley We think this is not an issue but a normal behavior.

If you set in your model

    /**
     * The name of the "updated at" column.
     *
     * @var string|null
     */
    const UPDATED_AT = 'updated_at_';

It will work.

We bypassed issues like this by setting timestamps to false and then in the model we set them as we wanted. See example https://github.com/macropay-solutions/laravel-crud-wizard-free/blob/71f80f9895aeb8201c07a27c8d515ce3a1e01e36/src/Models/BaseModel.php#L161

[macropay-solutions]

You can also try to set laravel timezone to Berlin in config and test. See also db saved values in this case.

[thbley]

I have app.timezone set to Europe/Berlin and that's why I created the ticket.

In general: if I write X to the database, I want to read X later and not Y. Everything else is not normal behavior.

$m->toArray()['updated_at'] should always be the same as (string) $m->updated_at

[thbley]

const UPDATED_AT = 'updated_at_';

I want automatic population of updated_at, with the option to override automatic.

[thbley]

A possible fix for this problem would be this (but I'm not sure if this works for all use cases):

trait HasAttributes
{
...
    protected function serializeDate(DateTimeInterface $date)
    {
        return $date instanceof DateTimeImmutable ?
            CarbonImmutable::instance($date)->toISOString(true) :
            Carbon::instance($date)->toISOString(true);
    }

[macropay-solutions]

@thbley

I want automatic population of updated_at, with the option to override automatic.

    public $timestamps = false;

    public static function boot(): void
    {
        parent::boot();
        static::creating(function (BaseModel $baseModel): void {
             if ($baseModel->isDirty($c = $baseModel->getCreatedAtColumn()) && null !== $baseModel->getAttribute($c)) { // instead of null check you could validate the format
                 // if you set it already do nothing
                 return;
             }

            $baseModel->setCreatedAt(Carbon::now()->format($baseModel::CREATED_AT_FORMAT));
        });

        static::updating(function (BaseModel $baseModel): void {
            $updatedAtColumn = $baseModel->getUpdatedAtColumn();

            if ('' === $baseModel->getAttribute($updatedAtColumn)) { // feature to not set updatedAt (datetime or null) on request
                $baseModel->setUpdatedAt($baseModel->getOriginal($updatedAtColumn));

                return;
            }

             if ($baseModel->isDirty($updatedAtColumn) && null !== $baseModel->getAttribute($updatedAtColumn)) { // instead of null check you could validate the format
                 // if you set it already do nothing
                 return;
             }

            $baseModel->setUpdatedAt(Carbon::now()->format($baseModel::UPDATED_AT_FORMAT));
        });
    }

[thbley]

I don't think it makes sense to patch every model for this bug.

[macropay-solutions]

That is why we added a base model to avoid duplicate code.

Have you tried setting a date time format that includes the Berlin Timezone in your first example?

        $m->updated = '2024-03-18 09:00:07';
        $m->updated_at = '2024-03-18T09:00:07+01:00';

[rodrigopedra]

Where did you set app.timezone?

On your ./config/app.php config file?

On a fresh installation of Laravel 12, it works as expected:

<?php // ./routes/console.php

use App\Models\User;
use Illuminate\Support\Facades\Artisan;

Artisan::command('app:test', function () {
    $this->info(config('app.timezone'));

    // on insert
    $user = User::factory()->create();
    $this->info($user->updated_at->toDateTimeString());

    // force update to a different date
    \sleep(1);
    $user->touch();

    // after update
    $user = User::query()->find($user->getKey());
    $this->info($user->updated_at->toDateTimeString());

    // force update to a different date
    \sleep(1);
    $user->touch();

    // after update, reading raw data from DB
    $pdo = User::query()->getConnection()->getPdo();
    $statement = $pdo->query('SELECT updated_at FROM users ORDER BY id DESC LIMIT 1');
    $updatedAt = $statement->fetchColumn();

    $this->info($updatedAt);
});

Output:

$ TZ="Europe/Berlin" date --iso-8601=seconds
2025-02-24T23:52:03+01:00

$ php artisan app:test
Europe/Berlin
2025-02-24 23:52:04
2025-02-24 23:52:05
2025-02-24 23:52:06

You don't need to call date_default_timezone_set() manually.

Mind that the APP_TIMEZONE environment variable was removed in the latest releases.

If you were using that environment variable to set your app's timezone, you need to either:

• manually set the timezone on your ./config/app.php
• change your ./config/app.php to read the environment variable

[rodrigopedra]

Can you try using this override:

protected function serializeDate(DateTimeInterface $date): string
{
    return Carbon::instance($date)->toDateTimeString();
}

There is no need to check if $date is immutable, as \DateTimeImmutable implements \DateTimeInterface and the method's return is a string.

I tested with this code:

<?php // ./routes/console.php

use Illuminate\Support\Carbon;
use Illuminate\Support\Facades\Artisan;

Artisan::command('app:test', function () {
    date_default_timezone_set('Europe/Berlin');

    $m = new class extends \Illuminate\Database\Eloquent\Model {
        protected $attributes = [
        ];
        protected $fillable = [
            'updated',
            'updated_at',
        ];
        protected $casts = [
            'updated' => 'datetime:Y-m-d H:i:s',
            'updated_at' => 'datetime:Y-m-d H:i:s',
        ];

        protected function serializeDate(DateTimeInterface $date): string
        {
            return Carbon::instance($date)->toDateTimeString();
        }
    };

    $m->updated = '2024-03-18 09:00:07';
    $m->updated_at = '2024-03-18 09:00:07';

    dd($m->toArray()['updated'], $m->toArray()['updated_at'], (string) $m->updated, (string) $m->updated_at);
});

And the results seem to be what you are after:

$ php artisan app:test
"2024-03-18 09:00:07" // routes/console.php:30
"2024-03-18 09:00:07" // routes/console.php:30
"2024-03-18 09:00:07" // routes/console.php:30
"2024-03-18 09:00:07" // routes/console.php:30

[rodrigopedra]

Regarding serializing with timezone info:

protected function serializeDate(DateTimeInterface $date): string
{
    return Carbon::instance($date)
        ->setTimezone($date->getTimezone())
        ->toAtomString();
}

But then you need to remove the format from the datetime casts ('updated' => 'datetime').

Sample output:

$ php artisan app:test
"2024-03-18T09:00:07+01:00" // routes/console.php:32
"2024-03-18T09:00:07+01:00" // routes/console.php:32
"2024-03-18 09:00:07" // routes/console.php:32
"2024-03-18 09:00:07" // routes/console.php:32

[thbley]

That works. Overriding serializeDate() in the relevant models is an option, injecting serializeDate() with a new trait might also work. But I would prefer to have it working out of the box.

My favorite would be to patch trait HasAttributes with:

        protected function serializeDate(\DateTimeInterface $date): string
        {
            return \Carbon\Carbon::instance($date)->toISOString(true);
        }

[thbley]

Removing the casts creates another topic:

    date_default_timezone_set('Europe/Berlin');

    $m = new class extends \Illuminate\Database\Eloquent\Model {
        protected $attributes = [
        ];
        protected $fillable = [
            'updated_at',
        ];
        protected $casts = [
        ];
    };

    $m->updated_at = '2024-03-18 09:00:07';

    dd((string) $m->toArray()['updated_at'], (string) $m->updated_at);

I'd expect (string) $m->toArray()['updated_at'] to be the same as (string) $m->updated_at:

"2024-03-18T08:00:07.000000Z"
"2024-03-18 09:00:07"

[rodrigopedra]

I'd expect (string) $m->toArray()['updated_at'] to be the same as (string) $m->updated_at

I don't.

One is the result of the model being serialized, to be used by outside consumers.

The other is a cast of an internal value to be used within your application.

I am glad we have different methods, to achieve different results for different purposes.

Regarding patching the HasAttributes trait, if you believe that makes a more sensible default, you can try sending a PR.

I, personally, also prefer the current implementation, but we can let the maintainers decide on it.

To me, having serialization standardized to a sensible default seems fine enough. Adding the fact one has a clear and documented way to customize it to their needs, is also a big plus.

[thbley]

Please check my example:

        date_default_timezone_set('Europe/Berlin');

        $m = new class extends \Illuminate\Database\Eloquent\Model {
            protected $attributes = [
            ];
            protected $fillable = [
                'updated',
                'updated_at',
            ];
            protected $casts = [
                'updated' => 'datetime:Y-m-d H:i:s',
                'updated_at' => 'datetime:Y-m-d H:i:s',
            ];
        };

        $m->updated = '2024-03-18 09:00:07';
        $m->updated_at = '2024-03-18 09:00:07';

        dd($m->toArray()['updated'], $m->toArray()['updated_at'], (string) $m->updated, (string) $m->updated_at);

It's clearly showing that $m->toArray()['updated_at'] gets converted to the wrong timezone.

app.timezone is used to populate date_default_timezone_set(), so to make the example easier, I call date_default_timezone_set() directly. The example is working correctly with date_default_timezone_set('UTC'), but it should be also working correctly with any other timezone.

[thbley]

Looking at HasAttributes::serializeDate(), it's clear that toJSON() removes the timezone information whereas toISOString(true) is preserving the timezone information.

vendor/laravel/framework/src/Illuminate/Database/Eloquent/Concerns/HasAttributes.php

    protected function serializeDate(DateTimeInterface $date)
    {
        return $date instanceof DateTimeImmutable ?
-            CarbonImmutable::instance($date)->toJSON() :
-            Carbon::instance($date)->toJSON();
+            CarbonImmutable::instance($date)->toISOString(true) :
+            Carbon::instance($date)->toISOString(true);
    }

[thbley]

@crynobone
Please move this issue back to the bug tracker. I don't want to discuss this issue, I want to help solving this issue.