Integration with JabRef online

.devcontainer/devcontainer.json

@@ -21,7 +21,7 @@
         }
     },
 
-    "onCreateCommand": "gradle assemble",
+    "onCreateCommand": "gradle assemble || true",
 
     // Need to connect as root otherwise we run into issues with gradle.
     // default option is "vscode". More info: https://aka.ms/vscode-remote/containers/non-root.

build.gradle

@@ -27,6 +27,8 @@ plugins {
     id 'project-report'
 
     id 'idea'
+    // JabRef Online GraphQL client integration
+    id 'com.apollographql.apollo3' version '3.7.0-SNAPSHOT'
 }
 
 // Enable following for debugging
@@ -81,6 +83,7 @@ repositories {
     mavenLocal()
     mavenCentral()
     maven { url 'https://oss.sonatype.org/content/groups/public' }
+    maven { url 'https://s01.oss.sonatype.org/content/repositories/snapshots/' }
     maven { url 'https://jitpack.io' }
 }
 
@@ -204,6 +207,9 @@ dependencies {
 
     implementation group: 'net.harawata', name: 'appdirs', version: '1.2.1'
 
+    implementation group: 'com.apollographql.apollo3', name: 'apollo-runtime-java', version: '3.7.0-SNAPSHOT'
+    implementation group: 'com.apollographql.apollo3', name: 'apollo-rx3-support-java', version: '3.7.0-SNAPSHOT'
+
     testImplementation 'io.github.classgraph:classgraph:4.8.149'
     testImplementation 'org.junit.jupiter:junit-jupiter:5.9.1'
     testImplementation 'org.junit.platform:junit-platform-launcher:1.9.1'
@@ -217,6 +223,11 @@ dependencies {
     testImplementation "org.testfx:testfx-junit5:4.0.16-alpha"
     testImplementation "org.hamcrest:hamcrest-library:2.2"
 
+    testImplementation 'io.github.origin-energy:java-snapshot-testing-junit5:3.2.+'
+    testImplementation 'io.github.origin-energy:java-snapshot-testing-plugin-jackson:3.2.+'
+    testImplementation 'com.fasterxml.jackson.core:jackson-core:2.11.3'
+    testImplementation 'com.fasterxml.jackson.core:jackson-databind:2.11.3'
+
     checkstyle 'com.puppycrawl.tools:checkstyle:10.3.4'
     // xjc needs the runtime as well for the ant task, otherwise it fails
     xjc group: 'org.glassfish.jaxb', name: 'jaxb-xjc', version: '3.0.2'
@@ -264,7 +275,8 @@ task generateSource(dependsOn: ["generateBstGrammarSource",
                                 "generateBibtexmlSource",
                                 "generateEndnoteSource",
                                 "generateModsSource",
-                                "generateCitaviSource"]) {
+                                "generateCitaviSource",
+                                "generateApolloSources"]) {
     group = 'JabRef'
     description 'Generates all necessary (Java) source files.'
 }
@@ -349,6 +361,24 @@ task generateJournalAbbreviationList(type: JournalAbbreviationConverter) {
     outputDir = file("src/main/resources/journals")
 }
 
+apollo {
+  packageName = "org.jabref.jabrefonline"
+  schemaFile = file("src-gen/main/java/org/jabref/jabrefonline/graphql/schema.json")
+  mapScalar("DateTime", "java.time.ZonedDateTime", "org.jabref.logic.jabrefonline.JavaZonedDateTimeAdapter.INSTANCE")
+  generateModelBuilder = true
+  introspection {
+    endpointUrl = "https://mango-pebble-0224c3803-dev.westeurope.1.azurestaticapps.net/api"
+  }
+}
+
+tasks.whenTaskAdded { task ->
+    // Download schema before trying to generate apollo sources
+    if (task.name.contains("generateServiceApolloSources")) {
+        task.dependsOn 'downloadServiceApolloSchemaFromIntrospection'
+    }
+}
+
+
 tasks.withType(JavaCompile) {
     options.encoding = 'UTF-8'
 }

buildSrc/src/main/groovy/org/jabref/build/xjc/XjcTask.groovy

@@ -49,7 +49,7 @@ class XjcTask extends DefaultTask {
         if (outputDirectory == null) {
             return null
         }
-        return project.file(outputDirectory)
+        return project.file(outputDirectory + "/" + javaPackage.replace(".", "/"))
     }
 
     void setOutputDirectory(Object outputDirectory) {

settings.gradle

@@ -3,6 +3,9 @@ pluginManagement {
         maven {
             url 'https://oss.sonatype.org/content/repositories/snapshots'
         }
+        maven {
+            url 'https://s01.oss.sonatype.org/content/repositories/snapshots/'
+        }
         gradlePluginPortal()
     }
 }

src/main/graphql/Login.graphql

@@ -0,0 +1,15 @@
+mutation Login($input: LoginInput!) {
+    login(input: $input) {
+        ... on UserReturned {
+            user {
+            id
+            }
+        }
+        ... on InputValidationProblem {
+            problems {
+            path
+            message
+            }
+        }
+    }
+}

src/main/graphql/UserChanges.graphql

@@ -0,0 +1,88 @@
+fragment allDetails on Entity {
+    ... on Person {
+        id
+        family
+        given
+        suffix
+        nonDroppingParticle
+        droppingParticle
+    }
+    ... on Organization {
+        id
+        name
+    }
+}
+
+query UserChanges($id: ID!) {
+    user(id: $id) {
+        id
+        changes {
+            edges {
+                node {
+                    id
+                    citationKeys
+                    lastModified
+                    added
+                    title
+                    subtitle
+                    titleAddon
+                    abstract
+                    authors {
+                        ...allDetails
+                    }
+                    note
+                    languages
+                    publicationState
+                    doi
+                    keywords
+                    ... on JournalArticle {
+                        in {
+                            id
+                            journal {
+                                id
+                                name
+                                subtitle
+                                titleAddon
+                                issn
+                            }
+                            title
+                            subtitle
+                            titleAddon
+                            number
+                            name
+                            series
+                            volume
+                        }
+                        pageStart
+                        pageEnd
+                        electronicId
+                        translated {
+                            translators {
+                                ...allDetails
+                            }
+                            originalLanguages
+                        }
+                        published
+                        annotators {
+                            ...allDetails
+                        }
+                        commentators {
+                            ...allDetails
+                        }
+                    }
+                }
+                revision {
+                    generation
+                    hash
+                }
+            }
+             pageInfo {
+                hasNextPage
+                endCursor {
+                    id
+                    lastModified
+                }
+             }
+        }
+    }
+}

src/main/graphql/addUserDocument.graphql

@@ -0,0 +1,5 @@
+mutation addUserDocument($addUserDocumentInput: AddUserDocumentInput!) {
+  addUserDocument(input: $addUserDocumentInput) {
+    id
+  }
+}

src/main/graphql/getDocumentById.graphql

@@ -0,0 +1,27 @@
+query getDocumentById($userDocumentId: ID!) {
+	userDocument(id: $userDocumentId){
+  id
+  citationKeys
+  lastModified
+  added
+  title
+  subtitle
+  titleAddon
+  abstract
+  authors {
+    ... on Person {
+      family
+      id
+    }
+    ... on Organization {
+      id
+      name
+    }
+  }
+  note
+  languages
+  publicationState
+  keywords
+
+}
+}

src/main/java/module-info.java

@@ -115,6 +115,13 @@
     requires com.fasterxml.jackson.datatype.jsr310;
     requires net.harawata.appdirs;
 
+    requires com.apollographql.apollo3.api;
+    requires com.apollographql.apollo3.runtime.java;
+    requires com.apollographql.apollo3.rx3.java;
+    // TOOD: Remove this dependency once apollo is fully migrated
+    requires kotlin.stdlib;
+    requires io.reactivex.rxjava3;
+
     requires org.eclipse.jgit;
     uses org.eclipse.jgit.transport.SshSessionFactory;
     uses org.eclipse.jgit.lib.GpgSigner;

src/main/java/org/jabref/gui/DefaultInjector.java

@@ -8,6 +8,7 @@
 import org.jabref.gui.theme.ThemeManager;
 import org.jabref.gui.util.TaskExecutor;
 import org.jabref.logic.importer.ImportFormatReader;
+import org.jabref.logic.jabrefonline.RemoteService;
 import org.jabref.logic.journals.JournalAbbreviationRepository;
 import org.jabref.logic.protectedterms.ProtectedTermsLoader;
 import org.jabref.model.entry.BibEntryTypesManager;
@@ -35,6 +36,8 @@ private static Object createDependency(Class<?> clazz) {
             return Globals.TASK_EXECUTOR;
         } else if (clazz == PreferencesService.class) {
             return Globals.prefs;
+        } else if (clazz == RemoteService.class) {
+            return new RemoteService(Globals.prefs);
         } else if (clazz == KeyBindingRepository.class) {
             return Globals.getKeyPrefs();
         } else if (clazz == JournalAbbreviationRepository.class) {

src/main/java/org/jabref/gui/libraryproperties/general/GeneralProperties.fxml

@@ -28,6 +28,8 @@
             <RowConstraints/>
             <RowConstraints/>
             <RowConstraints/>
+            <RowConstraints/>
+            <RowConstraints/>
         </rowConstraints>
 
         <Label styleClass="sectionHeader" text="%General"
@@ -41,15 +43,19 @@
         <ComboBox fx:id="databaseMode" prefWidth="150.0"
                   GridPane.columnIndex="1" GridPane.hgrow="ALWAYS" GridPane.rowIndex="2"/>
 
-        <Label styleClass="sectionHeader" text="%Override default file directories"
+        <Label styleClass="sectionHeader" text="%JabRef Account"
                GridPane.columnSpan="3" GridPane.rowIndex="3"/>
+        <Button onAction="#connectJabRefAccount" text="%Connect" GridPane.columnIndex="1" GridPane.rowIndex="4"/>
+
+        <Label styleClass="sectionHeader" text="%Override default file directories"
+               GridPane.columnSpan="3" GridPane.rowIndex="5"/>
         <Label text="%General file directory"
-               GridPane.columnIndex="0" GridPane.rowIndex="4"/>
+               GridPane.columnIndex="0" GridPane.rowIndex="6"/>
         <TextField fx:id="generalFileDirectory"
-                   GridPane.columnIndex="1" GridPane.rowIndex="4"/>
+                   GridPane.columnIndex="1" GridPane.rowIndex="6"/>
         <Button onAction="#browseGeneralFileDirectory"
                 styleClass="icon-button,narrow" prefHeight="20.0" prefWidth="20.0"
-                GridPane.columnIndex="2" GridPane.rowIndex="4">
+                GridPane.columnIndex="2" GridPane.rowIndex="6">
             <graphic>
                 <JabRefIconView glyph="OPEN"/>
             </graphic>
@@ -59,12 +65,12 @@
         </Button>
 
         <Label text="%User-specific file directory"
-               GridPane.columnIndex="0" GridPane.rowIndex="5"/>
+               GridPane.columnIndex="0" GridPane.rowIndex="7"/>
         <TextField fx:id="userSpecificFileDirectory"
-                   GridPane.columnIndex="1" GridPane.rowIndex="5"/>
+                   GridPane.columnIndex="1" GridPane.rowIndex="7"/>
         <Button onAction="#browseUserSpecificFileDirectory"
                 styleClass="icon-button,narrow" prefHeight="20.0" prefWidth="20.0"
-                GridPane.columnIndex="2" GridPane.rowIndex="5">
+                GridPane.columnIndex="2" GridPane.rowIndex="7">
             <graphic>
                 <JabRefIconView glyph="OPEN"/>
             </graphic>
@@ -74,12 +80,12 @@
         </Button>
 
         <Label text="%LaTeX file directory"
-               GridPane.columnIndex="0" GridPane.rowIndex="6"/>
+               GridPane.columnIndex="0" GridPane.rowIndex="8"/>
         <TextField fx:id="laTexFileDirectory"
-                   GridPane.columnIndex="1" GridPane.rowIndex="6"/>
+                   GridPane.columnIndex="1" GridPane.rowIndex="8"/>
         <Button onAction="#browseLatexFileDirectory"
                 styleClass="icon-button,narrow" prefHeight="20.0" prefWidth="20.0"
-                GridPane.columnIndex="2" GridPane.rowIndex="6">
+                GridPane.columnIndex="2" GridPane.rowIndex="8">
             <graphic>
                 <JabRefIconView glyph="OPEN"/>
             </graphic>

src/main/java/org/jabref/gui/libraryproperties/general/GeneralPropertiesView.java

@@ -12,6 +12,7 @@
 import org.jabref.gui.libraryproperties.AbstractPropertiesTabView;
 import org.jabref.gui.libraryproperties.PropertiesTab;
 import org.jabref.gui.util.ViewModelListCellFactory;
+import org.jabref.logic.jabrefonline.RemoteService;
 import org.jabref.logic.l10n.Localization;
 import org.jabref.model.database.BibDatabaseContext;
 import org.jabref.model.database.BibDatabaseMode;
@@ -30,6 +31,7 @@ public class GeneralPropertiesView extends AbstractPropertiesTabView<GeneralProp
 
     @Inject private PreferencesService preferencesService;
     @Inject private UndoManager undoManager;
+    @Inject private RemoteService remoteService;
 
     public GeneralPropertiesView(BibDatabaseContext databaseContext) {
         this.databaseContext = databaseContext;
@@ -45,7 +47,7 @@ public String getTabName() {
     }
 
     public void initialize() {
-        this.viewModel = new GeneralPropertiesViewModel(databaseContext, dialogService, preferencesService, undoManager);
+        this.viewModel = new GeneralPropertiesViewModel(databaseContext, dialogService, preferencesService, remoteService, undoManager);
 
         new ViewModelListCellFactory<Charset>()
                 .withText(Charset::displayName)
@@ -81,4 +83,9 @@ public void browseUserSpecificFileDirectory() {
     void browseLatexFileDirectory() {
         viewModel.browseLatexDir();
     }
+
+    @FXML
+    void connectJabRefAccount() {
+        viewModel.connectJabRefAccount();
+    }
 }