Headless Init and Configure #371

UnleashedMind · 2018-10-30T00:58:58Z

Headless init and configure command implemented.
--yes flag implemented for the init command.
Simplified the project-config.json file content structure

Use the following two bash shell scripts as examples to test the headless execution of the init and configure commands
packages/amplify-cli/tests/amplify-helpers/headless-init.sh
packages/amplify-cli/tests/amplify-helpers/headless-config.sh

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

kaustavghosh06

I think changes to 'packages/amplify-frontend-ios' is missing completly in this PR.

kaustavghosh06 · 2018-10-31T17:10:01Z

packages/amplify-category-hosting/lib/S3AndCloudFront/helpers/configure-Publish.js

-    const amplifyRC = JSON.parse(fs.readFileSync(amplifyRCFilePath, 'utf8'));
-    result = amplifyRC[PublishIgnoreRCLabel];
+    try {
+      const amplifyRC = require(amplifyRCFilePath);


We're getting rid of the amplifyRC file with the new multi-env design. Need a strategy to take this ignore publish into account.

kaustavghosh06 · 2018-10-31T17:12:16Z

packages/amplify-category-hosting/lib/S3AndCloudFront/helpers/configure-Publish.js

+      const amplifyRC = require(amplifyRCFilePath);
+      result = amplifyRC[PublishIgnoreRCLabel];
+    } catch (e) {
+      result = undefined;


You don't need to set it to undefined here. By default result would be undefined.

This might be because of a lint complaint, but in this function is changed in the new implementation

kaustavghosh06 · 2018-10-31T17:58:35Z

packages/amplify-cli/src/lib/init-steps/s0-analyzeProject.js

+/* Begin getProjectName */
+async function getProjectName(context) {
+  let projectName;
+  if (context.exeInfo.inputParams.amplify && context.exeInfo.inputParams.amplify.projectName) {


This would break if I don't pass any params? Since inputParams would be undefined or inputParams.amplify might be undefined?

it's guaranteed by the CLI at the beginning of the command execution.

kaustavghosh06 · 2018-10-31T18:00:54Z

packages/amplify-cli/src/lib/init-steps/s0-analyzeProject.js

-    context.exeInfo.metaData = {
-    };
+function normalizeProjectName(projectName) {
+  if (!projectName) {


when would this branch get hit? I assume process.cwd() would always be defined?

kaustavghosh06 · 2018-10-31T18:03:37Z

packages/amplify-cli/src/lib/init-steps/s0-analyzeProject.js

+/* Begin getEditor */
+async function getEditor(context) {
+  let editor;
+  if (context.exeInfo.inputParams.amplify && context.exeInfo.inputParams.amplify.editor) {


Same as above-this would break the CLI if I don't pass any params? Since inputParams would be undefined or inputParams.amplify might be undefined?

inputParams is guaranteed by the cli at the beginning of the execution.

kaustavghosh06 · 2018-10-31T20:43:47Z

packages/amplify-frontend-javascript/lib/configuration-manager.js

+      context.exeInfo.projectConfig[constants.Label].config =
+          frameworkConfigMapping[inputParams.framework];
+    }
+  } else if (!context.exeInfo.inputParams.yes) {


Same as above. Shouldn't be using the yes flag to go into this branch.

kaustavghosh06 · 2018-10-31T20:46:54Z

packages/amplify-provider-awscloudformation/.eslintrc.json

@@ -4,7 +4,8 @@
    	"no-param-reassign": "off",
        "no-shadow": "off",
    	"no-return-await" : "off",
-    	"no-continue": "off",
+		"no-continue": "off",
+		"no-plusplus": "off",


This shouldn't be off. Its inconsistent with other packages style. Style-wise it is recommended to use i +=1 rather than i++.

kaustavghosh06 · 2018-10-31T20:47:59Z

packages/amplify-cli/tests/amplify-helpers/headless-config.sh

+\"region\":\"us-east-1\"\
+}"
+AWSCLOUDFORMATION="{\
+\"configLevel\":\"project\",\


This param doesn't make a lot of sense to the user. Should be replaced or inferred form other flags/params.

This can be removed, and by default the configuration is done on the project level. e.g. if the user doesn't know about it, it's not going to hurt him.

kaustavghosh06 · 2018-10-31T20:49:11Z

packages/amplify-provider-awscloudformation/lib/configuration-manager.js

 async function init(context) {
-  context.projectConfigInfo = {};
+  normalizeInputParams(context);
+  context.exeInfo.awsConfigInfo = {


Really hard to infer as to what the configLevel means.

see above comments, the user can ignore it if he does not know about it, and it won't hurt him, by default it's on the project level,

kaustavghosh06 · 2018-10-31T20:50:20Z

packages/amplify-provider-awscloudformation/lib/configuration-manager.js

+    const inputParams = context.exeInfo.inputParams[constants.Label];
+    Object.assign(awsConfigInfo, inputParams);
+  } else if (awsConfigInfo.configLevel === 'project' &&
+          !context.exeInfo.inputParams.yes) {


Same as above. User doesn't need to explicitly mention yes flag.

this is needed, without the yes flag it's the normal init workflow. because the cli then needs to gather information from the user.

kaustavghosh06

I think changes to 'packages/amplify-frontend-ios' is missing completly in this PR.

yuth

As a general thing can we write an wrapper around inquirer which takes the if something is running in headless mode, the argument that was passed in the command line which would be the default value.

Something akin to this implementation

function inquireWhenNotHeadless(questions, commandlineParams, isHeadless) {
    if (isHeadless) {
        const result = {};
        questions.forEach((question) => {
            const { name, default as defaultValue } = question;
            result[name] = commandLineParams[name] || defaultValue;
        } )
        return result;
   }
   
   return inquirer.prompt(questions);
   
}

packages/amplify-cli/src/lib/config-steps/c1-configFrontend.js

yuth · 2018-10-31T20:40:11Z

packages/amplify-cli/src/lib/config-steps/c1-configFrontend.js

+  }
+
+  if (!frontend && context.exeInfo.inputParams.yes) {
+    frontend = 'javascript';


Shouldn't this be the default frontend?

yuth · 2018-10-31T20:53:00Z

packages/amplify-cli/src/lib/init-steps/s0-analyzeProject.js

+/* Begin getProjectName */
+async function getProjectName(context) {
+  let projectName;
+  if (context.exeInfo.inputParams.amplify && context.exeInfo.inputParams.amplify.projectName) {


May be its better to use a util like loadash _.at

yuth · 2018-10-31T21:09:10Z

packages/amplify-cli/tests/amplify-helpers/headless-init.sh

+--amplify $AMPLIFY \
+--javascript $JAVASCRIPT \
+--aws $AWSCLOUDFORMATION \
+--yes


Instead of --yes can we change this to --headless

yuth · 2018-10-31T21:54:59Z

packages/amplify-cli/tests/amplify-helpers/headless-config.sh

@@ -0,0 +1,38 @@
+#!/bin/bash


Could we also add support for . config params and normalize them to an object. For instance amplify config could be written as below

amplify configure project \ --amplify.projectName "$PROJECTNAME" --amplify.defaultEditor "$EDITOR" --amplify.prioiders awscloudformation --amplify.frontend javascript --javascript $JAVASCRIPT \ --awscloudformation $AWSCLOUDFORMATION

I think this might be a good idea since passing complex values on command line is messy.

yuth · 2018-10-31T21:59:12Z

packages/amplify-cli/tests/amplify-helpers/headless-init.sh

@@ -0,0 +1,39 @@
+#!/bin/bash


Can we use the default values if in headless mode if values are not passed. For instance, user should be able to skip if they are using create-react-app

REACTCONFIG="{\ \"SourceDir\":\"src\",\ \"DistributionDir\":\"build\",\ \"BuildCommand\":\"npm run-script build\",\ \"StartCommand\":\"npm run-script start\"\ }"

yuth · 2018-10-31T22:01:32Z

packages/amplify-frontend-android/lib/configuration-manager.js

+  const inputParams = context.exeInfo.inputParams[constants.Label];
+  if (inputParams) {
+    Object.assign(context.exeInfo.projectConfig[constants.Label], inputParams);
+  } else if (!context.exeInfo.inputParams.yes) {


Conversely it should infer the default values when it is running in headless mode

UnleashedMind · 2018-11-01T21:00:44Z

ios frontend:
right now the ios frontend does not have any init and configure logic, so it's not in the headless implementation.
yes flag:
it's a CLI convention to use yes flag to suppress prompt and use default.
general philosophy:
If there is a yes flag, use default and no prompt.
If there is not a yes flag, take the input parameter.
If neither yes flag nor input parameter is present, prompt user for input.
the two scripts are examples, not all fields are required at the same time, e.g. if useProfile is set to true, then profileName is required but accesskey fields are not required. If all fields are present, then even if the yes flag is not there, the command will execute without any prompt.

kaustavghosh06

Great work. Looks good :D

* init headless * add headless for javascript frontend * setup headless for android frontend * move publish ignore to a file inside hosting folder * move publish ignore out of amplifyrc file

github-actions · 2021-05-25T22:03:12Z

This pull request has been automatically locked since there hasn't been any recent activity after it was closed. Please open a new issue for related bugs.

Looking for a help forum? We recommend joining the Amplify Community Discord server *-help channels for those types of questions.

UnleashedMind added 23 commits October 19, 2018 17:23

init headless

ded83ba

work in progress

ff9a953

work in progress

75f0b20

work in progress

f7311d7

work in progress

2529553

work in progress

b125239

work in progress

8755cd7

work in progress

a962d69

work in progress

8ca73d5

add headless for javascript frontend

e6af06a

setup headless for android frontent

88b7fee

work in progress

bfe1e67

through lint

c5ab2b8

work in progress

382b0ae

tested

84f0daa

work in progress

9b5f468

tested and through lint

f317cc4

minor fix

bb27ec7

work in progress

f08c62e

work in progress

079026c

through lint

9fa4fe7

work in progress

d3de2d1

work in progress

56e9882

ghost assigned UnleashedMind Oct 30, 2018

ghost added the review label Oct 30, 2018

UnleashedMind requested review from kaustavghosh06 and mlabieniec October 30, 2018 00:59

UnleashedMind added 2 commits October 29, 2018 18:02

through lint

c7348f1

fix test

f5b4cb4

kaustavghosh06 reviewed Oct 31, 2018

View reviewed changes

kaustavghosh06 suggested changes Oct 31, 2018

View reviewed changes

kaustavghosh06 requested a review from yuth October 31, 2018 20:53

yuth reviewed Oct 31, 2018

View reviewed changes

kaustavghosh06 mentioned this pull request Nov 1, 2018

Considerations for Windows support without WSL #131

Closed

UnleashedMind added 2 commits November 1, 2018 11:50

move publish ignore to a file inside hosting folder

44587ce

move publish ignore out of amplifyrc file

5ab2a95

UnleashedMind added 5 commits November 1, 2018 14:10

minor fix

ae02b3b

change per code review request

c6156ee

through lint

19192c4

minor fix

6a40f44

through lint

1a231e6

kaustavghosh06 approved these changes Nov 2, 2018

View reviewed changes

kaustavghosh06 merged commit 098c6f0 into aws-amplify:multienv Nov 2, 2018

ghost removed the review label Nov 2, 2018

github-actions bot locked as resolved and limited conversation to collaborators May 25, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Headless Init and Configure #371

Headless Init and Configure #371

UnleashedMind commented Oct 30, 2018 •

edited

kaustavghosh06 left a comment

kaustavghosh06 Oct 31, 2018

UnleashedMind Nov 1, 2018

kaustavghosh06 Oct 31, 2018

UnleashedMind Nov 1, 2018

kaustavghosh06 Oct 31, 2018

UnleashedMind Nov 1, 2018 •

edited

kaustavghosh06 Oct 31, 2018

kaustavghosh06 Oct 31, 2018

UnleashedMind Nov 1, 2018

kaustavghosh06 Oct 31, 2018

kaustavghosh06 Oct 31, 2018

kaustavghosh06 Oct 31, 2018

UnleashedMind Nov 1, 2018

kaustavghosh06 Oct 31, 2018

UnleashedMind Nov 1, 2018

kaustavghosh06 Oct 31, 2018

UnleashedMind Nov 1, 2018

kaustavghosh06 left a comment

yuth left a comment •

edited

yuth Oct 31, 2018

UnleashedMind Nov 1, 2018

yuth Oct 31, 2018

yuth Oct 31, 2018

yuth Oct 31, 2018

UnleashedMind Nov 1, 2018

yuth Oct 31, 2018

yuth Oct 31, 2018

UnleashedMind commented Nov 1, 2018 •

edited

kaustavghosh06 left a comment

github-actions bot commented May 25, 2021

Headless Init and Configure #371

Headless Init and Configure #371

Conversation

UnleashedMind commented Oct 30, 2018 • edited

kaustavghosh06 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

UnleashedMind Nov 1, 2018 • edited

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

kaustavghosh06 left a comment

Choose a reason for hiding this comment

yuth left a comment • edited

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

UnleashedMind commented Nov 1, 2018 • edited

kaustavghosh06 left a comment

Choose a reason for hiding this comment

github-actions bot commented May 25, 2021

UnleashedMind commented Oct 30, 2018 •

edited

UnleashedMind Nov 1, 2018 •

edited

yuth left a comment •

edited

UnleashedMind commented Nov 1, 2018 •

edited