Ghost/ghost/admin/app
Chris Raible cc88757e2a
Added local revisions to the editor as backstop against data loss (#21044)
ref https://app.incident.io/ghost/incidents/107

- We have a rare bug that causes the initial `POST` request to create a
new post from the editor to be skipped or fail. Subsequent `PUT`
requests then fail because there is no post ID, potentially resulting in
data loss. The aim of this commit is to start saving revisions of posts
in the editor to the browser's localStorage, as a last-ditch option to
restore lost work.
- Since we don't know where the bug is yet, and to protect against
future bugs, we've deliberately avoided depending too heavily on the
`lexical-editor` controller or the ember store. We've aimed to create a
direct route to the state in the editor, by hooking into the
`updateScratch` method (effectively the `onChange` handler for the
editor).
- The `scheduleSave` function on the new `local-revisions` service is
called immediately upon any changes to the state of the lexical editor,
which is effectively every keystroke. The service has some logic and
timeouts, so it doesn't actually save a revision on every change to the
editor.
- The "schema" of the datastore is a simple key-value store, where the
key is of the format: `post-revision-${postId}-${timestamp}` if the post
has an ID, or `post-revision-draft-${timestamp}` for an unsaved draft.
There is also an array of all the revisions' keys, which allows us to
clear all the revisions without having to loop over every key in
localStorage (along with some other conveniences, like filtering).
- There is currently no UI for viewing/restoring revisions. In the event
that you need to restore a revision, you can access the service in the
browser console. You can access all the saved revisions using the
`list()` method, which logs all the revisions to the console by title &
timestamp. You can then choose a revision to restore, and call
`restore(revision_key)`, which will `POST` the revision's data to the
server to create a new post.
- Since localStorage data is limited to a 5mb quota in most browsers,
the service has a mechanism for evicting the oldest revisions once it
meets the quota. If a save fails because it would exceed the quota, the
`performSave` method will evict the oldest revision, then recursively
try to save again.

---------

Co-authored-by: Steve Larson <9larsons@gmail.com>
2024-09-20 00:08:28 -07:00
..
adapters Fixed infinite save loop due to missing post_revisions include on saves (#18597) 2023-10-12 19:16:45 +00:00
authenticators Made session.user a synchronous property rather than a promise 2021-07-08 14:54:31 +01:00
components Updated missed references to unique visitors 2024-09-19 12:09:46 +01:00
controllers Added local revisions to the editor as backstop against data loss (#21044) 2024-09-20 00:08:28 -07:00
decorators Fixed hosting management screen not loading after sign-in process (#15763) 2022-11-03 11:14:36 +00:00
errors Improved validation process for members CSV import 2020-07-07 00:28:30 +12:00
helpers Make split number helper handle empty value (#20848) 2024-08-28 10:47:03 +00:00
initializers Resolved ember-simple-auth deprecations 2022-01-22 00:30:56 +00:00
instance-initializers Fixed hosting management screen not loading after sign-in process (#15763) 2022-11-03 11:14:36 +00:00
mixins Added collections CRUD UI 2023-05-23 17:26:47 +07:00
models 🐛 Fixed editor unsaved changes modal showing too often (#20787) 2024-08-19 18:03:13 +00:00
modifiers Fixed onboarding checklist video logo autoplay (#19967) 2024-04-02 13:55:22 +01:00
routes 🐛 Fixed wrong breadcrumb and missing post status when starting new post from analytics 2024-09-19 16:27:40 +01:00
serializers Added custom excerpt to post revisions (#20323) 2024-06-05 14:47:33 +01:00
services Added local revisions to the editor as backstop against data loss (#21044) 2024-09-20 00:08:28 -07:00
session-stores Migrated session-store to native class syntax 2022-02-02 18:41:16 +00:00
styles Updated buttons for share modal and post analytics (publish flow) in dark mode (#20989) 2024-09-12 11:39:50 +00:00
templates Removed unused react-editor template file (#20996) 2024-09-12 22:20:19 +00:00
transforms Dropped ember-cli-moment-shim dependency 2022-09-24 13:28:23 +02:00
transitions Fixed autofocus not working on modal inputs 2018-06-04 17:48:57 +01:00
utils Refined ui details for Stats page (#20977) 2024-09-11 14:14:05 +00:00
validators Excerpt form error fix (#20730) 2024-08-12 09:35:21 +00:00
app.js Dropped ember-cli-moment-shim dependency 2022-09-24 13:28:23 +02:00
index.html Fixed loading animation for Safari 2022-10-17 10:11:07 +02:00
README.md Fixed typos (#18648) 2023-10-31 15:21:44 +00:00
router.js Added initial Stats page to Ghost Admin (#20877) 2024-08-29 12:56:39 +01:00
transitions.js Removed tour feature 2021-03-02 14:29:26 +00:00

Ghost Admin App

Ember.js application used as a client-side admin for the Ghost blogging platform. This readme is a work in progress guide aimed at explaining the specific nuances of the Ghost Ember app to contributors whose main focus is on this side of things.

CSS

We use pure CSS, which is pre-processed for backwards compatibility by Myth. We do not follow any strict CSS framework, however our general style is pretty similar to BEM.

Styles are primarily broken up into 4 main categories:

  • Patterns - are base level visual styles for HTML elements (eg. Buttons)
  • Components - are groups of patterns used to create a UI component (eg. Modals)
  • Layouts - are groups of components used to create application screens (eg. Settings)

All of these separate files are subsequently imported and compiled in app.css.

Front End Standards

  • 4 spaces for HTML & CSS indentation. Never tabs.
  • Double quotes only, never single quotes.
  • Use tags and elements appropriate for an HTML5 doctype (including self-closing tags)
  • Adhere to the Recess CSS property order.
  • Always a space after a property's colon (.e.g, display: block; and not display:block;).
  • End all lines with a semi-colon.
  • For multiple, comma-separated selectors, place each selector on its own line.
  • Use js- prefixed classes for JavaScript hooks into the DOM, and never use these in CSS as per Slightly Obtrusive JavaScript
  • Avoid over-nesting CSS. Never nest more than 3 levels deep.
  • Use comments to explain "why" not "what" (Good: This requires a z-index in order to appear above mobile navigation. Bad: This is a thing which is always on top!)