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

fix: Allow users to fetch the packageValue of settings on /settings endpoint #34864

Merged
merged 6 commits into from
Jan 14, 2025

Conversation

KevLehman
Copy link
Contributor

@KevLehman KevLehman commented Jan 2, 2025

Proposed changes (including videos or screenshots)

Since fields param is deprecated (and it's disabled by default, behind an env var), there was no way to obtain the default value of the settings when using the settings endpoint.

The proposed solution is to use a new boolean flag that allows the requester to fetch the packageValue along with the current value when using the aforementioned endpoint.

Flag is includeDefaults

Issue(s)

https://rocketchat.atlassian.net/browse/CORE-911

Steps to test or reproduce

Further comments

Copy link
Contributor

dionisio-bot bot commented Jan 2, 2025

Looks like this PR is ready to merge! 🎉
If you have any trouble, please check the PR guidelines

Copy link

changeset-bot bot commented Jan 2, 2025

🦋 Changeset detected

Latest commit: 40751c6

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

This PR includes changesets to release 35 packages
Name Type
@rocket.chat/meteor Patch
@rocket.chat/rest-typings Patch
@rocket.chat/api-client Patch
@rocket.chat/core-services Patch
@rocket.chat/ddp-client Patch
@rocket.chat/models Patch
@rocket.chat/ui-contexts Patch
@rocket.chat/account-service Patch
@rocket.chat/authorization-service Patch
@rocket.chat/ddp-streamer Patch
@rocket.chat/stream-hub-service Patch
@rocket.chat/omnichannel-services Patch
@rocket.chat/presence Patch
rocketchat-services Patch
@rocket.chat/omnichannel-transcript Patch
@rocket.chat/presence-service Patch
@rocket.chat/queue-worker Patch
@rocket.chat/network-broker Patch
@rocket.chat/livechat Patch
@rocket.chat/cron Patch
@rocket.chat/instance-status Patch
@rocket.chat/uikit-playground Patch
@rocket.chat/fuselage-ui-kit Patch
@rocket.chat/gazzodown Patch
@rocket.chat/ui-avatar Patch
@rocket.chat/ui-client Patch
@rocket.chat/ui-video-conf Patch
@rocket.chat/ui-voip Patch
@rocket.chat/web-ui-registration Patch
@rocket.chat/core-typings Patch
@rocket.chat/apps Patch
@rocket.chat/freeswitch Patch
@rocket.chat/model-typings Patch
@rocket.chat/license Patch
@rocket.chat/pdf-worker Patch

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

Copy link
Contributor

github-actions bot commented Jan 2, 2025

PR Preview Action v1.6.0

🚀 View preview at
https://RocketChat.github.io/Rocket.Chat/pr-preview/pr-34864/

Built to branch gh-pages at 2025-01-14 13:50 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

Copy link

codecov bot commented Jan 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.16%. Comparing base (88be133) to head (40751c6).
Report is 1 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           develop   #34864      +/-   ##
===========================================
+ Coverage    59.12%   59.16%   +0.03%     
===========================================
  Files         2819     2819              
  Lines        67938    67793     -145     
  Branches     15134    15080      -54     
===========================================
- Hits         40171    40109      -62     
+ Misses       24934    24862      -72     
+ Partials      2833     2822      -11     
Flag Coverage Δ
unit 74.99% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@KevLehman KevLehman marked this pull request as ready for review January 2, 2025 16:48
@KevLehman KevLehman requested review from a team as code owners January 2, 2025 16:48
MarcosSpessatto
MarcosSpessatto previously approved these changes Jan 2, 2025
@MarcosSpessatto MarcosSpessatto added this to the 7.3.0 milestone Jan 2, 2025
@debdutdeb
Copy link
Member

debdutdeb commented Jan 3, 2025

Shouldn't this be a feat instead? I understand why it could be considered a fix, however it's a new thing that's being added?

Edit: or is it a fix to be able to ship it on patch releases for older versions?

@KevLehman
Copy link
Contributor Author

Well, it's a funny story: this was working, then it stopped working, then this will make it work again. So in theory is a fix... but could be a feat as well (as a new thing is added).

But i'm inclined more to "fix" cause it was working in a way and it stopped working

@jessicaschelly jessicaschelly added the stat: QA assured Means it has been tested and approved by a company insider label Jan 14, 2025
@dionisio-bot dionisio-bot bot added the stat: ready to merge PR tested and approved waiting for merge label Jan 14, 2025
@dionisio-bot dionisio-bot bot removed the stat: ready to merge PR tested and approved waiting for merge label Jan 14, 2025
@KevLehman KevLehman added the stat: ready to merge PR tested and approved waiting for merge label Jan 14, 2025
@kodiakhq kodiakhq bot merged commit 1f54b73 into develop Jan 14, 2025
51 checks passed
@kodiakhq kodiakhq bot deleted the fix/settings-package-value-on-end branch January 14, 2025 14:25
This was referenced Jan 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stat: QA assured Means it has been tested and approved by a company insider stat: ready to merge PR tested and approved waiting for merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants