Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add apply_auto_limit to ExecQueryJSONInput #236

Merged
merged 1 commit into from
Jan 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions query.go
Original file line number Diff line number Diff line change
Expand Up @@ -304,13 +304,15 @@ func (client *Client) GetQueryResults(ctx context.Context, id int, ext string, o

type ExecQueryJSONInput struct {
Parameters map[string]any `json:"parameters,omitempty"`
ApplyAutoLimit bool `json:"apply_auto_limit,omitempty"`
MaxAge int `json:"max_age,omitempty"`
WithoutOmittingMaxAge bool `json:"-"`
}

type execQueryJSONInputWithMaxAge struct {
Parameters map[string]any `json:"parameters,omitempty"`
MaxAge int `json:"max_age"`
Parameters map[string]any `json:"parameters,omitempty"`
ApplyAutoLimit bool `json:"apply_auto_limit,omitempty"`
MaxAge int `json:"max_age"`
}

func (client *Client) ExecQueryJSON(ctx context.Context, id int, input *ExecQueryJSONInput, out io.Writer) (*JobResponse, error) {
Expand All @@ -322,8 +324,9 @@ func (client *Client) ExecQueryJSON(ctx context.Context, id int, input *ExecQuer

if input != nil && input.WithoutOmittingMaxAge {
body = &execQueryJSONInputWithMaxAge{
Parameters: input.Parameters,
MaxAge: input.MaxAge,
Parameters: input.Parameters,
ApplyAutoLimit: input.ApplyAutoLimit,
MaxAge: input.MaxAge,
}
}

Expand Down
76 changes: 74 additions & 2 deletions query_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1380,7 +1380,7 @@ func Test_ExecQueryJSON_OK_WithParams(t *testing.T) {
)
require.NotNil(req.Body)
body, _ := io.ReadAll(req.Body)
assert.Equal(`{"parameters":{"date_param":"2020-01-01","date_range_param":{"end":"2020-12-31","start":"2020-01-01"},"number_param":100},"max_age":1800}`, string(body))
assert.Equal(`{"parameters":{"date_param":"2020-01-01","date_range_param":{"end":"2020-12-31","start":"2020-01-01"},"number_param":100},"apply_auto_limit":true,"max_age":1800}`, string(body))
return httpmock.NewStringResponse(http.StatusOK, `{"foo":"bar"}`), nil
})

Expand All @@ -1395,7 +1395,50 @@ func Test_ExecQueryJSON_OK_WithParams(t *testing.T) {
"end": "2020-12-31",
},
},
MaxAge: 1800,
ApplyAutoLimit: true,
MaxAge: 1800,
}, &buf)
assert.NoError(err)
assert.Equal(`{"foo":"bar"}`, buf.String())
assert.Empty(jobId)
}

func Test_ExecQueryJSON_OK_WithMaxAgeZero(t *testing.T) {
assert := assert.New(t)
require := require.New(t)
httpmock.Activate()
defer httpmock.DeactivateAndReset()

httpmock.RegisterResponder(http.MethodPost, "https://redash.example.com/api/queries/1/results", func(req *http.Request) (*http.Response, error) {
assert.Equal(
http.Header(
http.Header{
"Authorization": []string{"Key " + testRedashAPIKey},
"Content-Type": []string{"application/json"},
"User-Agent": []string{"redash-go"},
},
),
req.Header,
)
require.NotNil(req.Body)
body, _ := io.ReadAll(req.Body)
assert.Equal(`{"parameters":{"date_param":"2020-01-01","date_range_param":{"end":"2020-12-31","start":"2020-01-01"},"number_param":100},"apply_auto_limit":true,"max_age":0}`, string(body))
return httpmock.NewStringResponse(http.StatusOK, `{"foo":"bar"}`), nil
})

client, _ := redash.NewClient("https://redash.example.com", testRedashAPIKey)
var buf bytes.Buffer
jobId, err := client.ExecQueryJSON(context.Background(), 1, &redash.ExecQueryJSONInput{
Parameters: map[string]any{
"number_param": 100,
"date_param": "2020-01-01",
"date_range_param": map[string]string{
"start": "2020-01-01",
"end": "2020-12-31",
},
},
ApplyAutoLimit: true,
WithoutOmittingMaxAge: true,
}, &buf)
assert.NoError(err)
assert.Equal(`{"foo":"bar"}`, buf.String())
Expand Down Expand Up @@ -2885,6 +2928,35 @@ func Test_Query_WithParams_Acc(t *testing.T) {
}

assert.Contains(buf.String(), `"query": "select 999"`)

buf = bytes.Buffer{}
input = &redash.ExecQueryJSONInput{
Parameters: map[string]any{
"num": 999,
},
ApplyAutoLimit: true,
MaxAge: 1800,
}
job, err = client.ExecQueryJSON(context.Background(), query.ID, input, &buf)
require.NoError(err)

if job != nil && job.Job.ID != "" {
for {
job, err := client.GetJob(context.Background(), job.Job.ID)
require.NoError(err)

if job.Job.Status != redash.JobStatusPending && job.Job.Status != redash.JobStatusStarted {
assert.Equal(redash.JobStatusSuccess, job.Job.Status)
_, err := client.ExecQueryJSON(context.Background(), query.ID, input, &buf)
require.NoError(err)
break
}

time.Sleep(1 * time.Second)
}
}

assert.Contains(buf.String(), `"query": "select 999 LIMIT 1000"`)
}

func Test_Query_IgnoreCache_Acc(t *testing.T) {
Expand Down
Loading