Merge pull request #5884 from WowVeryLogin/denis/FLPROD-1586

Get cloudflare_snippet resource working

Author: musa-cf

docs/resources/snippet.md

@@ -0,0 +1,58 @@
+---
+page_title: "cloudflare_snippet Resource - Cloudflare"
+subcategory: ""
+description: |-
+  
+---
+
+# cloudflare_snippet (Resource)
+
+
+
+## Example Usage
+
+```terraform
+resource "cloudflare_snippet" "example_snippet" {
+  zone_id = "9f1839b6152d298aca64c4e906b6d074"
+  snippet_name = "my_snippet"
+  files = [
+    {
+      name    = "main.js"
+      content = <<-EOT
+      export default {
+        async fetch(request) {
+          return new Response('Hello, World!');
+        }
+      }
+      EOT
+    }
+  ]
+  metadata = {
+    main_module = "main.js"
+  }
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `files` (List of String) The list of files belonging to the snippet.
+- `metadata` (Attributes) Metadata about the snippet. (see [below for nested schema](#nestedatt--metadata))
+- `snippet_name` (String) The identifying name of the snippet.
+- `zone_id` (String) The unique ID of the zone.
+
+### Read-Only
+
+- `created_on` (String) The timestamp of when the snippet was created.
+- `modified_on` (String) The timestamp of when the snippet was last modified.
+
+<a id="nestedatt--metadata"></a>
+### Nested Schema for `metadata`
+
+Required:
+
+- `main_module` (String) Name of the file that contains the main module of the snippet.
+
+

examples/resources/cloudflare_snippet/resource.tf

@@ -1,7 +1,18 @@
 resource "cloudflare_snippet" "example_snippet" {
-  zone_id = "9f1839b6152d298aca64c4e906b6d074"
+  zone_id      = "9f1839b6152d298aca64c4e906b6d074"
   snippet_name = "my_snippet"
-  files = [null]
+  files = [
+    {
+      name    = "main.js"
+      content = <<-EOT
+      export default {
+        async fetch(request) {
+          return new Response('Hello, World!');
+        }
+      }
+      EOT
+    }
+  ]
   metadata = {
     main_module = "main.js"
   }

internal/apiform/encoder.go

@@ -326,6 +326,10 @@ func (e *encoder) newStructTypeEncoder(t reflect.Type) encoderFunc {
 			if ptag.name == "-" {
 				continue
 			}
+			// Computed fields come from the server
+			if ptag.computed && !ptag.forceEncode {
+				continue
+			}
 
 			dateFormat, ok := parseFormatStructTag(field)
 			oldFormat := e.dateFormat

internal/apiform/tag.go

@@ -11,9 +11,13 @@ const formatStructTag = "format"
 
 type parsedStructTag struct {
 	name     string
-	required bool
 	extras   bool
-	metadata bool
+	computed bool
+	// Don't skip this value, even if it's computed (no-op for computed optional fields)
+	// If encodeStateForUnknown is set on a computed field, this flag should also be set;
+	// otherwise this flag will have no effect
+	// NOTE: won't work if update behavior is 'patch'
+	forceEncode bool
 }
 
 func parseFormStructTag(field reflect.StructField) (tag parsedStructTag, ok bool) {
@@ -31,12 +35,12 @@ func parseFormStructTag(field reflect.StructField) (tag parsedStructTag, ok bool
 	tag.name = parts[0]
 	for _, part := range parts[1:] {
 		switch part {
-		case "required":
-			tag.required = true
 		case "extras":
 			tag.extras = true
-		case "metadata":
-			tag.metadata = true
+		case "computed":
+			tag.computed = true
+		case "force_encode":
+			tag.forceEncode = true
 		}
 	}
 	return

internal/services/snippet/model.go

@@ -4,21 +4,39 @@ package snippet
 
 import (
 	"bytes"
+	"context"
+	"fmt"
+	"io"
+	"mime"
 	"mime/multipart"
+	"strings"
 
 	"github.com/cloudflare/terraform-provider-cloudflare/internal/apiform"
 	"github.com/hashicorp/terraform-plugin-framework-timetypes/timetypes"
+	"github.com/hashicorp/terraform-plugin-framework/attr"
+	"github.com/hashicorp/terraform-plugin-framework/diag"
 	"github.com/hashicorp/terraform-plugin-framework/types"
+	"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
+	"github.com/hashicorp/terraform-plugin-go/tftypes"
 )
 
 type SnippetResultEnvelope struct {
 	Result SnippetModel `json:"result"`
 }
 
+var SnippetFileType = snippetFileType{
+	ObjectType: types.ObjectType{
+		AttrTypes: map[string]attr.Type{
+			"name":    types.StringType,
+			"content": types.StringType,
+		},
+	},
+}
+
 type SnippetModel struct {
 	SnippetName types.String          `tfsdk:"snippet_name" path:"snippet_name,required"`
 	ZoneID      types.String          `tfsdk:"zone_id" path:"zone_id,required"`
-	Files       *[]types.String       `tfsdk:"files" json:"files,required,no_refresh"`
+	Files       *[]SnippetFile        `tfsdk:"files" json:"files,metadata,required"`
 	Metadata    *SnippetMetadataModel `tfsdk:"metadata" json:"metadata,required,no_refresh"`
 	CreatedOn   timetypes.RFC3339     `tfsdk:"created_on" json:"created_on,computed" format:"date-time"`
 	ModifiedOn  timetypes.RFC3339     `tfsdk:"modified_on" json:"modified_on,computed" format:"date-time"`
@@ -42,3 +60,130 @@ func (r SnippetModel) MarshalMultipart() (data []byte, contentType string, err e
 type SnippetMetadataModel struct {
 	MainModule types.String `tfsdk:"main_module" json:"main_module,required"`
 }
+
+func (r *SnippetModel) UnmarshalMultipart(data []byte, contentType string) error {
+	mediaType, params, err := mime.ParseMediaType(contentType)
+	if err != nil {
+		return fmt.Errorf("failed to parse media type: %w", err)
+	}
+	if mediaType != "multipart/form-data" {
+		return fmt.Errorf("expected media type %q, got %q", "multipart/form-data", mediaType)
+	}
+	reader := multipart.NewReader(bytes.NewReader(data), params["boundary"])
+	var files []SnippetFile
+	for {
+		part, err := reader.NextPart()
+		if err == io.EOF {
+			break
+		}
+		if err != nil {
+			return fmt.Errorf("failed to get multipart part: %w", err)
+		}
+		if part.FormName() == "files" {
+			bytes, err := io.ReadAll(part)
+			if err != nil {
+				return fmt.Errorf("failed to read multipart part: %w", err)
+			}
+			files = append(files, NewSnippetsFileValueMust(
+				part.FileName(),
+				string(bytes),
+			))
+		}
+	}
+	r.Files = &files
+	return nil
+}
+
+type snippetFileType struct {
+	types.ObjectType
+}
+
+func (t snippetFileType) Equal(other attr.Type) bool {
+	_, ok := other.(snippetFileType)
+
+	return ok
+}
+
+func (t snippetFileType) String() string {
+	return "SnippetsFileContentType"
+}
+
+func (t snippetFileType) ValueFromTerraform(
+	ctx context.Context,
+	in tftypes.Value,
+) (attr.Value, error) {
+	val, err := t.ObjectType.ValueFromTerraform(ctx, in)
+	if err != nil {
+		return nil, err
+	}
+
+	obj, ok := val.(types.Object)
+	if !ok {
+		return nil, fmt.Errorf("unexpected value type of %T", val)
+	}
+
+	return SnippetFile{obj, new(int64)}, nil
+}
+
+func (t snippetFileType) ValueType(_ context.Context) attr.Value {
+	return SnippetFile{}
+}
+
+func (t snippetFileType) ValueFromObject(
+	_ context.Context,
+	obj basetypes.ObjectValue,
+) (basetypes.ObjectValuable, diag.Diagnostics) {
+	return SnippetFile{obj, new(int64)}, nil
+}
+
+type SnippetFile struct {
+	types.Object
+	offset *int64
+}
+
+func NewSnippetsFileValueMust(name string, content string) SnippetFile {
+	return SnippetFile{types.ObjectValueMust(
+		SnippetFileType.AttrTypes,
+		map[string]attr.Value{
+			"name":    types.StringValue(name),
+			"content": types.StringValue(content),
+		},
+	), new(int64)}
+}
+
+func (f SnippetFile) Type(_ context.Context) attr.Type {
+	return SnippetFileType
+}
+
+func (f SnippetFile) Equal(other attr.Value) bool {
+	o, ok := other.(SnippetFile)
+	if !ok {
+		return false
+	}
+
+	return f.Object.Equal(o.Object)
+}
+
+func (f SnippetFile) Name() string {
+	return f.Object.Attributes()["name"].(types.String).ValueString()
+}
+
+func (f SnippetFile) ContentType() string {
+	return "application/javascript+module"
+}
+
+func (f SnippetFile) Read(p []byte) (n int, err error) {
+	content := f.Object.Attributes()["content"].(types.String).ValueString()
+
+	reader := strings.NewReader(content)
+
+	if _, err := reader.Seek(*f.offset, io.SeekStart); err != nil {
+		return 0, err
+	}
+
+	n, err = reader.Read(p)
+
+	*f.offset += int64(n)
+
+	return n, err
+}

internal/services/snippet/resource.go

@@ -14,6 +14,7 @@ import (
 	"github.com/cloudflare/terraform-provider-cloudflare/internal/apijson"
 	"github.com/cloudflare/terraform-provider-cloudflare/internal/logging"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
+	"github.com/hashicorp/terraform-plugin-framework/types"
 )
 
 // Ensure provider defined types fully satisfy framework interfaces.
@@ -179,6 +180,33 @@ func (r *SnippetResource) Read(ctx context.Context, req resource.ReadRequest, re
 	}
 	data = &env.Result
 
+	res = new(http.Response)
+	_, err = r.client.Snippets.Content.Get(
+		ctx,
+		data.SnippetName.ValueString(),
+		snippets.ContentGetParams{
+			ZoneID: cloudflare.F(data.ZoneID.ValueString()),
+		},
+		option.WithResponseBodyInto(&res),
+		option.WithMiddleware(logging.Middleware(ctx)),
+	)
+	if res != nil && res.StatusCode == 404 {
+		resp.Diagnostics.AddWarning("Resource not found", "The resource was not found on the server and will be removed from state.")
+		resp.State.RemoveResource(ctx)
+		return
+	}
+	if err != nil {
+		resp.Diagnostics.AddError("failed to make http request", err.Error())
+		return
+	}
+	data.Metadata.MainModule = types.StringValue(res.Header.Get("Cf-Entrypoint"))
+	bytes, _ = io.ReadAll(res.Body)
+	err = data.UnmarshalMultipart(bytes, res.Header.Get("Content-Type"))
+	if err != nil {
+		resp.Diagnostics.AddError("failed to deserialize http request", err.Error())
+		return
+	}
+
 	resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
 }