REFACTOR: Posts #1226

drwasho · 2018-10-11T05:51:27Z

The changes in these commits cover the following:

Renames title to status
Adds type to indicate if the post is a 'comment' or 'repost' etc, if so:
Adds reference to point to the original post
Adds channels to allow a social post to be directed at a specific topic

This is a backwards incompatible change for nodes that have used posts; however since posts hasn't rolled out in desktop and has only been tested in a handful of nodes run by the developers, the impact should be negligible.

The changes in these commits cover the following: 1. Renames `title` to `status` 2. Adds `type` to indicate if the post is a 'comment' or 'repost' etc, if so: 3. Adds `reference` to point to the original post 4. Adds `channels` to allow a social post to be directed at a specific topic This is a backwards incompatible change for nodes that have used posts; however since posts hasn't rolled out in desktop and has only been tested in a handful of nodes run by the developers, the impact should be negligible.

The max lengths were increased as: 1. Tags could be used to reference a listing 2. Channels could be used to reference a store or listing This length gives us more than enough space if IPNS addresses increase beyond what they are now.

drwasho · 2018-10-11T06:02:10Z

Some additional information on the channels field; the terminology is a callback to IRC channels (not to be confused with our future feature 'curation channels'). A feed of posts can be constructed based on posts that specify certain channel.

For example, I could create a post advertising my listing or store in the nike channel... curators could post their review of a sneaker in the nike channel etc.

Tags add some granularity to finding posts within a channel too. Keeping with the example, I may blast out a social post in nike and sneaker, but my post carries a tag yeezy or drwasho review.

coveralls · 2018-10-11T12:23:48Z

Coverage decreased (-0.02%) to 34.338% when pulling 546e8ac on drwasho:drwasho.posts.refactor into 682c63a on OpenBazaar:master.

hoffmabc · 2018-10-11T13:22:50Z

Let’s make sure when this code is merged that we have some adequate documentation accompanying it. I don’t want to lose the description of this stuff.

drwasho · 2018-10-15T02:43:03Z

@hoffmabc documentation added!

placer14

A few changes requested, please. Thanks @drwasho. I also wouldn't object to some unit testing around these some of the critical parts of the code (like slug generation maybe or validation checking to name some examples).

api/jsonapi_data_test.go

core/posts.go

docs/posts.md

Tested some of these errors which appeared to work normally.

core/posts.go

docs/posts.md

This will then be used in listings and posts when creating content.

- Documentation will be moved to the OBIP for posts - After merging `master` into this branch, which had a change in the protobuf, we needed updated `pb.go` files for the changes to the protobuf from posts

drwasho · 2018-10-24T05:03:21Z

Documentation moved to OBIP: OpenBazaar/obips#37

placer14

One more round of changes which I'll apply. Thanks @drwasho

placer14 · 2018-10-29T14:40:08Z

api/jsonapi_data_test.go

 	},
-	"title": "test1",
+    "status": "test1",
+    "postType": "POST",


This should be a constant as above.

core/posts.go

placer14 · 2018-10-29T18:54:01Z

core/posts.go

