[router] move typed-routes logic into expo-router #26578

marklawlor · 2024-01-22T05:05:04Z

Why

Recreation of #25654. I'm splitting that PR into two PRs.

Move typed-routes logic
Refactor Expo Router so the code-base and typed routes shared the same definition file.

I've also removed the custom directory-traversal logic and switched to using getRoutes() directly. This is in preparation of
#26507 which fixes issue with the type generation.

Close ENG-10759

How

Previous

Typed routes used its own directory walk logic to generate the paths for typed routes.
All logic lives in @expo/cli

new

@expo/clichecks for the existence of expo-router/build/typed-routes. If so, it uses it instead of the current logic.
The updated functions call getRoutes() and traverse the RouteNode instead of the file-system.

Test Plan

This PR only tests the integration between getRoutes() and the expo-router.d.ts. The next PR will add type tests that are in #25654

Checklist

Documentation is up to date to reflect these changes (eg: https://docs.expo.dev and README.md).
Conforms with the Documentation Writing Style Guide
This diff will work correctly for npx expo prebuild & EAS Build (eg: updated a module plugin).

marklawlor · 2024-01-22T21:34:00Z

packages/@expo/cli/src/start/server/type-generation/routes.ts

+    options.projectRoot,
+    'expo-router/build/typed-routes'
+  );
+  return typedRoutesModule ? typedRoutes(typedRoutesModule, options) : legacyTypedRoutes(options);


We switch to the expo-router version if available

marklawlor · 2024-01-22T21:36:35Z

packages/expo-router/src/getRoutes.ts

@@ -383,6 +384,8 @@ export function assertDuplicateRoutes(filenames: string[]) {

 /** Given a Metro context module, return an array of nested routes. */
 export function getRoutes(contextModule: RequireContext, options?: Options): RouteNode | null {
+  options = { importMode: EXPO_ROUTER_IMPORT_MODE, ...options };


Typed routes need to force async loading, so this option can now be overridden.

marklawlor · 2024-01-22T21:37:36Z

packages/expo-router/src/testing-library/require-context-ponyfill.ts

+interface RequireContextPonyFill extends RequireContext {
+  __add(file: string): void;
+  __delete(file: string): void;
+}


I don't want to rebuild the context every time a file changes, so I added these methods to modify the context.

marklawlor · 2024-01-22T21:39:13Z

packages/expo-router/tsconfig.json

+    "types": [
+      "jest",
+      "jest-require",
+      "node"


typed-routes use node:fs and node:path, so I added node to the types. We could also remove this can just ts-ignore the imports.

marklawlor · 2024-01-22T21:41:35Z

packages/expo-router/types/expo-router.d.ts

@@ -0,0 +1,345 @@
+/* eslint-disable */


This is a new centralised location for Expo Router types that can be shared by both the code-base and typed routes. After this is merged, I'd adjust the expo-router package to use these types.

packages/expo-router/src/matchers.tsx

packages/@expo/cli/src/start/server/type-generation/routes.ts

EvanBacon · 2024-01-22T22:10:27Z

packages/@expo/cli/src/start/server/type-generation/routes.ts

+
+  const typedRoutesModule = require(typedRoutesModulePath);
+
+  if (metro && server) {


Should probably be an assertion

I think I prefer adding a comment explaining why these values could be false.

packages/@expo/cli/src/start/server/type-generation/routes.ts

linear · 2024-01-29T22:03:43Z

ENG-10759 Ensure generated type exports match expo-router standard exports

Co-authored-by: Expo Bot <34669131+expo-bot@users.noreply.github.com>

# Why The logic introduced in #26578 breaks router for all platforms in development only.  # How  # Test Plan  # Checklist  - [ ] Documentation is up to date to reflect these changes (eg: https://docs.expo.dev and README.md). - [ ] Conforms with the [Documentation Writing Style Guide](https://github.com/expo/expo/blob/main/guides/Expo%20Documentation%20Writing%20Style%20Guide.md) - [ ] This diff will work correctly for `npx expo prebuild` & EAS Build (eg: updated a module plugin). --------- Co-authored-by: Expo Bot <34669131+expo-bot@users.noreply.github.com>

expo-bot added the bot: suggestions ExpoBot has some suggestions label Jan 22, 2024

github-actions bot added the bot: fingerprint compatible label Jan 22, 2024

expo-bot added bot: passed checks ExpoBot has nothing to complain about and removed bot: suggestions ExpoBot has some suggestions labels Jan 22, 2024

github-actions bot added bot: fingerprint changed and removed bot: fingerprint compatible labels Jan 22, 2024

marklawlor commented Jan 22, 2024

View reviewed changes

marklawlor marked this pull request as ready for review January 22, 2024 21:43

marklawlor requested review from EvanBacon and byCedric as code owners January 22, 2024 21:43

EvanBacon reviewed Jan 22, 2024

View reviewed changes

packages/expo-router/src/matchers.tsx Outdated Show resolved Hide resolved

EvanBacon reviewed Jan 22, 2024

View reviewed changes

packages/@expo/cli/src/start/server/type-generation/routes.ts Show resolved Hide resolved

EvanBacon reviewed Jan 22, 2024

View reviewed changes

marklawlor force-pushed the marklawlor/typed-routes-rewrite branch from 577c3b3 to 62d9c44 Compare January 23, 2024 02:33

github-actions bot added bot: fingerprint compatible bot: fingerprint changed and removed bot: fingerprint changed bot: fingerprint compatible labels Jan 23, 2024

marklawlor force-pushed the marklawlor/typed-routes-rewrite branch from 781ab12 to 3c0b988 Compare January 24, 2024 00:44

EvanBacon reviewed Jan 25, 2024

View reviewed changes

packages/@expo/cli/src/start/server/type-generation/routes.ts Outdated Show resolved Hide resolved

marklawlor force-pushed the marklawlor/typed-routes-rewrite branch from eeeac35 to d02796e Compare January 29, 2024 00:59

github-actions bot added bot: fingerprint compatible and removed bot: fingerprint changed labels Jan 29, 2024

marklawlor force-pushed the marklawlor/typed-routes-rewrite branch 2 times, most recently from 9dbb76b to 6d5952d Compare January 30, 2024 00:46

EvanBacon approved these changes Feb 5, 2024

View reviewed changes

marklawlor force-pushed the marklawlor/typed-routes-rewrite branch 2 times, most recently from 136055c to 2c30c89 Compare February 12, 2024 08:11

expo-bot added bot: suggestions ExpoBot has some suggestions and removed bot: passed checks ExpoBot has nothing to complain about labels Feb 12, 2024

marklawlor and others added 15 commits February 12, 2024 19:03

[router] create typed route helpers that use getRoutes()

b4f2464

build and changelog

6b1d8ec

add expo-router.d.ts

f9bad26

Update packages/@expo/cli/CHANGELOG.md

472ca3d

Co-authored-by: Expo Bot <34669131+expo-bot@users.noreply.github.com>

Update packages/expo-router/CHANGELOG.md

e387ccf

Co-authored-by: Expo Bot <34669131+expo-bot@users.noreply.github.com>

switch to requireContext ponyfill

57af8ac

revert change to _ctx.js

3b95d2b

cleanup

f059876

revert _ctx changes

f458912

pr feedback

7af6965

rewrite _ctx-shared as commonjs

5853e0a

add test for spaces

7790a5c

cleanup comment

1affd2c

update tests after merge

aafc5b5

rebuild

b8deb57

marklawlor force-pushed the marklawlor/typed-routes-rewrite branch from 00784a3 to b8deb57 Compare February 12, 2024 09:04

Update packages/expo-router/CHANGELOG.md

559c057

Co-authored-by: Expo Bot <34669131+expo-bot@users.noreply.github.com>

expo-bot added bot: passed checks ExpoBot has nothing to complain about and removed bot: suggestions ExpoBot has some suggestions labels Feb 12, 2024

marklawlor merged commit 41c27d3 into main Feb 12, 2024
11 checks passed

marklawlor deleted the marklawlor/typed-routes-rewrite branch February 12, 2024 20:42

marklawlor mentioned this pull request Feb 15, 2024

Sitemap route is untyped in Expo Router v3 / Expo 50 #26796

Closed

EvanBacon mentioned this pull request Feb 22, 2024

Fix issue with skipping all imports. #27238

Merged

3 tasks

brentvatne added the published Changes from the PR have been published to npm label Apr 18, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[router] move typed-routes logic into expo-router #26578

[router] move typed-routes logic into expo-router #26578

marklawlor commented Jan 22, 2024 •

edited

marklawlor Jan 22, 2024

marklawlor Jan 22, 2024

marklawlor Jan 22, 2024

marklawlor Jan 22, 2024

marklawlor Jan 22, 2024

EvanBacon Jan 22, 2024

marklawlor Jan 23, 2024

linear bot commented Jan 29, 2024


		const typedRoutesModule = require(typedRoutesModulePath);

		if (metro && server) {

[router] move typed-routes logic into expo-router #26578

[router] move typed-routes logic into expo-router #26578

Conversation

marklawlor commented Jan 22, 2024 • edited

Why

How

Test Plan

Checklist

marklawlor Jan 22, 2024

Choose a reason for hiding this comment

marklawlor Jan 22, 2024

Choose a reason for hiding this comment

marklawlor Jan 22, 2024

Choose a reason for hiding this comment

marklawlor Jan 22, 2024

Choose a reason for hiding this comment

marklawlor Jan 22, 2024

Choose a reason for hiding this comment

EvanBacon Jan 22, 2024

Choose a reason for hiding this comment

marklawlor Jan 23, 2024

Choose a reason for hiding this comment

linear bot commented Jan 29, 2024

marklawlor commented Jan 22, 2024 •

edited