[expo-cli] add --experimental-bundle flag to 'export' command #3074

jkhales · 2021-01-11T21:34:21Z

For EAS, we are separating the creation of the bundles from their publication.

expo export does a lot of other stuff with the assumption that the user will be hosting a personal, non-EAS, static manifest and asset server.

expo export --eas strips away all of the extraneous work in expo export and introduces a standardized format to save bundles in for preparation use by eas publish.

dist
├── assets
│   └── *
├── bundles
│   ├── android.js
│   └── ios.js
└── metadata.json

Where metadata.json has type:

type Metadata = {
  version: number;
  bundler: 'metro';
  fileMetadata: {
    [key in Platform]: {
      bundle: string; 
      assets: { [key in 'path' | 'ext']: string }[]; 
    };
  };
}

This allows for easy expansion of the bundlers we support (which is the key reason for the separation of the bundling and the publishing). The versioning allows us to accommodate dramatic format changes.

Test Plan:
run:
expo export --experimental-bundle and confirm it creates the new file structure.
expo export --public-url test.com and confirm it creates the old file structure.

fson

Thanks, this looks good! Left a few comments/questions below.

packages/expo-cli/src/commands/bundle.ts

fson

EvanBacon

if this is supposed to be part of EAS, it should maybe be in EAS?
if this shares a majority of features with export, then it should share code too.
I'm not sure why we need two CLI commands for generating the static output of a project, this should really be consolidated.
we want to limit the amount of commands in the expo-cli since there are already a ton and the --help prompt is too large.

brentvatne

i agree with @EvanBacon that we should hide this from --help for now. we may want to consolidate expo export into this command and put it behind a flag (or the other way around), ping me on slack and we can chat about that more

packages/expo-cli/src/commands/bundle.ts

jkhales · 2021-01-14T13:17:13Z

if this is supposed to be part of EAS, it should maybe be in EAS?

There is a big push to seperate the bundler from EAS. @fson, @ide, and @ccheever have suggested going even further in the future and allowing arbitrary bundlers (not included in expo-cli) with an expo plugin.

if this shares a majority of features with export, then it should share code too.

Agreed. I made sure to reuse the relevant code from expo export. See, for example, the reuse of buildPublishBundlesAsync: https://github.com/expo/expo-cli/pull/3074/files#diff-3b46ddce3f17b5ba410e409f3404d47ddbb44c0a45fa865ff8f0cf5404190ed7R71

I'm not sure why we need two CLI commands for generating the static output of a project, this should really be consolidated.

I initially started writing this as a flag for expo export. I stopped as expo export does more than just create a bundle (for example it modifies the plist) and its output is tailored to the assumption that the user will be hosting the update from a static server.

Note: "hosting an update from a static server" is different from "generating the static output":

Hosting on a static server means we create the manifest as well as the bundles and that the client's plist looks for the manifest along a different route */android-index.json or */ios-index.json.

Creating just the static output means the bundles and the assets. But we also wanted to add some metadata about the assets (their extension) as that is required for the way we store assets in EAS (thus the metadata.json file). I also added versioning and the bundler name to this file in preparation for issues with multi-bundler support.

Combining these commands is possible, but because the output is rather different it seems confusing for the user and from the maintenance perspective the code becomes littered with if/else statements.

jkhales · 2021-01-14T13:19:20Z

i agree with @EvanBacon that we should hide this from --help for now. we may want to consolidate expo export into this command and put it behind a flag (or the other way around), ping me on slack and we can chat about that more

cool, pinged you on slack!

jkhales · 2021-01-18T20:46:59Z

packages/xdl/src/Project.ts

 ): Promise<void> {
+  const absoluteOutputDir = path.resolve(process.cwd(), outputDir);


This used to be called right before ExportAppAsync. I brought it inside and replaced the relevant outputDir with absoluteOutputDir.

jkhales · 2021-01-18T20:48:01Z

packages/xdl/src/Project.ts

@@ -1586,7 +1651,7 @@ export async function startReactNativeServerAsync({
      _logPackagerOutput(projectRoot, 'error', data);
    }
  });
