@openneuro/server 4.20.5 → 4.20.6-alpha.3

package/src/datalad/__tests__/pagination.spec.ts

@@ -0,0 +1,136 @@
+import { vi } from "vitest"
+vi.mock("ioredis")
+import * as pagination from "../pagination.js"
+import { connect, Types } from "mongoose"
+import Dataset from "../../models/dataset"
+const ObjectID = Types.ObjectId
+
+const base64 = /^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$/
+
+describe("pagination model operations", () => {
+  describe("enumToMongoSort()", () => {
+    it("should convert enum strings to -1 or 1 values", () => {
+      expect(
+        pagination.enumToMongoSort({
+          created: "descending",
+          name: "ascending",
+        }),
+      ).toEqual({ created: -1, name: 1 })
+    })
+  })
+  describe("apiCursor()", () => {
+    it("returns base64 string", () => {
+      expect(pagination.apiCursor(new ObjectID(5))).toMatch(base64)
+    })
+  })
+  describe("applyCursorToEdges()", () => {
+    it("returns the correct shape matching Relay connections", () => {
+      const res = pagination.applyCursorToEdges(
+        [{ _id: "123" }, { _id: "234" }, { _id: "345" }],
+        0,
+      )
+      expect(res).toEqual([
+        { cursor: "eyJvZmZzZXQiOjB9", node: { _id: "123" } },
+        { cursor: "eyJvZmZzZXQiOjF9", node: { _id: "234" } },
+        { cursor: "eyJvZmZzZXQiOjJ9", node: { _id: "345" } },
+      ])
+    })
+  })
+  describe("datasetsConnection()", () => {
+    beforeAll(async () => {
+      await connect(globalThis.__MONGO_URI__)
+      const ds = new Dataset({
+        _id: new ObjectID("5bef51a1ed211400c08e5524"),
+        id: "ds001001",
+        created: new Date("2018-11-16T23:24:17.203Z"),
+        modified: new Date("2018-11-16T23:24:25.050Z"),
+        uploader: "f8d5a57c-879a-40e6-b151-e34c4a28ff70",
+        revision: "262a8e610e32b5766cbf669acc71911c1ece7126",
+      })
+      await ds.save()
+    })
+    it("returns a connection shaped result", async () => {
+      const res = await pagination.datasetsConnection({
+        orderBy: { created: "ascending" },
+        limit: 5,
+        first: 10,
+      })([])
+      expect(res).toHaveProperty("pageInfo")
+      expect(res).toHaveProperty("edges")
+    })
+  })
+  describe("maxLimit()", () => {
+    it("should be within range 1-100", () => {
+      expect(pagination.maxLimit(0)).toBe(1)
+      expect(pagination.maxLimit(101)).toBe(100)
+    })
+    it("does not error with negative values", () => {
+      expect(pagination.maxLimit(-10)).toBe(1)
+    })
+  })
+  describe("sortAggregate()", () => {
+    it("should return natural sort for orderBy: created", () => {
+      expect(
+        pagination.sortAggregate({ orderBy: { created: "ascending" } }),
+      ).toEqual([{ $sort: { _id: 1 } }])
+    })
+    it("does not throw an error with no orderBy", () => {
+      expect(pagination.sortAggregate({})).toEqual([])
+    })
+    it("should return -1 for descending sorts", () => {
+      expect(
+        pagination.sortAggregate({ orderBy: { created: "descending" } }),
+      ).toEqual([{ $sort: { _id: -1 } }])
+    })
+    it('includes "name" for name sorts', () => {
+      expect(
+        pagination.sortAggregate({ orderBy: { name: "descending" } }),
+      ).toEqual([{ $sort: { name: -1 } }])
+    })
+    it("returns a lookup and count stage for stars", () => {
+      const agg = pagination.sortAggregate({ orderBy: { stars: "ascending" } })
+      expect(agg[0]).toHaveProperty("$lookup")
+      expect(agg[1]).toHaveProperty("$addFields")
+      // Ends with count sort
+      expect(agg.slice(-1)).toEqual([{ $sort: { starsCount: 1 } }])
+    })
+    it("returns a lookup and count stage for subscriptions", () => {
+      const agg = pagination.sortAggregate({
+        orderBy: { subscriptions: "descending" },
+      })
+      expect(agg[0]).toHaveProperty("$lookup")
+      expect(agg[1]).toHaveProperty("$addFields")
+      // Ends with count sort
+      expect(agg.slice(-1)).toEqual([{ $sort: { subscriptionsCount: -1 } }])
+    })
+    it("returns a lookup and no count stage for downloads", () => {
+      const agg = pagination.sortAggregate({
+        orderBy: { downloads: "ascending" },
+      })
+      // Ends with count sort
+      expect(agg.slice(-1)).toEqual([{ $sort: { downloads: 1 } }])
+    })
+    it("returns a lookup and no count stage for views", () => {
+      const agg = pagination.sortAggregate({
+        orderBy: { views: "ascending" },
+      })
+      // Ends with count sort
+      expect(agg.slice(-1)).toEqual([{ $sort: { views: 1 } }])
+    })
+    it("does not explode with all sorts", () => {
+      const agg = pagination.sortAggregate({
+        orderBy: {
+          created: "ascending",
+          name: "ascending",
+          uploader: "ascending",
+          stars: "ascending",
+          downloads: "ascending",
+          subscriptions: "ascending",
+        },
+      })
+      expect(agg).toHaveLength(6)
+      // Final stage should always be a sort
+      expect(agg.slice(-1)[0]).toHaveProperty("$sort")
+    })
+  })
+})

