Add domain for HTTP-based lesson guides like jupyter notebooks in the livelesson response

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## In development
 
+- Add domain for HTTP-based lesson guides like jupyter notebooks in the livelesson response [#177](https://github.com/nre-learning/antidote-core/pull/177)
 
 ## v0.6.1 - May 03, 2020
 

api/exp/definitions/livelesson.proto

@@ -76,16 +76,17 @@ message LiveLesson {
   int32 CurrentStage = 6;
   string GuideContents = 7;
   string GuideType = 8;
+  string GuideDomain = 9;
 
-  string Status = 9;
+  string Status = 10;
 
-  bool Error = 10;
-  int32 HealthyTests = 11;
-  int32 TotalTests = 12;
+  bool Error = 11;
+  int32 HealthyTests = 12;
+  int32 TotalTests = 13;
 
-  string Diagram = 13;
-  string Video = 14;
-  string StageVideo = 15;
+  string Diagram = 14;
+  string Video = 15;
+  string StageVideo = 16;
 }
 
 message LiveLessons {

api/exp/definitions/livelesson.swagger.json

@@ -175,6 +175,9 @@
         "GuideType": {
           "type": "string"
         },
+        "GuideDomain": {
+          "type": "string"
+        },
         "Status": {
           "type": "string"
         },

api/exp/livelessons.go

@@ -208,11 +208,16 @@ func (s *AntidoteAPI) RequestLiveLesson(ctx context.Context, lp *pb.LiveLessonRe
 	}
 
 	newLL := &models.LiveLesson{
-		ID:            newID,
-		SessionID:     lp.SessionId,
-		AntidoteID:    s.Config.InstanceID,
-		LessonSlug:    lp.LessonSlug,
-		GuideType:     string(lesson.Stages[lp.LessonStage].GuideType),
+		ID:         newID,
+		SessionID:  lp.SessionId,
+		AntidoteID: s.Config.InstanceID,
+		LessonSlug: lp.LessonSlug,
+		GuideType:  string(lesson.Stages[lp.LessonStage].GuideType),
+
+		// The front-end will only use this if GuideType is jupyter, but since it will not change, it makes
+		// sense to just set it here.
+		// TODO(mierdin): This needs to be coordinated with the creation of the jupyter ingress in requests.go
+		GuideDomain:   fmt.Sprintf("%s-jupyterlabguide-web.%s", nsName, s.Config.HEPSDomain),
 		LiveEndpoints: liveEndpoints,
 		CurrentStage:  lp.LessonStage,
 		Status:        models.Status_INITIALIZED,

api/exp/swagger/swagger.pb.go

@@ -921,6 +921,9 @@ Livelesson = `{
         "GuideType": {
           "type": "string"
         },
+        "GuideDomain": {
+          "type": "string"
+        },
         "Status": {
           "type": "string"
         },

db/models/livelesson.go

@@ -14,6 +14,7 @@ type LiveLesson struct {
 	CurrentStage  int32                    `json:"LessonStage"`
 	GuideContents string                   `json:"GuideContents"`
 	GuideType     string                   `json:"GuideType"`
+	GuideDomain   string                   `json:"GuideDomain"`
 	Status        LiveLessonStatus         `json:"Status"`
 	CreatedTime   time.Time                `json:"CreatedTime"`
 	Error         bool                     `json:"Error"`

scheduler/requests.go

@@ -187,13 +187,16 @@ func (s *AntidoteScheduler) createK8sStuff(sc ot.SpanContext, req services.Lesso
 		}
 		ll.LiveEndpoints[jupyterEp.Name] = jupyterEp
 
+		nsName := generateNamespaceName(s.Config.InstanceID, req.LiveLessonID)
+
 		_, err := s.createIngress(
 			span.Context(),
 			ns.ObjectMeta.Name,
 			jupyterEp,
 			&models.LivePresentation{
-				Name: "web",
-				Port: 8888,
+				Name:      "web",
+				Port:      8888,
+				HepDomain: fmt.Sprintf("%s-jupyterlabguide-web.%s", nsName, s.Config.HEPSDomain),
 			},
 		)
 		if err != nil {