-
Notifications
You must be signed in to change notification settings - Fork 331
fix(blueprint): Blueprint Modernization #4204
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.
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
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
91 changes: 91 additions & 0 deletions
91
src/elements/common/__tests__/withBlueprintModernization.test.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
import * as React from 'react'; | ||
import { BlueprintModernizationContext } from '@box/blueprint-web'; | ||
import { render } from '../../../test-utils/testing-library'; | ||
import { withBlueprintModernization } from '../withBlueprintModernization'; | ||
|
||
// Mock the Blueprint Web package with simple components | ||
jest.mock('@box/blueprint-web', () => { | ||
const ReactMock = jest.requireActual('react'); | ||
const mockContext = ReactMock.createContext({ enableModernizedComponents: false }); | ||
|
||
return { | ||
BlueprintModernizationContext: mockContext, | ||
BlueprintModernizationProvider: ({ children, enableModernizedComponents }) => | ||
ReactMock.createElement( | ||
'div', | ||
{ | ||
'data-testid': 'blueprint-provider', | ||
'data-enabled': String(enableModernizedComponents), | ||
}, | ||
children, | ||
), | ||
TooltipProvider: ({ children }) => | ||
ReactMock.createElement('div', { 'data-testid': 'tooltip-provider' }, children), | ||
BlueprintModernizationContextValue: {}, | ||
}; | ||
}); | ||
|
||
type TestComponentProps = { | ||
value?: string; | ||
enableModernizedComponents?: boolean; | ||
}; | ||
|
||
describe('src/elements/common/withBlueprintModernization', () => { | ||
const TestComponent = ({ value }: TestComponentProps) => ( | ||
<div data-testid="test-component">{`Test ${value || 'default'}`}</div> | ||
); | ||
|
||
const WrappedComponent = withBlueprintModernization(TestComponent); | ||
|
||
const renderComponent = (props?: TestComponentProps) => render(<WrappedComponent {...props} />); | ||
|
||
test('should wrap component with BlueprintModernizationProvider', () => { | ||
const { getByTestId } = renderComponent(); | ||
|
||
expect(getByTestId('test-component')).toBeInTheDocument(); | ||
expect(getByTestId('test-component')).toHaveTextContent('Test default'); | ||
expect(getByTestId('blueprint-provider')).toBeInTheDocument(); | ||
expect(getByTestId('blueprint-provider')).toHaveAttribute('data-enabled', 'false'); | ||
}); | ||
|
||
test('should pass props to wrapped component', () => { | ||
const { getByTestId } = renderComponent({ value: 'test-value' }); | ||
|
||
expect(getByTestId('test-component')).toBeInTheDocument(); | ||
expect(getByTestId('test-component')).toHaveTextContent('Test test-value'); | ||
}); | ||
|
||
test('should handle enableModernizedComponents prop', () => { | ||
const { getByTestId } = renderComponent({ | ||
value: 'modernized', | ||
enableModernizedComponents: true, | ||
}); | ||
|
||
expect(getByTestId('test-component')).toBeInTheDocument(); | ||
expect(getByTestId('test-component')).toHaveTextContent('Test modernized'); | ||
expect(getByTestId('blueprint-provider')).toBeInTheDocument(); | ||
expect(getByTestId('blueprint-provider')).toHaveAttribute('data-enabled', 'true'); | ||
}); | ||
|
||
test('should not wrap component when upstream BlueprintModernizationProvider exists', () => { | ||
// Create a parent component with existing BlueprintModernizationContext | ||
const ParentWithContext = ({ children }) => ( | ||
<BlueprintModernizationContext.Provider value={{ enableModernizedComponents: true }}> | ||
{children} | ||
</BlueprintModernizationContext.Provider> | ||
); | ||
|
||
const { getByTestId, queryByTestId } = render( | ||
<ParentWithContext> | ||
<WrappedComponent value="with-context" enableModernizedComponents={false} /> | ||
</ParentWithContext>, | ||
); | ||
|
||
// Component should render | ||
expect(getByTestId('test-component')).toBeInTheDocument(); | ||
expect(getByTestId('test-component')).toHaveTextContent('Test with-context'); | ||
|
||
// HOC should NOT add its own BlueprintModernizationProvider since upstream context exists | ||
expect(queryByTestId('blueprint-provider')).not.toBeInTheDocument(); | ||
}); | ||
}); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
import React, { useContext } from 'react'; | ||
import { | ||
BlueprintModernizationContext, | ||
BlueprintModernizationContextValue, | ||
BlueprintModernizationProvider, | ||
} from '@box/blueprint-web'; | ||
|
||
export function withBlueprintModernization<P>( | ||
Component: React.ComponentType<P & BlueprintModernizationContextValue>, | ||
): React.FC<(P & BlueprintModernizationContextValue) | P> { | ||
return function WithBlueprintModernization(props: P & BlueprintModernizationContextValue) { | ||
const context = useContext(BlueprintModernizationContext); | ||
// no context found from the parent component, so we need to provide our own | ||
if (!context.enableModernizedComponents) { | ||
return ( | ||
<BlueprintModernizationProvider enableModernizedComponents={!!props.enableModernizedComponents}> | ||
<Component {...props} /> | ||
</BlueprintModernizationProvider> | ||
); | ||
} | ||
// context found, so load the component with the existing context | ||
return <Component {...props} />; | ||
}; | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.