User Tracing Spec

[rohitgodspeed]

PART 1: managing user and org setup

Registration of ORg

• Ask customers to fill in details in a form with the required organization and department details.
• He will be sent an excel sheet to fill data of all of his developers with the departments and roles. Or, he will ask his developers to register on the website with their official email. And he will send us the email Ids with roles and departments.

When org is created the supplied email

Single User Registration

Use the current form as it is.

Creating or Linking Users with an Org

• Godspeed account management team will go to Supabase UI and create/link users with org, department and role connection.
• An email will go to the user that you have been linked with this org, department and role.

Forced Linking a project with an org

• The project must have a github url in the .git history.
• The user must have his email address set with the git installation on his A. repository or else B. On his machine.

Microservice Used for User and Departments

Supabase

PART 2: Tracking

Permission to run godspeed commands

• User must have created a login from the website and got an email with his userId. He needs to setup in the environment variables, to be able to run any godspeed command.
• TODO: Figure out how encryption of org’s sensitive data will happen so that Godspeed only gets unique hashes but can not decrypt those. Sensitive keys are marked below.

By developer usage (local environment)

Whenever a dev runs a command then send the following event details to the tracking backend

1. gs_user_id: User will have to set an environment variable in his shell or the project’s .env file.
2. Command: Name of the Godspeed command.
3. Args: A string specifying the remaining args as user typed when initiating the command.
4. MacId (sensitive)
5. IpAddress (sensitive): To be extracted from the headers of the request.
6. Plugins: To be added in future.
7. Environment (sensitive): A JSON Object with key value. This must include in V1: Node version, OS.
8. Git_url: (sensitive) The projects git remote url (needed for all commands except godspeed create and help). If this is not set, generate error without running the command. Say “Please set your github remote repository”.
9. Timestamp in ddMMyyhh:mm:ss in UTC.

The endpoint to which it will send POST request is: godspeed.systems/usage/dev

By service (in hosted environment)

Whenever godspeed dev, start or serve is run from any environment then send the uptime pings for tracking of uptime. (Not for godspeed dev command).

1. Timestamp in ddMMyyhh:mm:ss in UTC
2. Uptime: in seconds
3. Cmd: dev|start|serve ENUM
4. gs_user_id: User will have to set an environment variable in his shell or the project’s .env file.
5. Git_url: The projects git remote url (needed for all commands except godspeed create and help). If this is not set, generate error without running the command. Say “Please set your github remote repository”.
6. IpAddress
7. MacId (if available)
8. K8s podId, nodeId, clusterId (if available) Ask Avtar how to uniquely identify an instance of a microservice with and without K8s.

NOTE: P1

• If organization feels that it will not give us git url but instead set a project_id. Then it must register project with godspeed and get the generated project_id linked to the org. Initially we will manually create a project and give them an id.

  model User {
  id        String   @id @default(auto()) @map("_id") @db.ObjectId
  createdAt DateTime @default(now())
  email     String   @unique
  phone     String
  firstName      String
  lastName      String
  role    Role    @relation(fields: [roleId], references: [id])
  roleId  String   @db.ObjectId
  department    Department?    @relation(fields: [departmentId], references: [id])
  departmentId  String   @db.ObjectId
  org    Organization    @relation(fields: [orgId], references: [id])
  orgId  String   @db.ObjectId
  }
  model Organization {
  id String   @id @default(auto()) @map("_id") @db.ObjectId
  name String
  website String
  email String
  phone String
  address String
  users User[]
  // admin    Organization    @relation(fields: [orgId], references: [id])
  // adminId  String   @db.ObjectId
  }
  model Department {
  id String   @id @default(auto()) @map("_id") @db.ObjectId
  name String
  users User[]
  }
  model Role {
  id String   @id @default(auto()) @map("_id") @db.ObjectId
  name String @unique
  users User[]
  }

[kushal-godspeed]

In this sprint, just create tasks.

Figure out if we can use Prometheus or Open Telemetry to track new godspeed user.
Error reporting.
Track all the CLI function invocation.
Figure out rate limiting on call based on ORG key.
No of unique services.

[siddarthvader]

not in favour of using supabase for the user flow because we will eventually hit the end wall or vendor lockin.

We should probably use a custom setup for example postgres+lucia+drizzle or something else.