open-consul/ui-v2/app/adapters/kv.js
John Cowen 4ad691fa2f Looking into atob functionality, consequence of Value: null
The Consul API can pass through `Value: null` which does not get cast to
a string by ember-data. This snowballs into problems with `atob` which
then tried to decode `null`.

There are 2 problems here.

1. `Value` should never be `null`
  - I've added a removeNull function to shallowly loop though props and
  remove properties that are `null`, for the moment this is only on
  single KV JSON responses - therefore `Value` will never be `null`
  which is the root of the problem

2. `atob` doesn't quite follow the `window.atob` API in that the
`window.atob` API casts everything down to a string first, therefore it
will try to decode `null` > `'null'` > `crazy unicode thing`.
  - I've commented in a fix for this, but whilst this shouldn't be
  causing anymore problems in our UI (now that `Value` is never `null`),
  I'll uncomment it in another future release. Tests are already written
  for it which more closely follow `window.atob` but skipped for now
  (next commit)
2018-07-05 13:35:06 +01:00

143 lines
4.6 KiB
JavaScript

import Adapter, {
REQUEST_CREATE,
REQUEST_UPDATE,
REQUEST_DELETE,
DATACENTER_KEY as API_DATACENTER_KEY,
} from './application';
import isFolder from 'consul-ui/utils/isFolder';
import injectableRequestToJQueryAjaxHash from 'consul-ui/utils/injectableRequestToJQueryAjaxHash';
import { typeOf } from '@ember/utils';
import { get } from '@ember/object';
import { inject as service } from '@ember/service';
import keyToArray from 'consul-ui/utils/keyToArray';
import removeNull from 'consul-ui/utils/remove-null';
import { PRIMARY_KEY, SLUG_KEY } from 'consul-ui/models/kv';
import { FOREIGN_KEY as DATACENTER_KEY } from 'consul-ui/models/dc';
import { PUT as HTTP_PUT, DELETE as HTTP_DELETE } from 'consul-ui/utils/http/method';
import { OK as HTTP_OK } from 'consul-ui/utils/http/status';
const API_KEYS_KEY = 'keys';
const stringify = function(obj) {
if (typeOf(obj) === 'string') {
return obj;
}
return JSON.stringify(obj);
};
export default Adapter.extend({
// There is no code path that can avoid the payload of a PUT request from
// going via JSON.stringify.
// Therefore a string payload of 'foobar' will always be encoded to '"foobar"'
//
// This means we have no other choice but rewriting the entire codepath or
// overwriting the private `_requestToJQueryAjaxHash` method
//
// The `injectableRequestToJQueryAjaxHash` function makes the JSON object
// injectable, meaning we can copy letter for letter the sourcecode of
// `_requestToJQueryAjaxHash`, which means we can compare it with the original
// private method within a test (`tests/unit/utils/injectableRequestToJQueryAjaxHash.js`).
// This means, if `_requestToJQueryAjaxHash` changes between Ember versions
// we will know about it
_requestToJQueryAjaxHash: injectableRequestToJQueryAjaxHash({
stringify: stringify,
}),
decoder: service('atob'),
urlForQuery: function(query, modelName) {
// append keys here otherwise query.keys will add an '='
return this.appendURL('kv', keyToArray(query.id), {
...{
[API_KEYS_KEY]: null,
},
...this.cleanQuery(query),
});
},
urlForQueryRecord: function(query, modelName) {
return this.appendURL('kv', keyToArray(query.id), this.cleanQuery(query));
},
urlForCreateRecord: function(modelName, snapshot) {
return this.appendURL('kv', keyToArray(snapshot.attr(SLUG_KEY)), {
[API_DATACENTER_KEY]: snapshot.attr(DATACENTER_KEY),
});
},
urlForUpdateRecord: function(id, modelName, snapshot) {
return this.appendURL('kv', keyToArray(snapshot.attr(SLUG_KEY)), {
[API_DATACENTER_KEY]: snapshot.attr(DATACENTER_KEY),
});
},
urlForDeleteRecord: function(id, modelName, snapshot) {
const query = {
[API_DATACENTER_KEY]: snapshot.attr(DATACENTER_KEY),
};
if (isFolder(snapshot.attr(SLUG_KEY))) {
query.recurse = null;
}
return this.appendURL('kv', keyToArray(snapshot.attr(SLUG_KEY)), query);
},
slugFromURL: function(url) {
// keys don't follow the 'last part of the url' rule as they contain slashes
return decodeURIComponent(
url.pathname
.split('/')
.splice(3)
.join('/')
);
},
isQueryRecord: function(url) {
return !url.searchParams.has(API_KEYS_KEY);
},
handleResponse: function(status, headers, payload, requestData) {
let response = payload;
if (status === HTTP_OK) {
const url = this.parseURL(requestData.url);
switch (true) {
case response === true:
response = {
[PRIMARY_KEY]: this.uidForURL(url),
};
break;
case this.isQueryRecord(url):
response = {
...removeNull(response[0]),
...{
[PRIMARY_KEY]: this.uidForURL(url),
},
};
break;
default:
// isQuery
response = response.map((item, i, arr) => {
return {
[PRIMARY_KEY]: this.uidForURL(url, item),
[SLUG_KEY]: item,
};
});
}
}
return this._super(status, headers, response, requestData);
},
dataForRequest: function(params) {
const data = this._super(...arguments);
let value = '';
switch (params.requestType) {
case REQUEST_UPDATE:
case REQUEST_CREATE:
value = data.kv.Value;
if (typeof value === 'string') {
return get(this, 'decoder').execute(value);
}
return null;
}
},
methodForRequest: function(params) {
switch (params.requestType) {
case REQUEST_DELETE:
return HTTP_DELETE;
case REQUEST_CREATE:
return HTTP_PUT;
}
return this._super(...arguments);
},
});