CBG-3764 update base implementation of XDCR in rosmar

.github/ISSUE_TEMPLATE.md

@@ -1,10 +1,10 @@
-The Sync Gateway issue tracker is reserved for bug reports and enhancement 
+The Sync Gateway issue tracker is reserved for bug reports and enhancement
 requests. For general questions, please use the Couchbase forums:
 https://forums.couchbase.com/c/mobile/sync-gateway. Thank you!
 
 ### Sync Gateway version
-Version information is written on startup to the Sync Gateway log, or can 
-be obtained by accessing the root endpoint (`/`) on the Sync Gateway Admin REST API.   
+Version information is written on startup to the Sync Gateway log, or can
+be obtained by accessing the root endpoint (`/`) on the Sync Gateway Admin REST API.
 
 ### Operating system
 The operating system you're running Sync Gateway on.
@@ -27,6 +27,6 @@ What should have happened?
 What actually happened?
 
 ### Steps to reproduce
-1.  
-2.  
-3.  
+1.
+2.
+3.

.github/dependabot.yml

@@ -0,0 +1,22 @@
+# Copyright 2023-Present Couchbase, Inc.
+#
+# Use of this software is governed by the Business Source License included in
+# the file licenses/BSL-Couchbase.txt.  As of the Change Date specified in that
+# file, in accordance with the Business Source License, use of this software
+# will be governed by the Apache License, Version 2.0, included in the file
+# licenses/APL2.txt.
+
+version: 2
+updates:
+  - package-ecosystem: "gomod"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    registries:
+      - gh-private
+registries:
+  gh-private:
+    type: git
+    url: https://github.com
+    username: x-access-token
+    password: ${{secrets.GH_PERSONAL_ACCESS_TOKEN_CBROBOTSG}}

.github/workflows/ci.yml

@@ -13,48 +13,52 @@ on:
     branches:
       - 'master'
       - 'release/*'
+      - 'beryllium'
       - 'CBG*'
       - 'ci-*'
   pull_request:
     branches:
       - 'master'
       - 'release/*'
+      - 'beryllium'
 
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/setup-go@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
         with:
-          go-version: 1.20.3
-      - uses: actions/checkout@v3
+          go-version: 1.21.8
       - name: go-build
         run: go build "./..."
 
   addlicense:
     name: addlicense
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/setup-go@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
         with:
-          go-version: 1.20.3
+          go-version: 1.21.8
       - run: go install github.com/google/addlicense@latest
-      - uses: actions/checkout@v3
       - run: addlicense -check -f licenses/addlicense.tmpl .
 
   golangci:
     name: lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/setup-go@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
         with:
-          go-version: 1.20.3
-      - uses: actions/checkout@v3
+          go-version: 1.21.8
+          cache: false
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v3
+        uses: golangci/golangci-lint-action@v4
         with:
-          version: v1.52.0
-          args: --config=.golangci-strict.yml --timeout=3m
+          version: v1.57.2
+          args: --config=.golangci-strict.yml
+
   test:
     runs-on: ${{ matrix.os }}
     strategy:
@@ -72,18 +76,18 @@ jobs:
       MallocNanoZone: 0
     name: test (${{ matrix.name }})
     steps:
-      - uses: actions/setup-go@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
         with:
-          go-version: 1.20.3
-      - uses: actions/checkout@v3
+          go-version: 1.21.8
       - name: Build
         run: go build -v "./..."
       - name: Run Tests
-        run: go test -timeout=30m -count=1 -json -v "./..." | tee test.json | jq -s -jr 'sort_by(.Package,.Time) | .[].Output | select (. != null )'
+        run: go test -shuffle=on -timeout=30m -count=1 -json -v "./..." | tee test.json | jq -s -jr 'sort_by(.Package,.Time) | .[].Output | select (. != null )'
         shell: bash
       - name: Annotate Failures
         if: always()
-        uses: guyarb/golang-test-annotations@v0.6.0
+        uses: guyarb/golang-test-annotations@v0.7.0
         with:
           test-results: test.json
 
@@ -92,34 +96,52 @@ jobs:
     env:
       GOPRIVATE: github.com/couchbaselabs
     steps:
-      - uses: actions/setup-go@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
         with:
-          go-version: 1.20.3
-      - uses: actions/checkout@v3
+          go-version: 1.21.8
       - name: Run Tests
