feat(edulint): show nice result

Author: esoadamo

src/app/components/tasks/task-module/task-module-programming/task-module-programming.component.html

@@ -5,7 +5,6 @@
   <button class="btn btn-ksi download" (click)="download()">{{'tasks.module.programming.download'|translate}}</button>
   <button class="btn btn-ksi upload" (click)="upload()">{{'tasks.module.programming.upload'|translate}}</button>
   <button class="btn btn-ksi reset" (click)="reset()">{{'tasks.module.programming.reset'|translate}}</button>
-  <button [disabled]="linting$ | async" class="btn btn-ksi" [tooltip]="'tasks.module.programming.lint.tooltip'|translate" (click)="lintCode()">{{'tasks.module.programming.lint.text'|translate}}</button>
 </div>
 
 <input #uploadFile type="file" style="display: none" (change)="replaceCode($event)">
@@ -18,6 +17,32 @@
   <h6 class="report-heading">{{'tasks.module.programming.run-result'|translate}}</h6>
   <textarea #runOutput class="area-code-output" [value]="result.stdout || ''" [readOnly]="true"></textarea>
 
+  <ng-container *ngIf="linting$ !== null">
+    <ksi-spinner [source]="linting$"></ksi-spinner>
+  </ng-container>
+  <ng-container *ngIf="(linting$ | async) as lintReport">
+    <div *ngIf="!lintReport.problems.length; else lintProblems" class="alert alert-success lint-result">
+      {{'tasks.module.programming.lint.no-problems-found'|translate}}
+    </div>
+    <ng-template #lintProblems>
+      <div class="alert alert-warning lint-result">
+        <div class="problems">
+          {{'tasks.module.programming.lint.problems-found'|translate:{count: lintReport.problems.length} }}
+        </div>
+        <div>
+          <a
+            class="btn btn-ksi w-100"
+            [href]="lintReport.editorUrl"
+            target="_blank"
+            [tooltip]="'tasks.module.programming.lint.tooltip'|translate"
+          >
+            {{'tasks.module.programming.lint.text'|translate}}
+          </a>
+        </div>
+      </div>
+    </ng-template>
+  </ng-container>
+
   <ng-container *ngIf="user.isOrg$ | async">
     <h6 class="report-heading">{{'tasks.module.report'|translate}}</h6>
     <textarea class="area-code-output" [value]="result.report || ''" [readOnly]="true"></textarea>

src/app/components/tasks/task-module/task-module-programming/task-module-programming.component.scss

@@ -19,4 +19,12 @@
   .report-heading {
     margin-top: $ksi-margin;
   }
+
+  .lint-result {
+    text-align: center;
+
+    .problems {
+      padding-bottom: $ksi-margin-small;
+    }
+  }
 }

