fix broken typings for the non modular RTDB package (#4858)

Feiyang1 · yuchenshi · commit e808f33d94cd · 2021-05-03T14:11:05.000-07:00
* fix broken typings for the non modular sdk

* fix lint errors

* preserve comment
diff --git a/packages/database/index.ts b/packages/database/index.ts
@@ -28,8 +28,9 @@ import { Database } from './src/api/Database';
 import * as INTERNAL from './src/api/internal';
 import { DataSnapshot, Query, Reference } from './src/api/Reference';
 import * as TEST_ACCESS from './src/api/test_access';
+import { enableLogging } from './src/core/util/util';
 import { setSDKVersion } from './src/core/version';
-import { enableLogging, repoManagerDatabaseFromApp } from './src/exp/Database';
+import { repoManagerDatabaseFromApp } from './src/exp/Database';
 
 const ServerValue = Database.ServerValue;
 
diff --git a/packages/database/src/api/Database.ts b/packages/database/src/api/Database.ts
@@ -25,7 +25,6 @@ import {
 } from '@firebase/util';
 
 import {
-  FirebaseDatabase as ExpDatabase,
   goOnline,
   useDatabaseEmulator,
   goOffline,
@@ -37,6 +36,14 @@ import {
 
 import { Reference } from './Reference';
 
+// TODO: revert to import {FirebaseDatabase as ExpDatabase} from '@firebase/database' once modular SDK goes GA
+/**
+ * This is a workaround for an issue in the no-modular '@firebase/database' where its typings
+ * reference types from `@firebase/app-exp`.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type ExpDatabase = any;
+
 /**
  * Class representing a firebase database.
  */
diff --git a/packages/database/src/api/Reference.ts b/packages/database/src/api/Reference.ts
@@ -26,7 +26,6 @@ import {
 
 import {
   OnDisconnect as ExpOnDisconnect,
-  DataSnapshot as ExpDataSnapshot,
   off,
   onChildAdded,
   onChildChanged,
@@ -54,8 +53,6 @@ import {
   setPriority,
   push,
   runTransaction,
-  Query as ExpQuery,
-  Reference as ExpReference,
   _QueryImpl,
   _ReferenceImpl,
   child
@@ -75,6 +72,19 @@ import { Database } from './Database';
 import { OnDisconnect } from './onDisconnect';
 import { TransactionResult } from './TransactionResult';
 
+// TODO: revert to import {  DataSnapshot as ExpDataSnapshot, Query as ExpQuery,
+// Reference as ExpReference,} from '../../exp/index'; once the modular SDK goes GA
+/**
+ * This is part of a workaround for an issue in the no-modular '@firebase/database' where its typings
+ * reference types from `@firebase/app-exp`.
+ */
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+type ExpDataSnapshot = any;
+type ExpQuery = any;
+type ExpReference = any;
+/* eslint-enable @typescript-eslint/no-explicit-any */
+
 /**
  * Class representing a firebase data snapshot.  It wraps a SnapshotNode and
  * surfaces the public methods (val, forEach, etc.) we want to expose.
diff --git a/packages/database/src/api/onDisconnect.ts b/packages/database/src/api/onDisconnect.ts
@@ -17,10 +17,17 @@
 
 import { validateArgCount, validateCallback, Compat } from '@firebase/util';
 
-import { OnDisconnect as ExpOnDisconnect } from '../../exp/index';
 import { Indexable } from '../core/util/misc';
 import { warn } from '../core/util/util';
 
+// TODO: revert to import { OnDisconnect as ExpOnDisconnect } from '../../exp/index'; once the modular SDK goes GA
+/**
+ * This is a workaround for an issue in the no-modular '@firebase/database' where its typings
+ * reference types from `@firebase/app-exp`.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type ExpOnDisconnect = any;
+
 export class OnDisconnect implements Compat<ExpOnDisconnect> {
   constructor(readonly _delegate: ExpOnDisconnect) {}
 
diff --git a/packages/database/src/core/util/util.ts b/packages/database/src/core/util/util.ts
@@ -26,8 +26,14 @@ import {
 } from '@firebase/util';
 
 import { SessionStorage } from '../storage/storage';
-import { QueryContext } from '../view/EventRegistration';
 
+// TODO: revert to import { QueryContext } from '../view/EventRegistration'; once the modular SDK goes GA
+/**
+ * This is part of a workaround for an issue in the no-modular '@firebase/database' where its typings
+ * reference types from `@firebase/app-exp`.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type QueryContext = any;
 declare const window: Window;
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 declare const Windows: any;
diff --git a/repo-scripts/prune-dts/extract-public-api.ts b/repo-scripts/prune-dts/extract-public-api.ts
@@ -21,7 +21,7 @@ import * as path from 'path';
 import { Extractor, ExtractorConfig } from 'api-extractor-me';
 import * as tmp from 'tmp';
 
-import { pruneDts, removeUnusedImports } from './prune-dts';
+import { addBlankLines, pruneDts, removeUnusedImports } from './prune-dts';
 import * as yargs from 'yargs';
 
 /* eslint-disable no-console */
@@ -154,6 +154,8 @@ export async function generateApi(
   console.log('Generated rollup DTS');
   pruneDts(rollupDtsPath, publicDtsPath);
   console.log('Pruned DTS file');
+  await addBlankLines(publicDtsPath);
+  console.log('Added blank lines after imports');
   await removeUnusedImports(publicDtsPath);
   console.log('Removed unused imports');
 
diff --git a/repo-scripts/prune-dts/prune-dts.ts b/repo-scripts/prune-dts/prune-dts.ts
@@ -39,16 +39,47 @@ export function pruneDts(inputLocation: string, outputLocation: string): void {
   const program = ts.createProgram([inputLocation], compilerOptions, host);
   const printer: ts.Printer = ts.createPrinter();
   const sourceFile = program.getSourceFile(inputLocation)!;
+
   const result: ts.TransformationResult<ts.SourceFile> = ts.transform<ts.SourceFile>(
     sourceFile,
     [dropPrivateApiTransformer.bind(null, program, host)]
   );
   const transformedSourceFile: ts.SourceFile = result.transformed[0];
+  let content = printer.printFile(transformedSourceFile);
 
-  const content = printer.printFile(transformedSourceFile);
   fs.writeFileSync(outputLocation, content);
 }
 
+export async function addBlankLines(outputLocation: string): Promise<void> {
+  const eslint = new ESLint({
+    fix: true,
+    overrideConfig: {
+      parserOptions: {
+        ecmaVersion: 2017,
+        sourceType: 'module',
+        tsconfigRootDir: __dirname,
+        project: ['./tsconfig.eslint.json']
+      },
+      env: {
+        es6: true
+      },
+      plugins: ['@typescript-eslint'],
+      parser: '@typescript-eslint/parser',
+      rules: {
+        'unused-imports/no-unused-imports-ts': ['off'],
+        // add blank lines after imports. Otherwise removeUnusedImports() will remove the comment
+        // of the first item after the import block
+        'padding-line-between-statements': [
+          'error',
+          { 'blankLine': 'always', 'prev': 'import', 'next': '*' }
+        ]
+      }
+    }
+  });
+  const results = await eslint.lintFiles(outputLocation);
+  await ESLint.outputFixes(results);
+}
+
 export async function removeUnusedImports(
   outputLocation: string
 ): Promise<void> {
