Merge pull request #159 from contentful/fix/should-not-publish

Respect shouldPublish flag when set to false

src/lib/action/entry-derive.ts

@@ -2,6 +2,8 @@ import EntryDerive from '../interfaces/entry-derive'
 import { APIAction } from './action'
 import { OfflineAPI } from '../offline-api'
 import { ContentType } from '../entities/content-type'
+import isDefined from '../utils/is-defined'
+
 import Entry from '../entities/entry'
 import * as _ from 'lodash'
 
@@ -22,7 +24,7 @@ class EntryDeriveAction extends APIAction {
     this.derivedContentType = entryDerivation.derivedContentType
     this.deriveEntryForLocale = entryDerivation.deriveEntryForLocale
     this.identityKey = entryDerivation.identityKey
-    this.shouldPublish = entryDerivation.shouldPublish || true
+    this.shouldPublish = isDefined(entryDerivation.shouldPublish) ? entryDerivation.shouldPublish : true
   }
 
   async applyTo (api: OfflineAPI) {

src/lib/entities/entry.ts

@@ -1,6 +1,6 @@
 import { cloneDeep } from 'lodash'
 import APIEntry from '../interfaces/api-entry'
-import { isNullOrUndefined } from 'util'
+import isDefined from '../utils/is-defined'
 
 class Entry {
   private _id: string
@@ -64,7 +64,7 @@ class Entry {
   }
 
   get isPublished () {
-    return !isNullOrUndefined(this._publishedVersion)
+    return isDefined(this._publishedVersion)
   }
 
   get publishedVersion () {

src/lib/utils/is-defined.ts

@@ -0,0 +1,3 @@
+export default function isDefined<T> (value: T | undefined | null): value is T {
+  return value !== undefined && value !== null
+}

test/unit/lib/actions/entry-derive.spec.js

@@ -72,6 +72,67 @@ describe('Entry Derive', function () {
     expect(updateEntryWithLinkFields.ownerRef['en-US'].sys.id).to.eq(batches[0].requests[0].data.sys.id); // id of linked object is same as id of target object
   });
 
+  it('respects shouldPublish', async function () {
+    const action = new EntryDeriveAction('dog', {
+      derivedContentType: 'owner',
+      from: ['owner'],
+      toReferenceField: 'ownerRef',
+      derivedFields: ['firstName', 'lastName'],
+      identityKey: async (fromFields) => {
+        return fromFields.owner['en-US'].toLowerCase().replace(' ', '-');
+      },
+      shouldPublish: false,
+      deriveEntryForLocale: async (inputFields, locale) => {
+        if (locale !== 'en-US') {
+          return;
+        }
+        const [firstName, lastName] = inputFields.owner[locale].split(' ');
+        return {
+          firstName,
+          lastName
+        };
+      }
+    });
+
+    const contentTypes = new Map();
+    contentTypes.set('dog', new ContentType({
+      sys: {
+        id: 'dog'
+      },
+      fields: [{
+        name: 'ownerRef',
+        id: 'ownerRef',
+        type: 'Symbol'
+      }]
+    })
+    );
+
+    const entries = [
+      new Entry(makeApiEntry({
+        id: '246',
+        contentTypeId: 'dog',
+        version: 1,
+        fields: {
+          owner: {
+            'en-US': 'john doe'
+          }
+        }
+      }))
+    ];
+
+    const api = new OfflineApi(contentTypes, entries, ['en-US']);
+    api.startRecordingRequests(null);
+    await action.applyTo(api);
+    api.stopRecordingRequests();
+    const batches = await api.getRequestBatches();
+    expect(batches[0].requests.length).to.eq(2);
+
+    expect(batches[0].requests[0].data.sys.publishedVersion).to.eql(undefined);
+    expect(batches[0].requests[0].data.sys.version).to.eql(0);
+    expect(batches[0].requests[1].data.sys.publishedVersion).to.eql(undefined);
+    expect(batches[0].requests[1].data.sys.version).to.eql(1);
+  });
+
   it('derives an entry from n to n', async function () {
     const action = new EntryDeriveAction('dog', {
       derivedContentType: 'owner',