Skip to content

Conversation

@palkerecsenyi
Copy link
Member

@palkerecsenyi palkerecsenyi commented Sep 22, 2025

Related (vaguely) to inveniosoftware/invenio-github#190, but is not a dependency.

Important: we are aiming to release this at the same time as #328. When we merge, we need to align the DB migrations, but still keep them as 2 separate migrations so this one can be run manually. The other migration does not need to be run manually in any scenario.


  • JSONB is a newer and more efficient format for storing JSON in PostgreSQL. Compared to JSON, it offers significantly faster querying and indexing support (but is very slightly slower to input). The JSON is decomposed into a binary format rather than being stored in plaintext.

  • From a high-level perspective, the access of the data is unchanged in Python so this is not a breaking change. However, the new column type supports more querying operations which could be used in the future.

  • Migrating the column type is quite easy for small tables but can cause performance and stability issues for larger ones. Therefore, a default Alembic migration has been included for the vast majority of use cases, as well as a step-by-step alternative guide for larger instances. Instances with more than ~50k rows in oauthclient_remoteaccount are advised not to use the Alembic migration and to instead follow the upgrade guide.

from .proxies import current_oauthclient

__version__ = "5.3.1"
__version__ = "5.4.0"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately, we need to consider this a breaking change and bump it to v6, otherwise this version will be installed in InvenioRDM v13 without running the Alembic recipe.
Can you please change it?

Can you please add a line explaining this in the vNext in the docs repo? Ty!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, will do. I guess we can aim to also include #328 in 6.0.0? So I will include docs for both in the vNext release notes.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, will do. I guess we can aim to also include #328 in 6.0.0? So I will include docs for both in the vNext release notes.

Yes, because it has a DB upgrade, so it is not a transparent installation that only requires to update the dependencies' versions.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've updated the version and added the docs here inveniosoftware/docs-invenio-rdm#884

* `JSONB` is a newer and more efficient format for storing JSON in
PostgreSQL. Compared to `JSON`, it offers significantly faster querying
and indexing support (but is very slightly slower to input). The JSON is
decomposed into a binary format rather than being stored in plaintext.

* From a high-level perspective, the access of the data is unchanged in
Python so this is not a breaking change. However, the new column type
supports more querying operations which could be used in the future.

* Migrating the column type is quite easy for small tables but can cause
performance and stability issues for larger ones. Therefore, a default
Alembic migration has been included for the vast majority of use cases,
as well as a step-by-step alternative guide for larger instances.
Instances with more than ~50k rows in `oauthclient_remoteaccount` are
advised not to use the Alembic migration and to instead follow the
upgrade guide.
palkerecsenyi added a commit to mesemus/invenio-oauthclient that referenced this pull request Nov 3, 2025
* This matches up with
inveniosoftware#360 which we
are aiming to release at the same time
@ntarocco ntarocco merged commit e7d6457 into inveniosoftware:master Nov 3, 2025
2 checks passed
@github-project-automation github-project-automation bot moved this from In review 🔍 to To release 🤖 in Sprint Q4/2025 Nov 3, 2025
@palkerecsenyi palkerecsenyi deleted the jsonb branch November 3, 2025 15:05
palkerecsenyi added a commit to palkerecsenyi/invenio-app-rdm that referenced this pull request Nov 3, 2025
* Bumping the major version of invenio-oauthclient to 6.0.0

* This includes
inveniosoftware/invenio-oauthclient#360 which is
not necessarily breaking but requires a manual DB migration for very
large instances, as documented in the module's upgrade guide.

* Further changes are yet come in v6 before RDM v14, such as
inveniosoftware/invenio-oauthclient#328.
palkerecsenyi added a commit to palkerecsenyi/invenio-users-resources that referenced this pull request Nov 4, 2025
* Bumping the major version of invenio-oauthclient to 6.0.0

* This includes
inveniosoftware/invenio-oauthclient#360 which is
not necessarily breaking but requires a manual DB migration for very
large instances, as documented in the module's upgrade guide.

* Further changes are yet come in v6 before RDM v14, such as
inveniosoftware/invenio-oauthclient#328.
palkerecsenyi added a commit to palkerecsenyi/invenio-users-resources that referenced this pull request Nov 4, 2025
* Bumping the major version of invenio-oauthclient to 6.0.0

* This includes
inveniosoftware/invenio-oauthclient#360 which is
not necessarily breaking but requires a manual DB migration for very
large instances, as documented in the module's upgrade guide.

