GH Action Standards

docs/resources/complexity-report.md

@@ -1,12 +1,12 @@
-# Complexity report, 1/23/2024
-
-* Mean per-function logical LOC: 14.663793103448276
-* Mean per-function parameter count: 0.13017241379310346
-* Mean per-function cyclomatic complexity: 1.170689655172414
-* Mean per-function Halstead effort: 3426.6136676441265
-* Mean per-module maintainability index: 68.88659389428372
-* First-order density: 0.89179548156956%
-* Change cost: 5.618311533888228%
+# Complexity report, 1/27/2024
+
+* Mean per-function logical LOC: 14.458333333333334
+* Mean per-function parameter count: 0.15916666666666668
+* Mean per-function cyclomatic complexity: 1.2483333333333335
+* Mean per-function Halstead effort: 3318.2315431289767
+* Mean per-module maintainability index: 68.928875276727
+* First-order density: 0.8333333333333334%
+* Change cost: 5.305555555555555%
 * Core size: 100%
 
 ## /home/runner/work/package-backend/package-backend/jest.config.js
@@ -229,6 +229,36 @@
 * Maintainability index: 85.19382950159975
 * Dependency count: 27
 
+## /home/runner/work/package-backend/package-backend/src/database/_constants.js
+
+* Physical LOC: 6
+* Logical LOC: 5
+* Mean parameter count: 0
+* Cyclomatic complexity: 1
+* Cyclomatic complexity density: 20%
+* Maintainability index: 74.35668985133891
+* Dependency count: 0
+
+## /home/runner/work/package-backend/package-backend/src/database/_utils.js
+
+* Physical LOC: 19
+* Logical LOC: 15
+* Mean parameter count: 2
+* Cyclomatic complexity: 6
+* Cyclomatic complexity density: 40%
+* Maintainability index: 65.95338088382414
+* Dependency count: 0
+* Function: **getOrderField**
+    * Line No.: 9
+    * Physical LOC: 15
+    * Logical LOC: 12
+    * Parameter count: 2
+    * Cyclomatic complexity: 6
+    * Cyclomatic complexity density: 50%
+    * Halstead difficulty: 2.25
+    * Halstead volume: 75.28421251514429
+    * Halstead effort: 169.38947815907466
+
 ## /home/runner/work/package-backend/package-backend/src/models/ssoHTML.js
 
 * Physical LOC: 12

src/database/_clause.js

@@ -79,5 +79,5 @@ module.exports = {
   filterClause,
   ownerClause,
   serviceClause,
-  fileExtensionClause
-}
+  fileExtensionClause,
+};

src/database/_constants.js

@@ -3,6 +3,6 @@
 module.exports = {
   defaults: {
     engine: { atom: "*" },
-    license: "NONE"
-  }
+    license: "NONE",
+  },
 };

src/database/_export.js

@@ -6,14 +6,8 @@
 const fs = require("fs");
 const postgres = require("postgres");
 const logger = require("../logger.js");
-const {
-  DB_HOST,
-  DB_USER,
-  DB_PASS,
-  DB_DB,
-  DB_PORT,
-  DB_SSL_CERT
-} = require("../config.js").getConfig();
+const { DB_HOST, DB_USER, DB_PASS, DB_DB, DB_PORT, DB_SSL_CERT } =
+  require("../config.js").getConfig();
 
 // While the below method of exporting the additional database modules is nonstandard
 // it lets us accomplish several things:
