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

chore: max-params warning for src/sdk/sdk.ts #1728

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

tamirazrab
Copy link
Contributor

@tamirazrab tamirazrab commented Jan 27, 2025

Description

Resolve max-params warning for src/sdk/sdk.ts
...

End to End Test:
(See Pepr Excellent Examples)

Related Issue

Relates to #1700

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Other (security config, docs update, etc)

Checklist before merging

@tamirazrab tamirazrab requested a review from a team as a code owner January 27, 2025 09:33
@tamirazrab tamirazrab changed the title refactor: params to 4 for writeEvent at sdk refactor: Resolve max-params warning for src/sdk/sdk.ts Jan 27, 2025
Copy link
Contributor

@cmwylie19 cmwylie19 left a comment

Choose a reason for hiding this comment

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

Code looks good but this is user facing breaking change

https://docs.pepr.dev/main/user-guide/sdk/#writeevent

We would need to deprecate before making this change. We will chat as a team and give you some feedback. Thanks for the PR

Copy link

codecov bot commented Jan 31, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.12%. Comparing base (129376b) to head (d77ff1a).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1728   +/-   ##
=======================================
  Coverage   82.11%   82.12%           
=======================================
  Files          52       52           
  Lines        2214     2215    +1     
  Branches      459      469   +10     
=======================================
+ Hits         1818     1819    +1     
- Misses        367      394   +27     
+ Partials       29        2   -27     
Files with missing lines Coverage Δ
src/sdk/sdk.ts 100.00% <100.00%> (ø)

... and 7 files with indirect coverage changes

@tamirazrab tamirazrab changed the title refactor: Resolve max-params warning for src/sdk/sdk.ts chore: max-params warning for src/sdk/sdk.ts Jan 31, 2025
@samayer12
Copy link
Contributor

As an update, we're still thinking about how we want to approach the underlying program structure that caused this warning. In general, we prefer to avoid resolving max-params by creating an object that contains N properties. However, if that's the best solution, we can work with it.

@cmwylie19 cmwylie19 mentioned this pull request Feb 7, 2025
5 tasks
@samayer12 samayer12 removed the ON HOLD label Feb 7, 2025
Copy link
Contributor

@cmwylie19 cmwylie19 left a comment

Choose a reason for hiding this comment

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

lgtm, we will leave a message in our release about this change

Copy link
Contributor

@samayer12 samayer12 left a comment

Choose a reason for hiding this comment

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

We have a plan to communicate this breaking change to users, good to go!

@samayer12 samayer12 enabled auto-merge February 7, 2025 19:38
@cmwylie19 cmwylie19 disabled auto-merge February 7, 2025 19:49
@cmwylie19 cmwylie19 enabled auto-merge February 7, 2025 19:49
@cmwylie19
Copy link
Contributor

image

Looks like some commits are not signed. Can you sign them or open up a new PR with these changes?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 👀 In review
Development

Successfully merging this pull request may close these issues.

3 participants