-
Notifications
You must be signed in to change notification settings - Fork 233
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add wm module and pb interface for GETing (and encoding) active preflist
- Loading branch information
1 parent
382e295
commit 9fede91
Showing
5 changed files
with
260 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
%% -------------------------------------------------------------------------- | ||
%% | ||
%% riak_kv_pb_bucket_key_apl: Expose Core active preflist functionality to | ||
%% Protocol Buffers | ||
%% | ||
%% Copyright (c) 2015 Basho Technologies, Inc. | ||
%% | ||
%% This file is provided to you under the Apache License, | ||
%% Version 2.0 (the "License"); you may not use this file | ||
%% except in compliance with the License. You may obtain | ||
%% a copy of the License at | ||
%% | ||
%% http://www.apache.org/licenses/LICENSE-2.0 | ||
%% | ||
%% Unless required by applicable law or agreed to in writing, | ||
%% software distributed under the License is distributed on an | ||
%% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
%% KIND, either express or implied. See the License for the | ||
%% specific language governing permissions and limitations | ||
%% under the License. | ||
%% | ||
%% -------------------------------------------------------------------------- | ||
|
||
%% @doc <p>The Bucket-Key Preflist (Primaries & Fallbacks) PB service | ||
%% for Riak Core. This service covers the following request messages in the | ||
%% original protocol:</p> | ||
%% | ||
%% <pre> | ||
%% 33 - RpbGetBucketKeyPreflistReq | ||
%% </pre> | ||
%% | ||
%% <p>This service produces the following responses:</p> | ||
%% | ||
%% <pre> | ||
%% 34 - RpbGetBucketKeyPreflistResp | ||
%% </pre> | ||
%% | ||
%% @end | ||
|
||
-module(riak_kv_pb_bucket_key_apl). | ||
|
||
-export([init/0, | ||
decode/2, | ||
encode/1, | ||
process/2, | ||
process_stream/3]). | ||
|
||
-include_lib("riak_pb/include/riak_kv_pb.hrl"). | ||
|
||
init() -> | ||
undefined. | ||
|
||
%% @doc decode/2 callback. Decodes an incoming message. | ||
decode(Code, Bin) when Code == 33 -> | ||
Msg = #rpbgetbucketkeypreflistreq{type =T, bucket =B, key =Key} = | ||
riak_pb_codec:decode(Code, Bin), | ||
Bucket = riak_kv_pb_bucket:bucket_type(T, B), | ||
{ok, Msg, {"riak_kv.get_preflist", {Bucket, Key}}}. | ||
|
||
%% @doc encode/1 callback. Encodes an outgoing response message. | ||
encode(Message) -> | ||
{ok, riak_pb_codec:encode(Message)}. | ||
|
||
%% Get bucket-key preflist primaries | ||
process(#rpbgetbucketkeypreflistreq{bucket = <<>>}, State) -> | ||
{error, "Bucket cannot be zero-length", State}; | ||
process(#rpbgetbucketkeypreflistreq{key = <<>>}, State) -> | ||
{error, "Key cannot be zero-length", State}; | ||
process(#rpbgetbucketkeypreflistreq{type = <<>>}, State) -> | ||
{error, "Type cannot be zero-length", State}; | ||
process(#rpbgetbucketkeypreflistreq{type=T, bucket=B0, key =K}, State) -> | ||
B = riak_kv_pb_bucket:maybe_create_bucket_type(T, B0), | ||
Preflist = riak_core_apl:get_apl_ann_with_pnum({B, K}), | ||
PbPreflist = riak_pb_kv_codec:encode_apl_ann(Preflist), | ||
{reply, #rpbgetbucketkeypreflistresp{preflist=PbPreflist}, State}. | ||
|
||
process_stream(_, _, State) -> | ||
{ignore, State}. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,165 @@ | ||
%% -------------------------------------------------------------------------- | ||
%% | ||
%% riak_kv_wm_preflist - Webmachine resource for getting bucket/key active | ||
%% preflist. | ||
%% | ||
%% | ||
%% Copyright (c) 2015 Basho Technologies, Inc. | ||
%% | ||
%% This file is provided to you under the Apache License, | ||
%% Version 2.0 (the "License"); you may not use this file | ||
%% except in compliance with the License. You may obtain | ||
%% a copy of the License at | ||
%% | ||
%% http://www.apache.org/licenses/LICENSE-2.0 | ||
%% | ||
%% Unless required by applicable law or agreed to in writing, | ||
%% software distributed under the License is distributed on an | ||
%% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
%% KIND, either express or implied. See the License for the | ||
%% specific language governing permissions and limitations | ||
%% under the License. | ||
%% | ||
%% -------------------------------------------------------------------------- | ||
|
||
%% @doc Resource for getting Riak bucket/key active preflist over HTTP. | ||
%% | ||
%% Available operations: | ||
%% | ||
%% GET /types/Type/buckets/Bucket/keys/Key/preflist | ||
%% GET /buckets/Bucket/keys/Key/preflist | ||
%% Get information about the active preflist for a particular buckey/key | ||
%% combo. | ||
|
||
-module(riak_kv_wm_preflist). | ||
|
||
%% webmachine resource exports | ||
-export([ | ||
init/1, | ||
is_authorized/2, | ||
forbidden/2, | ||
allowed_methods/2, | ||
resource_exists/2, | ||
content_types_provided/2, | ||
encodings_provided/2, | ||
produce_preflist_body/2, | ||
malformed_request/2 | ||
]). | ||
|
||
-record(ctx, { | ||
bucket_type :: binary(), %% bucket type (from uri) | ||
bucket :: binary(), %% Bucket name (from uri) | ||
key :: binary(), %% Key (from uri) | ||
security :: riak_core_security:context() %% security context | ||
}). | ||
|
||
-type context() :: #ctx{}. | ||
|
||
-include_lib("webmachine/include/webmachine.hrl"). | ||
-include("riak_kv_wm_raw.hrl"). | ||
|
||
-spec init(proplists:proplist()) -> {ok, context()}. | ||
%% @doc Initialize this resource. This function extracts the | ||
%% 'prefix' and 'riak' properties from the dispatch args. | ||
init(Props) -> | ||
{ok, #ctx{ | ||
bucket_type=proplists:get_value(bucket_type, Props)}}. | ||
|
||
is_authorized(ReqData, Ctx) -> | ||
case riak_api_web_security:is_authorized(ReqData) of | ||
false -> | ||
{"Basic realm=\"Riak\"", ReqData, Ctx}; | ||
{true, SecContext} -> | ||
{true, ReqData, Ctx#ctx{security=SecContext}}; | ||
insecure -> | ||
%% XXX 301 may be more appropriate here, but since the http and | ||
%% https port are different and configurable, it is hard to figure | ||
%% out the redirect URL to serve. | ||
{{halt, 426}, wrq:append_to_resp_body(<<"Security is enabled and " | ||
"Riak does not accept credentials over HTTP. Try HTTPS " | ||
"instead.">>, ReqData), Ctx} | ||
end. | ||
|
||
forbidden(RD, Ctx = #ctx{security=undefined}) -> | ||
{riak_kv_wm_utils:is_forbidden(RD), RD, Ctx}; | ||
forbidden(RD, Ctx) -> | ||
case riak_kv_wm_utils:is_forbidden(RD) of | ||
true -> | ||
{true, RD, Ctx}; | ||
false -> | ||
Res = riak_core_security:check_permission({"riak_kv.get_preflist", | ||
Ctx#ctx.bucket_type}, | ||
Ctx#ctx.security), | ||
case Res of | ||
{false, Error, _} -> | ||
RD1 = wrq:set_resp_header("Content-Type", "text/plain", RD), | ||
{true, wrq:append_to_resp_body( | ||
unicode:characters_to_binary( | ||
Error, utf8, utf8), RD1), Ctx}; | ||
{true, _} -> | ||
{false, RD, Ctx} | ||
end | ||
end. | ||
|
||
-spec allowed_methods(#wm_reqdata{}, context()) -> | ||
{[atom()], #wm_reqdata{}, context()}. | ||
%% @doc Get the list of methods this resource supports. | ||
%% Properties allows, GET. | ||
allowed_methods(RD, Ctx) -> | ||
{['HEAD', 'GET'], RD, Ctx}. | ||
|
||
-spec content_types_provided(#wm_reqdata{}, context()) -> | ||
{[{ContentType::string(), Producer::atom()}], #wm_reqdata{}, context()}. | ||
%% @doc List the content types available for representing this resource. | ||
%% "application/json" is the content-type for listing keys. | ||
content_types_provided(RD, Ctx) -> | ||
%% bucket-level: JSON description only | ||
{[{"application/json", produce_preflist_body}], RD, Ctx}. | ||
|
||
-spec encodings_provided(#wm_reqdata{}, context()) -> | ||
{[{Encoding::string(), Producer::function()}], #wm_reqdata{}, context()}. | ||
%% @doc List the encodings available for representing this resource. | ||
%% "identity" and "gzip" are available for a preflist request. | ||
encodings_provided(RD, Ctx) -> | ||
%% identity and gzip for top-level and bucket-level requests | ||
{riak_kv_wm_utils:default_encodings(), RD, Ctx}. | ||
|
||
resource_exists(RD, #ctx{bucket_type=BType}=Ctx) -> | ||
{riak_kv_wm_utils:bucket_type_exists(BType), RD, Ctx}. | ||
|
||
-spec malformed_request(#wm_reqdata{}, context()) -> | ||
{boolean(), #wm_reqdata{}, context()}. | ||
malformed_request(RD, Ctx) -> | ||
{false, RD, Ctx}. | ||
|
||
-spec produce_preflist_body(#wm_reqdata{}, context()) -> | ||
{mochijson2:json_object(), | ||
#wm_reqdata{}, | ||
context()}. | ||
%% @doc Produce bucket/key annotated preflist as JSON. | ||
produce_preflist_body(RD, #ctx{bucket=Bucket0, | ||
bucket_type=BType, | ||
key=Key}=Ctx) -> | ||
Bucket = riak_kv_wm_utils:maybe_bucket_type(BType, Bucket0), | ||
Preflist = riak_core_apl:get_apl_ann_with_pnum({Bucket, Key}), | ||
%% Encode | ||
Json = mochijson2:encode({struct, | ||
[{<<"preflist">>, | ||
lists:flatten(jsonify_preflist(Preflist))}]}), | ||
{Json, RD, Ctx}. | ||
|
||
%% Private | ||
|
||
-spec jsonify_preflist(riak_core_apl:preflist_with_pnum_ann()) -> list(). | ||
%% @doc Jsonify active preflist to json. | ||
jsonify_preflist(Preflist) -> | ||
[jsonify_preflist_results(PartitionNumber, Node, T) || | ||
{{PartitionNumber, Node}, T} <- Preflist]. | ||
|
||
-spec jsonify_preflist_results(non_neg_integer(), node(), primary|fallback) -> | ||
[{struct, list()}]. | ||
jsonify_preflist_results(PartitionNumber, Node, Ann) -> | ||
[{struct, | ||
[{<<"partition">>, PartitionNumber}, | ||
{<<"node">>, atom_to_binary(Node, utf8)}, | ||
{<<"primary">>, Ann =:= primary}]}]. |
9fede91
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
saw approval from seancribbs
at 9fede91
9fede91
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
merging basho/riak_kv/feature/zl/add-wm-code-for-getting-active-preflist = 9fede91 into borshop-integration-1083-feature/zl/add-wm-code-for-getting-active-preflist
9fede91
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
basho/riak_kv/feature/zl/add-wm-code-for-getting-active-preflist = 9fede91 merged ok, testing candidate = 9bfa7f1
9fede91
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
all tests pass:
success: http://buildbot.bos1/builders/test-riak_kv/builds/1885
9fede91
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fast-forwarding develop to borshop-integration-1083-feature/zl/add-wm-code-for-getting-active-preflist = 9bfa7f1