idea-aws
    Preparing search index...

    Class ResourceControllerAbstract

    An abstract class to inherit to manage API requests (AWS API Gateway) in an AWS Lambda function.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    auth0User authorization body claims clientBundle clientPlatform clientVersion cognitoUser currentLang defaultLang event httpMethod initError? logger logRequestsWithKey metrics path pathParameters principalId project queryParams requestId resource resourceId resourcePath returnHeaders returnStatusCode? stage templateMatcher tracer tracerLambdaSegment tracerRCSegment translations

    Methods

    checkAuthBeforeRequest comesFromInternalRequest deleteResource deleteResources done getEventSummary getLambdaLogLevel getQueryParamAsArray getQueryParamAsBoolean getResource getResources handleControllerError handleRequest headResource headResources invokeInternalAPIRequest isInMaintenance loadSharedResource loadTranslations patchResource patchResources postResource postResources prepareMetrics publishMetrics putResource putResources setLambdaLogLevel sharedResourceExists silentLambdaLogs storeLog t

    Constructors

    Properties

    auth0User: Auth0User
    authorization: string

    Protectedbody

    body: any
    claims: any
    clientBundle: string = null
    clientPlatform: string = '?'
    clientVersion: string = '?'
    cognitoUser: CognitoUser
    currentLang: string
    defaultLang: string
    event: APIGatewayProxyEventV2 | APIGatewayProxyEvent
    httpMethod: string
    initError?: Error
    logger: LambdaLogger = ...
    logRequestsWithKey: string
    metrics: CloudWatchMetrics
    path: string
    pathParameters: any
    principalId: string
    project: string = PROJECT
    queryParams: any
    requestId: string

    The id API Gateway assigned to the request: the same value as the apigw-requestid (HTTP API) or x-amzn-RequestId (REST API) header of its response. It's logged in the request's START and END-* lines and added to the body of an unhandled error ({ message, requestId }), whose message is generic: the requester can report it, and it leads to the log line with the real cause — e.g. in CloudWatch Logs Insights, filter @message like "<requestId>". Note: there @requestId is a different value, the id of the Lambda invocation; read it from the lines found to get every other line of the same invocation.

    resource: string = RESOURCE
    resourceId: string
    resourcePath: string
    returnHeaders: Record<string, string> = ...
    returnStatusCode?: number
    stage: string = STAGE
    templateMatcher: RegExp = ...
    tracer: Tracer
    tracerLambdaSegment: any
    tracerRCSegment: any
    translations: any

    Methods

    • Whether the current request comes from an internal API request, i.e. it was invoked by another controller.

      Returns boolean

      don't run a Lambda from another Lambda (bad practice)

    • Parameters

      • limitBodyArrayDisplay: boolean = false

      Returns Record<string, any>

    • Get the current log level for the current Lambda function's logger. Note: "FATAL" means that no log will be printed.

      Returns "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR" | "FATAL"

    • Force the parsing of a query parameter as an array of strings.

      Parameters

      • paramName: string

      Returns string[]

    • Force the parsing of a query parameter as a boolean.

      Parameters

      • paramName: string

      Returns boolean

    • Whether the app is in maintenance, according to the status file its front-ends read (APP_STATUS_URL, e.g. the assets/status.json of the front-end's bucket); while it is, every request is answered 503, which a front-end on @idea-ionic/common >= 8.13.10 meets by reading its status again. Opt-in: without the variable, the API is never in maintenance. A file that can't be read leaves the last value known, or an open API the first time. Not for an app that reads its status through the API (viaApi): that request would be refused too, and the app would never show its maintenance page.

      Returns Promise<boolean>

    • Load a shared resource in the back-end (translation, template, etc.). Search for the specified file path in both the Lambda function's main folder and the layers folder.

      Parameters

      • filePath: string

      Returns string

    • Load the translations from the shared resources and set them with a fallback language.

      Parameters

      • lang: string
      • OptionaldefLang: string

      Returns void

    • Publish the CloudWatch metrics (default and custom-defined) at the end of a reqeust.

      Parameters

      • statusCode: number
      • Optionalerror: any

      Returns void

    • Set the log level for the current Lambda function's logger.

      Parameters

      • logLevel: "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR" | "FATAL"

      Returns void

    • Check whether shared resource exists in the back-end (translation, template, etc.). Search for the specified file path in both the Lambda function's main folder and the layers folder.

      Parameters

      • filePath: string

      Returns boolean

    • Store the log associated to the request (no response/error handling).

      Parameters

      • succeeded: boolean

      Returns Promise<void>

    • Get a translated term by key, optionally interpolating variables (e.g. {{user}}). If the term doesn't exist in the current language, it is searched in the default language.

      Parameters

      • key: string
      • OptionalinterpolateParams: any

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods