Added ask install and ask uninstall commands #466

azaan-sherani · 2023-05-03T19:12:01Z

Description of changes:

Added two new commands:
ask install --component-name - installs the specified skill component in the alexa skill
ask uninstall --component-name - removes the specified skill component from the alexa skill, if it is installed.

These changes are in beta and will require testing and additions before merging it to develop in the future.

tydonelson · 2023-05-03T19:38:13Z

Unit tests are missing. At a minimum we should have unit tests for the two new commands in /test/unit/commands/install/index-test.ts and test/unit/commands/uninstall/index-test.ts

tydonelson · 2023-05-03T19:41:00Z

lib/commands/uninstall/index.ts

+        throw err;
+        }
+
+        let skillPackageSrc = ResourcesConfig.getInstance().getSkillMetaSrc(profile);


Looks like this can be const as well

tydonelson · 2023-05-03T19:41:25Z

lib/commands/install/index.ts

+      throw err;
+    }
+
+    let skillPackageSrc = ResourcesConfig.getInstance().getSkillMetaSrc(profile);


Looks like this can be const

tydonelson · 2023-05-03T19:44:29Z

lib/commands/install/index.ts

+          path.join(componentDirPath, "README.md")
+        );
+
+        spinner.terminate(TERMINATE_STYLE.SUCCEED, `${componentName} installed successfully! \n \u001b[1mPlease edit the README.md file copied at ${skillPackageSrc}/components/${componentName} to configure the component\n`);


Can we make this more explicit that they must edit the README.md to configure the component in order to use it? This is very weakly worded as-is.

Also it seems weird to have a configuration living in a README file, those are usually informational or instructional files, not something that's functionally important to the application...

This was a silly mistake from me.
Since, right now we don't have a component on npm with the "config.jsonc" file, I was testing with the components already present on npm. For this, I temporarily used for the "README.md" instead of "config.jsonc"(to check if it's being copied/removed correctly). I forgot to change the file name back to "config.jsonc", will do it right now.

LucioMS · 2023-05-03T19:59:18Z

lib/commands/install/index.ts