src/app/components/tasks/task-module/task-module-programming/task-module-programming.component.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/ban-ts-comment */
 import {
   Component,
   OnInit,
@@ -17,10 +18,12 @@ import { FormControl } from '@angular/forms';
 // @ts-ignore
 import * as CodeMirror from '../../../../../../node_modules/codemirror/lib/codemirror';
 import '../../../../../../node_modules/codemirror/mode/python/python';
-import { BehaviorSubject, Observable, Subscription } from 'rxjs';
+import { Observable, Subscription } from 'rxjs';
 import { EdulintService, ModalService, ModuleService, UserService } from '../../../../services';
-import { mapTo, tap } from 'rxjs/operators';
+import { distinct, mapTo, shareReplay, tap } from 'rxjs/operators';
+import { EdulintReport } from '../../../../models';
 
+// noinspection JSUnresolvedReference
 @Component({
   selector: 'ksi-task-module-programming',
   templateUrl: './task-module-programming.component.html',
@@ -46,9 +49,7 @@ export class TaskModuleProgrammingComponent implements OnInit, OnDestroy {
 
   submission$: Observable<void> | null = null;
   codeRun$: Observable<void> | null = null;
-
-  private readonly lintingSubject = new BehaviorSubject<boolean>(false);
-  readonly linting$ = this.lintingSubject.asObservable();
+  linting$: Observable<EdulintReport> | null = null;
 
   private subs: Subscription[] = [];
 
@@ -83,13 +84,18 @@ export class TaskModuleProgrammingComponent implements OnInit, OnDestroy {
 
     this.moduleService.hideSubmit(this.module);
     this.codeRunResult$ = this.moduleService.runCode(this.module, this.code.value).pipe(
-      tap(() => {
+      shareReplay(1),
+      tap((result) => {
         // Scroll stdout into view after run completed
         window.setTimeout(() => {
           if (this.runOutput && this.runOutput.nativeElement) {
             this.runOutput.nativeElement.scrollIntoView({behavior: 'smooth', block: 'start', inline: 'nearest'});
           }
         });
+
+        if (result.result === 'ok') {
+          this.lintCode();
+        }
       })
     );
     (this.codeRun$ = this.codeRunResult$.pipe(mapTo(undefined))).subscribe(() => {
@@ -166,6 +172,7 @@ export class TaskModuleProgrammingComponent implements OnInit, OnDestroy {
     });
     // map tab key to spaces
     editor.setOption('extraKeys', {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       Tab: function(cm: any) {
         const spaces = Array(cm.getOption('indentUnit') + 1).join(' ');
         cm.replaceSelection(spaces);
@@ -183,10 +190,8 @@ export class TaskModuleProgrammingComponent implements OnInit, OnDestroy {
   }
 
   lintCode(): void {
-    this.lintingSubject.next(true);
-    this.lint.getCodeEditorUrl(this.code.value).subscribe((url) => {
-      this.lintingSubject.next(false);
-      window.open(url, '_blank');
-    });
+    this.linting$ = null;
+    this.linting$ = this.lint.analyzeCode(this.code.value).pipe(distinct());
+    this.linting$.subscribe();
   }
 }

src/app/models/edulint.service.ts

@@ -0,0 +1,6 @@
+import { Problems } from '../../api/edulint';
+
+export interface EdulintReport {
+  problems: Problems,
+  editorUrl: string
+}

src/app/models/index.ts

@@ -12,3 +12,4 @@ export * from './backend.service';
 export * from './task';
 export * from './prediction';
 export * from './admin-task.service';
+export * from './edulint.service';

src/app/services/tasks/edulint.service.ts

@@ -2,24 +2,44 @@ import { Injectable } from '@angular/core';
 import { HttpClient } from '@angular/common/http';
 import { APIService, Configuration, WebService } from '../../../api/edulint';
 import { environment } from '../../../environments/environment';
-import { Observable } from 'rxjs';
-import { map } from 'rxjs/operators';
+import { combineLatest, Observable, of } from 'rxjs';
+import { filter, map, mergeMap } from 'rxjs/operators';
+import { EdulintReport } from '../../models';
 
 @Injectable({
   providedIn: 'root'
 })
 export class EdulintService {
   readonly linter: APIService;
   readonly editor: WebService;
+  readonly version: string;
+  readonly url: string;
+  readonly config: string;
 
   constructor(private httpClient: HttpClient) {
-    this.linter = new APIService(this.httpClient, environment.edulint, new Configuration());
-    this.editor = new WebService(this.httpClient, environment.edulint, new Configuration());
+    const config = environment.edulint;
+    if (config === undefined) {
+      throw new Error('EduLint environment is undefined');
+    }
+    this.version = config.version;
+    this.url = config.url;
+    this.config = config.config;
+
+    this.linter = new APIService(this.httpClient, this.url, new Configuration());
+    this.editor = new WebService(this.httpClient, this.url, new Configuration());
   }
 
-  getCodeEditorUrl(code: string): Observable<string> {
+  analyzeCode(code: string): Observable<EdulintReport> {
+    code += `\n# edulint: config=${this.config}\n`;
+
     return this.linter.apiCodePost({code}).pipe(
-      map((response) => `${environment.edulint}editor/${response.hash}`)
+      filter((response) => response.hash !== undefined),
+      map(response => `${response.hash}`),
+      mergeMap((hash) => combineLatest([this.linter.analyzeUploaded(this.version, hash), of(hash)])),
+      map(([problems, hash]) => ({
+        problems,
+        editorUrl:  `${this.url}/editor/${hash}`
+      }))
     );
   }
 }

src/assets/edulint/ksi.toml

@@ -0,0 +1,121 @@
+[pylint]
+enable = [
+    "use-augmenting-assignment",
+    "redefined-builtin",
+    "use-foreach",
+    "simplifiable-if-return",
+    "simplifiable-if-nested",
+    "unused-argument",
+    "use-for-loop",
+    "duplicate-if-branches",
+    "redefined-outer-name",
+    "no-is-bool",
+    "redundant-arithmetic",
+    "unreachable",
+    "duplicate-value",
+    "use-literal-letter",
+    "use-ord-letter",
+    "simplifiable-if-expr",
+    "simplifiable-if-pass",
+    "modifying-iterated-structure",
+    "no-loop-else",
+    "use-integral-division",
+    "redefined-argument-from-local",
+    "pointless-statement",
+    "simplifiable-if-assignment",
+    "attribute-defined-outside-init",
+    "loop-shadows-control-variable",
+    "changing-control-variable",
+    "self-assigning-variable",
+    "dangerous-default-value",
+    "unnecessary-dunder-call",
+    "unnecessary-dict-index-lookup",
+    "unidiomatic-typecheck",
+    "comparison-of-constants",
+    "comparison-with-itself",
+    "remove-for",
+    "simplifiable-condition",
+    "condition-evals-to-constant",
+    "unreachable-else",
+    "non-ascii-name",
+    "no-self-argument",
+    "comparison-with-callable",
+    "for-target-subscript",
+    "function-redefined",
+    "missing-parentheses-for-call-in-test",
+    "method-hidden",
+    "duplicate-key",
+]
+
+
+[flake8]
+select = [
+    "E501", # line too long (82 > 79 characters)
+    "F841", # local variable name is assigned to but never used
+    "E999", # Syntax error
+    "F821", # undefined name name
+    "E112", # expected an indented block
+    "E712", # comparison to True should be ‘if cond is True:’ or ‘if cond:’
+    "E711", # comparison to None should be ‘if cond is None:’
+    "E701", # multiple statements on one line (colon)
+    "E101", # indentation contains mixed spaces and tabs
+    "E113", # unexpected indentation
+    "E713", # test for membership should be ‘not in’
+    "E902", # IOError
+    "W605", # invalid escape sequence ‘x’
+    "F811", # redefinition of unused name from line N
+    "E131", # continuation line unaligned for hanging indent
+    "F541", # f-string without any placeholders
+    "F601", # dictionary key name repeated with different values
+    "F632", # use ==/!= to compare str, bytes, and int literals
+    "F823", # local variable name … referenced before assignment
+    "E702", # multiple statements on one line (semicolon)
+    "E714", # test for object identity should be ‘is not’
+    "E721", # do not compare types, use ‘isinstance()’
+    "E742", # do not define classes named ‘l’, ‘O’, or ‘I’
+    "E743", # do not define functions named ‘l’, ‘O’, or ‘I’
+    "E901", # SyntaxError or IndentationError
+    "F402", # import module from line N shadowed by loop variable
+    "F404", # future import(s) name after other statements
+    "F406", # ‘from module import *’ only allowed at module level
+    "F407", # an undefined __future__ feature name was imported
+    "F501", # invalid % format literal
+    "F502", # % format expected mapping but got sequence
+    "F503", # % format expected sequence but got mapping
+    "F504", # % format unused named arguments
+    "F505", # % format missing named arguments
+    "F506", # % format mixed positional and named arguments
+    "F507", # % format mismatch of placeholder and argument count
+    "F508", # % format with * specifier requires a sequence
+    "F509", # % format with unsupported format character
+    "F521", # .format(...) invalid format string
+    "F522", # .format(...) unused named arguments
+    "F523", # .format(...) unused positional arguments
+    "F524", # .format(...) missing argument
+    "F525", # .format(...) mixing automatic and manual numbering
+    "F602", # dictionary key variable name repeated with different values
+    "F621", # too many expressions in an assignment with star-unpacking
+    "F622", # two or more starred expressions in an assignment (a, *b, *c = d)
+    "F631", # assertion test is a tuple, which is always True
+    "F633", # use of >> is invalid with print function
+    "F634", # if test is a tuple, which is always True
+    "F701", # a break statement outside of a while or for loop
+    "F702", # a continue statement outside of a while or for loop
+    "F703", # a continue statement in a finally block in a loop
+    "F704", # a yield or yield from statement outside of a function
+    "F705", # a return statement with arguments inside a generator
+    "F706", # a return statement outside of a function/method
+    "F707", # an except: block as not the last exception handler
+    "F721", # syntax error in doctest
+    "F722", # syntax error in forward annotation
+    "F723", # syntax error in type comment
+    "F822", # undefined name name in __all__
+    "F831", # duplicate argument name in function definition
+    "F901", # raise NotImplemented should be raise NotImplementedError
+    "W601", # .has_key() is deprecated, use ‘in’
+    "W602", # deprecated form of raising exception
+    "W603", # ‘<>’ is deprecated, use ‘!=’
+    "W604", # backticks are deprecated, use ‘repr()’
+    "W606", # ‘async’ and ‘await’ are reserved keywords starting with Python 3.7
+]
+max-line-length = "200"

src/assets/i18n/cs.json

@@ -204,7 +204,9 @@
         "reset-confirm": "Tato akce smaže všechny tvoje úpravy. Vážně ji chceš provést?",
         "lint": {
           "text": "Zkontrolovat kvalitu kódu pomocí EduLintu",
-          "tooltip": "Dojde k přesměřování na externí službu EduLint"
+          "tooltip": "Dojde k přesměřování na externí službu EduLint",
+          "problems-found": "Tvůj kód vypadá, že by se dal ještě vylepšit. EduLint našel {{count}} zlepšení.",
+          "no-problems-found": "Skvělá práce! EduLint nenašel v tvém kódu žádná další zlepšení."
         }
       },
       "general": {

src/environments/environment.kleobis.ts

@@ -8,7 +8,11 @@ export const environment: Environment = {
   production: true,
   disableRegistration: false,
   backend: 'https://rest.ksi.fi.muni.cz/',
-  edulint: 'https://edulint.rechtackova.cz/',
+  edulint: {
+    url: 'https://edulint.com',
+    version: '2.10.2',
+    config: 'https://ksi.fi.muni.cz/assets/edulint/ksi.toml'
+  },
   urlPrefix: '/',
   logger: {
     log: console.log,

src/environments/environment.kyzikos.ts

@@ -7,7 +7,11 @@ import { Environment } from './model';
 export const environment: Environment = {
   production: true,
   backend: 'https://kyzikos.fi.muni.cz:3000/',
-  edulint: 'https://edulint.rechtackova.cz/',
+  edulint: {
+    url: 'https://edulint.com',
+    version: '2.10.2',
+    config: 'default'
+  },
   urlPrefix: '/',
   logger: {
     log: console.log,