Register package version with Stripe instance (stripe#35)

christopher-stripe · web-flow · commit 33c5f52ca18d · 2020-03-31T08:52:54.000-07:00
diff --git a/jest.config.js b/jest.config.js
@@ -10,5 +10,6 @@ module.exports = {
   globals: {
     // Suppress noise about enabling `esModuleInterop`
     'ts-jest': {diagnostics: {ignoreCodes: [151001]}},
+    _VERSION: true,
   },
 };
diff --git a/package.json b/package.json
@@ -35,6 +35,7 @@
   "devDependencies": {
     "@babel/core": "^7.7.2",
     "@babel/preset-env": "^7.7.1",
+    "@rollup/plugin-replace": "^2.3.1",
     "@types/jest": "^24.0.25",
     "@typescript-eslint/eslint-plugin": "^2.15.0",
     "@typescript-eslint/parser": "^2.15.0",
diff --git a/rollup.config.js b/rollup.config.js
@@ -1,6 +1,8 @@
 import babel from 'rollup-plugin-babel';
 import pkg from './package.json';
 import ts from 'rollup-plugin-typescript2';
+import replace from '@rollup/plugin-replace';
+import {version} from './package.json';
 
 export default [
   {
@@ -16,6 +18,9 @@ export default [
       babel({
         extensions: ['.ts', '.js', '.tsx', '.jsx'],
       }),
+      replace({
+        _VERSION: JSON.stringify(version),
+      }),
     ],
   },
 ];
diff --git a/src/index.ts b/src/index.ts
@@ -2,6 +2,10 @@
 ///<reference path='../types/index.d.ts' />
 import {Stripe as StripeInstance, StripeConstructor} from '@stripe/stripe-js';
 
+// `_VERSION` will be rewritten by `@rollup/plugin-replace` as a string literal
+// containing the package.json version
+declare const _VERSION: string;
+
 const V3_URL = 'https://js.stripe.com/v3';
 
 const injectScript = (): HTMLScriptElement => {
@@ -21,6 +25,14 @@ const injectScript = (): HTMLScriptElement => {
   return script;
 };
 
+const registerWrapper = (stripe: any): void => {
+  if (!stripe || !stripe._registerWrapper) {
+    return;
+  }
+
+  stripe._registerWrapper({name: 'stripe-js', version: _VERSION});
+};
+
 // Execute our own script injection after a tick to give users time to
 // do their own script injection.
 const stripePromise: Promise<StripeConstructor | null> = Promise.resolve().then(
@@ -67,7 +79,13 @@ export const loadStripe = (
 ): Promise<StripeInstance | null> => {
   loadCalled = true;
 
-  return stripePromise.then((maybeStripe) =>
-    maybeStripe ? maybeStripe(...args) : null
-  );
+  return stripePromise.then((maybeStripe) => {
+    if (maybeStripe === null) {
+      return null;
+    }
+
+    const stripe = maybeStripe(...args);
+    registerWrapper(stripe);
+    return stripe;
+  });
 };
diff --git a/yarn.lock b/yarn.lock
@@ -806,6 +806,21 @@
     "@types/istanbul-reports" "^1.1.1"
     "@types/yargs" "^13.0.0"
 
+"@rollup/plugin-replace@^2.3.1":
+  version "2.3.1"
+  resolved "https://registry.yarnpkg.com/@rollup/plugin-replace/-/plugin-replace-2.3.1.tgz#16fb0563628f9e6c6ef9e05d48d3608916d466f5"
+  integrity sha512-qDcXj2VOa5+j0iudjb+LiwZHvBRRgWbHPhRmo1qde2KItTjuxDVQO21rp9/jOlzKR5YO0EsgRQoyox7fnL7y/A==
+  dependencies:
+    "@rollup/pluginutils" "^3.0.4"
+    magic-string "^0.25.5"
+
+"@rollup/pluginutils@^3.0.4":
+  version "3.0.8"
+  resolved "https://registry.yarnpkg.com/@rollup/pluginutils/-/pluginutils-3.0.8.tgz#4e94d128d94b90699e517ef045422960d18c8fde"
+  integrity sha512-rYGeAc4sxcZ+kPG/Tw4/fwJODC3IXHYDH4qusdN/b6aLw5LPUbzpecYbEJh4sVQGPFJxd2dBU4kc1H3oy9/bnw==
+  dependencies:
+    estree-walker "^1.0.1"
+
 "@types/babel__core@^7.1.0":
   version "7.1.3"
   resolved "https://registry.yarnpkg.com/@types/babel__core/-/babel__core-7.1.3.tgz#e441ea7df63cd080dfcd02ab199e6d16a735fc30"
@@ -1869,6 +1884,11 @@ estree-walker@^0.6.1:
   resolved "https://registry.yarnpkg.com/estree-walker/-/estree-walker-0.6.1.tgz#53049143f40c6eb918b23671d1fe3219f3a1b362"
   integrity sha512-SqmZANLWS0mnatqbSfRP5g8OXZC12Fgg1IwNtLsyHDzJizORW4khDfjPqJZsemPWBB2uqykUah5YpQ6epsqC/w==
 
+estree-walker@^1.0.1:
+  version "1.0.1"
+  resolved "https://registry.yarnpkg.com/estree-walker/-/estree-walker-1.0.1.tgz#31bc5d612c96b704106b477e6dd5d8aa138cb700"
+  integrity sha512-1fMXF3YP4pZZVozF8j/ZLfvnR8NSIljt56UhbZ5PeeDmmGHpgpdwQt7ITlGvYaQukCvuBRMLEiKiYC+oeIg4cg==
+
 esutils@^2.0.2:
   version "2.0.3"
   resolved "https://registry.yarnpkg.com/esutils/-/esutils-2.0.3.tgz#74d2eb4de0b8da1293711910d50775b9b710ef64"
@@ -3196,6 +3216,13 @@ loose-envify@^1.0.0:
   dependencies:
     js-tokens "^3.0.0 || ^4.0.0"
 
+magic-string@^0.25.5:
+  version "0.25.7"
+  resolved "https://registry.yarnpkg.com/magic-string/-/magic-string-0.25.7.tgz#3f497d6fd34c669c6798dcb821f2ef31f5445051"
+  integrity sha512-4CrMT5DOHTDk4HYDlzmwu4FVCcIYI8gauveasrdCu2IKIFOJ3f0v/8MDGJCDL9oD2ppz/Av1b0Nj345H9M+XIA==
+  dependencies:
+    sourcemap-codec "^1.4.4"
+
 make-dir@^2.1.0:
   version "2.1.0"
   resolved "https://registry.yarnpkg.com/make-dir/-/make-dir-2.1.0.tgz#5f0310e18b8be898cc07009295a30ae41e91e6f5"
@@ -4290,6 +4317,11 @@ source-map@^0.6.0, source-map@^0.6.1, source-map@~0.6.1:
   resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.6.1.tgz#74722af32e9614e9c287a8d0bbde48b5e2f1a263"
   integrity sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==
 
+sourcemap-codec@^1.4.4:
+  version "1.4.8"
+  resolved "https://registry.yarnpkg.com/sourcemap-codec/-/sourcemap-codec-1.4.8.tgz#ea804bd94857402e6992d05a38ef1ae35a9ab4c4"
+  integrity sha512-9NykojV5Uih4lgo5So5dtw+f0JgJX30KCNI8gwhz2J9A15wD0Ml6tjHKwf6fTSa6fAdVBdZeNOs9eJ71qCk8vA==
+
 spdx-correct@^3.0.0:
   version "3.1.0"
   resolved "https://registry.yarnpkg.com/spdx-correct/-/spdx-correct-3.1.0.tgz#fb83e504445268f154b074e218c87c003cd31df4"
