Skip to content

feat(connectors): add SurrealDB sink connector#3453

Open
countradooku wants to merge 11 commits into
apache:masterfrom
countradooku:feat/surrealdb-sink-connector
Open

feat(connectors): add SurrealDB sink connector#3453
countradooku wants to merge 11 commits into
apache:masterfrom
countradooku:feat/surrealdb-sink-connector

Conversation

@countradooku

@countradooku countradooku commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds a SurrealDB sink connector for writing Iggy messages into SurrealDB using the latest SurrealDB Rust SDK version available during implementation, 3.1.4.

The connector supports deterministic record IDs, bulk INSERT IGNORE writes for idempotent replay, configurable batch sizing, root/namespace/database/no-auth modes, optional table and offset-index definition, payload modes (auto, json, text, base64), metadata/header/checksum/origin timestamp fields, retry/backoff handling, and runtime metrics logging.

This also wires the connector into workspace membership, connector docs, example runtime config, binary artifact builds, edge-release output, version bump scripts, and Docker-backed integration test scaffolding.

Tests

  • cargo fmt --all
  • cargo sort --no-format --workspace
  • cargo clippy --all-features --all-targets -- -D warnings
  • cargo check --all --all-features
  • cargo test -p iggy_connector_surrealdb_sink
  • cargo test -p integration --no-run connectors::surrealdb
  • cargo test --locked --doc
  • cargo doc --no-deps --all-features --quiet
  • ./scripts/ci/taplo.sh
  • ./scripts/ci/license-headers.sh
  • ./scripts/ci/shellcheck.sh
  • ./scripts/ci/binary-artifacts.sh --check
  • ./scripts/extract-version.sh --check
  • git diff --check
  • prek install

Known Review Items

  • ./scripts/ci/third-party-licenses.sh --validate --manifest core/connectors/sinks/surrealdb_sink/Cargo.toml reports BUSL-1.1 license failures from SurrealDB SDK crates. This PR intentionally keeps the SDK dependency because the connector targets the latest SurrealDB SDK.

@countradooku countradooku marked this pull request as ready for review June 11, 2026 08:49
@github-actions github-actions Bot added the S-waiting-on-review PR is waiting on a reviewer label Jun 11, 2026
SurrealDB is a document database target for Iggy connector users, so the sink writes batches with deterministic record ids and bulk INSERT IGNORE to keep runtime redelivery idempotent without per-message round trips.

Constraint: User explicitly requested the latest SurrealDB Rust SDK and chose to keep it despite BUSL-1.1 license-validation warnings for SurrealDB crates.

Constraint: Local Docker daemon was unavailable, so real-container integration execution could not run here.

Rejected: Per-message SDK writes | too many round trips and weaker batching throughput.

Rejected: Using the testcontainers SurrealDB module | module source hardcodes an older SurrealDB image.

Confidence: medium

Scope-risk: moderate

Directive: Keep record ids deterministic across releases; changing build_record_id breaks replay idempotency.

Tested: cargo fmt --all; cargo sort --no-format --workspace; cargo clippy --all-features --all-targets -- -D warnings; cargo check --all --all-features; cargo test -p iggy_connector_surrealdb_sink; cargo test -p integration --no-run connectors::surrealdb; cargo test --locked --doc; cargo doc --no-deps --all-features --quiet; taplo/license/shellcheck/version/diff/binary checks; prek install

Not-tested: Docker-backed SurrealDB integration execution, because Docker daemon was not running locally.
@countradooku countradooku force-pushed the feat/surrealdb-sink-connector branch from 7b8305a to 48c3a9d Compare June 11, 2026 08:58
@codecov

codecov Bot commented Jun 11, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 85.49346% with 122 lines in your changes missing coverage. Please review.
✅ Project coverage is 50.02%. Comparing base (52b060d) to head (f5059a6).

Files with missing lines Patch % Lines
core/connectors/sinks/surrealdb_sink/src/lib.rs 85.38% 100 Missing and 22 partials ⚠️
Additional details and impacted files
@@              Coverage Diff              @@
##             master    #3453       +/-   ##
=============================================
- Coverage     74.26%   50.02%   -24.24%     
  Complexity      937      937               
=============================================
  Files          1259     1258        -1     
  Lines        125969   110755    -15214     
  Branches     101643    86474    -15169     
=============================================
- Hits          93551    55410    -38141     
- Misses        29403    52546    +23143     
+ Partials       3015     2799      -216     
Components Coverage Δ
Rust Core 43.93% <85.49%> (-31.22%) ⬇️
Java SDK 58.57% <ø> (ø)
C# SDK 71.40% <ø> (-0.73%) ⬇️
Python SDK 88.88% <ø> (ø)
PHP SDK 84.29% <ø> (ø)
Node SDK 91.22% <ø> (ø)
Go SDK 40.36% <ø> (ø)
Files with missing lines Coverage Δ
core/server/src/http/jwt/jwt_manager.rs 65.15% <100.00%> (+0.12%) ⬆️
core/server/src/http/jwt/mod.rs 100.00% <100.00%> (ø)
core/connectors/sinks/surrealdb_sink/src/lib.rs 85.38% <85.38%> (ø)

