`azurerm_signalr_service`: Expose `upstream_endpoint` #10459

jackbatzner · 2021-02-03T22:34:41Z

Upgrade signalr package to use 2020-05-01

katbyte · 2021-02-04T05:54:19Z

@Brunhil - could you fix up the build errors so we can run the tests and get this merged? thanks!

jackbatzner · 2021-02-04T11:42:14Z

Thanks for taking a peek @katbyte ! I was planning on this PR to have the library upgrade for SignalR and the new resource. Did you want me to pull out the library upgrade into a separate PR?

jackbatzner · 2021-02-10T04:06:00Z

Test is failing with the following,

=== RUN   TestAccSignalRService_upstreamSetting
=== PAUSE TestAccSignalRService_upstreamSetting
=== CONT  TestAccSignalRService_upstreamSetting
    testing.go:684: Step 0 error: Check failed: Check 6/18 error: azurerm_signalr_service.test: Attribute 'upstream_setting.0.url_template' not found
--- FAIL: TestAccSignalRService_upstreamSetting (253.89s)
FAIL
FAIL    github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/services/signalr     255.518s
FAIL

GNUmakefile

jackbatzner · 2021-02-10T05:29:32Z

Test is failing with the following,

=== RUN   TestAccSignalRService_upstreamSetting
=== PAUSE TestAccSignalRService_upstreamSetting
=== CONT  TestAccSignalRService_upstreamSetting
    testing.go:684: Step 0 error: Check failed: Check 6/18 error: azurerm_signalr_service.test: Attribute 'upstream_setting.0.url_template' not found
--- FAIL: TestAccSignalRService_upstreamSetting (253.89s)
FAIL
FAIL    github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/services/signalr     255.518s
FAIL

Turns out the response we get back isn't always in the order that we submit it. Going to drop the acceptance tests assertion to just verify we have four entries.

Test now passes and should be good for review!

=== RUN TestAccSignalRService_upstreamSetting
=== PAUSE TestAccSignalRService_upstreamSetting
=== CONT TestAccSignalRService_upstreamSetting
--- PASS: TestAccSignalRService_upstreamSetting (402.53s)
PASS
ok github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/services/signalr 404.288s

katbyte

Thanks @Brunhil - have some questions about schema but once those are addressed this should be good to merge

azurerm/internal/services/signalr/signalr_service_resource.go

website/docs/r/signalr_service.html.markdown

katbyte · 2021-02-11T03:28:46Z

website/docs/r/signalr_service.html.markdown

@@ -55,6 +62,8 @@ The following arguments are supported:

 * `features` - (Optional) A `features` block as documented below.

+* `upstream_setting` - (Optional) An `upstream_setting` block as documented below. Using this block requires the SignalR service to be Serverless.


could we add a check for this?

katbyte · 2021-02-11T03:30:07Z

azurerm/internal/services/signalr/signalr_service_resource.go

@@ -271,6 +301,10 @@ func resourceArmSignalRServiceRead(d *schema.ResourceData, meta interface{}) err
 		if err := d.Set("cors", flattenSignalRCors(properties.Cors)); err != nil {
 			return fmt.Errorf("Error setting `cors`: %+v", err)
 		}
