Merge pull request #307 from ulitol97/master

Preparing for streams

Author: ulitol97

.github/workflows/publish_gh_pages.yml

@@ -25,6 +25,6 @@ jobs:
         uses: ts-graphviz/setup-graphviz@v1
 
       - name: Build and publish docusaurus site, generating the scaladoc
-        run: sbt '++2.13.6 docs/docusaurusPublishGhpages'
+        run: sbt '++2.13.8 docs/docusaurusPublishGhpages'
         env:
           GIT_DEPLOY_KEY: ${{ secrets.RDFSHAPE_API_DEPLOY_KEY }}

build.sbt

@@ -8,10 +8,6 @@ Global / cancelable := true
 Global / apiURL := Some(url("https://github.com/weso/rdfshape-api"))
 Global / scalaVersion := scala213
 
-lazy val scala212               = "2.12.15"
-lazy val scala213               = "2.13.8"
-lazy val supportedScalaVersions = List(scala213)
-
 // Lint-excluded keys
 Global / excludeLintKeys ++= Set(
   name,
@@ -85,7 +81,8 @@ lazy val scaladocSettings: Seq[Def.Setting[_]] = Seq(
     // Other settings
     "-diagrams",
     "-implicits",
-    "-private"
+    "-private",
+    "-no-link-warnings"
   ),
   // Need to generate docs to publish to oss
   Compile / packageDoc / publishArtifact := true
@@ -116,39 +113,16 @@ lazy val mdocSettings = Seq(
       .dependsOn(Compile / unidoc)
       .value
 )
-// Unidoc settings, mirroring scaladoc settings
+// Unidoc settings
 lazy val unidocSettings: Seq[Def.Setting[_]] = Seq(
   // Generate docs for the root project and the server module
   ScalaUnidoc / unidoc / unidocProjectFilter := inProjects(rdfshape, server),
   // Dump docs into the website static part, to link them with docusaurus
   ScalaUnidoc / unidoc / target := (LocalRootProject / baseDirectory).value / "website" / "static" / "api",
   // When cleaning, remove unidoc generated docs as well
   cleanFiles += (ScalaUnidoc / unidoc / target).value,
-  // Scalac options
-  ScalaUnidoc / unidoc / scalacOptions ++= Seq(
-    // Base source path
-    "-sourcepath",
-    (LocalRootProject / baseDirectory).value.getAbsolutePath,
-    // Link to GitHub source
-    "-doc-source-url",
-    scmInfo.value.get.browseUrl + "/tree/master€{FILE_PATH}.scala",
-    // Page title
-    "-doc-title",
-    "RDFShape API - Docs",
-    // Docs version
-    "-doc-version",
-    version.value,
-    // Docs footer
-    "-doc-footer",
-    "WESO Research Group - University of Oviedo",
-    // Skip unnecessary source
-    "-skip-packages",
-    "org:buildinfo",
-    // Other settings
-    "-diagrams",
-    "-implicits",
-    "-private"
-  )
+  // Scalac options, mirroring scaladoc settings
+  ScalaUnidoc / unidoc / scalacOptions ++= (Compile / doc / scalacOptions).value
 )
 // Shared publish settings for all modules.
 lazy val publishSettings = Seq(
@@ -189,8 +163,9 @@ lazy val publishSettings = Seq(
 // Helper to resolve dependencies from GitHub packages
 lazy val resolverSettings = Seq(
   resolvers ++= Seq(
-    Resolver.DefaultMavenRepository,
-    Resolver.sonatypeRepo("snapshots")
+    Resolver.DefaultMavenRepository, // maven
+    Opts.resolver.sonatypeSnapshots, // sonatype
+    Opts.resolver.sonatypeReleases
   )
 )
 // Shared settings for the BuildInfo Plugin
@@ -261,14 +236,14 @@ lazy val server = project
     moduleName := s"${(Global / packageName).value}-server",
     run / fork := false,
     testFrameworks += MUnitFramework,
-    crossScalaVersions := supportedScalaVersions,
     libraryDependencies ++= Seq(
       http4sDsl,
       http4sBlazeServer,
       http4sBlazeClient,
       http4sEmberClient,
       http4sCirce,
       rho_swagger,
+      comet,
       umlShaclex,
       shexs,
       shaclex,
@@ -287,10 +262,12 @@ lazy val server = project
   )
 
 // "sbt-github-actions" plugin settings
-lazy val JavaCIVersion  = "adopt@1.11"
-lazy val ScalaCIVersion = scala213
-ThisBuild / githubWorkflowJavaVersions := Seq(JavaCIVersion)
-ThisBuild / githubWorkflowScalaVersions := Seq(ScalaCIVersion)
+lazy val scala212    = "2.12.15"
+lazy val scala213    = "2.13.8"
+lazy val java11adopt = "adopt@1.11"
+
+ThisBuild / githubWorkflowJavaVersions := Seq(java11adopt)
+ThisBuild / githubWorkflowScalaVersions := Seq(scala213)
 
 /* ------------------------------------------------------------------------- */
 // Documentation project, for MDoc + Docusaurus documentation
@@ -312,10 +289,11 @@ lazy val MUnitFramework = new TestFramework("munit.Framework")
 lazy val http4sVersion = "1.0.0-M30"
 lazy val rhoVersion    = "0.23.0-M1"
 lazy val catsVersion   = "2.7.0"
+lazy val cometVersion  = "0.1.1"
 /* ------------------------------------------------------------------------- */
-lazy val mongodbVersion      = "4.5.1"
+lazy val mongodbVersion      = "4.6.0"
 lazy val mongo4catsVersion   = "0.4.7"
-lazy val any23Version        = "2.6"
+lazy val any23Version        = "2.7"
 lazy val rdf4jVersion        = "3.7.6"
 lazy val graphvizJavaVersion = "0.18.1"
 lazy val logbackVersion      = "1.2.11"
@@ -337,11 +315,12 @@ lazy val http4sBlazeClient =
   "org.http4s" %% "http4s-blaze-client" % http4sVersion
 lazy val http4sEmberClient =
   "org.http4s" %% "http4s-ember-client" % http4sVersion
-lazy val http4sCirce = "org.http4s"        %% "http4s-circe"       % http4sVersion
-lazy val rho_swagger = "org.http4s"        %% "rho-swagger"        % rhoVersion
-lazy val catsCore    = "org.typelevel"     %% "cats-core"          % catsVersion
-lazy val catsKernel  = "org.typelevel"     %% "cats-kernel"        % catsVersion
-lazy val mongodb     = "org.mongodb.scala" %% "mongo-scala-driver" % mongodbVersion
+lazy val http4sCirce = "org.http4s"         %% "http4s-circe"       % http4sVersion
+lazy val rho_swagger = "org.http4s"         %% "rho-swagger"        % rhoVersion
+lazy val catsCore    = "org.typelevel"      %% "cats-core"          % catsVersion
+lazy val catsKernel  = "org.typelevel"      %% "cats-kernel"        % catsVersion
+lazy val comet       = "io.github.ulitol97" %% "comet"              % cometVersion
+lazy val mongodb     = "org.mongodb.scala"  %% "mongo-scala-driver" % mongodbVersion
 lazy val mongo4catsCore =
   "io.github.kirill5k" %% "mongo4cats-core" % mongo4catsVersion
 lazy val mongo4catsCirce =

docs/webpage/webpage_info.md

@@ -41,9 +41,6 @@ was followed. However, minor issues occurred:
 
 1. The _package.json_ had to be modified to include the script `publish-gh-pages`.
 2. The [Docusaurus config file](https://github.com/weso/rdfshape-api/blob/master/website/docusaurus.config.js) had to be
-   modified to indicate what the location of t2.
-   The [Docusaurus config file](https://github.com/weso/rdfshape-api/blob/master/website/docusaurus.config.js) had to be
-   modified to indicate what the location of the markdown files with the web docs is.he markdown files with the web docs
-   is.
+   modified to indicate what the location of the markdown files with the web docs is.
 3. The [sidebar configuration file](https://github.com/weso/rdfshape-api/blob/master/website/sidebars.js) was modified
    to customize the sidebar that is used as navigation when browsing the web docs.

modules/server/src/main/scala/es/weso/rdfshape/server/Server.scala

@@ -23,6 +23,7 @@ import org.http4s.client.Client
 import org.http4s.implicits.http4sKleisliResponseSyntaxOptionT
 import org.http4s.server.Router
 import org.http4s.server.middleware.{CORS, CORSPolicy, Logger}
+import org.http4s.server.websocket.WebSocketBuilder
 import org.http4s.{HttpApp, HttpRoutes}
 
 import java.util.concurrent.TimeUnit
@@ -116,7 +117,11 @@ private class Server(
       .bindHttp(port, ip)
       .withIdleTimeout(idleTimeout.minutes)
       .withResponseHeaderTimeout(requestTimeout.minute)
-      .withHttpApp(createApp(client))
+      /* WebSocketBuilder was deprecated and must be obtained here, from the
+       * server builder */
+      .withHttpWebSocketApp((wsBuilder: WebSocketBuilder[IO]) =>
+        createApp(client)
+      )
 
     sslContext match {
       case None          => baseServer

version.sbt

@@ -1 +1 @@
-ThisBuild / version := "0.2.6"
+ThisBuild / version := "0.2.7"

website/docusaurus.config.js

@@ -3,7 +3,10 @@ const baseUrl = "/rdfshape-api/"
 const scalaDocUrl = `${deployUrl}${baseUrl}api/es/weso/rdfshape/`
 const apiDocsUrl = "https://app.swaggerhub.com/apis-docs/weso/RDFShape/"
 
-/** @type {import('@docusaurus/types').DocusaurusConfig} */
+const lightCodeTheme = require("prism-react-renderer/themes/github");
+const darkCodeTheme = require("prism-react-renderer/themes/dracula");
+
+/** @type {import("@docusaurus/types").DocusaurusConfig} */
 module.exports = {
   title: "RDFShape API",
   tagline: "Processing and validation of RDF with ShEx, SHACL and more",
@@ -19,71 +22,71 @@ module.exports = {
     scalaDocUrl, apiDocsUrl
   },
   themeConfig: {
-    image: "img/preview.png", hideableSidebar: false, colorMode: {
+    image: "img/preview.png",
+    colorMode: {
       defaultMode: "light",
       disableSwitch: false,
-      respectPrefersColorScheme: true,
-      switchConfig: {
-        darkIcon: "🌙",
-        lightIcon: "\u2600",
-        darkIconStyle: {marginLeft: "2px"},
-        lightIconStyle: {marginLeft: "1px"},
-      },
-    }, navbar: {
+      respectPrefersColorScheme: true
+    },
+    navbar: {
       title: "RDFShape API", logo: {
-        alt: "RDFShape API - WESO", src: "img/logo-weso.png",
+        alt: "RDFShape API - WESO", src: "img/logo-weso.png"
       }, items: [// Web docs
         {
-          to: "/docs", label: "Web docs", position: "left",
+          to: "/docs", label: "Web docs", position: "left"
         }, // Scaladoc
         {
-          to: scalaDocUrl, label: "Scaladoc", position: "left",
+          href: scalaDocUrl, label: "Scaladoc", position: "left"
         }, // API Docs in SwaggerHub
         {
           href: "https://github.com/weso/rdfshape-api",
           label: "SwaggerHub",
-          position: "right",
+          position: "right"
         }, // Link to repo
         {
           href: "https://github.com/weso/rdfshape-api",
           label: "GitHub",
-          position: "right",
-        },],
+          position: "right"
+        }]
     }, footer: {
       style: "light",
       logo: {
         alt: "RDFShape API - WESO",
         src: "img/logo-weso-footer.png",
-        href: "https://www.weso.es/",
+        href: "https://www.weso.es/"
       },
       links: [{
         title: "About us", items: [{
-          label: "WESO Research Group", to: "https://www.weso.es/",
+          label: "WESO Research Group", to: "https://www.weso.es/"
         }, {
-          label: "University of Oviedo", to: "https://www.uniovi.es/",
-        },],
+          label: "University of Oviedo", to: "https://www.uniovi.es/"
+        }]
       }, {
         title: "Community", items: [{
-          label: "GitHub", to: "https://github.com/weso",
+          label: "GitHub", to: "https://github.com/weso"
         }, {
-          label: "Twitter", to: "https://twitter.com/wesoviedo",
-        },],
+          label: "Twitter", to: "https://twitter.com/wesoviedo"
+        }]
       }, {
         title: "Further work", items: [{
-          label: "RDFShape project", to: "https://github.com/weso/rdfshape",
+          label: "RDFShape project", to: "https://github.com/weso/rdfshape"
         }, {
-          label: "More software by WESO", to: "https://www.weso.es/#software",
-        },],
-      },],
-      copyright: `Copyright © ${new Date().getFullYear()} WESO Research Group`,
+          label: "More software by WESO", to: "https://www.weso.es/#software"
+        }]
+      }],
+      copyright: `Copyright © ${new Date().getFullYear()} WESO Research Group`
     },
+    prism: {
+      theme: lightCodeTheme,
+      darkTheme: darkCodeTheme
+    }
   },
   presets: [["@docusaurus/preset-classic", {
     docs: {
       path: "../rdfshape-docs/target/mdoc",
-      sidebarPath: require.resolve("./sidebars.js"),
+      sidebarPath: require.resolve("./sidebars.js")
     }, blog: false, theme: {
-      customCss: require.resolve("./src/css/custom.css"),
-    }, sitemap: {},
-  },],],
+      customCss: require.resolve("./src/css/custom.css")
+    }, sitemap: {}
+  }]]
 };

