Backend package with db models (#43)

* Setup backend package with express server (#11)

* Setup backend package with express server

* Rename ts.config.json to tsconfig.json

* Update lint setup in backend package

* Add a dummy typeorm entity

* Remove dummy entity

---------

Co-authored-by: Prathamesh Musale <prathamesh.musale0@gmail.com>

* Setup database connection (#13)

* Setup database connection

* Refactor database initialization into separate function

* Rename index.ts to server.ts

* Use debug package for logging

---------

Co-authored-by: neeraj <neeraj.rtly@gmail.com>

* Create entities for ER models (#14)

* Add entity for domain

* Add entity for environment variable

* Add entity for project

* Add entity for deployment

* git ignore db directory

* Add entity for organization

* Add entity for user organization and project member

* Add foreign key user and organization to project

---------

Co-authored-by: neerajvijay1997 <111040298+neerajvijay1997@users.noreply.github.com>
Co-authored-by: Prathamesh Musale <prathamesh.musale0@gmail.com>
Co-authored-by: neeraj <neeraj.rtly@gmail.com>

README.md

@@ -3,7 +3,7 @@
 - Clone the  `snowballtools` repo
 
   ```bash
-  git clone git@github.com:deep-stack/snowballtools.git
+  git clone git@github.com:snowball-tools/snowballtools-base.git
   ```
 
 - In root of the repo, install depedencies

packages/backend/.eslintignore

@@ -0,0 +1,5 @@
+# Don't lint node_modules.
+node_modules
+
+# Don't lint build output.
+dist

packages/backend/.eslintrc.json

@@ -0,0 +1,29 @@
+{
+  "env": {
+    "browser": true,
+    "es2021": true
+  },
+  "extends": ["semistandard", "plugin:@typescript-eslint/recommended"],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 12,
+    "sourceType": "module"
+  },
+  "plugins": ["@typescript-eslint"],
+  "rules": {
+    "indent": [
+      "error",
+      2,
+      {
+        "SwitchCase": 1
+      }
+    ],
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/explicit-module-boundary-types": [
+      "warn",
+      {
+        "allowArgumentsExplicitlyTypedAsAny": true
+      }
+    ]
+  }
+}

packages/backend/.gitignore

@@ -0,0 +1 @@
+db

packages/backend/.prettierignore

@@ -0,0 +1,3 @@
+# artifacts
+build
+coverage

packages/backend/.prettierrc.json

@@ -0,0 +1,3 @@
+{
+  "singleQuote": true
+}

packages/backend/README.md

@@ -0,0 +1 @@
+# Backend for Snowball Tools

packages/backend/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "backend",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "dependencies": {
+    "@types/express": "^4.17.21",
+    "@types/node": "^20.11.0",
+    "@types/debug": "^4.1.5",
+    "express": "^4.18.2",
+    "reflect-metadata": "^0.2.1",
+    "ts-node": "^10.9.2",
+    "typeorm": "^0.3.19",
+    "typescript": "^5.3.3"
+  },
+  "scripts": {
+    "start": "DEBUG=snowball:* ts-node ./src/server.ts",
+    "lint": "eslint .",
+    "format": "prettier --write .",
+    "format:check": "prettier --check ."
+  },
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^6.18.1",
+    "@typescript-eslint/parser": "^6.18.1",
+    "better-sqlite3": "^9.2.2",
+    "eslint": "^8.56.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-config-semistandard": "^15.0.1",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-promise": "^5.1.0",
+    "eslint-plugin-standard": "^5.0.0",
+    "prettier": "^3.1.1",
+    "workspace": "^0.0.1-preview.1"
+  }
+}

packages/backend/src/database.ts

@@ -0,0 +1,24 @@
+import { DataSource } from 'typeorm';
+import path from 'path';
+import debug from 'debug';
+
+const log = debug('snowball:server');
+
+export const initializeDatabase = async (
+  database: string = 'db/snowball'
+): Promise<void> => {
+  try {
+    const AppDataSource = new DataSource({
+      type: 'better-sqlite3',
+      database,
+      entities: [path.join(__dirname, '/entity/*')],
+      synchronize: true,
+      logging: false
+    });
+
+    await AppDataSource.initialize();
+    log('database initialized');
+  } catch (error) {
+    log(error);
+  }
+};

