Merge pull request #4749 from cloud-gov/feat-add-last-modified-attributes-to-file-query

apburnes · web-flow · commit 4c0629478020 · 2025-03-12T11:40:51.000-07:00
feat: Add last modified attributes to file queries
diff --git a/api/controllers/file-storage-service.js b/api/controllers/file-storage-service.js
@@ -49,7 +49,7 @@ module.exports = wrapHandlers({
     const client = await siteStorageService.createClient();
     const fss = await client.createDirectory(parent, name);
 
-    const data = serializeFileStorageFile(fss);
+    const data = serializeFileStorageFile(fss, { includeLastModified: false });
     return res.send(data);
   },
 
@@ -162,7 +162,7 @@ module.exports = wrapHandlers({
       originalname,
     });
 
-    const data = serializeFileStorageFile(fss);
+    const data = serializeFileStorageFile(fss, { includeLastModified: false });
     return res.send(data);
   },
 });
diff --git a/api/models/file-storage-file.js b/api/models/file-storage-file.js
@@ -1,4 +1,10 @@
-function associate({ FileStorageFile, FileStorageService, FileStorageUserAction }) {
+function associate({
+  FileStorageFile,
+  FileStorageService,
+  FileStorageUserAction,
+  UAAIdentity,
+  User,
+}) {
   FileStorageFile.belongsTo(FileStorageService, {
     foreignKey: 'fileStorageServiceId',
   });
@@ -15,6 +21,23 @@ function associate({ FileStorageFile, FileStorageService, FileStorageUserAction
       },
     ],
   }));
+
+  FileStorageFile.addScope('withLastAction', {
+    include: {
+      model: FileStorageUserAction,
+      limit: 1,
+      required: true,
+      order: [['createdAt', 'DESC']],
+      include: {
+        model: User,
+        required: true,
+        include: {
+          model: UAAIdentity,
+          required: true,
+        },
+      },
+    },
+  });
 }
 
 function define(sequelize, DataTypes) {
diff --git a/api/models/file-storage-user-action.js b/api/models/file-storage-user-action.js
@@ -34,11 +34,17 @@ function associate({
   });
 
   FileStorageUserAction.addScope('withUserIdentity', {
-    include: {
-      model: User,
-      required: true,
-      include: { model: UAAIdentity, required: true },
-    },
+    include: [
+      {
+        model: User,
+        required: true,
+        include: { model: UAAIdentity, required: true },
+      },
+      {
+        model: FileStorageFile,
+        required: true,
+      },
+    ],
   });
 }
 
diff --git a/api/serializers/file-storage.js b/api/serializers/file-storage.js
@@ -9,13 +9,35 @@ const allowedFileStorageFileFields = [
   'key',
   'type',
   'metadata',
+  'lastModifiedAt',
+  'lastModifiedBy',
+  'lastModifiedByUserId',
   ...dateFields,
 ];
 
