Release Notes

CBG-4349 - Restore single entry skipped sequence list

CBG-4360 - Use UNIX timestamp on reverted skipped list entry

CBG-3953 - Avoid timeout on creating indexes asynchronously

CBG-3966 - Fixed error where collection appears to be linked to 2 DBs after update

CBG-4004 - Fixed DeleteRole doesnt trigger history calculation for named collections

CBG-4016 - nextSequenceGreaterThan now updates to current _sync:seq before releasing sequences

CBG-4022 - Fixed race condition between config poll and dbconfig update

CBG-4029 - Fixed Users dynamically computed roles not getting invalidated after a resync

CBG-4073 - Fixed panic in CheckpointHash function for bucket UUID call

CBG-4107 - Fix error behavior in removeCorruptConfigIfExists where the database wasn’t unloaded/removed

CBG-4127 - Decouple client request context from lazy-init OIDC discovery sync process

CBG-4173 - Fixed corrupt DB config handling doesn’t remove the config when longer present in the bucket

CBG-4221 - Pending unused sequences shouldn’t update high cache sequence

CBG-4218 - Duplicated sequences can cause SGW to be unresponsive

CBG-3983 - sgcollect_info: Switch to runtime config endpoint to determine logFilePath

CBG-4028 - Failure to perform on-demand import results in not found/noRev

CBG-4035 - Skipped Sequence Optimisations

CBG-4036 - Detect and handle _sync:seq rollback in sequence allocator

CBG-4082 - Lower config mismatch logging to debug

CBG-4145 - Improvements to the "could not verify JWT" error logging

CBG-4162 - Log the origin of setting metadata ID when updating a dbconfig

CBG-3951 - Fixed Users API for database with default metadataID can return other db users in the bucket

CBG-3955 - Fixed updating import_filter and sync_filter to empty string does not work for named collection

CBG-3990 - Fixed Documents may not be imported when collection added to an existing db

CBG-4009 - All config updates now supported during async initialization

CBG-3879 - Recovery from cas mismatch on metadata documents when using xattrConfig now possible

CBG-3946 - Bucket and collection now provided when returning an error about inability to create collections

CBG-3959 - Include collection set in resync status

CBG-3964 - Check/wait for principal doc index readiness in resync w/ regenerate sequences

CBG-3965 - Do not regenerate principal seqs unless resync is running on default collection

CBG-3967 - Add a reason for why a database is offline in /_all_dbs

CBG-4020 - Add initialization active property to DbSummary

CBG-3683 - Fixed PANIC error when closing channel cache after Mutation feed fails to start inside StartOnlineProcesses

CBG-3828 - Fixed sgcollect windows doesn’t collect stderr / stdout

CBG-3845 - Fixed updateSeq must happen after DCP callback invocation

CBG-3878 - Fixed UnmarshalDocumentSyncDataFromFeed doesn’t return any present user xattrs if sync data doesn’t exist on the doc

CBG-3906 - Fixed logging for GetDatabaseConfigs verbose and ambiguous

CBG-3826 - Warn if there is a large number of skipped sequences

CBG-3860 - Reduce EOF logging from go-blip

CBG-3876 - Tweak logging around import of JSON but not JSON object docs

CBG-3885 - Fixed OIDC-auth causes admin_channels/admin_roles loss

CBG-3887 - Fixed sgcollect_info fails to upload to s3

CBG-3029 - Fixed sg_collect fails to get SGW config

CBG-3611 - Fixed PUT to _user/<username> does not override omitted fields

CBG-3699 - Fixed error from handleChangesResponse not handled correctly

CBG-3723 - Fixed TCP_NODELAY does not work for TLS connections

CBG-3725 - Fixed import DCP rollback unsuccessful in data migration cases

CBG-3744 - Fixed fetchAndLoadDatabase NewDatabaseContext race

CBG-3760 - Fixed sgcollect_info not collecting trace logging

CBG-3761 - Fixed user API Ignore read-only fields if values unchanged

CBG-3774 - Fixed incorrect log key used for log message inside DocChanged function

CBG-3777 - Fixed kv_pool_size on import feed can be non zero

CBG-3793 - Perform allow_dbconfig_env_vars check in getAuthScopeHandleCreateDB

CBG-3812 - Fixed sg_collect fails to get SGW config

CBG-3682 - sgcollect can upload zips in excess of 2GB

