feat(ingest): Support System Ingestion Sources, Show and hide system ingestion sources with Command-S

[jjoyce0510]

https://www.loom.com/share/28cced5188704fb897d0ccb14ff8b60a

Summary

Showing and hiding "system internal" ingestion sources.

QA

Tried everything locally, recorded Loom above!

Checklist

• The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
• Links to related issues (if applicable)
• Tests for the changes have been added/updated (if applicable)
• Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
• For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

Summary by CodeRabbit

• New Features

  • Added a feature to show or hide system ingestion sources based on a hidden command toggle.

• Improvements

  • Default filters for ingestion sources now dynamically adjust visibility based on user preferences.

[coderabbitai]

Walkthrough

The changes introduce a feature to show or hide system ingestion sources based on a hidden command using a new useCommandS hook. This involves adding a constant SYSTEM_INTERNAL_SOURCE_TYPE and managing the visibility of system sources via a toggle mechanism. Additionally, the DataHubIngestionSourceInfo record includes a new optional field source to describe the origin of the Ingestion Source.

Changes

Files	Change Summaries
datahub-web-react/src/app/ingest/source/IngestionSourceList.tsx	Added SYSTEM_INTERNAL_SOURCE_TYPE, hideSystemSources state, and useCommandS hook for toggling system sources visibility.
datahub-web-react/src/app/ingest/source/hooks.ts	Introduced useCommandS hook to detect MetaKey + 's' key combination and trigger a callback.
metadata-models/src/main/pegasus/com/.../DataHubIngestionSourceInfo.pdl	Added source field to DataHubIngestionSourceInfo with type field defining the source type as SYSTEM.

Poem

In the code, a secret lies,
A toggle with the 'MetaKey' sighs.
Hidden sources in the night,
With SYSTEM now in sight.
Tweak and dance, adjust the show,
Ingestion sources come and go. 🌟

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

Outside diff range, codebase verification and nitpick comments (1)

metadata-models/src/main/pegasus/com/linkedin/ingestion/DataHubIngestionSourceInfo.pdl (1)

66-84: Potential Integration Issue:

The new field source of type DataHubIngestionSourceSource in DataHubIngestionSourceInfo.pdl is defined but not referenced elsewhere in the codebase. This suggests that it might not be properly integrated.

• Ensure that the new field source is used and integrated correctly in the codebase.
• Verify if there are any additional steps needed for its integration.

Analysis chain

LGTM! Ensure proper integration with the rest of the system.

The new field source and its subfields are correctly defined. Ensure that the new field is properly documented and integrated with the rest of the system.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the integration of the new `source` field in the codebase.

# Test: Search for the usage of the `source` field. Expect: Proper integration and usage.
rg --type pdl -A 5 $'source'

Length of output: 55

---

Script:

#!/bin/bash
# Description: Verify the integration of the new `source` field in the codebase.

# Find all .pdl files and search for the usage of the `source` field within those files.
fd -e pdl -x rg 'source' {}

Length of output: 10245

---

Script:

#!/bin/bash
# Description: Verify the integration of the new `DataHubIngestionSourceSource` field in the codebase.

# Find all references to `DataHubIngestionSourceSource` in the codebase.
rg 'DataHubIngestionSourceSource'

Length of output: 319

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 452b94f and 6e7e843.

Files selected for processing (3)

• datahub-web-react/src/app/ingest/source/IngestionSourceList.tsx (4 hunks)
• datahub-web-react/src/app/ingest/source/hooks.ts (1 hunks)
• metadata-models/src/main/pegasus/com/linkedin/ingestion/DataHubIngestionSourceInfo.pdl (1 hunks)

Additional comments not posted (4)

datahub-web-react/src/app/ingest/source/IngestionSourceList.tsx (4)

55-55: LGTM!

The new constant SYSTEM_INTERNAL_SOURCE_TYPE is correctly defined and improves code readability.

---

108-108: LGTM! Ensure consistent usage of the new state.

The new state hideSystemSources is correctly defined and initialized. Ensure that it is used consistently throughout the component.

Verification successful

Let's correct the rg command to search within .tsx files without specifying the file type explicitly.

---

The new state hideSystemSources is used consistently.

