Implement GSP-111 Add System Metadata in Storage Metadata (#605)

beyondstorage · Jun 23, 2021 · 271aed5 · 271aed5
1 parent cb9b688
commit 271aed5
Show file tree

Hide file tree

Showing 6 changed files with 70 additions and 8 deletions.
diff --git a/cmd/definitions/bindata.go b/cmd/definitions/bindata.go
diff --git a/cmd/definitions/tests/service.toml b/cmd/definitions/tests/service.toml
@@ -72,6 +72,10 @@ description = "set storage features"
 type = "string"
 description = "is the storage class for this object"
 
+[infos.storage.meta.queries-per-second]
+type = "int64"
+description = "tests storage system metadata"
+
 [pairs.size]
 type = "int64"
 description = "tests pair conflict"

diff --git a/cmd/definitions/tmpl/service.tmpl b/cmd/definitions/tmpl/service.tmpl
@@ -24,6 +24,7 @@ const Type = "{{ .Name }}"
 // ObjectMetadata stores service metadata for object.
 type ObjectMetadata struct {
 {{- range $_, $v := .Infos }}
+    {{- if eq $v.Scope "object" }}
     {{- if not $v.Global }}
     {{- $pname := $v.Name | toPascal }}
     {{- if $v.DisplayName }}
@@ -32,6 +33,7 @@ type ObjectMetadata struct {
     {{ $v.Description }}
     {{ $pname }} {{ $v.Type }}
     {{- end }}
+    {{- end }}
 {{- end }}
 }
 
@@ -54,6 +56,40 @@ func setObjectMetadata(o *Object, om ObjectMetadata) {
     o.SetServiceMetadata(om)
 }
 
+// StorageSystemMetadata stores system metadata for storage meta.
+type StorageSystemMetadata struct {
+{{- range $_, $v := .Infos }}
+    {{- if eq $v.Scope "storage" }}
+        {{- if not $v.Global }}
+            {{- $pname := $v.Name | toPascal }}
+            {{- if $v.DisplayName }}
+                {{- $pname = $v.DisplayName }}
+            {{- end }}
+            {{ $v.Description }}
+            {{ $pname }} {{ $v.Type }}
+        {{- end }}
+    {{- end }}
+{{- end }}
+}
+
+// GetStorageSystemMetadata will get SystemMetadata from StorageMeta.
+//
+// - The returning StorageSystemMetadata is read only and should not be modified.
+func GetStorageSystemMetadata(s *StorageMeta) StorageSystemMetadata {
+    sm, ok := s.GetSystemMetadata()
+    if ok {
+        return sm.(StorageSystemMetadata)
+    }
+    return StorageSystemMetadata{}
+}
+
+// setStorageSystemMetadata will set SystemMetadata into StorageMeta.
+//
+// - This function should only be called once, please make sure all data has been written before set.
+func setStorageSystemMetadata(s *StorageMeta, sm StorageSystemMetadata) {
+    s.SetSystemMetadata(sm)
+}
+
 {{- range $_, $v := .Pairs }}
 {{- if not $v.Global }}
 {{- $pname := $v.Name | toPascal }}

diff --git a/go.mod b/go.mod
@@ -4,7 +4,7 @@ go 1.15
 
 require (
 	github.com/Xuanwo/templateutils v0.1.0
-	github.com/beyondstorage/specs/go v0.0.0-20210621052257-46d075c8cee3
+	github.com/beyondstorage/specs/go v0.0.0-20210623021521-09a4bf58fdb3
 	github.com/dave/dst v0.26.2
 	github.com/golang/mock v1.5.0
 	github.com/google/uuid v1.2.0

diff --git a/go.sum b/go.sum
@@ -1,7 +1,7 @@
 github.com/Xuanwo/templateutils v0.1.0 h1:WpkWOqQtIQ2vAIpJLa727DdN8WtxhUkkbDGa6UhntJY=
 github.com/Xuanwo/templateutils v0.1.0/go.mod h1:OdE0DJ+CJxDBq6psX5DPV+gOZi8bhuHuVUpPCG++Wb8=
-github.com/beyondstorage/specs/go v0.0.0-20210621052257-46d075c8cee3 h1:ZEite7O0btU34rKsnKptOJ5DyCgMs5hOqpA0H1+kidU=
-github.com/beyondstorage/specs/go v0.0.0-20210621052257-46d075c8cee3/go.mod h1:vF/Q0P1tCvhVAUrxg7i6NvrARRMQVTAuQdDNqpSzR1w=
+github.com/beyondstorage/specs/go v0.0.0-20210623021521-09a4bf58fdb3 h1:xQr2klNnWs/cCsBjfGhq1dAPNLLZcdODRAiD2sn/zsU=
+github.com/beyondstorage/specs/go v0.0.0-20210623021521-09a4bf58fdb3/go.mod h1:vF/Q0P1tCvhVAUrxg7i6NvrARRMQVTAuQdDNqpSzR1w=
 github.com/dave/dst v0.26.2 h1:lnxLAKI3tx7MgLNVDirFCsDTlTG9nKTk7GcptKcWSwY=
 github.com/dave/dst v0.26.2/go.mod h1:UMDJuIRPfyUCC78eFuB+SV/WI8oDeyFDvM/JR6NI3IU=
 github.com/dave/gopackages v0.0.0-20170318123100-46e7023ec56e/go.mod h1:i00+b/gKdIDIxuLDFob7ustLAVqhsZRk2qVZrArELGQ=

diff --git a/types/info.generated.go b/types/info.generated.go