-const serializeFileStorageFile = (serializable) => {
+const serializeFileStorageFile = (serializable, { includeLastModified = true } = {}) => {
   if (!serializable) return {};
 
-  return pick(allowedFileStorageFileFields, serializable.dataValues);
+  let lastModified = {};
+
+  if (includeLastModified) {
+    const { FileStorageUserActions } = serializable;
+
+    const {
+      createdAt: lastModifiedAt,
+      User: {
+        id: lastModifiedByUserId,
+        UAAIdentity: { email: lastModifiedBy },
+      },
+    } = FileStorageUserActions[0];
+
+    lastModified = { lastModifiedAt, lastModifiedByUserId, lastModifiedBy };
+  }
+
+  return pick(allowedFileStorageFileFields, {
+    ...serializable.dataValues,
+    ...lastModified,
+  });
 };
 
 const serializeFileStorageFiles = (list) => {
@@ -43,15 +65,33 @@ const allowedFileStorageUserActionFields = [
   'userId',
   'createdAt',
   'email',
+  'fileKey',
+  'fileName',
+  'fileMetadata',
+  'fileType',
 ];
 
 const serializeFileStorageUserAction = (serializable) => {
-  const { User, ...rest } = serializable.dataValues;
+  const { User, FileStorageFile, ...rest } = serializable.dataValues;
 
   const { UAAIdentity } = User.dataValues;
   const { email } = UAAIdentity.dataValues;
 
-  return pick(allowedFileStorageUserActionFields, { ...rest, email });
+  const {
+    key: fileKey,
+    name: fileName,
+    metadata: fileMetadata,
+    type: fileType,
+  } = FileStorageFile;
+
+  return pick(allowedFileStorageUserActionFields, {
+    ...rest,
+    email,
+    fileKey,
+    fileName,
+    fileMetadata,
+    fileType,
+  });
 };
 
 const serializeFileStorageUserActions = (list) => {
diff --git a/api/services/file-storage/index.js b/api/services/file-storage/index.js
@@ -184,7 +184,7 @@ class SiteFileStorageSerivce {
   }
 
   async getFile(id) {
-    const record = await FileStorageFile.findOne({
+    const record = await FileStorageFile.scope(['withLastAction']).findOne({
       where: { id, fileStorageServiceId: this.id },
     });
 
@@ -222,7 +222,7 @@ class SiteFileStorageSerivce {
     const key = this.#buildKeyPath(directory);
 
     const results = await paginate(
-      FileStorageFile,
+      FileStorageFile.scope(['withLastAction']),
       serializeFileStorageFiles,
       {
         limit,
diff --git a/package.json b/package.json
@@ -15,7 +15,7 @@
     "@tanstack/react-query": "^5.59.20",
     "@uswds/uswds": "^3.8.1",
     "ajv": "^8.12.0",
-    "axios": "^1.7.5",
+    "axios": "1.8.3",
     "bullmq": "^5.7.0",
     "cfenv": "^1.2.3",
     "connect-flash": "^0.1.1",
@@ -171,8 +171,8 @@
     "eslint-plugin-svelte": "^2.46.1",
     "eslint-plugin-testing-library": "^6.4.0",
     "fetch-mock": "^12.1.0",
-    "jest": "^29.6.2",
-    "jest-environment-jsdom": "^29.6.2",
+    "jest": "29.7.0",
+    "jest-environment-jsdom": "29.7.0",
     "json-schema-deref-sync": "^0.14.0",
     "jsonschema": "^1.4.0",
     "lodash.clonedeep": "^4.5.0",
diff --git a/test/api/requests/file-storage-service.test.js b/test/api/requests/file-storage-service.test.js
@@ -15,11 +15,13 @@ describe('File Storgage API', () => {
   beforeEach(async () => {
     sinon.stub(EventCreator, 'error').resolves();
     await factory.organization.truncate();
+    await factory.fileStorageFile.truncate();
   });
 
   afterEach(async () => {
     sinon.restore();
     await factory.organization.truncate();
+    await factory.fileStorageFile.truncate();
   });
 
   describe('GET /v0/file-storage/:file_storage_id', () => {
@@ -532,7 +534,7 @@ describe('File Storgage API', () => {
         validateAgainstJSONSchema('GET', endpoint, 200, body);
       });
 
-      it('returns a list of items in the directory path', async () => {
+      it('returns a list of user actions', async () => {
         const { site, org, user } = await stubSiteS3({ roleName: 'manager' });
         const fss = await factory.fileStorageService.create({
           siteId: site.id,
@@ -678,7 +680,7 @@ describe('File Storgage API', () => {
         validateAgainstJSONSchema('GET', endpoint, 200, body);
       });
 
-      it('returns a list of items in the directory path', async () => {
+      it('returns a list of user actions for a file', async () => {
         const { site, org, user } = await stubSiteS3({ roleName: 'manager' });
         const fss = await factory.fileStorageService.create({
           siteId: site.id,
diff --git a/test/api/support/factory/file-storage-file.js b/test/api/support/factory/file-storage-file.js
@@ -1,6 +1,8 @@
 const path = require('node:path');
 const fileStorageService = require('./file-storage-service');
-const { FileStorageFile } = require('../../../../api/models');
+const userWithIdentity = require('./user-with-uaa-identity');
+const { FileStorageFile, FileStorageUserAction } = require('../../../../api/models');
+const { getRandItem } = require('./utils');
 
 const counters = {};
 
@@ -17,6 +19,7 @@ async function build(params = {}) {
     fileStorageServiceId = null,
     description = null,
     metadata = null,
+    createFileUserAction = true,
   } = params;
 
   if (!name) {
@@ -36,25 +39,41 @@ async function build(params = {}) {
     fileStorageServiceId = fss.id;
   }
 
-  return FileStorageFile.create({
+  const file = await FileStorageFile.create({
     name,
     key,
     type,
     fileStorageServiceId,
     description,
     metadata,
   });
+
+  const { user } = await userWithIdentity.create();
+
+  if (createFileUserAction) {
+    await FileStorageUserAction.create({
+      userId: user.id,
+      fileStorageServiceId,
+      fileStorageFileId: file.id,
+      method: getRandItem(FileStorageUserAction.METHODS),
+      description: getRandItem(FileStorageUserAction.ACTION_TYPES),
+    });
+  }
+
+  return file;
 }
 
 function create(params) {
   return build(params);
 }
 
-function truncate() {
-  return FileStorageFile.truncate({
+async function truncate() {
+  await FileStorageFile.truncate({
     force: true,
     cascade: true,
   });
+
+  await userWithIdentity.truncate();
 }
 
 async function createBulk(
@@ -64,7 +83,6 @@ async function createBulk(
 ) {
   let totalFiles = [];
   let totalDiectories = [];
-
   if (files > 0) {
     const fileList = new Array(files).fill(0);
 
diff --git a/test/api/support/factory/file-storage-user-action.js b/test/api/support/factory/file-storage-user-action.js
@@ -3,14 +3,7 @@ const fileStorageService = require('./file-storage-service');
 const user = require('./user');
 const uaaIdentity = require('./uaa-identity');
 const { FileStorageUserAction } = require('../../../../api/models');
-
-function getRandItem(kv) {
-  const list = Object.keys(kv);
-  const randomIndex = Math.floor(Math.random() * list.length);
-  const key = list[randomIndex];
-
-  return kv[key];
-}
+const { getRandItem } = require('./utils');
 
 async function build(params = {}) {
   let {
@@ -78,7 +71,10 @@ async function createBulk(
 }
 
 async function createBulkRandom({ fileStorageServiceId }, actions = 1) {
-  const fsf = await fileStorageFile.create({ fileStorageServiceId });
+  const fsf = await fileStorageFile.create({
+    fileStorageServiceId,
+    createFileUserAction: false,
+  });
   const u = await user();
   await uaaIdentity.createUAAIdentity({ userId: u.id });
 
diff --git a/test/api/support/factory/user-with-uaa-identity.js b/test/api/support/factory/user-with-uaa-identity.js
@@ -0,0 +1,46 @@
+const { User } = require('../../../../api/models');
+const uaaIdentity = require('./uaa-identity');
+const user = require('./user');
+
+const counters = {};
+
+function increment(key = 'email') {
+  counters[key] = (counters[key] || 0) + 1;
+  return `user.${counters[key]}@example.gov`;
+}
+
+async function build(params = {}) {
+  let { email } = params;
+
+  if (!email) {
+    email = increment();
+  }
+
+  const createdUser = await user({ email });
+  const createdUAAId = await uaaIdentity.createUAAIdentity({
+    userId: createdUser.id,
+    email,
+  });
+
+  return {
+    user: createdUser,
+    uaaIdentity: createdUAAId,
+  };
+}
+
+function create(params) {
+  return build(params);
+}
+
+function truncate() {
+  return User.truncate({
+    force: true,
+    cascade: true,
+  });
+}
+
+module.exports = {
+  build,
+  create,
+  truncate,
+};
diff --git a/test/api/support/factory/utils.js b/test/api/support/factory/utils.js
@@ -0,0 +1,11 @@
+function getRandItem(kv) {
+  const list = Object.keys(kv);
+  const randomIndex = Math.floor(Math.random() * list.length);
+  const key = list[randomIndex];
+
+  return kv[key];
+}
+
+module.exports = {
+  getRandItem,
+};
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -184,7 +184,7 @@ class SiteFileStorageSerivce {`
`184`	`184`	`}`
`185`	`185`
`186`	`186`	`async getFile(id) {`
`187`		`- const record = await FileStorageFile.findOne({`
	`187`	`+ const record = await FileStorageFile.scope(['withLastAction']).findOne({`
`188`	`188`	`where: { id, fileStorageServiceId: this.id },`
`189`	`189`	`});`
`190`	`190`
`@@ -222,7 +222,7 @@ class SiteFileStorageSerivce {`
`222`	`222`	`const key = this.#buildKeyPath(directory);`
`223`	`223`
`224`	`224`	`const results = await paginate(`
`225`		`- FileStorageFile,`
	`225`	`+ FileStorageFile.scope(['withLastAction']),`
`226`	`226`	`serializeFileStorageFiles,`
`227`	`227`	`{`
`228`	`228`	`limit,`