fix: parse provided payloads before replacing templated variables #449
+269
−24
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -84,16 +84,120 @@ describe("content", () => { | |
| assert.deepEqual(config.content.values, expected); | ||
| }); | ||
|
|
||
| it("templatizes variables requires configuration", async () => { | ||
| mocks.core.getInput.withArgs("payload").returns(`{ | ||
| "message": "this matches an existing variable: \${{ github.apiUrl }}", | ||
| "channel": "C0123456789" | ||
| } | ||
| `); | ||
| const config = new Config(mocks.core); | ||
| const expected = { | ||
| message: "this matches an existing variable: ${{ github.apiUrl }}", | ||
| channel: "C0123456789", | ||
| }; | ||
| assert.deepEqual(config.content.values, expected); | ||
| }); | ||
|
|
||
| it("templatizes variables with matching variables", async () => { | ||
| mocks.core.getInput.withArgs("payload").returns(` | ||
| channel: C0123456789 | ||
| reply_broadcast: false | ||
| message: Served \${{ env.NUMBER }} items | ||
| blocks: | ||
| - type: section | ||
| text: | ||
| type: mrkdwn | ||
| text: "Served \${{ env.NUMBER }} items on: \${{ env.DETAILS }}" | ||
| - type: divider | ||
| - type: section | ||
| block_id: selector | ||
| text: | ||
| type: mrkdwn | ||
| text: Send feedback | ||
| accessory: | ||
| action_id: response | ||
| type: multi_static_select | ||
| placeholder: | ||
| type: plain_text | ||
| text: Select URL | ||
| options: | ||
| - text: | ||
| type: plain_text | ||
| text: "\${{ github.apiUrl }}" | ||
| value: api | ||
| - text: | ||
| type: plain_text | ||
| text: "\${{ github.serverUrl }}" | ||
| value: server | ||
| - text: | ||
| type: plain_text | ||
| text: "\${{ github.graphqlUrl }}" | ||
| value: graphql | ||
| `); | ||
| mocks.core.getBooleanInput.withArgs("payload-templated").returns(true); | ||
| process.env.DETAILS = ` | ||
| -fri | ||
| -sat | ||
| -sun`; | ||
| process.env.NUMBER = 12; | ||
| const config = new Config(mocks.core); | ||
| process.env.DETAILS = undefined; | ||
| process.env.NUMBER = undefined; | ||
| const expected = { | ||
| channel: "C0123456789", | ||
| reply_broadcast: false, | ||
| message: "Served 12 items", | ||
| blocks: [ | ||
| { | ||
| type: "section", | ||
| text: { | ||
| type: "mrkdwn", | ||
| text: "Served 12 items on: \n-fri\n-sat\n-sun", | ||
| }, | ||
| }, | ||
| { | ||
| type: "divider", | ||
| }, | ||
| { | ||
| type: "section", | ||
| block_id: "selector", | ||
| text: { | ||
| type: "mrkdwn", | ||
| text: "Send feedback", | ||
| }, | ||
| accessory: { | ||
| action_id: "response", | ||
| type: "multi_static_select", | ||
| placeholder: { | ||
| type: "plain_text", | ||
| text: "Select URL", | ||
| }, | ||
| options: [ | ||
| { | ||
| text: { | ||
| type: "plain_text", | ||
| text: "https://api.github.com", | ||
| }, | ||
| value: "api", | ||
| }, | ||
| { | ||
| text: { | ||
| type: "plain_text", | ||
| text: "https://github.com", | ||
| }, | ||
| value: "server", | ||
| }, | ||
| { | ||
| text: { | ||
| type: "plain_text", | ||
| text: "https://api.github.com/graphql", | ||
| }, | ||
| value: "graphql", | ||
| }, | ||
| ], | ||
| }, | ||
| }, | ||
| ], | ||
| }; | ||
| assert.deepEqual(config.content.values, expected); | ||
| }); | ||
|
|
@@ -252,19 +356,147 @@ describe("content", () => { | |
| assert.deepEqual(config.content.values, expected); | ||
| }); | ||
|
|
||
| it("templatizes variables requires configuration", async () => { | ||
| mocks.core.getInput.withArgs("payload-file-path").returns("example.json"); | ||
| mocks.fs.readFileSync | ||
| .withArgs(path.resolve("example.json"), "utf-8") | ||
| .returns(`{ | ||
| "message": "this matches an existing variable: \${{ github.apiUrl }}", | ||
| "channel": "C0123456789" | ||
| } | ||
| `); | ||
| const config = new Config(mocks.core); | ||
| const expected = { | ||
| message: "this matches an existing variable: ${{ github.apiUrl }}", | ||
| channel: "C0123456789", | ||
| }; | ||
| assert.deepEqual(config.content.values, expected); | ||
| }); | ||
|
|
||
| it("templatizes variables with matching variables", async () => { | ||
| mocks.core.getInput.withArgs("payload-file-path").returns("example.json"); | ||
| mocks.fs.readFileSync | ||
|
Contributor
There was a problem hiding this comment. These tests are pretty sweet 💯 should we also add a case with But this might be out of scope for this project because these elements mainly appear in interactive components like static multi-selects Example [
{
"type": "section",
"block_id": "section678",
"text": {
"type": "mrkdwn",
"text": "Pick items from the list"
},
"accessory": {
"action_id": "text1234",
"type": "multi_static_select",
"placeholder": {
"type": "plain_text",
"text": "Select items"
},
"options": [
{
"text": {
"type": "plain_text",
"text": "*this is plain_text text*"
},
"value": "value-0"
},
{
"text": {
"type": "plain_text",
"text": "*this is plain_text text*"
},
"value": "value-2"
}
]
}
}
]
Member
Author
There was a problem hiding this comment. @WilliamBergamin This is a fascinating suggestion! 🧠 ✨ Right now we have a I hadn't thought about sending interactive blocks from a GitHub Action but I'm now so curious about how this might connect with the same app listening for events in the workspace otherwise!
Member
Author
There was a problem hiding this comment. A similar example is added in 5c48fcf to confirm the templated replacement behavior 🚀 |
||
| .withArgs(path.resolve("example.json"), "utf-8") | ||
| .returns(`{ | ||
| "channel": "C0123456789", | ||
| "reply_broadcast": false, | ||
| "message": "Served \${{ env.NUMBER }} items", | ||
| "blocks": [ | ||
| { | ||
| "type": "section", | ||
| "text": { | ||
| "type": "mrkdwn", | ||
| "text": "Served \${{ env.NUMBER }} items on: \${{ env.DETAILS }}" | ||
| } | ||
| }, | ||
| { | ||
| "type": "divider" | ||
| }, | ||
| { | ||
| "type": "section", | ||
| "block_id": "selector", | ||
| "text": { | ||
| "type": "mrkdwn", | ||
| "text": "Send feedback" | ||
| }, | ||
| "accessory": { | ||
| "action_id": "response", | ||
| "type": "multi_static_select", | ||
| "placeholder": { | ||
| "type": "plain_text", | ||
| "text": "Select URL" | ||
| }, | ||
| "options": [ | ||
| { | ||
| "text": { | ||
| "type": "plain_text", | ||
| "text": "\${{ github.apiUrl }}" | ||
| }, | ||
| "value": "api" | ||
| }, | ||
| { | ||
| "text": { | ||
| "type": "plain_text", | ||
| "text": "\${{ github.serverUrl }}" | ||
| }, | ||
| "value": "server" | ||
| }, | ||
| { | ||
| "text": { | ||
| "type": "plain_text", | ||
| "text": "\${{ github.graphqlUrl }}" | ||
| }, | ||
| "value": "graphql" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| ] | ||
| }`); | ||
| mocks.core.getBooleanInput.withArgs("payload-templated").returns(true); | ||
| process.env.DETAILS = ` | ||
| -fri | ||
| -sat | ||
| -sun`; | ||
| process.env.NUMBER = 12; | ||
| const config = new Config(mocks.core); | ||
| process.env.DETAILS = undefined; | ||
| process.env.NUMBER = undefined; | ||
| const expected = { | ||
| channel: "C0123456789", | ||
| reply_broadcast: false, | ||
| message: "Served 12 items", | ||
| blocks: [ | ||
| { | ||
| type: "section", | ||
| text: { | ||
| type: "mrkdwn", | ||
| text: "Served 12 items on: \n-fri\n-sat\n-sun", | ||
| }, | ||
| }, | ||
| { | ||
| type: "divider", | ||
| }, | ||
| { | ||
| type: "section", | ||
| block_id: "selector", | ||
| text: { | ||
| type: "mrkdwn", | ||
| text: "Send feedback", | ||
| }, | ||
| accessory: { | ||
| action_id: "response", | ||
| type: "multi_static_select", | ||
| placeholder: { | ||
| type: "plain_text", | ||
| text: "Select URL", | ||
| }, | ||
| options: [ | ||
| { | ||
| text: { | ||
| type: "plain_text", | ||
| text: "https://api.github.com", | ||
| }, | ||
| value: "api", | ||
| }, | ||
| { | ||
| text: { | ||
| type: "plain_text", | ||
| text: "https://github.com", | ||
| }, | ||
| value: "server", | ||
| }, | ||
| { | ||
| text: { | ||
| type: "plain_text", | ||
| text: "https://api.github.com/graphql", | ||
| }, | ||
| value: "graphql", | ||
| }, | ||
| ], | ||
| }, | ||
| }, | ||
| ], | ||
| }; | ||
| assert.deepEqual(config.content.values, expected); | ||
| }); | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sweet 💯 I like the simplified arguments, makes it easier to test 🚀
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@WilliamBergamin Haha I started writing all possible types but also found that testing the actual behavior is more useful here 😉