5450 create a sample project

packages/client/hmi-client/src/components/home/tera-project-menu.vue

@@ -12,10 +12,11 @@ import { isEmpty } from 'lodash';
 import Button from 'primevue/button';
 import Menu from 'primevue/menu';
 import { computed, ref } from 'vue';
-import { exportProjectAsFile } from '@/services/project';
+import { exportProjectAsFile, setSample } from '@/services/project';
 import { AcceptedExtensions } from '@/types/common';
 import { MenuItem } from 'primevue/menuitem';
 import useAuthStore from '@/stores/auth';
+import { useToastService } from '@/services/toast';
 
 const props = defineProps<{ project: Project | null }>();
 
@@ -81,6 +82,20 @@ const downloadMenuItem = {
 	}
 };
 
+const makeSampleMenuItem = {
+	label: 'Make a sample',
+	icon: 'pi pi-star',
+	command: () => {
+		setSample(props.project?.id).then((response) => {
+			if (response) {
+				useToastService().success(undefined, 'Project set as sample');
+			} else {
+				useToastService().error(undefined, 'Error setting project as sample');
+			}
+		});
+	}
+};
+
 const projectMenuItems = computed(() => {
 	// Basic access to a public and reader project
 	const items: MenuItem[] = [copyMenuItem, downloadMenuItem];
@@ -95,6 +110,11 @@ const projectMenuItems = computed(() => {
 		items.push(removeMenuItem);
 	}
 
+	// Admin only
+	if (useAuthStore().isAdmin) {
+		items.push(makeSampleMenuItem);
+	}
+
 	return items;
 });
 

packages/client/hmi-client/src/page/Home.vue

@@ -230,9 +230,10 @@ const myFilteredSortedProjects = computed(() => {
 	const projects = useProjects().allProjects.value;
 	if (!projects) return [];
 	const myProjects = projects.filter(
-		({ userPermission, publicProject }) =>
-			// I can edit the project, or I can view the project and it's not public
-			['creator', 'writer'].includes(userPermission ?? '') || (userPermission === 'reader' && !publicProject)
+		({ userPermission, publicProject, sampleProject }) =>
+			// I can edit the project, or I can view the project, and it's not public
+			['creator', 'writer'].includes(userPermission ?? '') ||
+			(userPermission === 'reader' && publicProject === false && sampleProject === false)
 	);
 	return filterAndSortProjects(myProjects);
 });
@@ -248,10 +249,19 @@ function tabChange(event) {
 const publicFilteredSortedProjects = computed(() => {
 	const projects = useProjects().allProjects.value;
 	if (!projects) return [];
-	const publicProjects = projects.filter(({ publicProject }) => publicProject === true);
+	const publicProjects = projects.filter(
+		({ publicProject, sampleProject }) => publicProject === true && sampleProject === false
+	);
 	return filterAndSortProjects(publicProjects);
 });
 
+const sampleFilteredSortedProjects = computed(() => {
+	const projects = useProjects().allProjects.value;
+	if (!projects) return [];
+	const sampleProjects = projects.filter(({ sampleProject }) => sampleProject === true);
+	return filterAndSortProjects(sampleProjects);
+});
+
 function openCreateProjectModal() {
 	isProjectConfigDialogVisible.value = true;
 	menuProject.value = null;
@@ -305,7 +315,7 @@ function filterAndSortProjects(projects: Project[]) {
 const projectsTabs = computed<{ title: string; projects: Project[] }[]>(() => [
 	{ title: TabTitles.MyProjects, projects: myFilteredSortedProjects.value },
 	{ title: TabTitles.PublicProjects, projects: publicFilteredSortedProjects.value },
-	{ title: TabTitles.SampleProjects, projects: [] }
+	{ title: TabTitles.SampleProjects, projects: sampleFilteredSortedProjects.value }
 ]);
 
 // Table view

packages/client/hmi-client/src/services/project.ts

@@ -153,6 +153,16 @@ async function setAccessibility(projectId: Project['id'], isPublic: boolean): Pr
 	}
 }
 
+async function setSample(projectId: Project['id']): Promise<boolean> {
+	try {
+		const response = await API.post(`projects/set-sample/${projectId}`);
+		return response?.status === 200;
+	} catch (error) {
+		console.error(`The project was not made a sample project, ${error}`);
+		return false;
+	}
+}
+
 async function getPermissions(projectId: Project['id']): Promise<PermissionRelationships | null> {
 	try {
 		const { status, data } = await API.get(`projects/${projectId}/permissions`);
@@ -288,6 +298,7 @@ export {
 	removePermissions,
 	setAccessibility,
 	setPermissions,
+	setSample,
 	update,
 	updatePermissions,
 	exportProjectAsFile,

packages/client/hmi-client/src/types/Types.ts

@@ -294,6 +294,7 @@ export interface Project extends TerariumAsset {
     overviewContent?: any;
     projectAssets: ProjectAsset[];
     metadata?: { [index: string]: string };
+    sampleProject?: boolean;
     publicProject?: boolean;
     userPermission?: string;
 }
@@ -795,9 +796,9 @@ export interface ModelUnit {
 }
 
 export interface GroundedSemantic {
+    grounding?: ModelGrounding;
     id: string;
     name?: string;
-    grounding?: ModelGrounding;
     description?: string;
 }
 

packages/server/src/main/java/software/uncharted/terarium/hmiserver/controller/dataservice/ProjectController.java

@@ -1125,6 +1125,75 @@ public ResponseEntity<JsonNode> makeProjectPublic(
 		}
 	}
 
+	@Operation(summary = "Set a project as a sample project by ID")
+	@ApiResponses(
+		value = {
+			@ApiResponse(
+				responseCode = "200",
+				description = "Project has been made a sample project",
+				content = {
+					@Content(
+						mediaType = "application/json",
+						schema = @io.swagger.v3.oas.annotations.media.Schema(implementation = UUID.class)
+					)
+				}
+			),
+			@ApiResponse(
+				responseCode = "403",
+				description = "The current user does not have privileges to modify this project.",
+				content = @Content
+			),
+			@ApiResponse(responseCode = "500", description = "An error occurred verifying permissions", content = @Content)
+		}
+	)
+	@PostMapping("/set-sample/{id}")
+	@Secured(Roles.USER)
+	public ResponseEntity<JsonNode> makeProjectSample(@PathVariable("id") final UUID id) {
+		try {
+			// Only an admin can set a project as a sample project
+			projectService.checkPermissionCanAdministrate(currentUserService.get().getId(), id);
+
+			final Optional<Project> project = projectService.getProject(id);
+			if (project.isEmpty()) {
+				throw new ResponseStatusException(HttpStatus.NOT_FOUND, messages.get("projects.not-found"));
+			}
+
+			// Update the project and make it public as well as a sample project
+			project.get().setSampleProject(true).setPublicAsset(true);
+			projectAssetService.togglePublicForAssets(terariumAssetServices, id, true, Schema.Permission.WRITE);
+			projectService.updateProject(project.get());
+
+			/* Permissions */
+
+			// Getting the project
+			final RebacProject rebacProject = new RebacProject(id, reBACService);
+
+			// Delete all previous user relationships attached to the project,
+			final List<Contributor> contributors = projectPermissionsService.getContributors(rebacProject);
+			for (final Contributor contributor : contributors) {
+				if (contributor.isUser()) {
+					final RebacUser rebacUser = new RebacUser(contributor.getUserId(), reBACService);
+					rebacUser.removeAllRelationships(rebacProject);
+				}
+			}
+
+			// Add the Admin group to administrate the project
+			final RebacGroup adminGroup = new RebacGroup(ReBACService.ASKEM_ADMIN_GROUP_ID, reBACService);
+			adminGroup.removeAllRelationsExceptOne(rebacProject, Schema.Relationship.ADMIN);
+
+			// Add the public group to read the project
+			final RebacGroup publicGroup = new RebacGroup(ReBACService.PUBLIC_GROUP_ID, reBACService);
+			publicGroup.removeAllRelationsExceptOne(rebacProject, Schema.Relationship.READER);
+
+			return ResponseEntity.ok().build();
+		} catch (final ResponseStatusException rethrow) {
+			throw rethrow;
+		} catch (final Exception e) {
+			log.error("Unexpected error, failed to set as a sample project ", e);
+			throw new ResponseStatusException(HttpStatus.SERVICE_UNAVAILABLE, messages.get("rebac.service-unavailable"));
+		}
+	}
+
 	@PostMapping("/{id}/permissions/user/{user-id}/{relationship}")
 	@Secured(Roles.USER)
 	@Operation(summary = "Sets a user's permissions for a project")

packages/server/src/main/java/software/uncharted/terarium/hmiserver/models/dataservice/project/Contributor.java

@@ -26,4 +26,14 @@ public Schema.Relationship getPermission() {
 	public String getUserId() {
 		return userId;
 	}
+
+	/** Is the Contributor a Group? */
+	public Boolean isGroup() {
+		return userId == null;
+	}
+
+	/** Is the Contributor a User? */
+	public Boolean isUser() {
+		return userId != null;
+	}
 }

packages/server/src/main/java/software/uncharted/terarium/hmiserver/models/dataservice/project/Project.java

@@ -65,6 +65,10 @@ public class Project extends TerariumAsset {
 	@Schema(accessMode = Schema.AccessMode.READ_ONLY, defaultValue = "{}")
 	private Map<String, String> metadata;
 
+	@TSOptional
+	@Schema(accessMode = Schema.AccessMode.READ_ONLY, defaultValue = "false")
+	private Boolean sampleProject;
+
 	/** Information for the front-end to display/filter the project accordingly. */
 	@TSOptional
 	@Transient

packages/server/src/main/java/software/uncharted/terarium/hmiserver/utils/rebac/ReBACService.java

@@ -491,11 +491,15 @@ public void removeRelationship(
 		final SchemaObject who,
 		final SchemaObject what,
 		final Schema.Relationship relationship
-	) throws Exception, RelationshipAlreadyExistsException {
+	) throws Exception {
 		userCache.invalidate(who.id);
 		invalidatePermissionCache(who, what);
 		final ReBACFunctions rebac = new ReBACFunctions(channel, spiceDbBearerToken);
-		CURRENT_ZED_TOKEN = rebac.removeRelationship(who, relationship, what);
+		try {
+			CURRENT_ZED_TOKEN = rebac.removeRelationship(who, relationship, what);
+		} catch (RelationshipAlreadyExistsException ignore) {
+			// NB: This is a no-op as the relationship is already removed
+		}
 	}
 
 	private Consistency getCurrentConsistency() {

packages/server/src/main/java/software/uncharted/terarium/hmiserver/utils/rebac/askem/RebacGroup.java

@@ -26,6 +26,10 @@ public boolean canAdministrate(RebacObject rebacObject) throws Exception {
 		return reBACService.can(getSchemaObject(), Schema.Permission.ADMINISTRATE, rebacObject.getSchemaObject());
 	}
 
+	public void createReaderRelationship(RebacObject rebacObject) throws Exception, RelationshipAlreadyExistsException {
+		reBACService.createRelationship(getSchemaObject(), rebacObject.getSchemaObject(), Schema.Relationship.READER);
+	}
+
 	public void createWriterRelationship(RebacObject rebacObject) throws Exception, RelationshipAlreadyExistsException {
 		reBACService.createRelationship(getSchemaObject(), rebacObject.getSchemaObject(), Schema.Relationship.WRITER);
 	}
@@ -34,6 +38,38 @@ public void createCreatorRelationship(RebacObject rebacObject) throws Exception,
 		reBACService.createRelationship(getSchemaObject(), rebacObject.getSchemaObject(), Schema.Relationship.CREATOR);
 	}
 
+	public void createAdminRelationship(RebacObject rebacObject) throws Exception, RelationshipAlreadyExistsException {
+		reBACService.createRelationship(getSchemaObject(), rebacObject.getSchemaObject(), Schema.Relationship.ADMIN);
+	}
+
+	/** Remove all relationships between this group and the given object. */
+	public void removeAllRelationships(final RebacObject rebacObject) throws Exception {
+		final Schema.Relationship[] relationships = Schema.Relationship.values();
+		for (Schema.Relationship relationship : relationships) {
+			reBACService.removeRelationship(getSchemaObject(), rebacObject.getSchemaObject(), relationship);
+		}
+	}
+
+	/**
+	 * Remove all relationships between this group and the given object.
+	 * Except the provided relationship, if it doesn't exist, it will be added
+	 */
+	public void removeAllRelationsExceptOne(
+		final RebacObject rebacObject,
+		final Schema.Relationship relationshipToIgnore
+	) throws Exception {
+		final Schema.Relationship[] relationships = Schema.Relationship.values();
+		for (Schema.Relationship relationship : relationships) {
+			if (relationship == relationshipToIgnore) {
+				try {
+					reBACService.createRelationship(getSchemaObject(), rebacObject.getSchemaObject(), relationship);
+				} catch (RelationshipAlreadyExistsException ignore) {}
+			} else {
+				reBACService.removeRelationship(getSchemaObject(), rebacObject.getSchemaObject(), relationship);
+			}
+		}
+	}
+
 	public void setPermissionRelationships(RebacObject who, String relationship)
 		throws Exception, RelationshipAlreadyExistsException {
 		Schema.Relationship relationshipEnum = Schema.Relationship.valueOf(relationship.toUpperCase());

packages/server/src/main/java/software/uncharted/terarium/hmiserver/utils/rebac/askem/RebacUser.java

@@ -63,6 +63,34 @@ public void createCreatorRelationship(final RebacObject rebacObject)
 		reBACService.createRelationship(getSchemaObject(), rebacObject.getSchemaObject(), Schema.Relationship.CREATOR);
 	}
 
+	public void createWriterRelationship(final RebacObject rebacObject)
+		throws Exception, RelationshipAlreadyExistsException {
+		reBACService.createRelationship(getSchemaObject(), rebacObject.getSchemaObject(), Schema.Relationship.WRITER);
+	}
+
+	public void createReaderRelationship(final RebacObject rebacObject)
+		throws Exception, RelationshipAlreadyExistsException {
+		reBACService.createRelationship(getSchemaObject(), rebacObject.getSchemaObject(), Schema.Relationship.READER);
+	}
+
+	public void removeCreatorRelationship(final RebacObject rebacObject) throws Exception {
+		reBACService.removeRelationship(getSchemaObject(), rebacObject.getSchemaObject(), Schema.Relationship.CREATOR);
+	}
+
+	public void removeWriterRelationship(final RebacObject rebacObject) throws Exception {
+		reBACService.removeRelationship(getSchemaObject(), rebacObject.getSchemaObject(), Schema.Relationship.WRITER);
+	}
+
+	public void removeReaderRelationship(final RebacObject rebacObject) throws Exception {
+		reBACService.removeRelationship(getSchemaObject(), rebacObject.getSchemaObject(), Schema.Relationship.READER);
+	}
+
+	public void removeAllRelationships(final RebacObject rebacObject) throws Exception {
+		reBACService.removeRelationship(getSchemaObject(), rebacObject.getSchemaObject(), Schema.Relationship.CREATOR);
+		reBACService.removeRelationship(getSchemaObject(), rebacObject.getSchemaObject(), Schema.Relationship.WRITER);
+		reBACService.removeRelationship(getSchemaObject(), rebacObject.getSchemaObject(), Schema.Relationship.READER);
+	}
+
 	public PermissionGroup createGroup(final String name) throws Exception, RelationshipAlreadyExistsException {
 		final PermissionGroup group = reBACService.createGroup(name);
 		reBACService.createRelationship(