When tracing the settings for active_style_css, it looks like it is loading multiple times… need to investigate later for possible performance improvements.
Call 1
Call 2
Call 3
Call 4
Call 5
Multiple Settings Loading Calls (active_style_css)
Prod v Stage Settings Testing
WordPress / SaaS Menu Ordering
WordPress
add_menu_page()
add_menu_page(
string $page_title,
string $menu_title,
string $capability,
string $menu_slug,
callable $callback = ”,
string $icon_url = ”,
int|float $position = null
): stringWordPress Default Admin Menu Positions
| Standard | Network Admin |
|---|---|
| 2 – Dashboard | 2 – Dashboard |
| 4 – Separator | 4 – Separator |
| 5 – Posts | 5 – Sites |
| 10 – Media | 10 – Users |
| 15 – Links | 15 – Themes |
| 20 – Pages | 20 – Plugins |
| 25 – Comments | 25 – Settings |
| 30 – Updates | |
| 59 – Separator | |
| 60 – Appearance | |
| 65 – Plugins | |
| 70 – Users | |
| 75 – Tools | |
| 80 – Settings | |
| 99 – Separator | 99 – Separator |
add_submenu_page()
SaaS Menu Positions
| Standard / User | Network Admin |
|---|---|
| 1.10 – MySLP myslp-dashboard | 1.10 – Manage MYSLP_MANAGE_MENU_SLUG ‘myslp-manage-menu’ 10 – Customers 30 – History Log 50 – Cron : System 51 – Cron : User 80 – Database 70 – Addressess |
| 1.20 – Store Locator Plus® csl-slplus | |
| 1.30 – Config MYSLP_CONFIG_MENU_SLUG ‘myslp-config-menu’ 10 – Plans 15 – Plan Limits 20 – Plugins 25 – Email Settings 30 – Payments 70 – System Settings 80- Cache | |
| 2 – Dashboard | 2 – Dashboard |
| 4 – Separator | 4 – Separator |
| 5 – Posts | 5 – Sites |
| 10 – Media | 10 – Users |
| 15 – Links | 15 – Themes |
| 20 – Pages | 20 – Plugins |
| 25 – Comments | 25 – Settings |
| 30 – Updates | |
| 59 – Separator | |
| 60 – Appearance | |
| 65 – Plugins | |
| 70 – Users | |
| 75 – Tools | |
| 80 – Settings | |
| 99 – Separator | 99 – Separator |
Select STYLE or Make Changes Deprecated Error
If you change settings in Staging , Under Map or View get errors , example:
Deprecated: Calling get_class() without arguments is deprecated in
mu-plugins/store-locator-plus/include/module/admin_tabs/SLP_BaseClass_Admin.php on line 592
Reproduction
- Login or switch to Feeding America San Diego on local develop (or staging)
- Select a new Locator Style (“Feeding America”)
- Click Select
Dev Notes
Added get_class($this) to the method in SLP_BaseClass_Admin on line 592 as required by PHP 8.
SaaS Hooks Calls
See Lance Cleveland’s WordPress Hooks Order Of Precedence.
Processing Modes
Base Loop
Generic WordPress + MySLP processing of a page request.
- WordPress : muplugins_loaded
- WordPress : registered_taxonomy
- WordPress : registered_post_type
- WordPress : plugins_loaded
- WordPress : set_current_user
- WordPress : init
- SLP : slp_init_complete
- SLP: start_slp_specific_setup
- SLP: finish_slp_specific_setup
- SLP : slp_init_complete
- WordPress : parse_request
- WordPress : rest_api_init
- WordPress : send_headers
WordPress : plugins_loaded
Fires once activated plugins have loaded. The hook is generally used for immediate filter setup, or plugin overrides. The plugins_loaded action hook fires early, and precedes the setup_theme, after_setup_theme, init and wp_loaded action hooks.
Used By
- MySLP_Dashboard_Controller :: load_hooks()
- add_action( ‘plugins_loaded’, array( CLASS, ‘plugins_loaded’ ) );
WordPress : set_current_user
WordPress : init
Fires after WordPress has finished loading but before any headers are sent. Most of WP is loaded at this stage, and the user is authenticated.
Used By
- Site_Architect::__construct()
- add_action( ‘init’, array( $this, ‘sa_start_session’ ) );
- add_action( ‘init’, array( $this, ‘sa_start_session’ ) );
- SLP_Actions:initialize()
- add_action( ‘init’, array( $this, ‘init’ ), 11 );
Sets up the slplus->database object with slplus->database = SLP_Data::get_instance().
This needs to happen AFTER the WoredPress:set_current_user is called so MySLP has the proper user meta to set the database attributes.
- add_action( ‘init’, array( $this, ‘init’ ), 11 );
- MySLP::add_hooks()
- add_action( ‘init’, array( $this, ‘perform_init_actions’ ) );
User Logged In Traced Calls
- Site_Architect::sa_start_session()
- SLP_Actions::init()
- MySLP::perform_init_actions()
SLP : slp_init_complete
Executed during WordPress : init hook via SLP_Actions::init() after all of the main SLP plugin init stuff has been executed.
Used By
- \MySLP_Dashboard_Controller::load_hooks()
add_action( 'slp_init_complete', array( __CLASS__, 'slp_init_complete' ) );
- SLP_BaseClass_Addon :: initialize()
- add_action( ‘slp_init_complete’, array( $this, ‘slp_init’ ) );
- SLP_Power_Pages :: add_hooks_and_filters()
- add_action( ‘slp_init_complete’ , array( $this , ‘do_when_slp_ready’ ) , 11 ); // 11 ensures the base slp_init has run for the addon
WordPress : parse_request
Used By
- WordPress : rest_api_loaded
in wordpress/wp-includes/rest-api.php
this eventually calls the REST custom endpoint permission_callback
WordPress : rest_api_init
Called when processing a REST API call.
slp_ajax_response
Used By
\SLP_Premier_AJAX::add_ajax_hooks()
Invoked By
\SLP_AJAX::renderJSON_Response()
slp_ajaxsql_fullquery
Used By
\SLP_Experience_AJAX::add_ajax_hooks()
\SLP_Premier_AJAX::add_ajax_hooks()
Invoked By
\SLP_AJAX::execute_location_query()
slp_rest_geocode_invalid_referer
Invoked By
\SLP_REST_Handler::valid_referer() for any site that is not coming from get_site_url() or get_home_url(). This is run via the WordPress REST API handler via the register_rest_route() for the readable request for geocoding at the wp-json/store-locator-plus/v2/geocode/<address> endpoint. This happens via the permission_callback property.
ECS Container Cannot Connect To Internet
Recently stood up a new ECS container for the Store Locator Plus® staging app. We can connect to the app and login, but the app cannot talk to the outside world. It is not connecting to WordPress news service and cannot validate a WP SMTP Pro license.
This is the notebook for resolving that issue.
Research
Use Private Subnets : Stack Overflow
A Stack Overflow article that nearly describes our situation.
You are using the awsvpc network mode. This means that each ECS task gets its own Elastic Network Interface (ENI). With this configuration, the ECS tasks do not use the underlying EC2 instance’s network connection, they have their own network connection, with their own IP addresses.
- You are currently disabling public IP assignment to your ECS tasks in the ECS service
network_configurationblock. You will need to changeassign_public_iptotruein order to have ECS assign public IP addresses to the ECS Task’s ENIs, so that the ECS tasks can access resources outside of the VPC.
- I forgot you can’t use public IP with
awsvpcECS deployed to EC2. You can only do that with Fargate deployments. So your options are to use a different network mode, so you can use the EC2 instance’s public IP from your ECS task: docs.aws.amazon.com/AmazonECS/latest/bestpracticesguide/… or switch to private subnets and a NAT Gateway.
- I forgot you can’t use public IP with
Amazon ECS Networking Documents
Enable VPC internet access using internet gateways
“An internet gateway enables resources in your public subnets (such as EC2 instances) to connect to the internet if the resource has a public IPv4 address or an IPv6 address. “
Configuration for Internet Access
- Add a route to the route table for the subnet that directs internet-bound traffic to the internet gateway.
- Ensure that instances in your subnet have a public IPv4 address or IPv6 address. For more information, see Instance IP addressing in the Amazon EC2 User Guide.
- Ensure that your security groups and network access control lists allow the desired internet traffic to flow to and from your instances.
Connect Amazon ECS applications to the internet
ECS Stack
EC2 Instance
- ID i-0a1fa80a12dda9903
- VPC: vpc-1b5e2c7c (slp-cluster-vpc)
- Route Table: rtb-f0a96096 (slp-cluster-default-router)
- 0.0.0.0/0 => igw-ab334cf
- Route Table: rtb-f0a96096 (slp-cluster-default-router)
- Security Group: sg-020cdb78 (default)
- Network ACL: acl-e088aa87 (slp-cluster-acl)
- EC2 Subnet: subnet-7b232951 (slp-cluster-east-1c)
ECS Service Details
Task Definition: slp_saas_staging:4
arn:aws:ecs:us-east-1:744590032041:task-definition/slp_saas_staging:4
Load Balancer: application load balancer myslp-staging-alb
arn:aws:elasticloadbalancing:us-east-1:744590032041:loadbalancer/app/myslp-staging-alb/2eae5893f2db5c1b
Target Group: ecs-myslp-staging-target
arn:aws:elasticloadbalancing:us-east-1:744590032041:targetgroup/ecs-myslp-staging-target/331cd16e4b3c52e1
VPC: slp-cluster-vpc
From AWS Support
Summary of problem
ECS instances using AWSVPC have no public IP address on the running instance/container and thus cannot route through the Internet Gateway despite it being on the VPC and subnet where the EC2 instance and container are attached.
Resolution Summary
To resolve this issue, we need to separate the subnets for your ECS tasks and the ALB, and configure the routing appropriately.
Keep Existing ALB / IG Subnets Unchanged
Keep the existing public subnet(s) for your ALB unchanged, with the Internet Gateway attached.
myslp-staging-alb
DNS Name: myslp-staging-alb-1533129727.us-east-1.elb.amazonaws.com
VPC: slp-cluster-vpc (vpc-1b5e2c7c)
Subnets:
slp-cluster-east-1a : subnet-7c8a8124 us-east-1a (use1-az6)
slp-cluster-east-1c : subnet-7b232951 us-east-1c (use1-az2)
slp-cluster-east-1d : subnet-5213e91b us-east-1d (use1-az4)
slp-cluster-east-1e : subnet-d00210ed us-east-1e (use1-az3)
Internet Gateway: slp-cluster-gateway (igw-ab3d34cf)
attached to slp-cluster-vpc
Create A NAT Gateway
Create New Private Subnets To Match The Public Subnets
Create A New Route Table And Associate With The Private Subnets
And add a route to the general internet (0.0.0.0/0) that goes through the NAT gateway.
ECS Service Changes
Note: You cannot update the network configuration of an existing ECS service. Therefore, you need to recreate the service.
Put the new service on the private subnets only.
Autoscaling Group Updates
Update the auto scaling group to add the private subnet with the NAT gateway.
Resolution Summary
The container using AWSVPC will not have a public IP address. That means the automatic routing for outbound connections will never use the Internet Gateway.
You need to setup a VPC with a public subnet (we have 4 zones , A C D E) and private subnet in those same zones.
The cluster will setup an automatic scaling group, something like Infra-ECS-Cluster….* which will define the Auto Scaling group via the infrastructure subcomponent of the cluster.
The Auto Scaling Group(ASG) needs to include both the private and public subnets.
The EC2 instances it spins up can be in the private subnet (let ASG decide).
The cluster service will setup the application load balancer (ALB) and target group. The service must be placed in the private subnet only. This will ensure the subsequent tasks (container instances) run on the private subnet. The ALB that is created must be assigned to the public subnets on the VPC to allow general inbound traffic from the internet to find its way over to the container on the private subnet. As a side note, the target group listens on HTTPS port 443 and routes to the container HTTP port 80. Use the service to create the ALB and target groups.
On the VPC…
Make sure the default routing table is explicitly assigned to the public subnets and NOT the private subnets.
Create an Internet Gateway (IG) and attach it to the VPC. This will allow inbound traffic from the internet to any service on the VPC with a public IP, in our case the application load balancer listener on port 443.
Create a NAT Gateway. Assign all the private subnets to be part of the NAT Gateway.
Create a second routing table and assign the private subnets to this table. Add a route to 0.0.0.0/0 that goes through the NAT Gateway.
If there are any tasks, containers, or EC2 instances already running stop and reinstantiate each of them. If the service was created originally on the public subnet of the VPC it will need to be deleted and recreated on the private VPC subnets.
Updating Staging SaaS Server
This process is for updating the staging Store Locator Plus® SaaS server running on an ECS cluster after performing code updates.
These processes require a locally installed copy of the MySLP AWS ECS Kit repository which can be found at ssh://git-codecommit.us-east-1.amazonaws.com/v1/repos/myslp_aws_ecs_kit.
Edit your code or deployment kit files first. This can include WordPress plugins or themes, the Docker composer or image builder commands, helper scripts, or various configuration files used to manage and deploy the Store Locator Plus® SaaS container images.
Once your updates are ready, make sure the WordPress stack is up-to-date by updating the submodule links, then commit all of your updates to the MySLP AWS ECS Kit repository on the proper branch. There are AWS CodePipeline services running that will monitor the repository for changes, build any images as needed with ECR and deploy them via the Elastic Container Service if possible. Details on the processes are noted below.
Update The Submodules
From the MySLP AWS ECS Kit git project root:
./tools/create_mustuseplugins_stubs.shCommit The Code Updates To The Repo
Commit any changes to the MySLP AWS ECS Kit repository.
When you push the changes from your local develop, staging, or production branch an AWS listener service will detect the code changes and run Code Pipeline tied to services such as CodeBuild and ECS to deploy the final Store Locator Plus® SaaS container in the AWS cloud.
Commits to local branches will not trigger a change in the AWS deployments.
Commits to any branch not specifically named develop, staging, or production will not trigger changes in the AWS cloud deployments.
CodePipeline Notes
The CodePipeline that is configured to deploy the staging containers is named myslp-webserver-staging-pipeline.
Stage: Source
The pipeline monitors the staging branch on the AWS CodeCommit repo for the MySLP AWS ECS Kit project at ssh://git-codecommit.us-east-1.amazonaws.com/v1/repos/myslp_aws_ecs_kit
Stage: Build
The source will be read from the URL above and a series of commands will be executed in the cloud to create an container image. This image is stored in the AWS Elastic Container Registry as a private image.
The Store Locator Plus® SaaS (internal name: MySLP) container images are stored in the 744590032041.dkr.ecr.us-east-1.amazonaws.com/myslp2024-aarch64 docker image repository.
Staging branches will tag the latest build with the :staging tag.
Stage: Deploy
The deploy stage will execute if the build stage completes successfully. This stage will attempt to take the latest myslp2024-aarch64:staging ECR image and launch an active container in the AWS Elastic Container Service.
The deploy stage will attempt to launch a running container in the myslp-staging-cluster on the myslp-staging-service service within that cluster.
Manual Container Image Update
Build The Container Image and Store On AWS ECR
aws sso login --profile lance.cleveland
aws ecr get-login-password --region us-east-1 --profile lance.cleveland | docker login --username AWS --password-stdin 744590032041.dkr.ecr.us-east-1.amazonaws.com/myslp2024-aarch64
cd ./Docker/Images
docker build --platform=linux/arm64 -t 744590032041.dkr.ecr.us-east-1.amazonaws.com/myslp2024-aarch64:staging .docker push 744590032041.dkr.ecr.us-east-1.amazonaws.com/myslp2024-aarch64:staging
Email via WP Mail SMTP Pro
We use a 20-site pro license to manage email on the new server clusters via the WP Mail SMTP Pro service.
You will need to network activate the plugin and get the site license key to enable it.
Use Amazon SES service to send email. To configure you will need the Access Key and Secret Access key to set this up. These are in Lance’s password manager app — or you will need to create a new identity under the storelocatorplus.com domain in SES and create a new key pair.
Category : Updating Locations
Notes while debugging category changes not saving.
Bug report is that unchecking all the category boxes will result in nothing being saved.
Power 2301.11.01 with SLP 2301.24.01.
SLP Base Plugin
Power
Label Settings via Locator Layout
Use Case
The locator layout should be able to set any setting in SLP.
The Default Locator Style was updated to change “label_phone” from “Phone” to “Phone ” on the main Store Locator Plus® site (this is managed in the Premier Services plugin).
Problem
Setting the label_phone with a space at the end is not making it to the settings on a user site. It appears as though trim() is being called when the data is recieved.
Research
Cannot reproduce after fixing some JavaScript errors on the admin processor.
Sneak Preview: Reports 2208.15
A new reports interface is coming in the 2208.15 release based on preliminary work with the React API library. In addition to the simplified interface , the new reports provide more controls over the data table. Some new features include a date selector that auto-refreshes the data table, ability to filter rows, select which columns to display, or change the display density. The export CSV now honors the column display and filter settings. There is also a new “direct to print” option.
Here is the informal review of the new reports.