Restructure group routes and add test for search-groups

Author: ml-evs

pydatalab/schemas/cell.json

@@ -353,8 +353,7 @@
       },
       "required": [
         "group_id",
-        "display_name",
-        "group_admins"
+        "display_name"
       ]
     },
     "AccountStatus": {

pydatalab/schemas/equipment.json

@@ -308,8 +308,7 @@
       },
       "required": [
         "group_id",
-        "display_name",
-        "group_admins"
+        "display_name"
       ]
     },
     "AccountStatus": {

pydatalab/schemas/sample.json

@@ -312,8 +312,7 @@
       },
       "required": [
         "group_id",
-        "display_name",
-        "group_admins"
+        "display_name"
       ]
     },
     "AccountStatus": {

pydatalab/schemas/startingmaterial.json

@@ -366,8 +366,7 @@
       },
       "required": [
         "group_id",
-        "display_name",
-        "group_admins"
+        "display_name"
       ]
     },
     "AccountStatus": {

pydatalab/src/pydatalab/models/people.py

@@ -118,7 +118,7 @@ class Group(Entry):
     description: Optional[str]
     """A description of the group"""
 
-    group_admins: List[PyObjectId]
+    group_admins: Optional[List[PyObjectId]]
     """A list of user IDs that can manage this group."""
 
 

pydatalab/src/pydatalab/routes/v0_1/__init__.py

@@ -7,11 +7,12 @@
 from .collections import COLLECTIONS
 from .files import FILES
 from .graphs import GRAPHS
+from .groups import GROUPS
 from .healthcheck import HEALTHCHECK
 from .info import INFO
 from .items import ITEMS
 from .remotes import REMOTES
-from .users import GROUPS, USERS
+from .users import USERS
 
 BLUEPRINTS: tuple[Blueprint, ...] = (
     AUTH,

pydatalab/src/pydatalab/routes/v0_1/admin.py

@@ -1,10 +1,13 @@
+import json
+
+import pymongo.errors
 from bson import ObjectId
 from flask import Blueprint, jsonify, request
 from flask_login import current_user
 
 from pydatalab.config import CONFIG
 from pydatalab.models.people import Group, User
-from pydatalab.mongo import flask_mongo
+from pydatalab.mongo import _get_active_mongo_client, flask_mongo
 from pydatalab.permissions import admin_only
 
 ADMIN = Blueprint("admins", __name__)
@@ -54,7 +57,7 @@ def get_users():
         ]
     )
 
-    return jsonify({"status": "success", "data": list(User(**u).json() for u in users)})
+    return jsonify({"status": "success", "data": list(json.loads(User(**u).json()) for u in users)})
 
 
 @ADMIN.route("/roles/<user_id>", methods=["PATCH"])
@@ -111,5 +114,80 @@ def save_role(user_id):
 @ADMIN.route("/groups", methods=["GET"])
 def get_groups():
     return jsonify(
-        {"status": "success", "data": [Group(**d).json() for d in flask_mongo.db.groups.find()]}
+        {
+            "status": "success",
+            "data": [json.loads(Group(**d).json()) for d in flask_mongo.db.groups.find()],
+        }
     ), 200
+
+
+@ADMIN.route("/groups", methods=["PUT"])
+@admin_only
+def create_group():
+    request_json = request.get_json()
+
+    group_json = {
+        "group_id": request_json.get("group_id"),
+        "display_name": request_json.get("display_name"),
+        "description": request_json.get("description"),
+        "group_admins": request_json.get("group_admins"),
+    }
+    try:
+        group = Group(**group_json)
+    except Exception as e:
+        return jsonify({"status": "error", "message": f"Invalid group data: {str(e)}"}), 400
+
+    try:
+        group_immutable_id = flask_mongo.db.groups.insert_one(group.dict()).inserted_id
+    except pymongo.errors.DuplicateKeyError:
+        return jsonify(
+            {"status": "error", "message": f"Group ID {group.group_id} already exists."}
+        ), 400
+
+    if group_immutable_id:
+        return jsonify({"status": "success", "group_immutable_id": str(group_immutable_id)}), 200
+
+    return jsonify({"status": "error", "message": "Unable to create group."}), 400
+
+
+@ADMIN.route("/groups", methods=["DELETE"])
+def delete_group():
+    request_json = request.get_json()
+
+    group_id = request_json.get("immutable_id")
+    if group_id is not None:
+        result = flask_mongo.db.groups.delete_one({"_id": ObjectId(group_id)})
+
+        if result.deleted_count == 1:
+            return jsonify({"status": "success"}), 200
+
+    return jsonify({"status": "error", "message": "Unable to delete group."}), 400
+
+
+@ADMIN.route("/groups/<group_immutable_id>", methods=["PATCH"])
+def add_user_to_group(group_immutable_id):
+    request_json = request.get_json()
+
+    user_id = request_json.get("user_id")
+
+    if not user_id:
+        return jsonify({"status": "error", "message": "No user ID provided."}), 400
+
+    client = _get_active_mongo_client()
+    with client.start_session(causal_consistency=True) as session:
+        group_exists = flask_mongo.db.groups.find_one(
+            {"_id": ObjectId(group_immutable_id)}, session=session
+        )
+        if not group_exists:
+            return jsonify({"status": "error", "message": "Group does not exist."}), 400
+
+        update_user = flask_mongo.db.users.update_one(
+            {"_id": ObjectId(user_id)},
+            {"$addToSet": {"groups": group_immutable_id}},
+            session=session,
+        )
+
+        if not update_user.modified_count == 1:
+            return jsonify({"status": "error", "message": "Unable to add user to group."}), 400
+
+    return jsonify({"status": "error", "message": "Unable to add user to group."}), 400

