Inject package version during build instead of importing it from pack… (#434)

Author: Nir Maoz

__TESTS__/unit/analytics/analytics.node.test.ts

@@ -6,6 +6,9 @@
 import pkg from '../../../src/package.json';
 import {createNewImageWithAnalytics} from "./testUtils/createNewImageWithAnalytics";
 
+// Since packageVersion value is only set during build, we need to mock it during tests
+jest.mock("../../../src/internal/utils/packageVersion", () => ({packageVersion: pkg.version}));
+
 describe('Add analytics to a regular URL', () => {
   it('Works with default values', () => {
     const cldImage = createNewImageWithAnalytics('sample');

package.json

@@ -20,6 +20,7 @@
     "build:docs": "node ./scripts/buildDocs.js",
     "build:entryPoints": "ts-node ./scripts/createEntrypoints.ts",
     "build:copyCleanPackageJSON": "ts-node scripts/copyPackageJsonToSrc.ts",
+    "build:injectPackageVersion": "ts-node ./scripts/injectPackageVersionToDistFiles.ts",
     "lint": "eslint src __TESTS__ --color --ext .ts",
     "start": "rollup -c rollup.dev.config.js -w",
     "bundlewatch": "bundlewatch --config ./bundlewatch.config.js",
@@ -36,6 +37,7 @@
     "@release-it/bumper": "^2.0.0",
     "@rollup/plugin-json": "^4.1.0",
     "@rollup/plugin-node-resolve": "^7.1.1",
+    "@rollup/plugin-replace": "^3.0.0",
     "@types/jest": "^25.2.3",
     "@types/mock-fs": "^4.10.0",
     "@types/node": "^15.14.2",
@@ -71,6 +73,7 @@
     "prettier": "^2.3.1",
     "prismjs": "^1.14.0",
     "release-it": "^14.2.0",
+    "replace-in-file": "^6.2.0",
     "rimraf": "^3.0.2",
     "rollup": "^2.3.2",
     "rollup-plugin-babel": "^4.4.0",

rollup.config.js

@@ -2,6 +2,8 @@ import resolve from '@rollup/plugin-node-resolve';
 import typescript from 'rollup-plugin-typescript';
 import json from '@rollup/plugin-json';
 import commonjs from 'rollup-plugin-commonjs';
+import replace from '@rollup/plugin-replace';
+import {version} from './package.json';
 
 export default [{
   input: 'src/index.ts',
@@ -15,6 +17,9 @@ export default [{
   plugins: [
     json(),
     resolve(),
+    replace({
+      'PACKAGE_VERSION_INJECTED_DURING_BUILD': version
+    }),
     typescript({ target: "es5"}),
     commonjs()
   ]

rollup.dev.config.js

@@ -1,8 +1,10 @@
 import resolve from '@rollup/plugin-node-resolve';
 import babel from 'rollup-plugin-babel';
-import serve from 'rollup-plugin-serve'
+import serve from 'rollup-plugin-serve';
 import typescript from "rollup-plugin-typescript";
 import json from '@rollup/plugin-json';
+import replace from '@rollup/plugin-replace';
+import {version} from './package.json';
 
 export default {
   input: 'src/index.ts',
@@ -19,6 +21,9 @@ export default {
       contentBase: 'playground'
     }),
     resolve(),
+    replace({
+      'PACKAGE_VERSION_INJECTED_DURING_BUILD': version
+    }),
     babel({
       exclude: 'node_modules/**' // only transpile our source code
     })

scripts/build.sh

@@ -12,6 +12,7 @@ npm run build:ESM
 npm run build:UMD
 npm run build:entryPoints
 npm run build:docs
+npm run build:injectPackageVersion
 
 #cp CHANGELOG.md to dist
 cp ./CHANGELOG.md ./dist

scripts/injectPackageVersionToDistFiles.ts

@@ -0,0 +1,28 @@
+/* eslint @typescript-eslint/no-var-requires: 0 */
+
+/**
+ * This script goes over dist files and replaces the package version placeholder to be the actual package version.
+ */
+const replace = require('replace-in-file');
+const {version} = require('../package.json');
+const {resolve} = require('path');
+
+const distFolder = resolve('./dist');
+const options = {
+  files: [`${distFolder}/**/*.js`, `${distFolder}/**/*.ts`],
+  from: /PACKAGE_VERSION_INJECTED_DURING_BUILD/g,
+  to: version
+};
+
+// Internationally not catching errors so that build will fail on error
+const fileNamesReplaced = replace
+  .sync(options)
+  .filter((fileData: typeof replace.ReplaceResult) => fileData.hasChanged)
+  .map((fileData: typeof replace.ReplaceResult) => fileData.file);
+
+// files is not empty
+if (fileNamesReplaced.length) {
+  console.log('Successfully injected package version to dist files:', fileNamesReplaced);
+} else {
+  throw 'Failed to inject package version to dist files because no matching files where found';
+}

src/internal/utils/packageVersion.ts

@@ -0,0 +1,11 @@
+const packageVersion = 'PACKAGE_VERSION_INJECTED_DURING_BUILD';
+
+/**
+ * Export package version (injected during our build).
+ * Reason for this is that If we import values from from package.json,
+ * it will cause an error for users who do not have an 'import from json' plugin
+ * as part of their build process / bundler.
+ */
+export {
+  packageVersion
+};

src/sdkAnalytics/getSDKAnalyticsSignature.ts

@@ -1,7 +1,7 @@
 import {encodeVersion} from "./encodeVersion";
 import {getAnalyticsOptions} from "./getAnalyticsOptions";
 import {ITrackedPropertiesThroughAnalytics} from "./interfaces/ITrackedPropertiesThroughAnalytics";
-import pkg from '../package.json';
+import {packageVersion} from "../internal/utils/packageVersion";
 
 /**
  * @private
@@ -29,7 +29,7 @@ function ensureShapeOfTrackedProperties(trackedAnalytics?: Partial<ITrackedPrope
   const defaults = {
     techVersion: getNodeVersion(),
     sdkCode: 'T', // Base code
-    sdkSemver : pkg.version.split('-')[0], // remove -beta, -alpha or other tagged versions from the version string
+    sdkSemver : packageVersion.split('-')[0], // remove -beta, -alpha or other tagged versions from the version string
     responsive: false,
     placeholder: false,
     lazyload: false,