Skip to content
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.

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

Node: deprecate maxEventsInBatch in favor of flushAt #1015

Merged
merged 2 commits into from
Jan 8, 2024

Conversation

silesky
Copy link
Contributor

@silesky silesky commented Dec 14, 2023

Deprecate maxEventsInBatch in favor of flushAt. The purpose is to establish consistency between our SDKs, regardless of language.

(Basically, let's go back to the original naming of maxEventsInBatch)

Docs Change: segmentio/segment-docs#5808

Copy link

changeset-bot bot commented Dec 14, 2023

🦋 Changeset detected

Latest commit: 91493c0

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@segment/analytics-node Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@silesky silesky changed the title change maxEventsInBach to flushAt Node: change maxEventsInBach to flushAt Dec 14, 2023
@silesky silesky changed the title Node: change maxEventsInBach to flushAt Node: deprecate maxEventsInBatch in favor of flushAt Dec 14, 2023
@silesky silesky requested a review from zikaari January 2, 2024 23:58
Copy link
Contributor

@chrisradek chrisradek left a comment

Choose a reason for hiding this comment

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

Overall looks good, just a few comments.

packages/node/src/app/analytics-node.ts Outdated Show resolved Hide resolved
packages/node/src/app/analytics-node.ts Outdated Show resolved Hide resolved
@@ -0,0 +1,5 @@
---
'@segment/analytics-node': major
Copy link
Contributor

Choose a reason for hiding this comment

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

Might want to coordinate with @MichaelGHSeg to add the breaking changes he needs to make for oauth so they both get included when we bump this (if you haven't coordinated already)

Copy link
Contributor Author

@silesky silesky Jan 5, 2024

Choose a reason for hiding this comment

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

I did some internet research and the SemVar specification specifically says to bump the minor version for deprecation, so updated!

@silesky silesky merged commit 8fbe1a0 into master Jan 8, 2024
6 checks passed
@silesky silesky deleted the node-add-flush-at branch January 8, 2024 18:16
@github-actions github-actions bot mentioned this pull request Jan 3, 2024
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.

2 participants