OpenConext / OpenConext/OpenConext-engineblock

Remove language specific colums from the database schema

Open
#1,809 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

database needs-refinement on-hold refactoring
Dominant language
PHP
Stars
17
Forks
25
Avg merge
4d 1h
Merged PRs (30d)
1

Description

In #1338 multiple names for the same idp can be set, in multiple locales, without updating the db schema.

It would be preferable to store the 'main' idp / sp name details in a similar fashion, so languages can be added without schema updates.

Todo

  • Refactor references to the name_xx, description_xx, display_name_xx, keywords_xx, support_url_xx into a single json column on the AbstractRole, IdentityProvider and ServiceProvider Doctrine Entities.

Constraints
Do not drop the actual database columns yet until the production rollout of this ticket is complete. Create a new ticket for that.

For reference:

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the Doctrine entity definitions for AbstractRole, IdentityProvider, and ServiceProvider, then trace references to the name_xx, description_xx, display_name_xx, keywords_xx, and support_url_xx fields. The work is done when these values use a single JSON column without removing the existing database columns; review the referenced pull requests for context.

Written by the indexing model from the issue text.

Assessment

Tech stack
json, php
Domain
backend, databases
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.