* Further changes are yet come in v6 before RDM v14, such as
inveniosoftware/invenio-oauthclient#328.
palkerecsenyi added a commit to palkerecsenyi/invenio-vcs that referenced this pull request Nov 4, 2025
* Bumping the major version of invenio-oauthclient to 6.0.0

* This includes
inveniosoftware/invenio-oauthclient#360 which is
not necessarily breaking but requires a manual DB migration for very
large instances, as documented in the module's upgrade guide.

* Further changes are yet come in v6 before RDM v14, such as
inveniosoftware/invenio-oauthclient#328.
palkerecsenyi added a commit to palkerecsenyi/invenio-app-rdm that referenced this pull request Nov 4, 2025
* Bumping the major version of invenio-oauthclient to 6.0.0

* This includes
inveniosoftware/invenio-oauthclient#360 which is
not necessarily breaking but requires a manual DB migration for very
large instances, as documented in the module's upgrade guide.

* Further changes are yet come in v6 before RDM v14, such as
inveniosoftware/invenio-oauthclient#328.
palkerecsenyi added a commit to palkerecsenyi/invenio-app-rdm that referenced this pull request Nov 4, 2025
* Bumping the major version of invenio-oauthclient to 6.0.0

* This includes
inveniosoftware/invenio-oauthclient#360 which is
not necessarily breaking but requires a manual DB migration for very
large instances, as documented in the module's upgrade guide.

* Further changes are yet come in v6 before RDM v14, such as
inveniosoftware/invenio-oauthclient#328.
palkerecsenyi added a commit to palkerecsenyi/invenio-app-rdm that referenced this pull request Nov 4, 2025
* Bumping the major version of invenio-oauthclient to 6.0.0

* This includes
inveniosoftware/invenio-oauthclient#360 which is
not necessarily breaking but requires a manual DB migration for very
large instances, as documented in the module's upgrade guide.

* Further changes are yet come in v6 before RDM v14, such as
inveniosoftware/invenio-oauthclient#328.
palkerecsenyi added a commit to palkerecsenyi/invenio-app-ils that referenced this pull request Nov 5, 2025
* Bumping the major version of invenio-oauthclient to 6.0.0

* This includes
inveniosoftware/invenio-oauthclient#360 which is
not necessarily breaking but requires a manual DB migration for very
large instances, as documented in the module's upgrade guide.

* Further changes are yet come in v6 before RDM v14, such as
inveniosoftware/invenio-oauthclient#328.
palkerecsenyi added a commit to palkerecsenyi/invenio-app-ils that referenced this pull request Nov 5, 2025
* Bumping the major version of invenio-oauthclient to 6.0.0

* This includes
inveniosoftware/invenio-oauthclient#360 which is
not necessarily breaking but requires a manual DB migration for very
large instances, as documented in the module's upgrade guide.

* Further changes are yet come in v6, such as
inveniosoftware/invenio-oauthclient#328.
@kpsherva kpsherva moved this from To release 🤖 to Released ✔️ in Sprint Q4/2025 Nov 5, 2025
palkerecsenyi added a commit to palkerecsenyi/invenio-app-rdm that referenced this pull request Nov 6, 2025
* Bumping the major version of invenio-oauthclient to 6.0.0

* This includes
inveniosoftware/invenio-oauthclient#360 which is
not necessarily breaking but requires a manual DB migration for very
large instances, as documented in the module's upgrade guide.

* Further changes are yet come in v6 before RDM v14, such as
inveniosoftware/invenio-oauthclient#328.
palkerecsenyi added a commit to palkerecsenyi/invenio-app-rdm that referenced this pull request Nov 6, 2025
* Bumping the major version of invenio-oauthclient to 6.0.0

* This includes
inveniosoftware/invenio-oauthclient#360 which is
not necessarily breaking but requires a manual DB migration for very
large instances, as documented in the module's upgrade guide.

* Further changes are yet come in v6 before RDM v14, such as
inveniosoftware/invenio-oauthclient#328.
palkerecsenyi added a commit to palkerecsenyi/invenio-app-rdm that referenced this pull request Nov 6, 2025
* Bumping the major version of invenio-oauthclient to 6.0.0

* This includes
inveniosoftware/invenio-oauthclient#360 which is
not necessarily breaking but requires a manual DB migration for very
large instances, as documented in the module's upgrade guide.

* Further changes are yet come in v6 before RDM v14, such as
inveniosoftware/invenio-oauthclient#328.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Released ✔️

Development

Successfully merging this pull request may close these issues.

2 participants