Skip to content

CBG-4945: Fix default sync function dry run #7937

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bbrks merged 3 commits into from
Dec 24, 2025
Merged

CBG-4945: Fix default sync function dry run #7937

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
52ec132
fix default sync function dry run
RIT3shSapata Dec 24, 2025
feace27
use GetDefaultSyncFunction in syncFuncDryRun
RIT3shSapata Dec 24, 2025
f696c9e
refactor unit tests of sync function dry run
RIT3shSapata Dec 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion db/crud.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1711,12 +1711,16 @@ func (db *DatabaseCollectionWithUser) SyncFnDryrun(ctx context.Context, newDoc,
}
var output *channels.ChannelMapperOutput
var syncErr error
if syncFn == "" {
if syncFn == "" && db.ChannelMapper != nil {
Copy link

Copilot AI Dec 24, 2025

Choose a reason for hiding this comment

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

The logic flow has become less clear with the nested conditions. The outer condition checks syncFn == \"\" twice in different branches. Consider restructuring to: first check if syncFn is empty and set it to the default if needed, then proceed with a single conditional based on whether to use ChannelMapper or SyncRunner.

Copilot uses AI. Check for mistakes.
output, err = db.ChannelMapper.MapToChannelsAndAccess(ctx, mutableBody, string(oldDoc._rawBody), metaMap, syncOptions)
if err != nil {
return nil, &base.SyncFnDryRunError{Err: err}
}
} else {
if syncFn == "" {
scopeAndCollectionName := db.ScopeAndCollectionName()
syncFn = channels.GetDefaultSyncFunction(scopeAndCollectionName.Scope, scopeAndCollectionName.Collection)
}
jsTimeout := time.Duration(base.DefaultJavascriptTimeoutSecs) * time.Second
syncRunner, err := channels.NewSyncRunner(ctx, syncFn, jsTimeout)
if err != nil {
Expand Down
84 changes: 63 additions & 21 deletions rest/diagnostic_doc_api_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1004,6 +1004,28 @@ func TestSyncFuncDryRun(t *testing.T) {
base.SkipImportTestsIfNotEnabled(t)
base.SetUpTestLogging(t, base.LevelDebug, base.KeyAll)

rt := NewRestTester(t, &RestTesterConfig{
PersistentConfig: true,
})
defer rt.Close()

dbConfig := rt.NewDbConfig()
rt.CreateDatabase("db", dbConfig)

// When the tests run with named scopes and collections, then the default
// sync function is:
// function(doc){channel("<collection_name>");}
// when the tests run in default scope and collection then the default
// sync function is:
// function(doc){channel(doc.channels);}
var defaultChannelName string
dbc, _ := rt.GetSingleTestDatabaseCollection()
if dbc.IsDefaultCollection() {
defaultChannelName = "chanNew"
} else {
defaultChannelName = dbc.Name
}

tests := []struct {
name string
dbSyncFunction string
Expand Down Expand Up @@ -1077,7 +1099,7 @@ func TestSyncFuncDryRun(t *testing.T) {
syncFunction: "function(doc) {channel(doc.channel); access(doc.accessUser, doc.accessChannel); role(doc.accessUser, doc.role); expiry(doc.expiry);}",
document: map[string]any{"accessChannel": []string{"dynamicChan5412"}, "accessUser": "user", "channel": []string{"dynamicChan222"}, "expiry": 10},
existingDoc: true,
existingDocID: "doc1",
existingDocID: "custom_sync_func-db_sync_func-doc_body-existing_doc-no_doc_id",
existingDocBody: `{"accessChannel": ["dynamicChan5412"],"accessUser": "user","channel": ["dynamicChan222"],"expiry":10}`,
expectedOutput: SyncFnDryRun{
Channels: base.SetFromArray([]string{"dynamicChan222"}),
Expand Down Expand Up @@ -1106,9 +1128,9 @@ func TestSyncFuncDryRun(t *testing.T) {
dbSyncFunction: "function(doc,oldDoc){if (doc.user.num >= 100) {channel(doc.channel);} else {throw({forbidden: 'user num too low'});}if (oldDoc){ console.log(oldDoc); if (oldDoc.user.num > doc.user.num) { access(oldDoc.user.name, doc.channel);} else {access(doc.user.name[0], doc.channel);}}}",
syncFunction: "",
document: map[string]any{"user": map[string]any{"num": 150}, "channel": "abc"},
docID: "doc",
docID: "no_custom_sync_func-db_sync_func-doc_body-no_existing_doc-doc_id-sync_func_exception_typeError",
existingDoc: true,
existingDocID: "doc",
existingDocID: "no_custom_sync_func-db_sync_func-doc_body-no_existing_doc-doc_id-sync_func_exception_typeError",
existingDocBody: `{"user":{"num":123, "name":["user1"]}, "channel":"channel1"}`,
expectedOutput: SyncFnDryRun{
Exception: "Error returned from Sync Function: TypeError: Cannot access member '0' of undefined",
Expand All @@ -1120,9 +1142,9 @@ func TestSyncFuncDryRun(t *testing.T) {
dbSyncFunction: "function(doc,oldDoc){if (doc.user.num >= 100) {channel(doc.channel);} else {throw({forbidden: 'user num too low'});}if (oldDoc){ console.log(oldDoc); if (oldDoc.user.num > doc.user.num) { access(oldDoc.user.name, doc.channel);} else {access(doc.user.name[0], doc.channel);}}}",
syncFunction: "",
document: map[string]any{"user": map[string]any{"num": 120, "name": []string{"user2"}}, "channel": "channel2"},
docID: "doc",
docID: "no_custom_sync_func-db_sync_func-doc_body-existing_doc-doc_id",
existingDoc: true,
existingDocID: "doc",
existingDocID: "no_custom_sync_func-db_sync_func-doc_body-existing_doc-doc_id",
existingDocBody: `{"user":{"num":123, "name":["user1"]}, "channel":"channel1"}`,
expectedOutput: SyncFnDryRun{
Channels: base.SetFromArray([]string{"channel2"}),
Expand All @@ -1136,9 +1158,9 @@ func TestSyncFuncDryRun(t *testing.T) {
name: "no_custom_sync_func-db_sync_func-no_doc_body-existing_doc-doc_id",
dbSyncFunction: "function(doc,oldDoc){if (doc.user.num >= 100) {channel(doc.channel);} else {throw({forbidden: 'user num too low'});}if (oldDoc){ console.log(oldDoc); if (oldDoc.user.num > doc.user.num) { access(oldDoc.user.name, doc.channel);} else {access(doc.user.name[0], doc.channel);}}}",
syncFunction: "",
docID: "doc",
docID: "no_custom_sync_func-db_sync_func-no_doc_body-existing_doc-doc_id",
existingDoc: true,
existingDocID: "doc",
existingDocID: "no_custom_sync_func-db_sync_func-no_doc_body-existing_doc-doc_id",
existingDocBody: `{"user":{"num":123, "name":["user1"]}, "channel":"channel1"}`,
expectedOutput: SyncFnDryRun{
Channels: base.SetFromArray([]string{"channel1"}),
Expand All @@ -1154,7 +1176,7 @@ func TestSyncFuncDryRun(t *testing.T) {
syncFunction: "",
docID: "doc404",
existingDoc: true,
existingDocID: "doc",
existingDocID: "no_custom_sync_func-db_sync_func-no_doc_body-existing_doc-invalid_doc_id",
existingDocBody: `{"user":{"num":123, "name":["user1"]}, "channel":"channel1"}`,
expectedOutput: SyncFnDryRun{},
expectedStatus: http.StatusNotFound,
Expand All @@ -1165,7 +1187,7 @@ func TestSyncFuncDryRun(t *testing.T) {
syncFunction: "",
docID: "",
existingDoc: true,
existingDocID: "doc",
existingDocID: "no_custom_sync_func-db_sync_func-no_doc_body-existing_doc-no_doc_id",
existingDocBody: `{"user":{"num":123, "name":["user1"]}, "channel":"channel1"}`,
expectedOutput: SyncFnDryRun{},
expectedStatus: http.StatusBadRequest,
Expand All @@ -1177,7 +1199,7 @@ func TestSyncFuncDryRun(t *testing.T) {
document: map[string]any{"channel": "channel2"},
docID: "",
existingDoc: true,
existingDocID: "doc22",
existingDocID: "no_custom_sync_func-db_sync_func-doc_body-existing_doc-no_doc_id-new_doc_channel",
existingDocBody: `{"chan1":"channel1", "channel":"chanOld"}`,
expectedOutput: SyncFnDryRun{
Channels: base.SetFromArray([]string{"channel2"}),
Expand All @@ -1191,9 +1213,9 @@ func TestSyncFuncDryRun(t *testing.T) {
dbSyncFunction: "function(doc,oldDoc){if(oldDoc){ channel(oldDoc.channel)} else {channel(doc.channel)} }",
syncFunction: "",
document: map[string]any{"channel": "chanNew"},
docID: "doc22",
docID: "no_custom_sync_func-db_sync_func-doc_body-existing_doc-doc_id-old_doc_channel",
existingDoc: true,
existingDocID: "doc22",
existingDocID: "no_custom_sync_func-db_sync_func-doc_body-existing_doc-doc_id-old_doc_channel",
existingDocBody: `{"chan1":"channel1", "channel":"chanOld"}`,
expectedOutput: SyncFnDryRun{
Channels: base.SetFromArray([]string{"chanOld"}),
Expand All @@ -1207,24 +1229,44 @@ func TestSyncFuncDryRun(t *testing.T) {
dbSyncFunction: "function(doc,oldDoc){if(oldDoc){ channel(oldDoc.channel)} else {channel(doc.channel)} }",
syncFunction: "",
document: `{"channel": "chanNew", "oldchannel":}`,
docID: "doc22",
docID: "no_custom_sync_func-db_sync_func-invalid_doc_body-existing_doc-doc_id",
existingDoc: true,
existingDocID: "doc22",
existingDocID: "no_custom_sync_func-db_sync_func-invalid_doc_body-existing_doc-doc_id",
existingDocBody: `{"chan1":"channel1", "channel":"chanOld"}`,
expectedOutput: SyncFnDryRun{},
expectedStatus: http.StatusBadRequest,
},
{
name: "no_custom_sync_func-default_db_sync_func-doc_body-no_existing_doc-no_doc_id",
document: map[string]any{"channels": "chanNew"},
existingDoc: false,
expectedOutput: SyncFnDryRun{
Channels: base.SetFromArray([]string{defaultChannelName}),
Access: channels.AccessMap{},
Roles: channels.AccessMap{},
},
expectedStatus: http.StatusOK,
},
{
name: "no_custom_sync_func-default_db_sync_func-no_doc_body-existing_doc-doc_id",
docID: "no_custom_sync_func-default_db_sync_func-no_doc_body-existing_doc-doc_id",
existingDoc: true,
existingDocID: "no_custom_sync_func-default_db_sync_func-no_doc_body-existing_doc-doc_id",
existingDocBody: `{"channels": "chanNew"}`,
expectedOutput: SyncFnDryRun{
Channels: base.SetFromArray([]string{defaultChannelName}),
Access: channels.AccessMap{},
Roles: channels.AccessMap{},
},
expectedStatus: http.StatusOK,
},
}

for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
rt := NewRestTester(t, &RestTesterConfig{
PersistentConfig: true,
SyncFn: test.dbSyncFunction,
})
defer rt.Close()

RequireStatus(t, rt.CreateDatabase("db", rt.NewDbConfig()), http.StatusCreated)
dbConfig := rt.NewDbConfig()
dbConfig.Sync = &test.dbSyncFunction
RequireStatus(t, rt.SendAdminRequest("PUT", "/{{.keyspace}}/_config/sync", test.dbSyncFunction), http.StatusOK)

url := "/{{.keyspace}}/_sync"
if test.existingDoc {
Expand Down