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)			Jun 4, 2024 0:33am

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

strapi-cla · 2024-05-30T15:34:46Z

All committers have signed the CLA.

nathan-pichon · 2024-06-03T07:04:59Z

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

This will be added in the next iteration.

alexandrebodin · 2024-06-03T07:43:57Z

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

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


You can make all the functions async and use a then/catch at the root level anyway.

packages/cli/cloud/src/index.ts

packages/cli/cloud/src/login/action.ts

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

alexandrebodin · 2024-06-03T07:49:07Z

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

+ * using a shallow find for the package.json  and `fs` to read the file. If no package.json is found,
+ * the process will throw with an appropriate error message.
+ */
+const loadPkg = async ({ cwd, logger }: { cwd: string; logger: Logger }): Promise<object> => {


ping on this before merge

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

packages/cli/create-strapi-app/src/utils/parse-to-chalk.ts

Co-authored-by: Gonzalo Andres Garcia <nouvellegon@gmail.com> Co-authored-by: nathan-pichon <nathan.pichon@strapi.io> Co-authored-by: Abdallah M <55534657+abdallahmz@users.noreply.github.com>

innerdvations

Even though we don't have the infrastructure yet to run them "for real" it would be nice to add some CLI tests that at least verify the commands that exist.

innerdvations · 2024-06-03T12:38:46Z

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

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


Yeah, or at least I prefer the pattern used for the 403, where you can send a custom message from the cloud API and just fall back on this message.

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

innerdvations · 2024-06-03T13:15:01Z

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

+        `Project folder: ${projectFolder}\n`,
+        `Compressed filename: ${compressedFilename}`
+      );
+      await compressFilesToTar(storagePath, projectFolder, compressedFilename);


Not necessary, but it would be nice if this could throw as soon as the compressed size exceeded the limit

innerdvations · 2024-06-03T13:15:43Z

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

+    const fileStats = await fse.stat(tarFilePath);
+
+    if (fileStats.size > maxProjectFileSize) {
+      return ctx.logger.log(


We don't cleanup the tar file here

packages/cli/cloud/src/login/action.ts

innerdvations · 2024-06-03T13:30:12Z

packages/cli/cloud/src/login/command.ts

+    .description('Strapi Cloud Login')
+    .addHelpText(
+      'after',
+      '\nAfter running this command, you will be prompted to enter your authentication information.'


Just curious, do we have plans in the future to allow a non-interactive login?

What do you mean by "non-interactive"? Without a Web prompt?

innerdvations · 2024-06-03T14:57:07Z

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

+    try {
+      await saveLocalConfig(appConfig);
+    } catch (error: Error | unknown) {
+      logger.debug(error);


We supress the error here, but there are places where eraseToken() is called that seem to be expecting it to throw. Should we throw the error rather than logging, and let the caller handle it?

It looks like a default try-catch on an awaited promise. I don't think we expected anything while writing eraseToken to be honest 😅

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

innerdvations · 2024-06-03T15:12:47Z

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

+}
+
+export async function handleCloudProject(projectName: string): Promise<void> {
+  let cloudApiService = await cloudServices.cloudApiFactory();


There are several awaits here that aren't needed

What do you mean? cloudServices.cloudApiFactory() is returning a promise.

innerdvations · 2024-06-03T15:52:54Z

packages/core/strapi/src/commands/index.ts

+  for (const name of keys) {
    try {
      // Add this command to the Commander command object
-      strapiCommands[name]({ command, argv, ctx });
+      await strapiCommands[name]({ command, argv, ctx });
    } catch (e) {
      console.error(`Failed to load command ${name}`, e);
    }
-  });
+  }


Do we need building the commands to be async? I think they're all synchronous. But if it still works, I guess it doesn't really matter.

StrapiCloudCommands is an async func as we need to use FS, and Alex asked to turn it into async, to generate the deviceId and storing it in user's file system

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

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

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

vercel bot had a problem deploying to Preview – contributor-docs May 28, 2024 12:50 Failure

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

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

vercel bot deployed to Preview – contributor-docs May 30, 2024 13:38 View deployment

vercel bot had a problem deploying to Preview – contributor-docs May 30, 2024 15:36 Failure

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

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

gonbaum requested review from innerdvations, alexandrebodin and joshuaellis June 3, 2024 06:34

vercel bot had a problem deploying to Preview – contributor-docs June 3, 2024 07:08 Failure

alexandrebodin requested changes Jun 3, 2024

View reviewed changes

vercel bot had a problem deploying to Preview – contributor-docs June 3, 2024 09:51 Failure

vercel bot had a problem deploying to Preview – contributor-docs June 3, 2024 10:00 Failure

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

gonbaum force-pushed the feature/cloud-cli branch from b4d7952 to 6527077 Compare June 3, 2024 10:25

vercel bot had a problem deploying to Preview – contributor-docs June 3, 2024 10:26 Failure

gonbaum requested a review from alexandrebodin June 3, 2024 10:26

gonbaum force-pushed the feature/cloud-cli branch from 6527077 to 1bec273 Compare June 3, 2024 11:02

nathan-pichon and others added 2 commits June 3, 2024 13:02

feat(cli): add cloud commands

1bec273

Co-authored-by: Gonzalo Andres Garcia <nouvellegon@gmail.com> Co-authored-by: nathan-pichon <nathan.pichon@strapi.io> Co-authored-by: Abdallah M <55534657+abdallahmz@users.noreply.github.com>

chores: improve message at the end of cli deployment

9c4ac0f

vercel bot deployed to Preview – contributor-docs June 3, 2024 11:12 View deployment

innerdvations reviewed Jun 3, 2024

View reviewed changes

fix(cloud-cli): handle windows specificities

76e29ba

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

vercel bot had a problem deploying to Preview – contributor-docs June 3, 2024 16:04 Failure

chore(cloud-cli): remove unused logger

583a547

vercel bot had a problem deploying to Preview – contributor-docs June 4, 2024 12:33 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

strapi-cla commented May 30, 2024 •

edited

nathan-pichon commented Jun 3, 2024

alexandrebodin Jun 3, 2024

alexandrebodin Jun 3, 2024

innerdvations left a comment

innerdvations Jun 3, 2024

innerdvations Jun 3, 2024

innerdvations Jun 3, 2024

innerdvations Jun 3, 2024

nathan-pichon Jun 3, 2024

innerdvations Jun 3, 2024

nathan-pichon Jun 4, 2024

innerdvations Jun 3, 2024

nathan-pichon Jun 3, 2024

innerdvations Jun 3, 2024

nathan-pichon Jun 3, 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

strapi-cla commented May 30, 2024 • edited

nathan-pichon commented Jun 3, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

innerdvations 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

Choose a reason for hiding this comment

nathan-pichon commented Apr 15, 2024 •

edited

vercel bot commented Apr 15, 2024 •

edited

strapi-cla commented May 30, 2024 •

edited