Add proper TypeScript build logic

.github/workflows/pr-build.yml

@@ -4,7 +4,7 @@ on:
   push:
     branches: [master]
   pull_request:
-    branches: [master]
+    branches: [master, aws-v3-support]
 
 jobs:
   build:
@@ -44,6 +44,7 @@ jobs:
         if: '!matrix.coverage'
         run: |
           npx lerna bootstrap --hoist
+          npx lerna run compile
           npx lerna run test
         shell: bash
         env:
@@ -55,6 +56,7 @@ jobs:
         if: matrix.coverage
         run: |
           npx lerna bootstrap --hoist
+          npx lerna run compile
           npx lerna run testcov
           npx lerna run reportcov
           echo test

.github/workflows/release.yml

@@ -31,6 +31,7 @@ jobs:
       - name: Execute tests with Lerna
         run: |
           npx lerna bootstrap --hoist
+          npx lerna run compile
           npx lerna run test
 
       - name: Publish package to npm

.gitignore

@@ -4,3 +4,4 @@ docs
 .idea/
 .nyc_output/
 *.lcov
+dist

README.md

@@ -89,14 +89,18 @@ AWS will not:
 
 ## Testing from Source
 
-This repo uses [Lerna](https://lernajs.io) to manage multiple packages. To install Lerna:
+This repo uses [Lerna](https://lernajs.io) to manage multiple packages. To install Lerna as a CLI:
 ```
-npm install lerna
+npm install -g lerna
 ```
 To install devDependencies and peerDependencies for all packages:
 ```
 lerna bootstrap --hoist
 ```
+This repo has a combination of TypeScript and JavaScript source files. To transpile the TypeScript files for testing, run:
+```
+lerna run compile
+```
 To run tests for all packages:
 ```
 lerna run test

packages/core/lib/aws-xray.js

@@ -9,7 +9,7 @@ var LambdaEnv = require('./env/aws_lambda');
 // pkginfo as an empty object
 var pkginfo = {}
 try {
-  pkginfo = require('../package.json');
+  pkginfo = require('../../package.json');
 } catch (err) {
   logging.getLogger().debug('Failed to load SDK data:', err);
 }

packages/core/package.json

@@ -8,8 +8,13 @@
     "William Armiros <armiros@amazon.com>",
     "Moritz Onken <onken@netcubed.de>"
   ],
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "files": [
+    "dist/lib/**/*",
+    "LICENSE",
+    "README.md"
+  ],
+  "main": "dist/lib/index.js",
+  "types": "dist/lib/index.d.ts",
   "engines": {
     "node": ">= 10.x"
   },
@@ -25,9 +30,14 @@
     "semver": "^5.3.0"
   },
   "scripts": {
-    "test": "mocha --recursive ./test/ -R spec && tsd && mocha --recursive ./test_async/ -R spec",
+    "prepare": "npm run compile",
+    "compile": "tsc && npm run copy-lib && npm run copy-test",
+    "copy-lib": "find lib -type f \\( -name '*.d.ts' -o -name '*.json' \\) | xargs -I % ../../scripts/cp-with-structure.sh % dist",
+    "copy-test": "find test -name '*.json' | xargs -I % ../../scripts/cp-with-structure.sh % dist",
+    "test": "mocha --recursive ./dist/test/ -R spec && tsd && mocha --recursive ./dist/test_async/ -R spec",
     "test-d": "tsd",
-    "test-async": "mocha --recursive ./test_async/ -R spec",
+    "test-async": "mocha --recursive ./dist/test_async/ -R spec",
+    "clean": "rm -rf dist && rm -rf node_modules",
     "testcov": "nyc npm run test",
     "reportcov": "nyc report --reporter=text-lcov > coverage.lcov && codecov"
   },

packages/core/test/integration/segment_maintained_across_shared_promise.test.js

@@ -7,7 +7,7 @@ if (!global.Promise) {
 var assert = require('chai').assert;
 var http = require('http');
 
-var AWSXRay = require('../../');
+var AWSXRay = require('../../lib');
 var Segment = AWSXRay.Segment;
 
 AWSXRay.capturePromise();

packages/core/test/unit/aws-xray.test.js

@@ -2,7 +2,6 @@ var assert = require('chai').assert;
 var chai = require('chai');
 var sinon = require('sinon');
 var sinonChai = require('sinon-chai');
-var upath = require('upath');
 
 var segmentUtils = require('../../lib/segments/segment_utils');
 
@@ -30,14 +29,12 @@ describe('AWSXRay', function() {
       // This test requires both index.js and aws-xray.js are first time required.
       // We should always clear the require cache for these two files so this test
       // could run independently.
-      Object.keys(require.cache).forEach(function(key) {
-        var normalisedPath = upath.toUnix(key);
-        if(normalisedPath.includes('core/lib/index.js') || normalisedPath.includes('core/lib/aws-xray.js')) {
-          delete require.cache[key];
-        }
-      });
+      const indexPath = '../../lib/index';
+      const xrayPath = '../../lib/aws-xray';
+      delete require.cache[require.resolve(indexPath)];
+      delete require.cache[require.resolve(xrayPath)];
 
-      AWSXRay = require('../../lib/index');
+      AWSXRay = require(indexPath);
 
       setSDKDataStub.should.have.been.calledWithExactly(sinon.match.object);
       setServiceDataStub.should.have.been.calledWithExactly(sinon.match.object);

packages/core/test/unit/env/aws_lambda.test.js

@@ -41,7 +41,7 @@ describe('AWSLambda', function() {
   });
 
   describe('#init', function() {
-    var disableReusableSocketStub, populateStub, sandbox, setSegmentStub, validateStub;
+    var disableReusableSocketStub, disableCentralizedSamplingStub, populateStub, sandbox, setSegmentStub, validateStub;
 
     beforeEach(function() {
       sandbox = sinon.createSandbox();

packages/core/test_async/integration/segment_maintained_across_awaited.test.js

@@ -1,6 +1,6 @@
 var assert = require('chai').assert;
 var http = require('http');
-var AWSXRay = require('../../');
+var AWSXRay = require('../../lib');
 var Segment = AWSXRay.Segment;
 
 AWSXRay.enableAutomaticMode();

packages/core/tsconfig.json

@@ -4,8 +4,13 @@
     "target": "es2019",
     "strict": true,
     "strictNullChecks": true,
-    "declaration": true,
-    "esModuleInterop": true
+    "declaration": false,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "allowJs": true,
+    "checkJs": false,
+    "outDir": "dist",
   },
-  "files": ["lib/patchers/aws3_p.ts"]
+  "include": ["lib", "test", "test_async"],
+  "exclude": ["dist", "node_modules"]
 }

scripts/cp-with-structure.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+## This script copies a file provided as the first parameter into the destination directory
+## provided by the second parameter, while maintaining the directory structure of the source
+## file. It is similar to 'cp --parents' on Linux, but usable cross-platform
+src=(${*: 1})
+dest=${*: -1:1}
+for filename in $src; do
+  [ -e "$filename" ] || continue
+  dirPath=$(dirname "${filename}")
+  mkdir -p $dest/$dirPath
+  cp -a $filename $dest/$dirPath
+done