Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
34 changes: 32 additions & 2 deletions .try.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,24 @@ const compatDeps = {
export default {
scenarios: [
{
name: 'ember-lts-5.8',
name: 'ember-lts-3.28',
npm: {
devDependencies: {
'ember-source': '~5.8.0',
'ember-source': '~3.28.0',
...compatDeps,
'ember-cli': '^4.12',
},
},
env: {
ENABLE_COMPAT_BUILD: true,
},
files: compatFiles,
},
{
name: 'ember-lts-4.12',
npm: {
devDependencies: {
'ember-source': '~4.12.0',
...compatDeps,
},
},
Expand Down Expand Up @@ -59,6 +73,22 @@ export default {
},
},
},
{
name: 'ember-lts-6.8',
npm: {
devDependencies: {
'ember-source': 'npm:ember-source@~6.8.0',
},
},
},
{
name: 'ember-lts-6.12',
npm: {
devDependencies: {
'ember-source': 'npm:ember-source@~6.12.0',
},
},
},
{
name: 'ember-latest',
npm: {
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@
"eslint-plugin-ember": "^12.7.5",
"eslint-plugin-import": "^2.32.0",
"eslint-plugin-n": "^17.24.0",
"globals": "^17.4.0",
"globals": "^17.5.0",
"prettier": "^3.8.2",
"prettier-plugin-ember-template-tag": "^2.1.4",
"publint": "^0.3.18",
Expand Down
10 changes: 5 additions & 5 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

108 changes: 108 additions & 0 deletions src/-private/untrack.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
import * as glimmerValidator from '@glimmer/validator';

// Ember apps can provide @glimmer/validator through different module shapes
// depending on ember-source version and bundling mode. We centralize the
// resolution logic here so modifiers can always call a single untrack API.

type UntrackCallback = () => void;
type Untrack = (callback: UntrackCallback) => void;
type ValidatorRequire = (moduleName: string) => ValidatorModule;

interface ValidatorModule {
untrack?: unknown;
beginUntrackFrame?: unknown;
endUntrackFrame?: unknown;
}

function getCallable<T extends (...args: never[]) => unknown>(
target: unknown,
property: string,
): T | undefined {
const value = (target as Record<string, unknown>)[property];

return typeof value === 'function' ? (value as T) : undefined;
}

function tryRequire(maybeRequire: ValidatorRequire | undefined) {
if (typeof maybeRequire !== 'function') {
return undefined;
}

try {
return maybeRequire('@glimmer/validator');
} catch {
return undefined;
}
}

function resolveValidatorModule(): ValidatorModule {
const importedModule = glimmerValidator as ValidatorModule;
const importedUntrack = getCallable<Untrack>(importedModule, 'untrack');
const importedBeginUntrackFrame = getCallable<() => void>(
importedModule,
'beginUntrackFrame',
);

if (importedUntrack || importedBeginUntrackFrame) {
// Modern ESM shape: use the imported namespace directly.
return importedModule;
}

const globalWithEmber = globalThis as {
Ember?: {
__loader?: {
require?: (moduleName: string) => ValidatorModule;
};
};
require?: ValidatorRequire;
requirejs?: ValidatorRequire;
};

const requireCandidates: Array<ValidatorRequire | undefined> = [
globalWithEmber.Ember?.__loader?.require,
globalWithEmber.require,
globalWithEmber.requirejs,
];

for (const maybeRequire of requireCandidates) {
const module = tryRequire(maybeRequire);

if (module) {
// Older or compat builds: resolve from runtime module loader.
return module;
}
}

return {};
}

export const untrack: Untrack = (() => {
const validator = resolveValidatorModule();
const moduleUntrack = getCallable<Untrack>(validator, 'untrack');

if (moduleUntrack) {
return moduleUntrack;
}

const beginUntrackFrame = getCallable<() => void>(
validator,
'beginUntrackFrame',
);
const endUntrackFrame = getCallable<() => void>(validator, 'endUntrackFrame');

if (beginUntrackFrame && endUntrackFrame) {
// Some validator versions expose frame primitives instead of untrack.
return (callback: UntrackCallback) => {
beginUntrackFrame();

try {
callback();
} finally {
endUntrackFrame();
}
};
}

// Last resort for very old or unexpected runtime shapes.
return (callback: UntrackCallback) => callback();
})();
2 changes: 1 addition & 1 deletion src/modifiers/did-update.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { setModifierManager, capabilities } from '@ember/modifier';
import { untrack } from '@glimmer/validator';
import { untrack } from '../-private/untrack.ts';

import type {
ModifierArgs,
Expand Down
Loading