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

Enable change of prefixes to existing options proxy #11105

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
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
22 changes: 17 additions & 5 deletions src/helpers/helpers.config.ts
Expand Up @@ -46,6 +46,7 @@ export function _createResolver<
_fallback: fallback,
_getTarget: getTarget,
override: (scope: AnyObject) => _createResolver([scope, ...scopes], prefixes, finalRootScopes, fallback),
overridePrefixes: (pref: string[]) => _createResolver(scopes, pref, finalRootScopes, fallback)
};
return new Proxy(cache, {
/**
Expand Down Expand Up @@ -107,6 +108,16 @@ export function _createResolver<
}) as ResolverProxy<T, R>;
}

function applyPrefixes<
T extends AnyObject[] = AnyObject[],
R extends AnyObject[] = T
>(
proxy: ResolverProxy<T, R>,
prefixes: string[]
) : ResolverProxy<T, R> {
return (prefixes && prefixes.length ? proxy.overridePrefixes(prefixes) : proxy) as ResolverProxy<T, R>;
}

/**
* Returns an Proxy for resolving option values with context.
* @param proxy - The Proxy returned by `_createResolver`
Expand All @@ -131,8 +142,8 @@ export function _attachContext<
_subProxy: subProxy,
_stack: new Set(),
_descriptors: _descriptors(proxy, descriptorDefaults),
setContext: (ctx: AnyObject) => _attachContext(proxy, ctx, subProxy, descriptorDefaults),
override: (scope: AnyObject) => _attachContext(proxy.override(scope), context, subProxy, descriptorDefaults)
setContext: (ctx: AnyObject, prefixes: string[]) => _attachContext(applyPrefixes(proxy, prefixes), ctx, subProxy, descriptorDefaults),
override: (scope: AnyObject, prefixes: string[]) => _attachContext(applyPrefixes(proxy.override(scope), prefixes), context, subProxy, descriptorDefaults)
};
return new Proxy(cache, {
/**
Expand Down Expand Up @@ -336,7 +347,8 @@ function createSubResolver(
parentScopes: AnyObject[],
resolver: ResolverCache,
prop: ResolverObjectKey,
value: unknown
value: unknown,
prefixes: string[] = ['']
) {
const rootScopes = resolver._rootScopes;
const fallback = resolveFallback(resolver._fallback, prop, value);
Expand All @@ -353,7 +365,7 @@ function createSubResolver(
return false;
}
}
return _createResolver(Array.from(set), [''], rootScopes, fallback,
return _createResolver(Array.from(set), prefixes, rootScopes, fallback,
() => subGetTarget(resolver, prop as string, value));
}

Expand Down Expand Up @@ -398,7 +410,7 @@ function _resolveWithPrefixes(
value = _resolve(readKey(prefix, prop), scopes);
if (typeof value !== 'undefined') {
return needsSubResolver(prop, value)
? createSubResolver(scopes, proxy, prop, value)
? createSubResolver(scopes, proxy, prop, value, prefixes)
: value;
}
}
Expand Down
5 changes: 3 additions & 2 deletions src/helpers/helpers.config.types.ts
Expand Up @@ -19,6 +19,7 @@ export interface ResolverCache<
_storage?: T[number];
_getTarget(): T[number];
override<S extends AnyObject>(scope: S): ResolverProxy<(T[number] | S)[], T | R>
overridePrefixes<S extends AnyObject>(pref: string[]): ResolverProxy<(T[number] | S)[], T | R>
}

export type ResolverProxy<
Expand Down Expand Up @@ -50,8 +51,8 @@ export interface ContextCache<
_subProxy: ResolverProxy<T, R>;
_stack: Set<string>;
_descriptors: Descriptor
setContext(ctx: AnyObject): ContextProxy<T, R>
override<S extends AnyObject>(scope: S): ContextProxy<(T[number] | S)[], T | R>
setContext(ctx: AnyObject, prefixes: string[]): ContextProxy<T, R>
override<S extends AnyObject>(scope: S, prefixes: string[]): ContextProxy<(T[number] | S)[], T | R>
}

export type ContextProxy<
Expand Down
14 changes: 14 additions & 0 deletions test/specs/helpers.config.tests.js
Expand Up @@ -719,6 +719,20 @@ describe('Chart.helpers.config', function() {
expect(opts.fn).toEqual(1);
});

it('should support changing prefixes', function() {
const res = _createResolver([{test: 1, hoverTest: 2}]);
const opts = _attachContext(res, {ctx: 1});
expect(opts.test).toEqual(1);
expect(opts.setContext({ctx: 2}, ['hover', '']).test).toEqual(2);
expect(opts.test).toEqual(1);
expect(opts.override('', ['hover', '']).test).toEqual(2);
});

it('should support prefixes to subnodes', function() {
const res = _createResolver([{node: {test: 1, hoverTest: 2}}], ['hover', '']);
expect(res.node.test).toEqual(2);
});

it('should support common object methods', function() {
const defaults = {
option1: 'defaults'
Expand Down