+    const spinner = new SpinnerView({ color: "yellow" });
+    spinner.start(`Installing ${componentName}...`);
+
+    const installCommand = spawn("npm", ["install", componentName], {


Is this PR doing an npm install on the --component-name ? If so, I failed to see the target audience that needs help with npm install.

It's also copying the config.jsonc file to the skillPackage. This config.jsonc file needs to be configured(adding intents, for example) by the skill developer to use the component.

tydonelson

Requesting address of comments, accidentally approved before

doiron

should may add something in the README.md file to explain what these commands are and what they do.

doiron · 2023-05-03T19:28:05Z

lib/commands/uninstall/index.ts

+    async handle(cmd: Record<string, any>): Promise<void> {
+        let profile: string;
+        try {
+        profile = profileHelper.runtimeProfile(cmd.profile);


nit indentation

doiron · 2023-05-05T03:14:14Z

lib/commands/uninstall/index.ts

+
+        const skillPackageSrc = ResourcesConfig.getInstance().getSkillMetaSrc(profile);
+        if (!stringUtils.isNonBlankString(skillPackageSrc)) {
+        Messenger.getInstance().error("Skill package src is not found in ask-resources.json.");


nit: indentation

also suggest

The skill package source directory was not found in the ask-resource.json file.

One further edit, since this can occur due to a profile mismatch:

`The skill package source directory was not found in the ask-resources.json file under the profile '${profile}'.`

doiron · 2023-05-05T03:14:20Z

lib/commands/uninstall/index.ts

+        return;
+        }
+        if (!fs.existsSync(skillPackageSrc)) {
+        Messenger.getInstance().error(`File ${skillPackageSrc} does not exist.`);


nit: indentation

also skillPackageSrc is a directory right, not a file?

also skillPackageSrc is a directory right, not a file?

I think it's the skillMetadata src file. Also used here.

I believe that skillPackageSrc from the ask-resource.json file
https://github.com/alexa/ask-cli/blob/develop/lib/model/resources-config/ask-resources.js#L56

is referencing the ./skill-package/ folder. the root of the skill files that are uploaded to Alexa during creation/updates to the skill.

doiron · 2023-05-05T03:19:05Z

lib/commands/install/index.ts

+    installCommand.on("error", (err) => {
+      spinner.terminate(TERMINATE_STYLE.FAIL, `Failed to install ${componentName}.`);
+      throw new CliError(
+        `An error occurred while installing component ${componentName}: ${err.message}`


do we know what state we should be in here? what kind of errors does npm install throw and what are the mitigations?

doiron · 2023-05-05T03:20:01Z

lib/commands/install/index.ts

+      if (code !== 0) {
+        spinner.terminate(TERMINATE_STYLE.FAIL, `Failed to install ${componentName}.`);
+        throw new CliError(
+          `An error occurred while installing component ${componentName}. Please try again.`


maybe print out the error npm code and mention that npm threw this error code

doiron · 2023-05-05T03:22:20Z

lib/commands/install/index.ts

+        );
+
+        if (!fs.existsSync(componentDirPath)) {
+          fs.mkdirSync(componentDirPath, { recursive: true });


not catching any errors here?

doiron · 2023-05-05T03:22:41Z

lib/commands/install/index.ts

+          fs.mkdirSync(componentDirPath, { recursive: true });
+        }
+
+        fs.copyFileSync(


also not catching any io errors?

lib/commands/install/index.ts

+          path.join(componentDirPath, "config.jsonc")
+        );
+
+        spinner.terminate(TERMINATE_STYLE.SUCCEED, `${componentName} installed successfully! \n \u001b[1mPlease edit the config.jsonc file copied at ${skillPackageSrc}/components/${componentName} to configure the component. This step is necessary for the component to function properly within your Alexa skill.\n`);


doiron · 2023-05-05T03:24:32Z

lib/commands/option-model.json

  },
+  "component-name": {
+    "name": "component-name",
+    "description": "Name of the component to be installed.",


not sure where we landed on terminology but component here seems very generic.

suggest to use whatever word nomenclature used elsewhere like Alexa Skill reusable component...

doiron · 2023-05-05T03:24:59Z

lib/commands/uninstall/index.ts

+    }
+
+    description() {
+        return "uninstall alexa skill components from your alexa skill";


I think Alexa should be capitalized

doiron · 2023-05-05T03:27:27Z

lib/commands/uninstall/index.ts

+        // Check if the component is already installed
+        const componentDirPath = path.join(
+            skillPackageSrc,
+            "skillComponents",
+            componentName
+        );
+        const configFilePath = path.join(componentDirPath, "config.jsonc");
+
+        if (!fs.existsSync(configFilePath)) {
+            Messenger.getInstance().info(
+                `Component ${componentName} is not installed.`
+            );
+            return;
+        }


separate function

doiron · 2023-05-05T03:27:48Z

lib/commands/uninstall/index.ts

+            return;
+        }
+
+        // Uninstall the component using npm with spinner


also move to separate function

maybe move all the NPM stuff inside it's own module in the clients directory
https://github.com/alexa/ask-cli/tree/develop/lib/clients

interface npmClient {
installPackage(packageName)
unInstallPackage(packageName)
}

doiron · 2023-05-05T03:32:30Z

lib/commands/uninstall/index.ts

+        uninstallCommand.on("error", (err) => {
+            spinner.terminate(
+                TERMINATE_STYLE.FAIL,
+                `Failed to uninstall ${componentName}.`


nit: add mitigations like
"... Manually uninstall the Alexa skill component by running: npm uninstall ${componentName}"

Big +1 here, this goes for all error messages. Non-actionable error messages are not very useful.

doiron · 2023-05-05T03:32:55Z

lib/commands/uninstall/index.ts

+                `Failed to uninstall ${componentName}.`
+            );
+            throw new CliError(
+                `An error occurred while uninstalling component ${componentName}: ${err.message}`


same add mitigation message

tydonelson · 2023-05-05T17:19:51Z

lib/commands/install/index.ts

+          path.join(componentDirPath, "config.jsonc")
+        );
+
+        spinner.terminate(TERMINATE_STYLE.SUCCEED, `${componentName} installed successfully! \n \u001b[1mPlease edit the config.jsonc file copied at ${skillPackageSrc}/components/${componentName} to configure the component. This step is necessary for the component to function properly within your Alexa skill.\n`);


Thanks for the message update here, makes the necessity of this step much more apparent :)

tydonelson · 2023-05-05T17:41:32Z

lib/commands/uninstall/index.ts

+
+        const skillPackageSrc = ResourcesConfig.getInstance().getSkillMetaSrc(profile);
+        if (!stringUtils.isNonBlankString(skillPackageSrc)) {
+        Messenger.getInstance().error("Skill package src is not found in ask-resources.json.");


One further edit, since this can occur due to a profile mismatch:

`The skill package source directory was not found in the ask-resources.json file under the profile '${profile}'.`

tydonelson · 2023-05-05T17:43:29Z

lib/commands/uninstall/index.ts

+        uninstallCommand.on("error", (err) => {
+            spinner.terminate(
+                TERMINATE_STYLE.FAIL,
+                `Failed to uninstall ${componentName}.`


Big +1 here, this goes for all error messages. Non-actionable error messages are not very useful.

azaan-sherani added 2 commits May 4, 2023 00:26

Added install and uninstall commands

1b19a8d

Added install and uninstall commands

fe5a61a

azaan-sherani requested review from doiron and tydonelson May 3, 2023 19:12

azaan-sherani self-assigned this May 3, 2023

tydonelson approved these changes May 3, 2023

View reviewed changes

tydonelson self-requested a review May 3, 2023 19:46

LucioMS reviewed May 3, 2023

View reviewed changes

tydonelson requested changes May 3, 2023

View reviewed changes

azaan-sherani changed the base branch from develop to feature/im-componentization May 4, 2023 21:05

Addressed comments

b03e336

github-actions bot requested a review from LucioMS May 4, 2023 21:35

doiron reviewed May 5, 2023

View reviewed changes

tydonelson reviewed May 5, 2023

View reviewed changes

Addressed comments

95e7507

github-actions bot requested a review from tydonelson May 15, 2023 22:24

doiron approved these changes May 15, 2023

View reviewed changes

azaan-sherani merged commit 26d598a into feature/im-componentization May 15, 2023

azaan-sherani deleted the im-componentization branch May 15, 2023 22:35

Added ask install and ask uninstall commands #466

Added ask install and ask uninstall commands #466

Uh oh!

Conversation

azaan-sherani commented May 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tydonelson commented May 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tydonelson left a comment

Choose a reason for hiding this comment

Uh oh!

doiron left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

azaan-sherani commented May 3, 2023 •

edited

Loading

tydonelson commented May 3, 2023 •

edited

Loading