Merge pull request #239 from PDOK/properties-in-order

feat(oaf): Add support to return feature properties in a specific order and/or exclude certain properties.
PDOK · Sep 20, 2024 · 5ee54a9 · 5ee54a9
2 parents 618b66b + bba2856
commit 5ee54a9
Show file tree

Hide file tree

Showing 33 changed files with 1,834 additions and 176 deletions.
diff --git a/.github/workflows/lint-go.yml b/.github/workflows/lint-go.yml
@@ -17,7 +17,7 @@ jobs:
 
       - uses: actions/setup-go@v4
         with:
-          go-version: '1.22'
+          go-version: '1.23'
           cache: false
 
       - uses: actions/checkout@v3

diff --git a/.github/workflows/test-go.yml b/.github/workflows/test-go.yml
@@ -19,7 +19,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v4
         with:
-          go-version: '1.22'
+          go-version: '1.23'
 
       - name: Download
         run: go mod download all

diff --git a/.golangci.yaml b/.golangci.yaml
@@ -43,6 +43,9 @@ linters-settings:
     forbid:
       - http\.NotFound.*  # return RFC 7807 problem details instead
       - http\.Error.*  # return RFC 7807 problem details instead
+  gomoddirectives:
+    replace-allow-list:
+      - github.com/wk8/go-ordered-map/v2
 
 linters:
   disable-all: true
@@ -66,7 +69,7 @@ linters:
     - errname  # checks that sentinel errors are prefixed with the Err and error types are suffixed with the Error
     - errorlint  # finds code that will cause problems with the error wrapping scheme introduced in Go 1.13
     - exhaustive  # checks exhaustiveness of enum switch statements
-    - exportloopref  # checks for pointers to enclosing loop variables
+    - copyloopvar  # checks for pointers to enclosing loop variables
     - forbidigo  # forbids identifiers
     - funlen  # tool for detection of long functions
     - gocheckcompilerdirectives  # validates go compiler directive comments (//go:)

diff --git a/Dockerfile b/Dockerfile
@@ -7,7 +7,7 @@ RUN npm install
 RUN npm run build
 
 ####### Go build
-FROM docker.io/golang:1.22-bookworm AS build-env
+FROM docker.io/golang:1.23-bookworm AS build-env
 WORKDIR /go/src/service
 ADD . /go/src/service
 