pydatalab/src/pydatalab/routes/v0_1/groups.py

@@ -0,0 +1,46 @@
+import json
+
+from flask import Blueprint, jsonify, request
+
+from pydatalab.models.people import Group
+from pydatalab.mongo import flask_mongo
+from pydatalab.permissions import active_users_or_get_only
+
+GROUPS = Blueprint("groups", __name__)
+
+
+@GROUPS.route("/search/groups", methods=["GET"])
+@active_users_or_get_only
+def search_groups():
+    """Perform free text search on groups and return the top results.
+    GET parameters:
+        query: String with the search terms.
+        nresults: Maximum number of results (default 100)
+
+    Returns:
+        response list of dictionaries containing the matching groups in order of
+        descending match score.
+    """
+
+    query = request.args.get("query", type=str)
+    nresults = request.args.get("nresults", default=100, type=int)
+    match_obj = {"$text": {"$search": query}}
+
+    cursor = flask_mongo.db.groups.aggregate(
+        [
+            {"$match": match_obj},
+            {"$sort": {"score": {"$meta": "textScore"}}},
+            {"$limit": nresults},
+            {
+                "$project": {
+                    "_id": 1,
+                    "display_name": 1,
+                    "description": 1,
+                    "group_id": 1,
+                }
+            },
+        ]
+    )
+    return jsonify(
+        {"status": "success", "data": list(json.loads(Group(**d).json()) for d in cursor)}
+    ), 200

pydatalab/src/pydatalab/routes/v0_1/users.py

@@ -1,100 +1,22 @@
 import json
 
-import pymongo.errors
 from bson import ObjectId
 from flask import Blueprint, jsonify, request
 from flask_login import current_user
 
 from pydatalab.config import CONFIG
-from pydatalab.models.people import DisplayName, EmailStr, Group, Person
-from pydatalab.mongo import _get_active_mongo_client, flask_mongo
-from pydatalab.permissions import active_users_or_get_only, admin_only
+from pydatalab.models.people import DisplayName, EmailStr, Person
+from pydatalab.mongo import flask_mongo
+from pydatalab.permissions import active_users_or_get_only
 
 USERS = Blueprint("users", __name__)
-GROUPS = Blueprint("groups", __name__)
 
 
 @USERS.before_request
 @active_users_or_get_only
 def _(): ...
 
 
-@GROUPS.before_request
-@admin_only
-def _(): ...
-
-
-@GROUPS.route("/groups", methods=["PUT"])
-def create_group():
-    request_json = request.get_json()
-
-    group_json = {
-        "group_id": request_json.get("group_id"),
-        "display_name": request_json.get("display_name"),
-        "description": request_json.get("description"),
-        "group_admins": request_json.get("group_admins"),
-    }
-    try:
-        group = Group(**group_json)
-    except Exception as e:
-        return jsonify({"status": "error", "message": f"Invalid group data: {str(e)}"}), 400
-
-    try:
-        group_immutable_id = flask_mongo.db.groups.insert_one(group.dict()).inserted_id
-    except pymongo.errors.DuplicateKeyError:
-        return jsonify(
-            {"status": "error", "message": f"Group ID {group.group_id} already exists."}
-        ), 400
-
-    if group_immutable_id:
-        return jsonify({"status": "success", "group_immutable_id": str(group_immutable_id)}), 200
-
-    return jsonify({"status": "error", "message": "Unable to create group."}), 400
-
-
-@GROUPS.route("/groups", methods=["DELETE"])
-def delete_group():
-    request_json = request.get_json()
-
-    group_id = request_json.get("immutable_id")
-    if group_id is not None:
-        result = flask_mongo.db.groups.delete_one({"_id": ObjectId(group_id)})
-
-        if result.deleted_count == 1:
-            return jsonify({"status": "success"}), 200
-
-    return jsonify({"status": "error", "message": "Unable to delete group."}), 400
-
-
-@GROUPS.route("/groups/<group_immutable_id>", methods=["PATCH"])
-def add_user_to_group(group_immutable_id):
-    request_json = request.get_json()
-
-    user_id = request_json.get("user_id")
-
-    if not user_id:
-        return jsonify({"status": "error", "message": "No user ID provided."}), 400
-
-    client = _get_active_mongo_client()
-    with client.start_session(causal_consistency=True) as session:
-        group_exists = flask_mongo.db.groups.find_one(
-            {"_id": ObjectId(group_immutable_id)}, session=session
-        )
-        if not group_exists:
-            return jsonify({"status": "error", "message": "Group does not exist."}), 400
-
-        update_user = flask_mongo.db.users.update_one(
-            {"_id": ObjectId(user_id)},
-            {"$addToSet": {"groups": group_immutable_id}},
-            session=session,
-        )
-
-        if not update_user.modified_count == 1:
-            return jsonify({"status": "error", "message": "Unable to add user to group."}), 400
-
-    return jsonify({"status": "error", "message": "Unable to add user to group."}), 400
-
-
 @USERS.route("/users/<user_id>", methods=["PATCH"])
 def save_user(user_id):
     request_json = request.get_json()

pydatalab/tests/server/test_users.py

@@ -184,3 +184,8 @@ def test_create_group(admin_client, client, unauthenticated_client, real_mongo_c
         real_mongo_client.get_database().groups.find_one({"group_id": good_group["group_id"]})
         is None
     )
+
+    # Check a user can search groups
+    resp = client.get("/search/groups?query=New")
+    assert resp.status_code == 200
+    assert len(resp.json["data"]) == 1