feat(server): Allow customization of associated point (#99)

Author: devsjc

internal/server/postgres/dataserverimpl.go

@@ -1108,10 +1108,21 @@ func (s *DataPlatformDataServiceServerImpl) CreateLocation(
 
 	querier := db.New(ix.GetTxFromContext(ctx))
 
+	var associated_point *string
+	if req.AssociatedLatlng != nil {
+		point := fmt.Sprintf(
+			"POINT(%f %f)",
+			req.AssociatedLatlng.Longitude,
+			req.AssociatedLatlng.Latitude,
+		)
+		associated_point = &point
+	}
+
 	cgprms := db.CreateGeometryParams{
-		GeometryName:   req.LocationName,
-		Geom:           req.GeometryWkt,
-		GeometryTypeID: int16(req.LocationType),
+		GeometryName:    req.LocationName,
+		Geom:            req.GeometryWkt,
+		GeometryTypeID:  int16(req.LocationType),
+		AssociatedPoint: associated_point,
 	}
 
 	dbLocation, err := querier.CreateGeometry(ctx, cgprms)

internal/server/postgres/dataserverimpl_test.go

@@ -115,8 +115,9 @@ func TestCreateLocation(t *testing.T) {
 	require.NoError(t, err)
 
 	testcases := []struct {
-		name string
-		req  *pb.CreateLocationRequest
+		name           string
+		req            *pb.CreateLocationRequest
+		expectedLatLng *pb.LatLng
 	}{
 		{
 			name: "Should create solar location",
@@ -128,6 +129,10 @@ func TestCreateLocation(t *testing.T) {
 				LocationType:           pb.LocationType_LOCATION_TYPE_SITE,
 				Metadata:               metadata,
 			},
+			expectedLatLng: &pb.LatLng{
+				Latitude:  51.5,
+				Longitude: 0.0,
+			},
 		},
 		{
 			name: "Shouldn't create unknown energy source",
@@ -150,6 +155,10 @@ func TestCreateLocation(t *testing.T) {
 				LocationType:           pb.LocationType_LOCATION_TYPE_SITE,
 				Metadata:               metadata,
 			},
+			expectedLatLng: &pb.LatLng{
+				Latitude:  51.5,
+				Longitude: 0.0,
+			},
 		},
 		{
 			name: "Shouldn't create unknown location type",
@@ -183,6 +192,10 @@ func TestCreateLocation(t *testing.T) {
 				LocationType:           pb.LocationType_LOCATION_TYPE_GSP,
 				Metadata:               metadata,
 			},
+			expectedLatLng: &pb.LatLng{
+				Latitude:  51.75,
+				Longitude: 0.5,
+			},
 		},
 		{
 			name: "Shouldn't create location with non-closed POLYGON geometry",
@@ -205,6 +218,10 @@ func TestCreateLocation(t *testing.T) {
 				LocationType:           pb.LocationType_LOCATION_TYPE_DNO,
 				Metadata:               metadata,
 			},
+			expectedLatLng: &pb.LatLng{
+				Latitude:  51.75,
+				Longitude: 1.5,
+			},
 		},
 		{
 			name: "Shouldn't create location with non-closed MULTIPOLYGON geometry",
@@ -228,6 +245,25 @@ func TestCreateLocation(t *testing.T) {
 				Metadata:               metadata,
 			},
 		},
+		{
+			name: "Should create location with associated lat long",
+			req: &pb.CreateLocationRequest{
+				LocationName:           "closed_multipolygon_with_latlng",
+				EnergySource:           pb.EnergySource_ENERGY_SOURCE_WIND,
+				GeometryWkt:            "MULTIPOLYGON(((0.0 51.5, 1.0 51.5, 1.0 52.0, 0.0 52.0, 0.0 51.5)),((2.0 51.5, 3.0 51.5, 3.0 52.0, 2.0 52.0, 2.0 51.5)))",
+				EffectiveCapacityWatts: 14e6,
+				LocationType:           pb.LocationType_LOCATION_TYPE_DNO,
+				Metadata:               metadata,
+				AssociatedLatlng: &pb.LatLng{
+					Latitude:  51.5074,
+					Longitude: -0.1278,
+				},
+			},
+			expectedLatLng: &pb.LatLng{
+				Latitude:  51.5074,
+				Longitude: -0.1278,
+			},
+		},
 	}
 
 	for _, tc := range testcases {
@@ -253,6 +289,7 @@ func TestCreateLocation(t *testing.T) {
 				// require.Equal(t, tc.req.GeometryWkt, string(resp2.GeometryWkb))
 				require.Equal(t, tc.req.EffectiveCapacityWatts, resp2.EffectiveCapacityWatts)
 				require.Equal(t, tc.req.Metadata.AsMap(), resp2.Metadata.AsMap())
+				require.Equal(t, tc.expectedLatLng, resp2.Latlng)
 			}
 		})
 	}

internal/server/postgres/sql/migrations/00002_locations.sql

@@ -76,7 +76,14 @@ CREATE TABLE loc.geometries (
     REFERENCES loc.geometry_types (geometry_type_id)
     ON UPDATE CASCADE
     ON DELETE RESTRICT,
-    centroid GEOMETRY (POINT, 4326) GENERATED ALWAYS AS (ST_CENTROID(geom)) STORED,
+    associated_point GEOMETRY (POINT, 4326) NOT NULL,
+    CONSTRAINT associated_point_validity_check CHECK (
+	ST_SRID(associated_point) = 4326
+	AND ST_NDIMS(associated_point) = 2
+	AND ST_ISVALID(associated_point)
+	AND ST_X(associated_point) >= -180 AND ST_X(associated_point) <= 180
+	AND ST_Y(associated_point) >= -90 AND ST_Y(associated_point) <= 90
+    ),
     geom_hash TEXT GENERATED ALWAYS AS (MD5(ST_ASBINARY(geom))) STORED,
     metadata JSONB DEFAULT NULL,
     PRIMARY KEY (geometry_uuid),
@@ -139,8 +146,8 @@ SELECT
     sh.metadata,
     g.geometry_name,
     g.geometry_type_id,
-    ST_X(g.centroid)::REAL AS longitude,
-    ST_Y(g.centroid)::REAL AS latitude,
+    ST_X(g.associated_point)::REAL AS longitude,
+    ST_Y(g.associated_point)::REAL AS latitude,
     TSRANGE(
         sh.valid_from_utc,
         LEAD(sh.valid_from_utc, 1) OVER (

internal/server/postgres/sql/queries/locations.sql

@@ -2,18 +2,24 @@
 
 -- name: CreateGeometry :one
 INSERT INTO loc.geometries AS l (
-    geometry_name, geom, geometry_type_id
+    geometry_name, geom, geometry_type_id, associated_point
 ) VALUES (
     LOWER(sqlc.arg(geometry_name)::TEXT),
-    ST_GEOMFROMTEXT(sqlc.arg(geom)::TEXT, 4326), --Ensure in WSG84
-    $1
-) RETURNING l.geometry_uuid, l.geometry_name, ST_X(l.centroid)::REAL AS longitude, ST_Y(l.centroid)::REAL AS latitude;
+    ST_GEOMFROMTEXT(sqlc.arg(geom)::TEXT, 4326),
+    $1,
+    COALESCE(
+        ST_GEOMFROMTEXT(sqlc.narg(associated_point)::TEXT, 4326),
+        ST_CENTROID(ST_GEOMFROMTEXT(sqlc.arg(geom)::TEXT, 4326))
+    )
+) RETURNING
+    l.geometry_uuid, l.geometry_name, ST_X(l.associated_point)::REAL AS longitude, ST_Y(l.associated_point)::REAL AS latitude;
 
 -- name: RenameGeometry :one
 UPDATE loc.geometries AS l
 SET geometry_name = LOWER(sqlc.arg(new_geometry_name)::TEXT)
 WHERE l.geometry_uuid = $1
-RETURNING l.geometry_uuid, l.geometry_name, ST_X(l.centroid)::REAL AS longitude, ST_Y(l.centroid)::REAL AS latitude;
+RETURNING
+    l.geometry_uuid, l.geometry_name, ST_X(l.associated_point)::REAL AS longitude, ST_Y(l.associated_point)::REAL AS latitude;
 
 -- name: GetGeometryGeoJSON :one
 /* GetLocationGeoJSON returns a GeoJSON FeatureCollection for the given geometries.
@@ -52,8 +58,8 @@ SELECT
     s.geometry_uuid,
     l.geometry_name,
     s.sys_period,
-    ST_X(l.centroid)::REAL AS longitude,
-    ST_Y(l.centroid)::REAL AS latitude
+    ST_X(l.associated_point)::REAL AS longitude,
+    ST_Y(l.associated_point)::REAL AS latitude
 FROM loc.sources_mv AS s
     INNER JOIN loc.geometries AS l USING (geometry_uuid)
 WHERE
@@ -127,8 +133,8 @@ WITH unfiltered_sources AS (
         ls.capacity_limit_sip,
         l.geometry_name,
         l.geometry_type_id,
-        ST_X(l.centroid)::REAL AS longitude,
-        ST_Y(l.centroid)::REAL AS latitude,
+        ST_X(l.associated_point)::REAL AS longitude,
+        ST_Y(l.associated_point)::REAL AS latitude,
         l.metadata AS geometry_metadata,
         ls.metadata AS source_metadata
     FROM loc.sources_mv AS ls
@@ -161,7 +167,7 @@ WITH contained_geometries AS (
         l.geometry_name,
         l.geometry_type_id,
         l.geom,
-        l.centroid,
+        l.associated_point,
         l.metadata
     FROM loc.geometries AS l
         INNER JOIN
@@ -181,8 +187,8 @@ unfiltered_sources AS (
         ls.capacity_limit_sip,
         l.geometry_name,
         l.geometry_type_id,
-        ST_X(l.centroid)::REAL AS longitude,
-        ST_Y(l.centroid)::REAL AS latitude,
+        ST_X(l.associated_point)::REAL AS longitude,
+        ST_Y(l.associated_point)::REAL AS latitude,
         l.metadata AS geometry_metadata,
         ls.metadata AS source_metadata
     FROM loc.sources_mv AS ls
@@ -215,12 +221,12 @@ WITH containing_geometries AS (
         l.geometry_name,
         l.geometry_type_id,
         l.geom,
-        l.centroid,
+        l.associated_point,
         l.metadata
     FROM loc.geometries AS l
         INNER JOIN
             loc.geometries AS l_inner ON ST_WITHIN(
-                l_inner.geom,
+                l_inner.associated_point,
                 l.geom
             ) AND l_inner.geometry_uuid = sqlc.arg(inner_geometry_uuid)::UUID
             AND l.geometry_uuid <> sqlc.arg(inner_geometry_uuid)::UUID
@@ -235,8 +241,8 @@ unfiltered_sources AS (
         ls.capacity_limit_sip,
         l.geometry_name,
         l.geometry_type_id,
-        ST_X(l.centroid)::REAL AS longitude,
-        ST_Y(l.centroid)::REAL AS latitude,
+        ST_X(l.associated_point)::REAL AS longitude,
+        ST_Y(l.associated_point)::REAL AS latitude,
         l.metadata AS geometry_metadata,
         ls.metadata AS source_metadata
     FROM loc.sources_mv AS ls

internal/server/postgres/testdata/seeding.sql

@@ -22,10 +22,11 @@ BEGIN
 
     -- Insert geometries
     INSERT INTO loc.geometries
-      (geometry_name, geometry_type_id, geom)
+      (geometry_name, geometry_type_id, geom, associated_point)
     SELECT
         LOWER(name_prefix) || '_testgeometry' || i AS geometry_name,
         1,
+        ST_SetSRID(ST_MakePoint(random() * 355 - 180, random() * 175 - 90), 4326),
         ST_SetSRID(ST_MakePoint(random() * 355 - 180, random() * 175 - 90), 4326)
     FROM generate_series(0, num_locations - 1) as i;
     RAISE NOTICE 'Inserted % geometries', (SELECT COUNT(*) FROM loc.geometries);

proto/ocf/dp/dp-data.messages.proto

@@ -337,6 +337,16 @@ message CreateLocationRequest {
   optional google.protobuf.Timestamp valid_from_utc = 7 [
     (buf.validate.field).timestamp = { gt: { seconds: 112000000}, lt_now: true }
   ];
+  // Optional latitude/longitude to associate with the location.
+  // Defaults to the centroid of the geometry if not provided. Not required for Point geometries.
+  optional LatLng associated_latlng = 8;
+
+  option (buf.validate.message).cel = {
+    id: "latlng_invalid_for_point"
+    message: "latlng must not be provided for Point geometries"
+    expression:
+      "this.geometry_wkt.startsWith('POINT') ? !has(this.associated_latlng) : true"
+  };
 }
 
 message CreateLocationResponse {