-
Notifications
You must be signed in to change notification settings - Fork 0
/
managed.go
289 lines (250 loc) · 8.89 KB
/
managed.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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
package solr
import (
"bytes"
"context"
"encoding/json"
"fmt"
"net/http"
"net/url"
"strings"
"time"
)
// ManagedResponse represents the response from solr's managed resources API.
// Header and Error (if there is any) will always be populated. The rest
// are helpers on specific cases. Currently supported cases are when
// requesting for a list of all managed resources, and for
// a managed synonyms list.
type ManagedResponse struct {
Header *ResponseHeader `json:"responseHeader"`
Error *ResponseError `json:"error"`
Resources []*ManagedResource `json:"managedResources"`
Synonyms *SynonymMappings `json:"synonymMappings"`
RawMap map[string]interface{}
}
// UnmarshalJSON implements the unmarshaler interface
func (r *ManagedResponse) UnmarshalJSON(b []byte) error {
var m map[string]interface{}
err := json.Unmarshal(b, &m)
if err != nil {
return err
}
r.RawMap = m
headInf, ok := m["responseHeader"]
if ok {
headBytes, err := interfaceToBytes(headInf)
if err != nil {
return err
}
var h ResponseHeader
err = json.Unmarshal(headBytes, &h)
if err != nil {
return err
}
r.Header = &h
}
errInf, ok := m["error"]
if ok {
errBytes, err := interfaceToBytes(errInf)
if err != nil {
return err
}
var e ResponseError
err = json.Unmarshal(errBytes, &e)
if err != nil {
return err
}
r.Error = &e
}
resInfArr, ok := m["managedResources"]
if ok {
var resourceMap []*ManagedResource
resArr, ok := resInfArr.([]interface{})
if ok {
for _, resInf := range resArr {
var resource ManagedResource
resBytes, err := interfaceToBytes(resInf)
if err != nil {
return err
}
err = json.Unmarshal(resBytes, &resource)
if err != nil {
return err
}
resourceMap = append(resourceMap, &resource)
}
}
r.Resources = resourceMap
}
synInf, ok := m["synonymMappings"]
if ok {
synBytes, err := interfaceToBytes(synInf)
if err != nil {
return err
}
var syn SynonymMappings
err = json.Unmarshal(synBytes, &syn)
if err != nil {
return err
}
r.Synonyms = &syn
}
return nil
}
// ManagedResource represents a managed resource in solr.
type ManagedResource struct {
ID string `json:"resourceId"`
Class string `json:"class"`
ObserversNumber string `json:"numObservers"`
}
// SynonymMappings is a helper struct for navigating a synonyms managed list.
type SynonymMappings struct {
InitArgs *SynonymInitArgs `json:"initArgs"`
InitOn time.Time `json:"initializedOn"`
UpdatedOn time.Time `json:"updatedSinceInit"`
ManagedMap map[string][]string `json:"managedMap"`
}
// SynonymInitArgs are the initialization arguments for a synonyms
// managed list.
type SynonymInitArgs struct {
IgnoreCase bool `json:"ignoreCase"`
}
// ManagedAPI contains a connection to solr
type ManagedAPI struct {
conn *Connection
BasePath string
}
// NewManagedAPI returns a new Managed Resources API, creating a connection to solr using the provided
// http client, host and core info.
// https://lucene.apache.org/solr/guide/8_5/managed-resources.html#managed-resources-overview
func NewManagedAPI(ctx context.Context, host, core string, client *http.Client) (*ManagedAPI, error) {
if host == "" || core == "" {
return nil, ErrInvalidConfig
}
_, err := url.ParseRequestURI(host)
if err != nil {
return nil, err
}
conn := &Connection{
Host: host,
Core: core,
httpClient: client,
}
path := fmt.Sprintf("%s/schema", formatBasePath(host, core))
return &ManagedAPI{conn: conn, BasePath: path}, nil
}
// SetBasicAuth sets the authentication credentials if needed.
func (m *ManagedAPI) SetBasicAuth(username, password string) {
m.conn.Username = username
m.conn.Password = password
}
func (m *ManagedAPI) request(ctx context.Context, method, url string, body []byte) (*ManagedResponse, error) {
req, err := http.NewRequest(method, url, bytes.NewBuffer(body))
if err != nil {
return nil, err
}
req.Header.Add("Content-Type", "application/json")
if m.conn.Username != "" && m.conn.Password != "" {
req.SetBasicAuth(m.conn.Username, m.conn.Password)
}
res, err := m.conn.httpClient.Do(req.WithContext(ctx))
if err != nil {
return nil, err
}
var r ManagedResponse
defer res.Body.Close()
err = json.NewDecoder(res.Body).Decode(&r)
if err != nil {
return nil, err
}
if r.Error != nil {
return &r, r.Error
}
return &r, nil
}
func (m *ManagedAPI) formatURL(path string) string {
if strings.HasPrefix(path, "/") {
return m.BasePath + path
}
return m.BasePath + "/" + path
}
// RetrieveResource returns the specified resource. Requires the path to the resource.
func (m *ManagedAPI) RetrieveResource(ctx context.Context, path string) (*ManagedResponse, error) {
return m.request(ctx, http.MethodGet, m.formatURL(path), nil)
}
// UpsertResource updates the specified resource. Requires the path to the resource and
// the resource to be created/updated
func (m *ManagedAPI) UpsertResource(ctx context.Context, path string, data interface{}) (*ManagedResponse, error) {
bodyBytes, err := interfaceToBytes(data)
if err != nil {
return nil, err
}
return m.request(ctx, http.MethodPut, m.formatURL(path), bodyBytes)
}
// DeleteResource deletes the specified resource. Requires the path to the resource.
func (m *ManagedAPI) DeleteResource(ctx context.Context, path string) (*ManagedResponse, error) {
return m.request(ctx, http.MethodDelete, m.formatURL(path), nil)
}
// SetInitArgs set the initialization arguments for a managed resource. It requires the path to the managed
// resource and a map of the init arguments to update. Attention must be given to make sure that the
// arguments provided are valid init arguments, since solr doesn't check the validity during update
// but only during core reload.
func (m *ManagedAPI) SetInitArgs(ctx context.Context, path string, args map[string]interface{}) (*ManagedResponse, error) {
body := map[string]map[string]interface{}{"initArgs": args}
return m.UpsertResource(ctx, path, body)
}
// RestManager returns all available managed resources on the solr core.
func (m *ManagedAPI) RestManager(ctx context.Context) (*ManagedResponse, error) {
url := m.BasePath + "/managed"
return m.request(ctx, http.MethodGet, url, nil)
}
// SynonymSetIgnoreCase set the desired value to the ignoreCase initialization argument for
// managed synonym resources.
func (m *ManagedAPI) SynonymSetIgnoreCase(ctx context.Context, listName string, value bool) (*ManagedResponse, error) {
path := "/analysis/synonyms/" + listName
ign := map[string]interface{}{"ignoreCase": value}
return m.SetInitArgs(ctx, path, ign)
}
// SynonymList returns a map of all the synonyms in the specified list.
func (m *ManagedAPI) SynonymList(ctx context.Context, listName string) (*ManagedResponse, error) {
path := "/analysis/synonyms/" + listName
return m.RetrieveResource(ctx, path)
}
// SynonymGet returns the synonym mapping for the specified word in the specified list.
func (m *ManagedAPI) SynonymGet(ctx context.Context, listName string, synonym string) (*ManagedResponse, error) {
path := fmt.Sprintf("/analysis/synonyms/%s/%s", listName, synonym)
return m.RetrieveResource(ctx, path)
}
// SynonymAdd adds a new synonym mapping in the specified list.
func (m *ManagedAPI) SynonymAdd(ctx context.Context, listName string, synonyms map[string][]string) (*ManagedResponse, error) {
path := "/analysis/synonyms/" + listName
return m.UpsertResource(ctx, path, synonyms)
}
// SynonymAddSymmetric adds a list of symmetric synonyms. These are expanded into a mapping
// for each term in the list by solr. Despite what is said in the solr docs tho, currently
// (v.8.6.1) adding a synonym slice this way does not seem to remove the word for the
// mapping, ending up having a word being a synonym of itself. SynonymAddOptimal
// is therefore recommended for this purpose.
func (m *ManagedAPI) SynonymAddSymmetric(ctx context.Context, listName string, synonyms []string) (*ManagedResponse, error) {
path := "/analysis/synonyms/" + listName
return m.UpsertResource(ctx, path, synonyms)
}
// SynonymAddOptimal creates a mapping for each word in the given slice, just as
// solr should be doing under the hood in AddSymmetric. The conversion from
// slice to array of maps is here handled by golang.
func (m *ManagedAPI) SynonymAddOptimal(ctx context.Context, listName string, synonyms []string) (*ManagedResponse, error) {
path := "/analysis/synonyms/" + listName
body := map[string][]string{}
for i, s := range synonyms {
rest := make([]string, len(synonyms))
copy(rest, synonyms)
rest[i] = rest[len(rest)-1]
rest = rest[:len(rest)-1]
body[s] = rest
}
return m.UpsertResource(ctx, path, body)
}
// SynonymDelete removes the specified mapping from the specified synonyms list.
func (m *ManagedAPI) SynonymDelete(ctx context.Context, listName string, synonym string) (*ManagedResponse, error) {
path := fmt.Sprintf("/analysis/synonyms/%s/%s", listName, synonym)
return m.DeleteResource(ctx, path)
}