Merge pull request #8 from grafana/elliot/tests

adding tests

Author: eskirk

.github/workflows/publish-npm.yml

@@ -25,6 +25,11 @@ jobs:
         with:
           cmd: install --frozen-lockfile
 
+      - name: Run tests
+        uses: borales/actions-yarn@v4
+        with:
+          cmd: test
+
       - name: Build production bundle
         uses: borales/actions-yarn@v4
         with:

.github/workflows/run-tests.yml

@@ -0,0 +1,42 @@
+name: run-tests
+on:
+  pull_request:
+
+jobs:
+  run-tests:
+    name: Run tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.event.pull_request.head.ref }}
+          fetch-depth: 0
+
+      - name: Install dependencies
+        uses: borales/actions-yarn@v5
+        with:
+          cmd: install --frozen-lockfile
+
+      - name: Setup NPM
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.x
+          registry-url: "https://registry.npmjs.org"
+
+      - name: Run test manually
+        run: |
+          cd packages/faro-rollup/src/test
+          yarn install
+          cd ../..
+          yarn install
+          cd ../faro-webpack/src/test
+          yarn install
+          yarn build
+          cd ../../..
+          yarn test
+
+      - name: Build production bundle
+        uses: borales/actions-yarn@v5
+        with:
+          cmd: build

.gitignore

@@ -5,4 +5,5 @@ src/index.js
 src/index.d.ts
 yalc.lock
 .yalc
-.npmrc
+.npmrc
+lerna-debug.log

package.json

@@ -6,7 +6,8 @@
   ],
   "scripts": {
     "build": "lerna run build",
-    "publish": "lerna publish"
+    "publish": "lerna publish",
+    "test": "lerna run test"
   },
   "author": "Grafana Labs",
   "license": "Apache-2.0",

packages/faro-bundlers-shared/package.json

@@ -11,7 +11,8 @@
   },
   "license": "Apache-2.0",
   "scripts": {
-    "build": "rollup --config rollup.config.mjs"
+    "build": "rollup --config rollup.config.mjs",
+    "test": "echo \"No tests yet...\" && exit 0"
   },
   "devDependencies": {
     "@rollup/plugin-typescript": "^11.1.5",

packages/faro-rollup/package.json

@@ -2,6 +2,7 @@
   "name": "@grafana/faro-rollup-plugin",
   "version": "0.0.12",
   "description": "Upload a source map to the Faro source map API from a Rollup build pipeline",
+  "type": "module",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.mjs",
   "repository": {
@@ -12,12 +13,17 @@
   "license": "Apache-2.0",
   "author": "Grafana Labs",
   "scripts": {
-    "build": "rollup --config rollup.config.mjs"
+    "build": "rollup --config rollup.config.mjs",
+    "test": "ava src/index.test.js"
+  },
+  "devDependencies": {
+    "ava": "^3.8.1"
   },
   "dependencies": {
     "@grafana/faro-bundlers-shared": "^0.0.12",
     "cross-fetch": "^4.0.0",
-    "magic-string": "^0.30.5"
+    "magic-string": "^0.30.5",
+    "rollup": "^4.1.1"
   },
   "publishConfig": {
     "access": "public"

packages/faro-rollup/rollup.config.mjs

@@ -29,12 +29,13 @@ export default {
   plugins: [
     typescript({
       outDir: "dist",
+      exclude: ["**/*.test.ts"],
     }),
     babel({
       extensions,
       babelHelpers: "bundled",
       include: ["src/**/*"],
-      exclude: /node_modules/
+      exclude: [/node_modules/, /test/, "*.test.ts"]
     }),
     json(),
     resolve({
@@ -43,7 +44,8 @@ export default {
       preferBuiltins: true,
     }),
     commonjs({
-      include: /node_modules/
+      include: /node_modules/,
+      exclude: "*.test.ts"
     }),
   ],
 };

packages/faro-rollup/src/index.test.js

@@ -0,0 +1,10 @@
+import test from 'ava';
+import { rollup } from 'rollup';
+import config from './test/rollup.config.cjs';
+
+test('rollup', async t => {
+  const bundle = await rollup(config);
+  const output = await bundle.write(config.output);
+
+  t.truthy(output.output[0].code.startsWith(`(function(){try{var g=typeof window!=="undefined"?window:typeof global!=="undefined"?global:typeof self!=="undefined"?self:{};g["__faroBundleId_rollup-test-app"]="test"`));
+});

packages/faro-rollup/src/index.ts

@@ -19,7 +19,9 @@ export default function faroUploader(
   const {
     endpoint,
     appId,
+    apiKey,
     orgId,
+    stackId,
     appName,
     outputFiles,
     keepSourcemaps,
@@ -89,6 +91,8 @@ export default function faroUploader(
               filesToUpload.pop();
               const result = await uploadCompressedSourceMaps({
                 sourcemapEndpoint,
+                apiKey,
+                stackId,
                 orgId: orgId,
                 files: filesToUpload,
                 keepSourcemaps: !!keepSourcemaps,
@@ -109,6 +113,8 @@ export default function faroUploader(
           if (!gzipContents) {
             const result = await uploadSourceMap({
               sourcemapEndpoint,
+              apiKey,
+              stackId,
               filename,
               orgId: orgId,
               filePath: `${outputPath}/${filename}`,
@@ -126,6 +132,8 @@ export default function faroUploader(
         if (filesToUpload.length) {
           const result = await uploadCompressedSourceMaps({
             sourcemapEndpoint,
+            apiKey,
+            stackId,
             orgId: orgId,
             files: filesToUpload,
             keepSourcemaps: !!keepSourcemaps,

packages/faro-rollup/src/test/bundle.js

@@ -0,0 +1,5 @@
+<html>
+  <body>
+    <script type="text/javascript" src="bundle.js"></script>
+  </body>
+</html>

packages/faro-rollup/src/test/index.html

@@ -0,0 +1 @@
+document.write('<h1>Hello World</h1>');

packages/faro-rollup/src/test/main.js

@@ -0,0 +1,15 @@
+{
+  "name": "webpack-test-app",
+  "version": "1.0.0",
+  "main": "index.js",
+  "scripts": {
+    "build": "rollup --config rollup.config.cjs"
+  },
+  "dependencies": {
+    "@grafana/faro-rollup-plugin": "^0.0.12"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "webpack-cli": "^5.1.4"
+  }
+}

packages/faro-rollup/src/test/package.json

@@ -0,0 +1,19 @@
+const faroUploader = require('@grafana/faro-rollup-plugin');
+
+module.exports =
+{
+  input: "./src/test/main.js",
+  output: {
+    file: './dist/bundle.js'
+  },
+  plugins: [
+    faroUploader({
+      appName: 'rollup-test-app',
+      endpoint: 'http://localhost:8000/faro/api/v1',
+      appId: '1',
+      orgId: '1',
+      gzipContents: true,
+      bundleId: 'test'
+    })
+  ]
+};

packages/faro-rollup/src/test/rollup.config.cjs

@@ -0,0 +1,7 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "es5",
+    "esModuleInterop": true
+  }
+}