Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "pastoralist",
"version": "1.8.4",
"version": "1.9.0",
"description": "A tool to watch over node module resolutions and overrides 🐑 👩🏽‍🌾",
"main": "dist/index.cjs",
"module": "dist/index.js",
Expand Down
22 changes: 21 additions & 1 deletion src/cli/index.ts
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
#!/usr/bin/env node

import { parseArgs, showHelp } from "./parser";
import { createSpinner, green } from "../utils";
import { createSpinner, green, yellow } from "../utils";
import {
Options,
PastoralistJSON,
PastoralistResult,
SecurityAlert,
SecurityOverride,
SecurityOverrideDetail,
SecurityProviderPermissionError,
} from "../types";
import { update } from "../core/update";
import { logger as createLogger } from "../utils";
Expand Down Expand Up @@ -101,6 +102,7 @@ export const runSecurityCheck = async (
SecurityChecker,
determineSecurityScanPaths,
green,
yellow,
},
) => {
const spinner = deps
Expand Down Expand Up @@ -137,6 +139,24 @@ export const runSecurityCheck = async (

return { spinner, securityChecker, alerts, securityOverrides, updates };
} catch (error) {
if (error instanceof SecurityProviderPermissionError) {
spinner.warn(`🔒 ${deps.yellow(`pastoralist`)} ${error.message}`);
const securityChecker = new deps.SecurityChecker({
provider: mergedOptions.securityProvider,
forceRefactor: mergedOptions.forceSecurityRefactor,
interactive: mergedOptions.interactive,
token: mergedOptions.securityProviderToken,
debug: isLogging,
});
return {
spinner,
securityChecker,
alerts: [],
securityOverrides: [],
updates: [],
skipped: true,
};
}
spinner.fail(
`🔒 ${deps.green(`pastoralist`)} security check failed: ${error instanceof Error ? error.message : String(error)}`,
);
Expand Down
48 changes: 44 additions & 4 deletions src/core/security/providers/github.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import {
SecurityAlert,
SecurityCheckOptions,
GithubApiError,
SecurityProviderPermissionError,
} from "../../../types";
import { logger, retry } from "../../../utils";
import {
Expand Down Expand Up @@ -225,6 +226,13 @@ export class GitHubSecurityProvider {
factor: 2,
minTimeout: 1000,
onFailedAttempt: (error) => {
const errorMessage = String(error);
if (this.isPermissionError(errorMessage)) {
throw new SecurityProviderPermissionError(
"GitHub CLI",
errorMessage,
);
}
this.log.debug(
`gh CLI attempt ${error.attemptNumber} failed`,
"fetchAlertsWithGhCli",
Expand All @@ -240,6 +248,13 @@ export class GitHubSecurityProvider {

return Array.isArray(alerts) ? alerts : [];
} catch (error) {
if (error instanceof SecurityProviderPermissionError) {
throw error;
}
const errorMessage = String(error);
if (this.isPermissionError(errorMessage)) {
throw new SecurityProviderPermissionError("GitHub CLI", errorMessage);
}
this.log.error(
"Failed to fetch alerts with gh CLI",
"fetchAlertsWithGhCli",
Expand All @@ -249,6 +264,19 @@ export class GitHubSecurityProvider {
}
}

private isPermissionError(message: string): boolean {
const permissionPatterns = [
"Resource not accessible by integration",
"Must have admin rights",
"Not Found",
"Dependabot alerts are not enabled",
"vulnerability alerts are disabled",
];
return permissionPatterns.some((pattern) =>
message.toLowerCase().includes(pattern.toLowerCase()),
);
}

private async fetchFromGitHubAPI(): Promise<DependabotAlert[]> {
const url = `https://api.github.com/repos/${this.owner}/${this.repo}/dependabot/alerts`;
const controller = new AbortController();
Expand All @@ -268,9 +296,13 @@ export class GitHubSecurityProvider {

if (!response.ok) {
const error: GithubApiError = await response.json();
throw new Error(
`GitHub API error: ${error.message || response.statusText}`,
);
const errorMessage = error.message || response.statusText;

if (this.isPermissionError(errorMessage)) {
throw new SecurityProviderPermissionError("GitHub", errorMessage);
}

throw new Error(`GitHub API error: ${errorMessage}`);
}

const alerts = await response.json();
Expand All @@ -286,14 +318,22 @@ export class GitHubSecurityProvider {
retries: 3,
factor: 2,
minTimeout: 1000,
onFailedAttempt: (error) => {
onFailedAttempt: (error: Error & { attemptNumber?: number }) => {
const isPermissionError =
error.name === "SecurityProviderPermissionError";
if (isPermissionError) {
throw error;
}
this.log.debug(
`GitHub API attempt ${error.attemptNumber} failed`,
"fetchAlertsWithApi",
);
},
});
} catch (error) {
if (error instanceof SecurityProviderPermissionError) {
throw error;
}
this.log.error("Failed to fetch alerts with API", "fetchAlertsWithApi", {
error,
});
Expand Down
12 changes: 12 additions & 0 deletions src/core/security/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,18 @@ export interface GithubApiError {
status?: number;
}

export class SecurityProviderPermissionError extends Error {
constructor(
public provider: string,
public originalMessage: string,
) {
super(
`${provider} security check skipped: insufficient permissions. ${originalMessage}`,
);
this.name = "SecurityProviderPermissionError";
}
}

import type {
GitHubSecurityProvider,
SnykCLIProvider,
Expand Down
2 changes: 1 addition & 1 deletion src/utils/index.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
export { default as createSpinner } from "./spinner";
export { green } from "./colors";
export { green, yellow } from "./colors";
export type { SpinnerState, Spinner } from "./types";
export {
hideCursor,
Expand Down
Loading
Loading