forked from dapr/components-contrib
-
Notifications
You must be signed in to change notification settings - Fork 0
/
sqlite_metadata.go
137 lines (115 loc) · 4.43 KB
/
sqlite_metadata.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
/*
Copyright 2023 The Dapr Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package sqlite
import (
"errors"
"fmt"
"strconv"
"time"
"github.com/dapr/components-contrib/metadata"
"github.com/dapr/components-contrib/state"
)
const (
defaultTableName = "state"
defaultMetadataTableName = "metadata"
defaultCleanupInternal = time.Duration(0) // Disabled by default
defaultTimeout = 20 * time.Second // Default timeout for database requests, in seconds
defaultBusyTimeout = 2 * time.Second
errMissingConnectionString = "missing connection string"
errInvalidIdentifier = "invalid identifier: %s" // specify identifier type, e.g. "table name"
)
type sqliteMetadataStruct struct {
ConnectionString string `json:"connectionString" mapstructure:"connectionString"`
TableName string `json:"tableName" mapstructure:"tableName"`
MetadataTableName string `json:"metadataTableName" mapstructure:"metadataTableName"`
TimeoutInSeconds string `json:"timeoutInSeconds" mapstructure:"timeoutInSeconds"`
CleanupInterval time.Duration `json:"cleanupInterval" mapstructure:"cleanupInterval"`
BusyTimeout time.Duration `json:"busyTimeout" mapstructure:"busyTimeout"`
DisableWAL bool `json:"disableWAL" mapstructure:"disableWAL"` // Disable WAL journaling. You should not use WAL if the database is stored on a network filesystem (or data corruption may happen). This is ignored if the database is in-memory.
// Deprecated properties, maintained for backwards-compatibility
CleanupIntervalInSeconds string `json:"cleanupIntervalInSeconds" mapstructure:"cleanupIntervalInSeconds"`
// Internal properties
timeout time.Duration
}
func (m *sqliteMetadataStruct) InitWithMetadata(meta state.Metadata) error {
m.reset()
// Decode the metadata
err := metadata.DecodeMetadata(meta.Properties, &m)
if err != nil {
return err
}
// Validate and sanitize input
if m.ConnectionString == "" {
return errors.New(errMissingConnectionString)
}
if !validIdentifier(m.TableName) {
return fmt.Errorf(errInvalidIdentifier, m.TableName)
}
// Timeout
if m.TimeoutInSeconds != "" {
timeoutInSec, err := strconv.ParseInt(m.TimeoutInSeconds, 10, 0)
if err != nil {
return fmt.Errorf("invalid value for 'timeoutInSeconds': %s", m.TimeoutInSeconds)
}
if timeoutInSec < 1 {
return errors.New("invalid value for 'timeoutInSeconds': must be greater than 0")
}
m.timeout = time.Duration(timeoutInSec) * time.Second
}
// Legacy "CleanupIntervalInSeconds" property
// Non-positive duration means never clean up expired data
if v := meta.Properties["cleanupInterval"]; v == "" && m.CleanupIntervalInSeconds != "" {
cleanupIntervalInSec, err := strconv.ParseInt(m.CleanupIntervalInSeconds, 10, 0)
if err != nil {
return fmt.Errorf("invalid value for 'cleanupIntervalInSeconds': %s", m.CleanupIntervalInSeconds)
}
// Non-positive value from meta means disable auto cleanup.
if cleanupIntervalInSec > 0 {
m.CleanupInterval = time.Duration(cleanupIntervalInSec) * time.Second
}
}
// Busy timeout
// Truncate values to milliseconds. Values <= 0 do not set any timeout
m.BusyTimeout = m.BusyTimeout.Truncate(time.Millisecond)
return nil
}
// Reset the object
func (m *sqliteMetadataStruct) reset() {
m.ConnectionString = ""
m.TableName = defaultTableName
m.MetadataTableName = defaultMetadataTableName
m.TimeoutInSeconds = ""
m.CleanupInterval = defaultCleanupInternal
m.BusyTimeout = defaultBusyTimeout
m.DisableWAL = false
m.CleanupIntervalInSeconds = ""
m.timeout = defaultTimeout
}
// Validates an identifier, such as table or DB name.
func validIdentifier(v string) bool {
if v == "" {
return false
}
// Loop through the string as byte slice as we only care about ASCII characters
b := []byte(v)
for i := 0; i < len(b); i++ {
if (b[i] >= '0' && b[i] <= '9') ||
(b[i] >= 'a' && b[i] <= 'z') ||
(b[i] >= 'A' && b[i] <= 'Z') ||
b[i] == '_' {
continue
}
return false
}
return true
}