package/src/datalad/__tests__/{snapshots.spec.js → snapshots.spec.ts}

@@ -1,14 +1,14 @@
-import { vi } from 'vitest'
-vi.mock('ioredis')
-import request from 'superagent'
-import { createDataset } from '../dataset.js'
-import { createSnapshot } from '../snapshots.js'
-import { getDatasetWorker } from '../../libs/datalad-service'
-import { connect } from 'mongoose'
+import { vi } from "vitest"
+vi.mock("ioredis")
+import request from "superagent"
+import { createDataset } from "../dataset"
+import { createSnapshot } from "../snapshots"
+import { getDatasetWorker } from "../../libs/datalad-service"
+import { connect } from "mongoose"
 
 // Mock requests to Datalad service
-vi.mock('superagent')
-vi.mock('../../libs/redis.js', () => ({
+vi.mock("superagent")
+vi.mock("../../libs/redis.js", () => ({
   redis: {
     del: vi.fn(),
   },
@@ -17,17 +17,17 @@ vi.mock('../../libs/redis.js', () => ({
   },
 }))
 // Mock draft files calls
-vi.mock('../draft.js', () => ({
+vi.mock("../draft.ts", () => ({
   updateDatasetRevision: () => () => Promise.resolve(),
 }))
-vi.mock('../../config.js')
-vi.mock('../../libs/notifications.js')
+vi.mock("../../config.ts")
+vi.mock("../../libs/notifications.ts")
 
-describe('snapshot model operations', () => {
-  describe('createSnapshot()', () => {
-    it('posts to the DataLad /datasets/{dsId}/snapshots/{snapshot} endpoint', async () => {
-      const user = { id: '1234' }
-      const tag = 'snapshot'
+describe("snapshot model operations", () => {
+  describe("createSnapshot()", () => {
+    it("posts to the DataLad /datasets/{dsId}/snapshots/{snapshot} endpoint", async () => {
+      const user = { id: "1234" }
+      const tag = "snapshot"
       await connect(globalThis.__MONGO_URI__)
       const { id: dsId } = await createDataset(user.id, user, {
         affirmedDefaced: true,

package/src/datalad/{analytics.js → analytics.ts}

@@ -1,5 +1,5 @@
-import Analytics from '../models/analytics'
-import Dataset from '../models/dataset'
+import Analytics from "../models/analytics"
+import Dataset from "../models/dataset"
 
 /**
  * Update a dataset's analytics count
@@ -8,7 +8,7 @@ import Dataset from '../models/dataset'
  * @param {'views'|'downloads'} type
  */
 export const trackAnalytics = async (datasetId, tag, type) => {
-  if (type === 'views') {
+  if (type === "views") {
     return Dataset.updateOne(
       {
         id: datasetId,
@@ -22,7 +22,7 @@ export const trackAnalytics = async (datasetId, tag, type) => {
         upsert: true,
       },
     ).exec()
-  } else if (type === 'downloads') {
+  } else if (type === "downloads") {
     return Dataset.updateOne(
       {
         id: datasetId,

package/src/datalad/{changelog.js → changelog.ts}

@@ -1,12 +1,13 @@
-import format from 'date-fns/format'
-import { addFileString, commitFiles } from './dataset.js'
-import { getDatasetWorker } from '../libs/datalad-service'
+import format from "date-fns/format"
+import { addFileString, commitFiles } from "./dataset"
+import { getDatasetWorker } from "../libs/datalad-service"
 
 /**
  * Matches a CPAN changelog version line
  * @param {string} line
  */
-export const matchCpanVersion = line => /^(\S+) (\d{4}-\d{2}-\d{2})$/.exec(line)
+export const matchCpanVersion = (line) =>
+  /^(\S+) (\d{4}-\d{2}-\d{2})$/.exec(line)
 
 /**
  * Returns start and end indexes for the version being modified
@@ -32,7 +33,7 @@ export const findVersion = (changeLines, tag) => {
     } else {
       // First version didn't match, try again excluding lines we've searched
       return findVersion(changeLines.slice(start + 1), tag).map(
-        x => x + start + 1,
+        (x) => x + start + 1,
       )
     }
   }
@@ -54,14 +55,14 @@ export const spliceChangelog = (changelog, tag, date, changes) => {
   // this way we can always add it back after editing
   const changelogLines = changelog ? changelog.trimRight().split(/\r?\n/) : []
   const [start, length] = findVersion(changelogLines, tag)
-  const formattedChanges = changes.map(change => `  - ${change}`)
+  const formattedChanges = changes.map((change) => `  - ${change}`)
   formattedChanges.unshift(`${tag} ${date}`)
-  if (typeof start !== 'undefined' && typeof length !== 'undefined') {
+  if (typeof start !== "undefined" && typeof length !== "undefined") {
     changelogLines.splice(start, length, ...formattedChanges)
   } else {
     changelogLines.unshift(...formattedChanges)
   }
-  return changelogLines.join('\n') + '\n'
+  return changelogLines.join("\n") + "\n"
 }
 
 /**
@@ -70,9 +71,11 @@ export const spliceChangelog = (changelog, tag, date, changes) => {
  * @param {string} revision Git name for the requested ref
  */
 export const changesUrl = (datasetId, revision) => {
-  return `http://${getDatasetWorker(
-    datasetId,
-  )}/datasets/${datasetId}/snapshots/${revision}/files/CHANGES`
+  return `http://${
+    getDatasetWorker(
+      datasetId,
+    )
+  }/datasets/${datasetId}/snapshots/${revision}/files/CHANGES`
 }
 
 /**
@@ -82,15 +85,15 @@ export const changesUrl = (datasetId, revision) => {
  * @param {string[]} changes
  */
 export const updateChanges = async (datasetId, tag, changes, user) => {
-  const currentChangesReq = await fetch(changesUrl(datasetId, 'HEAD'))
+  const currentChangesReq = await fetch(changesUrl(datasetId, "HEAD"))
   const currentChanges = await currentChangesReq.text()
-  const changeLogDate = format(new Date(), 'YYYY-MM-DD')
+  const changeLogDate = format(new Date(), "YYYY-MM-DD")
   const updatedChangelog = spliceChangelog(
     currentChanges,
     tag,
     changeLogDate,
     changes,
   )
-  await addFileString(datasetId, 'CHANGES', 'text/plain', updatedChangelog)
+  await addFileString(datasetId, "CHANGES", "text/plain", updatedChangelog)
   return commitFiles(datasetId, user)
 }