The state hideSystemSources is correctly defined and initialized. It is used in the useCommandS hook, in a conditional assignment to filters, and as part of the useListIngestionSourcesQuery query.

• useCommandS(() => setHideSystemSources(!hideSystemSources));
• const filters = hideSystemSources ? [{ field: 'sourceType', values: [SYSTEM_INTERNAL_SOURCE_TYPE], negated: true }] : undefined;

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the consistent usage of the new state `hideSystemSources` in the codebase.

# Test: Search for the usage of the `hideSystemSources` state. Expect: Consistent usage.
rg --type tsx -A 5 $'hideSystemSources'

Length of output: 66

---

Script:

#!/bin/bash
# Description: Verify the consistent usage of the new state `hideSystemSources` in the codebase.

# Test: Search for the usage of the `hideSystemSources` state. Expect: Consistent usage.
rg 'hideSystemSources' --glob '*.tsx' -A 5

Length of output: 1477

---

113-113: LGTM! Ensure the functionality is tested.

The useCommandS hook is used correctly to toggle the visibility of system ingestion sources. Ensure that the functionality is tested.

---

115-118: LGTM! Ensure the filter logic is tested.

The new filter is correctly defined to hide system ingestion sources based on the hideSystemSources state. Ensure that the filter logic is tested.

Verification successful

---

LGTM! Ensure the filter logic is tested.

The new filter is correctly defined to hide system ingestion sources based on the hideSystemSources state. The search results indicate that there are test cases related to filters in the codebase, ensuring proper test coverage for the filter logic.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the filter logic for hiding system ingestion sources in the codebase.

# Test: Search for the usage of the filter logic. Expect: Proper functionality and testing.
rg --type tsx -A 5 $'filters'

Length of output: 56

---

Script:

#!/bin/bash
# Description: Verify the filter logic for hiding system ingestion sources in the codebase.

# Test: Search for the usage of the filter logic. Expect: Proper functionality and testing.
rg --type-add 'tsx:*.{ts,tsx}' --type tsx -A 5 'filters'

Length of output: 197765

---

Script:

#!/bin/bash
# Description: Verify the test cases for the filter logic for hiding system ingestion sources in the codebase.

# Test: Search for test cases related to filter logic. Expect: Proper test coverage.
rg --type-add 'tsx:*.{ts,tsx}' --type tsx -A 5 'filters' | grep -i 'test'

Length of output: 36723

[coderabbitai]

Consider improving readability and ensuring the event listener is added only once.

The hook implementation is correct, but you can improve readability and ensure the event listener is added only once by using a ref for the callback.

import { useEffect, useRef } from 'react';

export const useCommandS = (onPress: () => void) => {
    const onPressRef = useRef(onPress);

    useEffect(() => {
        onPressRef.current = onPress;
    }, [onPress]);

    useEffect(() => {
        const handleKeyDown = (event: KeyboardEvent) => {
            if (event.metaKey && event.key === 's') {
                event.preventDefault();
                onPressRef.current();
            }
        };
        window.addEventListener('keydown', handleKeyDown);
        return () => {
            window.removeEventListener('keydown', handleKeyDown);
        };
    }, []);
};

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	export const useCommandS = (onPress: () => void) => {
	useEffect(() => {
	const handleKeyDown = (event: KeyboardEvent) => {
	if (event.metaKey && event.key === 's') {
	event.preventDefault();
	onPress();
	}
	};
	window.addEventListener('keydown', handleKeyDown);
	return () => {
	window.removeEventListener('keydown', handleKeyDown);
	};
	}, [onPress]);
	import { useEffect, useRef } from 'react';
	export const useCommandS = (onPress: () => void) => {
	const onPressRef = useRef(onPress);
	useEffect(() => {
	onPressRef.current = onPress;
	}, [onPress]);
	useEffect(() => {
	const handleKeyDown = (event: KeyboardEvent) => {
	if (event.metaKey && event.key === 's') {
	event.preventDefault();
	onPressRef.current();
	}
	};
	window.addEventListener('keydown', handleKeyDown);
	return () => {
	window.removeEventListener('keydown', handleKeyDown);
	};
	}, []);
	};