added functionality to retry (#9)

Author: mehulgohil

README.md

@@ -22,13 +22,19 @@ terraform {
   required_providers {
     curl2 = {
       source = "mehulgohil/curl2"
-      version = "1.3.1"
+      version = "1.4.0"
     }
   }
 }
 
 provider "curl2" {
   #  disable_tls = true
+  #  timeout_ms = 500
+  #  retry {
+  #    retry_attempts = 5
+  #    min_delay_ms = 5
+  #    max_delay_ms = 10
+  #  }
 }
 
 data "curl2" "getPosts" {

curl2/client.go

@@ -2,35 +2,55 @@ package curl2
 
 import (
 	"crypto/tls"
+	"github.com/hashicorp/go-retryablehttp"
+	"github.com/hashicorp/terraform-plugin-framework/types"
 	"net/http"
 	"time"
 )
 
 type ApiClientOpts struct {
-	insecure bool
-	timeout  int64
+	insecure   bool
+	timeout    int64
+	maxRetries int
+	minDelay   types.Int64
+	maxDelay   types.Int64
 }
 
 type HttpClient struct {
-	httpClient *http.Client
+	httpClient *retryablehttp.Client
 }
 
-func NewClient(opts ApiClientOpts) (*HttpClient, error) {
+func NewClient(opts ApiClientOpts) *HttpClient {
+	retryClient := retryablehttp.NewClient()
+	retryClient.RetryMax = opts.maxRetries
+
+	if !opts.minDelay.IsNull() && !opts.minDelay.IsUnknown() && opts.minDelay.ValueInt64() >= 0 {
+		retryClient.RetryWaitMin = time.Duration(opts.minDelay.ValueInt64()) * time.Millisecond
+	}
+
+	if !opts.maxDelay.IsNull() && !opts.maxDelay.IsUnknown() && opts.maxDelay.ValueInt64() >= 0 {
+		retryClient.RetryWaitMax = time.Duration(opts.maxDelay.ValueInt64()) * time.Millisecond
+	}
+
+	standardClient := retryClient.StandardClient()
+
 	tlsConfig := &tls.Config{
 		InsecureSkipVerify: opts.insecure,
 	}
+	standardClient.Transport = &http.Transport{
+		TLSClientConfig: tlsConfig,
+		Proxy:           http.ProxyFromEnvironment,
+	}
 
 	tr := &http.Transport{
 		TLSClientConfig: tlsConfig,
 		Proxy:           http.ProxyFromEnvironment,
 	}
+	standardClient.Transport = tr
 
 	client := HttpClient{
-		httpClient: &http.Client{
-			Timeout:   time.Millisecond * time.Duration(opts.timeout),
-			Transport: tr,
-		},
+		httpClient: retryClient,
 	}
 
-	return &client, nil
+	return &client
 }

curl2/data_source.go

@@ -4,12 +4,12 @@ import (
 	"bytes"
 	"context"
 	"encoding/json"
+	"github.com/hashicorp/go-retryablehttp"
 	"github.com/hashicorp/terraform-plugin-framework/attr"
 	"github.com/hashicorp/terraform-plugin-framework/datasource"
 	"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/types"
 	"io"
-	"net/http"
 )
 
 var (
@@ -125,7 +125,7 @@ func (c *curl2DataSource) Read(ctx context.Context, req datasource.ReadRequest,
 		body = bytes.NewBuffer(requestBody)
 	}
 
-	newReq, err := http.NewRequest(config.HTTPMethod.ValueString(), config.URI.ValueString(), body)
+	newReq, err := retryablehttp.NewRequest(config.HTTPMethod.ValueString(), config.URI.ValueString(), body)
 	if err != nil {
 		resp.Diagnostics.AddError(
 			"Unable to create new http request",

curl2/provider.go

@@ -7,6 +7,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/provider/schema"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/hashicorp/terraform-plugin-framework/types"
+	"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
 	"github.com/hashicorp/terraform-plugin-log/tflog"
 )
 
@@ -22,8 +23,15 @@ type curl2Provider struct{}
 
 // curl2ProviderModel maps provider schema data to a Go type.
 type curl2ProviderModel struct {
-	DisableTLS types.Bool  `tfsdk:"disable_tls"`
-	TimeoutMS  types.Int64 `tfsdk:"timeout_ms"`
+	DisableTLS types.Bool   `tfsdk:"disable_tls"`
+	TimeoutMS  types.Int64  `tfsdk:"timeout_ms"`
+	Retry      types.Object `tfsdk:"retry"`
+}
+
+type retryModel struct {
+	RetryAttempts types.Int64 `tfsdk:"retry_attempts"`
+	MinDelay      types.Int64 `tfsdk:"min_delay_ms"`
+	MaxDelay      types.Int64 `tfsdk:"max_delay_ms"`
 }
 
 func (c *curl2Provider) Metadata(_ context.Context, _ provider.MetadataRequest, resp *provider.MetadataResponse) {
@@ -44,6 +52,25 @@ func (c *curl2Provider) Schema(_ context.Context, _ provider.SchemaRequest, resp
 				Description: "Request Timeout in milliseconds. Defaults to 0, no timeout",
 			},
 		},
+		Blocks: map[string]schema.Block{
+			"retry": schema.SingleNestedBlock{
+				Description: "Retry request configuration. By default there are no retries.",
+				Attributes: map[string]schema.Attribute{
+					"retry_attempts": schema.Int64Attribute{
+						Description: "The number of times the request is to be retried. For example, if 2 is specified, the request will be tried a maximum of 3 times.",
+						Optional:    true,
+					},
+					"min_delay_ms": schema.Int64Attribute{
+						Description: "The minimum delay between retry requests in milliseconds.",
+						Optional:    true,
+					},
+					"max_delay_ms": schema.Int64Attribute{
+						Description: "The maximum delay between retry requests in milliseconds.",
+						Optional:    true,
+					},
+				},
+			},
+		},
 	}
 }
 
@@ -57,18 +84,21 @@ func (c *curl2Provider) Configure(ctx context.Context, req provider.ConfigureReq
 		return
 	}
 
+	var retry retryModel
+
+	if !config.Retry.IsNull() && !config.Retry.IsUnknown() {
+		diags = config.Retry.As(ctx, &retry, basetypes.ObjectAsOptions{})
+		resp.Diagnostics.Append(diags...)
+		if resp.Diagnostics.HasError() {
+			return
+		}
+	}
+
 	opts := ApiClientOpts{
 		insecure: config.DisableTLS.ValueBool(),
 		timeout:  config.TimeoutMS.ValueInt64(),
 	}
-	client, err := NewClient(opts)
-	if err != nil {
-		resp.Diagnostics.AddError(
-			"Unable to Create curl2 client",
-			"Client Error: "+err.Error(),
-		)
-		return
-	}
+	client := NewClient(opts)
 
 	resp.DataSourceData = client
 	resp.ResourceData = client

docs/data-sources/curl2.md

@@ -17,14 +17,19 @@ terraform {
   required_providers {
     curl2 = {
       source = "mehulgohil/curl2"
-      version = "1.3.1"
+      version = "1.4.0"
     }
   }
 }
 
 provider "curl2" {
   #  disable_tls = true
   #  timeout_ms = 500
+  #  retry {
+  #    retry_attempts = 5
+  #    min_delay_ms = 5
+  #    max_delay_ms = 10
+  #  }
 }
 
 data "curl2" "getPosts" {

docs/index.md

@@ -17,14 +17,19 @@ terraform {
   required_providers {
     curl2 = {
       source = "mehulgohil/curl2"
-      version = "1.3.1"
+      version = "1.4.0"
     }
   }
 }
 
 provider "curl2" {
   #  disable_tls = true
   #  timeout_ms = 500
+  #  retry {
+  #    retry_attempts = 5
+  #    min_delay_ms = 5
+  #    max_delay_ms = 10
+  #  }
 }
 
 data "curl2" "getPosts" {
@@ -53,4 +58,14 @@ output "all_posts_status" {
 ### Optional
 
 - `disable_tls` (Boolean) Use to disable the TLS verification. Defaults to false.
+- `retry` (Block, Optional) Retry request configuration. By default there are no retries. (see [below for nested schema](#nestedblock--retry))
 - `timeout_ms` (Number) Request Timeout in milliseconds. Defaults to 0, no timeout
+
+<a id="nestedblock--retry"></a>
+### Nested Schema for `retry`
+
+Optional:
+
+- `max_delay_ms` (Number) The maximum delay between retry requests in milliseconds.
+- `min_delay_ms` (Number) The minimum delay between retry requests in milliseconds.
+- `retry_attempts` (Number) The number of times the request is to be retried. For example, if 2 is specified, the request will be tried a maximum of 3 times.

examples/data-sources/curl2/data-source.tf

@@ -2,14 +2,19 @@ terraform {
   required_providers {
     curl2 = {
       source = "mehulgohil/curl2"
-      version = "1.3.1"
+      version = "1.4.0"
     }
   }
 }
 
 provider "curl2" {
   #  disable_tls = true
   #  timeout_ms = 500
+  #  retry {
+  #    retry_attempts = 5
+  #    min_delay_ms = 5
+  #    max_delay_ms = 10
+  #  }
 }
 
 data "curl2" "getPosts" {

examples/provider/provider.tf

@@ -2,14 +2,19 @@ terraform {
   required_providers {
     curl2 = {
       source = "mehulgohil/curl2"
-      version = "1.3.1"
+      version = "1.4.0"
     }
   }
 }
 
 provider "curl2" {
   #  disable_tls = true
   #  timeout_ms = 500
+  #  retry {
+  #    retry_attempts = 5
+  #    min_delay_ms = 5
+  #    max_delay_ms = 10
+  #  }
 }
 
 data "curl2" "getPosts" {

go.mod

@@ -23,6 +23,7 @@ require (
 	github.com/hashicorp/go-hclog v1.4.0 // indirect
 	github.com/hashicorp/go-multierror v1.1.1 // indirect
 	github.com/hashicorp/go-plugin v1.4.8 // indirect
+	github.com/hashicorp/go-retryablehttp v0.7.2 // indirect
 	github.com/hashicorp/go-uuid v1.0.3 // indirect
 	github.com/hashicorp/go-version v1.6.0 // indirect
 	github.com/hashicorp/hc-install v0.5.0 // indirect

go.sum

@@ -78,13 +78,16 @@ github.com/hashicorp/go-cleanhttp v0.5.0/go.mod h1:JpRdi6/HCYpAwUzNwuwqhbovhLtng
 github.com/hashicorp/go-cleanhttp v0.5.1/go.mod h1:JpRdi6/HCYpAwUzNwuwqhbovhLtngrth3wmdIIUrZ80=
 github.com/hashicorp/go-cleanhttp v0.5.2 h1:035FKYIWjmULyFRBKPs8TBQoi0x6d9G4xc9neXJWAZQ=
 github.com/hashicorp/go-cleanhttp v0.5.2/go.mod h1:kO/YDlP8L1346E6Sodw+PrpBSV4/SoxCXGY6BqNFT48=
+github.com/hashicorp/go-hclog v0.9.2/go.mod h1:5CU+agLiy3J7N7QjHK5d05KxGsuXiQLrjA0H7acj2lQ=
 github.com/hashicorp/go-hclog v1.4.0 h1:ctuWFGrhFha8BnnzxqeRGidlEcQkDyL5u8J8t5eA11I=
 github.com/hashicorp/go-hclog v1.4.0/go.mod h1:W4Qnvbt70Wk/zYJryRzDRU/4r0kIg0PVHBcfoyhpF5M=
 github.com/hashicorp/go-multierror v1.0.0/go.mod h1:dHtQlpGsu+cZNNAkkCN/P3hoUDHhCYQXV3UM06sGGrk=
 github.com/hashicorp/go-multierror v1.1.1 h1:H5DkEtf6CXdFp0N0Em5UCwQpXMWke8IA0+lD48awMYo=
 github.com/hashicorp/go-multierror v1.1.1/go.mod h1:iw975J/qwKPdAO1clOe2L8331t/9/fmwbPZ6JB6eMoM=
 github.com/hashicorp/go-plugin v1.4.8 h1:CHGwpxYDOttQOY7HOWgETU9dyVjOXzniXDqJcYJE1zM=
 github.com/hashicorp/go-plugin v1.4.8/go.mod h1:viDMjcLJuDui6pXb8U4HVfb8AamCWhHGUjr2IrTF67s=
+github.com/hashicorp/go-retryablehttp v0.7.2 h1:AcYqCvkpalPnPF2pn0KamgwamS42TqUDDYFRKq/RAd0=
+github.com/hashicorp/go-retryablehttp v0.7.2/go.mod h1:Jy/gPYAdjqffZ/yFGCFV2doI5wjtH1ewM9u8iYVjtX8=
 github.com/hashicorp/go-uuid v1.0.0/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro=
 github.com/hashicorp/go-uuid v1.0.3 h1:2gKiV6YVmrJ1i2CKKa9obLvRieoRGviZFL26PcT/Co8=
 github.com/hashicorp/go-uuid v1.0.3/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro=