Skip to content

feat: add support for file+metadata streams#119

Merged
Ryan Br... (tryangul) merged 6 commits into
mainfrom
rbroughan/stream-based-file-and-metadata-support
Apr 7, 2025
Merged

feat: add support for file+metadata streams#119
Ryan Br... (tryangul) merged 6 commits into
mainfrom
rbroughan/stream-based-file-and-metadata-support

Conversation

@tryangul

@tryangul Ryan Br... (tryangul) commented Apr 1, 2025

Copy link
Copy Markdown
Contributor

What

Adds support for "file based" streams — streams consisting of files and their associated metadata.

These streams may be synced alongside normal streams, enabling a single connection to support both files and records.

Detailed information explaining the motivations of the supported feature and the changes themselves can be found in the proposal doc linked below.

Links

Protocol Proposal Doc

Feature description

Evolution of spike draft

@tryangul Ryan Br... (tryangul) force-pushed the rbroughan/stream-based-file-and-metadata-support branch 4 times, most recently from 0ca5213 to 33b2a3a Compare April 1, 2025 05:17
@tryangul Ryan Br... (tryangul) changed the title feat: add support for file attachments feat: add support for file+metadata streams Apr 2, 2025
@tryangul Ryan Br... (tryangul) force-pushed the rbroughan/stream-based-file-and-metadata-support branch from 7c70577 to bdf1b3c Compare April 3, 2025 22:20
@tryangul Ryan Br... (tryangul) marked this pull request as ready for review April 3, 2025 22:20
@tryangul Ryan Br... (tryangul) force-pushed the rbroughan/stream-based-file-and-metadata-support branch from 66dca60 to 1b050e8 Compare April 3, 2025 22:23
Comment thread .env Outdated
@@ -1,3 +1,3 @@
# x-release-please-start-version
VERSION=0.14.3
VERSION=0.14.4

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nit: should this be a minor upgrade since we're adding a feature?

@tryangul Ryan Br... (tryangul) Apr 7, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Per semver spec, MINOR version when you add functionality in a backward compatible manner

Sounds right to me assuming we are following semver and there aren't any externalities (forced connector updates, etc)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

CC Aldo Gonzalez (@aldogonzalez8) any concerns with us flagging this as a minor version bump?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Bumped to minor pending feedback.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Davin Chia (@davinchia) is this what you were referring to in standup?

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

CC Aldo Gonzalez (@aldogonzalez8) any concerns with us flagging this as a minor version bump?

Alexandre Girard (@girarda) No, being this additive, I think this is correct to be minor.

cc Maxime Carbonneau-Leclerc (@maxi297)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Looks like CI does this automatically #119 (comment)

If this is null, it means that the platform is not supporting the refresh and it is expected that no extra id will be added to the records and no data from previous generation will be cleanup.
"
type: integer
include_files:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

is this a no-op if the stream isn't file-based or is the platform expected to crash? Might be good to clarify the expectation in the description

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes, but also I was trying to avoid defining platform behavior here, as it could easily drift. I do see there is precedence for stating the platform behavior, however.

I could add "Otherwise, this property will be ignored."

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Went ahead and amended this.

@tryangul Ryan Br... (tryangul) force-pushed the rbroughan/stream-based-file-and-metadata-support branch from 1b050e8 to f53ac51 Compare April 7, 2025 18:36
@tryangul Ryan Br... (tryangul) force-pushed the rbroughan/stream-based-file-and-metadata-support branch from f53ac51 to 03efe1b Compare April 7, 2025 18:38
Comment thread .env Outdated
@@ -1,3 +1,3 @@
# x-release-please-start-version
VERSION=0.14.5
VERSION=0.15.0

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Remove this.

CI will automatically look at the PR title and create a following version bump PR.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Will it make it appropriately a minor bump or just a patch?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

it'll behave according to the PR title. Feat = minor.

Rules are in the readme!

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Awesome. Un-reving version then will merge on 🟢

@tryangul Ryan Br... (tryangul) merged commit b4b396a into main Apr 7, 2025
@tryangul Ryan Br... (tryangul) deleted the rbroughan/stream-based-file-and-metadata-support branch April 7, 2025 20:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants