Skip to content

Commit

Permalink
refactor(deps): Remove dependency date-and-time in favor of utility (#…
Browse files Browse the repository at this point in the history 
…1928)

function

refactor(deps): Remove date-and-time dependency in favor of utility function
  • Loading branch information
@ddelgrosso1
ddelgrosso1 authored May 16, 2022
1 parent 5d8bfd0 commit 850733c
Show file tree
Hide file tree
Showing 6 changed files with 62 additions and 51 deletions.
1 change: 0 additions & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@
"async-retry": "^1.3.3",
"compressible": "^2.0.12",
"configstore": "^5.0.0",
"date-and-time": "^2.0.0",
"duplexify": "^4.0.0",
"ent": "^2.2.0",
"extend": "^3.0.2",
Expand Down
18 changes: 9 additions & 9 deletions src/file.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ import {promisifyAll} from '@google-cloud/promisify';

import compressible = require('compressible');
import * as crypto from 'crypto';
import * as dateFormat from 'date-and-time';
import * as extend from 'extend';
import * as fs from 'fs';
// eslint-disable-next-line @typescript-eslint/no-var-requires
Expand Down Expand Up @@ -65,7 +64,12 @@ import {
} from './nodejs-common/util';
// eslint-disable-next-line @typescript-eslint/no-var-requires
const duplexify: DuplexifyConstructor = require('duplexify');
import {normalize, objectKeyToLowercase, unicodeJSONStringify} from './util';
import {
normalize,
objectKeyToLowercase,
unicodeJSONStringify,
formatAsUTCISO,
} from './util';
import retry = require('async-retry');

export type GetExpirationDateResponse = [Date];
Expand Down Expand Up @@ -2760,8 +2764,8 @@ class File extends ServiceObject<File> {
let fields = Object.assign({}, options.fields);

const now = new Date();
const nowISO = dateFormat.format(now, 'YYYYMMDD[T]HHmmss[Z]', true);
const todayISO = dateFormat.format(now, 'YYYYMMDD', true);
const nowISO = formatAsUTCISO(now, true);
const todayISO = formatAsUTCISO(now);

const sign = async () => {
const {client_email} = await this.storage.authClient.getCredentials();
Expand All @@ -2786,11 +2790,7 @@ class File extends ServiceObject<File> {

delete fields.bucket;

const expiration = dateFormat.format(
expires,
'YYYY-MM-DD[T]HH:mm:ss[Z]',
true
);
const expiration = formatAsUTCISO(expires, true, '-', ':');

const policy = {
conditions,
Expand Down
8 changes: 3 additions & 5 deletions src/signer.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,10 @@
// limitations under the License.

import * as crypto from 'crypto';
import * as dateFormat from 'date-and-time';
import * as http from 'http';
import * as url from 'url';
import {ExceptionMessages} from './storage';
import {encodeURI, qsStringify, objectEntries} from './util';
import {encodeURI, qsStringify, objectEntries, formatAsUTCISO} from './util';

interface GetCredentialsResponse {
client_email?: string;
Expand Down Expand Up @@ -268,15 +267,14 @@ export class URLSigner {

const extensionHeadersString = this.getCanonicalHeaders(extensionHeaders);

const datestamp = dateFormat.format(config.accessibleAt, 'YYYYMMDD', true);
const datestamp = formatAsUTCISO(config.accessibleAt);
const credentialScope = `${datestamp}/auto/storage/goog4_request`;

const sign = async () => {
const credentials = await this.authClient.getCredentials();
const credential = `${credentials.client_email}/${credentialScope}`;
const dateISO = dateFormat.format(
const dateISO = formatAsUTCISO(
config.accessibleAt ? config.accessibleAt : new Date(),
'YYYYMMDD[T]HHmmss[Z]',
true
);
const queryParams: Query = {
Expand Down
35 changes: 35 additions & 0 deletions src/util.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -131,3 +131,38 @@ export function convertObjKeysToSnakeCase(obj: object): object {

return obj;
}

/**
* Formats the provided date object as a UTC ISO string.
* @param {Date} dateTimeToFormat date object to be formatted.
* @param {boolean} includeTime flag to include hours, minutes, seconds in output.
* @param {string} dateDelimiter delimiter between date components.
* @param {string} timeDelimiter delimiter between time components.
* @returns {string} UTC ISO format of provided date obect.
*/
export function formatAsUTCISO(
dateTimeToFormat: Date,
includeTime = false,
dateDelimiter = '',
timeDelimiter = ''
): string {
const year = dateTimeToFormat.getUTCFullYear();
const month = dateTimeToFormat.getUTCMonth() + 1;
const day = dateTimeToFormat.getUTCDate();
const hour = dateTimeToFormat.getUTCHours();
const minute = dateTimeToFormat.getUTCMinutes();
const second = dateTimeToFormat.getUTCSeconds();

let resultString = `${year.toString().padStart(4, '0')}${dateDelimiter}${month
.toString()
.padStart(2, '0')}${dateDelimiter}${day.toString().padStart(2, '0')}`;
if (includeTime) {
resultString = `${resultString}T${hour
.toString()
.padStart(2, '0')}${timeDelimiter}${minute
.toString()
.padStart(2, '0')}${timeDelimiter}${second.toString().padStart(2, '0')}Z`;
}

return resultString;
}
28 changes: 8 additions & 20 deletions test/file.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ import {PromisifyAllOptions} from '@google-cloud/promisify';
import {Readable, PassThrough, Stream, Duplex, Transform} from 'stream';
import * as assert from 'assert';
import * as crypto from 'crypto';
import * as dateFormat from 'date-and-time';
import * as duplexify from 'duplexify';
import * as extend from 'extend';
import * as fs from 'fs';
Expand Down Expand Up @@ -57,6 +56,7 @@ import {
FileExceptionMessages,
} from '../src/file';
import {ExceptionMessages, IdempotencyStrategy} from '../src/storage';
import {formatAsUTCISO} from '../src/util';

class HTTPError extends Error {
code: number;
Expand Down Expand Up @@ -3324,11 +3324,7 @@ describe('File', () => {
{bucket: BUCKET.name},
...fieldsToConditions(requiredFields),
],
expiration: dateFormat.format(
new Date(CONFIG.expires),
'YYYY-MM-DD[T]HH:mm:ss[Z]',
true
),
expiration: formatAsUTCISO(new Date(CONFIG.expires), true, '-', ':'),
};

const policyString = JSON.stringify(policy);
Expand Down Expand Up @@ -3548,7 +3544,7 @@ describe('File', () => {
);
assert.strictEqual(
policy.expiration,
dateFormat.format(expires, 'YYYY-MM-DD[T]HH:mm:ss[Z]', true)
formatAsUTCISO(expires, true, '-', ':')
);
done();
}
Expand All @@ -3569,22 +3565,18 @@ describe('File', () => {
);
assert.strictEqual(
policy.expiration,
dateFormat.format(
new Date(expires),
'YYYY-MM-DD[T]HH:mm:ss[Z]',
true
)
formatAsUTCISO(new Date(expires), true, '-', ':')
);
done();
}
);
});

it('should accept strings', done => {
const expires = dateFormat.format(
const expires = formatAsUTCISO(
new Date(Date.now() + 2 * 24 * 60 * 60 * 1000),
'YYYY-MM-DD',
true
false,
'-'
);

file.generateSignedPostPolicyV4(
Expand All @@ -3598,11 +3590,7 @@ describe('File', () => {
);
assert.strictEqual(
policy.expiration,
dateFormat.format(
new Date(expires),
'YYYY-MM-DD[T]HH:mm:ss[Z]',
true
)
formatAsUTCISO(new Date(expires), true, '-', ':')
);
done();
}
Expand Down
23 changes: 7 additions & 16 deletions test/signer.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
// See the License for the specific language governing permissions and
// limitations under the License.
import * as assert from 'assert';
import * as dateFormat from 'date-and-time';
import * as crypto from 'crypto';
import * as sinon from 'sinon';
import {describe, it, beforeEach, afterEach} from 'mocha';
Expand All @@ -29,7 +28,7 @@ import {
Query,
SignerExceptionMessages,
} from '../src/signer';
import {encodeURI, qsStringify} from '../src/util';
import {encodeURI, formatAsUTCISO, qsStringify} from '../src/util';
import {ExceptionMessages} from '../src/storage';

describe('signer', () => {
Expand Down Expand Up @@ -187,11 +186,7 @@ describe('signer', () => {
expires: expiresNumber,
});
const blobToSign = authClientSign.getCall(0).args[0];
assert(
blobToSign.includes(
dateFormat.format(accessibleAt, 'YYYYMMDD[T]HHmmss[Z]', true)
)
);
assert(blobToSign.includes(formatAsUTCISO(accessibleAt, true)));
});

it('should throw if an expiration date from the before accessibleAt date is given', () => {
Expand All @@ -211,11 +206,7 @@ describe('signer', () => {

describe('checkInputTypes', () => {
const query = {
'X-Goog-Date': dateFormat.format(
new Date(accessibleAtNumber),
'YYYYMMDD[T]HHmmss[Z]',
true
),
'X-Goog-Date': formatAsUTCISO(new Date(accessibleAtNumber), true),
};

it('should accept Date objects', async () => {
Expand Down Expand Up @@ -688,7 +679,7 @@ describe('signer', () => {
const query = (await signer['getSignedUrlV4'](CONFIG)) as Query;
const arg = getCanonicalQueryParams.getCall(0).args[0];

const datestamp = dateFormat.format(NOW, 'YYYYMMDD', true);
const datestamp = formatAsUTCISO(NOW);
const credentialScope = `${datestamp}/auto/storage/goog4_request`;
const EXPECTED_CREDENTIAL = `${CLIENT_EMAIL}/${credentialScope}`;

Expand All @@ -697,7 +688,7 @@ describe('signer', () => {
});

it('should populate X-Goog-Date', async () => {
const dateISO = dateFormat.format(NOW, 'YYYYMMDD[T]HHmmss[Z]', true);
const dateISO = formatAsUTCISO(NOW, true);

const query = (await signer['getSignedUrlV4'](CONFIG)) as Query;
const arg = getCanonicalQueryParams.getCall(0).args[0];
Expand Down Expand Up @@ -787,9 +778,9 @@ describe('signer', () => {
});

it('should compose blobToSign', async () => {
const datestamp = dateFormat.format(NOW, 'YYYYMMDD', true);
const datestamp = formatAsUTCISO(NOW);
const credentialScope = `${datestamp}/auto/storage/goog4_request`;
const dateISO = dateFormat.format(NOW, 'YYYYMMDD[T]HHmmss[Z]', true);
const dateISO = formatAsUTCISO(NOW, true);

const authClientSign = sinon
.stub(authClient, 'sign')
Expand Down

0 comments on commit 850733c

Please sign in to comment.