Skip to content

Commit

Permalink
[Tables] removing RawResponse (#17230)
Browse files Browse the repository at this point in the history 
* removing RawResponse

* fixing failing builds

* better docs

* merge conflicts, consistent options comments

* release prep
  • Loading branch information
@seankane-msft
seankane-msft committed Mar 4, 2022
1 parent 4cfc2d1 commit 3aadec6
Show file tree
Hide file tree
Showing 8 changed files with 63 additions and 169 deletions.
9 changes: 2 additions & 7 deletions sdk/data/aztables/CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Release History

## 0.5.1 (Unreleased)

### Features Added
## 0.6.0 (2022-03-08)

### Breaking Changes
* Prefixed all `TransactionType` constants with `TransactionType`.
Expand All @@ -14,10 +12,7 @@
* Update `ListEntitiesPager` and `ListTablesPager`.
* The `More` method checks whether there are more pages to retrieve.
* The `NextPage(context.Context)` method gets the next page and returns a response and an `error`.

### Bugs Fixed

### Other Changes
* Removed `RawResponse` from all Response structs

## 0.5.0 (2022-01-12)

Expand Down
96 changes: 39 additions & 57 deletions sdk/data/aztables/client.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ import (
"context"
"encoding/json"
"errors"
"net/http"
"net/url"
"reflect"
"strings"
Expand Down Expand Up @@ -105,17 +104,13 @@ func parseURL(serviceURL string) (string, string, error) {
return rawServiceURL, tableName, nil
}

// CreateTableResponse contains response fields for Client.Create and ServiceClient.CreateTable
type CreateTableResponse struct {
RawResponse *http.Response
// placeholder for future response fields
}

func createTableResponseFromGen(g *generated.TableClientCreateResponse) CreateTableResponse {
if g == nil {
return CreateTableResponse{}
}
return CreateTableResponse{
RawResponse: g.RawResponse,
}
return CreateTableResponse{}
}

// Create creates the table with the tableName specified when NewClient was called. If the service returns a non-successful
Expand All @@ -134,7 +129,7 @@ func (t *Client) Delete(ctx context.Context, options *DeleteTableOptions) (Delet
return t.service.DeleteTable(ctx, t.name, options)
}

// ListEntitiesOptions contains a group of parameters for the Table.Query method.
// ListEntitiesOptions contains optional parameters for Table.Query
type ListEntitiesOptions struct {
// OData filter expression.
Filter *string
Expand Down Expand Up @@ -166,11 +161,8 @@ func (l *ListEntitiesOptions) toQueryOptions() *generated.QueryOptions {
}
}

// ListEntitiesPageResponse is the response envelope for operations that return a list of entities.
// ListEntitiesPageResponse contains response fields for ListEntitiesPager.NextPage
type ListEntitiesPageResponse struct {
// RawResponse contains the underlying HTTP response.
RawResponse *http.Response

// ContinuationNextPartitionKey contains the information returned from the x-ms-continuation-NextPartitionKey header response.
ContinuationNextPartitionKey *string

Expand All @@ -196,7 +188,6 @@ func newListEntitiesPage(resp generated.TableClientQueryEntitiesResponse) (ListE
}

return ListEntitiesPageResponse{
RawResponse: resp.RawResponse,
ContinuationNextPartitionKey: resp.XMSContinuationNextPartitionKey,
ContinuationNextRowKey: resp.XMSContinuationNextRowKey,
ODataMetadata: resp.TableEntityQueryResponse.ODataMetadata,
Expand Down Expand Up @@ -274,7 +265,7 @@ func (t *Client) List(listOptions *ListEntitiesOptions) ListEntitiesPager {
}
}

// Options for Client.GetEntity method
// GetEntityOptions contains optional parameters for Client.GetEntity
type GetEntityOptions struct {
// placeholder for future optional parameters
}
Expand All @@ -283,14 +274,11 @@ func (g *GetEntityOptions) toGenerated() (*generated.TableClientQueryEntityWithP
return &generated.TableClientQueryEntityWithPartitionAndRowKeyOptions{}, &generated.QueryOptions{Format: generated.ODataMetadataFormatApplicationJSONODataMinimalmetadata.ToPtr()}
}

// GetEntityResponse is the return type for a GetEntity operation. The individual entities are stored in the Value property
// GetEntityResponse contains response fields for Client.GetEntity
type GetEntityResponse struct {
// ETag contains the information returned from the ETag header response.
ETag azcore.ETag

// RawResponse contains the underlying HTTP response.
RawResponse *http.Response

// The properties of the table entity.
Value []byte
}
Expand All @@ -307,9 +295,8 @@ func newGetEntityResponse(g generated.TableClientQueryEntityWithPartitionAndRowK
ETag = azcore.ETag(*g.ETag)
}
return GetEntityResponse{
ETag: ETag,
RawResponse: g.RawResponse,
Value: marshalledValue,
ETag: ETag,
Value: marshalledValue,
}, nil
}

Expand All @@ -329,15 +316,15 @@ func (t *Client) GetEntity(ctx context.Context, partitionKey string, rowKey stri
return newGetEntityResponse(resp)
}

// Options for the Client.AddEntity operation
// AddEntityOptions contains optional parameters for Client.AddEntity
type AddEntityOptions struct {
// Specifies whether the response should include the inserted entity in the payload. Possible values are return-no-content and return-content.
ResponsePreference *ResponseFormat
}

// AddEntityResponse contains response fields for Client.AddEntityResponse
type AddEntityResponse struct {
RawResponse *http.Response
ETag azcore.ETag
ETag azcore.ETag
}

func addEntityResponseFromGenerated(g *generated.TableClientInsertEntityResponse) AddEntityResponse {
Expand All @@ -350,8 +337,7 @@ func addEntityResponseFromGenerated(g *generated.TableClientInsertEntityResponse
ETag = azcore.ETag(*g.ETag)
}
return AddEntityResponse{
RawResponse: g.RawResponse,
ETag: ETag,
ETag: ETag,
}
}

Expand All @@ -373,6 +359,7 @@ func (t *Client) AddEntity(ctx context.Context, entity []byte, options *AddEntit
return addEntityResponseFromGenerated(&resp), err
}

// DeleteEntityOptions contains optional parameters for Client.DeleteEntity
type DeleteEntityOptions struct {
IfMatch *azcore.ETag
}
Expand All @@ -381,17 +368,13 @@ func (d *DeleteEntityOptions) toGenerated() *generated.TableClientDeleteEntityOp
return &generated.TableClientDeleteEntityOptions{}
}

// DeleteEntityResponse contains response fields for Client.DeleteEntity
type DeleteEntityResponse struct {
RawResponse *http.Response
// placeholder for future optional response fields
}

func deleteEntityResponseFromGenerated(g *generated.TableClientDeleteEntityResponse) DeleteEntityResponse {
if g == nil {
return DeleteEntityResponse{}
}
return DeleteEntityResponse{
RawResponse: g.RawResponse,
}
return DeleteEntityResponse{}
}

// DeleteEntity deletes the entity with the specified partitionKey and rowKey from the table. If the service returns a non-successful HTTP
Expand All @@ -408,6 +391,7 @@ func (t *Client) DeleteEntity(ctx context.Context, partitionKey string, rowKey s
return deleteEntityResponseFromGenerated(&resp), err
}

// UpdateEntityOptions contains optional parameters for Client.UpdateEntity
type UpdateEntityOptions struct {
IfMatch *azcore.ETag
UpdateMode EntityUpdateMode
Expand All @@ -433,9 +417,9 @@ func (u *UpdateEntityOptions) toGeneratedUpdateEntity(m map[string]interface{})
}
}

