Release 0.5.0 (#100)

Co-authored-by: Surabhi Bhat <[email protected]>
Co-authored-by: Inel Pandzic <[email protected]>
Co-authored-by: Oleksandr Miroshnychenko <[email protected]>

Author: 4 people

.github/workflows/e2etests.yml

@@ -41,10 +41,10 @@ jobs:
         run: |
           make test-build
 
-      - name: Run Percona-MongoLink
+      - name: Run PLM
         run: |
           echo "Starting project..."
-          bin/pml_test \
+          bin/plm_test \
             --source="mongodb://source:pass@rs00:30000" \
             --target="mongodb://target:pass@rs10:30100" \
             --reset-state --start --log-level debug &> server.log &
@@ -57,7 +57,7 @@ jobs:
         run: |
           export TEST_SOURCE_URI=mongodb://adm:pass@rs00:30000
           export TEST_TARGET_URI=mongodb://adm:pass@rs10:30100
-          export TEST_MONGOLINK_URL=http://127.0.0.1:2242
+          export TEST_PLM_URL=http://127.0.0.1:2242
           poetry run pytest
 
       - name: Show server logs (on failure)

Makefile

@@ -20,11 +20,11 @@ all: build
 
 # Build production binary (optimized for runtime speed and size)
 build:
-	go build $(BUILD_FLAGS) -o bin/pml .
+	go build $(BUILD_FLAGS) -o bin/plm .
 
 # Build test binary with race detection and debugging enabled
 test-build:
-	go build $(TEST_BUILD_FLAGS) -o bin/pml_test .
+	go build $(TEST_BUILD_FLAGS) -o bin/plm_test .
 
 # Run tests with race detection
 test:

README.md

@@ -1,6 +1,6 @@
-# Percona MongoLink
+# Percona Link for MongoDB
 
-Percona MongoLink is a tool for replicating data from a source MongoDB cluster to a target MongoDB cluster. It supports cloning data, replicating changes, and managing collections and indexes.
+Percona Link for MongoDB is a tool for replicating data from a source MongoDB cluster to a target MongoDB cluster. It supports cloning data, replicating changes, and managing collections and indexes.
 
 ## Features
 
@@ -24,8 +24,8 @@ Percona MongoLink is a tool for replicating data from a source MongoDB cluster t
 1. Clone the repository:
 
     ```sh
-    git clone https://github.com/percona/percona-mongolink.git
-    cd percona-mongolink
+    git clone https://github.com/percona/percona-link-mongodb.git
+    cd percona-link-mongodb
     ```
 
 2. Build the project using the Makefile:
@@ -34,30 +34,28 @@ Percona MongoLink is a tool for replicating data from a source MongoDB cluster t
     make build
     ```
 
-    Alternatively, you can install MongoLink from the cloned repo using `go install`:
+    Alternatively, you can install PLM from the cloned repo using `go install`:
 
     ```sh
     go install .
     ```
 
-    > This will install `percona-mongolink` into your `GOBIN` directory. If `GOBIN` is included in your `PATH`, you can run MongoLink by typing `percona-mongolink` in your terminal.
+    > This will install `plm` into your `GOBIN` directory. If `GOBIN` is included in your `PATH`, you can run Percona Link for MongoDB by typing `plm` in your terminal.
 
 3. Run the server:
 
     ```sh
-    bin/pml --source <source-mongodb-uri> --target <target-mongodb-uri>
+    bin/plm --source <source-mongodb-uri> --target <target-mongodb-uri>
     ```
 
     Alternatively, you can use environment variables:
 
     ```sh
-    export SOURCE_URI=<source-mongodb-uri>
-    export TARGET_URI=<target-mongodb-uri>
-    bin/pml --source $SOURCE_URI --target $TARGET_URI
+    export PLM_SOURCE_URI=<source-mongodb-uri>
+    export PLM_TARGET_URI=<target-mongodb-uri>
+    bin/plm
     ```
 
-    > Connections to the source and target must have `readPreference=primary` and `writeConcern=majority` explicitly or unset.
-
 ## Usage
 
 ### Starting the Replication
@@ -67,7 +65,7 @@ To start the replication process, you can either use the command-line interface
 #### Using Command-Line Interface
 
 ```sh
-bin/pml start
+bin/plm start
 ```
 
 #### Using HTTP API
@@ -86,7 +84,7 @@ To finalize the replication process, you can either use the command-line interfa
 #### Using Command-Line Interface
 
 ```sh
-bin/pml finalize
+bin/plm finalize
 ```
 
 #### Using HTTP API
@@ -102,7 +100,7 @@ To pause the replication process, you can either use the command-line interface
 #### Using Command-Line Interface
 
 ```sh
-bin/pml pause
+bin/plm pause
 ```
 
 #### Using HTTP API
@@ -118,7 +116,7 @@ To resume the replication process, you can either use the command-line interface
 #### Using Command-Line Interface
 
 ```sh
-bin/pml resume
+bin/plm resume
 ```
 
 #### Using HTTP API
@@ -134,7 +132,7 @@ To check the current status of the replication process, you can either use the c
 #### Using Command-Line Interface
 
 ```sh
-bin/pml status
+bin/plm status
 ```
 
 #### Using HTTP API
@@ -143,9 +141,9 @@ bin/pml status
 curl http://localhost:2242/status
 ```
 
-## MongoLink Options
+## PLM Options
 
-When starting the MongoLink server, you can use the following options:
+When starting the PLM server, you can use the following options:
 
 - `--port`: The port on which the server will listen (default: 2242)
 - `--source`: The MongoDB connection string for the source cluster
@@ -157,7 +155,7 @@ When starting the MongoLink server, you can use the following options:
 Example:
 
 ```sh
-bin/pml \
+bin/plm \
     --source <source-mongodb-uri> \
     --target <target-mongodb-uri> \
     --port 2242 \
@@ -188,7 +186,7 @@ Example:
   "message": "Cloned db_1.coll_1" }
 
 { "level": "info",
-  "s": "mongolink",
+  "s": "plm",
   "elapsed_secs": 0,
   "time": "2025-02-23 11:26:03.857",
   "message": "Change replication stopped at 1740335163.1740335163 source cluster time" }
@@ -261,7 +259,7 @@ Resumes the replication process.
 
 #### Request Body
 
-- `fromFailure` (optional): Allows PML to resume from failed state
+- `fromFailure` (optional): Allows PLM to resume from failed state
 
 Example:
 
@@ -284,7 +282,7 @@ Example:
 
 ### GET /status
 
-The /status endpoint provides the current state of the MongoLink replication process, including its progress, lag, and event processing details.
+The /status endpoint provides the current state of the PLM replication process, including its progress, lag, and event processing details.
 
 #### Response
 
@@ -359,25 +357,25 @@ To run the tests, use the following command:
 poetry run pytest \
     --source-uri <source-mongodb-uri> \
     --target-uri <target-mongodb-uri> \
-    --mongolink-url http://localhost:2242 \
-    --mongolink-bin bin/pml_test
+    --plm_url http://localhost:2242 \
+    --plm-bin bin/plm_test
 ```
 
 Alternatively, you can use environment variables:
 
 ```sh
 export TEST_SOURCE_URI=<source-mongodb-uri>
 export TEST_TARGET_URI=<target-mongodb-uri>
-export TEST_MONGOLINK_URL=http://localhost:2242
-export TEST_MONGOLINK_BIN=bin/pml_test
+export TEST_PLM_URL=http://localhost:2242
+export TEST_PLM_BIN=bin/plm_test
 poetry run pytest
 ```
 
-> The `--mongolink-bin` flag or `TEST_MONGOLINK_BIN` environment variable specifies the path to the MongoLink binary. This allows the test suite to manage the MongoLink process, ensuring it starts and stops as needed during the tests. If neither the flag nor the environment variable is provided, you must run MongoLink externally before running the tests.
+> The `--plm-bin` flag or `TEST_PLM_BIN` environment variable specifies the path to the PLM binary. This allows the test suite to manage the PLM process, ensuring it starts and stops as needed during the tests. If neither the flag nor the environment variable is provided, you must run PLM externally before running the tests.
 
 ## Contributing
 
-Contributions are welcome. Please open a [JIRA](https://perconadev.atlassian.net/jira/software/c/projects/PML/issues) issue describing the proposed change, then submit a pull request on GitHub.
+Contributions are welcome. Please open a [JIRA](https://perconadev.atlassian.net/jira/software/c/projects/PLM/issues) issue describing the proposed change, then submit a pull request on GitHub.
 
 ## License
 

config/const.go

@@ -20,8 +20,8 @@ const (
 
 // MongoDB database and collection names.
 const (
-	// MongoLinkDatabase is the name of the MongoDB database used by MongoLink.
-	MongoLinkDatabase = "percona_mongolink"
+	// PLMDatabase is the name of the MongoDB database used by PLM.
+	PLMDatabase = "percona_link_mongodb"
 	// RecoveryCollection is the name of the collection used for recovery data.
 	RecoveryCollection = "checkpoints"
 	// HeartbeatCollection is the name of the collection used for heartbeats.

config/values.go

@@ -12,31 +12,31 @@ import (
 
 // UseCollectionBulkWrite determines whether to use the Collection Bulk Write API
 // instead of the Client Bulk Write API (introduced in MongoDB v8.0).
-// Enabled when the PML_USE_COLLECTION_BULK_WRITE environment variable is set to "1".
+// Enabled when the PLM_USE_COLLECTION_BULK_WRITE environment variable is set to "1".
 func UseCollectionBulkWrite() bool {
-	return os.Getenv("PML_USE_COLLECTION_BULK_WRITE") == "1"
+	return os.Getenv("PLM_USE_COLLECTION_BULK_WRITE") == "1"
 }
 
 // CloneNumParallelCollections returns the number of collections cloned in parallel
 // during the clone process. Default is 0.
 func CloneNumParallelCollections() int {
-	numColl, _ := strconv.ParseInt(os.Getenv("PML_CLONE_NUM_PARALLEL_COLLECTIONS"), 10, 32)
+	numColl, _ := strconv.ParseInt(os.Getenv("PLM_CLONE_NUM_PARALLEL_COLLECTIONS"), 10, 32)
 
 	return int(numColl)
 }
 
 // CloneNumReadWorkers returns the number of read workers used during the clone. Default is 0.
 // Note: Workers are shared across all collections.
 func CloneNumReadWorkers() int {
-	numReadWorker, _ := strconv.ParseInt(os.Getenv("PML_CLONE_NUM_READ_WORKERS"), 10, 32)
+	numReadWorker, _ := strconv.ParseInt(os.Getenv("PLM_CLONE_NUM_READ_WORKERS"), 10, 32)
 
 	return int(numReadWorker)
 }
 
 // CloneNumInsertWorkers returns the number of insert workers used during the clone. Default is 0.
 // Note: Workers are shared across all collections.
 func CloneNumInsertWorkers() int {
-	numInsertWorker, _ := strconv.ParseInt(os.Getenv("PML_CLONE_NUM_INSERT_WORKERS"), 10, 32)
+	numInsertWorker, _ := strconv.ParseInt(os.Getenv("PLM_CLONE_NUM_INSERT_WORKERS"), 10, 32)
 
 	return int(numInsertWorker)
 }
@@ -46,7 +46,7 @@ func CloneNumInsertWorkers() int {
 // operations by splitting the collection into multiple parallelizable units.
 // Zero or less enables auto size (per each collection). Default is [AutoCloneSegmentSize].
 func CloneSegmentSizeBytes() int64 {
-	segmentSizeBytes, _ := humanize.ParseBytes(os.Getenv("PML_CLONE_SEGMENT_SIZE"))
+	segmentSizeBytes, _ := humanize.ParseBytes(os.Getenv("PLM_CLONE_SEGMENT_SIZE"))
 	if segmentSizeBytes == 0 {
 		return AutoCloneSegmentSize
 	}
@@ -56,16 +56,16 @@ func CloneSegmentSizeBytes() int64 {
 
 // CloneReadBatchSizeBytes returns the read batch size in bytes used during the clone. Default is 0.
 func CloneReadBatchSizeBytes() int32 {
-	batchSizeBytes, _ := humanize.ParseBytes(os.Getenv("PML_CLONE_READ_BATCH_SIZE"))
+	batchSizeBytes, _ := humanize.ParseBytes(os.Getenv("PLM_CLONE_READ_BATCH_SIZE"))
 
 	return int32(min(batchSizeBytes, math.MaxInt32)) //nolint:gosec
 }
 
 // UseTargetClientCompressors returns a list of enabled compressors (from "zstd", "zlib", "snappy")
 // for the target MongoDB client connection, as specified by the comma-separated environment
-// variable PML_DEV_TARGET_CLIENT_COMPRESSORS. If unset or empty, returns nil.
+// variable PLM_DEV_TARGET_CLIENT_COMPRESSORS. If unset or empty, returns nil.
 func UseTargetClientCompressors() []string {
-	s := strings.TrimSpace(os.Getenv("PML_DEV_TARGET_CLIENT_COMPRESSORS"))
+	s := strings.TrimSpace(os.Getenv("PLM_DEV_TARGET_CLIENT_COMPRESSORS"))
 	if s == "" {
 		return nil
 	}

go.mod

@@ -1,4 +1,4 @@
-module github.com/percona/percona-mongolink
+module github.com/percona/percona-link-mongodb
 
 go 1.24
 

heartbeat.go

@@ -8,17 +8,17 @@ import (
 	"go.mongodb.org/mongo-driver/v2/mongo"
 	"go.mongodb.org/mongo-driver/v2/mongo/options"
 
-	"github.com/percona/percona-mongolink/config"
-	"github.com/percona/percona-mongolink/errors"
-	"github.com/percona/percona-mongolink/log"
+	"github.com/percona/percona-link-mongodb/config"
+	"github.com/percona/percona-link-mongodb/errors"
+	"github.com/percona/percona-link-mongodb/log"
 )
 
 var (
 	errConcurrentProcess = errors.New("detected concurrent process")
 	errStaleHeartbeat    = errors.New("stale heartbeat")
 )
 
-const heartbeatID = "mongolink"
+const heartbeatID = "plm"
 
 type StopHeartbeat func(context.Context) error
 
@@ -142,7 +142,7 @@ func doFirstHeartbeat(ctx context.Context, m *mongo.Client) (int64, error) {
 
 	currBeat := time.Now().Unix()
 
-	_, err := m.Database(config.MongoLinkDatabase).
+	_, err := m.Database(config.PLMDatabase).
 		Collection(config.HeartbeatCollection).
 		InsertOne(timeoutCtx, bson.D{{"_id", heartbeatID}, {"time", currBeat}})
 	if err == nil {
@@ -153,7 +153,7 @@ func doFirstHeartbeat(ctx context.Context, m *mongo.Client) (int64, error) {
 		return 0, err //nolint:wrapcheck
 	}
 
-	raw, err := m.Database(config.MongoLinkDatabase).
+	raw, err := m.Database(config.PLMDatabase).
 		Collection(config.HeartbeatCollection).
 		FindOne(ctx, bson.D{{"_id", heartbeatID}}).
 		Raw()
@@ -181,7 +181,7 @@ func doHeartbeat(ctx context.Context, m *mongo.Client, lastBeat int64) (int64, e
 
 	currBeat := time.Now().Unix()
 
-	raw, err := m.Database(config.MongoLinkDatabase).
+	raw, err := m.Database(config.PLMDatabase).
 		Collection(config.HeartbeatCollection).
 		FindOneAndUpdate(timeoutCtx,
 			bson.D{{"_id", heartbeatID}},
@@ -206,7 +206,7 @@ func doHeartbeat(ctx context.Context, m *mongo.Client, lastBeat int64) (int64, e
 }
 
 func DeleteHeartbeat(ctx context.Context, m *mongo.Client) error {
-	_, err := m.Database(config.MongoLinkDatabase).
+	_, err := m.Database(config.PLMDatabase).
 		Collection(config.HeartbeatCollection).
 		DeleteOne(ctx, bson.D{{"_id", heartbeatID}})
 

log/log.go

@@ -1,4 +1,4 @@
-// Package log provides logging utilities for the MongoLink application.
+// Package log provides logging utilities for the PLM application.
 package log
 
 import (