packages/backend/src/entity/Deployment.ts

@@ -0,0 +1,67 @@
+import {
+  Entity,
+  PrimaryGeneratedColumn,
+  Column,
+  CreateDateColumn,
+  UpdateDateColumn,
+  ManyToOne,
+  OneToOne,
+  JoinColumn
+} from 'typeorm';
+
+import { Project } from './Project';
+import { Domain } from './Domain';
+
+enum Environment {
+  Production = 'Production',
+  Preview = 'Preview',
+  Development = 'Development',
+}
+
+enum Status {
+  Building = 'Building',
+  Ready = 'Ready',
+  Error = 'Error',
+}
+
+@Entity()
+export class Deployment {
+  @PrimaryGeneratedColumn()
+    id!: number;
+
+  @ManyToOne(() => Project, { onDelete: 'CASCADE' })
+  @JoinColumn({ name: 'projectID' })
+    project!: Project;
+
+  @OneToOne(() => Domain)
+  @JoinColumn({ name: 'domainID' })
+    domain!: Domain;
+
+  @Column('varchar')
+    branch!: string;
+
+  @Column('varchar')
+    commitHash!: string;
+
+  @Column('varchar')
+    title!: string;
+
+  @Column({
+    enum: Environment
+  })
+    environment!: Environment;
+
+  @Column('boolean', { default: false })
+    isCurrent!: boolean;
+
+  @Column({
+    enum: Status
+  })
+    status!: Status;
+
+  @CreateDateColumn()
+    createdAt!: Date;
+
+  @UpdateDateColumn()
+    updatedAt!: Date;
+}

packages/backend/src/entity/Domain.ts

@@ -0,0 +1,38 @@
+import {
+  Entity,
+  PrimaryGeneratedColumn,
+  Column,
+  CreateDateColumn,
+  UpdateDateColumn
+} from 'typeorm';
+
+enum Status {
+  Live = 'Live',
+  Pending = 'Pending',
+}
+
+@Entity()
+export class Domain {
+  @PrimaryGeneratedColumn()
+    id!: number;
+
+  @Column('varchar', { length: 255, default: 'main' })
+    branch!: string;
+
+  @Column('varchar', { length: 255 })
+    name!: string;
+
+  @Column('boolean', { default: false })
+    isRedirected!: boolean;
+
+  @Column({
+    enum: Status
+  })
+    status!: Status;
+
+  @CreateDateColumn()
+    createdAt!: Date;
+
+  @UpdateDateColumn()
+    updatedAt!: Date;
+}

packages/backend/src/entity/EnvironmentVariable.ts

@@ -0,0 +1,38 @@
+import {
+  Entity,
+  PrimaryGeneratedColumn,
+  Column,
+  CreateDateColumn,
+  UpdateDateColumn,
+  ManyToOne,
+  JoinColumn
+} from 'typeorm';
+
+import { Project } from './Project';
+
+@Entity()
+export class EnvironmentVariable {
+  @PrimaryGeneratedColumn()
+    id!: number;
+
+  @ManyToOne(() => Project, { onDelete: 'CASCADE' })
+  @JoinColumn({ name: 'projectId' })
+    project!: Project;
+
+  @Column({
+    type: 'simple-array'
+  })
+    environments!: string[];
+
+  @Column('varchar')
+    key!: string;
+
+  @Column('varchar')
+    value!: string;
+
+  @CreateDateColumn()
+    createdAt!: Date;
+
+  @UpdateDateColumn()
+    updatedAt!: Date;
+}

packages/backend/src/entity/Organization.ts

@@ -0,0 +1,22 @@
+import {
+  Entity,
+  PrimaryGeneratedColumn,
+  Column,
+  CreateDateColumn,
+  UpdateDateColumn
+} from 'typeorm';
+
+@Entity()
+export class Organization {
+  @PrimaryGeneratedColumn()
+    id!: number;
+
+  @Column('varchar', { length: 255 })
+    name!: string;
+
+  @CreateDateColumn()
+    createdAt!: Date;
+
+  @UpdateDateColumn()
+    updatedAt!: Date;
+}