@@ -28,58 +22,55 @@ let sqlStorage; // SQL Object to interact with the DB
 
 function setupSQL() {
   return process.env.PULSAR_STATUS === "dev" && process.env.MOCK_DB !== "false"
-  ? postgres({
-      host: DB_HOST,
-      username: DB_USER,
-      database: DB_DB,
-      port: DB_PORT
-  })
-  : postgres({
-      host: DB_HOST,
-      username: DB_USER,
-      password: DB_PASS,
-      database: DB_DB,
-      port: DB_PORT,
-      ssl: {
-        rejectUnauthorized: true,
-        ca: fs.readFileSync(DB_SSL_CERT).toString()
-      }
-  });
+    ? postgres({
+        host: DB_HOST,
+        username: DB_USER,
+        database: DB_DB,
+        port: DB_PORT,
+      })
+    : postgres({
+        host: DB_HOST,
+        username: DB_USER,
+        password: DB_PASS,
+        database: DB_DB,
+        port: DB_PORT,
+        ssl: {
+          rejectUnauthorized: true,
+          ca: fs.readFileSync(DB_SSL_CERT).toString(),
+        },
+      });
 }
 
 function getSqlStorage() {
-  return sqlStorage ??= setupSQL();
+  return (sqlStorage ??= setupSQL());
 }
 
 function wrapper(modToUse) {
   // Return this function passing all args based on what module we need to use
   return async (...args) => {
     // Wrap all function calls in a try catch with a singular error handler
     try {
-
       // Call the function passing the `sqlStorage` object can other provided params
       return modToUse.exec(getSqlStorage(), ...args);
-
-    } catch(err) {
+    } catch (err) {
       // Generic Error Catcher for all database modules
       return {
         ok: false,
         content: "Generic Error",
         short: "server_error",
-        error: err
+        error: err,
       };
-
     }
   };
-};
+}
 
 const exportObj = {
   shutdownSQL: async () => {
     if (sqlStorage !== undefined) {
       await sqlStorage.end();
       logger.generic(1, "SQL Server Shutdown!");
     }
-  }
+  },
 };
 
 // Add all other modules here:

src/database/_utils.js

@@ -23,5 +23,5 @@ function getOrderField(method, sql) {
 }
 
 module.exports = {
-  getOrderField
+  getOrderField,
 };

src/database/applyFeatures.js

@@ -85,5 +85,5 @@ module.exports = {
     return {
       ok: true,
     };
-  }
+  },
 };

src/database/authCheckAndDeleteStateKey.js

@@ -52,5 +52,5 @@ module.exports = {
     }
 
     return { ok: true, content: command[0].keycode };
-  }
+  },
 };

src/database/authStoreStateKey.js

@@ -22,5 +22,5 @@ module.exports = {
           content: `The state key has not been saved on the database.`,
           short: "server_error",
         };
-  }
+  },
 };

src/database/getFeaturedPackages.js

@@ -8,7 +8,8 @@
  */
 
 const storage = require("../storage.js");
-const getPackageCollectionByName = require("./getPackageCollectionByName.js").exec;
+const getPackageCollectionByName =
+  require("./getPackageCollectionByName.js").exec;
 
 module.exports = {
   safe: false,
@@ -20,5 +21,5 @@ module.exports = {
     }
 
     return await getPackageCollectionByName(sql, featuredArray.content);
-  }
+  },
 };

src/database/getFeaturedThemes.js

@@ -6,7 +6,8 @@
  * @returns {object} A server status object.
  */
 const storage = require("../storage.js");
-const getPackageCollectionByName = require("./getPackageCollectionByName.js").exec;
+const getPackageCollectionByName =
+  require("./getPackageCollectionByName.js").exec;
 
 module.exports = {
   safe: false,
@@ -18,5 +19,5 @@ module.exports = {
     }
 
     return await getPackageCollectionByName(sql, featuredThemeArray.content);
-  }
+  },
 };

src/database/getPackageByName.js

@@ -25,9 +25,7 @@ module.exports = {
         JSONB_AGG(
           JSON_BUILD_OBJECT(
             ${
-              user
-                ? sql``
-                : sql`'id', v.id, 'package', v.package,`
+              user ? sql`` : sql`'id', v.id, 'package', v.package,`
             } 'semver', v.semver, 'license', v.license, 'engine', v.engine, 'meta', v.meta,
             'hasGrammar', v.has_grammar, 'hasSnippets', v.has_snippets,
             'supportedLanguages', v.supported_languages
@@ -47,5 +45,5 @@ module.exports = {
           content: `package ${name} not found.`,
           short: "not_found",
         };
-  }
+  },
 };

src/database/getPackageByNameSimple.js

@@ -22,5 +22,5 @@ module.exports = {
           content: `Package ${name} not found.`,
           short: "not_found",
         };
