COR-710: Publish System Rebuild #487

ElliottAYoung · 2017-04-24T20:31:08Z

Purpose:

This PR is for a rebuild / reimagining of the Cortex Publish System for created content items. The way this new system works is by using flexibly defined states from the decorator, rather than hard coded state machine states, then determining the current state of a content_item using the relevant date time fields. This is replacing our ActiveJob enqueued approach to handling scheduling and publishing.

Additional inclusions in this PR would be the new names for Employer Blog Categories in the Category tree, which was from a minor task by @justin3thompson, AND adds back the expiration date, since this new system makes that concern extremely simple.

As a content creator, I want my Content to Publish reliably and on-time. Our current system may have a weak spot - currently, it uses our Queuing system, which doesn't enforce reliability, can lose data, and will completely break if you deploy a code change that is incompatible with the version of code that initially spawned the Job.

JIRA:

https://cb-content-enablement.atlassian.net/browse/COR-710

Steps to Take On Prod

Create a new Employer Blog content item
Schedule the Publish Date to be ~10 minutes in the future (there's a 10 minute cache time)
Schedule the Expiration Date to be ~10 minutes after that
Hit Save
Notice how the state is draft
Wait until the first 10 minutes have passed, then confirm the state is published (clear the cache if it hasn't updated)
Wait the next 10 minutes then confirm the state is expired

Changes:

Changes to setup
- N/A
Architectural changes
- Rebuilds out publishing system from the ground up
Migrations
- N/A
Library changes
- Removes our dependency on transitions state_machine, we may wind up removing it altogether
Side effects
- N/A

Screenshots

Before
N/A
After
N/A

QA Links:

http://web.cortex-7.development.c66.me/

How to Verify These Changes

Specific pages to visit
- Create new Employer Blog
Steps to take
- Create a new Employer Blog content item
- Schedule the Publish Date to be ~10 minutes in the future (there's a 10 minute cache time)
- Schedule the Expiration Date to be ~10 minutes after that
- Hit Save
- Notice how the state is draft
- Wait until the first 10 minutes have passed, then confirm the state is published (clear the cache if it hasn't updated)
- Wait the next 10 minutes then confirm the state is expired
Responsive considerations
- N/A

Relevant PRs/Dependencies:

N/A

Additional Information

N/A

toastercup · 2017-04-25T16:18:38Z

app/views/content_items/_form.html.haml

-          = form.button 'Save as Draft', value: 'draft', name: 'content_item[state]', class: 'mdl-button mdl-js-button mdl-button--cb mdl-js-ripple-effect', type: 'submit'
-      - else
-        = form.submit 'Submit', class: 'mdl-button mdl-js-button mdl-button--raised mdl-button--success mdl-js-ripple-effect'
+      = form.submit 'Save Now', class: 'mdl-button mdl-js-button mdl-button--raised mdl-button--success mdl-js-ripple-effect'


I believe we'll still need to reflect the state in the button's text, per Justin's previous AC

I talked with him about this, since the buttons wouldn't actually move the state along he preferred if it just said "Save Now" until we figure out how best to implement the triggered state changes

toastercup · 2017-04-25T16:19:03Z

app/assets/javascripts/datepicker_init.js

@@ -4,20 +4,7 @@ var datepicker_init = function() {
  if (datepicker.length) {
    datepicker.datetimepicker({
      dateFormat: 'dd/mm/yy',
-      onSelect: function (date) {


We still need to reflect the latest state as the user changes publish/expiration dates, as per Justin's previous AC

I talked with him about this, since the buttons wouldn't actually move the state along he preferred if it just said "Save Now" until we figure out how best to implement the triggered state changes

toastercup · 2017-04-25T17:26:48Z

app/services/publish_state_service.rb

@@ -0,0 +1,27 @@
+class PublishStateService < ApplicationController


Let's not inherit from ApplicationController here - this brings in a lot of stuff. We can follow our existing service data object pattern - inherit from ApplicationService and specify your Service's attributes

Whoops - that's a typo, good catch

toastercup · 2017-04-25T17:29:25Z

app/services/publish_state_service.rb

@@ -0,0 +1,27 @@
+class PublishStateService < ApplicationController
+  def perform(sorted_field_items, content_item)


I'm guessing this returns the publish status of a ContentItem - if so, we'll want to make the method name reflect that

toastercup · 2017-04-25T17:34:20Z

app/services/publish_state_service.rb

+
+  private
+
+  def active_state


Since our terminology is 'published', should this be active_state?

Our terminology is only published for this specific ContentType, this method is only trying to figure out which, of the potentially multiple states, is presently active

toastercup · 2017-04-26T07:11:37Z

app/models/content_item.rb

-  def schedule_publish
-    timestamp = field_items.find { |field_item| field_item.field.name == "Publish Date" }.data["timestamp"]
-    PublishContentItemJob.set(wait_until: DateTime.parse(timestamp)).perform_later(self)
+    sorted_field_items = field_items.select { |fi| fi.field.field_type_instance.is_a?(DateTimeFieldType) && !fi.field.metadata["state"].nil? }.sort_by{ |a| a.data["timestamp"] }.reverse


I have some thoughts about this system (which is pretty neat!), but we may end up rebuilding some of this anyway - so we can discuss later.

Let's move this logic to the Service layer - consumers of this abstraction ideally shouldn't have to know how to groom the data being passed in. This issue of 'leaky abstractions' is something that I'm trying to correct across the application - it's hard to stay ontop of, and it's something we've all been guilty of. Thanks!

ElliottAYoung · 2017-04-26T15:51:58Z

@toastercup this is ready for re-review

toastercup · 2017-04-26T16:56:25Z

app/models/content_item.rb

@@ -115,4 +96,12 @@ def update_tag_lists
      ContentItemService.update_tags(self, tags)
    end
  end
+
+  def method_missing(*args)


Since method_missing can't be self-descriptive, would you mind documenting what this will give us?

toastercup · 2017-04-26T16:58:38Z

app/models/content_item.rb

-  def schedule_publish
-    timestamp = field_items.find { |field_item| field_item.field.name == "Publish Date" }.data["timestamp"]
-    PublishContentItemJob.set(wait_until: DateTime.parse(timestamp)).perform_later(self)
+    sorted_field_items = field_items.select { |fi| fi.field.field_type_instance.is_a?(DateTimeFieldType) && !fi.field.metadata["state"].nil? }.sort_by{ |a| a.data["timestamp"] }.reverse


Let's move this logic to the Service layer - consumers of this abstraction ideally shouldn't have to know how to groom the data being passed in. This issue of 'leaky abstractions' is something that I'm trying to correct across the application - it's hard to stay ontop of, and it's something we've all been guilty of. Thanks!

toastercup · 2017-04-26T17:00:19Z

app/services/publish_state_service.rb

@@ -0,0 +1,21 @@
+class PublishStateService < ApplicationService
+  def content_item_state(sorted_field_items, content_item)


As PublishStateService will always concern itself with ContentItems and FieldItems, let's make these two parameters Virtus attributes that methods across the service can refer to

ElliottAYoung · 2017-04-26T18:29:35Z

@toastercup this is ready for re-review

ElliottAYoung added 5 commits April 24, 2017 10:01

refactor: move down to two states

5f9d299

refactor: remove unused publishing method and job

1e0dd41

feat: build custom content approach to publishing workflow

506d8ca

feat: handle timezone through DatePicker

ae224f0

fix: clear state cache on update

49f221b

ElliottAYoung added enhancement infrastructure technical debt labels Apr 24, 2017

ElliottAYoung added this to the Custom Content milestone Apr 24, 2017

ElliottAYoung self-assigned this Apr 24, 2017

ElliottAYoung requested review from toastercup, arelia, mrfantasticwonders and MKwenhua April 24, 2017 20:31

ElliottAYoung added 5 commits April 25, 2017 10:20

refactor: remove previous button logic for publish

cfac6ca

feat: add working expiration date to content_item

4856669

refactor: limit cache time on state

0eb39aa

chore: add categories - per @justin3thompson

6d8f066

chore: change save button text - per @justin3thompson

5f64af6

ElliottAYoung force-pushed the topic/COR-710-Publish-System-Rebuild branch from 197fac5 to 5f64af6 Compare April 25, 2017 15:26

MKwenhua approved these changes Apr 25, 2017

View reviewed changes

arelia approved these changes Apr 25, 2017

View reviewed changes

feat: create DSL for content_items with #method_missing

dbd7f93

toastercup requested changes Apr 26, 2017

View reviewed changes

refactor: necessary pub system renamings and refactors

b32cd67

toastercup requested changes Apr 26, 2017

View reviewed changes

refactor: clean publish service and add method_missing comments

ea21a4f

toastercup approved these changes Apr 26, 2017

View reviewed changes

feat: implement hybrid approach for state system

7900600

ElliottAYoung force-pushed the topic/COR-710-Publish-System-Rebuild branch from bcc7e57 to 7900600 Compare April 26, 2017 21:19

Merge branch 'develop' into topic/COR-710-Publish-System-Rebuild

ae62c0e

ElliottAYoung added the verified label Apr 26, 2017

ElliottAYoung merged commit 9d5dc58 into develop Apr 26, 2017

ElliottAYoung deleted the topic/COR-710-Publish-System-Rebuild branch April 26, 2017 21:35

PlatformIntegrity unassigned ElliottAYoung Jun 4, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

COR-710: Publish System Rebuild #487

COR-710: Publish System Rebuild #487

ElliottAYoung commented Apr 24, 2017

toastercup Apr 25, 2017

ElliottAYoung Apr 26, 2017

toastercup Apr 25, 2017

ElliottAYoung Apr 26, 2017

toastercup Apr 25, 2017

ElliottAYoung Apr 26, 2017

toastercup Apr 25, 2017

toastercup Apr 25, 2017

ElliottAYoung Apr 26, 2017

toastercup Apr 26, 2017

toastercup Apr 26, 2017

ElliottAYoung commented Apr 26, 2017

toastercup Apr 26, 2017

toastercup Apr 26, 2017

toastercup Apr 26, 2017

ElliottAYoung commented Apr 26, 2017

		@@ -0,0 +1,27 @@
		class PublishStateService < ApplicationController

		@@ -0,0 +1,27 @@
		class PublishStateService < ApplicationController
		def perform(sorted_field_items, content_item)

		@@ -0,0 +1,21 @@
		class PublishStateService < ApplicationService
		def content_item_state(sorted_field_items, content_item)

COR-710: Publish System Rebuild #487

COR-710: Publish System Rebuild #487

Conversation

ElliottAYoung commented Apr 24, 2017

Purpose:

JIRA:

Steps to Take On Prod

Changes:

Screenshots

QA Links:

How to Verify These Changes

Relevant PRs/Dependencies:

Additional Information

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

ElliottAYoung commented Apr 26, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ElliottAYoung commented Apr 26, 2017