-        run: go test -race -timeout=30m -count=1 -json -v "./..." | tee test.json | jq -s -jr 'sort_by(.Package,.Time) | .[].Output | select (. != null )'
+        run: go test -race -shuffle=on -timeout=30m -count=1 -json -v "./..." | tee test.json | jq -s -jr 'sort_by(.Package,.Time) | .[].Output | select (. != null )'
         shell: bash
       - name: Annotate Failures
         if: always()
         uses: guyarb/[email protected]
         with:
           test-results: test.json
+
   test-sgcollect:
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
         os: [macos-latest, windows-latest, ubuntu-latest]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: 3.9
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install pytest pytest-github-actions-annotate-failures
+          pip install pytest pytest-github-actions-annotate-failures pytest-httpserver trustme
       - name: Run test
         run: |
           pytest
+
+  test-stats-definition-exporter:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, windows-latest, ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: 1.21.8
+      - name: Build
+        run: go build -v "./tools/stats-definition-exporter"
+      - name: Run Tests
+        run: go test -shuffle=on -timeout=5m -count=1 -json -v "./tools/stats-definition-exporter" | tee test.json | jq -s -jr 'sort_by(.Package,.Time) | .[].Output | select (. != null )'
+        shell: bash

.github/workflows/openapi-pr.yml

@@ -0,0 +1,43 @@
+# Copyright 2024-Present Couchbase, Inc.
+#
+# Use of this software is governed by the Business Source License included in
+# the file licenses/BSL-Couchbase.txt.  As of the Change Date specified in that
+# file, in accordance with the Business Source License, use of this software
+# will be governed by the Apache License, Version 2.0, included in the file
+# licenses/APL2.txt.
+
+name: openapi-pr
+
+on:
+  pull_request:
+    # Only run when we change an API spec
+    paths:
+      - 'docs/api/**'
+    branches:
+      - 'master'
+      - 'release/*'
+      - 'beryllium'
+
+jobs:
+  redocly_preview_links:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Find Comment
+        uses: peter-evans/find-comment@v3
+        id: fc
+        with:
+          issue-number: ${{ github.event.pull_request.number }}
+          comment-author: 'github-actions[bot]'
+          body-includes: Redocly previews
+      - name: Create or update comment
+        uses: peter-evans/create-or-update-comment@v4
+        with:
+          comment-id: ${{ steps.fc.outputs.comment-id }}
+          issue-number: ${{ github.event.pull_request.number }}
+          body: |
+            ## Redocly previews
+            - [Admin API](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/couchbase/sync_gateway/${{ github.event.pull_request.head.sha }}/docs/api/admin.yaml)
+            - [Public API](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/couchbase/sync_gateway/${{ github.event.pull_request.head.sha }}/docs/api/public.yaml)
+            - [Metric API](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/couchbase/sync_gateway/${{ github.event.pull_request.head.sha }}/docs/api/metric.yaml)
+            - [Diagnostic API](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/couchbase/sync_gateway/${{ github.event.pull_request.head.sha }}/docs/api/diagnostic.yaml)
+          edit-mode: replace

.github/workflows/openapi.yml

@@ -13,9 +13,10 @@ on:
     # Only run when we change an API spec
     paths:
       - 'docs/api/**'
-    branches: 
+    branches:
       - 'master'
       - 'release/*'
+      - 'beryllium'
       - 'CBG*'
       - 'ci-*'
       - 'api-ci-*'
@@ -26,16 +27,26 @@ on:
     branches:
       - 'master'
       - 'release/*'
+      - 'beryllium'
 
 jobs:
   api_validation:
     runs-on: ubuntu-latest
     name: OpenAPI Validation
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: r7kamura/redocly-problem-matchers@v1
-      - uses: mhiew/redoc-lint-github-action@v3
+      - uses: mhiew/redoc-lint-github-action@v4
         with:
           args: '--format stylish'
         env:
           NO_COLOR: '1'
+
+  yamllint:
+    name: 'yamllint'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: karancode/yamllint-github-action@master
+        with:
+          yamllint_file_or_dir: 'docs/api'

.gitignore

@@ -18,3 +18,8 @@ verbose*.xml
 sync_gateway
 *.pb.gz
 __pycache__
+
+### Couchbase Plugin ###
+.cbcache/
+
+planPIndexes/

.golangci-strict.yml

@@ -8,28 +8,31 @@
 
 # config file for golangci-lint
 
+run:
+  timeout: 3m
+
 linters:
   enable:
