Enable request overrides at the *Builder level and HyperClient method calls by michaelborn · Pull Request #149 · coldbox-modules/cbelasticsearch

michaelborn · 2026-03-13T16:11:11Z

This PR adds the ability to set custom connection parameters for each request, both at the Builder level:

var response = getWirebox()
	.getInstance( "IndexBuilder@cbelasticsearch" )
	.withTimeout( 45 )
	.withHeader( "My-Custom-Header", "value" )
	.new( name = "foo", settings = { "refresh_interval" : "1s" } )
	.save();

as well as the individual HyperClient method calls like applyIndex(), indexExists(), executeSearch(), etc.:

var response = getWirebox()
	.getInstance( "HyperClient@cbelasticsearch" )
	.indexExists( "bar", { timeout = 300 } );

…rClient method calls

gitguardian · 2026-03-13T17:08:43Z

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secret in your pull request

GitGuardian id	GitGuardian status	Secret	Commit	Filename
28573790	Triggered	Username Password	`b6caa22`	test-harness/tests/specs/unit/HyperClientTest.cfc	View secret

🛠 Guidelines to remediate hardcoded secrets

Understand the implications of revoking this secret by investigating where it is used in your code.
Replace and store your secret safely. Learn here the best practices.
Revoke and rotate this secret.
If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider

following these best practices for managing and storing secrets including API keys and other credentials
install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.

^{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.}

Copilot

Pull request overview

This PR introduces per-request connection/request configuration overrides across cbElasticsearch’s fluent builders (e.g., IndexBuilder, SearchBuilder, Document) and direct HyperClient method calls, allowing callers to tweak request-level settings such as timeouts, headers, and credentials without changing global config.

Changes:

Added a shared BaseModel that captures fluent .with*() calls into a requestOverrides struct for builder/model instances.
Extended HyperPool.newRequest() and many HyperClient methods to accept a requestOverrides struct and apply it to the underlying HyperRequest.
Added unit tests and documentation describing builder-level overrides and direct client call overrides.

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 11 comments.

Show a summary per file

File	Description
test-harness/tests/specs/unit/HyperClientTest.cfc	Adds unit tests covering request override behavior (timeout, credentials, headers).
models/io/HyperPool.cfc	Adds `overrides` parameter to `newRequest()` and attempts to apply override keys onto HyperRequest instances.
models/io/HyperClient.cfc	Threads `requestOverrides` through many public API calls and merges them with builder-level overrides.
models/SearchBuilder.cfc	Extends `BaseModel` to support fluent request overrides.
models/Pipeline.cfc	Extends `BaseModel` to support fluent request overrides.
models/IndexBuilder.cfc	Extends `BaseModel` to support fluent request overrides.
models/ILMPolicyBuilder.cfc	Extends `BaseModel` to support fluent request overrides.
models/Document.cfc	Extends `BaseModel` to support fluent request overrides.
models/BaseModel.cfc	New base class implementing `requestOverrides` storage and `.with*()` capture via `onMissingMethod()`.
models/AliasBuilder.cfc	Extends `BaseModel` to support fluent request overrides.
docs/Getting-Started/Configuration.md	Documents request override usage, merge precedence, and examples for builders and HyperClient calls.

models/io/HyperClient.cfc

models/io/HyperPool.cfc

models/BaseModel.cfc

models/io/HyperClient.cfc

models/Pipeline.cfc

models/BaseModel.cfc

docs/Getting-Started/Configuration.md

models/io/HyperClient.cfc

Thanks, Copilot. :)

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

github-actions · 2026-03-13T19:29:13Z

lucee@5 Test Results

0 tests - 255 0 ✅ - 255 0s ⏱️ -58s
0 suites - 17 0 💤 ± 0
0 files - 1 0 ❌ ± 0

Results for commit 834dfcc. ± Comparison against base commit 0a12b02.

♻️ This comment has been updated with latest results.

github-actions · 2026-03-13T19:29:43Z

adobe@2025 Test Results

1 files ± 0 17 suites ±0 20s ⏱️ -39s
180 tests - 75 92 ✅ - 163 0 💤 ±0 24 ❌ +24 64 🔥 +64
177 runs - 78 95 ✅ - 160 0 💤 ±0 24 ❌ +24 58 🔥 +58

For more details on these failures and errors, see this check.

Results for commit e9ab26d. ± Comparison against base commit 0a12b02.

This pull request removes 83 and adds 8 tests. Note that renamed tests count towards both.

