feat: Fabric stream subscription #864

thogarty · 2025-02-20T01:23:09Z

Add stream subscription resource
Add data source by ids and data source all for subscriptions
Add docs and examples
Add acceptance tests for contribution

codecov · 2025-02-20T01:25:14Z

Codecov Report

Attention: Patch coverage is 57.02782% with 587 lines in your changes missing coverage. Please review.

Project coverage is 64.95%. Comparing base (6a231ed) to head (afc5e3b).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
...l/resources/fabric/stream_subscription/resource.go	24.66%	267 Missing and 11 partials ⚠️
...nal/resources/fabric/stream_subscription/models.go	0.00%	234 Missing ⚠️
...urces/fabric/stream_subscription/datasource_all.go	24.39%	31 Missing ⚠️
...es/fabric/stream_subscription/datasource_by_ids.go	32.25%	21 Missing ⚠️
internal/resources/fabric/stream/sweeper.go	0.00%	10 Missing ⚠️
internal/fabric/testing_helpers/env_data.go	56.25%	4 Missing and 3 partials ⚠️
internal/framework/converters.go	0.00%	6 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##             main     #864       +/-   ##
===========================================
+ Coverage   31.38%   64.95%   +33.57%     
===========================================
  Files         217      224        +7     
  Lines       27667    29023     +1356     
===========================================
+ Hits         8682    18851    +10169     
+ Misses      18838     9275     -9563     
- Partials      147      897      +750

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

ctreatma · 2025-02-25T17:41:06Z

internal/resources/fabric/stream_subscription/models.go

+type DataSourceByIDsModel struct {
+	ID             types.String `tfsdk:"id"`


Nit / FYI: there is no need to export model types; if you start them with a lower-case letter they will only be accessible within the resource package, which reduces the risk of us incorrectly or unexpectedly tying different resource packages together.

srushti-patl · 2025-02-25T23:33:07Z

internal/resources/fabric/stream_subscription/datasource_all.go

+	}
+
+	// Use API client to get the current state of the resource
+	streamSubscriptions, _, err := client.StreamSubscriptionsApi.GetStreamSubscriptions(ctx, data.StreamID.ValueString()).Limit(limit).Offset(offset).Execute()


Offset and Limit are optional parameter for API request. Need to update the logic where, we will pass these attributes only when value is NotNull

They are optional, but they also default to 0 and 20. Which are the defaults of the API anyway. So whether or not they are given the API result is always correct.

The ValueInt32 will return 0 for a null HCL value on that same model attribute.

Because of Go Zero values: https://go.dev/tour/basics/12

srushti-patl · 2025-02-26T00:54:30Z

internal/resources/fabric/stream_subscription/resource_schema.go

