Created function signature and testsuite for the buildTypeWeightsFromSchemaObject function

.babelrc

@@ -0,0 +1,3 @@
+{
+    "presets": [["@babel/preset-env", { "targets": { "node": "current" } }], "@babel/preset-typescript"],
+}

.eslintignore

@@ -0,0 +1 @@
+node_modules

.eslintrc.json

@@ -4,19 +4,28 @@
         "commonjs": true,
         "es2021": true
     },
-    "extends": ["eslint:recommended", "airbnb-base"],
+    "extends": [
+        "eslint:recommended",
+        "airbnb-base",
+        "airbnb-typescript/base",
+        "plugin:@typescript-eslint/recommended",
+        "plugin:import/typescript",
+        "prettier"
+    ],
     "parser": "@typescript-eslint/parser",
     "parserOptions": {
-        "ecmaVersion": "latest"
+        "ecmaVersion": "latest",
+        "project": "./tsconfig.eslint.json"
     },
-    "plugins": ["@typescript-eslint"],
+    "plugins": ["import"],
     "rules": {
         "indent": [
             "warn",
-            2,
+            4,
             {
-                "SwitchCase": 1
+                "SwitchCase": 2
             }
         ]
-    }
+    }, 
+    "ignorePatterns": ["jest.config.js"]
 }

.travis.yml

@@ -6,4 +6,4 @@ branches:
         - dev
 script:
     - 'npm run lint'
-    # - "npm run test"
+    - 'npm run test'

.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+  "folders": [],
+  "settings": {},
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true
+  },
+  "editor.formatOnSave": true,
+}

jest.config.js

@@ -0,0 +1,7 @@
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+module.exports = {
+    roots: ['./test'],
+    preset: 'ts-jest',
+    testEnvironment: 'node',
+    moduleFileExtensions: ['js', 'ts'],
+};

package.json

@@ -4,7 +4,7 @@
     "description": "A GraphQL rate limiting library using query complexity analysis.",
     "main": "index.js",
     "scripts": {
-        "test": "echo \"Error: no test specified\" && exit 1",
+        "test": "jest --passWithNoTests",
         "lint": "eslint src",
         "lint:fix": "eslint --fix src",
         "prettier": "prettier --write .",
@@ -22,17 +22,30 @@
     },
     "homepage": "https://github.com/oslabs-beta/graph-beaver#readme",
     "devDependencies": {
-        "@typescript-eslint/eslint-plugin": "^5.23.0",
-        "@typescript-eslint/parser": "^5.23.0",
+        "@babel/core": "^7.17.12",
+        "@babel/preset-env": "^7.17.12",
+        "@babel/preset-typescript": "^7.17.12",
+        "@types/jest": "^27.5.1",
+        "@typescript-eslint/eslint-plugin": "^5.24.0",
+        "@typescript-eslint/parser": "^5.24.0",
+        "babel-jest": "^28.1.0",
         "eslint": "^8.15.0",
         "eslint-config-airbnb-base": "^15.0.0",
+        "eslint-config-airbnb-typescript": "^17.0.0",
+        "eslint-config-prettier": "^8.5.0",
         "eslint-plugin-import": "^2.26.0",
         "husky": "^8.0.1",
+        "jest": "^28.1.0",
         "lint-staged": "^12.4.1",
-        "prettier": "2.6.2"
+        "prettier": "2.6.2",
+        "ts-jest": "^28.0.2",
+        "typescript": "^4.6.4"
     },
     "lint-staged": {
         "*.{js, ts}": "eslint --cache --fix",
         "*.{js,ts,css,md}": "prettier --write --ignore-unknown"
+    },
+    "dependencies": {
+        "graphql": "^16.5.0"
     }
 }

src/@types/buildTypeWeights.d.ts

@@ -0,0 +1,20 @@
+interface Fields {
+    [index: string]: number;
+}
+
+interface Type {
+    weight: number;
+    fields: Fields;
+}
+
+interface TypeWeightObject {
+    [index: string]: Type;
+}
+
+interface TypeWeightConfig {
+    mutation?: number;
+    query?: number;
+    object?: number;
+    scalar?: number;
+    connection?: number;
+}

src/@types/rateLimit.d.ts

@@ -0,0 +1,14 @@
+interface RateLimiter {
+    /**
+     * Checks if a request is allowed under the given conditions and withdraws the specified number of tokens
+     * @param uuid Unique identifier for the user associated with the request
+     * @param tokens Number of tokens being used in this request. Optional
+     * @returns true if the request is allowed
+     */
+    processRequest: (uuid: string, tokens?: number) => boolean;
+    /**
+     * Connects the RateLimiter instance to a db to cache current token usage for connected users
+     * @param uri database connection string
+     */
+    connect: (uri: string) => void;
+}

src/analysis/buildTypeWeights.ts

@@ -0,0 +1,26 @@
+import { GraphQLSchema } from 'graphql/type/schema';
+
+/**
+ * The default typeWeightsConfig object is based off of Shopifys implementation of query
+ * cost analysis. Our function should input a users configuration of type weights or fall
+ * back on shopifys settings. We can change this later.
+ *
+ * This function should
+ *  - itreate through the schema object and create the typeWeightObject as described in the tests
+ *  - validate that the typeWeightsConfig parameter has no negative values (throw an error if it does)
+ *
+ * @param schema
+ * @param typeWeightsConfig
+ */
+function buildTypeWeightsFromSchema(
+    schema: GraphQLSchema,
+    typeWeightsConfig: TypeWeightConfig = {
+        mutation: 10,
+        object: 1,
+        scalar: 0,
+        connection: 2,
+    }
+): TypeWeightObject {
+    throw Error(`getTypeWeightsFromSchema is not implemented.`);
+}
+export default buildTypeWeightsFromSchema;

src/rateLimiters/tokenBucket.ts

@@ -0,0 +1,35 @@
+/**
+ *
+ */
+class TokenBucket implements RateLimiter {
+    capacity: number;
+
+    refillRate: number;
+
+    /**
+     * Create a new instance of a TokenBucket rate limiter that can be connected to any database store
+     * @param capacity max token bucket capacity
+     * @param refillRate rate at which the token bucket is refilled
+     */
+    constructor(capacity: number, refillRate: number) {
+        this.capacity = capacity;
+        this.refillRate = refillRate;
+    }
+
+    processRequest(uuid: string, tokens?: number): boolean {
+        throw Error(`TokenBucket.processRequest not implemented, ${this}`);
+    }
+
+    connect(uri: string) {
+        throw Error(`TokenBucket.connect not implemented, ${this}`);
+    }
+
+    /**
+     * @returns current size of the token bucket.
+     */
+    getSize(uuid: string): number {
+        throw Error(`TokenBucket.connect not implemented, ${this}`);
+    }
+}
+
+export default TokenBucket;