Time and timestamp utility refactoring (#593)

1. Exported all time utilities for downstream external usage 2. Renamed `getCurrentTimeInHighPrecision()` -> `getCurrentTimestamp()` for dev friendliness 3. Removed redundant `createDateString()` 4. Grouped all time utilities into a class 5. Replaced all direct usage of temporal library
decentralized-identity · Nov 2, 2023 · d79901a · d79901a
1 parent 7d9caec
commit d79901a
Show file tree

Hide file tree

Showing 31 changed files with 225 additions and 225 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -41,12 +41,12 @@ export { Protocols } from './utils/protocols.js';
 export { ProtocolsConfigure, ProtocolsConfigureOptions } from './interfaces/protocols-configure.js';
 export { ProtocolsQuery, ProtocolsQueryOptions } from './interfaces/protocols-query.js';
 export { Records } from './utils/records.js';
-export { createTimestamp } from './utils/time.js';
 export { RecordsDelete, RecordsDeleteOptions } from './interfaces/records-delete.js';
 export { RecordsRead, RecordsReadOptions } from './interfaces/records-read.js';
 export { Secp256k1 } from './utils/secp256k1.js';
 export { Signer } from './types/signer.js';
 export { SortOrder } from './types/message-types.js';
+export { Time } from './utils/time.js';
 
 // store interfaces
 export { DataStoreLevel } from './store/data-store-level.js';

diff --git a/src/interfaces/events-get.ts b/src/interfaces/events-get.ts
@@ -1,9 +1,9 @@
 import type { Signer } from '../types/signer.js';
 import type { EventsGetDescriptor, EventsGetMessage } from '../types/event-types.js';
 
+import { Time } from '../utils/time.js';
 import { validateMessageSignatureIntegrity } from '../core/auth.js';
 import { DwnInterfaceName, DwnMethodName, Message } from '../core/message.js';
-import { getCurrentTimeInHighPrecision, validateTimestamp } from '../utils/time.js';
 
 export type EventsGetOptions = {
   watermark?: string;
@@ -16,7 +16,7 @@ export class EventsGet extends Message<EventsGetMessage> {
   public static async parse(message: EventsGetMessage): Promise<EventsGet> {
     Message.validateJsonSchema(message);
     await validateMessageSignatureIntegrity(message.authorization.signature, message.descriptor);
-    validateTimestamp(message.descriptor.messageTimestamp);
+    Time.validateTimestamp(message.descriptor.messageTimestamp);
 
     return new EventsGet(message);
   }
@@ -25,7 +25,7 @@ export class EventsGet extends Message<EventsGetMessage> {
     const descriptor: EventsGetDescriptor = {
       interface        : DwnInterfaceName.Events,
       method           : DwnMethodName.Get,
-      messageTimestamp : options.messageTimestamp ?? getCurrentTimeInHighPrecision(),
+      messageTimestamp : options.messageTimestamp ?? Time.getCurrentTimestamp(),
     };
 
     if (options.watermark) {

diff --git a/src/interfaces/messages-get.ts b/src/interfaces/messages-get.ts
@@ -2,10 +2,10 @@ import type { Signer } from '../types/signer.js';
 import type { MessagesGetDescriptor, MessagesGetMessage } from '../types/messages-types.js';
 
 import { Cid } from '../utils/cid.js';
+import { Time } from '../utils/time.js';
 import { validateMessageSignatureIntegrity } from '../core/auth.js';
 import { DwnError, DwnErrorCode } from '../index.js';
 import { DwnInterfaceName, DwnMethodName, Message } from '../core/message.js';
-import { getCurrentTimeInHighPrecision, validateTimestamp } from '../utils/time.js';
 
 export type MessagesGetOptions = {
   messageCids: string[];
@@ -19,7 +19,7 @@ export class MessagesGet extends Message<MessagesGetMessage> {
     this.validateMessageCids(message.descriptor.messageCids);
 
     await validateMessageSignatureIntegrity(message.authorization.signature, message.descriptor);
-    validateTimestamp(message.descriptor.messageTimestamp);
+    Time.validateTimestamp(message.descriptor.messageTimestamp);
 
     return new MessagesGet(message);
   }
@@ -29,7 +29,7 @@ export class MessagesGet extends Message<MessagesGetMessage> {
       interface        : DwnInterfaceName.Messages,
       method           : DwnMethodName.Get,
       messageCids      : options.messageCids,
-      messageTimestamp : options?.messageTimestamp ?? getCurrentTimeInHighPrecision(),
+      messageTimestamp : options?.messageTimestamp ?? Time.getCurrentTimestamp(),
     };
 
     const authorization = await Message.createAuthorization(descriptor, options.signer);

diff --git a/src/interfaces/permissions-grant.ts b/src/interfaces/permissions-grant.ts
@@ -4,10 +4,10 @@ import type { DelegatedGrantMessage, PermissionConditions, PermissionScope, Reco
 import type { PermissionsGrantDescriptor, PermissionsGrantMessage } from '../types/permissions-types.js';
 
 import { removeUndefinedProperties } from '../utils/object.js';
+import { Time } from '../utils/time.js';
 import { validateMessageSignatureIntegrity } from '../core/auth.js';
 import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
 import { DwnInterfaceName, DwnMethodName, Message } from '../core/message.js';
-import { getCurrentTimeInHighPrecision, validateTimestamp } from '../utils/time.js';
 import { normalizeProtocolUrl, normalizeSchemaUrl } from '../utils/url.js';
 
 export type PermissionsGrantOptions = {
@@ -39,8 +39,8 @@ export class PermissionsGrant extends Message<PermissionsGrantMessage> {
   public static async parse(message: PermissionsGrantMessage): Promise<PermissionsGrant> {
     await validateMessageSignatureIntegrity(message.authorization.signature, message.descriptor);
     PermissionsGrant.validateScope(message);
-    validateTimestamp(message.descriptor.messageTimestamp);
-    validateTimestamp(message.descriptor.dateExpires);
+    Time.validateTimestamp(message.descriptor.messageTimestamp);
+    Time.validateTimestamp(message.descriptor.dateExpires);
 
     return new PermissionsGrant(message);
   }
@@ -53,7 +53,7 @@ export class PermissionsGrant extends Message<PermissionsGrantMessage> {
     const descriptor: PermissionsGrantDescriptor = {
       interface            : DwnInterfaceName.Permissions,
       method               : DwnMethodName.Grant,
-      messageTimestamp     : options.messageTimestamp ?? getCurrentTimeInHighPrecision(),
+      messageTimestamp     : options.messageTimestamp ?? Time.getCurrentTimestamp(),
       dateExpires          : options.dateExpires,
       description          : options.description,
       grantedTo            : options.grantedTo,

diff --git a/src/interfaces/permissions-request.ts b/src/interfaces/permissions-request.ts
@@ -3,9 +3,9 @@ import type { PermissionConditions, PermissionScope } from '../types/permissions
 import type { PermissionsRequestDescriptor, PermissionsRequestMessage } from '../types/permissions-types.js';
 
 import { removeUndefinedProperties } from '../utils/object.js';
+import { Time } from '../utils/time.js';
 import { validateMessageSignatureIntegrity } from '../core/auth.js';
 import { DwnInterfaceName, DwnMethodName, Message } from '../core/message.js';
-import { getCurrentTimeInHighPrecision, validateTimestamp } from '../utils/time.js';
 
 export type PermissionsRequestOptions = {
   messageTimestamp?: string;
@@ -22,7 +22,7 @@ export class PermissionsRequest extends Message<PermissionsRequestMessage> {
 
   public static async parse(message: PermissionsRequestMessage): Promise<PermissionsRequest> {
     await validateMessageSignatureIntegrity(message.authorization.signature, message.descriptor);
-    validateTimestamp(message.descriptor.messageTimestamp);
+    Time.validateTimestamp(message.descriptor.messageTimestamp);
 
     return new PermissionsRequest(message);
   }
@@ -31,7 +31,7 @@ export class PermissionsRequest extends Message<PermissionsRequestMessage> {
     const descriptor: PermissionsRequestDescriptor = {
       interface        : DwnInterfaceName.Permissions,
       method           : DwnMethodName.Request,
-      messageTimestamp : options.messageTimestamp ?? getCurrentTimeInHighPrecision(),
+      messageTimestamp : options.messageTimestamp ?? Time.getCurrentTimestamp(),
       description      : options.description,
       grantedTo        : options.grantedTo,
       grantedBy        : options.grantedBy,

diff --git a/src/interfaces/permissions-revoke.ts b/src/interfaces/permissions-revoke.ts
@@ -1,10 +1,10 @@
 import type { Signer } from '../types/signer.js';
 import type { PermissionsGrantMessage, PermissionsRevokeDescriptor, PermissionsRevokeMessage } from '../types/permissions-types.js';
 
+import { Time } from '../utils/time.js';
 import { validateMessageSignatureIntegrity } from '../core/auth.js';
 import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
 import { DwnInterfaceName, DwnMethodName, Message } from '../core/message.js';
-import { getCurrentTimeInHighPrecision, validateTimestamp } from '../utils/time.js';
 
 export type PermissionsRevokeOptions = {
   messageTimestamp?: string;
@@ -15,7 +15,7 @@ export type PermissionsRevokeOptions = {
 export class PermissionsRevoke extends Message<PermissionsRevokeMessage> {
   public static async parse(message: PermissionsRevokeMessage): Promise<PermissionsRevoke> {
     await validateMessageSignatureIntegrity(message.authorization.signature, message.descriptor);
-    validateTimestamp(message.descriptor.messageTimestamp);
+    Time.validateTimestamp(message.descriptor.messageTimestamp);
 
     return new PermissionsRevoke(message);
   }
@@ -24,7 +24,7 @@ export class PermissionsRevoke extends Message<PermissionsRevokeMessage> {
     const descriptor: PermissionsRevokeDescriptor = {
       interface          : DwnInterfaceName.Permissions,
       method             : DwnMethodName.Revoke,
-      messageTimestamp   : options.messageTimestamp ?? getCurrentTimeInHighPrecision(),
+      messageTimestamp   : options.messageTimestamp ?? Time.getCurrentTimestamp(),
       permissionsGrantId : options.permissionsGrantId,
     };
 

diff --git a/src/interfaces/protocols-configure.ts b/src/interfaces/protocols-configure.ts
@@ -1,10 +1,10 @@
 import type { Signer } from '../types/signer.js';
 import type { ProtocolDefinition, ProtocolRuleSet, ProtocolsConfigureDescriptor, ProtocolsConfigureMessage } from '../types/protocols-types.js';
 
+import { Time } from '../utils/time.js';
 import { validateMessageSignatureIntegrity } from '../core/auth.js';
 import { DwnError, DwnErrorCode } from '../index.js';
 import { DwnInterfaceName, DwnMethodName, Message } from '../core/message.js';
-import { getCurrentTimeInHighPrecision, validateTimestamp } from '../utils/time.js';
 import { normalizeProtocolUrl, normalizeSchemaUrl, validateProtocolUrlNormalized, validateSchemaUrlNormalized } from '../utils/url.js';
 
 export type ProtocolsConfigureOptions = {
@@ -22,7 +22,7 @@ export class ProtocolsConfigure extends Message<ProtocolsConfigureMessage> {
     Message.validateJsonSchema(message);
     ProtocolsConfigure.validateProtocolDefinition(message.descriptor.definition);
     await validateMessageSignatureIntegrity(message.authorization.signature, message.descriptor);
-    validateTimestamp(message.descriptor.messageTimestamp);
+    Time.validateTimestamp(message.descriptor.messageTimestamp);
 
     return new ProtocolsConfigure(message);
   }
@@ -31,7 +31,7 @@ export class ProtocolsConfigure extends Message<ProtocolsConfigureMessage> {
     const descriptor: ProtocolsConfigureDescriptor = {
       interface        : DwnInterfaceName.Protocols,
       method           : DwnMethodName.Configure,
-      messageTimestamp : options.messageTimestamp ?? getCurrentTimeInHighPrecision(),
+      messageTimestamp : options.messageTimestamp ?? Time.getCurrentTimestamp(),
       definition       : ProtocolsConfigure.normalizeDefinition(options.definition)
     };
 

diff --git a/src/interfaces/protocols-query.ts b/src/interfaces/protocols-query.ts
@@ -5,9 +5,9 @@ import type { ProtocolsQueryDescriptor, ProtocolsQueryFilter, ProtocolsQueryMess
 
 import { GrantAuthorization } from '../core/grant-authorization.js';
 import { removeUndefinedProperties } from '../utils/object.js';
+import { Time } from '../utils/time.js';
 import { validateMessageSignatureIntegrity } from '../core/auth.js';
 import { DwnInterfaceName, DwnMethodName, Message } from '../core/message.js';
-import { getCurrentTimeInHighPrecision, validateTimestamp } from '../utils/time.js';
 import { normalizeProtocolUrl, validateProtocolUrlNormalized } from '../utils/url.js';
 
 import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
@@ -29,7 +29,7 @@ export class ProtocolsQuery extends Message<ProtocolsQueryMessage> {
     if (message.descriptor.filter !== undefined) {
       validateProtocolUrlNormalized(message.descriptor.filter.protocol);
     }
-    validateTimestamp(message.descriptor.messageTimestamp);
+    Time.validateTimestamp(message.descriptor.messageTimestamp);
 
     return new ProtocolsQuery(message);
   }
@@ -38,7 +38,7 @@ export class ProtocolsQuery extends Message<ProtocolsQueryMessage> {
     const descriptor: ProtocolsQueryDescriptor = {
       interface        : DwnInterfaceName.Protocols,
       method           : DwnMethodName.Query,
-      messageTimestamp : options.messageTimestamp ?? getCurrentTimeInHighPrecision(),
+      messageTimestamp : options.messageTimestamp ?? Time.getCurrentTimestamp(),
       filter           : ProtocolsQuery.normalizeFilter(options.filter),
     };
 

diff --git a/src/interfaces/records-delete.ts b/src/interfaces/records-delete.ts
@@ -6,10 +6,10 @@ import type { RecordsDeleteDescriptor, RecordsDeleteMessage } from '../types/rec
 import { Message } from '../core/message.js';
 
 import { ProtocolAuthorization } from '../core/protocol-authorization.js';
+import { Time } from '../utils/time.js';
 import { validateMessageSignatureIntegrity } from '../core/auth.js';
 import { DwnError, DwnErrorCode } from '../index.js';
 import { DwnInterfaceName, DwnMethodName } from '../core/message.js';
-import { getCurrentTimeInHighPrecision, validateTimestamp } from '../utils/time.js';
 
 export type RecordsDeleteOptions = {
   recordId: string;
@@ -22,7 +22,7 @@ export class RecordsDelete extends Message<RecordsDeleteMessage> {
 
   public static async parse(message: RecordsDeleteMessage): Promise<RecordsDelete> {
     await validateMessageSignatureIntegrity(message.authorization.signature, message.descriptor);
-    validateTimestamp(message.descriptor.messageTimestamp);
+    Time.validateTimestamp(message.descriptor.messageTimestamp);
 
     const recordsDelete = new RecordsDelete(message);
     return recordsDelete;
@@ -35,7 +35,7 @@ export class RecordsDelete extends Message<RecordsDeleteMessage> {
    */
   public static async create(options: RecordsDeleteOptions): Promise<RecordsDelete> {
     const recordId = options.recordId;
-    const currentTime = getCurrentTimeInHighPrecision();
+    const currentTime = Time.getCurrentTimestamp();
 
     const descriptor: RecordsDeleteDescriptor = {
       interface        : DwnInterfaceName.Records,

diff --git a/src/interfaces/records-query.ts b/src/interfaces/records-query.ts
@@ -5,10 +5,10 @@ import type { RecordsFilter, RecordsQueryDescriptor, RecordsQueryMessage } from
 import { Message } from '../core/message.js';
 import { Records } from '../utils/records.js';
 import { removeUndefinedProperties } from '../utils/object.js';
+import { Time } from '../utils/time.js';
 import { validateMessageSignatureIntegrity } from '../core/auth.js';
 import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
 import { DwnInterfaceName, DwnMethodName } from '../core/message.js';
-import { getCurrentTimeInHighPrecision, validateTimestamp } from '../utils/time.js';
 import { validateProtocolUrlNormalized, validateSchemaUrlNormalized } from '../utils/url.js';
 
 export enum DateSort {
@@ -49,7 +49,7 @@ export class RecordsQuery extends Message<RecordsQueryMessage> {
     if (message.descriptor.filter.schema !== undefined) {
       validateSchemaUrlNormalized(message.descriptor.filter.schema);
     }
-    validateTimestamp(message.descriptor.messageTimestamp);
+    Time.validateTimestamp(message.descriptor.messageTimestamp);
 
     return new RecordsQuery(message);
   }
@@ -58,7 +58,7 @@ export class RecordsQuery extends Message<RecordsQueryMessage> {
     const descriptor: RecordsQueryDescriptor = {
       interface        : DwnInterfaceName.Records,
       method           : DwnMethodName.Query,
-      messageTimestamp : options.messageTimestamp ?? getCurrentTimeInHighPrecision(),
+      messageTimestamp : options.messageTimestamp ?? Time.getCurrentTimestamp(),
       filter           : Records.normalizeFilter(options.filter),
       dateSort         : options.dateSort,
       pagination       : options.pagination,

diff --git a/src/interfaces/records-read.ts b/src/interfaces/records-read.ts
@@ -8,10 +8,10 @@ import { ProtocolAuthorization } from '../core/protocol-authorization.js';
 import { Records } from '../utils/records.js';
 import { RecordsGrantAuthorization } from '../core/records-grant-authorization.js';
 import { removeUndefinedProperties } from '../utils/object.js';
+import { Time } from '../utils/time.js';
 import { validateMessageSignatureIntegrity } from '../core/auth.js';
 import { DwnError, DwnErrorCode } from '../index.js';
 import { DwnInterfaceName, DwnMethodName } from '../core/message.js';
-import { getCurrentTimeInHighPrecision, validateTimestamp } from '../utils/time.js';
 
 export type RecordsReadOptions = {
   filter: RecordsFilter;
@@ -31,7 +31,7 @@ export class RecordsRead extends Message<RecordsReadMessage> {
     if (message.authorization !== undefined) {
       await validateMessageSignatureIntegrity(message.authorization.signature, message.descriptor);
     }
-    validateTimestamp(message.descriptor.messageTimestamp);
+    Time.validateTimestamp(message.descriptor.messageTimestamp);
 
     const recordsRead = new RecordsRead(message);
     return recordsRead;
@@ -46,7 +46,7 @@ export class RecordsRead extends Message<RecordsReadMessage> {
    */
   public static async create(options: RecordsReadOptions): Promise<RecordsRead> {
     const { filter, signer, permissionsGrantId, protocolRole } = options;
-    const currentTime = getCurrentTimeInHighPrecision();
+    const currentTime = Time.getCurrentTimestamp();
 
     const descriptor: RecordsReadDescriptor = {
       interface        : DwnInterfaceName.Records,

diff --git a/src/interfaces/records-write.ts b/src/interfaces/records-write.ts
@@ -26,10 +26,10 @@ import { ProtocolAuthorization } from '../core/protocol-authorization.js';
 import { RecordsGrantAuthorization } from '../core/records-grant-authorization.js';
 import { removeUndefinedProperties } from '../utils/object.js';
 import { Secp256k1 } from '../utils/secp256k1.js';
+import { Time } from '../utils/time.js';
 import { validateMessageSignatureIntegrity } from '../core/auth.js';
 import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
 import { DwnInterfaceName, DwnMethodName } from '../core/message.js';
-import { getCurrentTimeInHighPrecision, validateTimestamp } from '../utils/time.js';
 import { normalizeProtocolUrl, normalizeSchemaUrl, validateProtocolUrlNormalized, validateSchemaUrlNormalized } from '../utils/url.js';
 
 export type RecordsWriteOptions = {
@@ -273,7 +273,7 @@ export class RecordsWrite {
     const dataCid = options.dataCid ?? await Cid.computeDagPbCidFromBytes(options.data!);
     const dataSize = options.dataSize ?? options.data!.length;
 
-    const currentTime = getCurrentTimeInHighPrecision();
+    const currentTime = Time.getCurrentTimestamp();
 
     const descriptor: RecordsWriteDescriptor = {
       interface        : DwnInterfaceName.Records,
@@ -356,7 +356,7 @@ export class RecordsWrite {
    */
   public static async createFrom(options: CreateFromOptions): Promise<RecordsWrite> {
     const sourceMessage = options.recordsWriteMessage;
-    const currentTime = getCurrentTimeInHighPrecision();
+    const currentTime = Time.getCurrentTimestamp();
 
     // inherit published value from parent if neither published nor datePublished is specified
     const published = options.published ?? (options.datePublished ? true : sourceMessage.descriptor.published);
@@ -634,10 +634,10 @@ export class RecordsWrite {
       validateSchemaUrlNormalized(this.message.descriptor.schema);
     }
 
-    validateTimestamp(this.message.descriptor.messageTimestamp);
-    validateTimestamp(this.message.descriptor.dateCreated);
+    Time.validateTimestamp(this.message.descriptor.messageTimestamp);
+    Time.validateTimestamp(this.message.descriptor.dateCreated);
     if (this.message.descriptor.datePublished) {
-      validateTimestamp(this.message.descriptor.datePublished);
+      Time.validateTimestamp(this.message.descriptor.datePublished);
     }
   }