Fix App Check state setting and promise clearing

[hsubox76]

Fixes #6734 (probably)?

Based on solution suggested in #6735

setState() and state usage is already pretty inconsistent throughout the App Check codebase (sometimes immutable, sometimes mutated) and I don't think the best answer is to continue mixing. Additionally, the way setState() is used depends on extending a temporary version of state that, due to a lot of async code, may be stale by the time it setState() is called.

set() is now only done once per key (a FirebaseApp) on the APP_CHECK_STATES, on initialization. Changed setState() to setIInitialState() to make this clear. The Map will now only be used to store a reference to this object, which should never be overwritten. Any further changes can be made by mutating this object's properties. getState() is changed to getStateReference() to make it clear it will just get you a reference to this object.

This seems like the best way to deal with instantly setting state on an object when it can be done through any number of dangling promises.

[changeset-bot]

🦋 Changeset detected

Latest commit: 94f9785

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

Name	Type
@firebase/app-check	Patch
@firebase/app-check-compat	Patch
firebase	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[google-oss-bot]

Size Report ¹

Affected Products

• @firebase/app-check

  Type	Base (e2a90bf)	Merge (778a3b0)	Diff
  browser	25.6 kB	25.2 kB	-365 B (-1.4%)
  esm5	30.3 kB	30.0 kB	-253 B (-0.8%)
  main	31.5 kB	31.1 kB	-385 B (-1.2%)
  module	25.6 kB	25.2 kB	-365 B (-1.4%)

• bundle

  Type	Base (e2a90bf)	Merge (778a3b0)	Diff
  app-check (CustomProvider)	36.5 kB	36.2 kB	-282 B (-0.8%)
  app-check (ReCaptchaEnterpriseProvider)	38.8 kB	38.5 kB	-364 B (-0.9%)
  app-check (ReCaptchaV3Provider)	38.8 kB	38.4 kB	-364 B (-0.9%)

• firebase

  Type	Base (e2a90bf)	Merge (778a3b0)	Diff
  firebase-app-check-compat.js	23.1 kB	22.7 kB	-422 B (-1.8%)
  firebase-app-check.js	21.8 kB	21.4 kB	-452 B (-2.1%)
  firebase-compat.js	740 kB	740 kB	-430 B (-0.1%)

Test Logs

• Base (e2a90bf): https://github.com/firebase/firebase-js-sdk/actions/runs/3370996781
• Merge (778a3b0): https://github.com/firebase/firebase-js-sdk/actions/runs/3372069144

1. https://storage.googleapis.com/firebase-sdk-metric-reports/XILDHHD9kb.html

[google-oss-bot]

Size Analysis Report ¹

Affected Products

