@caweb/cli 1.3.2 → 1.3.3

package/README.md

@@ -2,16 +2,12 @@
 `caweb-cli` is a tool which rapidly sets up a local WordPress environment fully configured for the [CAWebPublishing Service](https://caweb.cdt.ca.gov/), allows for the creation of Gutenberg blocks with the CAWebPublishing template configurations, and much more. The cli will automatically generate the necessary [.wp-env.json](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/#wp-env-json) file, to override or add additional configuration options use the [.wp-env.override.json](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/#wp-env-override-json) file.
 
 *`caweb-cli` is largely inspired by WordPress Packages major thanks to the whole WordPress team and community!*  
-The following WordPress packages are used:  
-[wp-env](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/)  
-[create-block](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-create-block/)
 
 ## Prerequisites
 - Latest version of [Docker Desktop](https://www.docker.com/products/docker-desktop), which includes [Compose v2](https://docs.docker.com/compose/migrate/), is installed.
   - <strong>For Debian-Based Linux distributions:</strong> <code>docker-compose</code> may need to be installed with: <code>sudo apt-get install docker-compose</code>.
   - <strong>For Windows users:</strong> [WSL should be set to version 2 for Windows Docker Desktop compatibility](https://docs.docker.com/desktop/windows/wsl/).
 - git is installed.
-- php is installed.
 
 ## Additional Features
 - Downloads and configures the [CAWeb Theme](https://github.com/CAWebPublishing/CAWeb)
@@ -21,15 +17,13 @@ The following WordPress packages are used:
   - phpMyAdmin development site starts at http://localhost:8080  
   - phpMyAdmin test site started at http://localhost:9090
 - Uses CAWebPublishing [External Project Template Configuration](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-create-block/packages-create-block-external-template/) when creating Gutenberg Blocks, see configurations [here](https://github.com/CAWebPublishing/cli/lib/template)
-- Allows for syncing of WordPress instance via Rest API and CLI, requires ssh. 
+- Allows for syncing of WordPress instance via Rest API, to maintain ID's please ensure [CAWebPublishing Development Toolbox](https://github.com/CAWebPublishing/caweb-dev/) plugin is installed. 
 - Adds config.yml to both cli containers, alias are added for each ssh connection.  
 <b>Example config.yml file</b>
 <pre>
     path: /var/www/html
     apache_modules:
       - mod_rewrite
-    @staging:
-        ssh: wpcli@staging.wp-cli.org
 </pre>
 
 
@@ -81,7 +75,7 @@ Options:
 </pre>
 ### `caweb run <container> [command...]`  
 <pre>
-caweb run <container> [command...]
+caweb run &lt;container&gt; [command...]
 
 Runs an arbitrary command in one of the underlying Docker containers. A double
 dash can be used to pass arguments to the container without parsing them. This
@@ -166,7 +160,7 @@ Options:
 
 ### `caweb create-block [options] <slug>`  
 <pre>
-caweb create-block [options] <slug>
+caweb create-block [options] &lt;slug&gt;
 
 Scaffold for WordPress plugin to register CA.gov Design System Block.
 
@@ -178,7 +172,7 @@ Options:
 </pre>
 ### `caweb update-block [options] <slug>`  
 <pre>
-caweb update-block [options] <slug>
+caweb update-block [options] &lt;slug&gt;
 
 Updates a CA.gov Design System Block.
 
@@ -188,3 +182,18 @@ Arguments:
 Options:
   -h, --help     display help for command
 </pre>
+### `caweb sync <from> <to>`  
+In order for the sync process to work correctly, you must have a caweb.json file in the project root directory. For more information read [caweb.json](./docs/SYNC.MD) configuration.
+<pre>
+caweb sync &lt;from&gt; &lt;to&gt;
+
+Sync changes from one destination to another.
+
+Arguments:
+  from               Target Site URL with current changes.
+  to                 Destination Site URL that should be synced.
+
+Options:
+  -h, --help         display help for command
+  -t,--tax [tax...]  Taxonomy that should be synced. Omitting this option will sync the full site. (choices: "pages", "posts", "media", "menus")
+</pre>

package/commands/sync.js

@@ -79,13 +79,11 @@ export default async function sync({
         }
     }
     
-    let ssh = 'local' !== to ? to : `docker:${path.basename(workDirectoryPath)}-cli-1`;
 
     to = serviceConfig.sync[to];
 
     let toOptions = {
         url: to.url,
-        ssh,
         headers: {
             Authorization: 'Basic ' + Buffer.from(`${to.user}:${to.pwd}`).toString('base64'),
             'content-type': 'multipart/form-data',
@@ -100,14 +98,18 @@ export default async function sync({
     let menus = [];
     let menuNavItems = [];
 
-    // get all settings 
-    // site settings are always synced
     spinner.text = `Getting Site Settings from ${from.url}`;
+    /**
+     * Site settings are always synced
+     * 
+     * @see https://developer.wordpress.org/rest-api/reference/settings/
+     */
     let settings = await getTaxonomies({
         ...fromOptions,
         fields: [
             'show_on_front',
-            'page_on_front'
+            'page_on_front',
+            'posts_per_page'
         ],
     }, 'settings')
     

package/lib/wordpress/api.js

@@ -4,21 +4,29 @@
 import path from 'path';
 import axios from 'axios';
 import terminalLink from  'terminal-link';
-
+import axiosRetry from 'axios-retry';
 
 /**
  * Internal dependencies
  */
-import {
-    projectPath,
-    runCmd
-} from '../index.js';
-
 const endpoint = '/wp-json/wp/v2';
-const requestDelay = 1000; // we wait 1 second between requests
-
-
-const sleep = (waitTimeInMs) => new Promise(resolve => setTimeout(resolve, waitTimeInMs));
+const syncEndpoint = '/wp-json/caweb/v1/sync';
+
+// Axios Configurations.
+axiosRetry(axios, 
+    { 
+        retries: 3, // attempt requests 3 times
+        shouldResetTimeout: true, // reset timeout on retries
+        retryCondition: (error) => { 
+            if( error.response && error.response.status === 500 ){
+                return true;
+            }
+        }, // retry on any network or 5xx error
+        retryDelay: (retryCount, error ) => {
+            return 5000 // retry delay
+        }
+    }
+);
 
 function processData( data ){
     /**
@@ -106,12 +114,13 @@ async function getTaxonomies( request, tax = 'pages' ){
         urlParams.push( 'menus=' + processUrlParam( request.menus ) );
     }
 
-    // if per page argument.
-    urlParams.push( 'per_page=' + request.per_page ? request.per_page : '100' )
-
-
-    // if posts_per_page argument.
-    urlParams.push( 'posts_per_page=' + request.posts_per_page ? request.posts_per_page : '10' )
+    /**
+     * The per_page parameter is capped at 100.
+     * 
+     * @see https://developer.wordpress.org/rest-api/using-the-rest-api/pagination/
+     */
+    request.per_page = request.per_page && request.per_page <= 100 ? request.per_page : 100;
+    urlParams.push( 'per_page=' + request.per_page  );
 
 
     let collection = [];
@@ -201,7 +210,6 @@ async function createTaxonomies( taxData, request, tax = 'pages', spinner ){
                     .catch(error => {return false;})
 
             }
-
             /**
              * if the ID doesn't exist we save it so we can make a request to our plugin endpoint.
              * if it does exist update endpoint url so we update the existing item.
@@ -232,13 +240,11 @@ async function createTaxonomies( taxData, request, tax = 'pages', spinner ){
         // make WordPress REST API request.
         let results = await axios.request({
                 ...request,
-                timeout: 7500,
                 data: 'media' === tax ? createMediaItem(obj) : obj,
                 url
             })
             .then( async (res) => { return res.data; } )
 
-            
         /**
          * if the obj had an existing ID that didn't exist we make a request to our plugin endpoint to update the IDs.
          */
@@ -246,8 +252,7 @@ async function createTaxonomies( taxData, request, tax = 'pages', spinner ){
 
             await axios.request({
                 ...request,
-                url: `${request.url}/wp-json/caweb-dev/v1/sync`,
-                timeout: 7500,
+                url: `${request.url}${syncEndpoint}`,
                 data: {
                     id: results.id,
                     newId: existingID,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caweb/cli",
-  "version": "1.3.2",
+  "version": "1.3.3",
   "description": "CAWebPublishing Command Line Interface.",
   "exports": "./lib/env.js",
   "type": "module",
@@ -62,6 +62,7 @@
     "accessibility-checker": "^3.1.67",
     "autoprefixer": "^10.4.17",
     "axios": "^1.6.7",
+    "axios-retry": "^4.0.0",
     "chalk": "^5.3.0",
     "commander": "^12.0.0",
     "cross-spawn": "^7.0.3",