Skip to content

feat: add order to coder_metadata #450

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

feat: add order to coder_metadata #450

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0153119
feat: add order to coder_metadata
BrunoQuaresma Oct 21, 2025
51a2685
improve description
BrunoQuaresma Oct 21, 2025
9716cd3
replace computed field
BrunoQuaresma Oct 22, 2025
db2d0cb
make gen
BrunoQuaresma Oct 22, 2025
a7da055
fix test
BrunoQuaresma Oct 23, 2025
5e47b1d
handle parse error
BrunoQuaresma Oct 23, 2025
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
6 changes: 6 additions & 0 deletions provider/metadata.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,12 @@ func metadataResource() *schema.Resource {
ForceNew: true,
Computed: true,
},
"order": {
Type: schema.TypeInt,
Description: "The order determines the position of item in the UI presentation. The lowest order is shown first and items with equal order are sorted by key (ascending order).",
ForceNew: true,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm... is ForceNew necessary @johnstcn ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not 100% sure, but it is already used in agent.metadata.order so it may be no harm to be safe and stick to the status quo.

Optional: true,
},
},
},
},
Expand Down
2 changes: 2 additions & 0 deletions provider/metadata_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ func TestMetadata(t *testing.T) {
item {
key = "foo"
value = "bar"
order = 4
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add more test cases?

  1. All items have order present.
  2. Order is negative.
  3. Only a few items have order present

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can have 1 and 3 on the same test. We can just add orders to all the items and leave one empty and check if it is set to 0(the expected default value).

About 2, I don't see we handling that in any other part of the provider for app or agent metadata order, but putting some thoughts on that, I think it should not be a problem since you can still sort things by negative numbers.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

}
item {
key = "secret"
Expand Down Expand Up @@ -66,6 +67,7 @@ func TestMetadata(t *testing.T) {
"item.0.key": "foo",
"item.0.value": "bar",
"item.0.sensitive": "false",
"item.0.order": "4",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BTW this is not enough for metadata items. See the comment on top of this function.

PS. VS code debugger is very handy when dealing with Terraform schema.

"item.1.key": "secret",
"item.1.value": "squirrel",
"item.1.sensitive": "true",
Expand Down
Loading