refactor: use symbol for ready property

asset-pipe · Nov 29, 2017 · 394c42d · 394c42d
1 parent 4442200
commit 394c42d
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 29 deletions.
diff --git a/lib/sink.js b/lib/sink.js
@@ -103,6 +103,7 @@ class ReadStream extends stream.PassThrough {
 }
 
 const getGcsFile = Symbol('getGcsFile');
+const ready = Symbol('ready');
 
 function getPrefixes(directoryName) {
  let prefix;
@@ -145,7 +146,7 @@ module.exports = class SinkGCS extends EventEmitter {
  const bucket = this.gcs.bucket(bucketName);
 
  // `getMetadata` fails if the bucket does not exist
- this._ready = bucket
+ this[ready] = bucket
  .getMetadata()
  .then(() => {
  this.bucket = bucket;
@@ -176,7 +177,7 @@ module.exports = class SinkGCS extends EventEmitter {
  }
 
  async get(fileName) {
- await this._ready;
+ await this[ready];
  const data = await this[getGcsFile](fileName).download();
  return data.toString();
  }
@@ -201,7 +202,7 @@ module.exports = class SinkGCS extends EventEmitter {
  }"`
  );
 
- await this._ready;
+ await this[ready];
  await this[getGcsFile](fileName).save(fileContent, {
  metadata: {
  contentType,
@@ -211,13 +212,13 @@ module.exports = class SinkGCS extends EventEmitter {
 
  async has(fileName) {
  assert(fileName, '"fileName" is missing');
- await this._ready;
+ await this[ready];
  const result = await this[getGcsFile](fileName).exists();
  return !!(result && result[0]);
  }
 
  async dir(directoryName) {
- await this._ready;
+ await this[ready];
  try {
  const { prefix, filterPrefix } = getPrefixes(directoryName);
  const fileRequestResult = await this.bucket.getFiles({

diff --git a/test/sink.test.js b/test/sink.test.js
@@ -58,8 +58,6 @@ test('.writer() - happy path', async done => {
  expect.assertions(2);
  const sink = getValidSink();
 
- await sink._ready;
-
  const gcsFakeWritestream = new stream.Writable({
  _data: false,
  write(chunk, encoding, next) {
@@ -99,8 +97,6 @@ test('.writer() - happy path', async done => {
 test('.get() - should resolve fileContent when file exist', async () => {
  const sink = getValidSink();
 
- await sink._ready;
-
  const content = 'some-file-content';
  sink.gcs._setState({
  download: {
@@ -115,8 +111,6 @@ test('.get() - should resolve fileContent when file exist', async () => {
 test('.set() - should return no value/undefined if success', async () => {
  const sink = getValidSink();
 
- await sink._ready;
-
  sink.gcs._setState({ save: '' });
 
  const result = await sink.set('some-file.json', 'file-content');
@@ -137,8 +131,6 @@ test('.set() - should error if file extension cannot be resolved to a mime type'
 test('.has() - should return true if file exists', async () => {
  const sink = getValidSink();
 
- await sink._ready;
-
  sink.gcs._setState({ exists: [true] });
 
  const result = await sink.has('some-file');
@@ -149,8 +141,6 @@ test('.has() - should return true if file exists', async () => {
 test('.has() - should return false if missing', async () => {
  const sink = getValidSink();
 
- await sink._ready;
-
  sink.gcs._setState({ exists: [] });
 
  const result = await sink.has('some-file');
@@ -168,8 +158,6 @@ test('dir() - should error when invalid response from getFiles', async () => {
  expect.assertions(1);
  const sink = getValidSink();
 
- await sink._ready;
-
  sink.gcs._setState({ getFiles: { '/': [] } });
 
  try {
@@ -183,8 +171,6 @@ test('dir() - should error when no files', async () => {
  expect.assertions(1);
  const sink = getValidSink();
 
- await sink._ready;
-
  sink.gcs._setState({ getFiles: { 'some-dir/': [[]] } });
 
  try {
@@ -198,8 +184,6 @@ test('dir() - should error when no matching files', async () => {
  expect.assertions(1);
  const sink = getValidSink();
 
- await sink._ready;
-
  sink.gcs._setState({
  getFiles: {
  'folder/': [
@@ -220,8 +204,6 @@ test('dir() - should output 1 file', async () => {
  expect.assertions(1);
  const sink = getValidSink();
 
- await sink._ready;
-
  const fileName = 'some-path/some-file-name.json';
  sink.gcs._setState({
  download: { [fileName]: 'file-content' },
@@ -238,8 +220,6 @@ test('dir() - should output 1 file with extra slash', async () => {
  expect.assertions(1);
  const sink = getValidSink();
 
- await sink._ready;
-
  const fileName = 'some-path/some-file-name.json';
  sink.gcs._setState({
  download: { [fileName]: 'file-content' },
@@ -256,8 +236,6 @@ test('dir() - should output 3 file', async () => {
  expect.assertions(1);
  const sink = getValidSink();
 
- await sink._ready;
-
  const fileName1 = 'some-path/some-file-name-1';
  const fileName2 = 'some-path/some-file-name-2';
  const fileName3 = 'some-path/some-file-name-3';
@@ -286,8 +264,6 @@ test('dir() - should output 3 files with extensions', async () => {
  expect.assertions(1);
  const sink = getValidSink();
 
- await sink._ready;
-
  const fileName1 = 'some-path/some-file-name-4.json';
  const fileName2 = 'some-path/some-file-name-5.css';
  const fileName3 = 'some-path/some-file-name-6.js';