Skip to content

Commit 57493f8

Browse files
palkerecsenyizzacharo
authored andcommitted
1 parent 7c6d5f6 commit 57493f8

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

docs/releases/vNext/upgrade-vNext.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,16 @@ oaipmh_service = current_rdm_records.oaipmh_server_service
101101
oaipmh_service.rebuild_index(identity=system_identity)
102102
```
103103

104+
#### OAuth client changes
105+
106+
The `extra_data` column of the `oauthclient_remoteaccount` table, storing remote-specific user information as required by various integrations, has been migrated from the `JSON` type to the `JSONB` type (only on PostgreSQL databases).
107+
This gives significant performance improvements when running certain queries.
108+
An automated Alembic migration is included and will be executed when you run the [database migration](#database-migration) step below.
109+
110+
However, if your `oauthclient_remoteaccount` table has more than ~50k rows and you are unable to take the system offline offline for an update, this operation could overload your database and create a lock lasting several minutes, due to the need to individually transform every row.
111+
To avoid issues in such cases, we recommend instead running the migration manually.
112+
Please follow [the upgrade guide](https://invenio-oauthclient.readthedocs.io/en/latest/upgrading.html#v6-0-0).
113+
104114
#### Upgrade option 1: In-place
105115

106116
This approach upgrades the dependencies in place. At the end of the process,

docs/releases/vNext/version-vNext.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,14 @@ This feature is also [highly customisable](../../operate/customize/record_deleti
2929

3030
https://github.com/inveniosoftware/invenio-previewer/pull/224
3131

32+
### OAuth improvements
33+
34+
We've added a few small but crucial improvements to the [invenio-oauthclient](https://github.com/inveniosoftware/invenio-oauthclient) module, improving security and bringing Invenio's third-party authentication in line with modern standards.
35+
36+
- **Refresh tokens** are now supported, meaning we now have full compatibility with all OAuth 2.0 authorization servers. This means we can securely store long-lived tokens and exchange them for short-lived access tokens as and when needed, allowing us to integrate with modern third-party apps ([invenio-oauthclient#328](https://github.com/inveniosoftware/invenio-oauthclient/pull/328)).
37+
38+
- The `extra_data` column of the `oauthclient_remoteaccount` table is now stored in the more efficient `JSONB` type when using PostgreSQL, improving the performance and flexibility of queries ([invenio-oauthclient#360](https://github.com/inveniosoftware/invenio-oauthclient/pull/360)).
39+
3240
### Miscellaneous additions
3341

3442
Here is a quick summary of the myriad of other improvements in this release:
@@ -47,6 +55,8 @@ Here is a quick summary of the myriad of other improvements in this release:
4755

4856
- Overridables in the deposit form have been modified to improve consistency in structure and naming conventions. This has involved renaming the IDs of several `<Overridable>`s, but none have been removed. If you are using these IDs to override components, please see [the full list of updates](https://github.com/inveniosoftware/invenio-rdm-records/pull/2101/files#diff-ff3c479edefad986d2fe6fe7ead575a46b086e3bbcf0ccc86d85efc4a4c63c79) and change your IDs accordingly.
4957

58+
- The changes to [invenio-oauthclient](https://github.com/inveniosoftware/invenio-oauthclient) include automated database migrations that will run smoothly for most instances. However, if your `oauthclient_remoteaccount` table has more than ~50k rows and you are unable to take your system offline for the upgrade, please instead [follow the manual steps](./upgrade-vNext.md#oauth-client-changes).
59+
5060
## Requirements
5161

5262
InvenioRDM vNext supports:

0 commit comments

Comments
 (0)