Jira integration

compose.ci.yaml

@@ -18,6 +18,9 @@ services:
       DATABASE_HOST: db
       DATABASE_PORT: 5432
       DATABASE_NAME: keijo_test
+      ATLASSIAN_CLIENT_ID: mock_id
+      ATLASSIAN_CLIENT_SECRET: mock_secret
+      SESSION_SECRET: mock_secret
     ports:
       - 4000:3001
 

compose.yaml

@@ -28,6 +28,9 @@ services:
       service: server-base
     container_name: keijo-server
     environment:
+      CORS_ORIGIN: http://localhost:3000
+      CALLBACK_URL: http://localhost:3001/jira/callback
+      CALLBACK_REDIRECT_URL: http://localhost:3000
       DATABASE_NAME: keijo_dev
     ports:
       - 3001:3001
@@ -40,6 +43,8 @@ services:
     environment:
       NETVISOR_API_URL: http://nv-mock:4002
       DATABASE_NAME: keijo_test
+      CORS_ORIGIN: http://localhost:4000
+
     ports:
       - 4001:3001
 

docs/configuration.md

@@ -31,5 +31,14 @@ Key|Default|Description
 `DATABASE_HOST`||Postgres hostname.
 `DATABASE_PORT`||Postgres port.
 `DATABASE_SSL_MODE`|`false`|When set to `true`, TypeORM is configured to use SSL mode `no-verify` when connecting to Postgres. Otherwise, SSL is disabled. See [`node-postgres` docs](https://github.com/brianc/node-postgres/tree/master/packages/pg-connection-string#tcp-connections) for more.
+`ATLASSIAN_CLIENT_ID`|| Client ID of your Atlassian OAuth 2.0 App. See [Jira OAuth2.0 apps](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/).
+`ATLASSIAN_CLIENT_SECRET`|| Client Secret of your Atlassian OAuth 2.0 App.
+`ATLASSIAN_AUTHORIZATION_URL`|https://auth.atlassian.com/authorize| Atlassian URL where user is directed to grant keijo access to use resources.
+`ATLASSIAN_TOKEN_URL`|https://auth.atlassian.com/oauth/token| Atlassian URL where keijo exchanges authorization code for access and refresh tokens.
+`CALLBACK_URL`|/jira/callback| Keijo URL where user is redirected from Jira after access is granted.
+`CALLBACK_REDIRECT_URL`|/| Keijo URL where user is redirected from callback after callback is handled.
+`SESSION_SECRET`|| Session secret.
+`CORS_ORIGIN`|| Development Cors origin URL.
+`TRUST_PROXY_IPS`|false| Trusted proxy ips to allow secure cookies to be sent over proxies.
 
 <sup>1</sup>) See [Logging docs](./logging.md) for more information.

docs/development-handbook.md

