OpenWF/SpaceNinjaServer
12
6
Fork 14
Code Issues 42 Pull Requests 2 Actions Packages Projects Releases Activity

feat(webui): add "add missing warframes" & "add missing weapons" #775

Merged
Sainan merged 4 commits from bulk into main 2025-01-14 20:20:17 -08:00
Conversation 2 Commits 4 Files Changed 6 +49 -91
5 changed files with 49 additions and 91 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit d747063213 - Show all commits

33
src/controllers/custom/addItemController.ts
View File

@ -1,33 +0,0 @@
import { getAccountIdForRequest } from "@/src/services/loginService";
import { ItemType, toAddItemRequest } from "@/src/helpers/customHelpers/addItemHelpers";
import { getWeaponType } from "@/src/services/itemDataService";
import { addPowerSuit, addEquipment, getInventory } from "@/src/services/inventoryService";
import { RequestHandler } from "express";
const addItemController: RequestHandler = async (req, res) => {
const accountId = await getAccountIdForRequest(req);
const request = toAddItemRequest(req.body);
switch (request.type) {
case ItemType.Powersuit: {
const inventory = await getInventory(accountId);
const inventoryChanges = addPowerSuit(inventory, request.InternalName);
await inventory.save();
res.json(inventoryChanges);
return;
}
case ItemType.Weapon: {
const inventory = await getInventory(accountId);
const weaponType = getWeaponType(request.InternalName);
const inventoryChanges = addEquipment(inventory, weaponType, request.InternalName);
await inventory.save();
res.json(inventoryChanges);
break;
}
default:
res.status(400).json({ error: "something went wrong" });
break;
}
};
export { addItemController };

33
src/controllers/custom/addItemsController.ts Normal file
View File

@ -0,0 +1,33 @@
import { getAccountIdForRequest } from "@/src/services/loginService";
import { getWeaponType } from "@/src/services/itemDataService";
import { addPowerSuit, addEquipment, getInventory } from "@/src/services/inventoryService";
import { RequestHandler } from "express";
export const addItemsController: RequestHandler = async (req, res) => {
const accountId = await getAccountIdForRequest(req);
const requests = req.body as IAddItemRequest[];
const inventory = await getInventory(accountId);
for (const request of requests) {
switch (request.type) {
case ItemType.Powersuit:
addPowerSuit(inventory, request.internalName);
break;
case ItemType.Weapon:
addEquipment(inventory, getWeaponType(request.internalName), request.internalName);
break;
}
}
await inventory.save();
res.end();
};
coderabbitai[bot] commented 2025-01-12 00:42:58 -08:00 (Migrated from github.com)
Review
Copy Link

🛠️ Refactor suggestion

Consider adding error handling for invalid request bodies.

The controller lacks error handling for:

  • Invalid/malformed request body
  • Empty requests array
  • Unknown item types

Consider adding error handling:

 export const addItemsController: RequestHandler = async (req, res) => {
+    if (!Array.isArray(req.body)) {
+        res.status(400).json({ error: "Request body must be an array" });
+        return;
+    }
+    if (req.body.length === 0) {
+        res.status(400).json({ error: "Request body cannot be empty" });
+        return;
+    }
     const accountId = await getAccountIdForRequest(req);
     const requests = req.body as IAddItemRequest[];
     const inventory = await getInventory(accountId);
     for (const request of requests) {
+        if (!Object.values(ItemType).includes(request.type)) {
+            res.status(400).json({ error: `Invalid item type: ${request.type}` });
+            return;
+        }
         switch (request.type) {
             case ItemType.Powersuit:
                 addPowerSuit(inventory, request.internalName);
                 break;
             case ItemType.Weapon:
                 addEquipment(inventory, getWeaponType(request.internalName), request.internalName);
                 break;
         }
     }
     await inventory.save();
-    res.end();
+    res.status(200).json({ message: "Items added successfully" });
 };
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

export const addItemsController: RequestHandler = async (req, res) => {
    if (!Array.isArray(req.body)) {
        res.status(400).json({ error: "Request body must be an array" });
        return;
    }
    if (req.body.length === 0) {
        res.status(400).json({ error: "Request body cannot be empty" });
        return;
    }
    const accountId = await getAccountIdForRequest(req);
    const requests = req.body as IAddItemRequest[];
    const inventory = await getInventory(accountId);
    for (const request of requests) {
        if (!Object.values(ItemType).includes(request.type)) {
            res.status(400).json({ error: `Invalid item type: ${request.type}` });
            return;
        }
        switch (request.type) {
            case ItemType.Powersuit:
                addPowerSuit(inventory, request.internalName);
                break;
            case ItemType.Weapon:
                addEquipment(inventory, getWeaponType(request.internalName), request.internalName);
                break;
        }
    }
    await inventory.save();
    res.status(200).json({ message: "Items added successfully" });
};
_:hammer_and_wrench: Refactor suggestion_ **Consider adding error handling for invalid request bodies.** The controller lacks error handling for: - Invalid/malformed request body - Empty requests array - Unknown item types Consider adding error handling: ```diff export const addItemsController: RequestHandler = async (req, res) => { + if (!Array.isArray(req.body)) { + res.status(400).json({ error: "Request body must be an array" }); + return; + } + if (req.body.length === 0) { + res.status(400).json({ error: "Request body cannot be empty" }); + return; + } const accountId = await getAccountIdForRequest(req); const requests = req.body as IAddItemRequest[]; const inventory = await getInventory(accountId); for (const request of requests) { + if (!Object.values(ItemType).includes(request.type)) { + res.status(400).json({ error: `Invalid item type: ${request.type}` }); + return; + } switch (request.type) { case ItemType.Powersuit: addPowerSuit(inventory, request.internalName); break; case ItemType.Weapon: addEquipment(inventory, getWeaponType(request.internalName), request.internalName); break; } } await inventory.save(); - res.end(); + res.status(200).json({ message: "Items added successfully" }); }; ``` <!-- suggestion_start --> <details> <summary>📝 Committable suggestion</summary> > ‼️ **IMPORTANT** > Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements. `````suggestion export const addItemsController: RequestHandler = async (req, res) => { if (!Array.isArray(req.body)) { res.status(400).json({ error: "Request body must be an array" }); return; } if (req.body.length === 0) { res.status(400).json({ error: "Request body cannot be empty" }); return; } const accountId = await getAccountIdForRequest(req); const requests = req.body as IAddItemRequest[]; const inventory = await getInventory(accountId); for (const request of requests) { if (!Object.values(ItemType).includes(request.type)) { res.status(400).json({ error: `Invalid item type: ${request.type}` }); return; } switch (request.type) { case ItemType.Powersuit: addPowerSuit(inventory, request.internalName); break; case ItemType.Weapon: addEquipment(inventory, getWeaponType(request.internalName), request.internalName); break; } } await inventory.save(); res.status(200).json({ message: "Items added successfully" }); }; ````` </details> <!-- suggestion_end --> <!-- This is an auto-generated comment by CodeRabbit -->
enum ItemType {
Powersuit = "Powersuit",
Weapon = "Weapon"
}
interface IAddItemRequest {
type: ItemType;
internalName: string;
}

46
src/helpers/customHelpers/addItemHelpers.ts
View File

@ -1,46 +0,0 @@
import { isString } from "@/src/helpers/general";
export enum ItemType {
Powersuit = "Powersuit",
Weapon = "Weapon"
}
export const isItemType = (itemType: string): itemType is ItemType => {
return Object.keys(ItemType).includes(itemType);
};
const parseItemType = (itemType: unknown): ItemType => {
if (!itemType || !isString(itemType) || !isItemType(itemType)) {
throw new Error("incorrect item type");
}
return itemType;
};
interface IAddItemRequest {
type: ItemType;
InternalName: string;
}
const parseInternalItemName = (internalName: unknown): string => {
if (!isString(internalName)) {
throw new Error("incorrect internal name");
}
return internalName;
};
export const toAddItemRequest = (body: unknown): IAddItemRequest => {
if (!body || typeof body !== "object") {
throw new Error("incorrect or missing add item request data");
}
if ("type" in body && "internalName" in body) {
return {
type: parseItemType(body.type),
InternalName: parseInternalItemName(body.internalName)
};
}
throw new Error("malformed add item request");
};

4
src/routes/custom.ts
View File

@ -8,7 +8,7 @@ import { deleteAccountController } from "@/src/controllers/custom/deleteAccountC
import { renameAccountController } from "@/src/controllers/custom/renameAccountController"; import { renameAccountController } from "@/src/controllers/custom/renameAccountController";
import { createAccountController } from "@/src/controllers/custom/createAccountController"; import { createAccountController } from "@/src/controllers/custom/createAccountController";
import { addItemController } from "@/src/controllers/custom/addItemController"; import { addItemsController } from "@/src/controllers/custom/addItemsController";
import { getConfigDataController } from "@/src/controllers/custom/getConfigDataController"; import { getConfigDataController } from "@/src/controllers/custom/getConfigDataController";
import { updateConfigDataController } from "@/src/controllers/custom/updateConfigDataController"; import { updateConfigDataController } from "@/src/controllers/custom/updateConfigDataController";
@ -23,7 +23,7 @@ customRouter.get("/deleteAccount", deleteAccountController);
customRouter.get("/renameAccount", renameAccountController); customRouter.get("/renameAccount", renameAccountController);
customRouter.post("/createAccount", createAccountController); customRouter.post("/createAccount", createAccountController);
customRouter.post("/addItem", addItemController); customRouter.post("/addItems", addItemsController);
customRouter.get("/config", getConfigDataController); customRouter.get("/config", getConfigDataController);
customRouter.post("/config", updateConfigDataController); customRouter.post("/config", updateConfigDataController);

24
static/webui/script.js
View File

@ -524,12 +524,14 @@ function doAcquireWarframe() {
} }
revalidateAuthz(() => { revalidateAuthz(() => {
const req = $.post({ const req = $.post({
url: "/custom/addItem?" + window.authz, url: "/custom/addItems?" + window.authz,
contentType: "application/json", contentType: "application/json",
data: JSON.stringify({ data: JSON.stringify([
type: "Powersuit", {
internalName: uniqueName type: "Powersuit",
}) internalName: uniqueName
}
])
}); });
req.done(() => { req.done(() => {
document.getElementById("warframe-to-acquire").value = ""; document.getElementById("warframe-to-acquire").value = "";
@ -550,12 +552,14 @@ function doAcquireWeapon() {
} }
revalidateAuthz(() => { revalidateAuthz(() => {
const req = $.post({ const req = $.post({
url: "/custom/addItem?" + window.authz, url: "/custom/addItems?" + window.authz,
contentType: "application/json", contentType: "application/json",
data: JSON.stringify({ data: JSON.stringify([
type: "Weapon", {
internalName: uniqueName type: "Weapon",
}) internalName: uniqueName
}
])
}); });
req.done(() => { req.done(() => {
document.getElementById("weapon-to-acquire").value = ""; document.getElementById("weapon-to-acquire").value = "";