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: make macOS spellchecker fns formal no-ops #35514

Merged
merged 3 commits into from Sep 14, 2022

Conversation

codebytere
Copy link
Member

Description of Change

Closes #35508.

Formally make session.setSpellCheckerLanguages() and session.setSpellCheckerDictionaryDownloadURL() no-ops on macOS. macOS uses system spellchecking functionality so those functions would not have their intended effect, but could still throw errors if called with an unsupported language.

Checklist

Release Notes

Notes: Fixed an issue where some spellcheck functionality would incorrectly throw errors on macOS.

@codebytere codebytere added semver/patch backwards-compatible bug fixes target/19-x-y target/21-x-y PR should also be added to the "21-x-y" branch. labels Aug 31, 2022
@electron-cation electron-cation bot added the new-pr 🌱 PR opened in the last 24 hours label Aug 31, 2022
Copy link
Member

@deepak1556 deepak1556 left a comment

Choose a reason for hiding this comment

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

Maybe a unittest to validate the noop on macOS ?

Copy link
Member

@ckerr ckerr left a comment

Choose a reason for hiding this comment

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

👍 on the idea and the ifdef wrapping. Had a few minor suggestions.

shell/browser/api/electron_api_session.cc Show resolved Hide resolved
shell/browser/api/electron_api_session.cc Show resolved Hide resolved
docs/api/session.md Outdated Show resolved Hide resolved
@electron-cation electron-cation bot removed the new-pr 🌱 PR opened in the last 24 hours label Sep 1, 2022
@jkleinsc jkleinsc merged commit 38a7da6 into main Sep 14, 2022
@jkleinsc jkleinsc deleted the spellchecker-actually-noop branch September 14, 2022 22:10
@release-clerk
Copy link

release-clerk bot commented Sep 14, 2022

Release Notes Persisted

Fixed an issue where some spellcheck functionality would incorrectly throw errors on macOS.

@trop
Copy link
Contributor

trop bot commented Sep 14, 2022

I was unable to backport this PR to "19-x-y" cleanly;
you will need to perform this backport manually.

@trop trop bot removed the target/19-x-y label Sep 14, 2022
@trop
Copy link
Contributor

trop bot commented Sep 14, 2022

I was unable to backport this PR to "20-x-y" cleanly;
you will need to perform this backport manually.

@trop
Copy link
Contributor

trop bot commented Sep 14, 2022

I have automatically backported this PR to "21-x-y", please check out #35679

@trop trop bot added in-flight/21-x-y merged/21-x-y PR was merged to the "21-x-y" branch. and removed target/21-x-y PR should also be added to the "21-x-y" branch. labels Sep 14, 2022
@trop trop bot removed the in-flight/21-x-y label Sep 14, 2022
khalwa pushed a commit to solarwindscloud/electron that referenced this pull request Feb 22, 2023
* chore: make macOS spellchecker fns formal no-ops

* docs: correct no-op note

* test: add no-op specs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merged/21-x-y PR was merged to the "21-x-y" branch. semver/patch backwards-compatible bug fixes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Spellcheck API can cause errors in macOS applications despite supposedly being a "no-op" on macOS
5 participants