@@ -121,3 +121,21 @@ Keijo is released as a single Docker image that contains the whole software. (Th
 1. Make sure you are in `main` branch and the working tree is clean.
 2. Run `npm version <patch|minor|major>`. **Always follow the [semantic versioning guidelines](https://semver.org/).** This script uses `npm version` to apply the desired version bump, sync the sub-projects with it, and finally push the created tags to GitHub.
 3. Allow the [CI/CD pipeline](https://github.com/funidata/keijo/actions) to finish. The new version is automatically published once the workflow completes.
+
+## Jira Integration
+
+Keijo integrates to Jira using OAuth2.0 to get, for example, issue related data.
+The backend functions as a [token-mediating backend](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-browser-based-apps#name-token-mediating-backend), storing users Jira tokens in user sessions, and handing access token to the frontend to make
+requests to [Jira Cloud REST API](https://developer.atlassian.com/cloud/jira/platform/rest/v2).
+
+### Atlassian App
+
+An Atlassian OAuth2.0 app needs to be created to get necessary Atlassian credentials and values.
+Atlassian app can be created in the [developer console](https://developer.atlassian.com/console/myapps/).
+The app needs to be configured to have:
+
+- scope `read:jira-work` (permissions tab).
+- callback URL e.g., `https://<keijo-site>/jira/callback` or for local development e.g., `http://localhost:3001/jira/callback` (Authorization tab).
+
+Once these are added to the app, get the client ID and client sercret from app settings.
+For more detailed steps and information see [Jira OAuth2.0 apps](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/).

e2e/playwright.config.ts

@@ -1,7 +1,7 @@
 import { defineConfig, devices } from "@playwright/test";
 import { test as base } from "@playwright/test";
 import { i18nFixture } from "./i18n-fixture";
-import dayjs, { Dayjs } from "dayjs";
+import dayjs from "dayjs";
 import weekOfYear from "dayjs/plugin/weekOfYear";
 import localizedFormat from "dayjs/plugin/localizedFormat";
 import "dayjs/locale/en-gb";
@@ -11,14 +11,12 @@ import "dayjs/locale/fi";
  */
 export default defineConfig({
   testDir: "./tests",
-  /* Run tests in files in parallel */
-  fullyParallel: true,
   /* Fail the build on CI if you accidentally left test.only in the source code. */
   forbidOnly: !!process.env.CI,
   /* Retry on CI only */
-  retries: process.env.CI ? 2 : 0,
+  retries: 2,
   /* Opt out of parallel tests on CI. */
-  workers: process.env.CI ? 1 : undefined,
+  workers: 1,
   /* Reporter to use. See https://playwright.dev/docs/test-reporters */
   reporter: "html",
   /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */

e2e/tests/entry.mobile.spec.ts

@@ -114,20 +114,8 @@ test.describe("Entry defaults mobile", () => {
   });
 
   test("Should use set default values", async ({ page, t }) => {
-    await page.goto(emptyWeekUrl + "/create");
-    await expect(page.getByRole("combobox", { name: t("entryDialog.product") })).toHaveValue("");
-    await page.goto(emptyWeekUrl);
-    await page.getByRole("banner").getByLabel(t("controls.openMenu")).click();
-    await page.getByRole("button", { name: t("controls.defaultsView") }).click();
-    await page.getByRole("combobox", { name: t("entryDialog.product") }).fill(entries[0].product);
-    await page.getByRole("combobox", { name: t("entryDialog.activity") }).fill(entries[0].activity);
-    await page.goto(emptyWeekUrl + "/create");
-    await expect(page.getByRole("combobox", { name: t("entryDialog.product") })).toHaveValue(
-      entries[0].product,
-    );
-    await expect(page.getByRole("combobox", { name: t("entryDialog.activity") })).toHaveValue(
-      entries[0].activity,
-    );
+    await setDefaultValuesMobile(page, t, entries[0].product, entries[0].activity);
+    await setDefaultValuesMobile(page, t, productNames[1], activityNames[1]);
   });
 });
 
@@ -140,3 +128,23 @@ const fillEntryFormMobile = async (page: Page, t: TFunction, entry: TestEntry) =
   await page.getByRole("gridcell", { name: entry.date.split(".")[0] }).click();
   await page.getByRole("button", { name: "OK" }).click();
 };
+
+const setDefaultValuesMobile = async (
+  page: Page,
+  t: TFunction,
+  product: string,
+  activity: string,
+) => {
+  await page.goto(emptyWeekUrl);
+  await page.getByRole("banner").getByLabel(t("controls.openMenu")).click();
+  await page.getByRole("button", { name: t("controls.defaultsView") }).click();
+  await page.getByRole("combobox", { name: t("entryDialog.product") }).click();
+  await page.getByRole("option", { name: product }).click();
+  await page.getByRole("combobox", { name: t("entryDialog.activity") }).click();
+  await page.getByRole("option", { name: activity }).click();
+  await page.goto(emptyWeekUrl + "/create");
+  await expect(page.getByRole("combobox", { name: t("entryDialog.product") })).toHaveValue(product);
+  await expect(page.getByRole("combobox", { name: t("entryDialog.activity") })).toHaveValue(
+    activity,
+  );
+};

e2e/tests/entry.spec.ts

@@ -115,25 +115,8 @@ test.describe("Entry defaults", () => {
   });
 
   test("Should use set default values", async ({ page, t }) => {
-    await page.goto(emptyWeekUrl + "/create");
-    await expect(page.getByRole("combobox", { name: t("entryDialog.product") })).toHaveValue("");
-    await page.goto(emptyWeekUrl);
-
-    await page.getByLabel(t("controls.settingsMenu")).click();
-    await page.getByRole("menuitem", { name: t("controls.defaultsView") }).click();
-
-    await page.getByRole("combobox", { name: t("entryDialog.product") }).click();
-    await page.getByRole("option", { name: entries[0].product }).click();
-    await page.getByRole("combobox", { name: t("entryDialog.activity") }).click();
-    await page.getByRole("option", { name: entries[0].activity }).click();
-
-    await page.goto(emptyWeekUrl + "/create");
-    await expect(page.getByRole("combobox", { name: t("entryDialog.product") })).toHaveValue(
-      entries[0].product,
-    );
-    await expect(page.getByRole("combobox", { name: t("entryDialog.activity") })).toHaveValue(
-      entries[0].activity,
-    );
+    await setDefaultValues(page, t, entries[0].product, entries[0].activity);
+    await setDefaultValues(page, t, productNames[1], activityNames[1]);
   });
 });
 
@@ -148,3 +131,20 @@ const fillEntryForm = async (page: Page, t: TFunction, entry: TestEntry) => {
     .first()
     .click();
 };
+
+const setDefaultValues = async (page: Page, t: TFunction, product: string, activity: string) => {
+  await page.goto(emptyWeekUrl);
+  await page.getByLabel(t("controls.settingsMenu")).click();
+  await page.getByRole("menuitem", { name: t("controls.defaultsView") }).click();
+
+  await page.getByRole("combobox", { name: t("entryDialog.product") }).click();
+  await page.getByRole("option", { name: product }).click();
+  await page.getByRole("combobox", { name: t("entryDialog.activity") }).click();
+  await page.getByRole("option", { name: activity }).click();
+
+  await page.goto(emptyWeekUrl + "/create");
+  await expect(page.getByRole("combobox", { name: t("entryDialog.product") })).toHaveValue(product);
+  await expect(page.getByRole("combobox", { name: t("entryDialog.activity") })).toHaveValue(
+    activity,
+  );
+};