Add eas `env:push` and `env:pull` commands #2437

khamilowicz · 2024-06-17T12:18:54Z

Why

User should be able to synchronise local environment variables with upstream.

How

added eas env:pull and eas env:push commands
eas env:pull handles sudo access to request values of sensitive variables

Test Plan

Tested manually

linear · 2024-06-17T12:18:57Z

ENG-11920 Add `eas env:push` command

github-actions · 2024-06-17T12:21:48Z

Size Change: +3.7 kB (+0.01%)

Total Size: 52.5 MB

Filename	Size	Change
`./packages/eas-cli/dist/eas-linux-x64.tar.gz`	52.5 MB	+3.7 kB (+0.01%)

_{compressed-size-action}

codecov · 2024-06-17T13:20:54Z

Codecov Report

Attention: Patch coverage is 23.88060% with 153 lines in your changes missing coverage. Please review.

Project coverage is 52.68%. Comparing base (27d0d42) to head (1f07455).

Files	Patch %	Lines
packages/eas-cli/src/commands/env/push.ts	16.86%	67 Missing and 7 partials ⚠️
packages/eas-cli/src/commands/env/pull.ts	36.12%	20 Missing and 3 partials ⚠️
packages/eas-cli/src/user/SessionManager.ts	17.86%	21 Missing and 2 partials ⚠️
packages/eas-cli/src/authUtils.ts	10.00%	8 Missing and 1 partial ⚠️
packages/eas-cli/src/commands/env/get.ts	10.00%	8 Missing and 1 partial ⚠️
...c/graphql/mutations/EnvironmentVariableMutation.ts	0.00%	3 Missing ⚠️
packages/eas-cli/src/commands/env/delete.ts	0.00%	2 Missing ⚠️
packages/eas-cli/src/commands/env/list.ts	0.00%	2 Missing ⚠️
...i/src/graphql/queries/EnvironmentVariablesQuery.ts	0.00%	2 Missing ⚠️
...ages/eas-cli/src/user/fetchSessionSecretAndUser.ts	33.34%	2 Missing ⚠️
... and 4 more

Additional details and impacted files

@@                                   Coverage Diff                                    @@
##           piotrekszeremeta/eng-11913-add-eas-envcreate-command    #2437      +/-   ##
========================================================================================
- Coverage                                                 52.94%   52.68%   -0.25%     
========================================================================================
  Files                                                       542      545       +3     
  Lines                                                     20063    20247     +184     
  Branches                                                   4101     4136      +35     
========================================================================================
+ Hits                                                      10620    10665      +45     
- Misses                                                     8630     8755     +125     
- Partials                                                    813      827      +14

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

packages/eas-cli/src/authUtils.ts

packages/eas-cli/src/commands/env/pull.ts

packages/eas-cli/src/commands/env/push.ts

szdziedzic

I'm not an expert on our auth/sudo system. Let's ask for the @wschurman review as well.

packages/eas-cli/src/user/SessionManager.ts

packages/eas-cli/src/user/fetchSessionSecretAndUser.ts

szdziedzic · 2024-08-06T11:45:39Z

packages/eas-cli/src/user/SessionManager.ts

+  private async ssoSudoUpgradeAsync(): Promise<void> {
+    throw Error('Sudo upgrade with SSO is not yet supported');
+  }


We need to figure out how to handle this case. We definitely want to allow SSO clients to pull env vars.

Yep. This will need to do something similar to how SSO login is done in the CLI (using the website I believe). Can trace the SSO code in the CLI ssoLoginAsync to see how SSO auth works. Happy to dig deeper if necessary.

Would be good to stack a PR on top of this that adds SSO and then land them together.

packages/eas-cli/src/user/SessionManager.ts

packages/eas-cli/src/authUtils.ts

wschurman

Since eas-cli doesn't have feature gating and does continuous deployment it'd probably be best to have the SSO functionality ironed out in a stacked PR before landing this. Otherwise we'd risk deploying a broken experience. Though I guess since the command is new and hidden it's okay for now, we can just fast-follow with the SSO fix.

wschurman · 2024-08-08T16:57:50Z

packages/eas-cli/src/user/SessionManager.ts

+  private async ssoSudoUpgradeAsync(): Promise<void> {
+    throw Error('Sudo upgrade with SSO is not yet supported');
+  }


Would be good to stack a PR on top of this that adds SSO and then land them together.

packages/eas-cli/src/commands/env/pull.ts

packages/eas-cli/src/commands/env/push.ts

khamilowicz · 2024-08-09T13:16:35Z

@wschurman @szdziedzic Ok, I'll work on SSO. I think the flow will be similar to that of login via SSO and I'll reuse some of its logic

packages/eas-cli/src/commands/env/pull.ts

szdziedzic · 2024-08-12T11:42:47Z

packages/eas-cli/src/commands/env/get.ts

