fix(core): eliminate import cycles #2125
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This change eliminates two import cycles found in `@actions/core`.
These import cycles would prevent rollupjs from removing unused code
within `@actions/core`, bloating the resultant packaged js. Anecdotally,
with these changes, a project I work on that only uses core's `info` and
`setState` was reduced in size from 1.0MiB to approximately 244KiB.
- `core.ts` <-> `oidc-utils.ts`:
- `core.ts` importing from `oidc-utils.ts` for the purpose of
forming and exporting `getIDToken()`.
- `oidc-utils.ts` was importing `debug()` and `setSecret` from
`core.ts`.
- Resolved by:
- Moving `getIDToken` into `oidc-utils.ts`.
- Moving all package exports into `index.ts`, including the export
of `getIDToken`.
- `core.ts` <-> `utils.ts`:
- `core.ts` importing `toCommandProperties` and `toCommandValue` from
`utils.ts`.
- `utils.ts` importing `AnnotationProperties` from `core.ts`.
- Resolved by moving the definition of `AnnotationProperties` into
`core-type.ts`, and having `utils.ts` import from there.
Partially fixes actions#1436, where one of the import cycles were first
described.
justfalter
force-pushed
the
core-eliminate-import-loop
branch
from
4d05e28 to
9e75787
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change eliminates two import cycles found in
@actions/core. These import cycles would prevent rollupjs from removing unused code within@actions/core, bloating the resultant packaged js. Anecdotally, with these changes, a project I work on that only uses core'sinfoandsetStatewas reduced in size from 1.0MiB to approximately 244KiB.core.ts<->oidc-utils.ts:core.tsimporting fromoidc-utils.tsfor the purpose of forming and exportinggetIDToken().oidc-utils.tswas importingdebug()andsetSecretfromcore.ts.getIDTokenintooidc-utils.ts.index.ts, including the export ofgetIDToken.core.ts<->utils.ts:core.tsimportingtoCommandPropertiesandtoCommandValuefromutils.ts.utils.tsimportingAnnotationPropertiesfromcore.ts.AnnotationPropertiesintocore-type.ts, and havingutils.tsimport from there.Partially fixes #1436, where one of the import cycles were first described.