Skip to content

Automatically active script response #72

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

Merged
merged 4 commits into from
Sep 3, 2024
Merged
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
14 changes: 14 additions & 0 deletions __tests__/fetch_request.js
Original file line number Diff line number Diff line change
@@ -71,6 +71,20 @@ describe('perform', () => {
expect(renderSpy).toHaveBeenCalledTimes(1)
jest.clearAllMocks();
})

test('script request automatically calls activeScript', async () => {
const mockResponse = new Response('', { status: 200, headers: { 'Content-Type': 'application/javascript' }})
window.fetch = jest.fn().mockResolvedValue(mockResponse)
jest.spyOn(FetchResponse.prototype, "ok", "get").mockReturnValue(true)
jest.spyOn(FetchResponse.prototype, "isScript", "get").mockReturnValue(true)
const renderSpy = jest.spyOn(FetchResponse.prototype, "activeScript").mockImplementation()

const testRequest = new FetchRequest("get", "localhost")
await testRequest.perform()

expect(renderSpy).toHaveBeenCalledTimes(1)
jest.clearAllMocks();
})
})

test('treat method name case-insensitive', async () => {
52 changes: 30 additions & 22 deletions __tests__/fetch_response.js
Original file line number Diff line number Diff line change
@@ -16,45 +16,45 @@ describe('body accessors', () => {
test('works multiple times', async () => {
const mockResponse = new Response("Mock", { status: 200, headers: new Headers({'Content-Type': 'text/plain'}) })
const testResponse = new FetchResponse(mockResponse)


expect(await testResponse.text).toBe("Mock")
expect(await testResponse.text).toBe("Mock")
expect(await testResponse.text).toBe("Mock")
})
test('work regardless of content-type', async () => {
const mockResponse = new Response("Mock", { status: 200, headers: new Headers({'Content-Type': 'not/text'}) })
const testResponse = new FetchResponse(mockResponse)
expect(await testResponse.text).toBe("Mock")

expect(await testResponse.text).toBe("Mock")
})
})
describe('html', () => {
test('works multiple times', async () => {
const mockResponse = new Response("<h1>hi</h1>", { status: 200, headers: new Headers({'Content-Type': 'application/html'}) })
const testResponse = new FetchResponse(mockResponse)


expect(await testResponse.html).toBe("<h1>hi</h1>")
expect(await testResponse.html).toBe("<h1>hi</h1>")
expect(await testResponse.html).toBe("<h1>hi</h1>")
})
test('rejects on invalid content-type', async () => {
const mockResponse = new Response("<h1>hi</h1>", { status: 200, headers: new Headers({'Content-Type': 'text/plain'}) })
const testResponse = new FetchResponse(mockResponse)

expect(testResponse.html).rejects.toBeInstanceOf(Error)
})
})
describe('json', () => {
test('works multiple times', async () => {
const mockResponse = new Response(JSON.stringify({ json: 'body' }), { status: 200, headers: new Headers({'Content-Type': 'application/json'}) })
const testResponse = new FetchResponse(mockResponse)

// works mutliple times
expect({ json: 'body' }).toStrictEqual(await testResponse.json)
expect({ json: 'body' }).toStrictEqual(await testResponse.json)
})
test('rejects on invalid content-type', async () => {
const mockResponse = new Response("<h1>hi</h1>", { status: 200, headers: new Headers({'Content-Type': 'text/json'}) })
const testResponse = new FetchResponse(mockResponse)

expect(testResponse.json).rejects.toBeInstanceOf(Error)
})
})
@@ -85,7 +85,7 @@ describe('body accessors', () => {
const warningSpy = jest.spyOn(console, 'warn').mockImplementation()

await testResponse.renderTurboStream()

expect(warningSpy).toBeCalled()
})
test('calls turbo', async () => {
@@ -99,10 +99,18 @@ describe('body accessors', () => {
test('rejects on invalid content-type', async () => {
const mockResponse = new Response("<h1>hi</h1>", { status: 200, headers: new Headers({'Content-Type': 'text/plain'}) })
const testResponse = new FetchResponse(mockResponse)

expect(testResponse.renderTurboStream()).rejects.toBeInstanceOf(Error)
})
})
describe('script', () => {
test('rejects on invalid content-type', async () => {
const mockResponse = new Response("", { status: 200, headers: new Headers({'Content-Type': 'text/plain'}) })
const testResponse = new FetchResponse(mockResponse)

expect(testResponse.activeScript()).rejects.toBeInstanceOf(Error)
})
})
})

describe('fetch response helpers', () => {
@@ -135,46 +143,46 @@ describe('fetch response helpers', () => {
})
})
describe('http-status helpers', () => {

test('200', () => {
const mockResponse = new Response(null, { status: 200 })
const testResponse = new FetchResponse(mockResponse)

expect(testResponse.statusCode).toBe(200)
expect(testResponse.ok).toBeTruthy()
expect(testResponse.redirected).toBeFalsy()
expect(testResponse.redirected).toBeFalsy()
expect(testResponse.unauthenticated).toBeFalsy()
expect(testResponse.unprocessableEntity).toBeFalsy()
})

test('401', () => {
const mockResponse = new Response(null, { status: 401 })
const testResponse = new FetchResponse(mockResponse)

expect(testResponse.statusCode).toBe(401)
expect(testResponse.ok).toBeFalsy()
expect(testResponse.redirected).toBeFalsy()
expect(testResponse.redirected).toBeFalsy()
expect(testResponse.unauthenticated).toBeTruthy()
expect(testResponse.unprocessableEntity).toBeFalsy()
})

test('422', () => {
const mockResponse = new Response(null, { status: 422 })
const testResponse = new FetchResponse(mockResponse)

expect(testResponse.statusCode).toBe(422)
expect(testResponse.ok).toBeFalsy()
expect(testResponse.redirected).toBeFalsy()
expect(testResponse.redirected).toBeFalsy()
expect(testResponse.unauthenticated).toBeFalsy()
expect(testResponse.unprocessableEntity).toBeTruthy()
})

test('302', () => {
const mockHeaders = new Headers({'Location': 'https://localhost/login'})
const mockResponse = new Response(null, { status: 302, url: 'https://localhost/login', headers: mockHeaders })
jest.spyOn(mockResponse, 'redirected', 'get').mockReturnValue(true)
const testResponse = new FetchResponse(mockResponse)

expect(testResponse.statusCode).toBe(302)
expect(testResponse.ok).toBeFalsy()
expect(testResponse.redirected).toBeTruthy()
3 changes: 2 additions & 1 deletion __tests__/request_interceptor.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
/**
* @jest-environment jsdom
*/
import 'isomorphic-fetch'
import { RequestInterceptor } from '../src/request_interceptor'
import { FetchRequest } from '../src/fetch_request'

beforeEach(() => {
window.fetch = jest.fn().mockResolvedValue({ status: 200, body: "done" })
window.fetch = jest.fn().mockResolvedValue(new Response("success!", { status: 200, body: "done" }))
})

test('request intercepter is executed', async () => {
6 changes: 6 additions & 0 deletions src/fetch_request.js
Original file line number Diff line number Diff line change
@@ -25,6 +25,10 @@ export class FetchRequest {
return Promise.reject(window.location.href = response.authenticationURL)
}

if (response.isScript) {
await response.activeScript()
}

const responseStatusIsTurboStreamable = response.ok || response.unprocessableEntity

if (responseStatusIsTurboStreamable && response.isTurboStream) {
@@ -103,6 +107,8 @@ export class FetchRequest {
return 'text/vnd.turbo-stream.html, text/html, application/xhtml+xml'
case 'json':
return 'application/json, application/vnd.api+json'
case 'script':
return 'text/javascript, application/javascript'
default:
return '*/*'
}
17 changes: 17 additions & 0 deletions src/fetch_response.js
Original file line number Diff line number Diff line change
@@ -61,6 +61,10 @@ export class FetchResponse {
return this.contentType.match(/^text\/vnd\.turbo-stream\.html/)
}

get isScript () {
return this.contentType.match(/\b(?:java|ecma)script\b/)
}

async renderTurboStream () {
if (this.isTurboStream) {
if (window.Turbo) {
@@ -72,4 +76,17 @@ export class FetchResponse {
return Promise.reject(new Error(`Expected a Turbo Stream response but got "${this.contentType}" instead`))
}
}

async activeScript () {
if (this.isScript) {
const script = document.createElement('script')
const metaTag = document.querySelector('meta[name=csp-nonce]')
const nonce = metaTag && metaTag.content
if (nonce) { script.setAttribute('nonce', nonce) }
script.innerHTML = await this.text
document.body.appendChild(script)
} else {
return Promise.reject(new Error(`Expected a Script response but got "${this.contentType}" instead`))
}
}
}