Use JavaScript fn names (pop > shift)

Author: timfish

packages/browser/src/transports/offline.ts

@@ -79,7 +79,7 @@ export function unshift(store: Store, value: Uint8Array | string, maxQueueSize:
 }
 
 /** Pop the oldest value from the store */
-export function pop(store: Store): Promise<Uint8Array | string | undefined> {
+export function shift(store: Store): Promise<Uint8Array | string | undefined> {
   return store(store => {
     return keys(store).then(keys => {
       if (keys.length === 0) {
@@ -141,9 +141,9 @@ function createIndexedDbStore(options: BrowserOfflineTransportOptions): OfflineS
         //
       }
     },
-    pop: async () => {
+    shift: async () => {
       try {
-        const deserialized = await pop(getStore());
+        const deserialized = await shift(getStore());
         if (deserialized) {
           return parseEnvelope(deserialized);
         }

packages/browser/test/unit/transports/offline.test.ts

@@ -11,7 +11,7 @@ import type {
 import { createEnvelope } from '@sentry/utils';
 
 import { MIN_DELAY } from '../../../../core/src/transports/offline';
-import { createStore, makeBrowserOfflineTransport, pop, push, unshift } from '../../../src/transports/offline';
+import { createStore, makeBrowserOfflineTransport, push, shift, unshift } from '../../../src/transports/offline';
 
 function deleteDatabase(name: string): Promise<void> {
   return new Promise<void>((resolve, reject) => {
@@ -65,21 +65,21 @@ describe('makeOfflineTransport', () => {
 
   it('indexedDb wrappers push, unshift and pop', async () => {
     const store = createStore('test', 'test');
-    const found = await pop(store);
+    const found = await shift(store);
     expect(found).toBeUndefined();
 
     await push(store, 'test1', 30);
     await push(store, new Uint8Array([1, 2, 3, 4, 5]), 30);
     await unshift(store, 'test2', 30);
 
-    const found2 = await pop(store);
+    const found2 = await shift(store);
     expect(found2).toEqual('test2');
-    const found3 = await pop(store);
+    const found3 = await shift(store);
     expect(found3).toEqual('test1');
-    const found4 = await pop(store);
+    const found4 = await shift(store);
     expect(found4).toEqual(new Uint8Array([1, 2, 3, 4, 5]));
 
-    const found5 = await pop(store);
+    const found5 = await shift(store);
     expect(found5).toBeUndefined();
   });
 

packages/core/src/transports/offline.ts

@@ -14,7 +14,7 @@ function log(msg: string, error?: Error): void {
 export interface OfflineStore {
   push(env: Envelope): Promise<void>;
   unshift(env: Envelope): Promise<void>;
-  pop(): Promise<Envelope | undefined>;
+  shift(): Promise<Envelope | undefined>;
 }
 
 export type CreateOfflineStore = (options: OfflineTransportOptions) => OfflineStore;
@@ -87,7 +87,7 @@ export function makeOfflineTransport<TO>(
       flushTimer = setTimeout(async () => {
         flushTimer = undefined;
 
-        const found = await store.pop();
+        const found = await store.shift();
         if (found) {
           log('Attempting to send previously queued event');
           void send(found, true).catch(e => {

packages/core/test/lib/transports/offline.test.ts

@@ -107,7 +107,7 @@ const createTestTransport = (...sendResults: MockResult<TransportMakeRequestResp
   };
 };
 
-type StoreEvents = ('push' | 'unshift' | 'pop')[];
+type StoreEvents = ('push' | 'unshift' | 'shift')[];
 
 function createTestStore(...popResults: MockResult<Envelope | undefined>[]): {
   getCalls: () => StoreEvents;
@@ -130,8 +130,8 @@ function createTestStore(...popResults: MockResult<Envelope | undefined>[]): {
           calls.push('unshift');
         }
       },
-      pop: async () => {
-        calls.push('pop');
+      shift: async () => {
+        calls.push('shift');
         const next = popResults.shift();
 
         if (next instanceof Error) {
@@ -182,7 +182,7 @@ describe('makeOfflineTransport', () => {
     await waitUntil(() => getCalls().length == 1, 1_000);
 
     // After a successful send, the store should be checked
-    expect(getCalls()).toEqual(['pop']);
+    expect(getCalls()).toEqual(['shift']);
   });
 
   it('Envelopes are added after existing envelopes in the queue', async () => {
@@ -197,7 +197,7 @@ describe('makeOfflineTransport', () => {
 
     expect(getSendCount()).toEqual(2);
     // After a successful send from the store, the store should be checked again to ensure it's empty
-    expect(getCalls()).toEqual(['pop', 'pop']);
+    expect(getCalls()).toEqual(['shift', 'shift']);
   });
 
   it('Queues envelope if wrapped transport throws error', async () => {
@@ -259,7 +259,7 @@ describe('makeOfflineTransport', () => {
       await waitUntil(() => getCalls().length === 3 && getSendCount() === 1, START_DELAY * 2);
 
       expect(getSendCount()).toEqual(1);
-      expect(getCalls()).toEqual(['push', 'pop', 'pop']);
+      expect(getCalls()).toEqual(['push', 'shift', 'shift']);
     },
     START_DELAY + 2_000,
   );
@@ -279,7 +279,7 @@ describe('makeOfflineTransport', () => {
       await waitUntil(() => getCalls().length === 3 && getSendCount() === 2, START_DELAY * 2);
 
       expect(getSendCount()).toEqual(2);
-      expect(getCalls()).toEqual(['pop', 'pop', 'pop']);
+      expect(getCalls()).toEqual(['shift', 'shift', 'shift']);
     },
     START_DELAY + 2_000,
   );
@@ -299,7 +299,7 @@ describe('makeOfflineTransport', () => {
       await waitUntil(() => getCalls().length === 2, START_DELAY * 2);
 
       expect(getSendCount()).toEqual(0);
-      expect(getCalls()).toEqual(['pop', 'unshift']);
+      expect(getCalls()).toEqual(['shift', 'unshift']);
     },
     START_DELAY + 2_000,
   );
@@ -361,12 +361,12 @@ describe('makeOfflineTransport', () => {
         // We're sending a replay envelope and they always get queued
         'push',
         // The first envelope popped out fails to send so it gets added to the front of the queue
-        'pop',
+        'shift',
         'unshift',
         // The rest of the attempts succeed
-        'pop',
-        'pop',
-        'pop',
+        'shift',
+        'shift',
+        'shift',
       ]);
 
       const envelopes = getSentEnvelopes().map(parseEnvelope);
@@ -416,7 +416,7 @@ describe('makeOfflineTransport', () => {
 
       expect(getSendCount()).toEqual(2);
       expect(queuedCount).toEqual(0);
-      expect(getCalls()).toEqual(['pop', 'pop']);
+      expect(getCalls()).toEqual(['shift', 'shift']);
     },
     START_DELAY * 3,
   );