AppFlowy/frontend/scripts/flutter_release_build/build_macos.sh

# This Script is used to build the AppFlowy macOS zip, dmg or pkg
#
# Usage: ./scripts/flutter_release_build/build_macos.sh --build_type <type> --build_arch <arch> --version <version> --apple-id <apple-id> --team-id <team-id> --password <password> [--skip-code-generation] [--skip-rebuild-core]
#
# Options:
#   -h, --help    Show this help message and exit
#   --build_type  The type of package to build. Must be one of:
#                 - all: Build all package types
#                 - zip: Build only zip package
#                 - dmg: Build only dmg package
#                 - tar.xz: Build only tar.xz package
#   --build_arch  The architecture to build. Must be one of:
#                 - x86_64: Build for x86_64 architecture
#                 - arm64: Build for arm64 architecture
#                 - universal: Build for universal architecture
#   --version     The version number (e.g. 0.8.2)
#   --skip-code-generation  Skip the code generation step
#   --skip-rebuild-core  Skip the core rebuild step
#   --apple-id      The apple id to use for the notary service
#   --team-id       The team id to use for the notary service
#   --password      The password to use for the notary service

show_help() {
    echo "Usage: ./scripts/flutter_release_build/build_macos.sh --build_type <type> --build_arch <arch> --version <version> --apple-id <apple-id> --team-id <team-id> --password <password> [--skip-code-generation] [--skip-rebuild-core]"
    echo ""
    echo "Options:"
    echo "  -h, --help    Show this help message and exit"
    echo ""
    echo "Arguments:"
    echo "  --build_type    The type of package to build. Must be one of:"
    echo "                - all: Build all package types"
    echo "                - zip: Build only zip package"
    echo "                  Please install the \033[33mp7zip\033[0m before building the zip package."
    echo "                  For more information, please refer to the https://distributor.leanflutter.dev/makers/zip/."
    echo "                - tar.xz: Build only tar.xz package"
    echo "                - dmg: Build only dmg package"
    echo "                  Please install the \033[33mappdmg\033[0m before building the dmg package."
    echo "                  For more information, please refer to the https://distributor.leanflutter.dev/makers/dmg/."
    echo "  --build_arch    The architecture to build. Must be one of:"
    echo "                - x86_64: Build for x86_64 architecture"
    echo "                - arm64: Build for arm64 architecture"
    echo "                - universal: Build for universal architecture"
    echo "  --version       The version number (e.g. 0.8.2)"
    echo "  --skip-code-generation   Skip the code generation step. It may save time if you have already generated the code."
    echo "  --skip-rebuild-core      Skip the core rebuild step. It may save time if you have already built the core."
    echo "  --apple-id      The apple id to use for the notary service"
    echo "  --team-id       The team id to use for the notary service"
    echo "  --password      The password to use for the notary service"
    exit 0
}

# Check for help flag
if [ "$1" = "-h" ] || [ "$1" = "--help" ]; then
    show_help
fi

# Parse named arguments
while [ $# -gt 0 ]; do
    case "$1" in
    --build_type)
        BUILD_TYPE="$2"
        shift 2
        ;;
    --build_arch)
        BUILD_ARCH="$2"
        shift 2
        ;;
    --version)
        VERSION="$2"
        shift 2
        ;;
    --skip-code-generation)
        SKIP_CODE_GENERATION=true
        shift
        ;;
    --skip-rebuild-core)
        SKIP_REBUILD_CORE=true
        shift
        ;;
    --apple-id)
        APPLE_ID="$2"
        shift 2
        ;;
    --team-id)
        TEAM_ID="$2"
        shift 2
        ;;
    --password)
        PASSWORD="$2"
        shift 2
        ;;
    *)
        echo "Unknown parameter: $1"
        show_help
        exit 1
        ;;
    esac
done

clear_cache() {
    echo "Clearing the cache..."
    rm -rf appflowy_flutter/build/$VERSION/
}

info() {
    echo "🚀 \033[32m$1\033[0m"
}

error() {
    echo "🚨 \033[31m$1\033[0m"
}

# Validate build type argument
if [ -z "$BUILD_TYPE" ]; then
    error "Please specify build type with --build_type: all, zip, dmg, tar.xz"
    exit 1
