feat(cli): cloud cli commands (v4) #20119

nathan-pichon · 2024-04-15T13:29:41Z

What does it do?

This pull request introduces new commands to the Strapi CLI for interacting with Strapi Cloud:

strapi login: This command allows users to log in to their Strapi Cloud application directly from the command line.
strapi logout: This command enables users to log out of their currently authenticated Strapi Cloud session.
strapi deploy: This command provides a streamlined way to deploy the local Strapi project directly to Strapi Cloud.
These functionalities aim to enhance the developer experience by simplifying authentication and deployment workflows for Strapi Cloud users and providing a seamless hosting solution for Strapi CMS users.

Important Update to create-strapi-app CLI:

Previously, when creating a new Strapi project using create-strapi-app, there was no option to directly connect to a Strapi Cloud project. This pull request also introduces changes to the create-strapi-app command. Users will now be prompted during project creation if they want to create and log in to a new Strapi Cloud project. This simplifies the workflow for developers who intend to deploy their Strapi project to Strapi Cloud from the very beginning.

⚠️ As an MVP restriction, for now, only trial project can be created and managed from the deploy command ⚠️

Why is it needed?

Streamlining deployments: The deploy command automates the deployment process, allowing developers to push their local project to Strapi Cloud directly from the CLI.

How to test it?

Login: Use the strapi login command to authenticate with your Strapi Cloud account. You'll likely be prompted for your credentials during this process (Google / GitHub or GitLab login providers ATM).
Deploy: Ensure you have a local Strapi project ready, you must be able to deploy a trial project (never had any project on Strapi Cloud). Use the strapi deploy command to deploy your project to Strapi Cloud. Verify that the deployment process was completed successfully and your application is accessible on Strapi Cloud.
Logout: User the strapi logout command to disconnect the CLI from your Strapi Cloud account. The strapi deploy should not work after being logged out.

Related issue(s)/PR(s)

Let us know if this is related to any issue/pull request

packages/core/strapi/src/commands/actions/cloud/create-project/action.ts

packages/core/strapi/src/commands/actions/cloud/deploy-project/action.ts

packages/core/strapi/src/commands/actions/cloud/utils/token.ts

vercel · 2024-04-15T13:41:34Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
contributor-docs	❌ Failed (Inspect)			May 7, 2024 10:18am

packages/core/strapi/src/commands/actions/cloud/config/api.ts

packages/core/strapi/src/commands/actions/cloud/deploy-project/action.ts

packages/core/strapi/src/commands/actions/cloud/create-project/action.ts

Co-authored-by: Ben Irvin <ben.irvin@strapi.io>

alexandrebodin

Overall looks good 👍

A nice improvement would be to add the "deploy" in the generate package.json script so you can run

yarn deploy, & add it in the log at the end of the creation CLI

alexandrebodin · 2024-04-26T12:47:11Z

packages/cli/cloud/src/config/api.ts

