Merge pull request #254 from FirebaseExtended/de-register-version

Add version number as an export

Author: davideast

reactfire/after.build.js

@@ -0,0 +1,29 @@
+const fs = require('fs');
+const path = require('path');
+const { version } = require('./package.json');
+
+// This script should only ever be ran after
+// a successful rollup build.
+
+const ABSOLUTE_PATH = path.join(process.cwd(), `/pub/reactfire`);
+
+const files = [{
+  name: 'firebaseApp/index.js',
+  token: '::__reactfireversion__::',
+  replaceValue: version
+}];
+
+const fileContents = files.map(file => {
+  const fullPath = path.join(ABSOLUTE_PATH, file.name);
+  const content = fs.readFileSync(fullPath, 'utf8');
+  return { 
+    fullPath,
+    content,
+    ...file,
+  };
+})
+
+fileContents.forEach(file => {
+  const replaced = file.content.replace(file.token, file.replaceValue);
+  fs.writeFileSync(file.fullPath, replaced, 'utf8');
+});

reactfire/firebaseApp/firebaseApp.test.tsx

@@ -3,8 +3,9 @@ import { renderHook } from '@testing-library/react-hooks';
 import * as firebase from 'firebase/app';
 import '@testing-library/jest-dom/extend-expect';
 import * as React from 'react';
-import { useFirebaseApp } from '.';
+import { useFirebaseApp, version } from '.';
 import { FirebaseAppProvider } from './index';
+const pkg = require('../package.json');
 
 afterEach(cleanup);
 
@@ -103,3 +104,11 @@ describe('useFirebaseApp', () => {
     expect(result.error).toBeDefined();
   });
 });
+
+describe('reactfire version', () => {
+
+  it(`should match ${pkg.version}`, () => {
+    expect(pkg.version).toEqual(version);
+  });
+
+})

reactfire/firebaseApp/index.tsx

@@ -1,8 +1,6 @@
 import * as firebase from 'firebase/app';
 import * as React from 'react';
 
-export * from './sdk';
-
 type FirebaseAppContextValue = firebase.app.App;
 
 // INVESTIGATE I don't like magic strings, can we have export this in js-sdk?
@@ -18,11 +16,15 @@ type Props = {
   appName?: string;
 };
 
+// The version number is substituted in as part of the build process
+// See after.build.js for the substitution script
+const version = '::__reactfireversion__::';
+
 const shallowEq = (a: Object, b: Object) =>
   a == b ||
   [...Object.keys(a), ...Object.keys(b)].every(key => a[key] == b[key]);
 
-export function FirebaseAppProvider(props: Props & { [key: string]: unknown }) {
+function FirebaseAppProvider(props: Props & { [key: string]: unknown }) {
   const { firebaseConfig, appName } = props;
   const firebaseApp: firebase.app.App =
     props.firebaseApp ||
@@ -38,14 +40,17 @@ export function FirebaseAppProvider(props: Props & { [key: string]: unknown }) {
             'default'} firebase app instance, give this new instance a different appName.`;
         }
       } else {
+        const reactVersion = React.version || 'unknown';
+        firebase.registerVersion('react', reactVersion);
+        firebase.registerVersion('reactfire', version);
         return firebase.initializeApp(firebaseConfig, appName);
       }
     }, [firebaseConfig, appName]);
 
   return <FirebaseAppContext.Provider value={firebaseApp} {...props} />;
 }
 
-export function useFirebaseApp() {
+function useFirebaseApp() {
   const firebaseApp = React.useContext(FirebaseAppContext);
   if (!firebaseApp) {
     throw new Error(
@@ -55,3 +60,11 @@ export function useFirebaseApp() {
 
   return firebaseApp;
 }
+
+
+export * from './sdk';
+export { 
+  FirebaseAppProvider,
+  useFirebaseApp,
+  version,
+};

reactfire/package.json

@@ -12,7 +12,7 @@
     "test": "yarn build && firebase emulators:exec --only firestore,database \"jest --rootDir pub --no-cache --verbose --detectOpenHandles --forceExit\"",
     "copy-package-json": "cp package.pub.json pub/reactfire/package.json",
     "watch": "yarn build && tsc --watch",
-    "build": "rm -rf pub && tsc && yarn copy-package-json && cp ../README.md pub/reactfire/README.md && cp ../LICENSE pub/reactfire/LICENSE && rollup -c && cp ./.npmignore pub/reactfire/ && npm pack ./pub/reactfire"
+    "build": "rm -rf pub && tsc && yarn copy-package-json && cp ../README.md pub/reactfire/README.md && cp ../LICENSE pub/reactfire/LICENSE && rollup -c && node after.build.js && cp ./.npmignore pub/reactfire/ && npm pack ./pub/reactfire"
   },
   "repository": {
     "type": "git",