packages/backend/src/entity/Project.ts

@@ -0,0 +1,55 @@
+import {
+  Entity,
+  PrimaryGeneratedColumn,
+  Column,
+  CreateDateColumn,
+  UpdateDateColumn,
+  ManyToOne,
+  JoinColumn
+} from 'typeorm';
+
+import { User } from './User';
+import { Organization } from './Organization';
+
+@Entity()
+export class Project {
+  @PrimaryGeneratedColumn('uuid')
+    id!: string;
+
+  @ManyToOne(() => User)
+  @JoinColumn({ name: 'ownerID' })
+    owner!: User;
+
+  @ManyToOne(() => Organization, { nullable: true })
+  @JoinColumn({ name: 'organizationID' })
+    organization!: Organization | null;
+
+  @Column('varchar')
+    name!: string;
+
+  @Column('varchar')
+    repository!: string;
+
+  @Column('varchar', { length: 255, default: 'main' })
+    prodBranch!: string;
+
+  @Column('text')
+    description!: string;
+
+  @Column('varchar')
+    template!: string;
+
+  @Column('varchar')
+    framework!: string;
+
+  @Column({
+    type: 'simple-array'
+  })
+    webhooks!: string[];
+
+  @CreateDateColumn()
+    createdAt!: Date;
+
+  @UpdateDateColumn()
+    updatedAt!: Date;
+}

packages/backend/src/entity/ProjectMember.ts

@@ -0,0 +1,43 @@
+import {
+  Entity,
+  Column,
+  CreateDateColumn,
+  UpdateDateColumn,
+  ManyToOne,
+  PrimaryGeneratedColumn,
+  JoinColumn
+} from 'typeorm';
+
+import { Project } from './Project';
+import { User } from './User';
+
+enum Permissions {
+  Owner = 'Owner',
+  Maintainer = 'Maintainer',
+  Reader = 'Reader',
+}
+
+@Entity()
+export class ProjectMember {
+  @PrimaryGeneratedColumn()
+    id!: number;
+
+  @ManyToOne(() => User, { onDelete: 'CASCADE' })
+  @JoinColumn({ name: 'userID' })
+    user!: User;
+
+  @ManyToOne(() => Project, { onDelete: 'CASCADE' })
+  @JoinColumn({ name: 'projectID' })
+    project!: Project;
+
+  @Column({
+    enum: Permissions
+  })
+    role!: Permissions;
+
+  @CreateDateColumn()
+    createdAt!: Date;
+
+  @UpdateDateColumn()
+    updatedAt!: Date;
+}

packages/backend/src/entity/User.ts

@@ -0,0 +1,24 @@
+import {
+  Entity,
+  PrimaryGeneratedColumn,
+  Column,
+  CreateDateColumn
+} from 'typeorm';
+
+@Entity()
+export class User {
+  @PrimaryGeneratedColumn()
+    id!: number;
+
+  @Column('varchar', { length: 255 })
+    name!: string;
+
+  @Column()
+    email!: string;
+
+  @CreateDateColumn()
+    createdAt!: Date;
+
+  @CreateDateColumn()
+    updatedAt!: Date;
+}

packages/backend/src/entity/UserOrganization.ts

@@ -0,0 +1,43 @@
+import {
+  Entity,
+  Column,
+  CreateDateColumn,
+  UpdateDateColumn,
+  ManyToOne,
+  PrimaryGeneratedColumn,
+  JoinColumn
+} from 'typeorm';
+
+import { User } from './User';
+import { Organization } from './Organization';
+
+enum Role {
+  Owner = 'Owner',
+  Maintainer = 'Maintainer',
+  Reader = 'Reader',
+}
+
+@Entity()
+export class UserOrganization {
+  @PrimaryGeneratedColumn()
+    id!: number;
+
+  @ManyToOne(() => User, { onDelete: 'CASCADE' })
+  @JoinColumn({ name: 'userID' })
+    user!: User;
+
+  @ManyToOne(() => Organization, { onDelete: 'CASCADE' })
+  @JoinColumn({ name: 'organizationID' })
+    organization!: Organization;
+
+  @Column({
+    enum: Role
+  })
+    role!: Role;
+
+  @CreateDateColumn()
+    createdAt!: Date;
+
+  @UpdateDateColumn()
+    updatedAt!: Date;
+}

