bugfix: validate process name to 18 characters (#2)

Data store names have a 50 character maximum. In the batch processor, we create a reserved Ordered Data Store named `_RBX_batch-process-failed-items-<process name>`, which reserves 32 of these 50 characters. Therefore, in order to be able to create this Ordered Data Store, the process name can be at most 18 characters long.

This PR:
- Updates the number of characters against which we validate the process name to 18 characters instead of 50
- Updates documentation with this value and ensures the examples given are within those limits

Author: LLOR3NZ-RBX

GUIDE.html

@@ -34,7 +34,8 @@ <h1 id="-roblox-data-stores-batch-processor-cli-technical-guide-">
   repository and stage a pull request with your contributions. Please see the
   <strong><a href="./LICENSE">LICENSE</a></strong> for details. This tool uses
   third-party modules; their licenses are listed in
-  <strong><a href="./ATTRIBUTIONS.md">ATTRIBUTIONS.md</a>.</strong>
+  <strong><a href="./ATTRIBUTIONS.md">ATTRIBUTIONS.md</a></strong
+  >.
 </p>
 <h2 id="-1-overview-"><strong>1. Overview</strong></h2>
 <p>
@@ -289,7 +290,8 @@ <h3 id="-4-1-process-keys-"><strong>4.1. process-keys</strong></h3>
 <ul>
   <li>
     <strong><code>&lt;process-name&gt;</code></strong
-    >: The unique name of the new batch process.
+    >: The unique name of the new batch process. The process name can be at most
+    18 characters long.
   </li>
 </ul>
 <p><strong>Command-Specific Options:</strong></p>
@@ -335,7 +337,7 @@ <h3 id="-4-2-process-data-stores-">
 <ul>
   <li>
     <strong><code>&lt;process-name&gt;</code></strong> : The unique name of the
-    new batch process.
+    new batch process. The process name can be at most 18 characters long.
   </li>
 </ul>
 <p><strong>Command-Specific Options:</strong></p>
@@ -820,7 +822,7 @@ <h2 id="-8-example-use-case-data-deletion-">
       deletion:</strong
     >
     e.g.<br /><code
-      >lune run batch-process process-keys DS_DELETION_JUNE17 -c &lt;config
+      >lune run batch-process process-keys DS_Deletion -c &lt;config
       filepath&gt;.json</code
     >
   </li>
@@ -873,8 +875,8 @@ <h2 id="-8-example-use-case-data-deletion-">
       deletion:</strong
     >
     e.g.<br /><code
-      >lune run batch-process process-data-stores DS_DELETION_JUNE17 -c
-      &lt;config filepath&gt;.json</code
+      >lune run batch-process process-data-stores DS_Deletion -c &lt;config
+      filepath&gt;.json</code
     >
   </li>
 </ol>
@@ -1019,7 +1021,7 @@ <h3 id="-9-2-specific-example-datastore2-migration-deletion-">
   </li>
   <li>
     Run the <code>process-data-stores</code> command, e.g.<br /><code
-      >lune run batch-process process-data-stores DS2_Migration_June17 -c
+      >lune run batch-process process-data-stores DS2_Migration -c
       examples/ds2-config.json</code
     >
   </li>
@@ -1213,8 +1215,7 @@ <h4 id="-shared-optional-configurations-">
       <td style="text-align: left"><code>--max-items-per-job</code></td>
       <td style="text-align: left">50</td>
       <td style="text-align: left">
-        Maximum number of items to process in one job. Note that if
-        <code>excludeDeletedKeys</code>
+        Maximum number of items to process in one job.
       </td>
     </tr>
     <tr>

README.md

@@ -119,7 +119,8 @@ lune run batch-process process-keys <process-name> --config <filepath>
 
 **Arguments:**
 
-- **`<process-name>`**: The unique name of the new batch process.
+- **`<process-name>`**: The unique name of the new batch process. The process name can be
+  at most 18 characters long.
 
 **Command-Specific Options:**
 
@@ -147,7 +148,8 @@ lune run batch-process process-data-stores <process-name> --config <filepath>
 
 **Arguments:**
 
-- **`<process-name>`** : The unique name of the new batch process.
+- **`<process-name>`** : The unique name of the new batch process. The process name can be
+  at most 18 characters long.
 
 **Command-Specific Options:**
 
@@ -379,7 +381,7 @@ end
 
 2. **Create the Configuration File** (or provide arguments on the command line)
 3. **Run the `process-keys` command to kick off the deletion:** e.g.  
-   `lune run batch-process process-keys DS_DELETION_JUNE17 -c <config filepath>.json`
+   `lune run batch-process process-keys DS_Deletion -c <config filepath>.json`
 
 On a related note, bulk Data Store deletion can be achieved by integrating the Deletion API with the batch processor. Please take caution that you are only deleting data stores that you are no longer
 using.
@@ -416,7 +418,7 @@ end
 
 2. **Create the Configuration File** (or provide arguments on the command line)
 3. **Run the `process-data-stores` command to kick off the deletion:** e.g.  
-   `lune run batch-process process-data-stores DS_DELETION_JUNE17 -c <config filepath>.json`
+   `lune run batch-process process-data-stores DS_Deletion -c <config filepath>.json`
 
 ## **9\. Example Use Case: Data Migrations**
 
@@ -459,7 +461,7 @@ to meet this exact use case in the `examples` folder in the tool.
 3. Update the provided `ds2-config.json` file with your preferred callback (`ds2-migrate[-delete[-all]].luau`), `universeId`, `placeId`, and the DataStore2 prefix. The DataStore2 prefix is the name of the key / master key of your data store, followed by a ‘/’. For example, if you have a master key called `DATA`, then the prefix will be `DATA/`. We recommend verifying you have the correct prefix by looking for data stores with the pattern `<prefix><user id>` in Data Stores Manager.
 4. (Optional) If you are using a custom migration scope in the [**DataStore2 Migration Tool**](https://create.roblox.com/store/asset/82521207271039/BETA-DataStore2-Migration-Tool?keyword=datastore2&pageNumber=1&pagePosition=0), edit the chosen callback script and add the scope as the value of `MIGRATED_DS_SCOPE`.
 5. Run the `process-data-stores` command, e.g.  
-   `lune run batch-process process-data-stores DS2_Migration_June17 -c examples/ds2-config.json`
+   `lune run batch-process process-data-stores DS2_Migration -c examples/ds2-config.json`
 
 ### **9.3. Specific Example: Generic Berezaa Method Migration**
 

src/main.luau

@@ -22,7 +22,7 @@ local Resume = require('./commands/resume')
 local Types = require('./shared/types')
 
 -- Constants
-local MAX_PROCESS_NAME_LENGTH = 50
+local MAX_PROCESS_NAME_LENGTH = 18
 
 --[[
     Main entry point for the batch processor.