feat: Implement getUsageData graphQL query

packages/backend/src/graphql/queries/get-usage-data.ee.ts

@@ -0,0 +1,29 @@
+import appConfig from '../../config/app';
+import Context from '../../types/express/context';
+
+const getUsageData = async (
+  _parent: unknown,
+  _params: unknown,
+  context: Context
+) => {
+  if (!appConfig.isCloud) return;
+
+  const usageData = await context.currentUser
+    .$relatedQuery('usageData')
+    .throwIfNotFound();
+
+  const paymentPlan = await context.currentUser
+    .$relatedQuery('paymentPlan')
+    .throwIfNotFound();
+
+  const computedUsageData = {
+    allowedTaskCount: paymentPlan.taskCount,
+    consumedTaskCount: usageData.consumedTaskCount,
+    remainingTaskCount: paymentPlan.taskCount - usageData.consumedTaskCount,
+    nextResetAt: usageData.nextResetAt,
+  };
+
+  return computedUsageData;
+};
+
+export default getUsageData;

packages/backend/src/graphql/query-resolvers.ts

@@ -11,6 +11,7 @@ import getExecutionSteps from './queries/get-execution-steps';
 import getDynamicData from './queries/get-dynamic-data';
 import getDynamicFields from './queries/get-dynamic-fields';
 import getCurrentUser from './queries/get-current-user';
+import getUsageData from './queries/get-usage-data.ee';
 import getAutomatischInfo from './queries/get-automatisch-info';
 import healthcheck from './queries/healthcheck';
 
@@ -28,6 +29,7 @@ const queryResolvers = {
   getDynamicData,
   getDynamicFields,
   getCurrentUser,
+  getUsageData,
   getAutomatischInfo,
   healthcheck,
 };

packages/backend/src/graphql/schema.graphql

@@ -34,6 +34,7 @@ type Query {
     parameters: JSONObject
   ): [SubstepArgument]
   getCurrentUser: User
+  getUsageData: GetUsageData
   getAutomatischInfo: GetAutomatischInfo
   healthcheck: AppHealth
 }
@@ -467,6 +468,13 @@ type GetAutomatischInfo {
   isCloud: String
 }
 
+type GetUsageData {
+  allowedTaskCount: Int
+  consumedTaskCount: Int
+  remainingTaskCount: Int
+  nextResetAt: String
+}
+
 schema {
   query: Query
   mutation: Mutation

packages/backend/src/models/usage-data.ee.ts

@@ -26,7 +26,7 @@ class UsageData extends Base {
       relation: Base.BelongsToOneRelation,
       modelClass: User,
       join: {
-        from: 'payment_plans.user_id',
+        from: 'usage_data.user_id',
         to: 'users.id',
       },
     },

packages/backend/src/models/user.ts

@@ -7,6 +7,7 @@ import Execution from './execution';
 import bcrypt from 'bcrypt';
 import crypto from 'crypto';
 import PaymentPlan from './payment-plan.ee';
+import UsageData from './usage-data.ee';
 
 class User extends Base {
   id!: string;
@@ -21,6 +22,7 @@ class User extends Base {
   steps?: Step[];
   executions?: Execution[];
   paymentPlan?: PaymentPlan;
+  usageData?: UsageData;
 
   static tableName = 'users';
 
@@ -86,6 +88,14 @@ class User extends Base {
         to: 'users.id',
       },
     },
+    usageData: {
+      relation: Base.HasOneRelation,
+      modelClass: UsageData,
+      join: {
+        from: 'usage_data.user_id',
+        to: 'users.id',
+      },
+    },
   });
 
   login(password: string) {