feat(tags): New mutation to add multiple tags to an experiment. (#98)

* add mutation for multiple tags with the change to the service and tests.

* fix issue with duplicate tags with different casing.

* fix minor issue in generate license report workflow.

* update vscode setting to append a line at the end of the file.

Author: samiralavi

.github/workflows/license_report.yml

@@ -14,9 +14,6 @@ jobs:
         with:
           python-version: "3.10"
 
-      - name: Install packages
-        run: poetry install
-
       - name: Create a markdown file with contents
         id: sets-licenses
         run: |

.gitignore

@@ -133,4 +133,5 @@ dmypy.json
 
 # Other unneeded files
 .DS_Store
-frontend_build
+frontend_build
+license_report.md

.vscode/settings.json

@@ -34,5 +34,7 @@
         "tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg",
         "tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji",
         "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
-    ]
-}
+    ],
+    "files.insertFinalNewline": true,
+    "notebook.insertFinalNewline": true
+}

aqueductcore/backend/routers/graphql/inputs.py

@@ -39,6 +39,14 @@ class ExperimentTagInput:
     tag: str
 
 
+@strawberry.input
+class ExperimentTagsInput:
+    """Input type to add or remove tags from experiment"""
+
+    experiment_id: UUID
+    tags: List[str]
+
+
 @strawberry.input
 class ExperimentCreateInput:
     """Input type to create experiemnt"""

aqueductcore/backend/routers/graphql/mutations/experiment_mutations.py

@@ -7,6 +7,7 @@
     ExperimentCreateInput,
     ExperimentRemoveInput,
     ExperimentTagInput,
+    ExperimentTagsInput,
     ExperimentUpdateInput,
 )
 from aqueductcore.backend.routers.graphql.types import ExperimentData
@@ -49,11 +50,25 @@ async def add_tag_to_experiment(
 ) -> ExperimentData:
     """Add tag to experiment mutation"""
 