-  const exitPromise = new Promise((resolve, reject) => {
+  const exitPromise = new Promise<void>((resolve, reject) => {


(Unrelated typescript error that I tacked onto this PR)

jkhales · 2021-01-18T20:50:37Z

packages/xdl/src/Project.ts

-    },
-  };
+  // Skip the hooks and manifest creation if building for EAS.
+  if (!eas) {


Everything in this if statement is copied over from before. Because if (options.dumpSourcemap) got shifted above the "hooks" block it looks like more change than it is.

jkhales · 2021-01-18T20:58:06Z

@EvanBacon @brentvatne changed from a new command to a flag!

ide · 2021-01-19T01:09:02Z

The flag name looks fine for a temporary option but ideally the exported format would be largely compatible with any host.

old:
expo publish: publish to classic Expo updates
expo export: command for self-hosting classic Expo updates

new:
expo export --eas: there is no difference between Expo-hosting and self-hosting; there is just hosting. command for exporting an update that can be uploaded to EAS or to any other compatible server. EAS-specific details are the responsibility of eas-cli.

jkhales · 2021-01-19T14:08:28Z

The flag name looks fine for a temporary option but ideally the exported format would be largely compatible with any host.

old:
expo publish: publish to classic Expo updates
expo export: command for self-hosting classic Expo updates

new:
expo export --eas: there is no difference between Expo-hosting and self-hosting; there is just hosting. command for exporting an update that can be uploaded to EAS or to any other compatible server. EAS-specific details are the responsibility of eas-cli.

Good point, talking with @jonsamp about this a bit and maybe --bundle would work? 😅

ide · 2021-01-19T17:29:59Z

tbh I think the right path is to work towards making it the default to export the EAS-compatible update format. The old format just needs to stick around to not break existing workflows. Don't need to get there right away but the new format works for all conformant hosts - EAS and otherwise - so there eventually won't be a need for old "expo export" behavior except for compat reasons.

packages/expo-cli/src/commands/export.ts

packages/xdl/src/Project.ts

packages/xdl/src/ProjectAssets.ts

EvanBacon

looks good but at least add a test plan to the PR description

Co-authored-by: Ville Immonen <ville.immonen@iki.fi>

jkhales mentioned this pull request Jan 11, 2021

[eas-cli] rework expected bundle format for eas publish expo/eas-cli#196

Merged

jkhales requested a review from fson January 11, 2021 21:58

jkhales marked this pull request as ready for review January 12, 2021 00:22

fson reviewed Jan 12, 2021

View reviewed changes

jkhales requested a review from fson January 12, 2021 21:34

fson approved these changes Jan 12, 2021

View reviewed changes

EvanBacon suggested changes Jan 14, 2021

View reviewed changes

brentvatne suggested changes Jan 14, 2021

View reviewed changes

packages/expo-cli/src/commands/bundle.ts Outdated Show resolved Hide resolved

jkhales commented Jan 18, 2021

View reviewed changes

jkhales changed the title ~~[expo-cli] add bundle command~~ [expo-cli] add --eas flag to 'export' command Jan 18, 2021

jkhales requested review from brentvatne, fson and EvanBacon January 18, 2021 20:57

EvanBacon reviewed Jan 20, 2021

View reviewed changes

packages/expo-cli/src/commands/export.ts Outdated Show resolved Hide resolved

EvanBacon reviewed Jan 20, 2021

View reviewed changes

packages/xdl/src/Project.ts Outdated Show resolved Hide resolved

EvanBacon reviewed Jan 20, 2021

View reviewed changes

packages/xdl/src/Project.ts Outdated Show resolved Hide resolved

EvanBacon reviewed Jan 20, 2021

View reviewed changes

packages/xdl/src/ProjectAssets.ts Outdated Show resolved Hide resolved

jkhales requested a review from EvanBacon January 20, 2021 21:20

EvanBacon approved these changes Jan 20, 2021

View reviewed changes

Jonathan 小林 Hales added 3 commits January 20, 2021 14:23

[expo-cli] add bundle command

7957873

rework metadata layout

a8264da

revert buildBundlesAsync

18e0841

Jonathan 小林 Hales and others added 14 commits January 20, 2021 14:23

small tweaks

28470ef

fix build

5fe1024

fix build, add comment

3ebd7d9

Update packages/expo-cli/src/commands/bundle.ts

8db449d

Co-authored-by: Ville Immonen <ville.immonen@iki.fi>

Update packages/expo-cli/src/commands/bundle.ts

b35ce2f

Co-authored-by: Ville Immonen <ville.immonen@iki.fi>

fix imports

70824d5

fix version type

72e7800

handle empty assets

4962c01

expo export --eas first draft

e354de8

consolidate into exportAppAsync

4ef4723

clean up old diffs

ef06cca

fix logger placemnet

9b8662c

some last changes

2dc467c

evan feedback

f6f90e1

jkhales force-pushed the @jkhales/add-bundle-command branch from 527c5df to f6f90e1 Compare January 20, 2021 22:24

jkhales changed the title ~~[expo-cli] add --eas flag to 'export' command~~ [expo-cli] add --experimental-bundle flag to 'export' command Jan 20, 2021

jkhales merged commit 1c778c1 into master Jan 20, 2021

jkhales deleted the @jkhales/add-bundle-command branch January 20, 2021 22:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[expo-cli] add --experimental-bundle flag to 'export' command #3074

[expo-cli] add --experimental-bundle flag to 'export' command #3074

jkhales commented Jan 11, 2021 •

edited

Loading

fson left a comment

fson left a comment

EvanBacon left a comment •

edited

Loading

brentvatne left a comment •

edited

Loading

jkhales commented Jan 14, 2021

jkhales commented Jan 14, 2021

jkhales Jan 18, 2021

jkhales Jan 18, 2021

jkhales Jan 18, 2021

jkhales commented Jan 18, 2021

ide commented Jan 19, 2021

jkhales commented Jan 19, 2021

ide commented Jan 19, 2021

EvanBacon left a comment

		): Promise<void> {
		const absoluteOutputDir = path.resolve(process.cwd(), outputDir);

[expo-cli] add --experimental-bundle flag to 'export' command #3074

[expo-cli] add --experimental-bundle flag to 'export' command #3074

Conversation

jkhales commented Jan 11, 2021 • edited Loading

fson left a comment

Choose a reason for hiding this comment

fson left a comment

Choose a reason for hiding this comment

EvanBacon left a comment • edited Loading

Choose a reason for hiding this comment

brentvatne left a comment • edited Loading

Choose a reason for hiding this comment

jkhales commented Jan 14, 2021

jkhales commented Jan 14, 2021

jkhales Jan 18, 2021

Choose a reason for hiding this comment

jkhales Jan 18, 2021

Choose a reason for hiding this comment

jkhales Jan 18, 2021

Choose a reason for hiding this comment

jkhales commented Jan 18, 2021

ide commented Jan 19, 2021

jkhales commented Jan 19, 2021

ide commented Jan 19, 2021

EvanBacon left a comment

Choose a reason for hiding this comment

jkhales commented Jan 11, 2021 •

edited

Loading

EvanBacon left a comment •

edited

Loading

brentvatne left a comment •

edited

Loading