forked from turbot/steampipe-plugin-salesforce
-
Notifications
You must be signed in to change notification settings - Fork 1
/
utils.go
347 lines (306 loc) · 12.9 KB
/
utils.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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
package salesforce
import (
"context"
"encoding/json"
"fmt"
"strings"
"github.com/iancoleman/strcase"
"github.com/simpleforce/simpleforce"
"github.com/turbot/steampipe-plugin-sdk/v5/connection"
"github.com/turbot/steampipe-plugin-sdk/v5/grpc/proto"
"github.com/turbot/steampipe-plugin-sdk/v5/plugin"
"github.com/turbot/steampipe-plugin-sdk/v5/plugin/transform"
)
func connect(ctx context.Context, d *plugin.QueryData) (*simpleforce.Client, error) {
return connectRaw(ctx, d.ConnectionCache, d.Connection)
}
// connect:: returns salesforce client after authentication
func connectRaw(ctx context.Context, cc *connection.ConnectionCache, c *plugin.Connection) (*simpleforce.Client, error) {
// Load connection from cache, which preserves throttling protection etc
cacheKey := "simpleforce"
if cc != nil {
if cachedData, ok := cc.Get(ctx, cacheKey); ok {
return cachedData.(*simpleforce.Client), nil
}
}
config := GetConfig(c)
apiVersion := simpleforce.DefaultAPIVersion
clientID := "steampipe"
securityToken := ""
if config.ClientId != nil {
clientID = *config.ClientId
}
if config.APIVersion != nil {
apiVersion = *config.APIVersion
}
if config.Username == nil {
plugin.Logger(ctx).Warn("salesforce.connectRaw", "'username' must be set in the connection configuration. Edit your connection configuration file and then restart Steampipe")
return nil, nil
}
if config.Password == nil {
plugin.Logger(ctx).Warn("salesforce.connectRaw", "'password' must be set in the connection configuration. Edit your connection configuration file and then restart Steampipe")
return nil, nil
}
// The Salesforce security token is only required If the client's IP address is not added to the organization's list of trusted IPs
// https://help.salesforce.com/s/articleView?id=sf.security_networkaccess.htm&type=5
// https://migration.trujay.com/help/how-to-add-an-ip-address-to-whitelist-on-salesforce/
if config.Token != nil {
securityToken = *config.Token
}
// setup client
client := simpleforce.NewClient(*config.URL, clientID, apiVersion)
if client == nil {
plugin.Logger(ctx).Error("salesforce.connectRaw", "couldn't get salesforce client. Client setup error.")
return nil, fmt.Errorf("salesforce.connectRaw couldn't get salesforce client. Client setup error.")
}
// LoginPassword signs into salesforce using password. token is optional if trusted IP is configured.
// Ref: https://developer.salesforce.com/docs/atlas.en-us.214.0.api_rest.meta/api_rest/intro_understanding_username_password_oauth_flow.htm
// Ref: https://developer.salesforce.com/docs/atlas.en-us.214.0.api.meta/api/sforce_api_calls_login.htm
err := client.LoginPassword(*config.Username, *config.Password, securityToken)
if err != nil {
plugin.Logger(ctx).Error("salesforce.connectRaw", "client login error", err)
return nil, fmt.Errorf("client login error %v", err)
}
// Save to cache
if cc != nil {
err = cc.Set(ctx, cacheKey, client)
if err != nil {
plugin.Logger(ctx).Error("connectRaw", "cache-set", err)
}
}
return client, nil
}
// generateQuery:: returns sql query based on the column names, table name passed
func generateQuery(columns []*plugin.Column, tableName string) string {
var queryColumns []string
for _, column := range columns {
queryColumns = append(queryColumns, getSalesforceColumnName(column.Name))
}
return fmt.Sprintf("SELECT %s FROM %s", strings.Join(queryColumns, ", "), tableName)
}
// decodeQueryResult(ctx, apiResponse, responseStruct):: converts raw apiResponse to required output struct
func decodeQueryResult(ctx context.Context, response interface{}, respObject interface{}) error {
resp, err := json.Marshal(response)
if err != nil {
return err
}
// For debugging purpose - commenting out to avoid unnecessary logs
// plugin.Logger(ctx).Info("decodeQueryResult", "Items", string(resp))
err = json.Unmarshal(resp, respObject)
if err != nil {
return err
}
return nil
}
// buildQueryFromQuals :: generate api_native based on the contions specified in sql query
// refrences
// - https://developer.salesforce.com/docs/atlas.en-us.234.0.soql_sosl.meta/soql_sosl/sforce_api_calls_soql_select_comparisonoperators.htm
func buildQueryFromQuals(equalQuals plugin.KeyColumnQualMap, tableColumns []*plugin.Column, salesforceCols map[string]string) string {
filters := []string{}
for _, filterQualItem := range tableColumns {
filterQual := equalQuals[filterQualItem.Name]
if filterQual == nil {
continue
}
// Check only if filter qual map matches with optional column name
if filterQual.Name == filterQualItem.Name {
if filterQual.Quals == nil {
continue
}
for _, qual := range filterQual.Quals {
if qual.Value != nil {
value := qual.Value
switch filterQualItem.Type {
case proto.ColumnType_STRING:
// In case of IN caluse
if value.GetListValue() != nil {
// continue
switch qual.Operator {
case "=":
stringValueSlice := []string{}
for _, q := range value.GetListValue().Values {
stringValueSlice = append(stringValueSlice, q.GetStringValue())
}
if len(stringValueSlice) > 0 {
filters = append(filters, fmt.Sprintf("%s IN ('%s')", getSalesforceColumnName(filterQualItem.Name), strings.Join(stringValueSlice, "','")))
}
case "<>":
stringValueSlice := []string{}
for _, q := range value.GetListValue().Values {
stringValueSlice = append(stringValueSlice, q.GetStringValue())
}
if len(stringValueSlice) > 0 {
filters = append(filters, fmt.Sprintf("%s NOT IN ('%s')", getSalesforceColumnName(filterQualItem.Name), strings.Join(stringValueSlice, "','")))
}
}
} else {
switch qual.Operator {
case "=":
filters = append(filters, fmt.Sprintf("%s = '%s'", getSalesforceColumnName(filterQualItem.Name), value.GetStringValue()))
case "<>":
filters = append(filters, fmt.Sprintf("%s != '%s'", getSalesforceColumnName(filterQualItem.Name), value.GetStringValue()))
}
}
case proto.ColumnType_BOOL:
switch qual.Operator {
case "<>":
filters = append(filters, fmt.Sprintf("%s = %s", getSalesforceColumnName(filterQualItem.Name), "FALSE"))
case "=":
filters = append(filters, fmt.Sprintf("%s = %s", getSalesforceColumnName(filterQualItem.Name), "TRUE"))
}
case proto.ColumnType_INT:
switch qual.Operator {
case "<>":
filters = append(filters, fmt.Sprintf("%s != %d", getSalesforceColumnName(filterQualItem.Name), value.GetInt64Value()))
default:
filters = append(filters, fmt.Sprintf("%s %s %d", getSalesforceColumnName(filterQualItem.Name), qual.Operator, value.GetInt64Value()))
}
case proto.ColumnType_DOUBLE:
switch qual.Operator {
case "<>":
filters = append(filters, fmt.Sprintf("%s != %f", getSalesforceColumnName(filterQualItem.Name), value.GetDoubleValue()))
default:
filters = append(filters, fmt.Sprintf("%s %s %f", getSalesforceColumnName(filterQualItem.Name), qual.Operator, value.GetDoubleValue()))
}
// Need a way to distinguish b/w date and dateTime fields
case proto.ColumnType_TIMESTAMP:
// https://developer.salesforce.com/docs/atlas.en-us.234.0.soql_sosl.meta/soql_sosl/sforce_api_calls_soql_select_dateformats.htm
if salesforceCols[filterQual.Name] == "date" {
switch qual.Operator {
case "=", ">=", ">", "<=", "<":
filters = append(filters, fmt.Sprintf("%s %s %s", getSalesforceColumnName(filterQualItem.Name), qual.Operator, value.GetTimestampValue().AsTime().Format("2006-01-02")))
}
} else {
switch qual.Operator {
case "=", ">=", ">", "<=", "<":
filters = append(filters, fmt.Sprintf("%s %s %s", getSalesforceColumnName(filterQualItem.Name), qual.Operator, value.GetTimestampValue().AsTime().Format("2006-01-02T15:04:05Z")))
}
}
}
}
}
}
}
if len(filters) > 0 {
return strings.Join(filters, " AND ")
}
return ""
}
func getSalesforceColumnName(name string) string {
var columnName string
// Salesforce custom fields are suffixed with '__c' and are not converted to
// snake case in the table schema, so use the column name as is
if strings.HasSuffix(name, "__c") {
columnName = name
} else {
columnName = strcase.ToCamel(name)
}
return columnName
}
func mergeTableColumns(_ context.Context, config salesforceConfig, dynamicColumns []*plugin.Column, staticColumns []*plugin.Column) []*plugin.Column {
var columns []*plugin.Column
// when NamingConvention is set to api_native, do not add the static columns
if config.NamingConvention != nil && *config.NamingConvention == "api_native" && len(dynamicColumns) > 0 {
columns = append(columns, dynamicColumns...)
return columns
}
columns = append(columns, staticColumns...)
for _, col := range dynamicColumns {
if isColumnAvailable(col.Name, staticColumns) {
continue
}
columns = append(columns, col)
}
return columns
}
// dynamicColumns:: Returns list coulms for a salesforce object
func dynamicColumns(ctx context.Context, client *simpleforce.Client, salesforceTableName string, config salesforceConfig) ([]*plugin.Column, plugin.KeyColumnSlice, map[string]string) {
sObjectMeta := client.SObject(salesforceTableName).Describe()
if sObjectMeta == nil {
plugin.Logger(ctx).Error("salesforce.dynamicColumns", fmt.Sprintf("Table %s not present in salesforce", salesforceTableName))
return []*plugin.Column{}, plugin.KeyColumnSlice{}, map[string]string{}
}
// Top columns
cols := []*plugin.Column{}
salesforceCols := map[string]string{}
// Key columns
keyColumns := plugin.KeyColumnSlice{}
salesforceObjectMetadata := *sObjectMeta
salesforceObjectMetadataAsByte, err := json.Marshal(salesforceObjectMetadata["fields"])
if err != nil {
plugin.Logger(ctx).Error("salesforce.dynamicColumns", "json marshal error %v", err)
}
salesforceObjectFields := []map[string]interface{}{}
// var queryColumns []string
err = json.Unmarshal(salesforceObjectMetadataAsByte, &salesforceObjectFields)
if err != nil {
plugin.Logger(ctx).Error("salesforce.dynamicColumns", "json unmarshal error %v", err)
}
for _, fields := range salesforceObjectFields {
if fields["name"] == nil {
continue
}
fieldName := fields["name"].(string)
compoundFieldName := fields["compoundFieldName"]
if compoundFieldName != nil && compoundFieldName.(string) != fieldName {
continue
}
if fields["soapType"] == nil {
continue
}
soapType := strings.Split((fields["soapType"]).(string), ":")
fieldType := soapType[len(soapType)-1]
// Column dynamic generation
// Don't convert to snake case since field names can have underscores in
// them, so it's impossible to convert from snake case back to camel case
// to match the original field name. Also, if we convert to snake case,
// custom fields like "TestField" and "Test_Field" will result in duplicates
// check if DynamicTableAndPropertyNames is true
var columnFieldName string
// keep the field name as it is if NamingConvention is set to api_native
if config.NamingConvention != nil && *config.NamingConvention == "api_native" {
columnFieldName = fieldName
} else if strings.HasSuffix(fieldName, "__c") {
columnFieldName = strings.ToLower(fieldName)
} else {
columnFieldName = strcase.ToSnake(fieldName)
}
column := plugin.Column{
Name: columnFieldName,
Description: fmt.Sprintf("%s.", fields["label"].(string)),
Transform: transform.FromP(getFieldFromSObjectMap, fieldName),
}
salesforceCols[columnFieldName] = fieldType
// Set column type based on the `soapType` from salesforce schema
switch fieldType {
case "string", "ID":
column.Type = proto.ColumnType_STRING
keyColumns = append(keyColumns, &plugin.KeyColumn{Name: columnFieldName, Require: plugin.Optional, Operators: []string{"=", "<>"}})
case "date", "dateTime":
column.Type = proto.ColumnType_TIMESTAMP
keyColumns = append(keyColumns, &plugin.KeyColumn{Name: columnFieldName, Require: plugin.Optional, Operators: []string{"=", ">", ">=", "<=", "<"}})
case "boolean":
column.Type = proto.ColumnType_BOOL
keyColumns = append(keyColumns, &plugin.KeyColumn{Name: columnFieldName, Require: plugin.Optional, Operators: []string{"=", "<>"}})
case "double":
column.Type = proto.ColumnType_DOUBLE
keyColumns = append(keyColumns, &plugin.KeyColumn{Name: columnFieldName, Require: plugin.Optional, Operators: []string{"=", ">", ">=", "<=", "<"}})
case "int":
column.Type = proto.ColumnType_INT
keyColumns = append(keyColumns, &plugin.KeyColumn{Name: columnFieldName, Require: plugin.Optional, Operators: []string{"=", ">", ">=", "<=", "<"}})
default:
column.Type = proto.ColumnType_JSON
}
cols = append(cols, &column)
}
return cols, keyColumns, salesforceCols
}
// isColumnAvailable:: Checks if the column is not present in the existing columns slice
func isColumnAvailable(columnName string, columns []*plugin.Column) bool {
for _, col := range columns {
if col.Name == columnName {
return true
}
}
return false
}