Complete lab9 #489

n0npax · 2019-06-24T22:41:11Z

Lab 9 - JSON input

Fixes #495

Review of colleague's PR #474

Changes proposed in this PR:

Implement features requested in spec.

codecov · 2019-06-25T12:35:13Z

Codecov Report

Merging #489 into master will not change coverage.
The diff coverage is 100%.

@@          Coverage Diff           @@
##           master   #489    +/-   ##
======================================
  Coverage     100%   100%            
======================================
  Files         157    161     +4     
  Lines        2806   2926   +120     
======================================
+ Hits         2806   2926   +120

Impacted Files	Coverage Δ
09_json/n0npax/pkg/puppy/errors.go	`100% <100%> (ø)`
09_json/n0npax/pkg/puppy/store/memStore.go	`100% <100%> (ø)`
09_json/n0npax/pkg/puppy/store/syncStore.go	`100% <100%> (ø)`
09_json/n0npax/cmd/puppy-server/main.go	`100% <100%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 216ef6f...9e0ce5b. Read the comment docs.

.golangci.yml

09_json/n0npax/cmd/puppy-server/main.go

willshen8 · 2019-07-27T12:58:44Z

One more thing. Marcin. Please fix up your commit message. It should be describing what you are committing. I got caught doing the same thing once like you :) Cheers!

09_json/n0npax/cmd/puppy-server/main.go

juliaogris

Let's resolve discussions around monkey patching and error passing in lab10 PR first please.
I've also updated this PR description.

09_json/n0npax/cmd/puppy-server/main.go

Copy lab08 Apply some new patches from lab07 Add command line support Add example data in json file

juliaogris

I couple more comments on variable naming / function signatures / structure, but nothing too big.
I'm happy for you to merge as is or fix and ping me personally and I'll approve right away. Up to you :)

juliaogris · 2019-08-10T06:17:08Z

09_json/n0npax/cmd/puppy-server/main.go

+
+var (
+	logFatalf = log.Fatal
+	parser    = parseArgs


i like this!

juliaogris · 2019-08-10T06:17:34Z

09_json/n0npax/cmd/puppy-server/main.go

+	return nil
+}
+
+func parseArgs(args []string) (config, error) {


juliaogris · 2019-08-10T06:19:48Z

09_json/n0npax/cmd/puppy-server/main.go

+func createStorer(c *config) error {
+	switch c.sType {
+	case "sync":
+		c.storer = store.NewSyncStore()


I think it would be nicer if this function didn't modify it's input but return the Storer:

func createStorer(storeStr string) (puppy.Storer, error) { //...

To me config should as much as possible only hold read-only/immutable config info (which storer is not).
Also, where all relevant information is just one (or two) fields of the config I find it nicer to pass those few fields (keep the interface smaller).

fixed in lab10

09_json/n0npax/cmd/puppy-server/main.go

juliaogris · 2019-08-10T06:31:37Z

09_json/n0npax/cmd/puppy-server/main.go

+	var storeType string
+	var puppyFile *os.File
+	kingpin.Flag("data", "path to file with puppies data").Short('d').FileVar(&puppyFile)
+	kingpin.Flag("store", "Store type").Short('s').Default("map").EnumVar(&storeType, "map", "sync")


cool i didn't know about this... will remember.

n0npax · 2019-08-10T07:42:10Z

Thanks for the review. I'll merge this as is and implement changes in lab10

alextmz

Nice code and some good ideas here. Had to really scratch the bottom of the nit-bag to find stuff to write about.

alextmz · 2019-11-07T11:33:33Z

09_json/n0npax/cmd/puppy-server/main.go

+
+var (
+	logFatalf = log.Fatal
+	parser    = parseArgs


alextmz · 2019-11-07T11:34:39Z

09_json/n0npax/README.md

+
+Review coverage with
+
+    go test -coverprofile=coverage.out ./... && go tool cover -html=coverage.out


nit: should had specified usage and parameters :-)

not sure if I get it. for sure it's refactored in lab11

alextmz · 2019-11-07T11:35:34Z

09_json/n0npax/cmd/puppy-server/main.go

+		logFatalf(err)
+	}
+	logFatalf(runPuppyServer(&config))
+}


That's clean!

alextmz · 2019-11-07T11:37:48Z

09_json/n0npax/cmd/puppy-server/main.go

+	kingpin.Flag("data", "path to file with puppies data").Short('d').FileVar(&puppyFile)
+	kingpin.Flag("store", "Store type").Short('s').Default("map").EnumVar(&storeType, "map", "sync")
+	_, err := kingpin.CommandLine.Parse(args)
+	return config{puppyFile, storeType, nil}, err


That's a much better way than I did

alextmz · 2019-11-07T11:45:45Z

09_json/n0npax/cmd/puppy-server/main.go

+	}
+	var puppies []puppy.Puppy
+	if err = json.Unmarshal(b, &puppies); err != nil {
+		return nil, errors.New(string(b))


Ok, here you return the read file contents as an error, but then you lose the context of whatever is returned by the Unmarshal error - might make whoever reads the error message confused, getting just a dump without saying what is wrong

good catch. I have no idea why I didn't just return nil, err

alextmz · 2019-11-07T12:03:01Z

09_json/n0npax/pkg/puppy/store/memStore.go

+// CreatePuppy creates puppy
+func (m *MemStore) CreatePuppy(p *puppy.Puppy) (int, error) {
+	if p.Value < 0 {
+		return -1, puppy.Errorf(puppy.ErrCodeInvalidInput, "Puppy value have to be positive number")


"Puppy value has to be equal or bigger than zero", as zero itself is nor positive nor negative (and I'm really running out of nits here)

?? This is returning error if p.Value is lower than 0. 0 < 0 -> False so we're jumping to line 26. If p.Value is equal or larger than 0 I'm not throwing error? Am I missing sth?

0 is positive as far as i remember.

Just a nit about the message itself - zero is neither negative nor positive, it's zero. So saying that value has to be positive is not strictly true, because the smallest possible value needs to be zero. So, the message must say value has to be bigger or equal than zero or sth else that includes the possibility of a zero value. Nit, really... :)

alextmz · 2019-11-07T12:05:28Z

09_json/n0npax/pkg/puppy/store/memStore.go

+}
+
+// UpdatePuppy updates puppy
+func (m *MemStore) UpdatePuppy(id int, p *puppy.Puppy) error {


I'd skip passing the ID separately, as Puppy already has one. If you're updating, the ID shouldn't change, so the ID in Puppy should be enough.

This is holly war :)

Example PUT in K8S (https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#volumemount-v1-core)
PUT /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}

We could extract {name} from payload, but it's provided explicitly.

:) Indeed can be a matter of taste. I agree with using it explicitly in case of a PUT, but just doesn't feel right in the case of internal language functions. But it's taste anyway :)

alextmz · 2019-11-07T12:06:23Z

09_json/n0npax/pkg/puppy/store/memStore.go

+}
+
+// DeletePuppy deletes puppy
+func (m *MemStore) DeletePuppy(id int) (bool, error) {


Feels like that both bool and error returning a bit too much, isn't just error enough?

yes it is. It's fixed in lab10 or lab11

alextmz · 2019-11-07T12:06:57Z

09_json/n0npax/pkg/puppy/store/store_test.go

+		return puppy.Puppy{
+			Breed:  "Type A",
+			Colour: "Grey",
+			Value:  rand.Intn(100) + 100,


good one randomizing the value

alextmz · 2019-11-07T12:08:42Z

09_json/n0npax/pkg/puppy/types.go

+// Puppy contains information about single puppy
+type Puppy struct {
+	ID     int    `json:"id"`
+	Value  int    `json:"value"`


Value could be 1,99... (float) 😆

design assumption :)

n0npax requested review from anzboi, anzdaddy, camscale, joshcarp, juliaogris, linuxmonk, pentaphobe and rokane as code owners June 24, 2019 22:41

n0npax force-pushed the lab09 branch 3 times, most recently from 177be32 to ad22907 Compare June 25, 2019 11:16

n0npax changed the title ~~[WIP] Complete lab~~ Complete lab9 Jun 25, 2019

n0npax force-pushed the lab09 branch 2 times, most recently from 6a5fe7c to 672b90e Compare June 25, 2019 11:22

anz-bank deleted a comment from golangcibot Jun 25, 2019

n0npax force-pushed the lab09 branch 3 times, most recently from d8fd441 to f074643 Compare June 25, 2019 12:32

n0npax added the lab9 label Jun 25, 2019

n0npax added the Ready for review label Jun 25, 2019

n0npax commented Jun 25, 2019

View reviewed changes

.golangci.yml Outdated Show resolved Hide resolved

n0npax force-pushed the lab09 branch from d528b12 to ecf933d Compare June 25, 2019 23:08

n0npax self-assigned this Jun 26, 2019

n0npax force-pushed the lab09 branch 2 times, most recently from a854acf to d6976e2 Compare June 26, 2019 06:36

golangcibot reviewed Jun 30, 2019

View reviewed changes

09_json/n0npax/cmd/puppy-server/main.go Outdated Show resolved Hide resolved

n0npax force-pushed the lab09 branch 2 times, most recently from 8a8e963 to b1fda19 Compare June 30, 2019 02:58

n0npax added the Ready for review label Jul 27, 2019

n0npax requested a review from willshen8 July 27, 2019 12:42

willshen8 previously approved these changes Jul 27, 2019

View reviewed changes

n0npax dismissed willshen8’s stale review via 6543691 July 27, 2019 13:12

n0npax force-pushed the lab09 branch from 8b9a8df to 6543691 Compare July 27, 2019 13:12

golangcibot reviewed Jul 27, 2019

View reviewed changes

09_json/n0npax/cmd/puppy-server/main.go Outdated Show resolved Hide resolved

n0npax commented Jul 27, 2019

View reviewed changes

09_json/n0npax/cmd/puppy-server/main.go Outdated Show resolved Hide resolved

n0npax force-pushed the lab09 branch from 6543691 to 42f9cb5 Compare July 28, 2019 01:11

juliaogris suggested changes Jul 30, 2019

View reviewed changes

09_json/n0npax/cmd/puppy-server/main.go Outdated Show resolved Hide resolved

09_json/n0npax/cmd/puppy-server/main.go Outdated Show resolved Hide resolved

juliaogris added Changes requested and removed Ready for review labels Jul 30, 2019

n0npax force-pushed the lab09 branch 3 times, most recently from 4924259 to 7657dd3 Compare August 8, 2019 12:15

n0npax mentioned this pull request Aug 8, 2019

Complete lab 10 #504

Merged

n0npax requested a review from juliaogris August 8, 2019 12:18

n0npax added Ready for review and removed Changes requested labels Aug 8, 2019

Complete lab09

493f020

Copy lab08 Apply some new patches from lab07 Add command line support Add example data in json file

n0npax force-pushed the lab09 branch from 7657dd3 to 493f020 Compare August 8, 2019 12:22

juliaogris approved these changes Aug 10, 2019

View reviewed changes

juliaogris added Merge me and removed Ready for review labels Aug 10, 2019

Merge branch 'master' into lab09

9e0ce5b

n0npax merged commit 058675e into anz-bank:master Aug 10, 2019

n0npax deleted the lab09 branch August 10, 2019 08:50

alextmz reviewed Nov 7, 2019

View reviewed changes

alextmz mentioned this pull request Nov 7, 2019

Add lab 9 - JSON Puppies #667

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Complete lab9 #489

Complete lab9 #489

n0npax commented Jun 24, 2019 •

edited

Loading

codecov bot commented Jun 25, 2019 •

edited

Loading

willshen8 commented Jul 27, 2019 •

edited

Loading

juliaogris left a comment •

edited

Loading

juliaogris left a comment

juliaogris Aug 10, 2019

alextmz Nov 7, 2019

juliaogris Aug 10, 2019

juliaogris Aug 10, 2019

n0npax Aug 10, 2019

juliaogris Aug 10, 2019

n0npax commented Aug 10, 2019

alextmz left a comment

alextmz Nov 7, 2019

alextmz Nov 7, 2019

n0npax Nov 7, 2019 •

edited

Loading

alextmz Nov 7, 2019

alextmz Nov 7, 2019

alextmz Nov 7, 2019

n0npax Nov 7, 2019

alextmz Nov 7, 2019

n0npax Nov 7, 2019

n0npax Nov 7, 2019

alextmz Nov 10, 2019

alextmz Nov 7, 2019

n0npax Nov 7, 2019

alextmz Nov 10, 2019

alextmz Nov 7, 2019

n0npax Nov 7, 2019

alextmz Nov 7, 2019

alextmz Nov 7, 2019

n0npax Nov 7, 2019


		Review coverage with

		go test -coverprofile=coverage.out ./... && go tool cover -html=coverage.out

Complete lab9 #489

Complete lab9 #489

Conversation

n0npax commented Jun 24, 2019 • edited Loading

Lab 9 - JSON input

Changes proposed in this PR:

codecov bot commented Jun 25, 2019 • edited Loading

Codecov Report

willshen8 commented Jul 27, 2019 • edited Loading

juliaogris left a comment • edited Loading

Choose a reason for hiding this comment

juliaogris 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

n0npax commented Aug 10, 2019

alextmz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

n0npax Nov 7, 2019 • edited Loading

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

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

n0npax commented Jun 24, 2019 •

edited

Loading

codecov bot commented Jun 25, 2019 •

edited

Loading

willshen8 commented Jul 27, 2019 •

edited

Loading

juliaogris left a comment •

edited

Loading

n0npax Nov 7, 2019 •

edited

Loading