changeset 5574:271888ef85bc surveysperbottleneckid

Finalize use of bottleneck id instead of name. Main feaure is the restructuring of the /surveys endpoint. The endpoint now takes queryparameters as qualifiers. /surveys?id={id} returns surveys to a given bottleck {id} /surveys?name={name} & date={date} returns surveys for given {name} of a bottleneck and {date} for a surveydate. This is needed mainly because there is some backwards incompatibility when reviewing sounding results where the summary of a sr import contains only the name instead of the id of the according bottleneck. To bridge this mismatch the survey endpoint could be queried for the sr to review given the surveydate and the name of the bottleneck. Premise is here, that a date and a bottleneck's name is specific enough to identify the correct survey with the correct bottleneck.
author Thomas Junk <thomas.junk@intevation.de>
date Wed, 21 Jul 2021 14:33:35 +0200
parents 5d95f3b7c45f
children 6709530f002e
files client/src/components/Bottlenecks.vue client/src/components/fairway/BottleneckDialogue.vue client/src/components/importoverview/SoundingResultDetail.vue client/src/store/bottlenecks.js pkg/controllers/routes.go pkg/controllers/surveys.go
diffstat 6 files changed, 75 insertions(+), 18 deletions(-) [+]
line wrap: on
line diff
--- a/client/src/components/Bottlenecks.vue	Tue Jul 20 18:56:18 2021 +0200
+++ b/client/src/components/Bottlenecks.vue	Wed Jul 21 14:33:35 2021 +0200
@@ -176,7 +176,8 @@
       } else {
         this.loading = bottleneck;
         HTTP.get(
-          "/surveys/" + encodeURIComponent(bottleneck.properties.bottleneck_id),
+          "/surveys?id=" +
+            encodeURIComponent(bottleneck.properties.bottleneck_id),
           {
             headers: {
               "X-Gemma-Auth": localStorage.getItem("token"),
--- a/client/src/components/fairway/BottleneckDialogue.vue	Tue Jul 20 18:56:18 2021 +0200
+++ b/client/src/components/fairway/BottleneckDialogue.vue	Wed Jul 21 14:33:35 2021 +0200
@@ -527,8 +527,10 @@
   watch: {
     selectedBottleneck() {
       this.$store.dispatch("fairwayprofile/previousCuts");
-      this.cutLabel =
-        this.bottleneck.get("objnam") + " (" + new Date().toISOString() + ")";
+      if (this.bottleneck) {
+        this.cutLabel =
+          this.bottleneck.get("objnam") + " (" + new Date().toISOString() + ")";
+      }
     },
     selectedSurvey(survey) {
       this.loadProfile(survey);
--- a/client/src/components/importoverview/SoundingResultDetail.vue	Tue Jul 20 18:56:18 2021 +0200
+++ b/client/src/components/importoverview/SoundingResultDetail.vue	Wed Jul 21 14:33:35 2021 +0200
@@ -31,6 +31,8 @@
  * Thomas Junk <thomas.junk@intevation.de>
  */
 import { mapState } from "vuex";
+import { HTTP } from "@/lib/http";
+import { displayError } from "@/lib/errors";
 
 export default {
   name: "soundingresultdetails",
@@ -55,10 +57,36 @@
         zoom: 17,
         preventZoomOut: true
       });
-      this.$store
-        .dispatch("bottlenecks/setSelectedBottleneck", bottleneck) //This has to be changed to bottleneck_id
-        .then(() => {
-          this.$store.commit("bottlenecks/setSelectedSurveyByDate", date);
+      HTTP.get(
+        "/surveys?name=" +
+          encodeURIComponent(bottleneck) +
+          "&date=" +
+          encodeURIComponent(date),
+        {
+          headers: {
+            "X-Gemma-Auth": localStorage.getItem("token"),
+            "Content-type": "text/xml; charset=UTF-8"
+          }
+        }
+      )
+        .then(response => {
+          const { bottleneck_id } = response.data.surveys[0];
+          this.$store
+            .dispatch("bottlenecks/setSelectedBottleneck", bottleneck_id)
+            .then(() => {
+              this.$store.commit("bottlenecks/setSelectedSurveyByDate", date);
+            });
+        })
+        .catch(error => {
+          let message = "Backend not reachable";
+          if (error.response) {
+            const { status, data } = error.response;
+            message = `${status}: ${data.message || data}`;
+          }
+          displayError({
+            title: this.$gettext("Backend Error"),
+            message: message
+          });
         });
     }
   }
--- a/client/src/store/bottlenecks.js	Tue Jul 20 18:56:18 2021 +0200
+++ b/client/src/store/bottlenecks.js	Wed Jul 21 14:33:35 2021 +0200
@@ -114,7 +114,7 @@
         commit("setSelectedBottleneck", id);
         if (id) {
           commit("surveysLoading", true);
-          HTTP.get("/surveys/" + encodeURIComponent(id), {
+          HTTP.get("/surveys?id=" + encodeURIComponent(id), {
             headers: {
               "X-Gemma-Auth": localStorage.getItem("token"),
               "Content-type": "text/xml; charset=UTF-8"
--- a/pkg/controllers/routes.go	Tue Jul 20 18:56:18 2021 +0200
+++ b/pkg/controllers/routes.go	Wed Jul 21 14:33:35 2021 +0200
@@ -177,7 +177,7 @@
 	})).Methods(http.MethodGet)
 
 	// Survey selection
-	api.Handle("/surveys/{bottleneck:.+}", any(&mw.JSONHandler{
+	api.Handle("/surveys", any(&mw.JSONHandler{
 		Handle: listSurveys,
 	})).Methods(http.MethodGet)
 
--- a/pkg/controllers/surveys.go	Tue Jul 20 18:56:18 2021 +0200
+++ b/pkg/controllers/surveys.go	Wed Jul 21 14:33:35 2021 +0200
@@ -19,15 +19,13 @@
 	"database/sql"
 	"net/http"
 
-	"github.com/gorilla/mux"
-
 	"gemma.intevation.de/gemma/pkg/models"
 
 	mw "gemma.intevation.de/gemma/pkg/middleware"
 )
 
 const (
-	listSurveysSQL = `
+	listSurveysByIdSQL = `
 SELECT DISTINCT
   s.bottleneck_id,
   s.date_info::text,
@@ -43,22 +41,50 @@
     ON s.depth_reference = r.depth_reference
       AND g.location = r.location AND g.validity = r.validity
 WHERE b.bottleneck_id = $1`
+
+	listSurveysByNameDateSQL = `
+SELECT DISTINCT
+	s.bottleneck_id,
+	s.date_info::text,
+	s.depth_reference,
+	COALESCE(g.objname, 'ERROR: MISSING GAUGE') AS gauge_objname,
+	r.value AS waterlevel_value,
+	COALESCE(s.surtyp, 'ERROR: MISSING SURVEY TYPE') AS surtype
+FROM waterway.bottlenecks AS b
+	JOIN waterway.sounding_results AS s ON b.bottleneck_id = s.bottleneck_id
+	LEFT JOIN waterway.gauges AS g
+	  ON b.gauge_location = g.location AND s.date_info::timestamptz <@ g.validity
+	LEFT JOIN waterway.gauges_reference_water_levels AS r
+	  ON s.depth_reference = r.depth_reference
+		AND g.location = r.location AND g.validity = r.validity
+WHERE b.objnam = $1 and s.date_info = $2`
 )
 
 func listSurveys(req *http.Request) (jr mw.JSONResult, err error) {
 
-	bottleneckName := mux.Vars(req)["bottleneck"]
-
+	v := req.URL.Query()
+	bottleneckName := v.Get("name")
+	date := v.Get("date")
+	id := v.Get("id")
 	var rows *sql.Rows
+	surveys := []*models.Survey{}
 
-	rows, err = mw.JSONConn(req).QueryContext(req.Context(), listSurveysSQL, bottleneckName)
+	if date == "" && bottleneckName == "" && id != "" {
+		rows, err = mw.JSONConn(req).QueryContext(req.Context(), listSurveysByIdSQL, id)
+	} else if date != "" && bottleneckName != "" && id == "" {
+		rows, err = mw.JSONConn(req).QueryContext(req.Context(), listSurveysByNameDateSQL, bottleneckName, date)
+	} else {
+		jr = mw.JSONResult{
+			Result: struct {
+				Surveys []*models.Survey `json:"surveys"`
+			}{surveys},
+		}
+		return
+	}
 	if err != nil {
 		return
 	}
 	defer rows.Close()
-
-	surveys := []*models.Survey{}
-
 	// as we do not use the values here, we could simply the code here
 	// to work without an explicit mdels/surverys.go
 	// (like done in controllers/search.go)