Write Brief: Load unconfident words from backend and update caching #39975

dhasilva · 2024-10-30T19:42:57Z

Fixes ##39899

Proposed changes:

Renames files to kebab-case
Moves the dictionary fetching mechanism to a separate file
Checks a file's last-modified header value for cache invalidation, making a HEAD request once when opening the editor
Moves the unconfident words list to the backend

Other information:

Have you written new tests for your changes, if applicable?
Have you checked the E2E test CI results, and verified that your changes do not break them?
Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

Checkout this branch, open a new browser tab with the developer console open, make sure to have debug enabled with localStorage.setItem( 'debug', '*' );.
Open the block editor
Check the debug messages. For the spelling mistakes and unconfident words features you should see those messages:
- Fetching feature data for type: <feature>. language: en
- Loaded data from server <feature> en
Check that the localStorage entries for both features are populated with requestTime and data.
Check that the previous localStorage entry for the spelling mistakes (jetpack-ai-breve-spelling-context-en) is removed
Check the network tab. You should see two requests for en.json, one for each feature.
Reload the page
You should see those messages:
- Fetching feature data for type: <feature>. language: en
- Data not modified <feature> en
- Loaded data from local storage <feature> en
Check that those features are working as expected
Sandbox s0.wp.com, s1.wp.com and s2.wp.com
Change the content of one of those files
Reload the page
The cache should invalidate and the files should be requested again

github-actions · 2024-10-30T19:43:49Z

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the update/jetpack-ai-write-brief-unconfident-dictionary branch.

To test on Simple, run the following command on your sandbox:

bin/jetpack-downloader test jetpack update/jetpack-ai-write-brief-unconfident-dictionary

Interested in more tips and information?

In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
Read more about our development workflow here: PCYsg-eg0-p2
Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

github-actions · 2024-10-30T19:43:55Z

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

✅ Include a description of your PR changes.
✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
✅ Add testing instructions.
✅ Specify whether this PR includes any changes to data or privacy.
✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

Follow this PR Review Process:

Ensure all required checks appearing at the bottom of this PR are passing.
Choose a review path based on your changes:
- A. Team Review: add the "[Status] Needs Team Review" label
  - For most changes, including minor cross-team impacts.
  - Example: Updating a team-specific component or a small change to a shared library.
- B. Crew Review: add the "[Status] Needs Review" label
  - For significant changes to core functionality.
  - Example: Major updates to a shared library or complex features.
- C. Both: Start with Team, then request Crew
  - For complex changes or when you need extra confidence.
  - Example: Refactor affecting multiple systems.
Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).
WoA releases happen weekly.
Releases to self-hosted sites happen monthly. The next release is scheduled for November 5, 2024 (scheduled code freeze on November 4, 2024).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

dhasilva · 2024-10-30T19:54:12Z

...ns/jetpack/extensions/plugins/ai-assistant-plugin/components/breve/utils/get-feature-data.ts

+	// The If-Modified-Since header causes a CORS preflight request error, so we need to check manually
+	if ( lastRequested ) {
+		const headData = await fetch( url, { method: 'HEAD' } );
+		const lastModified = headData.headers.get( 'last-modified' );


The etag should be more precise, but it is always null for some reason, even though I can see it in the browser tools 🤔

That's because CORS requests have limited headers that are accessible. If we can set access-control-expose-headers server side (not sure how feasible this is) then we can add etag there and will have access to it.

mwatson

I could not get the debug messages to show up consistently, but everything else behaved as described. I added an extra word to the unconfident words, reloaded, and it appeared. Subsequent refreshes I only saw the HEAD request. If I modified the dictionary again and reloaded then I saw the HEAD + GET requests. Nice work! 👍

CGastrell · 2024-10-31T16:47:42Z

I could not get the debug messages to show up consistently

did you enable “all” messages on devtool console. For some reason debug package logs outside of error/warning/info scope, so you need to select “all” messages

mwatson · 2024-11-01T13:53:39Z

I could not get the debug messages to show up consistently

did you enable “all” messages on devtool console. For some reason debug package logs outside of error/warning/info scope, so you need to select “all” messages

Yeah I have noticed that, and also Chrome sometimes defaults to not showing "All" even though I have clicked it numerous times. I did initially see some debug messages (not the ones Douglas described) but they didn't come up after the initial load. Everything worked exactly as described, so it's entirely possible I did not have "All" clicked and just didn't notice 😅

dhasilva added 5 commits October 30, 2024 16:22

rename files

ba5f7c5

refactor dictionary loading to allow caching invalidation

9f14392

change unconfident words to load from backend

bb673ca

clear old spelling context local storage key

dd3ee49

changelog

4da21cf

dhasilva added the [Status] Needs Team Review label Oct 30, 2024

dhasilva requested a review from a team October 30, 2024 19:42

dhasilva self-assigned this Oct 30, 2024

github-actions bot added [Extension] AI Assistant Plugin [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Oct 30, 2024

dhasilva commented Oct 30, 2024

View reviewed changes

mwatson approved these changes Oct 31, 2024

View reviewed changes

dhasilva merged commit aff8e92 into trunk Oct 31, 2024
58 checks passed

dhasilva deleted the update/jetpack-ai-write-brief-unconfident-dictionary branch October 31, 2024 21:45

github-actions bot removed the [Status] Needs Team Review label Oct 31, 2024

github-actions bot added this to the jetpack/14.0 milestone Oct 31, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Write Brief: Load unconfident words from backend and update caching #39975

Write Brief: Load unconfident words from backend and update caching #39975

dhasilva commented Oct 30, 2024

github-actions bot commented Oct 30, 2024 •

edited

Loading

github-actions bot commented Oct 30, 2024

dhasilva Oct 30, 2024

mwatson Oct 31, 2024

mwatson left a comment

CGastrell commented Oct 31, 2024

mwatson commented Nov 1, 2024

Write Brief: Load unconfident words from backend and update caching #39975

Write Brief: Load unconfident words from backend and update caching #39975

Conversation

dhasilva commented Oct 30, 2024

Proposed changes:

Other information:

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

github-actions bot commented Oct 30, 2024 • edited Loading

github-actions bot commented Oct 30, 2024

dhasilva Oct 30, 2024

Choose a reason for hiding this comment

mwatson Oct 31, 2024

Choose a reason for hiding this comment

mwatson left a comment

Choose a reason for hiding this comment

CGastrell commented Oct 31, 2024

mwatson commented Nov 1, 2024

github-actions bot commented Oct 30, 2024 •

edited

Loading