feat: atomic @sentry/utils used only with submodule imports (#1413)

HazAT · kamilogorek · commit 3a0ec5dac808 · 2018-06-26T14:53:58.000+02:00
* feat: Add .gitignore for utils
* fix: Utils submodule import
* feat: Build from src into root for utils, Remove browser packages
* feat: Move jest config into package.json to be consitent
* fix: Lint error
diff --git a/packages/browser/package.json b/packages/browser/package.json
@@ -38,7 +38,6 @@
     "rimraf": "^2.6.2",
     "rollup": "^0.58.2",
     "rollup-plugin-commonjs": "^9.1.3",
-    "rollup-plugin-node-builtins": "^2.1.2",
     "rollup-plugin-node-resolve": "^3.3.0",
     "rollup-plugin-npm": "^2.0.0",
     "rollup-plugin-typescript2": "^0.13.0",
diff --git a/packages/browser/rollup.config.js b/packages/browser/rollup.config.js
@@ -2,7 +2,6 @@ import commonjs from 'rollup-plugin-commonjs';
 import uglify from 'rollup-plugin-uglify';
 import resolve from 'rollup-plugin-node-resolve';
 import typescript from 'rollup-plugin-typescript2';
-import builtins from 'rollup-plugin-node-builtins';
 
 export default [
   {
@@ -13,14 +12,8 @@ export default [
       exports: 'named',
       interop: false,
     },
-    external: [
-      '@sentry/core',
-      '@sentry/hub',
-      '@sentry/minimal',
-      '@sentry/utils',
-    ],
+    external: ['@sentry/core', '@sentry/hub', '@sentry/minimal'],
     plugins: [
-      builtins(),
       typescript({
         tsconfig: 'tsconfig.build.json',
       }),
@@ -39,12 +32,9 @@ export default [
       format: 'iife',
       name: 'Sentry',
       sourcemap: true,
-      interop: false,
-      extend: true,
     },
     context: 'window',
     plugins: [
-      builtins(),
       typescript({
         tsconfig: 'tsconfig.build.json',
         tsconfigOverride: { compilerOptions: { declaration: false } },
diff --git a/packages/browser/src/backend.ts b/packages/browser/src/backend.ts
@@ -1,7 +1,7 @@
 import { Backend, DSN, Options, SentryError } from '@sentry/core';
 import { addBreadcrumb, captureEvent } from '@sentry/minimal';
 import { SentryEvent } from '@sentry/types';
-import { supportsFetch } from '@sentry/utils';
+import { supportsFetch } from '@sentry/utils/supports';
 import { Raven } from './raven';
 import { FetchTransport, XHRTransport } from './transports';
 
diff --git a/packages/browser/src/integrations/onunhandledrejection.ts b/packages/browser/src/integrations/onunhandledrejection.ts
@@ -1,6 +1,6 @@
 import { captureException } from '@sentry/minimal';
 import { Integration } from '@sentry/types';
-import { getGlobalObject } from '@sentry/utils';
+import { getGlobalObject } from '@sentry/utils/misc';
 
 const global: any = getGlobalObject();
 
diff --git a/packages/browser/src/integrations/tracekit.js b/packages/browser/src/integrations/tracekit.js
@@ -1,4 +1,4 @@
-import { isError, isErrorEvent } from '@sentry/utils/dist/is';
+import { isError, isErrorEvent } from '@sentry/utils/is';
 
 /*
  TraceKit - Cross brower stack traces
diff --git a/packages/browser/src/transports/base.ts b/packages/browser/src/transports/base.ts
@@ -5,7 +5,7 @@ import {
   Transport,
   TransportOptions,
 } from '@sentry/types';
-import { urlEncode } from '@sentry/utils';
+import { urlEncode } from '@sentry/utils/object';
 
 /** Base Transport class implementation */
 export abstract class BaseTransport implements Transport {
diff --git a/packages/browser/src/transports/fetch.ts b/packages/browser/src/transports/fetch.ts
@@ -1,9 +1,7 @@
 import { SentryEvent } from '@sentry/types';
-import {
-  getGlobalObject,
-  serialize,
-  supportsReferrerPolicy,
-} from '@sentry/utils';
+import { getGlobalObject } from '@sentry/utils/misc';
+import { serialize } from '@sentry/utils/object';
+import { supportsReferrerPolicy } from '@sentry/utils/supports';
 import { BaseTransport } from './base';
 
 const global: any = getGlobalObject();
diff --git a/packages/browser/src/transports/xhr.ts b/packages/browser/src/transports/xhr.ts
@@ -1,5 +1,5 @@
 import { SentryEvent } from '@sentry/types';
-import { serialize } from '@sentry/utils';
+import { serialize } from '@sentry/utils/object';
 import { BaseTransport } from './base';
 
 /** `XHR` based transport */
diff --git a/packages/core/jest.config.js b/packages/core/jest.config.js
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -40,5 +40,17 @@
     "fix:tslint": "tslint --fix -t stylish -p .",
     "test": "jest",
     "test:watch": "jest --watch --notify"
+  },
+  "jest": {
+    "collectCoverage": true,
+    "transform": { "^.+\\.ts$": "ts-jest" },
+    "moduleFileExtensions": ["js", "ts"],
+    "testEnvironment": "node",
+    "testMatch": ["**/*.test.ts"],
+    "globals": {
+      "ts-jest": {
+        "tsConfigFile": "./tsconfig.json"
+      }
+    }
   }
 }
diff --git a/packages/core/src/base.ts b/packages/core/src/base.ts
@@ -1,6 +1,7 @@
 import { Scope } from '@sentry/hub';
 import { Breadcrumb, SdkInfo, SentryEvent } from '@sentry/types';
-import { truncate, uuid4 } from '@sentry/utils';
+import { uuid4 } from '@sentry/utils/misc';
+import { truncate } from '@sentry/utils/string';
 import { DSN } from './dsn';
 import { Backend, Client, Options } from './interfaces';
 import { SendStatus } from './status';
diff --git a/packages/core/test/lib/base.test.ts b/packages/core/test/lib/base.test.ts
@@ -6,10 +6,13 @@ import { TEST_SDK, TestClient } from '../mocks/client';
 
 const PUBLIC_DSN = 'https://username@domain/path';
 
-jest.mock('@sentry/utils', () => ({
+jest.mock('@sentry/utils/misc', () => ({
   uuid4(): string {
     return '42';
   },
+}));
+
+jest.mock('@sentry/utils/string', () => ({
   truncate(str: string): string {
     return str;
   },
diff --git a/packages/hub/jest.config.js b/packages/hub/jest.config.js
diff --git a/packages/hub/package.json b/packages/hub/package.json
@@ -37,5 +37,17 @@
     "fix:tslint": "tslint --fix -t stylish -p .",
     "test": "jest",
     "test:watch": "jest --watch --notify"
+  },
+  "jest": {
+    "collectCoverage": true,
+    "transform": { "^.+\\.ts$": "ts-jest" },
+    "moduleFileExtensions": ["js", "ts"],
+    "testEnvironment": "node",
+    "testMatch": ["**/*.test.ts"],
+    "globals": {
+      "ts-jest": {
+        "tsConfigFile": "./tsconfig.json"
+      }
+    }
   }
 }
diff --git a/packages/minimal/jest.config.js b/packages/minimal/jest.config.js
diff --git a/packages/minimal/package.json b/packages/minimal/package.json
@@ -38,5 +38,17 @@
     "fix:tslint": "tslint --fix -t stylish -p .",
     "test": "jest",
     "test:watch": "jest --watch --notify"
+  },
+  "jest": {
+    "collectCoverage": true,
+    "transform": { "^.+\\.ts$": "ts-jest" },
+    "moduleFileExtensions": ["js", "ts"],
+    "testEnvironment": "node",
+    "testMatch": ["**/*.test.ts"],
+    "globals": {
+      "ts-jest": {
+        "tsConfigFile": "./tsconfig.json"
+      }
+    }
   }
 }
diff --git a/packages/node/jest.config.js b/packages/node/jest.config.js
diff --git a/packages/node/package.json b/packages/node/package.json
@@ -42,5 +42,17 @@
     "fix:tslint": "tslint --fix -t stylish -p .",
     "test": "jest",
     "test:watch": "jest --watch --notify"
+  },
+  "jest": {
+    "collectCoverage": true,
+    "transform": { "^.+\\.ts$": "ts-jest" },
+    "moduleFileExtensions": ["js", "ts"],
+    "testEnvironment": "node",
+    "testMatch": ["**/*.test.ts"],
+    "globals": {
+      "ts-jest": {
+        "tsConfigFile": "./tsconfig.json"
+      }
+    }
   }
 }
diff --git a/packages/node/src/integrations/console.ts b/packages/node/src/integrations/console.ts
@@ -1,6 +1,6 @@
 import { addBreadcrumb } from '@sentry/minimal';
 import { Integration, Severity } from '@sentry/types';
-import { fill } from '@sentry/utils';
+import { fill } from '@sentry/utils/object';
 import { format } from 'util';
 
 /**
diff --git a/packages/node/src/integrations/http.ts b/packages/node/src/integrations/http.ts
@@ -1,6 +1,6 @@
 import { addBreadcrumb } from '@sentry/minimal';
 import { Integration } from '@sentry/types';
-import { fill } from '@sentry/utils';
+import { fill } from '@sentry/utils/object';
 import { ClientRequest, ClientRequestArgs, ServerResponse } from 'http';
 import { inherits } from 'util';
 import { getDefaultHub } from '../hub';
diff --git a/packages/typescript/tslint.json b/packages/typescript/tslint.json
@@ -4,6 +4,8 @@
     // This rule has side effects and must be disabled
     "no-unused-variable": false,
 
+    "no-submodule-imports": false,
+
     // We don't want these
     "newline-before-return": false,
     "no-any": false,
diff --git a/packages/utils/.gitignore b/packages/utils/.gitignore
@@ -0,0 +1,3 @@
+*.js.map
+*.d.ts
+*.js
diff --git a/packages/utils/.npmignore b/packages/utils/.npmignore
@@ -1,2 +1,5 @@
 *
-!/dist/**/*
+!*.js.map
+!*.d.ts
+!*.js
+jest.config.js
diff --git a/packages/utils/README.md b/packages/utils/README.md
@@ -11,4 +11,5 @@
 [![npm dm](https://img.shields.io/npm/dm/@sentry/utils.svg)](https://www.npmjs.com/package/@sentry/utils)
 [![npm dt](https://img.shields.io/npm/dt/@sentry/utils.svg)](https://www.npmjs.com/package/@sentry/utils)
 
-Common utilities used by the Sentry JavaScript SDKs.
+Common utilities used by the Sentry JavaScript SDKs. **Warning, only submodule
+imports are allowed here.**
diff --git a/packages/utils/jest.config.js b/packages/utils/jest.config.js
diff --git a/packages/utils/package.json b/packages/utils/package.json
@@ -9,8 +9,6 @@
   "engines": {
     "node": ">=6"
   },
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
@@ -29,7 +27,7 @@
   },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
-    "clean": "rimraf dist coverage",
+    "clean": "rimraf dist coverage *.js *.js.map *.d.ts",
     "lint": "run-s lint:prettier lint:tslint",
     "lint:prettier": "prettier-check '{src,test}/**/*.ts'",
     "lint:tslint": "tslint -t stylish -p .",
@@ -38,5 +36,17 @@
     "fix:tslint": "tslint --fix -t stylish -p .",
     "test": "jest",
     "test:watch": "jest --watch --notify"
+  },
+  "jest": {
+    "collectCoverage": true,
+    "transform": { "^.+\\.ts$": "ts-jest" },
+    "moduleFileExtensions": ["js", "ts"],
+    "testEnvironment": "node",
+    "testMatch": ["**/*.test.ts"],
+    "globals": {
+      "ts-jest": {
+        "tsConfigFile": "./tsconfig.json"
+      }
+    }
   }
 }
diff --git a/packages/utils/src/index.ts b/packages/utils/src/index.ts
@@ -1,14 +1,2 @@
-export { forget, filterAsync } from './async';
-export { mkdirp, mkdirpSync } from './fs';
-export { clone, deserialize, fill, serialize, urlEncode } from './object';
-export { Store } from './store';
-export { isError, isErrorEvent, isDOMError, isDOMException } from './is';
-export { truncate } from './string';
-export {
-  supportsDOMError,
-  supportsDOMException,
-  supportsErrorEvent,
-  supportsFetch,
-  supportsReferrerPolicy,
-} from './supports';
-export { getGlobalObject, uuid4 } from './misc';
+// We do not export anything by default since we always want to deep import
+// like: import { getGlobalObject } from '@sentry/utils/misc';
diff --git a/packages/utils/src/object.ts b/packages/utils/src/object.ts
@@ -137,7 +137,9 @@ export function fill(
 ): void {
   const orig = source[name];
   source[name] = replacement(orig);
+  // tslint:disable-next-line:no-unsafe-any
   source[name].__raven__ = true;
+  // tslint:disable-next-line:no-unsafe-any
   source[name].__orig__ = orig;
   if (track) {
     track.push([source, name, orig]);
@@ -152,6 +154,9 @@ export function fill(
  */
 export function urlEncode(object: { [key: string]: any }): string {
   return Object.keys(object)
-    .map(key => `${encodeURIComponent(key)}=${encodeURIComponent(object[key])}`)
+    .map(
+      // tslint:disable-next-line:no-unsafe-any
+      key => `${encodeURIComponent(key)}=${encodeURIComponent(object[key])}`,
+    )
     .join('&');
 }
diff --git a/packages/utils/test/async.test.ts b/packages/utils/test/async.test.ts
@@ -1,4 +1,4 @@
-import { filterAsync, forget } from '../src';
+import { filterAsync, forget } from '../src/async';
 
 describe('forget', () => {
   const console = {
diff --git a/packages/utils/test/is.test.ts b/packages/utils/test/is.test.ts
@@ -1,12 +1,9 @@
+import { isDOMError, isDOMException, isError, isErrorEvent } from '../src/is';
 import {
-  isDOMError,
-  isDOMException,
-  isError,
-  isErrorEvent,
   supportsDOMError,
   supportsDOMException,
   supportsErrorEvent,
-} from '../src';
+} from '../src/supports';
 
 class SentryError extends Error {
   public name: string;
diff --git a/packages/utils/test/object.test.ts b/packages/utils/test/object.test.ts
diff --git a/packages/utils/test/store.test.ts b/packages/utils/test/store.test.ts
diff --git a/packages/utils/test/string.test.ts b/packages/utils/test/string.test.ts
diff --git a/packages/utils/tsconfig.build.json b/packages/utils/tsconfig.build.json
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { isError, isErrorEvent } from '@sentry/utils/dist/is';`
	`1`	`+import { isError, isErrorEvent } from '@sentry/utils/is';`
`2`	`2`
`3`	`3`	`/*`
`4`	`4`	`TraceKit - Cross brower stack traces`