summaryrefslogtreecommitdiff
path: root/spec/frontend/captcha/apollo_captcha_link_spec.js
blob: eab52344d1fd8b6558171f15343a27941f9b2de5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
import { ApolloLink, Observable } from '@apollo/client/core';

import { apolloCaptchaLink } from '~/captcha/apollo_captcha_link';
import UnsolvedCaptchaError from '~/captcha/unsolved_captcha_error';
import { waitForCaptchaToBeSolved } from '~/captcha/wait_for_captcha_to_be_solved';

jest.mock('~/captcha/wait_for_captcha_to_be_solved');

describe('apolloCaptchaLink', () => {
  const SPAM_LOG_ID = 'SPAM_LOG_ID';
  const CAPTCHA_SITE_KEY = 'CAPTCHA_SITE_KEY';
  const CAPTCHA_RESPONSE = 'CAPTCHA_RESPONSE';

  const SUCCESS_RESPONSE = {
    data: {
      user: {
        id: 3,
        name: 'foo',
      },
    },
    errors: [],
  };

  const NON_CAPTCHA_ERROR_RESPONSE = {
    data: {
      user: null,
    },
    errors: [
      {
        message: 'Something is severely wrong with your query.',
        path: ['user'],
        locations: [{ line: 2, column: 3 }],
        extensions: {
          message: 'Object not found',
          type: 2,
        },
      },
    ],
  };

  const SPAM_ERROR_RESPONSE = {
    data: {
      user: null,
    },
    errors: [
      {
        message: 'Your Query was detected to be spam.',
        path: ['user'],
        locations: [{ line: 2, column: 3 }],
        extensions: {
          spam: true,
        },
      },
    ],
  };

  const CAPTCHA_ERROR_RESPONSE = {
    data: {
      user: null,
    },
    errors: [
      {
        message: 'This is an unrelated error, captcha should still work despite this.',
        path: ['user'],
        locations: [{ line: 2, column: 3 }],
      },
      {
        message: 'You need to solve a Captcha.',
        path: ['user'],
        locations: [{ line: 2, column: 3 }],
        extensions: {
          spam: true,
          needs_captcha_response: true,
          captcha_site_key: CAPTCHA_SITE_KEY,
          spam_log_id: SPAM_LOG_ID,
        },
      },
    ],
  };

  let link;

  let mockLinkImplementation;
  let mockContext;

  const setupLink = (...responses) => {
    mockLinkImplementation = jest.fn().mockImplementation(() => {
      return Observable.of(responses.shift());
    });
    link = ApolloLink.from([apolloCaptchaLink, new ApolloLink(mockLinkImplementation)]);
  };

  function mockOperation() {
    mockContext = jest.fn();
    return { operationName: 'operation', variables: {}, setContext: mockContext };
  }

  it('successful responses are passed through', (done) => {
    setupLink(SUCCESS_RESPONSE);
    link.request(mockOperation()).subscribe((result) => {
      expect(result).toEqual(SUCCESS_RESPONSE);
      expect(mockLinkImplementation).toHaveBeenCalledTimes(1);
      expect(waitForCaptchaToBeSolved).not.toHaveBeenCalled();
      done();
    });
  });

  it('non-spam related errors are passed through', (done) => {
    setupLink(NON_CAPTCHA_ERROR_RESPONSE);
    link.request(mockOperation()).subscribe((result) => {
      expect(result).toEqual(NON_CAPTCHA_ERROR_RESPONSE);
      expect(mockLinkImplementation).toHaveBeenCalledTimes(1);
      expect(mockContext).not.toHaveBeenCalled();
      expect(waitForCaptchaToBeSolved).not.toHaveBeenCalled();
      done();
    });
  });

  it('unresolvable spam errors are passed through', (done) => {
    setupLink(SPAM_ERROR_RESPONSE);
    link.request(mockOperation()).subscribe((result) => {
      expect(result).toEqual(SPAM_ERROR_RESPONSE);
      expect(mockLinkImplementation).toHaveBeenCalledTimes(1);
      expect(mockContext).not.toHaveBeenCalled();
      expect(waitForCaptchaToBeSolved).not.toHaveBeenCalled();
      done();
    });
  });

  describe('resolvable spam errors', () => {
    it('re-submits request with spam headers if the captcha modal was solved correctly', (done) => {
      waitForCaptchaToBeSolved.mockResolvedValue(CAPTCHA_RESPONSE);
      setupLink(CAPTCHA_ERROR_RESPONSE, SUCCESS_RESPONSE);
      link.request(mockOperation()).subscribe((result) => {
        expect(result).toEqual(SUCCESS_RESPONSE);
        expect(waitForCaptchaToBeSolved).toHaveBeenCalledWith(CAPTCHA_SITE_KEY);
        expect(mockContext).toHaveBeenCalledWith({
          headers: {
            'X-GitLab-Captcha-Response': CAPTCHA_RESPONSE,
            'X-GitLab-Spam-Log-Id': SPAM_LOG_ID,
          },
        });
        expect(mockLinkImplementation).toHaveBeenCalledTimes(2);
        done();
      });
    });

    it('throws error if the captcha modal was not solved correctly', (done) => {
      const error = new UnsolvedCaptchaError();
      waitForCaptchaToBeSolved.mockRejectedValue(error);

      setupLink(CAPTCHA_ERROR_RESPONSE, SUCCESS_RESPONSE);
      link.request(mockOperation()).subscribe({
        next: done.catch,
        error: (result) => {
          expect(result).toEqual(error);
          expect(waitForCaptchaToBeSolved).toHaveBeenCalledWith(CAPTCHA_SITE_KEY);
          expect(mockContext).not.toHaveBeenCalled();
          expect(mockLinkImplementation).toHaveBeenCalledTimes(1);
          done();
        },
      });
    });
  });
});