Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PRE REVIEW]: Simple-Web-Server: a fast and flexible HTTP/1.1 C++ client and server library #1579

Closed
whedon opened this issue Jul 18, 2019 · 35 comments

Comments

@whedon
Copy link

whedon commented Jul 18, 2019

Submitting author: @eidheim (Ole Christian Eidheim)
Repository: https://gitlab.com/eidheim/Simple-Web-Server
Version: v3.0
Editor: @gkthiruvathukal
Reviewers: @ts-adi

Author instructions

Thanks for submitting your paper to JOSS @eidheim. Currently, there isn't an JOSS editor assigned to your paper.

@eidheim if you have any suggestions for potential reviewers then please mention them here in this thread. In addition, this list of people have already agreed to review for JOSS and may be suitable for this submission.

Editor instructions

The JOSS submission bot @whedon is here to help you find and assign reviewers and start the main review. To find out what @whedon can do for you type:

@whedon commands
@whedon
Copy link
Author

whedon commented Jul 18, 2019

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks.

For a list of things I can do to help you, just type:

@whedon commands

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@whedon generate pdf

What happens now?

This submission is currently in a pre-review state which means we are waiting for an editor to be assigned and for them to find some reviewers for your submission. This may take anything between a few hours to a couple of weeks. Thanks for your patience 😸

You can help the editor by looking at this list of potential reviewers to identify individuals who might be able to review your submission (please start at the bottom of the list). Also, feel free to suggest individuals who are not on this list by mentioning their GitHub handles here.

@whedon
Copy link
Author

whedon commented Jul 18, 2019

Attempting PDF compilation. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Jul 18, 2019

@danielskatz
Copy link

@gkthiruvathukal - would you be willing to edit this submission?

@gkthiruvathukal
Copy link

@danielskatz Yes, I will edit this one.

@danielskatz
Copy link

@whedon assign @gkthiruvathukal as editor

@whedon
Copy link
Author

whedon commented Jul 18, 2019

OK, the editor is @gkthiruvathukal

@danielskatz
Copy link

@gkthiruvathukal - in case you didn't know, you can do this (assign yourself as editor) too...

@gkthiruvathukal
Copy link

Thanks for letting me know! I will do that next time, @danielskatz.

@gkthiruvathukal
Copy link

gkthiruvathukal commented Jul 23, 2019

@danielskatz Any idea why this submission did not move to review state after you assigned me? On my dashboard, it shows as review_pending.

Disregard: I need to take it from here! :) Sorry.

@gkthiruvathukal
Copy link

@whedon commands

@whedon
Copy link
Author

whedon commented Jul 23, 2019

Here are some things you can ask me to do:

# List all of Whedon's capabilities
@whedon commands

# Assign a GitHub user as the sole reviewer of this submission
@whedon assign @username as reviewer

# Add a GitHub user to the reviewers of this submission
@whedon add @username as reviewer

# Remove a GitHub user from the reviewers of this submission
@whedon remove @username as reviewer

# List of editor GitHub usernames
@whedon list editors

# List of reviewers together with programming language preferences and domain expertise
@whedon list reviewers

# Change editorial assignment
@whedon assign @username as editor

# Set the software archive DOI at the top of the issue e.g.
@whedon set 10.0000/zenodo.00000 as archive

# Set the software version at the top of the issue e.g.
@whedon set v1.0.1 as version

# Open the review issue
@whedon start review

EDITORIAL TASKS

# Compile the paper
@whedon generate pdf

# Compile the paper from alternative branch
@whedon generate pdf from branch custom-branch-name

# Remind an author or reviewer to return to a review after a
# certain period of time (supported units days and weeks)
@whedon remind @reviewer in 2 weeks

# Ask Whedon to accept the paper and deposit with Crossref
@whedon accept

# Ask Whedon to check the references for missing DOIs
@whedon check references

@gkthiruvathukal
Copy link

@eidheim if you have any suggestions for potential reviewers then please mention them here in this thread. In addition, this list of people have already agreed to review for JOSS and may be suitable for this submission. Thanks!

@gkthiruvathukal
Copy link

@eidhelm Can you also comment on two things:

  • Why is Simple-Web-Server research software and/or how does it aid in developing research software?
  • Does this provide support for HTTPS?

The first question is important from a JOSS standpoint.
The second is important in general and is not mentioned anywhere in the paper. If HTTPS is not supported, this can present a great deal of frustration to users.

@eidheim
Copy link

eidheim commented Jul 23, 2019

@gkthiruvathukal First of all, thank you for accepting to be editor for this submission.

@eidheim if you have any suggestions for potential reviewers then please mention them here in this thread. In addition, this list of people have already agreed to review for JOSS and may be suitable for this submission. Thanks!

I see there are several potential reviewers with C++ as one of their preferred programming languages. The ones that stood out to me as having relevant background was: gradvohl, aaronyd, hainesr, jaynanavati, nmullins, HaoZeke, Danbo3004, gcdeshpande and adi3.

Why is Simple-Web-Server research software and/or how does it aid in developing research software?

Simple-Web-Server can be helpful for any research software written in C++ that needs to communicate with remote endpoints through HTTP or HTTPS. It is a general purpose library that might aid software development in several research fields. An example another paper accepted by JOSS describing a general purpose library can be found here: https://github.com/openjournals/joss-papers/blob/ceab2f713f640fcb4602a05206fbdbb8d04261a0/joss.01109/10.21105.joss.01109.pdf

Does this provide support for HTTPS?

Yes, Simple-Web-Server supports HTTPS. This is mentioned in the first paragraph of the summery in the paper: "Simple-Web-Server is a library that can be utilized in C++ applications to
implement web-resources or perform HTTP(S) requests in a simple manner across OS
platforms compared to using a networking library directly.". "HTTP(S)" could however be changed to "HTTP or HTTPS".

@gkthiruvathukal
Copy link

@eidheim Thanks for your responses. This is all I needed to proceed with assigning reviewers. I would like see a clear mention of how this helps research software (the language you provided being just about all we need) and to split HTTP and HTTPS. I even failed to notice the regex-like syntax at first.

@gkthiruvathukal
Copy link

@gradvohl, @aaronyd, @hainesr, @jaynanavati, @nmullins, @HaoZeke, @Danbo3004, @gcdeshpande and @adi3: Would you be willing to contribute a review for this JOSS submission? I need two reviewers. I plan to assign on an FCFS basis. I know a couple of you have helped me on recent submissions but would be grateful to have your help again.

@HaoZeke
Copy link
Member

HaoZeke commented Jul 24, 2019

@gkthiruvathukal I would be willing but there need to be significant rewrites. As far as I can tell there are no indications as to how this benefits researchers. It seems like a nice project though.. I understand it has been used for courses, but perhaps before being considered for publication here, perhaps enumerating which features or algorithms are implemented might be a start. Also of concern to me is the fact that most of the references are not part of academia (in terms of peer-reviewed journals) at all.

@HaoZeke
Copy link
Member

HaoZeke commented Jul 24, 2019

@whedon check references

@whedon
Copy link
Author

whedon commented Jul 24, 2019

Attempting to check references...

@whedon
Copy link
Author

whedon commented Jul 24, 2019


OK DOIs

- None

MISSING DOIs

- https://doi.org/10.1007/978-1-4419-7719-9_6 may be missing for title: Boost C++ Libraries

INVALID DOIs

- None

@gkthiruvathukal
Copy link

@HaoZeke If you take a look, I asked @eidheim about how it's research software and will be helpful to it. I believe he gave a satisfactory response and we can iterate with him on this during review. I'm going to assign you as you already have provided some good feedback.

@gkthiruvathukal
Copy link

@whedon assign @HaoZeke as reviewer

@whedon
Copy link
Author

whedon commented Jul 24, 2019

OK, the reviewer is @HaoZeke

@gkthiruvathukal
Copy link

Awaiting one more reviewer!

@HaoZeke
Copy link
Member

HaoZeke commented Jul 24, 2019

@gkthiruvathukal, sure, thanks. I am certain that working with @eidheim will definitely make this a valued contribution. Will continue once the review starts.

@ts-adi
Copy link

ts-adi commented Jul 24, 2019

@gkthiruvathukal I can take this on. The library is probably useful and I think @eidheim will just need to elucidate his response more specifically

It is a general purpose library that might aid software development in several research fields.

By the way, the code itself should have comments and documentation beyond a readme. This is especially important for a library where a doxygen-built API would help users. Not sure if that is part of the review process though.

@HaoZeke
Copy link
Member

HaoZeke commented Jul 24, 2019

@ts-adi it will be.

@gkthiruvathukal
Copy link

@ts-adi I'm grateful that you are willing to be a reviewer. Let me assign you and get the ball rolling. All of these comments will be helpful for the actual review.

@gkthiruvathukal
Copy link

@whedon assign @ts-adi as reviewer

@whedon
Copy link
Author

whedon commented Jul 24, 2019

OK, the reviewer is @ts-adi

@gkthiruvathukal
Copy link

@whedon start review

@whedon
Copy link
Author

whedon commented Jul 24, 2019

OK, I've started the review over in #1592. Feel free to close this issue now!

@gcdeshpande
Copy link

gcdeshpande commented Jul 24, 2019 via email

@gkthiruvathukal
Copy link

@gcdeshpande I will keep you in mind for another submission. Thanks for responding!

ShengHuaWu pushed a commit to ShengHuaWu/Simple-Web-Server that referenced this issue Sep 10, 2019
…(comment). Also added .markdown-format to autoformat paper.md on save
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

7 participants