Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Country names in complex (and RTL scripts) improperly rendered on map #12284

Closed
1 of 3 tasks
paluszak opened this issue Sep 3, 2024 · 7 comments · Fixed by #12308
Closed
1 of 3 tasks

Country names in complex (and RTL scripts) improperly rendered on map #12284

paluszak opened this issue Sep 3, 2024 · 7 comments · Fixed by #12308

Comments

@paluszak
Copy link

paluszak commented Sep 3, 2024

The bug

In the map view the country names in complex and RTL scripts are rendered improperly on the web. It seems that the script just renders unicode codepoints without passing it through some kind of text rendering engine like harfbuzz which is crucial to display text correctly. The problem is not present in Android app, only in the web view regardless of the web browser (Firefox or Chromium) used to access immich.

The OS that Immich Server is running on

Gentoo

Version of Immich Server

v1.113.1

Version of Immich Mobile App

n/a

Platform with the issue

  • Server
  • Web
  • Mobile

Your docker-compose.yml content

#
# WARNING: Make sure to use the docker-compose.yml of the current release:
#
# https://github.com/immich-app/immich/releases/latest/download/docker-compose.yml
#
# The compose file on main may not be compatible with the latest release.
#

name: immich

services:
  immich-server:
    container_name: immich_server
    image: ghcr.io/immich-app/immich-server:${IMMICH_VERSION:-release}
    # extends:
    #   file: hwaccel.transcoding.yml
    #   service: cpu # set to one of [nvenc, quicksync, rkmpp, vaapi, vaapi-wsl] for accelerated transcoding
    volumes:
      # Do not edit the next line. If you want to change the media storage location on your system, edit the value of UPLOAD_LOCATION in the .env file
      - ${UPLOAD_LOCATION}:/usr/src/app/upload
      - /etc/localtime:/etc/localtime:ro
    env_file:
      - .env
    ports:
      - 2283:3001
    depends_on:
      - redis
      - database
    restart: always
    healthcheck:
      disable: false

  immich-machine-learning:
    container_name: immich_machine_learning
    # For hardware acceleration, add one of -[armnn, cuda, openvino] to the image tag.
    # Example tag: ${IMMICH_VERSION:-release}-cuda
    image: ghcr.io/immich-app/immich-machine-learning:${IMMICH_VERSION:-release}
    # extends: # uncomment this section for hardware acceleration - see https://immich.app/docs/features/ml-hardware-acceleration
    #   file: hwaccel.ml.yml
    #   service: cpu # set to one of [armnn, cuda, openvino, openvino-wsl] for accelerated inference - use the `-wsl` version for WSL2 where applicable
    volumes:
      - model-cache:/cache
    env_file:
      - .env
    restart: always
    healthcheck:
      disable: false

  redis:
    container_name: immich_redis
    image: docker.io/redis:6.2-alpine@sha256:e3b17ba9479deec4b7d1eeec1548a253acc5374d68d3b27937fcfe4df8d18c7e
    healthcheck:
      test: redis-cli ping || exit 1
    restart: always

  database:
    container_name: immich_postgres
    image: docker.io/tensorchord/pgvecto-rs:pg14-v0.2.0@sha256:90724186f0a3517cf6914295b5ab410db9ce23190a2d9d0b9dd6463e3fa298f0
    environment:
      POSTGRES_PASSWORD: ${DB_PASSWORD}
      POSTGRES_USER: ${DB_USERNAME}
      POSTGRES_DB: ${DB_DATABASE_NAME}
      POSTGRES_INITDB_ARGS: '--data-checksums'
    volumes:
      # Do not edit the next line. If you want to change the database storage location on your system, edit the value of DB_DATA_LOCATION in the .env file
      - ${DB_DATA_LOCATION}:/var/lib/postgresql/data
    healthcheck:
      test: pg_isready --dbname='${DB_DATABASE_NAME}' --username='${DB_USERNAME}' || exit 1; Chksum="$$(psql --dbname='${DB_DATABASE_NAME}' --username='${DB_USERNAME}' --tuples-only --no-align --command='SELECT COALESCE(SUM(checksum_failures), 0) FROM pg_stat_database')"; echo "checksum failure count is $$Chksum"; [ "$$Chksum" = '0' ] || exit 1
      interval: 5m
      start_interval: 30s
      start_period: 5m
    command: ["postgres", "-c", "shared_preload_libraries=vectors.so", "-c", 'search_path="$$user", public, vectors', "-c", "logging_collector=on", "-c", "max_wal_size=2GB", "-c", "shared_buffers=512MB", "-c", "wal_compression=on"]
    restart: always

volumes:
  model-cache:

Your .env content

# You can find documentation for all the supported env variables at https://immich.app/docs/install/environment-variables

# The location where your uploaded files are stored
UPLOAD_LOCATION=./library
# The location where your database files are stored
DB_DATA_LOCATION=./postgres

# To set a timezone, uncomment the next line and change Etc/UTC to a TZ identifier from this list: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List
# TZ=Etc/UTC

# The Immich version to use. You can pin this to a specific version like "v1.71.0"
IMMICH_VERSION=release

# Connection secret for postgres. You should change it to a random password
DB_PASSWORD=[edited]

# The values below this line do not need to be changed
###################################################################################
DB_USERNAME=postgres
DB_DATABASE_NAME=immich

Reproduction steps

  1. Go to https://[immich server address]/map in your browser

...

Relevant log output

No response

Additional information

No response

@bo0tzz
Copy link
Member

bo0tzz commented Sep 4, 2024

@zackpollard will this be fixed by protomaps' localization thing, or is it another issue?

@zackpollard
Copy link
Contributor

Looks like there is a plugin for maplibre that enables RTL text processing. Looking at adding that in now.

@zackpollard
Copy link
Contributor

zackpollard commented Sep 4, 2024

@paluszak Would you be able to login to this instance https://map-rtl.dev.immich.cloud with email: [email protected] and password: demo and confirm that the text is displayed correctly on the main map view?

@paluszak
Copy link
Author

paluszak commented Sep 4, 2024

@zackpollard Looks fine, at least for the scripts I know (Arabic and Hebrew). Please mind, however, that some other scripts (mainly Indic origin scripts and Vietnamese) also require complex text processing to be rendered properly. I don't know Hindi or Bengali, but my limited knowledge of Burmese tells me that the name of the country may not be rendered properly.

@zackpollard
Copy link
Contributor

Hey, appreciate you taking a look. It's possible the font itself isn't fully compatible with some languages, however for now this seems like an improvement for RTL languages so we'll push forward with getting this merged in. As for other languages we'll probably need to wait for someone with more knowledge of those languages to either look into it if there are problems or help us fix them.

@zackpollard
Copy link
Contributor

For some more context, it appears that maplibre, or more specifically, GL JS and GL more widely don't support a lot of the features of the more complex languages. Take a look here for more info mapbox/mapbox-gl-js#4009

@paluszak
Copy link
Author

paluszak commented Sep 4, 2024

Yes, that seems to be the problem. As a person who occasionally has to dabble with typographical issues I'd like to add that complex text shaping is a must for a lot of scripts, even some Latin-based like Vietnamese, where diacritical marks sometimes need to stacked properly over the letters. Indic scripts (which include most of the scripts used in India, Sinhalese, Burmese, Lao, Thai, Khmer, Tibetan/Dzongkha etc.) generally require some kind of complex text shaping engine (usually harfbuzz) to be rendered in a legible way. Modern browsers tend to do it pretty well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants