@salesforce/pwa-kit-react-sdk 3.8.0-preview.0-basepath → 3.8.0-preview.0

package/utils/uuidv4.client.test.js

@@ -0,0 +1,27 @@
+"use strict";
+
+var _uuidv = require("./uuidv4.client");
+/*
+ * Copyright (c) 2022, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+let originalCrypto;
+describe('uuidv4', () => {
+  beforeEach(() => {
+    originalCrypto = global.crypto;
+  });
+  afterEach(() => {
+    global.crypto = originalCrypto;
+  });
+  test('returns correct format', () => {
+    global.crypto = {
+      // we mock the module because crypto.getRandomValues
+      // is not available on node v14 (came out in node v15)
+      getRandomValues: () => [123]
+    };
+    expect((0, _uuidv.uuidv4)()).toBe('abbbbbbb-abbb-4bbb-bbbb-abbbbbbbbbbb');
+  });
+});

package/utils/warnings.js

@@ -0,0 +1,81 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.experimental = exports.deprecated = void 0;
+/*
+ * Copyright (c) 2021, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+/**
+ * @module progressive-web-sdk/utils/warnings
+ * @private
+ */
+
+let displayed = {};
+
+/**
+ *
+ * Prints a warning to the console that a deprecated function is being used.
+ * This allows you to say when the function will be removed and what alternate
+ * function should be used. Example: "This function will be removed in version
+ * 1.2.3. Please use alternateFunction() instead."
+ *
+ * @function
+ * @param {String} message A message to follow the initial deprecation warning
+ */
+const deprecated = message => {
+  warn('deprecated', message);
+};
+
+/**
+ * Prints a warning to the console that an experimental function is being used.
+ *
+ * @function
+ * @param {String} message A message to follow the initial experimental warning
+ */
+exports.deprecated = deprecated;
+const experimental = message => {
+  warn('experimental', message);
+};
+
+/**
+ * Displays a warning once per hard navigation.
+ * Does not display a warning when in production mode.
+ * @private
+ */
+exports.experimental = experimental;
+const shouldDisplay = name => {
+  if (process.env.NODE_ENV === 'production' || displayed[name]) {
+    return false;
+  } else {
+    displayed[name] = true;
+    return true;
+  }
+};
+
+/**
+ * Logs a warning to the console
+ * @param type Warning type
+ * @param message A message to follow the initial warning
+ */
+const warn = (type, message) => {
+  let functionName = '';
+
+  // Get caller name by reading an Error stack trace instead of getting
+  // function property `caller` because it is not allowed in `strict` mode.
+  try {
+    throw new Error();
+  } catch (e) {
+    functionName = e.stack.split('\n')[3].split(' ')[5];
+  }
+  const messages = {
+    experimental: `You are currently using an experimental function: [${functionName}] This function may change at any time.`,
+    deprecated: `You are currently using an deprecated function: [${functionName}].`
+  };
+  if (!shouldDisplay(functionName)) return;
+  console.warn(`[PWA Kit API WARNING]: ${messages[type]} ${message ? message : ''}`);
+};

package/utils/warnings.test.js

@@ -0,0 +1,48 @@
+"use strict";
+
+var _warnings = require("./warnings");
+/*
+ * Copyright (c) 2021, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+describe('warnings', () => {
+  let original;
+  beforeEach(() => {
+    original = console.warn;
+    console.warn = jest.fn();
+  });
+  afterEach(() => {
+    console.warn = original;
+  });
+  test('deprecated', () => {
+    const testFunction1 = () => {
+      (0, _warnings.deprecated)('msg');
+    };
+    testFunction1();
+    expect(console.warn.mock.calls[0][0]).toBe(`[PWA Kit API WARNING]: You are currently using an deprecated function: [testFunction1]. msg`);
+    testFunction1();
+    expect(console.warn).toHaveBeenCalledTimes(1);
+    const testFunction2 = () => {
+      (0, _warnings.deprecated)();
+    };
+    testFunction2();
+    expect(console.warn.mock.calls[1][0]).toBe(`[PWA Kit API WARNING]: You are currently using an deprecated function: [testFunction2]. `);
+  });
+  test('experimental', () => {
+    const testFunction3 = () => {
+      (0, _warnings.experimental)('msg');
+    };
+    testFunction3();
+    expect(console.warn.mock.calls[0][0]).toBe(`[PWA Kit API WARNING]: You are currently using an experimental function: [testFunction3] This function may change at any time. msg`);
+    testFunction3();
+    expect(console.warn).toHaveBeenCalledTimes(1);
+    const testFunction4 = () => {
+      (0, _warnings.experimental)();
+    };
+    testFunction4();
+    expect(console.warn.mock.calls[1][0]).toBe(`[PWA Kit API WARNING]: You are currently using an experimental function: [testFunction4] This function may change at any time. `);
+  });
+});