enable eslint for functions (#1864)

* enable eslint for functions

* add ignore path

* [AUTOMATED]: Prettier Code Styling

* address Bryan's comments

* update eslint version

* update types

* add messaging as devDep in functions

Author: Feiyang1

config/functions/index.js

@@ -35,7 +35,7 @@ exports.dataTest = functions.https.onRequest((request, response) => {
           value: '3',
           '@type': 'type.googleapis.com/google.protobuf.Int64Value',
         },*/
-        string: 'four',
+        str: 'four',
         array: [5, 6],
         null: null
       }

packages/app/package.json

@@ -15,7 +15,7 @@
   ],
   "scripts": {
     "lint": "eslint -c .eslintrc.json '**/*.ts' --ignore-path '../../.gitignore'",
-    "lint:fix": "eslint --fix -c .eslintrc.json '**/*.ts'",
+    "lint:fix": "eslint --fix -c .eslintrc.json '**/*.ts'  --ignore-path '../../.gitignore'",
     "build": "rollup -c",
     "dev": "rollup -c -w",
     "test": "run-p lint test:browser test:node",

packages/functions-types/index.d.ts

@@ -27,7 +27,7 @@ export interface HttpsCallableResult {
  * Google Cloud Functions.
  */
 export interface HttpsCallable {
-  (data?: any): Promise<HttpsCallableResult>;
+  (data?: {} | null): Promise<HttpsCallableResult>;
 }
 
 /**

packages/functions/.eslintrc.json

@@ -0,0 +1,6 @@
+{
+    "extends": "../../config/.eslintrc.json",
+    "parserOptions": {
+        "project": "tsconfig.json"
+    }
+}

packages/functions/index.node.ts

@@ -25,12 +25,12 @@ import 'isomorphic-fetch';
  */
 const FUNCTIONS_TYPE = 'functions';
 
-function factory(app: FirebaseApp, unused: any, region?: string): Service {
+function factory(app: FirebaseApp, _unused: unknown, region?: string): Service {
   return new Service(app, region);
 }
 
-export function registerFunctions(instance) {
-  let namespaceExports = {
+export function registerFunctions(instance): void {
+  const namespaceExports = {
     // no-inline
     Functions: Service
   };

packages/functions/index.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 import firebase from '@firebase/app';
-import * as app_types from '@firebase/app-types';
+import * as appTypes from '@firebase/app-types';
 import { FirebaseServiceFactory } from '@firebase/app-types/private';
 import * as types from '@firebase/functions-types';
 import { Service } from './src/api/service';
@@ -26,15 +26,15 @@ import { Service } from './src/api/service';
 const FUNCTIONS_TYPE = 'functions';
 
 function factory(
-  app: app_types.FirebaseApp,
-  unused: any,
+  app: appTypes.FirebaseApp,
+  _unused: unknown,
   region?: string
 ): Service {
   return new Service(app, region);
 }
 
-export function registerFunctions(instance) {
-  let namespaceExports = {
+export function registerFunctions(instance): void {
+  const namespaceExports = {
     // no-inline
     Functions: Service
   };

packages/functions/package.json

@@ -11,9 +11,11 @@
     "dist"
   ],
   "scripts": {
+    "lint": "eslint -c .eslintrc.json '**/*.ts' --ignore-path '../../.gitignore'",
+    "lint:fix": "eslint --fix -c .eslintrc.json '**/*.ts' --ignore-path '../../.gitignore'",
     "build": "rollup -c",
     "dev": "rollup -c -w",
-    "test": "run-p test:browser test:node",
+    "test": "run-p lint test:browser test:node",
     "test:browser": "karma start --single-run",
     "test:browser:debug": "karma start --browsers=Chrome --auto-watch",
     "test:node": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'test/{,!(browser)/**/}*.test.ts' --file index.node.ts --opts ../../config/mocha.node.opts",
@@ -52,7 +54,12 @@
     "tslint": "5.16.0",
     "typescript": "3.4.5",
     "webpack": "4.30.0",
-    "yargs": "13.2.2"
+    "yargs": "13.2.2",
+    "eslint": "5.16.0",
+    "@typescript-eslint/parser": "1.10.2",
+    "@typescript-eslint/eslint-plugin": "1.10.2",
+    "@typescript-eslint/eslint-plugin-tslint": "1.10.2",
+    "@firebase/messaging": "0.4.2"
   },
   "repository": {
     "directory": "packages/functions",

packages/functions/src/api/error.ts

@@ -17,6 +17,7 @@
 
 import { HttpsError, FunctionsErrorCode } from '@firebase/functions-types';
 import { Serializer } from '../serializer';
+import { HttpResponseBody } from './service';
 
 /**
  * Standard error codes for different ways a request can fail, as defined by:
@@ -59,9 +60,9 @@ export class HttpsErrorImpl extends Error implements HttpsError {
   /**
    * Extra data to be converted to JSON and included in the error response.
    */
-  readonly details?: any;
+  readonly details?: unknown;
 
-  constructor(code: FunctionsErrorCode, message?: string, details?: any) {
+  constructor(code: FunctionsErrorCode, message?: string, details?: unknown) {
     super(message);
 
     // This is a workaround for a bug in TypeScript when extending Error:
@@ -113,6 +114,7 @@ function codeForHTTPStatus(status: number): FunctionsErrorCode {
       return 'unavailable';
     case 504:
       return 'deadline-exceeded';
+    default: // ignore
   }
   return 'unknown';
 }
@@ -122,19 +124,19 @@ function codeForHTTPStatus(status: number): FunctionsErrorCode {
  */
 export function _errorForResponse(
   status: number,
-  bodyJSON: any,
+  bodyJSON: HttpResponseBody | null,
   serializer: Serializer
 ): Error | null {
   let code = codeForHTTPStatus(status);
 
   // Start with reasonable defaults from the status code.
   let description: string = code;
 
-  let details: any = undefined;
+  let details: unknown = undefined;
 
   // Then look through the body for explicit details.
   try {
-    const errorJSON = bodyJSON.error;
+    const errorJSON = bodyJSON && bodyJSON.error;
     if (errorJSON) {
       const status = errorJSON.status;
       if (typeof status === 'string') {
@@ -143,10 +145,11 @@ export function _errorForResponse(
           return new HttpsErrorImpl('internal', 'internal');
         }
         code = errorCodeMap[status];
+
+        // TODO(klimt): Add better default descriptions for error enums.
+        // The default description needs to be updated for the new code.
+        description = status;
       }
-      // TODO(klimt): Add better default descriptions for error enums.
-      // The default description needs to be updated for the new code.
-      description = status;
 
       const message = errorJSON.message;
       if (typeof message === 'string') {
@@ -155,7 +158,7 @@ export function _errorForResponse(
 
       details = errorJSON.details;
       if (details !== undefined) {
-        details = serializer.decode(details);
+        details = serializer.decode(details as {} | null);
       }
     }
   } catch (e) {

packages/functions/src/api/service.ts

@@ -17,10 +17,8 @@
 
 import { FirebaseApp } from '@firebase/app-types';
 import { FirebaseService } from '@firebase/app-types/private';
-import firebase from '@firebase/app';
 import {
   FirebaseFunctions,
-  FunctionsErrorCode,
   HttpsCallable,
   HttpsCallableResult,
   HttpsCallableOptions
@@ -34,7 +32,21 @@ import { Serializer } from '../serializer';
  */
 interface HttpResponse {
   status: number;
-  json: any;
+  json: HttpResponseBody | null;
+}
+/**
+ * Describes the shape of the HttpResponse body.
+ * It makes functions that would otherwise take {} able to access the
+ * possible elements in the body more easily
+ */
+export interface HttpResponseBody {
+  data?: unknown;
+  result?: unknown;
+  error?: {
+    message?: unknown;
+    status?: unknown;
+    details?: unknown;
+  };
 }
 
 /**
@@ -43,7 +55,7 @@ interface HttpResponse {
  *
  * @param millis Number of milliseconds to wait before rejecting.
  */
-function failAfter(millis: number): Promise<HttpResponse> {
+function failAfter(millis: number): Promise<never> {
   return new Promise((_, reject) => {
     setTimeout(() => {
       reject(new HttpsErrorImpl('deadline-exceeded', 'deadline-exceeded'));
@@ -110,7 +122,7 @@ export class Service implements FirebaseFunctions, FirebaseService {
    * @param origin The origin of the local emulator, such as
    * "http://localhost:5005".
    */
-  useFunctionsEmulator(origin: string) {
+  useFunctionsEmulator(origin: string): void {
     this.emulatorOrigin = origin;
   }
 
@@ -119,10 +131,9 @@ export class Service implements FirebaseFunctions, FirebaseService {
    * @param name The name of the trigger.
    */
   httpsCallable(name: string, options?: HttpsCallableOptions): HttpsCallable {
-    let callable = <HttpsCallable>(data?: any) => {
+    return data => {
       return this.call(name, data, options || {});
     };
-    return callable;
   }
 
   /**
@@ -156,15 +167,15 @@ export class Service implements FirebaseFunctions, FirebaseService {
         json: null
       };
     }
-    let json: any = null;
+    let json: {} | null = null;
     try {
       json = await response.json();
     } catch (e) {
       // If we fail to parse JSON, it will fail the same as an empty body.
     }
     return {
       status: response.status,
-      json: json
+      json
     };
   }
 
@@ -175,7 +186,7 @@ export class Service implements FirebaseFunctions, FirebaseService {
    */
   private async call(
     name: string,
-    data: any,
+    data: unknown,
     options: HttpsCallableOptions
   ): Promise<HttpsCallableResult> {
     const url = this._url(name);
@@ -240,7 +251,7 @@ export class Service implements FirebaseFunctions, FirebaseService {
     }
 
     // Decode any special types, such as dates, in the returned data.
-    const decodedData = this.serializer.decode(responseData);
+    const decodedData = this.serializer.decode(responseData as {} | null);
 
     return { data: decodedData };
   }

packages/functions/src/context.ts

@@ -16,7 +16,6 @@
  */
 import { FirebaseApp } from '@firebase/app-types';
 import { _FirebaseApp } from '@firebase/app-types/private';
-import { firebase } from '@firebase/app';
 import { FirebaseMessaging } from '@firebase/messaging-types';
 
 /**
@@ -50,9 +49,11 @@ export class ContextProvider {
     try {
       // HACK: Until we have a separate instanceId package, this is a quick way
       // to load in the messaging instance for this app.
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       if (!(this.app as any).messaging) {
         return undefined;
       }
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       const messaging = (this.app as any).messaging() as FirebaseMessaging;
       const token = await messaging.getToken();
       if (!token) {
@@ -68,7 +69,7 @@ export class ContextProvider {
     }
   }
 
-  public async getContext(): Promise<Context> {
+  async getContext(): Promise<Context> {
     const authToken = await this.getAuthToken();
     const instanceIdToken = await this.getInstanceIdToken();
     return { authToken, instanceIdToken };

packages/functions/src/serializer.ts

@@ -18,9 +18,9 @@
 const LONG_TYPE = 'type.googleapis.com/google.protobuf.Int64Value';
 const UNSIGNED_LONG_TYPE = 'type.googleapis.com/google.protobuf.UInt64Value';
 
-function mapValues(o: object, f: (any) => any): object {
-  let result = {};
-  for (var key in o) {
+function mapValues(o: object, f: (val: unknown) => unknown): object {
+  const result = {};
+  for (const key in o) {
     if (o.hasOwnProperty(key)) {
       result[key] = f(o[key]);
     }
@@ -31,8 +31,8 @@ function mapValues(o: object, f: (any) => any): object {
 export class Serializer {
   // Takes data and encodes it in a JSON-friendly way, such that types such as
   // Date are preserved.
-  encode(data: any): any {
-    if (data === null || data === undefined) {
+  encode(data: unknown): unknown {
+    if (data == null) {
       return null;
     }
     if (data instanceof Number) {
@@ -53,16 +53,16 @@ export class Serializer {
       return data.map(x => this.encode(x));
     }
     if (typeof data === 'function' || typeof data === 'object') {
-      return mapValues(data, x => this.encode(x));
+      return mapValues(data as object, x => this.encode(x));
     }
     // If we got this far, the data is not encodable.
     throw new Error('Data cannot be encoded in JSON: ' + data);
   }
 
   // Takes data that's been encoded in a JSON-friendly form and returns a form
   // with richer datatypes, such as Dates, etc.
-  decode(json: any): any {
-    if (json === null) {
+  decode(json: {} | null): {} | null {
+    if (json == null) {
       return json;
     }
     if (json['@type']) {
@@ -73,7 +73,7 @@ export class Serializer {
           // Technically, this could work return a valid number for malformed
           // data if there was a number followed by garbage. But it's just not
           // worth all the extra code to detect that case.
-          const value = parseFloat(json.value);
+          const value = Number(json['value']);
           if (isNaN(value)) {
             throw new Error('Data cannot be decoded from JSON: ' + json);
           }
@@ -88,7 +88,7 @@ export class Serializer {
       return json.map(x => this.decode(x));
     }
     if (typeof json === 'function' || typeof json === 'object') {
-      return mapValues(json, x => this.decode(x));
+      return mapValues(json, x => this.decode(x as {} | null));
     }
     // Anything else is safe to return.
     return json;