Merge branch 'develop' into members-list-functionality

Author: cengique

Dockerfile

@@ -1,22 +1,27 @@
+# Builds and runs ASPNET project Analysim
 # Requires running database
 FROM mcr.microsoft.com/dotnet/sdk:6.0 AS build
 WORKDIR /source
-COPY src .
 
-# install NPM
-RUN apt-get update -yq && apt-get upgrade -yq && apt-get install -yq curl git nano
+# install Node.js and Python
+RUN apt-get update -yq && apt-get upgrade -yq && apt-get install -yq curl git nano python3 python3-venv python3-pip
 RUN curl -sL https://deb.nodesource.com/setup_20.x | bash - && apt-get install -yq nodejs build-essential
 RUN npm install -g npm
 
+# Install .Net EF Tools
+RUN dotnet tool install --global dotnet-ef --version 6.0
+ENV PATH="$PATH:/root/.dotnet/tools"
+
+# then copy sources so previous step is cached
+COPY src .
+
 # build project
 WORKDIR Analysim.Web
 RUN dotnet publish --configuration Release -o /app
 
 # run database migrations
 FROM build as database-update
 WORKDIR /source/Analysim.Web
-RUN dotnet tool install --global dotnet-ef --version 6.0
-ENV PATH="$PATH:/root/.dotnet/tools"
 CMD dotnet ef database update
 
 # run project in new container

README.md

