Skip to content

Refactor: Move GraphQL schema definitions to .gql files #280

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.

Sign up for GitHub

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

Draft
danielemery wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Refactor: Move GraphQL schema definitions to .gql files #280

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
350 changes: 287 additions & 63 deletions package-lock.json
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@
"@aws-sdk/s3-request-presigner": "^3.118.0",
"@aws-sdk/util-create-request": "^3.341.0",
"@google/generative-ai": "^0.24.0",
"@graphql-tools/load-files": "^7.0.1",
"@graphql-tools/merge": "^9.0.24",
"@prisma/client": "^6.5.0",
"@sentry/node": "^9.7.0",
"@sentry/profiling-node": "^9.7.0",
Expand Down
30 changes: 30 additions & 0 deletions src/activity/activity.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
"Optional action that can be taken when the activity is clicked"
type RecentActivityAction {
"Name of the action to take when the activity is clicked"
name: String!
"Link to the url to navigate to when the activity is clicked"
link: String!
}

"An item in the recent activity feed"
type RecentActivityItem {
"The date the activity occurred"
date: Date!
"The type of activity that occurred"
actionType: ActivityActionType!
"The id of the resource that the activity relates to"
resourceId: String!
"The text to display for the activity"
text: String!
"The user who performed the activity"
users: [User]!
"Optional action to take when the activity is clicked"
action: RecentActivityAction
}

extend type Query {
"""
Get the most recent activities.
"""
activityFeed: [RecentActivityItem]
}
332 changes: 30 additions & 302 deletions src/gql.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,304 +1,32 @@
import gql from 'graphql-tag';

