feat(main): 🚀 Database Name Correction and S3 Module Int32 Overflow Fix with Go Routine Integration for Automated Checks and Script Optimization (#1799)

* feat: replace mongo database openIM_v3 to openim_v3

* openim-building-an-efficient-version-control-and-testing-workflow

* feat: complete openim source deployment rpc start timeout

* feat: optimize config

Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com>

* feat: add scripts format

* feat: use scripts format code

* fix cos and minio etc to typecheck

* feat: scripts make verify check ci

* fix: make file verify spelling

* fix: make file verify spelling

* Concurrent Type Checking and Cross-Platform Development in Go

* feat: add copyright make lint and format

* feat: add config examples file

Signed-off-by: Xinwei Xiong <3293172751@qq.com>

* feat: add config examples file

Signed-off-by: Xinwei Xiong <3293172751@qq.com>

---------

Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com>
Signed-off-by: Xinwei Xiong <3293172751@qq.com>

.devcontainer/devcontainer.json

@@ -2,7 +2,6 @@
     // Reference Doc: https://code.visualstudio.com/remote/advancedcontainers/overview
     "name": "OpenIM Dev Environment",
     // Update the container version when you publish dev-container
-    "dockerComposeFile": "docker-compose.yml",
     "build": { "dockerfile": "Dockerfile" },
     // Replace with uncommented line below to build your own local copy of the image
     // "dockerFile": "../docker/Dockerfile-dev",

.github/workflows/help-comment-issue.yml

@@ -17,6 +17,7 @@ on:
   issues:
     types:
       - labeled
+
 jobs:
   add-comment:
     if: github.event.label.name == 'help wanted' || github.event.label.name == 'good first issue'

.github/workflows/openimci.yml

@@ -23,6 +23,8 @@ on:
         - "docs/**"
         - "README.md"
         - "README_zh-CN.md"
+        - "**.md"
+        - "docs/**"
         - "CONTRIBUTING.md"
   pull_request:
     branches:
@@ -31,7 +33,8 @@ on:
     paths-ignore:
         - "README.md"
         - "README_zh-CN.md"
-        - "CONTRIBUTING.md"
+        - "CONTRIBUTING/**"
+        - "**.md"
         - "docs/**"
 
 env:
@@ -67,6 +70,9 @@ jobs:
         version: '3.x' # If available, use the latest major version that's compatible
         repo-token: ${{ secrets.GITHUB_TOKEN }}
 
+    - name: OpenIM Scripts Verification(make verify)
+      run: sudo make verify
+
     - name: Module Operations
       run: |
         sudo make tidy
@@ -91,13 +97,6 @@ jobs:
     - name: Cleanup Build
       run: sudo make clean
 
-    - name: Push Changes to Main
-      uses: stefanzweifel/git-auto-commit-action@v5
-      with:
-        commit_message: "cicd: robot automated Change"
-        branch: main
-      continue-on-error: true
-
     - name: Set Current Directory
       id: set_directory
       run: echo "::set-output name=directory::$(pwd)"

.gitignore

@@ -34,6 +34,7 @@ deployments/charts/generated-configs/
 ### OpenIM Config ###
 .env
 config/config.yaml
+config/openim.yaml
 config/alertmanager.yml
 config/prometheus.yml
 config/email.tmpl

CHANGELOG/CHANGELOG-3.5.0.md

@@ -1,15 +0,0 @@
-# Version logging for OpenIM
-
-<!-- BEGIN MUNGE: GENERATED_TOC -->
-
-<!-- END MUNGE: GENERATED_TOC -->
-
-<a name="unreleased"></a>
-## [Unreleased]
-
-
-<a name="v3.5.0+3.97baaac"></a>
-## [v3.5.0+3.97baaac] - 2024-01-12
-
-[Unreleased]: https://github.com/openimsdk/open-im-server/compare/v3.5.0+3.97baaac...HEAD
-[v3.5.0+3.97baaac]: https://github.com/openimsdk/open-im-server/compare/v3.5.0+5.950e970...v3.5.0+3.97baaac

README.md

@@ -42,7 +42,7 @@ OpenIM is a service platform specifically designed for integrating chat, audio-v
   - 🛡️ API wrapping
   - 🌐 Connection management
 
-  ## 📚 Main Modules:
++ 📚 Main Modules:
 
   1. 🚀 Initialization and Login
   2. 👤 User Management
@@ -70,11 +70,16 @@ It is built using Golang and supports cross-platform deployment, ensuring a cons
 
 ## :rocket: Quick Start
 
+We support many platforms. Here are the addresses for quick experience on the web side：
+
+👉 **[OpenIM online web demo](https://web-enterprise.rentsoft.cn/)**
+
 🤲 To facilitate user experience, we offer various deployment solutions. You can choose your deployment method from the list below:
 
 + **[Source Code Deployment Guide](https://docs.openim.io/guides/gettingStarted/imSourceCodeDeployment)**
 + **[Docker Deployment Guide](https://docs.openim.io/guides/gettingStarted/dockerCompose)**
 + **[Kubernetes Deployment Guide](https://docs.openim.io/guides/gettingStarted/k8s-deployment)**
++ **[Mac Developer Deployment Guide](https://docs.openim.io/guides/gettingstarted/mac-deployment-guide)**
 
 ## :hammer_and_wrench: To Start Developing OpenIM
 

config/templates/config.yaml.template

@@ -14,7 +14,7 @@
 
 # -----------------------------------------------------------------
 # TODO: This config file is the template file
-# --| source: deployments/templates/openim.yaml
+# --| source: deployments/templates/config.yaml
 # --| env: scripts/install/environment
 # --| target: config/config.yaml
 # -----------------------------------------------------------------
@@ -52,8 +52,8 @@ mongo:
 # Default MongoDB database name
 # Maximum connection pool size
   address: [ 172.28.0.1:37017 ]
-  database: openIM_v3
+  database: openim_v3
-  username: root
+  username: openIM
   password: openIM123
   maxPoolSize: 100
 
@@ -122,14 +122,14 @@ api:
 # minio.signEndpoint is minio public network address
 object:
   enable: "minio"
-  apiURL: "http://14.155.64.202:10002"
+  apiURL: "http://172.28.0.1:10002"
   minio:
     bucket: "openim"
     endpoint: "http://172.28.0.1:10005"
     accessKeyID: "root"
     secretAccessKey: "openIM123"
     sessionToken: ''
-    signEndpoint: "http://14.155.64.202:10005"
+    signEndpoint: "http://172.28.0.1:10005"
     publicRead: false
   cos:
     bucketURL: https://temp-1252357374.cos.ap-chengdu.myqcloud.com
@@ -193,7 +193,7 @@ rpcRegisterName:
 # Whether to output in json format
 # Whether to include stack trace in logs
 log:
-  storageLocation: /data/workspaces/open-im-server/logs/
+  storageLocation: /workspaces/open-im-server/logs/
   rotationTime: 24
   remainRotationCount: 2
   remainLogLevel: 6
@@ -247,6 +247,14 @@ manager:
   userID: [ "openIM123456", "openIM654321", "openIMAdmin" ]
   nickname: [ "system1", "system2", "system3" ]
 
+# chatAdmin, use for send notification
+#
+# Built-in app system notification account ID
+# Built-in app system notification account nickname
+im-admin:
+  userID: [ "imAdmin" ]
+  nickname: [ "imAdmin" ]
+
 # Multi-platform login policy
 # For each platform(Android, iOS, Windows, Mac, web), only one can be online at a time
 multiLoginPolicy: 1
@@ -307,7 +315,7 @@ iosPush:
 # Timeout in seconds
 # Whether to continue execution if callback fails
 callback:
-  url: ""
+  url: "http://127.0.0.1:10008/callbackExample"
   beforeSendSingleMsg:
     enable: false
     timeout: 5
@@ -321,7 +329,7 @@ callback:
     timeout: 5
     failedContinue: true
   afterSendSingleMsg:
-    enable: false
+    enable: true
     timeout: 5
     failedContinue: true
   beforeSendGroupMsg:
@@ -505,8 +513,8 @@ callback:
 # The number of Prometheus ports per service needs to correspond to rpcPort
 # The number of ports needs to be consistent with msg_transfer_service_num in script/path_info.sh
 prometheus:
-  enable: false
+  enable: true
-  grafanaUrl: 172.28.0.1:13000
+  grafanaUrl: http://172.28.0.1:13000/
   apiPrometheusPort: [20100]
   userPrometheusPort: [ 20110 ]
   friendPrometheusPort: [ 20120 ]

config/templates/env.template

@@ -1,4 +1,4 @@
-# Copyright © 2023 OpenIM. All rights reserved.
+# Copyright © 2024 OpenIM. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,31 +12,26 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# ======================================
+# -----------------------------------------------------------------------------
-# ========= Basic Configuration ========
+# General Configuration
-# ======================================
+# This section contains general configuration options for the entire environment.
+# These options can be set via environment variables. If both environment variables 
+# and settings in this .env file exist, the environment variables take precedence.
+# -----------------------------------------------------------------------------
+# ==========================
+# General Configuration
+# ==========================
+# These settings apply to the overall environment.
 
-# The user for authentication or system operations.
+# Data storage directory for persistent data.
-# Default: OPENIM_USER=root
+# Example: DATA_DIR=/path/to/data
-USER=root
+DATA_DIR=/workspaces/open-im-server
 
-# Password associated with the specified user for authentication.
+# Docker image registry. Uncomment the preferred one.
-# Default: PASSWORD=openIM123
+# Options: ghcr.io/openimsdk, openim, registry.cn-hangzhou.aliyuncs.com/openimsdk
-PASSWORD=openIM123
+# IMAGE_REGISTRY="ghcr.io/openimsdk"
-
+# IMAGE_REGISTRY="openim"
-# Base URL for the application programming interface (API).
+# IMAGE_REGISTRY="registry.cn-hangzhou.aliyuncs.com/openimsdk"
-# Default: API_URL=http://172.28.0.1:10002
-API_URL=http://14.155.64.202:10002
-
-# Directory path for storing data files or related information.
-# Default: DATA_DIR=./
-DATA_DIR=/data/workspaces/open-im-server
-
-# Choose the appropriate image address, the default is GITHUB image, 
-# you can choose docker hub, for Chinese users can choose Ali Cloud
-# export IMAGE_REGISTRY="ghcr.io/openimsdk"
-# export IMAGE_REGISTRY="openim"
-# export IMAGE_REGISTRY="registry.cn-hangzhou.aliyuncs.com/openimsdk"
 IMAGE_REGISTRY=ghcr.io/openimsdk
 
 # ======================================
@@ -47,10 +42,9 @@ IMAGE_REGISTRY=ghcr.io/openimsdk
 # Default: DOCKER_BRIDGE_SUBNET=172.28.0.0/16
 DOCKER_BRIDGE_SUBNET=172.28.0.0/16
 
-# Gateway for the Docker network.
+# Set and specify the IP addresses of some containers. Generally speaking, 
-# Default: DOCKER_BRIDGE_GATEWAY=172.28.0.1
+# you do not need to modify these configurations to facilitate debugging
 DOCKER_BRIDGE_GATEWAY=172.28.0.1
-
 MONGO_NETWORK_ADDRESS=172.28.0.2
 REDIS_NETWORK_ADDRESS=172.28.0.3
 KAFKA_NETWORK_ADDRESS=172.28.0.4
@@ -65,45 +59,66 @@ NODE_EXPORTER_NETWORK_ADDRESS=172.28.0.12
 OPENIM_ADMIN_FRONT_NETWORK_ADDRESS=172.28.0.13
 ALERT_MANAGER_NETWORK_ADDRESS=172.28.0.14
 
-# ===============================================
+# ==============================================================================
-# = Component Extension Configuration =
+# Configuration Update Instructions
-# ===============================================
+# ==============================================================================
+# This header outlines the methods to update common variables in config.yaml and .env files.
+# These instructions are vital for maintaining the OpenIM environment's configuration.
+#
+# METHOD 1: Regenerate All Configurations
+# ----------------------------------------
+# Use this method to regenerate all configurations.
+# Steps:
+#   1. Delete existing config files:
+#      - openim-server/config/config.yaml
+#      - openim-chat/config/config.yaml
+#   2. Modify the .env file as required.
+#   3. Run 'docker compose up -d'. This will regenerate:
+#       - config/config.yaml
+#
+# METHOD 2: Modify Individual Configuration Files
+# -----------------------------------------------
+# Use this method to update specific configuration files.
+# Steps:
+#   1. Modify the .env file as necessary.
+#   2. Update the corresponding entries in:
+#      - config/config.yaml
+#   3. Restart the services with 'docker compose up -d'.
+#   4. Special Note: If you modify OPENIM_IP, API_OPENIM_PORT, or MINIO_PORT in .env,
+#      ensure to update the corresponding services and configurations accordingly.
+#
+# It is essential to follow these methods to ensure consistent and correct application behavior.
+# ==============================================================================
+# Local IP address of the service. Modify if necessary.
+# Example: OPENIM_IP=172.28.0.1，
+OPENIM_IP=172.28.0.1
 
-# ============ Component Extension Configuration ==========
 # ----- ZooKeeper Configuration -----
-# Address or hostname for the ZooKeeper service.
-# Default: ZOOKEEPER_ADDRESS=172.28.0.1
-ZOOKEEPER_ADDRESS=172.28.0.5
-
 # Port for ZooKeeper service.
 # Default: ZOOKEEPER_PORT=12181
 ZOOKEEPER_PORT=12181
 
-# ----- MongoDB Configuration -----
+# MongoDB service port configuration.
-# Address or hostname for the MongoDB service.
-# Default: MONGO_ADDRESS=172.28.0.1
-MONGO_ADDRESS=172.28.0.2
-
-# Port on which MongoDB service is running.
 # Default: MONGO_PORT=37017
 # MONGO_PORT=37017
 
-# Username to authenticate with the MongoDB service.
+# Password for MongoDB admin user. Used for service authentication.
-# Default: MONGO_USERNAME=root
-# MONGO_USERNAME=root
-
-# Password to authenticate with the MongoDB service.
 # Default: MONGO_PASSWORD=openIM123
 MONGO_PASSWORD=openIM123
 
-# Name of the database in MongoDB to be used.
+# Username for a regular OpenIM user in MongoDB.
-# Default: MONGO_DATABASE=openIM_v3
+# Default: MONGO_OPENIM_USERNAME=openIM
-MONGO_DATABASE=openIM_v3
+MONGO_OPENIM_USERNAME=openIM
+
+# Password for a regular OpenIM user in MongoDB.
+# Default: MONGO_OPENIM_PASSWORD=openIM123456
+MONGO_OPENIM_PASSWORD=openIM123
+
+# Specifies the database name to be used within MongoDB.
+# Default: MONGO_DATABASE=openim_v3
+MONGO_DATABASE=openim_v3
 
 # ----- Redis Configuration -----
-# Address or hostname for the Redis service.
-# Default: REDIS_ADDRESS=172.28.0.1
-REDIS_ADDRESS=172.28.0.3
 
 # Port on which Redis in-memory data structure store is running.
 # Default: REDIS_PORT=16379
@@ -113,11 +128,6 @@ REDIS_PORT=16379
 # Default: REDIS_PASSWORD=openIM123
 REDIS_PASSWORD=openIM123
 
-# ----- Kafka Configuration -----
-# Address or hostname for the Kafka service.
-# Default: KAFKA_ADDRESS=172.28.0.1
-KAFKA_ADDRESS=172.28.0.4
-
 # Kakfa username to authenticate with the Kafka service.
 # KAFKA_USERNAME=''
 
@@ -129,20 +139,13 @@ KAFKA_PORT=19094
 # Default: KAFKA_LATESTMSG_REDIS_TOPIC=latestMsgToRedis
 KAFKA_LATESTMSG_REDIS_TOPIC=latestMsgToRedis
 
-# Topic in Kafka for pushing messages (e.g. notifications or updates).
+# MINIO_PORT
-# Default: KAFKA_MSG_PUSH_TOPIC=msgToPush
+# ----------
-KAFKA_MSG_PUSH_TOPIC=msgToPush
+# MINIO_PORT sets the port for the MinIO object storage service.
-
+# Upon changing this port, the MinIO endpoint URLs in the  file must be updated
-# Topic in Kafka for storing offline messages in MongoDB.
+# to reflect this change. The endpoints include both the 'endpoint' and 'signEndpoint' 
-# Default: KAFKA_OFFLINEMSG_MONGO_TOPIC=offlineMsgToMongoMysql
+# under the MinIO configuration.
-KAFKA_OFFLINEMSG_MONGO_TOPIC=offlineMsgToMongoMysql
+#
-
-# ----- MinIO Configuration ----
-# Address or hostname for the MinIO object storage service.
-# Default: MINIO_ADDRESS=172.28.0.1
-MINIO_ADDRESS=172.28.0.6
-
-# Port on which MinIO object storage service is running.
 # Default: MINIO_PORT=10005
 MINIO_PORT=10005
 
@@ -155,19 +158,11 @@ MINIO_PORT=10005
 MINIO_SECRET_KEY=openIM123
 
 # ----- Prometheus Configuration -----
-# Address or hostname for the Prometheus service.
-# Default: PROMETHEUS_ADDRESS=172.28.0.1
-PROMETHEUS_ADDRESS=172.28.0.10
-
 # Port on which Prometheus service is running.
 # Default: PROMETHEUS_PORT=19090
 PROMETHEUS_PORT=19090
 
 # ----- Grafana Configuration -----
-# Address or hostname for the Grafana service.
-# Default: GRAFANA_ADDRESS=172.28.0.1
-GRAFANA_ADDRESS=172.28.0.11
-
 # Port on which Grafana service is running.
 # Default: GRAFANA_PORT=13000
 GRAFANA_PORT=13000
@@ -183,41 +178,34 @@ OPENIM_WEB_PORT=11001
 # ======================================
 # ========= OpenIM Server ==============
 # ======================================
-
-# Address or hostname for the OpenIM server.
-# Default: OPENIM_SERVER_ADDRESS=172.28.0.1
-OPENIM_SERVER_ADDRESS=172.28.0.8
-
 # Port for the OpenIM WebSockets.
 # Default: OPENIM_WS_PORT=10001
 OPENIM_WS_PORT=10001
 
-# Port for the OpenIM API.
+# API_OPENIM_PORT
+# ---------------
+# This variable defines the port on which the OpenIM API service will listen.
+# When changing this port, it's essential to update the apiURL in the config.yaml file
+# to ensure the API service is accessible at the new port.
+#
 # Default: API_OPENIM_PORT=10002
 API_OPENIM_PORT=10002
 
-
 # ======================================
 # ========== OpenIM Chat ===============
 # ======================================
 
 # Branch name for OpenIM chat.
 # Default: CHAT_IMAGE_VERSION=main
-# https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/version.md
 CHAT_IMAGE_VERSION=main
 
-# Address or hostname for the OpenIM chat service.
-# Default: OPENIM_CHAT_ADDRESS=172.28.0.1
-OPENIM_CHAT_ADDRESS=172.28.0.9
-
 # Port for the OpenIM chat API.
 # Default: OPENIM_CHAT_API_PORT=10008
 OPENIM_CHAT_API_PORT=10008
 
-# Directory path for storing data files or related information for OpenIM chat.
+# Port for the OpenIM admin API.
-# Default: OPENIM_CHAT_DATA_DIR=./openim-chat/main
+# Default: OPENIM_ADMIN_API_PORT=10009
-OPENIM_CHAT_DATA_DIR=./openim-chat/main
+OPENIM_ADMIN_API_PORT=10009
-
 
 # ======================================
 # ========== OpenIM Admin ==============
@@ -227,10 +215,6 @@ OPENIM_CHAT_DATA_DIR=./openim-chat/main
 # Default: SERVER_IMAGE_VERSION=main
 SERVER_IMAGE_VERSION=main
   
-# Port for the OpenIM admin API.
-# Default: OPENIM_ADMIN_API_PORT=10009
-OPENIM_ADMIN_API_PORT=10009
-  
 # Port for the node exporter.
 # Default: NODE_EXPORTER_PORT=19100
 NODE_EXPORTER_PORT=19100

deployments/Readme.md

@@ -165,7 +165,7 @@ export MINIO_ENDPOINT="http://im-minio:9000"
 export MINIO_SIGN_ENDPOINT="https://openim.server.com/im-minio-api"
 
 mkdir ./charts/generated-configs
-../scripts/genconfig.sh ../scripts/install/environment.sh ./templates/openim.yaml > ./charts/generated-configs/config.yaml
+../scripts/genconfig.sh ../scripts/install/environment.sh ./templates/config.yaml > ./charts/generated-configs/config.yaml
 cp ../config/notification.yaml ./charts/generated-configs/notification.yaml
 ../scripts/genconfig.sh ../scripts/install/environment.sh ./templates/helm-image.yaml > ./charts/generated-configs/helm-image.yaml
 ```

deployments/templates/config.yaml

@@ -14,7 +14,7 @@
 
 # -----------------------------------------------------------------
 # TODO: This config file is the template file
-# --| source: deployments/templates/openim.yaml
+# --| source: deployments/templates/config.yaml
 # --| env: scripts/install/environment
 # --| target: config/config.yaml
 # -----------------------------------------------------------------

deployments/templates/env-template.yaml

@@ -115,7 +115,7 @@ MONGO_OPENIM_USERNAME=${MONGO_OPENIM_USERNAME}
 MONGO_OPENIM_PASSWORD=${MONGO_OPENIM_PASSWORD}
 
 # Specifies the database name to be used within MongoDB.
-# Default: MONGO_DATABASE=openIM_v3
+# Default: MONGO_DATABASE=openim_v3
 MONGO_DATABASE=${MONGO_DATABASE}
 
 # ----- Redis Configuration -----

docker-compose.yml

@@ -27,7 +27,7 @@ services:
       - wiredTigerCacheSizeGB=1
       - MONGO_INITDB_ROOT_USERNAME=${MONGO_USERNAME:-root}
       - MONGO_INITDB_ROOT_PASSWORD=${MONGO_PASSWORD:-openIM123}
-      - MONGO_INITDB_DATABASE=${MONGO_DATABASE:-openIM_v3}
+      - MONGO_INITDB_DATABASE=${MONGO_DATABASE:-openim_v3}
       - MONGO_OPENIM_USERNAME=${MONGO_OPENIM_USERNAME:-openIM} # Non-root username
       - MONGO_OPENIM_PASSWORD=${MONGO_OPENIM_PASSWORD:-openIM123456} # Non-root password
     restart: always
@@ -87,6 +87,7 @@ services:
        - KAFKA_CFG_CONTROLLER_QUORUM_VOTERS=0@<your_host>:9093
        - KAFKA_CFG_LISTENERS=PLAINTEXT://:9092,CONTROLLER://:9093,EXTERNAL://:9094
        - KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092,EXTERNAL://${DOCKER_BRIDGE_GATEWAY:-172.28.0.1}:${KAFKA_PORT:-19094}
+      #  - KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092,EXTERNAL://127.0.0.1:${KAFKA_PORT:-19094} # Mac Deployment
        - KAFKA_CFG_LISTENER_SECURITY_PROTOCOL_MAP=CONTROLLER:PLAINTEXT,EXTERNAL:PLAINTEXT,PLAINTEXT:PLAINTEXT
        - KAFKA_CFG_CONTROLLER_LISTENER_NAMES=CONTROLLER
     networks:
@@ -213,6 +214,7 @@ services:
   #     - "${OPENIM_ADMIN_API_PORT:-10009}:10009"
   #   volumes:
   #     - "${DATA_DIR:-./}/components/openim-chat/logs:/openim/openim-chat/logs"
+  #     - "${DATA_DIR:-./}/components/openim-chat/_output/logs:/openim/openim-chat/_output/logs"
   #     - "${DATA_DIR:-./}/components/openim-chat/config:/openim/openim-chat/config"
   #   restart: always
   #   # user: root:root

docs/.generated_docs

@@ -31,7 +31,7 @@ docs/guide/en-US/cmd/openim/openim-rpc-user_list.md
 docs/guide/en-US/cmd/openim/openim-rpc-user_update.md
 docs/guide/en-US/cmd/openim/openim_validate.md
 docs/guide/en-US/cmd/openim/openim_version.md
-docs/guide/en-US/yaml/openim/openim.yaml
+docs/guide/en-US/yaml/openim/config.yaml
 docs/guide/en-US/yaml/openim/openim_color.yaml
 docs/guide/en-US/yaml/openim/openim_completion.yaml
 docs/guide/en-US/yaml/openim/openim_info.yaml

docs/contrib/environment.md

@@ -89,7 +89,7 @@ While the first two methods will be our main focus, it's worth noting that the t
 
 ###  1.2. <a name='SourceCodeDeployment'></a>Source Code Deployment
 
-In the source code deployment method, the configuration generation process involves executing `make init`, which fundamentally runs the script `./scripts/init-config.sh`. This script utilizes variables defined in the [`environment.sh`](https://github.com/openimsdk/open-im-server/blob/main/scripts/install/environment.sh) script to render the [`openim.yaml`](https://github.com/openimsdk/open-im-server/blob/main/deployments/templates/openim.yaml) template file, subsequently generating the [`config.yaml`](https://github.com/openimsdk/open-im-server/blob/main/config/config.yaml) configuration file.
+In the source code deployment method, the configuration generation process involves executing `make init`, which fundamentally runs the script `./scripts/init-config.sh`. This script utilizes variables defined in the [`environment.sh`](https://github.com/openimsdk/open-im-server/blob/main/scripts/install/environment.sh) script to render the [`config.yaml`](https://github.com/openimsdk/open-im-server/blob/main/deployments/templates/config.yaml) template file, subsequently generating the [`config.yaml`](https://github.com/openimsdk/open-im-server/blob/main/config/config.yaml) configuration file.
 
 ###  1.3. <a name='DockerComposeDeployment'></a>Docker Compose Deployment
 

docs/contrib/mac-developer-deployment-guide.md

@@ -45,60 +45,6 @@ Homebrew is an essential package manager for macOS. Install it using:
    git config --global user.email "your.email@example.com"
    ```
 
-### Forking and Cloning the Repository
-
-To optimize and add logic to your instructions, particularly regarding deploying on a Mac, you can modify them as follows:
-
-1. **Fork the OpenIM Repository**: Fork the OpenIM repository on GitHub to your account.
-
-2. **Clone Your Fork to Your Local Machine**:
-   Open your terminal and execute the following commands:
-
-   ```sh
-   # Clone the repository
-   git clone https://github.com/<your-username>/open-im-server.git
-
-   # Set Docker bridging network mode for Mac
-   export DOCKER_BRIDGE_SUBNET=127.0.0.0/16
-
-   # Set OpenIM IP
-   export OPENIM_IP=<your-ip>
-
-   # Initialize configuration
-   make init
-
-   # Start components using Docker
-   docker compose up -d
-
-   # Start OpenIM Server
-   make start
-   ```
-
-3. **Additional Steps for Mac Deployment**:
-   If you are deploying on a Mac and wish to use the chat feature, you need to modify the `docker-compose` file. Specifically, you'll need to uncomment the sections related to `openim-chat` and `mysql`. 
-
-   Here's how to do it:
-
-   - Open the `docker-compose.yml` file in a text editor.
-   - Find the sections for `openim-chat` and `mysql`.
-   - Remove the comment marks (`#`) at the beginning of the lines in these sections to enable them.
-   - Save the file after making these changes.
-
-4. **Update and Restart Services**:
-   After modifying the `docker-compose` file, you need to update and restart the services to apply these changes. Run the following command in your terminal:
-
-   ```sh
-   # Update and restart services
-   docker compose up -d
-
-   # Check openim-chat start
-   docker compose logs openim-chat
-   ```
-
-   This command will re-read the `docker-compose.yml` file, apply the new configuration, and restart the necessary containers.
-
-Remember, replacing `<your-username>` and `<your-ip>` with your actual GitHub username and desired IP address for OpenIM is crucial. These steps should streamline the setup process, particularly for Mac users wishing to use the chat feature.
-
 ### Setting Up the Devcontainer
 
 `Devcontainers` provide a Docker-based isolated development environment. 
@@ -126,6 +72,136 @@ Ensure the version of Go is compatible with the version required by OpenIM (refe
 
 Install other required tools like Docker, Vagrant, and necessary GNU utils as described in the main documentation.
 
+## Mac Deployment openim-chat and openim-server
+
+To integrate the Chinese document into an English document for Linux deployment, we will first translate the content and then adapt it to suit the Linux environment. Here's how the translated and adapted content might look:
+
+### Ensure a Clean Environment
+
+- It's recommended to execute in a new directory.
+- Run `ps -ef | grep openim` to ensure no OpenIM processes are running.
+- Run `ps -ef | grep chat` to check for absence of chat-related processes.
+- Execute `docker ps` to verify there are no related containers running.
+
+### Source Code Deployment
+
+#### Deploying openim-server
+
+Source code deployment is slightly more complex because Docker's networking on Linux differs from Mac.
+
+```bash
+git clone https://github.com/openimsdk/open-im-server
+cd open-im-server
+
+export OPENIM_IP="Your IP" # If it's a cloud server, setting might not be needed
+make init # Generates configuration files
+```
+
+Before deploying openim-server, modify the Kafka logic in the docker-compose.yml file. Replace:
+
+```yaml
+- KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092,EXTERNAL://${DOCKER_BRIDGE_GATEWAY:-172.28.0.1}:${KAFKA_PORT:-19094}
+```
+
+With:
+
+```yaml
+- KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092,EXTERNAL://127.0.0.1:${KAFKA_PORT:-19094}
+```
+
+Then start the service:
+
+```bash
+docker compose up -d
+```
+
+Before starting the openim-server source, set `config/config.yaml` by replacing all instances of `172.28.0.1` with `127.0.0.1`:
+
+```bash
+vim config/config.yaml -c "%s/172\.28\.0\.1/127.0.0.1/g" -c "wq"
+```
+
+Then start openim-server:
+
+```bash
+make start
+```
+
+To check the startup:
+
+```bash
+make check
+```
+
+<aside>
+🚧 To avoid mishaps, it's best to wait five minutes before running `make check` again.
+
+</aside>
+
+#### Deploying openim-chat
+
+There are several ways to deploy openim-chat, either by source code or using Docker.
+
+Navigate back to the parent directory:
+
+```bash
+cd ..
+```
+
+First, let's look at deploying chat from source:
+
+```bash
+git clone https://github.com/openimsdk/chat
+cd chat
+make init # Generates configuration files
+```
+
+If openim-chat has not deployed MySQL, you will need to deploy it. Note that the official Docker Hub for MySQL does not support architectures like ARM, so you can use the newer version of the open-source edition:
+
+```bash
+docker run -d \
+  --name mysql \
+  -p 13306:3306 \
+  -p 3306:33060 \
+  -v "$(pwd)/components/mysql/data:/var/lib/mysql" \
+  -v "/etc/localtime:/etc/localtime" \
+  -e MYSQL_ROOT_PASSWORD="openIM123" \
+  --restart always \
+  mariadb:10.6
+```
+
+Before starting the source code of openim-chat, set `config/config.yaml` by replacing all instances of `172.28.0.1` with `127.0.0.1`:
+
+```bash
+vim config/config.yaml -c "%s/172\.28\.0\.1/127.0.0.1/g" -c "wq"
+```
+
+Then start openim-chat from source:
+
+```bash
+make start
+```
+
+To check, ensure the following four processes start successfully:
+
+```bash
+make check 
+```
+
+### Docker Deployment
+
+Refer to https://github.com/openimsdk/openim-docker for Docker deployment instructions, which can be followed similarly on Linux.
+
+```bash
+git clone https://github.com/openimsdk/openim-docker
+cd openim-docker
+export OPENIM_IP="Your IP"
+make init
+docker compose up -d 
+docker compose logs -f openim-server
+docker compose logs -f openim-chat
+```
+
 ## GitHub Development Workflow
 
 ### Creating a New Branch

go.mod

@@ -5,7 +5,7 @@ go 1.19
 require (
 	firebase.google.com/go v3.13.0+incompatible
 	github.com/OpenIMSDK/protocol v0.0.48
-	github.com/OpenIMSDK/tools v0.0.23
+	github.com/OpenIMSDK/tools v0.0.28
 	github.com/bwmarrin/snowflake v0.3.0 // indirect
 	github.com/dtm-labs/rockscache v0.1.1
 	github.com/gin-gonic/gin v1.9.1
@@ -38,6 +38,7 @@ require (
 	github.com/aliyun/aliyun-oss-go-sdk v2.2.9+incompatible
 	github.com/go-redis/redis v6.15.9+incompatible
 	github.com/redis/go-redis/v9 v9.2.1
+	github.com/spf13/pflag v1.0.5
 	github.com/stathat/consistent v1.0.0
 	github.com/tencentyun/cos-go-sdk-v5 v0.7.45
 	go.uber.org/automaxprocs v1.5.3
@@ -116,7 +117,6 @@ require (
 	github.com/rcrowley/go-metrics v0.0.0-20201227073835-cf1acfcdf475 // indirect
 	github.com/rs/xid v1.5.0 // indirect
 	github.com/sergi/go-diff v1.0.0 // indirect
-	github.com/spf13/pflag v1.0.5 // indirect
 	github.com/src-d/gcfg v1.4.0 // indirect
 	github.com/stretchr/objx v0.5.0 // indirect
 	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect

go.sum

@@ -15,13 +15,13 @@ cloud.google.com/go/storage v1.30.1 h1:uOdMxAs8HExqBlnLtnQyP0YkvbiDpdGShGKtx6U/o
 cloud.google.com/go/storage v1.30.1/go.mod h1:NfxhC0UJE1aXSx7CIIbCf7y9HKT7BiccwkR7+P7gN8E=
 firebase.google.com/go v3.13.0+incompatible h1:3TdYC3DDi6aHn20qoRkxwGqNgdjtblwVAyRLQwGn/+4=
 firebase.google.com/go v3.13.0+incompatible/go.mod h1:xlah6XbEyW6tbfSklcfe5FHJIwjt8toICdV5Wh9ptHs=
-github.com/AndrewZuo01/protocol v0.0.0-20240112093520-fd9c53e27b94 h1:o86vkek41ZrQqoBGqyKvS0z6N0uJj64mpzK72OkDZVM=
-github.com/AndrewZuo01/protocol v0.0.0-20240112093520-fd9c53e27b94/go.mod h1:F25dFrwrIx3lkNoiuf6FkCfxuwf8L4Z8UIsdTHP/r0Y=
 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
 github.com/IBM/sarama v1.41.3 h1:MWBEJ12vHC8coMjdEXFq/6ftO6DUZnQlFYcxtOJFa7c=
 github.com/IBM/sarama v1.41.3/go.mod h1:Xxho9HkHd4K/MDUo/T/sOqwtX/17D33++E9Wib6hUdQ=
-github.com/OpenIMSDK/tools v0.0.23 h1:xozfrGzhbpNPlDTap5DLVPk+JfgZ/ZyIj4Cuu3/bm9w=
+github.com/OpenIMSDK/protocol v0.0.48 h1:8MIMjyzJRsruYhVv2ZKArFiOveroaofDOb3dlAdgjsw=
-github.com/OpenIMSDK/tools v0.0.23/go.mod h1:eg+q4A34Qmu73xkY0mt37FHGMCMfC6CtmOnm0kFEGFI=
+github.com/OpenIMSDK/protocol v0.0.48/go.mod h1:F25dFrwrIx3lkNoiuf6FkCfxuwf8L4Z8UIsdTHP/r0Y=
+github.com/OpenIMSDK/tools v0.0.28 h1:UT0rN1ysCFvsxQXyuxAj2TEkHt4C/sUezy+ChKpgt2Y=
+github.com/OpenIMSDK/tools v0.0.28/go.mod h1:eg+q4A34Qmu73xkY0mt37FHGMCMfC6CtmOnm0kFEGFI=
 github.com/QcloudApi/qcloud_sign_golang v0.0.0-20141224014652-e4130a326409/go.mod h1:1pk82RBxDY/JZnPQrtqHlUFfCctgdorsd9M06fMynOM=
 github.com/alcortesm/tgz v0.0.0-20161220082320-9c5fe88206d7 h1:uSoVVbwJiQipAclBbw+8quDsfcvFjOpI5iCf4p/cqCs=
 github.com/alcortesm/tgz v0.0.0-20161220082320-9c5fe88206d7/go.mod h1:6zEj6s6u/ghQa61ZWa/C2Aw3RkjiTBOix7dkqa1VLIs=

internal/api/user.go

@@ -201,27 +201,27 @@ func (u *UserApi) GetSubscribeUsersStatus(c *gin.Context) {
 	a2r.Call(user.UserClient.GetSubscribeUsersStatus, u.Client, c)
 }
 
-// ProcessUserCommandAdd user general function add
+// ProcessUserCommandAdd user general function add.
 func (u *UserApi) ProcessUserCommandAdd(c *gin.Context) {
 	a2r.Call(user.UserClient.ProcessUserCommandAdd, u.Client, c)
 }
 
-// ProcessUserCommandDelete user general function delete
+// ProcessUserCommandDelete user general function delete.
 func (u *UserApi) ProcessUserCommandDelete(c *gin.Context) {
 	a2r.Call(user.UserClient.ProcessUserCommandDelete, u.Client, c)
 }
 
-// ProcessUserCommandUpdate  user general function update
+// ProcessUserCommandUpdate  user general function update.
 func (u *UserApi) ProcessUserCommandUpdate(c *gin.Context) {
 	a2r.Call(user.UserClient.ProcessUserCommandUpdate, u.Client, c)
 }
 
-// ProcessUserCommandGet user general function get
+// ProcessUserCommandGet user general function get.
 func (u *UserApi) ProcessUserCommandGet(c *gin.Context) {
 	a2r.Call(user.UserClient.ProcessUserCommandGet, u.Client, c)
 }
 
-// ProcessUserCommandGet user general function get all
+// ProcessUserCommandGet user general function get all.
 func (u *UserApi) ProcessUserCommandGetAll(c *gin.Context) {
 	a2r.Call(user.UserClient.ProcessUserCommandGetAll, u.Client, c)
 }

internal/msggateway/n_ws_server.go

@@ -19,7 +19,6 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
-	"github.com/OpenIMSDK/tools/apiresp"
 	"net/http"
 	"os"
 	"os/signal"
@@ -29,6 +28,8 @@ import (
 	"syscall"
 	"time"
 
+	"github.com/OpenIMSDK/tools/apiresp"
+
 	"github.com/go-playground/validator/v10"
 	"github.com/redis/go-redis/v9"
 	"golang.org/x/sync/errgroup"

internal/push/push_rpc_server.go

@@ -16,9 +16,10 @@ package push
 
 import (
 	"context"
-	"github.com/OpenIMSDK/tools/utils"
 	"sync"
 
+	"github.com/OpenIMSDK/tools/utils"
+
 	"google.golang.org/grpc"
 
 	"github.com/OpenIMSDK/protocol/constant"

internal/push/push_to_client.go

@@ -18,9 +18,10 @@ import (
 	"context"
 	"encoding/json"
 	"errors"
-	"google.golang.org/grpc"
 	"sync"
 
+	"google.golang.org/grpc"
+
 	"golang.org/x/sync/errgroup"
 
 	"github.com/OpenIMSDK/protocol/constant"
@@ -143,7 +144,7 @@ func (p *Pusher) UnmarshalNotificationElem(bytes []byte, t any) error {
 }
 
 /*
-k8s deployment,offline push group messages function
+k8s deployment,offline push group messages function.
 */
 func (p *Pusher) k8sOfflinePush2SuperGroup(ctx context.Context, groupID string, msg *sdkws.MsgData, wsResults []*msggateway.SingleMsgToUserResults) error {
 

internal/rpc/conversation/conversaion.go

@@ -17,9 +17,10 @@ package conversation
 import (
 	"context"
 	"errors"
-	"github.com/OpenIMSDK/protocol/sdkws"
 	"sort"
 
+	"github.com/OpenIMSDK/protocol/sdkws"
+
 	"github.com/OpenIMSDK/tools/tx"
 
 	"github.com/openimsdk/open-im-server/v3/pkg/common/db/mgo"

internal/rpc/msg/as_read.go

@@ -18,6 +18,7 @@ import (
 	"context"
 
 	utils2 "github.com/OpenIMSDK/tools/utils"
+
 	cbapi "github.com/openimsdk/open-im-server/v3/pkg/callbackstruct"
 
 	"github.com/redis/go-redis/v9"

internal/rpc/msg/seq.go

@@ -16,6 +16,7 @@ package msg
 
 import (
 	"context"
+
 	pbmsg "github.com/OpenIMSDK/protocol/msg"
 )
 

internal/rpc/third/s3.go

@@ -19,12 +19,14 @@ import (
 	"encoding/base64"
 	"encoding/hex"
 	"encoding/json"
-	"github.com/google/uuid"
-	"github.com/openimsdk/open-im-server/v3/pkg/authverify"
 	"path"
 	"strconv"
 	"time"
 
+	"github.com/google/uuid"
+
+	"github.com/openimsdk/open-im-server/v3/pkg/authverify"
+
 	"github.com/openimsdk/open-im-server/v3/pkg/common/db/s3"
 
 	"github.com/OpenIMSDK/protocol/third"

internal/rpc/user/callback.go

@@ -16,6 +16,7 @@ package user
 
 import (
 	"context"
+
 	pbuser "github.com/OpenIMSDK/protocol/user"
 	"github.com/OpenIMSDK/tools/utils"
 

internal/rpc/user/user.go

@@ -17,12 +17,14 @@ package user
 import (
 	"context"
 	"errors"
-	"github.com/OpenIMSDK/tools/pagination"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/db/table/relation"
 	"math/rand"
 	"strings"
 	"time"
 
+	"github.com/OpenIMSDK/tools/pagination"
+
+	"github.com/openimsdk/open-im-server/v3/pkg/common/db/table/relation"
+
 	"github.com/OpenIMSDK/tools/tx"
 
 	"github.com/openimsdk/open-im-server/v3/pkg/common/db/mgo"
@@ -387,7 +389,7 @@ func (s *userServer) GetSubscribeUsersStatus(ctx context.Context,
 	return &pbuser.GetSubscribeUsersStatusResp{StatusList: onlineStatusList}, nil
 }
 
-// ProcessUserCommandAdd user general function add
+// ProcessUserCommandAdd user general function add.
 func (s *userServer) ProcessUserCommandAdd(ctx context.Context, req *pbuser.ProcessUserCommandAddReq) (*pbuser.ProcessUserCommandAddResp, error) {
 	err := authverify.CheckAccessV3(ctx, req.UserID)
 	if err != nil {
@@ -418,7 +420,7 @@ func (s *userServer) ProcessUserCommandAdd(ctx context.Context, req *pbuser.Proc
 	return &pbuser.ProcessUserCommandAddResp{}, nil
 }
 
-// ProcessUserCommandDelete user general function delete
+// ProcessUserCommandDelete user general function delete.
 func (s *userServer) ProcessUserCommandDelete(ctx context.Context, req *pbuser.ProcessUserCommandDeleteReq) (*pbuser.ProcessUserCommandDeleteResp, error) {
 	err := authverify.CheckAccessV3(ctx, req.UserID)
 	if err != nil {
@@ -440,7 +442,7 @@ func (s *userServer) ProcessUserCommandDelete(ctx context.Context, req *pbuser.P
 	return &pbuser.ProcessUserCommandDeleteResp{}, nil
 }
 
-// ProcessUserCommandUpdate user general function update
+// ProcessUserCommandUpdate user general function update.
 func (s *userServer) ProcessUserCommandUpdate(ctx context.Context, req *pbuser.ProcessUserCommandUpdateReq) (*pbuser.ProcessUserCommandUpdateResp, error) {
 	err := authverify.CheckAccessV3(ctx, req.UserID)
 	if err != nil {

pkg/common/convert/friend.go

@@ -17,6 +17,7 @@ package convert
 import (
 	"context"
 	"fmt"
+
 	"github.com/OpenIMSDK/protocol/sdkws"
 	"github.com/OpenIMSDK/tools/utils"
 

pkg/common/db/controller/msg_test.go

@@ -146,7 +146,7 @@ func Test_BatchInsertChat2DB(t *testing.T) {
 func GetDB() *commonMsgDatabase {
 	config.Config.Mongo.Address = []string{"203.56.175.233:37017"}
 	// config.Config.Mongo.Timeout = 60
-	config.Config.Mongo.Database = "openIM_v3"
+	config.Config.Mongo.Database = "openim_v3"
 	// config.Config.Mongo.Source = "admin"
 	config.Config.Mongo.Username = "root"
 	config.Config.Mongo.Password = "openIM123"

pkg/common/db/controller/user.go

@@ -142,12 +142,12 @@ func (u *userDatabase) Find(ctx context.Context, userIDs []string) (users []*rel
 	return u.cache.GetUsersInfo(ctx, userIDs)
 }
 
-// Find userInfo By Nickname
+// Find userInfo By Nickname.
 func (u *userDatabase) FindByNickname(ctx context.Context, nickname string) (users []*relation.UserModel, err error) {
 	return u.userDB.TakeByNickname(ctx, nickname)
 }
 
-// Find notificationAccouts
+// Find notificationAccouts.
 func (u *userDatabase) FindNotification(ctx context.Context, level int64) (users []*relation.UserModel, err error) {
 	return u.userDB.TakeNotification(ctx, level)
 }
@@ -190,7 +190,14 @@ func (u *userDatabase) Page(ctx context.Context, pagination pagination.Paginatio
 func (u *userDatabase) PageFindUser(ctx context.Context, level1 int64, level2 int64, pagination pagination.Pagination) (count int64, users []*relation.UserModel, err error) {
 	return u.userDB.PageFindUser(ctx, level1, level2, pagination)
 }
-func (u *userDatabase) PageFindUserWithKeyword(ctx context.Context, level1 int64, level2 int64, userID, nickName string, pagination pagination.Pagination) (count int64, users []*relation.UserModel, err error) {
+
+func (u *userDatabase) PageFindUserWithKeyword(
+	ctx context.Context,
+	level1 int64,
+	level2 int64,
+	userID, nickName string,
+	pagination pagination.Pagination,
+) (count int64, users []*relation.UserModel, err error) {
 	return u.userDB.PageFindUserWithKeyword(ctx, level1, level2, userID, nickName, pagination)
 }
 

pkg/common/db/mgo/friend.go

@@ -16,6 +16,7 @@ package mgo
 
 import (
 	"context"
+
 	"github.com/OpenIMSDK/tools/mgoutil"
 	"github.com/OpenIMSDK/tools/pagination"
 	"go.mongodb.org/mongo-driver/mongo/options"

pkg/common/db/mgo/user.go

@@ -16,10 +16,11 @@ package mgo
 
 import (
 	"context"
+	"time"
+
 	"github.com/OpenIMSDK/protocol/user"
 	"github.com/OpenIMSDK/tools/errs"
 	"go.mongodb.org/mongo-driver/bson/primitive"
-	"time"
 
 	"github.com/OpenIMSDK/tools/mgoutil"
 	"github.com/OpenIMSDK/tools/pagination"
@@ -89,7 +90,15 @@ func (u *UserMgo) PageFindUser(ctx context.Context, level1 int64, level2 int64,
 
 	return mgoutil.FindPage[*relation.UserModel](ctx, u.coll, query, pagination)
 }
-func (u *UserMgo) PageFindUserWithKeyword(ctx context.Context, level1 int64, level2 int64, userID string, nickName string, pagination pagination.Pagination) (count int64, users []*relation.UserModel, err error) {
+
+func (u *UserMgo) PageFindUserWithKeyword(
+	ctx context.Context,
+	level1 int64,
+	level2 int64,
+	userID string,
+	nickName string,
+	pagination pagination.Pagination,
+) (count int64, users []*relation.UserModel, err error) {
 	// Initialize the base query with level conditions
 	query := bson.M{
 		"$and": []bson.M{

pkg/common/db/s3/cos/cos.go

@@ -36,9 +36,9 @@ import (
 )
 
 const (
-	minPartSize = 1024 * 1024 * 1        // 1MB
+	minPartSize int64 = 1024 * 1024 * 1        // 1MB
-	maxPartSize = 1024 * 1024 * 1024 * 5 // 5GB
+	maxPartSize int64 = 1024 * 1024 * 1024 * 5 // 5GB
-	maxNumSize  = 1000
+	maxNumSize  int64 = 1000
 )
 
 const (
@@ -133,7 +133,7 @@ func (c *Cos) PartSize(ctx context.Context, size int64) (int64, error) {
 		return 0, errors.New("size must be greater than 0")
 	}
 	if size > maxPartSize*maxNumSize {
-		return 0, fmt.Errorf("size must be less than %db", maxPartSize*maxNumSize)
+		return 0, fmt.Errorf("COS size must be less than the maximum allowed limit")
 	}
 	if size <= minPartSize*maxNumSize {
 		return minPartSize, nil

pkg/common/db/s3/minio/minio.go

@@ -45,9 +45,9 @@ const (
 )
 
 const (
-	minPartSize = 1024 * 1024 * 5        // 1MB
+	minPartSize int64 = 1024 * 1024 * 5        // 1MB
-	maxPartSize = 1024 * 1024 * 1024 * 5 // 5GB
+	maxPartSize int64 = 1024 * 1024 * 1024 * 5 // 5GB
-	maxNumSize  = 10000
+	maxNumSize  int64 = 10000
 )
 
 const (
@@ -240,7 +240,7 @@ func (m *Minio) PartSize(ctx context.Context, size int64) (int64, error) {
 		return 0, errors.New("size must be greater than 0")
 	}
 	if size > maxPartSize*maxNumSize {
-		return 0, fmt.Errorf("size must be less than %db", maxPartSize*maxNumSize)
+		return 0, fmt.Errorf("MINIO size must be less than the maximum allowed limit")
 	}
 	if size <= minPartSize*maxNumSize {
 		return minPartSize, nil

pkg/common/db/s3/oss/oss.go

@@ -37,9 +37,9 @@ import (
 )
 
 const (
-	minPartSize = 1024 * 1024 * 1        // 1MB
+	minPartSize int64 = 1024 * 1024 * 1        // 1MB
-	maxPartSize = 1024 * 1024 * 1024 * 5 // 5GB
+	maxPartSize int64 = 1024 * 1024 * 1024 * 5 // 5GB
-	maxNumSize  = 10000
+	maxNumSize  int64 = 10000
 )
 
 const (
@@ -141,7 +141,7 @@ func (o *OSS) PartSize(ctx context.Context, size int64) (int64, error) {
 		return 0, errors.New("size must be greater than 0")
 	}
 	if size > maxPartSize*maxNumSize {
-		return 0, fmt.Errorf("size must be less than %db", maxPartSize*maxNumSize)
+		return 0, fmt.Errorf("OSS size must be less than the maximum allowed limit")
 	}
 	if size <= minPartSize*maxNumSize {
 		return minPartSize, nil

pkg/common/db/s3/s3.go

@@ -24,7 +24,7 @@ import (
 type PartLimit struct {
 	MinPartSize int64 `json:"minPartSize"`
 	MaxPartSize int64 `json:"maxPartSize"`
-	MaxNumSize  int   `json:"maxNumSize"`
+	MaxNumSize  int64 `json:"maxNumSize"`
 }
 
 type InitiateMultipartUploadResult struct {

pkg/common/db/table/relation/user.go

@@ -16,9 +16,10 @@ package relation
 
 import (
 	"context"
-	"github.com/OpenIMSDK/protocol/user"
 	"time"
 
+	"github.com/OpenIMSDK/protocol/user"
+
 	"github.com/OpenIMSDK/tools/pagination"
 )
 

pkg/common/discoveryregister/kubernetes/kubernetes.go

@@ -18,15 +18,17 @@ import (
 	"context"
 	"errors"
 	"fmt"
-	"github.com/stathat/consistent"
 	"os"
 	"strconv"
 	"strings"
 
+	"github.com/stathat/consistent"
+
 	"google.golang.org/grpc"
 
 	"github.com/OpenIMSDK/tools/discoveryregistry"
 	"github.com/OpenIMSDK/tools/log"
+
 	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
 )
 
@@ -102,7 +104,7 @@ func getSelfHost(ctx context.Context) string {
 	return host
 }
 
-// like openimserver-openim-msggateway-0.openimserver-openim-msggateway-headless.openim-lin.svc.cluster.local:88
+// like openimserver-openim-msggateway-0.openimserver-openim-msggateway-headless.openim-lin.svc.cluster.local:88.
 func getMsgGatewayHost(ctx context.Context) []string {
 	port := 88
 	instance := "openimserver"
@@ -166,7 +168,7 @@ func (cli *K8sDR) CloseConn(conn *grpc.ClientConn) {
 	conn.Close()
 }
 
-// do not use this method for call rpc
+// do not use this method for call rpc.
 func (cli *K8sDR) GetClientLocalConns() map[string][]*grpc.ClientConn {
 	fmt.Println("should not call this function!!!!!!!!!!!!!!!!!!!!!!!!!")
 	return nil

pkg/rpcclient/msg.go

@@ -17,6 +17,7 @@ package rpcclient
 import (
 	"context"
 	"encoding/json"
+
 	"google.golang.org/grpc"
 	"google.golang.org/protobuf/proto"
 

pkg/util/flag/flag.go

@@ -1,7 +1,21 @@
+// Copyright © 2024 OpenIM. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package flag
 
 import (
-	goFlag "flag"
+	"flag"
 	"log"
 	"strings"
 
@@ -29,7 +43,7 @@ func WarnWordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedNam
 // InitFlags normalizes, parses, then logs the command line flags.
 func InitFlags() {
 	pflag.CommandLine.SetNormalizeFunc(WordSepNormalizeFunc)
-	pflag.CommandLine.AddGoFlagSet(goFlag.CommandLine)
+	pflag.CommandLine.AddGoFlagSet(flag.CommandLine)
 }
 
 // PrintFlags logs the flags in the flagset.

pkg/util/genutil/genutil.go

@@ -1,3 +1,17 @@
+// Copyright © 2024 OpenIM. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package genutil
 
 import (

pkg/util/genutil/genutil_test.go

@@ -1,3 +1,17 @@
+// Copyright © 2024 OpenIM. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package genutil
 
 import (

scripts/bash_beautify.py

@@ -0,0 +1,173 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+#**************************************************************************
+#   Copyright (C) 2011, Paul Lutus                                        *
+#                                                                         *
+#   This program is free software; you can redistribute it and/or modify  *
+#   it under the terms of the GNU General Public License as published by  *
+#   the Free Software Foundation; either version 2 of the License, or     *
+#   (at your option) any later version.                                   *
+#                                                                         *
+#   This program is distributed in the hope that it will be useful,       *
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+#   GNU General Public License for more details.                          *
+#                                                                         *
+#   You should have received a copy of the GNU General Public License     *
+#   along with this program; if not, write to the                         *
+#   Free Software Foundation, Inc.,                                       *
+#   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+#**************************************************************************
+
+import re
+import sys
+
+PVERSION = '1.0'
+
+
+class BeautifyBash:
+
+    def __init__(self):
+        self.tab_str = ' '
+        self.tab_size = 2
+
+    def read_file(self, fp):
+        with open(fp) as f:
+            return f.read()
+
+    def write_file(self, fp, data):
+        with open(fp, 'w') as f:
+            f.write(data)
+
+    def beautify_string(self, data, path=''):
+        tab = 0
+        case_stack = []
+        in_here_doc = False
+        defer_ext_quote = False
+        in_ext_quote = False
+        ext_quote_string = ''
+        here_string = ''
+        output = []
+        line = 1
+        for record in re.split('\n', data):
+            record = record.rstrip()
+            stripped_record = record.strip()
+
+            # collapse multiple quotes between ' ... '
+            test_record = re.sub(r'\'.*?\'', '', stripped_record)
+            # collapse multiple quotes between " ... "
+            test_record = re.sub(r'".*?"', '', test_record)
+            # collapse multiple quotes between ` ... `
+            test_record = re.sub(r'`.*?`', '', test_record)
+            # collapse multiple quotes between \` ... ' (weird case)
+            test_record = re.sub(r'\\`.*?\'', '', test_record)
+            # strip out any escaped single characters
+            test_record = re.sub(r'\\.', '', test_record)
+            # remove '#' comments
+            test_record = re.sub(r'(\A|\s)(#.*)', '', test_record, 1)
+            if(not in_here_doc):
+                if(re.search('<<-?', test_record)):
+                    here_string = re.sub(
+                        '.*<<-?\s*[\'|"]?([_|\w]+)[\'|"]?.*', '\\1', stripped_record, 1)
+                    in_here_doc = (len(here_string) > 0)
+            if(in_here_doc):  # pass on with no changes
+                output.append(record)
+                # now test for here-doc termination string
+                if(re.search(here_string, test_record) and not re.search('<<', test_record)):
+                    in_here_doc = False
+            else:  # not in here doc
+                if(in_ext_quote):
+                    if(re.search(ext_quote_string, test_record)):
+                        # provide line after quotes
+                        test_record = re.sub(
+                            '.*%s(.*)' % ext_quote_string, '\\1', test_record, 1)
+                        in_ext_quote = False
+                else:  # not in ext quote
+                    if(re.search(r'(\A|\s)(\'|")', test_record)):
+                        # apply only after this line has been processed
+                        defer_ext_quote = True
+                        ext_quote_string = re.sub(
+                            '.*([\'"]).*', '\\1', test_record, 1)
+                        # provide line before quote
+                        test_record = re.sub(
+                            '(.*)%s.*' % ext_quote_string, '\\1', test_record, 1)
+                if(in_ext_quote):
+                    # pass on unchanged
+                    output.append(record)
+                else:  # not in ext quote
+                    inc = len(re.findall(
+                        '(\s|\A|;)(case|then|do)(;|\Z|\s)', test_record))
+                    inc += len(re.findall('(\{|\(|\[)', test_record))
+                    outc = len(re.findall(
+                        '(\s|\A|;)(esac|fi|done|elif)(;|\)|\||\Z|\s)', test_record))
+                    outc += len(re.findall('(\}|\)|\])', test_record))
+                    if(re.search(r'\besac\b', test_record)):
+                        if(len(case_stack) == 0):
+                            sys.stderr.write(
+                                'File %s: error: "esac" before "case" in line %d.\n' % (
+                                    path, line)
+                            )
+                        else:
+                            outc += case_stack.pop()
+                    # sepcial handling for bad syntax within case ... esac
+                    if(len(case_stack) > 0):
+                        if(re.search('\A[^(]*\)', test_record)):
+                            # avoid overcount
+                            outc -= 2
+                            case_stack[-1] += 1
+                        if(re.search(';;', test_record)):
+                            outc += 1
+                            case_stack[-1] -= 1
+                    # an ad-hoc solution for the "else" keyword
+                    else_case = (
+                        0, -1)[re.search('^(else)', test_record) != None]
+                    net = inc - outc
+                    tab += min(net, 0)
+                    extab = tab + else_case
+                    extab = max(0, extab)
+                    output.append(
+                        (self.tab_str * self.tab_size * extab) + stripped_record)
+                    tab += max(net, 0)
+                if(defer_ext_quote):
+                    in_ext_quote = True
+                    defer_ext_quote = False
+                if(re.search(r'\bcase\b', test_record)):
+                    case_stack.append(0)
+            line += 1
+        error = (tab != 0)
+        if(error):
+            sys.stderr.write(
+                'File %s: error: indent/outdent mismatch: %d.\n' % (path, tab))
+        return '\n'.join(output), error
+
+    def beautify_file(self, path):
+        error = False
+        if(path == '-'):
+            data = sys.stdin.read()
+            result, error = self.beautify_string(data, '(stdin)')
+            sys.stdout.write(result)
+        else:  # named file
+            data = self.read_file(path)
+            result, error = self.beautify_string(data, path)
+            if(data != result):
+                # make a backup copy
+                self.write_file(path + '~', data)
+                self.write_file(path, result)
+        return error
+
+    def main(self):
+        error = False
+        sys.argv.pop(0)
+        if(len(sys.argv) < 1):
+            sys.stderr.write(
+                'usage: shell script filenames or \"-\" for stdin.\n')
+        else:
+            for path in sys.argv:
+                error |= self.beautify_file(path)
+        sys.exit((0, 1)[error])
+
+# if not called as a module
+if(__name__ == '__main__'):
+    BeautifyBash().main()
+

scripts/build-all-service.sh

@@ -31,7 +31,7 @@ source "${OPENIM_ROOT}/scripts/lib/init.sh"
 
 # CPU core number
 pushd "${OPENIM_ROOT}/tools/ncpu" >/dev/null
-  cpu_count=$(go run .)
+cpu_count=$(go run .)
 popd >/dev/null
 
 openim::color::echo ${GREEN_PREFIX} "======> cpu_count=$cpu_count"

scripts/cherry-pick.sh

@@ -153,7 +153,7 @@ For details on the cherry pick process, see the [cherry pick requests](https://g
 EOF
 )
 
-  gh pr create --title="Automated cherry pick of ${numandtitle}" --body="${prtext}" --head "${GITHUB_USER}:${NEWBRANCH}" --base "${rel}" --repo="${MAIN_REPO_ORG}/${MAIN_REPO_NAME}"
+gh pr create --title="Automated cherry pick of ${numandtitle}" --body="${prtext}" --head "${GITHUB_USER}:${NEWBRANCH}" --base "${rel}" --repo="${MAIN_REPO_ORG}/${MAIN_REPO_NAME}"
 }
 
 git checkout -b "${NEWBRANCHUNIQ}" "${BRANCH}"
@@ -161,14 +161,14 @@ cleanbranch="${NEWBRANCHUNIQ}"
 
 gitamcleanup=true
 for pull in "${PULLS[@]}"; do
-  openim::log::status "Downloading patch to /tmp/${pull}.patch (in case you need to do this again)"
+openim::log::status "Downloading patch to /tmp/${pull}.patch (in case you need to do this again)"
 
-  curl -o "/tmp/${pull}.patch" -sSL "https://github.com/${MAIN_REPO_ORG}/${MAIN_REPO_NAME}/pull/${pull}.patch"
+curl -o "/tmp/${pull}.patch" -sSL "https://github.com/${MAIN_REPO_ORG}/${MAIN_REPO_NAME}/pull/${pull}.patch"
-  echo
+echo
-  openim::log::status "About to attempt cherry pick of PR. To reattempt:"
+openim::log::status "About to attempt cherry pick of PR. To reattempt:"
-  echo "  $ git am -3 /tmp/${pull}.patch"
+echo "  $ git am -3 /tmp/${pull}.patch"
-  echo
+echo
-  git am -3 "/tmp/${pull}.patch" || {
+git am -3 "/tmp/${pull}.patch" || {
   conflicts=false
   while unmerged=$(git status --porcelain | grep ^U) && [[ -n ${unmerged} ]] \
   || [[ -e "${REBASEMAGIC}" ]]; do
@@ -191,54 +191,54 @@ for pull in "${PULLS[@]}"; do
     echo "!!! git am failed, likely because of an in-progress 'git am' or 'git rebase'"
     exit 1
   fi
-  }
+}
 
-  # set the subject
+# set the subject
-  subject=$(grep -m 1 "^Subject" "/tmp/${pull}.patch" | sed -e 's/Subject: \[PATCH//g' | sed 's/.*] //')
+subject=$(grep -m 1 "^Subject" "/tmp/${pull}.patch" | sed -e 's/Subject: \[PATCH//g' | sed 's/.*] //')
-  SUBJECTS+=("#${pull}: ${subject}")
+SUBJECTS+=("#${pull}: ${subject}")
 
-  # remove the patch file from /tmp
+# remove the patch file from /tmp
-  rm -f "/tmp/${pull}.patch"
+rm -f "/tmp/${pull}.patch"
 done
 gitamcleanup=false
 
 # Re-generate docs (if needed)
 if [[ -n "${REGENERATE_DOCS}" ]]; then
-  echo
+echo
-  echo "Regenerating docs..."
+echo "Regenerating docs..."
-  if ! scripts/generate-docs.sh; then
+if ! scripts/generate-docs.sh; then
   echo
   echo "scripts/gendoc.sh FAILED to complete."
   exit 1
-  fi
+fi
 fi
 
 if [[ -n "${DRY_RUN}" ]]; then
-  openim::log::error "!!! Skipping git push and PR creation because you set DRY_RUN."
+openim::log::error "!!! Skipping git push and PR creation because you set DRY_RUN."
-  echo "To return to the branch you were in when you invoked this script:"
+echo "To return to the branch you were in when you invoked this script:"
-  echo
+echo
-  echo "  git checkout ${STARTINGBRANCH}"
+echo "  git checkout ${STARTINGBRANCH}"
-  echo
+echo
-  echo "To delete this branch:"
+echo "To delete this branch:"
-  echo
+echo
-  echo "  git branch -D ${NEWBRANCHUNIQ}"
+echo "  git branch -D ${NEWBRANCHUNIQ}"
-  exit 0
+exit 0
 fi
 
 if git remote -v | grep ^"${FORK_REMOTE}" | grep "${MAIN_REPO_ORG}/${MAIN_REPO_NAME}.git"; then
-  echo "!!! You have ${FORK_REMOTE} configured as your ${MAIN_REPO_ORG}/${MAIN_REPO_NAME}.git"
+echo "!!! You have ${FORK_REMOTE} configured as your ${MAIN_REPO_ORG}/${MAIN_REPO_NAME}.git"
-  echo "This isn't normal. Leaving you with push instructions:"
+echo "This isn't normal. Leaving you with push instructions:"
-  echo
+echo
-  openim::log::status "First manually push the branch this script created:"
+openim::log::status "First manually push the branch this script created:"
-  echo
+echo
-  echo "  git push REMOTE ${NEWBRANCHUNIQ}:${NEWBRANCH}"
+echo "  git push REMOTE ${NEWBRANCHUNIQ}:${NEWBRANCH}"
-  echo
+echo
-  echo "where REMOTE is your personal fork (maybe ${UPSTREAM_REMOTE}? Consider swapping those.)."
+echo "where REMOTE is your personal fork (maybe ${UPSTREAM_REMOTE}? Consider swapping those.)."
-  echo "OR consider setting UPSTREAM_REMOTE and FORK_REMOTE to different values."
+echo "OR consider setting UPSTREAM_REMOTE and FORK_REMOTE to different values."
-  echo
+echo
-  make-a-pr
+make-a-pr
-  cleanbranch=""
+cleanbranch=""
-  exit 0
+exit 0
 fi
 
 echo
@@ -248,8 +248,8 @@ echo "  git push ${FORK_REMOTE} ${NEWBRANCHUNIQ}:${NEWBRANCH}"
 echo
 read -p "+++ Proceed (anything other than 'y' aborts the cherry-pick)? [y/n] " -r
 if ! [[ "${REPLY}" =~ ^[yY]$ ]]; then
-  echo "Aborting." >&2
+echo "Aborting." >&2
-  exit 1
+exit 1
 fi
 
 git push "${FORK_REMOTE}" -f "${NEWBRANCHUNIQ}:${NEWBRANCH}"

scripts/common.sh

@@ -87,13 +87,13 @@ readonly OPENIM_CONTAINER_RSYNC_PORT=8730
 #
 # $1 - server architecture
 openim::build::get_docker_wrapped_binaries() {
-  local arch=$1
+local arch=$1
-  local debian_base_version=v2.1.0
+local debian_base_version=v2.1.0
-  local debian_iptables_version=v12.1.0
+local debian_iptables_version=v12.1.0
-  ### If you change any of these lists, please also update DOCKERIZED_BINARIES
+### If you change any of these lists, please also update DOCKERIZED_BINARIES
-  ### in build/BUILD. And openim::golang::server_image_targets
+### in build/BUILD. And openim::golang::server_image_targets
 
-  local targets=(
+local targets=(
   "openim-api,${OPENIM_BASE_IMAGE_REGISTRY}/debian-base-${arch}:${debian_base_version}"
   "openim-cmdutils,${OPENIM_BASE_IMAGE_REGISTRY}/debian-base-${arch}:${debian_base_version}"
   "openim-crontask,${OPENIM_BASE_IMAGE_REGISTRY}/debian-base-${arch}:${debian_base_version}"
@@ -107,8 +107,8 @@ openim::build::get_docker_wrapped_binaries() {
   "openim-rpc-msg,${OPENIM_BASE_IMAGE_REGISTRY}/debian-base-${arch}:${debian_base_version}"
   "openim-rpc-third,${OPENIM_BASE_IMAGE_REGISTRY}/debian-base-${arch}:${debian_base_version}"
   "openim-rpc-user,${OPENIM_BASE_IMAGE_REGISTRY}/debian-base-${arch}:${debian_base_version}"
-  )
+)
-  echo "${targets[@]}"
+echo "${targets[@]}"
 }
 
 # ---------------------------------------------------------------------------
@@ -133,11 +133,11 @@ openim::build::get_docker_wrapped_binaries() {
 #   DOCKER_MOUNT_ARGS
 #   LOCAL_OUTPUT_BUILD_CONTEXT
 function openim::build::verify_prereqs() {
-  local -r require_docker=${1:-true}
+local -r require_docker=${1:-true}
-  openim::log::status "Verifying Prerequisites...."
+openim::log::status "Verifying Prerequisites...."
-  openim::build::ensure_tar || return 1
+openim::build::ensure_tar || return 1
-  openim::build::ensure_rsync || return 1
+openim::build::ensure_rsync || return 1
-  if ${require_docker}; then
+if ${require_docker}; then
   openim::build::ensure_docker_in_path || return 1
   openim::util::ensure_docker_daemon_connectivity || return 1
   
@@ -145,31 +145,31 @@ function openim::build::verify_prereqs() {
     openim::log::status "Docker Version:"
     "${DOCKER[@]}" version | openim::log::info_from_stdin
   fi
-  fi
+fi
 
-  OPENIM_GIT_BRANCH=$(git symbolic-ref --short -q HEAD 2>/dev/null || true)
+OPENIM_GIT_BRANCH=$(git symbolic-ref --short -q HEAD 2>/dev/null || true)
-  OPENIM_ROOT_HASH=$(openim::build::short_hash "${HOSTNAME:-}:"${OPENIM_ROOT}":${OPENIM_GIT_BRANCH}")
+OPENIM_ROOT_HASH=$(openim::build::short_hash "${HOSTNAME:-}:${OPENIM_ROOT}:${OPENIM_GIT_BRANCH}")
-  OPENIM_BUILD_IMAGE_TAG_BASE="build-${OPENIM_ROOT_HASH}"
+OPENIM_BUILD_IMAGE_TAG_BASE="build-${OPENIM_ROOT_HASH}"
-  #OPENIM_BUILD_IMAGE_TAG="${OPENIM_BUILD_IMAGE_TAG_BASE}-${OPENIM_BUILD_IMAGE_VERSION}"
+#OPENIM_BUILD_IMAGE_TAG="${OPENIM_BUILD_IMAGE_TAG_BASE}-${OPENIM_BUILD_IMAGE_VERSION}"
-  #OPENIM_BUILD_IMAGE="${OPENIM_BUILD_IMAGE_REPO}:${OPENIM_BUILD_IMAGE_TAG}"
+#OPENIM_BUILD_IMAGE="${OPENIM_BUILD_IMAGE_REPO}:${OPENIM_BUILD_IMAGE_TAG}"
-  OPENIM_BUILD_CONTAINER_NAME_BASE="openim-build-${OPENIM_ROOT_HASH}"
+OPENIM_BUILD_CONTAINER_NAME_BASE="openim-build-${OPENIM_ROOT_HASH}"
-  #OPENIM_BUILD_CONTAINER_NAME="${OPENIM_BUILD_CONTAINER_NAME_BASE}-${OPENIM_BUILD_IMAGE_VERSION}"
+#OPENIM_BUILD_CONTAINER_NAME="${OPENIM_BUILD_CONTAINER_NAME_BASE}-${OPENIM_BUILD_IMAGE_VERSION}"
-  OPENIM_RSYNC_CONTAINER_NAME_BASE="openim-rsync-${OPENIM_ROOT_HASH}"
+OPENIM_RSYNC_CONTAINER_NAME_BASE="openim-rsync-${OPENIM_ROOT_HASH}"
-  #OPENIM_RSYNC_CONTAINER_NAME="${OPENIM_RSYNC_CONTAINER_NAME_BASE}-${OPENIM_BUILD_IMAGE_VERSION}"
+#OPENIM_RSYNC_CONTAINER_NAME="${OPENIM_RSYNC_CONTAINER_NAME_BASE}-${OPENIM_BUILD_IMAGE_VERSION}"
-  OPENIM_DATA_CONTAINER_NAME_BASE="openim-build-data-${OPENIM_ROOT_HASH}"
+OPENIM_DATA_CONTAINER_NAME_BASE="openim-build-data-${OPENIM_ROOT_HASH}"
-  #OPENIM_DATA_CONTAINER_NAME="${OPENIM_DATA_CONTAINER_NAME_BASE}-${OPENIM_BUILD_IMAGE_VERSION}"
+#OPENIM_DATA_CONTAINER_NAME="${OPENIM_DATA_CONTAINER_NAME_BASE}-${OPENIM_BUILD_IMAGE_VERSION}"
-  #DOCKER_MOUNT_ARGS=(--volumes-from "${OPENIM_DATA_CONTAINER_NAME}")
+#DOCKER_MOUNT_ARGS=(--volumes-from "${OPENIM_DATA_CONTAINER_NAME}")
-  #LOCAL_OUTPUT_BUILD_CONTEXT="${LOCAL_OUTPUT_IMAGE_STAGING}/${OPENIM_BUILD_IMAGE}"
+#LOCAL_OUTPUT_BUILD_CONTEXT="${LOCAL_OUTPUT_IMAGE_STAGING}/${OPENIM_BUILD_IMAGE}"
 
-  openim::version::get_version_vars
+openim::version::get_version_vars
-  #openim::version::save_version_vars "${OPENIM_ROOT}/.dockerized-openim-version-defs"
+#openim::version::save_version_vars "${OPENIM_ROOT}/.dockerized-openim-version-defs"
 }
 
 # ---------------------------------------------------------------------------
 # Utility functions
 
 function openim::build::docker_available_on_osx() {
-  if [[ -z "${DOCKER_HOST}" ]]; then
+if [[ -z "${DOCKER_HOST}" ]]; then
   if [[ -S "/var/run/docker.sock" ]]; then
     openim::log::status "Using Docker for MacOS"
     return 0
@@ -183,24 +183,24 @@ function openim::build::docker_available_on_osx() {
     elif [[ -n "$(which docker-machine)" ]]; then
     openim::build::prepare_docker_machine
   fi
-  fi
+fi
 }
 
 function openim::build::prepare_docker_machine() {
-  openim::log::status "docker-machine was found."
+openim::log::status "docker-machine was found."
 
-  local available_memory_bytes
+local available_memory_bytes
-  available_memory_bytes=$(sysctl -n hw.memsize 2>/dev/null)
+available_memory_bytes=$(sysctl -n hw.memsize 2>/dev/null)
 
-  local bytes_in_mb=1048576
+local bytes_in_mb=1048576
 
-  # Give virtualbox 1/2 the system memory. Its necessary to divide by 2, instead
+# Give virtualbox 1/2 the system memory. Its necessary to divide by 2, instead
-  # of multiple by .5, because bash can only multiply by ints.
+# of multiple by .5, because bash can only multiply by ints.
-  local memory_divisor=2
+local memory_divisor=2
 
-  local virtualbox_memory_mb=$(( available_memory_bytes / (bytes_in_mb * memory_divisor) ))
+local virtualbox_memory_mb=$(( available_memory_bytes / (bytes_in_mb * memory_divisor) ))
 
-  docker-machine inspect "${DOCKER_MACHINE_NAME}" &> /dev/null || {
+docker-machine inspect "${DOCKER_MACHINE_NAME}" &> /dev/null || {
   openim::log::status "Creating a machine to build OPENIM"
   docker-machine create --driver "${DOCKER_MACHINE_DRIVER}" \
   --virtualbox-memory "${virtualbox_memory_mb}" \
@@ -213,90 +213,90 @@ function openim::build::prepare_docker_machine() {
     openim::log::error "docker-machine create -d ${DOCKER_MACHINE_DRIVER} --virtualbox-memory ${virtualbox_memory_mb} ${DOCKER_MACHINE_NAME}"
     return 1
   }
-  }
+}
-  docker-machine start "${DOCKER_MACHINE_NAME}" &> /dev/null
+docker-machine start "${DOCKER_MACHINE_NAME}" &> /dev/null
-  # it takes `docker-machine env` a few seconds to work if the machine was just started
+# it takes `docker-machine env` a few seconds to work if the machine was just started
-  local docker_machine_out
+local docker_machine_out
-  while ! docker_machine_out=$(docker-machine env "${DOCKER_MACHINE_NAME}" 2>&1); do
+while ! docker_machine_out=$(docker-machine env "${DOCKER_MACHINE_NAME}" 2>&1); do
   if [[ ${docker_machine_out} =~ "Error checking TLS connection" ]]; then
     echo "${docker_machine_out}"
     docker-machine regenerate-certs "${DOCKER_MACHINE_NAME}"
   else
     sleep 1
   fi
-  done
+done
-  eval "$(docker-machine env "${DOCKER_MACHINE_NAME}")"
+eval "$(docker-machine env "${DOCKER_MACHINE_NAME}")"
-  openim::log::status "A Docker host using docker-machine named '${DOCKER_MACHINE_NAME}' is ready to go!"
+openim::log::status "A Docker host using docker-machine named '${DOCKER_MACHINE_NAME}' is ready to go!"
-  return 0
+return 0
 }
 
 function openim::build::is_gnu_sed() {
-  [[ $(sed --version 2>&1) == *GNU* ]]
+[[ $(sed --version 2>&1) == *GNU* ]]
 }
 
 function openim::build::ensure_rsync() {
-  if [[ -z "$(which rsync)" ]]; then
+if [[ -z "$(which rsync)" ]]; then
   openim::log::error "Can't find 'rsync' in PATH, please fix and retry."
   return 1
-  fi
+fi
 }
 
 function openim::build::update_dockerfile() {
-  if openim::build::is_gnu_sed; then
+if openim::build::is_gnu_sed; then
   sed_opts=(-i)
-  else
+else
   sed_opts=(-i '')
-  fi
+fi
-  sed "${sed_opts[@]}" "s/OPENIM_BUILD_IMAGE_CROSS_TAG/${OPENIM_BUILD_IMAGE_CROSS_TAG}/" "${LOCAL_OUTPUT_BUILD_CONTEXT}/Dockerfile"
+sed "${sed_opts[@]}" "s/OPENIM_BUILD_IMAGE_CROSS_TAG/${OPENIM_BUILD_IMAGE_CROSS_TAG}/" "${LOCAL_OUTPUT_BUILD_CONTEXT}/Dockerfile"
 }
 
 function  openim::build::set_proxy() {
-  if [[ -n "${OPENIMRNETES_HTTPS_PROXY:-}" ]]; then
+if [[ -n "${OPENIMRNETES_HTTPS_PROXY:-}" ]]; then
   echo "ENV https_proxy $OPENIMRNETES_HTTPS_PROXY" >> "${LOCAL_OUTPUT_BUILD_CONTEXT}/Dockerfile"
-  fi
+fi
-  if [[ -n "${OPENIMRNETES_HTTP_PROXY:-}" ]]; then
+if [[ -n "${OPENIMRNETES_HTTP_PROXY:-}" ]]; then
   echo "ENV http_proxy $OPENIMRNETES_HTTP_PROXY" >> "${LOCAL_OUTPUT_BUILD_CONTEXT}/Dockerfile"
-  fi
+fi
-  if [[ -n "${OPENIMRNETES_NO_PROXY:-}" ]]; then
+if [[ -n "${OPENIMRNETES_NO_PROXY:-}" ]]; then
   echo "ENV no_proxy $OPENIMRNETES_NO_PROXY" >> "${LOCAL_OUTPUT_BUILD_CONTEXT}/Dockerfile"
-  fi
+fi
 }
 
 function openim::build::ensure_docker_in_path() {
-  if [[ -z "$(which docker)" ]]; then
+if [[ -z "$(which docker)" ]]; then
   openim::log::error "Can't find 'docker' in PATH, please fix and retry."
   openim::log::error "See https://docs.docker.com/installation/#installation for installation instructions."
   return 1
-  fi
+fi
 }
 
 function openim::build::ensure_tar() {
-  if [[ -n "${TAR:-}" ]]; then
+if [[ -n "${TAR:-}" ]]; then
   return
-  fi
+fi
 
-  # Find gnu tar if it is available, bomb out if not.
+# Find gnu tar if it is available, bomb out if not.
-  TAR=tar
+TAR=tar
-  if which gtar &>/dev/null; then
+if which gtar &>/dev/null; then
   TAR=gtar
-  else
+else
   if which gnutar &>/dev/null; then
     TAR=gnutar
   fi
-  fi
+fi
-  if ! "${TAR}" --version | grep -q GNU; then
+if ! "${TAR}" --version | grep -q GNU; then
   echo "  !!! Cannot find GNU tar. Build on Linux or install GNU tar"
   echo "      on Mac OS X (brew install gnu-tar)."
   return 1
-  fi
+fi
 }
 
 function openim::build::has_docker() {
-  which docker &> /dev/null
+which docker &> /dev/null
 }
 
 function openim::build::has_ip() {
-  which ip &> /dev/null && ip -Version | grep 'iproute2' &> /dev/null
+which ip &> /dev/null && ip -Version | grep 'iproute2' &> /dev/null
 }
 
 # Detect if a specific image exists
@@ -304,12 +304,12 @@ function openim::build::has_ip() {
 # $1 - image repo name
 # $2 - image tag
 function openim::build::docker_image_exists() {
-  [[ -n $1 && -n $2 ]] || {
+[[ -n $1 && -n $2 ]] || {
   openim::log::error "Internal error. Image not specified in docker_image_exists."
   exit 2
-  }
+}
 
-  [[ $("${DOCKER[@]}" images -q "${1}:${2}") ]]
+[[ $("${DOCKER[@]}" images -q "${1}:${2}") ]]
 }
 
 # Delete all images that match a tag prefix except for the "current" version
@@ -318,9 +318,9 @@ function openim::build::docker_image_exists() {
 # $2: The tag base. We consider any image that matches $2*
 # $3: The current image not to delete if provided
 function openim::build::docker_delete_old_images() {
-  # In Docker 1.12, we can replace this with
+# In Docker 1.12, we can replace this with
-  #    docker images "$1" --format "{{.Tag}}"
+#    docker images "$1" --format "{{.Tag}}"
-  for tag in $("${DOCKER[@]}" images "${1}" | tail -n +2 | awk '{print $2}') ; do
+for tag in $("${DOCKER[@]}" images "${1}" | tail -n +2 | awk '{print $2}') ; do
   if [[ "${tag}" != "${2}"* ]] ; then
     V=3 openim::log::status "Keeping image ${1}:${tag}"
     continue
@@ -332,7 +332,7 @@ function openim::build::docker_delete_old_images() {
   else
     V=3 openim::log::status "Keeping image ${1}:${tag}"
   fi
-  done
+done
 }
 
 # Stop and delete all containers that match a pattern
@@ -340,9 +340,9 @@ function openim::build::docker_delete_old_images() {
 # $1: The base container prefix
 # $2: The current container to keep, if provided
 function openim::build::docker_delete_old_containers() {
-  # In Docker 1.12 we can replace this line with
+# In Docker 1.12 we can replace this line with
-  #   docker ps -a --format="{{.Names}}"
+#   docker ps -a --format="{{.Names}}"
-  for container in $("${DOCKER[@]}" ps -a | tail -n +2 | awk '{print $NF}') ; do
+for container in $("${DOCKER[@]}" ps -a | tail -n +2 | awk '{print $NF}') ; do
   if [[ "${container}" != "${1}"* ]] ; then
     V=3 openim::log::status "Keeping container ${container}"
     continue
@@ -353,23 +353,23 @@ function openim::build::docker_delete_old_containers() {
   else
     V=3 openim::log::status "Keeping container ${container}"
   fi
-  done
+done
 }
 
 # Takes $1 and computes a short has for it. Useful for unique tag generation
 function openim::build::short_hash() {
-  [[ $# -eq 1 ]] || {
+[[ $# -eq 1 ]] || {
   openim::log::error "Internal error.  No data based to short_hash."
   exit 2
-  }
+}
 
-  local short_hash
+local short_hash
-  if which md5 >/dev/null 2>&1; then
+if which md5 >/dev/null 2>&1; then
   short_hash=$(md5 -q -s "$1")
-  else
+else
   short_hash=$(echo -n "$1" | md5sum)
-  fi
+fi
-  echo "${short_hash:0:10}"
+echo "${short_hash:0:10}"
 }
 
 # Pedantically kill, wait-on and remove a container. The -f -v options
@@ -377,15 +377,15 @@ function openim::build::short_hash() {
 # container, wait to ensure it's stopped, then try the remove. This is
 # a workaround for bug https://github.com/docker/docker/issues/3968.
 function openim::build::destroy_container() {
-  "${DOCKER[@]}" kill "$1" >/dev/null 2>&1 || true
+"${DOCKER[@]}" kill "$1" >/dev/null 2>&1 || true
-  if [[ $("${DOCKER[@]}" version --format '{{.Server.Version}}') = 17.06.0* ]]; then
+if [[ $("${DOCKER[@]}" version --format '{{.Server.Version}}') = 17.06.0* ]]; then
   # Workaround https://github.com/moby/moby/issues/33948.
   # TODO: remove when 17.06.0 is not relevant anymore
   DOCKER_API_VERSION=v1.29 "${DOCKER[@]}" wait "$1" >/dev/null 2>&1 || true
-  else
+else
   "${DOCKER[@]}" wait "$1" >/dev/null 2>&1 || true
-  fi
+fi
-  "${DOCKER[@]}" rm -f -v "$1" >/dev/null 2>&1 || true
+"${DOCKER[@]}" rm -f -v "$1" >/dev/null 2>&1 || true
 }
 
 # ---------------------------------------------------------------------------
@@ -393,7 +393,7 @@ function openim::build::destroy_container() {
 
 
 function openim::build::clean() {
-  if openim::build::has_docker ; then
+if openim::build::has_docker ; then
   openim::build::docker_delete_old_containers "${OPENIM_BUILD_CONTAINER_NAME_BASE}"
   openim::build::docker_delete_old_containers "${OPENIM_RSYNC_CONTAINER_NAME_BASE}"
   openim::build::docker_delete_old_containers "${OPENIM_DATA_CONTAINER_NAME_BASE}"
@@ -401,39 +401,39 @@ function openim::build::clean() {
   
   V=2 openim::log::status "Cleaning all untagged docker images"
   "${DOCKER[@]}" rmi "$("${DOCKER[@]}" images -q --filter 'dangling=true')" 2> /dev/null || true
-  fi
+fi
 
-  if [[ -d "${LOCAL_OUTPUT_ROOT}" ]]; then
+if [[ -d "${LOCAL_OUTPUT_ROOT}" ]]; then
   openim::log::status "Removing _output directory"
   rm -rf "${LOCAL_OUTPUT_ROOT}"
-  fi
+fi
 }
 
 # Set up the context directory for the openim-build image and build it.
 function openim::build::build_image() {
-  mkdir -p "${LOCAL_OUTPUT_BUILD_CONTEXT}"
+mkdir -p "${LOCAL_OUTPUT_BUILD_CONTEXT}"
-  # Make sure the context directory owned by the right user for syncing sources to container.
+# Make sure the context directory owned by the right user for syncing sources to container.
-  chown -R "${USER_ID}":"${GROUP_ID}" "${LOCAL_OUTPUT_BUILD_CONTEXT}"
+chown -R "${USER_ID}":"${GROUP_ID}" "${LOCAL_OUTPUT_BUILD_CONTEXT}"
 
-  cp /etc/localtime "${LOCAL_OUTPUT_BUILD_CONTEXT}/"
+cp /etc/localtime "${LOCAL_OUTPUT_BUILD_CONTEXT}/"
 
-  cp "${OPENIM_ROOT}/build/build-image/Dockerfile" "${LOCAL_OUTPUT_BUILD_CONTEXT}/Dockerfile"
+cp "${OPENIM_ROOT}/build/build-image/Dockerfile" "${LOCAL_OUTPUT_BUILD_CONTEXT}/Dockerfile"
-  cp "${OPENIM_ROOT}/build/build-image/rsyncd.sh" "${LOCAL_OUTPUT_BUILD_CONTEXT}/"
+cp "${OPENIM_ROOT}/build/build-image/rsyncd.sh" "${LOCAL_OUTPUT_BUILD_CONTEXT}/"
-  dd if=/dev/urandom bs=512 count=1 2>/dev/null | LC_ALL=C tr -dc 'A-Za-z0-9' | dd bs=32 count=1 2>/dev/null > "${LOCAL_OUTPUT_BUILD_CONTEXT}/rsyncd.password"
+dd if=/dev/urandom bs=512 count=1 2>/dev/null | LC_ALL=C tr -dc 'A-Za-z0-9' | dd bs=32 count=1 2>/dev/null > "${LOCAL_OUTPUT_BUILD_CONTEXT}/rsyncd.password"
-  chmod go= "${LOCAL_OUTPUT_BUILD_CONTEXT}/rsyncd.password"
+chmod go= "${LOCAL_OUTPUT_BUILD_CONTEXT}/rsyncd.password"
 
-  openim::build::update_dockerfile
+openim::build::update_dockerfile
-  openim::build::set_proxy
+openim::build::set_proxy
-  openim::build::docker_build "${OPENIM_BUILD_IMAGE}" "${LOCAL_OUTPUT_BUILD_CONTEXT}" 'false'
+openim::build::docker_build "${OPENIM_BUILD_IMAGE}" "${LOCAL_OUTPUT_BUILD_CONTEXT}" 'false'
 
-  # Clean up old versions of everything
+# Clean up old versions of everything
-  openim::build::docker_delete_old_containers "${OPENIM_BUILD_CONTAINER_NAME_BASE}" "${OPENIM_BUILD_CONTAINER_NAME}"
+openim::build::docker_delete_old_containers "${OPENIM_BUILD_CONTAINER_NAME_BASE}" "${OPENIM_BUILD_CONTAINER_NAME}"
-  openim::build::docker_delete_old_containers "${OPENIM_RSYNC_CONTAINER_NAME_BASE}" "${OPENIM_RSYNC_CONTAINER_NAME}"
+openim::build::docker_delete_old_containers "${OPENIM_RSYNC_CONTAINER_NAME_BASE}" "${OPENIM_RSYNC_CONTAINER_NAME}"
-  openim::build::docker_delete_old_containers "${OPENIM_DATA_CONTAINER_NAME_BASE}" "${OPENIM_DATA_CONTAINER_NAME}"
+openim::build::docker_delete_old_containers "${OPENIM_DATA_CONTAINER_NAME_BASE}" "${OPENIM_DATA_CONTAINER_NAME}"
-  openim::build::docker_delete_old_images "${OPENIM_BUILD_IMAGE_REPO}" "${OPENIM_BUILD_IMAGE_TAG_BASE}" "${OPENIM_BUILD_IMAGE_TAG}"
+openim::build::docker_delete_old_images "${OPENIM_BUILD_IMAGE_REPO}" "${OPENIM_BUILD_IMAGE_TAG_BASE}" "${OPENIM_BUILD_IMAGE_TAG}"
 
-  openim::build::ensure_data_container
+openim::build::ensure_data_container
-  openim::build::sync_to_container
+openim::build::sync_to_container
 }
 
 # Build a docker image from a Dockerfile.
@@ -441,14 +441,14 @@ function openim::build::build_image() {
 # $2 is the location of the "context" directory, with the Dockerfile at the root.
 # $3 is the value to set the --pull flag for docker build; true by default
 function openim::build::docker_build() {
-  local -r image=$1
+local -r image=$1
-  local -r context_dir=$2
+local -r context_dir=$2
-  local -r pull="${3:-true}"
+local -r pull="${3:-true}"
-  local -ra build_cmd=("${DOCKER[@]}" build -t "${image}" "--pull=${pull}" "${context_dir}")
+local -ra build_cmd=("${DOCKER[@]}" build -t "${image}" "--pull=${pull}" "${context_dir}")
 
-  openim::log::status "Building Docker image ${image}"
+openim::log::status "Building Docker image ${image}"
-  local docker_output
+local docker_output
-  docker_output=$("${build_cmd[@]}" 2>&1) || {
+docker_output=$("${build_cmd[@]}" 2>&1) || {
     cat <<EOF >&2
 +++ Docker build command failed for ${image}
 
@@ -460,23 +460,23 @@ ${build_cmd[*]}
 
 EOF
   return 1
-  }
+}
 }
 
 function openim::build::ensure_data_container() {
-  # If the data container exists AND exited successfully, we can use it.
+# If the data container exists AND exited successfully, we can use it.
-  # Otherwise nuke it and start over.
+# Otherwise nuke it and start over.
-  local ret=0
+local ret=0
-  local code=0
+local code=0
 
-  code=$(docker inspect \
+code=$(docker inspect \
   -f '{{.State.ExitCode}}' \
-      "${OPENIM_DATA_CONTAINER_NAME}" 2>/dev/null) || ret=$?
+"${OPENIM_DATA_CONTAINER_NAME}" 2>/dev/null) || ret=$?
-  if [[ "${ret}" == 0 && "${code}" != 0 ]]; then
+if [[ "${ret}" == 0 && "${code}" != 0 ]]; then
   openim::build::destroy_container "${OPENIM_DATA_CONTAINER_NAME}"
   ret=1
-  fi
+fi
-  if [[ "${ret}" != 0 ]]; then
+if [[ "${ret}" != 0 ]]; then
   openim::log::status "Creating data container ${OPENIM_DATA_CONTAINER_NAME}"
   # We have to ensure the directory exists, or else the docker run will
   # create it as root.
@@ -509,11 +509,11 @@ function openim::build::ensure_data_container() {
     /usr/local/go/pkg/
   )
   "${docker_cmd[@]}"
-  fi
+fi
 }
 
 # Build all openim commands.
 function openim::build::build_command() {
-  openim::log::status "Running build command..."
+openim::log::status "Running build command..."
-  make -C "${OPENIM_ROOT}" multiarch
+make -C "${OPENIM_ROOT}" multiarch
 }

scripts/ensure-tag.sh

@@ -18,9 +18,9 @@ OPENIM_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
 
 version="${VERSION}"
 if [ "${version}" == "" ];then
-  version=v`${OPENIM_ROOT}/_output/tools/gsemver bump`
+  version=v$(${OPENIM_ROOT}/_output/tools/gsemver bump)
 fi
 
-if [ -z "`git tag -l ${version}`" ];then
+if [ -z "$(git tag -l ${version})" ];then
   git tag -a -m "release version ${version}" ${version}
 fi

scripts/gen-swagger-docs.sh

@@ -67,7 +67,7 @@ echo -e "=== any\nRepresents an untyped JSON map - see the description of the fi
 asciidoctor definitions.adoc
 asciidoctor paths.adoc
 
-cp ${OPENIM_OUTPUT_TMP}/definitions.html ${OPENIM_OUTPUT_TMP}/_output/
+cp "$OPENIM_OUTPUT_TMP/definitions.html" "$OPENIM_OUTPUT_TMP/_output/"
-cp ${OPENIM_OUTPUT_TMP}/paths.html ${OPENIM_OUTPUT_TMP}/_output/operations.html
+cp "$OPENIM_OUTPUT_TMP/paths.html" "$OPENIM_OUTPUT_TMP/_output/operations.html"
 
 success "SUCCESS"

scripts/genconfig.sh

@@ -25,7 +25,7 @@ OPENIM_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
 source "${OPENIM_ROOT}/scripts/lib/init.sh"
 
 if [ $# -ne 2 ];then
-    openim::log::error "Usage: scripts/genconfig.sh scripts/environment.sh configs/openim-api.yaml"
+  openim::log::error "Usage: scripts/genconfig.sh scripts/environment.sh configs/config.yaml"
   exit 1
 fi
 
@@ -47,7 +47,7 @@ do
 done
 
 if [ "${missing}" ];then
-    openim::log::error 'You may run `source scripts/environment.sh` to set these environment'
+  openim::log::error "You may run 'source scripts/environment.sh' to set these environment"
   exit 1
 fi
 

scripts/githooks/commit-msg.sh

@@ -50,9 +50,9 @@ printMessage "Running the OpenIM commit-msg hook."
 # This example catches duplicate Signed-off-by lines.
 
 test "" = "$(grep '^Signed-off-by: ' "$1" |
-	 sort | uniq -c | sed -e '/^[ 	]*1[ 	]/d')" || {
+sort | uniq -c | sed -e '/^[ 	]*1[ 	]/d')" || {
-	echo >&2 Duplicate Signed-off-by lines.
+echo >&2 Duplicate Signed-off-by lines.
-	exit 1
+exit 1
 }
 
 # TODO: go-gitlint dir set
@@ -60,21 +60,21 @@ OPENIM_ROOT=$(dirname "${BASH_SOURCE[0]}")/../..
 GITLINT_DIR="$OPENIM_ROOT/_output/tools/go-gitlint"
 
 $GITLINT_DIR \
-    --msg-file=$1 \
+--msg-file=$1 \
-    --subject-regex="^(build|chore|ci|docs|feat|feature|fix|perf|refactor|revert|style|bot|test)(.*)?:\s?.*" \
+--subject-regex="^(build|chore|ci|docs|feat|feature|fix|perf|refactor|revert|style|bot|test)(.*)?:\s?.*" \
-    --subject-maxlen=150 \
+--subject-maxlen=150 \
-    --subject-minlen=10 \
+--subject-minlen=10 \
-    --body-regex=".*" \
+--body-regex=".*" \
-    --max-parents=1
+--max-parents=1
 
 if [ $? -ne 0 ]
 then
-    if ! command -v $GITLINT_DIR &>/dev/null; then
+if ! command -v $GITLINT_DIR &>/dev/null; then
   printError "$GITLINT_DIR not found. Please run 'make tools' OR 'make tools.verify.go-gitlint' make verto install it."
-    fi
+fi
-    printError "Please fix your commit message to match kubecub coding standards"
+printError "Please fix your commit message to match kubecub coding standards"
-    printError "https://gist.github.com/cubxxw/126b72104ac0b0ca484c9db09c3e5694#file-githook-md"
+printError "https://gist.github.com/cubxxw/126b72104ac0b0ca484c9db09c3e5694#file-githook-md"
-    exit 1
+exit 1
 fi
 
 ### Add Sign-off-by line to the end of the commit message
@@ -88,5 +88,5 @@ SIGNED_OFF_BY_EXISTS=$?
 
 # Add "Signed-off-by" line if it doesn't exist
 if [ $SIGNED_OFF_BY_EXISTS -ne 0 ]; then
-  echo -e "\nSigned-off-by: $NAME <$EMAIL>" >> "$1"
+echo -e "\nSigned-off-by: $NAME <$EMAIL>" >> "$1"
 fi

scripts/githooks/pre-push.sh

@@ -38,7 +38,7 @@ printError() {
 
 printMessage "Running local OpenIM pre-push hook."
 
-if [[ `git status --porcelain` ]]; then
+if [[ $(git status --porcelain) ]]; then
   printError "This scripts needs to run against committed code only. Please commit or stash you changes."
   exit 1
 fi

scripts/init-config.sh

@@ -31,7 +31,7 @@ readonly ENV_FILE=${ENV_FILE:-"${OPENIM_ROOT}/scripts/install/environment.sh"}
 # Templates for configuration files
 declare -A TEMPLATES=(
   ["${OPENIM_ROOT}/deployments/templates/env-template.yaml"]="${OPENIM_ROOT}/.env"
-  ["${OPENIM_ROOT}/deployments/templates/openim.yaml"]="${OPENIM_ROOT}/config/config.yaml"
+  ["${OPENIM_ROOT}/deployments/templates/config.yaml"]="${OPENIM_ROOT}/config/config.yaml"
   ["${OPENIM_ROOT}/deployments/templates/prometheus.yml"]="${OPENIM_ROOT}/config/prometheus.yml"
   ["${OPENIM_ROOT}/deployments/templates/alertmanager.yml"]="${OPENIM_ROOT}/config/alertmanager.yml"
 )
@@ -39,7 +39,7 @@ declare -A TEMPLATES=(
 # Templates for example files
 declare -A EXAMPLES=(
   ["${OPENIM_ROOT}/deployments/templates/env-template.yaml"]="${OPENIM_ROOT}/config/templates/env.template"
-  ["${OPENIM_ROOT}/deployments/templates/openim.yaml"]="${OPENIM_ROOT}/config/templates/config.yaml.template"
+  ["${OPENIM_ROOT}/deployments/templates/config.yaml"]="${OPENIM_ROOT}/config/templates/config.yaml.template"
   ["${OPENIM_ROOT}/deployments/templates/prometheus.yml"]="${OPENIM_ROOT}/config/templates/prometheus.yml.template"
   ["${OPENIM_ROOT}/deployments/templates/alertmanager.yml"]="${OPENIM_ROOT}/config/templates/alertmanager.yml.template"
 )
@@ -95,6 +95,10 @@ generate_config_files() {
 # Function to generate example files
 generate_example_files() {
   env_cmd="env -i"
+  
+  env_vars["OPENIM_IP"]="127.0.0.1"
+  env_vars["LOG_STORAGE_LOCATION"]="../../"
+  
   for var in "${!env_vars[@]}"; do
     env_cmd+=" $var='${env_vars[$var]}'"
   done
@@ -110,7 +114,6 @@ generate_example_files() {
     local example_file="${COPY_EXAMPLES[$template]}"
     process_file "$template" "$example_file" false
   done
-
 }
 
 # Function to process a single file, either by generating or copying
@@ -181,7 +184,6 @@ clean_config_files() {
 
 # Function to clean example files
 clean_example_files() {
-  # 合并 EXAMPLES 和 COPY_EXAMPLES 数组
   local all_examples=("${EXAMPLES[@]}" "${COPY_EXAMPLES[@]}")
   
   for example_file in "${all_examples[@]}"; do

scripts/init-githooks.sh

@@ -50,7 +50,7 @@ help_info() {
 }
 
 delete_hooks() {
-    for file in ${OPENIM_ROOT}/scripts/githooks/*.sh; do
+  for file in "${OPENIM_ROOT}"/scripts/githooks/*.sh; do
     hook_name=$(basename "$file" .sh)  # This removes the .sh extension
     rm -f "$HOOKS_DIR/$hook_name"
   done

scripts/install/dependency.sh

@@ -24,66 +24,66 @@ OPENIM_ROOT=$(cd "$(dirname "${BASH_SOURCE[0]}")"/../.. && pwd -P)
 
 # Start MongoDB service
 docker run -d \
-    --name mongo \
+--name mongo \
-    -p 37017:27017 \
+-p 37017:27017 \
-    -v "${DATA_DIR}/components/mongodb/data/db:/data/db" \
+-v "${DATA_DIR}/components/mongodb/data/db:/data/db" \
-    -v "${DATA_DIR}/components/mongodb/data/logs:/data/logs" \
+-v "${DATA_DIR}/components/mongodb/data/logs:/data/logs" \
-    -v "${DATA_DIR}/components/mongodb/data/conf:/etc/mongo" \
+-v "${DATA_DIR}/components/mongodb/data/conf:/etc/mongo" \
-    -v "./scripts/mongo-init.sh:/docker-entrypoint-initdb.d/mongo-init.sh:ro" \
+-v "./scripts/mongo-init.sh:/docker-entrypoint-initdb.d/mongo-init.sh:ro" \
-    -e TZ=Asia/Shanghai \
+-e TZ=Asia/Shanghai \
-    -e wiredTigerCacheSizeGB=1 \
+-e wiredTigerCacheSizeGB=1 \
-    -e MONGO_INITDB_ROOT_USERNAME=${OPENIM_USER} \
+-e MONGO_INITDB_ROOT_USERNAME=${OPENIM_USER} \
-    -e MONGO_INITDB_ROOT_PASSWORD=${PASSWORD} \
+-e MONGO_INITDB_ROOT_PASSWORD=${PASSWORD} \
-    -e MONGO_INITDB_DATABASE=openIM \
+-e MONGO_INITDB_DATABASE=openim_v3 \
-    -e MONGO_OPENIM_USERNAME=${OPENIM_USER} \
+-e MONGO_OPENIM_USERNAME=${OPENIM_USER} \
-    -e MONGO_OPENIM_PASSWORD=${PASSWORD} \
+-e MONGO_OPENIM_PASSWORD=${PASSWORD} \
-    --restart always \
+--restart always \
-    mongo:6.0.2 --wiredTigerCacheSizeGB 1 --auth
+mongo:6.0.2 --wiredTigerCacheSizeGB 1 --auth
 
 # Start Redis service
 docker run -d \
-    --name redis \
+--name redis \
-    -p 16379:6379 \
+-p 16379:6379 \
-    -v "${DATA_DIR}/components/redis/data:/data" \
+-v "${DATA_DIR}/components/redis/data:/data" \
-    -v "${DATA_DIR}/components/redis/config/redis.conf:/usr/local/redis/config/redis.conf" \
+-v "${DATA_DIR}/components/redis/config/redis.conf:/usr/local/redis/config/redis.conf" \
-    -e TZ=Asia/Shanghai \
+-e TZ=Asia/Shanghai \
-    --sysctl net.core.somaxconn=1024 \
+--sysctl net.core.somaxconn=1024 \
-    --restart always \
+--restart always \
-    redis:7.0.0 redis-server --requirepass ${PASSWORD} --appendonly yes
+redis:7.0.0 redis-server --requirepass ${PASSWORD} --appendonly yes
 
 # Start Zookeeper service
 docker run -d \
-    --name zookeeper \
+--name zookeeper \
-    -p 2181:2181 \
+-p 2181:2181 \
-    -v "/etc/localtime:/etc/localtime" \
+-v "/etc/localtime:/etc/localtime" \
-    -e TZ=Asia/Shanghai \
+-e TZ=Asia/Shanghai \
-    --restart always \
+--restart always \
-    wurstmeister/zookeeper
+wurstmeister/zookeeper
 
 # Start Kafka service
 docker run -d \
-    --name kafka \
+--name kafka \
-    -p 9092:9092 \
+-p 9092:9092 \
-    -e TZ=Asia/Shanghai \
+-e TZ=Asia/Shanghai \
-    -e KAFKA_BROKER_ID=0 \
+-e KAFKA_BROKER_ID=0 \
-    -e KAFKA_ZOOKEEPER_CONNECT=zookeeper:2181 \
+-e KAFKA_ZOOKEEPER_CONNECT=zookeeper:2181 \
-    -e KAFKA_CREATE_TOPICS="latestMsgToRedis:8:1,msgToPush:8:1,offlineMsgToMongoMysql:8:1" \
+-e KAFKA_CREATE_TOPICS="latestMsgToRedis:8:1,msgToPush:8:1,offlineMsgToMongoMysql:8:1" \
-    -e KAFKA_ADVERTISED_LISTENERS="INSIDE://127.0.0.1:9092,OUTSIDE://103.116.45.174:9092" \
+-e KAFKA_ADVERTISED_LISTENERS="INSIDE://127.0.0.1:9092,OUTSIDE://103.116.45.174:9092" \
-    -e KAFKA_LISTENERS="INSIDE://:9092,OUTSIDE://:9093" \
+-e KAFKA_LISTENERS="INSIDE://:9092,OUTSIDE://:9093" \
-    -e KAFKA_LISTENER_SECURITY_PROTOCOL_MAP="INSIDE:PLAINTEXT,OUTSIDE:PLAINTEXT" \
+-e KAFKA_LISTENER_SECURITY_PROTOCOL_MAP="INSIDE:PLAINTEXT,OUTSIDE:PLAINTEXT" \
-    -e KAFKA_INTER_BROKER_LISTENER_NAME=INSIDE \
+-e KAFKA_INTER_BROKER_LISTENER_NAME=INSIDE \
-    --restart always \
+--restart always \
-    --link zookeeper \
+--link zookeeper \
-    wurstmeister/kafka
+wurstmeister/kafka
 
 # Start MinIO service
 docker run -d \
-    --name minio \
+--name minio \
-    -p 10005:9000 \
+-p 10005:9000 \
-    -p 9090:9090 \
+-p 9090:9090 \
-    -v "/mnt/data:/data" \
+-v "/mnt/data:/data" \
-    -v "/mnt/config:/root/.minio" \
+-v "/mnt/config:/root/.minio" \
-    -e MINIO_ROOT_USER=${OPENIM_USER} \
+-e MINIO_ROOT_USER=${OPENIM_USER} \
-    -e MINIO_ROOT_PASSWORD=${PASSWORD} \
+-e MINIO_ROOT_PASSWORD=${PASSWORD} \
-    --restart always \
+--restart always \
-    minio/minio server /data --console-address ':9090'
+minio/minio server /data --console-address ':9090'

scripts/install/environment.sh

@@ -52,7 +52,7 @@ def "OPENIM_USER" "root"
 readonly PASSWORD=${PASSWORD:-'openIM123'}
 
 # 设置统一的数据库名称，方便管理
-def "DATABASE_NAME" "openIM_v3"
+def "DATABASE_NAME" "openim_v3"
 
 # Linux系统 openim 用户
 def "LINUX_USERNAME" "openim"

scripts/install/install.sh

@@ -76,7 +76,7 @@ function openim::install::install_openim() {
   openim::log::info "check openim dependency"
   openim::common::sudo "cp -r ${OPENIM_ROOT}/config/* ${OPENIM_CONFIG_DIR}/"
   
-    ${OPENIM_ROOT}/scripts/genconfig.sh ${ENV_FILE} ${OPENIM_ROOT}/deployments/templates/openim.yaml > ${OPENIM_CONFIG_DIR}/config.yaml
+  ${OPENIM_ROOT}/scripts/genconfig.sh ${ENV_FILE} ${OPENIM_ROOT}/deployments/templates/config.yaml > ${OPENIM_CONFIG_DIR}/config.yaml
   ${OPENIM_ROOT}/scripts/genconfig.sh ${ENV_FILE} ${OPENIM_ROOT}/deployments/templates/prometheus.yml > ${OPENIM_CONFIG_DIR}/prometheus.yml
   
   openim::util::check_ports ${OPENIM_DEPENDENCY_PORT_LISTARIES[@]}

scripts/install/openim-rpc.sh

@@ -139,7 +139,7 @@ function openim::rpc::start() {
         done
     done
 
-    sleep 1
+    sleep 5
 
     openim::util::check_ports ${OPENIM_RPC_PORT_TARGETS[@]}
     # openim::util::check_ports ${OPENIM_RPC_PROM_PORT_TARGETS[@]}

scripts/install/openim-tools.sh

@@ -104,12 +104,7 @@ function openim::tools::start_service() {
     cmd="${cmd} --prometheus_port ${prometheus_port}"
   fi
   openim::log::status "Starting ${binary_name}..."
-  # Later, after discarding Docker, the Docker keyword is unreliable, and Kubepods is used
-  if grep -qE 'docker|kubepods' /proc/1/cgroup || [ -f /.dockerenv ]; then
-      ${cmd} >> "${LOG_FILE}" 2>&1
-  else
   ${cmd} | tee -a "${LOG_FILE}"
-  fi
 }
 
 function openim::tools::start() {

scripts/install/test.sh

@@ -73,20 +73,22 @@ function openim::test::auth() {
 # Define a function to get a token for a specific user
 openim::test::get_token() {
 	local user_id="${1:-openIM123456}" # Default user ID if not provided
-  token_response=$(${CCURL} "${OperationID}" "${Header}" ${INSECURE_OPENIMAPI}/auth/user_token \
+	token_response=$(
-      -d'{"secret": "'"$SECRET"'","platformID": 1,"userID": "'$user_id'"}')
+		${CCURL} "${OperationID}" "${Header}" ${INSECURE_OPENIMAPI}/auth/user_token \
+		-d'{"secret": "'"$SECRET"'","platformID": 1,"userID": "'$user_id'"}'
+	)
 	token=$(echo $token_response | grep -Po 'token[" :]+\K[^"]+')
 	echo "$token"
 }
 
-
 Header="-HContent-Type: application/json"
 OperationID="-HoperationID: 1646445464564"
 Token="-Htoken: $(openim::test::get_token)"
 
 # Forces a user to log out from the specified platform by user ID.
 openim::test::force_logout() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "platformID": 2,
   "userID": "4950983283"
@@ -100,7 +102,6 @@ EOF
 	openim::test::check_error "$response"
 }
 
-
 #################################### User Module ####################################
 
 # Registers a new user with provided user ID, nickname, and face URL using the API.
@@ -111,7 +112,8 @@ openim::test::user_register() {
 	local face_url="${3:-https://github.com/cubxxw}"
 
 	# Create the request body using the provided or default values
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "secret": "${SECRET}",
   "users": [
@@ -123,7 +125,7 @@ openim::test::user_register() {
   ]
 }
 EOF
-)
+	)
 
 	echo "Request body for user registration: $request_body"
 
@@ -136,7 +138,8 @@ EOF
 
 # Checks if the provided list of user IDs exist in the system.
 openim::test::check_user_account() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "checkUserIDs": [
     "${1}",
@@ -146,7 +149,7 @@ openim::test::check_user_account() {
   ]
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/user/account_check" -d "${request_body}")
@@ -156,7 +159,8 @@ EOF
 
 # Retrieves a list of users with pagination, limited to a specific number per page.
 openim::test::get_users() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "pagination": {
     "pageNumber": 1,
@@ -164,7 +168,7 @@ openim::test::get_users() {
   }
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/user/get_users" -d "${request_body}")
@@ -174,7 +178,8 @@ EOF
 
 # Obtains detailed information for a list of user IDs.
 openim::test::get_users_info() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userIDs": [
     "${1}",
@@ -182,7 +187,7 @@ openim::test::get_users_info() {
   ]
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/user/get_users_info" -d "${request_body}")
@@ -192,7 +197,8 @@ EOF
 
 # Retrieves the online status for a list of user IDs.
 openim::test::get_users_online_status() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userIDs": [
     "${TEST_USER_ID}",
@@ -202,7 +208,7 @@ openim::test::get_users_online_status() {
   ]
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/user/get_users_online_status" -d "${request_body}")
@@ -212,7 +218,8 @@ EOF
 
 # Updates the information for a user, such as nickname and face URL.
 openim::test::update_user_info() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userInfo": {
     "userID": "${TEST_USER_ID}",
@@ -221,7 +228,7 @@ openim::test::update_user_info() {
   }
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/user/update_user_info" -d "${request_body}")
@@ -231,12 +238,13 @@ EOF
 
 # Gets the online status for users that a particular user has subscribed to.
 openim::test::get_subscribe_users_status() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userID": "${TEST_USER_ID}"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/user/get_subscribe_users_status" -d "${request_body}")
@@ -246,7 +254,8 @@ EOF
 
 # Subscribes to the online status of a list of users for a particular user ID.
 openim::test::subscribe_users_status() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userID": "9168684795",
   "userIDs": [
@@ -257,7 +266,7 @@ openim::test::subscribe_users_status() {
   "genre": 1
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/user/subscribe_users_status" -d "${request_body}")
@@ -267,13 +276,14 @@ EOF
 
 # Sets the global message receiving option for a user, determining their messaging preferences.
 openim::test::set_global_msg_recv_opt() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userID": "${TEST_USER_ID}",
   "globalRecvMsgOpt": 0
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/user/set_global_msg_recv_opt" -d "${request_body}")
@@ -322,13 +332,14 @@ function openim::test::user() {
 
 # Checks if two users are friends.
 openim::test::is_friend() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userID1": "${1}",
   "userID2": "${2}"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/friend/is_friend" -d "${request_body}")
@@ -338,13 +349,14 @@ EOF
 
 # Deletes a friend for a user.
 openim::test::delete_friend() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "ownerUserID":"${1}",
   "friendUserID":"${2}"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/friend/delete_friend" -d "${request_body}")
@@ -354,7 +366,8 @@ EOF
 
 # Gets the friend application list for a user.
 openim::test::get_friend_apply_list() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userID": "${MANAGER_USERID_1}",
   "pagination": {
@@ -363,7 +376,7 @@ openim::test::get_friend_apply_list() {
   }
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/friend/get_friend_apply_list" -d "${request_body}")
@@ -373,7 +386,8 @@ EOF
 
 # Gets the friend list for a user.
 openim::test::get_friend_list() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userID": "${1}",
   "pagination": {
@@ -382,7 +396,7 @@ openim::test::get_friend_list() {
   }
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/friend/get_friend_list" -d "${request_body}")
@@ -392,14 +406,15 @@ EOF
 
 # Sets a remark for a friend.
 openim::test::set_friend_remark() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "ownerUserID": "${1}",
   "friendUserID": "${2}",
   "remark": "remark"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/friend/set_friend_remark" -d "${request_body}")
@@ -409,7 +424,8 @@ EOF
 
 # Adds a friend request.
 openim::test::add_friend() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "fromUserID": "${1}",
   "toUserID": "${2}",
@@ -417,7 +433,7 @@ openim::test::add_friend() {
   "ex": ""
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/friend/add_friend" -d "${request_body}")
@@ -429,13 +445,14 @@ EOF
 openim::test::import_friend() {
 	local friend_ids=$(printf ', "%s"' "${@:2}")
 	friend_ids=${friend_ids:2}
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "ownerUserID": "${1}",
   "friendUserIDs": [${friend_ids}]
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/friend/import_friend" -d "${request_body}")
@@ -443,10 +460,10 @@ EOF
 	openim::test::check_error "$response"
 }
 
-
 # Responds to a friend request.
 openim::test::add_friend_response() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "fromUserID": "${1}",
   "toUserID": "${2}",
@@ -454,7 +471,7 @@ openim::test::add_friend_response() {
   "handleMsg": "agree"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/friend/add_friend_response" -d "${request_body}")
@@ -464,7 +481,8 @@ EOF
 
 # Retrieves the friend application list that the user has applied for.
 openim::test::get_self_friend_apply_list() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userID": "${1}",
   "pagination": {
@@ -473,7 +491,7 @@ openim::test::get_self_friend_apply_list() {
   }
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/friend/get_self_friend_apply_list" -d "${request_body}")
@@ -483,13 +501,14 @@ EOF
 
 # Adds a user to the blacklist.
 openim::test::add_black() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "ownerUserID": "${1}",
   "blackUserID": "${2}"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/friend/add_black" -d "${request_body}")
@@ -499,13 +518,14 @@ EOF
 
 # Removes a user from the blacklist.
 openim::test::remove_black() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "ownerUserID": "${1}",
   "blackUserID": "${2}"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/friend/remove_black" -d "${request_body}")
@@ -515,7 +535,8 @@ EOF
 
 # Retrieves the blacklist for a user.
 openim::test::get_black_list() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userID": "${1}",
   "pagination": {
@@ -524,7 +545,7 @@ openim::test::get_black_list() {
   }
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/friend/get_black_list" -d "${request_body}")
@@ -544,16 +565,20 @@ openim::test::update_pin_status() {
 	for friendUserID in "$@"; do
 		friendUserIDsArray+=("\"${friendUserID}\"")
 	done
-  local friendUserIDs=$(IFS=,; echo "${friendUserIDsArray[*]}")
+	local friendUserIDs=$(
+		IFS=,
+		echo "${friendUserIDsArray[*]}"
+	)
 
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "ownerUserID": "${ownerUserID}",
   "friendUserIDs": [${friendUserIDs}],
   "isPinned": ${isPinned}
 }
 EOF
-)
+	)
 	echo "Requesting to update pin status: $request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/friend/update_pin_status" -d "${request_body}")
@@ -561,7 +586,6 @@ EOF
 	openim::test::check_error "$response"
 }
 
-
 # [openim::test::friend function description]
 # The `openim::test::friend` function serves as a test suite for friend-related operations.
 # It sequentially invokes all friend-related test functions to ensure the API's friend operations are functioning correctly.
@@ -587,7 +611,7 @@ function openim::test::friend() {
 	local friend_token="-Htoken: $(openim::test::get_token "${FRIEND_USER_ID}")"
 	# 3. Respond to a friend request.
 	# TODO：
-#   openim::test::add_friend_response "${FRIEND_USER_ID}" "${TEST_USER_ID}"
+	#   openim::test::add_friend_response "${FRIEND_USER_ID}" "${TEST_USER_ID}"
 
 	Token=$original_token
 	# 4. Retrieve the friend list of the test user.
@@ -595,7 +619,7 @@ function openim::test::friend() {
 
 	# 5. Set a remark for a friend.
 	# TODO：
-#   openim::test::set_friend_remark "${TEST_USER_ID}" "${FRIEND_USER_ID}"
+	#   openim::test::set_friend_remark "${TEST_USER_ID}" "${FRIEND_USER_ID}"
 
 	# 6. Retrieve the friend application list for the test user.
 	openim::test::get_friend_apply_list "${TEST_USER_ID}" 1 100
@@ -605,7 +629,7 @@ function openim::test::friend() {
 
 	# 8. Delete a friend.
 	# TODO：
-#   openim::test::delete_friend "${TEST_USER_ID}" "${FRIEND_USER_ID}"
+	#   openim::test::delete_friend "${TEST_USER_ID}" "${FRIEND_USER_ID}"
 
 	# 9. Add a user to the blacklist.
 	openim::test::add_black "${TEST_USER_ID}" "${BLACK_USER_ID}"
@@ -618,25 +642,25 @@ function openim::test::friend() {
 
 	# 12. Import friends for the user (Optional).
 	# TODO：
-#   openim::test::import_friend "${TEST_USER_ID}" "11111114" "11111115"
+	#   openim::test::import_friend "${TEST_USER_ID}" "11111114" "11111115"
 
 	# 13. pin Friend
 	# Add this call to your test suite where appropriate
 	# TODO：
-#  openim::test::update_pin_status "${TEST_USER_ID}" true "${FRIEND_USER_ID}"
+	#  openim::test::update_pin_status "${TEST_USER_ID}" true "${FRIEND_USER_ID}"
-#
+	#
-#  openim::test::update_pin_status "${TEST_USER_ID}" false "${FRIEND_USER_ID}"
+	#  openim::test::update_pin_status "${TEST_USER_ID}" false "${FRIEND_USER_ID}"
 
 	# Log the completion of the friend test suite.
 	openim::log::success "Friend test suite completed successfully."
 }
 
-
 #################################### Group Module ####################################
 
 # Creates a new group.
 openim::test::create_group() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "memberUserIDs": [
     "${1}"
@@ -659,7 +683,7 @@ openim::test::create_group() {
   }
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/create_group" -d "${request_body}")
@@ -669,7 +693,8 @@ EOF
 
 # Invites a user to join a group.
 openim::test::invite_user_to_group() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupID": "${1}",
   "invitedUserIDs": [
@@ -679,7 +704,7 @@ openim::test::invite_user_to_group() {
   "reason": "your reason"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/invite_user_to_group" -d "${request_body}")
@@ -689,14 +714,15 @@ EOF
 
 # Transfers the ownership of a group to another user.
 openim::test::transfer_group() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupID":"${1}",
   "oldOwnerUserID":"${2}",
   "newOwnerUserID": "${3}"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/transfer_group" -d "${request_body}")
@@ -706,12 +732,13 @@ EOF
 
 # Retrieves information about multiple groups.
 openim::test::get_groups_info() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupIDs": ["${1}", "${2}"]
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/get_groups_info" -d "${request_body}")
@@ -721,7 +748,8 @@ EOF
 
 # Removes a user from a group.
 openim::test::kick_group() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupID": "${1}",
   "kickedUserIDs": [
@@ -730,7 +758,7 @@ openim::test::kick_group() {
   "reason": "Bye!"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/kick_group" -d "${request_body}")
@@ -740,13 +768,14 @@ EOF
 
 # Retrieves information about group members.
 openim::test::get_group_members_info() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupID": "${1}",
   "userIDs": ["${2}"]
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/get_group_members_info" -d "${request_body}")
@@ -756,7 +785,8 @@ EOF
 
 # Retrieves a list of group members.
 openim::test::get_group_member_list() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupID": "${1}",
   "pagination": {
@@ -765,7 +795,7 @@ openim::test::get_group_member_list() {
   }
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/get_group_member_list" -d "${request_body}")
@@ -775,7 +805,8 @@ EOF
 
 # Retrieves a list of groups that a user has joined.
 openim::test::get_joined_group_list() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "fromUserID": "${1}",
   "pagination": {
@@ -784,7 +815,7 @@ openim::test::get_joined_group_list() {
   }
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/get_joined_group_list" -d "${request_body}")
@@ -792,10 +823,10 @@ EOF
 	openim::test::check_error "$response"
 }
 
-
 # Sets group member information.
 openim::test::set_group_member_info() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "members": [
     {
@@ -809,7 +840,7 @@ openim::test::set_group_member_info() {
   ]
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/set_group_member_info" -d "${request_body}")
@@ -819,12 +850,13 @@ EOF
 
 # Mutes a group.
 openim::test::mute_group() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupID": "${1}"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/mute_group" -d "${request_body}")
@@ -834,12 +866,13 @@ EOF
 
 # Cancels the muting of a group.
 openim::test::cancel_mute_group() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupID": "${1}"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/cancel_mute_group" -d "${request_body}")
@@ -849,12 +882,13 @@ EOF
 
 # Dismisses a group.
 openim::test::dismiss_group() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupID":"${1}"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/dismiss_group" -d "${request_body}")
@@ -864,13 +898,14 @@ EOF
 
 # Cancels muting a group member.
 openim::test::cancel_mute_group_member() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupID": "${1}",
   "userID": "${2}"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/cancel_mute_group_member" -d "${request_body}")
@@ -880,7 +915,8 @@ EOF
 
 # Allows a user to join a group.
 openim::test::join_group() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
  "groupID": "${1}",
  "reqMessage": "req msg join group",
@@ -888,7 +924,7 @@ openim::test::join_group() {
  "inviterUserID": "${2}"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/join_group" -d "${request_body}")
@@ -898,7 +934,8 @@ EOF
 
 # Sets group information.
 openim::test::set_group_info() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupInfoForSet": {
     "groupID": "${1}",
@@ -913,7 +950,7 @@ openim::test::set_group_info() {
   }
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/set_group_info" -d "${request_body}")
@@ -921,16 +958,16 @@ EOF
 	openim::test::check_error "$response"
 }
 
-
 # Allows a user to quit a group.
 openim::test::quit_group() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupID": "${1}",
   "userID": "${2}"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/quit_group" -d "${request_body}")
@@ -940,7 +977,8 @@ EOF
 
 # Retrieves the list of group applications received by the user.
 openim::test::get_recv_group_applicationList() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "fromUserID": "${1}",
   "pagination": {
@@ -949,7 +987,7 @@ openim::test::get_recv_group_applicationList() {
   }
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/get_recv_group_applicationList" -d "${request_body}")
@@ -959,7 +997,8 @@ EOF
 
 # Responds to a group application.
 openim::test::group_application_response() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupID": "${1}",
   "fromUserID": "${2}",
@@ -967,7 +1006,7 @@ openim::test::group_application_response() {
   "handleResult": 1
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/group_application_response" -d "${request_body}")
@@ -977,7 +1016,8 @@ EOF
 
 # Retrieves the list of group applications made by the user.
 openim::test::get_user_req_group_applicationList() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userID": "${1}",
   "pagination": {
@@ -986,7 +1026,7 @@ openim::test::get_user_req_group_applicationList() {
   }
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/get_user_req_group_applicationList" -d "${request_body}")
@@ -996,14 +1036,15 @@ EOF
 
 # Mutes a group member for a specified duration.
 openim::test::mute_group_member() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupID": "${1}",
   "userID": "${2}",
   "mutedSeconds": ${3}
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/mute_group_member" -d "${request_body}")
@@ -1013,7 +1054,8 @@ EOF
 
 # Retrieves a list of group applications from specific users.
 openim::test::get_group_users_req_application_list() {
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "groupID": "${1}",
   "userIDs": [
@@ -1021,7 +1063,7 @@ openim::test::get_group_users_req_application_list() {
   ]
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/group/get_group_users_req_application_list" -d "${request_body}")
@@ -1089,7 +1131,7 @@ function openim::test::group() {
 
 	# 13. Join group.
 	# TODO:
-#   openim::test::join_group "$GROUP_ID2" "$OTHER_USER2_ID"
+	#   openim::test::join_group "$GROUP_ID2" "$OTHER_USER2_ID"
 
 	# 14. Set group info.
 	openim::test::set_group_info "$GROUP_ID2"
@@ -1102,7 +1144,7 @@ function openim::test::group() {
 
 	# 17. Group application response.
 	# TODO:
-#   openim::test::group_application_response "$GROUP_ID2" "$OTHER_USER2_ID"
+	#   openim::test::group_application_response "$GROUP_ID2" "$OTHER_USER2_ID"
 
 	# 18. Get user requested group application list.
 	openim::test::get_user_req_group_applicationList "$USER_ID" 1 100
@@ -1121,11 +1163,13 @@ function openim::test::group() {
 
 # Define a function to register a user
 openim::register_user() {
-  user_register_response=$(${CCURL} "${Header}" ${INSECURE_OPENIMAPI}/user/user_register \
+	user_register_response=$(
+		${CCURL} "${Header}" ${INSECURE_OPENIMAPI}/user/user_register \
 		-d'{
-      "secret": "openIM123",
+"secret": "openIM123",
-      "users": [{"userID": "11111112","nickname": "yourNickname","faceURL": "yourFaceURL"}]
+"users": [{"userID": "11111112","nickname": "yourNickname","faceURL": "yourFaceURL"}]
-    }')
+}'
+	)
 
 	echo "$user_register_response"
 }
@@ -1133,10 +1177,12 @@ openim::register_user() {
 # Define a function to check the account
 openim::test::check_account() {
 	local token=$1
-  account_check_response=$(${CCURL} "${Header}" -H"operationID: 1646445464564" -H"token: ${token}" ${INSECURE_OPENIMAPI}/user/account_check \
+	account_check_response=$(
+		${CCURL} "${Header}" -H"operationID: 1646445464564" -H"token: ${token}" ${INSECURE_OPENIMAPI}/user/account_check \
 		-d'{
-          "checkUserIDs": ["11111111","11111112"]
+"checkUserIDs": ["11111111","11111112"]
-        }')
+}'
+	)
 
 	echo "$account_check_response"
 }
@@ -1179,7 +1225,8 @@ openim::test::send_msg() {
 	local recvID="${2}"
 	local groupID="${3}"
 
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "sendID": "${sendID}",
   "recvID": "${recvID}",
@@ -1204,7 +1251,7 @@ openim::test::send_msg() {
   }
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/msg/send_msg" -d "${request_body}")
@@ -1223,7 +1270,8 @@ openim::test::search_msg() {
 	local showNumber="${7}"
 
 	# Construct the request body
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "sendID": "${sendID}",
   "recvID": "${recvID}",
@@ -1236,7 +1284,7 @@ openim::test::search_msg() {
   }
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	# Send the request
@@ -1256,7 +1304,8 @@ openim::test::pull_msg_by_seq() {
 	local order="${6}" # Assuming 0 for ascending, 1 for descending
 
 	# Construct the request body
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userID": "${userID}",
   "seqRanges": [
@@ -1270,7 +1319,7 @@ openim::test::pull_msg_by_seq() {
   "order": ${order}
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	# Send the request
@@ -1286,14 +1335,15 @@ openim::test::revoke_msg() {
 	local conversationID="${2}"
 	local seq="${3}"
 
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userID": "${userID}",
   "conversationID": "${conversationID}",
   "seq": ${seq}
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/msg/revoke_msg" -d "${request_body}")
@@ -1301,17 +1351,17 @@ EOF
 	openim::test::check_error "$response"
 }
 
-
 # Clears all messages for a user.
 openim::test::user_clear_all_msg() {
 	local userID="${1}"
 
-  local request_body=$(cat <<EOF
+	local request_body=$(
+		cat <<EOF
 {
   "userID": "${userID}"
 }
 EOF
-)
+	)
 	echo "$request_body"
 
 	local response=$(${CCURL} "${Token}" "${OperationID}" "${Header}" "${INSECURE_OPENIMAPI}/msg/user_clear_all_msg" -d "${request_body}")
@@ -1322,8 +1372,7 @@ EOF
 # [openim::test::msg function description]
 # The `openim::test::msg` function serves as a test suite for message-related operations.
 # It sequentially invokes all message-related test functions to ensure the API's message operations are functioning correctly.
-function openim::test::msg()
+function openim::test::msg() {
-{
 	local SEND_USER_ID="${MANAGER_USERID_1}" # This should be the sender's userID
 	local GROUP_ID=""                        # GroupID if it's a group message
 	local USER_ID="$RANDOM"
@@ -1352,7 +1401,6 @@ function openim::test::msg()
 	local ORDER=0 # Assuming 0 for ascending order
 	openim::test::pull_msg_by_seq "${RECV_USER_ID}" "${CONVERSATION_ID}" "${BEGIN_SEQ}" "${END_SEQ}" "${NUM}" "${ORDER}"
 
-
 	# Assuming message sending was successful and returned a sequence number.
 	local SEQ_NUMBER=1 # This should be the actual sequence number of the message sent.
 
@@ -1375,7 +1423,6 @@ openim::test::man() {
 	openim::log::info "TODO: openim test man"
 }
 
-
 #################################### Build Module ####################################
 
 # Function: openim::test::smoke
@@ -1416,6 +1463,6 @@ openim::test::test() {
 # Main execution logic: This conditional block checks if the script's arguments match any known
 # test function patterns and, if so, evaluates the function call. This allows for specific test
 # functions to be triggered based on the passed arguments.
-if [[ "$*" =~ openim::test:: ]];then
+if [[ "$*" =~ openim::test:: ]]; then
 	eval $*
 fi

scripts/lib/util.sh

@@ -1086,7 +1086,7 @@ function openim::util::ensure-install-nginx {
     exit 1
   fi
 
-  for port in 80
+  for port in "80"
   do
     if echo |telnet 127.0.0.1 $port 2>&1|grep refused &>/dev/null;then
       exit 1
@@ -2320,7 +2320,7 @@ function openim::util::ensure-install-nginx {
     exit 1
   fi
 
-  for port in 80
+  for port in "80"
   do
     if echo |telnet 127.0.0.1 $port 2>&1|grep refused &>/dev/null;then
       exit 1
@@ -2467,7 +2467,7 @@ function openim::util::desc() {
 }
 
 function openim::util:run::prompt() {
-    echo -n "$yellow\$ $reset"
+    echo -n "${yellow}\$ ${reset}"
 }
 
 started=""
@@ -2488,7 +2488,7 @@ function openim::util::run() {
     if [ -n "$DEMO_RUN_FAST" ]; then
       rate=1000
     fi
-    echo "$green$1$reset" | pv -qL $rate
+    echo "${green}$1${reset}" | pv -qL "$rate"
     if [ -n "$DEMO_RUN_FAST" ]; then
       sleep 0.5
     fi

scripts/make-rules/common.mk

@@ -126,7 +126,7 @@ APIROOT=$(ROOT_DIR)/pkg/proto
 
 # Linux command settings
 # TODO: Whether you need to join utils?
-FIND := find . ! -path './utils/*' ! -path './vendor/*' ! -path './third_party/*'
+FIND := find . ! -path './utils/*' ! -path './vendor/*' ! -path './third_party/*' ! -path './components/*' ! -path './logs/*'
 XARGS := xargs -r --no-run-if-empty
 
 # Linux command settings-CODE DIRS Copyright

scripts/make-rules/golang.mk

@@ -244,7 +244,7 @@ go.imports: tools.verify.goimports
 
 ## go.verify: execute all verity scripts.
 .PHONY: go.verify
-go.verify:
+go.verify: tools.verify.misspell
 	@echo "Starting verification..."
 	@scripts_list=$$(find $(ROOT_DIR)/scripts -type f -name 'verify-*' | sort); \
 	for script in $$scripts_list; do \

scripts/make-rules/tools.mk

@@ -217,6 +217,11 @@ install.depth:
 install.go-callvis:
 	@$(GO) install github.com/ofabry/go-callvis@latest
 
+## install.misspell
+.PHONY: install.misspell
+install.misspell:
+	@$(GO) install github.com/client9/misspell/cmd/misspell@latest
+
 ## install.gothanks: Install gothanks, used to thank go dependencies
 .PHONY: install.gothanks
 install.gothanks:

scripts/verify-shellcheck.sh

@@ -43,6 +43,54 @@ disabled=(
   1091
   # this lint prefers command -v to which, they are not the same
   2230
+  # Error SC2155 indicates that you should separate variable declaration and assignment to avoid masking the return value of the command.
+  # In Bash scripts, when you declare and assign a local variable at the same time a command is executed, you only get the output of the command, but not the exit status (return value) of the command.  #
+  2155
+  # ShellCheck issues SC2086 warnings when you refer to a variable in a script but don't put it in double quotes.This can lead to unexpected behavior when scripts encounter Spaces, 
+  # newlines, and wildcards in file names or other data.
+  2086
+  2206
+
+  # TODO: 需要修复，然后开启
+  2034
+  2048
+  2148
+  2059
+  2214
+  2145
+  2128
+  2550
+  2046
+  2181
+  1102
+  2045
+  2068
+  2145
+  2207
+  2231
+  2013
+  2154
+  2120
+  1083
+  2001
+  2012
+  2016
+  2164
+  2223
+  2166
+  2119
+  2162
+  2295
+  2002
+  2004
+  2202
+  2178
+  2064
+  2260
+  2043
+  2178
+  2044
+  2153
 )
 # comma separate for passing to shellcheck
 join_by() {
@@ -65,14 +113,18 @@ cd "${OPENIM_ROOT}"
 #    forked should be linted and fixed.
 all_shell_scripts=()
 while IFS=$'\n' read -r script;
-  do git check-ignore -q "$script" || all_shell_scripts+=("$script");
+do git check-ignore -q "$script" || all_shell_scripts+=("$script");
-done < <(find . -name "*.sh" \
+  done < <(find . -name "*.sh" \
   -not \( \
   -path ./_\*      -o \
   -path ./.git\*   -o \
+  -path ./Godeps\* -o \
+  -path ./_output\* -o \
+  -path ./components\* -o \
+  -path ./logs\* -o \
   -path ./vendor\* -o \
   \( -path ./third_party\* -a -not -path ./third_party/forked\* \) \
-  \))
+\) -print 2>/dev/null)
 
 # detect if the host machine has the required shellcheck version installed
 # if so, we will use that instead.
@@ -113,7 +165,7 @@ if ${HAVE_SHELLCHECK}; then
 else
   openim::log::info "Using shellcheck ${SHELLCHECK_VERSION} docker image."
   "${DOCKER}" run \
-    --rm -v "${OPENIM_ROOT}:"${OPENIM_ROOT}"" -w "${OPENIM_ROOT}" \
+  --rm -v "${OPENIM_ROOT}:${OPENIM_ROOT}" -w "${OPENIM_ROOT}" \
   "${SHELLCHECK_IMAGE}" \
   shellcheck "${SHELLCHECK_OPTIONS[@]}" "${all_shell_scripts[@]}" >&2 || res=$?
 fi

scripts/verify-spelling.sh

@@ -25,17 +25,8 @@ OPENIM_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
 export OPENIM_ROOT
 source "${OPENIM_ROOT}/scripts/lib/init.sh"
 
-# Ensure that we find the binaries we build before anything else.
-export GOBIN="${KUBE_OUTPUT_BINPATH}"
-PATH="${GOBIN}:${PATH}"
-
-# Install tools we need
-pushd "${OPENIM_ROOT}/tools" >/dev/null
-  GO111MODULE=on go install github.com/client9/misspell/cmd/misspell
-popd >/dev/null
-
 # Spell checking
 # All the skipping files are defined in scripts/.spelling_failures
 skipping_file="${OPENIM_ROOT}/scripts/.spelling_failures"
 failing_packages=$(sed "s| | -e |g" "${skipping_file}")
-git ls-files | grep -v -e "${failing_packages}" | xargs misspell -i "Creater,creater,ect" -error -o stderr
+git ls-files | grep -v -e "${failing_packages}" | xargs "$OPENIM_ROOT/_output/tools/misspell" -i "Creater,creater,ect" -error -o stderr

scripts/verify-typecheck.sh

@@ -33,7 +33,7 @@ cd "${OPENIM_ROOT}"
 ret=0
 TYPECHECK_SERIAL="${TYPECHECK_SERIAL:-false}"
 scripts/run-in-gopath.sh \
-    go run test/typecheck/typecheck.go "$@" "--serial=$TYPECHECK_SERIAL" || ret=$?
+go run test/typecheck/typecheck.go "$@" "--serial=$TYPECHECK_SERIAL" || ret=$?
 if [[ $ret -ne 0 ]]; then
   openim::log::error "Type Check has failed. This may cause cross platform build failures." >&2
   openim::log::error "Please see https://github.com/openimsdk/open-im-server/tree/main/test/typecheck for more information." >&2

test/typecheck/README.md

@@ -1,27 +1,52 @@
-# OpenIM Typecheck
+# OpenIM Typecheck: Cross-Platform Source Code Type Checking for Go
 
-OpenIM Typecheck 为所有 Go 构建平台进行跨平台源代码类型检查。
+## Introduction
 
-## 优点
+OpenIM Typecheck is a robust tool designed for cross-platform source code type checking across all Go build platforms. This utility leverages Go’s built-in parsing and type-check libraries (`go/parser` and `go/types`) to deliver efficient and reliable code analysis.
 
-- **速度**：OpenIM 完整编译大约需要 3 分钟，而使用 Typecheck 只需数秒。
+## Advantages
-- **资源消耗**：与需要 >40GB 的 RAM 不同，Typecheck 只需 <8GB 的 RAM。
 
-## 实现
+- **Speed**: A complete compilation with OpenIM can take approximately 3 minutes. In contrast, OpenIM Typecheck achieves this in mere seconds, significantly enhancing productivity.
+- **Resource Efficiency**: Unlike the typical requirement of over 40GB of RAM for standard processes, Typecheck operates effectively with less than 8GB of RAM. This reduction in resource consumption makes it highly suitable for a variety of systems, reducing overheads and facilitating smoother operations.
 
-OpenIM Typecheck 使用 Go 内置的解析和类型检查库 (`go/parser` 和 `go/types`)。然而，这些库并不是 go 编译器所使用的。偶尔会出现不匹配的情况，但总的来说，它们是相当接近的。
+## Implementation
 
-## 错误处理
+OpenIM Typecheck employs Go's native parsing and type-checking libraries (`go/parser` and `go/types`). However, it's important to note that these libraries aren't identical to those used by the Go compiler. While occasional mismatches may occur, these libraries generally provide close approximations to the compiler's functionality, offering a reliable basis for type checking.
 
-如果错误不会阻止构建，可以忽略。
+## Error Handling
 
-**`go/types` 报告的错误，但 `go build` 不会**：
+Typecheck's approach to error handling is pragmatic, focusing on practicality and build continuity.
-- **真正的错误**（根据规范）：
-  - 应尽量修复。如果无法修复或正在进行中（例如，已被外部引用的代码），则可以忽略。
-    - 例如：闭包中的未使用变量
-- **不真实的错误**：
-  - 应忽略并在适当的情况下向上游报告。
-    - 例如：staging 和 generated 类型之间的类型检查不匹配
 
-**`go build` 报告的错误，但我们不会**：
+**Errors reported by `go/types` but not by `go build`**:
-- CGo 错误，包括语法和链接器错误。
+- **Actual Errors** (as per the specification):
+  - These should ideally be rectified. If rectification is not feasible, such as in cases of ongoing work or external dependencies in the code, these errors can be overlooked.
+    - Example: Unused variables within a closure.
+- **False Positives**:
+  - These errors should be ignored and, where appropriate, reported upstream for resolution.
+    - Example: Type mismatches between staging and generated types.
+
+**Errors reported by `go build` but not by us**:
+- CGo-related errors, including both syntax and linker issues, are outside our scope.
+
+## Usage
+
+### Locally
+
+To run Typecheck locally, simply use the following command:
+
+```bash
+make verify
+```
+
+### Continuous Integration (CI)
+
+In CI environments, Typecheck can be integrated into the workflow as follows:
+
+```yaml
+- name: Typecheck
+  run: make verify
+```
+
+This streamlined process facilitates efficient error detection and resolution, ensuring a robust and reliable build pipeline.
+
+More to learn about typecheck [share blog](https://nsddd.top/posts/concurrent-type-checking-and-cross-platform-development-in-go/)

test/typecheck/typecheck.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// do a fast type check of kubernetes code, for all platforms.
+// do a fast type check of openim code, for all platforms.
 package main
 
 import (
@@ -47,14 +47,12 @@ var (
 	crossPlatforms = []string{
 		"linux/amd64", "windows/386",
 		"darwin/amd64", "darwin/arm64",
-		"linux/386",
+		"linux/386", "linux/arm",
 		"windows/amd64", "linux/arm64",
 		"linux/ppc64le", "linux/s390x",
 		"windows/arm64",
 	}
 
-	// "linux/arm",
-
 	// directories we always ignore
 	standardIgnoreDirs = []string{
 		// Staging code is symlinked from vendor/k8s.io, and uses import
@@ -62,17 +60,14 @@ var (
 		// inside of staging/, but works when typechecked as part of vendor/.
 		"staging",
 		"components",
+		"logs",
 		// OS-specific vendor code tends to be imported by OS-specific
 		// packages. We recursively typecheck imported vendored packages for
 		// each OS, but don't typecheck everything for every OS.
 		"vendor",
+		"test",
 		"_output",
-		"OpenIMSKD/tools",
+		"*/mw/rpc_server_interceptor.go",
-		// This is a weird one. /testdata/ is *mostly* ignored by Go,
-		// and this translates to kubernetes/vendor not working.
-		// edit/record.go doesn't compile without gopkg.in/yaml.v2
-		// in $GOSRC/$GOROOT (both typecheck and the shell script).
-		"pkg/kubectl/cmd/testdata/edit",
 		// Tools we use for maintaining the code base but not necessarily
 		// ship as part of the release
 		"sopenim::golang::setup_env:tools/yamlfmt/yamlfmt.go:tools",

test/wrktest.sh

@@ -34,7 +34,7 @@ openim_root="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd -P)"
 wrkdir="${openim_root}/_output/wrk"
 jobname="openim-api"
 duration="300s"
-threads=$((3 * `grep -c processor /proc/cpuinfo`))
+threads=$((3 * $(grep -c processor /proc/cpuinfo)))
 
 source "${openim_root}/scripts/lib/color.sh"
 
@@ -122,7 +122,7 @@ if (s ~ "s") {
 
 # Remove existing data file
 function openim::wrk::prepare() {
-  rm -f ${wrkdir}/${datfile}
+  rm -f "${wrkdir}"/"${datfile}"
 }
 
 # Plot according to gunplot data file
@@ -216,7 +216,7 @@ openim::wrk::start_performance_test() {
   do
     wrkcmd="${cmd} -c ${c} $1"
     echo "Running wrk command: ${wrkcmd}"
-    result=`eval ${wrkcmd}`
+    result=$(eval "${wrkcmd}")
     openim::wrk::convert_plot_data "${result}"
   done
 
@@ -241,9 +241,10 @@ while getopts "hd:n:" opt;do
   esac
 done
 
-shift $(($OPTIND-1))
+shift $((OPTIND-1))
+
+mkdir -p "${wrkdir}"
 
-mkdir -p ${wrkdir}
 case $1 in
   "diff")
     if [ "$#" -lt 3 ];then
@@ -255,7 +256,7 @@ case $1 in
     t2=$(basename $3|sed 's/.dat//g') # 对比图中粉色线条名称
 
     join $2 $3 > /tmp/plot_diff.dat
-    openim::wrk::plot_diff `basename $2` `basename $3`
+    openim::wrk::plot_diff "$(basename "$2")" "$(basename "$3")"
     exit 0
     ;;
   *)

tools/data-conversion/README.md

@@ -31,7 +31,7 @@ var (
     usernameV3 = "root"
     passwordV3 = "openIM123"
     addrV3     = "127.0.0.1:13306"
-    databaseV3 = "openIM_v3"
+    databaseV3 = "openim_v3"
 )
 ```
 

tools/data-conversion/openim/cmd/conversion-mysql/conversion-mysql.go

@@ -38,7 +38,7 @@ func main() {
 		usernameV3 = "root"            // v3版本mysql用户名
 		passwordV3 = "openIM123"       // v3版本mysql密码
 		addrV3     = "127.0.0.1:13306" // v3版本mysql地址
-		databaseV3 = "openIM_v3"       // v3版本mysql数据库名字
+		databaseV3 = "openim_v3"       // v3版本mysql数据库名字
 	)
 
 	var concurrency = 1 // 并发数量

tools/data-conversion/openim/common/config.go

@@ -44,7 +44,7 @@ const (
 	UsernameV3 = "root"
 	PasswordV3 = "openIM123"
 	IpV3       = "43.134.63.160:13306"
-	DatabaseV3 = "openIM_v3"
+	DatabaseV3 = "openim_v3"
 )
 
 // V3 chat.

tools/data-conversion/openim/mysql/cmd.go

@@ -38,7 +38,7 @@ func Cmd() {
 		usernameV3 = "root"
 		passwordV3 = "openIM123"
 		addrV3     = "203.56.175.233:13306"
-		databaseV3 = "openIM_v3"
+		databaseV3 = "openim_v3"
 	)
 	log.SetFlags(log.LstdFlags | log.Llongfile)
 	dsnV2 := fmt.Sprintf("%s:%s@tcp(%s)/%s?charset=utf8mb4&parseTime=True&loc=Local", usernameV2, passwordV2, addrV2, databaseV2)

tools/formitychecker/checker/checker.go

@@ -1,3 +1,17 @@
+// Copyright © 2024 OpenIM. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package checker
 
 import (

tools/formitychecker/config/config.go

@@ -1,3 +1,17 @@
+// Copyright © 2024 OpenIM. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package config
 
 import (

tools/formitychecker/formitychecker.go

@@ -1,3 +1,17 @@
+// Copyright © 2024 OpenIM. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package main
 
 import (

tools/imctl/.gitignore

@@ -36,20 +36,6 @@ config/config.yaml
 .env
 ./.env
 
-### OpenIM deploy ###
-deploy/openim_demo
-deploy/openim-api
-deploy/openim-rpc-msg_gateway
-deploy/openim-msgtransfer
-deploy/openim-push
-deploy/openim_timer_task
-deploy/openim-rpc-user
-deploy/openim-rpc-friend
-deploy/openim-rpc-group
-deploy/openim-rpc-msg
-deploy/openim-rpc-auth
-deploy/Open-IM-SDK-Core
-
 # files used by the developer
 .idea.md
 .todo.md

tools/imctl/imctl.go

@@ -1,3 +1,17 @@
+// Copyright © 2024 OpenIM. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package main
 
 import "fmt"