fi

# Validate version argument
if [ -z "$VERSION" ]; then
    error "Please specify version number with --version (e.g. 0.8.2)"
    exit 1
fi

# Validate build arch argument
if [ -z "$BUILD_ARCH" ]; then
    error "Please specify build arch with --build_arch: x86_64, arm64 or universal"
    exit 1
fi

if [ "$BUILD_TYPE" != "all" ] && [ "$BUILD_TYPE" != "zip" ] && [ "$BUILD_TYPE" != "dmg" ] && [ "$BUILD_TYPE" != "tar.xz" ]; then
    error "Invalid build type. Must be one of: all, zip, dmg, tar.xz"
    exit 1
fi

prepare_build() {
    info "Preparing build..."

    # step 1: build the appflowy-core (rust-lib) based on the build arch
    if [ "$SKIP_REBUILD_CORE" != "true" ]; then
        if [ "$BUILD_ARCH" = "x86_64" ] || [ "$BUILD_ARCH" = "universal" ]; then
            info "Building appflowy-core for x86_64...(This may take a while)"
            cargo make --profile production-mac-x86_64 appflowy-core-release
        fi

        if [ "$BUILD_ARCH" = "arm64" ] || [ "$BUILD_ARCH" = "universal" ]; then
            info "Building appflowy-core for arm64...(This may take a while)"
            cargo make --profile production-mac-arm64 appflowy-core-release
        fi

        # step 2 (optional): combine these two libdart_ffi.a into one libdart_ffi.a if the build arch is universal
        if [ "$BUILD_ARCH" = "universal" ]; then
            info "Combining libdart_ffi.a for universal..."
            lipo -create \
                rust-lib/target/x86_64-apple-darwin/release/libdart_ffi.a \
                rust-lib/target/aarch64-apple-darwin/release/libdart_ffi.a \
                -output rust-lib/target/libdart_ffi.a

            info "Checking the libdart_ffi.a for universal..."
            lipo -archs rust-lib/target/libdart_ffi.a

            cp -rf rust-lib/target/libdart_ffi.a \
                appflowy_flutter/packages/appflowy_backend/macos/
        fi
    fi

    # step 3 (optional): generate the flutter code: languages, icons and freezed files.
    if [ "$SKIP_CODE_GENERATION" != "true" ]; then
        info "Generating the flutter code...(This may take a while)"
        cargo make code_generation
    fi

    # step 4: build the zip package
    info "Building the zip package..."
    cd appflowy_flutter
    flutter_distributor release --name=prod --jobs=release-prod-macos-zip --skip-clean
    cd ..
}

build_zip() {
    info "Building zip package version $VERSION..."

    # step 1: check if the macos zip package is built, if not, build the zip package
    if [ ! -f "appflowy_flutter/build/$VERSION/AppFlowy-$VERSION-macos-$BUILD_ARCH.zip" ]; then
        info "macOS zip package is not built. Building the zip package..."
        prepare_build

        # step 1.1: move the zip package to the build directory
        mv appflowy_flutter/build/$VERSION/appflowy-$VERSION+$VERSION-macos.zip appflowy_flutter/build/$VERSION/AppFlowy-$VERSION-macos-$BUILD_ARCH.zip
    fi

    # step 2: unzip the zip package and codesign the app
    unzip -o appflowy_flutter/build/$VERSION/AppFlowy-$VERSION-macos-$BUILD_ARCH.zip

    # step 3: codesign the app
    # note: You must install the certificate to the system before codesigning
    sudo /usr/bin/codesign --force --options runtime --deep --sign "Developer ID Application: APPFLOWY PTE. LTD" --deep --verbose AppFlowy.app -v

    # step 4: zip the app again
    7z a appflowy_flutter/build/$VERSION/AppFlowy-$VERSION-macos-$BUILD_ARCH.zip AppFlowy.app

    info "Zip package built successfully"
}

