elasticio / maester-client Goto Github PK

It should expose re-usable CRUD format

Skip any use of get-stream if getting a stream
Call getStream from get-stream if getting a string
Call getStream.bugger() from get-stream if getting a buffer

Method lookupObjectByQueryParameter returns string instead of Object or array. Parsing the response is on user now. Makes sense to add this logic to the method itself

Platform team requirements:

• Nightly tests in CI.
• Disable dev dependencies check during audit.
• Version should adhere to semver rules. Breaking change - new major version.
• All tests from object-storage-client must be present here. Especially which cover some edge cases (like passing the same stream on retry).
• Exponential back-off like in object-storage-client.
• All errors should be handled like in latest object-storage-client. Now they don't. E.g. I don't see Client error handler.

Now related to how our services are using the lib (I didn't check you PR in details and not sure you saved these features, most likely you did):

• We should be able to create an instance to make add/update/delete requests. The instance should accept maester uri and jwtSecret.
• Each method that modifies DB object should accept ttl. ttl can have -1 value.
• There should be ability to add stream for encrypt/decrypt.
• There should be ability to GET object as stream with specified jwt payload.
• There should be ability to PUT as stream with retries: 0.
• There should be ability to PUT with custom ttl and contentType (we get it from webhook request headers).
• There should be ability to POST a json object.
• There should be ability to GET object as json object.
• There should be ability to DELETE an object by ID.

Looks like it is a duplicate for one functionality:
https://github.com/elasticio/maester-client/blob/master/src/object.ts#L170

        if (params?.objectFields) {
            Object.entries(params.objectFields).forEach(e => {
                if (e[1].Query) headers[`X-Query-${e[0]}`] = e[1].Query;
                if (e[1].Meta) headers[`X-Meta-${e[0]}`] = e[1].Meta;
            })
        }

and
https://github.com/elasticio/maester-client/blob/master/src/object.ts#L24

export function metaToHeaders(meta: ObjectMetadata): Record<string, string> {
    const headers: Record<string, string> = {};
    for (const [key, value] of Object.entries(meta)) {
        headers[`${USER_META_HEADER_PREFIX}${key}`] = String(value);
    }
    return headers;
}

due to Maester service Bucket mark as deprecated

Update to whatever new version there will be after the fix elasticio/component-commons-library#87

Functionality was implemented here.