diff --git a/config/ogcapi_features.go b/config/ogcapi_features.go
@@ -79,6 +79,10 @@ type CollectionEntryFeatures struct {
 	// +optional
 	Filters FeatureFilters `yaml:"filters,omitempty" json:"filters,omitempty"`
 
+	// Optional way to exclude feature properties and/or determine the ordering of properties in the response.
+	// +optional
+	FeatureProperties *FeatureProperties `yaml:",inline" json:",inline"`
+
 	// Downloads available for this collection through map sheets. Note that 'map sheets' refer to a map
 	// divided in rectangle areas that can be downloaded individually.
 	// +optional
@@ -304,6 +308,30 @@ type FeatureFilters struct {
 	// <placeholder>
 }
 
+// +kubebuilder:object:generate=true
+type FeatureProperties struct {
+	// Properties/fields of features in this collection. This setting controls two things:
+	//
+	// A) allows one to exclude certain properties, when propertiesExcludeUnknown=true
+	// B) allows one sort the properties in the given order, when propertiesInSpecificOrder=true
+	//
+	// When not set all available properties are returned in API responses, in alphabetical order.
+	// +optional
+	Properties []string `yaml:"properties,omitempty" json:"properties,omitempty"`
+
+	// When true properties not listed under 'properties' are excluded from API responses. When false
+	// unlisted properties are also included in API responses.
+	// +optional
+	// +kubebuilder:default=false
+	PropertiesExcludeUnknown bool `yaml:"propertiesExcludeUnknown,omitempty" json:"propertiesExcludeUnknown,omitempty" default:"false"`
+
+	// When true properties are returned according to the ordering specified under 'properties'. When false
+	// properties are returned in alphabetical order.
+	// +optional
+	// +kubebuilder:default=false
+	PropertiesInSpecificOrder bool `yaml:"propertiesInSpecificOrder,omitempty" json:"propertiesInSpecificOrder,omitempty" default:"false"`
+}
+
 // +kubebuilder:object:generate=true
 type MapSheetDownloads struct {
 	// Properties that provide the download details per map sheet. Note that 'map sheets' refer to a map

diff --git a/config/zz_generated.deepcopy.go b/config/zz_generated.deepcopy.go
diff --git a/go.mod b/go.mod
@@ -1,6 +1,6 @@
 module github.com/PDOK/gokoala
 
-go 1.22.5
+go 1.23.1
 
 require (
 	dario.cat/mergo v1.0.0
@@ -29,11 +29,14 @@ require (
 	github.com/writeas/go-strip-markdown/v2 v2.1.1
 	go.uber.org/automaxprocs v1.5.3
 	golang.org/x/sync v0.8.0
-	golang.org/x/text v0.17.0
+	golang.org/x/text v0.18.0
 	gopkg.in/yaml.v3 v3.0.1
 	schneider.vip/problem v1.9.1
 )
 
+// required until https://github.com/wk8/go-ordered-map/pull/45 is merged and released
+replace github.com/wk8/go-ordered-map/v2 v2.1.8 => github.com/rkettelerij/go-ordered-map/v2 v2.2.1
+
 require (
 	github.com/bahlo/generic-list-go v0.2.0 // indirect
 	github.com/buger/jsonparser v1.1.1 // indirect

diff --git a/go.sum b/go.sum
@@ -99,6 +99,8 @@ github.com/prashantv/gostub v1.1.0 h1:BTyx3RfQjRHnUWaGF9oQos79AlQ5k8WNktv7VGvVH4
 github.com/prashantv/gostub v1.1.0/go.mod h1:A5zLQHz7ieHGG7is6LLXLz7I8+3LZzsrV0P1IAHhP5U=
 github.com/qustavo/sqlhooks/v2 v2.1.0 h1:54yBemHnGHp/7xgT+pxwmIlMSDNYKx5JW5dfRAiCZi0=
 github.com/qustavo/sqlhooks/v2 v2.1.0/go.mod h1:aMREyKo7fOKTwiLuWPsaHRXEmtqG4yREztO0idF83AU=
+github.com/rkettelerij/go-ordered-map/v2 v2.2.1 h1:U8lzt+530Qk42fMCo5LXIefCTlpWHQYe41VvETj5ebc=
+github.com/rkettelerij/go-ordered-map/v2 v2.2.1/go.mod h1:DbzwytT4g/odXquuOCqroKvtxxldI4nb3nuesHF/Exo=
 github.com/rogpeppe/go-internal v1.12.0 h1:exVL4IDcn6na9z1rAb56Vxr+CgyK3nn3O+epU5NdKM8=
 github.com/rogpeppe/go-internal v1.12.0/go.mod h1:E+RYuTGaKKdloAfM02xzb0FW3Paa99yedzYV+kq4uf4=
 github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk=
@@ -112,8 +114,6 @@ github.com/ugorji/go/codec v1.2.7 h1:YPXUKf7fYbp/y8xloBqZOw2qaVggbfwMlI8WM3wZUJ0
 github.com/ugorji/go/codec v1.2.7/go.mod h1:WGN1fab3R1fzQlVQTkfxVtIBhWDRqOviHU95kRgeqEY=
 github.com/urfave/cli/v2 v2.27.4 h1:o1owoI+02Eb+K107p27wEX9Bb8eqIoZCfLXloLUSWJ8=
 github.com/urfave/cli/v2 v2.27.4/go.mod h1:m4QzxcD2qpra4z7WhzEGn74WZLViBnMpb1ToCAKdGRQ=
-github.com/wk8/go-ordered-map/v2 v2.1.8 h1:5h/BUHu93oj4gIdvHHHGsScSTMijfx5PeYkE/fJgbpc=
-github.com/wk8/go-ordered-map/v2 v2.1.8/go.mod h1:5nJHM5DyteebpVlHnWMV0rPz6Zp7+xBAnxjb1X5vnTw=
 github.com/writeas/go-strip-markdown/v2 v2.1.1 h1:hAxUM21Uhznf/FnbVGiJciqzska6iLei22Ijc3q2e28=
 github.com/writeas/go-strip-markdown/v2 v2.1.1/go.mod h1:UvvgPJgn1vvN8nWuE5e7v/+qmDu3BSVnKAB6Gl7hFzA=
 github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1 h1:gEOO8jv9F4OT7lGCjxCBTO/36wtF6j2nSip77qHd4x4=
@@ -128,8 +128,8 @@ golang.org/x/sync v0.8.0 h1:3NFvSEYkUoMifnESzZl15y791HH1qU2xm6eCJU5ZPXQ=
 golang.org/x/sync v0.8.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
 golang.org/x/sys v0.21.0 h1:rF+pYz3DAGSQAxAu1CbC7catZg4ebC4UIeIhKxBZvws=
 golang.org/x/sys v0.21.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
-golang.org/x/text v0.17.0 h1:XtiM5bkSOt+ewxlOE/aE/AKEHibwj/6gvWMl9Rsh0Qc=
-golang.org/x/text v0.17.0/go.mod h1:BuEKDfySbSR4drPmRPG/7iBdf8hvFMuRexcpahXilzY=
+golang.org/x/text v0.18.0 h1:XvMDiNzPAl0jr17s6W9lcaIhGUfUORdGCNsuLmPG224=
+golang.org/x/text v0.18.0/go.mod h1:BuEKDfySbSR4drPmRPG/7iBdf8hvFMuRexcpahXilzY=
 google.golang.org/genproto/googleapis/rpc v0.0.0-20240521202816-d264139d666e h1:Elxv5MwEkCI9f5SkoL6afed6NTdxaGoAo39eANBwHL8=
 google.golang.org/genproto/googleapis/rpc v0.0.0-20240521202816-d264139d666e/go.mod h1:EfXuqaE1J41VCDicxHzUDm+8rk+7ZdXzHV0IhO/I6s0=
 google.golang.org/grpc v1.64.0 h1:KH3VH9y/MgNQg1dE7b3XfVK0GsPSIzJwdF617gUSbvY=

diff --git a/hack/crd/Dockerfile b/hack/crd/Dockerfile
@@ -1,7 +1,7 @@
-FROM docker.io/golang:1.22-bookworm AS build-env
+FROM docker.io/golang:1.23-bookworm AS build-env
 ADD hack/build-controller-gen.sh /build-controller-gen.sh
 RUN /build-controller-gen.sh
 
-FROM docker.io/golang:1.22-bookworm
+FROM docker.io/golang:1.23-bookworm
 COPY --from=build-env /bin/controller-gen /bin/controller-gen
 ENTRYPOINT ["/bin/controller-gen"]
diff --git a/hack/crd/go.mod b/hack/crd/go.mod
@@ -1,6 +1,6 @@
 module crd
 
-go 1.22.5
+go 1.23.1
 
 require (
 	github.com/PDOK/gokoala v0.0.0
@@ -30,7 +30,7 @@ require (
 	golang.org/x/crypto v0.24.0 // indirect
 	golang.org/x/net v0.26.0 // indirect
 	golang.org/x/sys v0.21.0 // indirect
-	golang.org/x/text v0.17.0 // indirect
+	golang.org/x/text v0.18.0 // indirect
 	gopkg.in/inf.v0 v0.9.1 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect

diff --git a/hack/crd/go.sum b/hack/crd/go.sum
@@ -82,8 +82,8 @@ golang.org/x/sys v0.21.0 h1:rF+pYz3DAGSQAxAu1CbC7catZg4ebC4UIeIhKxBZvws=
 golang.org/x/sys v0.21.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
-golang.org/x/text v0.17.0 h1:XtiM5bkSOt+ewxlOE/aE/AKEHibwj/6gvWMl9Rsh0Qc=
-golang.org/x/text v0.17.0/go.mod h1:BuEKDfySbSR4drPmRPG/7iBdf8hvFMuRexcpahXilzY=
+golang.org/x/text v0.18.0 h1:XvMDiNzPAl0jr17s6W9lcaIhGUfUORdGCNsuLmPG224=
+golang.org/x/text v0.18.0/go.mod h1:BuEKDfySbSR4drPmRPG/7iBdf8hvFMuRexcpahXilzY=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
 golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
 golang.org/x/tools v0.0.0-20200619180055-7c47624df98f/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE=