Merge branch 'develop'

Author: billy clark

.github/pull_request_template.md

@@ -21,6 +21,7 @@ Please provide screenshots / animations for any change that involves the UI. Ple
 
 ## Checklist
 
+- [ ] I have labeled my PR with: bug, feature, engineering, security fix or testing
 - [ ] I have performed a self-review of my own code
 - [ ] I have reviewed the title & description of this PR which I will use as the squashed PR commit message
 - [ ] I have commented my code, particularly in hard-to-understand areas

.github/workflows/integrate-and-deploy.yml

@@ -66,8 +66,8 @@ jobs:
       -
         name: Verify version stamping
         run: |
-          docker compose run --rm app cat build-version.txt version.php
-          docker compose run --rm app cat version.php | grep ${{ steps.image.outputs.TAG_APP }}
+          docker run --rm lf-app head build-version.txt version.php
+          docker run --rm lf-app head version.php | grep -q ${{ steps.image.outputs.TAG_APP }}
       -
         name: Build "next" images
         run: make build-next
@@ -79,11 +79,11 @@ jobs:
         run: make e2e-tests-ci
       -
         name: Upload Playwright test results
-        if: always()
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: test-results
-          path: test-results
+          path: test/e2e/test-results
+          if-no-files-found: error
       -
         name: Log in to Docker Hub
         uses: docker/login-action@v2

.github/workflows/pull-request.yml

@@ -13,6 +13,25 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  require-label:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_TOKEN: ${{ github.token }}
+    outputs:
+      status: ${{ steps.check-labels.outputs.status }}
+    steps:
+      - uses: mheap/github-action-required-labels@v2
+        id: check-labels
+        with:
+          mode: exactly
+          count: 1
+          labels: "bug, feature, engineering, security fix, testing"
+      - uses: mheap/github-action-required-labels@v2
+        with:
+          mode: exactly
+          count: 0
+          labels: "do not merge"
+
   unit-tests:
     runs-on: ubuntu-latest
 
@@ -68,11 +87,11 @@ jobs:
 
       -
         name: Upload Playwright test results
-        if: always()
         uses: actions/upload-artifact@v3
         with:
           name: test-results
           path: test/e2e/test-results
+          if-no-files-found: error
 
   check-code-formatting:
     runs-on: ubuntu-latest

.prettierignore

@@ -38,9 +38,6 @@ next-app/**/.env.*
 
 ## Extras
 # Libraries and generated code
-src/help/template/scripts/
-src/help/template/Theme3_Black/
-src/help/whxdata/
 src/js/lib/
 src/Site/views/languageforge/theme/default/page/home/assets/
 *.generated-data.*

LICENSE.txt

@@ -191,7 +191,7 @@ services:
     command: sh -c "postconf -e 'default_transport = retry:no outbound email allowed' && /run.sh"
 
   db:
-    image: mongo:4.4
+    image: mongo:5
     container_name: lf-db
     ports:
       # exposed this to host for admin tools
@@ -241,7 +241,7 @@ services:
       dockerfile: docker/app/Dockerfile
       args:
         - ENVIRONMENT=development
-    image: lf-app
+    image: lf-app-for-playwright
     container_name: app-for-playwright
     platform: linux/amd64
     depends_on:

docker-compose.yml

@@ -56,7 +56,7 @@ COPY --from=sillsdev/web-languageforge:wait-latest /wait /wait
 
 # DEVELOPMENT IMAGE
 FROM sillsdev/web-languageforge:base-php AS development-app
-RUN install-php-extensions xdebug
+RUN install-php-extensions xdebug-^3.1
 COPY docker/app/docker-php-ext-xdebug.ini /usr/local/etc/php/conf.d
 RUN mv $PHP_INI_DIR/php.ini-development $PHP_INI_DIR/php.ini
 COPY --from=sillsdev/web-languageforge:wait-latest /wait /wait

docker/app/Dockerfile

@@ -49,7 +49,7 @@ spec:
     spec:
       containers:
       - name: db
