[#167] Removal of unnecessary catch blocks #191

Eclipse-Dominator · 2023-06-13T13:55:04Z

Fixes #167

Alternative approach: #186 (Where functionality of the catch blocks is restored)

Following issue #167, all IOExceptions are already being handled within JsonUtil#readJsonFile(), therefore additional catch blocks as well as throwing of IOExceptions are no longer needed.

This PR moves handling of conversion errors as well as regular IOExceptions to within JsonUtil#readJsonFile(). As a result of this change, it is no longer appropriate to call the exception thrown DataConversionException.

Thus, the above-mentioned exception will be renamed to DataLoadingException. Affected interfaces and code caused by this change will then be updated.

canihasreview · 2023-06-13T13:55:07Z

Click here to submit a new iteration when this PR is ready for review.

See this repository's contribution guide for more information.

canihasreview · 2023-06-13T13:58:15Z

v1

@Eclipse-Dominator submitted v1 for review.

[v1 1/1] Removal of unnecessary catch blocks

(📚 Archive)

Checkout this PR version locally

git fetch https://github.com/se-edu/addressbook-level3.git refs/pr/191/1/head:BRANCHNAME

where BRANCHNAME is the name of the local branch you wish to fetch this PR to.

codecov · 2023-06-13T14:00:25Z

Codecov Report

Merging #191 (e00047a) into master (f0e9069) will increase coverage by 0.35%.
The diff coverage is 40.00%.

@@             Coverage Diff              @@
##             master     #191      +/-   ##
============================================
+ Coverage     72.06%   72.41%   +0.35%     
  Complexity      399      399              
============================================
  Files            70       70              
  Lines          1235     1229       -6     
  Branches        127      127              
============================================
  Hits            890      890              
+ Misses          314      308       -6     
  Partials         31       31

Impacted Files	Coverage Δ
src/main/java/seedu/address/MainApp.java	`0.00% <0.00%> (ø)`
...in/java/seedu/address/commons/util/ConfigUtil.java	`75.00% <ø> (ø)`
...va/seedu/address/storage/JsonUserPrefsStorage.java	`87.50% <ø> (ø)`
...ain/java/seedu/address/storage/StorageManager.java	`94.44% <ø> (ø)`
...dress/commons/exceptions/DataLoadingException.java	`100.00% <100.00%> (ø)`
...main/java/seedu/address/commons/util/JsonUtil.java	`94.11% <100.00%> (ø)`
.../seedu/address/storage/JsonAddressBookStorage.java	`100.00% <100.00%> (ø)`

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

damithc

Quick feedback: The renaming of the exception class deserves its own commit?

canihasreview · 2023-06-13T23:48:49Z

v2

@Eclipse-Dominator submitted v2 for review.

[v2 1/2] Removal of unnecessary catch blocks
[v2 2/2] Rename DataConversionException to ConfigLoadingException

(📚 Archive) (📈 Interdiff between v1 and v2) (📈 Range-Diff between v1 and v2)

Checkout this PR version locally

git fetch https://github.com/se-edu/addressbook-level3.git refs/pr/191/2/head:BRANCHNAME

where BRANCHNAME is the name of the local branch you wish to fetch this PR to.

damithc

Some suggestions added.

damithc · 2023-06-14T04:29:13Z

src/main/java/seedu/address/commons/exceptions/DataConversionException.java

@@ -1,7 +1,7 @@
 package seedu.address.commons.exceptions;

 /**
- * Represents an error during conversion of data from one format to another
+ * Represents an error during loading of files from the file system.


I think this belongs in the other commit, together with the name change.

Strictly speaking, the correct order is to tweak the exception first, and then remove the catch blocks. The latter is more justifiable after the exception has been tweaked.

src/main/java/seedu/address/commons/util/JsonUtil.java

damithc · 2023-06-14T04:38:02Z

src/main/java/seedu/address/commons/util/JsonUtil.java

     * @param filePath cannot be null.
     * @param classOfObjectToDeserialize Json file has to correspond to the structure in the class given here.
-     * @throws DataConversionException if the file format is not as expected.
+     * @throws DataConversionException if the loading of file failed


Not sure if loading of the file will be understood as both 'reading the file content and parsing the content'. Perhaps use loading of JSON data from the file?

For this version of PR, the handling of trying to read file content and parsing the content is both handled within JsonUtil so in a sense the new renamed exception represents both 'reading the file content and parsing the content'.

damithc · 2023-06-14T04:40:58Z

src/main/java/seedu/address/storage/JsonUserPrefsStorage.java

     * @param prefsFilePath location of the data. Cannot be null.
-     * @throws DataConversionException if the file format is not as expected.
+     * @throws DataConversionException if the loading of the preference file fails.


This is phrasing is slightly different from the one used in readAddressBook. Don't vary things unless there is a good reason.

damithc · 2023-06-14T04:41:22Z

src/main/java/seedu/address/storage/JsonAddressBookStorage.java

@@ -40,7 +40,7 @@ public Optional<ReadOnlyAddressBook> readAddressBook() throws DataConversionExce
     * Similar to {@link #readAddressBook()}.
     *
     * @param filePath location of the data. Cannot be null.
-     * @throws DataConversionException if the file is not in the correct format.
+     * @throws DataConversionException if the loading of the data fails.


fails -> failed?

damithc · 2023-06-14T04:44:32Z

src/test/java/seedu/address/commons/util/ConfigUtilTest.java

@@ -68,7 +68,8 @@ private Config getTypicalConfig() {
        return config;
    }

-    private Optional<Config> read(String configFileInTestDataFolder) throws DataConversionException {
+    private Optional<Config> read(String configFileInTestDataFolder)
+            throws DataConversionException {


This change is not needed?

damithc · 2023-06-14T04:45:07Z

src/test/java/seedu/address/storage/JsonAddressBookStorageTest.java

@@ -47,17 +47,20 @@ public void read_missingFile_emptyResult() throws Exception {

    @Test
    public void read_notJsonFormat_exceptionThrown() {
-        assertThrows(DataConversionException.class, () -> readAddressBook("notJsonFormatAddressBook.json"));
+        assertThrows(DataConversionException.class,
+                () -> readAddressBook("notJsonFormatAddressBook.json"));


Revert unrelated changes.

canihasreview · 2023-06-14T07:01:52Z

v3

@Eclipse-Dominator submitted v3 for review.

[v3 1/2] Rename DataConversoinException -> ConfigLoadingException
[v3 2/2] Removal of unnecessary catch blocks and exceptions

(📚 Archive) (📈 Interdiff between v2 and v3) (📈 Range-Diff between v2 and v3)

Checkout this PR version locally

git fetch https://github.com/se-edu/addressbook-level3.git refs/pr/191/3/head:BRANCHNAME

where BRANCHNAME is the name of the local branch you wish to fetch this PR to.

damithc

The first commit should be just the renaming. It is a mechanical change and requires minimal review. The only other thing that can be go into that commit is the tweaking of the javadoc comment of that class so that the comment matches the new class name.
Once that is out of the way, the next commit can focus on behavioral tweaks.

src/main/java/seedu/address/MainApp.java

src/main/java/seedu/address/commons/exceptions/ConfigLoadingException.java

src/main/java/seedu/address/storage/StorageManager.java

canihasreview · 2023-06-14T08:36:35Z

v4

@Eclipse-Dominator submitted v4 for review.

[v4 1/2] Rename DataConversoinException -> DataLoadingException
[v4 2/2] Removal of unnecessary catch blocks and exceptions

(📚 Archive) (📈 Interdiff between v3 and v4) (📈 Range-Diff between v3 and v4)

Checkout this PR version locally

git fetch https://github.com/se-edu/addressbook-level3.git refs/pr/191/4/head:BRANCHNAME

where BRANCHNAME is the name of the local branch you wish to fetch this PR to.

canihasreview · 2023-06-14T08:41:21Z

v5

@Eclipse-Dominator submitted v5 for review.

[v5 1/2] Rename DataConversionException -> DataLoadingException
[v5 2/2] Removal of unnecessary catch blocks and exceptions

(📚 Archive) (📈 Interdiff between v4 and v5) (📈 Range-Diff between v4 and v5)

Checkout this PR version locally

git fetch https://github.com/se-edu/addressbook-level3.git refs/pr/191/5/head:BRANCHNAME

where BRANCHNAME is the name of the local branch you wish to fetch this PR to.

damithc

Mostly OK. I suggest the following:

Commit 1: Remove everything else except those strictly related to renaming the exception. It should look almost like a mechanical find-and-replace refactoring.
Commit 2: commit message: No need to mention 'In the previous commit'. The previous commit speaks for itself. Here, mention that IOException is unnecessary and is removed, and logs/docs are adjusted accordingly.

DataConversionException is thrown to indicate any problem encountered while reading a JSON file, not just problems specific to data conversion. Let's rename it as DataLoadingException to make the name more representative of its purpose.

canihasreview · 2023-06-14T14:15:31Z

v6

@Eclipse-Dominator submitted v6 for review.

[v6 1/2] Rename DataConversionException -> DataLoadingException
[v6 2/2] Removal of unnecessary catch blocks and exceptions

(📚 Archive) (📈 Interdiff between v5 and v6) (📈 Range-Diff between v5 and v6)

Checkout this PR version locally

git fetch https://github.com/se-edu/addressbook-level3.git refs/pr/191/6/head:BRANCHNAME

where BRANCHNAME is the name of the local branch you wish to fetch this PR to.

damithc

Commit 1: Clean and easy to review. Nice!
Commit 2: Added a few cosmetic suggestions.

src/main/java/seedu/address/MainApp.java

src/main/java/seedu/address/storage/AddressBookStorage.java

src/main/java/seedu/address/MainApp.java

damithc · 2023-06-14T16:55:01Z

@Eclipse-Dominator Can you update the PR description to match the current state of the PR? After that, I'll ask others for reviews.

JsonUtil#readJsonFile() method throws a DataLoadingException when it detects an IOException. However, some client code of that method are written as if it throws an IOException. Let's, 1. remove 'throws IOExceptions' clause from the relevant client methods in Storage, AddressBookStorage, and UserPrefsStorage. 2. remove corresponding catch blocks. 3. tweak relevant javadocs and log message to match.

canihasreview · 2023-06-14T18:58:56Z

v7

@Eclipse-Dominator submitted v7 for review.

[v7 1/2] Rename DataConversionException -> DataLoadingException
[v7 2/2] Refactor client code handling IOException

(📚 Archive) (📈 Interdiff between v6 and v7) (📈 Range-Diff between v6 and v7)

Checkout this PR version locally

git fetch https://github.com/se-edu/addressbook-level3.git refs/pr/191/7/head:BRANCHNAME

where BRANCHNAME is the name of the local branch you wish to fetch this PR to.

damithc · 2023-06-15T15:51:33Z

@se-edu/tech-team-level1 for your review ...

SPWwj

LGTM! Now, the MainApp.java has become more streamlined, and the exceptions are more specific. Excellent work!

damithc · 2023-06-26T12:57:40Z

Thanks @Eclipse-Dominator for the fix, and @SPWwj for the review.

Eclipse-Dominator mentioned this pull request Jun 13, 2023

[#167] Unnecessary catch block in MainApp and Exceptions in Interfaces #186

Closed

canihasreview bot added the s.ToReview label Jun 13, 2023

damithc reviewed Jun 13, 2023

View reviewed changes

Eclipse-Dominator force-pushed the removal-of-catch-block branch from 81c3cf7 to 04749db Compare June 13, 2023 23:48

Eclipse-Dominator changed the title ~~Removal of unnecessary catch blocks~~ [#167] Removal of unnecessary catch blocks Jun 14, 2023

damithc requested changes Jun 14, 2023

View reviewed changes

Eclipse-Dominator force-pushed the removal-of-catch-block branch 3 times, most recently from eaf1589 to 7839b9a Compare June 14, 2023 07:01

canihasreview bot requested a review from damithc June 14, 2023 07:01

damithc requested changes Jun 14, 2023

View reviewed changes

src/main/java/seedu/address/MainApp.java Show resolved Hide resolved

src/main/java/seedu/address/commons/exceptions/ConfigLoadingException.java Outdated Show resolved Hide resolved

damithc reviewed Jun 14, 2023

View reviewed changes

src/main/java/seedu/address/storage/StorageManager.java Outdated Show resolved Hide resolved

Eclipse-Dominator force-pushed the removal-of-catch-block branch from 7839b9a to 8609d5a Compare June 14, 2023 08:36

canihasreview bot requested a review from damithc June 14, 2023 08:36

Eclipse-Dominator force-pushed the removal-of-catch-block branch from 8609d5a to 15fd221 Compare June 14, 2023 08:38

damithc requested changes Jun 14, 2023

View reviewed changes

Eclipse-Dominator force-pushed the removal-of-catch-block branch from 15fd221 to f2f77c7 Compare June 14, 2023 14:10

Eclipse-Dominator force-pushed the removal-of-catch-block branch from f2f77c7 to 5ccd0d6 Compare June 14, 2023 14:12

canihasreview bot requested a review from damithc June 14, 2023 14:15

damithc reviewed Jun 14, 2023

View reviewed changes

src/main/java/seedu/address/MainApp.java Outdated Show resolved Hide resolved

src/main/java/seedu/address/storage/AddressBookStorage.java Outdated Show resolved Hide resolved

src/main/java/seedu/address/MainApp.java Show resolved Hide resolved

Eclipse-Dominator force-pushed the removal-of-catch-block branch from 5ccd0d6 to c5e45e8 Compare June 14, 2023 18:56

Eclipse-Dominator force-pushed the removal-of-catch-block branch from c5e45e8 to e00047a Compare June 14, 2023 18:58

canihasreview bot requested a review from damithc June 14, 2023 18:58

SPWwj approved these changes Jun 16, 2023

View reviewed changes

damithc merged commit 0a8d2fb into se-edu:master Jun 26, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[#167] Removal of unnecessary catch blocks #191

[#167] Removal of unnecessary catch blocks #191

Eclipse-Dominator commented Jun 13, 2023 •

edited

Loading

canihasreview bot commented Jun 13, 2023

canihasreview bot commented Jun 13, 2023

codecov bot commented Jun 13, 2023 •

edited

Loading

damithc left a comment

canihasreview bot commented Jun 13, 2023

damithc left a comment

damithc Jun 14, 2023

damithc Jun 14, 2023

damithc Jun 14, 2023

Eclipse-Dominator Jun 14, 2023

damithc Jun 14, 2023

damithc Jun 14, 2023

damithc Jun 14, 2023

damithc Jun 14, 2023

canihasreview bot commented Jun 14, 2023

damithc left a comment

canihasreview bot commented Jun 14, 2023

canihasreview bot commented Jun 14, 2023

damithc left a comment

canihasreview bot commented Jun 14, 2023

damithc left a comment

damithc commented Jun 14, 2023

canihasreview bot commented Jun 14, 2023

damithc commented Jun 15, 2023

SPWwj left a comment

damithc commented Jun 26, 2023

[#167] Removal of unnecessary catch blocks #191

[#167] Removal of unnecessary catch blocks #191

Conversation

Eclipse-Dominator commented Jun 13, 2023 • edited Loading

canihasreview bot commented Jun 13, 2023

canihasreview bot commented Jun 13, 2023

v1

codecov bot commented Jun 13, 2023 • edited Loading

Codecov Report

damithc left a comment

Choose a reason for hiding this comment

canihasreview bot commented Jun 13, 2023

v2

damithc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

canihasreview bot commented Jun 14, 2023

v3

damithc left a comment

Choose a reason for hiding this comment

canihasreview bot commented Jun 14, 2023

v4

canihasreview bot commented Jun 14, 2023

v5

damithc left a comment

Choose a reason for hiding this comment

canihasreview bot commented Jun 14, 2023

v6

damithc left a comment

Choose a reason for hiding this comment

damithc commented Jun 14, 2023

canihasreview bot commented Jun 14, 2023

v7

damithc commented Jun 15, 2023

SPWwj left a comment

Choose a reason for hiding this comment

damithc commented Jun 26, 2023

Eclipse-Dominator commented Jun 13, 2023 •

edited

Loading

codecov bot commented Jun 13, 2023 •

edited

Loading