Make some workspace metadata properties optional

Author: Furisto

components/ws-manager-api/core.proto

@@ -467,11 +467,11 @@ message WorkspaceMetadata {
     // This is primarily intended for annotating headless workspace loads.
     map<string, string> annotations = 4;
 
-    // team the workspace belongs to
-    string team = 5;
+    // team the workspace belongs to, if the workspace is not associated with a team, this property will be empty
+    optional string team = 5;
 
-    // project the workspace belongs to
-    string project = 6;
+    // project the workspace belongs to, if the workspace is not associated with a project, this property will be empty
+    optional string project = 6;
 }
 
 // WorkspaceRuntimeInfo details the workspace's runtime, e.g. executing system, node other information

components/ws-manager-api/go/core.pb.go

@@ -838,9 +838,15 @@ export class WorkspaceMetadata extends jspb.Message {
 
     getAnnotationsMap(): jspb.Map<string, string>;
     clearAnnotationsMap(): void;
-    getTeam(): string;
+
+    hasTeam(): boolean;
+    clearTeam(): void;
+    getTeam(): string | undefined;
     setTeam(value: string): WorkspaceMetadata;
-    getProject(): string;
+
+    hasProject(): boolean;
+    clearProject(): void;
+    getProject(): string | undefined;
     setProject(value: string): WorkspaceMetadata;
 
     serializeBinary(): Uint8Array;
@@ -860,8 +866,8 @@ export namespace WorkspaceMetadata {
         startedAt?: google_protobuf_timestamp_pb.Timestamp.AsObject,
 
         annotationsMap: Array<[string, string]>,
-        team: string,
-        project: string,
+        team?: string,
+        project?: string,
     }
 }
 

components/ws-manager-api/go/core_grpc.pb.go

@@ -6833,15 +6833,15 @@ proto.wsman.WorkspaceMetadata.serializeBinaryToWriter = function(message, writer
   if (f && f.getLength() > 0) {
     f.serializeBinary(4, writer, jspb.BinaryWriter.prototype.writeString, jspb.BinaryWriter.prototype.writeString);
   }
-  f = message.getTeam();
-  if (f.length > 0) {
+  f = /** @type {string} */ (jspb.Message.getField(message, 5));
+  if (f != null) {
     writer.writeString(
       5,
       f
     );
   }
-  f = message.getProject();
-  if (f.length > 0) {
+  f = /** @type {string} */ (jspb.Message.getField(message, 6));
+  if (f != null) {
     writer.writeString(
       6,
       f
@@ -6959,7 +6959,25 @@ proto.wsman.WorkspaceMetadata.prototype.getTeam = function() {
  * @return {!proto.wsman.WorkspaceMetadata} returns this
  */
 proto.wsman.WorkspaceMetadata.prototype.setTeam = function(value) {
-  return jspb.Message.setProto3StringField(this, 5, value);
+  return jspb.Message.setField(this, 5, value);
+};
+
+
+/**
+ * Clears the field making it undefined.
+ * @return {!proto.wsman.WorkspaceMetadata} returns this
+ */
+proto.wsman.WorkspaceMetadata.prototype.clearTeam = function() {
+  return jspb.Message.setField(this, 5, undefined);
+};
+
+
+/**
+ * Returns whether this field is set.
+ * @return {boolean}
+ */
+proto.wsman.WorkspaceMetadata.prototype.hasTeam = function() {
+  return jspb.Message.getField(this, 5) != null;
 };
 
 
@@ -6977,7 +6995,25 @@ proto.wsman.WorkspaceMetadata.prototype.getProject = function() {
  * @return {!proto.wsman.WorkspaceMetadata} returns this
  */
 proto.wsman.WorkspaceMetadata.prototype.setProject = function(value) {
-  return jspb.Message.setProto3StringField(this, 6, value);
+  return jspb.Message.setField(this, 6, value);
+};
+
+
+/**
+ * Clears the field making it undefined.
+ * @return {!proto.wsman.WorkspaceMetadata} returns this
+ */
+proto.wsman.WorkspaceMetadata.prototype.clearProject = function() {
+  return jspb.Message.setField(this, 6, undefined);
+};
+
+
+/**
+ * Returns whether this field is set.
+ * @return {boolean}
+ */
+proto.wsman.WorkspaceMetadata.prototype.hasProject = function() {
+  return jspb.Message.getField(this, 6) != null;
 };
 
 

components/ws-manager-api/typescript/src/core_pb.d.ts

@@ -898,8 +898,8 @@ func (m *Manager) newStartWorkspaceContext(ctx context.Context, req *api.StartWo
 		wsk8s.WorkspaceIDLabel: req.Id,
 		wsk8s.OwnerLabel:       req.Metadata.Owner,
 		wsk8s.MetaIDLabel:      req.Metadata.MetaId,
-		wsk8s.ProjectLabel:     req.Metadata.Project,
-		wsk8s.TeamLabel:        req.Metadata.Team,
+		wsk8s.ProjectLabel:     req.Metadata.GetProject(),
+		wsk8s.TeamLabel:        req.Metadata.GetTeam(),
 		wsk8s.TypeLabel:        workspaceType,
 		headlessLabel:          fmt.Sprintf("%v", headless),
 		markerLabel:            "true",

components/ws-manager-api/typescript/src/core_pb.js

@@ -21,6 +21,11 @@ import (
 	config "github.com/gitpod-io/gitpod/ws-manager/api/config"
 )
 
+var (
+	team    = "awesome"
+	project = "gitpod"
+)
+
 func TestCreateDefiniteWorkspacePod(t *testing.T) {
 	type WorkspaceClass struct {
 		DefaultTemplate    *corev1.Pod                   `json:"defaultTemplate,omitempty"`
@@ -135,9 +140,10 @@ func TestCreateDefiniteWorkspacePod(t *testing.T) {
 						Metadata: &api.WorkspaceMetadata{
 							Owner:   "tester",
 							MetaId:  "foobar",
-							Team:    "awesome",
-							Project: "gitpod",
+							Team:    &team,
+							Project: &project,
 						},
+
 						ServicePrefix: "foobarservice",
 						Spec:          &spec,
 					}

components/ws-manager/pkg/manager/create.go

@@ -151,7 +151,7 @@ func (m *Manager) Close() {
 
 // StartWorkspace creates a new running workspace within the manager's cluster
 func (m *Manager) StartWorkspace(ctx context.Context, req *api.StartWorkspaceRequest) (res *api.StartWorkspaceResponse, err error) {
-	owi := log.LogContext(req.Metadata.Owner, req.Metadata.MetaId, req.Id, req.Metadata.Project, req.Metadata.Team)
+	owi := log.LogContext(req.Metadata.Owner, req.Metadata.MetaId, req.Id, req.Metadata.GetProject(), req.Metadata.GetTeam())
 	clog := log.WithFields(owi)
 	span, ctx := tracing.FromContext(ctx, "StartWorkspace")
 	tracing.LogRequestSafe(span, req)