CBG-3749 - Better logging around config registry operations

CBG-3762 - BLIP context ID now included in _blipsync response

CBG-3776 - There is now a configurable revs parallelism limit

CBG-3614 - DCP node list/alternate adddresses do not refresh after cluster topology change

CBG-3639 - Fixed InjectJSONProperties not escaping string values.

CBG-3643 - Fix incorrect usage of PreserveExpiry with an expiry and no doc flags.

CBG-3659 - cbgt fix to avoid file system writes.

CBG-3685 - CORS max_age now configurable on a database level.

CBG-3560 - Inherited channels from roles are not checked when running changes feed filtered to a channel

CBG-3554 - Increasing memory usage when failing to apply a database config from the bucket

CBG-3550 - Retry limit not set for operations requiring non-SDK retry

CBG-3465 - Config migration should consider use_xattr_config

CBG-3462 - Sync Gateway should not use 3.0 config when 3.1 config is present

CBG-3454 - Per-db log settings should take precedence over bootstrap

CBG-3450 - DCP rollback should force checkpoint persistence

CBG-3426 - Explicit check on xattr length to avoid panics

CBG-3405- Investigate the default scope/collection requiring resync after upgrade

CBG-3404 - Hook up the reset resync code to a parameter that is pssed into the resync endpoint

CBG-3403 -Handle rollback error for resync operations

CBG-3398 - Pick up gocb fix for bootstrapping against non KV nodes

CBG-3397 - SG warning when client’s maxHistory for a rev is exceeded on push

CBG-3383- Invalid error handling state for async db online

CBG-3350 - SGW 3.1.1 using 50-75% more memory compared to 3.1.0

CBG-3330 -buildRevokedFeed query iteration fails when no documents processed

CBG-3329 - Revision Cache, Replications with purge_on_removal and meta.xattrs for channel assignment not purging/syncing consistently

CBG-3197 - Cannot update db config from implicit '_default' scope to explicit '_default' scope

CBG-3557 - Improve behavior when allocating sequence much lower than existing doc seq

CBG-3509 - Add opt-out for config env var expansion for db configs

CBG-3495 - Detect and provide metrics for duplicate database names in bootstrap polling

CBG-3494 - Enforce "bucket" field match in DbConfig

CBG-3457 - Prevent minor version downgrade

CBG-3432 - Move KeyDCP changes and cache logging to KeyChanges and Key Cache

CBG-3430 - Deterministic databsae/bucket bootstrapping

CBG-3362 - Silence metrics requests

CBG-3361 - Add basic ping/healthcheck endpointr

CBG-3360 - Tune console log collation buffer size when writing to a file

CBG-3359 - Per-db console log settins

CBG-3143 - Investigate waiting request_plus changes feeds not waking up for released sequence batches

CBG-3131 - Panic during on demand import for get request

CBG-3129 - JWTLastUpdated should only be modified when claim-based access changes

CBG-3123 - Avoid panic in updateCalculatedStats for offline databases

CBG-3103 - Initial OIDC setup fails for keyspace request

CBG-3091 - Backport TestReconnectReplicator fix

CBG-3052 - cbgt panics when setting up import feed for server versions < 7.0

CBG-3039 - proveAttachment incompatibility between 3.0.x and 2.8.x

CBG-3036 - Replicator will not reconnect when max_back_off != 0

CBG-3033 - Import still starts when an offline database is created

CBG-3032 - CE Import feed starting from vb highseqno instead of zero

CBG-3030 - Panic inside Mutable1xBody for nil shallow copy

CBG-2913 - /db/ routing does not work with default collection that coexists with named collection

CBG-3147 - Avoid unnecessary resync on upgrade to 3.1

CBG-3118 - Shared bucket access=false without autoimport=false explicitly specified will panic

CBG-3109 - Remove confusing log line about non SG indexes

CBG-3042 - Attachment compaction code erroneously sets failOnRollback

CBG-3041 - Streamline database creation when using many collections

CBG-3040 - Suppress OnFeedError logging on database close

CBG-3038 - cbgt importlistener leaves open a connection to a bucket after database is deleted

CBG-3037 - Retry to insert config when write fails

CBG-3034 - Improve handling for deleted collection

CBG-3031 - Allow one-shot replications to wait for DCP to catch up on changes feed

CBG-3023 - cbgt cluster connection fails with HTTP polling enabled and TLS disabled