tests.specs.unit.DocumentTest ‑ Performs cbElasticsearch Document tests Tests new() with only an index argument
tests.specs.unit.DocumentTest ‑ Performs cbElasticsearch Document tests Tests setters with get()
tests.specs.unit.DocumentTest ‑ Performs cbElasticsearch Document tests Tests the ability to persist a Document via save()
tests.specs.unit.DocumentTest ‑ Performs cbElasticsearch Document tests Tests the ability to reset a document
tests.specs.unit.DocumentTest ‑ Performs cbElasticsearch Document tests can save a document with a space in the id
tests.specs.unit.IndexBuilderTest ‑ Performs cbElasticsearch IndexBuilder tests Tests new() with a callback for the builder syntax
tests.specs.unit.IndexBuilderTest ‑ Performs cbElasticsearch IndexBuilder tests Tests new() with a full properties struct
tests.specs.unit.IndexBuilderTest ‑ Performs cbElasticsearch IndexBuilder tests Tests new() with no arguments
tests.specs.unit.IndexBuilderTest ‑ Performs cbElasticsearch IndexBuilder tests Tests that a partial settings struct passed to new() will not override the defaults
tests.specs.unit.IndexBuilderTest ‑ Performs cbElasticsearch IndexBuilder tests Tests the ability to reset the index builder
…

tests.specs.unit.DocumentTest ‑ tests.specs.unit.DocumentTest
tests.specs.unit.HyperClientTest ‑ Performs cbElasticsearch HyperClient tests connection overrides BaseModel will throw on missing method
tests.specs.unit.HyperClientTest ‑ Performs cbElasticsearch HyperClient tests connection overrides Can set custom request headers
tests.specs.unit.HyperClientTest ‑ Performs cbElasticsearch HyperClient tests connection overrides Can set custom username/password
tests.specs.unit.HyperClientTest ‑ Performs cbElasticsearch HyperClient tests connection overrides Can set request overrides from IndexBuilder
tests.specs.unit.HyperClientTest ‑ Performs cbElasticsearch HyperClient tests connection overrides indexExists() - can set custom connection timeout
tests.specs.unit.IndexBuilderTest ‑ tests.specs.unit.IndexBuilderTest
tests.specs.unit.SearchBuilderTest ‑ tests.specs.unit.SearchBuilderTest

github-actions · 2026-03-13T19:29:45Z

adobe@2025 Test Results

1 files ± 0 17 suites ±0 19s ⏱️ -40s
180 tests - 75 92 ✅ - 163 0 💤 ±0 24 ❌ +24 64 🔥 +64
177 runs - 78 95 ✅ - 160 0 💤 ±0 24 ❌ +24 58 🔥 +58

For more details on these failures and errors, see this check.

Results for commit 834dfcc. ± Comparison against base commit 0a12b02.

This pull request removes 83 and adds 8 tests. Note that renamed tests count towards both.

tests.specs.unit.DocumentTest ‑ Performs cbElasticsearch Document tests Tests new() with only an index argument
tests.specs.unit.DocumentTest ‑ Performs cbElasticsearch Document tests Tests setters with get()
tests.specs.unit.DocumentTest ‑ Performs cbElasticsearch Document tests Tests the ability to persist a Document via save()
tests.specs.unit.DocumentTest ‑ Performs cbElasticsearch Document tests Tests the ability to reset a document
tests.specs.unit.DocumentTest ‑ Performs cbElasticsearch Document tests can save a document with a space in the id
tests.specs.unit.IndexBuilderTest ‑ Performs cbElasticsearch IndexBuilder tests Tests new() with a callback for the builder syntax
tests.specs.unit.IndexBuilderTest ‑ Performs cbElasticsearch IndexBuilder tests Tests new() with a full properties struct
tests.specs.unit.IndexBuilderTest ‑ Performs cbElasticsearch IndexBuilder tests Tests new() with no arguments
tests.specs.unit.IndexBuilderTest ‑ Performs cbElasticsearch IndexBuilder tests Tests that a partial settings struct passed to new() will not override the defaults
tests.specs.unit.IndexBuilderTest ‑ Performs cbElasticsearch IndexBuilder tests Tests the ability to reset the index builder
…

tests.specs.unit.DocumentTest ‑ tests.specs.unit.DocumentTest
tests.specs.unit.HyperClientTest ‑ Performs cbElasticsearch HyperClient tests connection overrides BaseModel will throw on missing method
tests.specs.unit.HyperClientTest ‑ Performs cbElasticsearch HyperClient tests connection overrides Can set custom request headers
tests.specs.unit.HyperClientTest ‑ Performs cbElasticsearch HyperClient tests connection overrides Can set custom username/password
tests.specs.unit.HyperClientTest ‑ Performs cbElasticsearch HyperClient tests connection overrides Can set request overrides from IndexBuilder
tests.specs.unit.HyperClientTest ‑ Performs cbElasticsearch HyperClient tests connection overrides indexExists() - can set custom connection timeout
tests.specs.unit.IndexBuilderTest ‑ tests.specs.unit.IndexBuilderTest
tests.specs.unit.SearchBuilderTest ‑ tests.specs.unit.SearchBuilderTest