+				Description: "Details of the last change on the stream resource",
+				Computed:    true,
+				CustomType:  fwtypes.NewObjectTypeOf[ChangeLogModel](ctx),
+				PlanModifiers: []planmodifier.Object{


Can you remove PlanModifiers for change_log attribute as it's values are going to change? Also, remove it from other attributes where it's not required.

srushti-patl

Approving PR but need to commit doc changes.
Getting this error: Uncommitted changes detected. Run 'make docs' and commit changes

thogarty · 2025-02-26T21:57:14Z

@ctreatma , this is ready for another look from devrel group 👍

… to be set from plan instead of API response because API response omits it

…sertions

thogarty · 2025-02-28T18:22:42Z

@ctreatma , any issues with this PR?

ctreatma · 2025-02-28T18:32:50Z

I think the only thing in here that forced devrel review was the new converter; that looks fine to me. (The rest looks fine too but will have to be reviewed by Fabric as codeowners.)

thogarty · 2025-02-28T18:35:38Z

I think the only thing in here that forced devrel review was the new converter; that looks fine to me. (The rest looks fine too but will have to be reviewed by Fabric as codeowners.)

Yes, correct. Srushti has reviewed from Fabric but we just needed the last stamp. Thank you!

github-actions · 2025-02-28T18:41:58Z

This PR is included in version 3.3.0 🎉

thogarty requested review from a team as code owners February 20, 2025 01:23

thogarty temporarily deployed to internal February 20, 2025 01:23 — with GitHub Actions Inactive

thogarty force-pushed the fabric_stream_subscription branch from 214d7f3 to ca50b26 Compare February 20, 2025 01:23

thogarty temporarily deployed to internal February 20, 2025 01:23 — with GitHub Actions Inactive

thogarty added the area/resources/fabric Issues related to Fabric and ECX APIs label Feb 20, 2025

thogarty force-pushed the fabric_stream_subscription branch from ca50b26 to 63fb1b4 Compare February 22, 2025 01:11

thogarty temporarily deployed to internal February 22, 2025 01:11 — with GitHub Actions Inactive

thogarty temporarily deployed to internal February 25, 2025 01:04 — with GitHub Actions Inactive

ctreatma reviewed Feb 25, 2025

View reviewed changes

srushti-patl requested changes Feb 26, 2025

View reviewed changes

thogarty force-pushed the fabric_stream_subscription branch from fa03858 to 44c4ad0 Compare February 26, 2025 01:20

thogarty temporarily deployed to internal February 26, 2025 01:20 — with GitHub Actions Inactive

thogarty temporarily deployed to internal February 26, 2025 01:22 — with GitHub Actions Inactive

srushti-patl previously approved these changes Feb 26, 2025

View reviewed changes

thogarty dismissed srushti-patl’s stale review via 26eca7b February 26, 2025 21:02

thogarty temporarily deployed to internal February 26, 2025 21:02 — with GitHub Actions Inactive

srushti-patl self-requested a review February 26, 2025 22:02

srushti-patl previously approved these changes Feb 26, 2025

View reviewed changes

thogarty added 2 commits February 27, 2025 16:38

First skeleton addition for stream_subscription

e786937

Schemas and models for stream subscriptions

0122700

thogarty added 14 commits February 27, 2025 16:38

Finish initial development of stream_subscription for testing

c7d2fd7

Resolve linter errors and update resource schema

16b8454

Update models for stream_subscription after testing; credential needs…

fa0fd15

… to be set from plan instead of API response because API response omits it

Add initial tests for streaming subscription sinks

10208f6

Fix selectors and filters with model updates

2b83ab3

Finish stream subscription and add docs

3950cb9

Fix linter errors that propagated to the rest of the project

5406ab4

Add test sweeper for stream subscriptions

08b9951

Update models for API return value inconsistencies and finish test as…

3643efb

…sertions

Polishing touches on PR

ff85d27

Update Fabric acceptance test workflow to include user data

b200d74

Fix schema elements and data models

4296791

Remove changeLog plan modifier because its values will change

c5af439

Remove transformAlerts parameter

6ae9169

thogarty force-pushed the fabric_stream_subscription branch from 26eca7b to 6ae9169 Compare February 28, 2025 00:39

thogarty temporarily deployed to internal February 28, 2025 00:39 — with GitHub Actions Inactive

Update linting error on testing_helpers import

afc5e3b

thogarty dismissed srushti-patl’s stale review via afc5e3b February 28, 2025 00:57

thogarty temporarily deployed to internal February 28, 2025 00:57 — with GitHub Actions Inactive

ctreatma approved these changes Feb 28, 2025

View reviewed changes

srushti-patl self-requested a review February 28, 2025 18:36

srushti-patl approved these changes Feb 28, 2025

View reviewed changes

thogarty merged commit 15d399b into main Feb 28, 2025
12 of 14 checks passed

thogarty deleted the fabric_stream_subscription branch February 28, 2025 18:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Fabric stream subscription #864

feat: Fabric stream subscription #864

thogarty commented Feb 20, 2025

codecov bot commented Feb 20, 2025 •

edited

Loading

ctreatma Feb 25, 2025

srushti-patl Feb 25, 2025

thogarty Feb 26, 2025

thogarty Feb 26, 2025

thogarty Feb 26, 2025

srushti-patl Feb 26, 2025 •

edited

Loading

srushti-patl left a comment •

edited

Loading

thogarty commented Feb 26, 2025

thogarty commented Feb 28, 2025

ctreatma commented Feb 28, 2025

thogarty commented Feb 28, 2025

github-actions bot commented Feb 28, 2025

		type DataSourceByIDsModel struct {
		ID types.String `tfsdk:"id"`

feat: Fabric stream subscription #864

feat: Fabric stream subscription #864

Conversation

thogarty commented Feb 20, 2025

codecov bot commented Feb 20, 2025 • edited Loading

Codecov Report

ctreatma Feb 25, 2025

Choose a reason for hiding this comment

srushti-patl Feb 25, 2025

Choose a reason for hiding this comment

thogarty Feb 26, 2025

Choose a reason for hiding this comment

thogarty Feb 26, 2025

Choose a reason for hiding this comment

thogarty Feb 26, 2025

Choose a reason for hiding this comment

srushti-patl Feb 26, 2025 • edited Loading

Choose a reason for hiding this comment

srushti-patl left a comment • edited Loading

Choose a reason for hiding this comment

thogarty commented Feb 26, 2025

thogarty commented Feb 28, 2025

ctreatma commented Feb 28, 2025

thogarty commented Feb 28, 2025

github-actions bot commented Feb 28, 2025

codecov bot commented Feb 20, 2025 •

edited

Loading

srushti-patl Feb 26, 2025 •

edited

Loading

srushti-patl left a comment •

edited

Loading