Merge pull request #3837 from FinnStutzenstein/constants

Angular constants via WebSocket

client/src/app/core/services/constants.service.spec.ts

@@ -0,0 +1,15 @@
+import { TestBed, inject } from '@angular/core/testing';
+
+import { ConstantsService } from './constants.service';
+
+describe('ConstantsService', () => {
+    beforeEach(() => {
+        TestBed.configureTestingModule({
+            providers: [ConstantsService]
+        });
+    });
+
+    it('should be created', inject([ConstantsService], (service: ConstantsService) => {
+        expect(service).toBeTruthy();
+    }));
+});

client/src/app/core/services/constants.service.ts

@@ -0,0 +1,97 @@
+import { Injectable } from '@angular/core';
+
+import { OpenSlidesComponent } from 'app/openslides.component';
+import { WebsocketService } from './websocket.service';
+import { Observable, of, Subject } from 'rxjs';
+
+/**
+ * constants have a key associated with the data.
+ */
+interface Constants {
+    [key: string]: any;
+}
+
+/**
+ * Get constants from the server.
+ *
+ * @example
+ * ```ts
+ * this.constantsService.get('OpenSlidesSettings').subscribe(constant => {
+ *     console.log(constant);
+ * });
+ * ```
+ */
+@Injectable({
+    providedIn: 'root'
+})
+export class ConstantsService extends OpenSlidesComponent {
+    /**
+     * The constants
+     */
+    private constants: Constants;
+
+    /**
+     * Flag, if the websocket connection is open.
+     */
+    private websocketOpen = false;
+
+    /**
+     * Flag, if constants are requested, but the server hasn't send them yet.
+     */
+    private pending = false;
+
+    /**
+     * Pending requests will be notified by these subjects, one per key.
+     */
+    private pendingSubject: { [key: string]: Subject<any> } = {};
+
+    /**
+     * @param websocketService
+     */
+    public constructor(private websocketService: WebsocketService) {
+        super();
+
+        // The hook for recieving constants.
+        websocketService.getOberservable<Constants>('constants').subscribe(constants => {
+            this.constants = constants;
+            if (this.pending) {
+                // send constants to subscribers that await constants.
+                this.pending = false;
+                Object.keys(this.pendingSubject).forEach(key => {
+                    this.pendingSubject[key].next(this.constants[key]);
+                });
+            }
+        });
+
+        // We can request constants, if the websocket connection opens.
+        websocketService.connectEvent.subscribe(() => {
+            if (!this.websocketOpen && this.pending) {
+                this.websocketService.send('constants', {});
+            }
+            this.websocketOpen = true;
+        });
+    }
+
+    /**
+     * Get the constant named by key.
+     * @param key The constant to get.
+     */
+    public get(key: string): Observable<any> {
+        if (this.constants) {
+            return of(this.constants[key]);
+        } else {
+            // we have to request constants.
+            if (!this.pending) {
+                this.pending = true;
+                // if the connection is open, we directly can send the request.
+                if (this.websocketOpen) {
+                    this.websocketService.send('constants', {});
+                }
+            }
+            if (!this.pendingSubject[key]) {
+                this.pendingSubject[key] = new Subject<any>();
+            }
+            return this.pendingSubject[key].asObservable();
+        }
+    }
+}

client/src/app/core/services/openslides.service.ts

