Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AI Assistant: Load Breve spelling dictionaries from CDN #38943

Merged
merged 6 commits into from
Aug 21, 2024

Conversation

dhasilva
Copy link
Contributor

@dhasilva dhasilva commented Aug 16, 2024

Fixes #38887

Proposed changes:

  • Loads the dictionary JSON from the backend, saving it to localStorage and reusing it on page refreshes

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:

  • Without sandboxing the public API, go to the block editor, with the Spelling Mistakes feature turned on
  • Check that the dictionary fails to load, but nothing breaks
  • Apply D158668-code and sandbox the public API
  • Reload the block editor
  • Check that the dictionary is loaded, with only one request to the endpoint. Note: The highlights are not properly re-loaded, but they appear if you click on a block. This will be tackled later.
  • Reload the page
  • Check that the dictionary is loaded from localStorage, without any requests
  • Check that the typos are highlighted

Copy link
Contributor

github-actions bot commented Aug 16, 2024

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-breve-load-dictionary-from-server branch.

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

    bin/jetpack-downloader test jetpack update/jetpack-ai-breve-load-dictionary-from-server
    

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 github-actions bot added the [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ label Aug 16, 2024
Copy link
Contributor

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:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. 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.
  3. 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 daily.
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for September 3, 2024 (scheduled code freeze on September 2, 2024).

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

CGastrell
CGastrell previously approved these changes Aug 19, 2024
Copy link
Contributor

@CGastrell CGastrell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code looks good and works as described. Nice implementation!

@CGastrell CGastrell added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Team Review labels Aug 19, 2024
@dhasilva dhasilva force-pushed the update/jetpack-ai-breve-load-dictionary-from-server branch from 7cff8c4 to e518698 Compare August 20, 2024 22:17
@dhasilva dhasilva changed the title AI Assistant: Load Breve spelling dictionaries from endpoint AI Assistant: Load Breve spelling dictionaries from CDN Aug 20, 2024
Copy link
Contributor

@CGastrell CGastrell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Load works nicely

@dhasilva dhasilva enabled auto-merge (squash) August 21, 2024 15:27
@dhasilva dhasilva merged commit e2e6b98 into trunk Aug 21, 2024
55 checks passed
@dhasilva dhasilva deleted the update/jetpack-ai-breve-load-dictionary-from-server branch August 21, 2024 15:37
@github-actions github-actions bot added this to the jetpack/13.8 milestone Aug 21, 2024
@github-actions github-actions bot removed the [Status] Ready to Merge Go ahead, you can push that green button! label Aug 21, 2024
pkuliga pushed a commit that referenced this pull request Aug 23, 2024
* add function to get dictionary from endpoint

* load the spelling dictionary context from the backend

* changelog

* change endpoint to CDN

* update changelog
gogdzl pushed a commit that referenced this pull request Oct 25, 2024
* add function to get dictionary from endpoint

* load the spelling dictionary context from the backend

* changelog

* change endpoint to CDN

* update changelog
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Extension] AI Assistant Plugin [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/
Projects
None yet
Development

Successfully merging this pull request may close these issues.

AI Assistant: Load Breve's grammar dictionary asynchronously
2 participants