open-consul/ui/packages/consul-ui/app/serializers/kv.js
John Cowen 299ecff703
ui: Adds @NullValue attr decorator (#9587)
There are many places in the API where we receive a property set to
`null` which can then lead to defensive code deeper in the app in order
to guard for this type of thing when usually we are expecting an array
or for the property to be undefined using omitempty on the backend.

Previously we had two places where we would deal with this in the
serializer using our 'remove-null' util (KV and Intentions).

This new decorator lets you declaritively define this type of data using
a decorator @NullValue([]) (which would replce a null value with [].

@NullValue in turn uses a more generic @replace helper, which we
currently don't need but would let you replace any value with another,
not just a null value.

An additional benefit here is that the guard/replacement is executed
lazily when we get the property instead of serializing all the values
when they come in via the API. On super large datasets, where we only
visualize part of the dataset (say in our scroll panes), this feels like
a good improvement on the previous approach.
2021-01-27 10:41:24 +00:00

44 lines
1.2 KiB
JavaScript

import Serializer from './application';
import { inject as service } from '@ember/service';
import { PRIMARY_KEY, SLUG_KEY } from 'consul-ui/models/kv';
import { NSPACE_KEY } from 'consul-ui/models/nspace';
import { NSPACE_QUERY_PARAM as API_NSPACE_KEY } from 'consul-ui/adapters/application';
export default class KvSerializer extends Serializer {
@service('atob') decoder;
primaryKey = PRIMARY_KEY;
slugKey = SLUG_KEY;
// TODO: Would undefined be better instead of null?
serialize(snapshot, options) {
const value = snapshot.attr('Value');
return typeof value === 'string' ? this.decoder.execute(value) : null;
}
respondForQueryRecord(respond, query) {
return super.respondForQueryRecord(
cb => respond((headers, body) => cb(headers, body[0])),
query
);
}
respondForQuery(respond, query) {
return super.respondForQuery(
cb =>
respond((headers, body) => {
return cb(
headers,
body.map(item => {
return {
[this.slugKey]: item,
[NSPACE_KEY]: query[API_NSPACE_KEY],
};
})
);
}),
query
);
}
}