@@ -38,7 +38,7 @@ export class OpenSlidesService extends OpenSlidesComponent {
 
         // Handler that gets called, if the websocket connection reconnects after a disconnection.
         // There might have changed something on the server, so we check the operator, if he changed.
-        websocketService.getReconnectObservable().subscribe(() => {
+        websocketService.reconnectEvent.subscribe(() => {
             this.checkOperator();
         });
     }

client/src/app/core/services/websocket.service.ts

@@ -1,4 +1,4 @@
-import { Injectable, NgZone } from '@angular/core';
+import { Injectable, NgZone, EventEmitter } from '@angular/core';
 import { Router } from '@angular/router';
 import { Observable, Subject } from 'rxjs';
 import { MatSnackBar, MatSnackBarRef, SimpleSnackBar } from '@angular/material';
@@ -36,7 +36,26 @@ export class WebsocketService {
     /**
      * Subjects that will be called, if a reconnect was successful.
      */
-    private reconnectSubject: Subject<void>;
+    private _reconnectEvent: EventEmitter<void> = new EventEmitter<void>();
+
+    /**
+     * Getter for the reconnect event.
+     */
+    public get reconnectEvent(): EventEmitter<void> {
+        return this._reconnectEvent;
+    }
+
+    /**
+     * Listeners will be nofitied, if the wesocket connection is establiched.
+     */
+    private _connectEvent: EventEmitter<void> = new EventEmitter<void>();
+
+    /**
+     * Getter for the connect event.
+     */
+    public get connectEvent(): EventEmitter<void> {
+        return this._connectEvent;
+    }
 
     /**
      * The websocket.
@@ -57,9 +76,7 @@ export class WebsocketService {
         private matSnackBar: MatSnackBar,
         private zone: NgZone,
         public translate: TranslateService
-    ) {
-        this.reconnectSubject = new Subject<void>();
-    }
+    ) {}
 
     /**
      * Creates a new WebSocket connection and handles incomming events.
@@ -91,8 +108,9 @@ export class WebsocketService {
                         this.connectionErrorNotice.dismiss();
                         this.connectionErrorNotice = null;
                     }
-                    this.reconnectSubject.next();
+                    this._reconnectEvent.emit();
                 }
+                this._connectEvent.emit();
             });
         };
 
@@ -156,13 +174,6 @@ export class WebsocketService {
         return this.subjects[type].asObservable();
     }
 
-    /**
-     * get the reconnect observable. It will be published, if a reconnect was sucessful.
-     */
-    public getReconnectObservable(): Observable<void> {
-        return this.reconnectSubject.asObservable();
-    }
-
     /**
      * Sends a message to the server with the content and the given type.
      *

client/src/app/site/login/login.component.ts

@@ -72,6 +72,13 @@ export class LoginComponent extends BaseComponent implements OnInit, OnDestroy {
      */
     public inProcess = false;
 
+    /**
+     * The provacy policy send by the server.
+     *
+     * TODO: give an option to show it during login.
+     */
+    public privacyPolicy: string;
+
     /**
      * Constructor for the login component
      *
@@ -106,9 +113,12 @@ export class LoginComponent extends BaseComponent implements OnInit, OnDestroy {
         super.setTitle('Login');
 
         this.http.get<any>(environment.urlPrefix + '/users/login/', {}).subscribe(response => {
-            this.installationNotice = this.matSnackBar.open(response.info_text, this.translate.instant('OK'), {
-                duration: 5000
-            });
+            if (response.info_text) {
+                this.installationNotice = this.matSnackBar.open(response.info_text, this.translate.instant('OK'), {
+                    duration: 5000
+                });
+            }
+            this.privacyPolicy = response.privacy_policy;
         });
     }
 

openslides/assignments/apps.py

@@ -47,14 +47,11 @@ class AssignmentsAppConfig(AppConfig):
 
     def get_angular_constants(self):
         assignment = self.get_model('Assignment')
-        InnerItem = TypedDict('InnerItem', {'value': int, 'display_name': str})
-        Item = TypedDict('Item', {'name': str, 'value': List[InnerItem]})
-        data: Item = {
-            'name': 'AssignmentPhases',
-            'value': []}
+        Item = TypedDict('Item', {'value': int, 'display_name': str})
+        phases: List[Item] = []
         for phase in assignment.PHASES:
-            data['value'].append({
+            phases.append({
                 'value': phase[0],
                 'display_name': phase[1],
             })
-        return [data]
+        return {'AssignmentPhases': phases}

openslides/core/apps.py

@@ -1,9 +1,10 @@
 from collections import OrderedDict
 from operator import attrgetter
-from typing import Any, List
+from typing import Any, Dict, List
 
 from django.apps import AppConfig
 from django.conf import settings
+from django.core.exceptions import ImproperlyConfigured
 from django.db.models.signals import post_migrate
 
 from ..utils.projector import register_projector_elements
@@ -37,6 +38,14 @@ class CoreAppConfig(AppConfig):
             ProjectorViewSet,
             TagViewSet,
         )
+        from ..utils.constants import set_constants, get_constants_from_apps
+
+        # Set constants
+        try:
+            set_constants(get_constants_from_apps())
+        except ImproperlyConfigured:
+            # Database is not loaded. This happens in tests.
+            pass
 
         # Define config variables and projector elements.
         config.update_config_variables(get_config_variables())
@@ -74,6 +83,8 @@ class CoreAppConfig(AppConfig):
     def get_angular_constants(self):
         from .config import config
 
+        constants: Dict[str, Any] = {}
+
         # Client settings
         client_settings_keys = [
             'MOTION_IDENTIFIER_MIN_DIGITS',
@@ -88,9 +99,7 @@ class CoreAppConfig(AppConfig):
                 # Settings key does not exist. Do nothing. The client will
                 # treat this as undefined.
                 pass
-        client_settings = {
-            'name': 'OpenSlidesSettings',
-            'value': client_settings_dict}
+        constants['OpenSlidesSettings'] = client_settings_dict
 
         # Config variables
         config_groups: List[Any] = []
@@ -110,17 +119,9 @@ class CoreAppConfig(AppConfig):
                     items=[]))
             # Add the config variable to the current group and subgroup.
             config_groups[-1]['subgroups'][-1]['items'].append(config_variable.data)
-        config_variables = {
-            'name': 'OpenSlidesConfigVariables',
-            'value': config_groups}
+        constants['OpenSlidesConfigVariables'] = config_groups
 
-        # Send the privacy policy to the client. A user should view them, even he is
-        # not logged in (so does not have the config values yet).
-        privacy_policy = {
-            'name': 'PrivacyPolicy',
-            'value': config['general_event_privacy_policy']}
-
-        return [client_settings, config_variables, privacy_policy]
+        return constants
 
 
 def call_save_default_values(**kwargs):

openslides/core/views.py

@@ -15,6 +15,7 @@ from .. import __license__ as license, __url__ as url, __version__ as version
 from ..utils import views as utils_views
 from ..utils.auth import anonymous_is_enabled, has_perm
 from ..utils.autoupdate import inform_changed_data, inform_deleted_data
+from ..utils.constants import get_constants
 from ..utils.plugins import (
     get_plugin_description,
     get_plugin_license,
@@ -133,18 +134,9 @@ class WebclientJavaScriptView(utils_views.View):
 
         # angular constants
         angular_constants = ''
-        for app in apps.get_app_configs():
-            try:
-                # Each app can deliver values to angular when implementing this method.
-                # It should return a list with dicts containing the 'name' and 'value'.
-                get_angular_constants = app.get_angular_constants
-            except AttributeError:
-                # The app doesn't have this method. Continue to next app.
-                continue
-            for constant in get_angular_constants():
-                value = json.dumps(constant['value'])
-                name = constant['name']
-                angular_constants += ".constant('{}', {})".format(name, value)
+        for key, value in get_constants().items():
+            value = json.dumps(value)
+            angular_constants += ".constant('{}', {})".format(key, value)
 
         # Use JavaScript loadScript function from
         # http://balpha.de/2011/10/jquery-script-insertion-and-its-consequences-for-debugging/

openslides/users/apps.py

@@ -58,7 +58,4 @@ class UsersAppConfig(AppConfig):
             permissions.append({
                 'display_name': permission.name,
                 'value': '.'.join((permission.content_type.app_label, permission.codename,))})
-        permission_settings = {
-            'name': 'permissions',
-            'value': permissions}
-        return [permission_settings]
+        return {'permissions': permissions}

openslides/users/views.py

@@ -453,6 +453,8 @@ class UserLoginView(APIView):
                                 password='<strong>admin</strong>')
                     else:
                         context['info_text'] = ''
+            # Add the privacy policy, so the client can display it even, it is not logged in.
+            context['privacy_policy'] = config['general_event_privacy_policy']
         else:
             # self.request.method == 'POST'
             context['user_id'] = self.user.pk

openslides/utils/constants.py

@@ -0,0 +1,40 @@
+from typing import Any, Dict
+
+from django.apps import apps
+
+
+def get_constants_from_apps() -> Dict[str, Any]:
+    out: Dict[str, Any] = {}
+    for app in apps.get_app_configs():
+        try:
+            # Each app can deliver values to angular when implementing this method.
+            # It should return a list with dicts containing the 'name' and 'value'.
+            get_angular_constants = app.get_angular_constants
+        except AttributeError:
+            # The app doesn't have this method. Continue to next app.
+            continue
+        out.update(get_angular_constants())
+    return out
+
+
+constants = None
+
+
+def get_constants() -> Dict[str, Any]:
+    """
+    Returns the constants.
+
+    This method only returns a static dict, so it is fast and can be used in a
+    async context.
+    """
+    if constants is None:
+        raise RuntimeError("Constants are not set.")
+    return constants
+
+
+def set_constants(value: Dict[str, Any]) -> None:
+    """
+    Sets the constants variable.
+    """
+    global constants
+    constants = value

openslides/utils/consumers.py

@@ -15,6 +15,7 @@ from .collection import (
     format_for_autoupdate,
     from_channel_message,
 )
+from .constants import get_constants
 
 
 class ProtocollAsyncJsonWebsocketConsumer(AsyncJsonWebsocketConsumer):
@@ -30,7 +31,7 @@ class ProtocollAsyncJsonWebsocketConsumer(AsyncJsonWebsocketConsumer):
             "type": {
                 "description": "Defines what kind of packages is packed.",
                 "type": "string",
-                "pattern": "notify",  # The server can sent other types
+                "pattern": "notify|constants",  # The server can sent other types
             },
             "content": {
                 "description": "The content of the package.",
@@ -137,6 +138,10 @@ class SiteConsumer(ProtocollAsyncJsonWebsocketConsumer):
             else:
                 await self.send_json(type='error', content='Invalid notify message', in_response=id)
 
+        elif type == 'constants':
+            # Return all constants to the client.
+            await self.send_json(type='constants', content=get_constants(), in_response=id)
+
     async def send_notify(self, event: Dict[str, Any]) -> None:
         """
         Send a notify message to the user.

tests/conftest.py

@@ -1,4 +1,6 @@
+import pytest
 from django.test import TestCase, TransactionTestCase
+from pytest_django.django_compat import is_django_unittest
 from pytest_django.plugin import validate_django_db
 
 
@@ -38,3 +40,20 @@ def pytest_collection_modifyitems(items):
         return 0
 
     items.sort(key=weight_test_case)
+
+
+@pytest.fixture(autouse=True)
+def constants(request):
+    """
+    Resets the constants on every test.
+
+    Uses fake constants, if the db is not in use.
+    """
+    from openslides.utils.constants import set_constants, get_constants_from_apps
+
+    if 'django_db' in request.node.keywords or is_django_unittest(request):
+        # When the db is created, use the original constants
+        set_constants(get_constants_from_apps())
+    else:
+        # Else: Use fake constants
+        set_constants({'constant1': 'value1', 'constant2': 'value2'})

tests/integration/core/test_views.py

@@ -94,17 +94,17 @@ class WebclientJavaScriptView(TestCase):
         response = self.client.get(reverse('core_webclient_javascript', args=['site']))
         content = response.content.decode()
         constants = self.get_angular_constants_from_apps()
-        for constant in constants:
-            self.assertTrue(json.dumps(constant['value']) in content)
+        for key, constant in constants.items():
+            self.assertTrue(json.dumps(constant) in content)
 
     def get_angular_constants_from_apps(self):
-        constants = []
+        constants = {}
         for app in apps.get_app_configs():
             try:
                 get_angular_constants = app.get_angular_constants
             except AttributeError:
                 continue
-            constants.extend(get_angular_constants())
+            constants.update(get_angular_constants())
         return constants
 
 

tests/integration/utils/test_consumers.py

@@ -241,3 +241,18 @@ async def test_send_unknown_type(communicator):
     response = await communicator.receive_json_from()
     assert response['type'] == 'error'
     assert response['in_response'] == 'test_id'
+
+
+@pytest.mark.asyncio
+async def test_request_constants(communicator, settings):
+    await set_config('general_system_enable_anonymous', True)
+    await communicator.connect()
+    # Await the startup data
+    await communicator.receive_json_from()
+
+    await communicator.send_json_to({'type': 'constants', 'content': '', 'id': 'test_id'})
+
+    response = await communicator.receive_json_from()
+    assert response['type'] == 'constants'
+    # See conftest.py for the content of 'content'
+    assert response['content'] == {'constant1': 'value1', 'constant2': 'value2'}