Merge pull request #149 from QCDIS/148-list-started-instances-on-vlab…

…-page

148 list started instances on vlab page

vre-panel/components/VLabDescription.tsx

@@ -1,52 +1,11 @@
-import React, {useEffect, useState} from "react";
-import getConfig from "next/config";
-import {JWT} from "next-auth/jwt";
+import {VLab} from "../types/vlab";
 
 type Props = {
-  slug: string | string[] | undefined,
-  isAuthenticated: boolean,
-  token: JWT,
+  vlab: VLab,
+  backendError: boolean,
 }
 
-const VLabDescription: React.FC<Props> = ({slug, isAuthenticated, token}) => {
-
-  const {publicRuntimeConfig} = getConfig()
-
-  const vlabPlaceholder = {
-    title: "Loading ..",
-    slug: "",
-    description: "Loading ..",
-    endpoint: ""
-  }
-
-  const [vlab, setVlab] = useState(vlabPlaceholder)
-  const [backendError, setBackendError] = useState(false)
-
-  const fetchVlab = async () => {
-
-    var requestOptions: RequestInit = {
-      method: "GET",
-      headers: {
-        "Authorization": "Bearer: " + token.accessToken
-      },
-    };
-
-    const apiUrl = `${window.location.origin}/${publicRuntimeConfig.apiBasePath}`
-    const res = await fetch(`${apiUrl}/vlabs/${slug}`, requestOptions);
-    try {
-      const dat = await res.json()
-      setVlab(dat)
-    } catch (e) {
-      console.log(e)
-      setBackendError(true)
-    }
-  }
-
-  useEffect(() => {
-    if (isAuthenticated) {
-      Promise.all([fetchVlab()])
-    }
-  }, [isAuthenticated]);
+const VLabDescription: React.FC<Props> = ({vlab, backendError}) => {
 
   return (
     <div>
@@ -57,11 +16,6 @@ const VLabDescription: React.FC<Props> = ({slug, isAuthenticated, token}) => {
       ) : (
         <>
           <p className="text-4xl font-sans">{vlab.title}</p>
-          <a target="blank" href={vlab.endpoint}>
-            <button className="bg-primary hover:bg-primaryDark text-onPrimary font-bold py-2 px-4 rounded mt-5">
-              Launch
-            </button>
-          </a>
           <p className="mt-5 text-justify">{vlab.description}</p>
         </>
       )}

vre-panel/components/VLabInstances.tsx

@@ -0,0 +1,140 @@
+import React, {useEffect, useState} from "react";
+import getConfig from "next/config";
+import {JWT} from "next-auth/jwt";
+import {VLab} from "../types/vlab";
+import {useSession} from "next-auth/react";
+
+type Props = {
+  vlab: VLab,
+  slug: string | string[] | undefined,
+  isAuthenticated: boolean,
+  token: JWT,
+}
+
+interface VLabInstance {
+  vlab: string,
+  username: string,
+}
+
+const VLabInstances: React.FC<Props> = ({vlab, slug, isAuthenticated, token}) => {
+
+  const {publicRuntimeConfig} = getConfig()
+
+  const session = useSession()
+
+  const [vlabInstances, setVlabInstances] = useState<Array<VLabInstance>>([])
+  const [backendError, setBackendError] = useState(false)
+  const [hideInstance, setHideInstance] = useState(false)
+
+  const registerInstance = async () => {
+    if (
+      hideInstance
+      || (session.status != "authenticated")
+    ) {
+      return
+    }
+
+    const username = session.data.user.name
+
+    const requestOptions: RequestInit = {
+      method: "POST",
+      headers: {
+        "Authorization": "Bearer: " + token.accessToken,
+        "Content-Type": "application/json",
+      },
+      body: JSON.stringify({
+        "vlab": slug,
+        "username": username,
+      }),
+    }
+
+    const apiUrl = `${window.location.origin}/${publicRuntimeConfig.apiBasePath}`
+    return fetch(`${apiUrl}/vlab_instances/`, requestOptions);
+  }
+
+  const fetchVlabInstances = async () => {
+
+    var requestOptions: RequestInit = {
+      method: "GET",
+      headers: {
+        "Authorization": "Bearer: " + token.accessToken
+      },
+    };
+
+    const apiUrl = `${window.location.origin}/${publicRuntimeConfig.apiBasePath}`
+    const res = await fetch(`${apiUrl}/vlab_instances/?vlab_slug=${slug}`, requestOptions);
+    try {
+      const dat = await res.json()
+      setVlabInstances(dat)
+    } catch (e) {
+      console.log(e)
+      setBackendError(true)
+    }
+  }
+
+  useEffect(() => {
+    if (isAuthenticated) {
+      Promise.all([fetchVlabInstances()])
+    }
+  }, [isAuthenticated]);
+
+  return (
+    <div className="space-y-4">
+      <p className="text-2xl font-sans">Instances</p>
+      {backendError || (
+        <>
+          <p>
+            {vlabInstances.length} instance{vlabInstances.length != 1 && "s"}
+          </p>
+          <ul
+            className="flex flex-wrap"
+          >
+            {vlabInstances.map((vlab_instance) => {
+              return (
+                <li
+                  key={vlab_instance.username}
+                  className="rounded-full m-1 px-2 bg-quinary text-onTertiary"
+                >
+                  {vlab_instance.username}
+                </li>
+              )
+            })}
+          </ul>
+          <div className="space-y-4 pt-4">
+            <div className="space-x-2">
+              <input
+                type="checkbox"
+                name="hideInstance"
+                checked={hideInstance}
+                onChange={
+                  (e) => {
+                    setHideInstance(e.target.checked)
+                  }
+                }
+              />
+              <label className="text-sm">
+                Hide my instance from this list
+              </label>
+            </div>
+            <div>
+              <a
+                target="blank"
+                href={vlab.endpoint}
+                onClick={registerInstance}
+              >
+                <button
+                  className="bg-primary hover:bg-primaryDark text-onPrimary font-bold py-2 px-4 rounded"
+                >
+                  Launch my instance
+                </button>
+              </a>
+            </div>
+          </div>
+
+        </>
+      )}
+    </div>
+  )
+}
+
+export default VLabInstances

vre-panel/pages/vlabs/[slug].tsx

@@ -1,10 +1,13 @@
 import {getToken} from "next-auth/jwt";
 import {useRouter} from "next/router";
 import VLabDescription from "../../components/VLabDescription";
-import React from "react";
+import React, {useEffect, useState} from "react";
 import VLAbAssets from "../../components/VLAbAssets";
 import PageLayout from "../../components/PageLayout";
 import useAuth from "../auth/useAuth";
+import VLabInstances from "../../components/VLabInstances";
+import getConfig from "next/config";
+import {VLab} from "../../types/vlab";
 
 
 interface VLabDetailsProps {
@@ -13,20 +16,63 @@ interface VLabDetailsProps {
 
 const VLabDetails: React.FC<VLabDetailsProps> = ({token}) => {
 
+  const {publicRuntimeConfig} = getConfig()
+
+  const vlabPlaceholder: VLab = {
+    title: "Loading ..",
+    slug: "",
+    description: "Loading ..",
+    endpoint: ""
+  }
+
   const isAuthenticated = useAuth(true);
   const router = useRouter();
   const {slug} = router.query;
 
+  const [vlab, setVlab] = useState(vlabPlaceholder)
+  const [backendError, setBackendError] = useState(false)
+
+  const fetchVlab = async () => {
+
+    var requestOptions: RequestInit = {
+      method: "GET",
+      headers: {
+        "Authorization": "Bearer: " + token.accessToken
+      },
+    };
+
+    const apiUrl = `${window.location.origin}/${publicRuntimeConfig.apiBasePath}`
+    const res = await fetch(`${apiUrl}/vlabs/${slug}`, requestOptions);
+    try {
+      const dat = await res.json()
+      setVlab(dat)
+    } catch (e) {
+      console.log(e)
+      setBackendError(true)
+    }
+  }
+
+  useEffect(() => {
+    if (isAuthenticated) {
+      Promise.all([fetchVlab()])
+    }
+  }, [isAuthenticated]);
+
+
   return (
     <PageLayout>
 
-        <div className="rounded shadow-lg bg-white p-8">
-          <VLabDescription slug={slug} isAuthenticated={isAuthenticated} token={token}/>
-        </div>
+      <div className="rounded shadow-lg bg-white p-8">
+        <VLabDescription vlab={vlab} backendError={backendError}/>
+      </div>
+
+      <div className="rounded shadow-lg bg-white p-8">
+        <VLabInstances vlab={vlab} slug={slug} isAuthenticated={isAuthenticated} token={token}/>
+      </div>
 
-        <div className="rounded shadow-lg bg-white p-8">
-          <VLAbAssets slug={slug} isAuthenticated={isAuthenticated} token={token}/>
-        </div>
+      <div className="rounded shadow-lg bg-white p-8">
+        <VLAbAssets slug={slug} isAuthenticated={isAuthenticated} token={token}/>
+      </div>
 
     </PageLayout>
   )

vre-panel/tailwind.config.js

@@ -14,6 +14,12 @@ module.exports = {
         onSecondary: '#ffffff',
         secondaryContainer: '#FFBD85',
         onSecondaryContainer: '#000000',
+        tertiary: '#009138',
+        onTertiary: '#ffffff',
+        quaternary: '#F4992B',
+        onQuaternary: '#000000',
+        quinary: '#009399',
+        onQuinary: '#ffffff',
         surface: '#ffffff',
         onSurface: '#333333',
         surfaceContainer: '#f2f2f2',

vre-panel/types/vlab.d.ts

@@ -0,0 +1,7 @@
+
+export interface VLab {
+  title: string,
+  slug: string,
+  description: string,
+  endpoint: string,
+}

vreapis/virtual_labs/admin.py

@@ -1,4 +1,5 @@
 from django.contrib import admin
-from virtual_labs.models import VirtualLab
+from virtual_labs.models import VirtualLab, VirtualLabInstance
 
 admin.site.register(VirtualLab)
+admin.site.register(VirtualLabInstance)

vreapis/virtual_labs/models.py

@@ -114,3 +114,8 @@ def __str__(self):
 
     class Meta:
         verbose_name = "KeyCloak Auth"
+
+
+class VirtualLabInstance(models.Model):
+    vlab = models.ForeignKey(VirtualLab, on_delete=models.CASCADE, null=True)
+    username = models.CharField(max_length=100, null=True)

vreapis/virtual_labs/serializers.py

@@ -1,8 +1,10 @@
 from dataclasses import fields
 from pyexpat import model
 from rest_framework import serializers
+from rest_framework.validators import UniqueTogetherValidator
 from django.contrib.auth.models import User
-from virtual_labs.models import VM, SDIAProvision, Topology, VLProfile, VirtualLab
+from virtual_labs.models import (VM, SDIAProvision, Topology, VLProfile,
+                                 VirtualLab, VirtualLabInstance)
 from workflows.models import Workflow
 from workflows.serializers import WorkflowSerializer
 
@@ -97,3 +99,25 @@ class Meta:
             'description',
             'endpoint'
         )
+
+
+class VirtualLabInstanceSerializer(serializers.ModelSerializer):
+
+    vlab = serializers.SlugRelatedField(
+        slug_field='slug',
+        queryset=VirtualLab.objects.all()
+        )
+
+    class Meta:
+        model = VirtualLabInstance
+        fields = (
+            'vlab',
+            'username',
+            )
+
+        validators = [
+            UniqueTogetherValidator(
+                queryset=VirtualLabInstance.objects.all(),
+                fields=['vlab', 'username'],
+                )
+            ]

vreapis/virtual_labs/views.py

@@ -1,5 +1,5 @@
 from sys import stdout
-from rest_framework import viewsets
+from rest_framework import mixins, viewsets
 from rest_framework.decorators import action
 from . import serializers
 from . import models
@@ -19,3 +19,20 @@ class VirtualLabViewSet(GetSerializerMixin, viewsets.ModelViewSet):
     }
 
 
+class VirtualLabInstanceViewSet(
+        GetSerializerMixin,
+        mixins.ListModelMixin,
+        mixins.CreateModelMixin,
+        viewsets.GenericViewSet,
+        ):
+
+    model = models.VirtualLabInstance
+    queryset = model.objects.all()
+    serializer_class = serializers.VirtualLabInstanceSerializer
+
+    def get_queryset(self):
+        vlab_slug = self.request.query_params.get('vlab_slug', None)
+        if vlab_slug:
+            return self.model.objects.filter(vlab__slug=vlab_slug)
+        else:
+            return self.model.objects.all()