[ASAP-853] Enable Hub Admin assign user role to a Lab in CMS

.github/workflows/on-demand-migrate-user-labs-rollback.yml

@@ -0,0 +1,54 @@
+name: Migrate user labs rollback
+on:
+  workflow_dispatch:
+    inputs:
+      environment-name:
+        required: true
+        description: The environment name
+        type: choice
+        options:
+          - Branch
+          - Development
+          - Production
+      contentful-env:
+        required: true
+        type: string
+        description: Choose the Contentful environment to migrate user labs
+
+jobs:
+  migrate_user_labs_rollback:
+    runs-on: ubuntu-latest
+    environment: ${{ inputs.environment-name }}
+    container:
+      image: ghcr.io/yldio/asap-hub/node-python-sq:7b77d99657ab3718ed548ba366ffbcbb15315fd8
+      credentials:
+        username: ${{ github.actor }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup
+        id: setup
+        uses: ./.github/actions/setup-environment
+        with:
+          environment-name: ${{ inputs.environment-name }}
+      - name: Run User Assignment as Lab PI Migration
+        run: |
+          yarn workspace @asap-hub/contentful migrate-assign-users-as-lab-pi
+        env:
+          CONTENTFUL_MANAGEMENT_ACCESS_TOKEN: ${{ secrets.CONTENTFUL_MANAGEMENT_TOKEN }}
+          CONTENTFUL_SPACE_ID: ${{ steps.setup.outputs.crn-contentful-space-id }}
+          CONTENTFUL_ENV_ID: ${{ inputs.contentful-env }}
+
+  notify_failure:
+    runs-on: ubuntu-latest
+    needs: [migrate_user_labs_rollback]
+    if: ${{ failure() && inputs.environment-name=='Production' }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - uses: ./.github/actions/slack/
+        with:
+          message: Migrate user labs rollback failed
+          webhook: ${{ secrets.SLACK_WEBHOOK }}
+          status: failure

apps/crn-server/src/data-providers/contentful/team.data-provider.ts

@@ -185,7 +185,7 @@ export const parseContentfulGraphQlTeamListItem = (
         membership.linkedFrom?.usersCollection?.items[0] || {};
 
       const memberLabIds = labsCollection?.items
-        .map((labMembership) => labMembership?.lab?.sys.id)
+        .map((labItem) => labItem?.sys.id)
         .filter((x): x is string => x !== undefined);
 
       memberLabIds?.forEach((labId) => labIdsSet.add(labId));
@@ -281,16 +281,16 @@ export const parseContentfulGraphQlTeam = (
       } = membership.linkedFrom?.usersCollection?.items[0] || {};
 
       const labs: LabResponse[] = (labsCollection?.items || []).reduce(
-        (userLabs: LabResponse[], labMembership): LabResponse[] => {
-          if (!labMembership || !labMembership.lab) {
+        (userLabs: LabResponse[], lab): LabResponse[] => {
+          if (!lab) {
             return userLabs;
           }
 
           return [
             ...userLabs,
             {
-              id: labMembership.lab.sys.id,
-              name: labMembership.lab.name || '',
+              id: lab.sys.id,
+              name: lab.name || '',
             },
           ];
         },

apps/crn-server/src/data-providers/contentful/user.data-provider.ts

@@ -548,16 +548,16 @@ export const parseLabsCollection = (
   labsCollection: LabsCollection,
 ): LabResponse[] =>
   (labsCollection?.items || []).reduce(
-    (userLabs: LabResponse[], labMembership): LabResponse[] => {
-      if (!labMembership || !labMembership.lab?.name) {
+    (userLabs: LabResponse[], lab): LabResponse[] => {
+      if (!lab || !lab.name) {
         return userLabs;
       }
 
       return [
         ...userLabs,
         {
-          id: labMembership.lab.sys.id,
-          name: labMembership.lab.name,
+          id: lab.sys.id,
+          name: lab.name,
         },
       ];
     },

apps/crn-server/src/utils/analytics/collaboration.ts

@@ -85,9 +85,8 @@ export const getUserDataById = (
               teamItem?.inactiveSinceDate ?? undefined,
           })) || [],
         labIds:
-          item?.labsCollection?.items.map(
-            (labMembership) => labMembership?.lab?.sys.id || '',
-          ) || [],
+          item?.labsCollection?.items.map((labItem) => labItem?.sys.id || '') ||
+          [],
         teamIds:
           item?.teamsCollection?.items.map(
             (teamItem) => teamItem?.team?.sys.id || '',

apps/crn-server/test/data-providers/contentful/teams.data-provider.test.ts

@@ -394,8 +394,8 @@ describe('Teams data provider', () => {
                           ...getContentfulGraphqlTeamMembers(),
                           labsCollection: {
                             items: [
-                              { lab: { sys: { id: 'lab-1' } } },
-                              { lab: { sys: { id: 'lab-2' } } },
+                              { sys: { id: 'lab-1' } },
+                              { sys: { id: 'lab-2' } },
                             ],
                           },
                         },
@@ -439,7 +439,7 @@ describe('Teams data provider', () => {
                         {
                           ...getContentfulGraphqlTeamMembers(),
                           labsCollection: {
-                            items: [null, { lab: { sys: { id: 'lab-2' } } }],
+                            items: [null, { sys: { id: 'lab-2' } }],
                           },
                         },
                       ],
@@ -483,9 +483,9 @@ describe('Teams data provider', () => {
                           ...getContentfulGraphqlTeamMembers(),
                           labsCollection: {
                             items: [
-                              { lab: { sys: { id: 'lab-1' } } },
-                              { lab: { sys: { id: 'lab-2' } } },
-                              { lab: { sys: { id: 'lab-3' } } },
+                              { sys: { id: 'lab-1' } },
+                              { sys: { id: 'lab-2' } },
+                              { sys: { id: 'lab-3' } },
                             ],
                           },
                         },
@@ -504,9 +504,9 @@ describe('Teams data provider', () => {
                           ...getContentfulGraphqlTeamMembers(),
                           labsCollection: {
                             items: [
-                              { lab: { sys: { id: 'lab-1' } } },
-                              { lab: { sys: { id: 'lab-2' } } },
-                              { lab: { sys: { id: 'lab-4' } } },
+                              { sys: { id: 'lab-1' } },
+                              { sys: { id: 'lab-2' } },
+                              { sys: { id: 'lab-4' } },
                             ],
                           },
                         },

apps/crn-server/test/data-providers/contentful/users.data-provider.test.ts

@@ -228,20 +228,16 @@ describe('User data provider', () => {
           labsCollection: {
             items: [
               {
-                lab: {
-                  sys: {
-                    id: '1',
-                  },
-                  name: 'My lab',
+                sys: {
+                  id: '1',
                 },
+                name: 'My lab',
               },
               {
-                lab: {
-                  sys: {
-                    id: '2',
-                  },
-                  name: null,
+                sys: {
+                  id: '2',
                 },
+                name: null,
               },
             ],
           },

apps/crn-server/test/fixtures/analytics.fixtures.ts

@@ -453,10 +453,8 @@ export const getUserTotalResearchOutputsItem = ({
   alumniSinceDate: null,
   labsCollection: {
     items: labIds.map((labId) => ({
-      lab: {
-        sys: {
-          id: labId,
-        },
+      sys: {
+        id: labId,
       },
     })),
   },

apps/crn-server/test/fixtures/teams.fixtures.ts

@@ -153,24 +153,10 @@ export const getContentfulGraphqlTeamMembers = () => ({
   onboarded: true,
 });
 
-type LabsCollectionType = NonNullable<
-  NonNullable<
-    NonNullable<
-      NonNullable<
-        NonNullable<
-          NonNullable<
-            NonNullable<FetchTeamByIdQuery['teams']>['linkedFrom']
-          >['teamMembershipCollection']
-        >['items'][number]
-      >['linkedFrom']
-    >['usersCollection']
-  >['items'][number]
->['labsCollection'];
-
-export const getContentfulGraphqlTeamMemberLabs = (): LabsCollectionType => ({
+export const getContentfulGraphqlTeamMemberLabs = () => ({
   items: [
-    { lab: { sys: { id: 'cd7be4902' }, name: 'Brighton' } },
-    { lab: { sys: { id: 'cd7be4903' }, name: 'Liverpool' } },
+    { sys: { id: 'cd7be4902' }, name: 'Brighton' },
+    { sys: { id: 'cd7be4903' }, name: 'Liverpool' },
   ],
 });
 

apps/crn-server/test/fixtures/users.fixtures.ts

@@ -503,8 +503,8 @@ export const getContentfulGraphqlUser = (
   role: 'Grantee',
   labsCollection: {
     items: [
-      { lab: { sys: { id: 'cd7be4902' }, name: 'Brighton' } },
-      { lab: { sys: { id: 'cd7be4903' }, name: 'Liverpool' } },
+      { sys: { id: 'cd7be4902' }, name: 'Brighton' },
+      { sys: { id: 'cd7be4903' }, name: 'Liverpool' },
     ],
   },
   teamsCollection: {
@@ -581,8 +581,8 @@ export const getContentfulGraphqlUserListItem = (
   role: 'Grantee',
   labsCollection: {
     items: [
-      { lab: { sys: { id: 'cd7be4902' }, name: 'Brighton' } },
-      { lab: { sys: { id: 'cd7be4903' }, name: 'Liverpool' } },
+      { sys: { id: 'cd7be4902' }, name: 'Brighton' },
+      { sys: { id: 'cd7be4903' }, name: 'Liverpool' },
     ],
   },
   teamsCollection: {

packages/contentful/migrations/crn/labs/20250202113054-rollback-lab-membership-and-adds-pi-field.js

@@ -0,0 +1,47 @@
+module.exports.description =
+  'Renames lab membership reference (labs to oldLabs) and creates new labs field (references labs) adds PI field';
+
+module.exports.up = (migration) => {
+  const labs = migration.editContentType('labs');
+
+  labs
+    .createField('labPI')
+    .name('Principle Investigator')
+    .type('Link')
+    .linkType('Entry')
+    .validations([
+      {
+        linkContentType: ['users'],
+      },
+    ]);
+
+  const users = migration.editContentType('users');
+
+  users.changeFieldId('labs', 'oldLabs');
+  users.editField('oldLabs', { name: 'Old Labs' });
+  users
+    .createField('labs')
+    .name('Labs')
+    .type('Array')
+    .items({
+      type: 'Link',
+      linkType: 'Entry',
+      validations: [
+        {
+          linkContentType: ['labs'],
+        },
+      ],
+    });
+  users.moveField('labs').afterField('teams');
+};
+
+module.exports.down = (migration) => {
+  const labs = migration.editContentType('labs');
+  labs.deleteField('labPI');
+
+  const users = migration.editContentType('users');
+  users.deleteField('labs');
+  users.changeFieldId('oldLabs', 'labs');
+  users.editField('oldLabs', { name: 'Labs' });
+  users.moveField('labs').afterField('teams');
+};

packages/contentful/package.json

@@ -11,6 +11,7 @@
   "scripts": {
     "build:babel": "../../scripts/build-babel.sh build",
     "migrate-user-labs": "ts-node ./scripts/migrate-user-labs.ts",
+    "migrate-assign-users-as-lab-pi": "ts-node ./scripts/assign-users-as-lab-pi.ts",
     "migrate-preprint-versions": "ts-node ./scripts/migrate-research-output-versions.ts",
     "watch:babel": "../../scripts/build-babel.sh watch",
     "space:rollback-migration": "yarn ctf-migrate down -c $CONTENT_TYPE -d $DRY_RUN",