Implement remote storage sync #642

koppor · 2023-04-22T06:19:38Z

Follow-up to JabRef#9748. While JabRef#9748 is for a plain http server, this one implements the JabRef sync to an online service. Details on sync at https://github.com/koppor/jabref/blob/sync-mwe/docs/code-howtos/remote-storage-jabdrive.md.

This is WIP. Missing at least

new data structure at update test
Add checksum from server in code
Add checksum from server to docs (meaning detailing https://github.com/koppor/jabref/blob/sync-mwe/docs/code-howtos/remote-storage-jabdrive.md)
Implement sync ^^

Compulsory checks

Give feedback

Change in CHANGELOG.md described in a way that is understandable for the average user (if applicable)
Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
Screenshots added in PR description (for UI changes)
Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.
Options

- Resources - /libraries - /libraries/{id} (both (embedded) BibTeX as string and CSL data) - Documentation / code style - Refined BibEntry class (JavaDoc, builder) - Comments to InternalField - move StyleTester to "test" module - package ...testutils/interactive... - Makes use of Jersey, Grizzly - Makes use of HK2 as dependency injection framework - Introduces "application/x-bibtex-library-csl+json" mimetype - Preparation for client/server sync (BibEntryDTO) - Minor - Made class "JabRefItemDataProvider" more visible - Encoding of a .bib file can now be asked for externally - Resorts modle-info.java - Fixes typo in NetworkTabViewModel - Installs SLF4J logging router: If a tool uses java commons logging, tinylog now also handles these logs

# Conflicts: # src/main/java/module-info.java

github-actions · 2023-04-22T06:21:22Z

src/test/java/org/jabref/testutils/interactive/http/rest-api.http

+
+[
+  {
+	"sharingMetadata": {


🚫 [reviewdog] <com.puppycrawl.tools.checkstyle.checks.whitespace.FileTabCharacterCheck> _{reported by reviewdog 🐶}
File contains tab characters (this is the first instance).

github-actions · 2023-04-22T06:21:22Z

src/test/java/org/jabref/http/server/ServerTest.java

+
+import org.jabref.http.dto.GsonFactory;
+import org.jabref.logic.bibtex.FieldContentFormatterPreferences;
+import org.jabref.logic.bibtex.FieldWriterPreferences;


🚫 [reviewdog] <com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck> _{reported by reviewdog 🐶}
Unused import - org.jabref.logic.bibtex.FieldWriterPreferences.

github-actions · 2023-04-22T06:21:22Z

src/test/java/org/jabref/http/sync/state/SyncStateTest.java

+import java.util.List;
+
+import org.jabref.model.entry.BibEntry;
+import org.jabref.http.dto.BibEntryDTO;


🚫 [reviewdog] <com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck> _{reported by reviewdog 🐶}
Wrong order for 'org.jabref.http.dto.BibEntryDTO' import.

github-actions · 2023-04-22T06:21:22Z

src/main/java/org/jabref/http/server/Application.java

+import org.glassfish.hk2.api.ServiceLocator;
+import org.glassfish.hk2.utilities.ServiceLocatorUtilities;
+
+import io.swagger.v3.jaxrs2.Reader;


🚫 [reviewdog] <com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck> _{reported by reviewdog 🐶}
Extra separation in import group before 'io.swagger.v3.jaxrs2.Reader'

github-actions · 2023-04-22T06:21:23Z

src/main/java/org/jabref/http/server/Application.java

+import org.glassfish.hk2.api.ServiceLocator;
+import org.glassfish.hk2.utilities.ServiceLocatorUtilities;
+
+import io.swagger.v3.jaxrs2.Reader;


🚫 [reviewdog] <com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck> _{reported by reviewdog 🐶}
Wrong order for 'io.swagger.v3.jaxrs2.Reader' import.

github-actions · 2023-04-22T06:21:23Z

src/main/java/org/jabref/http/client/SyncClient.java

+import java.util.List;
+
+import org.jabref.model.database.BibDatabaseContext;
+import org.jabref.http.dto.BibEntryDTO;


🚫 [reviewdog] <com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck> _{reported by reviewdog 🐶}
Wrong order for 'org.jabref.http.dto.BibEntryDTO' import.

github-actions · 2023-04-22T06:21:23Z

src/main/java/org/jabref/http/sync/state/SyncState.java

+import java.util.Set;
+import java.util.stream.Collectors;
+
+import org.jabref.gui.Globals;


🚫 [reviewdog] <com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck> _{reported by reviewdog 🐶}
Unused import - org.jabref.gui.Globals.

github-actions · 2023-04-22T06:21:23Z

src/main/java/org/jabref/http/sync/state/SyncState.java

+import java.util.stream.Collectors;
+
+import org.jabref.gui.Globals;
+import org.jabref.http.server.ServerPreferences;


🚫 [reviewdog] <com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck> _{reported by reviewdog 🐶}
Unused import - org.jabref.http.server.ServerPreferences.

github-actions · 2023-04-22T06:21:24Z

src/main/java/org/jabref/http/sync/state/SyncState.java

+
+import org.jabref.gui.Globals;
+import org.jabref.http.server.ServerPreferences;
+import org.jabref.model.database.BibDatabaseMode;


🚫 [reviewdog] <com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck> _{reported by reviewdog 🐶}
Unused import - org.jabref.model.database.BibDatabaseMode.

github-actions · 2023-04-22T06:21:24Z

src/main/java/org/jabref/http/sync/state/SyncState.java

+import org.jabref.http.server.ServerPreferences;
+import org.jabref.model.database.BibDatabaseMode;
+import org.jabref.model.entry.BibEntry;
+import org.jabref.http.dto.BibEntryDTO;


🚫 [reviewdog] <com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck> _{reported by reviewdog 🐶}
Wrong order for 'org.jabref.http.dto.BibEntryDTO' import.

github-actions · 2023-04-22T12:27:01Z

src/test/java/org/jabref/architecture/MainArchitectureTest.java

@@ -7,6 +7,7 @@
 import com.tngtech.archunit.junit.ArchIgnore;
 import com.tngtech.archunit.junit.ArchTest;
 import com.tngtech.archunit.library.GeneralCodingRules;
+import org.jabref.http.sync.state.SyncState;


🚫 [reviewdog] <com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck> _{reported by reviewdog 🐶}
Wrong order for 'org.jabref.http.sync.state.SyncState' import.

github-actions · 2023-04-22T12:27:01Z

src/test/java/org/jabref/http/server/UpdatesResourceTest.java

+package org.jabref.http.server;
+
+import org.glassfish.jersey.server.ResourceConfig;
+import org.jabref.http.sync.state.SyncState;


🚫 [reviewdog] <com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck> _{reported by reviewdog 🐶}
Wrong order for 'org.jabref.http.sync.state.SyncState' import.

github-actions · 2023-04-22T12:27:01Z

src/test/java/org/jabref/http/server/UpdatesResourceTest.java

+import org.glassfish.jersey.server.ResourceConfig;
+import org.jabref.http.sync.state.SyncState;
+import org.jabref.model.entry.BibEntry;
+import org.junit.jupiter.api.BeforeEach;


🚫 [reviewdog] <com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck> _{reported by reviewdog 🐶}
'org.junit.jupiter.api.BeforeEach' should be separated from previous imports.

github-actions · 2023-04-22T12:27:02Z

src/test/java/org/jabref/http/dto/BibEntryDTOTest.java

+package org.jabref.http.dto;
+
+import com.google.gson.Gson;
+import org.jabref.gui.Globals;


🚫 [reviewdog] <com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck> _{reported by reviewdog 🐶}
Wrong order for 'org.jabref.gui.Globals' import.

github-actions · 2023-04-22T12:27:02Z

src/test/java/org/jabref/http/dto/BibEntryDTOTest.java

+import org.jabref.model.database.BibDatabaseMode;
+import org.jabref.model.entry.BibEntry;
+import org.jabref.model.entry.field.StandardField;
+import org.junit.jupiter.params.ParameterizedTest;


🚫 [reviewdog] <com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck> _{reported by reviewdog 🐶}
'org.junit.jupiter.params.ParameterizedTest' should be separated from previous imports.

github-actions · 2023-04-22T12:27:02Z

src/test/java/org/jabref/http/dto/BibEntryDTOTest.java

+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
+
+import java.util.stream.Stream;


🚫 [reviewdog] <com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck> _{reported by reviewdog 🐶}
Wrong order for 'java.util.stream.Stream' import.

github-actions · 2023-04-22T12:27:02Z

src/test/java/org/jabref/http/dto/BibEntryDTOTest.java

+
+import java.util.stream.Stream;
+
+import static org.junit.jupiter.api.Assertions.*;


🚫 [reviewdog] <com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck> _{reported by reviewdog 🐶}
Using the '.' form of import should be avoided - org.junit.jupiter.api.Assertions..

github-actions · 2023-04-22T12:27:02Z

src/main/java/org/jabref/model/entry/BibEntry.java

@@ -748,6 +748,16 @@ public void setChanged(boolean changed) {
        this.changed = changed;
    }

+
+    /**


🚫 [reviewdog] <com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyLineSeparatorCheck> _{reported by reviewdog 🐶}
'/*' has more than 1 empty lines before.

github-actions · 2023-04-22T12:27:03Z

src/main/java/org/jabref/http/server/Server.java

+
+import javafx.collections.ObservableList;
+
+import org.jabref.architecture.AllowedToUseStandardStreams;


🚫 [reviewdog] <com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck> _{reported by reviewdog 🐶}
Unused import - org.jabref.architecture.AllowedToUseStandardStreams.

github-actions · 2023-04-24T06:21:28Z

src/test/java/org/jabref/http/server/UpdatesResourceTest.java

+import org.jabref.model.entry.BibEntry;
+import org.jabref.model.metadata.MetaData;
+
+import org.junit.jupiter.api.BeforeEach;


🚫 [reviewdog] <com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck> _{reported by reviewdog 🐶}
Unused import - org.junit.jupiter.api.BeforeEach.

github-actions · 2023-04-24T06:21:28Z

src/test/java/org/jabref/http/server/UpdatesResourceTest.java

+
+    private final String path = "/li<axSXSXXSSSSAAbraries/" + TestBibFile.GENERAL_SERVER_TEST.id + "/updates";
+
+    BibDatabaseContext bibDatabaseContext = new BibDatabaseContext(new BibDatabase(), new MetaData());


🚫 [reviewdog] <com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck> _{reported by reviewdog 🐶}
Variable access definition in wrong order.

github-actions · 2023-04-24T06:21:28Z

src/test/java/org/jabref/http/sync/state/SyncStateTest.java

@@ -0,0 +1,42 @@
+package org.jabref.http.sync.state;
+
+import java.util.ArrayList;


🚫 [reviewdog] <com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck> _{reported by reviewdog 🐶}
Unused import - java.util.ArrayList.

github-actions · 2023-04-24T06:21:28Z

src/test/java/org/jabref/http/sync/state/SyncStateTest.java

+import java.util.ArrayList;
+import java.util.List;
+
+import org.jabref.gui.importer.ImportEntriesViewModel;


🚫 [reviewdog] <com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck> _{reported by reviewdog 🐶}
Unused import - org.jabref.gui.importer.ImportEntriesViewModel.

github-actions · 2023-04-24T06:21:28Z

src/main/java/org/jabref/http/sync/state/ChangesAndServerView.java

+
+import org.jabref.http.dto.BibEntryDTO;
+
+import java.util.List;


🚫 [reviewdog] <com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck> _{reported by reviewdog 🐶}
Wrong order for 'java.util.List' import.

github-actions · 2023-04-24T06:21:29Z

src/main/java/org/jabref/http/sync/state/HashInfo.java

+package org.jabref.http.sync.state;
+
+import com.google.common.base.Strings;
+import org.jabref.model.entry.BibEntry;


🚫 [reviewdog] <com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck> _{reported by reviewdog 🐶}
Wrong order for 'org.jabref.model.entry.BibEntry' import.

github-actions · 2023-04-24T06:21:29Z

src/main/java/org/jabref/http/sync/state/HashInfo.java

+import com.google.common.base.Strings;
+import org.jabref.model.entry.BibEntry;
+import org.jabref.model.entry.SharedBibEntryData;
+import org.jabref.model.strings.StringUtil;


🚫 [reviewdog] <com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck> _{reported by reviewdog 🐶}
Unused import - org.jabref.model.strings.StringUtil.

tobiasdiez · 2023-04-25T07:25:56Z

this one implements the JabRef sync to an online service.

What's the relation with JabRef#7832?

koppor added 8 commits April 9, 2023 01:09

Remove temporary code

37dd6b9

Fix checkstyle

8f05677

Create http-server.md with a how-to for the SSL certificate generation

057e982

Merge remote-tracking branch 'upstream/main' into min-http-api

0d5a695

# Conflicts: # src/main/java/module-info.java

Enables passing files to a test Server

be12664

Merge branch 'main' into min-http-api

817d77d

Add initial sync

c675fd7

github-actions bot reviewed Apr 22, 2023

View reviewed changes

koppor added 2 commits April 22, 2023 12:39

Fix ADR name

13e0623

Add "withChanged" to enable proper BibEntryDTOTest

f3e7c2d

github-actions bot reviewed Apr 22, 2023

View reviewed changes

koppor added 2 commits April 22, 2023 15:08

Fix test

f59e57f

WIP: Make SyncState library-aware

d7897d1

github-actions bot reviewed Apr 24, 2023

View reviewed changes

koppor force-pushed the main branch from 9799dc4 to d6a0e59 Compare October 27, 2023 01:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement remote storage sync #642

Implement remote storage sync #642

koppor commented Apr 22, 2023

Compulsory checks

github-actions bot Apr 22, 2023

github-actions bot Apr 22, 2023

github-actions bot Apr 22, 2023

github-actions bot Apr 22, 2023

github-actions bot Apr 22, 2023

github-actions bot Apr 22, 2023

github-actions bot Apr 22, 2023

github-actions bot Apr 22, 2023

github-actions bot Apr 22, 2023

github-actions bot Apr 22, 2023

github-actions bot Apr 22, 2023

github-actions bot Apr 22, 2023

github-actions bot Apr 22, 2023

github-actions bot Apr 22, 2023

github-actions bot Apr 22, 2023

github-actions bot Apr 22, 2023

github-actions bot Apr 22, 2023

github-actions bot Apr 22, 2023

github-actions bot Apr 22, 2023

github-actions bot Apr 24, 2023

github-actions bot Apr 24, 2023

github-actions bot Apr 24, 2023

github-actions bot Apr 24, 2023

github-actions bot Apr 24, 2023

github-actions bot Apr 24, 2023

github-actions bot Apr 24, 2023

tobiasdiez commented Apr 25, 2023


		import java.util.stream.Stream;

		import static org.junit.jupiter.api.Assertions.*;


		import javafx.collections.ObservableList;

		import org.jabref.architecture.AllowedToUseStandardStreams;


		private final String path = "/li<axSXSXXSSSSAAbraries/" + TestBibFile.GENERAL_SERVER_TEST.id + "/updates";

		BibDatabaseContext bibDatabaseContext = new BibDatabaseContext(new BibDatabase(), new MetaData());

		@@ -0,0 +1,42 @@
		package org.jabref.http.sync.state;

		import java.util.ArrayList;


		import org.jabref.http.dto.BibEntryDTO;

		import java.util.List;

Implement remote storage sync #642

Are you sure you want to change the base?

Implement remote storage sync #642

Conversation

koppor commented Apr 22, 2023

Compulsory checks

github-actions bot Apr 22, 2023

Choose a reason for hiding this comment

github-actions bot Apr 22, 2023

Choose a reason for hiding this comment

github-actions bot Apr 22, 2023

Choose a reason for hiding this comment

github-actions bot Apr 22, 2023

Choose a reason for hiding this comment

github-actions bot Apr 22, 2023

Choose a reason for hiding this comment

github-actions bot Apr 22, 2023

Choose a reason for hiding this comment

github-actions bot Apr 22, 2023

Choose a reason for hiding this comment

github-actions bot Apr 22, 2023

Choose a reason for hiding this comment

github-actions bot Apr 22, 2023

Choose a reason for hiding this comment

github-actions bot Apr 22, 2023

Choose a reason for hiding this comment

github-actions bot Apr 22, 2023

Choose a reason for hiding this comment

github-actions bot Apr 22, 2023

Choose a reason for hiding this comment

github-actions bot Apr 22, 2023

Choose a reason for hiding this comment

github-actions bot Apr 22, 2023

Choose a reason for hiding this comment

github-actions bot Apr 22, 2023

Choose a reason for hiding this comment

github-actions bot Apr 22, 2023

Choose a reason for hiding this comment

github-actions bot Apr 22, 2023

Choose a reason for hiding this comment

github-actions bot Apr 22, 2023

Choose a reason for hiding this comment

github-actions bot Apr 22, 2023

Choose a reason for hiding this comment

github-actions bot Apr 24, 2023

Choose a reason for hiding this comment

github-actions bot Apr 24, 2023

Choose a reason for hiding this comment

github-actions bot Apr 24, 2023

Choose a reason for hiding this comment

github-actions bot Apr 24, 2023

Choose a reason for hiding this comment

github-actions bot Apr 24, 2023

Choose a reason for hiding this comment

github-actions bot Apr 24, 2023

Choose a reason for hiding this comment

github-actions bot Apr 24, 2023

Choose a reason for hiding this comment

tobiasdiez commented Apr 25, 2023