-        image: mongo:4.4
+        image: mongo:5
         # https://kubernetes.io/docs/concepts/configuration/manage-resources-containers
         resources:
           requests:

docker/deployment/db-deployment.yaml

@@ -3,7 +3,3 @@
 ![BrowserStack Logo](../readme_images/browserstack-logo.png "BrowserStack")
 
 for mobile device testing.
-
-## Libraries Used
-
-[lamejs](https://github.com/zhuker/lamejs) is used for encoding recorded audio and is based on [LAME](http://lame.sourceforge.net/), which is licensed under the terms of [the LGPL](https://www.gnu.org/licenses/old-licenses/lgpl-2.0.html).

docs/ACKNOWLEDGEMENTS.md

@@ -0,0 +1,12 @@
+// src/Api/Model/Shared/Rights/ProjectRoles.php
+// src/Api/Model/Shared/Rights/LexRoles.php
+const roles = [
+	'project_manager',
+	'contributor',
+	'tech_support',
+	'observer_with_comment',
+	'observer',
+]
+
+export const can_view_comments = role => roles.filter(_role => _role != 'observer').includes(role)
+export const can_view_activity = role => roles.filter(_role => ! _role.startsWith('observer')).includes(role)

next-app/src/lib/auth/index.ts

@@ -0,0 +1,18 @@
+import { throwError } from '$lib/error'
+import { sf } from '$lib/fetch/server'
+
+export async function fetch_current_user(cookie) {
+	const { userId, userProjectRole } = await sf({
+		name: 'session_getSessionData',
+		cookie,
+	})
+
+	if (! userId) {
+		throwError('User unknown', 404)
+	}
+
+	return {
+		id: userId,
+		role: userProjectRole,
+	}
+}

next-app/src/lib/data/user.ts

@@ -23,25 +23,18 @@ async function customFetch(method, url, body) {
 		body = JSON.stringify(body)
 	}
 
-	let response = {}
-	try {
-		start(url)
-
-		response = await fetch(url, {
-			method,
-			headers,
-			body,
-		})
-	} catch (e) {
-		// these only occur for network errors, like these:
-		//	request made with a bad host, e.g., //httpbin
-		//	the host is refusing connections
-		//	client is offline, i.e., airplane mode or something
-		//	CORS preflight failures
-		throwError(e)
-	} finally {
-		stop(url)
-	}
+	start(url)
+	const response = await fetch(url, {
+		method,
+		headers,
+		body,
+	})
+	.catch (throwError) // these only occur for network errors, like these:
+						//	  * request made with a bad host, e.g., //httpbin
+						//	  * the host is refusing connections
+						//	  * client is offline, i.e., airplane mode or something
+						//	  * CORS preflight failures
+	.finally(() => stop(url))
 
 	// reminder: fetch does not throw exceptions for non-200 responses (https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch)
 	if (! response.ok) {

next-app/src/lib/fetch/client.ts

@@ -38,25 +38,21 @@ export async function sf(rpc) {
 async function customFetch(url, method, body, cookie) {
 	const bodyAsJSON = JSON.stringify(body)
 
-	let response : Response
-
-	try {
-		// https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch#Supplying_request_options
-		response = await fetch(url, {
-			method,
-			headers: {
-				'content-type': 'application/json',
-				cookie,
-			},
-			body: bodyAsJSON,
-		})
-	} catch (e) {
+	// https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch#Supplying_request_options
+	const response = await fetch(url, {
+		method,
+		headers: {
+			'content-type': 'application/json',
+			cookie,
+		},
+		body: bodyAsJSON,
+	}).catch(e => {
 		// these only occur for network errors, like these:
 		//	request made with a bad host, e.g., //httpbin
 		//	the host is refusing connections
 		console.log(`fetch/server.ts.customFetch caught error on ${url}=>${bodyAsJSON}: `, e)
 		throwError('NETWORK ERROR', 500)
-	}
+	})
 
 	if (! response.ok) {
 		console.log('fetch/server.ts.customFetch response !ok: ', await response.text())

next-app/src/lib/fetch/server.ts

@@ -1,4 +1,5 @@
 import { json } from '@sveltejs/kit'
+import { fetch_current_user } from '$lib/data/user'
 import { throwError } from '$lib/error'
 import { sf } from '$lib/fetch/server'
 
@@ -14,18 +15,11 @@ export async function PUT({ request }) {
 
 	const cookie = request.headers.get('cookie')
 
-	const { userId } = await sf({
-		name: 'session_getSessionData',
-		cookie,
-	})
-
-	if (! userId) {
-		throwError('User unknown', 404)
-	}
+	const { id } = await fetch_current_user(cookie)
 
 	await sf({
 		name: 'change_password',
-		args: [userId, password],
+		args: [id, password],
 		cookie,
 	})
 

next-app/src/routes/password/+server.ts

@@ -1,24 +1,29 @@
-import { get_activities } from './activities/+server'
-import { get as get_project_info } from './meta/+server'
+import { fetch_activities } from './activities/+server'
+import { fetch_project_details } from './meta/+server'
+import { can_view_activity } from '$lib/auth'
+import { fetch_current_user } from '$lib/data/user'
 
 export async function load({ params: { project_code }, request: { headers }}) {
 	const args = {
 		project_code,
 		cookie: headers.get('cookie'),
 	}
 
-	const project = await get_project_info(args)
-
-	const last_30_days = {
-		start_date: daysAgo(30),
-		end_date: new Date(),
+	const result = {
+		project: await fetch_project_details(args),
 	}
-	const activities = await get_activities({ ...last_30_days, ...args })
 
-	return {
-		project,
-		activities,
+	const { role } = await fetch_current_user(args.cookie)
+	if (can_view_activity(role)) {
+		const last_30_days = {
+			start_date: daysAgo(30),
+			end_date: new Date(),
+		}
+
+		result.activities = await fetch_activities({ ...last_30_days, ...args })
 	}
+
+	return result
 }
 
 function daysAgo(num_days) {

next-app/src/routes/projects/[project_code]/+page.server.ts

@@ -49,7 +49,7 @@
 			icon: MessageAlertIcon,
 			url: `/app/lexicon/${ project.id }#!/editor/entry/000000?filterBy=Comments`,
 		},
-	]
+	].filter(({ value }) => value !== undefined)
 
 	async function load_all_activities() {
 		activities = await GET(`/projects/${$page.params.project_code}/activities`)
@@ -76,13 +76,15 @@
 	{/each}
 </Stats>
 
-<h2>Activity</h2>
-<Activity { activities } />
+{#if activities}
+	<h2>Activity</h2>
+	<Activity { activities } />
 
-{#if only_showing_subset}
-	<footer class='flex justify-center mt-2'>
-		<Button on:click={ load_all_activities } class='btn-outline btn-xs sm:btn-sm'>
-			show all
-		</Button>
-	</footer>
+	{#if only_showing_subset}
+		<footer class='flex justify-center mt-2'>
+			<Button on:click={ load_all_activities } class='btn-outline btn-xs sm:btn-sm'>
+				show all
+			</Button>
+		</footer>
+	{/if}
 {/if}

next-app/src/routes/projects/[project_code]/+page.svelte

@@ -6,14 +6,14 @@ export async function GET({ params: { project_code }, request: { headers } }) {
 
 	await sf({ name: 'set_project', args: [ project_code ], cookie })
 
-	const activities = await get_activities({ cookie })
+	const activities = await fetch_activities({ cookie })
 
 	return json(activities)
 }
 
 // src/Api/Model/Shared/Dto/ActivityListDto.php
 // src/Api/Model/Shared/Dto/ActivityListDto.php->ActivityListModel.__construct
-export async function get_activities({ cookie, start_date, end_date }) {
+export async function fetch_activities({ cookie, start_date, end_date }) {
 	const args = {
 		name: 'activity_list_dto_for_current_project',
 		args: [