Plastic Strategy #1611

lucassousaf · 2023-09-25T12:07:24Z

We need to manage the following information:

Plastic strategies.
Plastic strategies' steps.
Plastic strategy's groups.
Plastic strategy resources' bookmarks.

[Re #1611] * After discussing options internally with Martin, it was decided to use JSONB to store the steps of the plastic strategy. It's going to be faster for the FE iterations.

[Re #1611]

[Re #1611] * Assignments are unique per plastic strategy, user and group type. * The roles stored in this table is just an annotation for FE purposes, the real permissions assignment will be handled by RBAC.

[Re #1611] * Each plastic strategy has a team and inside there are "teams" which acts as internal/sub teams of the broader PS team. So, we just need to add or remove team members from the broader team. * Each team member can be part of N internal/sub "teams".

[Re #1611] * This is a rewrite of the previous implementation to adjust to the model changes. It also includes new functions to delete and get team members.

[Re #1611] * Incl. add-ps-team-member and update-ps-team-member. * The "role" field in the "plastic_strategy_team_member" table is an annotation for FE display purposes. The real role and permissions are handled using the RBAC system. * Each role annotation maps to other 3 roles in rbac: - viewer -> plastic-strategy-viewer - editor -> plastic-strategy-editor - admin -> plastic-strategy-admin

[Re #1611] * Given a list of GPML countries IDs, creates a plastic strategy record for each.

[Re #1611]

[Re #1611] * We'll need the RBAC contexts as we'll use permissions to control access of users to plastic strategy's API resources.

[Re #1611] * The teams properties are used internally as keywords so before inserting into the db and before returning to callers we should transform all the values of teams key into keywords.

[Re #1611]

[Re #1611] * The "ps-team-member" role can be "nil" so we need to consider that option as well.

[Re #1611] * Support for adding, editing and getting team members.

[Re #1611]

[Re #1611] * Also added a new permission to add a team member. * Renamed the permissions to be consistent with naming policy used (update instead of edit). * Removed the "plastic-strategy/add-team-member" permission from the "plastic-strategy-editor" role as it was wrong. Although they are editors, they can't edit the team. It's a restricted feature for "plastic-strategy-admin"s only.

[Re #1611]

[Re #1611] * The invitiation type is to distinguish which type of invitation it's. As of now we have one type of invitation in production which is "expert" and with PS we need another type of invitation. As experts have extra logic when the user actually accepts the invitation, the "INVITED" status is not enough. So this "type" column will give us the necessary information to distinguish both cases and more in the future.

[Re #1611]

[Re #1611] * Also refactor it to follow new conventions on the persistence layer side, handling errors at that level.

[Re #1611]

[Re #1611] * This was missing in previous commits.

[Re #1611] * Users invited to plastic strategy will also have they required RBAC roles added and RocketChat account created as well. * Also fixed the rollbacks for update-stakeholder as they were in the wrong txn-fns.

[Re #1611]

[Re #1611] Added new programmatic API endpoint for creating a Badge. As always, this endpoint is restricted for internal usage. We are not using JDBC transactions in the process since we need to perform side-effectful operations that cannot be just undone by aborting JDBC transactions, so we are explictly doing rollbacks when some steps cannot be performed and some others have been already committed.

[Re #1611] The new endpoint expects a `name` path parameter to find the target Badge by its unique name, as this is the most useful way to use this endpoint. As part of the data fetch the endpoint provides the content file's URL, retrieved from GCS. The `content-file-id` parameter is not used after getting the file url, so we remove it from the result.

[Re #1611] This new endpoint behaves in a similar way as the PS Bookmark-related endpoint, in the sense that it can be used for both assigning or unassigning a badge from a given entity type, providing a flag to know the action and other details to identify the resource type, id and the badge id as well. In this case we are handling the entity type in an easier and safer way than it is done with PS Bookmarking, as we are avoiding relying on `_` separator to infer the entity type. Hence, this bug will need to be fixed in PS Bookmark handling, but that is a separated issue. As a side note, we are sharing a single param for both GET and POST Assign Badge endpoints, in order to avoid route conflicts, so the path param can be an integer id or a name string in each case, what could be confusing, as one can imagine that you can provide name or id for both endpoints, but it doesn't work like that (as explained in the Swagger params.

[Re #1611] * In cases where the entity type is "case_study" the "ps-bookmark-entity-col" splitting will produce a wrong "entity-name". So instead of doing all of this work of splitting the "ps-bookmark-entity-col" we can just pass the "entity-type" already available in our service layer.

…1671) * Fix PS bookmark entity-type parsing for constraint violation check [Re #1611] * In cases where the entity type is "case_study" the "ps-bookmark-entity-col" splitting will produce a wrong "entity-name". So instead of doing all of this work of splitting the "ps-bookmark-entity-col" we can just pass the "entity-type" already available in our service layer.

[Re #1611]

[Re #1611] Now we load assigned badges metadata to each resource fetched with this endpoint. However, we are just providing relationship-related data and Badge's related extra data, such the File content URL, needs to be fetched using the individual `/api/badge` GET endpoint. For now we do not offer filtering or sorting capabilities regarding badges. That can also comes in the future.

[Re #1611] We load badge id as part of the relationship data of badge-resource assignments, so it make sense we can use the badge id to obtain all of its information, instead of just allowing to get it by its unique name. Added more clarifications about the shared context `id-or-name` parameter, as for assignments we only expect the badge id to be provided, as that is easier than using the name, for that case.

[Re #1611] Renamed the new DB migration after the merge, as we were using an already existing number.

[Re #1611] * PS bookmark would be duplicated in some occurrences. This might be due to the query complexity of `LEFT JOIN`s generating multiple rows for a single entity even after grouping. For now this is a quick fix but we should take quality time to refactor this query to make it right.

[Re #1611] The initial specs were wrong due to some misunderstanding, so we need to get rid of the `content-file-id` property from Badge entity and update the code accordingly. On the other hand, we also need to support additional badge types for the platform.

[Re #1611] * This is a convinience to the FE.

[Re #1611]

[Re #1611] We need to support assinging and unassigning badge by its unique name since it is more convinient for FE to avoid relying on extra GET call for getting the badge ids. We have decided to support both name and id properties here because it's easier and we can share same specs for the GET and POST Assign Badge endpoints, regarding path params.

[Re #1611] We need to include the same information we are adding in other APIs such as Submission one, in order to conditionally load Badges assignation-related metadata for the listed organisations.

[Re #1611] * Otherwise it wouldn't match the name real constraint name on the database and thus not throw the expected error.

[Re #1611] * Every user added to a plastic strategy needs to have a chat account enabled in order to add them to the PS channel. Therefore, I added an extra step to create the user account in RocketChat if it doesn't have one already. Since creating the "Forum" (i.e. RocketChat) account is completely transparent for the user using the platform, this is also something that only concerns the BE.

[Re #1611] * Also return a 409 status code when this case happens.

[Re #1611] * Every user added to a plastic strategy needs to have a chat account enabled in order to add them to the PS channel. Therefore, I added an extra step to create a user account in RocketChat if it doesn't have one already. Since creating the "Forum" (i.e. RocketChat) account is completely transparent for the user using the platform, this is also something that only concerns the BE. * Improved the error handling on the `add-ps-team-member` handler and service layer to return conflict if the team member already exists.

endpoint [Re #1611] We need to filter the strengths count according to the provided PS iso code from the params, so only those bookmarked initiatives for the given PS are taking into account when the PS iso code is provided. In this case, we do not count again same bookmarks for different sections, as it is only relevant the PS used to bookmark those initiatives.

lucassousaf added the Backend Backend related issue label Sep 25, 2023

lucassousaf self-assigned this Sep 25, 2023

lucassousaf added a commit that referenced this issue Oct 4, 2023

Migration: [WIP] setup plastic strategy data model

1903602

[Re #1611]

lucassousaf added a commit that referenced this issue Oct 4, 2023

Migration 194: fix permissions IDs

3d44d20

[Re #1611]

lucassousaf added a commit that referenced this issue Oct 4, 2023

Impl. core PS persistence layer

09ecec6

[Re #1611]

lucassousaf added a commit that referenced this issue Oct 4, 2023

Impl. core PS API endpoints

d90a7cc

[Re #1611]

lucassousaf added a commit that referenced this issue Oct 5, 2023

Refactor PS team persistence layer to reflect model updates

a46ae75

[Re #1611] * This is a rewrite of the previous implementation to adjust to the model changes. It also includes new functions to delete and get team members.

lucassousaf added a commit that referenced this issue Oct 6, 2023

Impl. programmatic endpoint to creaty plastic strategies

19fa28a

[Re #1611] * Given a list of GPML countries IDs, creates a plastic strategy record for each.

lucassousaf added a commit that referenced this issue Oct 6, 2023

Fix country_id to be UNIQUE

1047541

[Re #1611]

lucassousaf added a commit that referenced this issue Oct 6, 2023

Create RBAC contexts for new plastic strategies

6c6e0e9

[Re #1611] * We'll need the RBAC contexts as we'll use permissions to control access of users to plastic strategy's API resources.

lucassousaf added a commit that referenced this issue Oct 6, 2023

Remove debugging prn from update-ts-team-member prst layer fn

2ccd909

[Re #1611]

lucassousaf added a commit that referenced this issue Oct 6, 2023

Add get-ps-team-members service layer function

8c2e7a8

[Re #1611]

lucassousaf added a commit that referenced this issue Oct 6, 2023

Fix role update logic on team service update-ps-team-member fn

bd4207e

[Re #1611] * The "ps-team-member" role can be "nil" so we need to consider that option as well.

lucassousaf added a commit that referenced this issue Oct 6, 2023

Impl. plastic strategy team API

bdb627c

[Re #1611] * Support for adding, editing and getting team members.

lucassousaf added a commit that referenced this issue Oct 6, 2023

Fix PS model migration number

1264117

[Re #1611]

lucassousaf added a commit that referenced this issue Oct 9, 2023

Remove debugging prn

b9569b3

[Re #1611]

lucassousaf added a commit that referenced this issue Oct 9, 2023

Instrument plastic strategy API with RBAC

2468500

[Re #1611]

lucassousaf added a commit that referenced this issue Oct 10, 2023

Fix plastic-strategy/update permission

d419203

[Re #1611]

lucassousaf added a commit that referenced this issue Oct 10, 2023

Refactor invitation prst layer to use with plastic strategy

ed3e40c

[Re #1611] * Also refactor it to follow new conventions on the persistence layer side, handling errors at that level.

lucassousaf added a commit that referenced this issue Oct 10, 2023

[WIP] Impl. invite plastic strategy team member API

4d1b2b3

[Re #1611]

lucassousaf added a commit that referenced this issue Oct 10, 2023

Add missing create-stakeholder prst layer function

1f0ce11

[Re #1611] * This was missing in previous commits.

lucassousaf added a commit that referenced this issue Oct 23, 2023

Remove user from PS channel when it's deleted from the PS team

6be6995

[Re #1611]

lucassousaf added a commit that referenced this issue Oct 23, 2023

Fix query params destructuring in get-ps-files (#1668)

1255f8a

[Re #1611]

lucassousaf added a commit that referenced this issue Oct 23, 2023

Make invited PS users are added to the PS channel

59b0ea4

[Re #1611]

lucassousaf mentioned this issue Oct 24, 2023

Fix PS bookmark entity-type parsing for constraint violation check #1671

Merged

lucassousaf added a commit that referenced this issue Oct 24, 2023

Fix topic query PS bookmark duplicates

d724348

[Re #1611]

lucassousaf mentioned this issue Oct 24, 2023

Fix topic query PS bookmark duplicates #1672

Merged

joseAyudarte91 added a commit that referenced this issue Oct 24, 2023

Fix merge conflicts

b68b3d8

[Re #1611] Renamed the new DB migration after the merge, as we were using an already existing number.

joseAyudarte91 mentioned this issue Oct 25, 2023

1611 Update Badges DB model and support more types #1678

Merged

lucassousaf added a commit that referenced this issue Oct 25, 2023

Return empty array instead of null if there aren't ps bookmarks

ed03cb6

[Re #1611] * This is a convinience to the FE.

lucassousaf mentioned this issue Oct 25, 2023

Return empty array instead of null if there aren't ps bookmarks #1679

Merged

joseAyudarte91 added a commit that referenced this issue Oct 25, 2023

Fix DB migr. num conflict

f662a56

[Re #1611]

joseAyudarte91 mentioned this issue Oct 25, 2023

1611 Support using Badge name in /api/badge/assign endp. #1682

Merged

joseAyudarte91 mentioned this issue Oct 26, 2023

1611 Support badges-metadata in Organisations List endp. #1691

Merged

lucassousaf added a commit that referenced this issue Oct 31, 2023

Fix primary-key constraint name on add-ps-team-member

49ca4d1

[Re #1611] * Otherwise it wouldn't match the name real constraint name on the database and thus not throw the expected error.

lucassousaf added a commit that referenced this issue Oct 31, 2023

Improve error handling when PS team member already exists

5585a38

[Re #1611] * Also return a 409 status code when this case happens.

joseAyudarte91 mentioned this issue Nov 6, 2023

1611 Support strengths prop filtering by PS code in Organisations GET endpoint #1720

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Plastic Strategy #1611

Plastic Strategy #1611

lucassousaf commented Sep 25, 2023

Plastic Strategy #1611

Plastic Strategy #1611

Comments

lucassousaf commented Sep 25, 2023