const typeDefs = gql`
scalar Date

enum QuizType {
SHARK
BRAINWAVES
}

enum QuizImageState {
PENDING_UPLOAD
READY
}

enum QuizAIProcessingState {
NOT_QUEUED
QUEUED
COMPLETED
ERRORED
}

enum UserRole {
USER
ADMIN
}

enum QuizImageType {
QUESTION
ANSWER
QUESTION_AND_ANSWER
}

enum UserSortOption {
EMAIL_ASC
NAME_ASC
NUMBER_OF_QUIZZES_COMPLETED_WITH_DESC
}

enum IndividualUserStatisticsSortOption {
QUIZZES_COMPLETED_DESC
AVERAGE_SCORE_DESC
}

enum ActivityActionType {
QUIZ_COMPLETED
QUIZ_UPLOADED
}

type PageInfo {
hasNextPage: Boolean
startCursor: String
endCursor: String
}

type Quiz {
id: String!
type: QuizType!
date: Date!
uploadedAt: Date!
uploadedBy: User!
myCompletions: [QuizCompletion]
}

type QuizImage {
imageLink: String!
state: QuizImageState!
type: QuizImageType!
}

type QuizQuestion {
id: String!
questionNum: Int!
question: String!
answer: String!
}

type QuizDetails {
id: String!
type: QuizType!
date: Date!
uploadedAt: Date!
uploadedBy: User!
completions: [QuizCompletionWithQuestionResults]
images: [QuizImage]
"""
If the quiz has been successfully parsed, this will be a list of questions and answers.
"""
questions: [QuizQuestion]
"""
The current state of the AI processing for this quiz.
"""
aiProcessingState: QuizAIProcessingState!
"""
The certainty, as reported by the ai, that the quiz was processed correctly.
"""
aiProcessingCertaintyPercent: Float
"""
True if a user has marked the OCR for this quiz as inaccurate.
"""
reportedInaccurateOCR: Boolean
}

type QuizEdge {
node: Quiz!
cursor: String!
}

type QuizConnection {
edges: [QuizEdge]!
pageInfo: PageInfo!
}

type UserDetails {
email: String!
roles: [UserRole]!
}

type User {
email: String!
name: String
}

type UserEdge {
node: User!
cursor: String!
}

type UserConnection {
edges: [UserEdge]!
pageInfo: PageInfo!
}

input CreateQuizFile {
fileName: String!
type: QuizImageType!
}

type CreateQuizFileNameToUploadLink {
fileName: String!
link: String!
}

type CreateQuizResult {
quiz: Quiz!
uploadLinks: [CreateQuizFileNameToUploadLink]!
}

enum QuizCompletionQuestionResultScore {
"""
The question was answered correctly.
"""
CORRECT
"""
The question was answered incorrectly.
"""
INCORRECT
"""
The question was answered and gauged as half correct.
"""
HALF_CORRECT
}

input QuizCompletionQuestionResult {
questionNum: Int!
score: QuizCompletionQuestionResultScore!
}

type QuizCompletion {
completedAt: Date!
completedBy: [User]!
score: Float!
}

type QuizCompletionWithQuestionResultsQuestionResult {
questionId: String!
score: QuizCompletionQuestionResultScore!
}

type QuizCompletionWithQuestionResults {
completedAt: Date!
completedBy: [User]!
score: Float!
questionResults: [QuizCompletionWithQuestionResultsQuestionResult]
}

type CompleteQuizResult {
completion: QuizCompletion
}

type IndividualUserStatistic {
name: String
email: String!
totalQuizCompletions: Int!
averageScorePercentage: Float!
}

enum ExcludeIllegibleOptions {
"""
Exclude quizzes that have been marked as illegible by me.
"""
ME
"""
Exclude quizzes that have been marked as illegible by anyone.
"""
ANYONE
}

"Optional action that can be taken when the activity is clicked"
type RecentActivityAction {
"Name of the action to take when the activity is clicked"
name: String!
"Link to the url to navigate to when the activity is clicked"
link: String!
}

"An item in the recent activity feed"
type RecentActivityItem {
"The date the activity occurred"
date: Date!
"The type of activity that occurred"
actionType: ActivityActionType!
"The id of the resource that the activity relates to"
resourceId: String!
"The text to display for the activity"
text: String!
"The user who performed the activity"
users: [User]!
"Optional action to take when the activity is clicked"
action: RecentActivityAction
}

"Available filters for the quizzes query"
input QuizFilters {
"""
Optional list of user emails.
If provided, only quizzes completed by none of these users will be included in the results.
"""
excludeCompletedBy: [String]
"""
Optional option to exclude quizzes that have been marked as illegible.
"""
excludeIllegible: ExcludeIllegibleOptions
}

type Query {
"""
Get a paged list of quizzes.
Optionally filter using the filters parameter.
"""
quizzes(
"The number of results to return, capped at 100"
first: Int
"The cursor to start returning results from, for pagination"
after: String
"The filters to apply to the query"
filters: QuizFilters
): QuizConnection
quiz(id: String!): QuizDetails
"""
Get a paged list of users.
"""
users(first: Int, after: String, sortedBy: UserSortOption): UserConnection
me: UserDetails
"""
Get statistics for every user.
Optionally sort using the sortedBy parameter.

Results from this endpoint may be delayed by up to 24 hours.
"""
individualUserStatistics(
"The sorting option to use"
sortedBy: IndividualUserStatisticsSortOption
): [IndividualUserStatistic]

"""
Get the most recent activities.
"""
activityFeed: [RecentActivityItem]
}

type Mutation {
createQuiz(type: QuizType!, date: Date!, files: [CreateQuizFile]): CreateQuizResult
completeQuiz(
quizId: String!
completedBy: [String]!
"""
Optionally provide the total score of the quiz.
If not provided the individual question results will be used to calculate the score.
"""
score: Float
"""
Optionally provide the results of each question in the quiz.
If provided, the score will be calculated using these results, otherwise the score argument will be used.
"""
questionResults: [QuizCompletionQuestionResult]
): CompleteQuizResult
markQuizIllegible(quizId: String!): Boolean
markInaccurateOCR(quizId: String!): Boolean
aiProcessQuizImages(quizId: String!): Boolean
}
`;
import { loadFilesSync } from '@graphql-tools/load-files';
import { mergeTypeDefs } from '@graphql-tools/merge';
import path from 'path';

// Define the paths to the GraphQL files.
// It's important to load schema.graphql first as it contains base definitions.
const baseSchemaPath = path.join(__dirname, 'schema.graphql');
const domainSchemaPaths = [
path.join(__dirname, 'activity/activity.graphql'),
path.join(__dirname, 'quiz/quiz.graphql'),
path.join(__dirname, 'statistics/statistics.graphql'),
path.join(__dirname, 'user/user.graphql'),
];

// Load the base schema and domain-specific schemas.
// loadFilesSync returns an array of DocumentNode | string based on the input.
// We'll ensure they are loaded correctly.
const baseTypeDefs = loadFilesSync(baseSchemaPath);
const domainTypeDefs = domainSchemaPaths.flatMap(p => loadFilesSync(p));

Check failure on line 19 in src/gql.ts

View workflow job for this annotation

GitHub Actions / test 

Replace `p` with `(p)`

// Merge the type definitions.
// mergeTypeDefs can take an array of sources (DocumentNode, strings, etc.).
const typeDefs = mergeTypeDefs([...baseTypeDefs, ...domainTypeDefs]);

// The 'typeDefs' is likely a DocumentNode, which is generally what Apollo Server expects.
// If it were a string, and the rest of the application expected a gql tag,
// we would do:
// import gql from 'graphql-tag';
// export default gql(typeDefs);
// However, mergeTypeDefs usually produces a DocumentNode.

export default typeDefs;
Loading
Loading