feat(snowflake): extend Entity class to support snowflakes by miaulalala · Pull Request #56795 · nextcloud/server

miaulalala · 2025-12-02T13:10:41Z

RFC: extending the Entity class to support snowflake IDs automagically

Good ides - yes / no?

Benefits:

every entity that supports snowflake IDs can automagically handle them by implementing the SnowflakeAwareEntity instead of the regular Entity
No adding IGenerator / IDecoder in every entity class
centralised method support for createdAt, setId, and anything else we would like to offer separately
get entire decoded snowflake id from the entity

Drawbacks:

Will it work the way I think it should?

Resolves: #

TODO

...

Checklist

Code is properly formatted
Sign-off message is added to all commits
Tests (unit, integration, api and/or acceptance) are included
Screenshots before/after for front-end changes
Documentation (manuals or wiki) has been updated or is not required
Backports requested where applicable (ex: critical bugfixes)
Labels added where applicable (ex: bug/enhancement, 3. to review, feature component)
Milestone added for target branch/version (ex: 32.x for stable32)

lib/public/AppFramework/Db/SnowflakeAwareEntity.php

CarlSchwan

Llike the Id :)

lib/public/AppFramework/Db/SnowflakeAwareEntity.php

come-nc · 2025-12-02T16:18:12Z

We should rename IGenerator and IDecoder to ISnowflakeGenerator and ISnowflakeDecoder, otherwise after a use all code is ambiguous.
A value object for decoded snowflakes would be good as well.

miaulalala · 2025-12-03T22:46:51Z

We should rename IGenerator and IDecoder to ISnowflakeGenerator and ISnowflakeDecoder, otherwise after a use all code is ambiguous. A value object for decoded snowflakes would be good as well.

Added

lib/public/Snowflake/Snowflake.php

Altahrim

If we introduce a Snowflake DTO, I think Decoder should return it directly

lib/public/AppFramework/Db/SnowflakeAwareEntity.php

lib/public/Snowflake/Snowflake.php

miaulalala · 2025-12-04T12:03:53Z

Would it make sense to cache the decoded snowflake ID? Seems like there's quite a few expensive calculations going on.

Altahrim · 2025-12-04T13:19:19Z

We can still add a cache later if needed but decoding on 64 bits mainly involve binary operations, it should be fast.
32 bit is more complicated 😓

lib/private/Snowflake/SnowflakeDecoder.php

lib/public/AppFramework/Db/SnowflakeAwareEntity.php

lib/public/Snowflake/Snowflake.php

lib/public/Snowflake/ISnowflakeDecoder.php

Altahrim

With same comment than Côme :)

provokateurin

Some small changes would be nice. Also I would prefer if the changes were done in multiple commits. I also noticed the name of the DI variable is inconsistent, maybe you can fix that as well.

lib/public/AppFramework/Db/SnowflakeAwareEntity.php

lib/public/Snowflake/Snowflake.php

- [ ] needs nextcloud/server#56795 - [ ] needs #16508 Skipping CI for now, amend the commit message and remove the skip-ci param when ready to rebase and merge [skip-ci] Signed-off-by: Anna Larch <anna@nextcloud.com>

- [ ] needs nextcloud/server#56795 - [ ] needs #16508 Skipping CI for now, amend the commit message and remove the skip-ci param when ready to rebase and merge [skip ci] Signed-off-by: Anna Larch <anna@nextcloud.com>

lib/public/AppFramework/Db/SnowflakeAwareEntity.php

And introduce the Snowflake DTO Signed-off-by: Anna Larch <anna@nextcloud.com>

Signed-off-by: Anna Larch <anna@nextcloud.com>

- Rename setId() -> generateId() in SnowflakeAwareEntity Signed-off-by: Carl Schwan <carlschwan@kde.org>

Otherwise this breaks some existing code, in particular PublicKeyToken Signed-off-by: Carl Schwan <carlschwan@kde.org>

- [ ] needs nextcloud/server#56795 - [x] needs #16508 Skipping CI for now, amend the commit message and remove the skip-ci param when ready to rebase and merge [skip ci] Signed-off-by: Anna Larch <anna@nextcloud.com> Signed-off-by: Carl Schwan <carlschwan@kde.org>

- [x] needs nextcloud/server#56795 - [x] needs #16508 Signed-off-by: Anna Larch <anna@nextcloud.com> Signed-off-by: Carl Schwan <carlschwan@kde.org>

artonge · 2026-01-07T17:12:18Z

lib/public/AppFramework/Db/Entity.php

-	/** @var int $id */
-	public $id = null;
-
+	public int|string|null $id = null;


@miaulalala @CarlSchwan Is this really needed? This is breaking, as now any code accessing this property need to adapt to support all of those types.

There were some more last polishing PRs around the time of your comment, can you check latest ocp package?

The typing is still the same on latest master

miaulalala added this to the Nextcloud 33 milestone Dec 2, 2025

miaulalala requested review from CarlSchwan, nickvergessen, provokateurin and skjnldsv December 2, 2025 13:10

miaulalala self-assigned this Dec 2, 2025

miaulalala requested a review from a team as a code owner December 2, 2025 13:10

miaulalala requested review from ArtificialOwl and icewind1991 and removed request for a team December 2, 2025 13:10

miaulalala added enhancement 2. developing Work in progress standardization labels Dec 2, 2025

provokateurin reviewed Dec 2, 2025

View reviewed changes

lib/public/AppFramework/Db/SnowflakeAwareEntity.php Outdated Show resolved Hide resolved

CarlSchwan reviewed Dec 2, 2025

View reviewed changes