website/package.json

@@ -15,12 +15,13 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "^2.0.0-beta.4",
-    "@docusaurus/preset-classic": "^2.0.0-beta.4",
+    "@docusaurus/core": "^2.0.0-beta.18",
+    "@docusaurus/preset-classic": "^2.0.0-beta.18",
     "@mdx-js/react": "^1.6.21",
     "@svgr/webpack": "^5.5.0",
     "clsx": "^1.1.1",
     "file-loader": "^6.2.0",
+    "prism-react-renderer": "^1.3.1",
     "react": "^17.0.1",
     "react-dom": "^17.0.1",
     "url-loader": "^4.1.1"

website/sidebars.js

@@ -5,37 +5,37 @@ const apiDocsUrl = "https://app.swaggerhub.com/apis-docs/weso/RDFShape/"
 module.exports = {
   // Generate a sidebar from the docs folder structure
   // sidebar: [{type: "autogenerated", dirName: "."}],
-
+  
   // Create a sidebar manually
   docsSidebar: [/* Home */
     {
-      type: "doc", id: "home", label: "Welcome",
+      type: "doc", id: "home", label: "Welcome"
     },
-
+    
     /* Category: deployment */
     {
       type: "category",
       label: "API Deployment",
       items: ["api-deployment/deployment_overview", "api-deployment/deployment_manual", "api-deployment/deployment_docker"],
       collapsed: false
     },
-
+    
     /* Category: usage */
     {
       type: "category",
       label: "API Usage",
       items: ["api-usage/usage_cli"],
       collapsed: false
     },
-
+    
     /* Category: testing */
     {
       type: "category",
       label: "API Testing and Auditing",
       items: ["api-testing-auditing/testing-auditing_munit", "api-testing-auditing/testing-auditing_integration", "api-testing-auditing/testing-auditing_logs"],
       collapsed: true
     },
-
+    
     /* Category: documentation */
     {
       type: "category", label: "Additional documentation", items: [{
@@ -44,10 +44,10 @@ module.exports = {
         type: "link", label: "API Docs (Swagger Hub)", href: apiDocsUrl
       }], collapsed: false
     },
-
+    
     /* Webpage information */
     {
-      type: "doc", id: "webpage/webpage_info", label: "About this webpage",
-    },],
-
+      type: "doc", id: "webpage/webpage_info", label: "About this webpage"
+    }]
+  
 };

website/src/css/custom.css

@@ -17,6 +17,7 @@
   --ifm-code-font-size: 95%;
 }
 
+/* noinspection ALL */
 .docusaurus-highlight-code-line {
   background-color: rgb(72, 77, 91);
   display: block;