New support for Scopes and Collections
Couchbase has introduced support for Scopes and Collections for self-managed cloud-to-edge deployments only in Couchbase Lite 3.1.0 and Sync Gateway 3.1.0. This release won’t cause any issues with existing apps, as it’s compatible with older versions. If you have an app that uses bucket-based APIs, you can still upgrade to 3.1, but please note that this API is now deprecated. For more information, see Scopes and Collections Configuration for Sync Gateway.

Improved Data Organization and Access Control for Scopes and Collections
Couchbase Mobile now offers Scopes and Collections, allowing more efficient and scalable data organisation within a bucket. This also introduces an improved method of defining and enforcing data Access Control more granularly. Multi-tenant apps will also experience better scalability and independent data lifecycle management.

Improved metadata isolation for Scopes and Collections
Sync Gateway 3.1.0 has improved metadata isolation. The system data maintained by Sync Gateway is now stored in the _default Scope/Collection, while both the _default and user-defined Scope/Collection can be used for application data. For more information, examples and use cases, see Scopes and Collections Support in Couchbase Mobile for Edge Applications.

Collection-Level Sync Functions and Scoped User Associations
The Sync Functions now work on a Collection level, and additional optional fields have been added to the database configurations to support this update. Each database is designed to support only one Scope. Users can be associated with that Scope and shared across multiple Collections.

Enhanced Collection Synchronization and Local Data Storage with Couchbase Lite Client
With Couchbase Lite client replications, you can synchronize one or multiple Collections within a specific scope. The Couchbase Lite client also will store data locally in a scope not synchronized with the remote Sync Gateway.

CBG-2731 - AccessLock not being released when a PUSH replication is ongoing

CBG-2556 - Inefficient sequence parsing during ISGR checkpointing

CBG-2248 - Config admin API doesn't use Etags when config comes from JSON

CBG-2247 - Etags should be quoted

CBG-2208 - Index compaction failing due to not found handling

CBG-2183 - Revocation of non-existent role causes replication panic

CBG-2174 - Periodic high response times on REST API due to persistent config polling

CBG-2134 - Guest user is not initialised with access to public channel ("!")

CBG-2119 - Update DisablePasswordAuth to False does not work

CBG-2102 - Admin auth credentials not verified when using x.509 auth between SG and CBS

CBG-2101 - User endpoint: missing first user if name_only=false

CBG-2065 - Update golang.org/x/text to 0.3.3+ CVE-2020-14040 in SGW 2.8.x

CBG-2059 - HTTP logs incorrectly redact document name if the database name contains it

CBG-2058 - Compaction w/ import and xattrs enabled can panic

CBG-2048 - Update nhooyr.io/websocket gin-gonic/gin CVE-2020-28483

CBG-2030 - _user endpoint pagination causes query error

CBG-2010 - CBL revpos handling causes attachment fetch per write for docs with attachments

CBG-2729 - Info-level logging when a remote webhook filter is empty

CBG-2721 - Add a flag to sg-collect collection to delete zip once uploaded

CBG-2689 - Add sync_function_exception_count stat

CBG-2660 - Use MaxInt64 for high sequence queries

CBG-2559 - Move history to end of marshalled SyncData

CBG-2510 - Docs not being tombstoned with replication DocID filter

CBG-2450 - Leading null character in document ID causes ISGR to terminate pull replication

CBG-2418 - Make a Runtime Database Config to explicitly track if a database is suspended

CBG-2362 - Identify whether SG is running in persistent config mode (or not) via REST API

CBG-2177 - Maintain long-lived bucket connections for persistent config

CBG-2138 - Inform client they need to contact another SGW

CBG-2137 - Support downloading meta(data) from S3 and resuming the bucket

CBG-2136 - Support uploading meta(data) to S3 for hibernation

CBG-2135 - Add API to stop/start access to a given bucket for hibernation

CBG-2064 - Allow mapping OIDC claims to user roles/channels

CBG-2047 - Update client-golang to 1.11.1+ CVE-2022-21698

CBG-2027 - User API Enhancements - include details and limit

CBG-2026 - Option to disable basic auth on public REST API

CBG-2017 - Handle removed buckets in background persistent config update polling

CBG-1969 - Support CBL clients that don't increment revpos when attachment body changes

CBG-798 - Sync Gateway requires Couchbase Server nodes to use the same SSL memcached port