Feature Request/Idea:Code optimization suggestions

[noobyu6]

Overview of the Feature Request

Some fields can be replaced by local variables
What kind of user is the feature intended for?
(Example users roles: API User, Curator, Depositor, Guest, Superuser, Sysadmin)

What inspired the request?

What existing behavior do you want changed?

Any brand new behavior do you want to add to Dataverse?

Any related open or closed issues to this feature request?

Hi,

I find that the private field cm at Line 20 in the file 'dataverse/src/main/java/edu/harvard/iq/dataverse/api/datadeposit/SWORDv2ContainerServlet.java' on the master branch is only assigned and used in the method init. Therefore, this field can be removed from the class, and become a local variable in the method init. This transformation will normally reduce memory usage and improve readability of your code.

 private ContainerManager cm; // line 20 this field can be replaced by local variable ​   public void init() throws ServletException {         super.init(); ​         // ContainerManager cm = containerManagerImpl;         this.cm = containerManagerImpl; ​         this.sm = statementManagerImpl;              this.api = new ContainerAPI(cm, this.sm, this.config);     }

Besides, there are other fields like this.I sorted them out and put them in the table below.I will be happy if this transformation is helpful.

Location	Field
edu.harvard.iq.dataverse.api.datadeposit.SWORDv2ContainerServlet	sm
edu.harvard.iq.dataverse.api.datadeposit.SWORDv2StatementServlet	sm
edu.harvard.iq.dataverse.Shib	emailAddress
edu.harvard.iq.dataverse.DataCiteMetadataTemplate	xmlMetadata
edu.harvard.iq.dataverse.search.IndexServiceBean	rootDataverseName
edu.harvard.iq.dataverse.DatasetPage	protocol
edu.harvard.iq.dataverse.DatasetPage	customFields
edu.harvard.iq.dataverse.DatasetPage	authority
edu.harvard.iq.dataverse.ingest.tabulardata.impl.plugins.csv.CSVFileReader	doubleMathContext
edu.harvard.iq.dataverse.DatasetServiceBean	xmlOutputFactory
edu.harvard.iq.dataverse.harvest.server.web.servlet.OAIServlet	repositoryConfiguration
edu.harvard.iq.dataverse.harvest.server.web.servlet.OAIServlet	setRepository
edu.harvard.iq.dataverse.harvest.server.web.servlet.OAIServlet	itemRepository
edu.harvard.iq.dataverse.dashboard.DashboardUsersPage	authUser
edu.harvard.iq.dataverse.ingest.tabulardata.impl.plugins.dta.NewDTAFileReader	constantTable
edu.harvard.iq.dataverse.ingest.tabulardata.impl.plugins.dta.NewDTAFileReader	dataLabelLength
edu.harvard.iq.dataverse.ingest.tabulardata.impl.plugins.dta.NewDTAFileReader	headerLength
edu.harvard.iq.dataverse.harvest.client.FastGetRecord	xmlInputFactory
edu.harvard.iq.dataverse.rserve.VariableNameCheckerForR	safeVarNames
edu.harvard.iq.dataverse.mydata.DataRetrieverAPI	rolePermissionHelper
edu.harvard.iq.dataverse.mydata.DataRetrieverAPI	roleList
edu.harvard.iq.dataverse.mydata.DataRetrieverAPI	myDataFinder
edu.harvard.iq.dataverse.search.SearchIncludeFragment	solrQueryResponseAllTypes
edu.harvard.iq.dataverse.ManagePermissionsPage	roleList
edu.harvard.iq.dataverse.mydata.MyDataFinder	userIdentifier
edu.harvard.iq.dataverse.ingest.tabulardata.impl.plugins.por.PORFileReader	caseQnty
edu.harvard.iq.dataverse.ingest.tabulardata.impl.plugins.sav.SAVFileReader	spssVersionNumber
edu.harvard.iq.dataverse.ingest.IngestableDataChecker	regex
edu.harvard.iq.dataverse.ingest.IngestableDataChecker	rdargx

[pdurbin]

@noobyu6 are you using a tool to find these? If so, which one, please?

[noobyu6]

@noobyu6 are you using a tool to find these? If so, which one, please?

I am a researcher from Fudan University and developing a tool working on this. And I hope my suggestion is helpful!

[noobyu6]

Hello? So, are my suggestions helpful to your project?

[pdurbin]

Well, sort of? 😄

We always appreciate feedback on our code and "continue to increase the quality of the software" is one of our strategic goals that we list at https://www.iq.harvard.edu/roadmap-dataverse-project

However, every time we change code we review and re-test it, so it's not "free" in terms of time to make changes. As far as I know, all the Java classes you mentioned are working fine.

I'm not sure what to suggest. Some possible avenues:

• Set up an automated code quality tool that will measure the "before" and "after" of the changes you're suggesting? (I assume the score would be higher or better after the changes.) SonarQube and SonarCloud are mentioned in Dev Guide should give more guidance on type safety, code quality, code style, etc. #3950.
• Make a pull request to update the "coding style" page in the dev guide to emphasize a preference for local variables whenever possible? The current version is here: https://guides.dataverse.org/en/5.11/developers/coding-style.html Dev Guide should give more guidance on type safety, code quality, code style, etc. #3950 is related.
• Make a pull request to add "TODO" comments (// TODO: move to local variable) in all the places you identified? That way we don't have to review or test the code immediately, but in the future when developers are working on those classes to fix a bug or add a feature, they can take the TODO into consideration.
• Make a pull request to change one of the places you identified? This fits in our "small chunk" model of development: https://guides.dataverse.org/en/5.11/developers/version-control.html#how-to-make-a-pull-request
• Make a pull request to change all the places you identified? This would involve a fair amount of review and testing. I personally wasn't a huge fan of the "lost of ugly code" changes (which took a while to review, test and merge) in PR 3902 fixing lots of ugly code #3904.

I'd love to hear more of your thoughts! And thoughts from other developers, of course. 😄 What's the best way to clean up a code base?

[noobyu6]

thanks for your reply, i have made a new pr

[pdurbin]

Head up that there's a new column called "SonarQube cleanup" at https://github.com/orgs/IQSS/projects/34/views/1

Related:

• In TabularSubsetGenerator.java use try-with-resources for BufferedWriter #9282
• In DataConverter.java use try-with-resources for convertedFileStream #9281
• In Files.java usr try-with-resources to for JsonReader #9280