task[hmi-server] - server cleanup (#3464)

Co-authored-by: dvince2 <dvince2@users.noreply.github.com>

packages/client/hmi-client/src/components/code/tera-code.vue

@@ -508,7 +508,7 @@ watch(
 			const code = await getCodeAsset(props.assetId);
 			if (code && code.files && Object.keys(code.files)[0]) {
 				codeAsset.value = code;
-				codeName.value = code.name;
+				codeName.value = code.name ?? '';
 
 				const filename = Object.keys(code.files)[0];
 				codeSelectedFile.value = filename;

packages/client/hmi-client/src/components/workflow/ops/calibrate-ensemble-ciemss/tera-calibrate-ensemble-ciemss.vue

@@ -373,7 +373,7 @@ onMounted(async () => {
 	csvAsset.value = csv;
 	datasetColumnNames.value = csv?.headers;
 
-	listModelLabels.value = allModelConfigurations.value.map((ele) => ele.name);
+	listModelLabels.value = allModelConfigurations.value.map((ele) => ele.name ?? '');
 
 	// initalize ensembleConfigs when its length is less than the amount of models provided to node (- 1 due to dataset, -1 due to last empty )
 	if (knobs.value.ensembleConfigs.length < props.node.inputs.length - 2) {

packages/client/hmi-client/src/components/workflow/ops/model-config/tera-model-config.vue

@@ -715,7 +715,7 @@ const createConfiguration = async (force: boolean = false) => {
 
 	const data = await createModelConfiguration(
 		model.value.id,
-		knobs.value?.transientModelConfig?.name,
+		knobs.value?.transientModelConfig?.name ?? '',
 		knobs.value?.transientModelConfig?.description ?? '',
 		knobs.value?.transientModelConfig?.configuration
 	);

packages/client/hmi-client/src/components/workflow/ops/simulate-ensemble-ciemss/tera-simulate-ensemble-ciemss.vue

@@ -351,7 +351,7 @@ onMounted(async () => {
 		amr.semantics?.ode.observables?.forEach((element) => tempList.push(element.id));
 		allModelOptions.value[allModelConfigurations[i].id as string] = tempList;
 	}
-	listModelLabels.value = allModelConfigurations.map((ele) => ele.name);
+	listModelLabels.value = allModelConfigurations.map((ele) => ele.name ?? '');
 
 	const state = _.cloneDeep(props.node.state);
 

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

@@ -232,7 +232,9 @@ function sortProjectByDates(projects: Project[], dateType: DateType, sorting: 'A
 function filterAndSortProjects(projects: Project[]) {
 	if (projects) {
 		if (selectedSort.value === 'Alphabetical') {
-			return projects.sort((a, b) => a.name.toLowerCase().localeCompare(b.name.toLowerCase()));
+			return projects.sort((a, b) =>
+				(a.name ?? '').toLowerCase().localeCompare((b.name ?? '').toLowerCase())
+			);
 		}
 		if (selectedSort.value === 'Last updated (descending)') {
 			return sortProjectByDates(projects, 'updatedOn', 'DESC');

packages/client/hmi-client/src/page/data-explorer/components/tera-asset-card.vue

@@ -228,7 +228,7 @@ const title = computed(() => {
 	} else if (props.resourceType === ResourceType.MODEL) {
 		value = (props.asset as Model).header.name;
 	} else if (props.resourceType === ResourceType.DATASET) {
-		value = (props.asset as Dataset).name;
+		value = (props.asset as Dataset).name ?? '';
 	}
 	return highlightSearchTerms(value);
 });

packages/client/hmi-client/src/page/data-explorer/components/tera-search-results-list.vue

@@ -168,7 +168,7 @@ const projectOptions = computed(() => [
 						// then, link and store in the project assets
 						if (datasetId) {
 							response = await useProjects().addAsset(AssetType.Dataset, datasetId, project.id);
-							assetName = selectedAsset.value.name;
+							assetName = selectedAsset.value.name ?? '';
 						}
 					} else if (isDocument(selectedAsset.value) && props.source === DocumentSource.XDD) {
 						const document = selectedAsset.value as Document;

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

@@ -25,6 +25,7 @@ export interface ClientLog {
 export interface TerariumAsset {
     id?: string;
     name?: string;
+    description?: string;
     createdOn?: Date;
     updatedOn?: Date;
     deletedOn?: Date;
@@ -69,9 +70,7 @@ export interface GithubRepo {
 }
 
 export interface Artifact extends TerariumAsset {
-    name: string;
     userId: string;
-    description?: string;
     fileNames: string[];
     metadata?: any;
     concepts?: OntologyConcept[];
@@ -122,8 +121,6 @@ export interface ResponseSuccess {
 }
 
 export interface Code extends TerariumAsset {
-    name: string;
-    description: string;
     files?: { [index: string]: CodeFile };
     repoUrl?: string;
     metadata?: { [index: string]: string };
@@ -141,7 +138,6 @@ export interface Dynamics {
 }
 
 export interface ActiveConcept extends TerariumAsset {
-    name: string;
     curie: string;
 }
 
@@ -158,10 +154,8 @@ export interface OntologyConcept {
 }
 
 export interface Dataset extends TerariumAsset {
-    name: string;
     userId?: string;
     esgfId?: string;
-    description?: string;
     dataSourceDate?: Date;
     fileNames?: string[];
     datasetUrl?: string;
@@ -195,7 +189,6 @@ export interface AddDocumentAssetFromXDDResponse {
 }
 
 export interface DocumentAsset extends TerariumAsset {
-    description?: string;
     userId?: string;
     fileNames?: string[];
     documentUrl?: string;
@@ -236,8 +229,6 @@ export interface Model extends TerariumAssetThatSupportsAdditionalProperties {
 }
 
 export interface ModelConfiguration extends TerariumAssetThatSupportsAdditionalProperties {
-    name: string;
-    description?: string;
     configuration: Model;
     model_id: string;
 }
@@ -407,8 +398,6 @@ export interface DecapodesTerm {
 }
 
 export interface NotebookSession extends TerariumAsset {
-    name: string;
-    description?: string;
     data: any;
 }
 
@@ -418,11 +407,9 @@ export interface PetriNetModel {
 }
 
 export interface Project extends TerariumAsset {
-    name: string;
     userId: string;
     userName?: string;
     authors?: string[];
-    description?: string;
     overviewContent?: any;
     projectAssets: ProjectAsset[];
     metadata?: { [index: string]: string };
@@ -504,7 +491,6 @@ export interface RegNetVertex {
 
 export interface Simulation extends TerariumAsset {
     executionPayload: any;
-    description?: string;
     resultFiles?: string[];
     type: SimulationType;
     status: ProgressState;

packages/server/src/main/java/software/uncharted/terarium/hmiserver/models/TerariumAsset.java

@@ -28,8 +28,15 @@ public abstract class TerariumAsset implements Serializable {
 	private UUID id = UUID.randomUUID();
 
 	@TSOptional
+	@Column(length = 512)
+	@Schema(defaultValue = "Default Name")
 	private String name;
 
+	@TSOptional
+	@Schema(defaultValue = "Default Description")
+	@Column(columnDefinition = "text")
+	private String description;
+
 	@TSOptional
 	@Schema(accessMode = Schema.AccessMode.READ_ONLY)
 	@Column(columnDefinition = "TIMESTAMP WITH TIME ZONE")
@@ -78,6 +85,7 @@ public TerariumAsset clone() {
 	protected TerariumAsset cloneSuperFields(final TerariumAsset asset) {
 		asset.id = UUID.randomUUID(); // ensure we create a new id
 		asset.name = name;
+		asset.description = description;
 		asset.createdOn = this.createdOn != null ? new Timestamp(this.createdOn.getTime()) : null;
 		asset.updatedOn = this.updatedOn != null ? new Timestamp(this.updatedOn.getTime()) : null;
 		asset.deletedOn = this.deletedOn != null ? new Timestamp(this.deletedOn.getTime()) : null;

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

@@ -29,13 +29,6 @@ public class Artifact extends TerariumAsset {
 	/* UserId of who created this asset */
 	private String userId;
 
-	/* The name of the artifact. */
-	private String name;
-
-	/* A description of the artifact. */
-	@TSOptional
-	private String description;
-
 	/* The name of the file(s) in this artifact */
 	@JsonAlias("file_names")
 	private List<String> fileNames;

packages/server/src/main/java/software/uncharted/terarium/hmiserver/models/dataservice/code/Code.java

@@ -21,12 +21,6 @@ public class Code extends TerariumAsset {
 	@Serial
 	private static final long serialVersionUID = 3041175096070970227L;
 	/* The name of the code. */
-	@Schema(defaultValue = "Default Name")
-	private String name;
-
-	/* The description of the code. */
-	@Schema(defaultValue = "Default Description")
-	private String description;
 
 	/* Files that contain dynamics */
 	@TSOptional

packages/server/src/main/java/software/uncharted/terarium/hmiserver/models/dataservice/concept/ActiveConcept.java

@@ -21,6 +21,4 @@ public class ActiveConcept extends TerariumAsset {
 
 	@Column(unique = true)
 	private String curie;
-
-	private String name;
 }

packages/server/src/main/java/software/uncharted/terarium/hmiserver/models/dataservice/dataset/Dataset.java

@@ -30,13 +30,6 @@ public class Dataset extends TerariumAsset {
 	@TSOptional
 	private String esgfId;
 
-	/** Name of the dataset */
-	private String name;
-
-	/** (Optional) textual description of the dataset */
-	@TSOptional
-	private String description;
-
 	/** (Optional) data source date */
 	@TSOptional
 	@JsonAlias("data_source_date")

packages/server/src/main/java/software/uncharted/terarium/hmiserver/models/dataservice/document/DocumentAsset.java

@@ -24,12 +24,6 @@ public class DocumentAsset extends TerariumAsset {
 	@Serial
 	private static final long serialVersionUID = -8425680186002783351L;
 
-	@TSOptional
-	private String name;
-
-	@TSOptional
-	private String description;
-
 	@TSOptional
 	private String userId;
 

packages/server/src/main/java/software/uncharted/terarium/hmiserver/models/dataservice/equation/Equation.java

@@ -24,10 +24,6 @@ public class Equation extends TerariumAsset {
 	@TSOptional
 	private String userId;
 
-	/** (Optional) Display/human name for the equation * */
-	@TSOptional
-	private String name;
-
 	/** The type of equation (mathml or latex) * */
 	@JsonAlias("equation_type")
 	private EquationType equationType;

packages/server/src/main/java/software/uncharted/terarium/hmiserver/models/dataservice/model/ModelConfiguration.java

@@ -19,8 +19,6 @@ public class ModelConfiguration extends TerariumAssetThatSupportsAdditionalPrope
 	@Serial
 	private static final long serialVersionUID = -4109896135386019667L;
 
-	private String name;
-
 	@TSOptional
 	private String description;
 

packages/server/src/main/java/software/uncharted/terarium/hmiserver/models/dataservice/notebooksession/NotebookSession.java

@@ -6,7 +6,6 @@
 import lombok.EqualsAndHashCode;
 import lombok.experimental.Accessors;
 import software.uncharted.terarium.hmiserver.annotations.TSModel;
-import software.uncharted.terarium.hmiserver.annotations.TSOptional;
 import software.uncharted.terarium.hmiserver.models.TerariumAsset;
 
 @EqualsAndHashCode(callSuper = true)
@@ -18,10 +17,5 @@ public class NotebookSession extends TerariumAsset {
 	@Serial
 	private static final long serialVersionUID = 9176019416379347233L;
 
-	private String name;
-
-	@TSOptional
-	private String description;
-
 	private JsonNode data;
 }

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

@@ -31,9 +31,6 @@ public class Project extends TerariumAsset {
 	@Serial
 	private static final long serialVersionUID = -241733670076432802L;
 
-	@Schema(defaultValue = "My New Project")
-	private String name;
-
 	private String userId;
 
 	@TSOptional
@@ -46,10 +43,6 @@ public class Project extends TerariumAsset {
 	@Schema(accessMode = Schema.AccessMode.READ_ONLY)
 	private List<String> authors;
 
-	@TSOptional
-	@Schema(defaultValue = "My Project Description")
-	private String description;
-
 	@TSOptional
 	@Schema(defaultValue = "My Project Overview")
 	@Lob

packages/server/src/main/java/software/uncharted/terarium/hmiserver/models/dataservice/simulation/Simulation.java

@@ -31,13 +31,9 @@ public class Simulation extends TerariumAsset {
 	@Column(columnDefinition = "text")
 	private JsonNode executionPayload;
 
-	@TSOptional
-	@Column(length = 1000)
-	private String description;
-
 	@JsonAlias("result_files")
 	@TSOptional
-	@Column(length = 1000)
+	@Column(length = 1024)
 	@Schema(accessMode = Schema.AccessMode.READ_ONLY)
 	@ElementCollection
 	private List<String> resultFiles;
@@ -73,6 +69,7 @@ public class Simulation extends TerariumAsset {
 
 	@JsonAlias("user_id")
 	@TSOptional
+	@Column(length = 255)
 	private String userId;
 
 	@JsonAlias("project_id")
@@ -85,8 +82,6 @@ public Simulation clone() {
 
 		cloneSuperFields(clone);
 
-		clone.setDescription(this.description);
-
 		clone.setResultFiles(new ArrayList<>(this.resultFiles));
 		clone.setType(SimulationType.valueOf(this.type.name()));
 		clone.setStatus(ProgressState.valueOf(this.status.name()));

packages/server/src/main/java/software/uncharted/terarium/hmiserver/models/dataservice/workflow/Workflow.java

@@ -25,8 +25,6 @@ public class Workflow extends TerariumAsset {
 	@Serial
 	private static final long serialVersionUID = -1565930053830366145L;
 
-	private String description;
-
 	private Transform transform;
 
 	@Convert(converter = ObjectConverter.class)
@@ -43,7 +41,6 @@ public Workflow clone() {
 
 		cloneSuperFields(clone);
 
-		clone.description = this.description;
 		if (this.transform != null) {
 			clone.transform = new Transform()
 					.setX(this.transform.getX())

packages/server/src/main/resources/db/migration/V4__Change_description_to_text.sql

@@ -0,0 +1,13 @@
+BEGIN;
+
+ALTER TABLE simulation ALTER COLUMN result_files TYPE VARCHAR(1024)[];
+
+ALTER TABLE simulation ALTER COLUMN name TYPE VARCHAR(512);
+ALTER TABLE workflow ALTER COLUMN name TYPE VARCHAR(512);
+ALTER TABLE project ALTER COLUMN name TYPE VARCHAR(512);
+
+ALTER TABLE simulation ALTER COLUMN description TYPE text;
+ALTER TABLE workflow ALTER COLUMN description TYPE text;
+ALTER TABLE project ALTER COLUMN description TYPE text;
+
+COMMIT;