feat: add support for flag code (#1014)

* feat: loosen flag detection to include all non-zero

* refactor: use snake case

* fix: use camelcase variable name

* chore: remove console.log

* Update src/graphql/helpers.ts

Co-authored-by: Copilot <[email protected]>

* docs: add flag codes decription

---------

Co-authored-by: Copilot <[email protected]>

Author: wa0x6e

README.md

@@ -65,6 +65,18 @@ yarn start
 
 To load a space settings in the database you can go on this endpoint <http://localhost:3000/api/spaces/yam.eth/poke> (change yam.eth with the space you want to activate).
 
+## Flag codes
+
+The hub uses flag codes (`flagCode`) to mark proposals and spaces for various reasons:
+
+| Flag Code | Description             | Purpose                                                           |
+|-----------|-------------------------|-------------------------------------------------------------------|
+| `1`       | Spam/Malicious Content  | Reserved for content identified as spam or malicious             |
+| `2`       | DMCA Requests          | Reserved for Digital Millennium Copyright Act takedown requests  |
+| `3+`      | Future Use             | Additional codes may be introduced for other moderation purposes  |
+
+When content is flagged, it may have restricted visibility or functionality depending on the flag type applied.
+
 ## License
 
 Snapshot is open-sourced software licensed under the © [MIT license](LICENSE).

src/graphql/helpers.ts

@@ -141,7 +141,8 @@ export function formatSpace({
   space.skinSettings = skinSettings;
 
   space.verified = verified ?? null;
-  space.flagged = flagged ?? null;
+  space.flagged = flagged > 0;
+  space.flagCode = flagged;
   space.hibernated = hibernated ?? null;
   space.turbo =
     new Date((turboExpiration || 0) * 1000) > new Date() ? true : turbo ?? null;
@@ -464,6 +465,9 @@ export function formatProposal(proposal) {
   }));
   proposal.privacy = proposal.privacy || '';
   proposal.quorumType = proposal.quorum_type || 'default';
+  const rawFlagged = proposal.flagged;
+  proposal.flagCode = rawFlagged;
+  proposal.flagged = rawFlagged > 0;
   return proposal;
 }
 

src/graphql/operations/proposals.ts

@@ -66,7 +66,7 @@ export default async function (parent, args) {
   }
 
   if (where.flagged === true) {
-    searchSql += ' AND p.flagged = 1';
+    searchSql += ' AND p.flagged > 0';
   }
 
   if (where.flagged === false) {

src/graphql/schema.gql

@@ -441,6 +441,7 @@ type Space {
   template: String
   verified: Boolean
   flagged: Boolean
+  flagCode: Int
   hibernated: Boolean
   turbo: Boolean
   turboExpiration: Int
@@ -510,6 +511,7 @@ type Proposal {
   scores_updated: Int
   votes: Int
   flagged: Boolean
+  flagCode: Int
 }
 
 type Strategy {

src/helpers/metrics.ts

@@ -100,7 +100,7 @@ new client.Gauge({
         { status },
         (
           await db.queryAsync(
-            `SELECT COUNT(id) as count FROM spaces WHERE ${status} = 1`
+            `SELECT COUNT(id) as count FROM spaces WHERE ${status} > 0`
           )
         )[0].count
       );

src/helpers/spaces.ts

@@ -172,7 +172,8 @@ async function loadSpaces() {
       space.id,
       {
         ...JSON.parse(space.settings),
-        flagged: space.flagged === 1,
+        flagged: space.flagged > 0,
+        flagCode: space.flagged,
         verified: space.verified === 1,
         turbo: isTurbo(!!space.turbo, space.turbo_expiration),
         turboExpiration: space.turbo_expiration,
@@ -319,7 +320,7 @@ export async function getSpace(id: string) {
   return {
     ...JSON.parse(space.settings),
     domain: space.domain,
-    flagged: space.flagged === 1,
+    flagged: space.flagged > 0,
     verified: space.verified === 1,
     turbo: isTurbo(!!space.turbo, space.turbo_expiration),
     turboExpiration: space.turbo_expiration,