From d9cd3b3c62ae530c788e2c55502a74cd7ae26288 Mon Sep 17 00:00:00 2001
From: rhenck <richard.henck@iqb.hu-berlin.de>
Date: Sun, 26 May 2024 15:16:38 +0200
Subject: [PATCH] [editor] Refactor API-Service and remove
 voeGetDefinitionRequest

- Remove stupid getters
- Improve naming
- Remove deprecated voeGetDefinitionRequest
---
 projects/editor/src/app/app.component.ts      | 11 ++---
 .../src/app/services/verona-api.service.ts    | 44 ++++++-------------
 2 files changed, 16 insertions(+), 39 deletions(-)

diff --git a/projects/editor/src/app/app.component.ts b/projects/editor/src/app/app.component.ts
index 0bf27edfc..834092574 100644
--- a/projects/editor/src/app/app.component.ts
+++ b/projects/editor/src/app/app.component.ts
@@ -42,16 +42,11 @@ export class AppComponent implements OnInit {
   }
 
   ngOnInit(): void {
-    this.veronaApiService.voeStartCommand
-      .subscribe((message: VoeStartCommand): void => {
+    this.veronaApiService.startCommand
+      .subscribe((message: StartCommand): void => {
         this.unitService.loadUnitDefinition(message.unitDefinition);
       });
-    this.veronaApiService.voeGetDefinitionRequest
-      .subscribe(() => {
-        this.veronaApiService.sendVoeDefinitionChangedNotification(this.unitService.unit);
-      });
-
-    this.veronaApiService.sendVoeReadyNotification();
+    this.veronaApiService.sendReady();
     registerLocaleData(localeDe);
   }
 }
diff --git a/projects/editor/src/app/services/verona-api.service.ts b/projects/editor/src/app/services/verona-api.service.ts
index b651232eb..f0068ea41 100644
--- a/projects/editor/src/app/services/verona-api.service.ts
+++ b/projects/editor/src/app/services/verona-api.service.ts
@@ -1,5 +1,5 @@
 import { Injectable } from '@angular/core';
-import { fromEvent, Observable, Subject } from 'rxjs';
+import { fromEvent, Subject } from 'rxjs';
 import { Unit } from 'common/models/unit';
 import { VariableInfo } from '@iqb/responses';
 
@@ -9,10 +9,7 @@ import { VariableInfo } from '@iqb/responses';
 export class VeronaAPIService {
   sessionID: string | undefined;
   resourceURL: string | undefined;
-  private _voeStartCommand = new Subject<VoeStartCommand>();
-  private _voeGetDefinitionRequest = new Subject<VoeGetDefinitionRequest>();
-
-  private isStandalone = window === window.parent;
+  startCommand = new Subject<StartCommand>();
 
   constructor() {
     fromEvent(window, 'message')
@@ -21,18 +18,11 @@ export class VeronaAPIService {
       });
   }
 
-  private handleMessage(messageData: VoeGetDefinitionRequest | VoeStartCommand): void {
-    switch (messageData.type) {
-      case 'voeStartCommand':
-        this.sessionID = messageData.sessionId;
-        this.resourceURL = (messageData as VoeStartCommand).editorConfig.directDownloadUrl;
-        this._voeStartCommand.next(messageData as VoeStartCommand);
-        break;
-      case 'voeGetDefinitionRequest': // No longer part of the API. Kept in for compatibility.
-        this._voeGetDefinitionRequest.next(messageData);
-        break;
-      default:
-        console.warn(`editor: got message of unknown type ${messageData}`);
+  private handleMessage(messageData: GetDefinitionCommand | StartCommand): void {
+    if (messageData.type === 'voeStartCommand') {
+      this.sessionID = messageData.sessionId;
+      this.resourceURL = (messageData as StartCommand).editorConfig.directDownloadUrl;
+      this.startCommand.next(messageData as StartCommand);
     }
   }
 
@@ -42,14 +32,15 @@ export class VeronaAPIService {
 
   private send(message: Record<string, string | VariableInfo[]>): void {
     // prevent posts in local (dev) mode
-    if (!this.isStandalone) {
+    const isStandalone = window === window.parent;
+    if (!isStandalone) {
       window.parent.postMessage(message, '*');
     } else {
       // console.log(`player: ${message.type}`);
     }
   }
 
-  sendVoeReadyNotification(): void {
+  sendReady(): void {
     const metadata: string | null | undefined = document.getElementById('verona-metadata')?.textContent;
     this.send({
       type: 'voeReadyNotification',
@@ -57,7 +48,7 @@ export class VeronaAPIService {
     });
   }
 
-  sendVoeDefinitionChangedNotification(unit: Unit): void {
+  sendChanged(unit: Unit): void {
     this.send({
       type: 'voeDefinitionChangedNotification',
       sessionId: this.sessionID as string,
@@ -67,18 +58,9 @@ export class VeronaAPIService {
       variables: unit.getVariableInfos()
     });
   }
-
-  get voeStartCommand(): Observable<VoeStartCommand> {
-    return this._voeStartCommand.asObservable();
-  }
-
-  // No longer part of the API. Kept in for compatibility.
-  get voeGetDefinitionRequest(): Observable<VoeGetDefinitionRequest> {
-    return this._voeGetDefinitionRequest.asObservable();
-  }
 }
 
-export interface VoeStartCommand extends MessageEvent {
+export interface StartCommand extends MessageEvent {
   sessionId: string,
   unitDefinition: string,
   unitDefinitionType: string,
@@ -87,6 +69,6 @@ export interface VoeStartCommand extends MessageEvent {
   }
 }
 
-export interface VoeGetDefinitionRequest extends MessageEvent {
+export interface GetDefinitionCommand extends MessageEvent {
   sessionId: string
 }
-- 
GitLab