Merge branch 'development' into docs/gh-pages

Author: civilx64

Makefile

@@ -49,6 +49,18 @@ start-swarm-local:
 stop-swarm:
 	docker stack rm validate
 
+redeploy-swarm:
+	$(MAKE) stop-swarm
+	@echo "Waiting 15s for overlay network cleanup..."
+	sleep 15
+	$(MAKE) swarm-push ENV_FILE=$(ENV_FILE)
+	$(MAKE) start-swarm-nodb ENV_FILE=$(ENV_FILE)
+
+redeploy-frontend: rebuild-frontend
+	docker tag buildingsmart/validationsvc-frontend $(REGISTRY)/validationsvc-frontend
+	docker push $(REGISTRY)/validationsvc-frontend
+	docker service update --force --image $(REGISTRY)/validationsvc-frontend validate_frontend
+
 scale-workers:
 	docker service scale validate_worker=$(WORKERS)
 
@@ -121,7 +133,7 @@ rebuild: clean
 rebuild-frontend:
 	docker stop frontend || true
 	docker rmi --force $$(docker images -q 'buildingsmart/validationsvc-frontend:latest' | uniq) || true
-	docker compose build \
+	docker compose build frontend \
 	--build-arg GIT_COMMIT_HASH="$$(git rev-parse --short HEAD)" \
 	--build-arg VERSION="$$(cat .VERSION)"
 

backend/Makefile

@@ -30,7 +30,7 @@ install-macos: venv
 install-macos-m1: venv
 	find . -name 'requirements.txt' -exec $(PIP) install -r {} \;
 	$(PIP) install -r requirements.txt
-	wget -O /tmp/ifcopenshell_python.zip "https://s3.amazonaws.com/ifcopenshell-builds/ifcopenshell-python-311-v0.8.5-1c5b825-macosm164.zip"
+	wget -O /tmp/ifcopenshell_python.zip "https://s3.amazonaws.com/ifcopenshell-builds/ifcopenshell-python-311-v0.8.5-7bdc1b6-macosm164.zip"
 	mkdir -p $(VIRTUAL_ENV)/lib/python3.11/site-packages
 	unzip /tmp/ifcopenshell_python.zip -d $(VIRTUAL_ENV)/lib/python3.11/site-packages
 	rm /tmp/ifcopenshell_python.zip

backend/apps/ifc_validation/admin.py

@@ -1,5 +1,4 @@
 import logging
-from datetime import timedelta
 
 from django.urls import path
 from django.contrib import admin
@@ -91,7 +90,12 @@ class ValidationRequestAdmin(BaseAdmin, NonAdminAddable):
     actions_on_top = True
 
     def get_queryset(self, request):
