Skip to content

Remove deprecated Temporal.configuration function #343

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

aguynamedben
Copy link

@aguynamedben aguynamedben commented Jun 28, 2025

Fixes #143. For a few years there has been a noise warn message telling people to not use the function Temporal.configuration, but this function was still used internall in temporal-ruby.

The options were:
a) Remove the logger warn message, as whoever in the past had planned to deprecate access via Temporal.configuration never followed up. I don't know why they were trying to remove this method of accessing it. b) [CHOSEN OPTION] Raise the config function from private to be accessible externally. I don't see why this wouldn't be okay.

I ran the tests per the instructions and I get the same amount of test passes, without the noisy deprecation warnings.

I don't know the full history that led to this being half-deprecated, but this seems like a fine way to clean it up.

Before

image

After

image

Breaking Change

CHANGELOG.md should have:

  • Breaking change: Temporal.configuration was removed and replace by Temporal.config. If you previously relied on Temporal.configuration just update the reference to Temporal.config.

Also if this Gem is still doing any versioning, it's a MAJOR patch (i.e. first digit) because if removes a public-facing API, i.e. Temporal.configuration. If we don't want to create a breaking change, I recommend Option A above, just remove the annoying log message and let the method live on into the future.

Fixes coinbase#143. For a few years there has been a noise `warn` message telling people to not use the function Temporal.configuration, but this function was still used internall in temporal-ruby.

The options were:
a) Remove the logger warn message, as whoever in the past had planned to deprecate access via `Temporal.configuration` never followed up. I don't know why they were trying to remove this method of accessing it.
b) **[CHOSEN OPTION]** Raise the `config` function from `private` to be accessible externally. I don't see why this wouldn't be okay.

I ran the tests per the instructions and I get the same amount of test passes, without the noisy deprecation warnings.

I don't know the full history that led to this being half-deprecated, but this seems like a fine way to clean it up.
@@ -75,9 +74,6 @@ def default_client
@default_client ||= Client.new(config)
end

def config
@config ||= Configuration.new
end
Copy link
Author

Choose a reason for hiding this comment

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

Not removed, hoisted out of private ⬆️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Deprecation message spam
1 participant