-    const { appVariables } = await EnvironmentVariablesQuery.byAppIdAsync(
-      graphqlClient,
-      projectId,
+    const { appVariables } = await EnvironmentVariablesQuery.byAppIdAsync(graphqlClient, {


Should we allow getting sensitive env vars values here as well?

yes, we allow it here

szdziedzic · 2024-08-12T11:43:56Z

packages/eas-cli/src/commands/env/list.ts

-            .appVariables
-        : await EnvironmentVariablesQuery.sharedAsync(graphqlClient, projectId);
+        ? (
+            await EnvironmentVariablesQuery.byAppIdAsync(graphqlClient, {


should we allow pulling sensitive env vars here as well?

maybe with '--include-sensitive' flag? We'll save on decrypting values when user just want to know whether a variable is defined.

packages/eas-cli/src/commands/env/pull.ts

szdziedzic · 2024-08-12T11:50:49Z

packages/eas-cli/src/authUtils.ts

+import SessionManager from './user/SessionManager';
+
+// Handle the case where a user needs to be in sudo mode to perform an action.
+export async function withSudoModeAsync<T>(


I believe it doesn't respect --non-interactive mode, right?

No, it wouldn't make sense to automatically reauthorize in non-interactive mode.

packages/eas-cli/src/commands/env/push.ts

github-actions · 2024-08-12T15:45:27Z

❌ It looks like a changelog entry is missing for this PR. You have two options: you can add it manually, or you can use the changelog bot to do it for you.
🤖 To use the bot, simply comment on this PR with the command /changelog-entry [breaking-change|new-feature|bug-fix|chore] [message].
⏩ If this PR doesn't require a changelog entry, such as if it's an internal change that doesn't affect the user experience, you can add the "no changelog" label to the PR.

szdziedzic · 2024-08-13T10:13:28Z

packages/eas-cli/src/authUtils.ts

+// Handle the case where a user needs to be in sudo mode to perform an action.
+export async function withSudoModeAsync<T>(
+  sessionManager: SessionManager,
+  graphqlQuery: () => Promise<T>
+): Promise<T> {
+  try {
+    return await graphqlQuery();
+  } catch (error: any) {
+    const isSudoError = error.graphQLErrors?.some(
+      (err: { extensions: { errorCode: string } }) =>
+        err?.extensions?.errorCode === 'SUDO_MODE_REQUIRED'
+    );
+    if (!isSudoError) {
+      throw error;
+    }
+    await sessionManager.showSudoPromptAsync({ sso: false });
+    return await graphqlQuery();
+  }
+}


Offline discussion feedback:

It seems like requiring sudo mode is problematic for now, it doesn't work for SSO auth and doesn't seem to work with --non-interactive mode, which is a big use case. For now, we decided to allow people to read sensitive env vars without sudo mode. This will require backend changes + dropping sudo logic from this PR.

khamilowicz force-pushed the piotrekszeremeta/eng-11920-add-eas-envpush-command branch from 499c5d9 to 8bd1071 Compare June 17, 2024 12:23

khamilowicz changed the title ~~Piotrekszeremeta/eng 11920 add eas envpush command~~ add eas envpush command Jun 17, 2024

khamilowicz changed the title ~~add eas envpush command~~ Add eas env:push and env:pull commands Jun 17, 2024

khamilowicz force-pushed the piotrekszeremeta/eng-11920-add-eas-envpush-command branch from 8bd1071 to db531a4 Compare June 17, 2024 13:16

khamilowicz force-pushed the piotrekszeremeta/eng-11913-add-eas-envcreate-command branch from 2b270de to 37c7b6a Compare June 17, 2024 16:38

khamilowicz force-pushed the piotrekszeremeta/eng-11920-add-eas-envpush-command branch 3 times, most recently from 05552ae to 5aa373c Compare June 19, 2024 11:00

khamilowicz force-pushed the piotrekszeremeta/eng-11913-add-eas-envcreate-command branch from 3eb0466 to f8dc407 Compare July 24, 2024 12:12

khamilowicz force-pushed the piotrekszeremeta/eng-11920-add-eas-envpush-command branch 2 times, most recently from f821dbb to 7c6f532 Compare August 1, 2024 14:51

khamilowicz force-pushed the piotrekszeremeta/eng-11913-add-eas-envcreate-command branch from f8dc407 to 114acb6 Compare August 1, 2024 15:11

khamilowicz force-pushed the piotrekszeremeta/eng-11920-add-eas-envpush-command branch 2 times, most recently from e807c8d to 70be519 Compare August 1, 2024 15:35

khamilowicz force-pushed the piotrekszeremeta/eng-11913-add-eas-envcreate-command branch 2 times, most recently from 710782b to 63928f0 Compare August 1, 2024 15:53

khamilowicz force-pushed the piotrekszeremeta/eng-11920-add-eas-envpush-command branch 3 times, most recently from 0365364 to 8d097bf Compare August 5, 2024 13:40

khamilowicz marked this pull request as ready for review August 5, 2024 13:44

khamilowicz requested review from szdziedzic and sjchmiela as code owners August 5, 2024 13:44

szdziedzic requested a review from radoslawkrzemien August 6, 2024 08:41

szdziedzic requested changes Aug 6, 2024

View reviewed changes

szdziedzic requested a review from wschurman August 6, 2024 11:51

khamilowicz requested a review from szdziedzic August 6, 2024 14:36

khamilowicz force-pushed the piotrekszeremeta/eng-11920-add-eas-envpush-command branch 2 times, most recently from f246d72 to 3ebe97d Compare August 7, 2024 16:03

khamilowicz requested a review from wschurman August 8, 2024 07:09

wschurman approved these changes Aug 8, 2024

View reviewed changes

szdziedzic requested changes Aug 8, 2024

View reviewed changes

khamilowicz force-pushed the piotrekszeremeta/eng-11920-add-eas-envpush-command branch from 3ebe97d to 50a54a8 Compare August 9, 2024 11:42

khamilowicz requested a review from szdziedzic August 9, 2024 11:43

khamilowicz force-pushed the piotrekszeremeta/eng-11913-add-eas-envcreate-command branch from 9971a16 to 54af248 Compare August 9, 2024 11:49

khamilowicz force-pushed the piotrekszeremeta/eng-11920-add-eas-envpush-command branch from 50a54a8 to c66be42 Compare August 9, 2024 11:49

khamilowicz force-pushed the piotrekszeremeta/eng-11913-add-eas-envcreate-command branch from 54af248 to 6f6faf5 Compare August 9, 2024 11:55

khamilowicz force-pushed the piotrekszeremeta/eng-11920-add-eas-envpush-command branch from c66be42 to 621c5ad Compare August 9, 2024 11:55

khamilowicz added 2 commits August 9, 2024 13:59

Implement eas env:pull and eas env:push commands

eacc9dd

Implement review suggestions

531a3f8

khamilowicz force-pushed the piotrekszeremeta/eng-11913-add-eas-envcreate-command branch from 6f6faf5 to 27d0d42 Compare August 9, 2024 11:59

khamilowicz force-pushed the piotrekszeremeta/eng-11920-add-eas-envpush-command branch from 621c5ad to 676c707 Compare August 9, 2024 11:59

khamilowicz added 2 commits August 9, 2024 15:07

Implement review suggestions

3f8749c

Allow fetching sensitive variables with env:get

a023474

khamilowicz force-pushed the piotrekszeremeta/eng-11920-add-eas-envpush-command branch from 676c707 to 3f8749c Compare August 9, 2024 13:07

khamilowicz requested a review from wschurman August 9, 2024 13:15

wschurman approved these changes Aug 9, 2024

View reviewed changes

szdziedzic requested changes Aug 12, 2024

View reviewed changes

Implement review suggestions

1f07455

khamilowicz requested a review from szdziedzic August 12, 2024 15:45

szdziedzic requested changes Aug 13, 2024

View reviewed changes

khamilowicz merged commit 1f07455 into piotrekszeremeta/eng-11913-add-eas-envcreate-command Aug 13, 2024
8 of 9 checks passed

khamilowicz deleted the piotrekszeremeta/eng-11920-add-eas-envpush-command branch August 13, 2024 13:29

khamilowicz restored the piotrekszeremeta/eng-11920-add-eas-envpush-command branch August 13, 2024 13:53

khamilowicz mentioned this pull request Aug 15, 2024

Add eas env:push and env:pull commands #2495

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add eas `env:push` and `env:pull` commands #2437

Add eas `env:push` and `env:pull` commands #2437

khamilowicz commented Jun 17, 2024 •

edited

Loading

linear bot commented Jun 17, 2024

github-actions bot commented Jun 17, 2024 •

edited

Loading

codecov bot commented Jun 17, 2024 •

edited

Loading

szdziedzic left a comment

szdziedzic Aug 6, 2024

wschurman Aug 6, 2024

wschurman Aug 8, 2024

wschurman left a comment

wschurman Aug 8, 2024

khamilowicz commented Aug 9, 2024

szdziedzic Aug 12, 2024

khamilowicz Aug 12, 2024

szdziedzic Aug 12, 2024

khamilowicz Aug 12, 2024

szdziedzic Aug 12, 2024

khamilowicz Aug 12, 2024

github-actions bot commented Aug 12, 2024

szdziedzic Aug 13, 2024

Add eas env:push and env:pull commands #2437

Add eas env:push and env:pull commands #2437

Conversation

khamilowicz commented Jun 17, 2024 • edited Loading

Why

How

Test Plan

linear bot commented Jun 17, 2024

github-actions bot commented Jun 17, 2024 • edited Loading

codecov bot commented Jun 17, 2024 • edited Loading

Codecov Report

szdziedzic left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wschurman left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

khamilowicz commented Aug 9, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Aug 12, 2024

Choose a reason for hiding this comment

Add eas `env:push` and `env:pull` commands #2437

Add eas `env:push` and `env:pull` commands #2437

khamilowicz commented Jun 17, 2024 •

edited

Loading

github-actions bot commented Jun 17, 2024 •

edited

Loading

codecov bot commented Jun 17, 2024 •

edited

Loading