fix: skip processing invalid body payload (#132)

* fix: fix processing invalid payload

* fix: disable typecheck errors on lib

.github/workflows/test.yml

@@ -0,0 +1,11 @@
+name: Test
+
+on: [push]
+
+jobs:
+  test:
+    uses: snapshot-labs/actions/.github/workflows/test.yml@main
+    secrets: inherit
+    with:
+      mysql_database_name: snapshot_relayer_test
+      mysql_schema_path: ./src/schema.sql

.gitignore

@@ -1,7 +1,7 @@
 .DS_Store
 node_modules
 dist
-build
+coverage
 
 # Remove some common IDE working directories
 .idea

jest.config.ts

@@ -0,0 +1,14 @@
+export default {
+  clearMocks: true,
+  collectCoverage: true,
+  collectCoverageFrom: ['./src/**'],
+  coverageDirectory: 'coverage',
+  coverageProvider: 'v8',
+  coveragePathIgnorePatterns: ['/node_modules/', '<rootDir>/dist/', '<rootDir>/test/fixtures/'],
+  preset: 'ts-jest',
+  testEnvironment: 'jest-environment-node-single-context',
+  setupFiles: ['dotenv/config'],
+  moduleFileExtensions: ['js', 'ts'],
+  testPathIgnorePatterns: ['dist/'],
+  verbose: true
+};

package.json

@@ -8,7 +8,10 @@
     "typecheck": "tsc --noEmit",
     "build": "tsc",
     "dev": "nodemon src/index.ts",
-    "start": "node dist/src/index.js"
+    "start": "node dist/src/index.js",
+    "start:test": "dotenv -e test/.env.test yarn dev",
+    "test": "PORT=3003 start-server-and-test 'yarn start:test' http://localhost:3003/api 'dotenv -e test/.env.test jest --runInBand test'",
+    "test:e2e": "PORT=3003 start-server-and-test 'yarn start:test' http://localhost:3003/api 'dotenv -e test/.env.test jest --runInBand --collectCoverage=false test/e2e/'"
   },
   "eslintConfig": {
     "extends": "@snapshot-labs"
@@ -37,9 +40,17 @@
     "@snapshot-labs/eslint-config": "^0.1.0-beta.7",
     "@snapshot-labs/prettier-config": "^0.1.0-beta.7",
     "@types/express": "^4.17.11",
+    "@types/jest": "^29.5.3",
     "@types/node": "^14.14.21",
+    "@types/supertest": "^2.0.12",
+    "dotenv-cli": "^7.3.0",
     "eslint": "^8.32.0",
+    "jest": "^29.6.3",
+    "jest-environment-node-single-context": "^29.1.0",
     "nodemon": "^2.0.15",
-    "prettier": "^2.8.0"
+    "prettier": "^2.8.0",
+    "start-server-and-test": "^2.0.0",
+    "supertest": "^6.3.3",
+    "ts-jest": "^29.1.1"
   }
 }

src/api.ts

@@ -66,6 +66,12 @@ router.get('/api/messages/:hash', async (req, res) => {
 });
 
 router.post('/', async (req, res) => {
+  if (!req.body.data || !req.body.data.message) {
+    return res.status(400).json({
+      error: 'Invalid format request'
+    });
+  }
+
   try {
     const msg = req.body.data.message;
     const msgHash = snapshot.utils.getHash(req.body.data);

test/.env.test

@@ -0,0 +1 @@
+DATABASE_URL=mysql://root:[email protected]:3306/snapshot_relayer_test

test/e2e/api.test.ts

@@ -0,0 +1,19 @@
+import request from 'supertest';
+
+const HOST = `http://localhost:${process.env.PORT || 3003}`;
+
+describe('POST /', () => {
+  describe('when the request body is invalid', () => {
+    const inputs: [string, any][] = [
+      ['empty', {}],
+      ['missing the data key', { foo: 'bar' }],
+      ['missing the data.msg key', { data: { foo: 'bar' } }]
+    ];
+
+    it.each(inputs)('returns a 400 error when the input is %s', async (name, input) => {
+      const response = await request(HOST).post('/').send(input);
+
+      expect(response.statusCode).toBe(400);
+    });
+  });
+});

tsconfig.json

@@ -8,6 +8,7 @@
     "strict": true,
     "noImplicitAny": false,
     "resolveJsonModule": true,
-    "moduleResolution": "Node"
+    "moduleResolution": "Node",
+    "skipLibCheck": true
   }
 }