Confluence Cloud Sample App

This repo provides the skelleton of a minimal Confluence Cloud app that help us reproduce bugs and report them properly

Bugs reproduced

Next are the bugs we have discovered on Confluence Cloud:

1. page_moved webhook bug

Description

When a page is moved to or from the Space Root content hierarchy, the page_moved webhook is not triggered.

Steps to reproduce

This Confluence Cloud sample app registers a page_moved webhook to add contentproperty flag to the page that was moved.

Install this sample app in your Confluence instance
Create a space
Create a page under the Space Homepage
Move the page to Space Root
The content property my-sample-app-flag with value true is not created because page_moved webhooks is not triggered.

Expected result

The content property my-sample-app-flag with value true is created in the moved page.

Automatic Tests

This webhook is used by a suite of integration tests we have created to automatically verify whether that flag is being created or not in different scenarios. It can be found at: /src/test/integration/002.pageMovedWebhookBug.test.js

Only 1 out of the 3 tests pass successfully. We consider that the three of them should pass.

⚠️ Please note the app must be running before executing the automatic tests

2. contents removal not reflected by copy-single-page API when updating a page

Description

When using the Copy Single Page REST API endpoint to create and update a page (target page) from an already existing page (source page), the API takes care of coping over all the page contents (attachments, content properties, custom content types, ...)

This is the case for instance when a content property is added or updated in the source page, which will be copied across to the target page when using this API.

The only exception is when a content property or a custom content type is deleted in the source page. Those kind of changes won't be reflected on the target page after using the copy-dingle-page endpoint and we consider that a bug.

Steps to reproduce

Create pageA as source page
Add a content property to pageA with key foo and value bar
Using the copy-single-page API, copy pageA to another space to create the target page
target page A will contain the content property with key foo and value bar
Remove content property foo from source pageA
Using the copy-single-page API, copy source pageA again on target pageA to update
Content property foo is still available on target pageA

We have included an integration test 003.copyPageBug.test.js in this repository to help reproduce the issue.

No need to install the sample app to run the test.

Expected result

Content property foo is automatically removed from target pageA

Setting up the app backend

Install dependencies

npm i

Set environment variables

Since we are using dotenv, you would need to copy the .env.sample file to .env and replacing the values that correspond yo tou environment.

LOCAL_BASE_URL=https://xxxxx.ngrok.io
CONFLUENCE_BASE_URL=https://your-instance.atlassian.net/wiki
ATLASSIAN_USER=your@email.com
ATLASSIAN_API_TOKEN=<your_api_token>

LOCAL_BASE_URL is required to install the sample app in your Confluence Cloud instance.

The rest are required to execute the tests.

Running the sample app

You need to start you http tunnel to expose port 3001
Start the server:

npm start

...or for development using nodemon:

npm start:dev

Now the app can be installed in your Confluence Cloud instance.

Running all the automatic tests

First you need to run the app following previosu steps
After that just run:

npm run test:integration

aruizca / confluence-cloud-app-sample