OpenConext / OpenConext/Stepup-Middleware

Refactor out InstitutionListing value object

Open
#522 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Imported middleware middleware-client technical debt
Dominant language
PHP
Stars
3
Forks
2
Avg merge
2d 9h
Merged PRs (30d)
2

Description

This issue is imported from pivotal - Originaly created at Jan 23, 2020 by bstrooband

Earlier on for filtering on institutions in RA the Institution projection was used. This however resulted in not being able to manage institutions if a user from that institution hadn't logged in before.

Therefore the ConfiguredInstitutions had to be used. But the MW client returned a serialized institutionListing value object. This serialized data was different then the serialized ConfiguredInstitution value object so the MW client bundle should have been updated for all projects where the InstitutionListing was used.

That would have resulted in too much changes just to fix a few bugs before releaseing R17. Therefore this issue was filed to address this later on.

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

Start by locating the InstitutionListing value object and every project or consumer where it is used, then compare its serialized data with ConfiguredInstitution. The work is done when InstitutionListing has been refactored out and the affected consumers use the intended configured-institution representation without requiring the earlier bundle-wide workaround.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
backend
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.