Improving the use of spatial extension with wasm (#278)

* adding SimpleGeoDB to web bundle

* test for flipCoordinates

Author: nshiab

src/bundle.ts

@@ -1,3 +1,2 @@
 export { default as SimpleDB } from "./class/SimpleDB.js"
-// Not working for now.
-// export { default as SimpleGeoDB } from "./class/SimpleGeoDB.js"
+export { default as SimpleGeoDB } from "./class/SimpleGeoDB.js"

src/class/SimpleDB.ts

@@ -63,7 +63,7 @@ import replaceNullsQuery from "../methods/replaceNullsQuery.js"
  * const sdb = new SimpleDB()
  * ```
  *
- * The start() method will be called internally automatically with the first method you'll run. It initializes DuckDB and establishes a connection to the database. It sets the default_collation to NOCASE.
+ * The start() method will be called internally automatically with the first method you'll run. It initializes DuckDB and establishes a connection to the database.
  *
  */
 
@@ -101,7 +101,7 @@ export default class SimpleDB {
      * const sdb = new SimpleDB()
      * ```
      *
-     * The start() method will be called internally automatically with the first method you'll run. It initializes DuckDB and establishes a connection to the database. It sets the default_collation to NOCASE.
+     * The start() method will be called internally automatically with the first method you'll run. It initializes DuckDB and establishes a connection to the database.
      *
      * @param options - An optional object with configuration options:
      *   @param options.debug - A flag indicating whether debugging information should be logged. Defaults to false.

src/class/SimpleGeoDB.ts

@@ -4,8 +4,6 @@ import queryDB from "../helpers/queryDB.js"
 import SimpleDB from "./SimpleDB.js"
 
 /**
- * !!! UNDER HEAVY DEVELOPMENT !!!
- *
  * SimpleGeoDB extends the SimpleDB class by adding methods for geospatial analysis. This class provides a simplified interface for working with DuckDB, a high-performance in-memory analytical database. This class is meant to be used in a web browser. For NodeJS and similar runtimes, use SimpleNodeDB with the spatial option set to true.
  *
  * Here's how to instantiate a SimpleGeoDB instance.
@@ -14,7 +12,7 @@ import SimpleDB from "./SimpleDB.js"
  * const sdb = new SimpleGeoDB()
  * ```
  *
- * The start() method will be called internally automatically with the first method you'll run. It initializes DuckDB and establishes a connection to the database. It sets the default_collation to NOCASE and loads the [spatial](https://duckdb.org/docs/extensions/spatial) extension.
+ * The start() method will be called internally automatically with the first method you'll run. It initializes DuckDB and establishes a connection to the database. It loads the [spatial](https://duckdb.org/docs/extensions/spatial) extension.
  *
  */
 export default class SimpleGeoDB extends SimpleDB {
@@ -66,7 +64,7 @@ export default class SimpleGeoDB extends SimpleDB {
     }
 
     /**
-     * Checks if a geometry is valid. (Not tested)
+     * Checks if a geometry is valid.
      *
      * ```ts
      * // Checks if the geometries in column geom from table tableGeo are valid and returns a boolean in column isValid.
@@ -90,7 +88,7 @@ export default class SimpleGeoDB extends SimpleDB {
     }
 
     /**
-     * Flips the coordinates of a geometry. Useful for some geojson files which have lat and lon inverted. (Not tested)
+     * Flips the coordinates of a geometry. Useful for some geojson files which have lat and lon inverted.
      *
      * ```ts
      * await sdb.flipCoordinates("tableGeo", "geom")

src/class/SimpleNodeDB.ts

@@ -21,7 +21,7 @@ import runQueryNode from "../helpers/runQueryNode.js"
  * const sdb = new SimpleNodeDB()
  * ```
  *
- * The start() method will be called internally automatically with the first method you'll run. It initializes DuckDB and establishes a connection to the database. It sets the default_collation to NOCASE and optionally loads the [spatial](https://duckdb.org/docs/extensions/spatial) extension.
+ * The start() method will be called internally automatically with the first method you'll run. It initializes DuckDB and establishes a connection to the database. It optionally loads the [spatial](https://duckdb.org/docs/extensions/spatial) extension.
  *
  * With very expensive computations, it might create a .tmp folder, so make sure to add .tmp to your gitignore.
  *
@@ -35,7 +35,7 @@ export default class SimpleNodeDB extends SimpleGeoDB {
      * const sdb = new SimpleNodeDB()
      * ```
      *
-     * The start() method will be called internally automatically with the first method you'll run. It initializes DuckDB and establishes a connection to the database. It sets the default_collation to NOCASE and optionally loads the [spatial](https://duckdb.org/docs/extensions/spatial) extension.
+     * The start() method will be called internally automatically with the first method you'll run. It initializes DuckDB and establishes a connection to the database. It optionally loads the [spatial](https://duckdb.org/docs/extensions/spatial) extension.
      *
      * @param options - An optional object with configuration options:
      *   - debug: A flag indicating whether debugging information should be logged. Defaults to false.

src/helpers/getDuckDB.ts

@@ -1,5 +1,3 @@
-// From https://github.com/ryan-williams/next-duckdb-parquet-demo/blob/main/src/parquet.ts
-
 import * as duckdb from "@duckdb/duckdb-wasm"
 import { AsyncDuckDB, DuckDBBundle } from "@duckdb/duckdb-wasm"
 import Worker from "web-worker"

test/geodata/files/invalid.geojson

@@ -0,0 +1,29 @@
+{
+    "type": "FeatureCollection",
+    "name": "polygon_inner_and_exterior_ring_cross",
+    "features": [
+        {
+            "type": "Feature",
+            "properties": {},
+            "geometry": {
+                "type": "Polygon",
+                "coordinates": [
+                    [
+                        [13.382288, 52.515426],
+                        [13.382096, 52.514797],
+                        [13.383424, 52.51464],
+                        [13.383529, 52.515496],
+                        [13.382288, 52.515426]
+                    ],
+                    [
+                        [13.382603, 52.514954],
+                        [13.38262, 52.516255],
+                        [13.383144, 52.515321],
+                        [13.383127, 52.514867],
+                        [13.382603, 52.514954]
+                    ]
+                ]
+            }
+        }
+    ]
+}

test/geodata/files/point.json

@@ -0,0 +1,13 @@
+{
+    "type": "FeatureCollection",
+    "features": [
+        {
+            "type": "Feature",
+            "properties": {},
+            "geometry": {
+                "coordinates": [-73.62315106245389, 45.51412791316409],
+                "type": "Point"
+            }
+        }
+    ]
+}

test/unit/class/SimpleGeoDB.test.ts

@@ -1,27 +1,11 @@
 import assert from "assert"
 import SimpleGeoDB from "../../../src/class/SimpleGeoDB.js"
-// import { AsyncDuckDB, AsyncDuckDBConnection } from "@duckdb/duckdb-wasm"
 
 describe("SimpleGeoDB", () => {
     const simpleGeoDB = new SimpleGeoDB()
     it("should instantiate a SimpleGeoDB class", () => {
         assert.deepStrictEqual(simpleGeoDB instanceof SimpleGeoDB, true)
     })
 
-    it("should start and instantiate a db", async () => {
-        console.log("NOT WORKING FOR NOW.")
-        // await simpleGeoDB.start()
-        // assert.deepStrictEqual(simpleGeoDB.db instanceof AsyncDuckDB, true)
-    })
-    it("should instantiate a connection", async () => {
-        console.log("NOT WORKING FOR NOW.")
-        // assert.deepStrictEqual(
-        // simpleGeoDB.connection instanceof AsyncDuckDBConnection,
-        // true
-        // )
-    })
-    it("should close the db", async () => {
-        console.log("NOT WORKING FOR NOW.")
-        // await simpleGeoDB.done()
-    })
+    // For the rest, testing in https://observablehq.com/@nshiab/testing-simple-data-analysis-v2-0-0
 })

test/unit/methods/flipCoordinates.test.ts

@@ -1,3 +1,4 @@
+import assert from "assert"
 import SimpleNodeDB from "../../../src/class/SimpleNodeDB.js"
 
 describe("flipCoordinates", () => {
@@ -6,7 +7,7 @@ describe("flipCoordinates", () => {
         simpleNodeDB = new SimpleNodeDB({ spatial: true })
         await simpleNodeDB.loadGeoData(
             "geodata",
-            "test/geodata/files/CanadianProvincesAndTerritories.json"
+            "test/geodata/files/point.json"
         )
     })
     after(async function () {
@@ -15,7 +16,13 @@ describe("flipCoordinates", () => {
 
     it("should flip the coordinates", async () => {
         await simpleNodeDB.flipCoordinates("geodata", "geom")
+        const data = await simpleNodeDB.customQuery(
+            `SELECT ST_AsText(geom) as geomText FROM geoData;`,
+            { returnDataFrom: "query" }
+        )
 
-        // Not sure how to test
+        assert.deepStrictEqual(data, [
+            { geomText: "POINT (45.51412791316409 -73.62315106245389)" },
+        ])
     })
 })

test/unit/methods/isValidGeo.test.ts

@@ -10,7 +10,7 @@ describe("isValidGeo", () => {
         await simpleNodeDB.done()
     })
 
-    it("should check if geometries are valid", async () => {
+    it("should find that geometries are valid", async () => {
         await simpleNodeDB.loadGeoData(
             "geodata",
             "test/geodata/files/CanadianProvincesAndTerritories.json"
@@ -23,7 +23,6 @@ describe("isValidGeo", () => {
         ])
         const data = await simpleNodeDB.getData("geoData")
 
-        // Not very useful.
         assert.deepStrictEqual(data, [
             {
                 nameEnglish: "Newfoundland and Labrador",
@@ -68,4 +67,16 @@ describe("isValidGeo", () => {
             { nameEnglish: "Nunavut", nameFrench: "Nunavut", isValid: true },
         ])
     })
+    it("should find that geometries are not valid", async () => {
+        // From https://github.com/chrieke/geojson-invalid-geometry
+        await simpleNodeDB.loadGeoData(
+            "geodata",
+            "test/geodata/files/invalid.geojson"
+        )
+        await simpleNodeDB.isValidGeo("geoData", "geom", "isValid")
+        await simpleNodeDB.selectColumns("geoData", "isValid")
+        const data = await simpleNodeDB.getData("geoData")
+
+        assert.deepStrictEqual(data, [{ isValid: false }])
+    })
 })