Testing Oomph Preference Synchronization with Eclipse IDE

As part of the Eclipse Foundation's initiative to migrate our Drupal 7 sites to Drupal 9, some of the D7 services are moving to Quarkus. The USS-API (handles all read/write operations for synced data) is one of these services.

In order to further validate functionality, we require some additional testing of the API on staging. Outlined below are the steps to help with this.

NOTE: Upon going live with the D9 implementation for Marketplace, MPC favorite data will be stored on that website, rather than with the USS-API. For this testing phase, we only want to focus on Oomph Preference Synchronization.

Adding the Staging Service URI

• Locate your Eclipse IDE install directory
• Open and edit the eclipse.ini file
• Under the -vmargs section, add the following argument:
  • -Dorg.eclipse.userstorage.serviceURI=https://api-staging.eclipse.org/sandbox

Authorize USS with your Eclipse Account (if this hasn’t already been done)

• Use Window > Preferences > Oomph > Setup Tasks > Preference Synchronizer
• Check the Synchronize with eclipse.org box
• If it does not automatically prompt you for a sign-in, click Synchronize Now
• Sign in to accounts
• Authorize the request
  • You can view/revoke this access in your Eclipse profile page at https://accounts.eclipse.org/users/{ef-username}/storage under the applications tab

To Sync Settings

• Use Navigate > Open Setup > User and click on the Capture Preferences toolbar button.
• Add any desired settings from the left side to the right side
• Click OK
  • The main user.setup panel should display all user preferences being synced
• Click the Record Preferences toolbar button
  • This should reopen the Preference Synchronizer menu
  • OR Use Window > Preferences > Oomph > Setup Tasks > Preference Synchronizer
• Click Synchronize Now
• You can review the updates and change whether you want any preferences to not get synced with eclipse.org
• Click OK
  • Your settings should now be synced

To View Synced Settings

• Click the Record Preferences toolbar button
  • This should reopen the Preference Synchronizer menu
  • OR Use Window > Preferences > Oomph > Setup Tasks > Preference Synchronizer
• Click View Remote Storage to view all synced settings

DB Confirmation(Only for webdev staff with access to staging data)

• You can take a look at the staging DB to view all api_eclipse_api_blob_application_usage records that were created while performing the read/write operations
  • You can filter these entries by UID
• You should be able to see an entry with your UID in the api_eclipse_api_blob table with an updated changed field