-
Notifications
You must be signed in to change notification settings - Fork 22
/
admin_import_network.go
169 lines (139 loc) · 4.36 KB
/
admin_import_network.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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
package api
import (
"context"
"errors"
"fmt"
"regexp"
"strings"
vgfs "code.vegaprotocol.io/vega/libs/fs"
"code.vegaprotocol.io/vega/libs/jsonrpc"
"code.vegaprotocol.io/vega/paths"
"code.vegaprotocol.io/vega/wallet/network"
"github.com/mitchellh/mapstructure"
)
var (
ErrInvalidNetworkSource = errors.New("invalid network source")
githubToml = regexp.MustCompile(`(http[s]?://)(github\.com).*(.toml)$`)
)
type AdminImportNetworkParams struct {
Name string `json:"name"`
URL string `json:"url"`
Overwrite bool `json:"overwrite"`
}
type AdminImportNetworkResult struct {
Name string `json:"name"`
}
type AdminImportNetwork struct {
networkStore NetworkStore
}
type Reader func(uri string, net interface{}) error
type Readers struct {
ReadFromFile Reader
ReadFromURL Reader
}
func NewReaders() Readers {
return Readers{
ReadFromFile: paths.ReadStructuredFile,
ReadFromURL: paths.FetchStructuredFile,
}
}
func (h *AdminImportNetwork) Handle(_ context.Context, rawParams jsonrpc.Params) (jsonrpc.Result, *jsonrpc.ErrorDetails) {
params, err := validateImportNetworkParams(rawParams)
if err != nil {
return nil, invalidParams(err)
}
net, err := readImportNetworkSource(params)
if errors.Is(err, ErrInvalidNetworkSource) {
return nil, invalidParams(err)
}
if err != nil {
return nil, internalError(err)
}
if len(params.Name) != 0 {
net.Name = params.Name
}
if len(net.Name) == 0 {
return nil, invalidParams(ErrNetworkNameIsRequired)
}
if exist, err := h.networkStore.NetworkExists(net.Name); err != nil {
return nil, internalError(fmt.Errorf("could not verify the network existence: %w", err))
} else if exist && !params.Overwrite {
return nil, invalidParams(ErrNetworkAlreadyExists)
}
if err := h.networkStore.SaveNetwork(net); err != nil {
return nil, internalError(err)
}
return AdminImportNetworkResult{
Name: net.Name,
}, nil
}
// urlPreCheck looks for basic user errors in the given URL. For example if a github
// URL is supplied instead of a link to the raw-file-contents.
func urlPreCheck(url string) error {
m := githubToml.FindString(url)
if len(m) == 0 {
return nil
}
// make a suggestion
suggestion := strings.Replace(url, "github.com", "raw.githubusercontent.com", 1)
suggestion = strings.Replace(suggestion, "/blob/", "/", 1)
return fmt.Errorf("this URL leads to a Github page and not the network configuration, did you mean %s", suggestion)
}
func validateImportNetworkParams(rawParams jsonrpc.Params) (AdminImportNetworkParams, error) {
if rawParams == nil {
return AdminImportNetworkParams{}, ErrParamsRequired
}
params := AdminImportNetworkParams{}
if err := mapstructure.Decode(rawParams, ¶ms); err != nil {
return AdminImportNetworkParams{}, ErrParamsDoNotMatch
}
if params.URL == "" {
return AdminImportNetworkParams{}, ErrNetworkSourceIsRequired
}
if err := urlPreCheck(params.URL); err != nil {
return AdminImportNetworkParams{}, err
}
return params, nil
}
// readImportNetworkSource parse the network file given by the source in the params
// into a `Network` which can then be saved to disk.
func readImportNetworkSource(params AdminImportNetworkParams) (*network.Network, error) {
net := &network.Network{}
rs := NewReaders()
s, filePath, isFile := strings.Cut(params.URL, FileSchemePrefix)
if isFile && len(s) == 0 {
exists, err := vgfs.FileExists(filePath)
if err != nil {
return nil, fmt.Errorf("could not check file's existence at %q: %w", filePath, err)
}
if !exists {
return nil, fmt.Errorf("the network source file does not exist: %w", ErrInvalidNetworkSource)
}
err = rs.ReadFromFile(filePath, net)
if err == paths.ErrEmptyFile {
return nil, fmt.Errorf("network source file is empty: %w", ErrInvalidNetworkSource)
}
if err != nil {
return nil, fmt.Errorf("could not read the network configuration at %q: %w", filePath, err)
}
return net, nil
}
if len(params.URL) != 0 {
err := rs.ReadFromURL(params.URL, net)
if err == paths.ErrEmptyResponse {
return nil, fmt.Errorf("network source url points to an empty file: %w", ErrInvalidNetworkSource)
}
if err != nil {
return nil, fmt.Errorf("could not fetch the network configuration from %q: %w", params.URL, err)
}
return net, nil
}
return net, nil
}
func NewAdminImportNetwork(
networkStore NetworkStore,
) *AdminImportNetwork {
return &AdminImportNetwork{
networkStore: networkStore,
}
}