move all string util tests to utils

Author: lobsterkatie

packages/browser/test/unit/string.test.ts

@@ -104,11 +104,11 @@ export function isMatchingPattern(value: string, pattern: RegExp | string): bool
   return false;
 }
 
-type GlobalWithBase64Helpers = {
-  // browser
+export type GlobalBase64Helpers = {
+  // browser and Node 16+
   atob?: (base64String: string) => string;
   btoa?: (utf8String: string) => string;
-  // Node
+  // all versions of Node
   Buffer?: { from: (input: string, encoding: string) => { toString: (encoding: string) => string } };
 };
 
@@ -120,7 +120,7 @@ type GlobalWithBase64Helpers = {
  * @returns A base64-encoded version of the string
  */
 export function unicodeToBase64(plaintext: string): string {
-  const globalObject = getGlobalObject<GlobalWithBase64Helpers>();
+  const globalObject = getGlobalObject<GlobalBase64Helpers>();
 
   // To account for the fact that different platforms use different character encodings natively, our `tracestate`
   // spec calls for all jsonified data to be encoded in UTF-8 bytes before being passed to the base64 encoder.
@@ -129,7 +129,7 @@ export function unicodeToBase64(plaintext: string): string {
       throw new Error(`Input must be a string. Received input of type '${typeof plaintext}'.`);
     }
 
-    // browser
+    // browser and Node 16+
     if ('btoa' in globalObject) {
       // encode using UTF-8
       const bytes = new TextEncoder().encode(plaintext);
@@ -142,7 +142,7 @@ export function unicodeToBase64(plaintext: string): string {
       return globalObject.btoa!(bytesAsString);
     }
 
-    // Node
+    // fallback for Node <= 14
     if ('Buffer' in globalObject) {
       // encode using UTF-8
       // TODO: if TS ever learns about "in", we can get rid of the non-null assertion
@@ -173,7 +173,7 @@ export function unicodeToBase64(plaintext: string): string {
  * @returns A Unicode string
  */
 export function base64ToUnicode(base64String: string): string {
-  const globalObject = getGlobalObject<GlobalWithBase64Helpers>();
+  const globalObject = getGlobalObject<GlobalBase64Helpers>();
 
   // To account for the fact that different platforms use different character encodings natively, our `tracestate` spec
   // calls for all jsonified data to be encoded in UTF-8 bytes before being passed to the base64 encoder. So to reverse
@@ -183,7 +183,7 @@ export function base64ToUnicode(base64String: string): string {
       throw new Error(`Input must be a string. Received input of type '${typeof base64String}'.`);
     }
 
-    // browser
+    // browser and Node 16+
     if ('atob' in globalObject) {
       // `atob` returns a string rather than bytes, so we first need to encode using the native encoding (UTF-16)
       // TODO: if TS ever learns about "in", we can get rid of the non-null assertion
@@ -195,7 +195,7 @@ export function base64ToUnicode(base64String: string): string {
       return new TextDecoder().decode(Uint8Array.from(bytes));
     }
 
-    // Node
+    // fallback for Node <= 14
     if ('Buffer' in globalObject) {
       // unlike the browser, Node can go straight from base64 to bytes
       // TODO: if TS ever learns about "in", we can get rid of the non-null assertion

packages/utils/src/string.ts

@@ -1,4 +1,7 @@
-import { base64ToUnicode, isMatchingPattern, truncate, unicodeToBase64 } from '../src/string';
+import { JSDOM } from 'jsdom';
+
+import * as crossPlatformUtils from '../src/crossplatform';
+import { base64ToUnicode, GlobalBase64Helpers, isMatchingPattern, truncate, unicodeToBase64 } from '../src/string';
 
 // See https://tools.ietf.org/html/rfc4648#section-4 for base64 spec
 // eslint-disable-next-line no-useless-escape
@@ -50,13 +53,51 @@ describe('isMatchingPattern()', () => {
   });
 });
 
-// NOTE: These tests are copied (and adapted for chai syntax) to `string.test.ts` in `@sentry/browser`. The
-// base64-conversion functions have a different implementation in browser and node, so they're copied there to prove
-// they work in a real live browser. If you make changes here, make sure to also port them over to that copy.
-describe('base64ToUnicode/unicodeToBase64', () => {
+// these functions use different built-ins depending on whether the code is running in Node or in the browser, so test
+// both environments
+describe.each(['node', 'browser'])('base64ToUnicode/unicodeToBase64 (%s)', (testEnv: string) => {
   const unicodeString = 'Dogs are great!';
   const base64String = 'RG9ncyBhcmUgZ3JlYXQh';
 
+  let atobSpy: jest.SpyInstance, btoaSpy: jest.SpyInstance, bufferSpy: jest.SpyInstance;
+
+  beforeAll(() => {
+    const { Buffer, ...nonBufferGlobals } = global as typeof global & GlobalBase64Helpers;
+
+    // By default, all tests in run in a node environment. To mimic the behavior of a browser, we need to adjust what is
+    // available globally.
+    if (testEnv === 'browser') {
+      const { window } = new JSDOM('', { url: 'http://dogs.are.great/' });
+
+      atobSpy = jest.spyOn(window, 'atob');
+      btoaSpy = jest.spyOn(window, 'btoa');
+
+      jest
+        .spyOn(crossPlatformUtils, 'getGlobalObject')
+        .mockReturnValue({ atob: atobSpy, btoa: btoaSpy, ...nonBufferGlobals } as any);
+    }
+    // no need to adjust what's in `global`, but set up a spy so we can make sure the right functions are getting called
+    // in the right environments
+    else {
+      bufferSpy = jest.spyOn(Buffer, 'from');
+    }
+  });
+
+  afterAll(() => {
+    jest.restoreAllMocks();
+  });
+
+  it('meta: uses the right mock given test env', () => {
+    unicodeToBase64(unicodeString);
+    base64ToUnicode(base64String);
+    if (testEnv === 'browser') {
+      expect(atobSpy).toHaveBeenCalled();
+      expect(btoaSpy).toHaveBeenCalled();
+    } else {
+      expect(bufferSpy).toHaveBeenCalled();
+    }
+  });
+
   test('converts to valid base64', () => {
     expect(BASE64_REGEX.test(unicodeToBase64(unicodeString))).toBe(true);
   });