build_dmg() {
    info "Building DMG package version $VERSION..."

    # step 1: check if the macos zip package is built, if not, build the zip package
    if [ ! -f "appflowy_flutter/build/$VERSION/AppFlowy-$VERSION-macos-$BUILD_ARCH.zip" ]; then
        info "macOS zip package is not built. Building the zip package..."
        build_zip
    fi

    # step 2: unzip the zip package and copy the make_config.json file to the build directory
    unzip appflowy_flutter/build/$VERSION/AppFlowy-$VERSION-macos-$BUILD_ARCH.zip -d appflowy_flutter/build/$VERSION/
    cp appflowy_flutter/macos/packaging/dmg/make_config.json appflowy_flutter/build/$VERSION/

    # check if the AppFlowy.app doesn't exist, exit the script
    if [ ! -d "appflowy_flutter/build/$VERSION/AppFlowy.app" ]; then
        error "AppFlowy.app doesn't exist. Please check the zip package."
        exit 1
    fi

    # check if the appdmg has been installed
    if ! command -v appdmg &>/dev/null; then
        info "appdmg is not installed. Installing appdmg..."
        npm install -g appdmg
    fi

    # step 3: build the dmg package using appdmg
    # note: You must install the appdmg to the system before building the dmg package
    appdmg appflowy_flutter/build/$VERSION/make_config.json appflowy_flutter/build/$VERSION/AppFlowy-$VERSION-macos-$BUILD_ARCH.dmg

    # step 4: clear the temp files
    rm -rf appflowy_flutter/build/$VERSION/AppFlowy.app
    rm -rf appflowy_flutter/build/$VERSION/make_config.json

    # check if the dmg package is built
    if [ ! -f "appflowy_flutter/build/$VERSION/AppFlowy-$VERSION-macos-$BUILD_ARCH.dmg" ]; then
        error "DMG package is not built. Please check the build process."
        exit 1
    fi

    info "DMG package built successfully. The dmg package is located at appflowy_flutter/build/$VERSION/AppFlowy-$VERSION-macos-$BUILD_ARCH.dmg"

    if [ -z "$APPLE_ID" ] || [ -z "$TEAM_ID" ] || [ -z "$PASSWORD" ]; then
        error "The apple id, team id and password are not specified. Please notarize the dmg package manually."
        error "xcrun notarytool submit appflowy_flutter/build/$VERSION/AppFlowy-$VERSION-macos-$BUILD_ARCH.dmg --apple-id <your-apple-id> --team-id <your-team-id> --password <your-password> -v -f \"json\" --wait"
    else
        xcrun notarytool submit appflowy_flutter/build/$VERSION/AppFlowy-$VERSION-macos-$BUILD_ARCH.dmg --apple-id $APPLE_ID --team-id $TEAM_ID --password $PASSWORD -v -f "json" --wait
        info "Notarization is completed. Please check the notarization status"
    fi
}

build_tar_xz() {
    info "Building tar.xz package version $VERSION..."

    # step 1: check if the macos zip package is built, if not, build the zip package
    if [ ! -f "appflowy_flutter/build/$VERSION/AppFlowy-$VERSION-macos-$BUILD_ARCH.zip" ]; then
        info "macOS zip package is not built. Building the zip package..."
        build_zip
    fi

    # step 2: unzip the zip package and copy the make_config.json file to the build directory
    unzip appflowy_flutter/build/$VERSION/AppFlowy-$VERSION-macos-$BUILD_ARCH.zip -d appflowy_flutter/build/$VERSION/

    # check if the AppFlowy.app doesn't exist, exit the script
    if [ ! -d "appflowy_flutter/build/$VERSION/AppFlowy.app" ]; then
        error "AppFlowy.app doesn't exist. Please check the zip package."
        exit 1
    fi

    # step 3: build the tar.xz package
    tar -cJvf appflowy_flutter/build/$VERSION/AppFlowy-$VERSION-macos-$BUILD_ARCH.tar.xz appflowy_flutter/build/$VERSION/AppFlowy.app

    info "Tar.xz package built successfully. The tar.xz package is located at appflowy_flutter/build/$VERSION/AppFlowy-$VERSION-macos-$BUILD_ARCH.tar.xz"
}

clear_cache

# Build packages based on build type
case $BUILD_TYPE in
"all")
    build_zip
    build_dmg
    build_tar_xz
    ;;
"zip")
    build_zip
    ;;
"dmg")
    build_dmg
    ;;
"tar.xz")
    build_tar_xz
    ;;
esac