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.

Sign up for GitHub

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

fix: doc attribute inconsistencies #101

Merged
merged 2 commits into from
Jan 19, 2024
Merged

fix: doc attribute inconsistencies #101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7aa0c16
build(deps): bump github.com/cloudflare/circl from 1.3.3 to 1.3.7
dependabot[bot] Jan 8, 2024
1a5b522
fix: doc attribute inconsistencies
joshbeard Jan 16, 2024
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
1 change: 0 additions & 1 deletion readme/doc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,6 @@ func getDoc(

parent, apiResponse, err := client.Doc.Get(IDPrefix+state.ParentDoc.ValueString(), options)
if err != nil {
// failing here
return state, apiResponse, errors.New(clientError(err, apiResponse))
}
state.ParentDocSlug = types.StringValue(parent.Slug)
Expand Down
172 changes: 116 additions & 56 deletions readme/doc_resource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,13 @@ import (
"reflect"
"strings"

"github.com/hashicorp/terraform-plugin-framework/attr"
"github.com/hashicorp/terraform-plugin-framework/path"
"github.com/hashicorp/terraform-plugin-framework/resource"
"github.com/hashicorp/terraform-plugin-framework/resource/schema"
"github.com/hashicorp/terraform-plugin-framework/resource/schema/booldefault"
"github.com/hashicorp/terraform-plugin-framework/resource/schema/boolplanmodifier"
"github.com/hashicorp/terraform-plugin-framework/resource/schema/int64planmodifier"
"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier"
"github.com/hashicorp/terraform-plugin-framework/schema/validator"
Expand All @@ -18,7 +21,6 @@ import (

"github.com/liveoaklabs/readme-api-go-client/readme"
"github.com/liveoaklabs/terraform-provider-readme/readme/frontmatter"
"github.com/liveoaklabs/terraform-provider-readme/readme/otherattributemodifier"
)

// Ensure the implementation satisfies the expected interfaces.
Expand Down Expand Up @@ -112,10 +114,80 @@ func (r docResource) ValidateConfig(
}
}

func (r *docResource) ModifyPlan(
ctx context.Context,
req resource.ModifyPlanRequest,
resp *resource.ModifyPlanResponse,
) {
plan := &docModel{}
resp.Diagnostics.Append(req.Plan.Get(ctx, &plan)...)

state := &docModel{}
resp.Diagnostics.Append(req.State.Get(ctx, &state)...)

if resp.Diagnostics.HasError() || plan == nil {
return
}

if state == nil {
plan.BodyClean = types.StringUnknown()
plan.BodyHTML = types.StringUnknown()
plan.Revision = types.Int64Unknown()
plan.UpdatedAt = types.StringUnknown()
plan.User = types.StringUnknown()
diags := resp.Plan.Set(ctx, plan)
resp.Diagnostics.Append(diags...)

return
}

body := strings.TrimSpace(plan.Body.ValueString())

// Expand newline escape sequences.
body = strings.ReplaceAll(body, `\n`, "\n")
plan.BodyClean = types.StringValue(body)

diags := resp.Plan.Set(ctx, plan)
resp.Diagnostics.Append(diags...)

// The 'algolia', 'revision', 'updated_at', and 'user' attributes are
// volatile and may show changes in the post-apply diff. If other
// attributes are changed, set these attributes to unknown to trigger a
// refresh.
if !state.BodyClean.Equal(plan.BodyClean) ||
!state.BodyHTML.Equal(plan.BodyHTML) ||
!state.Category.Equal(plan.Category) ||
!state.CategorySlug.Equal(plan.CategorySlug) ||
!state.Hidden.Equal(plan.Hidden) ||
!state.Order.Equal(plan.Order) ||
!state.ParentDoc.Equal(plan.ParentDoc) ||
!state.ParentDocSlug.Equal(plan.ParentDocSlug) ||
!state.Slug.Equal(plan.Slug) ||
!state.Title.Equal(plan.Title) ||
!state.Type.Equal(plan.Type) {

plan.Revision = types.Int64Unknown()
plan.UpdatedAt = types.StringUnknown()
plan.User = types.StringUnknown()

plan.Algolia = types.ObjectUnknown(
map[string]attr.Type{
"record_count": types.Int64Type,
"publish_pending": types.BoolType,
"updated_at": types.StringType,
},
)

}

diags = resp.Plan.Set(ctx, plan)
resp.Diagnostics.Append(diags...)
}

// docPlanToParams maps plan attributes to a `readme.DocParams` struct to create or update a doc.
func docPlanToParams(ctx context.Context, plan docModel) readme.DocParams {
params := readme.DocParams{
Body: strings.TrimSpace(plan.Body.ValueString()),
Body: plan.Body.ValueString(),
Hidden: plan.Hidden.ValueBoolPointer(),
Order: intPoint(int(plan.Order.ValueInt64())),
Title: plan.Title.ValueString(),
Expand Down Expand Up @@ -199,11 +271,18 @@ func (r *docResource) Create(
if err != nil {
resp.Diagnostics.AddError(
"Unable to create doc.",
fmt.Sprintf(
"There was a problem retrieving the doc '%s' after creation: %s.",
doc.Slug,
err.Error(),
),
fmt.Sprintf("There was a problem retrieving the doc '%s' after creation: %s.", doc.Slug, err.Error()),
)

return
}

// Get the doc a second time to ensure the state is fully populated.
state, _, err = getDoc(r.client, ctx, doc.Slug, state, requestOpts)
if err != nil {
resp.Diagnostics.AddError(
"Unable to create doc.",
fmt.Sprintf("There was a problem retrieving the doc '%s' after creation: %s.", doc.Slug, err.Error()),
)

return
Expand Down Expand Up @@ -375,6 +454,21 @@ func (r *docResource) Update(
return
}

// Get the doc a second time to ensure the state is fully populated.
plan, _, err = getDoc(r.client, ctx, response.Slug, plan, requestOpts)
if err != nil {
resp.Diagnostics.AddError(
"Unable to update doc.",
fmt.Sprintf(
"There was a problem retrieving the doc '%s' after update: %s.",
response.Slug,
err.Error(),
),
)

return
}

// Set refreshed state.
resp.Diagnostics.Append(resp.State.Set(ctx, plan)...)
if resp.Diagnostics.HasError() {
Expand Down Expand Up @@ -479,29 +573,18 @@ func (r *docResource) Schema(
Attributes: map[string]schema.Attribute{
"record_count": schema.Int64Attribute{
Computed: true,
PlanModifiers: []planmodifier.Int64{
int64planmodifier.UseStateForUnknown(),
},
},
"publish_pending": schema.BoolAttribute{
Computed: true,
PlanModifiers: []planmodifier.Bool{
boolplanmodifier.UseStateForUnknown(),
},
},
"updated_at": schema.StringAttribute{
Computed: true,
PlanModifiers: []planmodifier.String{
otherattributemodifier.StringModifyString(path.Root("body"), "Body", true),
otherattributemodifier.StringModifyString(path.Root("body_html"), "BodyHTML", true),
otherattributemodifier.StringModifyString(path.Root("category"), "Category", true),
otherattributemodifier.StringModifyString(path.Root("category_slug"), "CategorySlug", true),
otherattributemodifier.BoolModifyString(path.Root("hidden"), "Hidden", true),
otherattributemodifier.Int64ModifyString(path.Root("order"), "Order", true),
otherattributemodifier.StringModifyString(path.Root("parent_doc"), "ParentDoc", true),
otherattributemodifier.StringModifyString(
path.Root("parent_doc_slug"),
"ParentDocSlug",
true,
),
otherattributemodifier.StringModifyString(path.Root("slug"), "Slug", true),
otherattributemodifier.StringModifyString(path.Root("title"), "Title", true),
otherattributemodifier.StringModifyString(path.Root("type"), "Type", true),
},
},
},
},
Expand Down Expand Up @@ -683,10 +766,16 @@ func (r *docResource) Schema(
"is_api": schema.BoolAttribute{
Description: "Identifies if a doc is an API doc or not.",
Computed: true,
PlanModifiers: []planmodifier.Bool{
boolplanmodifier.UseStateForUnknown(),
},
},
"is_reference": schema.BoolAttribute{
Description: "Identifies if a doc is a reference doc or not.",
Computed: true,
PlanModifiers: []planmodifier.Bool{
boolplanmodifier.UseStateForUnknown(),
},
},
"link_external": schema.BoolAttribute{
Description: "Identifies a doc's link as external or not.",
Expand Down Expand Up @@ -789,23 +878,13 @@ func (r *docResource) Schema(
"project": schema.StringAttribute{
Description: "The ID of the project the doc is in.",
Computed: true,
PlanModifiers: []planmodifier.String{
stringplanmodifier.UseStateForUnknown(),
},
},
"revision": schema.Int64Attribute{
Description: "A number that is incremented upon doc updates.",
Computed: true,
PlanModifiers: []planmodifier.Int64{
otherattributemodifier.StringModifyInt64(path.Root("body"), "Body", true),
otherattributemodifier.StringModifyInt64(path.Root("body_html"), "BodyHTML", true),
otherattributemodifier.StringModifyInt64(path.Root("category"), "Category", true),
otherattributemodifier.StringModifyInt64(path.Root("category_slug"), "CategorySlug", true),
otherattributemodifier.BoolModifyInt64(path.Root("hidden"), "Hidden", true),
otherattributemodifier.Int64ModifyInt64(path.Root("order"), "Order", true),
otherattributemodifier.StringModifyInt64(path.Root("parent_doc"), "ParentDoc", true),
otherattributemodifier.StringModifyInt64(path.Root("parent_doc_slug"), "ParentDocSlug", true),
otherattributemodifier.StringModifyInt64(path.Root("slug"), "Slug", true),
otherattributemodifier.StringModifyInt64(path.Root("title"), "Title", true),
otherattributemodifier.StringModifyInt64(path.Root("type"), "Type", true),
},
},
"slug": schema.StringAttribute{
Description: "The slug of the doc.",
Expand Down Expand Up @@ -841,29 +920,10 @@ func (r *docResource) Schema(
"updated_at": schema.StringAttribute{
Description: "The timestamp of when the doc was last updated.",
Computed: true,
PlanModifiers: []planmodifier.String{
otherattributemodifier.StringModifyString(path.Root("body"), "Body", true),
otherattributemodifier.StringModifyString(path.Root("body_html"), "BodyHTML", true),
otherattributemodifier.StringModifyString(path.Root("category"), "Category", true),
otherattributemodifier.StringModifyString(path.Root("category_slug"), "CategorySlug", true),
otherattributemodifier.BoolModifyString(path.Root("hidden"), "Hidden", true),
otherattributemodifier.Int64ModifyString(path.Root("order"), "Order", true),
otherattributemodifier.StringModifyString(path.Root("parent_doc"), "ParentDoc", true),
otherattributemodifier.StringModifyString(path.Root("parent_doc_slug"), "ParentDocSlug", true),
otherattributemodifier.StringModifyString(path.Root("slug"), "Slug", true),
otherattributemodifier.StringModifyString(path.Root("title"), "Title", true),
otherattributemodifier.StringModifyString(path.Root("type"), "Type", true),
},
},
"user": schema.StringAttribute{
Description: "The ID of the author of the doc in the web editor.",
Computed: true,
PlanModifiers: []planmodifier.String{
// The user attribute is volatile and may show changes in
// the post-apply diff. This effectively triggers it to
// refresh whenever the document is updated.
otherattributemodifier.StringModifyString(path.Root("updated_at"), "UpdatedAt", true),
},
},
"use_slug": schema.StringAttribute{
Description: "**Use with caution!** Create the doc resource by importing an existing doc by its slug. " +
Expand Down
Loading
Loading