Update check-all.sh (#1573)

* feat: add openim server code

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

* feat: add openim env

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

* feat: add openim mongo and redis env

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

* feat: add zk and redis mongo env

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

* feat: add kafka and redis mongo env

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

* feat: add openim docker

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

* feat: add openim docker

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

* feat: add openim docker

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

* feat: add openim copyright

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

* fix: docker compose

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

* fix: remove openim chat config file

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

* feat: add openim config set

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

* feat: add openim config set

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

* fix: fix Security vulnerability

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

* fix: fix Security vulnerability

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

* fix: docker compose

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

* Update kubernetes.go

* Update discoveryregister.go

* fix: copyright-add

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

---------

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

.github/workflows/openimci.yml

@@ -130,14 +130,14 @@ jobs:
         sudo make install
 
   execute-scripts:
-    name: Execute OpenIM script on ${{ matrix.os }}
+    name: Execute OpenIM Script On ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     environment:
       name: openim
     strategy:
       matrix:
         go_version: ["1.20"]
-        os: ["ubuntu-latest"]
+        os: ["ubuntu-latest", "macos-latest"]
     steps:
     - name: Checkout code
       uses: actions/checkout@v4
@@ -154,18 +154,52 @@ jobs:
         version: '3.x' # If available, use the latest major version that's compatible
         repo-token: ${{ secrets.GITHUB_TOKEN }}
 
-    - name: Docker Operations
+    # - name: Install latest Bash (macOS only)
+    #   if: runner.os == 'macOS'
+    #   run: |
+    #     /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+    #     brew update
+    
+    #     brew install bash
+    #     brew install gnu-sed
+    
+    #     echo "/usr/local/bin" >> $GITHUB_PATH
+    #     echo "$(brew --prefix)/opt/gnu-sed/libexec/gnubin" >> $GITHUB_PATH
+    #   continue-on-error: true
+
+    - name: Set up Docker for Ubuntu
+      if: runner.os == 'Linux'
       run: |
         sudo make init
         sudo docker compose up -d
         sudo sleep 20
 
-    - name: Module Operations
+    # - name: Set up Docker for macOS
+    #   if: runner.os == 'macOS'
+    #   run: |
+    #     brew install --cask docker
+    #     open /Applications/Docker.app
+
+    #     sleep 10
+    #     docker-compose --version || brew install docker-compose
+
+    #     docker-compose up -d
+    #     sleep 20
+
+    - name: Module Operations for Ubuntu
+      if: runner.os == 'Linux'
       run: |
         sudo make tidy
         sudo make tools.verify.go-gitlint
 
-    - name: Build, Start, Check Services and Print Logs
+    # - name: Module Operations for macOS
+    #   if: runner.os == 'macOS'
+    #   run: |
+    #     make tidy
+    #     make tools.verify.go-gitlint
+
+    - name: Build, Start, Check Services and Print Logs for Ubuntu
+      if: runner.os == 'Linux'
       run: |
         sudo make init && \
         sudo make build && \
@@ -173,6 +207,15 @@ jobs:
         sudo make check || \
         (echo "An error occurred, printing logs:" && sudo cat ./_output/logs/* 2>/dev/null)
 
+    # - name: Build, Start, Check Services and Print Logs for macOS
+    #   if: runner.os == 'macOS'
+    #   run: |
+    #     make init && \
+    #     make build && \
+    #     make start && \
+    #     make check || \
+    #     (echo "An error occurred, printing logs:" && sudo cat ./_output/logs/* 2>/dev/null)
+
   openim-test-build-image:
     name: Build OpenIM Docker Image
     runs-on: ubuntu-latest

Dockerfile

@@ -10,7 +10,7 @@ ENV GOPROXY=$GOPROXY
 # Set up the working directory
 WORKDIR /openim/openim-server
 
-COPY go.mod go.sum ./dd
+COPY go.mod go.sum ./
 RUN go mod download
 
 # Copy all files to the container

config/templates/env.template

@@ -210,8 +210,9 @@ API_OPENIM_PORT=10002
 # ======================================
 
 # Branch name for OpenIM chat.
-# Default: CHAT_BRANCH=main
+# Default: CHAT_IMAGE_VERSION=main
-CHAT_BRANCH=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
@@ -231,8 +232,8 @@ OPENIM_CHAT_DATA_DIR=./openim-chat/main
 # ======================================
 
 # Branch name for OpenIM server.
-# Default: SERVER_BRANCH=main
+# Default: SERVER_IMAGE_VERSION=main
-SERVER_BRANCH=main
+SERVER_IMAGE_VERSION=main
 
 # Port for the OpenIM admin API.
 # Default: OPENIM_ADMIN_API_PORT=10009

deployments/templates/env-template.yaml

@@ -210,8 +210,8 @@ API_OPENIM_PORT=${API_OPENIM_PORT}
 # ======================================
 
 # Branch name for OpenIM chat.
-# Default: CHAT_BRANCH=main
+# Default: CHAT_IMAGE_VERSION=main
-CHAT_BRANCH=${CHAT_BRANCH}
+CHAT_IMAGE_VERSION=${CHAT_IMAGE_VERSION}
 
 # Address or hostname for the OpenIM chat service.
 # Default: OPENIM_CHAT_ADDRESS=172.28.0.1
@@ -231,8 +231,8 @@ OPENIM_CHAT_DATA_DIR=${OPENIM_CHAT_DATA_DIR}
 # ======================================
 
 # Branch name for OpenIM server.
-# Default: SERVER_BRANCH=main
+# Default: SERVER_IMAGE_VERSION=main
-SERVER_BRANCH=${SERVER_BRANCH}
+SERVER_IMAGE_VERSION=${SERVER_IMAGE_VERSION}
 
 # Port for the OpenIM admin API.
 # Default: OPENIM_ADMIN_API_PORT=10009

docs/contrib/environment.md

@@ -104,18 +104,18 @@ Docker deployment offers a slightly more intricate template. Within the [openim-
 Configuration file modifications can be made by specifying corresponding environment variables, for instance:
 
 ```bash
-export CHAT_BRANCH="main"   
+export CHAT_IMAGE_VERSION="main"   
-export SERVER_BRANCH="main" 
+export SERVER_IMAGE_VERSION="main" 
 ```
 
 These variables are stored within the [`environment.sh`](https://github.com/OpenIMSDK/openim-docker/blob/main/scripts/install/environment.sh) configuration:
 
 ```bash
-readonly CHAT_BRANCH=${CHAT_BRANCH:-'main'}
+readonly CHAT_IMAGE_VERSION=${CHAT_IMAGE_VERSION:-'main'}
-readonly SERVER_BRANCH=${SERVER_BRANCH:-'main'}
+readonly SERVER_IMAGE_VERSION=${SERVER_IMAGE_VERSION:-'main'}
 ```
 
-Setting a variable, e.g., `export CHAT_BRANCH="release-v1.3"`, will prioritize `CHAT_BRANCH="release-v1.3"` as the variable value. Ultimately, the chosen image version is determined, and rendering is achieved through `make init` (or `./scripts/init-config.sh`).
+Setting a variable, e.g., `export CHAT_IMAGE_VERSION="release-v1.3"`, will prioritize `CHAT_IMAGE_VERSION="release-v1.3"` as the variable value. Ultimately, the chosen image version is determined, and rendering is achieved through `make init` (or `./scripts/init-config.sh`).
 
 > Note: Direct modifications to the `config.yaml` file are also permissible without utilizing `make init`.
 

internal/rpc/group/group.go

@@ -279,7 +279,6 @@ func (s *groupServer) CreateGroup(ctx context.Context, req *pbgroup.CreateGroupR
 			break
 		}
 	}
-	s.Notification.GroupCreatedNotification(ctx, tips)
 	if req.GroupInfo.GroupType == constant.SuperGroup {
 		go func() {
 			for _, userID := range userIDs {

pkg/common/discoveryregister/kubernetes/kubernetes.go

@@ -16,11 +16,17 @@ package kubernetes
 
 import (
 	"context"
+	"errors"
 	"fmt"
+	"os"
+	"strconv"
+	"strings"
 
 	"google.golang.org/grpc"
 
 	"github.com/OpenIMSDK/tools/discoveryregistry"
+	"github.com/OpenIMSDK/tools/log"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
 )
 
 // K8sDR represents the Kubernetes service discovery and registration client.
@@ -37,7 +43,11 @@ func NewK8sDiscoveryRegister() (discoveryregistry.SvcDiscoveryRegistry, error) {
 
 // Register registers a service with Kubernetes.
 func (cli *K8sDR) Register(serviceName, host string, port int, opts ...grpc.DialOption) error {
-	cli.rpcRegisterAddr = serviceName
+	if serviceName != config.Config.RpcRegisterName.OpenImMessageGatewayName {
+		cli.rpcRegisterAddr = serviceName
+	} else {
+		cli.rpcRegisterAddr = cli.getSelfHost(context.Background())
+	}
 
 	return nil
 }
@@ -65,10 +75,68 @@ func (cli *K8sDR) GetConfFromRegistry(key string) ([]byte, error) {
 	return nil, nil
 }
 
+func (cli *K8sDR) getSelfHost(ctx context.Context) string {
+	port := 88
+	instance := "openimserver"
+	selfPodName := os.Getenv("MY_POD_NAME")
+	ns := os.Getenv("MY_POD_NAMESPACE")
+	statefuleIndex := 0
+	gatewayEnds := strings.Split(config.Config.RpcRegisterName.OpenImMessageGatewayName, ":")
+	if len(gatewayEnds) != 2 {
+		log.ZError(ctx, "msggateway RpcRegisterName is error:config.Config.RpcRegisterName.OpenImMessageGatewayName", errors.New("config error"))
+	} else {
+		port, _ = strconv.Atoi(gatewayEnds[1])
+	}
+	podInfo := strings.Split(selfPodName, "-")
+	instance = podInfo[0]
+	count := len(podInfo)
+	statefuleIndex, _ = strconv.Atoi(podInfo[count-1])
+	host := fmt.Sprintf("%s-openim-msggateway-%d.%s-openim-msggateway-headless.%s.svc.cluster.local:%d", instance, statefuleIndex, instance, ns, port)
+	return host
+}
+
 // GetConns returns a list of gRPC client connections for a given service.
 func (cli *K8sDR) GetConns(ctx context.Context, serviceName string, opts ...grpc.DialOption) ([]*grpc.ClientConn, error) {
-	conn, err := grpc.DialContext(ctx, serviceName, append(cli.options, opts...)...)
+	if serviceName != config.Config.RpcRegisterName.OpenImMessageGatewayName {
-	return []*grpc.ClientConn{conn}, err
+		conn, err := grpc.DialContext(ctx, serviceName, append(cli.options, opts...)...)
+		return []*grpc.ClientConn{conn}, err
+	}
+	var ret []*grpc.ClientConn
+	gatewayHosts := cli.getMsgGatewayHost(ctx)
+	for _, host := range gatewayHosts {
+		conn, err := grpc.DialContext(ctx, host, append(cli.options, opts...)...)
+		if err != nil {
+			return nil, err
+		}
+		ret = append(ret, conn)
+	}
+	return ret, nil
+}
+
+// like openimserver-openim-msggateway-0.openimserver-openim-msggateway-headless.openim-lin.svc.cluster.local:88
+func (cli *K8sDR) getMsgGatewayHost(ctx context.Context) []string {
+	port := 88
+	instance := "openimserver"
+	selfPodName := os.Getenv("MY_POD_NAME")
+	replicas := os.Getenv("MY_MSGGATEWAY_REPLICACOUNT")
+	ns := os.Getenv("MY_POD_NAMESPACE")
+	gatewayEnds := strings.Split(config.Config.RpcRegisterName.OpenImMessageGatewayName, ":")
+	if len(gatewayEnds) != 2 {
+		log.ZError(ctx, "msggateway RpcRegisterName is error:config.Config.RpcRegisterName.OpenImMessageGatewayName", errors.New("config error"))
+	} else {
+		port, _ = strconv.Atoi(gatewayEnds[1])
+	}
+	nReplicas, _ := strconv.Atoi(replicas)
+	podInfo := strings.Split(selfPodName, "-")
+	instance = podInfo[0]
+	var ret []string
+	for i := 0; i < nReplicas; i++ {
+		host := fmt.Sprintf("%s-openim-msggateway-%d.%s-openim-msggateway-headless.%s.svc.cluster.local:%d", instance, i, instance, ns, port)
+		ret = append(ret, host)
+	}
+	log.ZInfo(ctx, "getMsgGatewayHost", "instance", instance, "selfPodName", selfPodName, "replicas", replicas, "ns", ns, "ret", ret)
+
+	return ret
 }
 
 // GetConn returns a single gRPC client connection for a given service.

scripts/check-all.sh

@@ -33,8 +33,8 @@ openim::log::info "\n# Begin to check all openim service"
 # OpenIM status
 # Elegant printing function
 print_services_and_ports() {
-    declare -g service_names=("${!1}")
+    local -n service_names=$1
-    declare -g service_ports=("${!2}")
+    local -n service_ports=$2
 
     echo "+-------------------------+----------+"
     echo "| Service Name            | Port     |"
@@ -47,7 +47,6 @@ print_services_and_ports() {
     echo "+-------------------------+----------+"
 }
 
-
 # Print out services and their ports
 print_services_and_ports OPENIM_SERVER_NAME_TARGETS OPENIM_SERVER_PORT_TARGETS
 

scripts/githooks/pre-push.sh

@@ -102,7 +102,7 @@ print_color "Deleted Files: ${deleted_files}" "${BACKGROUND_GREEN}"
 if [[ ! $local_branch =~ $valid_branch_regex ]]
 then
     printError "There is something wrong with your branch name. Branch names in this project must adhere to this contract: $valid_branch_regex. 
-Your commit will be rejected. You should rename your branch to a valid name(feat/name OR bug/name) and try again."
+Your commit will be rejected. You should rename your branch to a valid name(feat/name OR fix/name) and try again."
     printError "For more on this, read on: https://gist.github.com/cubxxw/126b72104ac0b0ca484c9db09c3e5694"
     exit 1
 fi

scripts/init-config.sh

@@ -13,7 +13,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-
 # This script automatically initializes various configuration files and can generate example files.
 
 set -o errexit
@@ -111,6 +110,7 @@ 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
@@ -146,10 +146,17 @@ process_file() {
       openim::log::error "genconfig.sh script not found"
       exit 1
     fi
-    "${OPENIM_ROOT}/scripts/genconfig.sh" "${ENV_FILE}" "${template}" > "${output_file}" || {
+    if [[ -n "${env_cmd}" ]]; then
-      openim::log::error "Error processing template file ${template}"
+        eval "$env_cmd ${OPENIM_ROOT}/scripts/genconfig.sh '${ENV_FILE}' '${template}' > '${output_file}'" || {
-      exit 1
+        openim::log::error "Error processing template file ${template}"
-    }
+        exit 1
+        }
+    else
+        "${OPENIM_ROOT}/scripts/genconfig.sh" "${ENV_FILE}" "${template}" > "${output_file}" || {
+        openim::log::error "Error processing template file ${template}"
+        exit 1
+        }
+    fi
   else
     openim::log::info "📋 Copying ${template} to ${output_file}..."
     cp "${template}" "${output_file}" || {
@@ -161,15 +168,10 @@ process_file() {
   sleep 0.5
 }
 
-declare -A env_vars=(
-    ["OPENIM_IP"]="172.28.0.1"
-    ["DATA_DIR"]="./"
-    ["LOG_STORAGE_LOCATION"]="../logs/"
-)
-
-# Function to clean configuration files
 clean_config_files() {
-  for output_file in "${TEMPLATES[@]}"; do
+  local all_templates=("${TEMPLATES[@]}" "${COPY_TEMPLATES[@]}")
+  
+  for output_file in "${all_templates[@]}"; do
     if [[ -f "${output_file}" ]]; then
       rm -f "${output_file}"
       openim::log::info "Removed configuration file: ${output_file}"
@@ -179,7 +181,10 @@ clean_config_files() {
 
 # Function to clean example files
 clean_example_files() {
-  for example_file in "${EXAMPLES[@]}"; do
+  # 合并 EXAMPLES 和 COPY_EXAMPLES 数组
+  local all_examples=("${EXAMPLES[@]}" "${COPY_EXAMPLES[@]}")
+  
+  for example_file in "${all_examples[@]}"; do
     if [[ -f "${example_file}" ]]; then
       rm -f "${example_file}"
       openim::log::info "Removed example file: ${example_file}"

scripts/install/environment.sh

@@ -66,8 +66,8 @@ def "ENV_FILE" ""${OPENIM_ROOT}"/scripts/install/environment.sh"
 
 ###################### Docker compose ###################
 # OPENIM AND CHAT
-def "CHAT_BRANCH" "main"
+def "CHAT_IMAGE_VERSION" "main"
-def "SERVER_BRANCH" "main"
+def "SERVER_IMAGE_VERSION" "main"
 
 # Choose the appropriate image address, the default is GITHUB image,
 # you can choose docker hub, for Chinese users can choose Ali Cloud
@@ -139,7 +139,7 @@ readonly API_OPENIM_PORT=${API_OPENIM_PORT:-'10002'}
 def "API_LISTEN_IP" "0.0.0.0" # API的监听IP
 
 ###################### openim-chat 配置信息 ######################
-def "OPENIM_CHAT_DATA_DIR" "./openim-chat/${CHAT_BRANCH}"
+def "OPENIM_CHAT_DATA_DIR" "./openim-chat/${CHAT_IMAGE_VERSION}"
 def "OPENIM_CHAT_ADDRESS" "${DOCKER_BRIDGE_GATEWAY}" # OpenIM服务地址
 def "OPENIM_CHAT_API_PORT" "10008"                   # OpenIM API端口
 def "CHAT_API_LISTEN_IP" ""                          # OpenIM API的监听IP

scripts/lib/logging.sh

@@ -20,7 +20,7 @@ OPENIM_VERBOSE="${OPENIM_VERBOSE:-5}"
 ENABLE_LOGGING="${ENABLE_LOGGING:-true}"
 
 # If OPENIM_OUTPUT is not set, set it to the default value
-if [[ ! -v OPENIM_OUTPUT ]]; then
+if [ -z "${OPENIM_OUTPUT+x}" ]; then
     OPENIM_OUTPUT="$(cd "$(dirname "${BASH_SOURCE[0]}")/../../_output" && pwd -P)"
 fi
 

scripts/lib/util.sh

@@ -302,7 +302,11 @@ openim::util::check_ports() {
     # Iterate over each given port.
     for port in "$@"; do
         # Use the `ss` command to find process information related to the given port.
-        local info=$(ss -ltnp | grep ":$port" || true)
+        if command -v ss > /dev/null 2>&1; then
+            info=$(ss -ltnp | grep ":$port" || true)
+        else
+            info=$(netstat -ltnp | grep ":$port" || true)
+        fi
 
         # If there's no process information, it means the process associated with the port is not running.
         if [[ -z $info ]]; then
@@ -364,6 +368,18 @@ openim::util::check_ports() {
 # openim::util::check_process_names nginx mysql redis
 # The function returns a status of 1 if any of the processes is not running.
 openim::util::check_process_names() {
+    # Function to get the port of a process
+    get_port() {
+        local pid=$1
+        if command -v ss > /dev/null 2>&1; then
+            # used ss comment
+            ss -ltnp 2>/dev/null | grep $pid | awk '{print $4}' | cut -d ':' -f2
+        else
+            # used netstat comment replace ss
+            netstat -ltnp 2>/dev/null | grep $pid | awk '{print $4}' | sed 's/.*://'
+        fi
+    }
+
     # Arrays to collect details of processes
     local not_started=()
     local started=()
@@ -382,7 +398,7 @@ openim::util::check_process_names() {
             for pid in "${pids[@]}"; do
                 local command=$(ps -p $pid -o cmd=)
                 local start_time=$(ps -p $pid -o lstart=)
-                local port=$(ss -ltnp 2>/dev/null | grep $pid | awk '{print $4}' | cut -d ':' -f2)
+                local port=$(get_port $pid)
 
                 # Check if port information was found for the PID
                 if [[ -z $port ]]; then
@@ -419,6 +435,7 @@ openim::util::check_process_names() {
         return 0
     fi
 }
+
 # openim::util::check_process_names docker-pr
 
 # The `openim::util::stop_services_on_ports` function stops services running on specified ports.