Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(admin): add backend role management api #4487

Merged
merged 3 commits into from
Nov 18, 2024
Merged

feat(admin): add backend role management api #4487

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
49e765b
feat: add backend role management api
chinook25 Nov 13, 2024
307c777
chore: delete renamed file
chinook25 Nov 13, 2024
37189fc
chore: pr comments
chinook25 Nov 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
144 changes: 0 additions & 144 deletions ...olgenis-emx2-graphql/src/main/java/org/molgenis/emx2/graphql/GraphlAdminFieldFactory.java
View file
Open in desktop

This file was deleted.

248 changes: 248 additions & 0 deletions ...lgenis-emx2-graphql/src/main/java/org/molgenis/emx2/graphql/GraphqlAdminFieldFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,248 @@
package org.molgenis.emx2.graphql;

import static org.molgenis.emx2.Constants.*;
import static org.molgenis.emx2.Constants.KEY;
import static org.molgenis.emx2.graphql.GraphqlApiMutationResult.Status.SUCCESS;
import static org.molgenis.emx2.graphql.GraphqlApiMutationResult.typeForMutationResult;
import static org.molgenis.emx2.graphql.GraphqlConstants.*;
import static org.molgenis.emx2.graphql.GraphqlSchemaFieldFactory.*;

import graphql.Scalars;
import graphql.schema.*;
import java.util.*;
import org.jetbrains.annotations.NotNull;
import org.molgenis.emx2.*;

