Add a note type for logging post events, that displays inline with user-input internal notes #9
Conversation
*It's still not working quite right, it double-renders new log entries even though only one is created.
When the prepending functionality was in a component within the sidebar, the state didn't get updated correctly if the sidebar was closed. This way even if the Post sidebar is open and you're changing e.g. a post's categories, log notes will still get loaded into state.
source/wp-content/plugins/wporg-internal-notes/src/notes-list/notes-list-item.scss
Outdated
Show resolved
Hide resolved
source/wp-content/plugins/wporg-internal-notes/src/store/reducer.js
Outdated
Show resolved
Hide resolved
source/wp-content/plugins/wporg-internal-notes/src/store/reducer.js
Outdated
Show resolved
Hide resolved
| // Gutenberg doesn't have a specific way to check whether the post was just saved, so we store the | ||
| // previous value of isSaving and when isSaving goes from true -> false, we prepend the notes. | ||
| const postWasJustSaved = prevIsSaving && ! isSaving; | ||
| if ( postWasJustSaved ) { |
There was a problem hiding this comment.
It's important to note that this doesn't make any assumptions as to whether it succeeded. I'm not familiar with all the use cases of this code/plugin, but if you wanted to make sure it succeeded first, check:
select('core/editor').didPostSaveRequestSucceed()
This check does not represent the "next" state after saving so it needs to be checked after a save was performed. For example, if you check this on load, it may return true.
There was a problem hiding this comment.
That's a good point. In this case, though, I don't think it matters whether or not it succeeded. If the routine to prepend more log notes runs, but doesn't find any new logs, it should just fetch an empty array, rather than throwing an error of some kind.
@ryelle That's really odd. It is definitely showing the term names in my local dev environment. When you first create a new post, is there a log showing that the "Uncategorized" category was added? Or is that one blank too? |
|
Honestly I didn't try creating a new post, I was testing on the Hello World post - I removed Uncategorized and added a new category. Oh… I think in both cases (tags and cats) I was adding terms that didn't already exist when the page loaded, could that have something to do with it? |
The totalNotes value that appendNotes receives is inaccurate because it represents found_posts for the offset query. So it's not used. Removing it simplifies the code a touch and avoids confusion.
🤔 I just tried that, and I still got the term names included in the logs... |
|
I'm going to go ahead and merge this, since I can't reproduce the missing term names issue. We can open up a new issue if it reappears. |
…s inline with user-input internal notes (#9) Introduces a second type of note for logging changes to a post. These log notes appear in the sidebar along with user-created internal notes, and can provide extra context to what is happening with a post. On the backend, this plugin provides logging for some generic event types that happen when posts are updated, but the idea is that other plugins can add their own logging as well. In the UI, log notes have a more compact style in the notes list so that they are de-emphasized compared to user-created internal notes. They also can't be deleted. Co-authored-by: Steven Dufresne <steve.dufresne@automattic.com>
Introduces a second type of note for logging changes to a post. These log notes appear in the sidebar along with user-created internal notes, and can provide extra context to what is happening with a post.
On the backend, this plugin provides logging for some generic event types that happen when posts are updated, but the idea is that other plugins (e.g. the Pattern Directory) can add their own logging as well.
In the UI, log notes have a more compact style in the notes list so that they are de-emphasized compared to user-created internal notes. They also can't be deleted.
I have made an attempt to have new log notes appear automatically in the sidebar when changes to a post are saved, but right now, it's causing a problem because the new log is getting loaded twice, even though the note is only getting created once. It must be some kind of race condition with the way React component updates happen, but so far I haven't been able to figure out how to avoid it.Fixed thanks to @StevenDufresneScreencast
https://d.pr/v/iVeFjS
To test
0-sandbox.phpfile has been updated to add post support for the logging. Check out the updated readme for more info about how enabling logging works.