Merge pull request #5535 from beyondessential/release-2024-13

Release 2024-13
beyondessential · Mar 26, 2024 · 4f302f5 · 4f302f5
2 parents 2f1050d + 273644f
commit 4f302f5
Show file tree

Hide file tree

Showing 552 changed files with 40,966 additions and 26,187 deletions.
diff --git a/.github/workflows/cd.yaml b/.github/workflows/cd.yaml
@@ -16,9 +16,9 @@ jobs:
     # Only run if Tupaia CI passed
     if: ${{ github.event.workflow_run.conclusion == 'success' }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Configure AWS Credentials
-        uses: aws-actions/configure-aws-credentials@v2
+        uses: aws-actions/configure-aws-credentials@v4
         with:
           aws-region: ap-southeast-2
           role-to-assume: arn:aws:iam::843218180240:role/Tupaia_GHA

diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -17,28 +17,28 @@ jobs:
     name: Validate branch name
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Validate branch name
         run: packages/devops/scripts/ci/validateBranchName.sh
 
   validate_migration:
     name: Validate new migrations
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Validate new migration
         run: packages/devops/scripts/ci/validateNewMigrations.sh
 
   validate_tests:
     name: Validate tests
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 16.20.2
+          node-version-file: '.nvmrc'
           cache: yarn
-      - run: yarn set version 3.2.1
+      - run: corepack enable yarn
       - run: SKIP_BUILD_INTERNAL_DEPENDENCIES=true yarn install
       - run: yarn workspace @tupaia/utils build # /scripts/node/validateTests.js uses utils package
       - name: Validate unit tests
@@ -71,12 +71,12 @@ jobs:
           # Maps tcp port 5432 on service container to the host
           - 5432:5432
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 16.20.2
+          node-version-file: '.nvmrc'
           cache: yarn
-      - run: yarn set version 3.2.1
+      - run: corepack enable yarn
       - run: SKIP_BUILD_INTERNAL_DEPENDENCIES=true yarn install
       - run: yarn build:internal-dependencies
       - run: ./packages/devops/scripts/ci/validateTypesAndDbSchemaInSync.sh
@@ -165,12 +165,12 @@ jobs:
           - 5432:5432
 
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 16.20.2
+          node-version-file: '.nvmrc'
           cache: yarn
-      - run: yarn set version 3.2.1
+      - run: corepack enable yarn
       - run: SKIP_BUILD_INTERNAL_DEPENDENCIES=true yarn install
       - run: yarn build:internal-dependencies
       - run: yarn workspace @tupaia/${{ matrix.package }} setup-test || echo "No setup needed"
@@ -182,12 +182,12 @@ jobs:
     env:
       CI: false # react-scripts build treats warnings as errors if this is true
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 16.20.2
+          node-version-file: '.nvmrc'
           cache: yarn
-      - run: yarn set version 3.2.1
+      - run: corepack enable yarn
       - run: SKIP_BUILD_INTERNAL_DEPENDENCIES=true yarn install --immutable
       - run: yarn build
 

diff --git a/.github/workflows/e2e.yaml b/.github/workflows/e2e.yaml
@@ -18,12 +18,12 @@ jobs:
       CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
       TERM: xterm # workaround for issue where cypress fails to upload to cypress.io
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 16.20.2
+          node-version-file: '.nvmrc'
           cache: yarn
-      - run: yarn set version 3.2.1
+      - run: corepack enable yarn
       - run: SKIP_BUILD_INTERNAL_DEPENDENCIES=true yarn install
       - run: yarn workspace @tupaia/utils build
       - run: yarn workspace "@tupaia/e2e" test-e2e --ciBuildId $GITHUB_RUN_ID
diff --git a/.nvmrc b/.nvmrc
@@ -1 +1 @@
-16.20.2
+20.11.1
diff --git a/package.json b/package.json
@@ -41,7 +41,7 @@
     "package:build:lib": "cd $INIT_CWD && babel src --out-dir lib --source-maps --config-file \"../../babel.config.json\" --copy-files --no-copy-ignored --ignore \"**/__tests__\",\"**/__mocks__\"",
     "package:lint": "cd $INIT_CWD && eslint .",
     "package:test": "cd $INIT_CWD && jest --maxWorkers=50%",
-    "package:test:withdb": "cd $INIT_CWD && yarn workspace @tupaia/database check-test-database-exists && DB_NAME=tupaia_test jest  --runInBand",
+    "package:test:withdb": "cd $INIT_CWD && yarn workspace @tupaia/database check-test-database-exists && DB_NAME=tupaia_test jest --runInBand",
     "package:start:backend-start-dev": "cd $INIT_CWD && LOG_LEVEL=debug ../../scripts/bash/backendStartDev.sh",
     "package:start:vite": "cd $INIT_CWD && vite --config \"../../vite.config.js\"",
     "package:start-stack": "scripts/bash/pm2startInline.sh"
@@ -68,7 +68,7 @@
     "@beyondessential/eslint-config-ts": "^2.0.0",
     "@vitejs/plugin-react": "^4.0.4",
     "babel-eslint": "^10.1.0",
-    "babel-jest": "^27.0.6",
+    "babel-jest": "^29.7.0",
     "babel-preset-react-app": "^10.0.0",
     "concurrently": "^5.2.0",
     "cypress-dotenv": "^1.2.2",
@@ -77,13 +77,14 @@
     "eslint-import-resolver-babel-module": "^5.3.1",
     "eslint-plugin-cypress": "^2.11.1",
     "eslint-plugin-module-resolver": "^1.5.0",
-    "jest": "^27.0.6",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
     "jest-extended": "^0.11.5",
     "jest-when": "^3.6.0",
     "nodemon": "^2.0.4",
     "npm-package-json-lint": "5.1.0",
     "pm2": "^5.3.0",
-    "ts-jest": "^27.1.3",
+    "ts-jest": "^29.1.2",
     "ts-node": "^10.7.0",
     "typescript": "^5.2.2",
     "vite": "^4.4.8",
@@ -92,7 +93,7 @@
     "yargs": "15.4.1"
   },
   "engines": {
-    "node": "^16.20.2"
+    "node": "^20.11.1"
   },
   "packageManager": "yarn@3.2.1"
 }
