Skip to content

chore(v0): rework Fela renderer to use useInsertionEffect #35266

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

Draft
wants to merge 1 commit into
base: react-v0
Choose a base branch
from
Draft

chore(v0): rework Fela renderer to use useInsertionEffect #35266

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 0 additions & 1 deletion packages/fluentui/docs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
"@fluentui/react-northstar": "*",
"@fluentui/react-northstar-fela-renderer": "*",
"@fluentui/react-northstar-prototypes": "*",
"@fluentui/react-northstar-styles-renderer": "*",
"@fluentui/styles": "*",
"@hot-loader/react-dom": "17.0.2",
"@mdx-js/react": "^2.3.0",
Expand Down
6 changes: 3 additions & 3 deletions packages/fluentui/docs/src/components/VariableResolver/useEnhancedRenderer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { ProviderContextPrepared } from '@fluentui/react-northstar';
import { Renderer } from '@fluentui/react-northstar-styles-renderer';
import { Renderer } from '@fluentui/react-northstar-fela-renderer';
import { callable } from '@fluentui/styles';
import * as _ from 'lodash';
import * as React from 'react';
Expand All @@ -12,7 +12,7 @@ const useEnhancedRenderer = (
): [ProviderContextPrepared, React.RefObject<UsedVariables>] => {
const resolvedVariables = React.useRef<UsedVariables>({});
const renderRule: Renderer['renderRule'] = React.useCallback(
(styles, rendererParam) => {
(styles, rendererParam, changes) => {
const componentName: string = rendererParam.displayName;
const componentVariables = callable(context.theme.componentVariables[rendererParam.displayName])(
context.theme.siteVariables,
Expand All @@ -26,7 +26,7 @@ const useEnhancedRenderer = (
}
});

return context.renderer.renderRule(styles, rendererParam);
return context.renderer.renderRule(styles, rendererParam, changes);
},
[context],
);
Expand Down
1 change: 0 additions & 1 deletion packages/fluentui/docs/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
"@fluentui/react-icons-northstar": ["packages/fluentui/react-icons-northstar/src/index.ts"],
"@fluentui/react-northstar": ["packages/fluentui/react-northstar/src/index.ts"],
"@fluentui/react-northstar-fela-renderer": ["packages/fluentui/react-northstar-fela-renderer/src/index.ts"],
"@fluentui/react-northstar-styles-renderer": ["packages/fluentui/react-northstar-styles-renderer/src/index.ts"],
"@fluentui/react-northstar-prototypes": ["packages/fluentui/react-northstar-prototypes/src/index.ts"],
"@fluentui/react-proptypes": ["packages/fluentui/react-proptypes/src/index.ts"],
"@fluentui/styles": ["packages/fluentui/styles/src/index.ts"]
Expand Down
1 change: 0 additions & 1 deletion packages/fluentui/e2e/tsconfig.e2e.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
"@fluentui/react-icons-northstar": ["packages/fluentui/react-icons-northstar/src/index.ts"],
"@fluentui/react-northstar": ["packages/fluentui/react-northstar/src/index.ts"],
"@fluentui/react-northstar-fela-renderer": ["packages/fluentui/react-northstar-fela-renderer/src/index.ts"],
"@fluentui/react-northstar-styles-renderer": ["packages/fluentui/react-northstar-styles-renderer/src/index.ts"],
"@fluentui/react-northstar-prototypes": ["packages/fluentui/react-northstar-prototypes/src/index.ts"],
"@fluentui/react-proptypes": ["packages/fluentui/react-proptypes/src/index.ts"],
"@fluentui/styles": ["packages/fluentui/styles/src/index.ts"]
Expand Down
1 change: 0 additions & 1 deletion packages/fluentui/react-bindings/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
"@fluentui/react-component-event-listener": "^0.68.0",
"@fluentui/react-component-ref": "^0.68.0",
"@fluentui/react-northstar-fela-renderer": "^0.68.0",
"@fluentui/react-northstar-styles-renderer": "^0.68.0",
"@fluentui/styles": "^0.68.0",
"classnames": "^2.2.6",
"lodash": "^4.17.15",
Expand Down
2 changes: 1 addition & 1 deletion packages/fluentui/react-bindings/src/context.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { noopRenderer, Renderer } from '@fluentui/react-northstar-styles-renderer';
import { noopRenderer, Renderer } from '@fluentui/react-northstar-fela-renderer';
import { emptyTheme, ThemeInput, ThemePrepared } from '@fluentui/styles';
import * as React from 'react';

Expand Down
11 changes: 10 additions & 1 deletion packages/fluentui/react-bindings/src/hooks/useStyles.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,11 @@ export const useStyles = <StyleProps extends PrimitiveProps>(
{},
);

const { classes, styles: resolvedStyles } = getStyles({
const {
classes,
styles: resolvedStyles,
changes,
} = getStyles({
// Input values
allDisplayNames: composeOptions?.displayNames || [displayName],
className: composeOptions?.className || className,
Expand All @@ -108,5 +112,10 @@ export const useStyles = <StyleProps extends PrimitiveProps>(
performance: context.performance,
});

React.useLayoutEffect(() => {
console.log('changes', changes);
context.renderer.insertChanges(changes);
}, [changes]);

return { classes, styles: resolvedStyles };
};
3 changes: 1 addition & 2 deletions packages/fluentui/react-bindings/src/renderer/RendererContext.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import { createFelaRenderer } from '@fluentui/react-northstar-fela-renderer';
import { CreateRenderer } from '@fluentui/react-northstar-styles-renderer';
import { createFelaRenderer, type CreateRenderer } from '@fluentui/react-northstar-fela-renderer';
import * as React from 'react';

export const RendererContext = React.createContext<CreateRenderer>(createFelaRenderer());
4 changes: 3 additions & 1 deletion packages/fluentui/react-bindings/src/styles/getStyles.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import { resolveStyles } from './resolveStyles';

export type GetStylesResult = {
classes: ComponentSlotClasses;
changes: any[];
variables: ComponentVariablesObject;
styles: ComponentSlotStylesResolved;
theme: ProviderContextPrepared['theme'];
Expand All @@ -28,7 +29,7 @@ export const getStyles = (options: ResolveStylesOptions): GetStylesResult => {
options.performance.enableVariablesCaching,
);

const { classes, resolvedStyles, resolvedStylesDebug } = resolveStyles(options, resolvedVariables);
const { classes, resolvedStyles, resolvedStylesDebug, changes } = resolveStyles(options, resolvedVariables);

// conditionally add sources for evaluating debug information to component
if (process.env.NODE_ENV !== 'production' && isDebugEnabled) {
Expand All @@ -53,6 +54,7 @@ export const getStyles = (options: ResolveStylesOptions): GetStylesResult => {

return {
classes,
changes,
variables: resolvedVariables,
styles: resolvedStyles,
theme: options.theme,
Expand Down
138 changes: 5 additions & 133 deletions packages/fluentui/react-bindings/src/styles/resolveStyles.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { RendererParam } from '@fluentui/react-northstar-styles-renderer';
import { RendererParam } from '@fluentui/react-northstar-fela-renderer';
import {
ComponentSlotStylesInput,
ComponentSlotStylesPrepared,
Expand All @@ -20,6 +20,7 @@ export type ResolveStylesResult = {
resolvedStyles: ComponentSlotStylesResolved;
resolvedStylesDebug: Record<string, { styles: Object }[]>;
classes: ComponentSlotClasses;
changes: any[];
};

// this weak map is used as cache for the classes
Expand Down Expand Up @@ -56,6 +57,7 @@ export const resolveStyles = (
performance: performanceFlags,
} = options;

const changes = [];
const { className, design, styles, variables } = inlineStylesProps;
const noInlineStylesOverrides = !(design || styles);

Expand Down Expand Up @@ -152,137 +154,6 @@ export const resolveStyles = (
}`
: '';

if (typeof Proxy === 'undefined') {
//
//
// IE11 branch of code, feel free to remove later.
// Keep it sync with another branch below!
//
//

const resolvedStyles: Record<string, ICSSInJSStyle> = {};
const classes: Record<string, string> = {};

Object.keys(mergedStyles).forEach(slotName => {
// resolve/render slot styles once and cache
const lazyEvaluationKey = `${slotName}__return`;
const slotCacheKey = componentCacheKey + slotName;

Object.defineProperty(resolvedStyles, slotName, {
enumerable: false,
configurable: false,
set(val: ICSSInJSStyle) {
// Add to the cache if it's enabled
if (cacheEnabled && theme) {
stylesCache.set(theme, {
...stylesCache.get(theme),
[slotCacheKey]: val,
});
}

resolvedStyles[lazyEvaluationKey] = val;
},
get(): ICSSInJSStyle {
// If caching enabled and entry exists, get from cache, avoid lazy evaluation
if (cacheEnabled && theme) {
const stylesThemeCache = stylesCache.get(theme) || {};
if (stylesThemeCache[slotCacheKey]) {
return stylesThemeCache[slotCacheKey];
}
}

if (resolvedStyles[lazyEvaluationKey]) {
return resolvedStyles[lazyEvaluationKey];
}

// resolve/render slot styles once and cache
resolvedStyles[lazyEvaluationKey] = mergedStyles[slotName](styleParam);

if (cacheEnabled && theme) {
stylesCache.set(theme, {
...stylesCache.get(theme),
[slotCacheKey]: resolvedStyles[lazyEvaluationKey],
});
}

if (process.env.NODE_ENV !== 'production' && isDebugEnabled) {
resolvedStylesDebug[slotName] = (resolvedStyles[slotName] as any)?.['_debug'];
delete (resolvedStyles[slotName] as any)?.['_debug'];
}

return resolvedStyles[lazyEvaluationKey];
},
});

Object.defineProperty(classes, slotName, {
enumerable: false,
configurable: false,
set(val: string) {
if (cacheEnabled && theme) {
classesCache.set(theme, {
...classesCache.get(theme),
[slotCacheKey]: val,
});
}

classes[lazyEvaluationKey] = val;
},
get(): string {
if (cacheEnabled && theme) {
const classesThemeCache = classesCache.get(theme) || {};

//
// Cached styles
//

if (classesThemeCache[slotCacheKey] || classesThemeCache[slotCacheKey] === '') {
return slotName === 'root'
? cx(componentClassName, classesThemeCache[slotCacheKey], className)
: classesThemeCache[slotCacheKey];
}
}

//
// Lazy eval
//

if (classes[lazyEvaluationKey]) {
return slotName === 'root'
? cx(componentClassName, classes[lazyEvaluationKey], className)
: classes[lazyEvaluationKey];
}

// this resolves the getter magic
const styleObj = resolvedStyles[slotName];

if (styleObj) {
classes[lazyEvaluationKey] = renderer.renderRule(styleObj, rendererParam);

if (cacheEnabled && theme) {
classesCache.set(theme, {
...classesCache.get(theme),
[slotCacheKey]: classes[lazyEvaluationKey],
});
}
}

const resultClassName =
slotName === 'root'
? cx(componentClassName, classes[lazyEvaluationKey], className)
: classes[lazyEvaluationKey];

return resultClassName;
},
});
});

return {
resolvedStyles,
resolvedStylesDebug,
classes,
};
}

const resolvedStyles = new Proxy<Record<string, ICSSInJSStyle>>(
{},
{
Expand Down Expand Up @@ -352,7 +223,7 @@ export const resolveStyles = (
const styleObj = resolvedStyles[slotName];

if (styleObj) {
target[slotName] = renderer.renderRule(styleObj, rendererParam);
target[slotName] = renderer.renderRule(styleObj, rendererParam, changes);

if (cacheEnabled && theme) {
classesCache.set(theme, {
Expand All @@ -374,5 +245,6 @@ export const resolveStyles = (
resolvedStyles,
resolvedStylesDebug,
classes,
changes,
};
};
2 changes: 1 addition & 1 deletion packages/fluentui/react-bindings/test/compose/useCompose-test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import {
useUnhandledProps,
Unstable_FluentContextProvider,
} from '@fluentui/react-bindings';
import { noopRenderer } from '@fluentui/react-northstar-styles-renderer';
import { noopRenderer } from '@fluentui/react-northstar-fela-renderer';
import { ComponentSlotStylesPrepared, emptyTheme, ThemeInput } from '@fluentui/styles';
import cx from 'classnames';
import { mount, shallow } from 'enzyme';
Expand Down
2 changes: 1 addition & 1 deletion packages/fluentui/react-bindings/test/styles/resolveStyles-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import * as _ from 'lodash';
import { ResolveStylesOptions, StylesContextPerformance } from '@fluentui/react-bindings';
import { RendererRenderRule, noopRenderer } from '@fluentui/react-northstar-styles-renderer';
import { RendererRenderRule, noopRenderer } from '@fluentui/react-northstar-fela-renderer';
import {
ComponentSlotStylesPrepared,
ComponentVariablesObject,
Expand Down
3 changes: 0 additions & 3 deletions packages/fluentui/react-bindings/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,6 @@
},
{
"path": "../react-northstar-fela-renderer"
},
{
"path": "../react-northstar-styles-renderer"
}
]
}
3 changes: 1 addition & 2 deletions packages/fluentui/react-northstar-fela-renderer/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,10 @@
"bugs": "https://github.com/microsoft/fluentui/issues",
"dependencies": {
"@babel/runtime": "^7.10.4",
"@fluentui/react-northstar-styles-renderer": "^0.68.0",
"@fluentui/react-northstar-fela-renderer": "^0.68.0",
"@fluentui/styles": "^0.68.0",
"css-in-js-utils": "^3.0.0",
"fela": "^10.6.1",
"fela-dom": "^11.7.0",
"fela-plugin-embedded": "^10.6.1",
"fela-plugin-fallback-value": "^10.6.1",
"fela-plugin-placeholder-prefixer": "^10.6.1",
Expand Down
64 changes: 0 additions & 64 deletions packages/fluentui/react-northstar-fela-renderer/src/RendererProvider.tsx
View file
Open in desktop

This file was deleted.

Loading
Loading