♻️ This comment has been updated with latest results.

github-actions · 2026-03-13T19:29:48Z

boxlang@be Test Results

260 tests +5 260 ✅ +5 1m 1s ⏱️ -1s
17 suites ±0 0 💤 ±0
1 files ±0 0 ❌ ±0

Results for commit 834dfcc. ± Comparison against base commit 0a12b02.

♻️ This comment has been updated with latest results.

github-actions · 2026-03-13T19:29:55Z

adobe@2023 Test Results

1 files ± 0 17 suites ±0 21s ⏱️ -39s
180 tests - 75 92 ✅ - 163 0 💤 ±0 24 ❌ +24 64 🔥 +64
177 runs - 78 95 ✅ - 160 0 💤 ±0 24 ❌ +24 58 🔥 +58

For more details on these failures and errors, see this check.

Results for commit 834dfcc. ± Comparison against base commit 0a12b02.

This pull request removes 83 and adds 8 tests. Note that renamed tests count towards both.

tests.specs.unit.DocumentTest ‑ Performs cbElasticsearch Document tests Tests new() with only an index argument
tests.specs.unit.DocumentTest ‑ Performs cbElasticsearch Document tests Tests setters with get()
tests.specs.unit.DocumentTest ‑ Performs cbElasticsearch Document tests Tests the ability to persist a Document via save()
tests.specs.unit.DocumentTest ‑ Performs cbElasticsearch Document tests Tests the ability to reset a document
tests.specs.unit.DocumentTest ‑ Performs cbElasticsearch Document tests can save a document with a space in the id
tests.specs.unit.IndexBuilderTest ‑ Performs cbElasticsearch IndexBuilder tests Tests new() with a callback for the builder syntax
tests.specs.unit.IndexBuilderTest ‑ Performs cbElasticsearch IndexBuilder tests Tests new() with a full properties struct
tests.specs.unit.IndexBuilderTest ‑ Performs cbElasticsearch IndexBuilder tests Tests new() with no arguments
tests.specs.unit.IndexBuilderTest ‑ Performs cbElasticsearch IndexBuilder tests Tests that a partial settings struct passed to new() will not override the defaults
tests.specs.unit.IndexBuilderTest ‑ Performs cbElasticsearch IndexBuilder tests Tests the ability to reset the index builder
…

tests.specs.unit.DocumentTest ‑ tests.specs.unit.DocumentTest
tests.specs.unit.HyperClientTest ‑ Performs cbElasticsearch HyperClient tests connection overrides BaseModel will throw on missing method
tests.specs.unit.HyperClientTest ‑ Performs cbElasticsearch HyperClient tests connection overrides Can set custom request headers
tests.specs.unit.HyperClientTest ‑ Performs cbElasticsearch HyperClient tests connection overrides Can set custom username/password
tests.specs.unit.HyperClientTest ‑ Performs cbElasticsearch HyperClient tests connection overrides Can set request overrides from IndexBuilder
tests.specs.unit.HyperClientTest ‑ Performs cbElasticsearch HyperClient tests connection overrides indexExists() - can set custom connection timeout
tests.specs.unit.IndexBuilderTest ‑ tests.specs.unit.IndexBuilderTest
tests.specs.unit.SearchBuilderTest ‑ tests.specs.unit.SearchBuilderTest

♻️ This comment has been updated with latest results.

github-actions · 2026-03-13T19:30:12Z

boxlang@1 Test Results

260 tests +5 260 ✅ +5 1m 1s ⏱️ -1s
17 suites ±0 0 💤 ±0
1 files ±0 0 ❌ ±0

Results for commit 834dfcc. ± Comparison against base commit 0a12b02.

♻️ This comment has been updated with latest results.

github-actions · 2026-03-13T19:30:18Z

lucee@6 Test Results

260 tests +5 260 ✅ +5 54s ⏱️ -3s
17 suites ±0 0 💤 ±0
1 files ±0 0 ❌ ±0

Results for commit 834dfcc. ± Comparison against base commit 0a12b02.

♻️ This comment has been updated with latest results.

github-actions · 2026-03-13T19:30:19Z

adobe@2021 Test Results

1 files ± 0 17 suites ±0 20s ⏱️ -40s
180 tests - 75 92 ✅ - 163 0 💤 ±0 24 ❌ +24 64 🔥 +64
177 runs - 78 95 ✅ - 160 0 💤 ±0 24 ❌ +24 58 🔥 +58

For more details on these failures and errors, see this check.

Results for commit 834dfcc. ± Comparison against base commit 0a12b02.

This pull request removes 83 and adds 8 tests. Note that renamed tests count towards both.