• @firebase/app-check

  • CustomProvider

    Size

    Type	Base (e2a90bf)	Merge (778a3b0)	Diff
    size	7.72 kB	7.52 kB	-206 B (-2.7%)
    size-with-ext-deps	25.3 kB	25.1 kB	-212 B (-0.8%)

    Dependency

    Type	Base (e2a90bf)	Merge (778a3b0)	Diff
    functions	21 dependencies addTokenListener computeKey createTokenRefresher ensureActivated factory formatDummyToken getDBPromise getState getToken$2 initTokenRefresher internalFactory isValid makeDummyTokenResult notifyTokenListeners registerAppCheck removeTokenListener setState sleep write writeTokenToIndexedDB writeTokenToStorage	20 dependencies addTokenListener computeKey createTokenRefresher ensureActivated factory formatDummyToken getDBPromise getStateReference getToken$2 initTokenRefresher internalFactory isValid makeDummyTokenResult notifyTokenListeners registerAppCheck removeTokenListener sleep write writeTokenToIndexedDB writeTokenToStorage	+ getStateReference - getState - setState

  • ReCaptchaEnterpriseProvider

    Size

    Type	Base (e2a90bf)	Merge (778a3b0)	Diff
    size	11.3 kB	11.0 kB	-288 B (-2.6%)
    size-with-ext-deps	28.7 kB	28.4 kB	-294 B (-1.0%)

    Dependency

    Type	Base (e2a90bf)	Merge (778a3b0)	Diff
    functions	34 dependencies addTokenListener computeKey createTokenRefresher ensureActivated exchangeToken factory formatDummyToken getDBPromise getDurationString getExchangeRecaptchaEnterpriseTokenRequest getRecaptcha getState getToken$1 getToken$2 initTokenRefresher initializeEnterprise internalFactory isValid loadReCAPTCHAEnterpriseScript makeDiv makeDummyTokenResult notifyTokenListeners pad queueWidgetRender registerAppCheck removeTokenListener renderInvisibleWidget setBackoff setState sleep throwIfThrottled write writeTokenToIndexedDB writeTokenToStorage	33 dependencies addTokenListener computeKey createTokenRefresher ensureActivated exchangeToken factory formatDummyToken getDBPromise getDurationString getExchangeRecaptchaEnterpriseTokenRequest getRecaptcha getStateReference getToken$1 getToken$2 initTokenRefresher initializeEnterprise internalFactory isValid loadReCAPTCHAEnterpriseScript makeDiv makeDummyTokenResult notifyTokenListeners pad queueWidgetRender registerAppCheck removeTokenListener renderInvisibleWidget setBackoff sleep throwIfThrottled write writeTokenToIndexedDB writeTokenToStorage	+ getStateReference - getState - setState

  • ReCaptchaV3Provider

    Size

    Type	Base (e2a90bf)	Merge (778a3b0)	Diff
    size	11.2 kB	11.0 kB	-288 B (-2.6%)
    size-with-ext-deps	28.7 kB	28.4 kB	-294 B (-1.0%)

    Dependency

    Type	Base (e2a90bf)	Merge (778a3b0)	Diff
    functions	34 dependencies addTokenListener computeKey createTokenRefresher ensureActivated exchangeToken factory formatDummyToken getDBPromise getDurationString getExchangeRecaptchaV3TokenRequest getRecaptcha getState getToken$1 getToken$2 initTokenRefresher initializeV3 internalFactory isValid loadReCAPTCHAV3Script makeDiv makeDummyTokenResult notifyTokenListeners pad queueWidgetRender registerAppCheck removeTokenListener renderInvisibleWidget setBackoff setState sleep throwIfThrottled write writeTokenToIndexedDB writeTokenToStorage	33 dependencies addTokenListener computeKey createTokenRefresher ensureActivated exchangeToken factory formatDummyToken getDBPromise getDurationString getExchangeRecaptchaV3TokenRequest getRecaptcha getStateReference getToken$1 getToken$2 initTokenRefresher initializeV3 internalFactory isValid loadReCAPTCHAV3Script makeDiv makeDummyTokenResult notifyTokenListeners pad queueWidgetRender registerAppCheck removeTokenListener renderInvisibleWidget setBackoff sleep throwIfThrottled write writeTokenToIndexedDB writeTokenToStorage	+ getStateReference - getState - setState

  • getToken

    Size

    Type	Base (e2a90bf)	Merge (778a3b0)	Diff
    size	7.35 kB	7.15 kB	-206 B (-2.8%)
    size-with-ext-deps	24.5 kB	24.2 kB	-212 B (-0.9%)

    Dependency

    Type	Base (e2a90bf)	Merge (778a3b0)	Diff
    functions	22 dependencies addTokenListener computeKey createTokenRefresher ensureActivated factory formatDummyToken getDBPromise getState getToken getToken$2 initTokenRefresher internalFactory isValid makeDummyTokenResult notifyTokenListeners registerAppCheck removeTokenListener setState sleep write writeTokenToIndexedDB writeTokenToStorage	21 dependencies addTokenListener computeKey createTokenRefresher ensureActivated factory formatDummyToken getDBPromise getStateReference getToken getToken$2 initTokenRefresher internalFactory isValid makeDummyTokenResult notifyTokenListeners registerAppCheck removeTokenListener sleep write writeTokenToIndexedDB writeTokenToStorage	+ getStateReference - getState - setState

  • initializeAppCheck

    Size

    Type	Base (e2a90bf)	Merge (778a3b0)	Diff
    size	11.2 kB	10.9 kB	-276 B (-2.5%)
    size-with-ext-deps	35.5 kB	35.2 kB	-282 B (-0.8%)

    Dependency

    Type	Base (e2a90bf)	Merge (778a3b0)	Diff
    functions	35 dependencies _activate addTokenListener computeKey createTokenRefresher ensureActivated exchangeToken factory formatDummyToken getDBPromise getDebugState getDebugToken getExchangeDebugTokenRequest getState getToken$2 initTokenRefresher initializeAppCheck initializeDebugMode internalFactory isDebugMode isValid makeDummyTokenResult notifyTokenListeners read readDebugTokenFromIndexedDB readOrCreateDebugTokenFromStorage readTokenFromIndexedDB readTokenFromStorage registerAppCheck removeTokenListener setState sleep write writeDebugTokenToIndexedDB writeTokenToIndexedDB writeTokenToStorage	35 dependencies _activate addTokenListener computeKey createTokenRefresher ensureActivated exchangeToken factory formatDummyToken getDBPromise getDebugState getDebugToken getExchangeDebugTokenRequest getStateReference getToken$2 initTokenRefresher initializeAppCheck initializeDebugMode internalFactory isDebugMode isValid makeDummyTokenResult notifyTokenListeners read readDebugTokenFromIndexedDB readOrCreateDebugTokenFromStorage readTokenFromIndexedDB readTokenFromStorage registerAppCheck removeTokenListener setInitialState sleep write writeDebugTokenToIndexedDB writeTokenToIndexedDB writeTokenToStorage	+ getStateReference + setInitialState - getState - setState

  • onTokenChanged

    Size

    Type	Base (e2a90bf)	Merge (778a3b0)	Diff
    size	7.45 kB	7.24 kB	-206 B (-2.8%)
    size-with-ext-deps	24.5 kB	24.3 kB	-212 B (-0.9%)

    Dependency

    Type	Base (e2a90bf)	Merge (778a3b0)	Diff
    functions	22 dependencies addTokenListener computeKey createTokenRefresher ensureActivated factory formatDummyToken getDBPromise getState getToken$2 initTokenRefresher internalFactory isValid makeDummyTokenResult notifyTokenListeners onTokenChanged registerAppCheck removeTokenListener setState sleep write writeTokenToIndexedDB writeTokenToStorage	21 dependencies addTokenListener computeKey createTokenRefresher ensureActivated factory formatDummyToken getDBPromise getStateReference getToken$2 initTokenRefresher internalFactory isValid makeDummyTokenResult notifyTokenListeners onTokenChanged registerAppCheck removeTokenListener sleep write writeTokenToIndexedDB writeTokenToStorage	+ getStateReference - getState - setState

  • setTokenAutoRefreshEnabled

    Size

    Type	Base (e2a90bf)	Merge (778a3b0)	Diff
    size	7.48 kB	7.23 kB	-246 B (-3.3%)
    size-with-ext-deps	24.6 kB	24.3 kB	-253 B (-1.0%)

    Dependency

    Type	Base (e2a90bf)	Merge (778a3b0)	Diff
    functions	22 dependencies addTokenListener computeKey createTokenRefresher ensureActivated factory formatDummyToken getDBPromise getState getToken$2 initTokenRefresher internalFactory isValid makeDummyTokenResult notifyTokenListeners registerAppCheck removeTokenListener setState setTokenAutoRefreshEnabled sleep write writeTokenToIndexedDB writeTokenToStorage	21 dependencies addTokenListener computeKey createTokenRefresher ensureActivated factory formatDummyToken getDBPromise getStateReference getToken$2 initTokenRefresher internalFactory isValid makeDummyTokenResult notifyTokenListeners registerAppCheck removeTokenListener setTokenAutoRefreshEnabled sleep write writeTokenToIndexedDB writeTokenToStorage	+ getStateReference - getState - setState

Test Logs

• Base (e2a90bf): https://github.com/firebase/firebase-js-sdk/actions/runs/3370996781
• Merge (778a3b0): https://github.com/firebase/firebase-js-sdk/actions/runs/3372069144

1. https://storage.googleapis.com/firebase-sdk-metric-reports/VEnAaWpuQ7.html

[ishowta]

I think it is better than my code, but it seems to be prone to bugs because the information rewritten in the setter is not immediately reflected in the local state.

Performance may be somewhat degraded, but I thought it would be safer and more readable to stop using setter and getter and use mutex to execute the entire function exclusively.

[hsubox76]

That's true, we would have to use getState() before every reference to state to be sure. I still think whichever solution we go with should be global and not a mix of mutable and immutable state so perhaps state should just be rewritten to be directly mutable across the board, I'll take a look at doing that.

[dwyfrequency]

LGTM