feat: add no-floating-promises lint rule

Only warn in tests, disable rule for existing occurences in non-test modules. Signed-off-by: naseemkullah <naseem@transit.app>
open-telemetry · Apr 12, 2021 · b373c9a · b373c9a
1 parent 4ef22ca
commit b373c9a
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 11 deletions.
diff --git a/eslint.config.js b/eslint.config.js
@@ -4,27 +4,28 @@ module.exports = {
     "header"
   ],
   extends: [
-      "./node_modules/gts",
+    "./node_modules/gts",
   ],
   parser: "@typescript-eslint/parser",
   parserOptions: {
-      "project": "./tsconfig.json"
+    "project": "./tsconfig.json"
   },
   rules: {
+    "@typescript-eslint/no-floating-promises": 2,
     "@typescript-eslint/no-this-alias": "off",
     "eqeqeq": [
       "error",
       "smart"
     ],
     "prefer-rest-params": "off",
     "@typescript-eslint/naming-convention": [
-        "error",
-        {
-          "selector": "memberLike",
-          "modifiers": ["private", "protected"],
-          "format": ["camelCase"],
-          "leadingUnderscore": "require"
-        }
+      "error",
+      {
+        "selector": "memberLike",
+        "modifiers": ["private", "protected"],
+        "format": ["camelCase"],
+        "leadingUnderscore": "require"
+      }
     ],
     "no-console": "error",
     "no-shadow": "off",
@@ -35,8 +36,8 @@ module.exports = {
     "prettier/prettier": ["error", { "singleQuote": true, "arrowParens": "avoid" }],
     "node/no-deprecated-api": ["warn"],
     "header/header": [2, "block", [{
-        pattern: / \* Copyright The OpenTelemetry Authors[\r\n]+ \*[\r\n]+ \* Licensed under the Apache License, Version 2\.0 \(the \"License\"\);[\r\n]+ \* you may not use this file except in compliance with the License\.[\r\n]+ \* You may obtain a copy of the License at[\r\n]+ \*[\r\n]+ \*      https:\/\/www\.apache\.org\/licenses\/LICENSE-2\.0[\r\n]+ \*[\r\n]+ \* Unless required by applicable law or agreed to in writing, software[\r\n]+ \* distributed under the License is distributed on an \"AS IS\" BASIS,[\r\n]+ \* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied\.[\r\n]+ \* See the License for the specific language governing permissions and[\r\n]+ \* limitations under the License\./gm,
-        template:
+      pattern: / \* Copyright The OpenTelemetry Authors[\r\n]+ \*[\r\n]+ \* Licensed under the Apache License, Version 2\.0 \(the \"License\"\);[\r\n]+ \* you may not use this file except in compliance with the License\.[\r\n]+ \* You may obtain a copy of the License at[\r\n]+ \*[\r\n]+ \*      https:\/\/www\.apache\.org\/licenses\/LICENSE-2\.0[\r\n]+ \*[\r\n]+ \* Unless required by applicable law or agreed to in writing, software[\r\n]+ \* distributed under the License is distributed on an \"AS IS\" BASIS,[\r\n]+ \* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied\.[\r\n]+ \* See the License for the specific language governing permissions and[\r\n]+ \* limitations under the License\./gm,
+      template:
         `\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the "License");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *      https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an "AS IS" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n `
     }]]
   },
@@ -48,6 +49,7 @@ module.exports = {
         "@typescript-eslint/ban-ts-ignore": "off",
         "@typescript-eslint/no-empty-function": "off",
         "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-floating-promises": 1,
         "@typescript-eslint/no-unused-vars": "off",
         "@typescript-eslint/no-var-requires": "off",
         "@typescript-eslint/no-shadow": ["off"],

diff --git a/packages/opentelemetry-exporter-collector-grpc/src/util.ts b/packages/opentelemetry-exporter-collector-grpc/src/util.ts
@@ -38,6 +38,7 @@ export function onInit<ExportItem, ServiceRequest>(
 
   const includeDirs = [path.resolve(__dirname, '..', 'protos')];
 
+  // eslint-disable-next-line @typescript-eslint/no-floating-promises
   protoLoader
     .load(collector.getServiceProtoPath(), {
       keepCase: false,

diff --git a/packages/opentelemetry-metrics/src/export/Controller.ts b/packages/opentelemetry-metrics/src/export/Controller.ts
@@ -37,6 +37,7 @@ export class PushController extends Controller {
   ) {
     super();
     this._timer = setInterval(() => {
+      // eslint-disable-next-line @typescript-eslint/no-floating-promises
       this._collect();
     }, interval);
     unrefTimer(this._timer);