Remove all public const enums; export maps instead (with typings to strings) #5022

sam-gc · 2021-06-14T18:02:13Z

This PR removes public const enums (which are inaccessible to JS anyway) and moves any (public) reference to those types to simply string. Instead, we export maps that can be used to reference acceptable values (but these are not used internally to aid tree shaking)

Fixes #5012

changeset-bot · 2021-06-14T18:02:16Z

⚠️ No Changeset found

Latest commit: 375c307

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

google-oss-bot · 2021-06-14T20:49:40Z

Binary Size Report

Affected SDKs

@firebase/auth

Type Base (5473957) Head (253e05d) Diff

browser 181 kB 181 kB +109 B (+0.1%)

main 181 kB 181 kB +109 B (+0.1%)

module 181 kB 181 kB +109 B (+0.1%)
firebase

Type Base (5473957) Head (253e05d) Diff

firebase-auth.js 177 kB 177 kB +107 B (+0.1%)

firebase.js 891 kB 891 kB +107 B (+0.0%)

Test Logs

Base (5473957f): https://github.com/firebase/firebase-js-sdk/actions/runs/926895462
Head (253e05d3): https://github.com/firebase/firebase-js-sdk/actions/runs/940254794

google-oss-bot · 2021-06-14T20:54:13Z

Size Analysis Report

Affected Products

`@firebase/analytics-exp`

`getAnalytics`

Size Table

Type	Base (`5473957`)	Head (`253e05d`)	Diff
size	9.10 kB	9.58 kB	+477 B (+5.2%)
size-with-ext-deps	27.8 kB	28.2 kB	+480 B (+1.7%)

Dependency Table

Type Base (5473957) Head (253e05d) Diff

functions

22 dependencies

attemptFetchDynamicConfigWithRetry
factory
fetchDynamicConfig
fetchDynamicConfigWithRetry
findGtagScriptOnPage
getAnalytics
getHeaders
getOrCreateDataLayer
gtagOnConfig
gtagOnEvent
initializeAnalytics
insertScriptTag
isRetriableError
logEvent
logEvent$1
promiseAllSettled
registerAnalytics
setAbortableTimeout
validateIndexedDB
warnOnBrowserContextMismatch
wrapGtag
wrapOrCreateGtag

23 dependencies

attemptFetchDynamicConfigWithRetry
factory
fetchDynamicConfig
fetchDynamicConfigWithRetry
findGtagScriptOnPage
getAnalytics
getHeaders
getOrCreateDataLayer
gtagOnConfig
gtagOnEvent
initializeAnalytics
initializeAnalytics$1
insertScriptTag
isRetriableError
logEvent
logEvent$1
promiseAllSettled
registerAnalytics
setAbortableTimeout
validateIndexedDB
warnOnBrowserContextMismatch
wrapGtag
wrapOrCreateGtag

+ initializeAnalytics$1

`initializeAnalytics`

Size Table

Type	Base (`5473957`)	Head (`253e05d`)	Diff
size	?	9.47 kB	? (?)
size-with-ext-deps	?	27.5 kB	? (?)

Dependency Table

Type	Base (`5473957`)	Head (`253e05d`)	Diff
functions	?	21 dependencies attemptFetchDynamicConfigWithRetry factory fetchDynamicConfig fetchDynamicConfigWithRetry findGtagScriptOnPage getHeaders getOrCreateDataLayer gtagOnConfig gtagOnEvent initializeAnalytics insertScriptTag isRetriableError logEvent logEvent$1 promiseAllSettled registerAnalytics setAbortableTimeout validateIndexedDB warnOnBrowserContextMismatch wrapGtag wrapOrCreateGtag	?
classes	?	AnalyticsAbortSignal AnalyticsService RetryData	?
variables	?	22 dependencies ANALYTICS_TYPE BASE_INTERVAL_MILLIS DYNAMIC_CONFIG_URL ERRORS ERROR_FACTORY FETCH_TIMEOUT_MILLIS GA_FID_KEY GTAG_URL LONG_RETRY_FACTOR ORIGIN_KEY dataLayerName defaultRetryData dynamicConfigPromisesList globalInitDone gtagCoreFunction gtagName initializationPromisesMap logger measurementIdToAppId name version wrappedGtagFunction	?
enums	?		?

External Dependency Table

Module	Base (`5473957`)	Head (`253e05d`)	Diff
`@firebase/app-exp`	?	_getProvider _registerComponent registerVersion	?
`@firebase/logger`	?	Logger	?
`@firebase/util`	?	ErrorFactory FirebaseError areCookiesEnabled calculateBackoffMillis getModularInstance isBrowserExtension isIndexedDBAvailable validateIndexedDBOpenable	?
`@firebase/component`	?	Component	?

isSupported
Size Table
Type Base (5473957) Head (253e05d) Diff
size
9.13 kB
9.45 kB
+314 B (+3.4%)
size-with-ext-deps
27.2 kB
27.5 kB
+314 B (+1.2%)
logEvent
Size Table
Type Base (5473957) Head (253e05d) Diff
size
8.99 kB
9.30 kB
+314 B (+3.5%)
size-with-ext-deps
27.1 kB
27.4 kB
+314 B (+1.2%)
setAnalyticsCollectionEnabled
Size Table
Type Base (5473957) Head (253e05d) Diff
size
9.15 kB
9.47 kB
+314 B (+3.4%)
size-with-ext-deps
27.2 kB
27.5 kB
+314 B (+1.2%)
setCurrentScreen
Size Table
Type Base (5473957) Head (253e05d) Diff
size
9.24 kB
9.55 kB
+314 B (+3.4%)
size-with-ext-deps
27.3 kB
27.6 kB
+314 B (+1.2%)
setUserId
Size Table
Type Base (5473957) Head (253e05d) Diff
size
9.22 kB
9.54 kB
+314 B (+3.4%)
size-with-ext-deps
27.3 kB
27.6 kB
+314 B (+1.2%)
setUserProperties
Size Table
Type Base (5473957) Head (253e05d) Diff
size
9.30 kB
9.61 kB
+314 B (+3.4%)
size-with-ext-deps
27.4 kB
27.7 kB
+314 B (+1.1%)
settings
Size Table
Type Base (5473957) Head (253e05d) Diff
size
9.12 kB
9.43 kB
+314 B (+3.4%)
size-with-ext-deps
27.2 kB
27.5 kB
+314 B (+1.2%)

`@firebase/auth-exp`

`ActionCodeOperation`

Size Table

Type	Base (`5473957`)	Head (`253e05d`)	Diff
size	?	29.7 kB	? (?)
size-with-ext-deps	?	40.9 kB	? (?)

Dependency Table

Type	Base (`5473957`)	Head (`253e05d`)	Diff
functions	?	47 dependencies _assert _castAuth _createError _emulatorUrl _fail _getBrowserName _getClientVersion _getCurrentScheme _getFinalTarget _getInstance _getUserLanguage _initializeAuthInstance _isAndroid _isBlackBerry _isChromeIOS _isFirefox _isHttpOrHttps _isIEMobile _isOnline _isSafari _isWebOS _logError _logoutIfInvalidated _makeTaggedError _parseToken _performApiRequest _performFetchWithErrorHandling _persistenceKeyName _prodErrorMap _reloadWithoutSaving _tokenExpiresIn assertStringOrUndefined createErrorInternal debugAssert debugFail deleteAccount extractProviderData getAccountInfo getIdTokenResult getVersionForPlatform isUserInvalidated mergeProviderData registerAuth reload requestStsToken secondsStringToMilliseconds utcTimestampToDateString	?
classes	?	12 dependencies AuthImpl AuthInterop Delay FetchProvider InMemoryPersistence NetworkTimeout PersistenceUserManager ProactiveRefresh StsTokenManager Subscription UserImpl UserMetadata	?
variables	?	13 dependencies ActionCodeOperation DEFAULT_API_TIMEOUT_MS NETWORK_TIMEOUT NETWORK_TIMEOUT_DELAY PING_TIMEOUT SERVER_ERROR_MAP _DEFAULT_AUTH_ERROR_FACTORY _POLL_WINDOW_CLOSE_TIMEOUT inMemoryPersistence instanceCache logClient name version	?
enums	?		?

External Dependency Table

Module	Base (`5473957`)	Head (`253e05d`)	Diff
`@firebase/app-exp`	?	SDK_VERSION _registerComponent registerVersion	?
`@firebase/util`	?	ErrorFactory FirebaseError base64Decode createSubscribe getModularInstance getUA isBrowserExtension isMobileCordova isReactNative querystring	?
`@firebase/logger`	?	LogLevel Logger	?
`tslib`	?	__rest	?
`@firebase/component`	?	Component	?

`FactorId`

Size Table

Type	Base (`5473957`)	Head (`253e05d`)	Diff
size	?	29.5 kB	? (?)
size-with-ext-deps	?	40.7 kB	? (?)

Dependency Table

Type	Base (`5473957`)	Head (`253e05d`)	Diff
functions	?	47 dependencies _assert _castAuth _createError _emulatorUrl _fail _getBrowserName _getClientVersion _getCurrentScheme _getFinalTarget _getInstance _getUserLanguage _initializeAuthInstance _isAndroid _isBlackBerry _isChromeIOS _isFirefox _isHttpOrHttps _isIEMobile _isOnline _isSafari _isWebOS _logError _logoutIfInvalidated _makeTaggedError _parseToken _performApiRequest _performFetchWithErrorHandling _persistenceKeyName _prodErrorMap _reloadWithoutSaving _tokenExpiresIn assertStringOrUndefined createErrorInternal debugAssert debugFail deleteAccount extractProviderData getAccountInfo getIdTokenResult getVersionForPlatform isUserInvalidated mergeProviderData registerAuth reload requestStsToken secondsStringToMilliseconds utcTimestampToDateString	?
classes	?	12 dependencies AuthImpl AuthInterop Delay FetchProvider InMemoryPersistence NetworkTimeout PersistenceUserManager ProactiveRefresh StsTokenManager Subscription UserImpl UserMetadata	?
variables	?	13 dependencies DEFAULT_API_TIMEOUT_MS FactorId NETWORK_TIMEOUT NETWORK_TIMEOUT_DELAY PING_TIMEOUT SERVER_ERROR_MAP _DEFAULT_AUTH_ERROR_FACTORY _POLL_WINDOW_CLOSE_TIMEOUT inMemoryPersistence instanceCache logClient name version	?
enums	?		?

External Dependency Table

Module	Base (`5473957`)	Head (`253e05d`)	Diff
`@firebase/app-exp`	?	SDK_VERSION _registerComponent registerVersion	?
`@firebase/util`	?	ErrorFactory FirebaseError base64Decode createSubscribe getModularInstance getUA isBrowserExtension isMobileCordova isReactNative querystring	?
`@firebase/logger`	?	LogLevel Logger	?
`tslib`	?	__rest	?
`@firebase/component`	?	Component	?

`OperationType`

Size Table

Type	Base (`5473957`)	Head (`253e05d`)	Diff
size	?	29.5 kB	? (?)
size-with-ext-deps	?	40.7 kB	? (?)

Dependency Table

Type	Base (`5473957`)	Head (`253e05d`)	Diff
functions	?	47 dependencies _assert _castAuth _createError _emulatorUrl _fail _getBrowserName _getClientVersion _getCurrentScheme _getFinalTarget _getInstance _getUserLanguage _initializeAuthInstance _isAndroid _isBlackBerry _isChromeIOS _isFirefox _isHttpOrHttps _isIEMobile _isOnline _isSafari _isWebOS _logError _logoutIfInvalidated _makeTaggedError _parseToken _performApiRequest _performFetchWithErrorHandling _persistenceKeyName _prodErrorMap _reloadWithoutSaving _tokenExpiresIn assertStringOrUndefined createErrorInternal debugAssert debugFail deleteAccount extractProviderData getAccountInfo getIdTokenResult getVersionForPlatform isUserInvalidated mergeProviderData registerAuth reload requestStsToken secondsStringToMilliseconds utcTimestampToDateString	?
classes	?	12 dependencies AuthImpl AuthInterop Delay FetchProvider InMemoryPersistence NetworkTimeout PersistenceUserManager ProactiveRefresh StsTokenManager Subscription UserImpl UserMetadata	?
variables	?	13 dependencies DEFAULT_API_TIMEOUT_MS NETWORK_TIMEOUT NETWORK_TIMEOUT_DELAY OperationType PING_TIMEOUT SERVER_ERROR_MAP _DEFAULT_AUTH_ERROR_FACTORY _POLL_WINDOW_CLOSE_TIMEOUT inMemoryPersistence instanceCache logClient name version	?
enums	?		?

External Dependency Table

Module	Base (`5473957`)	Head (`253e05d`)	Diff
`@firebase/app-exp`	?	SDK_VERSION _registerComponent registerVersion	?
`@firebase/util`	?	ErrorFactory FirebaseError base64Decode createSubscribe getModularInstance getUA isBrowserExtension isMobileCordova isReactNative querystring	?
`@firebase/logger`	?	LogLevel Logger	?
`tslib`	?	__rest	?
`@firebase/component`	?	Component	?

`ProviderId`

Size Table

Type	Base (`5473957`)	Head (`253e05d`)	Diff
size	?	29.6 kB	? (?)
size-with-ext-deps	?	40.8 kB	? (?)

Dependency Table

