Merge pull request #83 from shelfio/feature/migrate-js-to-ts

Migrate js to ts

Author: vladgolubev

.babelrc.js

@@ -0,0 +1,13 @@
+module.exports = {
+  presets: [
+    '@babel/preset-typescript',
+    [
+      '@babel/preset-env',
+      {
+        targets: {
+          node: '12'
+        }
+      }
+    ]
+  ]
+};

.circleci/config.yml

@@ -1,26 +1,27 @@
-version: 2
+version: 2.1
 
-jobs:
-  build:
-    docker:
-      - image: circleci/node:10-browsers
+orbs:
+  node: circleci/node@1.1.6
 
-    working_directory: ~/repo
+commands:
+  install_deps:
+    steps:
+      - node/with-cache:
+          cache-version: v1-all
+          cache-key: yarn.lock
+          dir: ~/repo/node_modules
+          use-strict-cache: true
+          steps:
+            - run: yarn install --pure-lockfile --no-progress
 
+jobs:
+  build:
+    executor:
+      name: node/default
+      tag: '12-browsers'
     steps:
       - checkout
-      - restore_cache:
-          keys:
-            - v1-dependencies-{{ checksum "package.json" }}
-            - v1-dependencies-
-
-      - run: yarn
-
-      - save_cache:
-          paths:
-            - /tmp/dynamodb-local
-            - node_modules
-            - yarn.lock
-          key: v1-dependencies-{{ checksum "package.json" }}
-
+      - install_deps
       - run: yarn test
+      - run: yarn type-check
+      - run: yarn lint:ci

.eslintignore

@@ -0,0 +1,3 @@
+lib/
+renovate.json
+tsconfig.json

.eslintrc

@@ -1,4 +1,6 @@
 {
   "root": true,
-  "extends": ["@shelf/eslint-config/backend"]
+  "extends": [
+    "@shelf/eslint-config/typescript"
+  ]
 }

.gitignore

@@ -1,8 +1,9 @@
 .idea/
 coverage/
 node_modules/
+dist/
+lib/
 temp
 yarn.lock
 *.log
 .DS_Store
-dist/

package.json

@@ -2,62 +2,84 @@
   "name": "@shelf/dynamodb-parallel-scan",
   "version": "1.0.2",
   "description": "Scan large DynamoDB tables faster with parallelism",
-  "license": "MIT",
+  "keywords": [
+    "parallel-scan",
+    "dynamodb",
+    "aws"
+  ],
   "repository": "shelfio/dynamodb-parallel-scan",
+  "license": "MIT",
   "author": {
     "name": "Vlad Holubiev",
     "email": "vlad@shelf.io",
     "url": "shelf.io"
   },
-  "engines": {
-    "node": ">=8"
-  },
+  "files": [
+    "lib"
+  ],
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "scripts": {
+    "build": "rm -rf lib/ && yarn build:types && babel src --out-dir lib --ignore '**/*.test.ts' --extensions '.ts'",
+    "build:types": "tsc --emitDeclarationOnly --declaration --isolatedModules false --declarationDir lib",
     "coverage": "jest --coverage",
-    "lint": "eslint . --fix",
-    "test": "export ENVIRONMENT=local && jest src --runInBand"
+    "lint": "eslint . --ext .js,.ts,.json --fix --quiet",
+    "lint:ci": "eslint . --ext .js,.ts,.json --quiet",
+    "test": "export ENVIRONMENT=local && jest src --runInBand",
+    "type-check": "tsc --noEmit",
+    "type-check:watch": "npm run type-check -- --watch"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged",
+      "post-commit": "git update-index --again"
+    }
+  },
+  "lint-staged": {
+    "*.{html,json,md,yml}": [
+      "prettier --write --ignore-path=./.eslintignore",
+      "git add"
+    ],
+    "*.{ts,js}": [
+      "eslint --fix",
+      "git add"
+    ]
+  },
+  "jest": {
+    "testEnvironment": "node"
   },
-  "files": [
-    "src"
-  ],
-  "main": "src/index.js",
-  "keywords": [],
   "dependencies": {
     "debug": "4.1.1",
     "lodash.clonedeep": "4.5.0",
     "lodash.times": "4.3.2",
     "p-map": "3.0.0"
   },
   "devDependencies": {
+    "@babel/cli": "7.8.3",
+    "@babel/core": "7.8.3",
+    "@babel/preset-env": "7.8.3",
+    "@babel/preset-typescript": "7.8.3",
     "@shelf/eslint-config": "0.13.0",
     "@shelf/jest-dynamodb": "1.6.0",
+    "@types/debug": "4.1.5",
+    "@types/jest": "24.9.0",
+    "@types/lodash.clonedeep": "4.5.6",
+    "@types/lodash.times": "4.3.6",
+    "@types/node": "12",
+    "@types/p-map": "2.0.0",
     "aws-sdk": "2.536.0",
     "eslint": "6.8.0",
     "husky": "4.0.9",
     "jest": "24.9.0",
     "lint-staged": "9.5.0",
-    "prettier": "1.19.1"
+    "prettier": "1.19.1",
+    "typescript": "3.7.4"
   },
   "peerDependencies": {
     "aws-sdk": "2.x.x"
   },
