Improved Result & Query Logging

.gitignore

@@ -1,3 +1,4 @@
+src/config.json
 deploy.log
 
 src/app/**/*.js

README.md

@@ -11,9 +11,9 @@ For setup information, consult our [Wiki](https://github.com/vitrivr/vitrivr-ng/
 
 ## Config
 
-There is a `config.json` which enables configuration of the UI to a certain extend.
-While we provide a sensible [default config](src/config.json), the
-some default values are better explored in the [code](src/app/shared/model/config/config.model.ts).
+We follow a zero-config approach, where everything has reasonable defaults.
+There is a `src/config.template.json` file which you can copy to `src/config.json` and modify if you have custom needs.
+The default values are in the [code](src/app/shared/model/config/config.model.ts).
 Information about the configuration can be found in [the wiki](https://github.com/vitrivr/vitrivr-ng/wiki/Configuration).
 
 ## Development server

package.json

@@ -79,4 +79,4 @@
     "ts-node": "10.7.0",
     "tslint": "^6.1.3"
   }
-}
+}

src/app/app.component.ts

@@ -93,8 +93,4 @@ export class AppComponent implements OnInit, AfterViewInit {
     this._active_view = view;
   }
 
-  isCompetitionActive() {
-    return this._configService.configAsObservable;
-    return this._config.dresEndpointRest && (this._config.get('competition.vbs') || this._config.get('competition.lsc'))
-  }
 }

src/app/app.config.ts

@@ -63,13 +63,13 @@ export class AppConfig {
         AppConfig.settingsSubject.next(AppConfig.settings);
         resolve();
       }).catch((response: any) => {
-        this._snackBar.open('Could not parse config.json. Using default config, your UI may not work', 'Dismiss', {
+        this._snackBar.open('No config file present, using default config.', 'Dismiss', {
           duration: 1_000_000,
           verticalPosition: 'top'
         })
         AppConfig.settings = new Proxy<Config>(new Config(), this.handler);
         AppConfig.settingsSubject.next(AppConfig.settings);
-        console.log(`Could not load config file '${jsonFile}'. Fallback to default.`);
+        console.log(`No config present at '${jsonFile}'. Using default.`);
         resolve();
       });
     });

src/app/core/basics/basic.module.ts

@@ -9,11 +9,12 @@ import {NotificationService} from './notification.service';
 import {NoConnectDialogComponent} from './no-connect-dialog';
 import {MatDialogModule} from '@angular/material/dialog';
 import {MatButtonModule} from '@angular/material/button';
