Laying the groundwork for the git refactor

codeql-config.yml

@@ -7,4 +7,5 @@ queries:
 paths-ignore:
   - ./src/tests
   - ./src/tests_integration
+  - ./src/vcs_providers_tests
 # https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors

jest.config.js

@@ -11,12 +11,19 @@ const config = {
       globalSetup: "<rootDir>/node_modules/@databases/pg-test/jest/globalSetup",
       globalTeardown:
         "<rootDir>/node_modules/@databases/pg-test/jest/globalTeardown",
-      testMatch: ["<rootDir>/src/tests_integration/*.test.js"],
+      testMatch: ["<rootDir>/src/tests_integration/main.test.js"],
     },
     {
       displayName: "Unit-Tests",
       testMatch: ["<rootDir>/src/tests/*.test.js"],
     },
+    {
+      displayName: "VCS-Tests",
+      testMatch: [
+        "<rootDir>/src/vcs_providers_tests/**/*.test.js",
+        "<rootDir>/src/vcs_providers_tests/*.test.js"
+      ],
+    }
   ],
 };
 

package.json

@@ -12,6 +12,7 @@
     "test:integration": "cross-env NODE_ENV=test PULSAR_STATUS=dev jest --selectProjects Integration-Tests",
     "start:dev": "cross-env PULSAR_STATUS=dev node ./src/dev_server.js",
     "test": "cross-env NODE_ENV=test PULSAR_STATUS=dev jest",
+    "test:vcs": "cross-env NODE_ENV=test PULSAR_STATUS=dev MOCK_GH=false jest --selectProjects VCS-Tests",
     "api-docs": "quick-webserver-docs -i ./src/main.js -o ./docs/reference/API_Definition.md",
     "lint": "prettier --check -u -w .",
     "complex": "cr --newmi --config .complexrc .",

src/handlers/package_handler.js

@@ -14,6 +14,7 @@
 const common = require("./common_handler.js");
 const query = require("../query.js");
 const git = require("../git.js");
+const vcs = require("../vcs.js");
 const logger = require("../logger.js");
 const { server_url } = require("../config.js").getConfig();
 const utils = require("../utils.js");
@@ -420,9 +421,13 @@ async function deletePackagesName(req, res) {
     return;
   }
 