packages/backend/src/server.ts

@@ -0,0 +1,30 @@
+import express, { Request, Response } from 'express';
+import 'reflect-metadata';
+import debug from 'debug';
+
+import { initializeDatabase } from './database';
+
+const log = debug('snowball:server');
+
+export const main = async (): Promise<void> => {
+  await initializeDatabase();
+
+  const app = express();
+  const port = 8080;
+
+  app.get('/', (req: Request, res: Response) => {
+    res.send('Hello, TypeScript Express Server!');
+  });
+
+  app.listen(port, () => {
+    log(`Server is running at http://localhost:${port}`);
+  });
+};
+
+main()
+  .then(() => {
+    log('Starting server...');
+  })
+  .catch((err) => {
+    log(err);
+  });

packages/backend/tsconfig.json

@@ -0,0 +1,81 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Basic Options */
+    // "incremental": true,                         /* Enable incremental compilation */
+    "target": "es5" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', 'ES2021', or 'ESNEXT'. */,
+    "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */,
+    "lib": [
+      "ES5",
+      "ES6",
+      "ES2020"
+    ] /* Specify library files to be included in the compilation. */,
+    // "allowJs": true,                             /* Allow javascript files to be compiled. */
+    // "checkJs": true,                             /* Report errors in .js files. */
+    // "jsx": "preserve",                           /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */
+    "declaration": true /* Generates corresponding '.d.ts' file. */,
+    // "declarationMap": true,                      /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    "sourceMap": true /* Generates corresponding '.map' file. */,
+    // "outFile": "./",                             /* Concatenate and emit output to single file. */
+    "outDir": "dist" /* Redirect output structure to the directory. */,
+    // "rootDir": "./",                             /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                           /* Enable project compilation */
+    // "tsBuildInfoFile": "./",                     /* Specify file to store incremental compilation information */
+    // "removeComments": true,                      /* Do not emit comments to output. */
+    // "noEmit": true,                              /* Do not emit outputs. */
+    // "importHelpers": true,                       /* Import emit helpers from 'tslib'. */
+    "downlevelIteration": true /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */,
+    // "isolatedModules": true,                     /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true /* Enable all strict type-checking options. */,
+    // "noImplicitAny": true,                       /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                    /* Enable strict null checks. */
+    // "strictFunctionTypes": true,                 /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,                 /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,        /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                      /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                        /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                      /* Report errors on unused locals. */
+    // "noUnusedParameters": true,                  /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,                   /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,          /* Report errors for fallthrough cases in switch statement. */
+    // "noUncheckedIndexedAccess": true,            /* Include 'undefined' in index signature results */
+    // "noImplicitOverride": true,                  /* Ensure overriding members in derived classes are marked with an 'override' modifier. */
+    // "noPropertyAccessFromIndexSignature": true,  /* Require undeclared properties from index signatures to use element accesses. */
+
+    /* Module Resolution Options */
+    "moduleResolution": "node" /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */,
+    // "baseUrl": "./",                             /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                                 /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                              /* List of root folders whose combined content represents the structure of the project at runtime. */,
+    //"typeRoots": [
+    //   "./src/types"
+    // ],                                           /* List of folders to include type definitions from. */
+    // "types": [],                                 /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,        /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
+    // "preserveSymlinks": true,                    /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,                /* Allow accessing UMD globals from modules. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                            /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                               /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                     /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                       /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    "experimentalDecorators": true /* Enables experimental support for ES7 decorators. */,
+    "emitDecoratorMetadata": true /* Enables experimental support for emitting type metadata for decorators. */,
+
+    /* Advanced Options */
+    "skipLibCheck": true /* Skip type checking of declaration files. */,
+    "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */,
+    "resolveJsonModule": true /* Enabling the option allows importing JSON, and validating the types in that JSON file. */
+  },
+  "include": ["src/**/*"],
+  "exclude": ["dist", "src/**/*.test.ts"]
+}