-    #- bodyclose # checks whether HTTP response body is closed successfully
+    - bodyclose # checks whether HTTP response body is closed successfully
     #- dupl # Tool for code clone detection
     - errcheck # Errcheck is a program for checking for unchecked errors in go programs. These unchecked errors can be critical bugs in some cases
     #- goconst # Finds repeated strings that could be replaced by a constant
-    #- gocritic # The most opinionated Go source code linter
+    - gocritic # The most opinionated Go source code linter
     - goimports # Goimports does everything that gofmt does. Additionally it checks unused imports
     #- goprintffuncname # Checks that printf-like functions are named with `f` at the end
     #- gosec # (gas) Inspects source code for security problems
     #- gosimple # (megacheck) Linter for Go source code that specializes in simplifying a code
     - govet # (vet, vetshadow) Vet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format string
     - ineffassign # Detects when assignments to existing variables are not used
+    - misspell # Finds commonly misspelled English words in comments
     #- nakedret # Finds naked returns in functions greater than a specified function length
     #- prealloc # Finds slice declarations that could potentially be preallocated
     #- revive # Golint differs from gofmt. Gofmt reformats Go source code, whereas golint prints out style mistakes
-    #- staticcheck # (megacheck) Staticcheck is a go vet on steroids, applying a ton of static analysis checks
-    #- structcheck # Finds unused struct fields
+    - staticcheck # (megacheck) Staticcheck is a go vet on steroids, applying a ton of static analysis checks
     - typecheck # Like the front-end of a Go compiler, parses and type-checks Go code
-    #- unconvert # Remove unnecessary type conversions
+    - unconvert # Remove unnecessary type conversions
     #- unparam # Reports unused function parameters
-    #- unused # (megacheck) Checks Go code for unused constants, variables, functions and types
+    - unused # (megacheck) Checks Go code for unused constants, variables, functions and types
   disable:
     - asciicheck # Simple linter to check that your code does not contain non-ASCII identifiers
     - depguard # Go linter that checks if package imports are in a list of acceptable packages
@@ -47,31 +50,25 @@ linters:
     - gomodguard # Allow and block list linter for direct Go module dependencies.
     - interfacer # Linter that suggests narrower interface types
     - lll # Reports long lines
-    - misspell # Finds commonly misspelled English words in comments
     - nestif # Reports deeply nested if statements
     - nolintlint # Reports ill-formed or insufficient nolint directives
     - rowserrcheck # checks whether Err of rows is checked successfully
     - scopelint # Scopelint checks for unpinned variables in go programs
     - stylecheck # Stylecheck is a replacement for golint
     - testpackage # linter that makes you use a separate _test package
-    - unused # (megacheck) Checks Go code for unused constants, variables, functions and types
     - whitespace # Tool for detection of leading and trailing whitespace
     - wsl # Whitespace Linter - Forces you to use empty lines!
     # Once fixed, should enable
-    - bodyclose # checks whether HTTP response body is closed successfully
     - deadcode # Finds unused code
     - dupl # Tool for code clone detection
     - goconst # Finds repeated strings that could be replaced by a constant
-    - gocritic # The most opinionated Go source code linter
     - goprintffuncname # Checks that printf-like functions are named with `f` at the end
     - gosec # (gas) Inspects source code for security problems
     - gosimple # (megacheck) Linter for Go source code that specializes in simplifying a code
     - nakedret # Finds naked returns in functions greater than a specified function length
     - prealloc # Finds slice declarations that could potentially be preallocated
     - revive # Golint differs from gofmt. Gofmt reformats Go source code, whereas golint prints out style mistakes
-    - staticcheck # (megacheck) Staticcheck is a go vet on steroids, applying a ton of static analysis checks
     - structcheck # Finds unused struct fields
-    - unconvert # Remove unnecessary type conversions
     - unparam # Reports unused function parameters
     - varcheck # Finds unused global variables and constants
 
@@ -88,3 +85,29 @@ issues:
     - path: (_test\.go|utilities_testing\.go)
       linters:
         - goconst
+    - path: rest/debug.go
+      linters:
+        - unused
+
+linters-settings:
+  gocritic:
+    enabled-checks:
+      - ruleguard
+    disabled-checks:
+      - appendAssign
+      - assignOp
+      - badCond
+      - captLocal
+      - commentFormatting
+      - deprecatedComment
+      - elseif
+      - ifElseChain
+      - regexpMust
+      - singleCaseSwitch
+      - sloppyLen
+      - unlambda
+      - valSwap
+      - wrapperFunc
+    settings:
+      ruleguard:
+        rules: '${configDir}/ruleguard/*.go'