+	}
+	for _, channel := range post.Channels {
+		if len(channel) > PostChannelsMaxCharacters {
+			return ErrPostChannelsLengthLongerThanMax


And this error should be ErrPostChannelsLongerThanMax instead.

placer14 · 2018-10-29T18:54:22Z

core/posts.go

+
+	// Channels
+	if len(post.Channels) > MaxPostChannels {
+		return ErrPostChannelsLongerThanMax


The error looks like it should be ErrPostChannelsLengthLongerThanMax.

I see. They're right, just the name allows them to be confused with their similarly named counterpart.

placer14 · 2018-10-29T18:56:40Z

core/posts.go

 	// Tags
 	if len(post.Tags) > MaxPostTags {
-		return fmt.Errorf("Tags in the post is longer than the max of %d characters", MaxPostTags)
+		return ErrPostTagsLongerThanMax


The name of the errors don't appear to match their content. I had to doublecheck to disambiguate this with ErrPostTagsLengthLongerThanMax.

* origin/master: Log error adding key to peerstore Update bitcoin/listeners/transaction_listener.go Improved grammar and fixed capitalization in the main README file. Fixed import error Update Documentation section (PR OpenBazaar#1252) Remove unused Python modules in qa/chat.py Improve README: fix grammar CLEANUP: Fix misspellings. Enable goimports linter rules HandleOfflineRelay save public key Conflicts: core/core.go core/listings.go

drwasho requested review from a user, cpacia and placer14 October 11, 2018 05:51

TWEAK: Increase tag and channel max length

2ae6d2f

The max lengths were increased as: 1. Tags could be used to reference a listing 2. Channels could be used to reference a store or listing This length gives us more than enough space if IPNS addresses increase beyond what they are now.

FIX: JSON API slug generation based on 'status' not 'title'

cae5b24

drwasho force-pushed the drwasho.posts.refactor branch from 89326a9 to 68a1867 Compare October 11, 2018 08:47

FIX: Post tests

d7fb7b9

drwasho force-pushed the drwasho.posts.refactor branch from 68a1867 to d7fb7b9 Compare October 11, 2018 11:45

FIX: Type check and channels

7decb1a

NEW: Documentation for Posts

880cd95

placer14 suggested changes Oct 17, 2018

View reviewed changes

refactor: Export errors

51708a3

Tested some of these errors which appeared to work normally.

cpacia suggested changes Oct 18, 2018

View reviewed changes

core/posts.go Outdated Show resolved Hide resolved

cpacia reviewed Oct 18, 2018

View reviewed changes

docs/posts.md Outdated Show resolved Hide resolved

reformat: Error variables

1dc672a

drwasho mentioned this pull request Oct 18, 2018

Refactoring posts #1235

Closed

drwasho added 5 commits October 19, 2018 14:53

tweak: Use enumerated post type in test

2f01387

Create generic function for generating a slug

9d4dce6

This will then be used in listings and posts when creating content.

refactor: Addition of tags and channels to GET posts response

d49e5da

Merge remote-tracking branch 'origin/master' into drwasho.posts.refactor

3790385

Review: Remove documentation + update pb.go files

9cfdf49

- Documentation will be moved to the OBIP for posts - After merging `master` into this branch, which had a change in the protobuf, we needed updated `pb.go` files for the changes to the protobuf from posts

placer14 suggested changes Oct 29, 2018

View reviewed changes

placer14 force-pushed the drwasho.posts.refactor branch from e9042c4 to 4955a9b Compare October 29, 2018 19:37

Extract makeUnique helper for Post Tags and Channels

ca0c7ec

placer14 force-pushed the drwasho.posts.refactor branch from 7e60eee to a480939 Compare October 30, 2018 02:27

Normalize Post error messages and variables names

546e8ac

placer14 force-pushed the drwasho.posts.refactor branch from a480939 to 546e8ac Compare October 30, 2018 02:42

placer14 approved these changes Oct 30, 2018

View reviewed changes

cpacia approved these changes Oct 30, 2018

View reviewed changes

Add README to mobile package

139b98d

placer14 merged commit e9f9fc0 into OpenBazaar:master Oct 30, 2018

REFACTOR: Posts #1226

REFACTOR: Posts #1226

Uh oh!

Conversation

drwasho commented Oct 11, 2018

Uh oh!

drwasho commented Oct 11, 2018

Uh oh!

coveralls commented Oct 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hoffmabc commented Oct 11, 2018

Uh oh!

drwasho commented Oct 15, 2018

Uh oh!

placer14 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

drwasho commented Oct 24, 2018

Uh oh!

placer14 left a comment

Choose a reason for hiding this comment

Uh oh!

placer14 Oct 29, 2018

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

placer14 Oct 29, 2018

Choose a reason for hiding this comment

Uh oh!

placer14 Oct 29, 2018

Choose a reason for hiding this comment

Uh oh!

placer14 Oct 29, 2018

Choose a reason for hiding this comment

Uh oh!

placer14 Oct 29, 2018

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

coveralls commented Oct 11, 2018 •

edited

Loading

placer14 left a comment •

edited

Loading