Add custom domain support with tests; add compat test to Circle CI #505

joshcanhelp · 2018-07-23T18:44:37Z

Main purpose of this PR is to add a field for custom domains and application code to use the custom domain properly.

Follows guidance from the Auth0 docs on custom domains and the additional configuration docs. In summary: all auth-level domains were changed to the custom domain but management API calls remain pointing to the tenant domain (would appreciate a review of how this is being used as well).

Also:

Add WP_Auth0::get_tenant_region() to get the tenant region from a domain
Add WP_Auth0::get_tenant() to get the full tenant name from a domain
Add WP_Auth0_Options::get_auth_domain() to get a custom domain, if saved, falling back to main domain
Tests!
Add test-specific code quality checks
Fix 2 whitespace-caused issues

joshcanhelp · 2018-07-23T20:08:50Z

assets/js/admin.js

@@ -41,7 +41,7 @@ jQuery(document).ready(function($) {
 // Show/hide field for specific switches
 $('[data-expand!=""]').each( function() {
 var $thisSwitch = $( this );
- var $showFieldRow = $( '#' + $thisSwitch.attr( 'data-expand' ) ).closest( 'tr' );
+ var $showFieldRow = $( '#' + $thisSwitch.attr( 'data-expand' ).trim() ).closest( 'tr' );


Found an issue with whitespace formatting 😮 corrected the issue but this will prevent it from happening again.

joshcanhelp · 2018-07-23T20:08:56Z

assets/js/admin.js

@@ -94,7 +94,7 @@ jQuery(document).ready(function($) {
 // Set the tab showing on the form and persist the tab
 $( '.js-a0-settings-tabs' ).click( function () {
 window.location.hash = '';
- var tabHref = $( this ).attr( 'aria-controls' );
+ var tabHref = $( this ).attr( 'aria-controls' ).trim();


Found an issue with whitespace formatting 😮 corrected the issue but this will prevent it from happening again.

joshcanhelp · 2018-07-23T20:09:06Z

assets/js/lock-init.js

- var Lock = opts.usePasswordless
- ? new Auth0LockPasswordless( opts.clientId, opts.domain, opts.settings )
- : new Auth0Lock( opts.clientId, opts.domain, opts.settings );
+ var Lock = opts.usePasswordless ?


IDE found an issue here.

joshcanhelp · 2018-07-23T20:10:24Z

circle.yml

@@ -19,6 +19,7 @@ test:
 phpcs --config-set installed_paths $HOME/.composer/vendor/wp-coding-standards/wpcs,$HOME/.composer/vendor/wimg/php-compatibility
 override:
 - phpcs --standard=$HOME/wp-auth0/phpcs-compat-ruleset.xml $HOME/wp-auth0 -pn -d memory_limit=-1
+ - phpcs --standard=$HOME/wp-auth0/phpcs-test-ruleset.xml $HOME/wp-auth0/tests -pn -d memory_limit=-1


Add a specific code standard test config to Circle. Allows for a higher version of PHP.

joshcanhelp · 2018-07-23T20:10:36Z

composer.json

@@ -32,10 +32,12 @@
 "scripts": {
 "compat": "./vendor/bin/phpcs --standard=phpcs-compat-ruleset.xml .",
 "phpcs": "./vendor/bin/phpcs --standard=phpcs-ruleset.xml -s .",
+ "phpcs-tests": "./vendor/bin/phpcs --standard=phpcs-test-ruleset.xml -s ./tests/",


Add a specific code standard test config to Circle. Allows for a higher version of PHP.

joshcanhelp · 2018-07-23T20:11:13Z

lib/WP_Auth0_Lock10_Options.php

 */
- public function __construct( $extended_settings = array() ) {
- $this->wp_options = WP_Auth0_Options::Instance();
+ public function __construct( $extended_settings = array(), $opts = null ) {


Dependency injection to help with testing. I would have just refactored or added a new class but not sure if Lock is sticking around in the plugin.

joshcanhelp · 2018-07-23T20:12:21Z

lib/WP_Auth0_Lock10_Options.php

@@ -190,6 +191,14 @@ public function get_lock_options() {
 $extraOptions['auth']['redirectUrl'] = $this->get_code_callback_url();
 }

+ if ( $this->wp_options->get( 'custom_domain' ) ) {


Add the correct CDN base URL if we're using a custom domain.

joshcanhelp · 2018-07-23T20:14:18Z

lib/WP_Auth0_LoginManager.php

 $client_id = $this->a0_options->get( 'client_id' );
 $client_secret = $this->a0_options->get( 'client_secret' );
 $userinfo_resp_code = null;
 $userinfo_resp_body = null;

 // Exchange authorization code for an access token.
 $exchange_resp = WP_Auth0_Api_Client::get_token(
- $domain, $client_id, $client_secret, 'authorization_code', array(
+ $auth_domain, $client_id, $client_secret, 'authorization_code', array(


Switch to using a custom domain for the auth code exchange.

joshcanhelp · 2018-07-23T20:16:25Z

lib/WP_Auth0_LoginManager.php

@@ -547,7 +548,7 @@ public function logout() {
 $telemetry_headers = WP_Auth0_Api_Client::get_info_headers();
 $redirect_url = sprintf(
 'https://%s/v2/logout?returnTo=%s&client_id=%s&auth0Client=%s',
- $this->a0_options->get( 'domain' ),
+ $this->a0_options->get_auth_domain(),


Switch to a custom domain for logout

joshcanhelp · 2018-07-23T20:16:37Z

lib/WP_Auth0_LoginManager.php

@@ -266,7 +267,7 @@ public function redirect_login() {
 // Management API call failed, fallback to userinfo.
 if ( 200 !== $userinfo_resp_code || empty( $userinfo_resp_body ) ) {

- $userinfo_resp = WP_Auth0_Api_Client::get_user_info( $domain, $access_token );
+ $userinfo_resp = WP_Auth0_Api_Client::get_user_info( $auth_domain, $access_token );


Switch to using a custom domain for the userinfo call.

joshcanhelp · 2018-07-23T20:17:10Z

lib/WP_Auth0_LoginManager.php

@@ -436,7 +437,7 @@ public function login_user( $userinfo, $id_token = null, $access_token = null, $
 }

 wp_update_user(
- array(
+ (object) array(


Casting to an object to avoid an IDE error (bad docblock on WordPress core)

joshcanhelp · 2018-07-23T20:18:17Z

lib/initial-setup/WP_Auth0_InitialSetup_AdminUser.php

@@ -9,10 +9,6 @@ public function __construct( WP_Auth0_Options $a0_options ) {
 }

 public function render( $step ) {
- $client_id = $this->a0_options->get( 'client_id' );


Deleted some, moved the rest to the template.

joshcanhelp · 2018-07-23T20:19:50Z

templates/auth0-singlelogout-handler.php

@@ -20,7 +20,7 @@

 var webAuth = new auth0.WebAuth({
 clientID:'<?php echo sanitize_text_field( $this->a0_options->get( 'client_id' ) ); ?>',
- domain:'<?php echo sanitize_text_field( $this->a0_options->get( 'domain' ) ); ?>'
+ domain:'<?php echo sanitize_text_field( $this->a0_options->get_auth_domain() ); ?>'


Make sure our SLO check matches the login.

joshcanhelp · 2018-07-23T20:20:30Z

templates/auth0-sso-handler-lock10.php

@@ -4,42 +4,44 @@
 $domain = $lock_options->get_domain();
 ?>
 <script type="text/javascript">
-document.addEventListener("DOMContentLoaded", function() {


Mostly code quality stuff but also corrected another whitespace snafu 😮

joshcanhelp · 2018-07-23T20:21:04Z

tests/testWPAuth0Options.php


 // Make sure the number of options has not changed unintentionally.
- $this->assertEquals( 66, count( $opts->get_options() ) );
+ $this->assertEquals( 67, count( $opts->get_options() ) );


Added a setting 🎉

joshcanhelp · 2018-07-23T20:22:17Z

tests/testWPAuth0Options.php

@@ -47,6 +49,7 @@ public function testThatFiltersOverrideValues() {
 $opts = new WP_Auth0_Options();

 add_filter(
+ // phpcs:ignore


Ignore unused var in the function

joshcanhelp · 2018-07-23T20:24:40Z

lib/WP_Auth0_LoginManager.php

@@ -110,7 +110,7 @@ public function login_auto() {
 $connection = apply_filters( 'auth0_get_auto_login_connection', $this->a0_options->get( 'auto_login_method' ) );
 $auth_params = self::get_authorize_params( $connection );

- $auth_url = 'https://' . $this->a0_options->get( 'domain' ) . '/authorize';
+ $auth_url = 'https://' . $this->a0_options->get_auth_domain() . '/authorize';


Switch to using a custom domain for auto-login /authorize link

cocojoe · 2018-07-27T09:51:32Z

WP_Auth0.php

+ *
+ * @return string
+ */
+ public static function get_tenant_region( $domain ) {


Could you just regexp for this so not hardcoded checks?

That's not a bad idea, actually ... would make this more future-proof if we add additional regions. I'll add, rebase, and re-submit.

@cocojoe - Much better with regex and can handle new regions 👍 thanks for the suggestion. Tests added.

cocojoe

Getting all emotional seeing tests start to appear in this repo 😂

cocojoe · 2018-07-27T09:54:33Z

@joshcanhelp also rebase please

cocojoe

LGTM

joshcanhelp added the work in progress label Jul 23, 2018

joshcanhelp added this to the v3-Next milestone Jul 23, 2018

joshcanhelp force-pushed the add-custom-domain-support branch 2 times, most recently from 27f8209 to a911acb Compare July 23, 2018 20:07

joshcanhelp added the CH: Added label Jul 23, 2018

joshcanhelp commented Jul 23, 2018

View reviewed changes

joshcanhelp removed the work in progress label Jul 23, 2018

cocojoe reviewed Jul 27, 2018

View reviewed changes

Add custom domain support with tests; add compat test to Circle CI

e448958

joshcanhelp force-pushed the add-custom-domain-support branch from a911acb to e448958 Compare July 27, 2018 14:49

Refactor tenant region to use regex + tests; fix js error

c5b7a09

cocojoe approved these changes Jul 30, 2018

View reviewed changes

joshcanhelp merged commit e072d1e into dev Jul 30, 2018

joshcanhelp deleted the add-custom-domain-support branch July 30, 2018 17:39

github-actions bot locked as resolved and limited conversation to collaborators Sep 19, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add custom domain support with tests; add compat test to Circle CI #505

Add custom domain support with tests; add compat test to Circle CI #505

joshcanhelp commented Jul 23, 2018 •

edited

Loading

joshcanhelp Jul 23, 2018

joshcanhelp Jul 23, 2018

joshcanhelp Jul 23, 2018

joshcanhelp Jul 23, 2018

joshcanhelp Jul 23, 2018

joshcanhelp Jul 23, 2018

joshcanhelp Jul 23, 2018

joshcanhelp Jul 23, 2018

joshcanhelp Jul 23, 2018

joshcanhelp Jul 23, 2018

joshcanhelp Jul 23, 2018

joshcanhelp Jul 23, 2018

joshcanhelp Jul 23, 2018

joshcanhelp Jul 23, 2018

joshcanhelp Jul 23, 2018

joshcanhelp Jul 23, 2018

joshcanhelp Jul 23, 2018

cocojoe Jul 27, 2018

joshcanhelp Jul 27, 2018

joshcanhelp Jul 27, 2018

cocojoe left a comment

cocojoe commented Jul 27, 2018

cocojoe left a comment

Add custom domain support with tests; add compat test to Circle CI #505

Add custom domain support with tests; add compat test to Circle CI #505

Conversation

joshcanhelp commented Jul 23, 2018 • 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

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

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

cocojoe left a comment

Choose a reason for hiding this comment

cocojoe commented Jul 27, 2018

cocojoe left a comment

Choose a reason for hiding this comment

joshcanhelp commented Jul 23, 2018 •

edited

Loading