Scribble V3

[yedhink]

@nancy-binani Start with this from tomorrow.

https://public.3.basecamp.com/p/ZcDNj5fhtocuzhLtkLookBFd

Also, when submitting V3 again, ensure you take into consideration the following too:

• [x] Don't use a job. Use a worker. Refer: https://www.bigbinary.com/books/learn-rubyonrails-book/handling-idempotency-when-sending-emails-using-sidekiq#sidekiq-worker
• [x] I would like to see how the schedule related worker behaves. As in I want to see the following from in a video: How the status change is reflected in UI once the article is published by the worker, how the version history changes once article is published by worker, what happens if we delete the article itself before it gets published or unpublished, what happens if we delete the category to which an article belonged to and move the article into a new category, and how it affects schedule worker.
• [x] Don't allow unpublishing an article if the current article is not published or if there is no publish schedule
• [x] Let's say there's a publish schedule that we have added. We need an option to cancel that schedule in case we change our mind. Like if I set the publishing to be like at 10UTC, then before that time or before an offset time, I should be allowed to cancel the publish schedule.
• [x] The unpublish logic in backend should be written in a way that it only takes into account the published articles for unpublishing. Explicitly stating this although it's obvious.
• [x] Write test cases verifying these scenarios.
• [x] Say that there's an unpublish schedule set for 10PM. If the user decides to draft the article manually before 10PM, then make sure to confirm with the user on whether they want to continue. Because if the user is drafting, then it doesn't make sense to have another unpublish later because the article would already be in the draft state after this operation.
• [x] Show a callout if the article show page if there's a publish or unpublish schedule
• [x] No need to allow setting publish schedule down to minutes. Just date and hour of publish/unpublish is good enough.
• [x] Does restoring the versions of an article when a schedule is set have any impact on the scheduling process overall?

Few separate videos required(or combined - whichever is sensible):

1. Publish later working
2. Unpublish later working
3. Sidekiq server working - enqueuing of worker, how workers successful completion affects UI etc.
4. How schedule cancellation works

[nancy-binani]

I wanted to ask whether I should first work on paper trail suggestion or should I start writing the code for version3 as almost all the reviews I have completed working on except test cases and paper trail suggestion.

[yedhink]

@nancy-binani You can set aside the paper trail part and start working on this issue. We need to finish V3 on time.

[nancy-binani]

Monday 26 Dec - EOD

[nancy-binani]

My sidekiq server is not running.Can you help me with it?

[nancy-binani]

Please ignore my comment.The error is resolved.

[nancy-binani]

https://www.loom.com/share/d032553d1fbd41d3901f45505133514d ->publish/unpublish later

https://www.loom.com/share/9a50a121af704b5ba3a9b6897cd3fc1e -> version history

https://www.loom.com/share/a278d706a4884d78a028d5bbab259763 -> cancel schedule

https://www.loom.com/share/8ff5c8590ddb4960bb468ec95f3af922 -> delete article/edit category & backend code

https://www.loom.com/share/20382edb2e6849c39b1441d677fb751b -> delete the category to which an article belonged to and move the article into a new category

Please review the code.Actually there were 3 reviews of version 2 which I thought I can work after completing version 3 but I did not get time at all to work on them. Code cleaning and few review changes are left and I did not want to extend the deadline for version 3. I have written the code for version 3 and would be working on code cleaning and those few reviews.

[yedhink]

https://www.loom.com/share/d032553d1fbd41d3901f45505133514d ->publish/unpublish later

After you schedule a publish or unpublish action, then the user should not be forced to refresh the page in order to get the latest data. Rather you should fetch latest data once the schedule is created.

• Why are you using and over &&? Please research and point out the difference between the two. Also please read about safe navigation and presence method in Rails: https://github.com/bigbinary/bb-academy-web/issues/2329

  

• [x] I want you to carefully go through https://www.bigbinary.com/books/learn-rubyonrails-book/handling-idempotency-when-sending-emails-using-sidekiq and point out to me how the following logic constitutes to a single point of failure and what can be done to fix the issue:

  

• [x] It's an overkill to have two different workers handling very closely related code. Rather have a single worker called ArticleSchedulerWorker and handle both publish and unpublish logic conditionally within it. https://github.com/nancy-binani/scribble-by-nancy-binani/blob/135bca70a4827c459596ec6e667397c1d13823a2/app/workers/article_publish_later_worker.rb#L3-L21

• [x] I only see a categories controller in the public namespace, which most probably suggests to me that you are sending all the categories and articles and their corresponding details in one single API call. That's actually not a good way to create APIs. You should also have a article controller in the public namespace to send the detail of a particular article based on the slug. The categories controller should simply send the bare minimum details of the article like say the title of the article. This API division is required so to ensure that the APIs are performant. https://github.com/nancy-binani/scribble-by-nancy-binani/blob/135bca70a4827c459596ec6e667397c1d13823a2/app/controllers/api/public/categories_controller.rb#L5