@parca/profile 0.14.29 → 0.14.36

package/CHANGELOG.md

@@ -3,6 +3,43 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.14.36](https://github.com/parca-dev/parca/compare/ui-v0.14.35...ui-v0.14.36) (2022-08-24)
+
+
+### Bug Fixes
+
+* **ui:** enforce @typescript-eslint/explicit-function-return-type ([22a18fd](https://github.com/parca-dev/parca/commit/22a18fd3f7befef5cc175131d8c997c3967a5713))
+
+
+
+## 0.14.32 (2022-08-18)
+
+
+
+
+
+## [0.14.31](https://github.com/parca-dev/parca/compare/ui-v0.14.30...ui-v0.14.31) (2022-08-18)
+
+
+### Bug Fixes
+
+* **ui:** address all problems reported by ESLint ([7f9c921](https://github.com/parca-dev/parca/commit/7f9c9217af49f2661a4363b9b17a9a06f1c7539b))
+
+
+
+
+
+## [0.14.30](https://github.com/parca-dev/parca/compare/ui-v0.14.29...ui-v0.14.30) (2022-08-17)
+
+
+### Bug Fixes
+
+* **ui:** run eslint --fix ([#1542](https://github.com/parca-dev/parca/issues/1542)) ([e522131](https://github.com/parca-dev/parca/commit/e5221318fc1140d661c45d2d04b096bfebba4af4))
+
+
+
+
+
 ## [0.14.29](https://github.com/parca-dev/parca/compare/ui-v0.14.28...ui-v0.14.29) (2022-08-15)
 
 

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@parca/profile",
-  "version": "0.14.29",
+  "version": "0.14.36",
   "description": "Profile viewing libraries",
   "dependencies": {
     "@iconify/react": "^3.2.2",
     "@parca/client": "^0.14.16",
-    "@parca/dynamicsize": "^0.14.29",
-    "@parca/parser": "^0.14.29",
+    "@parca/dynamicsize": "^0.14.36",
+    "@parca/parser": "^0.14.36",
     "d3-scale": "^4.0.2",
     "d3-selection": "3.0.0",
     "react-copy-to-clipboard": "^5.1.0"
@@ -22,5 +22,5 @@
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
-  "gitHead": "e6dabbc59485409b1fc818d5c56c7999d9a22f17"
+  "gitHead": "7d75476b99eafbb9e9d3976c1de6cfb88cbfc8c2"
 }

package/src/IcicleGraph.tsx

@@ -91,7 +91,7 @@ function IcicleRect({
   onMouseLeave,
   onClick,
   curPath,
-}: IcicleRectProps) {
+}: IcicleRectProps): JSX.Element {
   const currentSearchString = useAppSelector(selectSearchNodeString);
   const isFaded = curPath.length > 0 && name !== curPath[curPath.length - 1];
   const styles = isFaded ? fadedIcicleRectStyles : icicleRectStyles;
@@ -111,7 +111,11 @@ function IcicleRect({
         height={height - 1}
         style={{
           opacity:
-            Boolean(currentSearchString) && !isSearchMatch(currentSearchString, name) ? 0.5 : 1,
+            currentSearchString !== undefined &&
+            currentSearchString !== '' &&
+            !isSearchMatch(currentSearchString, name)
+              ? 0.5
+              : 1,
           fill: color,
         }}
       />
@@ -130,7 +134,7 @@ export function nodeLabel(node: FlamegraphNode): string {
   if (node.meta === undefined) return '<unknown>';
   const mapping = `${
     node.meta?.mapping?.file !== undefined && node.meta?.mapping?.file !== ''
-      ? '[' + getLastItem(node.meta.mapping.file) + '] '
+      ? '[' + (getLastItem(node.meta.mapping.file) ?? '') + '] '
       : ''
   }`;
   if (node.meta.function?.name !== undefined && node.meta.function?.name !== '')
@@ -154,7 +158,7 @@ export function IcicleGraphNodes({
   path,
   setCurPath,
   curPath,
-}: IcicleGraphNodesProps) {
+}: IcicleGraphNodesProps): JSX.Element {
   const isDarkMode = useAppSelector(selectDarkMode);
 
   const nodes =
@@ -185,7 +189,7 @@ export function IcicleGraphNodes({
 
         const color = diffColor(diff, cumulative, isDarkMode);
 
-        const onClick = () => {
+        const onClick = (): void => {
           setCurPath(nextPath);
         };
 
@@ -195,8 +199,8 @@ export function IcicleGraphNodes({
             ? scaleLinear().domain([0, cumulative]).range([0, totalWidth])
             : xScale;
 
-        const onMouseEnter = () => setHoveringNode(d);
-        const onMouseLeave = () => setHoveringNode(undefined);
+        const onMouseEnter = (): void => setHoveringNode(d);
+        const onMouseLeave = (): void => setHoveringNode(undefined);
 
         return (
           <React.Fragment key={`node-${key}`}>
@@ -246,16 +250,16 @@ export function IcicleGraphRootNode({
   setHoveringNode,
   setCurPath,
   curPath,
-}: IcicleGraphRootNodeProps) {
+}: IcicleGraphRootNodeProps): JSX.Element {
   const isDarkMode = useAppSelector(selectDarkMode);
 
   const cumulative = parseFloat(node.cumulative);
   const diff = parseFloat(node.diff);
   const color = diffColor(diff, cumulative, isDarkMode);
 
-  const onClick = () => setCurPath([]);
-  const onMouseEnter = () => setHoveringNode(node);
-  const onMouseLeave = () => setHoveringNode(undefined);
+  const onClick = (): void => setCurPath([]);
+  const onMouseEnter = (): void => setHoveringNode(node);
+  const onMouseLeave = (): void => setHoveringNode(undefined);
   const path = [];
 
   return (
@@ -297,7 +301,7 @@ export default function IcicleGraph({
   setCurPath,
   curPath,
   sampleUnit,
-}: IcicleGraphProps) {
+}: IcicleGraphProps): JSX.Element {
   const [hoveringNode, setHoveringNode] = useState<
     FlamegraphNode | FlamegraphRootNode | undefined
   >();

package/src/ProfileIcicleGraph.tsx

@@ -31,7 +31,7 @@ const ProfileIcicleGraph = ({
   curPath,
   setNewCurPath,
   sampleUnit,
-}: ProfileIcicleGraphProps) => {
+}: ProfileIcicleGraphProps): JSX.Element => {
   const compareMode = useAppSelector(selectCompareMode);
   const {ref, dimensions} = useContainerDimensions();
 

package/src/ProfileView.tsx

@@ -58,7 +58,7 @@ interface ProfileViewProps {
   compare?: boolean;
 }
 
-function arrayEquals(a, b): boolean {
+function arrayEquals<T>(a: T[], b: T[]): boolean {
   return (
     Array.isArray(a) &&
     Array.isArray(b) &&
@@ -70,7 +70,7 @@ export const useProfileVisState = (): ProfileVisState => {
   const router = parseParams(window.location.search);
   const currentViewFromURL = router.currentProfileView as string;
   const [currentView, setCurrentView] = useState<VisualizationType>(
-    (currentViewFromURL as VisualizationType) || 'icicle'
+    (currentViewFromURL as VisualizationType) ?? 'icicle'
   );
 
   return {currentView, setCurrentView};
@@ -98,13 +98,13 @@ export const ProfileView = ({
 
   const isLoading = useMemo(() => {
     if (currentView === 'icicle') {
-      return !!flamegraphData?.loading;
+      return Boolean(flamegraphData?.loading);
     }
     if (currentView === 'table') {
-      return !!topTableData?.loading;
+      return Boolean(topTableData?.loading);
     }
     if (currentView === 'both') {
-      return !!flamegraphData?.loading || !!topTableData?.loading;
+      return Boolean(flamegraphData?.loading) || Boolean(topTableData?.loading);
     }
     return false;
   }, [currentView, flamegraphData?.loading, topTableData?.loading]);
@@ -124,9 +124,9 @@ export const ProfileView = ({
     );
   }
 
-  const downloadPProf = async (e: React.MouseEvent<HTMLElement>) => {
+  const downloadPProf = async (e: React.MouseEvent<HTMLElement>): Promise<void> => {
     e.preventDefault();
-    if (!profileSource || !queryClient) {
+    if (profileSource == null || queryClient == null) {
       return;
     }
 
@@ -141,15 +141,15 @@ export const ProfileView = ({
     }
   };
 
-  const resetIcicleGraph = () => setCurPath([]);
+  const resetIcicleGraph = (): void => setCurPath([]);
 
-  const setNewCurPath = (path: string[]) => {
+  const setNewCurPath = (path: string[]): void => {
     if (!arrayEquals(curPath, path)) {
       setCurPath(path);
     }
   };
 
-  const switchProfileView = (view: VisualizationType) => {
+  const switchProfileView = (view: VisualizationType): void => {
     if (view == null) {
       return;
     }
@@ -169,14 +169,14 @@ export const ProfileView = ({
             <div className="flex py-3 w-full">
               <div className="w-2/5 flex space-x-4">
                 <div className="flex space-x-1">
-                  {profileSource && queryClient ? (
+                  {profileSource != null && queryClient != null ? (
                     <ProfileShareButton
                       queryRequest={profileSource.QueryRequest()}
                       queryClient={queryClient}
                     />
                   ) : null}
 
-                  <Button color="neutral" onClick={downloadPProf}>
+                  <Button color="neutral" onClick={void downloadPProf}>
                     Download pprof
                   </Button>
                 </div>

package/src/ProfileViewWithData.tsx

@@ -30,7 +30,7 @@ export const ProfileViewWithData = ({
   queryClient,
   profileSource,
   navigateTo,
-}: ProfileViewWithDataProps) => {
+}: ProfileViewWithDataProps): JSX.Element => {
   const profileVisState = useProfileVisState();
   const {currentView} = profileVisState;
   const {
@@ -38,7 +38,7 @@ export const ProfileViewWithData = ({
     response: flamegraphResponse,
     error: flamegraphError,
   } = useQuery(queryClient, profileSource, QueryRequest_ReportType.FLAMEGRAPH_UNSPECIFIED, {
-    skip: currentView != 'icicle' && currentView != 'both',
+    skip: currentView !== 'icicle' && currentView !== 'both',
   });
 
   const {
@@ -46,7 +46,7 @@ export const ProfileViewWithData = ({
     response: topTableResponse,
     error: topTableError,
   } = useQuery(queryClient, profileSource, QueryRequest_ReportType.TOP, {
-    skip: currentView != 'table' && currentView != 'both',
+    skip: currentView !== 'table' && currentView !== 'both',
   });
 
   const sampleUnit = profileSource.ProfileType().sampleUnit;

package/src/TopTable.tsx

@@ -26,7 +26,7 @@ interface TopTableProps {
   sampleUnit: string;
 }
 
-const Arrow = ({direction}: {direction: string | undefined}) => {
+const Arrow = ({direction}: {direction: string | undefined}): JSX.Element => {
   return (
     <svg
       className={`${direction !== undefined ? 'fill-[#161616] dark:fill-[#ffffff]' : ''}`}
@@ -41,12 +41,27 @@ const Arrow = ({direction}: {direction: string | undefined}) => {
   );
 };
 
-const useSortableData = (top?: Top, config = {key: 'cumulative', direction: 'desc'}) => {
+const useSortableData = (
+  top?: Top,
+  config = {key: 'cumulative', direction: 'desc'}
+): {
+  items:
+    | Array<{
+        diff: number;
+        cumulative: number;
+        flat: number;
+        name: string | undefined;
+        meta?: TopNodeMeta | undefined;
+      }>
+    | undefined;
+  requestSort: (key: string) => void;
+  sortConfig: {key: string; direction: string} | null;
+} => {
   const [sortConfig, setSortConfig] = React.useState<{key: string; direction: string} | null>(
     config
   );
 
-  const rawTableReport = top ? top.list : [];
+  const rawTableReport = top != null ? top.list : [];
 
   const items = rawTableReport.map(node => ({
     ...node,
@@ -57,9 +72,9 @@ const useSortableData = (top?: Top, config = {key: 'cumulative', direction: 'des
   }));
 
   const sortedItems = React.useMemo(() => {
-    if (!items) return;
+    if (items.length === 0) return;
 
-    let sortableItems = [...items];
+    const sortableItems = [...items];
     if (sortConfig !== null) {
       sortableItems.sort((a, b) => {
         if (a[sortConfig.key] < b[sortConfig.key]) {
@@ -74,9 +89,9 @@ const useSortableData = (top?: Top, config = {key: 'cumulative', direction: 'des
     return sortableItems;
   }, [items, sortConfig]);
 
-  const requestSort = key => {
+  const requestSort = (key: string): void => {
     let direction = 'desc';
-    if (sortConfig && sortConfig.key === key && sortConfig.direction === 'desc') {
+    if (sortConfig != null && sortConfig.key === key && sortConfig.direction === 'desc') {
       direction = 'asc';
     }
     setSortConfig({key, direction});
@@ -89,14 +104,14 @@ export const RowLabel = (meta: TopNodeMeta | undefined): string => {
   if (meta === undefined) return '<unknown>';
   const mapping = `${
     meta?.mapping?.file !== undefined && meta?.mapping?.file !== ''
-      ? `[${getLastItem(meta.mapping.file)}]`
+      ? `[${getLastItem(meta.mapping.file) ?? ''}]`
       : ''
   }`;
   if (meta.function?.name !== undefined && meta.function?.name !== '')
     return `${mapping} ${meta.function.name}`;
 
   const address = hexifyAddress(meta.location?.address);
-  const fallback = `${mapping} ${address as string}`;
+  const fallback = `${mapping} ${address}`;
 
   return fallback === '' ? '<unknown>' : fallback;
 };
@@ -109,17 +124,17 @@ export const TopTable = ({data: top, sampleUnit}: TopTableProps): JSX.Element =>
 
   const unit = sampleUnit;
 
-  const total = top ? top.list.length : 0;
+  const total = top != null ? top.list.length : 0;
   if (total === 0) return <>Profile has no samples</>;
 
-  const getClassNamesFor = name => {
-    if (!sortConfig) {
+  const getClassNamesFor = (name: string): string | undefined => {
+    if (sortConfig == null) {
       return;
     }
     return sortConfig.key === name ? sortConfig.direction : undefined;
   };
 
-  const addPlusSign = (num: string) => {
+  const addPlusSign = (num: string): string => {
     if (num.charAt(0) === '0' || num.charAt(0) === '-') {
       return num;
     }
@@ -138,7 +153,9 @@ export const TopTable = ({data: top, sampleUnit}: TopTableProps): JSX.Element =>
                 onClick={() => requestSort('name')}
               >
                 Name
-                <span className={`inline-block align-middle ml-2 ${getClassNamesFor('name')}`}>
+                <span
+                  className={`inline-block align-middle ml-2 ${getClassNamesFor('name') ?? ''}`}
+                >
                   <Arrow direction={getClassNamesFor('name')} />
                 </span>
               </th>
@@ -147,7 +164,9 @@ export const TopTable = ({data: top, sampleUnit}: TopTableProps): JSX.Element =>
                 onClick={() => requestSort('flat')}
               >
                 Flat
-                <span className={`inline-block align-middle ml-2 ${getClassNamesFor('flat')}`}>
+                <span
+                  className={`inline-block align-middle ml-2 ${getClassNamesFor('flat') ?? ''}`}
+                >
                   <Arrow direction={getClassNamesFor('flat')} />
                 </span>
               </th>
@@ -157,7 +176,9 @@ export const TopTable = ({data: top, sampleUnit}: TopTableProps): JSX.Element =>
               >
                 Cumulative
                 <span
-                  className={`inline-block align-middle ml-2 ${getClassNamesFor('cumulative')}`}
+                  className={`inline-block align-middle ml-2 ${
+                    getClassNamesFor('cumulative') ?? ''
+                  }`}
                 >
                   <Arrow direction={getClassNamesFor('cumulative')} />
                 </span>
@@ -168,7 +189,9 @@ export const TopTable = ({data: top, sampleUnit}: TopTableProps): JSX.Element =>
                   onClick={() => requestSort('diff')}
                 >
                   Diff
-                  <span className={`inline-block align-middle ml-2 ${getClassNamesFor('diff')}`}>
+                  <span
+                    className={`inline-block align-middle ml-2 ${getClassNamesFor('diff') ?? ''}`}
+                  >
                     <Arrow direction={getClassNamesFor('diff')} />
                   </span>
                 </th>

package/src/components/DiffLegend.tsx

@@ -25,7 +25,7 @@ const DiffLegendBar = ({
 }: {
   onMouseEnter: () => void;
   onMouseLeave: () => void;
-}) => {
+}): JSX.Element => {
   const isDarkMode = useAppSelector(selectDarkMode);
 
   return (
@@ -54,20 +54,20 @@ const DiffLegendBar = ({
   );
 };
 
-const DiffLegend = () => {
+const DiffLegend = (): JSX.Element => {
   const [showLegendTooltip, setShowLegendTooltip] = useState(false);
   const [popperElement, setPopperElement] = useState<HTMLDivElement | null>(null);
-  let [referenceElement, setReferenceElement] = useState<HTMLDivElement | null>(null);
+  const [referenceElement, setReferenceElement] = useState<HTMLDivElement | null>(null);
 
-  const {styles, attributes, ...popperProps} = usePopper(referenceElement, popperElement, {
+  const {styles, attributes} = usePopper(referenceElement, popperElement, {
     placement: 'auto-start',
     strategy: 'absolute',
   });
 
-  const handleMouseEnter = () => {
+  const handleMouseEnter = (): void => {
     setShowLegendTooltip(true);
   };
-  const handleMouseLeave = () => {
+  const handleMouseLeave = (): void => {
     setShowLegendTooltip(false);
   };
 

package/src/components/ProfileShareButton/ResultBox.tsx

@@ -24,10 +24,10 @@ interface Props {
 
 let timeoutHandle: ReturnType<typeof setTimeout> | null = null;
 
-const ResultBox = ({value, className = ''}: Props) => {
+const ResultBox = ({value, className = ''}: Props): JSX.Element => {
   const [isCopied, setIsCopied] = useState<boolean>(false);
 
-  const onCopy = () => {
+  const onCopy = (): void => {
     setIsCopied(true);
     (window.document?.activeElement as HTMLElement)?.blur();
     if (timeoutHandle != null) {

package/src/components/ProfileShareButton/index.tsx

@@ -34,16 +34,16 @@ const ProfileShareModal = ({
   closeModal,
   queryRequest,
   queryClient,
-}: ProfileShareModalProps) => {
+}: ProfileShareModalProps): JSX.Element => {
   const [isShared, setIsShared] = useState(false);
   const [loading, setLoading] = useState<boolean>(false);
   const [error, setError] = useState<string>('');
   const [description, setDescription] = useState<string>('');
   const [sharedLink, setSharedLink] = useState<string>('');
   const metadata = useGrpcMetadata();
-  const isFormDataValid = () => true;
+  const isFormDataValid = (): boolean => true;
 
-  const handleSubmit: () => void = async () => {
+  const handleSubmit: () => Promise<void> = async () => {
     try {
       setLoading(true);
       const {response} = await queryClient.shareProfile(
@@ -60,7 +60,7 @@ const ProfileShareModal = ({
     }
   };
 
-  const onClose = () => {
+  const onClose = (): void => {
     setLoading(false);
     setError('');
     setDescription('');
@@ -89,7 +89,7 @@ const ProfileShareModal = ({
               className="w-fit mt-4"
               onClick={e => {
                 e.preventDefault();
-                handleSubmit();
+                void handleSubmit();
               }}
               disabled={loading || !isFormDataValid()}
               type="submit"
@@ -113,7 +113,7 @@ const ProfileShareModal = ({
   );
 };
 
-const ProfileShareButton = ({queryRequest, queryClient}: Props) => {
+const ProfileShareButton = ({queryRequest, queryClient}: Props): JSX.Element => {
   const [isOpen, setIsOpen] = useState<boolean>(false);
 
   return (

package/src/useDelayedLoader.ts

@@ -17,11 +17,11 @@ interface DelayedLoaderOptions {
   delay?: number;
 }
 
-const useDelayedLoader = (isLoading = false, options?: DelayedLoaderOptions) => {
-  const {delay = 500} = options || {};
+const useDelayedLoader = (isLoading = false, options?: DelayedLoaderOptions): boolean => {
+  const {delay = 500} = options ?? {};
   const [isLoaderVisible, setIsLoaderVisible] = useState<boolean>(false);
   useEffect(() => {
-    let showLoaderTimeout;
+    let showLoaderTimeout: ReturnType<typeof setTimeout>;
     if (isLoading && !isLoaderVisible) {
       // if the request takes longer than half a second, show the loading icon
       showLoaderTimeout = setTimeout(() => {
@@ -31,7 +31,7 @@ const useDelayedLoader = (isLoading = false, options?: DelayedLoaderOptions) =>
       setIsLoaderVisible(false);
     }
     return () => clearTimeout(showLoaderTimeout);
-  }, [isLoading]);
+  }, [isLoading, isLoaderVisible, delay]);
 
   return isLoaderVisible;
 };

package/src/useQuery.tsx

@@ -35,7 +35,7 @@ export const useQuery = (
   reportType: QueryRequest_ReportType,
   options?: UseQueryOptions
 ): IQueryResult => {
-  const {skip = false} = options || {};
+  const {skip = false} = options ?? {};
   const [result, setResult] = useState<IQueryResult>({
     response: null,
     error: null,
@@ -58,9 +58,9 @@ export const useQuery = (
     const call = client.query(req, {meta: metadata});
 
     call.response
-      .then(response => setResult({response: response, error: null, isLoading: false}))
-      .catch(error => setResult({error: error, response: null, isLoading: false}));
-  }, [client, profileSource, metadata, reportType]);
+      .then(response => setResult({response, error: null, isLoading: false}))
+      .catch(error => setResult({error, response: null, isLoading: false}));
+  }, [skip, client, profileSource, metadata, reportType]);
 
   return result;
 };

package/src/utils.ts

@@ -25,7 +25,7 @@ export const downloadPprof = async (
   request: QueryRequest,
   queryClient: QueryServiceClient,
   metadata: RpcMetadata
-) => {
+): Promise<Blob> => {
   const req = {
     ...request,
     reportType: QueryRequest_ReportType.PPROF,