Type	Base (`5473957`)	Head (`253e05d`)	Diff
functions	?	47 dependencies _assert _castAuth _createError _emulatorUrl _fail _getBrowserName _getClientVersion _getCurrentScheme _getFinalTarget _getInstance _getUserLanguage _initializeAuthInstance _isAndroid _isBlackBerry _isChromeIOS _isFirefox _isHttpOrHttps _isIEMobile _isOnline _isSafari _isWebOS _logError _logoutIfInvalidated _makeTaggedError _parseToken _performApiRequest _performFetchWithErrorHandling _persistenceKeyName _prodErrorMap _reloadWithoutSaving _tokenExpiresIn assertStringOrUndefined createErrorInternal debugAssert debugFail deleteAccount extractProviderData getAccountInfo getIdTokenResult getVersionForPlatform isUserInvalidated mergeProviderData registerAuth reload requestStsToken secondsStringToMilliseconds utcTimestampToDateString	?
classes	?	12 dependencies AuthImpl AuthInterop Delay FetchProvider InMemoryPersistence NetworkTimeout PersistenceUserManager ProactiveRefresh StsTokenManager Subscription UserImpl UserMetadata	?
variables	?	13 dependencies DEFAULT_API_TIMEOUT_MS NETWORK_TIMEOUT NETWORK_TIMEOUT_DELAY PING_TIMEOUT ProviderId SERVER_ERROR_MAP _DEFAULT_AUTH_ERROR_FACTORY _POLL_WINDOW_CLOSE_TIMEOUT inMemoryPersistence instanceCache logClient name version	?
enums	?		?

External Dependency Table

Module	Base (`5473957`)	Head (`253e05d`)	Diff
`@firebase/app-exp`	?	SDK_VERSION _registerComponent registerVersion	?
`@firebase/util`	?	ErrorFactory FirebaseError base64Decode createSubscribe getModularInstance getUA isBrowserExtension isMobileCordova isReactNative querystring	?
`@firebase/logger`	?	LogLevel Logger	?
`tslib`	?	__rest	?
`@firebase/component`	?	Component	?

`SignInMethod`

Size Table

Type	Base (`5473957`)	Head (`253e05d`)	Diff
size	?	29.6 kB	? (?)
size-with-ext-deps	?	40.8 kB	? (?)

Dependency Table

Type	Base (`5473957`)	Head (`253e05d`)	Diff
functions	?	47 dependencies _assert _castAuth _createError _emulatorUrl _fail _getBrowserName _getClientVersion _getCurrentScheme _getFinalTarget _getInstance _getUserLanguage _initializeAuthInstance _isAndroid _isBlackBerry _isChromeIOS _isFirefox _isHttpOrHttps _isIEMobile _isOnline _isSafari _isWebOS _logError _logoutIfInvalidated _makeTaggedError _parseToken _performApiRequest _performFetchWithErrorHandling _persistenceKeyName _prodErrorMap _reloadWithoutSaving _tokenExpiresIn assertStringOrUndefined createErrorInternal debugAssert debugFail deleteAccount extractProviderData getAccountInfo getIdTokenResult getVersionForPlatform isUserInvalidated mergeProviderData registerAuth reload requestStsToken secondsStringToMilliseconds utcTimestampToDateString	?
classes	?	12 dependencies AuthImpl AuthInterop Delay FetchProvider InMemoryPersistence NetworkTimeout PersistenceUserManager ProactiveRefresh StsTokenManager Subscription UserImpl UserMetadata	?
variables	?	13 dependencies DEFAULT_API_TIMEOUT_MS NETWORK_TIMEOUT NETWORK_TIMEOUT_DELAY PING_TIMEOUT SERVER_ERROR_MAP SignInMethod _DEFAULT_AUTH_ERROR_FACTORY _POLL_WINDOW_CLOSE_TIMEOUT inMemoryPersistence instanceCache logClient name version	?
enums	?		?

External Dependency Table

Module	Base (`5473957`)	Head (`253e05d`)	Diff
`@firebase/app-exp`	?	SDK_VERSION _registerComponent registerVersion	?
`@firebase/util`	?	ErrorFactory FirebaseError base64Decode createSubscribe getModularInstance getUA isBrowserExtension isMobileCordova isReactNative querystring	?
`@firebase/logger`	?	LogLevel Logger	?
`tslib`	?	__rest	?
`@firebase/component`	?	Component	?

Test Logs

packages-exp/auth-exp/src/model/enum_maps.ts

Feiyang1 · 2021-06-16T00:10:23Z

common/api-review/auth-exp.api.md

