feat: sync with benchttp/runner

[moreirathomas]

Description

Architectural changes and sync with benchttp/runner regarding data structure and endpoints.

Changes

• changes packages structure: server (previous http) is at the root, benchttp entities are inside benchttp
• swap Benchmark and Report structs
• rework HTTP response writing for JSON and errors (not better or worst, mainly experiments, subject to discussion)
• /v1 subrouter

Notes

[GregoryAlbouy]

Even though I'm not a fan of having source files at the root mixed with config files, it works really well here with the name of the module (e.g. server.New).
I also really like the domain package benchttp, I'm wondering whether we should consider porting it to the runner (might not work as well as there's much more going on with the equivalent entities).

[GregoryAlbouy]

[question] This is not used, what should we do about it?

[nitpick] I'd keep the implementation details to the implementation itself, considering the underlying client is private.

Suggested change

	// CloseClient calls the Close method of the internal client
	// of the ReportService.
	func (s ReportService) CloseClient() {
	s.client.Close()
	}
	// Close closes the connection to Firestore client.
	func (s ReportService) Close() error {
	return s.client.Close()
	}

[GregoryAlbouy]

🚀

My only remaining concerns are:

• the 405 returned in certain cases of invalid id: not ideal but secondary and can be improved later
• the endpoint path that I believe would be more conventional in format /reports/{id}, but the query param works well too so let's let the author choose 🤷‍♂️

[GregoryAlbouy]

😍

[moreirathomas]

the 405 returned in certain cases of invalid id: not ideal but secondary and can be improved later

Only thing remaining. What happens:

• /reports accepts POST requests to write a new report
• /reports/{id} accepts GET requests to read an existing report

Calling /reports with a GET request is by definition a method not allowed.

[GregoryAlbouy]

Calling /reports with a GET request is by definition a method not allowed.

Yes, now it makes perfect sense because the two endpoints do not share the same path anymore.
What was happening is that because the ID didn't match the defined GET /report route, the router was falling back to the POST /report hence the Method not allowed, I guess.