lib/public/AppFramework/Db/SnowflakeAwareEntity.php Show resolved Hide resolved

lib/public/AppFramework/Db/SnowflakeAwareEntity.php Outdated Show resolved Hide resolved

nickvergessen reviewed Dec 2, 2025

View reviewed changes

lib/public/AppFramework/Db/SnowflakeAwareEntity.php Outdated Show resolved Hide resolved

miaulalala requested review from CarlSchwan, nickvergessen and provokateurin December 3, 2025 22:42

miaulalala requested review from Altahrim and come-nc December 3, 2025 22:58

Altahrim reviewed Dec 4, 2025

View reviewed changes

lib/public/Snowflake/Snowflake.php Outdated Show resolved Hide resolved

Altahrim reviewed Dec 4, 2025

View reviewed changes

lib/public/AppFramework/Db/SnowflakeAwareEntity.php Outdated Show resolved Hide resolved

lib/public/Snowflake/Snowflake.php Outdated Show resolved Hide resolved

miaulalala requested a review from Altahrim December 4, 2025 13:51

Altahrim reviewed Dec 4, 2025

View reviewed changes

nickvergessen reviewed Dec 5, 2025

View reviewed changes

lib/public/Snowflake/ISnowflakeDecoder.php Outdated Show resolved Hide resolved

miaulalala added the 3. to review Waiting for reviews label Dec 16, 2025

Altahrim approved these changes Dec 16, 2025

View reviewed changes

provokateurin requested changes Dec 18, 2025

View reviewed changes

miaulalala force-pushed the feat/noid/extend-entity-to-be-snoflake-aware branch from 75a21de to 8d35e95 Compare December 18, 2025 22:34

miaulalala mentioned this pull request Dec 18, 2025

refactor: use SnowflakeAwareEntity nextcloud/spreed#16595

Merged

5 tasks

miaulalala force-pushed the feat/noid/extend-entity-to-be-snoflake-aware branch from ba2f797 to 67b168a Compare December 23, 2025 08:49

CarlSchwan reviewed Dec 23, 2025

View reviewed changes

lib/public/AppFramework/Db/SnowflakeAwareEntity.php Show resolved Hide resolved

CarlSchwan force-pushed the feat/noid/extend-entity-to-be-snoflake-aware branch 3 times, most recently from 29d972b to 4238c1e Compare January 6, 2026 09:16

miaulalala and others added 4 commits January 6, 2026 12:57

refactor: Rename Snowflake Generator and Decoder

f546daa

And introduce the Snowflake DTO Signed-off-by: Anna Larch <anna@nextcloud.com>

feat: extend Entity and adjust QBMapper to support Snowflake IDs

a100ede

Signed-off-by: Anna Larch <anna@nextcloud.com>

refactor: move existing usages of snoflake IDs SnowflakeAwareEntity

5f797eb

Signed-off-by: Anna Larch <anna@nextcloud.com>

feat: Adapt a bit the snowflake ids API

7c1a8a4

- Rename setId() -> generateId() in SnowflakeAwareEntity Signed-off-by: Carl Schwan <carlschwan@kde.org>

CarlSchwan force-pushed the feat/noid/extend-entity-to-be-snoflake-aware branch from 4238c1e to 7c1a8a4 Compare January 6, 2026 11:57

CarlSchwan requested a review from provokateurin January 6, 2026 13:41

CarlSchwan mentioned this pull request Jan 6, 2026

refactor(snowflake-id): Rename IGenerator to ISnowflakeGenerator nextcloud/spreed#16679

Closed

4 tasks

CarlSchwan marked this pull request as draft January 6, 2026 14:16

fix(entity): Do not call getId when inserting and $id is null

693a226

Otherwise this breaks some existing code, in particular PublicKeyToken Signed-off-by: Carl Schwan <carlschwan@kde.org>

CarlSchwan marked this pull request as ready for review January 6, 2026 14:43

nextcloud-bot mentioned this pull request Jan 7, 2026

33.0.0 beta 2 #57398

Merged

nickvergessen merged commit 40b79f5 into master Jan 7, 2026
208 of 220 checks passed

nickvergessen deleted the feat/noid/extend-entity-to-be-snoflake-aware branch January 7, 2026 12:42

CarlSchwan pushed a commit to nextcloud/spreed that referenced this pull request Jan 7, 2026

refactor: use SnowflakeAwareEntity

bd34ab8

- [x] needs nextcloud/server#56795 - [x] needs #16508 Signed-off-by: Anna Larch <anna@nextcloud.com> Signed-off-by: Carl Schwan <carlschwan@kde.org>

artonge reviewed Jan 7, 2026

View reviewed changes

tobiasKaminsky mentioned this pull request Jan 8, 2026

Type of OCA\Polls\Db\Option::$id must be string|int|null nextcloud/polls#4433

Closed

13 tasks

saw-jan mentioned this pull request Jan 12, 2026

App breaks with the Nextcloud next stable version (master branch) H2CK/oidc#612

Closed

Uh oh!

Conversation

miaulalala commented Dec 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

RFC: extending the Entity class to support snowflake IDs automagically

TODO

Checklist

Uh oh!

Uh oh!

CarlSchwan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

come-nc commented Dec 2, 2025

Uh oh!

miaulalala commented Dec 3, 2025

Uh oh!

Uh oh!

Altahrim left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

miaulalala commented Dec 4, 2025

Uh oh!

Altahrim commented Dec 4, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Altahrim left a comment

Choose a reason for hiding this comment

Uh oh!

provokateurin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

artonge Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

nickvergessen Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

artonge Jan 8, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

miaulalala commented Dec 2, 2025 •

edited

Loading