... and 331 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@ryerraguntla

Copy link
Copy Markdown
Contributor

/author

@github-actions github-actions Bot added S-waiting-on-author PR is waiting on author response and removed S-waiting-on-review PR is waiting on a reviewer labels Jun 14, 2026
@ryerraguntla

Copy link
Copy Markdown
Contributor

Please check the pre-checks failure

@countradooku

Copy link
Copy Markdown
Contributor Author

Sure

HawkEye maps Rust files to the double-slash license style, so the block comments in the new SurrealDB connector files were treated as missing headers by CI.

Constraint: CI runs the updated HawkEye-based license check with strict header matching.

Confidence: high

Scope-risk: narrow

Tested: PATH=/opt/homebrew/bin:/Users/radudiaconu/.vite-plus/bin:/Users/radudiaconu/.codex/tmp/arg0/codex-arg0uTrL1r:/Users/radudiaconu/Library/pnpm/bin:/Users/radudiaconu/.opencode/bin:/opt/homebrew/opt/ruby/bin:/opt/homebrew/opt/ruby/bin:/opt/homebrew/opt/ruby/bin:/opt/homebrew/lib/ruby/gems/4.0.0/bin:/Users/radudiaconu/.local/bin:/Users/radudiaconu/Library/Application Support/Herd/bin/:/Users/radudiaconu/.bun/bin:/usr/local/bin:/System/Cryptexes/App/usr/bin:/usr/bin:/bin:/usr/sbin:/sbin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/local/bin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/bin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/appleinternal/bin:/pkg/env/global/bin:/Library/Apple/usr/bin:/usr/local/share/dotnet:~/.dotnet/tools:/opt/homebrew/bin:/opt/zerobrew/bin:/Users/radudiaconu/.zerobrew/bin:/Users/radudiaconu/.cargo/bin:/Users/radudiaconu/Library/Application Support/JetBrains/Toolbox/scripts:/Users/radudiaconu/Library/Android/sdk/platform-tools:/Applications/Codex.app/Contents/Resources ./scripts/ci/license-headers.sh --check; cargo fmt --all --check; git diff --check
The Rust pre-merge machete job reported that the SurrealDB sink crate declared toml without using it. Removing the dev-dependency is simpler than adding an ignore entry.

Constraint: CI runs cargo machete --with-metadata and fails on unused dependencies.

Rejected: Add cargo-machete metadata ignore | the dependency is genuinely unused.

Confidence: high

Scope-risk: narrow

Tested: cargo sort --no-format --workspace; cargo test -p iggy_connector_surrealdb_sink; PATH=/opt/homebrew/bin:/Users/radudiaconu/.vite-plus/bin:/Users/radudiaconu/.codex/tmp/arg0/codex-arg0uTrL1r:/Users/radudiaconu/Library/pnpm/bin:/Users/radudiaconu/.opencode/bin:/opt/homebrew/opt/ruby/bin:/opt/homebrew/opt/ruby/bin:/opt/homebrew/opt/ruby/bin:/opt/homebrew/lib/ruby/gems/4.0.0/bin:/Users/radudiaconu/.local/bin:/Users/radudiaconu/Library/Application Support/Herd/bin/:/Users/radudiaconu/.bun/bin:/usr/local/bin:/System/Cryptexes/App/usr/bin:/usr/bin:/bin:/usr/sbin:/sbin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/local/bin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/bin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/appleinternal/bin:/pkg/env/global/bin:/Library/Apple/usr/bin:/usr/local/share/dotnet:~/.dotnet/tools:/opt/homebrew/bin:/opt/zerobrew/bin:/Users/radudiaconu/.zerobrew/bin:/Users/radudiaconu/.cargo/bin:/Users/radudiaconu/Library/Application Support/JetBrains/Toolbox/scripts:/Users/radudiaconu/Library/Android/sdk/platform-tools:/Applications/Codex.app/Contents/Resources ./scripts/ci/license-headers.sh --check; cargo fmt --all --check; git diff --check; cargo metadata confirms toml is absent from iggy_connector_surrealdb_sink
Comment thread core/connectors/sinks/surrealdb_sink/src/lib.rs Outdated
Comment thread core/connectors/sinks/surrealdb_sink/src/lib.rs
Comment thread core/connectors/sinks/surrealdb_sink/Cargo.toml
Comment thread core/connectors/sinks/surrealdb_sink/src/lib.rs
Comment thread core/connectors/sinks/surrealdb_sink/src/lib.rs
Comment thread core/connectors/sinks/surrealdb_sink/src/lib.rs Outdated
Comment thread core/connectors/sinks/surrealdb_sink/src/lib.rs
Comment thread core/connectors/sinks/surrealdb_sink/src/lib.rs
Comment thread core/integration/tests/connectors/surrealdb/surrealdb_sink.rs
@countradooku

