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

[BUGFIX] do not throw on deepFreezeValue with objects with properties that are JS Proxy instances #2317

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

nikita-starostin
Copy link

Together with https://github.com/it-mukaseev we met an issue when trying to use recoil with pyodie.

pyodide is a library for running scripts in a browser, that how it is being loaded:

// creating atom
import {atom} from 'recoil';
export const pyodideAtom = atom<any>({
    key: "pyodideAtom",
    default: undefined,
});

// loading
import { loadPyodide, PyodideInterface } from "pyodide";
import { pyodideAtom } from "./appAtoms"

function usePyodide() {
    const [pyodide, setPyodide] = useRecoilState(pyodideAtom);
    useEffect(() => {
        const config = {} // pyodide config
        loadPyodide(config)
           .then((pyodideResult) => {
               // pyodideResult contains a property globals, that is not allowed to be frozen
               // e.g. Object.freeze(pyodideResult.globals) will throw an error
               // so the next line will throw an error, because `deepFreezeValue` will be called
               setPyodide(pyodideResult);
            });
    }, []);
}

the loadPyodide returns instance of pyodide, and that instance contains a property globals which is a JS Proxy, which is can not frozen.

During debugging we have found that the root issue is deepFreezeValue function, that calls Object.freeze on the proxy with not frozen target.

Proxy with not frozen target can not be frozen, so one solution is to froze the target, but that can break the handler of the Proxy behavior, so that is a bad decision. And calling the freeze on proxy with not frozen is not possible, so the only solution is to ignore proxy objects and leave up to the consumers of the package.-

@facebook-github-bot
Copy link
Contributor

Hi @nikita-starostin!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label May 10, 2024
@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants