Merge pull request #77 from CentreForDigitalHumanities/feature/parse-interface-ctd

Integration with parser backend

Author: jgonggrijp

.gitignore

@@ -37,3 +37,9 @@ venv.bak/
 node_modules/
 frontend/src/environments/version.ts
 *~
+
+# ProofBank datasets
+/backend/SICK.txt
+/backend/fracas.xml
+/backend/snli_1.0_dev.txt
+/backend/snli_1.0_test.txt

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "langpro-container"]
+	path = langpro-container
+	url = https://github.com/CentreForDigitalHumanities/langpro-container.git

CONTRIBUTING.md

@@ -4,7 +4,9 @@ This document contains basic documentation for developing LangPro Annotator.
 
 ## Before you start
 
-You need to install the following software, *unless* you will be using Docker:
+This repository has a submodule that requires [git-lfs][git-lfs]. It is recommended that you install git-lfs before cloning the repository to a local disk.
+
+You also need to install the following software, *unless* you will be using Docker:
 
  - PostgreSQL >= 10, client, server and C libraries
  - Python >= 3.8, <= 3.10
@@ -14,18 +16,33 @@ You need to install the following software, *unless* you will be using Docker:
  - Node.js >= 14.20.0
  - Yarn
 
+After cloning the repository, run the following commands once in order to obtain a local copy of [langpro-container][container] and its recursive submodule [LangPro][langpro]:
+
+``` sh
+git submodule init
+# customize clone URL in .git/config before proceeding (if needed)
+git submodule update --recursive
+```
+
+If you don't need to customize clone URLs, you can also do both steps at once with `git submodule update --init --recursive`.
+
 [1]: https://wiki.python.org/moin/WindowsCompilers
+[git-lfs]: https://git-lfs.com/
+[container]: https://github.com/CentreForDigitalHumanities/langpro-container
+[langpro]: https://github.com/kovvalsky/LangPro
 
 ## How it works
 
-This project integrates three isolated subprojects, each inside its own subdirectory with its own code, package dependencies and tests:
+This project integrates four isolated subprojects, each inside its own subdirectory with its own code, package dependencies and tests:
 
  - **backend**: the server side web application based on [Django][3] and [DRF][4]
 
  - **frontend**: the client side web application based on [Angular](https://angular.io)
 
  - **functional-tests**: the functional test suite based on [playwright][6] and [pytest][7]
 
+ - **langpro-container**: a git submodule that provides a backend for parsing and proving problems
+
 [3]: https://www.djangoproject.com
 [4]: https://www.django-rest-framework.org
 [6]: https://playwright.dev/python/docs/library

backend/langpro_annotator/settings.py

@@ -91,3 +91,5 @@
 
 STATICFILES_DIRS = []
 PROXY_FRONTEND = None
+
+LANGPRO_URL = os.environ.get('LANGPRO_CONTAINER') or 'http://localhost:8080'

backend/problem/views/parse.py

@@ -1,3 +1,5 @@
+import requests
+from django.conf import settings
 from dataclasses import dataclass, field, asdict
 
 from django.http import JsonResponse
@@ -65,19 +67,21 @@ def post(self, request: Request) -> JsonResponse:
     def send_to_parser(self, data: ParserInput) -> dict | None:
         """Send frontend data to downstream LangPro service."""
 
-        logger.info("Sending to LangPro service:", asdict(data))
+        logger.info(f"Sending to LangPro service: {asdict(data)}")
 
-        # try:
-        #     response = requests.post(
-        #         url=f"{LANGPRO_URL}/parse",
-        #         json=asdict(data),
-        #         headers={"Content-Type": "application/json"},
-        #     )
-        #     response.raise_for_status()
-        #     return response.json()
-        # except requests.RequestException as e:
-        #     logger.exception(f"Error sending request to LangPro: {e}")
-        #     return None
+        params = asdict(data)
+        # ask LangPro container to return results in a format suitable for
+        # this application
+        params['format'] = 'annotator'
 
-
-        return {"ok": "true"}
+        try:
+            response = requests.post(
+                url=f"{settings.LANGPRO_URL}/api/prove/",
+                json=params,
+                headers={"Content-Type": "application/json"},
+            )
+            response.raise_for_status()
+            return response.json()
+        except requests.RequestException as e:
+            logger.exception(f"Error sending request to LangPro: {e}")
+            raise

docker-compose.yml

@@ -1,3 +1,6 @@
+include:
+    - ./langpro-container/compose.yaml
+
 services:
     postgres:
         image: postgres:15
@@ -16,6 +19,7 @@ services:
             context: ./backend
         environment:
             PGHOST: postgres
+            LANGPRO_CONTAINER: 'http://langpro:80'
             LANGPRO_FRONTEND: 'http://frontend:4200'
         depends_on:
             postgres:

frontend/package.json

@@ -37,6 +37,7 @@
     "colors": "^1.4.0",
     "express": "^4.18.2",
     "rxjs": "~7.8.0",
+    "svg-pan-zoom": "bumbu/svg-pan-zoom",
     "tslib": "^2.3.0",
     "zone.js": "~0.15.1"
   },
@@ -57,4 +58,4 @@
     "ng-extract-i18n-merge": "^2.12.0",
     "typescript": "~5.8.3"
   }
-}
+}

frontend/src/app/annotate/annotation-input/annotation-input.component.ts

@@ -124,14 +124,6 @@ export class AnnotationInputComponent implements OnInit {
             });
             this.router.navigate(["/", "annotate", response.id]);
         });
-
-        // Subscription needed to ensure a request is actually made.
-        // TODO: replace this with actual parse results.
-        this.parseService.parse$
-            .pipe(takeUntilDestroyed(this.destroyRef))
-            .subscribe((response) => {
-                console.log("Parse response:", response);
-            });
     }
 
     public startParse(): void {

frontend/src/app/annotate/annotation-parse-results/annotation-parse-results.component.ts

@@ -1,5 +1,7 @@
-import { Component } from "@angular/core";
+import { Component, DestroyRef, inject, OnInit } from "@angular/core";
+import { takeUntilDestroyed } from "@angular/core/rxjs-interop";
 import { mockResult } from "./mockParseResult";
+import { ParseService } from "@/services/parse.service";
 import { ParseTreeTableComponent } from "./parse-tree-table/parse-tree-table.component";
 import { NgbAccordionModule } from "@ng-bootstrap/ng-bootstrap";
 
@@ -11,6 +13,19 @@ import { NgbAccordionModule } from "@ng-bootstrap/ng-bootstrap";
     templateUrl: "./annotation-parse-results.component.html",
     styleUrl: "./annotation-parse-results.component.scss",
 })
-export class AnnotationParseResultsComponent {
-    public readonly parseResults = mockResult;
+export class AnnotationParseResultsComponent implements OnInit {
+    private destroyRef = inject(DestroyRef);
+    private parseService = inject(ParseService);
+
+    public parseResults = mockResult;
+
+    ngOnInit(): void {
+        // Subscription needed to ensure a request is actually made.
+        this.parseService.parse$
+            .pipe(takeUntilDestroyed(this.destroyRef))
+            .subscribe((response) => {
+                console.log("Parse response:", response);
+                this.parseResults = response.data.ccg_trees;
+            });
+    }
 }