@@ -20,18 +20,18 @@ export interface ActionCodeInfo {
        multiFactorInfo?: MultiFactorInfo | null;
        previousEmail?: string | null;
    };
-    operation: ActionCodeOperation;
+    operation: string;


We can use string literal unions to make it more type safe, using something like

typeof ActionCodeOperation[keyof typeof ActionCodeOperation]

We can apply the same to other places.

Done (where appropriate)

ProviderId and SignInMethod should remain string. Updated the others.

sam-gc added 2 commits June 14, 2021 10:58

Remove external const enums

4d9ee4c

Formatting

40b2605

sam-gc requested review from Feiyang1 and yuchenshi June 14, 2021 18:02

sam-gc assigned yuchenshi Jun 14, 2021

sam-gc requested review from avolkovi, hiranya911 and hsubox76 as code owners June 14, 2021 18:02

sam-gc added 2 commits June 14, 2021 11:04

Small fixes

f714d11

Fix compat build

8b30abb

yuchenshi approved these changes Jun 15, 2021

View reviewed changes

packages-exp/auth-exp/src/model/enum_maps.ts Outdated Show resolved Hide resolved

PR feedback

4195817

yuchenshi approved these changes Jun 15, 2021

View reviewed changes

sam-gc assigned egilmorez Jun 15, 2021

sam-gc requested a review from egilmorez June 15, 2021 19:04

Feiyang1 reviewed Jun 16, 2021

View reviewed changes

Feiyang1 assigned sam-gc Jun 17, 2021

sam-gc added 2 commits June 18, 2021 09:22

PR feedback

ba7f084

Formatting

375c307

sam-gc assigned Feiyang1 and unassigned sam-gc Jun 18, 2021

Feiyang1 approved these changes Jun 18, 2021

View reviewed changes

Feiyang1 merged commit be08d19 into master Jun 18, 2021

Feiyang1 deleted the sam-gc/enum branch June 18, 2021 18:45

firebase locked and limited conversation to collaborators Jul 19, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove all public const enums; export maps instead (with typings to strings) #5022

Remove all public const enums; export maps instead (with typings to strings) #5022

sam-gc commented Jun 14, 2021

changeset-bot bot commented Jun 14, 2021 •

edited

Loading

google-oss-bot commented Jun 14, 2021 •

edited

Loading

`@firebase/auth`

`firebase`

google-oss-bot commented Jun 14, 2021 •

edited

Loading

Affected Products

`@firebase/analytics-exp`

`getAnalytics`

`initializeAnalytics`

`isSupported`

`logEvent`

`setAnalyticsCollectionEnabled`

`setCurrentScreen`

`setUserId`

`setUserProperties`

`settings`

`@firebase/auth-exp`

`ActionCodeOperation`

`FactorId`

`OperationType`

`ProviderId`

`SignInMethod`

Test Logs

Feiyang1 Jun 16, 2021

sam-gc Jun 18, 2021

Remove all public const enums; export maps instead (with typings to strings) #5022

Remove all public const enums; export maps instead (with typings to strings) #5022

Conversation

sam-gc commented Jun 14, 2021

changeset-bot bot commented Jun 14, 2021 • edited Loading

⚠️ No Changeset found

google-oss-bot commented Jun 14, 2021 • edited Loading

Binary Size Report

Affected SDKs

@firebase/auth

firebase

Test Logs

google-oss-bot commented Jun 14, 2021 • edited Loading

Size Analysis Report

Affected Products

@firebase/analytics-exp

getAnalytics

initializeAnalytics

isSupported

logEvent

setAnalyticsCollectionEnabled

setCurrentScreen

setUserId

setUserProperties

settings

@firebase/auth-exp

ActionCodeOperation

FactorId

OperationType

ProviderId

SignInMethod

Test Logs

Feiyang1 Jun 16, 2021

Choose a reason for hiding this comment

sam-gc Jun 18, 2021

Choose a reason for hiding this comment

changeset-bot bot commented Jun 14, 2021 •

edited

Loading

google-oss-bot commented Jun 14, 2021 •

edited

Loading

`@firebase/auth`

`firebase`

google-oss-bot commented Jun 14, 2021 •

edited

Loading

`@firebase/analytics-exp`

`getAnalytics`

`initializeAnalytics`

`isSupported`

`logEvent`

`setAnalyticsCollectionEnabled`

`setCurrentScreen`

`setUserId`

`setUserProperties`

`settings`

`@firebase/auth-exp`

`ActionCodeOperation`

`FactorId`

`OperationType`

`ProviderId`

`SignInMethod`