Skip to content
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

fix: props enumeration of simbols #2229

Merged
merged 1 commit into from
Nov 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 2 additions & 3 deletions packages/qwik/src/core/container/resume.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,9 @@ import {
} from './container';
import { findClose, VirtualElementImpl } from '../render/dom/virtual-element';
import { getProxyManager, parseSubscription, Subscriptions } from '../state/common';
import { createProxy } from '../state/store';
import { createProxy, setObjectFlags } from '../state/store';
import { qSerialize } from '../util/qdev';
import { pauseContainer } from './pause';
import { QObjectFlagsSymbol } from '../state/constants';
import { isPrimitive } from '../render/dom/render-dom';
import { getContext } from '../state/context';
import { domToVnode } from '../render/dom/visitor';
Expand Down Expand Up @@ -229,7 +228,7 @@ const reviveSubscriptions = (
}
}
if (flag > 0) {
value[QObjectFlagsSymbol] = flag;
setObjectFlags(value, flag);
}
if (!parser.subs(value, converted)) {
const proxy = containerState.$proxyMap$.get(value);
Expand Down
16 changes: 3 additions & 13 deletions packages/qwik/src/core/render/dom/visitor.ts
Original file line number Diff line number Diff line change
Expand Up @@ -73,13 +73,8 @@ import {
tryGetContext,
} from '../../state/context';
import { getProxyManager, getProxyTarget, SubscriptionManager } from '../../state/common';
import { createProxy } from '../../state/store';
import {
QObjectFlagsSymbol,
QObjectImmutable,
_IMMUTABLE,
_IMMUTABLE_PREFIX,
} from '../../state/constants';
import { createPropsState, createProxy } from '../../state/store';
import { _IMMUTABLE, _IMMUTABLE_PREFIX } from '../../state/constants';

export const SVG_NS = 'http://www.w3.org/2000/svg';

Expand Down Expand Up @@ -1032,12 +1027,7 @@ export const setComponentProps = (
const keys = Object.keys(expectProps);
let props = elCtx.$props$;
if (!props) {
elCtx.$props$ = props = createProxy(
{
[QObjectFlagsSymbol]: QObjectImmutable,
},
rCtx.$static$.$containerState$
);
elCtx.$props$ = props = createProxy(createPropsState(), rCtx.$static$.$containerState$);
}
if (keys.length === 0) {
return false;
Expand Down
14 changes: 4 additions & 10 deletions packages/qwik/src/core/render/ssr/render-ssr.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,8 @@ import {
QContext,
Q_CTX,
} from '../../state/context';
import { createProxy } from '../../state/store';
import {
QObjectFlagsSymbol,
QObjectImmutable,
_IMMUTABLE,
_IMMUTABLE_PREFIX,
} from '../../state/constants';
import { createPropsState, createProxy } from '../../state/store';
import { _IMMUTABLE, _IMMUTABLE_PREFIX } from '../../state/constants';

const FLUSH_COMMENT = '<!--qkssr-f-->';

Expand Down Expand Up @@ -815,9 +810,8 @@ const setComponentProps = (
expectProps: Record<string, any>
) => {
const keys = Object.keys(expectProps);
const target = {
[QObjectFlagsSymbol]: QObjectImmutable,
} as Record<string, any>;
const target = createPropsState();

elCtx.$props$ = createProxy(target, rCtx.$static$.$containerState$);

if (keys.length === 0) {
Expand Down
10 changes: 2 additions & 8 deletions packages/qwik/src/core/state/context.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,7 @@ import { isElement } from '../../testing/html';
import { assertQwikElement } from '../util/element';
import { assertTrue } from '../error/assert';
import { QScopedStyle } from '../util/markers';
import { createProxy } from './store';
import { QObjectFlagsSymbol, QObjectImmutable } from './constants';
import { createPropsState, createProxy } from './store';

export const Q_CTX = '_qc_';

Expand Down Expand Up @@ -105,12 +104,7 @@ export const getContext = (el: QwikElement, containerState: ContainerState): QCo
if (props) {
elCtx.$props$ = getObject(props);
} else {
elCtx.$props$ = createProxy(
{
[QObjectFlagsSymbol]: QObjectImmutable,
},
containerState
);
elCtx.$props$ = createProxy(createPropsState(), containerState);
}
}
}
Expand Down
16 changes: 14 additions & 2 deletions packages/qwik/src/core/state/q-object.unit.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import { suite } from 'uvu';
import { equal } from 'uvu/assert';
import { getContainerState } from '../container/container';
import { createSubscriptionManager, unwrapProxy } from './common';
import { createSubscriptionManager, getProxyFlags, unwrapProxy } from './common';
import { QObjectRecursive } from './constants';
import { getOrCreateProxy } from './store';
import { createPropsState, createProxy, getOrCreateProxy } from './store';

const qObject = suite('q-object');
const container = getContainerState({} as any);
Expand All @@ -17,6 +17,18 @@ qObject('should create QObject', () => {
equal(obj, { salutation: 'Hello', name: 'World' });
});

qObject('should not copy proxy flags metadata', () => {
const target = createPropsState();
const proxy = createProxy(target, container);
equal(getProxyFlags(proxy), 2);
equal(getProxyFlags(target), 2);

const targetCopy = Object.assign({}, target);
const proxyCopy = Object.assign({}, proxy);
equal(getProxyFlags(targetCopy), undefined);
equal(getProxyFlags(proxyCopy), undefined);
});

qObject('should support basic operations', () => {
const value = { a: 1, b: 2 };
const proxy = getOrCreateProxy(value, map);
Expand Down
14 changes: 12 additions & 2 deletions packages/qwik/src/core/state/store.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export const getOrCreateProxy = <T extends object>(
return proxy;
}
if (flags !== 0) {
(target as any)[QObjectFlagsSymbol] = flags;
setObjectFlags(target, flags);
}
return createProxy(target, containerState, undefined);
};
Expand All @@ -66,6 +66,16 @@ export const createProxy = <T extends object>(
return proxy;
};

export const createPropsState = (): Record<string, any> => {
const props = {};
setObjectFlags(props, QObjectImmutable);
return props;
};

export const setObjectFlags = (obj: object, flags: number) => {
Object.defineProperty(obj, QObjectFlagsSymbol, { value: flags, enumerable: false });
};

export type TargetType = Record<string | symbol, any>;

class ReadWriteProxyHandler implements ProxyHandler<TargetType> {
Expand Down Expand Up @@ -178,7 +188,7 @@ class ReadWriteProxyHandler implements ProxyHandler<TargetType> {
}

getOwnPropertyDescriptor(target: TargetType, prop: string) {
if (isArray(target)) {
if (isArray(target) || typeof prop === 'symbol') {
return Object.getOwnPropertyDescriptor(target, prop);
}
return {
Expand Down