diff --git a/packages/admin-panel-server/package.json b/packages/admin-panel-server/package.json
@@ -30,6 +30,7 @@
     "@tupaia/api-client": "workspace:*",
     "@tupaia/database": "workspace:*",
     "@tupaia/server-boilerplate": "workspace:*",
+    "@tupaia/types": "workspace:*",
     "@tupaia/utils": "workspace:*",
     "api-error-handler": "^1.0.0",
     "body-parser": "^1.18.3",
@@ -44,7 +45,6 @@
     "winston": "^3.3.3"
   },
   "devDependencies": {
-    "@tupaia/types": "workspace:*",
     "@types/multer": "^1.4.7"
   }
 }
diff --git a/packages/admin-panel-server/src/@types/express/index.d.ts b/packages/admin-panel-server/src/@types/express/index.d.ts
@@ -5,13 +5,13 @@
 import { AccessPolicy } from '@tupaia/access-policy';
 import { TupaiaApiClient } from '@tupaia/api-client';
 
-import { AdminPanelSessionType } from '../../models';
+import { AdminPanelSessionRecord } from '../../models';
 
 declare global {
   namespace Express {
     export interface Request {
       accessPolicy: AccessPolicy;
-      session: AdminPanelSessionType;
+      session: AdminPanelSessionRecord;
       ctx: {
         services: TupaiaApiClient;
       };

diff --git a/.../src/__tests__/viz-builder/dashboardVisualisation/DashboardVisualisationExtractor.test.ts b/.../src/__tests__/viz-builder/dashboardVisualisation/DashboardVisualisationExtractor.test.ts
@@ -78,6 +78,7 @@ describe('DashboardVisualisationExtractor', () => {
           config: {
             transform: [],
           },
+          latestDataParameters: {},
         });
       });
 
@@ -99,6 +100,7 @@ describe('DashboardVisualisationExtractor', () => {
           config: {
             customReport: 'custom',
           },
+          latestDataParameters: {},
         });
       });
     });
@@ -300,6 +302,7 @@ describe('DashboardVisualisationExtractor', () => {
           },
         },
         permissionGroup: 'Admin',
+        latestDataParameters: {},
       });
     });
 
@@ -339,6 +342,7 @@ describe('DashboardVisualisationExtractor', () => {
           },
         },
         permissionGroup: 'Admin',
+        latestDataParameters: {},
       });
     });
 
@@ -376,6 +380,7 @@ describe('DashboardVisualisationExtractor', () => {
           },
         },
         permissionGroup: 'Admin',
+        latestDataParameters: {},
       });
     });
   });