// UpdateEntityResponse contains response fields for Client.UpdateEntity
type UpdateEntityResponse struct {
RawResponse *http.Response
ETag azcore.ETag
ETag azcore.ETag
}

func updateEntityResponseFromMergeGenerated(g *generated.TableClientMergeEntityResponse) UpdateEntityResponse {
Expand All @@ -448,8 +432,7 @@ func updateEntityResponseFromMergeGenerated(g *generated.TableClientMergeEntityR
ETag = azcore.ETag(*g.ETag)
}
return UpdateEntityResponse{
RawResponse: g.RawResponse,
ETag: ETag,
ETag: ETag,
}
}

Expand All @@ -463,8 +446,7 @@ func updateEntityResponseFromUpdateGenerated(g *generated.TableClientUpdateEntit
ETag = azcore.ETag(*g.ETag)
}
return UpdateEntityResponse{
RawResponse: g.RawResponse,
ETag: ETag,
ETag: ETag,
}
}

Expand Down Expand Up @@ -528,14 +510,19 @@ func (t *Client) UpdateEntity(ctx context.Context, entity []byte, options *Updat
return UpdateEntityResponse{}, errInvalidUpdateMode
}

// InsertEntityOptions contains optional parameters for Client.InsertEntity
type InsertEntityOptions struct {
ETag azcore.ETag
// ETag is the optional etag for the Table
ETag azcore.ETag

// UpdateMode is the desired mode for the Update. Use ReplaceEntity to replace fields on
// the entity, use MergeEntity to merge fields of the entity.
UpdateMode EntityUpdateMode
}

// InsertEntityResponse contains response fields for Client.InsertEntity
type InsertEntityResponse struct {
RawResponse *http.Response
ETag azcore.ETag
ETag azcore.ETag
}

func insertEntityFromGeneratedMerge(g *generated.TableClientMergeEntityResponse) InsertEntityResponse {
Expand All @@ -548,8 +535,7 @@ func insertEntityFromGeneratedMerge(g *generated.TableClientMergeEntityResponse)
ETag = azcore.ETag(*g.ETag)
}
return InsertEntityResponse{
RawResponse: g.RawResponse,
ETag: ETag,
ETag: ETag,
}
}

Expand All @@ -563,8 +549,7 @@ func insertEntityFromGeneratedUpdate(g *generated.TableClientUpdateEntityRespons
ETag = azcore.ETag(*g.ETag)
}
return InsertEntityResponse{
RawResponse: g.RawResponse,
ETag: ETag,
ETag: ETag,
}
}

Expand Down Expand Up @@ -622,7 +607,7 @@ func (t *Client) InsertEntity(ctx context.Context, entity []byte, options *Inser
return InsertEntityResponse{}, errInvalidUpdateMode
}

// GetAccessPolicyOptions provides optional parameters for the Client.GetAccessPolicy methods
// GetAccessPolicyOptions contains optional parameters for Client.GetAccessPolicy
type GetAccessPolicyOptions struct {
// placeholder for future optional parameters
}
Expand All @@ -631,8 +616,8 @@ func (g *GetAccessPolicyOptions) toGenerated() *generated.TableClientGetAccessPo
return &generated.TableClientGetAccessPolicyOptions{}
}

// GetAccessPolicyResponse contains response fields for Client.GetAccessPolicy
type GetAccessPolicyResponse struct {
RawResponse *http.Response
SignedIdentifiers []*SignedIdentifier
}

Expand All @@ -646,7 +631,6 @@ func getAccessPolicyResponseFromGenerated(g *generated.TableClientGetAccessPolic
sis = append(sis, fromGeneratedSignedIdentifier(s))
}
return GetAccessPolicyResponse{
RawResponse: g.RawResponse,
SignedIdentifiers: sis,
}
}
Expand All @@ -659,22 +643,20 @@ func (t *Client) GetAccessPolicy(ctx context.Context, options *GetAccessPolicyOp
return getAccessPolicyResponseFromGenerated(&resp), err
}

// SetAccessPolicyOptions contains optional parameters for Client.SetAccessPolicy
type SetAccessPolicyOptions struct {
TableACL []*SignedIdentifier
}

// SetAccessPolicyResponse contains response fields for Client.SetAccessPolicy
type SetAccessPolicyResponse struct {
RawResponse *http.Response
// placeholder for future optional parameters
}

func setAccessPolicyResponseFromGenerated(g *generated.TableClientSetAccessPolicyResponse) SetAccessPolicyResponse {
if g == nil {
return SetAccessPolicyResponse{}
}
return SetAccessPolicyResponse{
RawResponse: g.RawResponse,
}
return SetAccessPolicyResponse{}
}

func (s *SetAccessPolicyOptions) toGenerated() *generated.TableClientSetAccessPolicyOptions {
var sis []*generated.SignedIdentifier
for _, t := range s.TableACL {
Expand Down
3 changes: 1 addition & 2 deletions sdk/data/aztables/client_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,9 @@ func TestCreateTable(t *testing.T) {
client, delete := initClientTest(t, service, false)
defer delete()

resp, err := client.Create(ctx, nil)
_, err := client.Create(ctx, nil)

require.NoError(t, err)
require.NotNil(t, resp.RawResponse)
})
}
}
Expand Down
2 changes: 1 addition & 1 deletion sdk/data/aztables/internal/constants.go
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 3aadec6

Please sign in to comment.