feat: refactor ZIM file creation handling and validation

- Add split-by-grapheme npm package to handle grapheme counting accurately.
- Modify ZimFile.vue to implement grapheme counting for title, description, and long description fields
- Introduce new exceptions for invalid ZIM metadata: InvalidZimTitleError, InvalidZimDescriptionError, and InvalidZimLongDescriptionError.
- Add regex python module to Pipfile and rebuilt Pipfile.lock
- Enhance backend logic in builder.py and zimfarm.py to validate ZIM metadata against grapheme limits using regex module
- Update unit tests to cover new validation rules and exceptions for ZIM metadata.
- Update ZIM file creation tests to check for disabled state of the request button
- Add frontend and backend validation of long description (max. length, min. length and difference to description)

Author: nicolapace

Pipfile

@@ -31,6 +31,7 @@ pytest-cov = "*"
 supervisor = "~=4.2"
 yoyo-migrations = "==7.3.2"
 pysocks = "*"
+regex = "==2024.11.6"
 
 # Versions required for dependabot
 sqlparse = "~=0.5.0"

Pipfile.lock

@@ -54,10 +54,10 @@ describe('the zim file creation page', () => {
 
         it('displays the Request ZIM file button', () => {
           cy.get('#request').should('be.visible');
-          cy.get('#request').should('not.have.attr', 'disabled');
+          cy.get('#request').should('have.attr', 'disabled');
         });
 
-        describe('when the description is missing and the submit button is clicked', () => {
+        describe('when the description is missing', () => {
           beforeEach(() => {
             cy.intercept('POST', 'v1/builders/1/zim', () => {
               throw new Error(
@@ -66,14 +66,14 @@ describe('the zim file creation page', () => {
             }).as('request');
           });
 
-          it('does not submit the form', () => {
-            cy.get('#request').click();
-          });
+            it('disables the submit button', () => {
+            cy.get('#request').should('have.attr', 'disabled');
+            });
 
-          it('shows the error message', () => {
-            cy.get('#request').click();
+            it('shows the error message', () => {
+            cy.get('#request').click({ force: true });
             cy.get('#desc-group > .invalid-feedback').should('be.visible');
-          });
+            });
         });
 
         describe('when the Request ZIM file button is clicked', () => {
@@ -167,7 +167,7 @@ describe('the zim file creation page', () => {
 
         it('displays the Request ZIM file button', () => {
           cy.get('#request').should('be.visible');
-          cy.get('#request').should('not.have.attr', 'disabled');
+          cy.get('#request').should('have.attr', 'disabled');
         });
 
         describe('when the Request ZIM file button is clicked', () => {
@@ -209,7 +209,7 @@ describe('the zim file creation page', () => {
 
         it('displays the Request ZIM file button', () => {
           cy.get('#request').should('be.visible');
-          cy.get('#request').should('not.have.attr', 'disabled');
+          cy.get('#request').should('have.attr', 'disabled');
         });
       });
     });

wp1-frontend/cypress/e2e/zimFile.cy.js

@@ -53,6 +53,7 @@
     "popper.js": "^1.16.0",
     "postcss": "^8.4.31",
     "serialize-javascript": "^3.1.0",
+    "split-by-grapheme": "^1.0.1",
     "vite": "^3.2.11",
     "vue": "^2.7.14",
     "vue-router": "^3.1.6",