mirror of
https://github.com/compiler-explorer/compiler-explorer.git
synced 2026-05-16 16:02:45 -04:00
d7c4eecbf7
Refactors the handler for the AsmDocs API to reduce code duplication. **Breaking changes proposed** - API will now return 404. This used to return 200 with "Unknown opcode" which is what led to issue #3117. Following cases has been changed: 1. archiecture was not found 2. instruction opcode was not found - API will now return 406 not acceptable when the accepted content type is not text or json - There is no longer a `result` field on a 200 request, instead the assembly documentation object is returned. - There is no longer a `found` field on any request, the HTTP codes indicate whether it was found or not (200 means found) **New features** - The frontend will only request the opcode for an instruction set at most once, caching every single outgoing request. - The "There was an error fetching the documentation for this opcode" has been adjusted to contain what went wrong. Relevant tests have been added and updated.
47 lines
2.1 KiB
TypeScript
47 lines
2.1 KiB
TypeScript
// Copyright (c) 2021, Compiler Explorer Authors
|
|
// All rights reserved.
|
|
//
|
|
// Redistribution and use in source and binary forms, with or without
|
|
// modification, are permitted provided that the following conditions are met:
|
|
//
|
|
// * Redistributions of source code must retain the above copyright notice,
|
|
// this list of conditions and the following disclaimer.
|
|
// * Redistributions in binary form must reproduce the above copyright
|
|
// notice, this list of conditions and the following disclaimer in the
|
|
// documentation and/or other materials provided with the distribution.
|
|
//
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
|
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
// POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
import { AssemblyDocumentationResponse, AssemblyDocumentationRequest } from './assemblydocumentation.interfaces';
|
|
|
|
/** Type wrapper allowing .json() to resolve to a concrete type */
|
|
type TypedResponse<R> = Response & {
|
|
json(): Promise<R>
|
|
}
|
|
|
|
/** Lightweight fetch() wrapper for CE API urls */
|
|
const request = async <R>(uri: string, options?: RequestInit): Promise<TypedResponse<R>> => fetch(
|
|
`${window.location.origin}${window.httpRoot}api${uri}`,
|
|
{
|
|
...options,
|
|
headers: {
|
|
...options?.headers,
|
|
'Accept': 'application/json',
|
|
}
|
|
},
|
|
);
|
|
|
|
export const getAssemblyDocumentation = async (
|
|
options: AssemblyDocumentationRequest
|
|
) => request<AssemblyDocumentationResponse>(`/asm/${options.instructionSet}/${options.opcode}`);
|