-        queryset = super().get_queryset(request)
+        queryset = super().get_queryset(request).select_related(
+            'model__produced_by', 
+            'model__produced_by__company',
+            'created_by__useradditionalinfo', 
+            'updated_by__useradditionalinfo'
+        )
         queryset = queryset.annotate(
             _duration=Case(
                 When(completed__isnull=True, then=Now() - F('started')),
@@ -376,11 +380,13 @@ class ValidationTaskAdmin(BaseAdmin, NonAdminAddable):
 
     list_display = ["id", "public_id", "request", "type", "status", "progress", "started", "ended", "duration_text", "created", "updated"]
     readonly_fields = ["id", "public_id", "request", "type", "process_id", "process_cmd", "started", "ended", "created", "updated"]
-    date_hierarchy = "created"
 
     list_filter = ["status", "type", "status", "started", "ended", ('created', AdvancedDateFilter)]
     search_fields = ('request__file_name', 'status', 'type')
 
+    paginator = utils.LargeTablePaginator
+    show_full_result_count = False # do not use COUNT(*) twice
+
     def get_queryset(self, request):
         queryset = super().get_queryset(request)
         queryset = queryset.annotate(
@@ -442,14 +448,20 @@ class ValidationOutcomeAdmin(BaseAdmin, NonAdminAddable):
 
     list_display = ["id", "public_id", "model_text", "instance_id", "type_text", "feature", "feature_version", "outcome_code", "severity", "is_whitelisted", "expected", "observed", "created", "updated"]
     readonly_fields = ["id", "public_id", "created", "updated"]
-    date_hierarchy = "created"
-
-    list_filter = ['validation_task__type', 'severity_in_db', 'validation_task__request__model', 'outcome_code', 'feature', ('created', AdvancedDateFilter)]
+    
+    list_filter = ['validation_task__type', 'severity_in_db', 'outcome_code', ('created', AdvancedDateFilter)]
     search_fields = ('validation_task__request__file_name', 'feature', 'feature_version', 'outcome_code', 'severity_in_db', 'expected', 'observed')
 
     paginator = utils.LargeTablePaginator
     show_full_result_count = False # do not use COUNT(*) twice
 
+    # optimize for list display and filters
+    def get_queryset(self, request):
+        return super().get_queryset(request).select_related(
+            'validation_task__request__model',
+            'validation_task'
+        )
+    
     @admin.display(description="Model")
     def model_text(self, obj):
         return obj.validation_task.request.model
@@ -833,13 +845,13 @@ class VersionAdmin(BaseAdmin):
     search_fields = ("name", "released", "release_notes")
 
 
-class WhiteListQueryFragmentInline(admin.TabularInline):
+class WhiteListQueryFragmentInlineAdmin(admin.TabularInline):
     model = WhiteListQueryFragment
     extra = 1
 
-@admin.register(WhiteListEntry)
+
 class WhiteListEntryAdmin(BaseAdmin):
-    inlines = [WhiteListQueryFragmentInline]
+    inlines = [WhiteListQueryFragmentInlineAdmin]
 
     readonly_fields = ["id", "created", "updated"]
     fieldsets = [
@@ -916,6 +928,7 @@ def get_row(field):
         )
         return TemplateResponse(request, "admin/whitelistentry_test_outcome.html", context)
 
+
 class WhiteListTestForm(forms.Form):
     whitelist_entry = forms.ModelChoiceField(
         queryset=WhiteListEntry.objects.all(),
@@ -937,6 +950,7 @@ class WhiteListTestForm(forms.Form):
 admin.site.register(Company, CompanyAdmin)
 admin.site.register(AuthoringTool, AuthoringToolAdmin)
 admin.site.register(Version, VersionAdmin)
+admin.site.register(WhiteListEntry, WhiteListEntryAdmin)
 
 admin.site.unregister(User)
 admin.site.register(User, CustomUserAdmin)

backend/apps/ifc_validation/chart_views.py

@@ -54,27 +54,15 @@
 }
 
 
-DEV_TEAM_EMAILS = {
-    "hesselinkgeert@gmail.com",
-    "geert.hess@gmail.com",
-    "geertparallels@gmail.com",
-    "t.krijnen@gmail.com",
-    "rw-bsi@xeneo.biz",
-    "raphael@xeneo.biz",
-    "raphael.wouters@gmail.com",
-    "evandro.alfieri@buildingsmart.org",
-    "evandroalfieri@gmail.com",
-}
-
 def _dev_team_ids() -> set[int]:
     """
     Return a set of user IDs that should be classified as 'dev-team'.
 
-    Defined by DEV_TEAM_EMAILS. Keeps classification separate from is_vendor.
+    Defined by User.is_staff. Manage membership via Django admin.
     """
     return set(
         User.objects
-            .filter(email__in=DEV_TEAM_EMAILS)
+            .filter(is_staff=True)
             .values_list("id", flat=True)
     )
 

backend/core/settings.py

@@ -246,10 +246,14 @@
         "USER": os.environ.get("POSTGRES_USER", "postgres"),
         "PASSWORD": os.environ.get("POSTGRES_PASSWORD", "postgres"),
         "PORT": int(os.environ.get("POSTGRES_PORT", "5432")),
-        "CONN_MAX_AGE": int(os.environ.get("POSTGRES_CONN_MAX_AGE", 600)),
+        "CONN_MAX_AGE": 0,  # must be 0 when using pool; pool handles lifecycle via max_lifetime
         "CONN_HEALTH_CHECKS": True,
         "OPTIONS": {
-            "pool": False,
+            "pool": {
+                "min_size": 2,
+                "max_size": 10,
+                "max_lifetime": 600,  # recycle connections before overlay network kills them (~13 min)
+            },
         },
     },
 }
@@ -288,7 +292,7 @@
 TIME_ZONE = "UTC"
 USE_I18N = True
 USE_TZ = True
-
+USE_THOUSAND_SEPARATOR = True
 
 # Static files (CSS, JavaScript, Images)
 # https://docs.djangoproject.com/en/4.2/howto/static-files/

backend/core/utils.py

@@ -158,17 +158,31 @@ def count(self):
         # print('db pk = ', self.object_list.first()._meta.pk.name)
 
         with transaction.atomic(), connection.cursor() as cursor:
-            cursor.execute('SET LOCAL statement_timeout TO 25000;') # 25 seconds timeout
             try:
-                # workaround for Postgres well-documented slow count(*) performance
                 table = self.object_list.first()._meta.db_table
                 id = self.object_list.first()._meta.pk.name
-                cursor.execute(f'SELECT COUNT(distinct {id}) FROM {table}')
-                row = cursor.fetchone()
-                return row[0]
+                count = 0
+
+                # workarounds for Postgres well-documented slow count(*) performance
+                if connection.vendor == 'postgresql':
+                    cursor.execute(f'SELECT reltuples::bigint AS estimate FROM pg_class WHERE relname = \'{table}\'') # estimation
+                    row = cursor.fetchone()
+                    count = row[0]
+                    if count < 1*1000*1000:
+                        cursor.execute(f'SELECT COUNT(distinct {id}) FROM {table}') # exact per pk
+                        row = cursor.fetchone()
+                        count = row[0]
+                    
+                else:
+                    cursor.execute(f'SELECT COUNT(*) FROM {table}')
+                    row = cursor.fetchone()
+                    count = row[0]
+                
+                return count
 
             except OperationalError:
-                return 9999999999 # naive guess
+                
+                return 9999999999 # naive guess in case of timeout/error
 
             except AttributeError:
                 return 0

docker/frontend/nginx/default.conf.template

@@ -36,6 +36,24 @@ server {
         try_files $uri @proxy_api;
     }
 
+    # Swagger/ReDoc — relaxed CSP for inline scripts, proxied directly
+    location ~ ^/api/v1/(swagger-ui|redoc) {
+        resolver 127.0.0.11 valid=30s;
+        set $upstream http://backend:8000;
+        add_header X-Content-Type-Options nosniff always;
+        add_header X-Frame-Options DENY always;
+        add_header Referrer-Policy 'same-origin' always;
+        add_header Content-Security-Policy "script-src 'self' 'unsafe-inline' https://cdn.jsdelivr.net; frame-ancestors 'none'" always;
+        proxy_read_timeout 500s;
+        proxy_connect_timeout 75s;
+        proxy_pass $upstream;
+        proxy_redirect off;
+        proxy_set_header Host $http_host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
+    }
+
     # API (Django APP)
     location /api {
         try_files $uri @proxy_api;
@@ -72,10 +90,13 @@ server {
 
     # Django backend (API + BFF + Admin)
     location @proxy_api {
+        resolver 127.0.0.11 valid=30s;
+        set $upstream http://backend:8000;
+
         proxy_read_timeout 500s;
         proxy_connect_timeout 75s;
 
-        proxy_pass   http://backend:8000;
+        proxy_pass   $upstream;
         proxy_redirect off;
 
         proxy_set_header   Host                 $http_host;

docs/dev/api_quickstart.md

@@ -13,7 +13,7 @@ formats.
 
 ## Auth token
 
-You will need an Authentication token before making calls to the API, 
+You will need an Authentication token before making calls to the API,
 which can be obtained by emailing [validate@buildingsmart.org](mailto:validate@buildingsmart.org).
 
 You can use this token either as a Bearer token or use it as the password in combination with your username/email for basic authentication.
@@ -26,13 +26,14 @@ You can use this token either as a Bearer token or use it as the password in com
      curl -X GET --location 'https://dev.validate.buildingsmart.org/api/v1/validationrequest' --header 'Authorization: Token <TOKEN>'
     ```
 
-    -or-
+   -or-
 
     ```shell
     curl -X GET --location 'https://dev.validate.buildingsmart.org/api/v1/validationrequest' --header 'Authorization: Basic <HASH>'
+    curl -X GET --location 'https://dev.validate.buildingsmart.org/api/validationrequest/' --header 'Authorization: Basic <HASH>'
     ```
 
-    where `<HASH>` is the Base64-encoded email and token as password, separated by a colon, eg. base64(johndoe@gmail.com:abcdefgh12345)
+   where `<HASH>` is the Base64-encoded email and token as password, separated by a colon, eg. base64(johndoe@gmail.com:abcdefgh12345)
 
 2. Submit a POST request to the `/validationrequest` endpoint to initiate a new Validation Request (requires a file name and the file contents):
 
@@ -65,7 +66,7 @@ You can use this token either as a Bearer token or use it as the password in com
    ```shell
    curl -X GET --location 'https://dev.validate.buildingsmart.org/api/v1/validationtask?request_public_id=r75257132,r383446691' --header 'Authorization: Token <TOKEN>'
    ```
-   
+
 6. Fetch all the outcomes of a single ValidationRequest via a GET request to the `/validationoutcome` endpoint
 
    ```shell

docs/ref/index.md

@@ -35,3 +35,8 @@ The responses to these inquiries are provided here for the benefit of the entire
 :heading-offset: 1
 :relative-images:
 ```
+
+```{include} ./normative-rules/BRP003.md
+:heading-offset: 1
+:relative-images:
+```

docs/ref/normative-rules/BRP003.md

@@ -0,0 +1,13 @@
+# BRP003
+
+This rule confirms that geometric faces indicated as being planar
+do actually lie on the same plane.
+
+## Approach
+
+1. Derive the plane from the outer boundary; uses Newell’s method for the normal and compute d from the average of the input points.
+2. Validate outer and inner boundaries by projecting their points onto that plane and checking that each projection distance is within the representation context precision.
+
+```{note}
+All calculations are performed in 128-bit floating point.
+```