+import {DresService} from './dres.service';
 
 @NgModule({
   imports: [HttpClientModule, MatDialogModule, MatButtonModule],
   declarations: [NoConnectDialogComponent],
-  providers: [ResolverService, EventBusService, PingService, DatabaseService, KeyboardService, NotificationService]
+  providers: [ResolverService, EventBusService, PingService, DatabaseService, KeyboardService, NotificationService, DresService]
 })
 
 export class BasicModule {

src/app/core/basics/database.service.ts

@@ -11,11 +11,12 @@ export class DatabaseService {
    */
   constructor() {
     DatabaseService.DB.version(1).stores({
-      config: 'id,config',
       history: '++id,timestamp',
-      log_results: '++id,log',
-      log_interaction: '++id,log',
-      log_submission: '++id,log'
+      log_results_dres: '++id,log',
+      log_interaction_dres: '++id,log',
+      log_submission_dres: '++id,log',
+      log_results: '++id,entry',
+      log_queries: '++id,entry',
     });
   }
 

src/app/core/basics/dres.service.ts

@@ -0,0 +1,92 @@
+import {Injectable} from '@angular/core';
+import {AppConfig} from '../../app.config';
+import {ClientRunInfo, ClientRunInfoService, ClientTaskInfo, UserDetails, UserService} from '../../../../openapi/dres';
+import {BehaviorSubject, Observable} from 'rxjs';
+
+@Injectable()
+export class DresService {
+
+  private _status: BehaviorSubject<UserDetails> = new BehaviorSubject(null)
+  private _activeRun: BehaviorSubject<ClientRunInfo> = new BehaviorSubject(null);
+  private _activeTask: BehaviorSubject<ClientTaskInfo> = new BehaviorSubject(null);
+
+  constructor(private _configService: AppConfig, private _runInfo: ClientRunInfoService, private _dresUser: UserService,) {
+    this._configService.configAsObservable.subscribe(config => {
+        if (config?.dresEndpointRest == null) {
+          return
+        }
+        this._dresUser.getApiV1User().subscribe(
+          {
+            next: (user) => {
+              this._status.next(user)
+            },
+            error: (error) => {
+              this._status.error(error)
+            }
+          })
+      }
+    )
+
+    // init dres info
+    this.updateDresInfo()
+
+    // update every 5 seconds
+    setInterval(
+      () => {
+        this.updateDresInfo()
+      },
+      5 * 1000
+    )
+
+  }
+
+  private updateDresInfo() {
+    if (this.getStatus() == null) {
+      return
+    }
+    this._runInfo.getApiV1ClientRunInfoList(this.getStatus().sessionId).subscribe(list => {
+      const l = list.runs.filter(info => info.status == 'ACTIVE');
+      const activeRun = l.length == 0 ? null : l[0]
+      this._activeRun.next(activeRun)
+      if (this._activeRun) {
+        this._runInfo.getApiV1ClientRunInfoCurrenttaskWithRunid(this._activeRun.getValue().id, this.getStatus().sessionId).subscribe(task => {
+          this._activeTask.next(task)
+        })
+      }
+    })
+  }
+
+  public statusObservable(): Observable<UserDetails> {
+    return this._status.asObservable()
+  }
+
+  public activeTaskObservable(): Observable<ClientTaskInfo> {
+    return this._activeTask.asObservable()
+  }
+
+  public activeRunObservable(): Observable<ClientRunInfo> {
+    return this._activeRun.asObservable()
+  }
+
+  public activeTask(): ClientTaskInfo {
+    return this._activeTask.getValue()
+  }
+
+  public activeRun(): ClientRunInfo {
+    return this._activeRun.getValue()
+  }
+
+  /**
+   * Returns null if an error was thrown during connection
+   */
+  public getStatus(): UserDetails {
+    try {
+      if (this._status.getValue()) {
+        return this._status.getValue()
+      }
+      return null
+    } catch (e) {
+      return null
+    }
+  }
+}

src/app/core/basics/event-bus.service.ts

@@ -17,7 +17,7 @@ export class EventBusService {
   private _currentView: Subject<string> = new BehaviorSubject<string>(null);
 
   /** The subject used to track the currently active view. */
-  private _lastQuery: Subject<InteractionEvent> = new BehaviorSubject<InteractionEvent>(null);
+  private _lastQuery = new BehaviorSubject<InteractionEvent>(null);
 
   /**
    * Publishes a nev InteractionEvent to the bus.
@@ -44,12 +44,10 @@ export class EventBusService {
   }
 
   /**
-   * Returns an observable that allows a consumer to be informed about the last query issued.
-   *
-   * @return {Observable<InteractionEvent>}
+   * Returns the latest query
    */
-  public lastQuery(): Observable<InteractionEvent> {
-    return this._lastQuery.asObservable()
+  public lastQueryInteractionEvent(): InteractionEvent {
+    return this._lastQuery.getValue()
   }
 
   /**

src/app/core/basics/notification.service.ts

@@ -1,17 +1,18 @@
 import {Injectable} from '@angular/core';
 import {BehaviorSubject, combineLatest, of} from 'rxjs';
-import {VbsSubmissionService} from '../vbs/vbs-submission.service';
+import {VbsSubmissionService} from '../competition/vbs-submission.service';
 import {NotificationUtil} from '../../shared/util/notification.util';
 import {catchError, tap} from 'rxjs/operators';
 import {AppConfig} from '../../app.config';
+import {DresService} from './dres.service';
 
 @Injectable()
 export class NotificationService {
 
   private _dresStatusBadge = new BehaviorSubject('')
 
-  constructor(private _submissionService: VbsSubmissionService, private _configService: AppConfig) {
-    combineLatest([this._submissionService.statusObservable, this._configService.configAsObservable]).pipe(
+  constructor(private _submissionService: VbsSubmissionService, private _configService: AppConfig, private _dresService: DresService) {
+    combineLatest([this._dresService.statusObservable(), this._configService.configAsObservable]).pipe(
       tap(([status, config]) => {
           if (config._config.competition.host) {
             /* Do not update observable for undefined since that is the initial value*/

src/app/core/vbs/vbs.module.ts → src/app/core/competition/competition.module.ts

@@ -13,4 +13,4 @@ import {AppConfig} from '../../app.config';
   declarations: [],
   providers: [VbsSubmissionService, CollabordinatorService]
 })
-export class VbsModule { }
+export class CompetitionModule { }

src/app/core/competition/logging/filter-information.ts

@@ -0,0 +1,50 @@
+import {MediaObjectDescriptor} from "../../../../../openapi/cineast";
+import {ColorLabel} from "../../../shared/model/misc/colorlabel.model";
+import {Tag} from "../../selection/tag.model";
+
+/**
+ * A simple data class for logging
+ */
+export class FilterInformation {
+
+  /**
+   * When set to true, objects who have metadata matching for any of the categories are displayed.
+   */
+  _useOrForMetadataCategoriesFilter = false;
+
+  _id: string;
+
+  /**
+   * A filter by MediaType. Affects both MediaObjectScoreContainers and MediaSegmentScoreContainers. If non-empty, only objects
+   * that match one of the MediaTypes contained in this array will pass the filter.
+   */
+  _mediatypes: Map<MediaObjectDescriptor.MediatypeEnum, boolean> = new Map();
+
+  /**
+   * A filter by dominant color. Affects only MediaSegmentScoreContainers. If non-empty, only segments
+   * that match at least one of the dominant colors contained in this array will pass the filter.
+   */
+  _dominant: Map<ColorLabel, boolean> = new Map();
+
+  /**
+   * A filter by metadata. For each metadata category (e.g. day), a list of allowed values is kept.
+   * If empty, all results are displayed. If non-empty, only results are displayed where for every key in the filter, the metadata value of the object matches an allowed value in the list.
+   * Behavior across categories is determined by a different boolean.
+   * If the object does not have one of the metadata keys, it is filtered.
+   */
+  _filterMetadata: Map<string, Set<string>> = new Map();
+
+  /**
+   * A filter for tags. This is the list of allowed tag names. If the set is empty, no filter is applied.
+   */
+  _filterTags: Set<Tag> = new Set();
+
+  /**
+   * A filter by metadata for numeric values.
+   * For each category, a min and max number is kept (or null)
+   */
+  _filterRangeMetadata: Map<string, [number | null, number | null]> = new Map();
+
+  /** Threshold for score filtering. */
+  _threshold = 0.0;
+}

src/app/core/competition/logging/query-log-item.ts

@@ -0,0 +1,7 @@
+import {ClientRunInfo, ClientTaskInfo} from '../../../../../openapi/dres';
+
+export interface QueryLogItem {
+  query: any,
+  dresTask: ClientTaskInfo,
+  dresRun: ClientRunInfo,
+}

src/app/core/competition/logging/result-log-item.ts

@@ -0,0 +1,8 @@
+import {FilterInformation} from "./filter-information";
+import {SegmentScoreLogContainer} from "./segment-score-log-container";
+
+export interface ResultLogItem {
+  filter: FilterInformation
+  query: any,
+  results: SegmentScoreLogContainer[],
+}

src/app/core/competition/logging/segment-score-log-container.ts

@@ -0,0 +1,15 @@
+export class SegmentScoreLogContainer {
+  public readonly objectId: string;
+  public readonly segmentId: string;
+  public readonly startabs: number;
+  public readonly endabs: number;
+  public readonly _score: number;
+
+  constructor(objectId: string, segmentId: string, startabs: number, endabs: number, score: number) {
+    this.objectId = objectId;
+    this.segmentId = segmentId;
+    this.startabs = startabs;
+    this.endabs = endabs;
+    this._score = score;
+  }
+}