Column ordering

[puzzledpolymath]

The issue

When compiling a migration and an entity uses behaviors, such as CreatedAt and UpdatedAt, the RenderModifiers generator adds these to the table schema first ignoring or not knowing the order in which fields are defined. Which means the migration files need to be manually edited to ensure column ordering reflects the entity fields.

Let me know if this something you see as an issue and I can try and work on a solution.

Potential Solution

cycle/schema-migrations-generator/src/GenerateMigrations.php

    public function run(Registry $registry): Registry
    {
        $databases = [];
        foreach ($registry as $e) {
            if ($registry->hasTable($e) && !$e->getOptions()->has(SyncTables::READONLY_SCHEMA)) {
                // An array of column names in the order fields are listed
                $names = array_map(fn(Field $field) => $field->getColumn(), \iterator_to_array($e->getFields()));
                // Store the table before modification and passing to $databases
                $table = $registry->getTableSchema($e);
                // Call newly added method for sorting columns
                $table->sortColumns($names);
                // Set table with preferred column ordering
                $databases[$registry->getDatabase($e)][] = $table;
            }
        }
        ...
    }

cycle/database/src/Schema/AbstractTable.php

    public function sortColumns(array $names): void
    {
        $this->current->sortColumnsByNames($names);
    }

cycle/database/src/Schema/State.php

    public function sortColumnsByNames(array $names): void
    {
        $sorted = [];

        foreach ($names as $name) {
            if (isset($this->columns[$name])) {
                $sorted[$name] = $this->columns[$name];
            }
        }

        foreach ($this->columns as $name => $column) {
            if (! isset($sorted[$name])) {
                $sorted[$name] = $column;
            }
        }

        $this->columns = $sorted;
    }

[roxblnfk]

This doesn't seem like a problem because it's a feature of how schema generators work. User can add the #[Column] attribute to the generated field and place the column in line with others in the Schema Builder's processing queue, as well as customize some things (for example, add first or after from this PR).
Feel free to reopen the issue if needed.

[puzzledpolymath]

@roxblnfk While I can implement a work-around for this locally, or manually adjust the migrations after generation, your recent comment left me scratching my head.

As well as customize some things (for example, add first or after from cycle/database#226).

This might be true for schema modifications, but doesn't really apply for newly created tables and columns.

User can add the #[Column] attribute to the generated field and place the column in line with others in the Schema Builder's processing queue

I either don't grasp what you're saying here, or your beliefs that defining a property with a #[Column] attribute somehow fixes the ordering. In my experience, this changes nothing. Take the following example below. Columns createdAt and updatedAt will always be positioned above other fields within a generated migration.

#[Entity(
    role: 'account',
    repository: AccountRepository::class,
    table: 'account',
)]
#[Feature\Snowflake(field: 'id')]
#[Behavior\CreatedAt(field: 'createdAt')]
#[Behavior\UpdatedAt(field: 'updatedAt')]
#[Index(columns: ['identifier'], unique: true)]
class Account
{
    #[Column(
        type: 'bigInteger',
        name: 'id',
        primary: true,
        unsigned: true,
        comment: 'Account ID',
    )]
    private int $id;
    
    #[Column(
        type: 'string',
        name: 'identifier',
        size: 50,
        comment: 'Account identifier',
    )]
    private string $identifier;

    #[Column(
        type: 'string',
        name: 'name',
        size: 50,
        comment: 'Account name',
    )]
    private string $name;
    
    #[Column(
        type: 'datetime',
        name: 'created_at',
        comment: 'Date and time account was created',
    )]
    private DateTimeImmutable $createdAt;

    #[Column(
        type: 'datetime',
        name: 'updated_at',
        comment: 'Date and time account was last updated',
    )]
    private DateTimeImmutable $updatedAt;
}

[roxblnfk]

Columns createdAt and updatedAt will always be positioned above other fields within a generated migration.

I wonder why this happens. I thought it depended on which schema generator triggers first (RenderModifiers runs almost at the very end).

[puzzledpolymath]

Out of interest here's the order of generators given when compiling