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.

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

Jump to bottom

[recoil][devtools] Release snapshots #1006

Closed
wants to merge 1 commit into from
Closed

[recoil][devtools] Release snapshots #1006

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
105 changes: 59 additions & 46 deletions packages/recoil-devtools/src/pages/Page/PageScript.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,49 +35,53 @@ async function normalizeSnapshot(
if (snapshot == null) {
return {modifiedValues: undefined};
}

const dirtyNodes = snapshot.getNodes_UNSTABLE({isModified: onlyDirty});
const customSerialize = props.serializeFn ?? DefaultCustomSerialize;
const modifiedValues = {};
const subscribers = new Set();
const release = snapshot.retain();
try {
const dirtyNodes = snapshot.getNodes_UNSTABLE({isModified: onlyDirty});
const customSerialize = props.serializeFn ?? DefaultCustomSerialize;
const subscribers = new Set();

// We wrap this loop into a promise to defer the execution
// of the second (subscribers) loop, so selector
// can settle before we check their values
await new Promise(resolve => {
for (const node of dirtyNodes) {
const info = snapshot.getInfo_UNSTABLE(node);
// We only accumulate subscribers if we are looking at only dirty nodes
if (onlyDirty) {
subscribers.add(...Array.from(info.subscribers.nodes));
// We wrap this loop into a promise to defer the execution
// of the second (subscribers) loop, so selector
// can settle before we check their values
await new Promise(resolve => {
for (const node of dirtyNodes) {
const info = snapshot.getInfo_UNSTABLE(node);
// We only accumulate subscribers if we are looking at only dirty nodes
if (onlyDirty) {
subscribers.add(...Array.from(info.subscribers.nodes));
}
modifiedValues[node.key] = {
content: serialize(
customSerialize(info.loadable?.contents, node.key),
props.maxDepth,
props.maxItems,
),
nodeType: info.type,
deps: Array.from(info.deps).map(n => n.key),
};
}
modifiedValues[node.key] = {
content: serialize(
customSerialize(info.loadable?.contents, node.key),
props.maxDepth,
props.maxItems,
),
nodeType: info.type,
deps: Array.from(info.deps).map(n => n.key),
};
}
resolve();
});
resolve();
});

for (const node of subscribers) {
if (node != null) {
const info = snapshot.getInfo_UNSTABLE(node);
modifiedValues[node.key] = {
content: serialize(
customSerialize(info.loadable?.contents, node.key),
props.maxDepth,
props.maxItems,
),
nodeType: info.type,
isSubscriber: true,
deps: Array.from(info.deps).map(n => n.key),
};
for (const node of subscribers) {
if (node != null) {
const info = snapshot.getInfo_UNSTABLE(node);
modifiedValues[node.key] = {
content: serialize(
customSerialize(info.loadable?.contents, node.key),
props.maxDepth,
props.maxItems,
),
nodeType: info.type,
isSubscriber: true,
deps: Array.from(info.deps).map(n => n.key),
};
}
}
} finally {
release();
}

return {
Expand All @@ -98,20 +102,29 @@ const __RECOIL_DEVTOOLS_EXTENSION__ = {
debug('CONNECT_PAGE', props);
initConnection(props);
const {devMode, goToSnapshot, initialSnapshot} = props;
const previousSnapshots = new EvictableList<RecoilSnapshot>(
const previousSnapshots = new EvictableList<[RecoilSnapshot, () => void]>(
props.persistenceLimit,
([_, release]) => release(),
);
if (devMode && initialSnapshot != null) {
previousSnapshots.add(initialSnapshot);
previousSnapshots.add([initialSnapshot, initialSnapshot.retain()]);
}

let loadedSnapshot, releaseLoadedSnapshot;
function setLoadedSnapshot(s) {
releaseLoadedSnapshot?.();
[loadedSnapshot, releaseLoadedSnapshot] = [s, s?.retain()];
}
setLoadedSnapshot(initialSnapshot);

let loadedSnapshot = initialSnapshot;
const backgroundMessageListener = (message: MessageEventFromBackground) => {
if (message.data?.source === ExtensionSourceContentScript) {
if (message.data?.action === RecoilDevToolsActions.GO_TO_SNAPSHOT) {
loadedSnapshot = previousSnapshots.get(message.data?.snapshotId);
if (loadedSnapshot != null) {
goToSnapshot(loadedSnapshot);
const [snapshot] =
previousSnapshots.get(message.data?.snapshotId) ?? [];
setLoadedSnapshot(snapshot);
if (snapshot != null) {
goToSnapshot(snapshot);
}
}
}
Expand All @@ -136,11 +149,11 @@ const __RECOIL_DEVTOOLS_EXTENSION__ = {
return;
}
// reset the just loaded snapshot
loadedSnapshot = null;
setLoadedSnapshot(null);
// On devMode we accumulate the list of rpevious snapshots
// to be able to time travel
if (devMode) {
previousSnapshots.add(snapshot);
previousSnapshots.add([snapshot, snapshot.retain()]);
}

window.postMessage(
Expand Down
13 changes: 11 additions & 2 deletions packages/recoil-devtools/src/utils/EvictableList.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,13 @@ class EvictableList<TType> {
list: Map<number, TType>;
capacity: number;
index: number;
onEvict: ?(TType) => void;

constructor(maxCapacity: number = 50) {
constructor(maxCapacity: number = 50, onEvict?: TType => void) {
this.list = new Map();
this.capacity = maxCapacity;
this.index = 0;
this.capacity = maxCapacity;
this.onEvict = onEvict;
}

add(elm: TType) {
Expand All @@ -32,6 +34,13 @@ class EvictableList<TType> {
evict() {
const keyToEvict = this.list.keys().next().value;
if (keyToEvict != null) {
const onEvict = this.onEvict;
if (onEvict) {
const value = this.list.get(keyToEvict);
if (value !== undefined) {
onEvict(value);
}
}
this.list.delete(keyToEvict);
}
}
Expand Down