matrix-org / matrix-org/matrix-js-sdk
drop support for `ICreateClientOpts.useAuthorizationHeader`
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.2k
- Forks
- 704
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 40
Description
The matrix spec has supported auth via the Authorization header since r0.3.0, and indeed the use of the query param has been deprecated since v1.11.
Nevertheless the js-sdk still allows applications to fall back to use of the query param by setting ICreateClientOpts.useAuthorizationHeader: false.
I believe we should completely remove this option in the next major version of the SDK.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Search the TypeScript SDK for ICreateClientOpts and useAuthorizationHeader, then trace where the option controls authentication requests. Remove the option and its query-parameter fallback for the next major SDK version, and verify that all remaining references are gone.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100