fix: handle invalid file and log path

specfy · Nov 6, 2023 · f5a0e62 · f5a0e62
1 parent f35e92b
commit f5a0e62
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 10 deletions.
diff --git a/src/analyser/__snapshots__/index.test.ts.snap b/src/analyser/__snapshots__/index.test.ts.snap
@@ -745,7 +745,7 @@ exports[`analyser > should run correctly 1`] = `
       "languages": {
         "AMPL": 1,
         "HCL": 1,
-        "JSON": 1,
+        "JSON": 2,
         "YAML": 2,
       },
       "name": "fake",
@@ -1155,7 +1155,7 @@ exports[`analyser > should run correctly 2`] = `
         "Go": 1,
         "HCL": 1,
         "HTML": 1,
-        "JSON": 4,
+        "JSON": 5,
         "SCSS": 1,
         "TOML": 1,
         "YAML": 2,
@@ -1805,7 +1805,7 @@ exports[`analyser > should run correctly 2`] = `
     "Go": 3,
     "HCL": 2,
     "HTML": 3,
-    "JSON": 11,
+    "JSON": 13,
     "SCSS": 3,
     "TOML": 3,
     "YAML": 4,

diff --git a/src/provider/base.ts b/src/provider/base.ts
@@ -7,7 +7,7 @@ export interface ProviderFile {
 export interface BaseProvider {
   basePath: string;
   listDir: (pathRelative: string) => Promise<ProviderFile[]>;
-  open: (path: string) => Promise<string>;
+  open: (path: string) => Promise<string | null>;
 }
 
 export const IGNORED_DIVE_PATHS = [

diff --git a/src/provider/fs.ts b/src/provider/fs.ts
@@ -1,6 +1,8 @@
 import fs from 'fs/promises';
 import path from 'node:path';
 
+import { l } from '../common/log.js';
+
 import type { BaseProvider, ProviderFile } from './base.js';
 
 export interface FSProviderOptions {
@@ -33,9 +35,13 @@ export class FSProvider implements BaseProvider {
     return list;
   }
 
-  async open(pathRelative: string): Promise<string> {
-    const content = await fs.readFile(pathRelative);
-
-    return content.toString();
+  async open(pathRelative: string): Promise<string | null> {
+    try {
+      const content = await fs.readFile(pathRelative);
+      return content ? content.toString() : null;
+    } catch (err) {
+      l.error('Failed to open file', { pathRelative, err });
+      return null;
+    }
   }
 }
diff --git a/src/rules/spec/docker/component.ts b/src/rules/spec/docker/component.ts
@@ -23,7 +23,6 @@ export const detectDockerComponent: ComponentMatcher = async (
 
     const content = await provider.open(file.fp);
     if (!content) {
-      l.warn('Failed to open Docker file', file.fp);
       continue;
     }
 

diff --git a/src/rules/spec/githubActions/component.ts b/src/rules/spec/githubActions/component.ts
@@ -47,7 +47,6 @@ export const detectGithubActionsComponent: ComponentMatcher = async (
 
     const content = await provider.open(file.fp);
     if (!content) {
-      l.warn('Failed to open GitHub Actions file', file.fp);
       continue;
     }
 

diff --git a/tests/__fixtures__/nodejs/invalid/package.json b/tests/__fixtures__/nodejs/invalid/package.json
@@ -0,0 +1,3 @@
+{
+  "
+}