Upgrade to use stable `package:googleapis/v1.dart` of datastore

lib/src/datastore_impl.dart

 // Copyright (c) 2014, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 library gcloud.datastore_impl;
 
 import 'dart:async';
 
 import 'package:http/http.dart' as http;
 
 import '../datastore.dart' as datastore;
 import '../common.dart' show Page;
-import 'package:googleapis_beta/datastore/v1beta2.dart' as api;
+import 'package:googleapis/datastore/v1.dart' as api;
 
 class TransactionImpl implements datastore.Transaction {
   final String data;
   TransactionImpl(this.data);
 }
 
 class DatastoreImpl implements datastore.Datastore {
   static const List<String> SCOPES = const <String>[
       api.DatastoreApi.DatastoreScope,
-      api.DatastoreApi.UserinfoEmailScope,
+      api.DatastoreApi.CloudPlatformScope,
   ];
 
   final api.DatastoreApi _api;
   final String _project;
 
-  DatastoreImpl(http.Client client, this._project)
-      : _api = new api.DatastoreApi(client);
+  /// The [project] parameter is the name of the cloud project (it should not
+  /// start with a `s~`).
+  DatastoreImpl(http.Client client, String project)
+      : _api = new api.DatastoreApi(client), _project = project;
 
   api.Key _convertDatastore2ApiKey(datastore.Key key, {bool enforceId: true}) {
     var apiKey = new api.Key();
 
     apiKey.partitionId = new api.PartitionId()
-        ..datasetId = _project
-        ..namespace = key.partition.namespace;
+        ..projectId = _project
+        ..namespaceId = key.partition.namespace;
 
     apiKey.path = key.elements.map((datastore.KeyElement element) {
-      var part = new api.KeyPathElement();
+      var part = new api.PathElement();
       part.kind = element.kind;
       if (element.id is int) {
         part.id = '${element.id}';
       } else if (element.id is String) {
         part.name = element.id;
       } else if (enforceId) {
         throw new datastore.ApplicationError(
             'Error while encoding entity key: Using `null` as the id is not '
             'allowed.');
       }
       return part;
     }).toList();
 
     return apiKey;
   }
 
   static datastore.Key _convertApi2DatastoreKey(api.Key key) {
-    var elements = key.path.map((api.KeyPathElement element) {
+    var elements = key.path.map((api.PathElement element) {
       if (element.id != null) {
         return new datastore.KeyElement(element.kind, int.parse(element.id));
       } else if (element.name != null) {
         return new datastore.KeyElement(element.kind, element.name);
       } else {
         throw new datastore.DatastoreError(
             'Invalid server response: Expected allocated name/id.');
       }
     }).toList();
 
     var partition;
     if (key.partitionId != null) {
-      partition = new datastore.Partition(key.partitionId.namespace);
+      partition = new datastore.Partition(key.partitionId.namespaceId);
       // TODO: assert projectId.
     }
     return new datastore.Key(elements, partition: partition);
   }
 
   bool _compareApiKey(api.Key a, api.Key b) {
     if (a.path.length != b.path.length) return false;
 
     // FIXME(Issue #2): Is this comparison working correctly?
     if (a.partitionId != null) {
       if (b.partitionId == null) return false;
-      if (a.partitionId.datasetId != b.partitionId.datasetId) return false;
-      if (a.partitionId.namespace != b.partitionId.namespace) return false;
+      if (a.partitionId.projectId != b.partitionId.projectId) return false;
+      if (a.partitionId.namespaceId != b.partitionId.namespaceId) return false;
     } else {
       if (b.partitionId != null) return false;
     }
 
     for (int i = 0; i < a.path.length; i++) {
       if (a.path[i].id != b.path[i].id ||
           a.path[i].name != b.path[i].name ||
           a.path[i].kind != b.path[i].kind) return false;
     }
     return true;
   }
 
-  static _convertApi2DatastorePropertyValue(api.Value value) {
-    if (value.booleanValue != null)
-      return value.booleanValue;
-    else if (value.integerValue != null)
-      return int.parse(value.integerValue);
-    else if (value.doubleValue != null)
-      return value.doubleValue;
-    else if (value.stringValue != null)
-      return value.stringValue;
-    else if (value.dateTimeValue != null)
-      return value.dateTimeValue;
-    else if (value.blobValue != null)
-      return new datastore.BlobValue(value.blobValueAsBytes);
-    else if (value.keyValue != null)
-      return _convertApi2DatastoreKey(value.keyValue);
-    else if (value.listValue != null)
-      // FIXME(Issue #3): Consistently handle exceptions.
-      throw new Exception('Cannot have lists inside lists.');
-    else if (value.blobKeyValue != null)
-      throw new UnsupportedError('Blob keys are not supported.');
-    else if (value.entityValue != null)
-      throw new UnsupportedError('Entity values are not supported.');
-    return null;
-  }
-
   api.Value _convertDatastore2ApiPropertyValue(
       value, bool indexed, {bool lists: true}) {
     var apiValue = new api.Value()
-        ..indexed = indexed;
+        ..excludeFromIndexes = !indexed;
     if (value == null) {
-      return apiValue;
+      return apiValue
+          ..nullValue = "NULL_VALUE";

[Søren Gjesse, 2016/08/29 10:29:09]

How does this nullValue thing work? Is this required to have the value
"NULL_VALUE", or will any (non null?) value for nullValue indicate "null"?

[kustermann, 2016/08/29 16:24:04]

It is an enum and the enum values are ["NULL_VALUE"].

The funny thing is: If I send just 'new api.Value()' (which translates to "{}")
I get an error saying the property doesn't contain a value.

But when I receive data, I never get '{ nullValue: "NULL_VALUE" }, I just get
"{}"

:-/

     } else if (value is bool) {
       return apiValue
           ..booleanValue = value;
     } else if (value is int) {
       return apiValue
           ..integerValue = '$value';
     } else if (value is double) {
       return apiValue
           ..doubleValue = value;
     } else if (value is String) {
       return apiValue
           ..stringValue = value;
     } else if (value is DateTime) {
       return apiValue
-          ..dateTimeValue = value;
+          ..timestampValue = value.toIso8601String();
     } else if (value is datastore.BlobValue) {
       return apiValue
           ..blobValueAsBytes = value.bytes;
     } else if (value is datastore.Key) {
       return apiValue
           ..keyValue = _convertDatastore2ApiKey(value, enforceId: false);
     } else if (value is List) {
       if (!lists) {
         // FIXME(Issue #3): Consistently handle exceptions.
         throw new Exception('List values are not allowed.');
       }
 
       convertItem(i)
           => _convertDatastore2ApiPropertyValue(i, indexed, lists: false);
 
-      return new api.Value()
-          ..listValue = value.map(convertItem).toList();
+      return new api.Value()..arrayValue = (
+          new api.ArrayValue()..values = value.map(convertItem).toList());
     } else {
       throw new UnsupportedError(
           'Types ${value.runtimeType} cannot be used for serializing.');
     }
   }
 
-  static _convertApi2DatastoreProperty(api.Property property) {
-    if (property.booleanValue != null)
-      return property.booleanValue;
-    else if (property.integerValue != null)
-      return int.parse(property.integerValue);
-    else if (property.doubleValue != null)
-      return property.doubleValue;
-    else if (property.stringValue != null)
-      return property.stringValue;
-    else if (property.dateTimeValue != null)
-      return property.dateTimeValue;
-    else if (property.blobValue != null)
-      return new datastore.BlobValue(property.blobValueAsBytes);
-    else if (property.keyValue != null)
-      return _convertApi2DatastoreKey(property.keyValue);
-    else if (property.listValue != null)
-      return
-          property.listValue.map(_convertApi2DatastorePropertyValue).toList();
-    else if (property.blobKeyValue != null)
-      throw new UnsupportedError('Blob keys are not supported.');
-    else if (property.entityValue != null)
+  static _convertApi2DatastoreProperty(api.Value value) {

[Søren Gjesse, 2016/08/29 10:29:09]

Add explicit dynamic here?

[kustermann, 2016/08/29 16:24:04]

done

+    if (value.booleanValue != null)
+      return value.booleanValue;
+    else if (value.integerValue != null)
+      return int.parse(value.integerValue);
+    else if (value.doubleValue != null)
+      return value.doubleValue;
+    else if (value.stringValue != null)
+      return value.stringValue;
+    else if (value.timestampValue != null)
+      return DateTime.parse(value.timestampValue);
+    else if (value.blobValue != null)
+      return new datastore.BlobValue(value.blobValueAsBytes);
+    else if (value.keyValue != null)
+      return _convertApi2DatastoreKey(value.keyValue);
+    else if (value.arrayValue != null && value.arrayValue.values != null)
+      return value
+          .arrayValue.values.map(_convertApi2DatastoreProperty).toList();
+    else if (value.entityValue != null)

[Søren Gjesse, 2016/08/29 10:29:09]

Why is value.nullValue not handled here?

[kustermann, 2016/08/29 16:24:04]

It was handled via the default case below, but I've added it explicitly now.

       throw new UnsupportedError('Entity values are not supported.');
     return null;
   }
 
-  api.Property _convertDatastore2ApiProperty(
-      value, bool indexed, {bool lists: true}) {
-    var apiProperty = new api.Property()
-        ..indexed = indexed;
-    if (value == null) {
-      return null;
-    } else if (value is bool) {
-      return apiProperty
-          ..booleanValue = value;
-    } else if (value is int) {
-      return apiProperty
-          ..integerValue = '$value';
-    } else if (value is double) {
-      return apiProperty
-          ..doubleValue = value;
-    } else if (value is String) {
-      return apiProperty
-          ..stringValue = value;
-    } else if (value is DateTime) {
-      return apiProperty
-          ..dateTimeValue = value;
-    } else if (value is datastore.BlobValue) {
-      return apiProperty
-          ..blobValueAsBytes = value.bytes;
-    } else if (value is datastore.Key) {
-      return apiProperty
-          ..keyValue = _convertDatastore2ApiKey(value, enforceId: false);
-    } else if (value is List) {
-      if (!lists) {
-        // FIXME(Issue #3): Consistently handle exceptions.
-        throw new Exception('List values are not allowed.');
-      }
-      convertItem(i)
-          => _convertDatastore2ApiPropertyValue(i, indexed, lists: false);
-      return new api.Property()..listValue = value.map(convertItem).toList();
-    } else {
-      throw new UnsupportedError(
-          'Types ${value.runtimeType} cannot be used for serializing.');
-    }
-  }
-
   static datastore.Entity _convertApi2DatastoreEntity(api.Entity entity) {
     var unindexedProperties = new Set();
     var properties = {};
 
     if (entity.properties != null) {
-      entity.properties.forEach((String name, api.Property property) {
-        properties[name] = _convertApi2DatastoreProperty(property);
-        if (property.indexed == false) {
-          // TODO(Issue #$4): Should we support mixed indexed/non-indexed list
-          // values?
-          if (property.listValue != null) {
-            if (property.listValue.length > 0) {
-              var firstIndexed = property.listValue.first.indexed;
-              for (int i = 1; i < property.listValue.length; i++) {
-                if (property.listValue[i].indexed != firstIndexed) {
-                  throw new Exception('Some list entries are indexed and some '
-                      'are not. This is currently not supported.');
-                }
-              }
-              if (firstIndexed == false) {
-                unindexedProperties.add(name);
-              }
-            }
-          } else {
-            unindexedProperties.add(name);
-          }
+      entity.properties.forEach((String name, api.Value value) {
+        properties[name] = _convertApi2DatastoreProperty(value);
+        if (value.excludeFromIndexes != null &&
+            value.excludeFromIndexes) {
+          unindexedProperties.add(name);
         }
       });
     }
     return new datastore.Entity(_convertApi2DatastoreKey(entity.key),
                                 properties,
                                 unIndexedProperties: unindexedProperties);
   }
 
   api.Entity _convertDatastore2ApiEntity(datastore.Entity entity,
                                          {bool enforceId: false}) {
@@ skipping 28 matching lines @@
     var pf = new api.PropertyFilter();
     var operator = relationMapping[filter.relation];
     // FIXME(Issue #5): Is this OK?
     if (filter.relation == datastore.FilterRelation.In) {
       operator = 'EQUAL';
     }
 
     if (operator == null) {
       throw new ArgumentError('Unknown filter relation: ${filter.relation}.');
     }
-    pf.operator = operator;
+    pf.op = operator;
     pf.property = new api.PropertyReference()..name = filter.name;
 
     // FIXME(Issue #5): Is this OK?
     var value = filter.value;
     if (filter.relation == datastore.FilterRelation.In) {
       if (value is List && value.length == 1) {
         value = value.first;
       } else {
         throw new ArgumentError('List values not supported (was: $value).');
       }
     }
 
     pf.value = _convertDatastore2ApiPropertyValue(value, true, lists: false);
     return new api.Filter()..propertyFilter = pf;
   }
 
   api.Filter _convertDatastoreAncestorKey2ApiFilter(datastore.Key key) {
     var pf = new api.PropertyFilter();
-    pf.operator = 'HAS_ANCESTOR';
+    pf.op = 'HAS_ANCESTOR';
     pf.property = new api.PropertyReference()..name = '__key__';
     pf.value = new api.Value()
         ..keyValue = _convertDatastore2ApiKey(key, enforceId: true);
     return new api.Filter()..propertyFilter = pf;
   }
 
   api.Filter _convertDatastore2ApiFilters(List<datastore.Filter> filters,
                                           datastore.Key ancestorKey) {
     if ((filters == null || filters.length == 0) && ancestorKey == null) {
       return null;
     }
 
     var compFilter = new api.CompositeFilter();
     if (filters != null) {
       compFilter.filters = filters.map(_convertDatastore2ApiFilter).toList();
     }
     if (ancestorKey != null) {
       var filter = _convertDatastoreAncestorKey2ApiFilter(ancestorKey);
       if (compFilter.filters == null) {
         compFilter.filters = [filter];
       } else {
         compFilter.filters.add(filter);
       }
     }
-    compFilter.operator = 'AND';
+    compFilter.op = 'AND';
     return new api.Filter()..compositeFilter = compFilter;
   }
 
   api.PropertyOrder _convertDatastore2ApiOrder(datastore.Order order) {
     var property = new api.PropertyReference()..name = order.propertyName;
     var direction = order.direction == datastore.OrderDirection.Ascending
         ? 'ASCENDING' : 'DESCENDING';
     return new api.PropertyOrder()
         ..direction = direction
         ..property = property;
@@ skipping 21 matching lines @@
       }
     }
     return new Future.error(error, stack);
   }
 
   Future<List<datastore.Key>> allocateIds(List<datastore.Key> keys) {
     var request = new api.AllocateIdsRequest();
     request..keys = keys.map((key) {
       return _convertDatastore2ApiKey(key, enforceId: false);
     }).toList();
-    return _api.datasets.allocateIds(request, _project).then((response) {
+    return _api.projects.allocateIds(request, _project).then((response) {
       return response.keys.map(_convertApi2DatastoreKey).toList();
     }, onError: _handleError);
   }
 
   Future<datastore.Transaction> beginTransaction(
       {bool crossEntityGroup: false}) {
     var request = new api.BeginTransactionRequest();
-    // TODO: Should this be made configurable?
-    request.isolationLevel = 'SERIALIZABLE';
-    return _api.datasets.beginTransaction(request, _project).then((result) {
+    return _api.projects.beginTransaction(request, _project).then((result) {
       return new TransactionImpl(result.transaction);
     }, onError: _handleError);
   }
 
   Future<datastore.CommitResult> commit({List<datastore.Entity> inserts,
                                          List<datastore.Entity> autoIdInserts,
                                          List<datastore.Key> deletes,
                                          datastore.Transaction transaction}) {
     var request = new api.CommitRequest();
 
     if (transaction != null) {
       request.mode = 'TRANSACTIONAL';
       request.transaction = (transaction as TransactionImpl).data;
     } else {
       request.mode = 'NON_TRANSACTIONAL';
     }
 
-    request.mutation = new api.Mutation();
+    var mutations = request.mutations = [];
     if (inserts != null) {
-      request.mutation.upsert = new List(inserts.length);
       for (int i = 0; i < inserts.length; i++) {
-        request.mutation.upsert[i] = _convertDatastore2ApiEntity(inserts[i]);
+        mutations.add(
+            new api.Mutation()..upsert =
+              _convertDatastore2ApiEntity(inserts[i], enforceId: true));
       }
     }
+    int autoIdStartIndex = -1;
     if (autoIdInserts != null) {
-      request.mutation.insertAutoId = new List(autoIdInserts.length);
+      autoIdStartIndex = mutations.length;
       for (int i = 0; i < autoIdInserts.length; i++) {
-        request.mutation.insertAutoId[i] =
-            _convertDatastore2ApiEntity(autoIdInserts[i], enforceId: false);
+        mutations.add(
+            new api.Mutation()..insert =
+              _convertDatastore2ApiEntity(autoIdInserts[i], enforceId: false));
       }
     }
     if (deletes != null) {
-      request.mutation.delete = new List(deletes.length);
       for (int i = 0; i < deletes.length; i++) {
-        request.mutation.delete[i] =
-            _convertDatastore2ApiKey(deletes[i], enforceId: true);
+        mutations.add(
+            new api.Mutation()..delete =
+            _convertDatastore2ApiKey(deletes[i], enforceId: true));
       }
     }
-    return _api.datasets.commit(request, _project).then((result) {
+    return _api.projects.commit(request, _project).then((result) {
       var keys;
       if (autoIdInserts != null && autoIdInserts.length > 0) {
-        keys = result
-          .mutationResult
-          .insertAutoIdKeys
-          .map(_convertApi2DatastoreKey).toList();
+        List<api.MutationResult> mutationResults = result.mutationResults;
+        assert(autoIdStartIndex != -1);
+        assert(mutationResults.length >=
+               (autoIdStartIndex + autoIdInserts.length));
+        keys = mutationResults
+            .skip(autoIdStartIndex)
+            .take(autoIdInserts.length)
+            .map((api.MutationResult r) => _convertApi2DatastoreKey(r.key))
+            .toList();
       }
       return new datastore.CommitResult(keys);
     }, onError: _handleError);
   }
 
   Future<List<datastore.Entity>> lookup(List<datastore.Key> keys,
                                         {datastore.Transaction transaction}) {
     var apiKeys = keys.map((key) {
       return _convertDatastore2ApiKey(key, enforceId: true);
     }).toList();
     var request = new api.LookupRequest();
     request.keys = apiKeys;
     if (transaction != null) {
       // TODO: Make readOptions more configurable.
       request.readOptions = new api.ReadOptions();
       request.readOptions.transaction = (transaction as TransactionImpl).data;
     }
-    return _api.datasets.lookup(request, _project).then((response) {
+    return _api.projects.lookup(request, _project).then((response) {
       if (response.deferred != null && response.deferred.length > 0) {
         throw new datastore.DatastoreError(
             'Could not successfully look up all keys due to resource '
             'constraints.');
       }
 
       // NOTE: This is worst-case O(n^2)!
       // Maybe we can optimize this somehow. But the API says:
       //  message LookupResponse {
       //    // The order of results in these fields is undefined and has no relation to
@@ skipping 51 matching lines @@
                               datastore.Transaction transaction}) {
     // NOTE: We explicitly do not set 'limit' here, since this is handled by
     // QueryPageImpl.runQuery.
     var apiQuery = new api.Query()
         ..filter = _convertDatastore2ApiFilters(query.filters,
                                                 query.ancestorKey)
         ..order = _convertDatastore2ApiOrders(query.orders)
         ..offset = query.offset;
 
     if (query.kind != null) {
-      apiQuery.kinds = [new api.KindExpression()..name = query.kind];
+      apiQuery.kind = [new api.KindExpression()..name = query.kind];
     }
 
     var request = new api.RunQueryRequest();
     request.query = apiQuery;
     if (transaction != null) {
       // TODO: Make readOptions more configurable.
       request.readOptions = new api.ReadOptions();
       request.readOptions.transaction = (transaction as TransactionImpl).data;
     }
     if (partition != null) {
       request.partitionId = new api.PartitionId()
-          ..namespace = partition.namespace;
+          ..namespaceId = partition.namespace;
     }
 
     return QueryPageImpl.runQuery(_api, _project, request, query.limit)
         .catchError(_handleError);
   }
 
   Future rollback(datastore.Transaction transaction) {
     // TODO: Handle [transaction]
     var request = new api.RollbackRequest()
         ..transaction = (transaction as TransactionImpl).data;
-    return _api.datasets.rollback(request, _project).catchError(_handleError);
+    return _api.projects.rollback(request, _project).catchError(_handleError);
   }
 }
 
 class QueryPageImpl implements Page<datastore.Entity> {
   static const int MAX_ENTITIES_PER_RESPONSE = 2000;
 
   final api.DatastoreApi _api;
   final String _project;
   final api.RunQueryRequest _nextRequest;
   final List<datastore.Entity> _entities;
@@ skipping 14 matching lines @@
     int batchLimit = batchSize;
     if (batchLimit == null) {
       batchLimit = MAX_ENTITIES_PER_RESPONSE;
     }
     if (limit != null && limit < batchLimit) {
       batchLimit = limit;
     }
 
     request.query.limit = batchLimit;
 
-    return api.datasets.runQuery(request, project).then((response) {
+    return api.projects.runQuery(request, project).then((response) {
       var returnedEntities = const [];
 
       var batch = response.batch;
       if (batch.entityResults != null) {
         returnedEntities = batch.entityResults
             .map((result) => result.entity)
             .map(DatastoreImpl._convertApi2DatastoreEntity)
             .toList();
       }
 
@@ skipping 95 matching lines @@
       return new Future.sync(() {
         throw new ArgumentError('Cannot call next() on last page.');
       });
     }
 
     return QueryPageImpl.runQuery(
         _api, _project, _nextRequest, _remainingNumberOfEntities)
         .catchError(DatastoreImpl._handleError);
   }
 }