public class GraphqlAdminFieldFactory {
private GraphqlAdminFieldFactory() {
// hide constructor
}

private static final String UPDATE_USER = "updateUser";

// Output types
private static final GraphQLOutputType userType =
GraphQLObjectType.newObject()
.name("_AdminUserType")
.field(
GraphQLFieldDefinition.newFieldDefinition()
.name(EMAIL)
.type(Scalars.GraphQLString)
.build())
.field(
GraphQLFieldDefinition.newFieldDefinition()
.name(ENABLED)
.type(Scalars.GraphQLBoolean)
.build())
.field(
GraphQLFieldDefinition.newFieldDefinition()
.name(SETTINGS)
.type(GraphQLList.list(outputSettingsType))
.build())
.field(
chinook25 marked this conversation as resolved.
Show resolved Hide resolved
GraphQLFieldDefinition.newFieldDefinition()
.name(ROLES)
.type(GraphQLList.list(userRolesType))
.build())
.build();

// retrieve user list, user count
public static GraphQLFieldDefinition queryAdminField(Database db) {
String userCount = "userCount";
GraphQLOutputType adminType =
GraphQLObjectType.newObject()
.name("MolgenisAdmin")
.field(
GraphQLFieldDefinition.newFieldDefinition()
.name(USERS)
.argument(GraphQLArgument.newArgument().name(EMAIL).type(Scalars.GraphQLString))
Copy link
Member

Choose a reason for hiding this comment

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

I would prefer a 'search' argument so we can search in any field. I would for example like to search on role names. That might also be a future enhancement (I think we should first convert emx2 metadata schema to be a 'normal' schema).

.argument(GraphQLArgument.newArgument().name(LIMIT).type(Scalars.GraphQLInt))
.argument(GraphQLArgument.newArgument().name(OFFSET).type(Scalars.GraphQLInt))
.type(GraphQLList.list(userType))
.build())
.field(
GraphQLFieldDefinition.newFieldDefinition()
.name(userCount)
.type(Scalars.GraphQLInt)
.build())
.build();

return GraphQLFieldDefinition.newFieldDefinition()
.name("_admin")
.dataFetcher(
dataFetchingEnvironment -> {
Map<String, Object> result = new LinkedHashMap<>();
// check for parameters
for (SelectedField selectedField :
dataFetchingEnvironment.getSelectionSet().getImmediateFields()) {
if (selectedField.getName().equals(USERS)) {
result.put(USERS, getUsers(selectedField, db));
}
if (selectedField.getName().equals(userCount)) {
result.put(userCount, db.countUsers());
}
}
return result;
})
.type(adminType)
.build();
}

private static Object getUsers(SelectedField selectedField, Database db) {
Map<String, Object> args = selectedField.getArguments();
int limit = args.containsKey(LIMIT) ? (int) args.get(LIMIT) : 100;
int offset = args.containsKey(OFFSET) ? (int) args.get(OFFSET) : 0;
String email = args.containsKey(EMAIL) ? (String) args.get(EMAIL) : null;
List<Member> members = db.loadUserRoles();

if (email != null) {
return List.of(toGraphqlUser(db.getUser(email), members));
} else {
return db.getUsers(limit, offset).stream().map(user -> toGraphqlUser(user, members)).toList();
}
}

public static GraphQLFieldDefinition removeUser(Database database) {
return GraphQLFieldDefinition.newFieldDefinition()
.name("removeUser")
.type(typeForMutationResult)
.argument(GraphQLArgument.newArgument().name(EMAIL).type(Scalars.GraphQLString))
.dataFetcher(
dataFetchingEnvironment -> {
String email = dataFetchingEnvironment.getArgument(EMAIL);
database.removeUser(email);
return new GraphqlApiMutationResult(SUCCESS, "User %s removed", email);
})
.build();
}

public static GraphQLFieldDefinition setEnabledUser(Database database) {
return GraphQLFieldDefinition.newFieldDefinition()
.name("setEnabledUser")
.type(typeForMutationResult)
.argument(GraphQLArgument.newArgument().name(EMAIL).type(Scalars.GraphQLString))
.argument(GraphQLArgument.newArgument().name(ENABLED).type(Scalars.GraphQLBoolean))
.dataFetcher(
dataFetchingEnvironment -> {
String email = dataFetchingEnvironment.getArgument(EMAIL);
boolean enabled = dataFetchingEnvironment.getArgument(ENABLED);
database.setEnabledUser(email, enabled);
return new GraphqlApiMutationResult(
SUCCESS, "User %s %s ", email, enabled ? "Enabled" : "Disabled");
})
.build();
}

private static Map<String, Object> toGraphqlUser(User user, List<Member> members) {
Map<String, Object> result = new LinkedHashMap<>();
result.put(EMAIL, user.getUsername());
result.put(ENABLED, user.getEnabled());
result.put(SETTINGS, mapSettingsToGraphql(user.getSettings()));

List<Map<String, String>> roles = getRoles(user, members);
result.put(ROLES, roles);
return result;
}

private static List<Map<String, String>> getRoles(User user, List<Member> members) {
return members.stream()
.filter(member -> member.getUser().equals(user.getUsername()))
.map(GraphqlAdminFieldFactory::getUserRoleMap)
.toList();
}

private static Map<String, String> getUserRoleMap(Member member) {
String role = member.getRole();
String[] parts = role.split("/");
Map<String, String> roleMap = new HashMap<>();
roleMap.put(SCHEMA_ID, parts[0]);
roleMap.put(ROLE, parts[1]);
return roleMap;
}

public static Object mapSettingsToGraphql(Map<String, String> settings) {
return settings.entrySet().stream()
.filter(entry -> !MOLGENIS_JWT_SHARED_SECRET.equals(entry.getKey()))
.map(entry -> Map.of(KEY, entry.getKey(), VALUE, entry.getValue()))
.toList();
}

public static GraphQLFieldDefinition updateUser(Database database) {
return GraphQLFieldDefinition.newFieldDefinition()
.name(UPDATE_USER)
.type(typeForMutationResult)
.argument(GraphQLArgument.newArgument().name(UPDATE_USER).type(updateUserType))
.dataFetcher(
dataFetchingEnvironment -> executeUpdateUser(database, dataFetchingEnvironment))
.build();
}

@NotNull
private static GraphqlApiMutationResult executeUpdateUser(
Database database, DataFetchingEnvironment dataFetchingEnvironment) {
LinkedHashMap<String, Object> updatedUser = dataFetchingEnvironment.getArgument(UPDATE_USER);
String userName = (String) updatedUser.get(EMAIL);
if (userName != null) {
database.tx(
db -> {
String password = (String) updatedUser.get(PASSWORD);
if (password != null) {
db.setUserPassword(userName, password);
}

List<Map<String, String>> roles = (List<Map<String, String>>) updatedUser.get(ROLES);
if (roles != null && roles.iterator().hasNext()) {
db.updateRoles(userName, roles);
}

List<Map<String, String>> revokedRoles =
(List<Map<String, String>>) updatedUser.get("revokedRoles");
if (revokedRoles != null && revokedRoles.iterator().hasNext()) {
db.revokeRoles(userName, revokedRoles);
}

Boolean enabled = (Boolean) updatedUser.get(ENABLED);
if (enabled != null) {
db.setEnabledUser(userName, enabled);
}
});
}
return new GraphqlApiMutationResult(SUCCESS, "User %s updated", userName);
}

private static final GraphQLInputObjectType inputUserRolesType =
new GraphQLInputObjectType.Builder()
.name("InputUserRolesType")
.field(
GraphQLInputObjectField.newInputObjectField()
.name(SCHEMA_ID)
.type(Scalars.GraphQLString))
.field(
GraphQLInputObjectField.newInputObjectField().name(ROLE).type(Scalars.GraphQLString))
.field(
GraphQLInputObjectField.newInputObjectField().name(USER).type(Scalars.GraphQLString))
.build();

private static final GraphQLInputObjectType updateUserType =
new GraphQLInputObjectType.Builder()
.name("InputUpdateUser")
.field(
GraphQLInputObjectField.newInputObjectField().name(EMAIL).type(Scalars.GraphQLString))
.field(
GraphQLInputObjectField.newInputObjectField()
.name(PASSWORD)
.type(Scalars.GraphQLString))
.field(
GraphQLInputObjectField.newInputObjectField()
.name(ENABLED)
.type(Scalars.GraphQLBoolean))
.field(
GraphQLInputObjectField.newInputObjectField()
.name(ROLES)
.type(GraphQLList.list(inputUserRolesType)))
.field(
GraphQLInputObjectField.newInputObjectField()
.name("revokedRoles")
.type(GraphQLList.list(inputUserRolesType)))
.build();
}
Loading
Loading