@@ -18,6 +18,7 @@ git clone https://github.com/soft-eng-practicum/AnalySim.git
 - [Visual Studio](https://visualstudio.microsoft.com/downloads/) or [ASP.Net 6.0 command-line interface (CLI)](https://dotnet.microsoft.com/en-us/download) (Required)
 - [Visual Studio Code](https://code.visualstudio.com/download) or other editor
 - [Postman](https://www.postman.com/downloads/) for testing API calls
+- [Python](https://www.python.org/downloads/) for building project
 - [Docker](https://www.docker.com/products/docker-desktop) for testing deployment
 - [Azure Data Studio](https://docs.microsoft.com/en-us/sql/azure-data-studio/download-azure-data-studio?view=sql-server-ver15) or use online [Azure Portal](https://portal.azure.com) for browsing Azure Blob Storage 
 
@@ -32,6 +33,13 @@ command.
 npm install
 ```
 
+Then navigate to `AnalySim\src\Analysim.Web\ClientApp\src\assets\jupyter` folder and run the following commands.
+
+```sh
+python -m pip install -r requirements.txt
+jupyter-lite build --output-dir dist
+```
+
 ### Connecting to databases and other services
 
 Analysim requires two databases to operate: one SQL database (PostgreSQL) for relational data and one Azure BlobStorage database for keeping uploaded user files. In addition, an Outlook account is needed for the email functionality. All of these services are accessed via authentication information stored in the `appsettings.json` and `appsettings.Development.json` files under the `src/Analysim.Web` folder. The structure of the files are as follows (`XXX` means redacted):
@@ -138,7 +146,7 @@ You can run Analysim and the PostGreSQL in containers using Docker Compose. You
     ```
 1. Create the Docker image by running the following in the base project folder (e.g. `Analysim/`) :
     ```bash
-    docker build -t analysim-dev -f deploy/Dockerfile .
+    docker build -t analysim-dev -f Dockerfile-run .
     ```
 1. Test image locally, by running it:
    ```bash

docker-compose-db.yml

@@ -1,5 +1,3 @@
-version: '3.1'
-
 services:
 
   db-update:

docker-compose.yml

@@ -1,6 +1,4 @@
 # Use postgres/example user/password credentials
-version: '3.1'
-
 services:
 
   db:

src/Analysim.Core/Services/BlobService.cs

@@ -68,7 +68,7 @@ public async Task<BlobDownloadInfo> GetNotebookAsync(Notebook notebook)
             var containerClient = _blobServiceClient.GetBlobContainerClient(notebook.Container.ToLower());
 
             // Get File Reference
-            var blobClient = containerClient.GetBlobClient(notebook.Directory+notebook.Name + notebook.Extension);
+            var blobClient = containerClient.GetBlobClient(notebook.Directory + notebook.Name + notebook.Extension);
 
             // Download File
             BlobDownloadInfo blobDownloadInfo = await blobClient.DownloadAsync();
@@ -167,7 +167,7 @@ public async Task<BlobClient> CreateFolder(string container, string filePath)
         public async Task<BlobClient> CreateNotebookFolder(string container, string filePath)
         {
             // Get Storage Container
-            var containerClient = _blobServiceClient.GetBlobContainerClient("notebook-"+container.ToLower());
+            var containerClient = _blobServiceClient.GetBlobContainerClient("notebook-" + container.ToLower());
 
             bool isExist = containerClient.Exists();
             if (!isExist)
@@ -288,7 +288,7 @@ public async Task<BlobClient> DeleteNotebookAsync(Notebook notebook)
             // Get Storage Container
             var containerClient = _blobServiceClient.GetBlobContainerClient(notebook.Container.ToLower());
 
-            if(notebook.type== "new" || notebook.type== "collab" || notebook.type=="folder")
+            if (notebook.type == "new" || notebook.type == "colab" || notebook.type == "folder")
             {
                 var blobClient = containerClient.GetBlobClient(notebook.Directory + notebook.Name + notebook.Extension);
                 await blobClient.DeleteIfExistsAsync();

src/Analysim.Infrastructure/Data/ApplicationDbContext.cs

@@ -99,6 +99,7 @@ protected override void OnModelCreating(ModelBuilder modelBuilder)
         public DbSet<UserUser> UserUsers { get; set; }
 
         public DbSet<Notebook> Notebook {get;set;}
+        public DbSet<ObservableNotebookDataset> ObservableNotebookDataset { get;set;}
 
 
 

src/Analysim.Web/Analysim.Web.csproj

@@ -62,12 +62,41 @@
     </Exec>
     <Error Condition="'$(ErrorCode)' != '0'" Text="Node.js is required to build and run this project. To continue, please install Node.js from https://nodejs.org/, and then restart your command prompt or IDE." />
     <Message Importance="high" Text="Restoring dependencies using 'npm'. This may take several minutes..." />
-    <Exec WorkingDirectory="$(SpaRoot)" Command="npm install" />
+    <Exec WorkingDirectory="$(SpaRoot)" Command="npm --legacy-peer-deps install" />
+  </Target>
+
+  <Target Name="BuildJupyterLite" BeforeTargets="Build" Condition=" !Exists('$(SpaRoot)src\assets\jupyter\dist') ">
+    <Message Importance="high" Text="Installing dependencies and building JupyterLite on '$(OS)'" />
+
+    <!-- Commands for Linux -->
+    <Exec WorkingDirectory="$(SpaRoot)src\assets\jupyter" Command="python3 -m venv .env" Condition="'$(OS)' == 'Unix'" />
+    <Exec WorkingDirectory="$(SpaRoot)src\assets\jupyter" Command=".env/bin/python3 -m pip install -r requirements.txt" Condition="'$(OS)' == 'Unix'" />
+    <Exec WorkingDirectory="$(SpaRoot)src\assets\jupyter" Command=".env/bin/jupyter lite build --output-dir dist" Condition="'$(OS)' == 'Unix'" />
+
+    <!-- Commands for Windows -->
+    <Exec WorkingDirectory="$(SpaRoot)src\assets\jupyter" Command="python -m pip install -r requirements.txt" Condition="'$(OS)' == 'Windows_NT'" />
+    <Exec WorkingDirectory="$(SpaRoot)src\assets\jupyter" Command="jupyter-lite build --output-dir dist" Condition="'$(OS)' == 'Windows_NT'" />
+    <ItemGroup>
+        <JupyterIndex Include="$(SpaRoot)src\assets\jupyter\index.html"/>
+    </ItemGroup>
+    <Copy SourceFiles="@(JupyterIndex)" DestinationFolder="$(SpaRoot)src\assets\jupyter\dist\lab\" />
   </Target>
 
   <Target Name="PublishRunWebpack" AfterTargets="ComputeFilesToPublish">
     <!-- As part of publishing, ensure the JS resources are freshly built in production mode -->
-    <Exec WorkingDirectory="$(SpaRoot)" Command="npm install" />
+    <Exec WorkingDirectory="$(SpaRoot)" Command="npm --legacy-peer-deps install" />
+    <!-- Commands for Linux -->
+    <Exec WorkingDirectory="$(SpaRoot)src\assets\jupyter" Command="python3 -m venv .env" Condition="'$(OS)' == 'Unix'" />
+    <Exec WorkingDirectory="$(SpaRoot)src\assets\jupyter" Command=".env/bin/python3 -m pip install -r requirements.txt" Condition="'$(OS)' == 'Unix'" />
+    <Exec WorkingDirectory="$(SpaRoot)src\assets\jupyter" Command=".env/bin/jupyter lite build --output-dir dist" Condition="'$(OS)' == 'Unix'" />
+
+    <!-- Commands for Windows -->
+    <Exec WorkingDirectory="$(SpaRoot)src\assets\jupyter" Command="python -m pip install -r requirements.txt" Condition="'$(OS)' == 'Windows_NT'" />
+    <Exec WorkingDirectory="$(SpaRoot)src\assets\jupyter" Command="jupyter-lite build --output-dir dist" Condition="'$(OS)' == 'Windows_NT'" />
+    <ItemGroup>
+        <JupyterIndex Include="$(SpaRoot)src\assets\jupyter\index.html"/>
+    </ItemGroup>
+    <Copy SourceFiles="@(JupyterIndex)" DestinationFolder="$(SpaRoot)src\assets\jupyter\dist\lab\" />    
     <Exec WorkingDirectory="$(SpaRoot)" Command="npm run build -- --configuration production" />
     <Exec WorkingDirectory="$(SpaRoot)" Command="npm run build:ssr -- --configuration production" Condition=" '$(BuildServerSideRenderer)' == 'true' " />