+
+		if err := d.Set("upstream_setting", flattenUpstreamSettings(properties.Upstream)); err != nil {


could we check and throw an error if the service is serverless?

katbyte · 2021-02-11T03:30:55Z

website/docs/r/signalr_service.html.markdown

@@ -73,6 +82,18 @@ A `features` block supports the following:

 ---

+An `upstream_setting` block supports the following:
+
+* `url_template` - (Required) The upstream URL Template. Possible values are `EnableConnectivityLogs`, `EnableMessagingLogs`, and `ServiceMode`.


Is this wrong?

Also is url_template the best name for this

katbyte · 2021-02-11T03:31:50Z

website/docs/r/signalr_service.html.markdown

@@ -73,6 +82,18 @@ A `features` block supports the following:

 ---

+An `upstream_setting` block supports the following:


i think think we can remove setting here.

This block seems to match things, so maybe

Suggested change

An `upstream_setting` block supports the following:

An `upstream_match` block supports the following:

or match upstream?

Based off my reading of Azure's documentation around this feature I'm not convinced either of our options are best.

Upstream is a preview feature that allows Azure SignalR Service to send messages and connection events to a set of endpoints in serverless mode. You can use upstream to invoke a hub method from clients in serverless mode and let endpoints get notified when client connections are connected or disconnected.

Based off my experience with SignalR in the past I'd imagine this is a "forwarding" mechanism for SignalR service events (clients connected, disconnected, message sent, etc.).

I am thinking that upstream or upstream_endpoint would better represent the intended functionality. I'm leaning towards upstream_endpoint, thoughts?

upstream endpoint makes sense to me 🙂

katbyte · 2021-02-11T03:34:58Z

website/docs/r/signalr_service.html.markdown

+* `category_pattern` - (Optional) The matching pattern for category names. Possible values are `*`, multiple categories separated by commas `,`, and single categories. Ex: `connections,messages`, `*`, and `connections`.
+
+* `event_pattern` - (Optional) The matching pattern for event names.  Possible values are `*`, multiple events separated by commas `,`, and single events. Ex: `connect,disconnect`, `*`, and `connect`.
+
+* `hub_pattern` - (Optional) The matching mattern for hub names.  Possible values are `*`, multiple hubs separated by commas `,`, and single hubs. Ex: `hub1,hub1`, `*`, `hub1`.


pattern doesn't really make sense as its really just lists, so could we make these lists instead of strings and join them in code?

Suggested change

* `category_pattern` - (Optional) The matching pattern for category names. Possible values are `*`, multiple categories separated by commas `,`, and single categories. Ex: `connections,messages`, `*`, and `connections`.

* `event_pattern` - (Optional) The matching pattern for event names. Possible values are `*`, multiple events separated by commas `,`, and single events. Ex: `connect,disconnect`, `*`, and `connect`.

* `hub_pattern` - (Optional) The matching mattern for hub names. Possible values are `*`, multiple hubs separated by commas `,`, and single hubs. Ex: `hub1,hub1`, `*`, `hub1`.

* `categories` - (Optional) The categories to match on, or `*` for all.

* `events` - (Optional) The events to match on, or `*` for all.

* `hubs` - (Optional) The hubs to match on, or `*` for all.

and then use would be

upstream_setting { category_pattern = ["connections", "messages"] event_pattern = ["*"] hub_pattern = ["hub1"] url_template = "http://foo.com" // if this is just any url, the template can be removed?

url_template can just be a URL or a template. See the Azure documentation,

These predefined parameters can be used in the URL pattern. Parameters will be replaced with a specified value when you're evaluating the upstream URL.

For example: http://host.com/{hub}/api/{category}/{event}

When a client connection in the "chat" hub is connected, a message will be sent to this URL: http://host.com/chat/api/connections/connected

Or, if you provide category, event, or hub patterns those will be substituted in the respective places.

that makes sense to me!

jackbatzner · 2021-02-12T04:12:32Z

I covered most of your comments @katbyte . One I didn't was around validating the input. Given the type changed from a string to a list we can't validate that anymore (based on my knowledge). Let me know your thoughts!

Latest changes still pass,

=== RUN TestAccSignalRService_upstreamSetting
=== PAUSE TestAccSignalRService_upstreamSetting
=== CONT TestAccSignalRService_upstreamSetting
--- PASS: TestAccSignalRService_upstreamSetting (394.25s)
PASS
ok github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/services/signalr 396.188s

katbyte · 2021-02-12T06:11:39Z

unless an empty entry makes sense lets throw a NoEmptyStrings vlaidation on them

jackofallops · 2021-02-19T07:29:26Z

Tests passing:

dismissing since changes have been pushed

This reverts commit 56b3bab.

tombuildsstuff

LGTM - thanks for pushing those changes @Brunhil

tombuildsstuff · 2021-03-01T17:00:12Z

Tests pass:

ghost · 2021-03-05T04:43:51Z

This has been released in version 2.50.0 of the provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading. As an example:

provider "azurerm" {
    version = "~> 2.50.0"
}
# ... other configuration ...

ghost · 2021-04-01T14:50:06Z

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. If you feel I made an error 🤖 🙉 , please reach out to my human friends 👉 hashibot-feedback@hashicorp.com. Thanks!

ghost added size/XXL dependencies labels Feb 3, 2021

katbyte added service/signalr waiting-response labels Feb 4, 2021

ghost removed the waiting-response label Feb 4, 2021

jackbatzner changed the title ~~[WIP] New resource azurerm_signalr_service_upstream~~ [WIP] azurerm_signalr_service: Expose upstream_setting Feb 10, 2021

jackbatzner force-pushed the signalr-upstream branch from 78f4706 to 404b809 Compare February 10, 2021 04:05

ghost added the documentation label Feb 10, 2021

jackbatzner commented Feb 10, 2021

View reviewed changes

GNUmakefile Show resolved Hide resolved

jackbatzner changed the title ~~[WIP] azurerm_signalr_service: Expose upstream_setting~~ azurerm_signalr_service: Expose upstream_setting Feb 10, 2021

katbyte added this to the v2.47.0 milestone Feb 11, 2021

katbyte previously requested changes Feb 11, 2021

View reviewed changes

katbyte modified the milestones: v2.47.0, v2.48.0 Feb 11, 2021

katbyte added the waiting-response label Feb 11, 2021

ghost removed the waiting-response label Feb 12, 2021

jackbatzner requested a review from katbyte February 12, 2021 04:14

jackbatzner changed the title ~~azurerm_signalr_service: Expose upstream_setting~~ azurerm_signalr_service: Expose upstream_endpoint Feb 12, 2021

jackbatzner force-pushed the signalr-upstream branch from 83829c1 to e896571 Compare February 18, 2021 14:23

jackofallops modified the milestones: v2.48.0, v2.49.0 Feb 18, 2021

jackofallops force-pushed the signalr-upstream branch from e896571 to 5b1ba78 Compare February 18, 2021 18:48

ghost removed the waiting-response label Feb 19, 2021

tombuildsstuff added the waiting-response label Feb 19, 2021

Jack and others added 14 commits February 19, 2021 13:15

Upgrade signalr package to use 2020-05-01

7a03f40

Fix models being used

32db874

Update acctests make def to work

587b5a6

Expose upstream_setting

6ff1dc2

Update upstream_setting

6016927

Fix acceptance test

e407225

Code review feedback changes

18b16e6

Rename test to match new property name

9aaba5e

No empty strings on upstream patterns

d82b94d

Update signalr_service.html.markdown

e98d65e

dependencies update

c55b724

fix check for upstream setting

5332ba3

r/kubernetes_cluster: fixing pr comments

56b3bab

Address feedback

a6a1d70

jackbatzner force-pushed the signalr-upstream branch from 5b1ba78 to a6a1d70 Compare February 19, 2021 19:15

Revert "r/kubernetes_cluster: fixing pr comments"

9c13912

This reverts commit 56b3bab.

jackbatzner requested a review from tombuildsstuff February 19, 2021 19:17

tombuildsstuff modified the milestones: v2.49.0, v2.50.0 Feb 25, 2021

tombuildsstuff approved these changes Mar 1, 2021

View reviewed changes

tombuildsstuff removed the waiting-response label Mar 1, 2021

tombuildsstuff merged commit f42a0e0 into hashicorp:master Mar 1, 2021

tombuildsstuff added a commit that referenced this pull request Mar 1, 2021

updating to include #10459

b15356c

jackbatzner deleted the signalr-upstream branch March 2, 2021 02:26

ghost locked as resolved and limited conversation to collaborators Apr 1, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`azurerm_signalr_service`: Expose `upstream_endpoint` #10459

`azurerm_signalr_service`: Expose `upstream_endpoint` #10459

jackbatzner commented Feb 3, 2021 •

edited

katbyte commented Feb 4, 2021

jackbatzner commented Feb 4, 2021

jackbatzner commented Feb 10, 2021 •

edited

jackbatzner commented Feb 10, 2021

katbyte left a comment

katbyte Feb 11, 2021

katbyte Feb 11, 2021

katbyte Feb 11, 2021

katbyte Feb 11, 2021

jackbatzner Feb 12, 2021 •

edited

katbyte Feb 12, 2021

katbyte Feb 11, 2021

jackbatzner Feb 12, 2021

katbyte Feb 12, 2021

jackbatzner commented Feb 12, 2021

katbyte commented Feb 12, 2021

jackofallops commented Feb 19, 2021

tombuildsstuff left a comment

tombuildsstuff commented Mar 1, 2021

ghost commented Mar 5, 2021

ghost commented Apr 1, 2021

		@@ -55,6 +62,8 @@ The following arguments are supported:

		* `features` - (Optional) A `features` block as documented below.

		* `upstream_setting` - (Optional) An `upstream_setting` block as documented below. Using this block requires the SignalR service to be Serverless.

		@@ -73,6 +82,18 @@ A `features` block supports the following:

		---

		An `upstream_setting` block supports the following:

	An `upstream_setting` block supports the following:
	An `upstream_match` block supports the following:

azurerm_signalr_service: Expose upstream_endpoint #10459

azurerm_signalr_service: Expose upstream_endpoint #10459

Conversation

jackbatzner commented Feb 3, 2021 • edited

katbyte commented Feb 4, 2021

jackbatzner commented Feb 4, 2021

jackbatzner commented Feb 10, 2021 • edited

jackbatzner commented Feb 10, 2021

katbyte left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jackbatzner Feb 12, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jackbatzner commented Feb 12, 2021

katbyte commented Feb 12, 2021

jackofallops commented Feb 19, 2021

tombuildsstuff left a comment

Choose a reason for hiding this comment

tombuildsstuff commented Mar 1, 2021

ghost commented Mar 5, 2021

ghost commented Apr 1, 2021

`azurerm_signalr_service`: Expose `upstream_endpoint` #10459

`azurerm_signalr_service`: Expose `upstream_endpoint` #10459

jackbatzner commented Feb 3, 2021 •

edited

jackbatzner commented Feb 10, 2021 •

edited

jackbatzner Feb 12, 2021 •

edited