Skip to content

Fix socket analytics blessed import #331

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jdalton merged 2 commits into from
Feb 19, 2025
Merged

Fix socket analytics blessed import #331

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6be6bd1
Fix socket analytics blessed import
pvdz Feb 18, 2025
da03502
Merge branch 'main' into fix_widgets
jdalton Feb 19, 2025
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
7 changes: 5 additions & 2 deletions src/commands/analytics/display-analytics.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
import fs from 'node:fs/promises'

import { Widgets } from 'blessed'
// @ts-ignore
import ScreenWidget from 'blessed/lib/widgets/screen'
import contrib from 'blessed-contrib'

import { Spinner } from '@socketsecurity/registry/lib/spinner'

import { handleApiCall, handleUnsuccessfulApiResponse } from '../../utils/api'
import { setupSdk } from '../../utils/sdk'

import type { Widgets } from 'blessed' // Note: Widgets does not seem to actually work as code :'(

type FormattedData = {
top_five_alert_types: { [key: string]: number }
total_critical_alerts: { [key: string]: number }
Expand Down Expand Up @@ -98,7 +101,7 @@ export async function displayAnalytics({
}

function displayAnalyticsScreen(data: FormattedData): void {
const screen = new Widgets.Screen({})
const screen: Widgets.Screen = new ScreenWidget({})
Copy link
Contributor

@jdalton jdalton Feb 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would this be implicit by the return type of ScreenWidget? does it need to be explicitly added to const screen: Widgets.Screen?

Copy link
Contributor Author

@pvdz pvdz Feb 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TS is ignoring the import so ScreenWidget is any. But it should be the same value as what I was expecting Widgets.Screen to be, except importing it fails because apparently Widgets ends up as undefined.

This way we get a typed screen variable, mitigating the impact of the ts-ignore.

const grid = new contrib.grid({ rows: 5, cols: 4, screen })

renderLineCharts(
Expand Down
Loading