chore: remove noteFromQuote mutations (#1034)

* chore: remove noteFromQuote mutations Clients will handle formatting (or not) quoted notes using the createNote mutations instead. * chore: lint and codegen
Pocket · Jan 28, 2025 · 8980227 · 8980227
1 parent 6d11e36
commit 8980227
Show file tree

Hide file tree

Showing 10 changed files with 4 additions and 835 deletions.
diff --git a/servers/notes-api/schema.graphql b/servers/notes-api/schema.graphql
@@ -277,72 +277,6 @@ input CreateNoteMarkdownInput {
   createdAt: ISOString
 }
 
-"""
-Input to create a new Note seeded with copied content from a page.
-The entire content becomes editable and is not able to be "reattached"
-like a traditional highlight.
-"""
-input CreateNoteFromQuoteInput {
-  """Optional title for this Note"""
-  title: String
-  """
-  Client-provided UUID for the new Note.
-  If not provided, will be generated on the server.
-  """
-  id: ID
-  """
-  The Web Resource where the quote is taken from.
-  This should always be sent by the client where possible,
-  but in some cases (e.g. copying from mobile apps) there may
-  not be an accessible source url.
-  """
-  source: ValidUrl
-  """
-  JSON representation of a ProseMirror document, which
-  contains the formatted snipped text. This is used to seed
-  the initial Note document state, and will become editable.
-  """
-  quote: ProseMirrorJson!
-  """
-  When this note was created. If not provided, defaults to server time upon
-  receiving request.
-  """
-  createdAt: ISOString
-}
-
-"""
-Input to create a new Note seeded with copied content from a page.
-The entire content becomes editable and is not able to be "reattached"
-like a traditional highlight.
-"""
-input CreateNoteFromQuoteMarkdownInput {
-  """Optional title for this Note"""
-  title: String
-  """
-  Client-provided UUID for the new Note.
-  If not provided, will be generated on the server.
-  """
-  id: ID
-  """
-  The Web Resource where the quote is taken from.
-  This should always be sent by the client where possible,
-  but in some cases (e.g. copying from mobile apps) there may
-  not be an accessible source url.
-  """
-  source: ValidUrl
-  """
-  Commonmark Markdown document, which contains the formatted 
-  snipped text. This is used to seed the initial Note 
-  document state, and will become editable.
-  """
-  quote: Markdown!
-  """
-  When this note was created. If not provided, defaults to server time upon
-  receiving request.
-  """
-  createdAt: ISOString
-}
-
 input EditNoteTitleInput {
   """The ID of the note to edit"""
   id: ID!
@@ -427,16 +361,6 @@ type Mutation {
   Create a new note, optionally with title and markdown content
   """
   createNoteMarkdown(input: CreateNoteMarkdownInput!): Note! @requiresScopes(scopes: [["ROLE_USER"]])
-  """
-  Create a new note, with a pre-populated block that contains the quoted and cited text
-  selected by a user.
-  """
-  createNoteFromQuote(input: CreateNoteFromQuoteInput!): Note! @requiresScopes(scopes: [["ROLE_USER"]])
-  """
-  Create a new note, with a pre-populated block that contains the quoted and cited text
-  selected by a user.
-  """
-  createNoteFromQuoteMarkdown(input: CreateNoteFromQuoteMarkdownInput!): Note! @requiresScopes(scopes: [["ROLE_USER"]])
 
   """
   Edit the title of a Note.

diff --git a/servers/notes-api/src/__generated__/graphql.ts b/servers/notes-api/src/__generated__/graphql.ts
diff --git a/servers/notes-api/src/apollo/resolvers.ts b/servers/notes-api/src/apollo/resolvers.ts
@@ -69,12 +69,6 @@ export const resolvers: Resolvers = {
     createNoteMarkdown(root, { input }, context) {
       return context.NoteModel.createFromMarkdown(input);
     },
-    createNoteFromQuote(root, { input }, context) {
-      return context.NoteModel.fromQuote(input);
-    },
-    createNoteFromQuoteMarkdown(root, { input }, context) {
-      return context.NoteModel.fromMarkdownQuote(input);
-    },
     editNoteTitle(root, { input }, context) {
       return context.NoteModel.editTitle(input);
     },

diff --git a/servers/notes-api/src/models/Note.ts b/servers/notes-api/src/models/Note.ts
@@ -2,11 +2,9 @@ import DataLoader from 'dataloader';
 import {
   Note,
   CreateNoteInput,
-  CreateNoteFromQuoteInput,
   EditNoteTitleInput,
   EditNoteContentInput,
   DeleteNoteInput,
-  CreateNoteFromQuoteMarkdownInput,
   CreateNoteMarkdownInput,
   EditNoteContentMarkdownInput,
   ArchiveNoteInput,
@@ -16,11 +14,7 @@ import { Insertable, NoResultError, Selectable } from 'kysely';
 import { orderAndMap } from '../utils/dataloader';
 import { IContext } from '../apollo/context';
 import { NotesService } from '../datasources/NoteService';
-import {
-  docFromMarkdown,
-  ProseMirrorDoc,
-  wrapDocInBlockQuote,
-} from './ProseMirrorDoc';
+import { docFromMarkdown, ProseMirrorDoc } from './ProseMirrorDoc';
 import { DatabaseError } from 'pg';
 import {
   NoteFilterInput,
@@ -192,46 +186,6 @@ export class NoteModel {
     };
     return await this.create(createInput);
   }
-  /**
-   * Create a new Note seeded with a blockquote (optionally with
-   * an additional paragraph with the source link).
-   */
-  async fromQuote(input: CreateNoteFromQuoteInput) {
-    try {
-      const docContent = JSON.parse(input.quote);
-      const options =
-        input.source != null ? { source: input.source.toString() } : undefined;
-      const quotedDoc = wrapDocInBlockQuote(docContent, options);
-      const createInput: CreateNoteInput = {
-        docContent: JSON.stringify(quotedDoc),
-        createdAt: input.createdAt,
-        id: input.id,
-        title: input.title,
-        source: input.source,
-      };
-      return this.create(createInput);
-    } catch (error) {
-      if (error instanceof SyntaxError) {
-        throw new UserInputError(
-          `Received malformed JSON for docContent: ${error.message}`,
-        );
-      } else {
-        throw error;
-      }
-    }
-  }
-  /**
-   * Create a new Note seeded with a blockquote (optionally with
-   * an additional paragraph with the source link).
-   */
-  async fromMarkdownQuote(input: CreateNoteFromQuoteMarkdownInput) {
-    const quote = docFromMarkdown(input.quote);
-    const createInput: CreateNoteFromQuoteInput = {
-      ...input,
-      quote: JSON.stringify(quote.toJSON()),
-    };
-    return await this.fromQuote(createInput);
-  }
   /**
    * Edit a note's title
    */

diff --git a/servers/notes-api/src/models/ProseMirrorDoc.spec.ts b/servers/notes-api/src/models/ProseMirrorDoc.spec.ts
@@ -1,13 +1,7 @@
 import basicText from '../test/documents/basicText.json';
-import {
-  docFromMarkdown,
-  ProseMirrorDoc,
-  wrapDocInBlockQuote,
-} from './ProseMirrorDoc';
+import { docFromMarkdown, ProseMirrorDoc } from './ProseMirrorDoc';
 import { schema } from 'prosemirror-markdown';
-import fromQuote from '../test/documents/fromQuote.json';
 import badMd from '../test/documents/badMd.json';
-import { UserInputError } from '@pocket-tools/apollo-utils';
 import * as fs from 'fs';
 import path from 'path';
 
@@ -30,38 +24,6 @@ describe('ProseMirrorDoc', () => {
       expect(doc.markdown).toBeString();
     });
   });
-  describe('quote constructor', () => {
-    it('wraps quote in blockquote and adds attribution', () => {
-      const { input, expectedSource } = fromQuote;
-      const actual = wrapDocInBlockQuote(input, { source: 'localhost:3001' });
-      expect(actual).toEqual(expectedSource);
-    });
-    it('wraps quote in blockquote without attribution', () => {
-      const { input, expectedNoSource } = fromQuote;
-      const actual = wrapDocInBlockQuote(input);
-      expect(actual).toEqual(expectedNoSource);
-    });
-    it('throws error if an invalid node is encountered', () => {
-      const bad = {
-        type: 'doc',
-        content: [
-          {
-            type: 'invalid',
-            content: [
-              {
-                type: 'text',
-                text: '',
-              },
-            ],
-          },
-        ],
-      };
-      expect(() => wrapDocInBlockQuote(bad)).toThrowWithMessage(
-        UserInputError,
-        /.*Invalid Document.*/,
-      );
-    });
-  });
   describe('markdown parser', () => {
     it('parses plain text paragraphs', () => {
       const doc = docFromMarkdown(basicTextMd);