Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(server): Migrate summary and permission resolvers to TypeScript #2858

Merged
merged 1 commit into from
Jul 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import {
states,
checkDatasetWrite,
checkDatasetAdmin,
} from '../permissions.js'
} from '../permissions'

vi.mock('ioredis')

Expand Down
4 changes: 2 additions & 2 deletions packages/openneuro-server/src/graphql/resolvers/dataset.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ import {
checkDatasetRead,
checkDatasetWrite,
checkDatasetAdmin,
} from '../permissions.js'
} from '../permissions'
import { user } from './user.js'
import { permissions } from './permissions.js'
import { permissions } from './permissions'
import { datasetComments } from './comment.js'
import { metadata } from './metadata.js'
import { history } from './history.js'
Expand Down
2 changes: 1 addition & 1 deletion packages/openneuro-server/src/graphql/resolvers/draft.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Summary from '../../models/summary'
import { summary } from './summary.js'
import { summary } from './summary'
import { issues } from './issues.js'
import { description } from './description.js'
import { readme } from './readme.js'
Expand Down
4 changes: 2 additions & 2 deletions packages/openneuro-server/src/graphql/resolvers/mutation.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ import {
undoDeprecateSnapshot,
} from './snapshots.js'
import { removeUser, setAdmin, setBlocked } from './user.js'
import { updateSummary } from './summary.js'
import { updateSummary } from './summary'
import { revalidate, updateValidation } from './validation.js'
import { updatePermissions, removePermissions } from './permissions.js'
import { updatePermissions, removePermissions } from './permissions'
import { followDataset } from './follow.js'
import { starDataset } from './stars.js'
import { publishDataset } from './publish.js'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,17 +1,25 @@
import User from '../../models/user'
import Permission from '../../models/permission'
import User, { UserDocument } from '../../models/user'
import Permission, { PermissionDocument } from '../../models/permission'
import { checkDatasetAdmin } from '../permissions'
import { user } from './user'
import pubsub from '../pubsub.js'

export const permissions = async ds => {
interface DatasetPermission {
id: string
userPermissions: (PermissionDocument & { user: Promise<UserDocument> })[]
}

export async function permissions(ds): Promise<DatasetPermission> {
const permissions = await Permission.find({ datasetId: ds.id }).exec()
return {
id: ds.id,
userPermissions: permissions.map(userPermission => ({
...userPermission.toJSON(),
user: user(ds, { id: userPermission.userId }),
})),
userPermissions: permissions.map(
userPermission =>
({
...userPermission.toJSON(),
user: user(ds, { id: userPermission.userId }),
} as PermissionDocument & { user: Promise<UserDocument> }),
),
}
}

Expand Down Expand Up @@ -53,7 +61,7 @@ export const updatePermissions = async (obj, args, { user, userInfo }) => {
}

const userPromises = users.map(user => {
return new Promise((resolve, reject) => {
return new Promise<void>((resolve, reject) => {
Permission.updateOne(
{
datasetId: args.datasetId,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { onBrainlife } from './brainlife'
import { checkDatasetRead, checkDatasetWrite } from '../permissions.js'
import { readme } from './readme.js'
import { description } from './description.js'
import { summary } from './summary.js'
import { summary } from './summary'
import { snapshotIssues } from './issues.js'
import { getFiles } from '../../datalad/files'
import Summary from '../../models/summary'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import Summary from '../../models/summary'
import Summary, { SummaryDocument } from '../../models/summary'

/**
* Summary resolver
*/
export const summary = async dataset => {
export async function summary(dataset): Promise<Partial<SummaryDocument>> {
const datasetSummary = (
await Summary.findOne({
id: dataset.revision,
Expand Down
2 changes: 2 additions & 0 deletions packages/openneuro-server/src/models/summary.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ export interface SummaryDocument extends Document {
subjectMetadata: Record<string, any>
tasks: string[]
modalities: string[]
primaryModality: string
secondaryModalities: string[]
dataTypes: string[]
totalFiles: number
Expand All @@ -33,6 +34,7 @@ const summarySchema = new Schema({
subjectMetadata: Object,
tasks: [String],
modalities: [String],
primaryModality: String,
secondaryModalities: [String],
dataTypes: [String],
totalFiles: Number,
Expand Down