feat: Add options parameter to Mapbox.addCustomHeader method #3988

KijongHan · 2025-09-21T07:58:49Z

Description

Added your feature that allows adding custom headers based on url pattern matching, as per discussion here

add optional options parameter to Mapbox.addCustomHeader with optional urlPattern key which defines the regex string for when there is a match against the request.url it will add the custom header value header and value.
There is no change to the default behaviour or method signature.
If there is an error with converting to regex pattern it will default to not adding the associated header to the request

Checklist

I've read CONTRIBUTING.md
I updated the doc/other generated code with running yarn generate in the root folder
I have tested the new feature on /example app.
- In V11 mode/ios
- In New Architecture mode/ios
- In V11 mode/android
- In New Architecture mode/android
I added/updated a sample - if a new feature was implemented (/example)

Screenshot OR Video

(only Custom-Header and Mapbox-Api-Header-Value added as per `App.js` example)

…ttern to add header only when there is a regex pattern match against urlPattern - Add example usage of addCustomHeader to example App.js and disable escape character check for regex characters

KijongHan · 2025-09-21T08:24:22Z

I know contributions guidelines detail how to generate components docs but it doesn't look like Mapbox.md and CustomHttpHeaders.md are hooked up to auto generate based on code block comments? Have manually updated those docs in PR

mfazekas · 2025-09-21T09:28:47Z

I know contributions guidelines detail how to generate components docs but it doesn't look like Mapbox.md and CustomHttpHeaders.md are hooked up to auto generate based on code block comments? Have manually updated those docs in PR

Yes Mapbox.md and CustomHttpHeaders.md not generated

mfazekas

👍 awesome, thanks much for working on it

mfazekas · 2025-09-21T14:44:45Z

android/src/main/java/com/rnmapbox/rnmbx/modules/CustomHttpHeaders.kt