@@ -385,13 +390,13 @@ describe('DashboardVisualisationExtractor', () => {
       const extractor = new DashboardVisualisationExtractor(
         {
           code: 'viz',
-          name: 'My Viz',
           data: {
             transform: ['keyValueByDataElementName'],
           },
           presentation: {
             type: 'chart',
             chartType: 'bar',
+            name: 'My Viz',
             output: {
               type: 'bar',
             },
@@ -422,13 +427,13 @@ describe('DashboardVisualisationExtractor', () => {
       const extractor = new DashboardVisualisationExtractor(
         {
           code: 'viz',
-          name: 'My Viz',
           data: {
             transform: ['keyValueByDataElementName'],
           },
           presentation: {
             type: 'chart',
             chartType: 'bar',
+            name: 'My Viz',
             output: {
               type: 'bar',
             },
@@ -451,6 +456,7 @@ describe('DashboardVisualisationExtractor', () => {
             },
           },
           permission_group: 'Admin',
+          latest_data_parameters: {},
         },
         dashboardItem: {
           code: 'viz',

diff --git a/packages/admin-panel-server/src/models/AdminPanelSession.ts b/packages/admin-panel-server/src/models/AdminPanelSession.ts
@@ -3,14 +3,14 @@
  * Copyright (c) 2017 - 2021 Beyond Essential Systems Pty Ltd
  */
 
-import { SessionType, SessionModel } from '@tupaia/server-boilerplate';
+import { SessionRecord, SessionModel } from '@tupaia/server-boilerplate';
 
-export class AdminPanelSessionType extends SessionType {
-  public static databaseType = 'admin_panel_session';
+export class AdminPanelSessionRecord extends SessionRecord {
+  public static databaseRecord = 'admin_panel_session';
 }
 
 export class AdminPanelSessionModel extends SessionModel {
-  public get DatabaseTypeClass() {
-    return AdminPanelSessionType;
+  public get DatabaseRecordClass() {
+    return AdminPanelSessionRecord;
   }
 }
diff --git a/packages/admin-panel-server/src/models/index.ts b/packages/admin-panel-server/src/models/index.ts
@@ -3,4 +3,4 @@
  * Copyright (c) 2017 - 2021 Beyond Essential Systems Pty Ltd
  */
 
-export { AdminPanelSessionType, AdminPanelSessionModel } from './AdminPanelSession';
+export { AdminPanelSessionRecord, AdminPanelSessionModel } from './AdminPanelSession';
diff --git a/packages/admin-panel-server/src/routes/FetchHierarchyEntitiesRoute.ts b/packages/admin-panel-server/src/routes/FetchHierarchyEntitiesRoute.ts
@@ -12,14 +12,14 @@ export type FetchHierarchyEntitiesRequest = Request<
   { hierarchyName: string; entityCode: string },
   Record<string, unknown>[],
   Record<string, never>,
-  { fields?: string; search?: string }
+  { fields?: string; search?: string; pageSize?: string }
 >;
 
 export class FetchHierarchyEntitiesRoute extends Route<FetchHierarchyEntitiesRequest> {
   public async buildResponse() {
     const { entity: entityApi } = this.req.ctx.services;
     const { hierarchyName, entityCode } = this.req.params;
-    const { fields, search } = this.req.query;
+    const { fields, search, pageSize } = this.req.query;
     const queryParams: {
       fields?: string[];
       filter?: Record<string, { comparator: string; comparisonValue: unknown }>;
@@ -35,12 +35,21 @@ export class FetchHierarchyEntitiesRoute extends Route<FetchHierarchyEntitiesReq
         },
       };
     }
+
     const projectEntity = await entityApi.getEntities(hierarchyName, [entityCode], queryParams);
     const descendants = await entityApi.getDescendantsOfEntity(
       hierarchyName,
       entityCode,
       queryParams,
+      false,
+      false,
     );
-    return projectEntity.concat(descendants);
+    const flattenedDescendants = projectEntity.concat(descendants);
+
+    // If pageSize is provided, return only the first n entities
+    if (pageSize) {
+      return flattenedDescendants.slice(0, parseInt(pageSize, 10));
+    }
+    return flattenedDescendants;
   }
 }
diff --git a/...dmin-panel-server/src/routes/dashboardVisualisations/ExportDashboardVisualisationRoute.ts b/...dmin-panel-server/src/routes/dashboardVisualisations/ExportDashboardVisualisationRoute.ts
@@ -22,7 +22,7 @@ import type {
 
 export type ExportDashboardVisualisationRequest = Request<
   { dashboardVisualisationId?: string },
-  { contents: DashboardViz; filePath: string; type: string },
+  { contents: Omit<DashboardViz, 'latestDataParameters'>; filePath: string; type: string },
   { visualisation: DashboardViz },
   Record<string, any>
 >;
@@ -40,14 +40,14 @@ export class ExportDashboardVisualisationRoute extends Route<ExportDashboardVisu
       builtVisualisation || (await this.buildDashboardItemVisualisation(dashboardItem));
     const fileBaseName = visualisation.code || 'new_dashboard_visualisation';
 
-    const { id, ...visualisationWithoutId } = visualisation;
+    const { id, latestDataParameters, ...visualisationWithoutIdAndLatestParams } = visualisation;
     const { dashboards, dashboardRelations } = await this.buildDashboardsAndRelations(
       dashboardItem,
     );
 
     return {
       contents: {
-        ...visualisationWithoutId,
+        ...visualisationWithoutIdAndLatestParams,
         dashboards,
         dashboardRelations,
       },