-    experiment = await experiment_service.add_tag_to_experiment(
+    experiment = await experiment_service.add_tags_to_experiment(
         user_info=context.user_info,
         db_session=context.db_session,
         experiment_id=experiment_tag_input.experiment_id,
-        tag=experiment_tag_input.tag,
+        tags=[experiment_tag_input.tag],
+    )
+    return experiment_model_to_node(experiment)
+
+
+async def add_tags_to_experiment(
+    context: ServerContext, experiment_tags_input: ExperimentTagsInput
+) -> ExperimentData:
+    """Add tag to experiment mutation"""
+
+    experiment = await experiment_service.add_tags_to_experiment(
+        user_info=context.user_info,
+        db_session=context.db_session,
+        experiment_id=experiment_tags_input.experiment_id,
+        tags=experiment_tags_input.tags,
     )
     return experiment_model_to_node(experiment)
 

aqueductcore/backend/routers/graphql/mutations_schema.py

@@ -11,10 +11,12 @@
     ExperimentCreateInput,
     ExperimentRemoveInput,
     ExperimentTagInput,
+    ExperimentTagsInput,
     ExperimentUpdateInput,
 )
 from aqueductcore.backend.routers.graphql.mutations.experiment_mutations import (
     add_tag_to_experiment,
+    add_tags_to_experiment,
     create_experiment,
     remove_experiment,
     remove_tag_from_experiment,
@@ -65,6 +67,18 @@ async def add_tag_to_experiment(
         )
         return experiment
 
+    @strawberry.mutation
+    async def add_tags_to_experiment(
+        self, info: Info, experiment_tags_input: ExperimentTagsInput
+    ) -> ExperimentData:
+        """Mutation to add tag to experiment"""
+
+        context = cast(ServerContext, info.context)
+        experiment = await add_tags_to_experiment(
+            context=context, experiment_tags_input=experiment_tags_input
+        )
+        return experiment
+
     @strawberry.mutation
     async def remove_tag_from_experiment(
         self, info: Info, experiment_tag_input: ExperimentTagInput

aqueductcore/backend/services/experiment.py

@@ -320,8 +320,7 @@ async def create_experiment(
     )
     db_session.add(db_experiment)
 
-    for db_tag in tags_in_db:
-        db_experiment.tags.append(db_tag)
+    db_experiment.tags.extend(tags_in_db)
 
     await db_session.commit()
 
@@ -369,8 +368,8 @@ async def update_experiment(
 
 
 @validate_call(config=ConfigDict(arbitrary_types_allowed=True))
-async def add_tag_to_experiment(
-    user_info: UserInfo, db_session: AsyncSession, experiment_id: UUID, tag: ExperimentTag
+async def add_tags_to_experiment(
+    user_info: UserInfo, db_session: AsyncSession, experiment_id: UUID, tags: List[ExperimentTag]
 ) -> ExperimentRead:
     """Add tag to experiment"""
 
@@ -391,21 +390,25 @@ async def add_tag_to_experiment(
             "Non-existing experiment with the specified ID for the user."
         )
 
-    tag_key = tag.lower()
-    experiment_tags = [tag.key for tag in db_experiment.tags]
-
-    if tag_key in experiment_tags:
-        raise AQDDBError("DB query failed due to pre-existing tag with the Experiment.")
+    new_tags = {tag.lower(): tag for tag in tags}
 
-    tag_statement = select(orm.Tag).filter(orm.Tag.key == tag_key)
+    if len(set(new_tags.keys())) != len(tags):
+        raise AQDValidationError("Duplicate tags are not allowed in the request.")
 
+    tag_statement = select(orm.Tag).filter(orm.Tag.key.in_(new_tags.keys()))
     result = await db_session.execute(tag_statement)
-    db_tag = result.scalars().first()
-    if db_tag is None:
-        db_tag = orm.Tag(name=tag, key=tag_key)
-        db_session.add(db_tag)
 
-    db_experiment.tags.append(db_tag)
+    cur_db_tags = result.unique().scalars().all()
+    for db_tag in cur_db_tags:
+        if db_tag.key in new_tags:
+            del new_tags[db_tag.key]
+            if db_tag not in db_experiment.tags:
+                db_experiment.tags.append(db_tag)
+
+    for key, value in new_tags.items():
+        db_tag = orm.Tag(name=value, key=key)
+        db_session.add(db_tag)
+        db_experiment.tags.append(db_tag)
 
     await db_session.commit()
 

ci/generate_license_report.sh

@@ -20,7 +20,8 @@ if [[ -z $(which poetry) ]]; then
     poetry config virtualenvs.in-project false
 fi
 
-
+echo "Installing dependencies"
+poetry install
 yarn install --cwd $FRONTEND_DIR
 
 export BACKEND_LICENSES=$(poetry run pip-licenses --format=markdown --order=license)

ci/unit_tests.sh

@@ -23,4 +23,3 @@ poetry install
 
 echo "Build coverage report"
 poetry run $PROJECT_ROOT/scripts/run_unit_tests.sh
-

tests/unittests/test_experiment_services.py

@@ -9,11 +9,11 @@
 from sqlalchemy.ext.asyncio import AsyncSession
 
 from aqueductcore.backend.context import UserInfo, UserScope
-from aqueductcore.backend.errors import AQDDBExperimentNonExisting
+from aqueductcore.backend.errors import AQDDBExperimentNonExisting, AQDValidationError
 from aqueductcore.backend.models import orm
 from aqueductcore.backend.models.experiment import ExperimentCreate, TagCreate
 from aqueductcore.backend.services.experiment import (
-    add_tag_to_experiment,
+    add_tags_to_experiment,
     build_experiment_dir_absolute_path,
     create_experiment,
     generate_experiment_id_and_alias,
@@ -384,20 +384,108 @@ async def test_add_db_tag_to_experiment(
 
     await db_session.commit()
 
-    in_db_experiment = await add_tag_to_experiment(
+    in_db_experiment = await add_tags_to_experiment(
         user_info=UserInfo(
             user_id=uuid4(), username=settings.default_username, scopes=set(UserScope)
         ),
         db_session=db_session,
         experiment_id=experiments_data[0].id,
-        tag="important",
+        tags=["important"],
     )
-    await db_session.commit()
 
     in_db_experiment_tags = [tag.name for tag in in_db_experiment.tags]
     assert "important" in in_db_experiment_tags
 
 
+@pytest.mark.asyncio
+async def test_add_db_unique_tags_to_experiment(
+    db_session: AsyncSession, experiments_data: List[ExperimentCreate]
+):
+    """Test update_db_experiment operation"""
+
+    db_user = orm.User(id=UUID(int=0), username=settings.default_username)
+    db_session.add(db_user)
+
+    for experiment in experiments_data:
+        db_experiment = experiment_model_to_orm(experiment)
+        db_experiment.created_by_user = db_user
+        db_session.add(db_experiment)
+
+    await db_session.commit()
+
+    expected_tags = ["test1", "test2", "test3"]
+    in_db_experiment = await add_tags_to_experiment(
+        user_info=UserInfo(
+            user_id=uuid4(), username=settings.default_username, scopes=set(UserScope)
+        ),
+        db_session=db_session,
+        experiment_id=experiments_data[0].id,
+        tags=expected_tags,
+    )
+
+    in_db_experiment_tags = [tag.name for tag in in_db_experiment.tags]
+    for item in expected_tags:
+        assert item in in_db_experiment_tags
+
+
+@pytest.mark.asyncio
+async def test_add_db_unique_tags_to_experiment_pre_existing_tags(
+    db_session: AsyncSession, experiments_data: List[ExperimentCreate]
+):
+    """Test update_db_experiment operation"""
+
+    db_user = orm.User(id=UUID(int=0), username=settings.default_username)
+    db_session.add(db_user)
+
+    for experiment in experiments_data:
+        db_experiment = experiment_model_to_orm(experiment)
+        db_experiment.created_by_user = db_user
+        db_session.add(db_experiment)
+
+    await db_session.commit()
+
+    expected_tags = {"test1", "test2", "test3", experiments_data[0].tags[0].name}
+    in_db_experiment = await add_tags_to_experiment(
+        user_info=UserInfo(
+            user_id=uuid4(), username=settings.default_username, scopes=set(UserScope)
+        ),
+        db_session=db_session,
+        experiment_id=experiments_data[0].id,
+        tags=list(expected_tags),
+    )
+
+    in_db_experiment_tags = [tag.name for tag in in_db_experiment.tags]
+    assert expected_tags.issubset(in_db_experiment_tags)
+
+
+@pytest.mark.asyncio
+async def test_add_db_duplicate_tags_in_request_to_experiment(
+    db_session: AsyncSession, experiments_data: List[ExperimentCreate]
+):
+    """Test update_db_experiment operation"""
+
+    db_user = orm.User(id=UUID(int=0), username=settings.default_username)
+    db_session.add(db_user)
+
+    for experiment in experiments_data:
+        db_experiment = experiment_model_to_orm(experiment)
+        db_experiment.created_by_user = db_user
+        db_session.add(db_experiment)
+
+    await db_session.commit()
+
+    expected_tags = ["test1", "test1"]
+    with pytest.raises(AQDValidationError):
+        await add_tags_to_experiment(
+            user_info=UserInfo(
+                user_id=uuid4(), username=settings.default_username, scopes=set(UserScope)
+            ),
+            db_session=db_session,
+            experiment_id=experiments_data[0].id,
+            tags=expected_tags,
+        )
+
+
 @pytest.mark.asyncio
 async def test_remove_db_tag_from_experiment(
     db_session: AsyncSession, experiments_data: List[ExperimentCreate]