+                    headers[entry.key] = entry.value.headerValue
+                }
+            } catch (e: PatternSyntaxException) {
+                Log.w(LOG_TAG, e.localizedMessage ?: "Error converting ${options?.urlPattern} to regex")


Prefer Logger.e as that's visible in react-native side as well

Also it would be better to convert to regex in add, as we have a few adds and a lot of tests

ios/RNMBX/CustomHttpHeaders.swift

mfazekas · 2025-09-21T14:51:12Z

ios/RNMBX/CustomHttpHeaders.swift

+      // Check if a URL pattern exists.
+      if let pattern = options.urlPattern {
+        do {
+          let regex = try NSRegularExpression(pattern: pattern)


Same as android: store as regexp in add and just test here

mfazekas · 2025-09-21T14:56:58Z

src/RNMBXModule.ts

+  addCustomHeader(
+    headerName: string,
+    headerValue: string,
+    options?: { urlPattern?: string },


Maybe call urlRegexp as we're expecting a regular epxression?

sounds good, updated

… modules to caller scope for better defined boundaries - rename urlPattern to urlRegexp

KijongHan · 2025-10-01T09:52:14Z

hey @mfazekas - I had to try a different approach and added a new method addCustomHeaderWithOptions as the nullable options parameter from Kotlin wasn't being surfaced to the javascript RBMXModule (it was still expecting 3 explicit parameters and would break backwards compatibility) - have addressed your other PR comments

mfazekas · 2025-10-12T05:38:11Z

Thanks much looks good to me. Not sure if it's possible to add a new TypeScript method to RNMBXModule, which would call the appropriate native method.

hey @mfazekas - I had to try a different approach and added a new method addCustomHeaderWithOptions as the nullable options parameter from Kotlin wasn't being surfaced to the javascript RBMXModule (it was still expecting 3 explicit parameters and would break backwards compatibility) - have addressed your other PR comments

KijongHan · 2025-10-13T19:40:16Z

Thanks much looks good to me. Not sure if it's possible to add a new TypeScript method to RNMBXModule, which would call the appropriate native method.

hey @mfazekas - I had to try a different approach and added a new method addCustomHeaderWithOptions as the nullable options parameter from Kotlin wasn't being surfaced to the javascript RBMXModule (it was still expecting 3 explicit parameters and would break backwards compatibility) - have addressed your other PR comments

hey when I tried doing this the method signature in the RBMXModule javascript was still expecting a match against the native layer, so when I tried implementing a addCustomHeader method export with optional param that calls into addCustomHeaderWithOptions it was still expecting addCustomHeader with 2 arguments

mfazekas

Pls fix CI, otherwise looks good to me

mfazekas · 2025-10-14T19:16:13Z

.eslintrc.js

    'no-return-assign': 0,
    'no-underscore-dangle': [0],
    'no-await-in-loop': 0,
+    'no-useless-escape': ['error', { allowRegexCharacters: ['-'] }],


CI fails:

Error: .eslintrc.js: Configuration for rule "no-useless-escape" is invalid: Value [{"allowRegexCharacters":["-"]}] should NOT have more than 0 items.

oops mb bad commit - was testing this out locally

hey @mfazekas - have fixed eslint and unit tests for CI, I think the other tests that fail are related to requiring mapbox tokens? not sure

…-parameter-to-add-custom-header

- Add options parameter to addCustomHeader method that takes in urlPa…

20b0f84

…ttern to add header only when there is a regex pattern match against urlPattern - Add example usage of addCustomHeader to example App.js and disable escape character check for regex characters

KijongHan had a problem deploying to CI with Mapbox Tokens September 21, 2025 07:58 — with GitHub Actions Error

Update customHeader docs

42b309a

KijongHan had a problem deploying to CI with Mapbox Tokens September 21, 2025 09:27 — with GitHub Actions Failure

mfazekas requested changes Sep 21, 2025

View reviewed changes

KijongHan had a problem deploying to CI with Mapbox Tokens September 21, 2025 19:26 — with GitHub Actions Error

- move string to regex conversion logic from inside CustomHttpHeaders…

83c3dd8

… modules to caller scope for better defined boundaries - rename urlPattern to urlRegexp

KijongHan force-pushed the feature/add-options-parameter-to-add-custom-header branch from 44e4145 to 83c3dd8 Compare September 21, 2025 20:15

KijongHan had a problem deploying to CI with Mapbox Tokens September 21, 2025 20:16 — with GitHub Actions Failure

KijongHan had a problem deploying to CI with Mapbox Tokens October 1, 2025 09:50 — with GitHub Actions Failure

KijongHan requested a review from mfazekas October 1, 2025 09:50

mfazekas requested changes Oct 14, 2025

View reviewed changes

- remove eslint config "no-useless-escape"

64b8fc5

KijongHan had a problem deploying to CI with Mapbox Tokens October 15, 2025 03:54 — with GitHub Actions Failure

- Fix breaking test for addCustomHeaderWithOptions

8c3cbca

KijongHan had a problem deploying to CI with Mapbox Tokens October 15, 2025 22:57 — with GitHub Actions Failure

Merge remote-tracking branch 'upstream/main' into feature/add-options…

da7927c

…-parameter-to-add-custom-header

KijongHan temporarily deployed to CI with Mapbox Tokens October 19, 2025 19:22 — with GitHub Actions Inactive

KijongHan deployed to CI with Mapbox Tokens October 19, 2025 19:22 — with GitHub Actions Active

KijongHan temporarily deployed to CI with Mapbox Tokens October 19, 2025 19:22 — with GitHub Actions Inactive

Uh oh!

feat: Add options parameter to Mapbox.addCustomHeader method #3988

Are you sure you want to change the base?

feat: Add options parameter to Mapbox.addCustomHeader method #3988

Uh oh!

Conversation

KijongHan commented Sep 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Screenshot OR Video

Uh oh!

KijongHan commented Sep 21, 2025

Uh oh!

mfazekas commented Sep 21, 2025

Uh oh!

mfazekas left a comment

Choose a reason for hiding this comment

Uh oh!

mfazekas Sep 21, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mfazekas Sep 21, 2025

Choose a reason for hiding this comment

Uh oh!

mfazekas Sep 21, 2025

Choose a reason for hiding this comment

Uh oh!

KijongHan Sep 21, 2025

Choose a reason for hiding this comment

Uh oh!

KijongHan commented Oct 1, 2025

Uh oh!

mfazekas commented Oct 12, 2025

Uh oh!

KijongHan commented Oct 13, 2025

Uh oh!

mfazekas left a comment

Choose a reason for hiding this comment

Uh oh!

mfazekas Oct 14, 2025

Choose a reason for hiding this comment

Uh oh!

KijongHan Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

KijongHan Oct 19, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

KijongHan commented Sep 21, 2025 •

edited

Loading