Copy link
Copy Markdown
Contributor Author

/ready

@github-actions github-actions Bot added S-waiting-on-review PR is waiting on a reviewer and removed S-waiting-on-author PR is waiting on author response labels Jun 15, 2026
@ryerraguntla

Copy link
Copy Markdown
Contributor

/author - could you please check the pre-checks failures

@github-actions github-actions Bot removed the S-waiting-on-review PR is waiting on a reviewer label Jun 17, 2026
@github-actions github-actions Bot added the S-waiting-on-author PR is waiting on author response label Jun 17, 2026
@countradooku

Copy link
Copy Markdown
Contributor Author

/ready

@github-actions github-actions Bot added S-waiting-on-review PR is waiting on a reviewer and removed S-waiting-on-author PR is waiting on author response labels Jun 18, 2026
iggy_connector_sdk = { workspace = true }
secrecy = { workspace = true }
serde = { workspace = true }
serde_json = { workspace = true }

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

surrealdb = { workspace = true } pulls surrealdb-core as a transitive dependency. surrealdb-core is licensed under Business Source License 1.1 (BUSL-1.1), an OSI-non-approved license incompatible with Apache 2.0 redistribution. The PR author explicitly flags this: ./scripts/ci/third-party-licenses.sh --validate --manifest core/connectors/sinks/surrealdb_sink/Cargo.toml reports BUSL-1.1 failures. The workspace-level CI passes only because that step runs against core/server/Cargo.toml and core/cli/Cargo.toml, which do not include this crate. The crates.io page for surrealdb v3.1.4 lists the license as "non-standard" and the README confirms surrealdb-core is BUSL-1.1. This cannot be distributed in an Apache Software Foundation project.


Ok(())
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

process_messages — every insertion failure is logged and swallowed, function always returns Ok(()):

if let Some(error) = outcome.error {
    self.insertion_errors.fetch_add(batch.len() as u64, Ordering::Relaxed);
    error!("Failed to insert SurrealDB batch ...: {error}");
}
// no early return, no Err propagation
Ok(())

consume() at L258 propagates this directly. The runtime receives Ok(()) and advances the consumer offset, permanently losing all messages from failed batches with no possibility of redelivery. Other connectors in the repo (Meilisearch, S3, Elasticsearch) return Err from consume() to trigger runtime retry.

Self { stream, topic }
}
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

build_record_id — the deterministic ID uses message_id (u128) not the message offset:

id.push_str("_m");
let _ = write!(&mut id, "{message_id:032x}");

INSERT IGNORE INTO {table} $records silently deduplicates on matching IDs. If a producer sends messages with id = 0 (the default when IggyMessage::builder().build() is used without setting .id()), every such message in the same stream/topic/partition maps to the same record ID. Only the first insert succeeds; all subsequent messages with id = 0 are silently dropped by SurrealDB with no error returned to the connector. The offset is written as a field but is not part of the record ID. Replace or augment with message.offset, which is unique per partition.

}
.with_config_defaults()
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

with_config_defaults — max_retries clamped to .max(1):

self.max_retries = self.config.max_retries.unwrap_or(DEFAULT_MAX_RETRIES).max(1);
Setting max_retries = 0 is silently raised to 1. Document the minimum-1 behavior or reject 0 with an error. Severity:


Ok(client)
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

wait_until_ready — polls by attempting a full create_client() (WebSocket connect + sign in + use_ns/use_db + health check) on every attempt:

for _ in 0..SURREALDB_BOOT_ATTEMPTS {
    if let Ok(client) = self.create_client().await
        && client.health().await.is_ok()
    {
        return Ok(());
    }
    sleep(Duration::from_millis(SURREALDB_BOOT_INTERVAL_MS)).await;
}

With SURREALDB_BOOT_ATTEMPTS = 120 and SURREALDB_BOOT_INTERVAL_MS = 250, the max wait is 30s. Connection errors during the boot window are swallowed via if let Ok. This is acceptable in test code, but swallowing all errors including non-transient auth failures means a misconfigured test fixture fails with "SurrealDB did not become ready" rather than the actual error.

@ryerraguntla

Copy link
Copy Markdown
Contributor

@countradooku - Please check the Cargo.toml comment on licensing and distribution in the apache redistribution. Please check with any other packages which are distributed with apache license. Unresolved this could be a show stopper. otherwise looks good with more of nits.

@ryerraguntla

Copy link
Copy Markdown
Contributor

/author

@github-actions github-actions Bot added S-waiting-on-author PR is waiting on author response and removed S-waiting-on-review PR is waiting on a reviewer labels Jun 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-author PR is waiting on author response

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants