Adds Filters to Geocoder; Sets options to autoload=false #217

bozdoz · 2023-04-21T03:14:25Z

No description provided.

class.geocoder.php

bozdoz · 2023-04-25T23:54:56Z

Using these new filters, a consumer can handle the addresses themselves:

<?php

function getit($address_key, $plain_address){
  echo "<pre>". "in getit";
  var_dump($address_key);
  var_dump($plain_address);
  echo "</pre>";
}

add_filter( 'leaflet_geocoder_get_cache', 'getit', 10, 2 );

function setit($key, $value){
  echo "<pre>". "in setit";
  var_dump($key);
  var_dump($value);
  echo "</pre>";
}

add_filter( 'leaflet_geocoder_set_cache', 'setit', 10, 2 );

function update_caches($address){
  echo "<pre>". "in update_caches";
  var_dump($address);
  echo "</pre>";
}

add_filter( 'leaflet_geocoder_update_caches', 'update_caches' );

bozdoz · 2023-04-26T00:17:59Z

And the full example, using the filters to do md5 hashing, and transients from #218:

<?php

// theme/functions.php

//
// geocoders save to transients
//
const GEOCACHE_PREFIX = 'lm_';

// get transient
function leaflet_transient_get($key, $plain_address){
  $transient_key = GEOCACHE_PREFIX . md5($key);

  return get_transient( $transient_key );
}

add_filter( 'leaflet_geocoder_get_cache', 'leaflet_transient_get', 10, 2 );

// set transient
function leaflet_transient_set($key, $value){
  $transient_key = GEOCACHE_PREFIX . md5($key);
  set_transient( $transient_key, $value, MONTH_IN_SECONDS );
  
  // return false to avoid saving to options table
  return false;
}

add_filter( 'leaflet_geocoder_set_cache', 'leaflet_transient_set', 10, 2 );

// don't update cache key array
function update_caches($address){
  return false;
}

add_filter( 'leaflet_geocoder_update_caches', 'update_caches' );

// custom cleanup function
function leaflet_remove_caches() {
  global $wpdb;
  
  // _transient_ is prefixed to all transient keys in the options table
  $prefix = '_transient_' . GEOCACHE_PREFIX;
  $prefix = $wpdb->esc_like( $prefix );

  $sql    = "SELECT `option_name` FROM $wpdb->options WHERE `option_name` LIKE '%s'";
  $keys   = $wpdb->get_results($wpdb->prepare($sql, $prefix . '%'), ARRAY_A);

  if (is_wp_error($keys) || !is_array($keys)) {
      return;
  }

  $transient_keys = array_map(function ($key) {
      // Remove '_transient_' from the option name.
      return ltrim($key['option_name'], '_transient_');
  }, $keys);

  foreach ($transient_keys as $transient_name) {
      delete_transient($transient_name);
  }
}

add_action( 'leaflet_geocoder_remove_caches', 'leaflet_remove_caches' );

Seems to work great, refreshing shortcode helper page and clearing geocoder cache from settings

sonarcloud · 2023-05-18T02:55:46Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
106 Code Smells

No Coverage information
0.0% Duplication

bozdoz · 2023-05-18T02:56:24Z

class.geocoder.php

+        $filtered = apply_filters( 'leaflet_geocoder_get_cache', $address_key, $plain_address );
+
+        if ($filtered === $address_key) {
+            return get_transient( $address_key );


alright, I've gone back to transients

bozdoz · 2023-05-18T02:56:45Z

class.geocoder.php

+         */
+        if (apply_filters('leaflet_geocoder_set_cache', $key, $value)) {
+            // get user-defined expiry (maybe this should be an admin option?)
+            $expiry = apply_filters('leaflet_geocoder_expiry', null);


power users can define their own transient expiries

bozdoz · 2023-05-18T02:57:05Z

class.geocoder.php

+            if ($expiry === null) {
+                // stagger caches between 200-400 days to prevent all caches expiring on the same day
+                $stagger = random_int(200, 400);
+                $expiry = DAY_IN_SECONDS * $stagger;


by default, we set expiry randomly between 200 and 400 days

bozdoz · 2023-05-18T02:57:47Z

class.geocoder.php

+
+            // set to 25 year expiry since we never really want it to expire
+            // but omitting expiry causes it to autoload
+            set_transient( self::$locations_key, $locations, YEAR_IN_SECONDS * 25 );


the transient which holds all address keys is 25 years to avoid expiry and avoid autoload

bozdoz · 2023-05-18T02:58:19Z

class.leaflet-map.php

@@ -104,13 +104,34 @@ public static function init() {
     * Leaflet_Map Constructor
     */
    private function __construct() {
+        $this->run_migrations();


run migrations before any other initialization of the plugin

bozdoz · 2023-05-18T02:58:59Z

class.leaflet-map.php

+            return;
+        }
+
+        include_once LEAFLET_MAP__PLUGIN_DIR . 'class.migrations.php';


only include migrations if there's a version mismatch in the db

bozdoz · 2023-05-18T02:59:33Z

class.leaflet-map.php

-        wp_register_style('leaflet_stylesheet', $css_url, Array(), null, false);
-        wp_register_script('leaflet_js', $js_url, Array(), null, true);
+        wp_register_style('leaflet_stylesheet', $css_url, Array(), LEAFLET_MAP__PLUGIN_VERSION, false);
+        wp_register_script('leaflet_js', $js_url, Array(), LEAFLET_MAP__PLUGIN_VERSION, true);


adds plugin version like all the other registered scripts; #222

Actually I don't think this is right. Adding the plugin version rather than the Leaflet JS version means that if the Leaflet JS version is changed then the cache potentially wouldn't know (if the URL was the same). This is why I would opt for apply_filters('leaflet_js_version', Leaflet_Map::$leaflet_version) instead because it would also allow this to be filtered when the version is changed programatically (as we do).

Furthermore, $in_footer is set to true here but line 218 is set to false. I think that both need to be true or both need to be false which is why the JavaScript is breaking when using "Merge + Minify + Refresh" plugin.

Actually I don't think this is right. Adding the plugin version rather than the Leaflet JS version means that if the Leaflet JS version is changed then the cache potentially wouldn't know (if the URL was the same). This is why I would opt for apply_filters('leaflet_js_version', Leaflet_Map::$leaflet_version) instead because it would also allow this to be filtered when the version is changed programatically (as we do).

This makes me think "null" is better here.

Furthermore, $in_footer is set to true here but line 218 is set to false. I think that both need to be true or both need to be false which is why the JavaScript is breaking when using "Merge + Minify + Refresh" plugin.

Hesitant to change this because we've had issues in the past with people running async and deferred scripts.

It makes no odds to me. I've developed around it by directly filtering the global $wp_styles and $wp_scripts. Here is what Wordpress says though (script version not plugin version) https://developer.wordpress.org/reference/functions/wp_register_script/#parameters

$ver string|bool|null Optional
String specifying script version number, if it has one, which is added to the URL as a query string for cache busting purposes. If version is set to false, a version number is automatically added equal to current installed WordPress version.

But "null" will definitely not help the cache at all.

Again, it doesn't bother me if you change the scripts to both be in the header or footer because I've developed around it by directly filtering the global $wp_scripts. We chose to put them both in the footer FYI.

UPDATE: We have changed our position on this and moved both scripts to be loaded in the header instead of the footer. This is because loading them in the footer breaks compatibility with Leaflet.GestureHandling https://elmarquis.github.io/Leaflet.GestureHandling/

bozdoz · 2023-05-18T02:59:44Z

class.leaflet-map.php

@@ -204,7 +225,8 @@ public static function enqueue_and_register()
        // optional ajax geojson plugin
        wp_register_script('tmcw_togeojson', $settings->get('togeojson_url'), Array('jquery'), LEAFLET_MAP__PLUGIN_VERSION, false);

-        if (defined('WP_DEBUG') && WP_DEBUG) {
+        // @since 3.4.0
+        if (defined('LEAFLET_MAP__DEBUG') && LEAFLET_MAP__DEBUG) {


as per #222

bozdoz · 2023-05-18T03:00:42Z

class.migrations.php

+        if (version_compare($db_version, '3.4.0', '<')) {
+            include_once LEAFLET_MAP__MIGRATION_DIR . '001-v3.4.0-geocoder-transients.php';
+
+            migration001();


included above; needs to be a unique migration function name; assuming this is ok; maybe I could use "leaflet_map__" prefix?

bozdoz · 2023-05-18T03:01:23Z

class.migrations.php

+            migration001();
+
+            // update version, if for some reason something fails afterwards, and we want to prevent this migration
+            update_option(LEAFLET_MAP__DB_VERSION_KEY, '3.4.0');


assuming there may be more migrations in the future, we update db asap so this particular migration never refires

bozdoz · 2023-05-18T03:03:49Z

Screenshots of the migration (cycling between master branch and this branch):

v3.3.0

After migration to v3.4.0 (simply by refreshing the browser)

sonarcloud · 2023-09-20T01:28:59Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
69 Code Smells

No Coverage information
0.0% Duplication

moves geocoders to use single transient key

565a298

bozdoz mentioned this pull request Apr 21, 2023

Option to use geocoder client side #213

Open

bozdoz commented Apr 21, 2023

View reviewed changes

class.geocoder.php Outdated Show resolved Hide resolved

bozdoz commented Apr 21, 2023

View reviewed changes

class.geocoder.php Outdated Show resolved Hide resolved

bozdoz added 3 commits April 21, 2023 00:18

deletes transients on cleanup

1d23749

adds filters instead of transients; makes the plugin more pluggable

4c70c70

adds not_found filter

7baf8a6

bozdoz changed the title ~~moves geocoders to use single transient key~~ Adds Filters to Geocoder; Sets options to autoload=false Apr 26, 2023

bozdoz added 3 commits April 25, 2023 21:22

osm is default

b6a7042

adds migration; resolves #222

c95a0de

update to migrations

c38a3d7

bozdoz commented May 18, 2023

View reviewed changes

bozdoz mentioned this pull request May 18, 2023

Add leaflet plug-in version to enquire scripts #222

Open

adds prettier

7f34981

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds Filters to Geocoder; Sets options to autoload=false #217

Adds Filters to Geocoder; Sets options to autoload=false #217

bozdoz commented Apr 21, 2023

bozdoz commented Apr 25, 2023

bozdoz commented Apr 26, 2023

sonarcloud bot commented May 18, 2023

bozdoz May 18, 2023

bozdoz May 18, 2023

bozdoz May 18, 2023

bozdoz May 18, 2023

bozdoz May 18, 2023

bozdoz May 18, 2023

bozdoz May 18, 2023

webd-uk May 18, 2023

webd-uk May 18, 2023

bozdoz May 22, 2023

bozdoz May 22, 2023

webd-uk May 23, 2023

webd-uk May 26, 2023

bozdoz May 18, 2023

webd-uk May 18, 2023

bozdoz May 18, 2023

bozdoz May 18, 2023

bozdoz commented May 18, 2023

sonarcloud bot commented Sep 20, 2023

Adds Filters to Geocoder; Sets options to autoload=false #217

Are you sure you want to change the base?

Adds Filters to Geocoder; Sets options to autoload=false #217

Conversation

bozdoz commented Apr 21, 2023

bozdoz commented Apr 25, 2023

bozdoz commented Apr 26, 2023

sonarcloud bot commented May 18, 2023

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

bozdoz commented May 18, 2023

sonarcloud bot commented Sep 20, 2023