+import { env } from '@strapi/utils';
+
+export const apiConfig = {
+  apiBaseUrl: env('STRAPI_CLI_CLOUD_API', 'https://cli.cloud.strapi.io'),


side note: libraries should avoid using env vars and get that as an input param unless it's a debug env var

Considering this will be just a way to test we can live with it. @innerdvations wdyt of a specific prefix for all hardcoded env var ? STRAPI_DEBUG 🤔

That sounds fine to me. STRAPI_ will already be reserved for us, so if we want to call STRAPI_DEBUG_ the debugging prefix it won't cause any issues.

alexandrebodin · 2024-04-26T12:51:04Z

packages/cli/cloud/src/config/local.ts

+export function getTmpStoragePath() {
+  const storagePath = path.join(os.tmpdir(), APP_FOLDER_NAME);
+  if (!checkDirectoryExists(storagePath)) {
+    fs.mkdirSync(storagePath, { recursive: true });


we use fs-extra everywhere in the codebase you could use the ensure fn directly

alexandrebodin · 2024-04-26T12:53:36Z

packages/cli/cloud/src/config/local.ts

+}
+
+function getConfigPath() {
+  const configDirs = XDGAppPaths(APP_FOLDER_NAME).configDirs();


what would be the advantage ? we are not storing a pwd but just a temp access token 🤔

side note, Also this CLI could be used to automate deployment so we need to support tokens via the CLI in the CI.

alexandrebodin · 2024-04-26T12:55:50Z

packages/cli/cloud/src/config/local.ts

+  }
+}
+
+export function saveLocalConfig(data: LocalConfig) {


Can we make all those file manipulation async instead ?

alexandrebodin · 2024-04-26T12:57:09Z

packages/cli/cloud/src/create-project/action.ts

+      case 403:
+        logger.error(
+          error.response.data ||
+            'You do not have permission to create a project. Please contact support for assistance.'


in what case would you get a forbidden considering we do not really have an authorization system ?

packages/cli/cloud/src/services/logger.ts

alexandrebodin · 2024-04-26T13:11:36Z

packages/cli/cloud/src/services/strapi-info-save.ts

+  project?: ProjectInfos;
+};
+
+export function save(data: LocalSave, { directoryPath }: { directoryPath?: string } = {}) {


Same comment on using async fs methods instead

alexandrebodin · 2024-04-26T13:12:46Z

packages/cli/cloud/src/utils/helpers.ts

@@ -0,0 +1,43 @@
+import chalk from 'chalk';


Can you add a //TODO to remove the duplicated code later with a share CLI pkg or sth

packages/cli/create-strapi-app/src/create-strapi-app.ts

alexandrebodin · 2024-04-26T13:20:49Z

Should we move "loadPkg" and "logger" to strapi/utils ?

Probably beyond the scope of this PR, but yeah, I think we need a generic logger to use for all these cases outside of Strapi. We've reinvented the wheel about 10 times already.

This should definitely be part of the CLI context passed to all commands 👍 but it goes beyond that as a topic for the CLI API overall

innerdvations · 2024-04-26T13:28:01Z

packages/cli/cloud/src/config/local.ts

+}
+
+function getConfigPath() {
+  const configDirs = XDGAppPaths(APP_FOLDER_NAME).configDirs();


It would allow the user control the security level on the token and keeps it encrypted.

For example, I think most systems would allow users to configure their keychain to ask for verification before the token is accessed (so, someone sitting down at their system couldn't deploy without re-entering password/fingerprint/whatever). But I think what we're doing here is still secure enough for most cases.

I do think a separation by project would be extremely helpful though, otherwise someone with multiple clients on Strapi cloud would have to log in and out between each project, or accidentally attempt to deploy a project with the wrong account (though I assume it wouldn't work).

Alternatively, a login manager to switch between them, but that's a huge feature in itself 😆

innerdvations · 2024-04-26T13:34:19Z

packages/cli/cloud/src/utils/tests/compress-files.test.ts

+import { isIgnoredFile } from '../compress-files';
+
+describe('isIgnoredFile', () => {
+  const folderPath = os.tmpdir(); // Use the system's temporary directory as a dummy folder path


You could use mock-fs here to avoid real effects in the test runs

fyi we use memfs already

Oh yeah, that one, I misremembered which one we used 😆

…ject

joshuaellis

minor feedback

joshuaellis · 2024-04-29T12:09:27Z

packages/cli/cloud/README.md

Shall we document here what commands are available?

Makes me think, don't we have in the contrbiuting guide the CLI command list too ? worth it if the others are listed.

joshuaellis · 2024-04-29T12:15:07Z

packages/cli/cloud/src/create-project/action.ts

+        );
+        return;
+      case 400:
+        logger.error('Invalid input. Please check your inputs and try again.');


I think we can improve this error message, it's really vague. Do you not return a good error message from the API you can utilise?

joshuaellis · 2024-04-29T12:15:27Z

packages/cli/cloud/src/create-project/action.ts

+    }
+  }
+  logger.error(
+    'We encountered an issue while creating your project. Please try again in a moment. If the problem persists, contact support for assistance.'


Should you propose using the debug flag to find more info?

joshuaellis · 2024-04-29T12:15:53Z

packages/cli/cloud/src/create-project/action.ts

+
+  logger.debug(JSON.stringify(error));
+  if (error instanceof AxiosError) {
+    switch (error.response?.status) {


If it's 5XX should we handle it to show it's our problem not theres? at the moment it's not clear imo

joshuaellis · 2024-04-29T12:17:12Z

packages/cli/cloud/src/deploy-project/action.ts

+      ctx.logger.log('📦 Project compressed successfully!');
+    } catch (error: unknown) {
+      ctx.logger.error(
+        '⚠️ Project compression failed. Try again later or check for large/incompatible files.'


why would trying again later do anything different here?

joshuaellis · 2024-04-29T12:18:19Z

packages/cli/cloud/src/deploy-project/action.ts

+          ctx.logger.error(error.response.data);
+        }
+      } else {
+        ctx.logger.error('An error occurred while deploying the project. Please try again later.');


Should we propose individuals use the debug option to learn more about their issue?

joshuaellis · 2024-04-29T12:21:52Z

packages/cli/cloud/src/utils/compress-files.ts

+import * as path from 'path';
+import { minimatch } from 'minimatch';
+
+const IGNORED_PATTERNS = [


Why blocklist over allowlist? 🤔

Allowing custom user code / resources

+ Update types

…i cli

nathan-pichon added source: cli Source is cli package pr: feature This PR adds a new feature echoes/type: feature Effort to deliver new features, significant feature changes and new functionality labels Apr 15, 2024

nathan-pichon self-assigned this Apr 15, 2024

nathan-pichon changed the title ~~Feat: cloud cli commands (v4)~~ feat(cli): cloud cli commands (v4) Apr 15, 2024

nathan-pichon commented Apr 15, 2024

View reviewed changes

vercel bot had a problem deploying to Preview – contributor-docs April 15, 2024 13:45 Failure

vercel bot had a problem deploying to Preview – contributor-docs April 15, 2024 14:00 Failure

vercel bot had a problem deploying to Preview – contributor-docs April 15, 2024 15:55 Failure

nathan-pichon commented Apr 15, 2024

View reviewed changes

packages/core/strapi/src/commands/actions/cloud/config/api.ts Outdated Show resolved Hide resolved

nathan-pichon commented Apr 15, 2024

View reviewed changes

packages/core/strapi/src/commands/actions/cloud/deploy-project/action.ts Outdated Show resolved Hide resolved

vercel bot had a problem deploying to Preview – contributor-docs April 15, 2024 16:21 Failure

vercel bot had a problem deploying to Preview – contributor-docs April 15, 2024 16:23 Failure

vercel bot had a problem deploying to Preview – contributor-docs April 16, 2024 07:55 Failure

vercel bot had a problem deploying to Preview – contributor-docs April 16, 2024 09:10 Failure

gonbaum reviewed Apr 16, 2024

View reviewed changes

packages/core/strapi/src/commands/actions/cloud/create-project/action.ts Outdated Show resolved Hide resolved

vercel bot had a problem deploying to Preview – contributor-docs April 16, 2024 15:49 Failure

vercel bot had a problem deploying to Preview – contributor-docs April 17, 2024 10:06 Failure

vercel bot had a problem deploying to Preview – contributor-docs April 17, 2024 10:19 Failure

vercel bot had a problem deploying to Preview – contributor-docs April 18, 2024 08:59 Failure

vercel bot deployed to Preview – contributor-docs April 23, 2024 08:15 View deployment

nathan-pichon force-pushed the feature/cloud-cli branch from b544834 to eaed54e Compare April 23, 2024 14:22

vercel bot had a problem deploying to Preview – contributor-docs April 23, 2024 14:47 Failure

nathan-pichon force-pushed the feature/cloud-cli branch from eaed54e to 42d0785 Compare April 23, 2024 14:58

vercel bot had a problem deploying to Preview – contributor-docs April 23, 2024 15:28 Failure

vercel bot had a problem deploying to Preview – contributor-docs April 24, 2024 12:45 Failure

nathan-pichon force-pushed the feature/cloud-cli branch from 755dda4 to 3a2e3f9 Compare April 24, 2024 14:08

vercel bot deployed to Preview – contributor-docs April 24, 2024 14:24 View deployment

vercel bot had a problem deploying to Preview – contributor-docs April 25, 2024 13:25 Failure

chore(cloud-cli): add help on login command

30e5267

Co-authored-by: Ben Irvin <ben.irvin@strapi.io>

alexandrebodin requested changes Apr 26, 2024

View reviewed changes

vercel bot had a problem deploying to Preview – contributor-docs April 26, 2024 13:22 Failure

innerdvations reviewed Apr 26, 2024

View reviewed changes

nathan-pichon added 3 commits April 26, 2024 18:08

fix(cloud-cli): typing

d1cb1ad

fix(cloud-cli): update return types and data properties

9ed73cb

fix(cloud-cli): update compress to use relative path

0034ed4

vercel bot had a problem deploying to Preview – contributor-docs April 26, 2024 16:13 Failure

fix(cloud-cli): build logs

ec8d767

vercel bot had a problem deploying to Preview – contributor-docs April 26, 2024 16:59 Failure

fix(cloud-cli): use name property of project instead of displayName

3b8cc96

vercel bot had a problem deploying to Preview – contributor-docs April 29, 2024 08:43 Failure

fix(cloud-cli): create-strapi-app quickstart should ask for cloud pro…

254a2c3

…ject

vercel bot had a problem deploying to Preview – contributor-docs April 29, 2024 09:28 Failure

joshuaellis reviewed Apr 29, 2024

View reviewed changes

fix: typo login

e9ea177

vercel bot had a problem deploying to Preview – contributor-docs May 2, 2024 14:17 Failure

feat: display logged account email

6fb4194

vercel bot had a problem deploying to Preview – contributor-docs May 3, 2024 11:45 Failure

feat: config constants

d742115

vercel bot had a problem deploying to Preview – contributor-docs May 3, 2024 13:43 Failure

nathan-pichon added 2 commits May 3, 2024 17:52

fix(cloud-cli): rollback

c356506

chore(cli-logger): use predefined objects for silent options

65fddb3

vercel bot had a problem deploying to Preview – contributor-docs May 7, 2024 08:10 Failure

nathan-pichon added 4 commits May 7, 2024 12:13

fix(cli): update mock for silent spinner log

192d569

fix(cloud-cli): update build cli function + debug & silent options

b05d050

+ Update types

fix(cloud-cli): on deploy, spinner should fail when timeout occurs

c53c609

chore(cloud-cli): update how cloud cli commands are imported in strap…

08f9419

…i cli

vercel bot had a problem deploying to Preview – contributor-docs May 7, 2024 10:18 Failure

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(cli): cloud cli commands (v4) #20119

feat(cli): cloud cli commands (v4) #20119

nathan-pichon commented Apr 15, 2024 •

edited

vercel bot commented Apr 15, 2024 •

edited

alexandrebodin left a comment

alexandrebodin Apr 26, 2024

innerdvations Apr 26, 2024

alexandrebodin Apr 26, 2024

alexandrebodin Apr 26, 2024

alexandrebodin Apr 26, 2024

alexandrebodin Apr 26, 2024

alexandrebodin Apr 26, 2024

alexandrebodin Apr 26, 2024

alexandrebodin commented Apr 26, 2024

innerdvations Apr 26, 2024

innerdvations Apr 26, 2024

alexandrebodin Apr 26, 2024

innerdvations Apr 29, 2024

joshuaellis left a comment

joshuaellis Apr 29, 2024

alexandrebodin Apr 29, 2024

joshuaellis Apr 29, 2024

joshuaellis Apr 29, 2024

joshuaellis Apr 29, 2024

joshuaellis Apr 29, 2024

joshuaellis Apr 29, 2024

joshuaellis Apr 29, 2024

joshuaellis Apr 29, 2024

alexandrebodin Apr 29, 2024

feat(cli): cloud cli commands (v4) #20119

Are you sure you want to change the base?

feat(cli): cloud cli commands (v4) #20119

Conversation

nathan-pichon commented Apr 15, 2024 • edited

What does it do?

Important Update to create-strapi-app CLI:

Why is it needed?

How to test it?

Related issue(s)/PR(s)

vercel bot commented Apr 15, 2024 • edited

alexandrebodin 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

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

alexandrebodin commented Apr 26, 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

joshuaellis 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

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

Choose a reason for hiding this comment

nathan-pichon commented Apr 15, 2024 •

edited

vercel bot commented Apr 15, 2024 •

edited