Initial Tableau Reading Support (#10733)

- Adds `Hyper_File` allowing reading a Tableau hyper file.
- Can read the schema and table list.
- Can read the structure of a table.
- Can read data into an Enso Table.

CHANGELOG.md

@@ -7,10 +7,12 @@
 - [Relative paths are now resolved relative to the project location, also in the
   Cloud.][10660]
 - [Added Newline option to Text_Cleanse/Text_Replace.][10761]
+- [Support for reading from Tableau Hyper files.][10733]
 
 [10614]: https://github.com/enso-org/enso/pull/10614
 [10660]: https://github.com/enso-org/enso/pull/10660
 [10761]: https://github.com/enso-org/enso/pull/10761
+[10733]: https://github.com/enso-org/enso/pull/10733
 
 # Enso 2023.3
 

build.sbt

@@ -18,6 +18,7 @@ import src.main.scala.licenses.{
 import JPMSPlugin.autoImport._
 
 import java.io.File
+import java.nio.file.Files
 import java.nio.file.Paths
 
 // ============================================================================
@@ -167,7 +168,11 @@ GatherLicenses.distributions := Seq(
     "Snowflake",
     Distribution.sbtProjects(`std-snowflake`)
   ),
-  makeStdLibDistribution("Microsoft", Distribution.sbtProjects(`std-microsoft`))
+  makeStdLibDistribution(
+    "Microsoft",
+    Distribution.sbtProjects(`std-microsoft`)
+  ),
+  makeStdLibDistribution("Tableau", Distribution.sbtProjects(`std-tableau`))
 )
 
 GatherLicenses.licenseConfigurations := Set("compile")
@@ -351,6 +356,7 @@ lazy val enso = (project in file("."))
     `std-aws`,
     `std-snowflake`,
     `std-microsoft`,
+    `std-tableau`,
     `http-test-helper`,
     `enso-test-java-helpers`,
     `exploratory-benchmark-java-helpers`,
@@ -526,6 +532,7 @@ val poiOoxmlVersion         = "5.2.3"
 val redshiftVersion         = "2.1.0.15"
 val univocityParsersVersion = "2.9.1"
 val xmlbeansVersion         = "5.1.1"
+val tableauVersion          = "0.0.19691.r2d7e5bc8"
 
 // === ZIO ====================================================================
 
@@ -570,6 +577,7 @@ val apacheArrowVersion      = "14.0.1"
 val snowflakeJDBCVersion    = "3.15.0"
 val mssqlserverJDBCVersion  = "12.6.2.jre11"
 val jsoniterVersion         = "2.28.5"
+val jnaVersion              = "5.14.0"
 
 // ============================================================================
 // === Utility methods =====================================================
@@ -1947,6 +1955,7 @@ lazy val runtime = (project in file("engine/runtime"))
       .dependsOn(`std-aws` / Compile / packageBin)
       .dependsOn(`std-snowflake` / Compile / packageBin)
       .dependsOn(`std-microsoft` / Compile / packageBin)
+      .dependsOn(`std-tableau` / Compile / packageBin)
       .value
   )
   .dependsOn(`common-polyglot-core-utils`)
@@ -3267,6 +3276,8 @@ val `std-snowflake-polyglot-root` =
   stdLibComponentRoot("Snowflake") / "polyglot" / "java"
 val `std-microsoft-polyglot-root` =
   stdLibComponentRoot("Microsoft") / "polyglot" / "java"
+val `std-tableau-polyglot-root` =
+  stdLibComponentRoot("Tableau") / "polyglot" / "java"
 
 lazy val `std-base` = project
   .in(file("std-bits") / "base")
@@ -3604,6 +3615,95 @@ lazy val `std-microsoft` = project
   .dependsOn(`std-table` % "provided")
   .dependsOn(`std-database` % "provided")
 
+lazy val `std-tableau` = project
+  .in(file("std-bits") / "tableau")
+  .settings(
+    frgaalJavaCompilerSetting,
+    autoScalaLibrary := false,
+    unmanagedExternalZip := {
+      val platform = if (Platform.isWindows) {
+        "windows"
+      } else if (Platform.isMacOS) {
+        "macos"
+      } else if (Platform.isLinux) {
+        "linux"
+      }
+      val arch = if (Platform.isArm64) {
+        "arm64"
+      } else {
+        "x86_64"
+      }
+      new URI(
+        s"https://downloads.tableau.com/tssoftware/tableauhyperapi-java-$platform-$arch-release-main.$tableauVersion.zip"
+      ).toURL()
+    },
+    fetchZipToUnmanaged := {
+      val unmanagedDirectory = (Compile / unmanagedBase).value
+      val logger             = state.value.log
+      if (IO.listFiles(unmanagedDirectory).size < 2) { // Heuristic, should have at least hyperapi jar and os-specific one.
+        logger.log(
+          Level.Info,
+          "std-tableau's unmanaged dependencies are not up-to-date. fetching..."
+        )
+        unmanagedDirectory.mkdirs()
+        val unmanagedPath = unmanagedDirectory.toPath
+        IO.withTemporaryDirectory(
+          tmp => {
+            val files = IO.unzipURL(
+              unmanagedExternalZip.value,
+              tmp,
+              f =>
+                f.endsWith(".jar") && !f.contains("gradle") && !f.contains(
+                  "javadoc"
+                ) && !f.contains("jna")
+            )
+            files.map { f =>
+              IO.move(f, unmanagedPath.resolve(f.getName).toFile)
+              Attributed.blank(unmanagedPath.resolve(f.getName).toFile)
+            }.toSeq
+          },
+          keepDirectory = false
+        )
+      } else {
+        Seq[Attributed[File]]()
+      }
+    },
+    Compile / unmanagedClasspath := Def.task {
+      val additionalFiles: Seq[Attributed[File]] = fetchZipToUnmanaged.value
+      val result                                 = (Compile / unmanagedClasspath).value
+      result ++ additionalFiles
+    }.value,
+    Compile / unmanagedJars := (Compile / unmanagedJars)
+      .dependsOn(fetchZipToUnmanaged)
+      .value,
+    Compile / packageBin / artifactPath :=
+      `std-tableau-polyglot-root` / "std-tableau.jar",
+    libraryDependencies ++= Seq(
+      "org.netbeans.api" % "org-openide-util-lookup" % netbeansApiVersion % "provided",
+      "net.java.dev.jna" % "jna-platform"            % jnaVersion
+    ),
+    Compile / packageBin := Def.task {
+      val result = (Compile / packageBin).value
+      val _ = StdBits
+        .copyDependencies(
+          `std-tableau-polyglot-root`,
+          Seq("std-tableau.jar"),
+          ignoreScalaLibrary = true
+        )
+        .value
+      result
+    }.value
+  )
+  .dependsOn(`std-base` % "provided")
+  .dependsOn(`std-table` % "provided")
+
+lazy val fetchZipToUnmanaged =
+  taskKey[Seq[Attributed[File]]](
+    "Download zip file from an `unmanagedExternalZip` url and unpack jars to unmanaged libs directory"
+  )
+lazy val unmanagedExternalZip =
+  settingKey[URL]("URL to zip file with dependencies")
+
 /* Note [Native Image Workaround for GraalVM 20.2]
  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  * In GraalVM 20.2 the Native Image build of even simple Scala programs has
@@ -3824,6 +3924,8 @@ pkgStdLibInternal := Def.inputTask {
       (`std-snowflake` / Compile / packageBin).value
     case "Microsoft" =>
       (`std-microsoft` / Compile / packageBin).value
+    case "Tableau" =>
+      (`std-tableau` / Compile / packageBin).value
     case _ if buildAllCmd =>
       (`std-base` / Compile / packageBin).value
       (`enso-test-java-helpers` / Compile / packageBin).value
@@ -3836,6 +3938,7 @@ pkgStdLibInternal := Def.inputTask {
       (`std-aws` / Compile / packageBin).value
       (`std-snowflake` / Compile / packageBin).value
       (`std-microsoft` / Compile / packageBin).value
+      (`std-tableau` / Compile / packageBin).value
     case _ =>
   }
   val libs =

distribution/lib/Standard/Base/0.0.0-dev/src/Data/Json.enso

@@ -162,7 +162,7 @@ type JS_Object
         JS_Object.Value object_node (make_field_names object_node)
 
     ## PRIVATE
-       Creates a Jackon_Object from a list of key-value pairs.
+       Creates a Jackson_Object from a list of key-value pairs.
        Keys must be `Text` values.
        Values will be recursively converted to JSON serializable as needed.
     from_pairs : Vector -> JS_Object

distribution/lib/Standard/Tableau/0.0.0-dev/THIRD-PARTY/COPYRIGHT-HYPERAPI

@@ -0,0 +1,3 @@
+Copyright (c) 2016 - 2023, Salesforce, Inc. and its licensors. All rights reserved.
+
+Protected by U.S. Patents and Trademarks as noted at http://www.tableau.com/ip; Patents pending.

distribution/lib/Standard/Tableau/0.0.0-dev/THIRD-PARTY/NOTICE

@@ -0,0 +1,12 @@
+Enso
+Copyright 2020 - 2024 New Byte Order sp. z o. o.
+
+'jna', licensed under the Apache-2.0, is distributed with the Tableau.
+The license file can be found at `licenses/APACHE2.0`.
+Copyright notices related to this dependency can be found in the directory `net.java.dev.jna.jna-5.14.0`.
+
+
+'jna-platform', licensed under the Apache-2.0, is distributed with the Tableau.
+The license file can be found at `licenses/APACHE2.0`.
+Copyright notices related to this dependency can be found in the directory `net.java.dev.jna.jna-platform-5.14.0`.
+