3.0.0 #333

rgomezp · 2024-12-14T01:30:38Z

One line summary

Introduce hybrid support for V2 and V3 of the OneSignal plugin, enabling smooth migration and improved user experience.

Description

This update introduces a hybrid implementation of the OneSignal WordPress plugin to support the transition from V2 to V3. The primary goal is to ensure a seamless migration for existing users while providing a simplified experience for new users.

Key Features and Changes

Migration Flow

Trigger Migration: Users can initiate migration via the "Migration Complete" button on the current configuration page.
Migration Status Update: The onesignal_plugin_migrated option in the database is set to true upon successful migration.
UI Switch: The configuration page is replaced with a simplified dashboard post-migration.

Dynamic Plugin Loading

The plugin dynamically loads the correct version:
- V2 Plugin: Used if onesignal_plugin_migrated is false or unset.
- V3 Plugin: Used if onesignal_plugin_migrated is true.
This approach ensures minimal disruption for existing users while new users directly access V3.

New User Experience

Fresh installations bypass migration entirely and use V3 with a streamlined configuration page.

Supporting Enhancements

Added helpers for migration tasks:
- Configuration Export: Allows users to export settings to a .txt file.
- Complete Migration: Marks migration complete and cleans up old settings.
Updated pre-migration headers to guide users and include a migration button.
Improved form validation and added key-type badges for legacy and rich keys.
Updated API handling to support both legacy and rich authorization keys.
Improved styles and user experience on configuration pages.

Post-Release Cleanup

Legacy V2 code will be removed entirely in a future update to simplify maintenance and reduce technical debt.

This update lays the foundation for ongoing improvements while maintaining stability for current users.

This change is

Motivation: allows users to export their settings to a txt file

Motivation: will allow us to mark the migration as complete in the DB

Motivation: add new header with explanation, migration, button. Clean up stackable menu & outdated tabs.

Motivation: allow us to load the old or new plugin depending on migration status

Motivation: referrer nonce was incorrect & redirect was to the wrong page

Motivation: based on the option `onesignal_plugin_migrated` we serve either the old version or the new one.

complete-migration.php

views/config.php

v2/complete-migration.php

v3/onesignal-admin/onesignal-admin.js

sdk_files/push/onesignal/index.html

v2/onesignal-public.php

marclucraft · 2024-12-16T19:58:33Z

@rgomezp im on my phone, so can't see full context - why are you swapping the v2 code to have v16 SDK, and be defer? Should that not remain as is? V16 is in v3 folder, no?

rgomezp · 2024-12-16T20:07:23Z

@rgomezp im on my phone, so can't see full context - why are you swapping the v2 code to have v16 SDK, and be defer? Should that not remain as is? V16 is in v3 folder, no?

we are loading v16 for v2 also. this will be the simplest way to make things work. if we move the sdk_files into the subdirectories we can break existing integrations

@marclucraft

marclucraft · 2024-12-16T20:16:56Z

@rgomezp im on my phone, so can't see full context - why are you swapping the v2 code to have v16 SDK, and be defer? Should that not remain as is? V16 is in v3 folder, no?

we are loading v16 for v2 also. this will be the simplest way to make things work. if we move the sdk_files into the subdirectories we can break existing integrations

@marclucraft

Got it - So, is the SDK version that is used this based on the plugin version they use? If not, it should be, since folks will be using v15 methods, especially if they have other prompts which they needed to add via custom code.

rgomezp · 2024-12-16T20:32:57Z

Got it - So, is the SDK version that is used this based on the plugin version they use? If not, it should be, since folks will be using v15 methods, especially if they have other prompts which they needed to add via custom code.

Yep plugin versions < 3 will still be on v15 and 3> will use 16. However, if they have custom code + the plugin, it will break when they upgrade to v3. This is fine since it's a major version, but we should consider adding to the docs.

marclucraft · 2024-12-16T21:02:41Z

Cool! where's the logic? Since I can only see a straight swap of the SDK code?

EDIT:
Or if I'm misunderstanding, we are just releasing this with the breaking change?

rgomezp · 2024-12-16T21:15:59Z

Cool! where's the logic? Since I can only see a straight swap of the SDK code?

EDIT: Or if I'm misunderstanding, we are just releasing this with the breaking change?

I suppose it would be breaking for people who are customizing the code instead of just using the plugin dashboard. Is that your concern?

marclucraft · 2024-12-16T21:31:01Z

I suppose it would be breaking for people who are customizing the code instead of just using the plugin dashboard. Is that your concern?

Yes – Since the 'original' V3 wasn't released due to concern for the same breaking change.

Therefore, only after clicking the Migrate button should the SDK version change.

gdeglin · 2024-12-18T22:32:41Z

sdk_files/OneSignalSDKUpdaterWorker.js.php

-		echo "importScripts('https://localhost:3001/dev_sdks/OneSignalSDK.js');";
-	} else {
-		echo "importScripts('https://cdn.onesignal.com/sdks/OneSignalSDKWorker.js');";
-	}


Is removal of this file going to create weird behavior if someone already has this service worker registered and the browser tries to update it?

It shouldn't. We deprecated that some time ago even on the player model so shouldn't be necessary anymore. We use query params to update the worker.

gdeglin · 2024-12-18T22:33:45Z

sdk_files/OneSignalSDKWorker.js

@@ -1 +1 @@
-importScripts('https://cdn.onesignal.com/sdks/OneSignalSDKWorker.js');
+importScripts("https://cdn.onesignal.com/sdks/web/v16/OneSignalSDK.sw.js");


It's a little curious that we have chosen to version our hosted Service Worker. Is there any documentation about why we decided to do this?

We need to support both the player model SDK as well as the new user model SDK which use different workers

gdeglin · 2024-12-18T22:42:36Z

v3/onesignal-metabox/onesignal-metabox.php

+  if (is_wp_error($response)) {
+    error_log('API request failed: ' . $response->get_error_message());
+  }
+  $json = json_decode(wp_remote_retrieve_body($response));


Is this going to break if $response is an error?

It won't break. It'll fail silently

gdeglin · 2024-12-18T22:44:22Z

v3/onesignal-metabox/onesignal-metabox.php

+  <div id="os_options">
+    <label for="os_segment">Send to segment</label>
+    <select name="os_segment" id="os_segment">
+      <option value="All">All</option>


Seems a little odd to have an "All" option hardcoded when most users will also have a "Total Subscribers" segment or similar. Wdyt about removing this hard-coded option?

It's best to have one hardcoded option, in case the segment list isn't returned for any reason.

We have renamed our Default segments over the years, so it's hard to decide on the correct Segment name to choose here.

"All" is what the current plugin uses, so I added this to keep the same behaviour of targeting all subscribed subscriptions.

Motivation: show the v3 plugin to fresh installs and the v2 plugin to existing installs

Motivation: provide more detail on how to complete the migration

Motivation: we want to be able to check if the api key is a legacy key or a "rich" key in order to know what headers to send. We put that method here.

Motivation: we should support legacy and rich keys

Motivation: improve styles and also add a badge denoting what type the key is (legacy or rich). Add form validation via jquery: checks to see if keys are valid

Motivation: get v2 to start using the v16 API

Motivation: to ensure a smooth transition, we will handle SW installation in the plugin. We need to update v3 to do that

rgomezp · 2024-12-19T21:26:46Z

readme.txt

+= 3.0.0 =
+WARNING: this update contains breaking changes.
+We are moving all OneSignal plugin settings to the OneSignal.com dashboard.
+If you have made any OneSignal custom-code modifications (not via UI) updating


WARNING: this update contains changes that may break specific setups, as detailed below:

If you have made any code modifications to your Wordpress installation to directly interact with the OneSignal SDK, this version will break your implementation. Please revert your code modifications prior to upgrading and use our improved dashboard functionality to configure your OneSignal integration instead.

Motivation: notifications are also sent when the post is updated.

Motivation: link to the docs

ezpuzz

Needs link to new docs on the V3 new user settings page
Needs improved release notes to warn about breakage for users with modifications to their installation
Needs improved release line items about why the new version is great
Needs release note that notifications are not sent by default, and the user will have to opt-in per post

Add configuration-export.php helper

02836d2

Motivation: allows users to export their settings to a txt file

rgomezp requested a review from jkasten2 December 14, 2024 01:30

rgomezp added 6 commits December 13, 2024 19:31

Add complete-migration.php helper

672a692

Motivation: will allow us to mark the migration as complete in the DB

Style nits for plugin pre-migration

b3b2b73

Add pre-migration header to config page

e7bbafc

Motivation: add new header with explanation, migration, button. Clean up stackable menu & outdated tabs.

Move entire old plugin to v2 subdirectory

89886b0

Motivation: allow us to load the old or new plugin depending on migration status

Fix migration nonce & redirect

a444dde

Motivation: referrer nonce was incorrect & redirect was to the wrong page

Add V3 plugin files & handle both versions in onesignal.php

70f32ca

Motivation: based on the option `onesignal_plugin_migrated` we serve either the old version or the new one.

rgomezp force-pushed the 3.0.0 branch from 03a2471 to 056f99a Compare December 14, 2024 01:33

rgomezp requested review from marclucraft and sherwinski December 16, 2024 17:51

rgomezp commented Dec 16, 2024

View reviewed changes

rgomezp force-pushed the 3.0.0 branch from 056f99a to eba76c8 Compare December 16, 2024 19:45

rgomezp force-pushed the 3.0.0 branch 3 times, most recently from 070baaf to 4cc3a16 Compare December 17, 2024 21:54

rgomezp requested a review from gdeglin December 18, 2024 00:03

gdeglin reviewed Dec 18, 2024

View reviewed changes

rgomezp added 5 commits December 19, 2024 12:06

Handle new users correctly

8730cb3

Motivation: show the v3 plugin to fresh installs and the v2 plugin to existing installs

Copy Update: Migration Instructions

3896f5c

Motivation: provide more detail on how to complete the migration

onesignal-helpers.php file for validation helper method

115355c

Motivation: we want to be able to check if the api key is a legacy key or a "rich" key in order to know what headers to send. We put that method here.

Use the correct authorization header to support new and old keys

35abe90

Motivation: we should support legacy and rich keys

Update settings page validation and styles

48bd9be

Motivation: improve styles and also add a badge denoting what type the key is (legacy or rich). Add form validation via jquery: checks to see if keys are valid

rgomezp added 4 commits December 19, 2024 12:06

Move sdk_files from nested v2 & v3 directories to top level (original)

8f32ab9

Update SDK initialization & onesignal-public.php code to v16

7275ad0

Motivation: get v2 to start using the v16 API

Address PR Feedback

a361393

Update v3 Plugin Initialization to use plugin-defined SW settings

24b9c97

Motivation: to ensure a smooth transition, we will handle SW installation in the plugin. We need to update v3 to do that

rgomezp force-pushed the 3.0.0 branch 2 times, most recently from ceed42b to 8a06b63 Compare December 19, 2024 18:26

rgomezp requested a review from ezpuzz December 19, 2024 18:32

rgomezp commented Dec 19, 2024

View reviewed changes

rgomezp added 2 commits December 19, 2024 17:41

Add clear warning message about steps 3 and 4

fa797b9

Update language to clarify notification is sent when post is updated

5a5f3e3

Motivation: notifications are also sent when the post is updated.

rgomezp force-pushed the 3.0.0 branch from ab91062 to a9bcf0b Compare December 19, 2024 23:41

rgomezp added 2 commits December 19, 2024 17:42

Getting Started link for new users

86e3987

Motivation: link to the docs

3.0.0 Release Commit

039f557

rgomezp force-pushed the 3.0.0 branch from a9bcf0b to 039f557 Compare December 19, 2024 23:42

ezpuzz approved these changes Dec 19, 2024

View reviewed changes

rgomezp merged commit 31e0d22 into main Dec 19, 2024
1 of 2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

3.0.0 #333

3.0.0 #333

rgomezp commented Dec 14, 2024 •

edited by niels-s

Loading

marclucraft commented Dec 16, 2024

rgomezp commented Dec 16, 2024 •

edited

Loading

marclucraft commented Dec 16, 2024

rgomezp commented Dec 16, 2024

marclucraft commented Dec 16, 2024 •

edited

Loading

rgomezp commented Dec 16, 2024

marclucraft commented Dec 16, 2024 •

edited

Loading

gdeglin Dec 18, 2024

rgomezp Dec 18, 2024

gdeglin Dec 18, 2024

rgomezp Dec 18, 2024

gdeglin Dec 18, 2024

rgomezp Dec 18, 2024

gdeglin Dec 18, 2024

marclucraft Dec 18, 2024

rgomezp Dec 19, 2024 •

edited

Loading

ezpuzz left a comment

		@@ -1 +1 @@
		importScripts('https://cdn.onesignal.com/sdks/OneSignalSDKWorker.js');
		importScripts("https://cdn.onesignal.com/sdks/web/v16/OneSignalSDK.sw.js");

3.0.0 #333

3.0.0 #333

Conversation

rgomezp commented Dec 14, 2024 • edited by niels-s Loading

One line summary

Description

Key Features and Changes

Migration Flow

Dynamic Plugin Loading

New User Experience

Supporting Enhancements

Post-Release Cleanup

marclucraft commented Dec 16, 2024

rgomezp commented Dec 16, 2024 • edited Loading

marclucraft commented Dec 16, 2024

rgomezp commented Dec 16, 2024

marclucraft commented Dec 16, 2024 • edited Loading

rgomezp commented Dec 16, 2024

marclucraft commented Dec 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rgomezp Dec 19, 2024 • edited Loading

Choose a reason for hiding this comment

ezpuzz left a comment

Choose a reason for hiding this comment

rgomezp commented Dec 14, 2024 •

edited by niels-s

Loading

rgomezp commented Dec 16, 2024 •

edited

Loading

marclucraft commented Dec 16, 2024 •

edited

Loading

marclucraft commented Dec 16, 2024 •

edited

Loading

rgomezp Dec 19, 2024 •

edited

Loading