-  "jest": {
-    "testEnvironment": "node"
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged"
-    }
-  },
-  "lint-staged": {
-    "*.js": [
-      "eslint --fix",
-      "git add"
-    ],
-    "*.{html,json,md,yml}": [
-      "prettier --write",
-      "git add"
-    ]
+  "engines": {
+    "node": ">=12"
   },
   "publishConfig": {
     "access": "public"

src/ddb.js

@@ -0,0 +1,32 @@
+import DynamoDB from 'aws-sdk/clients/dynamodb';
+import {DocumentClient} from 'aws-sdk/lib/dynamodb/document_client';
+
+const isTest = process.env.JEST_WORKER_ID;
+const config = {
+  convertEmptyValues: true,
+  ...(isTest && {endpoint: 'localhost:8000', sslEnabled: false, region: 'local-env'})
+};
+
+const documentClient: DocumentClient = new DynamoDB.DocumentClient(config);
+
+export async function scan(params: DocumentClient.ScanInput): Promise<DocumentClient.ScanOutput> {
+  return documentClient.scan(params).promise();
+}
+
+export function insertMany({items, tableName}): Promise<DocumentClient.BatchWriteItemOutput> {
+  const params: DocumentClient.BatchWriteItemInput = {
+    RequestItems: {
+      [tableName]: items.map(item => ({
+        PutRequest: {
+          Item: item
+        }
+      }))
+    }
+  };
+
+  return batchWrite(params);
+}
+
+async function batchWrite(items): Promise<DocumentClient.BatchWriteItemOutput> {
+  return documentClient.batchWrite(items).promise();
+}

src/ddb.ts

@@ -1,5 +1,5 @@
-const {insertMany} = require('./ddb');
-const {parallelScan} = require('./');
+import {insertMany} from './ddb';
+import {parallelScan} from './';
 
 describe('parallelScan', () => {
   const files = [
@@ -33,7 +33,7 @@ describe('parallelScan', () => {
 
     expect(items).toHaveLength(10);
 
-    for (let item of items) {
+    for (const item of items) {
       expect(files).toContainEqual(item);
     }
   });
@@ -52,7 +52,7 @@ describe('parallelScan', () => {
 
     expect(items).toHaveLength(10);
 
-    for (let item of items) {
+    for (const item of items) {
       expect(files).toContainEqual(item);
     }
   });
@@ -71,7 +71,7 @@ describe('parallelScan', () => {
 
     expect(items).toHaveLength(3);
 
-    for (let item of items) {
+    for (const item of items) {
       expect(files).toContainEqual(item);
     }
   });

src/index.test.js src/index.test.tssrc/index.test.js renamed to src/index.test.ts

@@ -1,24 +1,31 @@
-const pMap = require('p-map');
-const cloneDeep = require('lodash.clonedeep');
-const times = require('lodash.times');
-const {scan} = require('./ddb');
-
-const debug = require('debug')('ddb-parallel-scan');
-
-async function parallelScan(scanParams, {concurrency}) {
-  const segments = times(concurrency);
-  const docs = [];
+import pMap from 'p-map';
+import cloneDeep from 'lodash.clonedeep';
+import times from 'lodash.times';
+import Debug from 'debug';
+import {DocumentClient} from 'aws-sdk/lib/dynamodb/document_client';
+import {scan} from './ddb';
+
+const debug = Debug('ddb-parallel-scan');
+
+export async function parallelScan(
+  scanParams: DocumentClient.ScanInput,
+  {concurrency}: {concurrency: number}
+): Promise<DocumentClient.ItemList> {
+  const segments: number[] = times(concurrency);
+  const docs: DocumentClient.ItemList = [];
 
   debug(`Started parallel scan with ${concurrency} threads`);
 
   await pMap(segments, async (_, segmentIndex) => {
-    let ExclusiveStartKey = '';
+    let ExclusiveStartKey: DocumentClient.Key;
 
-    const params = cloneDeep(scanParams);
-    params.Segment = segmentIndex;
-    params.TotalSegments = concurrency;
+    const params: DocumentClient.ScanInput = {
+      ...cloneDeep(scanParams),
+      Segment: segmentIndex,
+      TotalSegments: concurrency
+    };
 
-    const now = Date.now();
+    const now: number = Date.now();
     debug(`[${segmentIndex}/${concurrency}][start]`, {ExclusiveStartKey});
 
     do {
@@ -43,7 +50,3 @@ async function parallelScan(scanParams, {concurrency}) {
 
   return docs;
 }
-
-module.exports = {
-  parallelScan
-};