From d195069b65d9e2eec135a17bab65333ec35c05d4 Mon Sep 17 00:00:00 2001 From: Sarah Ishida Date: Thu, 22 Aug 2019 15:16:16 -0400 Subject: [PATCH 1/6] Adding Appsody info to Troubleshooting Signed-off-by: Sarah Ishida --- docs/_documentations/troubleshooting.md | 80 +++++++++++++++++++++++++ 1 file changed, 80 insertions(+) diff --git a/docs/_documentations/troubleshooting.md b/docs/_documentations/troubleshooting.md index c16708ef..058511b8 100644 --- a/docs/_documentations/troubleshooting.md +++ b/docs/_documentations/troubleshooting.md @@ -22,6 +22,7 @@ The following sections contain workarounds for issues that you might encounter w * [Checking the application and build statuses](#checking-the-application-and-build-statuses) * [Editing your project](#editing-your-project) * [Disabling development on specific projects](#disabling-development-on-specific-projects) +* [Appsody with Codewind](#appsody-with-codewind) @@ -231,3 +232,82 @@ Issue link: If you turn off `auto build` for a Node.js project when you run Codewind locally, it has no effect. Changes you make to your code automatically start or restart a build even though `auto build` is disabled. *** +# Appsody with Codewind + + +## Attaching the debugger must run a second time for Microprofile project extensions +If you use a VS Code extension on a Mac, the first attempt to attach the debugger fails when you restart an extension project in debug mode. When you set up a project extension environment and create a Microprofile project and then restart in debug mode, you receive an error message that states, `Failed to attach to remote debuggee VM` or `Failed to attach debugger to at ipaddress:`. Currently, project extensions do not delay. + +**Workaround** Attach the debugger manually. Run the **Attach Debugger** action. + + +## Node.js and and Swift templates remain in the starting state +Node.js and Swift templates remain in the starting state because they do not connect with the server. + + +## A project build error appears before you create an initial project +If you use Eclipse and either Java Microprofile or Spring Appsody templates, you might receive a `Project build error: Non-resolvable parent POM` error before you create the initial project. + +**Workaround** Complete the following instructions to work around the error: +1. From the **New Codewind Project Wizard**, select a Java-based Appsody template. +2. Complete the prompts that the wizard presents. +3. After the project appears in the **Codewind Explorer** view, right-click the project and select **Show Log Files**>**Show All**. +4. If your `.m2` cache is empty, or if you have not previously created a Java Appsody project, the dependencies will download, and the `[Container] Installing parent dev.appsody` message appears. +5. Wait until the cache completes. You can wait until the `Liberty defaultServer` starts or when the **Project status** is **Running**. +6. Right-click the **Project** from the **Project Explorer** and select **Maven**>**Update Project...**. +7. Accept the defaults and click **OK**. The project is configured, and the `Project build error: Non-resolvable parent POM` disappears. + +After you create the initial project and set the `.m2` cache, new projects begin to be configured properly. + + +## An Unknown error appears on on line 1 of the pom.xml file +If you use an Eclipse IDE for Enterprise Developer EPP prior to 2019.06, you might see an `Unknown` validation erro in the `pom.xml` file. + +**Workaround** Switch to version 2019.06 or later or see (Cannot import any project into Eclipse with maven-jar-plugin 3.1.2)[https://bugs.eclipse.org/bugs/show_bug.cgi?id=547340]. + + +## Classpath warnings appear or the application classes are not on the classpath +If you work with Appsody projects in Codewind for VS Code, you might encounter `Classpath is incomplete` warnings or notifications that applications classes are not on the classpath. + +**Workaround** Complete the following instructions to work around the error: +1. After you create an Appsody Java Microprofile project, open the `codewind-workspace`. +2. Right-click the `codewind-workspace` folder and select **Add Folder to Workspace...**. +3. Choose the project folder and click **Add**. + + +## Starting in debug mode results in failure to attach the debugger +If you work with Appsody projects in Codewind for VS Code, you might receive message that state, `Failed to attach to remote debuggee VM` or `Failed to attach debugger` when you start a project in debug mode. + +**Workaround** Run the `Attach Debugger` action manually: +1. Right-click the project and select **Restart in Debug Mode**. You might receive one or both error messages that state, `Failed to attach to remote debuggee VM` or `Failed to attach debugger`. +2. Right-click on the project and select `Attach Debugger`. \ No newline at end of file From 44ad25b84cf14b8cdb73c2bd402d6c4f9f287e3a Mon Sep 17 00:00:00 2001 From: Sarah Ishida Date: Thu, 22 Aug 2019 17:31:08 -0400 Subject: [PATCH 2/6] Grammar edits Signed-off-by: Sarah Ishida --- docs/_documentations/troubleshooting.md | 43 +++++++++---------------- 1 file changed, 16 insertions(+), 27 deletions(-) diff --git a/docs/_documentations/troubleshooting.md b/docs/_documentations/troubleshooting.md index 058511b8..c44b7c4c 100644 --- a/docs/_documentations/troubleshooting.md +++ b/docs/_documentations/troubleshooting.md @@ -176,8 +176,8 @@ Issue type: bug Issue link: https://github.ibm.com/dev-ex/iterative-dev/issues/459 18.10: Still an issue --> -## Microprofile project gets updated twice upon file change -If you modify files in Microprofile projects, sometimes the project gets double updates. You might see the application status changed from **Running** to **Stopped** twice. If you notice this status change, the default polling rate, which is 500 ms, is too short for the application monitor. +## MicroProfile project gets updated twice upon file change +If you modify files in MicroProfile projects, sometimes the project gets double updates. You might see the application status changed from **Running** to **Stopped** twice. If you notice this status change, the default polling rate, which is 500 ms, is too short for the application monitor. **Workaround:** Increase the polling rate in the `server.xml` file to 1000 ms or longer. ``` @@ -234,24 +234,13 @@ If you turn off `auto build` for a Node.js project when you run Codewind locally *** # Appsody with Codewind - -## Attaching the debugger must run a second time for Microprofile project extensions -If you use a VS Code extension on a Mac, the first attempt to attach the debugger fails when you restart an extension project in debug mode. When you set up a project extension environment and create a Microprofile project and then restart in debug mode, you receive an error message that states, `Failed to attach to remote debuggee VM` or `Failed to attach debugger to at ipaddress:`. Currently, project extensions do not delay. - -**Workaround** Attach the debugger manually. Run the **Attach Debugger** action. - -## Node.js and and Swift templates remain in the starting state +## Node.js and Swift templates remain in the starting state Node.js and Swift templates remain in the starting state because they do not connect with the server. ## A project build error appears before you create an initial project -If you use Eclipse and either Java Microprofile or Spring Appsody templates, you might receive a `Project build error: Non-resolvable parent POM` error before you create the initial project. +If you use Eclipse and either Java MicroProfile or Spring Appsody templates, you might receive a `Project build error: Non-resolvable parent POM` error before you create the initial project. **Workaround** Complete the following instructions to work around the error: -1. From the **New Codewind Project Wizard**, select a Java-based Appsody template. +1. From the New Codewind Project Wizard, select a Java-based Appsody template. 2. Complete the prompts that the wizard presents. -3. After the project appears in the **Codewind Explorer** view, right-click the project and select **Show Log Files**>**Show All**. +3. After the project appears in the Codewind Explorer view, right-click the project and select **Show Log Files**>**Show All**. 4. If your `.m2` cache is empty, or if you have not previously created a Java Appsody project, the dependencies will download, and the `[Container] Installing parent dev.appsody` message appears. -5. Wait until the cache completes. You can wait until the `Liberty defaultServer` starts or when the **Project status** is **Running**. -6. Right-click the **Project** from the **Project Explorer** and select **Maven**>**Update Project...**. +5. Wait until the cache completes. You can wait until the `Liberty defaultServer` starts or when the Project status is `Running`. +6. Right-click the **Project** from the Project Explorer and select **Maven**>**Update Project...**. 7. Accept the defaults and click **OK**. The project is configured, and the `Project build error: Non-resolvable parent POM` disappears. After you create the initial project and set the `.m2` cache, new projects begin to be configured properly. @@ -280,10 +269,10 @@ Issue type: bug/info Issue link: https://github.com/eclipse/codewind-docs/issues/64 18.10: --> -## An Unknown error appears on on line 1 of the pom.xml file -If you use an Eclipse IDE for Enterprise Developer EPP prior to 2019.06, you might see an `Unknown` validation erro in the `pom.xml` file. +## An Unknown error appears on line one of the pom.xml file +If you use an Eclipse IDE for Enterprise Developer EPP prior to version 2019.06, you might see an `Unknown` validation error in the `pom.xml` file. -**Workaround** Switch to version 2019.06 or later or see (Cannot import any project into Eclipse with maven-jar-plugin 3.1.2)[https://bugs.eclipse.org/bugs/show_bug.cgi?id=547340]. +**Workaround** Switch to version 2019.06 or later, or see (Cannot import any project into Eclipse with maven-jar-plugin 3.1.2)[https://bugs.eclipse.org/bugs/show_bug.cgi?id=547340]. ## Classpath warnings appear or the application classes are not on the classpath -If you work with Appsody projects in Codewind for VS Code, you might encounter `Classpath is incomplete` warnings or notifications that applications classes are not on the classpath. +If you work with Appsody projects in Codewind for VS Code, you might encounter `Classpath is incomplete` warnings or notifications that application classes are not on the classpath. -**Workaround** Complete the following instructions to work around the error: -1. After you create an Appsody Java Microprofile project, open the `codewind-workspace`. +**Workaround** Add the `codewind-workspace` folder to the workspace: +1. After you create an Appsody Java MicroProfile project, open the `codewind-workspace` folder. 2. Right-click the `codewind-workspace` folder and select **Add Folder to Workspace...**. 3. Choose the project folder and click **Add**. @@ -306,8 +295,8 @@ Issue link: https://github.com/eclipse/codewind-docs/issues/64 and https://githu 18.10: --> ## Starting in debug mode results in failure to attach the debugger -If you work with Appsody projects in Codewind for VS Code, you might receive message that state, `Failed to attach to remote debuggee VM` or `Failed to attach debugger` when you start a project in debug mode. +If you work with Appsody projects in Codewind for VS Code, you might receive messages that state, `Failed to attach to remote debuggee VM` or `Failed to attach debugger` when you start a project in debug mode. **Workaround** Run the `Attach Debugger` action manually: -1. Right-click the project and select **Restart in Debug Mode**. You might receive one or both error messages that state, `Failed to attach to remote debuggee VM` or `Failed to attach debugger`. +1. Right-click the project and select **Restart in Debug Mode**. You might receive an error message that states, `Failed to attach to remote debuggee VM` or `Failed to attach debugger`. 2. Right-click on the project and select `Attach Debugger`. \ No newline at end of file From a8650ca23e3e477756516c30d19ea49cba72dee9 Mon Sep 17 00:00:00 2001 From: Sarah Ishida Date: Fri, 23 Aug 2019 16:06:11 -0400 Subject: [PATCH 3/6] Editing text based on feedback Signed-off-by: Sarah Ishida --- docs/_documentations/troubleshooting.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/docs/_documentations/troubleshooting.md b/docs/_documentations/troubleshooting.md index c44b7c4c..734beab6 100644 --- a/docs/_documentations/troubleshooting.md +++ b/docs/_documentations/troubleshooting.md @@ -241,7 +241,7 @@ Issue link: https://github.com/eclipse/codewind-docs/issues/64 18.10: --> ## Node.js and Swift templates remain in the starting state -Node.js and Swift templates remain in the starting state because they do not connect with the server. +Node.js and Swift templates remain in the starting state. These projects don't start a server for Codewind to ping. -## A project build error appears before you create an initial project -If you use Eclipse and either Java MicroProfile or Spring Appsody templates, you might receive a `Project build error: Non-resolvable parent POM` error before you create the initial project. +## A project build error appears after you create an initial project +If you use Eclipse and either Java MicroProfile or Spring Appsody templates, you might receive a `Project build error: Non-resolvable parent POM` error after you create the initial project. **Workaround** Complete the following instructions to work around the error: -1. From the New Codewind Project Wizard, select a Java-based Appsody template. -2. Complete the prompts that the wizard presents. -3. After the project appears in the Codewind Explorer view, right-click the project and select **Show Log Files**>**Show All**. -4. If your `.m2` cache is empty, or if you have not previously created a Java Appsody project, the dependencies will download, and the `[Container] Installing parent dev.appsody` message appears. -5. Wait until the cache completes. You can wait until the `Liberty defaultServer` starts or when the Project status is `Running`. -6. Right-click the **Project** from the Project Explorer and select **Maven**>**Update Project...**. -7. Accept the defaults and click **OK**. The project is configured, and the `Project build error: Non-resolvable parent POM` disappears. +1. Right-click the project and select **Show Log Files**>**Show All**. +2. If your `.m2` cache is empty, or if you have not previously created a Java Appsody project, the dependencies will download, and the `[Container] Installing parent dev.appsody` message appears. +3. Wait until the cache completes. You can wait until the Project status is `Running`, or, if you use the MicroProfile template, you can wait until the `Liberty defaultServer` starts. +4. Right-click the **Project** from the Project Explorer and select **Maven**>**Update Project...**. +5. Accept the defaults and click **OK**. The project is configured, and the `Project build error: Non-resolvable parent POM` disappears. After you create the initial project and set the `.m2` cache, new projects begin to be configured properly. From 0e1c9339d611329a7b72991c57f84f1085445ab9 Mon Sep 17 00:00:00 2001 From: Sarah Ishida Date: Mon, 26 Aug 2019 11:34:40 -0400 Subject: [PATCH 4/6] Fixing link syntax Signed-off-by: Sarah Ishida --- docs/_documentations/troubleshooting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_documentations/troubleshooting.md b/docs/_documentations/troubleshooting.md index 734beab6..c5d20efe 100644 --- a/docs/_documentations/troubleshooting.md +++ b/docs/_documentations/troubleshooting.md @@ -270,7 +270,7 @@ Issue link: https://github.com/eclipse/codewind-docs/issues/64 ## An Unknown error appears on line one of the pom.xml file If you use an Eclipse IDE for Enterprise Developer EPP prior to version 2019.06, you might see an `Unknown` validation error in the `pom.xml` file. -**Workaround** Switch to version 2019.06 or later, or see (Cannot import any project into Eclipse with maven-jar-plugin 3.1.2)[https://bugs.eclipse.org/bugs/show_bug.cgi?id=547340]. +**Workaround** Switch to version 2019.06 or later, or see [Cannot import any project into Eclipse with maven-jar-plugin 3.1.2](https://bugs.eclipse.org/bugs/show_bug.cgi?id=547340). ## Node.js and Swift templates remain in the starting state -Node.js and Swift templates remain in the starting state. These projects don't start a server for Codewind to ping. +The templates `Appsody Node.js template` and `Appsody Swift template` go from the starting state to the stopped state by default. The application stops, but the container still runs. These templates do not have a server and are intended to help you implement your own server. + +**Workaround** To get the application into a started state, use a server for the application. After the application has a server, Codewind can monitor the server, and the status turns to `started` if the server is running. +## Attempts fail to attach the debugger +If you work on Appsody projects on macOS, and if you restart an extension project in debug mode, the first attempt to attach the debugger might fail. Currently, a delay does not occur for project extensions. + +These steps reproduce the issue: +1. Set up a project extension environment and create a Microprofile project. +2. Restart the project in debug mode. You receive one or both of the following error messages: `Failed to attach to remote debuggee VM` or `Failed to attach debugger to at ipaddress:`. + +**Workaround** Run the `Attach Debugger` action manually. \ No newline at end of file