ARC 2043 - [Nice to Have] Uninstall/Install connect app automatically on startup (#32)

Author: krazziekay

.env.example

@@ -4,7 +4,13 @@ NGROK_AUTHTOKEN=
 # [AUTOFILL] This URL is automatically filled
 APP_URL=
 
+# These variables are needed for the auto-app installation
+INSTALL_ATLASSIAN_URL=
+INSTALL_JIRA_ADMIN_USERNAME=
+# Create a new API token in Jira [https://id.atlassian.com/manage-profile/security/api-tokens]
+INSTALL_JIRA_ADMIN_PASSWORD=
+
 # These variables need to be filled only for running E2E test
-ATLASSIAN_URL=
-JIRA_ADMIN_USERNAME=
-JIRA_ADMIN_PASSWORD=
+E2E_ATLASSIAN_URL=
+E2E_JIRA_ADMIN_USERNAME=
+E2E_JIRA_ADMIN_PASSWORD=

.github/workflows/build.yml

@@ -50,8 +50,8 @@ jobs:
         run: |
           echo "APP_URL=http://localhost" > .env
           echo "NGROK_AUTHTOKEN=${{ secrets.NGROK_AUTHTOKEN }}" >> .env
-          echo "ATLASSIAN_URL=${{ secrets.ATLASSIAN_URL }}" >> .env
-          echo "JIRA_ADMIN_USERNAME=${{ secrets.JIRA_ADMIN_USERNAME }}" >> .env
-          echo "JIRA_ADMIN_PASSWORD=${{ secrets.JIRA_ADMIN_PASSWORD }}" >> .env
+          echo "E2E_ATLASSIAN_URL=${{ secrets.E2E_ATLASSIAN_URL }}" >> .env
+          echo "E2E_JIRA_ADMIN_USERNAME=${{ secrets.E2E_JIRA_ADMIN_USERNAME }}" >> .env
+          echo "E2E_JIRA_ADMIN_PASSWORD=${{ secrets.E2E_JIRA_ADMIN_PASSWORD }}" >> .env
       - run: docker-compose up -d
       - run: yarn run test:e2e

Dockerfile

@@ -1,5 +1,7 @@
 FROM node:lts-alpine as build
 
+RUN apk --no-cache add curl
+
 COPY . /app
 WORKDIR /app
 

README.md

@@ -1,4 +1,4 @@
-# [WIP] Atlassian Connect example app - Node edition
+# Atlassian Connect example app - Node edition
 
 > **_NOTE:_**  This repository is in progress and is not ready yet.
 
@@ -10,6 +10,7 @@ This app is aimed to help you to easily add your integration in Jira.
 - [Pre-requisites](#pre-requisites)
 - [Features](#features)
 - [Getting started](#getting-started)
+- [Manual Install](#manually-installing-the-app)
 - [Running your application](#running-your-application)
 - [Testing](#testing)
 - [Getting help](#getting-help)
@@ -25,23 +26,30 @@ This app is aimed to help you to easily add your integration in Jira.
 
 ## Getting started
 You can run this app in 3 simple steps:
-- **Installing dependencies** - Run `yarn install` for installing all the dependencies for this app.
+- **Installing dependencies** 
+  - Run `yarn install` for installing all the dependencies for this app.
 
-- **Tunneling** - For this purpose, we are using [ngrok](https://ngrok.com/docs/getting-started). You need to set the ngrok authtoken in the env file, so please make sure you have a ngrok account. 
-Simply go to [ngrok](https://dashboard.ngrok.com/get-started/your-authtoken) and copy your authtoken and paste it in the [.env](./.env) file.
+- **Tunneling**
+  - For this purpose, we are using [ngrok](https://ngrok.com/docs/getting-started). You need to set the ngrok authtoken in the env file, so please make sure you have a ngrok account.
+  - Simply go to [ngrok](https://dashboard.ngrok.com/get-started/your-authtoken) and copy your authtoken and paste it in the [.env](./.env) file.
 
-- **Running docker compose** - Then simply run `docker-compose up`. Once the docker finishes running, you can view the tunneled URL in the logs. 
-![img.png](static/images/tunnel-output.png)
+- **Running docker compose** 
+  - Then simply run `docker-compose up`.
+  - Please be patient as it will take a few minutes for everything to be setup. When everything is setup, you should see the URL in the terminal as in the picture below. ![img.png](static/images/tunnel-output.png)
 
-After you have the tunneled URL, check for the config in the url `/atlassian-connect.json`(`https://TUNNELED_URL/atlassian-connect.json`). This is the __app descriptor URL__ for uploading the app and installing in Jira.
+> **Note:** _If you are using a free version of ngrok, please open the tunneled URL first. This needs to be done to bypass the ngrok browser warning. Just visit the ngrok warning page and just click on the Visit button._
 
-## Installing the App
-Go to your Jira instance and do the following steps:
+At the very end, you can see the URL the index page of your app. Just open the URL and that's it, you're ready!
+
+## Manually Installing the App
+The above steps automatically installs the app, however you can only install one app at a time. 
+
+So, if you want to install the app in multiple Jira instances, please do it manually. Go to your Jira instances and do the following steps:
 - From the header menu, select Apps -> Manage your apps.
 - Verify the filter is set to User-installed, and select Settings beneath the User-installed apps table.
-- On the Settings pop-up, add Enable development mode and click Apply. Refresh the page. 
+- On the Settings pop-up, add Enable development mode and click Apply. Refresh the page.
 - On the right side of the header, there should now appear a button Upload app. Click it and enter the tunneled URL `/atlassian-connect.json`(`https://TUNNELED_URL/atlassian-connect.json`)
-- Click Upload. 
+- Click Upload.
 - That's it! You're done. 🎉
 
 ## Running your application

app-install/Dockerfile

@@ -0,0 +1,9 @@
+FROM ubuntu:latest
+
+COPY app-install/app-install.sh ./app-install.sh
+RUN chmod +x app-install.sh
+
+RUN apt update
+RUN apt install -y curl jq
+
+CMD ["bash", "app-install.sh"]

app-install/app-install.sh

@@ -0,0 +1,33 @@
+# App key defined for this sample app
+APP_KEY=com.atlassian.sample-app-node
+# Fetching the new ngrok URL, not fetching the one from the .env because its not updated
+BASE_URL=$(curl --silent http://tunnel:4040/api/tunnels | jq -r '.tunnels[] | select(.proto == "https") | .public_url')
+
+# Bypassing the ngrok warning page
+curl -H "ngrok-skip-browser-warning: 1" BASE_URL
+
+# Uninstalling the app first
+curl -X DELETE -u $INSTALL_JIRA_ADMIN_USERNAME:$INSTALL_JIRA_ADMIN_PASSWORD \
+-H "Content-Type: application/vnd.atl.plugins.install.uri+json" "${INSTALL_ATLASSIAN_URL}/rest/plugins/1.0/${APP_KEY}-key"
+echo "Uninstalling old version of the app \n\n"
+
+# Getting the UPM token first, which will be used for app installation
+UPM_TOKEN=$(curl -u $INSTALL_JIRA_ADMIN_USERNAME:$INSTALL_JIRA_ADMIN_PASSWORD --head ${INSTALL_ATLASSIAN_URL}/rest/plugins/1.0/| fgrep upm-token | cut -c 12- | tr -d '\r\n')
+
+# Installing the app
+curl -u $INSTALL_JIRA_ADMIN_USERNAME:$INSTALL_JIRA_ADMIN_PASSWORD -H "Content-Type: application/vnd.atl.plugins.install.uri+json" \
+-X POST ${INSTALL_ATLASSIAN_URL}/rest/plugins/1.0/?token=${UPM_TOKEN} \
+-d "{\"pluginUri\":\"${BASE_URL}/atlassian-connect.json\", \"pluginName\": \"Sample Connect Node App\"}"
+
+echo "The app has been successfully installed \n\n"
+echo "
+*********************************************************************************************************************
+IF YOU ARE USING A FREE NGROK ACCOUNT, PLEASE DO THIS STEP FIRST!!!
+Before going to your app, please open this URL first: ${BASE_URL}.
+This will open up the ngrok page, don't worry just click on the Visit button.
+That's it, you're all ready!
+*********************************************************************************************************************
+*********************************************************************************************************************
+Now open your app in this URL: ${INSTALL_ATLASSIAN_URL}/plugins/servlet/ac/${APP_KEY}/acn-introduction
+*********************************************************************************************************************
+"

docker-compose.yml

@@ -17,3 +17,18 @@ services:
     ports:
       - "3000:3000" # server port
       - "9229:9229" # debug port
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:3000/healthcheck"]
+      interval: 10s
+      retries: 5
+
+  installation:
+    container_name: install-in-jira
+    depends_on:
+      app:
+        condition: service_healthy
+    build:
+      context: .
+      dockerfile: app-install/Dockerfile
+    env_file:
+      - .env

src/env.ts

@@ -4,6 +4,9 @@ export type EnvVars = {
 	APP_URL: string;
 	APP_KEY: string;
 	NGROK_AUTHTOKEN: string;
+	INSTALL_ATLASSIAN_URL: string;
+	INSTALL_JIRA_ADMIN_USERNAME: string;
+	INSTALL_JIRA_ADMIN_PASSWORD: string;
 };
 
 const variables = config().parsed as Partial<EnvVars>;

src/routes/router.ts

@@ -11,7 +11,7 @@ export const RootRouter = Router();
 
 /************************************************************************************************************************
  * Healthcheck
-	************************************************************************************************************************/
+ ************************************************************************************************************************/
 RootRouter.get("/healthcheck", (_req, res) => res.status(200).send("Healthy!"));
 
 /************************************************************************************************************************

src/server.ts

@@ -23,6 +23,7 @@ app.use(json());
 app.use(RootRouter);
 
 const port = 3000;
-app.listen(port, () => {
-	console.log(`Example app listening on port ${port}`);
+app.listen(port, async () => {
+	// App is now running
+	console.log(`Sample app listening on port ${port}`);
 });