-  const gitowner = await git.ownership(
+  //const gitowner = await git.ownership(
+  //  user.content,
+  //  utils.getOwnerRepoFromPackage(packageExists.content.data)
+  //);
+  const gitowner = await vcs.ownership(
     user.content,
-    utils.getOwnerRepoFromPackage(packageExists.content.data)
+    packageExists.content
   );
 
   if (!gitowner.ok) {
@@ -628,61 +633,70 @@ async function postPackagesVersion(req, res) {
   // Get `owner/repo` string format from package.
   let ownerRepo = utils.getOwnerRepoFromPackage(packExists.content.data);
 
-  // Now it's important to note, that getPackageJSON was intended to be an internal function.
-  // As such does not return a Server Status Object. This may change later, but for now,
-  // we will expect `undefined` to not be success.
-  const packJSON = await git.getPackageJSON(ownerRepo, user.content);
+  // Using our new VCS Service
+  // TODO: The "git" Service shouldn't always be hardcoded.
+  let packMetadata = await vcs.newVersionData(user.content, ownerRepo, "git");
 
-  if (packJSON === undefined) {
-    logger.generic(6, `Unable to get Package JSON from git with: ${ownerRepo}`);
-    await common.handleError(req, res, {
-      ok: false,
-      short: "Bad Package",
-      content: `Failed to get Package JSON: ${ownerRepo}`,
-    });
+  if (!packMetadata.ok) {
+    logger.generic(6, packMetadata.content);
+    await common.handleError(req, res, packMetadata);
     return;
   }
+  // Now it's important to note, that getPackageJSON was intended to be an internal function.
+  // As such does not return a Server Status Object. This may change later, but for now,
+  // we will expect `undefined` to not be success.
+  //const packJSON = await git.getPackageJSON(ownerRepo, user.content);
+
+  //if (packJSON === undefined) {
+  //  logger.generic(6, `Unable to get Package JSON from git with: ${ownerRepo}`);
+  //  await common.handleError(req, res, {
+  //    ok: false,
+  //    short: "Bad Package",
+  //    content: `Failed to get Package JSON: ${ownerRepo}`,
+  //  });
+  //  return;
+  //}
 
   // Now we will also need to get the packages data to update on the db
   // during version pushes.
 
-  const packReadme = await git.getRepoReadMe(ownerRepo, user.content);
+  //const packReadme = await git.getRepoReadMe(ownerRepo, user.content);
   // Again important to note, this was intended as an internal function of git
   // As such does not return a Server Status Object, and instead returns the obj or null
-  if (packReadme === undefined) {
-    logger.generic(
-      6,
-      `Unable to Get Package Readme from git with: ${ownerRepo}`
-    );
-    await common.handleError(req, res, {
-      ok: false,
-      short: "Bad Package",
-      content: `Failed to get Package Readme: ${ownerRepo}`,
-    });
-  }
-
-  const packMetadata = await git.metadataAppendTarballInfo(
-    packJSON,
-    packJSON.version,
-    user.content
-  );
-  if (packMetadata === undefined) {
-    await common.handleError(req, res, {
-      ok: false,
-      short: "Bad Package",
-      content: `Failed to get Package metadata info: ${ownerRepo}`,
-    });
-  }
+  //if (packReadme === undefined) {
+  //  logger.generic(
+  //    6,
+  //    `Unable to Get Package Readme from git with: ${ownerRepo}`
+  //  );
+  //  await common.handleError(req, res, {
+  //    ok: false,
+  //    short: "Bad Package",
+  //    content: `Failed to get Package Readme: ${ownerRepo}`,
+  //  });
+  //}
+
+  //const packMetadata = await git.metadataAppendTarballInfo(
+  //  packJSON,
+  //  packJSON.version,
+  //  user.content
+  //);
+  //if (packMetadata === undefined) {
+  //  await common.handleError(req, res, {
+  //    ok: false,
+  //    short: "Bad Package",
+  //    content: `Failed to get Package metadata info: ${ownerRepo}`,
+  //  });
+  //}
 
   // Now construct the object that will be used to update the `data` column.
-  const packageData = {
-    name: packMetadata.name.toLowerCase(),
-    repository: git.selectPackageRepository(packMetadata.repository),
-    readme: packReadme,
-    metadata: packMetadata,
-  };
-
-  const newName = packMetadata.name;
+  //const packageData = {
+  //  name: packMetadata.name.toLowerCase(),
+  //  repository: git.selectPackageRepository(packMetadata.repository),
+  //  readme: packReadme,
+  //  metadata: packMetadata,
+  //};
+
+  const newName = packMetadata.content.metadata.name;
   const currentName = packExists.content.name;
   if (newName !== currentName && !params.rename) {
     logger.generic(
@@ -705,9 +719,10 @@ async function postPackagesVersion(req, res) {
   // From the newest updated `package.json` info, just in case it's changed that will be
   // supported here
 
-  ownerRepo = utils.getOwnerRepoFromPackage(packJSON);
+  ownerRepo = utils.getOwnerRepoFromPackage(packMetadata.content.metadata);
 
-  const gitowner = await git.ownership(user.content, ownerRepo);
+  //const gitowner = await git.ownership(user.content, ownerRepo);
+  const gitowner = await vcs.ownership(user.content, packExists.content);
 
   if (!gitowner.ok) {
     logger.generic(6, `User Failed Git Ownership Check: ${gitowner.content}`);
@@ -740,8 +755,8 @@ async function postPackagesVersion(req, res) {
   // Now add the new Version key.
 
   const addVer = await database.insertNewPackageVersion(
-    packMetadata,
-    packageData,
+    packMetadata.content.metadata,
+    packageMetadata.content,
     rename ? currentName : null
   );
 

src/tests/vcs.test.js

@@ -0,0 +1,62 @@
+const vcs = require("../vcs.js");
+
+describe("determineProvider Returns as expected", () => {
+  test("Returns null when no input is passed", () => {
+    const res = vcs.determineProvider();
+    expect(res.type).toBe("na");
+    expect(res.url).toBe("");
+  });
+  test("Returns null when null input is passed", () => {
+    const res = vcs.determineProvider(null);
+    expect(res.type).toBe("na");
+    expect(res.url).toBe("");
+  });
+  test("Returns proper object, when object is passed", () => {
+    const tmp = { type: "git", url: "https://github.com/confused-Techie/atom-backend" };
+    const res = vcs.determineProvider(tmp);
+    expect(res.type).toBe(tmp.type);
+    expect(res.url).toBe(tmp.url);
+  });
+  test("Returns unknown VCS Object, when unkown is passed", () => {
+    const tmp = "https://new-vcs.com/pulsar-edit/pulsar";
+    const res = vcs.determineProvider(tmp);
+    expect(res.type).toBe("unknown");
+    expect(res.url).toBe(tmp);
+  });
+  test("Returns unkown string when passed invalid data", () => {
+    const tmp = 123;
+    const res = vcs.determineProvider(tmp);
+    expect(res.type).toBe("unknown");
+    expect(res.url).toBe(tmp);
+  });
+  test("Returns proper GitHub Object, passed GitHub string", () => {
+    const tmp = "https://github.com/confused-Techie/atom-backend";
+    const res = vcs.determineProvider(tmp);
+    expect(res.type).toBe("git");
+    expect(res.url).toBe(tmp);
+  });
+  test("Returns proper GitLab Object, passed GitLab string", () => {
+    const tmp = "https://gitlab.com/clj-editors/atom-chlorine";
+    const res = vcs.determineProvider(tmp);
+    expect(res.type).toBe("lab");
+    expect(res.url).toBe(tmp);
+  });
+  test("Returns proper Sourceforge Object, when passed Sourceforge string", () => {
+    const tmp = "https://sourceforge.net/projects/jellyfin.mirror/";
+    const res = vcs.determineProvider(tmp);
+    expect(res.type).toBe("sfr");
+    expect(res.url).toBe(tmp);
+  });
+  test("Returns proper Bitbucket Object, when passed Bitbucket string", () => {
+    const tmp = "https://bitbucket.org/docker_alpine/alpine-jellyfin/src/master/";
+    const res = vcs.determineProvider(tmp);
+    expect(res.type).toBe("bit");
+    expect(res.url).toBe(tmp);
+  });
+  test("Returns proper Codeberg Object, when passed Codeberg string", () => {
+    const tmp = "https://codeberg.org/itbastian/makemkv-move-extras";
+    const res = vcs.determineProvider(tmp);
+    expect(res.type).toBe("berg");
+    expect(res.url).toBe(tmp);
+  });
+});