tests.specs.unit.DocumentTest ‑ Performs cbElasticsearch Document tests Tests new() with only an index argument
tests.specs.unit.DocumentTest ‑ Performs cbElasticsearch Document tests Tests setters with get()
tests.specs.unit.DocumentTest ‑ Performs cbElasticsearch Document tests Tests the ability to persist a Document via save()
tests.specs.unit.DocumentTest ‑ Performs cbElasticsearch Document tests Tests the ability to reset a document
tests.specs.unit.DocumentTest ‑ Performs cbElasticsearch Document tests can save a document with a space in the id
tests.specs.unit.IndexBuilderTest ‑ Performs cbElasticsearch IndexBuilder tests Tests new() with a callback for the builder syntax
tests.specs.unit.IndexBuilderTest ‑ Performs cbElasticsearch IndexBuilder tests Tests new() with a full properties struct
tests.specs.unit.IndexBuilderTest ‑ Performs cbElasticsearch IndexBuilder tests Tests new() with no arguments
tests.specs.unit.IndexBuilderTest ‑ Performs cbElasticsearch IndexBuilder tests Tests that a partial settings struct passed to new() will not override the defaults
tests.specs.unit.IndexBuilderTest ‑ Performs cbElasticsearch IndexBuilder tests Tests the ability to reset the index builder
…

tests.specs.unit.DocumentTest ‑ tests.specs.unit.DocumentTest
tests.specs.unit.HyperClientTest ‑ Performs cbElasticsearch HyperClient tests connection overrides BaseModel will throw on missing method
tests.specs.unit.HyperClientTest ‑ Performs cbElasticsearch HyperClient tests connection overrides Can set custom request headers
tests.specs.unit.HyperClientTest ‑ Performs cbElasticsearch HyperClient tests connection overrides Can set custom username/password
tests.specs.unit.HyperClientTest ‑ Performs cbElasticsearch HyperClient tests connection overrides Can set request overrides from IndexBuilder
tests.specs.unit.HyperClientTest ‑ Performs cbElasticsearch HyperClient tests connection overrides indexExists() - can set custom connection timeout
tests.specs.unit.IndexBuilderTest ‑ tests.specs.unit.IndexBuilderTest
tests.specs.unit.SearchBuilderTest ‑ tests.specs.unit.SearchBuilderTest

♻️ This comment has been updated with latest results.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

michaelborn and others added 2 commits March 13, 2026 12:07

Enable request overrides at the *Builder level and on individual Hype…

5a6be06

…rClient method calls

Apply cfformat changes

f7509bb

michaelborn marked this pull request as draft March 13, 2026 16:36

michaelborn added 2 commits March 13, 2026 13:07

Tweaks to support withHeader() method

b6caa22

Document request overrides

afe22fe

Apply cfformat changes

800408c

michaelborn requested a review from Copilot March 13, 2026 17:09

michaelborn marked this pull request as ready for review March 13, 2026 17:09

Copilot started reviewing on behalf of michaelborn March 13, 2026 17:12 View session

Copilot AI reviewed Mar 13, 2026

View reviewed changes

michaelborn and others added 5 commits March 13, 2026 14:50

Tweaks per Copilot review

f9bcc49

Thanks, Copilot. :)

More tweaks per copilot review

873b0df

More tweaks per Copilot

b0dfbd8

Apply cfformat changes

6a2f683

Fix getMappings() call when passing request overrides

e9ab26d

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Drop incorrect 5th argument in applyMapping()

834dfcc

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Uh oh!

Conversation

michaelborn commented Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gitguardian bot commented Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

lucee@5 Test Results

Uh oh!

github-actions bot commented Mar 13, 2026

adobe@2025 Test Results

Uh oh!

github-actions bot commented Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

adobe@2025 Test Results

Uh oh!

github-actions bot commented Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

boxlang@be Test Results

Uh oh!

github-actions bot commented Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

adobe@2023 Test Results

Uh oh!

github-actions bot commented Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

boxlang@1 Test Results

Uh oh!

github-actions bot commented Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

lucee@6 Test Results

Uh oh!

github-actions bot commented Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

adobe@2021 Test Results

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

michaelborn commented Mar 13, 2026 •

edited

Loading

gitguardian bot commented Mar 13, 2026 •

edited

Loading

github-actions bot commented Mar 13, 2026 •

edited

Loading

github-actions bot commented Mar 13, 2026 •

edited

Loading

github-actions bot commented Mar 13, 2026 •

edited

Loading

github-actions bot commented Mar 13, 2026 •

edited

Loading

github-actions bot commented Mar 13, 2026 •

edited

Loading

github-actions bot commented Mar 13, 2026 •

edited

Loading

github-actions bot commented Mar 13, 2026 •

edited

Loading