-  }
+  },
 };

src/database/getPackageCollectionByID.js

@@ -21,5 +21,5 @@ module.exports = {
     return command.count !== 0
       ? { ok: true, content: command }
       : { ok: false, content: "No packages found.", short: "Not Found" };
-  }
+  },
 };

src/database/getPackageCollectionByName.js

@@ -27,5 +27,5 @@ module.exports = {
     return command.count !== 0
       ? { ok: true, content: command }
       : { ok: false, content: "No packages found.", short: "not_found" };
-  }
+  },
 };

src/database/getPackageVersionByNameAndVersion.js

@@ -24,5 +24,5 @@ module.exports = {
           content: `Package ${name} and Version ${version} not found.`,
           short: "not_found",
         };
-  }
+  },
 };

src/database/getSortedPackages.js

@@ -48,7 +48,11 @@ module.exports = {
           INNER JOIN versions AS v ON (p.pointer = v.package AND v.deleted IS FALSE
           ${clause.queryClause(sql, opts)}
           ${clause.filterClause(sql, opts)}
-          ${themes === true ? clause.filterClause(sql, { filter: "theme" }) : sql``})
+          ${
+            themes === true
+              ? clause.filterClause(sql, { filter: "theme" })
+              : sql``
+          })
 
         WHERE p.name IS NOT NULL
 
@@ -60,9 +64,7 @@ module.exports = {
       )
       SELECT *, COUNT(*) OVER() AS query_result_count
       FROM latest_versions
-      ORDER BY ${orderType} ${
-      opts.direction === "desc" ? sql`DESC` : sql`ASC`
-    }
+      ORDER BY ${orderType} ${opts.direction === "desc" ? sql`DESC` : sql`ASC`}
       LIMIT ${limit}
       OFFSET ${offset};
     `;
@@ -82,5 +84,5 @@ module.exports = {
         limit,
       },
     };
-  }
+  },
 };

src/database/getStarredPointersByUserID.js

@@ -25,5 +25,5 @@ module.exports = {
         : [];
 
     return { ok: true, content: packArray };
-  }
+  },
 };

src/database/getStarringUsersByPointer.js

@@ -31,5 +31,5 @@ module.exports = {
     }
 
     return { ok: true, content: userArray };
-  }
+  },
 };

src/database/getUserByID.js

@@ -29,5 +29,5 @@ module.exports = {
           content: `Unable to get user by ID: ${id}`,
           short: "server_error",
         };
-  }
+  },
 };

src/database/getUserByName.js

@@ -21,5 +21,5 @@ module.exports = {
           content: `Unable to query for user: ${username}`,
           short: "not_found",
         };
-  }
+  },
 };

src/database/getUserByNodeID.js

@@ -29,5 +29,5 @@ module.exports = {
           content: `Unable to get User By NODE_ID: ${id}`,
           short: "server_error",
         };
-  }
+  },
 };

src/database/getUserCollectionById.js

@@ -33,5 +33,5 @@ module.exports = {
     }
 
     return { ok: true, content: userArray };
-  }
+  },
 };

src/database/insertNewPackage.js

@@ -109,5 +109,5 @@ module.exports = {
               error: err,
             };
       });
-  }
+  },
 };

src/database/insertNewPackageName.js

@@ -76,5 +76,5 @@ module.exports = {
               error: err,
             };
       });
-  }
+  },
 };

src/database/insertNewPackageVersion.js

@@ -102,7 +102,8 @@ module.exports = {
         // The only requirement is that the provided semver is not already present
         // in the database for the targeted package.
 
-        const license = packJSON.metadata.license ?? _constants.defaults.license;
+        const license =
+          packJSON.metadata.license ?? _constants.defaults.license;
         const engine = packJSON.metadata.engines ?? _constants.defaults.engine;
 
         let addVer = {};
@@ -155,5 +156,5 @@ module.exports = {
               error: err,
             };
       });
-  }
+  },
 };

src/database/insertNewUser.js

@@ -24,5 +24,5 @@ module.exports = {
           content: `Unable to create user: ${username}`,
           short: "Server Error",
         };
-  }
+  },
 };